From 2a3294803a8df71659e27711e5fbfe4e97826828 Mon Sep 17 00:00:00 2001 From: Gerry Tan Date: Fri, 27 Sep 2024 12:04:52 +1000 Subject: [PATCH 001/101] Add typespec-csharp config for .NET SDK code generation (#30736) * typespec-csharp config for AzureTerraform * Rename AzureTerraform to Terraform --- .../Microsoft.AzureTerraform.Management/tspconfig.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml index 2b37c676ebf5..b0969fdd42f9 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml +++ b/specification/terraform/Microsoft.AzureTerraform.Management/tspconfig.yaml @@ -7,6 +7,12 @@ options: emitter-output-dir: "{project-root}/.." azure-resource-provider-folder: "resource-manager" output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/export.json" + "@azure-tools/typespec-csharp": + flavor: azure + package-dir: "Azure.ResourceManager.Terraform" + clear-output-folder: true + model-namespace: false + namespace: "{package-dir}" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 139840784c38414085b3d799cee5545f9b6e8dec Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Fri, 27 Sep 2024 11:03:41 +0800 Subject: [PATCH 002/101] mgmt, codesigning, update tspconfig (#30744) * mgmt, codesigning, update tspconfig * Update python config * Update tspconfig.yaml * update client name for python * Update client.tsp * Update tspconfig.yaml * Update tspconfig.yaml for go --------- Co-authored-by: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Co-authored-by: ChenxiJiang333 Co-authored-by: Chenjie Shi --- .../CodeSigning.Management/client.tsp | 7 ++++ .../CodeSigning.Management/tspconfig.yaml | 36 +++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 specification/codesigning/CodeSigning.Management/client.tsp diff --git a/specification/codesigning/CodeSigning.Management/client.tsp b/specification/codesigning/CodeSigning.Management/client.tsp new file mode 100644 index 000000000000..740e592dc8e0 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/client.tsp @@ -0,0 +1,7 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.CodeSigning, "TrustedSigningMgmt", "python"); +@@clientName(Microsoft.CodeSigning, "TrustedSigningManagementClient", "java"); diff --git a/specification/codesigning/CodeSigning.Management/tspconfig.yaml b/specification/codesigning/CodeSigning.Management/tspconfig.yaml index 78c952a12b48..a500693e0357 100644 --- a/specification/codesigning/CodeSigning.Management/tspconfig.yaml +++ b/specification/codesigning/CodeSigning.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/trustedsigning" emit: - "@azure-tools/typespec-autorest" options: @@ -9,6 +12,39 @@ options: # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeSigningAccount.json" + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-trustedsigning" + flavor: "azure" + namespace: "com.azure.resourcemanager.trustedsigning" + service-name: "Trusted Signing" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-trustedsigning" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + package-dir: "arm-trustedsigning" + flavor: "azure" + packageDetails: + name: "@azure/arm-trustedsigning" + "@azure-tools/typespec-go": + service-dir: "sdk/resourcemanager/trustedsigning" + package-dir: "armtrustedsigning" + module: "github.com/Azure/azure-sdk-for-go/{service-dir}/{package-dir}" + fix-const-stuttering: true + flavor: "azure" + generate-examples: true + generate-fakes: true + head-as-boolean: true + inject-spans: true + remove-unreferenced-types: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 10b3107f2eafcd428a208ec5858f3ca9261b1123 Mon Sep 17 00:00:00 2001 From: Jian Chen Date: Fri, 27 Sep 2024 13:19:07 +0800 Subject: [PATCH 003/101] [Service Linker] add 24-07-01-preview api version (#30743) * add 24-07-01-preview --------- Co-authored-by: Bryce Chen --- .../examples/ConfigurationNamesList.json | 52 + .../examples/ConnectorDryrunCreate.json | 116 + .../examples/ConnectorDryrunDelete.json | 13 + .../examples/ConnectorDryrunGet.json | 33 + .../examples/ConnectorDryrunList.json | 36 + .../examples/ConnectorDryrunUpdate.json | 78 + .../examples/ConnectorList.json | 34 + .../examples/Connectors.json | 43 + .../examples/DeleteConnector.json | 18 + .../examples/DeleteDryrun.json | 11 + .../examples/DeleteLinker.json | 16 + .../examples/GenerateConfigurations.json | 26 + .../examples/GetConfigurations.json | 41 + .../examples/GetDaprConfigurations.json | 33 + .../examples/GetDryrun.json | 32 + .../2024-07-01-preview/examples/Linker.json | 47 + .../LinkerGenerateConfigurations.json | 24 + .../examples/LinkerList.json | 32 + .../examples/ListDryrun.json | 35 + .../examples/OperationsList.json | 184 ++ .../examples/PatchConnector.json | 64 + .../examples/PatchDryrun.json | 77 + .../examples/PatchLinker.json | 59 + .../examples/PutConnector.json | 63 + .../examples/PutDryrun.json | 116 + .../examples/PutLinker.json | 68 + .../examples/ValidateConnectorSuccess.json | 38 + .../examples/ValidateLinkerSuccess.json | 38 + .../2024-07-01-preview/servicelinker.json | 2937 +++++++++++++++++ .../servicelinker/resource-manager/readme.md | 11 +- 30 files changed, 4374 insertions(+), 1 deletion(-) create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json create mode 100644 specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json new file mode 100644 index 000000000000..57c406a4b875 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConfigurationNamesList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "systemAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for the token." + } + ] + } + }, + { + "properties": { + "targetService": "MICROSOFT.APPCONFIGURATION/CONFIGURATIONSTORES", + "clientType": "none", + "authType": "userAssignedIdentity", + "names": [ + { + "value": "AZURE_APPCONFIGURATION_ENDPOINT", + "description": "App configuration endpoint" + }, + { + "value": "AZURE_APPCONFIGURATION_CLIENTID", + "description": "The client(application) ID of the user identity." + }, + { + "value": "AZURE_APPCONFIGURATION_SCOPE", + "description": "The scopes required for getting token." + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json new file mode 100644 index 000000000000..d4103f9d88e4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunCreate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Accepted" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json new file mode 100644 index 000000000000..d1cd053dfdf2 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json new file mode 100644 index 000000000000..e9fab0f0d0fb --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json new file mode 100644 index 000000000000..b0d6cb39937d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json new file mode 100644 index 000000000000..3f87be091230 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorDryrunUpdate.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "dryrunName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/locations/westus/dryruns/dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json new file mode 100644 index 000000000000..ac02963e6953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ConnectorList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/linkers/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json new file mode 100644 index 000000000000..b774d9142b09 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Connectors.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/devConnnectors/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/devConnectors", + "properties": { + "authInfo": { + "authType": "systemAssignedIdentity", + "roles": [ + "customizedOwner" + ] + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "publicNetworkSolution": { + "firewallRules": { + "ipRanges": [ + "182.22.120" + ], + "callerClientIP": "true" + }, + "action": "enable", + "deleteOrUpdateBehavior": "ForcedCleanup" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json new file mode 100644 index 000000000000..1dc02aed0953 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteConnector.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json new file mode 100644 index 000000000000..b6d84517cba6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteDryrun.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json new file mode 100644 index 000000000000..a2eb35ce6361 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/DeleteLinker.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json new file mode 100644 index 000000000000..b51f80725ab6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GenerateConfigurations.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json new file mode 100644 index 000000000000..39d787a2211d --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetConfigurations.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.App/containerApps/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "AZURE_POSTGRESQL_HOST", + "value": "Host", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_USER", + "value": "Username", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_DATABASE", + "value": "DatabaseName", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PORT", + "value": "Port", + "configType": "Default" + }, + { + "name": "AZURE_POSTGRESQL_PASSWORD", + "value": "SecretUri", + "configType": "KeyVaultSecret", + "keyVaultReferenceIdentity": "system" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json new file mode 100644 index 000000000000..cdbc03e325fc --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDaprConfigurations.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetType": "MICROSOFT.STORAGE/STORAGEACCOUNTS/BLOBSERVICES", + "authType": "secret", + "daprProperties": { + "version": "v1", + "componentType": "bindings", + "runtimeVersion": "1.10", + "bindingComponentDirection": "input", + "metadata": [ + { + "name": "containerName", + "description": "The name of the container to be used for Dapr state.", + "required": "true" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json new file mode 100644 index 000000000000..6545c44b1163 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/GetDryrun.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json new file mode 100644 index 000000000000..eabc04aa76e7 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/Linker.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/kvname" + }, + "scope": "AKS-Namespace", + "clientType": "dotnet", + "publicNetworkSolution": { + "action": "enable" + }, + "configurationInfo": { + "deleteOrUpdateBehavior": "ForcedCleanup", + "customizedKeys": { + "AZURE_MYSQL_CONNECTIONSTRING": "myConnectionstring", + "AZURE_MYSQL_SSLMODE": "mySslmode" + }, + "additionalConfigurations": { + "throttlingLimit": "100" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json new file mode 100644 index 000000000000..20077dc3ba0b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerGenerateConfigurations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "customizedKeys": { + "ASL_DocumentDb_ConnectionString": "MyConnectionstring" + } + } + }, + "responses": { + "200": { + "body": { + "configurations": [ + { + "name": "MyConnectionstring", + "value": "ConnectionString" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json new file mode 100644 index 000000000000..99a8f52427c4 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/LinkerList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ServiceLinker/links/linkName", + "name": "linkName", + "type": "Microsoft.ServiceLinker/links", + "properties": { + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json new file mode 100644 index 000000000000..4a8dde8c63f0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ListDryrun.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "name": "dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "authInfo": { + "authType": "secret", + "name": "username" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + }, + "systemData": { + "createdAt": "2020-07-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..905bfe616da0 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/OperationsList.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Register the subscription for Microsoft.ServiceLinker", + "operation": "Register the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/register/action" + }, + { + "display": { + "description": "Unregister the subscription for Microsoft.ServiceLinker", + "operation": "Unregister the Microsoft.ServiceLinker", + "provider": "Microsoft.ServiceLinker", + "resource": "Microsoft.ServiceLinker" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/unregister/action" + }, + { + "display": { + "description": "read operations", + "operation": "read_operations", + "provider": "Microsoft.ServiceLinker", + "resource": "operations" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/operations/read" + }, + { + "display": { + "description": "list dryrun jobs", + "operation": "Dryrun_List", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "get a dryrun job", + "operation": "Dryrun_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/read" + }, + { + "display": { + "description": "create a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Create", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "delete a dryrun job", + "operation": "Dryrun_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/delete" + }, + { + "display": { + "description": "add a dryrun job to do necessary check before actual creation", + "operation": "Dryrun_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "dryruns" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/dryruns/write" + }, + { + "display": { + "description": "read operationStatuses", + "operation": "read_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/read" + }, + { + "display": { + "description": "write operationStatuses", + "operation": "write_operationStatuses", + "provider": "Microsoft.ServiceLinker", + "resource": "locations/operationStatuses" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/locations/operationStatuses/write" + }, + { + "display": { + "description": "Returns list of Linkers which connects to the resource.", + "operation": "Linker_List", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Returns Linker resource for a given name.", + "operation": "Linker_Get", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/read" + }, + { + "display": { + "description": "Create or update linker resource.", + "operation": "Linker_CreateOrUpdate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Delete a link.", + "operation": "Linker_Delete", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/delete" + }, + { + "display": { + "description": "Operation to update an existing link.", + "operation": "Linker_Update", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/write" + }, + { + "display": { + "description": "Validate a link.", + "operation": "Linker_Validate", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/validateLinker/action" + }, + { + "display": { + "description": "list source configurations for a linker.", + "operation": "Linker_ListConfigurations", + "provider": "Microsoft.ServiceLinker", + "resource": "linkers" + }, + "isDataAction": false, + "name": "Microsoft.ServiceLinker/linkers/listConfigurations/action" + } + ] + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json new file mode 100644 index 000000000000..a302ac667d38 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchConnector.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json new file mode 100644 index 000000000000..c7da10d3eac5 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchDryrun.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json new file mode 100644 index 000000000000..6a85c703e63b --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PatchLinker.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id", + "secret": "secret" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "servicePrincipalSecret", + "clientId": "name", + "principalId": "id" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json new file mode 100644 index 000000000000..b85bfd26ae2e --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutConnector.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "properties": { + "authInfo": { + "authType": "secret" + }, + "secretStore": { + "keyVaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/test-kv" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json new file mode 100644 index 000000000000..65e6713bb9c6 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutDryrun.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "dryrunName": "dryrunName", + "parameters": { + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/dryruns/dryrunName", + "type": "Microsoft.ServiceLinker/dryruns", + "name": "dryrunName", + "properties": { + "parameters": { + "actionName": "createOrUpdate", + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db" + }, + "authInfo": { + "authType": "secret", + "name": "name" + } + }, + "prerequisiteResults": [ + { + "type": "basicError", + "code": "ResourceNotFound", + "message": "Target resource is not found" + }, + { + "type": "permissionsMissing", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc", + "permissions": [ + "Microsoft.DocumentDb/databaseAccounts/write" + ] + } + ], + "operationPreviews": [ + { + "name": "configFirewallRule", + "operationType": "configNetwork", + "description": "Config firewall rule for target service to allow source service access", + "action": "Microsoft.DocumentDb/databaseAccounts/write", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc" + } + ], + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json new file mode 100644 index 000000000000..f678acb875be --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/PutLinker.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName", + "parameters": { + "properties": { + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "authInfo": { + "authType": "secret", + "name": "name", + "secretInfo": { + "secretType": "rawValue", + "value": "secret" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceLinker/links", + "name": "linkName", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app/providers/Microsoft.ServiceLinker/links/linkName", + "properties": { + "authInfo": { + "authType": "secret", + "name": "name" + }, + "vNetSolution": { + "type": "serviceEndpoint" + }, + "targetService": { + "type": "AzureResource", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DBforPostgreSQL/servers/test-pg/databases/test-db" + } + } + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json new file mode 100644 index 000000000000..a2e570267b75 --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateConnectorSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "location": "westus", + "connectorName": "connectorName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json new file mode 100644 index 000000000000..3bb0f31ce67f --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/examples/ValidateLinkerSuccess.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-01-preview", + "resourceUri": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Web/sites/test-app", + "linkerName": "linkName" + }, + "responses": { + "200": { + "body": { + "properties": { + "isConnectionAvailable": true, + "reportStartTimeUtc": "2020-07-12T22:05:09Z", + "reportEndTimeUtc": "2020-07-12T22:06:09Z", + "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "targetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.DocumentDb/databaseAccounts/test-acc/mongodbDatabases/test-db", + "authType": "secret", + "validationDetail": [ + { + "name": "TargetExistence", + "description": "The target existence is validated", + "result": "success" + }, + { + "name": "TargetNetworkAccess", + "description": "Deny public network access is set to yes. Please confirm you are using private endpoint connection to access target resource.", + "result": "warning" + } + ] + } + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json new file mode 100644 index 000000000000..3be7908389ae --- /dev/null +++ b/specification/servicelinker/resource-manager/Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json @@ -0,0 +1,2937 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.ServiceLinker", + "description": "Microsoft.ServiceLinker provider", + "version": "2024-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ConnectorDryrunList": { + "$ref": "./examples/ConnectorDryrunList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "ConnectorDryrunGet": { + "$ref": "./examples/ConnectorDryrunGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Connector" + ], + "operationId": "Connector_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunCreate": { + "$ref": "./examples/ConnectorDryrunCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_UpdateDryrun", + "description": "update a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ConnectorDryrunUpdate": { + "$ref": "./examples/ConnectorDryrunUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "ConnectorDryrunDelete": { + "$ref": "./examples/ConnectorDryrunDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors": { + "get": { + "deprecated": false, + "description": "Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.", + "operationId": "Connector_List", + "x-ms-examples": { + "ConnectorList": { + "$ref": "./examples/ConnectorList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}": { + "get": { + "description": "Returns Connector resource for a given name.", + "operationId": "Connector_Get", + "x-ms-examples": { + "Connector": { + "$ref": "./examples/Connectors.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connector details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Connector resource.", + "operationId": "Connector_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutConnector": { + "$ref": "./examples/PutConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Connector.", + "x-ms-examples": { + "DeleteConnector": { + "$ref": "./examples/DeleteConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Connector is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Connector is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Update", + "description": "Operation to update an existing Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchConnector": { + "$ref": "./examples/PatchConnector.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connector details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Connector.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "202": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/validate": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_Validate", + "description": "Validate a Connector.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateConnectorSuccess": { + "$ref": "./examples/ValidateConnectorSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceLinker/locations/{location}/connectors/{connectorName}/generateConfigurations": { + "post": { + "tags": [ + "Connector" + ], + "operationId": "Connector_GenerateConfigurations", + "description": "Generate configurations for a Connector.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/GenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ConnectorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers": { + "get": { + "deprecated": false, + "description": "Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.", + "operationId": "Linker_List", + "x-ms-examples": { + "LinkerList": { + "$ref": "./examples/LinkerList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/ResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}": { + "get": { + "description": "Returns Linker resource for a given name.", + "operationId": "Linker_Get", + "x-ms-examples": { + "Linker": { + "$ref": "./examples/Linker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "Linker details.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Create or update Linker resource.", + "operationId": "Linker_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutLinker": { + "$ref": "./examples/PutLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerResource" + } + } + ], + "responses": { + "200": { + "description": "Successful.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Delete a Linker.", + "x-ms-examples": { + "DeleteLinker": { + "$ref": "./examples/DeleteLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The Linker is deleted." + }, + "202": { + "description": "Long running operation." + }, + "204": { + "description": "Deleted. The Linker is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Update", + "description": "Operation to update an existing Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchLinker": { + "$ref": "./examples/PatchLinker.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Linker details.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LinkerPatch" + } + } + ], + "responses": { + "200": { + "description": "Success. The response describes a Linker.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "201": { + "description": "Long running operation.", + "schema": { + "$ref": "#/definitions/LinkerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/validateLinker": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_Validate", + "description": "Validate a Linker.", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ValidateLinkerSuccess": { + "$ref": "./examples/ValidateLinkerSuccess.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateOperationResult" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/listConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linker_ListConfigurations", + "description": "list source configurations for a Linker.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/GetConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDryrun", + "description": "list dryrun jobs", + "x-ms-examples": { + "ListDryrun": { + "$ref": "./examples/ListDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/dryruns/{dryrunName}": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GetDryrun", + "description": "get a dryrun job", + "x-ms-examples": { + "GetDryrun": { + "$ref": "./examples/GetDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_CreateDryrun", + "description": "create a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PutDryrun": { + "$ref": "./examples/PutDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunResource" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "201": { + "description": "Long running operation", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_UpdateDryrun", + "description": "add a dryrun job to do necessary check before actual creation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "PatchDryrun": { + "$ref": "./examples/PatchDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "description": "dryrun resource.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DryrunPatch" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DryrunResource" + } + }, + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_DeleteDryrun", + "description": "delete a dryrun job", + "x-ms-examples": { + "DeleteDryrun": { + "$ref": "./examples/DeleteDryrun.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dryrunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of dryrun.", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The job is deleted." + }, + "204": { + "description": "Deleted. The job is not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/generateConfigurations": { + "post": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_GenerateConfigurations", + "description": "Generate configurations for a Linker.", + "x-ms-examples": { + "GenerateConfiguration": { + "$ref": "./examples/LinkerGenerateConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LinkerNameParameter" + }, + { + "name": "parameters", + "description": "Connection Info, including format, secret store, etc", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ConfigurationInfo" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.ServiceLinker/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists the available ServiceLinker REST API operations.", + "x-ms-examples": { + "GetConfiguration": { + "$ref": "./examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.ServiceLinker/configurationNames": { + "get": { + "tags": [ + "ConfigurationNames" + ], + "operationId": "ConfigurationNames_List", + "description": "Lists the configuration names generated by Service Connector for all target, client types, auth types.", + "x-ms-examples": { + "GetConfigurationNames": { + "$ref": "./examples/ConfigurationNamesList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter options." + }, + { + "name": "$skipToken", + "in": "query", + "required": false, + "type": "string", + "description": "OData skipToken option for pagination." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConfigurationNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.ServiceLinker/daprConfigurations": { + "get": { + "tags": [ + "Linkers" + ], + "operationId": "Linkers_ListDaprConfigurations", + "description": "List the dapr configuration supported by Service Connector.", + "x-ms-examples": { + "GetDaprConfigurations": { + "$ref": "./examples/GetDaprConfigurations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DaprConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TargetServiceType": { + "description": "The target service type.", + "type": "string", + "enum": [ + "AzureResource", + "ConfluentBootstrapServer", + "ConfluentSchemaRegistry", + "SelfHostedServer", + "FabricPlatform" + ], + "x-ms-enum": { + "name": "targetServiceType", + "modelAsString": true + } + }, + "TargetServiceBase": { + "description": "The target service properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The target service type.", + "$ref": "#/definitions/TargetServiceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResourceType": { + "description": "The azure resource type.", + "type": "string", + "enum": [ + "KeyVault", + "AppConfig" + ], + "x-ms-enum": { + "name": "azureResourceType", + "modelAsString": true + } + }, + "AzureResourcePropertiesBase": { + "description": "The azure resource properties", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "description": "The azure resource type.", + "$ref": "#/definitions/AzureResourceType" + } + }, + "required": [ + "type" + ] + }, + "AzureResource": { + "x-ms-discriminator-value": "AzureResource", + "type": "object", + "description": "The azure resource info when target service type is AzureResource", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "id": { + "description": "The Id of azure resource.", + "type": "string" + }, + "resourceProperties": { + "x-nullable": true, + "description": "The azure resource connection related properties.", + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + } + }, + "AzureKeyVaultProperties": { + "x-ms-discriminator-value": "KeyVault", + "type": "object", + "description": "The resource properties when type is Azure Key Vault", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectAsKubernetesCsiDriver": { + "x-nullable": true, + "description": "True if connect via Kubernetes CSI Driver.", + "type": "boolean" + } + } + }, + "AzureAppConfigProperties": { + "x-ms-discriminator-value": "AppConfig", + "type": "object", + "description": "The resource properties when type is Azure App Configuration", + "allOf": [ + { + "$ref": "#/definitions/AzureResourcePropertiesBase" + } + ], + "properties": { + "connectWithKubernetesExtension": { + "x-nullable": true, + "description": "True if connection enables app configuration kubernetes extension.", + "type": "boolean" + } + } + }, + "ConfluentBootstrapServer": { + "x-ms-discriminator-value": "ConfluentBootstrapServer", + "type": "object", + "description": "The service properties when target service type is ConfluentBootstrapServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "FabricPlatform": { + "x-ms-discriminator-value": "FabricPlatform", + "type": "object", + "description": "The service properties when target service type is FabricPlatform", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "SelfHostedServer": { + "x-ms-discriminator-value": "SelfHostedServer", + "type": "object", + "description": "The service properties when target service type is SelfHostedServer", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "ConfluentSchemaRegistry": { + "x-ms-discriminator-value": "ConfluentSchemaRegistry", + "type": "object", + "description": "The service properties when target service type is ConfluentSchemaRegistry", + "allOf": [ + { + "$ref": "#/definitions/TargetServiceBase" + } + ], + "properties": { + "endpoint": { + "description": "The endpoint of service.", + "type": "string" + } + } + }, + "DeleteOrUpdateBehavior": { + "description": "The cleanup behavior to indicate whether clean up operation when resource is deleted or updated", + "type": "string", + "enum": [ + "Default", + "ForcedCleanup" + ], + "x-ms-enum": { + "name": "DeleteOrUpdateBehavior", + "modelAsString": true + } + }, + "ClientType": { + "description": "The application client type", + "type": "string", + "enum": [ + "none", + "dotnet", + "java", + "python", + "go", + "php", + "ruby", + "django", + "nodejs", + "springBoot", + "kafka-springBoot", + "jms-springBoot", + "dapr" + ], + "x-ms-enum": { + "name": "clientType", + "modelAsString": true + } + }, + "AuthType": { + "description": "The authentication type.", + "type": "string", + "enum": [ + "systemAssignedIdentity", + "userAssignedIdentity", + "servicePrincipalSecret", + "servicePrincipalCertificate", + "secret", + "accessKey", + "userAccount", + "easyAuthMicrosoftEntraID" + ], + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true + } + }, + "SecretType": { + "description": "The secret type.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecretUri", + "keyVaultSecretReference" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "SecretSourceType": { + "description": "The type of secret source.", + "type": "string", + "enum": [ + "rawValue", + "keyVaultSecret" + ], + "x-ms-enum": { + "name": "SecretSourceType", + "modelAsString": true + } + }, + "SecretInfoBase": { + "description": "The secret info", + "discriminator": "secretType", + "type": "object", + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + } + }, + "required": [ + "secretType" + ] + }, + "ValueSecretInfo": { + "x-ms-discriminator-value": "rawValue", + "type": "object", + "description": "The secret info when type is rawValue. It's for scenarios that user input the secret.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "x-nullable": true, + "description": "The actual value of the secret.", + "type": "string", + "x-ms-secret": true + } + } + }, + "KeyVaultSecretReferenceSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretReference", + "type": "object", + "description": "The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "name": { + "description": "Name of the Key Vault secret.", + "type": "string" + }, + "version": { + "x-nullable": true, + "description": "Version of the Key Vault secret.", + "type": "string" + } + } + }, + "KeyVaultSecretUriSecretInfo": { + "x-ms-discriminator-value": "keyVaultSecretUri", + "type": "object", + "description": "The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App.", + "allOf": [ + { + "$ref": "#/definitions/SecretInfoBase" + } + ], + "properties": { + "value": { + "description": "URI to the keyvault secret", + "type": "string" + } + } + }, + "AuthInfoBase": { + "description": "The authentication info", + "discriminator": "authType", + "type": "object", + "properties": { + "authType": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "authMode": { + "description": "Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth.", + "$ref": "#/definitions/AuthMode" + } + }, + "required": [ + "authType" + ] + }, + "AccessKeyInfoBase": { + "description": "The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage", + "x-ms-discriminator-value": "accessKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "permissions": { + "description": "Permissions of the accessKey. `Read` and `Write` are for Azure Cosmos DB and Azure App Configuration, `Listen`, `Send` and `Manage` are for Azure Event Hub and Azure Service Bus.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Read", + "Write", + "Listen", + "Send", + "Manage" + ], + "x-ms-enum": { + "name": "accessKeyPermissions", + "modelAsString": true + } + } + } + } + }, + "DatabaseAadAuthInfo": { + "description": "The extra auth info required by Database AAD authentication.", + "type": "object", + "properties": { + "userName": { + "x-nullable": true, + "description": "Username created in the database which is mapped to a user in AAD.", + "type": "string" + } + } + }, + "SecretAuthInfo": { + "x-ms-discriminator-value": "secret", + "type": "object", + "description": "The authentication info when authType is secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "name": { + "x-nullable": true, + "description": "Username or account name for secret auth.", + "type": "string" + }, + "secretInfo": { + "x-nullable": true, + "description": "Password or key vault secret for secret auth.", + "$ref": "#/definitions/SecretInfoBase" + } + } + }, + "UserAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "userAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is userAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "Client Id for userAssignedIdentity.", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription id for userAssignedIdentity.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "SystemAssignedIdentityAuthInfo": { + "x-ms-discriminator-value": "systemAssignedIdentity", + "type": "object", + "description": "The authentication info when authType is systemAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure role to be assigned" + } + } + }, + "ServicePrincipalSecretAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalSecret", + "type": "object", + "description": "The authentication info when authType is servicePrincipal secret", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "clientId": { + "description": "ServicePrincipal application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "secret": { + "description": "Secret for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "secret" + ] + }, + "ServicePrincipalCertificateAuthInfo": { + "x-ms-discriminator-value": "servicePrincipalCertificate", + "type": "object", + "description": "The authentication info when authType is servicePrincipal certificate", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for servicePrincipal auth.", + "type": "string" + }, + "principalId": { + "description": "Principal Id for servicePrincipal auth.", + "type": "string" + }, + "certificate": { + "description": "ServicePrincipal certificate for servicePrincipal auth.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + }, + "required": [ + "clientId", + "principalId", + "certificate" + ] + }, + "UserAccountAuthInfo": { + "x-ms-discriminator-value": "userAccount", + "type": "object", + "description": "The authentication info when authType is user account", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + }, + { + "$ref": "#/definitions/DatabaseAadAuthInfo" + } + ], + "properties": { + "principalId": { + "description": "Principal Id for user account.", + "type": "string" + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional, this value specifies the Azure roles to be assigned. Automatically " + } + } + }, + "EasyAuthMicrosoftEntraIDAuthInfo": { + "x-ms-discriminator-value": "easyAuthMicrosoftEntraID", + "type": "object", + "description": "The authentication info when authType is EasyAuth Microsoft Entra ID", + "allOf": [ + { + "$ref": "#/definitions/AuthInfoBase" + } + ], + "properties": { + "clientId": { + "description": "Application clientId for EasyAuth Microsoft Entra ID.", + "type": "string" + }, + "secret": { + "description": "Application Secret for EasyAuth Microsoft Entra ID.", + "type": "string", + "x-ms-secret": true + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "LinkerResource": { + "type": "object", + "description": "Linker of source and target resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "The properties of the Linker.", + "$ref": "#/definitions/LinkerProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "x-nullable": true, + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/systemData", + "description": "The system data." + } + } + }, + "LinkerPatch": { + "description": "A Linker to be updated.", + "type": "object", + "properties": { + "properties": { + "description": "Linker properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LinkerProperties" + } + } + }, + "ResourceList": { + "description": "The list of Linker.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The Linker used to get the next page of Linker list.", + "type": "string" + }, + "value": { + "description": "The list of Linkers.", + "type": "array", + "items": { + "$ref": "#/definitions/LinkerResource" + } + } + } + }, + "LinkerProperties": { + "description": "The properties of the Linker.", + "type": "object", + "properties": { + "targetService": { + "$ref": "#/definitions/TargetServiceBase", + "description": "The target service properties" + }, + "authInfo": { + "description": "The authentication type.", + "$ref": "#/definitions/AuthInfoBase" + }, + "clientType": { + "description": "The application client type", + "$ref": "#/definitions/ClientType" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + }, + "vNetSolution": { + "x-nullable": true, + "description": "The VNet solution.", + "$ref": "#/definitions/VNetSolution" + }, + "secretStore": { + "x-nullable": true, + "description": "An option to store secret value in secure place", + "$ref": "#/definitions/SecretStore" + }, + "scope": { + "x-nullable": true, + "type": "string", + "description": "connection scope in source service." + }, + "publicNetworkSolution": { + "x-nullable": true, + "description": "The network solution.", + "$ref": "#/definitions/PublicNetworkSolution" + }, + "configurationInfo": { + "x-nullable": true, + "description": "The connection information consumed by applications, including secrets, connection strings.", + "$ref": "#/definitions/ConfigurationInfo" + } + } + }, + "LinkerConfigurationType": { + "description": "Type of configuration to determine whether the configuration can be modified after creation. KeyvaultSecret means the configuration references a key vault secret, such as App Service/ACA key vault reference. Default means the configuration is real value, such as user name, raw secret, etc.", + "type": "string", + "enum": [ + "Default", + "KeyVaultSecret" + ], + "x-ms-enum": { + "name": "LinkerConfigurationType", + "modelAsString": true + } + }, + "SourceConfiguration": { + "description": "A configuration item for source resource", + "type": "object", + "properties": { + "name": { + "description": "The name of setting.", + "type": "string" + }, + "value": { + "x-nullable": true, + "description": "The value of setting", + "type": "string" + }, + "configType": { + "description": "The type of setting", + "readOnly": true, + "$ref": "#/definitions/LinkerConfigurationType" + }, + "keyVaultReferenceIdentity": { + "x-nullable": true, + "description": "The identity for key vault reference, system or user-assigned managed identity ID", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "Descriptive information for the configuration", + "type": "string" + } + } + }, + "ConfigurationNameItem": { + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConfigurationNames" + } + } + }, + "ConfigurationNames": { + "type": "object", + "description": "The configuration names which will be set based on specific target resource, client type, auth type.", + "properties": { + "targetService": { + "type": "string", + "description": "The target service provider name and resource name." + }, + "clientType": { + "$ref": "#/definitions/ClientType", + "description": "The client type for configuration names." + }, + "authType": { + "$ref": "#/definitions/AuthType", + "description": "The auth type." + }, + "secretType": { + "$ref": "#/definitions/SecretSourceType", + "description": "Indicates where the secrets in configuration from. Used when secrets are from Keyvault." + }, + "daprProperties": { + "description": "Deprecated, please use #/definitions/DaprConfigurationList instead", + "$ref": "#/definitions/DaprProperties" + }, + "names": { + "type": "array", + "description": "The configuration names to be set in compute service environment.", + "items": { + "$ref": "#/definitions/ConfigurationName" + } + } + } + }, + "ConfigurationName": { + "type": "object", + "description": "The configuration names.", + "properties": { + "value": { + "type": "string" + }, + "description": { + "type": "string", + "description": "Description for the configuration name." + }, + "required": { + "type": "boolean", + "description": "Represent the configuration is required or not" + } + } + }, + "ConfigurationNameResult": { + "description": "Configuration Name list which will be set based on different target resource, client type, auth type.", + "type": "object", + "properties": { + "value": { + "description": "Expected configuration names for each target service.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationNameItem" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "ConfigurationResult": { + "description": "Configurations for source resource, include appSettings, connectionString and serviceBindings", + "type": "object", + "properties": { + "configurations": { + "description": "The configuration properties for source resource.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidateOperationResult": { + "description": "The validation operation result for a Linker.", + "type": "object", + "properties": { + "properties": { + "x-nullable": true, + "description": "The validation result detail.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ValidateResult" + }, + "resourceId": { + "x-nullable": true, + "description": "Validated Linker id.", + "type": "string" + }, + "status": { + "x-nullable": true, + "description": "Validation operation status.", + "type": "string" + } + } + }, + "ValidateResult": { + "description": "The validation result for a Linker.", + "type": "object", + "properties": { + "linkerName": { + "x-nullable": true, + "description": "The linker name.", + "type": "string" + }, + "isConnectionAvailable": { + "x-nullable": true, + "description": "A boolean value indicating whether the connection is available or not", + "type": "boolean" + }, + "reportStartTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The start time of the validation report." + }, + "reportEndTimeUtc": { + "x-nullable": true, + "type": "string", + "format": "date-time", + "description": "The end time of the validation report." + }, + "sourceId": { + "x-nullable": true, + "description": "The resource id of the Linker source application.", + "type": "string" + }, + "targetId": { + "x-nullable": true, + "description": "The resource Id of target service.", + "type": "string" + }, + "authType": { + "x-nullable": true, + "description": "The authentication type.", + "$ref": "#/definitions/AuthType" + }, + "validationDetail": { + "description": "The detail of validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationResultItem" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ValidationResultItem": { + "description": "The validation item for a Linker.", + "type": "object", + "properties": { + "name": { + "description": "The validation item name.", + "type": "string" + }, + "description": { + "x-nullable": true, + "description": "The display name of validation item", + "type": "string" + }, + "result": { + "x-nullable": true, + "description": "The result of validation", + "type": "string", + "enum": [ + "success", + "failure", + "warning" + ], + "x-ms-enum": { + "name": "ValidationResultStatus", + "modelAsString": true + } + }, + "errorMessage": { + "x-nullable": true, + "description": "The error message of validation result", + "type": "string" + }, + "errorCode": { + "x-nullable": true, + "description": "The error code of validation result", + "type": "string" + } + } + }, + "VNetSolution": { + "type": "object", + "description": "The VNet solution for linker", + "properties": { + "type": { + "x-nullable": true, + "description": "Type of VNet solution.", + "type": "string", + "enum": [ + "serviceEndpoint", + "privateLink" + ], + "x-ms-enum": { + "name": "vNetSolutionType", + "modelAsString": true + } + }, + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + } + } + }, + "PublicNetworkSolution": { + "type": "object", + "description": "Indicates public network solution, include firewall rules", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration.", + "$ref": "#/definitions/ActionType" + }, + "firewallRules": { + "description": "Describe firewall rules of target service to make sure source application could connect to the target.", + "$ref": "#/definitions/FirewallRules" + } + } + }, + "FirewallRules": { + "type": "object", + "description": "Target service's firewall rules. to allow connections from source service.", + "properties": { + "ipRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account." + }, + "azureServices": { + "description": "Allow Azure services to access the target service if true.", + "$ref": "#/definitions/AllowType" + }, + "callerClientIP": { + "description": "Allow caller client IP to access the target service if true. the property is used when connecting local application to target service.", + "$ref": "#/definitions/AllowType" + } + } + }, + "ConfigurationInfo": { + "type": "object", + "description": "The configuration information, used to generate configurations or save to applications", + "properties": { + "deleteOrUpdateBehavior": { + "description": "Indicates whether to clean up previous operation when Linker is updating or deleting", + "$ref": "#/definitions/DeleteOrUpdateBehavior" + }, + "action": { + "description": "Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source.", + "$ref": "#/definitions/ActionType" + }, + "customizedKeys": { + "description": "Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "daprProperties": { + "description": "Indicates some additional properties for dapr client type", + "$ref": "#/definitions/DaprProperties" + }, + "additionalConfigurations": { + "description": "A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "additionalConnectionStringProperties": { + "description": "A dictionary of additional properties to be added in the end of connection string.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "configurationStore": { + "x-nullable": true, + "description": "An option to store configuration into different place", + "$ref": "#/definitions/ConfigurationStore" + } + } + }, + "ConfigurationStore": { + "type": "object", + "description": "An option to store configuration into different place", + "properties": { + "appConfigurationId": { + "x-nullable": true, + "type": "string", + "description": "The app configuration id to store configuration" + } + } + }, + "DaprProperties": { + "type": "object", + "description": "Indicates some additional properties for dapr client type", + "properties": { + "version": { + "x-nullable": true, + "type": "string", + "description": "The dapr component version" + }, + "componentType": { + "x-nullable": true, + "type": "string", + "description": "The dapr component type" + }, + "secretStoreComponent": { + "x-nullable": true, + "type": "string", + "description": "The name of a secret store dapr to retrieve secret" + }, + "metadata": { + "description": "Additional dapr metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scopes": { + "description": "The dapr component scopes", + "type": "array", + "items": { + "type": "string" + } + }, + "runtimeVersion": { + "x-nullable": true, + "type": "string", + "readOnly": true, + "description": "The runtime version supported by the properties" + }, + "bindingComponentDirection": { + "x-nullable": true, + "type": "string", + "enum": [ + "input", + "output" + ], + "x-ms-enum": { + "name": "DaprBindingComponentDirection", + "modelAsString": true + }, + "readOnly": true, + "description": "The direction supported by the dapr binding component" + } + } + }, + "DaprMetadata": { + "description": "The dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "The secret name where dapr could get value", + "type": "string" + }, + "description": { + "description": "The description of the metadata, returned from configuration api", + "type": "string" + }, + "required": { + "description": "The value indicating whether the metadata is required or not", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "DaprMetadataRequired", + "modelAsString": true + } + } + } + }, + "SecretStore": { + "type": "object", + "description": "An option to store secret value in secure place", + "properties": { + "keyVaultId": { + "x-nullable": true, + "type": "string", + "description": "The key vault id to store secret" + }, + "keyVaultSecretName": { + "x-nullable": true, + "type": "string", + "description": "The key vault secret name to store secret, only valid when storing one secret" + } + } + }, + "DryrunList": { + "description": "The list of dryrun.", + "type": "object", + "properties": { + "nextLink": { + "x-nullable": true, + "description": "The link used to get the next page of dryrun list.", + "type": "string" + }, + "value": { + "description": "The list of dryrun.", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunResource" + } + } + } + }, + "DryrunResource": { + "type": "object", + "description": "a dryrun job resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource", + "description": "The resource model definition for an Azure Resource Manager proxy resource." + } + ], + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunPatch": { + "type": "object", + "description": "a dryrun job to be updated.", + "properties": { + "properties": { + "description": "The properties of the dryrun job.", + "$ref": "#/definitions/DryrunProperties", + "x-ms-client-flatten": true + } + } + }, + "DryrunProperties": { + "description": "The properties of the dryrun job", + "type": "object", + "properties": { + "parameters": { + "description": "The parameters of the dryrun", + "$ref": "#/definitions/DryrunParameters" + }, + "prerequisiteResults": { + "readOnly": true, + "description": "the result of the dryrun", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunPrerequisiteResult" + }, + "x-ms-identifiers": [] + }, + "operationPreviews": { + "readOnly": true, + "description": "the preview of the operations for creation", + "type": "array", + "items": { + "$ref": "#/definitions/DryrunOperationPreview" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + } + } + }, + "DryrunActionName": { + "description": "The name of action for you dryrun job.", + "type": "string", + "enum": [ + "createOrUpdate" + ], + "x-ms-enum": { + "name": "DryrunActionName", + "modelAsString": true + } + }, + "DryrunParameters": { + "description": "The parameters of the dryrun", + "discriminator": "actionName", + "type": "object", + "properties": { + "actionName": { + "$ref": "#/definitions/DryrunActionName" + } + }, + "required": [ + "actionName" + ] + }, + "CreateOrUpdateDryrunParameters": { + "x-ms-discriminator-value": "createOrUpdate", + "type": "object", + "description": "The dryrun parameters for creation or update a linker", + "allOf": [ + { + "$ref": "#/definitions/DryrunParameters" + }, + { + "$ref": "#/definitions/LinkerProperties" + } + ] + }, + "DryrunPrerequisiteResultType": { + "description": "The type of dryrun result.", + "type": "string", + "enum": [ + "basicError", + "permissionsMissing" + ], + "x-ms-enum": { + "name": "DryrunPrerequisiteResultType", + "modelAsString": true + } + }, + "DryrunPrerequisiteResult": { + "description": "A result of dryrun", + "discriminator": "type", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/DryrunPrerequisiteResultType" + } + }, + "required": [ + "type" + ] + }, + "BasicErrorDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "basicError", + "description": "The represent of basic error", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "PermissionsMissingDryrunPrerequisiteResult": { + "x-ms-discriminator-value": "permissionsMissing", + "description": "The represent of missing permissions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DryrunPrerequisiteResult" + } + ], + "properties": { + "scope": { + "description": "The permission scope", + "type": "string" + }, + "permissions": { + "description": "The permission list", + "type": "array", + "items": { + "type": "string" + } + }, + "recommendedRole": { + "description": "The recommended role to resolve permissions missing", + "type": "string" + } + } + }, + "DryrunOperationPreview": { + "description": "The preview of the operations for creation", + "type": "object", + "properties": { + "name": { + "description": "The operation name", + "type": "string" + }, + "operationType": { + "description": "The operation type", + "type": "string", + "enum": [ + "configConnection", + "configNetwork", + "configAuth" + ], + "x-ms-enum": { + "name": "DryrunPreviewOperationType", + "modelAsString": true + } + }, + "description": { + "description": "The description of the operation", + "type": "string" + }, + "action": { + "description": "The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format", + "type": "string" + }, + "scope": { + "description": "The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview", + "type": "string" + } + } + }, + "ActionType": { + "description": "Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration.", + "type": "string", + "enum": [ + "enable", + "optOut" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "AuthMode": { + "description": "Indicates how to apply the authentication configuration operations.", + "type": "string", + "enum": [ + "optInAllAuth", + "optOutAllAuth" + ], + "x-ms-enum": { + "name": "authMode", + "modelAsString": true, + "values": [ + { + "value": "optInAllAuth", + "description": "Default authentication configuration according to the authentication type." + }, + { + "value": "optOutAllAuth", + "description": "Skip all authentication configuration such as enabling managed identity and granting RBAC roles" + } + ] + } + }, + "AllowType": { + "description": "Whether to allow firewall rules.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "allowType", + "modelAsString": true + } + }, + "DaprConfigurationList": { + "description": "Dapr configuration list supported by Service Connector", + "type": "object", + "properties": { + "value": { + "description": "The list of dapr configurations", + "type": "array", + "items": { + "$ref": "#/definitions/DaprConfigurationResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprConfigurationResource": { + "description": "Represent one resource of the dapr configuration list", + "type": "object", + "properties": { + "properties": { + "description": "The properties of the dapr configuration.", + "$ref": "#/definitions/DaprConfigurationProperties", + "x-ms-client-flatten": true + } + } + }, + "DaprConfigurationProperties": { + "type": "object", + "properties": { + "targetType": { + "type": "string", + "description": "Supported target resource type, extract from resource id, uppercase" + }, + "authType": { + "$ref": "#/definitions/AuthType" + }, + "daprProperties": { + "$ref": "#/definitions/DaprProperties" + } + } + } + }, + "parameters": { + "LinkerNameParameter": { + "name": "linkerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name Linker resource.", + "x-ms-parameter-location": "method" + }, + "ConnectorNameParameter": { + "name": "connectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of resource.", + "x-ms-parameter-location": "method" + }, + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified Azure Resource manager identifier of the resource to be connected.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicelinker/resource-manager/readme.md b/specification/servicelinker/resource-manager/readme.md index 96b6eb39a705..7d8caa630389 100644 --- a/specification/servicelinker/resource-manager/readme.md +++ b/specification/servicelinker/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ServiceLinker. title: ServiceLinkerManagementClient openapi-type: arm openapi-subtype : rpaas -tag: package-2023-04-01-preview +tag: package-2024-07-01-preview ``` ### Tag: package-2021-11-01-preview @@ -85,6 +85,15 @@ input-file: - Microsoft.ServiceLinker/stable/2024-04-01/servicelinker.json ``` +### Tag: package-2024-07-01-preview + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01-preview' +input-file: + - Microsoft.ServiceLinker/preview/2024-07-01-preview/servicelinker.json +``` + ## Suppression ``` yaml From 701ad5a0ab92105df6a35110f87fc146f91aeb00 Mon Sep 17 00:00:00 2001 From: abhi580 <43762309+abhi580@users.noreply.github.com> Date: Fri, 27 Sep 2024 11:32:23 +0530 Subject: [PATCH 004/101] Abhi580 migrate microsoft.migrate nonbreaking 2023 05 01 preview (#28274) * Adds base for updating Microsoft.Migrate/AssessmentProjects from version preview/2023-04-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * added 2023-05-01-preview changes * added prettierchecks * added prettier checks 2 * added ANF changed * handled failed checks * handled comments 2 * added supressions * fixed relative path for suppression * added final changes * fixed prettier checks * added Enum changes * added supreesion for additionalProperty and provisionaing State * added supression for UnSupportedPatchProperties * handled arm comments * changed totalStorage to float in avsSummary * added vcf BYOL changes * removed external storage ri example * fixed prettier checks * added supression for lintdiff * added final changes and handled comments * added error code fixes * fixed readme --- ...smentOperations_Create_MaximumSet_Gen.json | 146 + ...smentOperations_Delete_MaximumSet_Gen.json | 15 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 25 + ...sessmentOperations_Get_MaximumSet_Gen.json | 65 + ...istByAssessmentProject_MaximumSet_Gen.json | 73 + ...sClusterOperations_Get_MaximumSet_Gen.json | 54 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 59 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 47 + ...sOptionsOperations_Get_MaximumSet_Gen.json | 38 + ...istByAssessmentProject_MaximumSet_Gen.json | 42 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 63 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 67 + ...MachinesOperations_Get_MaximumSet_Gen.json | 129 + ...tions_ListByAssessment_MaximumSet_Gen.json | 137 + ...tabaseV2Operations_Get_MaximumSet_Gen.json | 225 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 233 + ...stanceV2Operations_Get_MaximumSet_Gen.json | 474 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 505 + ...MachinesOperations_Get_MaximumSet_Gen.json | 155 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 163 + ...edEntityOperations_Get_MaximumSet_Gen.json | 330 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 330 + ...WebAppV2Operations_Get_MaximumSet_Gen.json | 63 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 71 + ...licationOperations_Get_MaximumSet_Gen.json | 73 + ...ns_ListByAksAssessment_MaximumSet_Gen.json | 81 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 3079 ++ ...istByAssessmentProject_MaximumSet_Gen.json | 3083 ++ ...tSummaryOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...jectsOperations_Create_MaximumSet_Gen.json | 144 + ...jectsOperations_Delete_MaximumSet_Gen.json | 14 + ...ProjectsOperations_Get_MaximumSet_Gen.json | 69 + ...ns_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...ons_ListBySubscription_MaximumSet_Gen.json | 72 + ...jectsOperations_Update_MaximumSet_Gen.json | 88 + ...mentsOperations_Create_MaximumSet_Gen.json | 236 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 103 + ...Operations_ListByGroup_MaximumSet_Gen.json | 107 + ...MachinesOperations_Get_MaximumSet_Gen.json | 81 + ...ns_ListByAvsAssessment_MaximumSet_Gen.json | 89 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 184 + ...istByAssessmentProject_MaximumSet_Gen.json | 188 + ...mentsOperations_Create_MaximumSet_Gen.json | 326 + ...mentsOperations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...essmentsOperations_Get_MaximumSet_Gen.json | 148 + ...Operations_ListByGroup_MaximumSet_Gen.json | 152 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 269 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 273 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 291 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 295 + ...rations_CompareSummary_MaximumSet_Gen.json | 185 + ...sCaseOperations_Create_MaximumSet_Gen.json | 410 + ...sCaseOperations_Delete_MaximumSet_Gen.json | 15 + ...s_GetReportDownloadUrl_MaximumSet_Gen.json | 25 + ...nessCaseOperations_Get_MaximumSet_Gen.json | 151 + ...istByAssessmentProject_MaximumSet_Gen.json | 155 + ...wSummaryOperations_Get_MaximumSet_Gen.json | 123 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 127 + ...sSummaryOperations_Get_MaximumSet_Gen.json | 252 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 256 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...MachinesOperations_Get_MaximumSet_Gen.json | 40 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 48 + ...EntitiesOperations_Get_MaximumSet_Gen.json | 41 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 49 + ...dWebAppsOperations_Get_MaximumSet_Gen.json | 38 + ...ons_ListByBusinessCase_MaximumSet_Gen.json | 46 + ...roupsOperations_Create_MaximumSet_Gen.json | 85 + ...roupsOperations_Delete_MaximumSet_Gen.json | 15 + .../GroupsOperations_Get_MaximumSet_Gen.json | 44 + ...istByAssessmentProject_MaximumSet_Gen.json | 48 + ...rations_UpdateMachines_MaximumSet_Gen.json | 58 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 62 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 33 + ...istByAssessmentProject_MaximumSet_Gen.json | 37 + ...MachinesOperations_Get_MaximumSet_Gen.json | 89 + ...istByAssessmentProject_MaximumSet_Gen.json | 97 + .../Operations_List_MaximumSet_Gen.json | 28 + ...ctionOperations_Delete_MaximumSet_Gen.json | 15 + ...nnectionOperations_Get_MaximumSet_Gen.json | 39 + ...istByAssessmentProject_MaximumSet_Gen.json | 43 + ...ctionOperations_Update_MaximumSet_Gen.json | 76 + ...ResourceOperations_Get_MaximumSet_Gen.json | 37 + ...istByAssessmentProject_MaximumSet_Gen.json | 41 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 1635 + ...istByAssessmentProject_MaximumSet_Gen.json | 1639 + ...entV2Operations_Create_MaximumSet_Gen.json | 219 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 94 + ...Operations_ListByGroup_MaximumSet_Gen.json | 254 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 128 + ..._ListBySqlAssessmentV2_MaximumSet_Gen.json | 132 + ...ectorOperations_Create_MaximumSet_Gen.json | 97 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...ctorsOperations_Create_MaximumSet_Gen.json | 98 + ...ctorsOperations_Delete_MaximumSet_Gen.json | 15 + ...llectorsOperations_Get_MaximumSet_Gen.json | 45 + ...istByAssessmentProject_MaximumSet_Gen.json | 49 + ...tOptionsOperations_Get_MaximumSet_Gen.json | 56 + ...istByAssessmentProject_MaximumSet_Gen.json | 60 + ...entV2Operations_Create_MaximumSet_Gen.json | 167 + ...entV2Operations_Delete_MaximumSet_Gen.json | 16 + ...Operations_DownloadUrl_MaximumSet_Gen.json | 26 + ...ssmentV2Operations_Get_MaximumSet_Gen.json | 70 + ...Operations_ListByGroup_MaximumSet_Gen.json | 74 + ...2SummaryOperations_Get_MaximumSet_Gen.json | 61 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 65 + ...ectorOperations_Create_MaximumSet_Gen.json | 99 + ...ectorOperations_Delete_MaximumSet_Gen.json | 15 + ...ollectorOperations_Get_MaximumSet_Gen.json | 46 + ...istByAssessmentProject_MaximumSet_Gen.json | 50 + ...cePlanV2Operations_Get_MaximumSet_Gen.json | 52 + ...stByWebAppAssessmentV2_MaximumSet_Gen.json | 60 + .../preview/2023-05-01-preview/migrate.json | 24820 ++++++++++++++++ .../migrate/resource-manager/readme.md | 32 + .../resource-manager/suppressions.yaml | 7 + 133 files changed, 46864 insertions(+) create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json create mode 100644 specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json create mode 100644 specification/migrate/resource-manager/suppressions.yaml diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0d418f94535 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,146 @@ +{ + "title": "AksAssessmentOperations_Create", + "operationId": "AksAssessmentOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "resource": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a6797bf0e74c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "AksAssessmentOperations_Delete", + "operationId": "AksAssessmentOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..65bcf8c345e3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "AksAssessmentOperations_DownloadUrl", + "operationId": "AksAssessmentOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "vthjjfdenyh", + "expirationTime": "2023-11-07T06:51:25.205Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..379b0af21ae4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "AksAssessmentOperations_Get", + "operationId": "AksAssessmentOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..eb1d3d3c010f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AksAssessmentOperations_ListByAssessmentProject", + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "polt", + "$top": 5, + "$filter": "azekdtdhupdngbqxzdppicwf", + "totalRecordCount": 18, + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "category": "All", + "savingsOptions": "None", + "consolidation": "Full", + "pricingTier": "Standard", + "azureLocation": "Unknown", + "environmentType": "Unknown", + "licensingProgram": "Default", + "currency": "Unknown", + "discountPercentage": 15, + "sizingCriteria": "PerformanceBased", + "performanceData": { + "timeRange": "Day", + "perfDataStartTime": "2023-11-07T06:51:24.320Z", + "perfDataEndTime": "2023-11-07T06:51:24.320Z", + "percentile": "Percentile50" + }, + "scalingFactor": 3 + }, + "details": { + "webAppCount": 25, + "webServerCount": 29, + "machineCount": 15, + "totalMonthlyCost": 1, + "pricesTimestamp": "2023-11-07T06:51:24.320Z", + "confidenceRatingInPercentage": 1, + "createdTimestamp": "2023-11-07T06:51:24.320Z", + "updatedTimestamp": "2023-11-07T06:51:24.320Z", + "status": "Created" + }, + "scope": { + "serverGroupId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/groups/testgrp" + }, + "provisioningState": "Unknown" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment", + "name": "testaksassessment", + "type": "AKSAssessment", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c6a658b3732 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "AksClusterOperations_Get", + "operationId": "AksClusterOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "clusterName": "testaksassessment-cluster" + }, + "responses": { + "200": { + "body": { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..44c2cc38ac41 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,59 @@ +{ + "title": "AksClusterOperations_ListByAksAssessment", + "operationId": "AksClusterOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "sfmesuqkmjezolfjvalm", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "name": "testaksassessment-cluster", + "nodePools": [ + { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 1, + "podCount": 1, + "monthlyCost": 10, + "podApproxMonthlyCost": 10 + } + ], + "region": "Unknown", + "userNodePoolCount": 0, + "userNodeCount": 6, + "systemNodePoolCount": 16, + "systemNodeCount": 18, + "podCount": 26, + "monthlyCost": 14 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/clusters/testaksassessment-cluster", + "name": "testaksassessment-cluster", + "type": "AKSAssessmentCluster", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..237b9ac37848 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "AksCostDetailOperations_ListByAksAssessment", + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "$filter": "ww", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "clusterName": "testaksassessment-cluster", + "mode": "User", + "osType": "Linux", + "armSkuName": "StandardDS_v2", + "nodeCount": 16, + "podCount": 7, + "monthlyCost": 6, + "podApproxMonthlyCost": 27 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/costDetails/testaksassessmentCostDetail", + "name": "testaksassessmentCostDetail", + "type": "AKSAssessmentCostDetail", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ae168b3c0e76 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "AksOptionsOperations_Get", + "operationId": "AksOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..4294d53b5da0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "AksOptionsOperations_ListByAssessmentProject", + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "edges": { + "AKS": { + "AzureLocation": [ + "EastAsia" + ] + } + } + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessmentOptions/default", + "name": "default", + "type": "AKSAssessmentOptions", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..604a335908a9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AksSummaryOperations_Get", + "operationId": "AksSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "summaryName": "AKS" + }, + "responses": { + "200": { + "body": { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..c081413b984b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,67 @@ +{ + "title": "AksSummaryOperations_ListByAksAssessment", + "operationId": "AksSummaryOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "aksAssessmentSummary": { + "skuSummary": { + "StandardDS_v2": { + "count": 17, + "monthlyCost": 18 + } + }, + "webAppSummary": { + "IIS": { + "count": 17, + "monthlyCost": 18 + } + }, + "webServerSummary": { + "IIS": 13 + }, + "webAppCount": 19, + "webServerCount": 28, + "machineCount": 17, + "totalMonthlyCost": 6 + }, + "assessmentName": "testaksassessment", + "summaryName": "testaksassessmentsummary", + "suitabilityPerTarget": { + "AKS": { + "Ready": 11 + } + }, + "monthlyComputeCost": 8, + "monthlyStorageCost": 26, + "confidenceScore": 7 + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentProjects/testproject/aksAssessments/testaksassessment/summaries/AKS", + "name": "AKS", + "type": "AKSAssessmentSummary", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0fcdfdae30f3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,129 @@ +{ + "title": "AssessedMachinesOperations_Get", + "operationId": "AssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "projectName": "pavqtntysjn", + "groupName": "smawqdmhfngray", + "assessmentName": "qjlumxyqsitd", + "assessedMachineName": "oqxjeheiipjmuo" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..579f4b0d2fcf --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json @@ -0,0 +1,137 @@ +{ + "title": "AssessedMachinesOperations_ListByAssessment", + "operationId": "AssessedMachinesOperations_ListByAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D8E1C413-E65F-40C0-8A7E-743D6B7A6AE9", + "resourceGroupName": "rgopenapi", + "$filter": "sbkdovsfqldhdb", + "pageSize": 10, + "continuationToken": "hbyseetshbplfkjmpjhsiurqgt", + "totalRecordCount": 25, + "projectName": "sloqixzfjk", + "groupName": "kjuepxerwseq", + "assessmentName": "rhzcmubwrrkhtocsibu" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing", + "recommendedDiskSize": "StandardSSD_E10", + "recommendedDiskType": "StandardSSD", + "gigabytesForRecommendedDiskSize": 17, + "recommendDiskThroughputInMbps": 13, + "recommendedDiskIops": 7, + "monthlyStorageCost": 5, + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 8, + "megabytesPerSecondOfRead": 9, + "megabytesPerSecondOfWrite": 29, + "numberOfReadOperationsPerSecond": 12, + "numberOfWriteOperationsPerSecond": 28 + } + }, + "monthlyUltraStorageCost": 11, + "hostProcessor": { + "name": "Intel(R) Xeon(R) Gold 5220R CPU @ 2.20GHz", + "numberOfSockets": 2, + "numberOfCoresPerSocket": 24 + }, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 273.792, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 14.88, + "description": null + } + ], + "monthlyBandwidthCost": 4, + "monthlyStorageCost": 10, + "monthlyPremiumStorageCost": 6, + "monthlyStandardSsdStorageCost": 4, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "NotApplicable", + "suitabilityExplanation": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "monthlyBandwidthCosts": 4, + "netGigabytesTransmittedPerMonth": 6, + "displayName": "VM Network", + "macAddress": "00:50:56:95:98:e8", + "ipAddresses": [ + "2404:f801:4800:1c:c4c2:1cd:7154:a028" + ], + "megabytesPerSecondReceived": 10, + "megabytesPerSecondTransmitted": 24 + } + }, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "recommendedSize": "Standard_F4s_v2", + "numberOfCoresForRecommendedSize": 8, + "megabytesOfMemoryForRecommendedSize": 27, + "monthlyComputeCostForRecommendedSize": 1, + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "PercentageOfCoresUtilizedMissing", + "type": "AssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T09:14:13.8168575Z", + "updatedTimestamp": "2023-09-26T09:14:13.8168575Z", + "displayName": "SQLTestDBVM28", + "description": null, + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_50150976-65ec-de99-1b54-a52710c3066e", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 21, + "numberOfCores": 7, + "confidenceRatingInPercentage": 14, + "percentageCoresUtilization": 24, + "percentageMemoryUtilization": 5, + "suitability": "Suitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1/assessedMachines/50fa865c-8c5c-4371-b7eb-5b900d7f9451", + "name": "riigi", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments/assessedMachines", + "systemData": { + "createdBy": "jsfqnyqqwykkv", + "createdByType": "sakanwar", + "createdAt": "2023-09-26T12:46:17.892Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T12:46:17.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..916961c77ed7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,225 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_Get", + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlDatabaseName": "858eb860-9e07-417c-91b6-bca1bffb3bf5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..d1a70164a4c1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,233 @@ +{ + "title": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DatabaseName,'adv130'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlDatabases/858eb860-9e07-417c-91b6-bca1bffb3bf5", + "name": "858eb860-9e07-417c-91b6-bca1bffb3bf5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlDatabases", + "properties": { + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "bufferCacheSizeInMB": 18.875576036866359, + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 1024.0, + "predictedDataSizeInMB": 10.0, + "predictedLogSizeInMB": 5.0, + "cores": 2, + "azureSqlTargetType": "AzureSqlDatabase" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 118.999824, + "monthlyStorageCost": 0.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "DatabaseCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsDatabaseStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.01" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.005" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "Finance_User10", + "objectType": "SqlDatabase" + } + ] + } + ] + }, + "isDatabaseHighlyAvailable": false, + "linkedAvailabilityGroupOverview": null, + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "assessedSqlInstanceArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "machineName": "SQLHAVM17", + "instanceName": "MSSQLSERVER", + "databaseName": "Finance_User10", + "databaseSizeInMB": 15.0, + "compatibilityLevel": "CompatLevel120", + "sqlDatabaseSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqldatabases/ea92ba27-3656-5370-8bcc-e5eed9d7ba5e", + "percentageCoresUtilization": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.8572031Z", + "updatedTimestamp": "2023-09-08T05:22:36.4665924Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b98abfa180da --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,474 @@ +{ + "title": "AssessedSqlInstanceV2Operations_Get", + "operationId": "AssessedSqlInstanceV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlInstanceName": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "name": "3c6574cf-b4e1-4fdc-93db-6bbcc570dda2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "logDiskSizes": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.56 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 32.94432, + "monthlyStorageCost": 3.12, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigratePrimaryReplicaAndAllOtherReplicasToIaaS", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "2 PremiumSSD(P2)" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "memoryInUseInMB": 4096.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "BusinessCritical", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 32768.0, + "predictedDataSizeInMB": 112.0, + "predictedLogSizeInMB": 112.0, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 475.999296, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [ + { + "reasoningId": "InstanceCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "0.109" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "1024" + } + ] + }, + { + "reasoningId": "MeetsAlwaysOnInstanceReplicaRequirementWithoutSecondaries", + "reasoningString": null, + "reasoningCategory": "AlwaysOnAG", + "contextParameters": [ + { + "contextKey": "AlwaysOnDatabaseServiceTier", + "contextValue": "BusinessCritical" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "BusinessCritical" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 833.165424, + "monthlyStorageCost": 24.69, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 112.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": { + "numberOfSynchronousReadReplicas": 0, + "numberOfSynchronousNonReadReplicas": 0, + "numberOfAsynchronousReadReplicas": 0, + "numberOfAsynchronousNonReadReplicas": 0, + "numberOfPrimaryReplicas": 6 + }, + "isClustered": false, + "isHighAvailabilityEnabled": true, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedWithWarningsForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "1" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "36.06432" + } + ] + } + ], + "sizingCriterion": "AsOnPremises", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/machines/184b8433-6991-45db-9f57-3dd3f6397a60", + "machineName": "SQLAGVM02", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/13c17b85-8842-4d50-a640-df0e45e56670", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 2, + "percentageCoresUtilization": 100.0, + "logicalDisks": [ + { + "diskId": "s:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "l:", + "diskSizeInMB": 104.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "diskId": "c:", + "diskSizeInMB": 16.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 6, + "totalDatabaseSizeInMB": 224.0, + "largestDatabaseSizeInMB": 144.0, + "totalDiscoveredUserDatabases": 7 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-09-08T05:22:34.9353438Z", + "updatedTimestamp": "2023-09-08T05:22:35.9666076Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e43e084aedc9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,505 @@ +{ + "title": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/groups/test_paas_pref_grp_2812/sqlAssessments/test_train_250823/assessedSqlInstances/27b94796-026e-4278-a546-664d46977c0a", + "name": "27b94796-026e-4278-a546-664d46977c0a", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlInstances", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.2 + } + ], + "logDiskSizes": [ + { + "diskType": "Premium", + "diskSize": "Premium_P3", + "diskRedundancy": "LRS", + "storageCost": 2.4 + } + ], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 26.361408, + "monthlyStorageCost": 3.6, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsVirtualMachineCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "0" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOPSRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineUncachedDiskIOPSAvailableInIOPerSec", + "contextValue": "3200" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "VirtualMachineIOThroughputRequiredInInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "VirtualMachineIOThroughputUncachedAvailableInIOPerSec", + "contextValue": "48" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "1 PremiumSSD_P2,1 PremiumSSD_P3" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "memoryInUseInMB": 0.0, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": { + "azureSqlServiceTier": "GeneralPurpose", + "azureSqlComputeTier": "Provisioned", + "azureSqlHardwareGeneration": "Gen5", + "storageMaxSizeInMB": 65536.0, + "predictedDataSizeInMB": 6696.25, + "predictedLogSizeInMB": 14220.125, + "cores": 4, + "azureSqlTargetType": "AzureSqlManagedInstance" + }, + "replicaAzureSqlSku": [], + "sharedResources": { + "sharedDataDisks": [], + "sharedLogDisks": [], + "sharedTempDbDisks": [], + "numberOfMounts": 0, + "quorumWitness": null + }, + "monthlyComputeCost": 199.999104, + "monthlyStorageCost": 3.68, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToMI", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "MeetsInstanceCpuScalingFactorRequirement", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "CoreUtilizationPercentage", + "contextValue": "0" + }, + { + "contextKey": "AllocatedCores", + "contextValue": "4" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "4" + } + ] + }, + { + "reasoningId": "MeetsInstanceStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "TotalStorageConsumedByDataFilesInGB", + "contextValue": "6.539" + }, + { + "contextKey": "TotalStorageConsumedByLogFilesInGB", + "contextValue": "13.887" + }, + { + "contextKey": "TotalRecommendedStorageInGB", + "contextValue": "64" + }, + { + "contextKey": "IncrementsInStorageInGB", + "contextValue": "32" + }, + { + "contextKey": "MaxAvailableStorageInGB", + "contextValue": "2048" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOThroughputRequirement", + "reasoningString": null, + "reasoningCategory": "ThroughputType", + "contextParameters": [ + { + "contextKey": "InstanceLevelThroughputRequiredInMBPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelThroughputAvailableInMBPerSec", + "contextValue": "10" + } + ] + }, + { + "reasoningId": "MeetsInstanceIOPSDataLogRequirement", + "reasoningString": null, + "reasoningCategory": "IOPSType", + "contextParameters": [ + { + "contextKey": "InstanceLevelIOPSRequiredInIOPerSec", + "contextValue": "0" + }, + { + "contextKey": "InstanceLevelIOPSAvailableInIOPerSec", + "contextValue": "6000" + } + ] + }, + { + "reasoningId": "MeetsProvisionedComputeTierRequirement", + "reasoningString": null, + "reasoningCategory": "ComputeTier", + "contextParameters": [ + { + "contextKey": "ComputeTier", + "contextValue": "Provisioned" + } + ] + }, + { + "reasoningId": "MeetsServiceTierRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "ServiceTier", + "contextValue": "GeneralPurpose" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 1199.994624, + "monthlyStorageCost": 7.13, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 15.0, + "description": null + } + ], + "securitySuitability": "Suitable", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "MigrateDataFromSourceSqlServerToDB", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "ServerCredentials", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "accessibilitytestdiag917", + "objectType": "ServerCredential" + } + ] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + } + ] + }, + "storageTypeBasedDetails": [ + { + "storageType": "Rows", + "diskSizeInMB": 6696.25, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + }, + { + "storageType": "Log", + "diskSizeInMB": 14220.125, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 34, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2021-07-13T00:00:00Z", + "extendedSupportEndDate": "2026-07-14T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "fciMetadata": null, + "availabilityReplicaSummary": null, + "isClustered": false, + "isHighAvailabilityEnabled": false, + "recommendedTargetReasonings": [ + { + "reasoningId": "RecommendedForSQLVM", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "MigrationIssuesCount", + "contextValue": "0" + }, + { + "contextKey": "MigrationWarningsCount", + "contextValue": "0" + }, + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "RecommendedCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "RecommendedCost", + "contextValue": "29.961408" + } + ] + }, + { + "reasoningId": "SQLMICost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLMICost", + "contextValue": "203.679104" + } + ] + }, + { + "reasoningId": "SQLDBCost", + "reasoningString": null, + "reasoningCategory": "RecommendedTargetReasoning", + "contextParameters": [ + { + "contextKey": "SQLDBCost", + "contextValue": "1207.124624" + } + ] + } + ], + "sizingCriterion": "PerformanceBased", + "machineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/dhlodhiccy/providers/Microsoft.Migrate/assessmentprojects/dhccy30279project/machines/daf51245-560b-4caa-9c18-5409ab93d319", + "machineName": "SQLTestDBVM46", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/dhlodhiccy/providers/microsoft.offazure/mastersites/dhccy37819mastersite/sqlsites/dhccy37819sqlsites/sqlservers/a5a6441d-9f63-463e-a720-73fecd90a2e4", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2016", + "numberOfCoresAllocated": 4, + "percentageCoresUtilization": 0.0, + "logicalDisks": [ + { + "diskId": "d:", + "diskSizeInMB": 20916.375, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + ], + "databaseSummary": { + "numberOfUserDatabases": 12, + "totalDatabaseSizeInMB": 20916.375, + "largestDatabaseSizeInMB": 20815.0, + "totalDiscoveredUserDatabases": 12 + }, + "confidenceRatingInPercentage": 0.0, + "createdTimestamp": "2023-08-25T09:20:24.5544874Z", + "updatedTimestamp": "2023-08-25T09:20:25.2195402Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..a7fca64bc148 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "AssessedSqlMachinesOperations_Get", + "operationId": "AssessedSqlMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "assessedSqlMachineName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..06215da53218 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,163 @@ +{ + "title": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/DisplayName,'SQLHAVM17'))", + "pageSize": 23, + "totalRecordCount": 1, + "continuationToken": null, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines/cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "name": "cc64c9dc-b38e-435d-85ad-d509df5d92c6", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/assessedSqlMachines", + "properties": { + "biosGuid": null, + "fqdn": null, + "sqlInstances": [ + { + "instanceId": "291313e5-e25f-4b6b-9f21-165a2dd03650", + "instanceName": "MSSQLSERVER", + "sqlInstanceSdsArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/mastersites/fci-ankit-test6065mastersite/sqlsites/fci-ankit-test6065sqlsites/sqlservers/291313e5-e25f-4b6b-9f21-165a2dd03650", + "sqlInstanceEntityId": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlFciState": "Active" + } + ], + "suitabilityDetail": "PercentageOfCoresUtilizedMissing, PercentageOfMemoryUtilizedMissing", + "suitabilityExplanation": "NotApplicable", + "recommendedVmSize": "Standard_D2as_v4", + "recommendedVmFamily": "Dasv4_series", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Mainstream", + "eta": 64, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2024-01-09T00:00:00Z", + "extendedSupportEndDate": "2029-01-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "recommendedVmSizeNumberOfCores": 2, + "recommendedVmSizeMegabytesOfMemory": 8192.0, + "monthlyComputeCost": 32.94432, + "disks": { + "6000C293-381c-8460-c29b-ef937230e629": { + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "suitabilityDetail": "NumberOfReadOperationsPerSecondMissing, NumberOfWriteOperationsPerSecondMissing, MegabytesPerSecondOfReadMissing, MegabytesPerSecondOfWriteMissing", + "recommendedDiskSize": "Premium_P10", + "recommendedDiskType": "Premium", + "recommendedDiskSizeGigabytes": 128, + "recommendDiskThroughputInMbps": 100.0, + "recommendedDiskIops": 500.0, + "monthlyStorageCost": 19.71, + "name": "6000C293-381c-8460-c29b-ef937230e629", + "displayName": "scsi0:0", + "gigabytesProvisioned": 100.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0 + } + }, + "networkAdapters": { + "4000": { + "suitability": "Suitable", + "suitabilityDetail": "MegabytesOfDataTransmittedMissing, MegabytesOfDataRecievedMissing", + "suitabilityExplanation": "NotApplicable", + "monthlyBandwidthCosts": 0.0, + "netGigabytesTransmittedPerMonth": 0.0, + "name": "4000", + "displayName": "VM Network", + "macAddress": "00:50:56:82:b7:83", + "ipAddresses": [ + "2404:f801:4800:20:418c:eec9:86c5:aea1", + "2404:f801:4800:20:6113:238d:17f0:b246", + "10.150.91.119", + "10.150.91.138", + "10.150.91.139" + ], + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "monthlyBandwidthCost": 0.0, + "monthlyStorageCost": 19.71, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "migrationGuidelines": [ + { + "guidelineId": "MigrateNodeSinceItHasActiveFCIInstance", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "UseSharedDiskWitnessForWSFCIfNeeded", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ReconfigureAnyAvailabilityGroupsAfterMigration", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "sizingCriterion": "PerformanceBased", + "type": "SqlAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2019 (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-08T05:22:34.8416411Z", + "updatedTimestamp": "2023-09-08T05:23:39.1749465Z", + "displayName": "SQLHAVM17", + "description": "", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/bansalankit-rg/providers/microsoft.offazure/vmwaresites/fci-ankit-test6904site/machines/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa_5002fdf3-5889-c2f8-86e5-3119b251331b", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/VMwareSites/fci-ankit-test6904site/vcenters/10-150-91-150-202bfa1a-ad9f-414f-91ff-61f5ca0540aa", + "datacenterManagementServerName": "10.150.91.150", + "megabytesOfMemory": 4096.0, + "numberOfCores": 2, + "confidenceRatingInPercentage": 0.0, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "Suitable" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlMachines?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvANYGbAopzgkAAAAAAg%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65551%23QCF%3a8%23FPC%3aASnOCQAAAAACO84JAAAAAAI%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D9CD673390%22%2c%22max%22%3a%2205C1DFFFFFFFF4%22%7d%7d%5d&totalRecordCount=19" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1bb7d4898f01 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_Get", + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "recommendedAssessedEntityName": "cc64c9dc-b38e-435d-85ad-d509df5d92c6" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..348298f89a97 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,330 @@ +{ + "title": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "$filter": "(contains(Properties/InstanceName,'MSSQLSERVER'))", + "pageSize": 23, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "name": "b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/recommendedAssessedEntities", + "properties": { + "azureSqlVMSuitabilityDetails": { + "azureSqlSku": { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + }, + "replicaAzureSqlSku": [ + { + "virtualMachineSize": { + "azureVmFamily": "Dasv4_series", + "cores": 2, + "azureSkuName": "Standard_D2as_v4", + "availableCores": 2, + "maxNetworkInterfaces": 0 + }, + "dataDiskSizes": [], + "logDiskSizes": [], + "azureSqlTargetType": "AzureSqlVirtualMachine" + } + ], + "sharedResources": { + "sharedDataDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedLogDisks": [ + { + "recommendedSizeInGib": 8.0, + "recommendedThroughputInMbps": 25.0, + "recommendedIops": 120.0, + "diskType": "Premium", + "diskSize": "Premium_P2", + "diskRedundancy": "LRS", + "storageCost": 1.6380000000000001 + } + ], + "sharedTempDbDisks": [], + "numberOfMounts": 2, + "quorumWitness": { + "quorumWitnessType": "Disk" + } + }, + "monthlyComputeCost": 65.88864, + "monthlyStorageCost": 3.276, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": true, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [ + { + "guidelineId": "ProvisionInstanceAsFciOnSqlVM", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionDisksBasedOnLayoutInSku", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "ProvisionSharedDiskForQuorum", + "migrationGuidelineCategory": "FailoverCluterInstanceGuideLine", + "migrationGuidelineContext": [] + }, + { + "guidelineId": "MigrateNonReplicatedDatabasesAndAutoSeedSecondaryIfNeeded", + "migrationGuidelineCategory": "AvailabilityGroupGuideline", + "migrationGuidelineContext": [] + } + ], + "recommendationReasonings": [ + { + "reasoningId": "VirtualMachineCpuScalingFactorRequirementUnavailable", + "reasoningString": null, + "reasoningCategory": "CpuType", + "contextParameters": [ + { + "contextKey": "AllocatedCores", + "contextValue": "2" + }, + { + "contextKey": "TargetCoresRecommended", + "contextValue": "2" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineMemoryRequirement", + "reasoningString": null, + "reasoningCategory": "MemoryType", + "contextParameters": [ + { + "contextKey": "BufferPoolSizeInGB", + "contextValue": "4" + }, + { + "contextKey": "RAMRecommendedInGB", + "contextValue": "8" + } + ] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCIDiskWitness", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "AlwaysOnVirtualMachineFCISharedZRSDisks", + "reasoningString": null, + "reasoningCategory": "AlwaysOnFCI", + "contextParameters": [] + }, + { + "reasoningId": "MeetsVirtualMachineStorageRequirement", + "reasoningString": null, + "reasoningCategory": "StorageType", + "contextParameters": [ + { + "contextKey": "CommaSeperatedManagedDisks", + "contextValue": "" + } + ] + }, + { + "reasoningId": "MeetsVirtualMachineFamilyRequirement", + "reasoningString": null, + "reasoningCategory": "ServiceTier", + "contextParameters": [ + { + "contextKey": "VirtualMachineSize", + "contextValue": "standardDASv4Family" + } + ] + } + ], + "migrationTargetPlatform": "AzureSqlVirtualMachine", + "suitability": "Suitable", + "migrationIssues": [ + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "machineName": "FC7-SQL2K14.FPL.COM", + "instanceName": "MSSQLSERVER", + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 9, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2019-07-09T00:00:00Z", + "extendedSupportEndDate": "2024-07-09T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear2EndDate": "0001-01-01T00:00:00", + "extendedSecurityUpdateYear3EndDate": "0001-01-01T00:00:00" + }, + "dbCount": 217, + "discoveredDBCount": 217, + "hasScanOccurred": true, + "recommendedAzureSqlTargetType": "AzureSqlVirtualMachine", + "recommendedSuitability": "SuitableForSqlVM", + "azureSqlMISuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 0.0, + "monthlyStorageCost": 0.0, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlManagedInstance", + "suitability": "NotSuitable", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "SkuNotFound", + "issueCategory": "Issue", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "azureSqlDBSuitabilityDetails": { + "azureSqlSku": null, + "replicaAzureSqlSku": [], + "sharedResources": null, + "monthlyComputeCost": 25822.9618079999, + "monthlyStorageCost": 149.73, + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 0.0, + "description": null + } + ], + "securitySuitability": "Unknown", + "shouldProvisionReplicas": false, + "skuReplicationMode": "NotApplicable", + "migrationGuidelines": [], + "recommendationReasonings": [], + "migrationTargetPlatform": "AzureSqlDatabase", + "suitability": "ReadinessUnknown", + "migrationIssues": [ + { + "issueId": "SuitabilityReportMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerformanceDataMissing", + "issueCategory": "Internal", + "impactedObjects": [] + }, + { + "issueId": "PerfBasedFallbackToAsOnPremises", + "issueCategory": "Warning", + "impactedObjects": [ + { + "objectName": "MSSQLSERVER", + "objectType": "SqlInstance" + } + ] + } + ] + }, + "assessedSqlEntityArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/assessedSqlInstances/b11d90cc-b528-49e4-aac2-1c9a53209f8e", + "isClustered": true, + "isHighAvailabilityEnabled": true, + "sqlEdition": "Enterprise Edition: Core-based Licensing (64-bit)", + "sqlVersion": "SQL Server 2014", + "sizingCriterion": "AsOnPremises" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/recommendedAssessedEntities?api-version=2023-05-01-preview&pageSize=1&continuationToken=%5b%7b%22token%22%3a%22%2bRID%3a%7eOHlvAMMvEvMxeAsAAAAABQ%3d%3d%23RT%3a1%23TRC%3a1%23ISV%3a2%23IEO%3a65567%23QCF%3a8%23FPC%3aATF4CwAAAAAFRXgLAAAAAAU%3d%22%2c%22range%22%3a%7b%22min%22%3a%2205C1D32F43775C%22%2c%22max%22%3a%2205C1DFFFFFFFFC%22%7d%7d%5d&totalRecordCount=21" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6f7c1705b8a6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,63 @@ +{ + "title": "AssessedWebAppV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "assessedWebAppName": "webapp1" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-001-azureappservice", + "suitability": "Suitable", + "securitySuitability": "Unknown", + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1" + }, + "migrationIssues": [ + { + "issueId": "AppPoolIdentityCheck", + "issueCategory": "Info", + "issueDescriptionList": [ + "SpecificUser (SharePoint - 80), SpecificUser (SecurityTokenServiceApplicationPool)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice,plan-001-azureappservicecontainer", + "machineName": "a404-r1w28r2-1", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "100%WebSite", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/aa096c1b26cd80dd76e547d61d722d04e1779a9c8d95ae1baa91bdb226eb5c3d-9e55bf838a799e058f7c0478ff1029d5224456ab0a1c30f3a8779ba7bb841e88", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5037cd30-828f-f362-c62c-d1715b8ede4c", + "confidenceRatingInPercentage": null, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/assessedWebApps/e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "name": "e1c05a87-93c7-4b01-bf19-a4db9bf791a8", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..e04d18b4ae19 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,71 @@ +{ + "title": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "", + "pageSize": 23, + "continuationToken": "pwqummugahjguraaqqssuwmxic", + "totalRecordCount": 6, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "akgugrp2", + "assessmentName": "assess1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "targetSpecificResult": { + "azureAppService": { + "assessmentResult": { + "appServicePlanName": "plan-003-azureappservicecontainer", + "suitability": "ConditionallySuitable", + "securitySuitability": "Suitable", + "webAppSkuName": "Premium_V3", + "webAppSkuSize": "P1 v3" + }, + "migrationIssues": [ + { + "issueId": "AuthCheckContainer", + "issueCategory": "Info", + "issueDescriptionList": [ + "windowsAuthentication (/)" + ] + } + ] + } + }, + "appServicePlanName": "plan-001-azureappservice", + "machineName": "windows-2k16", + "serverArmId": null, + "webServerName": "IIS Server", + "webAppName": "Microsoft Azure Migrate App Containerization", + "discoveredWebAppId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/mastersites/sumukk-ccy-bcs9880mastersite/webappsites/sumukk-ccy-bcs9880webappsites/iiswebapplications/70c2efd9345164750ddf889a474512530466d8f7aaa85052b59a73ff6a4d41b1-ae625d98de8e57d253ae9812590de37f17f382bcd47da01c2f3f9be5350ae98e", + "discoveredMachineId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sumukk-ccy-bcs/providers/microsoft.offazure/vmwaresites/sumukk-ccy-bcs4557site/machines/idclab-vcen67-fareast-corp-micr-49743448-0440-4c6b-8300-eec352b87e73_5015ed4a-5f13-8cd3-a4d4-1ec729e836ff", + "confidenceRatingInPercentage": 11, + "createdTimestamp": "2023-11-03T05:42:51.551Z", + "updatedTimestamp": "2023-11-03T05:42:51.551Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/akgugrp2/webAppAssessments/akgutestappsvc2/assessedWebApps/2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "name": "2d4423e1-9b0d-466f-a2f1-4f68adaa3c76", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/assessedWebApps", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..ce2fec0cc3a0 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessedWebApplicationOperations_Get", + "operationId": "AssessedWebApplicationOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "projectName": "testproject", + "assessmentName": "testaksassessment", + "assessedWorkload": "testaksassessmentapp" + }, + "responses": { + "200": { + "body": { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..51daadff6ff7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AssessedWebApplicationOperations_ListByAksAssessment", + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA", + "resourceGroupName": "rgaksswagger", + "continuationToken": "gjilveslqiowaembajtj", + "$top": 13, + "$filter": "zqvpvrpvghjnxamq", + "totalRecordCount": 23, + "projectName": "testproject", + "assessmentName": "testaksassessment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "suitabilityResult": { + "readiness": "Unknown", + "suitability": "NotSuitable", + "failedChecks": [ + { + "name": "check", + "behavior": "Issue", + "description": "check", + "cause": "check", + "recommendation": "upgrade IIS version", + "moreInfo": { + "title": "title", + "url": "https://www.bing.com" + } + } + ], + "suggestedMigrationTool": "None" + }, + "recommendationResult": { + "request": { + "cores": 12, + "memory": 28 + }, + "limit": { + "cores": 18, + "memory": 13 + }, + "osType": "Linux", + "clusterName": "testaksassessment-cluster", + "nodePoolId": "testaksassessmentCostDetail", + "nodePoolName": "testaksassessmentCostDetail", + "nodePoolArmSkuName": "StandardDS_v2", + "approxMonthlyCost": 3 + }, + "discoveryArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webApps/webapp", + "displayName": "webapp", + "webServerArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/webServers/webserver", + "webServerDisplayName": "webserver", + "machineArmId": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourcegroups/testrg/providers/microsoft.offazure/vmwaresites/testsite/machines/machine", + "machineDisplayName": "machine", + "webAppType": "IIS" + }, + "eTag": "00000000-0000-0000-a616-12d4724c01d9", + "id": "/subscriptions/D6F60DF4-CE70-4E39-8217-B8FBE7CA85AA/resourceGroups/rgaksswagger/providers/Microsoft.Migrate/assessmentprojects/testproject/aksAssessments/testaksassessment/assessedWebApps/testaksassessmentapp", + "name": "testaksassessmentapp", + "type": "AssessedWebApplication", + "systemData": { + "createdBy": "User", + "createdByType": "User", + "createdAt": "2023-11-07T06:51:24.108Z", + "lastModifiedBy": "User", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-07T06:51:24.108Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4bf59fede16d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,3079 @@ +{ + "title": "AssessmentOptionsOperations_Get", + "operationId": "AssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..85fd43eb9807 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,3083 @@ +{ + "title": "AssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "fhodvffhuoqwbysrrqbizete" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmFamilies": [ + { + "familyName": "Basic_A0_A4", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Standard_A0_A7", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Av2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "D_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized" + ] + }, + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "DC_Series", + "targetLocations": [ + "EastUs", + "WestEurope" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage", + "Confidential" + ] + }, + { + "familyName": "DS_series", + "targetLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "ChinaEast", + "ChinaNorth", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "DSv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ev3_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ev4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "F_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovIowa", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestIndia", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "ComputeOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "G_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "GS_series", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "CanadaEast", + "EastUs2", + "JapanEast", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "AustraliaEast", + "CentralIndia", + "CentralUs", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "UkSouth", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "StorageOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia", + "USGovIowa" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "ultraDiskVmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Dasv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dsv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Dsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Dv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Esv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Ev5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Easv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv3_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Esv4_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fs_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Fsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ] + }, + { + "familyName": "Lsv2_series", + "targetLocations": [ + "CentralIndia", + "GermanyWestCentral", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Msv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovVirginia" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "BrazilSouth", + "CentralIndia", + "EastAsia", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "SouthCentralUs", + "WestUs", + "USGovArizona", + "USGovVirginia" + ] + } + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Ddsv4_series", + "Ddsv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "DC_Series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Esv5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Esv3_series", + "Esv4_series", + "Fs_series", + "Fsv2_series", + "GS_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "D_series", + "Dv2_series", + "Dadsv5_series", + "Dasv4_series", + "Dasv5_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Dsv3_series", + "Dsv4_series", + "Dsv5_series", + "Dv3_series", + "Dv4_series", + "Dv5_series", + "DS_series", + "DSv2_series", + "Edsv5_series", + "Edv5_series", + "Esv5_series", + "Ev5_series", + "Eadsv5_series", + "Easv4_series", + "Easv5_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "Esv3_series", + "Esv4_series", + "Ev3_series", + "Ev4_series", + "F_series", + "Fs_series", + "Fsv2_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "JapanEast", + "JapanWest", + "NorthCentralUs", + "NorthEurope", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "WestEurope", + "WestIndia", + "WestUs", + "AustraliaCentral", + "AustraliaCentral2", + "CanadaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "KoreaCentral", + "KoreaSouth", + "NorwayEast", + "NorwayWest", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestUs2", + "PolandCentral" + ] + }, + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/assessmentOptions/default", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..9696871525df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "AssessmentProjectSummaryOperations_Get", + "operationId": "AssessmentProjectSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project", + "projectSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..ee2e155990e9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "piyushapp1", + "projectName": "PiyushApp15328project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errorSummaryAffectedEntities": [ + { + "assessmentType": "MachineAssessment", + "count": 1 + }, + { + "assessmentType": "AvsAssessment", + "count": 2 + } + ], + "numberOfPrivateEndpointConnections": 0, + "numberOfGroups": 4, + "numberOfMachines": 4, + "numberOfImportMachines": 0, + "numberOfAssessments": 2, + "lastAssessmentTimestamp": "2023-09-15T07:23:46.901Z" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/piyushapp1/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/projectSummary/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/projectSummary", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdef" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..58f9bd54652f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,144 @@ +{ + "title": "AssessmentProjectsOperations_Create", + "operationId": "AssessmentProjectsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "resource": { + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..acd27b03c6a8 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,14 @@ +{ + "title": "AssessmentProjectsOperations_Delete", + "operationId": "AssessmentProjectsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "A926B99C-7F4C-4556-871E-20CB8C6ADB56", + "resourceGroupName": "rgmigrate", + "projectName": "zqrsyncwahgydqvwuchkfd" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cc5ab980f796 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "AssessmentProjectsOperations_Get", + "operationId": "AssessmentProjectsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..ca1d41e95a05 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "AssessmentProjectsOperations_ListByResourceGroup", + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects?api-version=2023-05-01-preview&%24skiptoken=1ZFNboMwEIXv4nWMCT9pihRVKGIXqirAASZ44joIG82YtGqUu9c9Rndv8Unfe3oP4fA7nKybWFQPcWze%2b3N9GrpmqD9EJT5DWLhSagYHBmd0IYGflTAZ%2fax4vfBIdgnWO1bFRWcA6VVmMchC717k6xb2soSizHNd7ndpqgjZrzSiIb8urBgmcF9AaiF%2ftxqJVWtH8uyvIWmtIQiogBmZ%2f9yRuuEY%2bA0WK%2b%2bRjuJDlma5THO5LcVGNHXXD132L9s%2fNwJoro0hNHG37v2ELn5Qn1vx%2fAU%3d" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..a03eb31ea4fa --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "AssessmentProjectsOperations_ListBySubscription", + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcdefg" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..52c73465808e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,88 @@ +{ + "title": "AssessmentProjectsOperations_Update", + "operationId": "AssessmentProjectsOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "properties": { + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "properties": { + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdTimestamp": "2023-09-15T07:22:18.588Z", + "updatedTimestamp": "2023-09-15T07:22:18.588Z", + "serviceEndpoint": "https://asmsrv.sea.test.migration.windowsazure.com/", + "assessmentSolutionId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "projectStatus": "Active", + "customerWorkspaceId": null, + "customerWorkspaceLocation": null, + "publicNetworkAccess": "Disabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateEndpointConnections/sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "name": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "customerStorageAccountArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Storage/storageAccounts/sakanwar1204usa", + "provisioningState": "Succeeded" + }, + "tags": { + "Migrate Project": "sakanwar-PE-SEA" + }, + "location": "southeastasia", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project", + "name": "sakanwar1204project", + "type": "Microsoft.Migrate/assessmentprojects", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..fcdc9440e53d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,236 @@ +{ + "title": "AssessmentsOperations_Create", + "operationId": "AssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "resource": { + "properties": { + "eaSubscriptionId": "kwsu", + "azurePricingTier": "Standard", + "azureStorageRedundancy": "Unknown", + "reservedInstance": "None", + "azureHybridUseBenefit": "Unknown", + "linuxAzureHybridUseBenefit": "Unknown", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 26 + }, + "groupType": "Default", + "assessmentType": "Unknown", + "azureLocation": "njxbwdtsxzhichsnk", + "azureOfferCode": "Unknown", + "currency": "Unknown", + "scalingFactor": 24, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..958ef8165c9d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AssessmentsOperations_Delete", + "operationId": "AssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..64a23188c49e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "uri/uri/uri", + "expirationTime": "2023-09-26T09:36:57.114Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..04f31ac72755 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "AssessmentsOperations_Get", + "operationId": "AssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm1" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0611cc70e56 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,107 @@ +{ + "title": "AssessmentsOperations_ListByGroup", + "operationId": "AssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentErrorSummary": {}, + "monthlyUltraStorageCost": 21, + "costComponents": [ + { + "name": "MonthlyAzureHybridCostSavings", + "value": 547.584, + "description": null + }, + { + "name": "MonthlySecurityCost", + "value": 44.64, + "description": null + } + ], + "eaSubscriptionId": null, + "azurePricingTier": "Standard", + "azureStorageRedundancy": "LocallyRedundant", + "reservedInstance": "RI3Year", + "azureHybridUseBenefit": "Yes", + "linuxAzureHybridUseBenefit": "Yes", + "azureDiskTypes": [ + "Premium", + "StandardSSD" + ], + "azureVmFamilies": [ + "D_series", + "Lsv2_series", + "M_series", + "Mdsv2_series", + "Msv2_series", + "Mv2_series" + ], + "monthlyComputeCost": 10, + "monthlyBandwidthCost": 21, + "monthlyStorageCost": 20, + "monthlyPremiumStorageCost": 13, + "monthlyStandardSsdStorageCost": 3, + "suitabilitySummary": { + "suitable": 3 + }, + "numberOfMachines": 3, + "vmUptime": { + "daysPerMonth": 13, + "hoursPerDay": 20 + }, + "distributionBySupportStatus": { + "extended": 3 + }, + "distributionByServicePackInsight": {}, + "distributionByOsName": { + "microsoft Windows Server 2016 or later (64-bit)": 3 + }, + "groupType": "Default", + "assessmentType": "MachineAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 24, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-26T09:36:48.491Z", + "perfDataEndTime": "2023-09-26T09:36:48.491Z", + "stage": "InProgress", + "discountPercentage": 6, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 28, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T09:14:05.7322406Z", + "updatedTimestamp": "2023-09-26T09:14:05.7322406Z", + "status": "Created", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1", + "name": "asm1", + "type": "Microsoft.Migrate/assessmentprojects/groups/assessments", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-26T09:36:29.583Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-26T09:36:29.583Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..044fcc80ff5d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,81 @@ +{ + "title": "AvsAssessedMachinesOperations_Get", + "operationId": "AvsAssessedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "avsAssessedMachineName": "b6d6fc6f-796f-4c16-96af-a6d22e0f12f7" + }, + "responses": { + "200": { + "body": { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c4d52535114 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "$filter": "ujmwhhuloficljxcjyc", + "pageSize": 6, + "continuationToken": "qwrjeiukbcicfrkqlqsfukfc", + "totalRecordCount": 19 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "errors": [], + "disks": { + "6000C297-455f-f81e-37b7-dc17da4433d4": { + "name": "6000C297-455f-f81e-37b7-dc17da4433d4", + "displayName": "scsi0:0", + "gigabytesProvisioned": 80.0, + "megabytesPerSecondOfRead": 0.0, + "megabytesPerSecondOfWrite": 0.0, + "numberOfReadOperationsPerSecond": 0.0, + "numberOfWriteOperationsPerSecond": 0.0, + "assessedExternalStorageType": "AnfPremium", + "estimatedDiskSizeInGB": 14, + "suitabilityDetail": "None" + } + }, + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:95:7a:57", + "ipAddresses": [ + "2404:f801:4800:25:38fe:66de:64e4:5a26", + "10.150.9.214" + ], + "displayName": "VM Network", + "megabytesPerSecondReceived": 0.0, + "megabytesPerSecondTransmitted": 0.0 + } + }, + "storageInUseGB": 0.0, + "suitabilityExplanation": "IpV6NotSupported", + "suitabilityDetail": "None", + "type": "AvsAssessedMachine", + "bootType": "BIOS", + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2016 or later (64-bit)", + "operatingSystemVersion": null, + "operatingSystemArchitecture": "X64", + "createdTimestamp": "2023-09-26T13:35:59.2324082Z", + "updatedTimestamp": "2023-09-26T13:35:59.2324082Z", + "displayName": "CustomerAE24Feb", + "description": "Microsoft Azure Migration Image on Windows Server 2016", + "datacenterMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app18700site/machines/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3_501505aa-baaa-af9d-8315-5a45209fd255", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app18700site/vcenters/idclab-vcen67-fareast-corp-micr-d991d5f4-63f1-41c3-ad6a-40253e24ffa3", + "datacenterManagementServerName": "idclab-vcen67.fareast.corp.microsoft.com", + "megabytesOfMemory": 32768.0, + "numberOfCores": 8, + "confidenceRatingInPercentage": null, + "percentageCoresUtilization": 0.0, + "percentageMemoryUtilization": 0.0, + "suitability": "ConditionallySuitable" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2/avsAssessedMachines/18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments/avsAssessedMachines", + "name": "18895660-c5e5-4247-8cfc-cd24e1fe57f3", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d4e5ae2b06e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "AvsAssessmentOptionsOperations_Get", + "operationId": "AvsAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "avsAssessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6d5f7e75d2c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,188 @@ +{ + "title": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "avsNodes": [ + { + "nodeType": "AV36", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "nodeType": "AV36P", + "targetLocations": [ + "AustraliaEast", + "CanadaCentral", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "EastUs2", + "WestUs", + "QatarCentral", + "WestEurope" + ] + }, + { + "nodeType": "AV52", + "targetLocations": [ + "WestEurope", + "UkSouth", + "EastUs2" + ] + } + ], + "avsExternalStorageTypes": [ + { + "storageType": "AnfStandard", + "targetLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + }, + { + "storageType": "AnfPremium", + "targetLocations": [ + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral" + ] + } + ], + "failuresToTolerateAndRaidLevelValues": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "reservedInstanceAvsNodes": [ + "AV36", + "AV36P", + "AV52" + ], + "reservedInstanceSupportedLocations": [ + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "JapanEast", + "JapanWest", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "FranceCentral", + "SouthAfricaNorth", + "GermanyWestCentral", + "SwedenCentral", + "WestUs2", + "QatarCentral" + ], + "reservedInstanceSupportedCurrencies": [ + "USD", + "DKK", + "CAD", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SEK", + "GBP", + "INR", + "BRL", + "TWD", + "EUR", + "CHF", + "AUD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/avsAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/{assessmentOptionsName}", + "systemData": { + "createdBy": "asd", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "tnmop", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8443a2476cc4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,326 @@ +{ + "title": "AvsAssessmentsOperations_Create", + "operationId": "AvsAssessmentsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "resource": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P", + "AV64" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "reservedInstance": "RI3Year", + "suitability": "Unknown", + "suitabilityExplanation": "Unknown", + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "isStretchClusterEnabled": true, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "status": "Created", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "avsAssessmentScenario": "NewAvsSddc", + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV52", + "AV36P" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyExternalStorageCost", + "value": 600.0, + "description": "Monthly External Storage Cost for Assessment." + }, + { + "name": "MonthlyNetworkCost", + "value": 120, + "description": "Monthly Cost of Network." + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..376b0f0cf896 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "AvsAssessmentsOperations_Delete", + "operationId": "AvsAssessmentsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..d0832a337560 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..220145e6ff94 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,148 @@ +{ + "title": "AvsAssessmentsOperations_Get", + "operationId": "AvsAssessmentsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "assessmentName": "asm2" + }, + "responses": { + "200": { + "body": { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..2914243e803b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,152 @@ +{ + "title": "AvsAssessmentsOperations_ListByGroup", + "operationId": "AvsAssessmentsOperations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "failuresToTolerateAndRaidLevel": "Unknown", + "failuresToTolerateAndRaidLevelList": [ + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt3Raid1" + ], + "vcpuOversubscription": 4.0, + "nodeType": "Unknown", + "avsAssessmentScenario": "NewAvsSddc", + "nodeTypes": [ + "AV36", + "AV36P", + "AV52" + ], + "externalStorageTypes": [ + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "isVcfByolEnabled": true, + "costComponents": [ + { + "name": "MonthlyAvsNodeCost", + "value": 9088.5, + "description": "Monthly Cost of AVS Nodes." + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": 600.0, + "description": "Monthly AVS External Storage Cost for Assessment." + }, + { + "name": "MonthlyAvsNetworkCost", + "value": 120, + "description": "Monthly AVS Cost of Network." + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": 7088.5, + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ], + "reservedInstance": "RI3Year", + "totalMonthlyCost": 9808.5, + "suitability": "Suitable", + "suitabilityExplanation": "NotApplicable", + "numberOfNodes": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 77.43, + "totalCpuCores": 108.0, + "totalRamInGB": 1728.0, + "totalStorageInGB": 48128.0, + "numberOfMachines": 3, + "avsEstimatedNodes": [ + { + "monthlyPrice": 9088.5, + "nodeType": "AV36", + "nodeNumber": 3, + "cpuUtilization": 46.3, + "ramUtilization": 12.73, + "storageUtilization": 76.99, + "totalCpu": 108.0, + "totalRam": 1728.0, + "totalStorage": 46080.0, + "pricingModel": "RI3Year", + "fttRaidLevel": "Ftt1Raid1" + } + ], + "avsEstimatedExternalStorages": [ + { + "monthlyPrice": 250.0, + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0 + }, + { + "monthlyPrice": 350.0, + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 78.0 + } + ], + "avsEstimatedNetworks": [ + { + "monthlyPrice": 120, + "networkType": "ExpressRouteUltra" + } + ], + "suitabilitySummary": { + "conditionallySuitable": 3 + }, + "memOvercommit": 1.0, + "dedupeCompression": 1.5, + "limitingFactor": "Storage", + "assessmentErrorSummary": {}, + "isStretchClusterEnabled": false, + "groupType": "Default", + "assessmentType": "AvsAssessment", + "azureLocation": "EastUs", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-25T13:35:56.5671462Z", + "perfDataEndTime": "2023-09-26T13:35:56.5671462Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "AsOnPremises", + "confidenceRatingInPercentage": 100.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-26T13:35:56.5983656Z", + "updatedTimestamp": "2023-09-26T13:36:01.1699411Z", + "status": "Completed", + "schemaVersion": null, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/avsAssessments/asm2", + "name": "asm2", + "type": "Microsoft.Migrate/assessmentprojects/groups/avsAssessments", + "systemData": { + "createdBy": "sjghfaivpyryuvovuvcqegaorvhp", + "createdByType": "User", + "createdAt": "2024-02-15T18:24:02.548Z", + "lastModifiedBy": "fjkmzd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-02-15T18:24:02.548Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..893a17d43ac3 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,269 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_Get", + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "avsSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..db75126ff536 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,273 @@ +{ + "title": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureAvsSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "avsNodeSummary": { + "serversSuitableForMigration": 28, + "totalNumberOfServers": 4, + "cores": 17, + "memoryGb": 19, + "avsNodeCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 29, + "osLicensingCost": 18, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedAvsNodeTypeSummary": [ + { + "avsNodeType": "AV36", + "numberOfNodes": 16, + "failuresToTolerateAndRaidLevel": "Ftt1Raid1" + } + ], + "estimatedExternalStorage": [ + { + "storageType": "AnfStandard", + "totalStorageInGB": 1024.0, + "storageUtilization": 97.0, + "totalStorageCost": 250 + }, + { + "storageType": "AnfPremium", + "totalStorageInGB": 1024.0, + "storageUtilization": 99.0, + "totalStorageCost": 350 + } + ], + "estimatedNetwork": [ + { + "skuType": "ExpressRouteUltra", + "cost": 200 + } + ], + "estimatedCostWithVcfByol": 24.0 + }, + "avsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "linuxAhubSavings": 18, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesAvsSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "linuxAhubSavings": 18, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "WindowsOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Microsoft Windows Server 2016 Datacenter", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/avsSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/avsSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1d7482a205d5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,291 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_Get", + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "iaasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..c17c6c692c91 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,295 @@ +{ + "title": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azureIaasSummary": { + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "azureIaasVmSummary": { + "serversSuitableForMigration": 15, + "totalNumberOfServers": 27, + "cores": 6, + "memoryGb": 26, + "azureVmCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 19, + "osLicensingCost": 12, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasSqlSummary": { + "totalSqlEntities": 7, + "suitableSqlEntities": 21, + "azureSqlCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "estimatedCost": 23, + "osLicensingCost": 8, + "estimatedCostByRecommendedOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "recommendedVmFamilySummary": [ + { + "azureVmFamily": "Standard_F4", + "numberOfMachines": 26 + } + ], + "costByStorageType": [ + { + "storageType": "StandardSsd", + "cost": 12 + } + ] + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremisesIaasSummary": { + "servers": 29, + "cores": 26, + "memoryGb": 4, + "cpuUtilization": 24, + "memoryUtilization": 10, + "storageUtilization": 26, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostForDecommissioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "osLicensingDetails": [ + { + "osType": "Windows", + "totalCost": 11, + "decomissionCost": 29 + } + ], + "distributionByOperatingSystem": [ + { + "osClassificationType": "LinuxOSInSupport", + "count": 4 + } + ], + "onPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionByVirtualization": [ + { + "virtualizationType": "Vmware", + "count": 30 + } + ], + "iaasOsSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "iaasSqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "distributionByOperatingSystemVersion": [ + { + "type": "Ubuntu", + "count": 27 + } + ], + "distributionBySqlVersion": [ + { + "type": "SQL Server 2012", + "count": 27 + } + ], + "distributionBySqlEdition": [ + { + "type": "Enterprise Evaluation Edition", + "count": 27 + } + ] + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/iaasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/iaasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json new file mode 100644 index 000000000000..e3f35a21e286 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json @@ -0,0 +1,185 @@ +{ + "title": "Get Compare summary report for Business case.", + "operationId": "BusinessCaseOperations_CompareSummary", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "azurePaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "azureAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesIaasDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesAvsDecommissionedCostDetails": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..86c849d71731 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,410 @@ +{ + "title": "BusinessCaseOperations_Create", + "operationId": "BusinessCaseOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "resource": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "InProgress" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 83, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-11-08T07:10:07.764Z", + "performanceDataEndTime": "2023-11-08T07:10:07.764Z", + "comfortFactor": 29, + "performanceUtilizationPercentile": 4, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 83, + "wacc": 79, + "networkCostPercentage": 40, + "iaasLaborCostPercentage": 94, + "paasLaborCostPercentage": 47, + "avsLaborCostPercentage": 0, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 12, + "price": 16, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 27, + "softwareAssuranceCost": 16 + } + ], + "windowsServerLicensing": { + "licenseCost": 9, + "softwareAssuranceCost": 1, + "licensesPerCore": 11 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 17, + "softwareAssuranceCost": 14, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 8, + "basicSupportCost": 22, + "productionSupportCost": 22 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 22, + "maintainanceCostPercentageToAcquisitionCost": 1 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 50, + "maintenanceCostPercentage": 48 + }, + "facilitySettings": { + "facilitiesCost": 7 + }, + "laborSettings": { + "physicalServersPerAdmin": 6, + "virtualMachinesPerAdmin": 24, + "hourlyAdminCost": 25 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 14, + "sqlServerSecurityCostPerServerPerYear": 7 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 2, + "softwareAssuranceCost": 11, + "licenseAndSupportList": [ + { + "licenseCost": 4, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 6, + "basicSupportCost": 1, + "productionSupportCost": 18 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 23, + "supportCost": 9 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 10, + "patchingCostPerServerPerYear": 18, + "dataProtectionCostPerServerPerYear": 18 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..02c258c77124 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "BusinessCaseOperations_Delete", + "operationId": "BusinessCaseOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..215c3249743e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,25 @@ +{ + "title": "Get download URL for the business case report.", + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "body": {} + }, + "responses": { + "200": { + "body": { + "businessCaseReportUrl": "mxwaejake", + "expirationTime": "2023-11-08T07:10:20.491Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..0cc302e6c3df --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,151 @@ +{ + "title": "BusinessCaseOperations_Get", + "operationId": "BusinessCaseOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case", + "name": "sample-business-case", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b572a90d604f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,155 @@ +{ + "title": "BusinessCaseOperations_ListByAssessmentProject", + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "settings": { + "azureSettings": { + "targetLocation": "WestUs2", + "discountPercentage": 52, + "currency": "USD", + "businessCaseType": "OptimizeForCost", + "workloadDiscoverySource": "Appliance", + "performanceDataStartTime": "2023-10-05T11:57:41.237Z", + "performanceDataEndTime": "2023-10-05T11:57:41.237Z", + "comfortFactor": 8, + "performanceUtilizationPercentile": 64, + "perYearMigrationCompletionPercentage": { + "Year0": 20, + "Year1": 30, + "Year2": 60, + "Year3": 90 + }, + "infrastructureGrowthRate": 44, + "wacc": 5, + "networkCostPercentage": 71, + "iaasLaborCostPercentage": 73, + "paasLaborCostPercentage": 50, + "avsLaborCostPercentage": 69, + "savingsOption": "RI3Year" + }, + "onPremiseSettings": { + "computeSettings": { + "hyperthreadCoreToMemoryRatio": 5, + "price": 14, + "sqlServerLicensing": [ + { + "version": "Enterprise", + "licenseCost": 14, + "softwareAssuranceCost": 13 + } + ], + "windowsServerLicensing": { + "licenseCost": 13, + "softwareAssuranceCost": 14, + "licensesPerCore": 8 + }, + "rhelLinuxServerLicensing": { + "licenseCost": 9 + }, + "suseLinuxServerLicensing": { + "licenseCost": 9 + }, + "virtualizationSoftwareSettings": { + "numberOfPhysicalCoresPerLicense": 11, + "softwareAssuranceCost": 28, + "licenseAndSupportList": [ + { + "licenseType": "VSphereStandard", + "licenseCost": 16, + "basicSupportCost": 7, + "productionSupportCost": 25 + } + ] + } + }, + "storageSettings": { + "costPerGbPerMonth": 15, + "maintainanceCostPercentageToAcquisitionCost": 91 + }, + "networkSettings": { + "hardwareSoftwareCostPercentage": 79, + "maintenanceCostPercentage": 82 + }, + "facilitySettings": { + "facilitiesCost": 12 + }, + "laborSettings": { + "physicalServersPerAdmin": 30, + "virtualMachinesPerAdmin": 1, + "hourlyAdminCost": 15 + }, + "securitySettings": { + "serverSecurityCostPerServerPerYear": 2, + "sqlServerSecurityCostPerServerPerYear": 23 + }, + "managementSettings": { + "hypervVirtualizationManagementSettings": { + "numberOfPhysicalCoresPerLicense": 21, + "softwareAssuranceCost": 1, + "licenseAndSupportList": [ + { + "licenseCost": 12, + "licenseType": "Standard" + } + ] + }, + "vsphereManagementSettings": { + "licenseAndSupportList": [ + { + "licenseType": "VSphereServerStandard", + "licenseCost": 9, + "basicSupportCost": 11, + "productionSupportCost": 24 + } + ] + }, + "thirdPartyManagementSettings": { + "licenseCost": 6, + "supportCost": 2 + }, + "otherManagementCostsSettings": { + "monitoringCostPerServerPerYear": 15, + "patchingCostPerServerPerYear": 15, + "dataProtectionCostPerServerPerYear": 28 + } + } + } + }, + "state": "Completed", + "reportStatusDetails": [ + { + "reportType": "Excel", + "reportStatus": "Completed" + } + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5E8485F1-A440-404E-9F91-AFAC5A9993B2/resourceGroups/rgv2023-05-01-preview/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/businessCase1", + "name": "businessCase1", + "type": "Microsoft.Migrate/assessmentProjects/businessCases", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-10-05T11:57:41.238Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-10-05T11:57:41.238Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..cb0486793f9f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,123 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_Get", + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "overviewSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b85ff7b12ce --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,127 @@ +{ + "title": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "totalAzureCost": 20, + "totalAzureIaasCost": 29, + "totalAzurePaasCost": 18, + "totalAzureAvsCost": 21, + "windowsAhubSavings": 26, + "linuxAhubSavings": 26, + "sqlAhubSavings": 29, + "totalOnPremisesCost": 20, + "esuSavingsFor4years": 20, + "managementCostSavings": 19, + "securityCostSavings": 8, + "yearOnYearEstimates": { + "onPremisesCost": { + "Year0": 351803.869241272, + "Year1": 369394.062703335, + "Year2": 387863.765838502, + "Year3": 408410.454130427 + }, + "azureCost": { + "Year0": 351803.869241272, + "Year1": 374738.191162668, + "Year2": 391989.235419251, + "Year3": 396114.705 + }, + "savings": { + "Year0": 0, + "Year1": -5344.12845933292, + "Year2": -4125.46958074899, + "Year3": 12295.7491304271 + }, + "onPremisesCapexCost": { + "Year0": 1049.81370090828, + "Year1": 1102.30438595369, + "Year2": 1157.41960525138, + "Year3": 1215.29058551395 + }, + "onPremisesOpexCost": { + "Year0": 350754.055540363, + "Year1": 368291.758317382, + "Year2": 386706.346233251, + "Year3": 407195.163544913 + }, + "azureCapexCost": { + "Year0": 1049.81370090828, + "Year1": 881.843508762955, + "Year2": 578.709802625689, + "Year3": 0 + }, + "azureOpexCost": { + "Year0": 350754.055540363, + "Year1": 373856.347653905, + "Year2": 391410.525616625, + "Year3": 396114.705 + }, + "paybackPeriod": 0 + }, + "serversDiscovered": { + "vmWare": 6, + "hyperV": 28, + "physical": 16, + "notApplicable": 13 + }, + "utilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "iaasOsDistribution": { + "windows": 5, + "linux": 22, + "other": 14 + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "paasDistribution": { + "sqlServers": 28, + "iisWebServers": 9, + "webAppDistribution": { + "key683": 28 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/overviewSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/overviewSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..96f3b16c2228 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,252 @@ +{ + "title": "BusinessCasePaasSummaryOperations_Get", + "operationId": "BusinessCasePaasSummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "paasSummaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..9ee7b6b127b4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,256 @@ +{ + "title": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "azure": { + "totalSqlEntities": 1, + "suitableSqlEntities": 8, + "totalWebApps": 22, + "suitableWebApps": 8, + "cores": 3, + "memory": 29, + "storage": 8, + "estimatedCostByTarget": { + "azureSqlMiCost": 27, + "azureSqlDbCost": 6, + "appServiceCost": 5, + "appServiceContainerCost": 23, + "azureKubernetesServiceCost": 22 + }, + "estimatedSqlServerLicensingCost": 18, + "azureSqlSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year RI", + "cost": 17 + } + ], + "distributionByServiceTier": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlMi": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ], + "distributionByServiceTierForSqlDb": [ + { + "serviceTierName": "GeneralPurpose", + "serviceTierNumber": 1 + } + ] + }, + "azureAppServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 6, + "count": 27 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureAppServiceContainerSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "azureKubernetesServiceSummary": { + "estimatedCostByOffer": [ + { + "offerName": "3 Year ASP", + "cost": 17 + } + ], + "distributionBySku": [ + { + "skuName": "Premium_V3", + "cost": 14, + "count": 30 + } + ], + "distributionByApp": [ + { + "webAppType": "Unknown", + "numberOfWebApps": 14 + } + ] + }, + "totalAzurePaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + } + }, + "onPremises": { + "totalServers": 29, + "cpuUtilization": 18, + "memoryUtilization": 14, + "totalOnPremisesPaasCost": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasCostForDecommisioned": { + "storageCost": 27, + "computeCost": 19, + "itLaborCost": 29, + "networkCost": 28, + "ahubSavings": 1, + "securityCost": 4, + "managementCostDetails": { + "managementCost": 22, + "managementCostComponents": [ + { + "name": "Unknown", + "value": 16 + } + ] + }, + "esuSavings": 28 + }, + "onPremisesPaasLicensingCost": { + "version": null, + "totalCost": 29, + "decomissionServerCost": 1 + }, + "onPremisesSqlSummary": { + "sqlInstances": 26, + "sqlDatabases": 21, + "distributionBySqlVersion": [ + { + "sqlVersion": "SQL Server 2019", + "numberOfInstances": 20 + } + ], + "sqlOnPremisesUtilizationData": { + "numberOfActiveEntities": 10, + "numberOfInactiveEntities": 18, + "numberOfDecommisionEntities": 10, + "numberOfUnknownEntities": 13 + }, + "distributionBySqlEdition": [ + { + "type": "Enterprise Edition (64-bit)", + "count": 27 + } + ] + }, + "onPremisesWebAppSummary": { + "numberOfWebServers": 1, + "numberOfWebApplications": 27, + "numberOfWebAppsPerType": { + "key2586": 28 + } + }, + "osSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "sqlSupportStatusDistribution": { + "unknownSupport": 2, + "mainStream": 20, + "extended": 26, + "outOfSupport": 29 + }, + "osServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + }, + "sqlServicePackInsight": { + "unknownServicePack": 3, + "patched": 14, + "unpatched": 5 + } + } + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentProjects/multipleto8617project/businessCases/sample-business-case/paasSummaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/businessCases/paasSummaries", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c2eb7cd6b53 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedAvsMachinesOperations_Get", + "operationId": "EvaluatedAvsMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedAvsMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..064037b1ffab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "zcwvgkjkvddoylnfkgclpytp", + "pageSize": 9, + "continuationToken": "er", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedavsmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedavsmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..fc339892f0fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,40 @@ +{ + "title": "EvaluatedMachinesOperations_Get", + "operationId": "EvaluatedMachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedMachineName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..35ed7d9ee09f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "EvaluatedMachinesOperations_ListByBusinessCase", + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "fyiccra", + "pageSize": 16, + "continuationToken": "mipqzxorbubmdjm", + "totalRecordCount": 28, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "machineId": "a404-r1w16-1.FPL.COM", + "serverName": "a404-r1w16-1.FPL.COM", + "virtualizationType": "Vmware", + "activityState": "inconclusive", + "operatingSystemName": "Ubuntu", + "recommendedAzureTarget": "AzureVm", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedmachine/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedmachine", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..46dd3278c512 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_Get", + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedSqlEntityName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..84d57567bd54 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "rukrirndrwnypcf", + "pageSize": 13, + "continuationToken": "bqkhzxsvqhnarrffqtgeytrznivh", + "totalRecordCount": 12, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serverName": "a404-r1w16-1.FPL.COM", + "activityState": "active", + "sqlVersion": null, + "sqlEdition": null, + "recommendedAzureTarget": "AzureVirtualMachine", + "qualifyingOffer": "3 Year RI", + "readyForMigration": "Ready", + "virtualizationType": "Vmware", + "dbCount": 1, + "supportStatus": "Unknown" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedsqlentity/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedsqlentity", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..25cc686cab57 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,38 @@ +{ + "title": "EvaluatedWebAppsOperations_Get", + "operationId": "EvaluatedWebAppsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case", + "evaluatedWebAppName": "a404-r1w16-1.FPL.COM" + }, + "responses": { + "200": { + "body": { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json new file mode 100644 index 000000000000..b35da02ac34c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "EvaluatedWebAppsOperations_ListByBusinessCase", + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "ADC896AD-6A38-454E-9A62-AFC618F5F4BC", + "resourceGroupName": "rgopenapi", + "$filter": "pwrvmthelxikwweggf", + "pageSize": 18, + "continuationToken": "oizcutotskmhqxxmpwiqzvzyaubjt", + "totalRecordCount": 2, + "projectName": "multipleto8617project", + "businessCaseName": "sample-business-case" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recommendedAzureTarget": "AzureVm", + "recommendedAzureSkuName": "Premium_V3", + "recommendedAzureSkuSize": "P1 v3", + "serverName": "a404-r1w16-1.FPL.COM", + "workload": "WebApps", + "activityState": "active", + "readyForMigration": "Ready" + }, + "id": "/subscriptions/ADC896AD-6A38-454E-9A62-AFC618F5F4BC/resourceGroups/rgopenapi/providers/Microsoft.Migrate/assessmentprojects/multipleto8617project/businessCases/sample-business-case/evaluatedwebapp/a404-r1w16-1.FPL.COM", + "name": "a404-r1w16-1.FPL.COM", + "type": "Microsoft.Migrate/assessmentprojects/businessCases/evaluatedwebapp", + "systemData": { + "createdBy": "t72jdt@company.com", + "createdByType": "User", + "createdAt": "2023-11-08T07:09:55.036Z", + "lastModifiedBy": "t72jdt@company.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-08T07:09:55.036Z" + } + } + ], + "nextLink": "https://management.azure.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..8b3211b9c547 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,85 @@ +{ + "title": "GroupsOperations_Create", + "operationId": "GroupsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "resource": { + "properties": { + "groupStatus": "Completed", + "groupType": "Default", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..236bfa69b784 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "GroupsOperations_Delete", + "operationId": "GroupsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c0bc491a1 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "GroupsOperations_Get", + "operationId": "GroupsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb8806e74610 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "GroupsOperations_ListByAssessmentProject", + "operationId": "GroupsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json new file mode 100644 index 000000000000..92535ad483eb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json @@ -0,0 +1,58 @@ +{ + "title": "Update machines in group.", + "operationId": "GroupsOperations_UpdateMachines", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "groupName": "kuchatur-test", + "body": { + "eTag": "*", + "properties": { + "operationType": "Add", + "machines": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/18895660-c5e5-4247-8cfc-cd24e1fe57f3" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "groupStatus": "Completed", + "machineCount": 20, + "assessments": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test/assessments/asm1" + ], + "supportedAssessmentTypes": [ + "MachineAssessment", + "AvsAssessment" + ], + "areAssessmentsRunning": true, + "createdTimestamp": "2023-09-15T07:22:29.161Z", + "updatedTimestamp": "2023-09-15T07:22:29.161Z", + "groupType": "Default", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/kuchatur-test", + "name": "kuchatur-test", + "type": "Microsoft.Migrate/assessmentprojects/groups", + "systemData": { + "createdBy": "bhjfiiwermbzqfoqxtxpjigj", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "lrmhonmbodwva", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..2c525d06629b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "HypervCollectorsOperations_Create", + "operationId": "HypervCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..350f931b1618 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "HypervCollectorsOperations_Delete", + "operationId": "HypervCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f3606e653d5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "HypervCollectorsOperations_Get", + "operationId": "HypervCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "hypervCollectorName": "test-697cecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..70558c2a051c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "HypervCollectorsOperations_ListByAssessmentProject", + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/hypervcollectors/test-697cecollector", + "name": "test-697cecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/hypervcollectors", + "properties": { + "agentProperties": { + "id": "12f1d90f-b3fa-4926-8893-e56803a09af0", + "version": "2.0.1993.19", + "lastHeartbeatUtc": "2022-07-07T14:25:35.708325Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "audience": "e3bd6eaa-980b-40ae-a30e-2a5069ba097c", + "objectId": "01b9f9e2-2d82-414c-adaa-09ce259b6b44", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/HyperVSites/test-60527site", + "createdTimestamp": "2022-07-06T17:35:52.7505235Z", + "updatedTimestamp": "2023-02-16T12:23:47.9845327Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..e8904f39703b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,62 @@ +{ + "title": "ImportCollectorsOperations_Create", + "operationId": "ImportCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5", + "resource": { + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..7919004da039 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ImportCollectorsOperations_Delete", + "operationId": "ImportCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..d441848e7fd4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,33 @@ +{ + "title": "ImportCollectorsOperations_Get", + "operationId": "ImportCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "importCollectorName": "importCollectore7d5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..cd8e5436ce84 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "ImportCollectorsOperations_ListByAssessmentProject", + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/importcollectors/importCollectore7d5", + "name": "importCollectore7d5", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/importcollectors", + "properties": { + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawRG/providers/microsoft.offazure/importsites/actualSEA37d4importSite", + "createdTimestamp": "2021-10-01T11:04:34.3408113Z", + "updatedTimestamp": "2023-02-16T12:23:48.3830682Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..159426f8d68c --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,89 @@ +{ + "title": "MachinesOperations_Get", + "operationId": "MachinesOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "projectName": "app18700project", + "machineName": "55082b89-99e2-4c40-b63f-d4f4d6ba961d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b009dd1f59cb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "MachinesOperations_ListByAssessmentProject", + "operationId": "MachinesOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawrg", + "$filter": null, + "pageSize": 1, + "continuationToken": null, + "totalRecordCount": 1, + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/machines/55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "name": "55082b89-99e2-4c40-b63f-d4f4d6ba961d", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/machines", + "properties": { + "workloadSummary": { + "oracleInstances": 0, + "springApps": 0 + }, + "errors": [], + "productSupportStatus": { + "currentVersion": null, + "servicePackStatus": "Unknown", + "esuStatus": "Unknown", + "supportStatus": "Extended", + "eta": 0, + "currentEsuYear": "Unknown", + "mainstreamEndDate": "2018-10-09T00:00:00Z", + "extendedSupportEndDate": "2023-10-10T00:00:00Z", + "extendedSecurityUpdateYear1EndDate": "2024-10-08T00:00:00Z", + "extendedSecurityUpdateYear2EndDate": "2025-10-14T00:00:00Z", + "extendedSecurityUpdateYear3EndDate": "2026-10-13T00:00:00Z" + }, + "hostProcessor": null, + "discoveryMachineArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourcegroups/ayagrawrg/providers/microsoft.offazure/vmwaresites/app48697site/machines/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17_50379cec-8534-dcd7-0c7e-b16f6572bf94", + "datacenterManagementServerArmId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/app48697site/vcenters/idclab-vcen65-fareast-corp-micr-7071f35f-082c-4333-9ca9-3fdd5254db17", + "datacenterManagementServerName": "idclab-vcen65.fareast.corp.microsoft.com", + "bootType": "BIOS", + "displayName": "a410-r1w12r2-7", + "megabytesOfMemory": 30720.0, + "numberOfCores": 8, + "operatingSystemType": "windowsGuest", + "operatingSystemName": "Microsoft Windows Server 2012 (64-bit)", + "operatingSystemVersion": null, + "description": "", + "createdTimestamp": "2021-08-31T14:31:19.465845Z", + "disks": { + "6000C29d-4e28-24a9-eaee-02fa5a17dadf": { + "gigabytesAllocated": 150.0, + "displayName": "scsi0:0" + }, + "6000C297-a876-f49f-c202-0289620d5223": { + "gigabytesAllocated": 250.0, + "displayName": "scsi0:1" + }, + "6000C295-4e9d-4322-6690-aff91beffb82": { + "gigabytesAllocated": 50.0, + "displayName": "scsi0:2" + } + }, + "groups": [ + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/azure-vmwaresolution-ame-15389", + "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/groups/rajoshtest" + ], + "networkAdapters": { + "4000": { + "macAddress": "00:50:56:b7:04:06", + "ipAddresses": [], + "displayName": "VM Network" + } + }, + "sqlInstances": [], + "webApplications": [], + "updatedTimestamp": "2023-08-03T16:22:11.2610571Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..a47c702d4ad9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AksAssessmentOperations_Get", + "isDataAction": true, + "display": { + "provider": "Microsoft.Migrate", + "resource": "AKSAssessment", + "operation": "GET", + "description": "AKSAssessment" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb4441759275 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "PrivateEndpointConnectionOperations_Delete", + "operationId": "PrivateEndpointConnectionOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1ed91c2f7f5b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,39 @@ +{ + "title": "PrivateEndpointConnectionOperations_Get", + "operationId": "PrivateEndpointConnectionOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..a0ee06195281 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,43 @@ +{ + "title": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/avol" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..56ea66251470 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "PrivateEndpointConnectionOperations_Update", + "operationId": "PrivateEndpointConnectionOperations_Update", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateEndpointConnectionName": "sakanwar1204project1634pe.bf42f8a1-09f5-4ee4-aea6-a019cc60f9d7", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Network/privateEndpoints/sakanwar1204project1634pe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/31be0ff4-c932-4cb3-8efc-efa411d79280/resourceGroups/PrivLink-SelfHost/providers/Microsoft.Migrate/assessmentprojects/PiyushApp15328project/privateEndpointConnections/sakanwar1204project1634pe", + "name": "sakanwar1204project1634pe", + "type": "Microsoft.Migrate/assessmentprojects/privateEndpointConnections", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..66add9e9ec82 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,37 @@ +{ + "title": "PrivateLinkResourceOperations_Get", + "operationId": "PrivateLinkResourceOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project", + "privateLinkResourceName": "Default" + }, + "responses": { + "200": { + "body": { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..b07930fdc471 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinkResourceOperations_ListByAssessmentProject", + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "sakanwar", + "projectName": "sakanwar1204project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "requiredMembers": [ + "CollectorAgent" + ], + "requiredZoneNames": [ + "privatelink.test.migration.windowsazure.com" + ], + "groupId": "Default" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sakanwar/providers/Microsoft.Migrate/assessmentprojects/sakanwar1204project/privateLinkResources/Default", + "name": "Default", + "type": "Microsoft.Migrate/assessmentprojects/privateLinkResources", + "systemData": { + "createdBy": "sakanwar", + "createdByType": "User", + "createdAt": "2023-09-15T07:22:18.589Z", + "lastModifiedBy": "sakanwar", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-09-15T07:22:18.589Z" + } + } + ], + "nextLink": "https://microsoft.com/abcd" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..b405d3d54016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "ServerCollectorsOperations_Create", + "operationId": "ServerCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector", + "resource": { + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..be1cd1d47d55 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "ServerCollectorsOperations_Delete", + "operationId": "ServerCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..f89f2bc2a89b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "ServerCollectorsOperations_Get", + "operationId": "ServerCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "serverCollectorName": "walter389fcollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..8ef3c807b70b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "ServerCollectorsOperations_ListByAssessmentProject", + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/servercollectors/walter389fcollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "walter389fcollector", + "type": "Microsoft.Migrate/assessmentprojects/servercollectors", + "properties": { + "agentProperties": { + "id": "498e4965-bbb1-47c2-8613-345baff9c509", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "audience": "65153d2f-9afb-44e8-b3ca-1369150b7354", + "objectId": "ddde6f96-87c8-420b-9d4d-f16a5090519e", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/ServerSites/walter7155site", + "createdTimestamp": "2023-05-29T13:35:13.3621563Z", + "updatedTimestamp": "2023-09-25T07:28:34.8075563Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..870a5fe98991 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,1635 @@ +{ + "title": "SqlAssessmentOptionsOperations_Get", + "operationId": "SqlAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..7a5b8dc8a6f9 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,1639 @@ +{ + "title": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Migrate/assessmentprojects/sqlAssessmentOptions", + "systemData": { + "createdAt": "2023-09-25T10:16:46.5581628Z", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "2023-09-25T10:16:46.5581628Z", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "properties": { + "vmFamilies": [ + { + "familyName": "Dadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dasv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Dav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ddv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Ddv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "GeneralPurpose" + ] + }, + { + "familyName": "Edsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Eadsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Easv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Eav4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "Ebdsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Ebsv5_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edsv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Edv4_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "GermanyWestCentral", + "ItalyNorth", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "NorwayWest", + "PolandCentral", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized" + ] + }, + { + "familyName": "M_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyNorth", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthAfricaWest", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mdsv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "FranceCentral", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "QatarCentral", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "ChinaNorth2", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + }, + { + "familyName": "Mv2_series", + "targetLocations": [ + "AustraliaCentral", + "AustraliaCentral2", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "CentralIndia", + "CentralUs", + "EastAsia", + "EastUs", + "EastUs2", + "GermanyWestCentral", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "SouthAfricaNorth", + "SouthCentralUs", + "SoutheastAsia", + "SouthIndia", + "SwedenCentral", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAECentral", + "UAENorth", + "UkSouth", + "UkWest", + "WestEurope", + "WestUs", + "WestUs2", + "USGovArizona", + "USGovVirginia" + ], + "category": [ + "MemoryOptimized", + "SupportsPremiumStorage" + ] + } + ], + "reservedInstanceVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "premiumDiskVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Edsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanVmFamilies": [ + "Dadsv5_series", + "Dasv4_series", + "Dav4_series", + "Ddsv4_series", + "Ddsv5_series", + "Ddv4_series", + "Ddv5_series", + "Edsv5_series", + "Edv5_series", + "Eadsv5_series", + "Easv4_series", + "Eav4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edv4_series", + "M_series", + "Mdsv2_series", + "Mv2_series" + ], + "savingsPlanSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral" + ], + "savingsPlanSupportedLocationsForPaas": [], + "reservedInstanceSupportedLocationsForIaas": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "savingsPlanSupportedOffers": [ + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "sqlSkus": [ + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "NorwayWest", + "CanadaCentral", + "CanadaEast", + "GermanyNorth", + "SouthAfricaWest", + "EastAsia", + "NorwayEast", + "WestUs2", + "SouthIndia", + "EastUs", + "SouthCentralUs", + "UAENorth", + "AustraliaSoutheast", + "PolandCentral", + "KoreaCentral", + "UkWest", + "SwitzerlandNorth", + "NorthCentralUs", + "SoutheastAsia", + "BrazilSouth", + "FranceSouth", + "SwitzerlandWest", + "SwedenCentral", + "WestUs", + "AustraliaCentral2", + "NorthEurope", + "WestIndia", + "FranceCentral", + "ItalyNorth", + "KoreaSouth", + "GermanyWestCentral", + "JapanEast", + "WestEurope", + "WestCentralUs", + "SouthAfricaNorth", + "AustraliaCentral", + "UAECentral", + "UkSouth", + "JapanWest", + "CentralIndia", + "EastUs2", + "AustraliaEast", + "CentralUs", + "QatarCentral", + "ChinaNorth2", + "ChinaEast", + "ChinaEast2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "AustraliaEast", + "SoutheastAsia", + "WestIndia", + "CanadaEast", + "NorthEurope", + "UAENorth", + "SouthAfricaNorth", + "EastUs", + "NorthCentralUs", + "BrazilSouth", + "WestCentralUs", + "UAECentral", + "CanadaCentral", + "JapanEast", + "CentralUs", + "FranceSouth", + "ItalyNorth", + "SouthCentralUs", + "UkWest", + "NorwayEast", + "FranceCentral", + "CentralIndia", + "AustraliaCentral2", + "EastAsia", + "WestUs", + "SouthAfricaWest", + "SwitzerlandWest", + "QatarCentral", + "AustraliaSoutheast", + "WestUs2", + "KoreaSouth", + "NorwayWest", + "GermanyWestCentral", + "JapanWest", + "UkSouth", + "WestEurope", + "KoreaCentral", + "EastUs2", + "SwedenCentral", + "AustraliaCentral", + "SouthIndia", + "GermanyNorth", + "SwitzerlandNorth", + "PolandCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth", + "ChinaNorth2", + "USGovIowa", + "USGovVirginia", + "USGovArizona", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeriesMemoryOptimized", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "UAECentral", + "FranceSouth", + "SwitzerlandNorth", + "CentralIndia", + "NorthEurope", + "SwedenCentral", + "WestCentralUs", + "CanadaEast", + "AustraliaSoutheast", + "EastAsia", + "UAENorth", + "SwitzerlandWest", + "BrazilSouth", + "EastUs2", + "GermanyWestCentral", + "FranceCentral", + "WestUs", + "AustraliaCentral", + "NorwayWest", + "QatarCentral", + "WestUs2", + "UkWest", + "KoreaSouth", + "JapanWest", + "CanadaCentral", + "SoutheastAsia", + "PolandCentral", + "KoreaCentral", + "SouthCentralUs", + "GermanyNorth", + "ItalyNorth", + "EastUs", + "SouthAfricaWest", + "CentralUs", + "AustraliaEast", + "NorwayEast", + "WestEurope", + "WestIndia", + "NorthCentralUs", + "UkSouth", + "AustraliaCentral2", + "SouthAfricaNorth", + "JapanEast", + "SouthIndia", + "ChinaEast2", + "ChinaNorth2", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "PremiumSeries", + "targetType": "AzureSqlDatabase", + "serviceTier": "HyperScale", + "targetLocations": [ + "CentralIndia", + "AustraliaCentral", + "UAENorth", + "KoreaCentral", + "UAECentral", + "AustraliaSoutheast", + "SoutheastAsia", + "ItalyNorth", + "AustraliaEast", + "WestUs2", + "AustraliaCentral2", + "BrazilSouth", + "FranceSouth", + "JapanEast", + "NorthCentralUs", + "NorthEurope", + "PolandCentral", + "NorwayWest", + "UkSouth", + "SouthAfricaNorth", + "CanadaEast", + "WestIndia", + "GermanyWestCentral", + "NorwayEast", + "SwitzerlandWest", + "KoreaSouth", + "SwedenCentral", + "JapanWest", + "CentralUs", + "QatarCentral", + "WestEurope", + "CanadaCentral", + "SouthIndia", + "GermanyNorth", + "WestCentralUs", + "EastUs", + "SwitzerlandNorth", + "FranceCentral", + "SouthAfricaWest", + "UkWest", + "WestUs", + "SouthCentralUs", + "EastUs2", + "EastAsia", + "ChinaNorth2", + "ChinaEast2", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlDatabase", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "EastUs2", + "SouthCentralUs", + "GermanyWestCentral", + "AustraliaCentral", + "SouthAfricaWest", + "GermanyNorth", + "CanadaEast", + "WestUs", + "WestUs2", + "CanadaCentral", + "SouthAfricaNorth", + "FranceCentral", + "CentralUs", + "NorwayEast", + "JapanEast", + "UkWest", + "WestCentralUs", + "FranceSouth", + "BrazilSouth", + "KoreaSouth", + "EastAsia", + "UAENorth", + "CentralIndia", + "NorthEurope", + "AustraliaEast", + "KoreaCentral", + "SwitzerlandNorth", + "SwedenCentral", + "WestEurope", + "AustraliaCentral2", + "EastUs", + "PolandCentral", + "NorthCentralUs", + "UAECentral", + "ItalyNorth", + "SouthIndia", + "WestIndia", + "SoutheastAsia", + "AustraliaSoutheast", + "NorwayWest", + "JapanWest", + "SwitzerlandWest", + "QatarCentral", + "UkSouth", + "ChinaEast2", + "ChinaNorth", + "ChinaNorth2", + "ChinaEast", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "GeneralPurpose", + "targetLocations": [ + "PolandCentral", + "JapanEast", + "SoutheastAsia", + "GermanyNorth", + "AustraliaCentral", + "UAECentral", + "GermanyWestCentral", + "NorwayWest", + "NorwayEast", + "AustraliaCentral2", + "SwitzerlandNorth", + "UAENorth", + "FranceSouth", + "BrazilSouth", + "CanadaEast", + "EastUs2", + "WestEurope", + "JapanWest", + "WestUs2", + "FranceCentral", + "WestIndia", + "SouthCentralUs", + "KoreaSouth", + "NorthEurope", + "SouthAfricaWest", + "SouthAfricaNorth", + "EastAsia", + "EastUs", + "ItalyNorth", + "SwedenCentral", + "KoreaCentral", + "AustraliaSoutheast", + "QatarCentral", + "CentralIndia", + "CanadaCentral", + "CentralUs", + "AustraliaEast", + "NorthCentralUs", + "WestCentralUs", + "SouthIndia", + "WestUs", + "UkSouth", + "SwitzerlandWest", + "UkWest", + "ChinaEast", + "ChinaNorth2", + "ChinaEast2", + "ChinaNorth", + "USGovTexas", + "USGovArizona", + "USGovIowa", + "USGovVirginia" + ] + }, + { + "computeTier": "Provisioned", + "hardwareGeneration": "Gen5", + "targetType": "AzureSqlManagedInstance", + "serviceTier": "BusinessCritical", + "targetLocations": [ + "NorwayWest", + "NorthEurope", + "GermanyNorth", + "KoreaSouth", + "EastUs2", + "CentralIndia", + "SoutheastAsia", + "SwedenCentral", + "WestUs", + "JapanEast", + "WestEurope", + "AustraliaEast", + "SouthAfricaNorth", + "UkSouth", + "UAENorth", + "NorthCentralUs", + "SouthAfricaWest", + "CanadaEast", + "UkWest", + "CentralUs", + "SouthCentralUs", + "WestUs2", + "NorwayEast", + "JapanWest", + "PolandCentral", + "WestCentralUs", + "EastAsia", + "SouthIndia", + "ItalyNorth", + "QatarCentral", + "FranceCentral", + "CanadaCentral", + "SwitzerlandWest", + "UAECentral", + "AustraliaCentral", + "SwitzerlandNorth", + "KoreaCentral", + "WestIndia", + "BrazilSouth", + "EastUs", + "FranceSouth", + "AustraliaCentral2", + "AustraliaSoutheast", + "GermanyWestCentral", + "ChinaEast2", + "ChinaEast", + "ChinaNorth2", + "ChinaNorth", + "USGovArizona", + "USGovIowa", + "USGovVirginia", + "USGovTexas" + ] + } + ], + "reservedInstanceSqlTargets": [ + "AzureSqlDatabase", + "AzureSqlManagedInstance" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaCentral", + "AustraliaSoutheast", + "CanadaEast", + "CentralIndia", + "CentralUs", + "CanadaCentral", + "EastAsia", + "BrazilSouth", + "AustraliaEast", + "FranceCentral", + "FranceSouth", + "GermanyNorth", + "EastUs", + "EastUs2", + "JapanWest", + "KoreaSouth", + "NorthCentralUs", + "NorthEurope", + "NorwayEast", + "JapanEast", + "PolandCentral", + "SouthCentralUs", + "NorwayWest", + "SoutheastAsia", + "SouthIndia", + "SouthAfricaWest", + "SwedenCentral", + "SwitzerlandNorth", + "UAENorth", + "UkSouth", + "UkWest", + "WestCentralUs", + "WestEurope", + "WestUs", + "WestUs2", + "KoreaCentral", + "AustraliaCentral2", + "GermanyWestCentral", + "ItalyNorth", + "QatarCentral", + "SouthAfricaNorth", + "SwitzerlandWest", + "UAECentral", + "USGovArizona", + "USGovTexas", + "USGovVirginia" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P", + "MSAZRUSGOV0003P" + ], + "supportedOffers": [ + "MSAZR0003P" + ] + }, + "name": "default", + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlAssessmentOptions/default" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..a40eb6a666c6 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,219 @@ +{ + "title": "SqlAssessmentV2Operations_Create", + "operationId": "SqlAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "resource": { + "properties": { + "entityUptime": { + "daysPerMonth": 30, + "hoursPerDay": 24 + }, + "osLicense": "Unknown", + "optimizationLogic": "MinimizeCost", + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Automatic", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Eadsv5_series" + ] + }, + "environmentType": "Production", + "reservedInstance": "None", + "reservedInstanceForVm": "None", + "sqlServerLicense": "Unknown", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "azureOfferCodeForVm": "MSAZR0003P", + "currency": "USD", + "percentile": "Percentile95", + "scalingFactor": 1, + "timeRange": "Day", + "discountPercentage": 0, + "sizingCriterion": "PerformanceBased", + "multiSubnetIntent": "DisasterRecovery", + "asyncCommitModeIntent": "DisasterRecovery", + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..f2e38db2e96e --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "SqlAssessmentV2Operations_Delete", + "operationId": "SqlAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..7acc1a52c057 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "Get download URL for the assessment report.", + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "fagqmlysjfwtt", + "expirationTime": "2023-09-15T07:22:40.818Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b58cef26efcb --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,94 @@ +{ + "title": "SqlAssessmentV2Operations_Get", + "operationId": "SqlAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..b96c917afe29 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,254 @@ +{ + "title": "SqlAssessmentV2Operations_ListByGroup", + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_1", + "name": "test_assmt_hadr_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-02-16T16:14:03.477007Z", + "perfDataEndTime": "2023-02-17T16:14:03.477007Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2022-12-20T00:00:00Z", + "createdTimestamp": "2023-01-04T14:17:43.1744405Z", + "updatedTimestamp": "2023-02-17T16:16:25.1524275Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_assmt_hadr_2", + "name": "test_assmt_hadr_2", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-06T07:47:29.6769501Z", + "perfDataEndTime": "2023-09-07T07:47:29.6769501Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-07T07:47:29.6925964Z", + "updatedTimestamp": "2023-09-07T07:49:26.5732595Z", + "status": "Completed", + "schemaVersion": "2.0" + } + }, + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1", + "name": "test_swagger_1", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments", + "properties": { + "osLicense": "Yes", + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 31, + "hoursPerDay": 24 + }, + "optimizationLogic": "MinimizeCost", + "reservedInstanceForVm": "RI3Year", + "azureOfferCodeForVm": "MSAZR0003P", + "eaSubscriptionId": null, + "azureSqlManagedInstanceSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlInstanceType": "SingleInstance" + }, + "azureSqlDatabaseSettings": { + "azureSqlServiceTier": "Automatic", + "azureSqlDataBaseType": "SingleDatabase", + "azureSqlComputeTier": "Provisioned", + "azureSqlPurchaseModel": "VCore" + }, + "azureSqlVmSettings": { + "instanceSeries": [ + "Dadsv5_series", + "Dasv4_series", + "Ddsv4_series", + "Ddsv5_series", + "Eadsv5_series", + "Easv4_series", + "Ebdsv5_series", + "Ebsv5_series", + "Edsv4_series", + "Edsv5_series", + "M_series", + "Mdsv2_series" + ] + }, + "multiSubnetIntent": "HighAvailability", + "asyncCommitModeIntent": "HighAvailability", + "isInternetAccessAvailable": false, + "disasterRecoveryLocation": "EastAsia", + "enableHadrAssessment": true, + "azureSecurityOfferingType": "NO", + "reservedInstance": "RI3Year", + "sqlServerLicense": "Yes", + "groupType": "Default", + "assessmentType": "SqlAssessment", + "azureLocation": "SoutheastAsia", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 1.0, + "percentile": "Percentile95", + "timeRange": "Day", + "perfDataStartTime": "2023-09-07T05:21:45.9644382Z", + "perfDataEndTime": "2023-09-08T05:21:45.9644382Z", + "stage": "InProgress", + "discountPercentage": 0.0, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 0.0, + "pricesTimestamp": "2023-08-16T00:00:00", + "createdTimestamp": "2023-09-08T05:21:45.9800654Z", + "updatedTimestamp": "2023-09-08T05:23:45.2686461Z", + "status": "Completed", + "schemaVersion": "2.0" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..908b43ec5209 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,128 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_Get", + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a974ed1660e7 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,132 @@ +{ + "title": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "groupName": "test_fci_hadr", + "assessmentName": "test_swagger_1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/groups/test_fci_hadr/sqlAssessments/test_swagger_1/summaries/default", + "name": "default", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/groups/sqlAssessments/summaries", + "properties": { + "assessmentSummary": { + "azureSqlManagedInstance": { + "suitabilitySummary": { + "notSuitable": 7, + "readinessUnknown": 15, + "suitableForSqlMI": 1 + }, + "monthlyComputeCost": 4581.992448, + "monthlyStorageCost": 0.0, + "monthlyLicenseCost": 6568.5107999999991, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlVirtualMachine": { + "suitabilitySummary": { + "suitableForSqlVM": 21, + "readinessUnknown": 2 + }, + "monthlyComputeCost": 889.49663999999962, + "monthlyStorageCost": 73.943999999999988, + "monthlyLicenseCost": 25281.36, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureSqlDatabase": { + "suitabilitySummary": { + "readinessUnknown": 1468, + "suitableForSqlDB": 16 + }, + "monthlyComputeCost": 175079.07398399821, + "monthlyStorageCost": 1054.8825000000395, + "monthlyLicenseCost": 214401.07883999476, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "azureVirtualMachine": { + "suitabilitySummary": { + "suitableForVM": 19 + }, + "monthlyComputeCost": 625.94207999999981, + "monthlyStorageCost": 374.48999999999995, + "monthlyLicenseCost": 1300.5120000000002, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + }, + "recommended": { + "suitabilitySummary": { + "suitableForSqlVM": 19, + "suitableForVM": 4 + }, + "monthlyComputeCost": 823.60799999999972, + "monthlyStorageCost": 100.88400000000002, + "monthlyLicenseCost": 22912.896, + "confidenceScore": 0.0, + "monthlySecurityCost": 0.0 + } + }, + "distributionBySupportStatus": { + "extended": 11, + "outOfSupport": 9, + "mainstream": 3 + }, + "distributionByServicePackInsight": { + "unknown": 23 + }, + "distributionBySqlVersion": { + "sql Server 2014": 4, + "sql Server 2012": 9, + "sql Server 2019": 3, + "sql Server 2016": 5, + "sql Server 2017": 2 + }, + "distributionBySqlEdition": { + "enterprise Edition: Core-based Licensing (64-bit)": 15, + "web Edition": 1, + "express Edition (64-bit)": 2, + "enterprise Evaluation Edition (64-bit)": 1, + "enterprise Edition: Core-based Licensing": 1, + "enterprise Edition (64-bit)": 1, + "standard Edition (64-bit)": 2 + }, + "instanceDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 23 + }, + "databaseDistributionBySizingCriterion": { + "performanceBased": 0, + "asOnPremises": 0, + "perfBasedFallbackToAsOnPremises": 1484 + }, + "numberOfMachines": 19, + "numberOfSqlInstances": 23, + "numberOfSqlDatabases": 1484, + "numberOfFciInstances": 4, + "numberOfSqlAvailabilityGroups": 5 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..7dad7d97a34b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,97 @@ +{ + "title": "SqlCollectorOperations_Create", + "operationId": "SqlCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector", + "resource": { + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..6fcfd6243e85 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "SqlCollectorOperations_Delete", + "operationId": "SqlCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..8d8c73d771a5 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "SqlCollectorOperations_Get", + "operationId": "SqlCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project", + "collectorName": "fci-test0c1esqlsitecollector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-test6904project/sqlcollectors/fci-test0c1esqlsitecollector", + "name": "fci-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..9e322501d3ea --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "SqlCollectorOperations_ListByAssessmentProject", + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "rgmigrate", + "projectName": "fci-test6904project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.Migrate/assessmentprojects/fci-ankit-test6904project/sqlcollectors/fci-ankit-test0c1esqlsitecollector", + "name": "fci-ankit-test0c1esqlsitecollector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "type": "Microsoft.Migrate/assessmentprojects/sqlcollectors", + "properties": { + "agentProperties": { + "id": "630da710-4d44-41f7-a189-72fe3db5502b-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "db9c4c3d-477c-4d5a-817b-318276713565", + "audience": "db9c4c3d-477c-4d5a-817b-318276713565", + "objectId": "e50236ad-ad07-47d4-af71-ed7b52d200d5", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/bansalankit-rg/providers/Microsoft.OffAzure/MasterSites/fci-ankit-test6065mastersite/SqlSites/fci-ankit-test6065sqlsites", + "createdTimestamp": "2022-11-22T09:50:37.1061418Z", + "updatedTimestamp": "2023-02-16T12:17:52.9185188Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..6039ffa97e75 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,98 @@ +{ + "title": "VmwareCollectorsOperations_Create", + "operationId": "VmwareCollectorsOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector", + "resource": { + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "provisioningState": "Succeeded" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..99c229a6db40 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "VmwareCollectorsOperations_Delete", + "operationId": "VmwareCollectorsOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..05f39123a1ab --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,45 @@ +{ + "title": "VmwareCollectorsOperations_Get", + "operationId": "VmwareCollectorsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project", + "vmWareCollectorName": "Vmware2258collector" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..c819f602be15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,49 @@ +{ + "title": "VmwareCollectorsOperations_ListByAssessmentProject", + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600", + "resourceGroupName": "ayagrawRG", + "projectName": "app18700project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentprojects/app18700project/vmwarecollectors/Vmware2258collector", + "systemData": { + "createdAt": "0001-01-01T00:00:00", + "createdBy": null, + "createdByType": null, + "lastModifiedAt": "0001-01-01T00:00:00", + "lastModifiedBy": null, + "lastModifiedByType": null + }, + "name": "Vmware2258collector", + "type": "Microsoft.Migrate/assessmentprojects/vmwarecollectors", + "properties": { + "agentProperties": { + "id": "fe243486-3318-41fa-aaba-c48b5df75308", + "version": "1.0.8.383", + "lastHeartbeatUtc": "2022-03-29T12:10:08.9167289Z", + "spnDetails": { + "authority": "https://login.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "82b3e452-c0e8-4662-8347-58282925ae84", + "audience": "82b3e452-c0e8-4662-8347-58282925ae84", + "objectId": "3fc89111-1405-4938-9214-37aa4739401d", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawRG/providers/Microsoft.OffAzure/VMwareSites/Vmware2744site", + "createdTimestamp": "2022-03-28T13:41:17.5560477Z", + "updatedTimestamp": "2023-02-16T12:23:45.9695649Z" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b48e8c4873c4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,56 @@ +{ + "title": "WebAppAssessmentOptionsOperations_Get", + "operationId": "WebAppAssessmentOptionsOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "assessmentOptionsName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "WestEurope" + ] + } + ], + "savingsPlanSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedLocations": [ + "WestEurope" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3a440e7fb3b --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "92EA264C-A8A7-4192-A5E5-D9B487409240", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppSkus": [ + { + "webAppTier": "Premium_V3", + "targetLocations": [ + "PolandCentral" + ] + } + ], + "savingsPlanSupportedLocations": [ + "Unknown" + ], + "reservedInstanceSupportedLocations": [ + "AustraliaSoutheast" + ], + "reservedInstanceSupportedCurrencies": [ + "USD" + ], + "reservedInstanceSupportedOffers": [ + "MSAZR0003P" + ], + "reservedInstanceSupportedWebAppTiers": [ + "Premium_V3" + ], + "savingsPlanSupportedWebAppTiers": [ + "Premium_V3" + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webAppAssessmentOptions/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentprojects/webAppAssessmentOptions", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-06T05:40:17.507Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-06T05:40:17.507Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..bb14673c0e02 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json @@ -0,0 +1,167 @@ +{ + "title": "WebAppAssessmentV2Operations_Create_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "resource": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "status": "Created" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-v2-test", + "name": "anraghun-v2-test", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": "eatnpvdxza", + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": "rnfkzoaidy", + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..ab39129ddebd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json @@ -0,0 +1,16 @@ +{ + "title": "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json new file mode 100644 index 000000000000..15631ba5ae4d --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json @@ -0,0 +1,26 @@ +{ + "title": "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "body": {} + }, + "responses": { + "200": { + "body": { + "assessmentReportUrl": "https://assessmentsrvcanccysa2.blob.core.windows.net/cc1325ff-d42f-4c45-bfb6-12069e45becb/anraghun-selfhost-v2anraghun-v2-testWebAppAssessment.xlsx?sv=2018-03-28&sr=b&sig=NYBG6gJmofvIQsk1K1tewWfX51BpFZWsvIy7gBXNYUE%3D&st=2023-11-03T05%3A51%3A39Z&se=2023-11-03T06%3A26%3A39Z&sp=r", + "expirationTime": "2023-11-03T05:42:09.465Z" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53b3facf4279 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,70 @@ +{ + "title": "WebAppAssessmentV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-v2-test" + }, + "responses": { + "200": { + "body": { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "Unknown", + "currency": "MSAZR0003P", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..e64efd28c39f --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json @@ -0,0 +1,74 @@ +{ + "title": "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "environmentType": "Production", + "entityUptime": { + "daysPerMonth": 18, + "hoursPerDay": 13 + }, + "eaSubscriptionId": "", + "appSvcNativeSettings": { + "isolationRequired": true + }, + "appSvcContainerSettings": { + "isolationRequired": true + }, + "discoveredEntityLightSummary": { + "numberOfServers": 5, + "numberOfWebApps": 23, + "numberOfMachines": 27 + }, + "azureSecurityOfferingType": "NO", + "reservedInstance": "None", + "groupType": "Default", + "assessmentType": "WebAppAssessment", + "azureLocation": "UkWest", + "azureOfferCode": "MSAZR0003P", + "currency": "USD", + "scalingFactor": 17, + "percentile": "Percentile50", + "timeRange": "Day", + "perfDataStartTime": "2023-11-03T05:42:45.496Z", + "perfDataEndTime": "2023-11-03T05:42:45.496Z", + "stage": "InProgress", + "discountPercentage": 13, + "sizingCriterion": "PerformanceBased", + "confidenceRatingInPercentage": 13, + "pricesTimestamp": "2023-11-03T05:42:45.496Z", + "createdTimestamp": "2023-11-03T05:42:45.496Z", + "updatedTimestamp": "2023-11-03T05:42:45.496Z", + "status": "Created", + "schemaVersion": "2.0", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2", + "name": "anraghun-selfhost-v2", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4792774b016 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,61 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "summaryName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "suitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 21, + "monthlySecurityCost": 3, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 4 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..a10fdde3de45 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,65 @@ +{ + "title": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "assessmentSummary": { + "discoveredEntitiesSummary": { + "numberOfServers": 15, + "numberOfWebApps": 6, + "numberOfMachines": 24, + "webServerSummary": { + "iis": 13 + }, + "webAppSummary": { + "iis": 30 + } + } + }, + "targetSpecificSummary": { + "azureAppService": { + "readinessSummary": { + "conditionallySuitable": 13 + }, + "recommendationResultSkuDetails": { + "isolated": { + "totalMonthlyCost": 584, + "monthlySecurityCost": 0, + "skuName": "Isolated", + "skuSize": "I1", + "appServicePlanCount": 2 + } + } + } + } + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentProjects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/summaries/default", + "name": "default", + "type": "Microsoft.Migrate/assessmentProjects/groups/webAppAssessments", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/anxenhw" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9339ee47caf4 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json @@ -0,0 +1,99 @@ +{ + "title": "WebAppCollectorOperations_Create", + "operationId": "WebAppCollectorOperations_Create", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1", + "resource": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a451d12ce142 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json @@ -0,0 +1,15 @@ +{ + "title": "WebAppCollectorOperations_Delete", + "operationId": "WebAppCollectorOperations_Delete", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2b35e4770378 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "WebAppCollectorOperations_Get", + "operationId": "WebAppCollectorOperations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "collectorName": "collector1" + }, + "responses": { + "200": { + "body": { + "properties": { + "agentProperties": { + "id": "fed93df5-b787-4e3f-a764-e3d2b9101a59-agent", + "version": null, + "lastHeartbeatUtc": null, + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json new file mode 100644 index 000000000000..216dd036df36 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "WebAppCollectorOperations_ListByAssessmentProject", + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "agentProperties": { + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "version": null, + "lastHeartbeatUtc": "2023-11-03T05:43:02.078Z", + "spnDetails": { + "authority": "https://login.microsoftonline.com/72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "audience": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "objectId": "2f70d5e8-7adc-4c64-910a-7031079efc6e", + "tenantId": "2f70d5e8-7adc-4c64-910a-7031079efc6e" + } + }, + "discoverySiteId": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.OffAzure/MasterSites/sumukk-ccy-bcs9880mastersite/WebAppSites/sumukk-ccy-bcs9880webappsites", + "createdTimestamp": "2023-11-03T05:43:02.078Z", + "updatedTimestamp": "2023-11-03T05:43:02.078Z", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/webappcollectors/sumukk-ccy-bcs4a93webappsitecollector", + "name": "sumukk-ccy-bcs4a93webappsitecollector", + "type": "Microsoft.Migrate/assessmentprojects/webappcollectors", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..53fceead7c22 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json @@ -0,0 +1,52 @@ +{ + "title": "WebAppServicePlanV2Operations_Get_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_Get", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2", + "webAppServicePlanName": "plan-001" + }, + "responses": { + "200": { + "body": { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json new file mode 100644 index 000000000000..95878e631a15 --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json @@ -0,0 +1,60 @@ +{ + "title": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen - generated by [MaximumSet] rule", + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "6D59B561-47B6-4AB8-84B5-39CF2B808C26", + "resourceGroupName": "rgopenapi", + "$filter": "okepiszphg", + "pageSize": 18, + "$skipToken": "hcpyxryhoumfkypulwpsxxkzuu", + "totalRecordCount": 14, + "projectName": "sumukk-ccy-bcs4557project", + "groupName": "anraghun-selfhost-v2", + "assessmentName": "anraghun-selfhost-v2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "webAppType": "IIS", + "webAppTargetType": "AzureAppService", + "webAppServicePlanName": "Plan-001", + "numberOfWebApps": 2, + "monthlyCost": 20, + "storage": 25, + "scaleOutInstances": 8, + "cores": 17, + "ram": 18, + "webAppSkuName": "Isolated", + "webAppSkuSize": "I1", + "createdTimestamp": "2023-11-03T05:42:59.387Z", + "updatedTimestamp": "2023-11-03T05:42:59.387Z", + "costComponents": [ + { + "name": "MonthlySecurityCost", + "value": 16, + "description": null + } + ] + }, + "id": "/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/sumukk-ccy-bcs/providers/Microsoft.Migrate/assessmentprojects/sumukk-ccy-bcs4557project/groups/anraghun-selfhost-v2/webAppAssessments/anraghun-selfhost-v2/webAppServicePlans/plan-002-azureappservice", + "name": "plan-002-azureappservice", + "type": "Microsoft.Migrate/assessmentprojects/groups/webAppAssessments/webAppServicePlans", + "systemData": { + "createdBy": null, + "createdByType": "User", + "createdAt": "2023-11-03T05:41:40.597Z", + "lastModifiedBy": null, + "lastModifiedByType": "User", + "lastModifiedAt": "2023-11-03T05:41:40.597Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json new file mode 100644 index 000000000000..4780abbd83fd --- /dev/null +++ b/specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json @@ -0,0 +1,24820 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Migrate Assessment Service", + "version": "2023-05-01-preview", + "description": "Azure Migrate Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "AssessmentProjectsOperations" + }, + { + "name": "AssessmentProjectSummaryOperations" + }, + { + "name": "MachinesOperations" + }, + { + "name": "GroupsOperations" + }, + { + "name": "AssessmentsOperations" + }, + { + "name": "AssessmentOptionsOperations" + }, + { + "name": "AssessedMachinesOperations" + }, + { + "name": "HypervCollectorsOperations" + }, + { + "name": "VmwareCollectorsOperations" + }, + { + "name": "ServerCollectorsOperations" + }, + { + "name": "ImportCollectorsOperations" + }, + { + "name": "PrivateEndpointConnectionOperations" + }, + { + "name": "PrivateLinkResourceOperations" + }, + { + "name": "AvsAssessmentsOperations" + }, + { + "name": "AvsAssessmentOptionsOperations" + }, + { + "name": "AvsAssessedMachinesOperations" + }, + { + "name": "SqlAssessmentV2SummaryOperations" + }, + { + "name": "SqlAssessmentV2Operations" + }, + { + "name": "SqlAssessmentOptionsOperations" + }, + { + "name": "AssessedSqlMachinesOperations" + }, + { + "name": "AssessedSqlRecommendedEntityOperations" + }, + { + "name": "AssessedSqlInstanceV2Operations" + }, + { + "name": "AssessedSqlDatabaseV2Operations" + }, + { + "name": "SqlCollectorOperations" + }, + { + "name": "WebAppAssessmentV2SummaryOperations" + }, + { + "name": "WebAppAssessmentV2Operations" + }, + { + "name": "WebAppAssessmentOptionsOperations" + }, + { + "name": "AssessedWebAppV2Operations" + }, + { + "name": "WebAppServicePlanV2Operations" + }, + { + "name": "WebAppCollectorOperations" + }, + { + "name": "BusinessCaseOperations" + }, + { + "name": "BusinessCaseIaasSummaryOperations" + }, + { + "name": "BusinessCasePaasSummaryOperations" + }, + { + "name": "BusinessCaseOverviewSummaryOperations" + }, + { + "name": "BusinessCaseAvsSummaryOperations" + }, + { + "name": "EvaluatedMachinesOperations" + }, + { + "name": "EvaluatedSqlEntitiesOperations" + }, + { + "name": "EvaluatedWebAppsOperations" + }, + { + "name": "EvaluatedAvsMachinesOperations" + }, + { + "name": "AKSAssessmentOperations" + }, + { + "name": "AssessedWebApplicationOperations" + }, + { + "name": "AKSOptionsOperations" + }, + { + "name": "AKSSummaryOperations" + }, + { + "name": "AKSClusterOperations" + }, + { + "name": "AKSCostDetailOperations" + } + ], + "paths": { + "/providers/Microsoft.Migrate/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List_MaximumSet_Gen": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListBySubscription", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources 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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListBySubscription_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects": { + "get": { + "operationId": "AssessmentProjectsOperations_ListByResourceGroup", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "List AssessmentProject resources 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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_ListByResourceGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}": { + "get": { + "operationId": "AssessmentProjectsOperations_Get", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Get a AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentProjectsOperations_Create", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Create a AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AssessmentProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "201": { + "description": "Resource 'AssessmentProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/AssessmentProject" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "patch": { + "operationId": "AssessmentProjectsOperations_Update", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Update a AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AssessmentProjectUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "202": { + "description": "Resource update request accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentProjectsOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentProjectsOperations_Delete", + "tags": [ + "AssessmentProjectsOperations" + ], + "description": "Delete a AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions": { + "get": { + "operationId": "AksOptionsOperations_ListByAssessmentProject", + "tags": [ + "AKSOptionsOperations" + ], + "description": "List AKSAssessmentOptions resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AksOptionsOperations_Get", + "tags": [ + "AKSOptionsOperations" + ], + "description": "Get a AKSAssessmentOptions", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "AKS Assessment Options Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments": { + "get": { + "operationId": "AksAssessmentOperations_ListByAssessmentProject", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "List AKSAssessment resources by AssessmentProject", + "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": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}": { + "get": { + "operationId": "AksAssessmentOperations_Get", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get a AKSAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AksAssessmentOperations_Create", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Create a AKSAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AKSAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "201": { + "description": "Resource 'AKSAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AKSAssessment" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AksAssessmentOperations_Delete", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Delete a AKSAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksAssessmentOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebApplicationOperations_ListByAksAssessment", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "List AssessedWebApplication resources by AKSAssessment", + "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": "continuationToken", + "in": "query", + "description": "Continuation Token Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "Page Size Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total Record Count Query Parameter.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/assessedWebApps/{assessedWorkload}": { + "get": { + "operationId": "AssessedWebApplicationOperations_Get", + "tags": [ + "AssessedWebApplicationOperations" + ], + "description": "Get a AssessedWebApplication", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWorkload", + "in": "path", + "description": "Assessed Web Application Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebApplicationOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebApplicationOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters": { + "get": { + "operationId": "AksClusterOperations_ListByAksAssessment", + "tags": [ + "AKSClusterOperations" + ], + "description": "List AKSCluster resources by AKSAssessment", + "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": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksClusterOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/clusters/{clusterName}": { + "get": { + "operationId": "AksClusterOperations_Get", + "tags": [ + "AKSClusterOperations" + ], + "description": "Get a AKSCluster", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "clusterName", + "in": "path", + "description": "AKS Cluster Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksClusterOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksClusterOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/costDetails": { + "get": { + "operationId": "AksCostDetailOperations_ListByAksAssessment", + "tags": [ + "AKSCostDetailOperations" + ], + "description": "List AKSCostDetail resources by AKSAssessment", + "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": "$filter", + "in": "query", + "description": "Filter Query Parameter.", + "required": false, + "type": "string" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSCostDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksCostDetailOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AksAssessmentOperations_DownloadUrl", + "tags": [ + "AKSAssessmentOperations" + ], + "description": "Get URL for downloading AKS Assessment Report.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AksAssessmentOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AksAssessmentOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "AksSummaryOperations_ListByAksAssessment", + "tags": [ + "AKSSummaryOperations" + ], + "description": "List AKSSummary resources by AKSAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_ListByAksAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/aksAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "AksSummaryOperations_Get", + "tags": [ + "AKSSummaryOperations" + ], + "description": "Get a AKSSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AKS Assessment Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "AKS Assessment Summary Name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AKSSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AksSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AksSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions": { + "get": { + "operationId": "AssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "List AssessmentOptions resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/assessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "AssessmentOptionsOperations_Get", + "tags": [ + "AssessmentOptionsOperations" + ], + "description": "Get a AssessmentOptions", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": " assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "List AvsAssessmentOptions resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/avsAssessmentOptions/{avsAssessmentOptionsName}": { + "get": { + "operationId": "AvsAssessmentOptionsOperations_Get", + "tags": [ + "AvsAssessmentOptionsOperations" + ], + "description": "Get a AvsAssessmentOptions", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessmentOptionsName", + "in": "path", + "description": "AVS Assessment options ARM name. Accepted value is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases": { + "get": { + "operationId": "BusinessCaseOperations_ListByAssessmentProject", + "tags": [ + "BusinessCaseOperations" + ], + "description": "List BusinessCase resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCaseListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}": { + "get": { + "operationId": "BusinessCaseOperations_Get", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Get a BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BusinessCaseOperations_Create", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Create a BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BusinessCase" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BusinessCase' update operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + } + }, + "201": { + "description": "Resource 'BusinessCase' create operation succeeded", + "schema": { + "$ref": "#/definitions/BusinessCase" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "BusinessCaseOperations_Delete", + "tags": [ + "BusinessCaseOperations" + ], + "description": "Delete a BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "List AvsSummary resources by BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/avsSummaries/{avsSummaryName}": { + "get": { + "operationId": "BusinessCaseAvsSummaryOperations_Get", + "tags": [ + "BusinessCaseAvsSummaryOperations" + ], + "description": "Get a AvsSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsSummaryName", + "in": "path", + "description": "Gets the Name of the Avs Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseAvsSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/compareSummary": { + "post": { + "operationId": "BusinessCaseOperations_CompareSummary", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get Compare summary report for Business case.", + "description": "A long-running resource action.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CompareSummary" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_CompareSummary_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_CompareSummary_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "List EvaluatedAvsMachine resources by BusinessCase", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedAvsMachines/{evaluatedAvsMachineName}": { + "get": { + "operationId": "EvaluatedAvsMachinesOperations_Get", + "tags": [ + "EvaluatedAvsMachinesOperations" + ], + "description": "Get a EvaluatedAvsMachine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedAvsMachineName", + "in": "path", + "description": "Business case Evaluated AVS machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedAvsMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines": { + "get": { + "operationId": "EvaluatedMachinesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "List EvaluatedMachine resources by BusinessCase", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedMachines/{evaluatedMachineName}": { + "get": { + "operationId": "EvaluatedMachinesOperations_Get", + "tags": [ + "EvaluatedMachinesOperations" + ], + "description": "Get a EvaluatedMachine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedMachineName", + "in": "path", + "description": "Business case Evaluated machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_ListByBusinessCase", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "List EvaluatedSqlEntity resources by BusinessCase", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedSqlEntities/{evaluatedSqlEntityName}": { + "get": { + "operationId": "EvaluatedSqlEntitiesOperations_Get", + "tags": [ + "EvaluatedSqlEntitiesOperations" + ], + "description": "Get a EvaluatedSqlEntity", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedSqlEntityName", + "in": "path", + "description": "Business case Evaluated sql entity ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedSqlEntitiesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps": { + "get": { + "operationId": "EvaluatedWebAppsOperations_ListByBusinessCase", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "List EvaluatedWebApp resources by BusinessCase", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/evaluatedWebApps/{evaluatedWebAppName}": { + "get": { + "operationId": "EvaluatedWebAppsOperations_Get", + "tags": [ + "EvaluatedWebAppsOperations" + ], + "description": "Get a EvaluatedWebApp", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "evaluatedWebAppName", + "in": "path", + "description": "Business case Evaluated web App ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EvaluatedWebAppsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/EvaluatedWebAppsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/getReportDownloadUrl": { + "post": { + "operationId": "BusinessCaseOperations_GetReportDownloadUrl", + "tags": [ + "BusinessCaseOperations" + ], + "summary": "Get download URL for the business case report.", + "description": "Get the URL for downloading the business case in a report format.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ReportDownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOperations_GetReportDownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "List IaasSummary resources by BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/iaasSummaries/{iaasSummaryName}": { + "get": { + "operationId": "BusinessCaseIaasSummaryOperations_Get", + "tags": [ + "BusinessCaseIaasSummaryOperations" + ], + "description": "Get a IaasSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "iaasSummaryName", + "in": "path", + "description": "Gets the Name of the Iaas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/IaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseIaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "List OverviewSummary resources by BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/overviewSummaries/{overviewSummaryName}": { + "get": { + "operationId": "BusinessCaseOverviewSummaryOperations_Get", + "tags": [ + "BusinessCaseOverviewSummaryOperations" + ], + "description": "Get a OverviewSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "overviewSummaryName", + "in": "path", + "description": "Gets the Name of the Overview Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCaseOverviewSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_ListByBusinessCase", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "List PaasSummary resources by BusinessCase", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_ListByBusinessCase_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/businessCases/{businessCaseName}/paasSummaries/{paasSummaryName}": { + "get": { + "operationId": "BusinessCasePaasSummaryOperations_Get", + "tags": [ + "BusinessCasePaasSummaryOperations" + ], + "description": "Get a PaasSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "businessCaseName", + "in": "path", + "description": "Business case ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "paasSummaryName", + "in": "path", + "description": "Gets the Name of the Paas Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PaasSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/BusinessCasePaasSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups": { + "get": { + "operationId": "GroupsOperations_ListByAssessmentProject", + "tags": [ + "GroupsOperations" + ], + "description": "List Group resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/GroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GroupsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}": { + "get": { + "operationId": "GroupsOperations_Get", + "tags": [ + "GroupsOperations" + ], + "description": "Get a 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "GroupsOperations_Create", + "tags": [ + "GroupsOperations" + ], + "description": "Create a 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Group" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Group' update operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "201": { + "description": "Resource 'Group' create operation succeeded", + "schema": { + "$ref": "#/definitions/Group" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "GroupsOperations_Delete", + "tags": [ + "GroupsOperations" + ], + "description": "Delete a 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GroupsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments": { + "get": { + "operationId": "AssessmentsOperations_ListByGroup", + "tags": [ + "AssessmentsOperations" + ], + "description": "List Assessment resources by 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}": { + "get": { + "operationId": "AssessmentsOperations_Get", + "tags": [ + "AssessmentsOperations" + ], + "description": "Get a Assessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AssessmentsOperations_Create", + "tags": [ + "AssessmentsOperations" + ], + "description": "Create a Assessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Assessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Assessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + } + }, + "201": { + "description": "Resource 'Assessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Assessment" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AssessmentsOperations_Delete", + "tags": [ + "AssessmentsOperations" + ], + "description": "Delete a Assessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines": { + "get": { + "operationId": "AssessedMachinesOperations_ListByAssessment", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "List AssessedMachine resources by Assessment", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_ListByAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { + "get": { + "operationId": "AssessedMachinesOperations_Get", + "tags": [ + "AssessedMachinesOperations" + ], + "description": "Get a AssessedMachine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedMachineName", + "in": "path", + "description": "Machine assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AssessmentsOperations_DownloadUrl", + "tags": [ + "AssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Machine Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments": { + "get": { + "operationId": "AvsAssessmentsOperations_ListByGroup", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "List AvsAssessment resources by 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}": { + "get": { + "operationId": "AvsAssessmentsOperations_Get", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Get a AvsAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "AvsAssessmentsOperations_Create", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Create a AvsAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AvsAssessment' update operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "201": { + "description": "Resource 'AvsAssessment' create operation succeeded", + "schema": { + "$ref": "#/definitions/AvsAssessment" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "AvsAssessmentsOperations_Delete", + "tags": [ + "AvsAssessmentsOperations" + ], + "description": "Delete a AvsAssessment", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessmentsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines": { + "get": { + "operationId": "AvsAssessedMachinesOperations_ListByAvsAssessment", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "List AvsAssessedMachine resources by AvsAssessment", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_ListByAvsAssessment_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/avsAssessedMachines/{avsAssessedMachineName}": { + "get": { + "operationId": "AvsAssessedMachinesOperations_Get", + "tags": [ + "AvsAssessedMachinesOperations" + ], + "description": "Get a AvsAssessedMachine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "avsAssessedMachineName", + "in": "path", + "description": "AVS assessment Assessed Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AvsAssessedMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessedMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/avsAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "AvsAssessmentsOperations_DownloadUrl", + "tags": [ + "AvsAssessmentsOperations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "AVS Assessment ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/AvsAssessmentsOperations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments": { + "get": { + "operationId": "SqlAssessmentV2Operations_ListByGroup", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "List SqlAssessmentV2 resources by 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}": { + "get": { + "operationId": "SqlAssessmentV2Operations_Get", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Get a SqlAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlAssessmentV2Operations_Create", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Create a SqlAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "201": { + "description": "Resource 'SqlAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlAssessmentV2Operations_Delete", + "tags": [ + "SqlAssessmentV2Operations" + ], + "description": "Delete a SqlAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "List AssessedSqlDatabaseV2 resources by SqlAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlDatabases/{assessedSqlDatabaseName}": { + "get": { + "operationId": "AssessedSqlDatabaseV2Operations_Get", + "tags": [ + "AssessedSqlDatabaseV2Operations" + ], + "description": "Get a AssessedSqlDatabaseV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlDatabaseName", + "in": "path", + "description": "Sql assessment Assessed Databases ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlDatabaseV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "List AssessedSqlInstanceV2 resources by SqlAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlInstances/{assessedSqlInstanceName}": { + "get": { + "operationId": "AssessedSqlInstanceV2Operations_Get", + "tags": [ + "AssessedSqlInstanceV2Operations" + ], + "description": "Get a AssessedSqlInstanceV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlInstanceName", + "in": "path", + "description": "Sql assessment Assessed Instance ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlInstanceV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines": { + "get": { + "operationId": "AssessedSqlMachinesOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "List AssessedSqlMachine resources by SqlAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/assessedSqlMachines/{assessedSqlMachineName}": { + "get": { + "operationId": "AssessedSqlMachinesOperations_Get", + "tags": [ + "AssessedSqlMachinesOperations" + ], + "description": "Get a AssessedSqlMachine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedSqlMachineName", + "in": "path", + "description": "Sql assessment Assessed Machine ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlMachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlMachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "SqlAssessmentV2Operations_DownloadUrl", + "tags": [ + "SqlAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "List AssessedSqlRecommendedEntity resources by SqlAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/recommendedAssessedEntities/{recommendedAssessedEntityName}": { + "get": { + "operationId": "AssessedSqlRecommendedEntityOperations_Get", + "tags": [ + "AssessedSqlRecommendedEntityOperations" + ], + "description": "Get a AssessedSqlRecommendedEntity", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "recommendedAssessedEntityName", + "in": "path", + "description": "Sql assessment Assessed Recommended Entity ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedSqlRecommendedEntityOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "List SqlAssessmentV2Summary resources by SqlAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_ListBySqlAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/sqlAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "SqlAssessmentV2SummaryOperations_Get", + "tags": [ + "SqlAssessmentV2SummaryOperations" + ], + "description": "Get a SqlAssessmentV2Summary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "SQL Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the SQL Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/updateMachines": { + "post": { + "operationId": "GroupsOperations_UpdateMachines", + "tags": [ + "GroupsOperations" + ], + "summary": "Update machines in group.", + "description": "Update machines in group by adding or removing machines.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGroupBody" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Group" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "GroupsOperations_UpdateMachines_MaximumSet_Gen": { + "$ref": "./examples/GroupsOperations_UpdateMachines_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments": { + "get": { + "operationId": "WebAppAssessmentV2Operations_ListByGroup", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "List WebAppAssessmentV2 resources by 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" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_ListByGroup_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}": { + "get": { + "operationId": "WebAppAssessmentV2Operations_Get", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Get a WebAppAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppAssessmentV2Operations_Create", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Create a WebAppAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppAssessmentV2' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "201": { + "description": "Resource 'WebAppAssessmentV2' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppAssessmentV2Operations_Delete", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "description": "Delete a WebAppAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2Operations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps": { + "get": { + "operationId": "AssessedWebAppV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "List AssessedWebAppV2 resources by WebAppAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/assessedWebApps/{assessedWebAppName}": { + "get": { + "operationId": "AssessedWebAppV2Operations_Get", + "tags": [ + "AssessedWebAppV2Operations" + ], + "description": "Get a AssessedWebAppV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessedWebAppName", + "in": "path", + "description": "Assessed web app ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessedWebAppV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessedWebAppV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/downloadUrl": { + "post": { + "operationId": "WebAppAssessmentV2Operations_DownloadUrl", + "tags": [ + "WebAppAssessmentV2Operations" + ], + "summary": "Get download URL for the assessment report.", + "description": "Get the URL for downloading the assessment in a report format.", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2Operations_DownloadUrl_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "List WebAppAssessmentV2Summary resources by WebAppAssessmentV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/summaries/{summaryName}": { + "get": { + "operationId": "WebAppAssessmentV2SummaryOperations_Get", + "tags": [ + "WebAppAssessmentV2SummaryOperations" + ], + "description": "Get a WebAppAssessmentV2Summary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "summaryName", + "in": "path", + "description": "Gets the Name of the Web app Summary.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentV2SummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans": { + "get": { + "operationId": "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "List WebAppServicePlanV2 resources by WebAppAssessmentV2", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2ListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_ListByWebAppAssessmentV2_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/webAppAssessments/{assessmentName}/webAppServicePlans/{webAppServicePlanName}": { + "get": { + "operationId": "WebAppServicePlanV2Operations_Get", + "tags": [ + "WebAppServicePlanV2Operations" + ], + "description": "Get a WebAppServicePlanV2", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "groupName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentName", + "in": "path", + "description": "Web app Assessment arm name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "webAppServicePlanName", + "in": "path", + "description": "Web app service plan ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppServicePlanV2Operations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppServicePlanV2Operations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors": { + "get": { + "operationId": "HypervCollectorsOperations_ListByAssessmentProject", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "List HypervCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/hypervcollectors/{hypervCollectorName}": { + "get": { + "operationId": "HypervCollectorsOperations_Get", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Get a HypervCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "HypervCollectorsOperations_Create", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Create a HypervCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/HypervCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'HypervCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + } + }, + "201": { + "description": "Resource 'HypervCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/HypervCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "HypervCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "HypervCollectorsOperations_Delete", + "tags": [ + "HypervCollectorsOperations" + ], + "description": "Delete a HypervCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "hypervCollectorName", + "in": "path", + "description": "Hyper-V collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HypervCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/HypervCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors": { + "get": { + "operationId": "ImportCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "List ImportCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/importcollectors/{importCollectorName}": { + "get": { + "operationId": "ImportCollectorsOperations_Get", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Get a ImportCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ImportCollectorsOperations_Create", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Create a ImportCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ImportCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + } + }, + "201": { + "description": "Resource 'ImportCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ImportCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ImportCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ImportCollectorsOperations_Delete", + "tags": [ + "ImportCollectorsOperations" + ], + "description": "Delete a ImportCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "importCollectorName", + "in": "path", + "description": "Import collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImportCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ImportCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines": { + "get": { + "operationId": "MachinesOperations_ListByAssessmentProject", + "tags": [ + "MachinesOperations" + ], + "description": "List Machine resources by AssessmentProject", + "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": "$filter", + "in": "query", + "description": "Filter query.", + "required": false, + "type": "string" + }, + { + "name": "pageSize", + "in": "query", + "description": "Optional parameter for page size.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "continuationToken", + "in": "query", + "description": "Optional parameter for continuation token.", + "required": false, + "type": "string" + }, + { + "name": "totalRecordCount", + "in": "query", + "description": "Total record count.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/MachineListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MachinesOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/machines/{machineName}": { + "get": { + "operationId": "MachinesOperations_Get", + "tags": [ + "MachinesOperations" + ], + "description": "Get a Machine", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "machineName", + "in": "path", + "description": "Assessible Machine ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Machine" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MachinesOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/MachinesOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_ListByAssessmentProject", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "List PrivateEndpointConnection resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnectionOperations_Get", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Get a PrivateEndpointConnection", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnectionOperations_Update", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Create a PrivateEndpointConnection", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Update_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "PrivateEndpointConnectionOperations_Delete", + "tags": [ + "PrivateEndpointConnectionOperations" + ], + "description": "Delete a PrivateEndpointConnection", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/PrivateEndpointConnectionOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinkResourceOperations_ListByAssessmentProject", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "List PrivateLinkResource resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "operationId": "PrivateLinkResourceOperations_Get", + "tags": [ + "PrivateLinkResourceOperations" + ], + "description": "Get a PrivateLinkResource", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "Private link resource ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinkResourceOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/PrivateLinkResourceOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_ListByAssessmentProject", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "List AssessmentProjectSummary resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/projectSummary/{projectSummaryName}": { + "get": { + "operationId": "AssessmentProjectSummaryOperations_Get", + "tags": [ + "AssessmentProjectSummaryOperations" + ], + "description": "Get a AssessmentProjectSummary", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "projectSummaryName", + "in": "path", + "description": "Group ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AssessmentProjectSummaryOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/AssessmentProjectSummaryOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors": { + "get": { + "operationId": "ServerCollectorsOperations_ListByAssessmentProject", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "List ServerCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/servercollectors/{serverCollectorName}": { + "get": { + "operationId": "ServerCollectorsOperations_Get", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Get a ServerCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "ServerCollectorsOperations_Create", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Create a ServerCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ServerCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + } + }, + "201": { + "description": "Resource 'ServerCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/ServerCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ServerCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "ServerCollectorsOperations_Delete", + "tags": [ + "ServerCollectorsOperations" + ], + "description": "Delete a ServerCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "serverCollectorName", + "in": "path", + "description": "Physical server collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ServerCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/ServerCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "List SqlAssessmentOptions resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "SqlAssessmentOptionsOperations_Get", + "tags": [ + "SqlAssessmentOptionsOperations" + ], + "description": "Get a SqlAssessmentOptions", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Sql assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors": { + "get": { + "operationId": "SqlCollectorOperations_ListByAssessmentProject", + "tags": [ + "SqlCollectorOperations" + ], + "description": "List SqlCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/sqlcollectors/{collectorName}": { + "get": { + "operationId": "SqlCollectorOperations_Get", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Get a SqlCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "SqlCollectorOperations_Create", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Create a SqlCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqlCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + } + }, + "201": { + "description": "Resource 'SqlCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqlCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SqlCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "SqlCollectorOperations_Delete", + "tags": [ + "SqlCollectorOperations" + ], + "description": "Delete a SqlCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Sql collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqlCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/SqlCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors": { + "get": { + "operationId": "VmwareCollectorsOperations_ListByAssessmentProject", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "List VmwareCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/vmwarecollectors/{vmWareCollectorName}": { + "get": { + "operationId": "VmwareCollectorsOperations_Get", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Get a VmwareCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "VmwareCollectorsOperations_Create", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Create a VmwareCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VmwareCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "201": { + "description": "Resource 'VmwareCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/VmwareCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VmwareCollectorsOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "VmwareCollectorsOperations_Delete", + "tags": [ + "VmwareCollectorsOperations" + ], + "description": "Delete a VmwareCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "vmWareCollectorName", + "in": "path", + "description": "VMware collector ARM name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VmwareCollectorsOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/VmwareCollectorsOperations_Delete_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_ListByAssessmentProject", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "List WebAppAssessmentOptions resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptionsListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppAssessmentOptions/{assessmentOptionsName}": { + "get": { + "operationId": "WebAppAssessmentOptionsOperations_Get", + "tags": [ + "WebAppAssessmentOptionsOperations" + ], + "description": "Get a WebAppAssessmentOptions", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "assessmentOptionsName", + "in": "path", + "description": "Web app assessment options ARM name. Accepted values is 'default'", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppAssessmentOptionsOperations_Get_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors": { + "get": { + "operationId": "WebAppCollectorOperations_ListByAssessmentProject", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "List WebAppCollector resources by AssessmentProject", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_ListByAssessmentProject_MaximumSet_Gen.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/webAppCollectors/{collectorName}": { + "get": { + "operationId": "WebAppCollectorOperations_Get", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Get a WebAppCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Get_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "WebAppCollectorOperations_Create", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Create a WebAppCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WebAppCollector' update operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "201": { + "description": "Resource 'WebAppCollector' create operation succeeded", + "schema": { + "$ref": "#/definitions/WebAppCollector" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "WebAppCollectorOperations_Create_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Create_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "WebAppCollectorOperations_Delete", + "tags": [ + "WebAppCollectorOperations" + ], + "description": "Delete a WebAppCollector", + "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": "projectName", + "in": "path", + "description": "Assessment Project Name", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + }, + { + "name": "collectorName", + "in": "path", + "description": "Web app collector ARM name.", + "required": true, + "type": "string", + "pattern": "^[^<>&:\\?/#]{1,260}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WebAppCollectorOperations_Delete_MaximumSet_Gen": { + "$ref": "./examples/WebAppCollectorOperations_Delete_MaximumSet_Gen.json" + } + } + } + } + }, + "definitions": { + "AKSAssessment": { + "type": "object", + "description": "ARM model of AKS Assessment.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentDetails": { + "type": "object", + "description": "Data model of AKS Assessment Details.", + "properties": { + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentDetails" + } + ] + }, + "AKSAssessmentListResult": { + "type": "object", + "description": "The response of a AKSAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessment items on this page", + "items": { + "$ref": "#/definitions/AKSAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptions": { + "type": "object", + "description": "ARM model of AKS Assessment Options.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSAssessmentOptionsProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AKSAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AKSAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSAssessmentOptionsProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Options Properties.", + "allOf": [ + { + "$ref": "#/definitions/OptionsArmPropertiesBase" + } + ] + }, + "AKSAssessmentProperties": { + "type": "object", + "description": "ARM model of AKS Assessment Properties.", + "properties": { + "settings": { + "$ref": "#/definitions/AKSAssessmentSettings", + "description": "Gets or sets AKS Assessment Settings." + }, + "details": { + "$ref": "#/definitions/AKSAssessmentDetails", + "description": "Gets AKS Assessment Details.", + "readOnly": true + } + }, + "required": [ + "settings" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentPropertiesBase" + } + ] + }, + "AKSAssessmentSettings": { + "type": "object", + "description": "Data model of AKS Assessment Settings.", + "properties": { + "category": { + "$ref": "#/definitions/AzureVmCategory", + "description": "Gets or sets azure VM category." + }, + "savingsOptions": { + "$ref": "#/definitions/SavingsOptions", + "description": "Gets or sets savings options." + }, + "consolidation": { + "$ref": "#/definitions/ConsolidationType", + "description": "Gets or sets consolidation type." + }, + "pricingTier": { + "$ref": "#/definitions/PricingTier", + "description": "Gets or sets pricing tier." + } + }, + "required": [ + "category", + "savingsOptions", + "consolidation", + "pricingTier" + ], + "allOf": [ + { + "$ref": "#/definitions/AssessmentSettings" + } + ] + }, + "AKSAssessmentSummary": { + "type": "object", + "description": "Data model of AKS Assessment Summary.", + "properties": { + "skuSummary": { + "type": "object", + "description": "Gets SKU summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Gets web app summary.", + "additionalProperties": { + "$ref": "#/definitions/SummaryDetails" + }, + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Gets web server summary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web apps.", + "readOnly": true + }, + "webServerCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of web servers.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines.", + "readOnly": true + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets the total monthly cost.", + "readOnly": true + } + }, + "required": [ + "skuSummary", + "webAppSummary", + "webServerSummary", + "webAppCount", + "webServerCount", + "machineCount", + "totalMonthlyCost" + ] + }, + "AKSCluster": { + "type": "object", + "description": "ARM model of AKS Cluster.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSClusterProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSClusterListResult": { + "type": "object", + "description": "The response of a AKSCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCluster items on this page", + "items": { + "$ref": "#/definitions/AKSCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSClusterProperties": { + "type": "object", + "description": "ARM model of AKS Cluster Properties.", + "allOf": [ + { + "$ref": "#/definitions/Cluster" + } + ] + }, + "AKSCostDetail": { + "type": "object", + "description": "ARM model of AKS Cost Detail.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSCostDetailProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSCostDetailListResult": { + "type": "object", + "description": "The response of a AKSCostDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSCostDetail items on this page", + "items": { + "$ref": "#/definitions/AKSCostDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSCostDetailProperties": { + "type": "object", + "description": "ARM model of AKS Cost Detail Properties.", + "allOf": [ + { + "$ref": "#/definitions/NodePool" + } + ] + }, + "AKSSummary": { + "type": "object", + "description": "ARM model of AKS Summary.", + "properties": { + "properties": { + "$ref": "#/definitions/AKSSummaryProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AKSSummaryListResult": { + "type": "object", + "description": "The response of a AKSSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AKSSummary items on this page", + "items": { + "$ref": "#/definitions/AKSSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AKSSummaryProperties": { + "type": "object", + "description": "ARM model of AKS Summary Properties.", + "properties": { + "aksAssessmentSummary": { + "$ref": "#/definitions/AKSAssessmentSummary", + "description": "Gets AKS assessment summary.", + "readOnly": true + } + }, + "required": [ + "aksAssessmentSummary" + ], + "allOf": [ + { + "$ref": "#/definitions/SummaryPropertiesBase" + } + ] + }, + "ApiVersions": { + "type": "string", + "description": "Common API Versions for Assessment Project Tracked Resource.", + "enum": [ + "2019-10-01", + "2020-01-01", + "2020-05-01-preview", + "2022-02-02-preview", + "2022-08-01-preview", + "2023-03-03", + "2023-03-15", + "2023-04-01-preview", + "2023-05-01-preview", + "2023-07-07-preview" + ], + "x-ms-enum": { + "name": "ApiVersions", + "modelAsString": true, + "values": [ + { + "name": "v2019_10_01", + "value": "2019-10-01", + "description": "2019-10-01 API Version." + }, + { + "name": "v2020_01_01", + "value": "2020-01-01", + "description": "2020-01-01 API Version." + }, + { + "name": "v2020_05_01_preview", + "value": "2020-05-01-preview", + "description": "2020-05-01-preview API Version." + }, + { + "name": "v2022_02_02_preview", + "value": "2022-02-02-preview", + "description": "2022-02-02-preview API Version." + }, + { + "name": "v2022_08_01_preview", + "value": "2022-08-01-preview", + "description": "2022-08-01-preview API Version." + }, + { + "name": "v2023_03_03", + "value": "2023-03-03", + "description": "2023-03-03 API Version." + }, + { + "name": "v2023_03_15", + "value": "2023-03-15", + "description": "2023-03-15 API Version." + }, + { + "name": "v2023_04_01_preview", + "value": "2023-04-01-preview", + "description": "2023-04-01-preview API Version." + }, + { + "name": "v2023_05_01_preview", + "value": "2023-05-01-preview", + "description": "2023-05-01-preview API Version." + }, + { + "name": "v2023_07_07_preview", + "value": "2023-07-07-preview", + "description": "2023-07-07-preview API Version." + } + ] + } + }, + "AppServiceSku": { + "type": "object", + "description": "The app service SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans recommended.", + "readOnly": true + } + } + }, + "AppSvcContainerSettings": { + "type": "object", + "description": "App service container settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AppSvcNativeSettings": { + "type": "object", + "description": "App service native settings.", + "properties": { + "isolationRequired": { + "type": "boolean", + "description": "Gets or sets the isolation required." + } + }, + "required": [ + "isolationRequired" + ] + }, + "AssessedDisk": { + "type": "object", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "gigabytesForRecommendedDiskSize": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedDiskData": { + "type": "object", + "description": "Assessed Disk data. Used in Assessed SQL machine DTO.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureDiskSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "recommendedDiskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the recommended disk size." + }, + "recommendedDiskType": { + "$ref": "#/definitions/AzureDiskType", + "description": "Gets the recommended disk type." + }, + "recommendedDiskSizeGigabytes": { + "type": "integer", + "format": "int32", + "description": "Gets the recommended disk size." + }, + "recommendDiskThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk throughput." + }, + "recommendedDiskIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended disk iops." + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the machine display name." + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gets the gigabytes provisioned." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedMachine": { + "type": "object", + "description": "Machine assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedMachineProperties", + "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/ProxyResource" + } + ] + }, + "AssessedMachineListResult": { + "type": "object", + "description": "The response of a AssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedMachineProperties": { + "type": "object", + "description": "Assessed machine properties class.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "Dictionary of disks attached to the machine. Key is ID of disk. Value is a disk object.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDisk" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly ultra storage cost.", + "readOnly": true + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets or sets the processor details of the host." + }, + "costComponents": { + "type": "array", + "description": "Gets or sets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly premium storage cost.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly standard SSD storage cost.", + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedNetworkAdapter" + }, + "readOnly": true + }, + "recommendedSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Recommended Azure Size for the machine.", + "readOnly": true + }, + "numberOfCoresForRecommendedSize": { + "type": "integer", + "format": "int32", + "description": "Number of cores for recommended size. Read Only.", + "readOnly": true + }, + "megabytesOfMemoryForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Megabytes of memory for recommended size. Read Only.", + "readOnly": true + }, + "monthlyComputeCostForRecommendedSize": { + "type": "number", + "format": "float", + "description": "Monthly Compute cost calculated for Recommended size, for a 31-day month.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AssessedMachineType": { + "type": "string", + "enum": [ + "Unknown", + "AssessedMachine", + "AvsAssessedMachine", + "SqlAssessedMachine" + ], + "x-ms-enum": { + "name": "AssessedMachineType", + "modelAsString": true + } + }, + "AssessedNetworkAdapter": { + "type": "object", + "description": "Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "AssessedSqlDatabaseV2": { + "type": "object", + "description": "Assessed SQL database web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlDatabaseV2Properties", + "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/ProxyResource" + } + ] + }, + "AssessedSqlDatabaseV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlDatabaseV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlDatabaseV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlDatabaseV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlDatabaseV2Properties": { + "type": "object", + "description": "Assessed SQL database properties web model.", + "properties": { + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "bufferCacheSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregated cache size of this database. This is a performance\ndata metric for this DB.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "Gets or sets the azure SQL DB suitability details.", + "readOnly": true + }, + "isDatabaseHighlyAvailable": { + "type": "boolean", + "description": "Gets a value indicating whether the assessed SQL database is highly available\nor not.", + "readOnly": true + }, + "linkedAvailabilityGroupOverview": { + "$ref": "#/definitions/SqlAvailabilityGroupDataOverview", + "description": "Gets the linked availability group overview if the database being assessed is\nhighly available.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "assessedSqlInstanceArmId": { + "type": "string", + "description": "Assessed SQL instance arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "SQL database name.", + "readOnly": true + }, + "databaseSizeInMB": { + "type": "number", + "format": "float", + "description": "SQL database size in megabytes.", + "readOnly": true + }, + "compatibilityLevel": { + "$ref": "#/definitions/CompatibilityLevel", + "description": "Database compatibility level.", + "readOnly": true + }, + "sqlDatabaseSdsArmId": { + "type": "string", + "description": "SQL database SDS arm id.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "The read throughput of the SQL database.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "The write throughput of the SQL database.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The read operations per second of the SQL database.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "The write operations per second of the SQL database.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database last updated.", + "readOnly": true + } + } + }, + "AssessedSqlInstanceDatabaseSummary": { + "type": "object", + "description": "Assessed Sql Instance Database Summary.", + "properties": { + "numberOfUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the number of user databases." + }, + "totalDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the total database size in MB." + }, + "largestDatabaseSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the largest database size in MB." + }, + "totalDiscoveredUserDatabases": { + "type": "integer", + "format": "int32", + "description": "Gets the total discovered user databases." + } + } + }, + "AssessedSqlInstanceDiskDetails": { + "type": "object", + "description": "Assessed Sql Instance Disk Details.", + "properties": { + "diskId": { + "type": "string", + "description": "Gets the disk id." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of write." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceStorageDetails": { + "type": "object", + "description": "Assessed Sql Instance Storage Details.", + "properties": { + "storageType": { + "type": "string", + "description": "Gets the storage type." + }, + "diskSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the disk size in mb." + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second of read." + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of read operations per second." + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Gets the number of write operations per second." + } + } + }, + "AssessedSqlInstanceSummary": { + "type": "object", + "description": "Assessed Sql Instance Summary.", + "properties": { + "instanceId": { + "type": "string", + "description": "Gets the instance id." + }, + "instanceName": { + "type": "string", + "description": "Gets the instance name." + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "Gets the instance arm id." + }, + "sqlInstanceEntityId": { + "type": "string", + "description": "Gets the instance entity id." + }, + "sqlEdition": { + "type": "string", + "description": "Gets the Sql edition." + }, + "sqlVersion": { + "type": "string", + "description": "Gets the Sql version." + }, + "isClustered": { + "type": "boolean", + "description": "Gets whether Sql is clustered." + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets whether Sql is highly available." + }, + "sqlFciState": { + "$ref": "#/definitions/SqlFCIState", + "description": "Gets the Sql Fci state." + } + } + }, + "AssessedSqlInstanceV2": { + "type": "object", + "description": "Assessed SQL instance web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlInstanceV2Properties", + "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/ProxyResource" + } + ] + }, + "AssessedSqlInstanceV2ListResult": { + "type": "object", + "description": "The response of a AssessedSqlInstanceV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlInstanceV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlInstanceV2Properties": { + "type": "object", + "description": "Assessed SQL instance properties web model.", + "properties": { + "memoryInUseInMB": { + "type": "number", + "format": "float", + "description": "Gets or sets the memory used by SQL instance in megabytes.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether SQL instance has been deep discovered.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "storageTypeBasedDetails": { + "type": "array", + "description": "Gets the storage details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceStorageDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "fciMetadata": { + "$ref": "#/definitions/SqlFCIMetadata", + "description": "Gets the FCI metadata if this instance represents an FCI instance.", + "readOnly": true + }, + "availabilityReplicaSummary": { + "$ref": "#/definitions/SqlAvailabilityReplicaSummary", + "description": "Gets the overview counts of availability replicas in the assessed instance, by\ncommit mode and read type.", + "readOnly": true + }, + "isClustered": { + "type": "boolean", + "description": "Gets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "recommendedTargetReasonings": { + "type": "array", + "description": "Gets the list of recommended target reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "machineArmId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Machine display name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL instance name.", + "readOnly": true + }, + "sqlInstanceSdsArmId": { + "type": "string", + "description": "SQL instance SDS arm id.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL instance edition.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL instance version.", + "readOnly": true + }, + "numberOfCoresAllocated": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores assigned to the SQL instance.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "The percentage of the total number of cores being utilized by the SQL instance.", + "readOnly": true + }, + "logicalDisks": { + "type": "array", + "description": "The logical disk details.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceDiskDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "databaseSummary": { + "$ref": "#/definitions/AssessedSqlInstanceDatabaseSummary", + "description": "The databases summary.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL instance last updated.", + "readOnly": true + } + } + }, + "AssessedSqlMachine": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlMachineProperties", + "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/ProxyResource" + } + ] + }, + "AssessedSqlMachineListResult": { + "type": "object", + "description": "The response of a AssessedSqlMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlMachine items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlMachineProperties": { + "type": "object", + "description": "Assessed SQL machine properties.", + "properties": { + "biosGuid": { + "type": "string", + "description": "Gets or sets the BIOS GUID for the machine.", + "readOnly": true + }, + "fqdn": { + "type": "string", + "description": "Gets or sets the FQDN for the machine.", + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "Gets the list of SQL instances discovered on the machine.", + "items": { + "$ref": "#/definitions/AssessedSqlInstanceSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureVmSuitabilityDetail", + "description": "Gets or sets the detailed messages that were set on the machine during\nevaluation.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureVmSuitabilityExplanation", + "description": "Gets or sets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "recommendedVmSize": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets or sets the Recommended Azure Size for the machine.", + "readOnly": true + }, + "recommendedVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets or sets the Recommended Azure VM Family for the machine.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "recommendedVmSizeNumberOfCores": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of cores for recommended size.", + "readOnly": true + }, + "recommendedVmSizeMegabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Gets or sets the Megabytes of memory for recommended size.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly compute cost calculated for recommended size.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Gets the list of data disks that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/AssessedDiskData" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Gets the list of network adapters that were assessed as part of this assessment.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessedNetworkAdapter" + }, + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly networking cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the monthly total storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedSqlRecommendedEntity": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedSqlRecommendedEntityProperties", + "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/ProxyResource" + } + ] + }, + "AssessedSqlRecommendedEntityListResult": { + "type": "object", + "description": "The response of a AssessedSqlRecommendedEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedSqlRecommendedEntity items on this page", + "items": { + "$ref": "#/definitions/AssessedSqlRecommendedEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedSqlRecommendedEntityProperties": { + "type": "object", + "description": "Assessed SQL recommended entity properties.", + "properties": { + "machineName": { + "type": "string", + "description": "Gets or sets machine name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "Gets or sets SQL instance name.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets assessed database count.", + "readOnly": true + }, + "discoveredDBCount": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the total discovered database count.", + "readOnly": true + }, + "hasScanOccurred": { + "type": "boolean", + "description": "Gets or sets a value indicating whether instance deep discovery has occurred or\nnot.", + "readOnly": true + }, + "recommendedAzureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the recommended azure SQL target type.", + "readOnly": true + }, + "recommendedSuitability": { + "$ref": "#/definitions/RecommendedSuitability", + "description": "Gets or sets the recommended azure SQL suitability.", + "readOnly": true + }, + "azureSqlMISuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL MI suitability details.", + "readOnly": true + }, + "azureSqlDBSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2PaasSuitabilityData", + "description": "SQL instance azure SQL DB suitability details.", + "readOnly": true + }, + "azureSqlVMSuitabilityDetails": { + "$ref": "#/definitions/SqlAssessmentV2IaasSuitabilityData", + "description": "SQL instance azure SQL VM suitability details.", + "readOnly": true + }, + "assessedSqlEntityArmId": { + "type": "string", + "description": "Gets or sets Arm id of assessed entity." + }, + "isClustered": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the SQL instance is clustered or not.", + "readOnly": true + }, + "isHighAvailabilityEnabled": { + "type": "boolean", + "description": "Gets or sets a value indicating whether the high availability is enabled or not.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "Gets the SQL edition from the recommended entity if applicable.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "Gets the SQL version from the recommended entity if applicable.", + "readOnly": true + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion.", + "readOnly": true + } + } + }, + "AssessedWebApp": { + "type": "object", + "description": "Data model of Assessed Web App.", + "properties": { + "suitabilityResult": { + "$ref": "#/definitions/SuitabilityResult", + "description": "Gets suitability result.", + "readOnly": true + }, + "recommendationResult": { + "$ref": "#/definitions/RecommendationResult", + "description": "Gets recommendation result.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/WebApp" + } + ] + }, + "AssessedWebAppV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebAppV2Properties", + "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/ProxyResource" + } + ] + }, + "AssessedWebAppV2ListResult": { + "type": "object", + "description": "The response of a AssessedWebAppV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebAppV2 items on this page", + "items": { + "$ref": "#/definitions/AssessedWebAppV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebAppV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "targetSpecificResult": { + "type": "object", + "description": "Gets or sets the target specific result.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificResult" + }, + "readOnly": true + }, + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "machineName": { + "type": "string", + "description": "Gets the machine name.", + "readOnly": true + }, + "serverArmId": { + "type": "string", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "webServerName": { + "type": "string", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "webAppName": { + "type": "string", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "discoveredWebAppId": { + "type": "string", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "discoveredMachineId": { + "type": "string", + "description": "Machine arm id.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + } + }, + "required": [ + "appServicePlanName", + "machineName" + ] + }, + "AssessedWebApplication": { + "type": "object", + "description": "ARM model of Assessed Web Application.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessedWebApplicationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AssessedWebApplicationListResult": { + "type": "object", + "description": "The response of a AssessedWebApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessedWebApplication items on this page", + "items": { + "$ref": "#/definitions/AssessedWebApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessedWebApplicationProperties": { + "type": "object", + "description": "ARM model of Assessed Web Application Properties.", + "allOf": [ + { + "$ref": "#/definitions/AssessedWebApp" + } + ] + }, + "Assessment": { + "type": "object", + "description": "Machine assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineAssessmentProperties", + "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/ProxyResource" + } + ] + }, + "AssessmentDetails": { + "type": "object", + "description": "Data model of Details of Assessment Computation.", + "properties": { + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets last time when rates were queried.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Gets Confidence score.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets date and time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Gets assessment status.", + "readOnly": true + } + }, + "required": [ + "createdTimestamp", + "updatedTimestamp", + "status" + ] + }, + "AssessmentListResult": { + "type": "object", + "description": "The response of a Assessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Assessment items on this page", + "items": { + "$ref": "#/definitions/Assessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptions": { + "type": "object", + "description": "Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentOptionsProperties", + "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/ProxyResource" + } + ] + }, + "AssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentOptionsProperties": { + "type": "object", + "description": "Assessment options properties.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Dictionary of VM families grouped by vm family name describing the targeted\nazure locations of VM family and the category of the family.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "List of supported VM Families.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "ultraDiskVmFamilies": { + "type": "array", + "description": "Ultra disk related assessment options.", + "items": { + "$ref": "#/definitions/UltraDiskAssessmentOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "List of VM Families that support premium disks for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "List of VM Families that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "List of Azure locations that support Savings plan offer for assessments.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AssessmentProject": { + "type": "object", + "description": "An Assessment project site resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProjectProperties", + "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" + } + ] + }, + "AssessmentProjectListResult": { + "type": "object", + "description": "The response of a AssessmentProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProject items on this page", + "items": { + "$ref": "#/definitions/AssessmentProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummary": { + "type": "object", + "description": "Assessment project summary resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AssessmentProjectSummaryProperties", + "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/ProxyResource" + } + ] + }, + "AssessmentProjectSummaryListResult": { + "type": "object", + "description": "The response of a AssessmentProjectSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AssessmentProjectSummary items on this page", + "items": { + "$ref": "#/definitions/AssessmentProjectSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AssessmentProjectSummaryProperties": { + "type": "object", + "description": "Assessment project summary properties class.", + "properties": { + "errorSummaryAffectedEntities": { + "type": "array", + "description": "Gets the Error summary by feature. Contains number of affected Entities per\nfeature.", + "items": { + "$ref": "#/definitions/ErrorSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfPrivateEndpointConnections": { + "type": "integer", + "format": "int32", + "description": "Gets the number of private endpoint connections.", + "readOnly": true + }, + "numberOfGroups": { + "type": "integer", + "format": "int32", + "description": "Gets the number of groups created in this project.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of machines part of this project.", + "readOnly": true + }, + "numberOfImportMachines": { + "type": "integer", + "format": "int32", + "description": "Gets the number of import machines part of this project.", + "readOnly": true + }, + "numberOfAssessments": { + "type": "integer", + "format": "int32", + "description": "Gets the number of assessments created in this project.", + "readOnly": true + }, + "lastAssessmentTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the last assessment timestamp.", + "readOnly": true + } + } + }, + "AssessmentProjectUpdate": { + "type": "object", + "description": "The type used for update operations of the AssessmentProject.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/AssessmentProjectUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "AssessmentProjectUpdateProperties": { + "type": "object", + "description": "The updatable properties of the AssessmentProject.", + "properties": { + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AssessmentPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment ARM properties.", + "properties": { + "scope": { + "$ref": "#/definitions/AssessmentScopeParameters", + "description": "Gets or sets scope parameters to identify inventory items for assessment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MutableArmResource" + } + ] + }, + "AssessmentResult": { + "type": "object", + "description": "Assessment results.", + "properties": { + "appServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name." + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the suitability." + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the security suitability." + }, + "webAppSkuName": { + "type": "string", + "description": "Gets or sets the web app sku name." + }, + "webAppSkuSize": { + "type": "string", + "description": "Gets or sets the web app sku size." + } + }, + "required": [ + "appServicePlanName", + "suitability", + "securitySuitability", + "webAppSkuName", + "webAppSkuSize" + ] + }, + "AssessmentScopeParameters": { + "type": "object", + "description": "Data model of Assessment Scope Parameters.", + "properties": { + "serverGroupId": { + "type": "string", + "description": "Gets or sets the server group id." + } + } + }, + "AssessmentSettings": { + "type": "object", + "description": "Base data model of Assessment Settings.", + "properties": { + "azureLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "environmentType": { + "$ref": "#/definitions/AzureEnvironmentType", + "description": "Gets or sets environment type." + }, + "licensingProgram": { + "$ref": "#/definitions/LicensingProgram", + "description": "Gets or sets licensing program." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Gets or sets currency." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets or sets discount percentage." + }, + "sizingCriteria": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Gets or sets sizing criteria." + }, + "performanceData": { + "$ref": "#/definitions/PerfDataSettings", + "description": "Gets or sets performance data settings." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Gets or sets scaling factor." + } + }, + "required": [ + "azureLocation", + "environmentType", + "licensingProgram", + "currency", + "sizingCriteria" + ] + }, + "AssessmentSizingCriterion": { + "type": "string", + "description": "Assessment Sizing Criteria.", + "enum": [ + "PerformanceBased", + "AsOnPremises" + ], + "x-ms-enum": { + "name": "AssessmentSizingCriterion", + "modelAsString": true, + "values": [ + { + "name": "PerformanceBased", + "value": "PerformanceBased", + "description": "Performance Data based Sizing." + }, + { + "name": "AsOnPremises", + "value": "AsOnPremises", + "description": "As On Premises or Static Data based Sizing." + } + ] + } + }, + "AssessmentStage": { + "type": "string", + "enum": [ + "InProgress", + "UnderReview", + "Approved" + ], + "x-ms-enum": { + "name": "AssessmentStage", + "modelAsString": true + } + }, + "AssessmentStatus": { + "type": "string", + "description": "Assessment Status.", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid", + "OutOfSync", + "OutDated", + "Deleted" + ], + "x-ms-enum": { + "name": "AssessmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Created", + "value": "Created", + "description": "Assessment is Created." + }, + { + "name": "Updated", + "value": "Updated", + "description": "Assessment is Updated." + }, + { + "name": "Running", + "value": "Running", + "description": "Assessment is currently running." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Assessment is Completed or Ready." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Assessment is Failed i.e. it is now invalid." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "Assessment is Out of Sync." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "Assessment is Out Dated." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Assessment is Deleted." + } + ] + } + }, + "AssessmentType": { + "type": "string", + "enum": [ + "Unknown", + "MachineAssessment", + "AvsAssessment", + "SqlAssessment", + "WebAppAssessment" + ], + "x-ms-enum": { + "name": "AssessmentType", + "modelAsString": true + } + }, + "AsyncCommitModeIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "AsyncCommitModeIntent", + "modelAsString": true + } + }, + "AvsAssessedDisk": { + "type": "object", + "description": "AVS assessed disk web model class.", + "properties": { + "name": { + "type": "string", + "description": "Gets the ID of the disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the disk.", + "readOnly": true + }, + "gigabytesProvisioned": { + "type": "number", + "format": "float", + "description": "Gigabytes Provisioned for a disk in private data center.", + "readOnly": true + }, + "megabytesPerSecondOfRead": { + "type": "number", + "format": "float", + "description": "Disk Read Throughput in MB/s.", + "readOnly": true + }, + "megabytesPerSecondOfWrite": { + "type": "number", + "format": "float", + "description": "Disk Write Throughput in MB/s.", + "readOnly": true + }, + "numberOfReadOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Read Operations per second.", + "readOnly": true + }, + "numberOfWriteOperationsPerSecond": { + "type": "number", + "format": "float", + "description": "Write Operations per second.", + "readOnly": true + }, + "assessedExternalStorageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Associated storage Type recommended for Disk.", + "readOnly": true + }, + "estimatedDiskSizeInGB": { + "type": "number", + "format": "float", + "description": "Estimated Disk Size in GB.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureDiskSuitabilityDetail", + "description": "Gets the suitability detail.", + "readOnly": true + } + } + }, + "AvsAssessedMachine": { + "type": "object", + "description": "AVS assessment Assessed Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessedMachineProperties", + "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/ProxyResource" + } + ] + }, + "AvsAssessedMachineListResult": { + "type": "object", + "description": "The response of a AvsAssessedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessedMachine items on this page", + "items": { + "$ref": "#/definitions/AvsAssessedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessedMachineProperties": { + "type": "object", + "description": "AVS assessed machine properties web model.", + "properties": { + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "disks": { + "type": "object", + "description": "List of Disks that were assessed as part of this machine's assessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedDisk" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "List of Network Adapters that were assessed as part of this machine's\nassessment.", + "additionalProperties": { + "$ref": "#/definitions/AvsAssessedNetworkAdapter" + }, + "readOnly": true + }, + "storageInUseGB": { + "type": "number", + "format": "float", + "description": "Gets the storage in use.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsVmSuitabilityExplanation", + "description": "Gets the explanation if machine is not suitable for cloud.", + "readOnly": true + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureAvsVmSuitabilityDetail", + "description": "Gets the details if machine is not suitable for cloud.", + "readOnly": true + }, + "type": { + "$ref": "#/definitions/AssessedMachineType", + "description": "Assessed machine type.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemArchitecture": { + "$ref": "#/definitions/GuestOperatingSystemArchitecture", + "description": "Operating system architecture as reported by datacenter management solution.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "datacenterMachineArmId": { + "type": "string", + "description": "Data center machine ARM id.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "Data center management server ARM id.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "Data center management server name.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "percentageCoresUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Cores Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "percentageMemoryUtilization": { + "type": "number", + "format": "float", + "description": "Percentile of Percentage of Memory Utilized noted during time period T.\n \n Here N and T are settings on Assessment.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets a value indicating whether machine is suitable for the cloud platform\nselected.", + "readOnly": true + } + } + }, + "AvsAssessedNetworkAdapter": { + "type": "object", + "description": "Second level object returned as part of AVS AssessedMachine REST resource.", + "properties": { + "macAddress": { + "type": "string", + "description": "Mac address of the NIC.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "IP V4 addresses for the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets the display name of the network adapter.", + "readOnly": true + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the Received data for Network Adapter in MB/s.\n This value is\nthe percentile of historical data based on options selected in Assessment.", + "readOnly": true + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the Transmitted data for Network Adapter in MB/s.\n This value\nis the percentile of historical data based on options selected in Assessment.", + "readOnly": true + } + } + }, + "AvsAssessment": { + "type": "object", + "description": "AVS assessment resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentProperties", + "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/ProxyResource" + } + ] + }, + "AvsAssessmentListResult": { + "type": "object", + "description": "The response of a AvsAssessment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessment items on this page", + "items": { + "$ref": "#/definitions/AvsAssessment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptions": { + "type": "object", + "description": "AVS Assessment options resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsAssessmentOptionsProperties", + "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/ProxyResource" + } + ] + }, + "AvsAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a AvsAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/AvsAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsAssessmentOptionsProperties": { + "type": "object", + "description": "AVS Assessment options properties.", + "properties": { + "avsNodes": { + "type": "array", + "description": "AVS SKU Nodes.", + "items": { + "$ref": "#/definitions/AvsSkuOptions" + }, + "x-ms-identifiers": [] + }, + "avsExternalStorageTypes": { + "type": "array", + "description": "AVS External Storage Types Supported.", + "items": { + "$ref": "#/definitions/AvsExternalStorageOptions" + }, + "x-ms-identifiers": [] + }, + "failuresToTolerateAndRaidLevelValues": { + "type": "array", + "description": "FTT and Raid level values.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "reservedInstanceAvsNodes": { + "type": "array", + "description": "List of AVS nodes for RI.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "List of supported Azure regions for reserved instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "List of supported currencies for reserved instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + } + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "List of supported Azure offer codes for reserved instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + } + } + } + }, + "AvsAssessmentProperties": { + "type": "object", + "description": "Properties of the AVS assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets the assessment error summary.\n This is the number of machines\naffected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level in a common property." + }, + "failuresToTolerateAndRaidLevelList": { + "type": "array", + "description": "List of Failures to tolerate and RAID levels in a common property.", + "items": { + "$ref": "#/definitions/FttAndRaidLevel" + } + }, + "vcpuOversubscription": { + "type": "number", + "format": "float", + "description": "VCPU over subscription." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS node type." + }, + "nodeTypes": { + "type": "array", + "description": "AVS node types.", + "items": { + "$ref": "#/definitions/AzureAvsNodeType" + } + }, + "externalStorageTypes": { + "type": "array", + "description": "List of AVS external storage types.", + "items": { + "$ref": "#/definitions/ExternalStorageType" + } + }, + "avsAssessmentScenario": { + "$ref": "#/definitions/AvsAssessmentScenario", + "description": "AVS Assessment Scenario." + }, + "isVcfByolEnabled": { + "type": "boolean", + "description": "Is VCF license applied" + }, + "costComponents": { + "type": "array", + "description": "collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets or sets the Assessment cloud suitability.", + "readOnly": true + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureAvsSuitabilityExplanation", + "description": "Gets or sets the Assessment suitability explanation.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Recommended number of nodes.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization.", + "readOnly": true + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization.", + "readOnly": true + }, + "totalCpuCores": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores used.", + "readOnly": true + }, + "totalRamInGB": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB.", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB.", + "readOnly": true + }, + "avsEstimatedNodes": { + "type": "array", + "description": "EstimatedNodes AVS SKU for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNode" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedExternalStorages": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "avsEstimatedNetworks": { + "type": "array", + "description": "Estimated External Storage for Assessment.", + "items": { + "$ref": "#/definitions/AvsEstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Cloud suitability summary for all the machines in the assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "memOvercommit": { + "type": "number", + "format": "float", + "description": "Memory overcommit." + }, + "dedupeCompression": { + "type": "number", + "format": "float", + "description": "De-duplication compression." + }, + "limitingFactor": { + "type": "string", + "description": "Limiting factor.", + "readOnly": true + }, + "isStretchClusterEnabled": { + "type": "boolean", + "description": "Is Stretch Cluster Enabled." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer code according to which cost estimation is done." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when the Azure Prices were queried. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "AvsExternalStorageOptions": { + "type": "object", + "description": "AVS External Storage specific options.", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "AVS external storage type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this storage type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsNodeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of Avs VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "avsNodeCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedAvsNodeTypeSummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedAvsNodeTypeSummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedExternalStorage": { + "type": "array", + "description": "Estimated External Storage", + "items": { + "$ref": "#/definitions/EstimatedExternalStorage" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedNetwork": { + "type": "array", + "description": "Estimated Network", + "items": { + "$ref": "#/definitions/EstimatedNetwork" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "estimatedCostWithVcfByol": { + "type": "number", + "format": "float", + "description": "Estimated Cost With VCF BYOL", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "Represents errors which might have occurred while calculating AVS Node Summary", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AvsEstimatedExternalStorage": { + "type": "object", + "description": "Details on the Estimated External Storage for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type of storage." + }, + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "Recommended External Storage." + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + } + } + }, + "AvsEstimatedNetwork": { + "type": "object", + "description": "Details on the Estimated Network Costs for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Monthly cost for network type." + }, + "networkType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Recommended Network Sku." + } + } + }, + "AvsEstimatedNode": { + "type": "object", + "description": "Details on the Estimated nodes for AVS Assessment.", + "properties": { + "monthlyPrice": { + "type": "number", + "format": "float", + "description": "Total monthly cost for type and number of nodes." + }, + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "Recommended SKU." + }, + "nodeNumber": { + "type": "integer", + "format": "int32", + "description": "Number of nodes that will be needed." + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "Predicted CPU utilization." + }, + "ramUtilization": { + "type": "number", + "format": "float", + "description": "Predicted RAM utilization." + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Predicted storage utilization." + }, + "totalCpu": { + "type": "number", + "format": "float", + "description": "Predicted total CPU cores across the set of nodes." + }, + "totalRam": { + "type": "number", + "format": "float", + "description": "Predicted total RAM used in GB." + }, + "totalStorage": { + "type": "number", + "format": "float", + "description": "Predicted total Storage used in GB." + }, + "pricingModel": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Pricing model indicates what hour multiplier to use while estimating the Nodes cost." + }, + "fttRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "FttRaidLevel recommended for Node." + } + } + }, + "AvsSkuOptions": { + "type": "object", + "description": "AVS SKU specific options.", + "properties": { + "nodeType": { + "$ref": "#/definitions/AzureAvsNodeType", + "description": "AVS Node type." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where this node type is available.", + "items": { + "$ref": "#/definitions/AzureLocation" + } + } + } + }, + "AvsSummary": { + "type": "object", + "description": "Avs summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/AvsSummaryProperties", + "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/ProxyResource" + } + ] + }, + "AvsSummaryListResult": { + "type": "object", + "description": "The response of a AvsSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AvsSummary items on this page", + "items": { + "$ref": "#/definitions/AvsSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AvsSummaryProperties": { + "type": "object", + "description": "Avs summary properties class.", + "properties": { + "azureAvsSummary": { + "$ref": "#/definitions/AzureAvsSummary", + "description": "The Azure Avs summary.", + "readOnly": true + }, + "onPremisesAvsSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "AzureAppServiceContainerSummary": { + "type": "object", + "description": "Shows Azure App Service Container summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAppServiceSummary": { + "type": "object", + "description": "Shows Azure App Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/AppServiceSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureAvsNodeType": { + "type": "string", + "enum": [ + "Unknown", + "AV36", + "AV36P", + "AV52", + "AV64" + ], + "x-ms-enum": { + "name": "AzureAvsNodeType", + "modelAsString": true + } + }, + "AzureAvsSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "UnsupportedLocationForSelectedNode", + "InternalErrorInRecommendation", + "UnsupportedLocationForSelectedExternalStorageTypes" + ], + "x-ms-enum": { + "name": "AzureAvsSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureAvsSummary": { + "type": "object", + "description": "The Azure AVS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "avsNodeSummary": { + "$ref": "#/definitions/AvsNodeSummary", + "description": "Avs virtual machine summary.", + "readOnly": true + }, + "avsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureAvsVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange", + "PercentageOfStorageUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureAvsVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "IpV6NotSupported", + "UnsupportedOperatingSystem" + ], + "x-ms-enum": { + "name": "AzureAvsVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureCurrency": { + "type": "string", + "description": "Currency for Azure.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "AzureCurrency", + "modelAsString": true + } + }, + "AzureDiskSize": { + "type": "string", + "enum": [ + "Unknown", + "Standard_S4", + "Standard_S6", + "Standard_S10", + "Standard_S15", + "Standard_S20", + "Standard_S30", + "Standard_S40", + "Standard_S50", + "Standard_S60", + "Standard_S70", + "Standard_S80", + "Premium_P4", + "Premium_P6", + "Premium_P10", + "Premium_P15", + "Premium_P20", + "Premium_P30", + "Premium_P40", + "Premium_P50", + "Premium_P60", + "Premium_P70", + "Premium_P80", + "StandardSSD_E10", + "StandardSSD_E15", + "StandardSSD_E20", + "StandardSSD_E30", + "StandardSSD_E40", + "StandardSSD_E50", + "StandardSSD_E60", + "StandardSSD_E70", + "StandardSSD_E80", + "StandardSSD_E4", + "StandardSSD_E6", + "StandardSSD_E1", + "StandardSSD_E2", + "StandardSSD_E3", + "Premium_P1", + "Premium_P2", + "Premium_P3", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "StandardS4", + "value": "Standard_S4" + }, + { + "name": "StandardS6", + "value": "Standard_S6" + }, + { + "name": "StandardS10", + "value": "Standard_S10" + }, + { + "name": "StandardS15", + "value": "Standard_S15" + }, + { + "name": "StandardS20", + "value": "Standard_S20" + }, + { + "name": "StandardS30", + "value": "Standard_S30" + }, + { + "name": "StandardS40", + "value": "Standard_S40" + }, + { + "name": "StandardS50", + "value": "Standard_S50" + }, + { + "name": "StandardS60", + "value": "Standard_S60" + }, + { + "name": "StandardS70", + "value": "Standard_S70" + }, + { + "name": "StandardS80", + "value": "Standard_S80" + }, + { + "name": "PremiumP4", + "value": "Premium_P4" + }, + { + "name": "PremiumP6", + "value": "Premium_P6" + }, + { + "name": "PremiumP10", + "value": "Premium_P10" + }, + { + "name": "PremiumP15", + "value": "Premium_P15" + }, + { + "name": "PremiumP20", + "value": "Premium_P20" + }, + { + "name": "PremiumP30", + "value": "Premium_P30" + }, + { + "name": "PremiumP40", + "value": "Premium_P40" + }, + { + "name": "PremiumP50", + "value": "Premium_P50" + }, + { + "name": "PremiumP60", + "value": "Premium_P60" + }, + { + "name": "PremiumP70", + "value": "Premium_P70" + }, + { + "name": "PremiumP80", + "value": "Premium_P80" + }, + { + "name": "StandardSSDE10", + "value": "StandardSSD_E10" + }, + { + "name": "StandardSSDE15", + "value": "StandardSSD_E15" + }, + { + "name": "StandardSSDE20", + "value": "StandardSSD_E20" + }, + { + "name": "StandardSSDE30", + "value": "StandardSSD_E30" + }, + { + "name": "StandardSSDE40", + "value": "StandardSSD_E40" + }, + { + "name": "StandardSSDE50", + "value": "StandardSSD_E50" + }, + { + "name": "StandardSSDE60", + "value": "StandardSSD_E60" + }, + { + "name": "StandardSSDE70", + "value": "StandardSSD_E70" + }, + { + "name": "StandardSSDE80", + "value": "StandardSSD_E80" + }, + { + "name": "StandardSSDE4", + "value": "StandardSSD_E4" + }, + { + "name": "StandardSSDE6", + "value": "StandardSSD_E6" + }, + { + "name": "StandardSSDE1", + "value": "StandardSSD_E1" + }, + { + "name": "StandardSSDE2", + "value": "StandardSSD_E2" + }, + { + "name": "StandardSSDE3", + "value": "StandardSSD_E3" + }, + { + "name": "PremiumP1", + "value": "Premium_P1" + }, + { + "name": "PremiumP2", + "value": "Premium_P2" + }, + { + "name": "PremiumP3", + "value": "Premium_P3" + }, + { + "name": "Ultra", + "value": "Ultra" + }, + { + "name": "PremiumV2", + "value": "PremiumV2" + } + ] + } + }, + "AzureDiskSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "NumberOfReadOperationsPerSecondMissing", + "NumberOfWriteOperationsPerSecondMissing", + "MegabytesPerSecondOfReadMissing", + "MegabytesPerSecondOfWriteMissing", + "DiskGigabytesConsumedMissing", + "DiskGigabytesProvisionedMissing", + "NumberOfReadOperationsPerSecondOutOfRange", + "NumberOfWriteOperationsPerSecondOutOfRange", + "MegabytesPerSecondOfReadOutOfRange", + "MegabytesPerSecondOfWriteOutOfRange", + "DiskGigabytesConsumedOutOfRange", + "DiskGigabytesProvisionedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityDetail", + "modelAsString": true + } + }, + "AzureDiskSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "DiskSizeGreaterThanSupported", + "NoSuitableDiskSizeForIops", + "NoSuitableDiskSizeForThroughput", + "NoDiskSizeFoundInSelectedLocation", + "NoDiskSizeFoundForSelectedRedundancy", + "InternalErrorOccurredForDiskEvaluation", + "NoEaPriceFoundForDiskSize" + ], + "x-ms-enum": { + "name": "AzureDiskSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureDiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureDiskType", + "modelAsString": true + } + }, + "AzureEnvironmentType": { + "type": "string", + "description": "Environment Type for Azure.", + "enum": [ + "Unknown", + "DevTest", + "Production" + ], + "x-ms-enum": { + "name": "AzureEnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "DevTest", + "value": "DevTest", + "description": "Development or Test Environment." + }, + { + "name": "Production", + "value": "Production", + "description": "Production Environment." + } + ] + } + }, + "AzureHybridUseBenefit": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "AzureHybridUseBenefit", + "modelAsString": true + } + }, + "AzureIaasSqlSummary": { + "type": "object", + "description": "Azure Iaas sql server summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Total SQL entities.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable SQL entities.", + "readOnly": true + }, + "azureSqlCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureIaasSummary": { + "type": "object", + "description": "The Azure IaaS summary.", + "properties": { + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "azureIaasVmSummary": { + "$ref": "#/definitions/AzureIaasVmSummary", + "description": "Azure Iaas virtual machine summary.", + "readOnly": true + }, + "azureIaasSqlSummary": { + "$ref": "#/definitions/AzureIaasSqlSummary", + "description": "Azure Iaas sql server summary.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzureIaasVmSummary": { + "type": "object", + "description": "Azure Iaas virtual machine summary.", + "properties": { + "serversSuitableForMigration": { + "type": "integer", + "format": "int32", + "description": "Servers suitable for migration.", + "readOnly": true + }, + "totalNumberOfServers": { + "type": "integer", + "format": "int32", + "description": "The total number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The total number of IaaS VM cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "The total memory in GB.", + "readOnly": true + }, + "azureVmCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "estimatedCost": { + "type": "number", + "format": "float", + "description": "Estimated cost.", + "readOnly": true + }, + "osLicensingCost": { + "type": "number", + "format": "float", + "description": "OS licensing cost.", + "readOnly": true + }, + "estimatedCostByRecommendedOffer": { + "type": "array", + "description": "Estimated cost by offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendedVmFamilySummary": { + "type": "array", + "description": "The recommended VM family summary.", + "items": { + "$ref": "#/definitions/RecommendedVmFamilySummary" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "costByStorageType": { + "type": "array", + "description": "The cost by storage type.", + "items": { + "$ref": "#/definitions/CostByStorageType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureKubernetesServiceSummary": { + "type": "object", + "description": "Shows Azure Kubernetes Service summary.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommendation offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySku": { + "type": "array", + "description": "Distribution by SKU.", + "items": { + "$ref": "#/definitions/WebAppTargetSku" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByApp": { + "type": "array", + "description": "Distribution by application type.", + "items": { + "$ref": "#/definitions/WebAppDistribution" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureLocation": { + "type": "string", + "description": "Location for Azure.", + "enum": [ + "Unknown", + "EastAsia", + "SoutheastAsia", + "AustraliaEast", + "AustraliaSoutheast", + "BrazilSouth", + "CanadaCentral", + "CanadaEast", + "WestEurope", + "NorthEurope", + "CentralIndia", + "SouthIndia", + "WestIndia", + "JapanEast", + "JapanWest", + "KoreaCentral", + "KoreaSouth", + "UkWest", + "UkSouth", + "NorthCentralUs", + "EastUs", + "WestUs2", + "SouthCentralUs", + "CentralUs", + "EastUs2", + "WestUs", + "WestCentralUs", + "GermanyCentral", + "GermanyNortheast", + "ChinaNorth", + "ChinaEast", + "USGovArizona", + "USGovTexas", + "USGovIowa", + "USGovVirginia", + "USDoDCentral", + "USDoDEast", + "FranceCentral", + "AustraliaCentral", + "SouthAfricaNorth", + "FranceSouth", + "AustraliaCentral2", + "SouthAfricaWest", + "GermanyNorth", + "GermanyWestCentral", + "NorwayEast", + "NorwayWest", + "ChinaEast2", + "ChinaNorth2", + "SwitzerlandNorth", + "SwitzerlandWest", + "UAENorth", + "UAECentral", + "UsNatEast", + "UsNatWest", + "UsSecEast", + "UsSecCentral", + "UsSecWest", + "SwedenCentral", + "QatarCentral" + ], + "x-ms-enum": { + "name": "AzureLocation", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTO": { + "type": "object", + "description": "Class representing an Azure Managed Disk SKU.", + "properties": { + "diskType": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskType", + "description": "Gets the Type (\"tier\") of disk - e.g. standard, premium, ultra.", + "readOnly": true + }, + "diskSize": { + "$ref": "#/definitions/AzureDiskSize", + "description": "Gets the Size of the managed disk - e.g. P30, P40.", + "readOnly": true + }, + "diskRedundancy": { + "$ref": "#/definitions/AzureManagedDiskSkuDTODiskRedundancy", + "description": "Gets disk redundancy - e.g. LRS, ZRS.", + "readOnly": true + }, + "storageCost": { + "type": "number", + "format": "float", + "description": "Gets the managed disk storage cost.", + "readOnly": true + }, + "recommendedSizeInGib": { + "type": "number", + "format": "float", + "description": "Gets the recommended in GB of the managed disk.", + "readOnly": true + }, + "recommendedThroughputInMbps": { + "type": "number", + "format": "float", + "description": "Gets the recommended throughput in MBPS of the managed disk.", + "readOnly": true + }, + "recommendedIops": { + "type": "number", + "format": "float", + "description": "Gets the recommended IOPS of the managed disk.", + "readOnly": true + } + } + }, + "AzureManagedDiskSkuDTODiskRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LRS", + "ZRS" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskRedundancy", + "modelAsString": true + } + }, + "AzureManagedDiskSkuDTODiskType": { + "type": "string", + "enum": [ + "Unknown", + "Standard", + "StandardSSD", + "Premium", + "StandardOrPremium", + "Ultra", + "PremiumV2" + ], + "x-ms-enum": { + "name": "AzureManagedDiskSkuDTODiskType", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "MegabytesOfDataTransmittedMissing", + "MegabytesOfDataTransmittedOutOfRange", + "MegabytesOfDataRecievedMissing", + "MegabytesOfDataRecievedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityDetail", + "modelAsString": true + } + }, + "AzureNetworkAdapterSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "InternalErrorOccurred" + ], + "x-ms-enum": { + "name": "AzureNetworkAdapterSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureOfferCode": { + "type": "string", + "enum": [ + "Unknown", + "MSAZR0003P", + "MSAZR0044P", + "MSAZR0059P", + "MSAZR0060P", + "MSAZR0062P", + "MSAZR0063P", + "MSAZR0064P", + "MSAZR0029P", + "MSAZR0022P", + "MSAZR0023P", + "MSAZR0148P", + "MSAZR0025P", + "MSAZR0036P", + "MSAZR0120P", + "MSAZR0121P", + "MSAZR0122P", + "MSAZR0123P", + "MSAZR0124P", + "MSAZR0125P", + "MSAZR0126P", + "MSAZR0127P", + "MSAZR0128P", + "MSAZR0129P", + "MSAZR0130P", + "MSAZR0111P", + "MSAZR0144P", + "MSAZR0149P", + "MSMCAZR0044P", + "MSMCAZR0059P", + "MSMCAZR0060P", + "MSMCAZR0063P", + "MSMCAZR0120P", + "MSMCAZR0121P", + "MSMCAZR0125P", + "MSMCAZR0128P", + "MSAZRDE0003P", + "MSAZRDE0044P", + "MSAZRUSGOV0003P", + "EA", + "MSAZR0243P", + "SavingsPlan1Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "AzureOfferCode", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Msazr0003P", + "value": "MSAZR0003P" + }, + { + "name": "Msazr0044P", + "value": "MSAZR0044P" + }, + { + "name": "Msazr0059P", + "value": "MSAZR0059P" + }, + { + "name": "Msazr0060P", + "value": "MSAZR0060P" + }, + { + "name": "Msazr0062P", + "value": "MSAZR0062P" + }, + { + "name": "Msazr0063P", + "value": "MSAZR0063P" + }, + { + "name": "Msazr0064P", + "value": "MSAZR0064P" + }, + { + "name": "Msazr0029P", + "value": "MSAZR0029P" + }, + { + "name": "Msazr0022P", + "value": "MSAZR0022P" + }, + { + "name": "Msazr0023P", + "value": "MSAZR0023P" + }, + { + "name": "Msazr0148P", + "value": "MSAZR0148P" + }, + { + "name": "Msazr0025P", + "value": "MSAZR0025P" + }, + { + "name": "Msazr0036P", + "value": "MSAZR0036P" + }, + { + "name": "Msazr0120P", + "value": "MSAZR0120P" + }, + { + "name": "Msazr0121P", + "value": "MSAZR0121P" + }, + { + "name": "Msazr0122P", + "value": "MSAZR0122P" + }, + { + "name": "Msazr0123P", + "value": "MSAZR0123P" + }, + { + "name": "Msazr0124P", + "value": "MSAZR0124P" + }, + { + "name": "Msazr0125P", + "value": "MSAZR0125P" + }, + { + "name": "Msazr0126P", + "value": "MSAZR0126P" + }, + { + "name": "Msazr0127P", + "value": "MSAZR0127P" + }, + { + "name": "Msazr0128P", + "value": "MSAZR0128P" + }, + { + "name": "Msazr0129P", + "value": "MSAZR0129P" + }, + { + "name": "Msazr0130P", + "value": "MSAZR0130P" + }, + { + "name": "Msazr0111P", + "value": "MSAZR0111P" + }, + { + "name": "Msazr0144P", + "value": "MSAZR0144P" + }, + { + "name": "Msazr0149P", + "value": "MSAZR0149P" + }, + { + "name": "Msmcazr0044P", + "value": "MSMCAZR0044P" + }, + { + "name": "Msmcazr0059P", + "value": "MSMCAZR0059P" + }, + { + "name": "Msmcazr0060P", + "value": "MSMCAZR0060P" + }, + { + "name": "Msmcazr0063P", + "value": "MSMCAZR0063P" + }, + { + "name": "Msmcazr0120P", + "value": "MSMCAZR0120P" + }, + { + "name": "Msmcazr0121P", + "value": "MSMCAZR0121P" + }, + { + "name": "Msmcazr0125P", + "value": "MSMCAZR0125P" + }, + { + "name": "Msmcazr0128P", + "value": "MSMCAZR0128P" + }, + { + "name": "Msazrde0003P", + "value": "MSAZRDE0003P" + }, + { + "name": "Msazrde0044P", + "value": "MSAZRDE0044P" + }, + { + "name": "Msazrusgov0003P", + "value": "MSAZRUSGOV0003P" + }, + { + "name": "EA", + "value": "EA" + }, + { + "name": "Msazr0243P", + "value": "MSAZR0243P" + }, + { + "name": "SavingsPlan1Year", + "value": "SavingsPlan1Year" + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year" + } + ] + } + }, + "AzurePaasSummary": { + "type": "object", + "description": "Shows the PaaS Azure summary.", + "properties": { + "totalSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Number of Sql instances.", + "readOnly": true + }, + "suitableSqlEntities": { + "type": "integer", + "format": "int32", + "description": "Suitable Sql instances.", + "readOnly": true + }, + "totalWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web applications.", + "readOnly": true + }, + "suitableWebApps": { + "type": "integer", + "format": "int32", + "description": "Suitable web applications.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Memory Utilization.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "float", + "description": "Storage Utilization.", + "readOnly": true + }, + "estimatedCostByTarget": { + "$ref": "#/definitions/EstimatedCostByTarget", + "description": "Shows the estimated cost by target.", + "readOnly": true + }, + "estimatedSqlServerLicensingCost": { + "type": "number", + "format": "float", + "description": "estimated SQL Server licensing cost.", + "readOnly": true + }, + "azureSqlSummary": { + "$ref": "#/definitions/AzureSqlSummary", + "description": "Shows the Azure SQL details.", + "readOnly": true + }, + "azureAppServiceSummary": { + "$ref": "#/definitions/AzureAppServiceSummary", + "description": "Shows Azure App Service summary.", + "readOnly": true + }, + "azureAppServiceContainerSummary": { + "$ref": "#/definitions/AzureAppServiceContainerSummary", + "description": "Shows Azure App Service Container summary.", + "readOnly": true + }, + "azureKubernetesServiceSummary": { + "$ref": "#/definitions/AzureKubernetesServiceSummary", + "description": "Shows Azure Kubernetes Service summary.", + "readOnly": true + }, + "totalAzurePaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + } + } + }, + "AzurePricingTier": { + "type": "string", + "enum": [ + "Standard", + "Basic" + ], + "x-ms-enum": { + "name": "AzurePricingTier", + "modelAsString": true + } + }, + "AzureQuorumWitnessDTO": { + "type": "object", + "description": "Quorum Witness.", + "properties": { + "quorumWitnessType": { + "$ref": "#/definitions/AzureQuorumWitnessDTOQuorumWitnessType", + "description": "Gets quorum witness type.", + "readOnly": true + } + } + }, + "AzureQuorumWitnessDTOQuorumWitnessType": { + "type": "string", + "enum": [ + "Unknown", + "Cloud", + "Disk" + ], + "x-ms-enum": { + "name": "AzureQuorumWitnessDTOQuorumWitnessType", + "modelAsString": true + } + }, + "AzureReservedInstance": { + "type": "string", + "enum": [ + "None", + "RI1Year", + "RI3Year" + ], + "x-ms-enum": { + "name": "AzureReservedInstance", + "modelAsString": true + } + }, + "AzureResourceProperties": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "AzureResourceProperties2": { + "type": "object", + "description": "Common properties for all azure tracked and proxy resources.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState2", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AzureSecurityOfferingType": { + "type": "string", + "enum": [ + "NO", + "MDC" + ], + "x-ms-enum": { + "name": "AzureSecurityOfferingType", + "modelAsString": true + } + }, + "AzureSettings": { + "type": "object", + "description": "Azure settings for a business case.", + "properties": { + "targetLocation": { + "type": "string", + "description": "Gets or sets azure location." + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Gets azure Discount percentage.", + "minimum": 0, + "maximum": 100 + }, + "currency": { + "$ref": "#/definitions/BusinessCaseCurrency", + "description": "Business case Currency.", + "default": "USD" + }, + "businessCaseType": { + "$ref": "#/definitions/MigrationStrategy", + "description": "Migration Strategy.", + "default": "OptimizeForCost" + }, + "workloadDiscoverySource": { + "$ref": "#/definitions/DiscoverySource", + "description": "Workload discovery source.", + "default": "Appliance" + }, + "performanceDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets start time to use for performance." + }, + "performanceDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets end time to use for performance." + }, + "comfortFactor": { + "type": "number", + "format": "float", + "description": "Gets comfort factor.", + "default": 1 + }, + "performanceUtilizationPercentile": { + "type": "number", + "format": "float", + "description": "Gets utilization percentile for performance.", + "default": 95, + "minimum": 0, + "maximum": 100 + }, + "perYearMigrationCompletionPercentage": { + "type": "object", + "description": "Gets migration completion percentage per year.", + "additionalProperties": { + "format": "float", + "type": "number" + } + }, + "infrastructureGrowthRate": { + "type": "number", + "format": "float", + "description": "Gets infrastructure growth rate.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "wacc": { + "type": "number", + "format": "float", + "description": "Gets wACC percentage.", + "minimum": 0, + "maximum": 100 + }, + "networkCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets network cost percentage.", + "default": 5, + "minimum": 0, + "maximum": 100 + }, + "iaasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets IaaS labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "paasLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets PaaS labour cost percentage.", + "default": 60, + "minimum": 0, + "maximum": 100 + }, + "avsLaborCostPercentage": { + "type": "number", + "format": "float", + "description": "Gets Avs labour cost percentage.", + "default": 75, + "minimum": 0, + "maximum": 100 + }, + "savingsOption": { + "$ref": "#/definitions/SavingsOption", + "description": "Gets the business case savings option type.", + "default": "RI3Year" + } + }, + "required": [ + "targetLocation", + "currency" + ] + }, + "AzureSqlDataBaseType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleDatabase", + "ElasticPool" + ], + "x-ms-enum": { + "name": "AzureSqlDataBaseType", + "modelAsString": true + } + }, + "AzureSqlIaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL IAAS SKU.", + "properties": { + "virtualMachineSize": { + "$ref": "#/definitions/AzureVirtualMachineSkuDTO", + "description": "Gets the The Azure Compute Virtual Machine.", + "readOnly": true + }, + "dataDiskSizes": { + "type": "array", + "description": "Gets the The list of data disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "logDiskSizes": { + "type": "array", + "description": "Gets the The list of log disk sizes.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlInstanceType": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "SingleInstance", + "InstancePools" + ], + "x-ms-enum": { + "name": "AzureSqlInstanceType", + "modelAsString": true + } + }, + "AzureSqlPaasSkuDTO": { + "type": "object", + "description": "Class representing Azure SQL PAAS SKU.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets the service tier.", + "readOnly": true + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets the compute tier.", + "readOnly": true + }, + "azureSqlHardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets the hardware generation.", + "readOnly": true + }, + "storageMaxSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the storage maximum size in megabytes.", + "readOnly": true + }, + "predictedDataSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted data size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "predictedLogSizeInMB": { + "type": "number", + "format": "float", + "description": "Gets the predicted log size in megabytes in the Azure SQL, will impact the\nbilling cost.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the number of cores.", + "readOnly": true + }, + "azureSqlTargetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets the target type.", + "readOnly": true + } + } + }, + "AzureSqlPurchaseModel": { + "type": "string", + "enum": [ + "Unknown", + "VCore", + "DTU" + ], + "x-ms-enum": { + "name": "AzureSqlPurchaseModel", + "modelAsString": true + } + }, + "AzureSqlServiceTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "GeneralPurpose", + "BusinessCritical", + "HyperScale" + ], + "x-ms-enum": { + "name": "AzureSqlServiceTier", + "modelAsString": true + } + }, + "AzureSqlSummary": { + "type": "object", + "description": "Shows the Azure SQL details.", + "properties": { + "estimatedCostByOffer": { + "type": "array", + "description": "Estimated cost by recommended offer.", + "items": { + "$ref": "#/definitions/EstimatedCostByOffer" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTier": { + "type": "array", + "description": "Distribution by service tiers, retaining just to support older Business cases.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlMi": { + "type": "array", + "description": "Distribution by service tiers for SQL MI.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByServiceTierForSqlDb": { + "type": "array", + "description": "Distribution by service tiers for SQL DB.", + "items": { + "$ref": "#/definitions/SqlServiceTier" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "AzureStorageRedundancy": { + "type": "string", + "enum": [ + "Unknown", + "LocallyRedundant", + "ZoneRedundant", + "GeoRedundant", + "ReadAccessGeoRedundant" + ], + "x-ms-enum": { + "name": "AzureStorageRedundancy", + "modelAsString": true + } + }, + "AzureVirtualMachineSkuDTO": { + "type": "object", + "description": "Azure Virtual Machine SKU.", + "properties": { + "azureVmFamily": { + "$ref": "#/definitions/AzureVmFamily", + "description": "Gets the Virtual Machine Family, for example : standardMSFamily.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the Compute Size in vCores.", + "readOnly": true + }, + "azureSkuName": { + "$ref": "#/definitions/AzureVmSize", + "description": "Gets the Virtual Machine SKU name,: E.g. : Standard_F16s.", + "readOnly": true + }, + "availableCores": { + "type": "integer", + "format": "int32", + "description": "Gets the Available vCores. This can be less than the vCores in the Constrained\nvCPU VM Sizes.", + "readOnly": true + }, + "maxNetworkInterfaces": { + "type": "integer", + "format": "int32", + "description": "Gets the Max network interfaces.", + "readOnly": true + } + } + }, + "AzureVmCategory": { + "type": "string", + "description": "Azure VM Category.", + "enum": [ + "All", + "ComputeOptimized", + "GeneralPurpose", + "GpuOptimized", + "HighPerformanceCompute", + "MemoryOptimized", + "StorageOptimized", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureVmCategory", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "Indicates All categories of VM." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute Optimized." + }, + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General Purpose." + }, + { + "name": "GpuOptimized", + "value": "GpuOptimized", + "description": "GPU Optimized." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "High Performance Compute." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory Optimized." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage Optimized." + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "Isolated VM." + } + ] + } + }, + "AzureVmFamily": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0_A4", + "Standard_A0_A7", + "Standard_A8_A11", + "Av2_series", + "D_series", + "Dv2_series", + "DS_series", + "DSv2_series", + "F_series", + "Fs_series", + "G_series", + "GS_series", + "H_series", + "Ls_series", + "Dsv3_series", + "Dv3_series", + "Fsv2_series", + "Ev3_series", + "Esv3_series", + "M_series", + "DC_Series", + "Lsv2_series", + "Ev4_series", + "Esv4_series", + "Edv4_series", + "Edsv4_series", + "Dv4_series", + "Dsv4_series", + "Ddv4_series", + "Ddsv4_series", + "Easv4_series", + "Dasv4_series", + "Mv2_series", + "Eav4_series", + "Dav4_series", + "Msv2_series", + "Mdsv2_series", + "Dv5_series", + "Dsv5_series", + "Ddv5_series", + "Ddsv5_series", + "Dasv5_series", + "Dadsv5_series", + "Ev5_series", + "Esv5_series", + "Edv5_series", + "Edsv5_series", + "Easv5_series", + "Eadsv5_series", + "Ebsv5_series", + "Ebdsv5_series" + ], + "x-ms-enum": { + "name": "AzureVmFamily", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0A4", + "value": "Basic_A0_A4" + }, + { + "name": "StandardA0A7", + "value": "Standard_A0_A7" + }, + { + "name": "StandardA8A11", + "value": "Standard_A8_A11" + }, + { + "name": "Av2Series", + "value": "Av2_series" + }, + { + "name": "DSeries", + "value": "D_series" + }, + { + "name": "Dv2Series", + "value": "Dv2_series" + }, + { + "name": "DSSeries", + "value": "DS_series" + }, + { + "name": "DSv2Series", + "value": "DSv2_series" + }, + { + "name": "FSeries", + "value": "F_series" + }, + { + "name": "FsSeries", + "value": "Fs_series" + }, + { + "name": "GSeries", + "value": "G_series" + }, + { + "name": "GSSeries", + "value": "GS_series" + }, + { + "name": "HSeries", + "value": "H_series" + }, + { + "name": "LsSeries", + "value": "Ls_series" + }, + { + "name": "Dsv3Series", + "value": "Dsv3_series" + }, + { + "name": "Dv3Series", + "value": "Dv3_series" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "Ev3Series", + "value": "Ev3_series" + }, + { + "name": "Esv3Series", + "value": "Esv3_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_Series" + }, + { + "name": "Lsv2Series", + "value": "Lsv2_series" + }, + { + "name": "Ev4Series", + "value": "Ev4_series" + }, + { + "name": "Esv4Series", + "value": "Esv4_series" + }, + { + "name": "Edv4Series", + "value": "Edv4_series" + }, + { + "name": "Edsv4Series", + "value": "Edsv4_series" + }, + { + "name": "Dv4Series", + "value": "Dv4_series" + }, + { + "name": "Dsv4Series", + "value": "Dsv4_series" + }, + { + "name": "Ddv4Series", + "value": "Ddv4_series" + }, + { + "name": "Ddsv4Series", + "value": "Ddsv4_series" + }, + { + "name": "Easv4Series", + "value": "Easv4_series" + }, + { + "name": "Dasv4Series", + "value": "Dasv4_series" + }, + { + "name": "Mv2Series", + "value": "Mv2_series" + }, + { + "name": "Eav4Series", + "value": "Eav4_series" + }, + { + "name": "Dav4Series", + "value": "Dav4_series" + }, + { + "name": "Msv2Series", + "value": "Msv2_series" + }, + { + "name": "Mdsv2Series", + "value": "Mdsv2_series" + }, + { + "name": "Dv5Series", + "value": "Dv5_series" + }, + { + "name": "Dsv5Series", + "value": "Dsv5_series" + }, + { + "name": "Ddv5Series", + "value": "Ddv5_series" + }, + { + "name": "Ddsv5Series", + "value": "Ddsv5_series" + }, + { + "name": "Dasv5Series", + "value": "Dasv5_series" + }, + { + "name": "Dadsv5Series", + "value": "Dadsv5_series" + }, + { + "name": "Ev5Series", + "value": "Ev5_series" + }, + { + "name": "Esv5Series", + "value": "Esv5_series" + }, + { + "name": "Edv5Series", + "value": "Edv5_series" + }, + { + "name": "Edsv5Series", + "value": "Edsv5_series" + }, + { + "name": "Easv5Series", + "value": "Easv5_series" + }, + { + "name": "Eadsv5Series", + "value": "Eadsv5_series" + }, + { + "name": "Ebsv5Series", + "value": "Ebsv5_series" + }, + { + "name": "Ebdsv5Series", + "value": "Ebdsv5_series" + } + ] + } + }, + "AzureVmSize": { + "type": "string", + "enum": [ + "Unknown", + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_DC2s", + "Standard_DC4s", + "Standard_E20_v3", + "Standard_E20s_v3", + "Standard_E64i_v3", + "Standard_E64is_v3", + "Standard_M8ms", + "Standard_M16ms", + "Standard_M32ls", + "Standard_M32ms", + "Standard_M32ts", + "Standard_M64", + "Standard_M64ls", + "Standard_M64m", + "Standard_M128", + "Standard_M128m", + "Standard_L8s_v2", + "Standard_L16s_v2", + "Standard_L32s_v2", + "Standard_L48s_v2", + "Standard_L64s_v2", + "Standard_L80s_v2", + "Standard_D2_v4", + "Standard_D4_v4", + "Standard_D8_v4", + "Standard_D16_v4", + "Standard_D32_v4", + "Standard_D48_v4", + "Standard_D64_v4", + "Standard_D2s_v4", + "Standard_D4s_v4", + "Standard_D8s_v4", + "Standard_D16s_v4", + "Standard_D32s_v4", + "Standard_D48s_v4", + "Standard_D64s_v4", + "Standard_D2d_v4", + "Standard_D4d_v4", + "Standard_D8d_v4", + "Standard_D16d_v4", + "Standard_D32d_v4", + "Standard_D48d_v4", + "Standard_D64d_v4", + "Standard_D2ds_v4", + "Standard_D4ds_v4", + "Standard_D8ds_v4", + "Standard_D16ds_v4", + "Standard_D32ds_v4", + "Standard_D48ds_v4", + "Standard_D64ds_v4", + "Standard_E2_v4", + "Standard_E4_v4", + "Standard_E8_v4", + "Standard_E16_v4", + "Standard_E20_v4", + "Standard_E32_v4", + "Standard_E48_v4", + "Standard_E64_v4", + "Standard_E2s_v4", + "Standard_E4s_v4", + "Standard_E8s_v4", + "Standard_E16s_v4", + "Standard_E20s_v4", + "Standard_E32s_v4", + "Standard_E48s_v4", + "Standard_E64s_v4", + "Standard_E2d_v4", + "Standard_E4d_v4", + "Standard_E8d_v4", + "Standard_E16d_v4", + "Standard_E20d_v4", + "Standard_E32d_v4", + "Standard_E48d_v4", + "Standard_E64d_v4", + "Standard_E2ds_v4", + "Standard_E4ds_v4", + "Standard_E8ds_v4", + "Standard_E16ds_v4", + "Standard_E20ds_v4", + "Standard_E32ds_v4", + "Standard_E48ds_v4", + "Standard_E64ds_v4", + "Standard_E2as_v4", + "Standard_E4as_v4", + "Standard_E8as_v4", + "Standard_E16as_v4", + "Standard_E20as_v4", + "Standard_E32as_v4", + "Standard_E48as_v4", + "Standard_E64as_v4", + "Standard_E96as_v4", + "Standard_D2as_v4", + "Standard_D4as_v4", + "Standard_D8as_v4", + "Standard_D16as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D64as_v4", + "Standard_D96as_v4", + "Standard_M208ms_v2", + "Standard_M208s_v2", + "Standard_M416ms_v2", + "Standard_M416s_v2", + "Standard_F48s_v2", + "Standard_E48_v3", + "Standard_E48s_v3", + "Standard_E80is_v4", + "Standard_E80ids_v4", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E20a_v4", + "Standard_E32a_v4", + "Standard_E48a_v4", + "Standard_E64a_v4", + "Standard_E96a_v4", + "Standard_D2a_v4", + "Standard_D4a_v4", + "Standard_D8a_v4", + "Standard_D16a_v4", + "Standard_D32a_v4", + "Standard_D48a_v4", + "Standard_D64a_v4", + "Standard_D96a_v4", + "Standard_M32ms_v2", + "Standard_M64s_v2", + "Standard_M64ms_v2", + "Standard_M128s_v2", + "Standard_M128ms_v2", + "Standard_M192is_v2", + "Standard_M192ims_v2", + "Standard_M32dms_v2", + "Standard_M64ds_v2", + "Standard_M64dms_v2", + "Standard_M128ds_v2", + "Standard_M128dms_v2", + "Standard_M192ids_v2", + "Standard_M192idms_v2", + "Standard_D2_v5", + "Standard_D4_v5", + "Standard_D8_v5", + "Standard_D16_v5", + "Standard_D32_v5", + "Standard_D48_v5", + "Standard_D64_v5", + "Standard_D96_v5", + "Standard_D2s_v5", + "Standard_D4s_v5", + "Standard_D8s_v5", + "Standard_D16s_v5", + "Standard_D32s_v5", + "Standard_D48s_v5", + "Standard_D64s_v5", + "Standard_D96s_v5", + "Standard_D2d_v5", + "Standard_D4d_v5", + "Standard_D8d_v5", + "Standard_D16d_v5", + "Standard_D32d_v5", + "Standard_D48d_v5", + "Standard_D64d_v5", + "Standard_D96d_v5", + "Standard_D2ds_v5", + "Standard_D4ds_v5", + "Standard_D8ds_v5", + "Standard_D16ds_v5", + "Standard_D32ds_v5", + "Standard_D48ds_v5", + "Standard_D64ds_v5", + "Standard_D96ds_v5", + "Standard_D2as_v5", + "Standard_D4as_v5", + "Standard_D8as_v5", + "Standard_D16as_v5", + "Standard_D32as_v5", + "Standard_D48as_v5", + "Standard_D64as_v5", + "Standard_D96as_v5", + "Standard_D2ads_v5", + "Standard_D4ads_v5", + "Standard_D8ads_v5", + "Standard_D16ads_v5", + "Standard_D32ads_v5", + "Standard_D48ads_v5", + "Standard_D64ads_v5", + "Standard_D96ads_v5", + "Standard_E2_v5", + "Standard_E4_v5", + "Standard_E8_v5", + "Standard_E16_v5", + "Standard_E20_v5", + "Standard_E32_v5", + "Standard_E48_v5", + "Standard_E64_v5", + "Standard_E96_v5", + "Standard_E104i_v5", + "Standard_E2s_v5", + "Standard_E4s_v5", + "Standard_E8s_v5", + "Standard_E16s_v5", + "Standard_E20s_v5", + "Standard_E32s_v5", + "Standard_E48s_v5", + "Standard_E64s_v5", + "Standard_E96s_v5", + "Standard_E104is_v5", + "Standard_E2d_v5", + "Standard_E4d_v5", + "Standard_E8d_v5", + "Standard_E16d_v5", + "Standard_E20d_v5", + "Standard_E32d_v5", + "Standard_E48d_v5", + "Standard_E64d_v5", + "Standard_E96d_v5", + "Standard_E104id_v5", + "Standard_E2ds_v5", + "Standard_E4ds_v5", + "Standard_E8ds_v5", + "Standard_E16ds_v5", + "Standard_E20ds_v5", + "Standard_E32ds_v5", + "Standard_E48ds_v5", + "Standard_E64ds_v5", + "Standard_E96ds_v5", + "Standard_E104ids_v5", + "Standard_E2as_v5", + "Standard_E4as_v5", + "Standard_E8as_v5", + "Standard_E16as_v5", + "Standard_E20as_v5", + "Standard_E32as_v5", + "Standard_E48as_v5", + "Standard_E64as_v5", + "Standard_E96as_v5", + "Standard_E2ads_v5", + "Standard_E4ads_v5", + "Standard_E8ads_v5", + "Standard_E16ads_v5", + "Standard_E20ads_v5", + "Standard_E32ads_v5", + "Standard_E48ads_v5", + "Standard_E64ads_v5", + "Standard_E96ads_v5", + "Standard_M8_2ms", + "Standard_M8_4ms", + "Standard_M16_4ms", + "Standard_M16_8ms", + "Standard_M32_8ms", + "Standard_M32_16ms", + "Standard_M64_32ms", + "Standard_M64_16ms", + "Standard_M128_64ms", + "Standard_M128_32ms", + "Standard_E4_2s_v3", + "Standard_E8_4s_v3", + "Standard_E8_2s_v3", + "Standard_E16_8s_v3", + "Standard_E16_4s_v3", + "Standard_E32_16s_v3", + "Standard_E32_8s_v3", + "Standard_E64_32s_v3", + "Standard_E64_16s_v3", + "Standard_E4_2s_v4", + "Standard_E8_4s_v4", + "Standard_E8_2s_v4", + "Standard_E16_8s_v4", + "Standard_E16_4s_v4", + "Standard_E32_16s_v4", + "Standard_E32_8s_v4", + "Standard_E64_32s_v4", + "Standard_E64_16s_v4", + "Standard_E4_2ds_v4", + "Standard_E8_4ds_v4", + "Standard_E8_2ds_v4", + "Standard_E16_8ds_v4", + "Standard_E16_4ds_v4", + "Standard_E32_16ds_v4", + "Standard_E32_8ds_v4", + "Standard_E64_32ds_v4", + "Standard_E64_16ds_v4", + "Standard_E4_2as_v4", + "Standard_E8_4as_v4", + "Standard_E8_2as_v4", + "Standard_E16_8as_v4", + "Standard_E16_4as_v4", + "Standard_E32_16as_v4", + "Standard_E32_8as_v4", + "Standard_E64_32as_v4", + "Standard_E64_16as_v4", + "Standard_E96_48as_v4", + "Standard_E96_24as_v4", + "Standard_E4_2ads_v5", + "Standard_E8_4ads_v5", + "Standard_E8_2ads_v5", + "Standard_E16_8ads_v5", + "Standard_E16_4ads_v5", + "Standard_E32_16ads_v5", + "Standard_E32_8ads_v5", + "Standard_E64_32ads_v5", + "Standard_E64_16ads_v5", + "Standard_E96_48ads_v5", + "Standard_E96_24ads_v5", + "Standard_E4_2s_v5", + "Standard_E8_4s_v5", + "Standard_E8_2s_v5", + "Standard_E16_8s_v5", + "Standard_E16_4s_v5", + "Standard_E32_16s_v5", + "Standard_E32_8s_v5", + "Standard_E64_32s_v5", + "Standard_E64_16s_v5", + "Standard_E96_48s_v5", + "Standard_E96_24s_v5", + "Standard_E4_2ds_v5", + "Standard_E8_4ds_v5", + "Standard_E8_2ds_v5", + "Standard_E16_8ds_v5", + "Standard_E16_4ds_v5", + "Standard_E32_16ds_v5", + "Standard_E32_8ds_v5", + "Standard_E64_32ds_v5", + "Standard_E64_16ds_v5", + "Standard_E96_48ds_v5", + "Standard_E96_24ds_v5", + "Standard_E4_2as_v5", + "Standard_E8_4as_v5", + "Standard_E8_2as_v5", + "Standard_E16_8as_v5", + "Standard_E16_4as_v5", + "Standard_E32_16as_v5", + "Standard_E32_8as_v5", + "Standard_E64_32as_v5", + "Standard_E64_16as_v5", + "Standard_E96_48as_v5", + "Standard_E96_24as_v5", + "Standard_GS4_8", + "Standard_GS4_4", + "Standard_GS5_16", + "Standard_GS5_8", + "Standard_DS11_1_v2", + "Standard_DS12_2_v2", + "Standard_DS12_1_v2", + "Standard_DS13_4_v2", + "Standard_DS13_2_v2", + "Standard_DS14_8_v2", + "Standard_DS14_4_v2", + "Standard_M416_208s_v2", + "Standard_M416_208ms_v2", + "Standard_E2bs_v5", + "Standard_E4bs_v5", + "Standard_E8bs_v5", + "Standard_E16bs_v5", + "Standard_E32bs_v5", + "Standard_E48bs_v5", + "Standard_E64bs_v5", + "Standard_E2bds_v5", + "Standard_E4bds_v5", + "Standard_E8bds_v5", + "Standard_E16bds_v5", + "Standard_E32bds_v5", + "Standard_E48bds_v5", + "Standard_E64bds_v5" + ], + "x-ms-enum": { + "name": "AzureVmSize", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "BasicA0", + "value": "Basic_A0" + }, + { + "name": "BasicA1", + "value": "Basic_A1" + }, + { + "name": "BasicA2", + "value": "Basic_A2" + }, + { + "name": "BasicA3", + "value": "Basic_A3" + }, + { + "name": "BasicA4", + "value": "Basic_A4" + }, + { + "name": "StandardA0", + "value": "Standard_A0" + }, + { + "name": "StandardA1", + "value": "Standard_A1" + }, + { + "name": "StandardA2", + "value": "Standard_A2" + }, + { + "name": "StandardA3", + "value": "Standard_A3" + }, + { + "name": "StandardA4", + "value": "Standard_A4" + }, + { + "name": "StandardA5", + "value": "Standard_A5" + }, + { + "name": "StandardA6", + "value": "Standard_A6" + }, + { + "name": "StandardA7", + "value": "Standard_A7" + }, + { + "name": "StandardA8", + "value": "Standard_A8" + }, + { + "name": "StandardA9", + "value": "Standard_A9" + }, + { + "name": "StandardA10", + "value": "Standard_A10" + }, + { + "name": "StandardA11", + "value": "Standard_A11" + }, + { + "name": "StandardA1V2", + "value": "Standard_A1_v2" + }, + { + "name": "StandardA2V2", + "value": "Standard_A2_v2" + }, + { + "name": "StandardA4V2", + "value": "Standard_A4_v2" + }, + { + "name": "StandardA8V2", + "value": "Standard_A8_v2" + }, + { + "name": "StandardA2MV2", + "value": "Standard_A2m_v2" + }, + { + "name": "StandardA4MV2", + "value": "Standard_A4m_v2" + }, + { + "name": "StandardA8MV2", + "value": "Standard_A8m_v2" + }, + { + "name": "StandardD1", + "value": "Standard_D1" + }, + { + "name": "StandardD2", + "value": "Standard_D2" + }, + { + "name": "StandardD3", + "value": "Standard_D3" + }, + { + "name": "StandardD4", + "value": "Standard_D4" + }, + { + "name": "StandardD11", + "value": "Standard_D11" + }, + { + "name": "StandardD12", + "value": "Standard_D12" + }, + { + "name": "StandardD13", + "value": "Standard_D13" + }, + { + "name": "StandardD14", + "value": "Standard_D14" + }, + { + "name": "StandardD1V2", + "value": "Standard_D1_v2" + }, + { + "name": "StandardD2V2", + "value": "Standard_D2_v2" + }, + { + "name": "StandardD3V2", + "value": "Standard_D3_v2" + }, + { + "name": "StandardD4V2", + "value": "Standard_D4_v2" + }, + { + "name": "StandardD5V2", + "value": "Standard_D5_v2" + }, + { + "name": "StandardD11V2", + "value": "Standard_D11_v2" + }, + { + "name": "StandardD12V2", + "value": "Standard_D12_v2" + }, + { + "name": "StandardD13V2", + "value": "Standard_D13_v2" + }, + { + "name": "StandardD14V2", + "value": "Standard_D14_v2" + }, + { + "name": "StandardD15V2", + "value": "Standard_D15_v2" + }, + { + "name": "StandardDS1", + "value": "Standard_DS1" + }, + { + "name": "StandardDS2", + "value": "Standard_DS2" + }, + { + "name": "StandardDS3", + "value": "Standard_DS3" + }, + { + "name": "StandardDS4", + "value": "Standard_DS4" + }, + { + "name": "StandardDS11", + "value": "Standard_DS11" + }, + { + "name": "StandardDS12", + "value": "Standard_DS12" + }, + { + "name": "StandardDS13", + "value": "Standard_DS13" + }, + { + "name": "StandardDS14", + "value": "Standard_DS14" + }, + { + "name": "StandardDS1V2", + "value": "Standard_DS1_v2" + }, + { + "name": "StandardDS2V2", + "value": "Standard_DS2_v2" + }, + { + "name": "StandardDS3V2", + "value": "Standard_DS3_v2" + }, + { + "name": "StandardDS4V2", + "value": "Standard_DS4_v2" + }, + { + "name": "StandardDS5V2", + "value": "Standard_DS5_v2" + }, + { + "name": "StandardDS11V2", + "value": "Standard_DS11_v2" + }, + { + "name": "StandardDS12V2", + "value": "Standard_DS12_v2" + }, + { + "name": "StandardDS13V2", + "value": "Standard_DS13_v2" + }, + { + "name": "StandardDS14V2", + "value": "Standard_DS14_v2" + }, + { + "name": "StandardDS15V2", + "value": "Standard_DS15_v2" + }, + { + "name": "StandardF1", + "value": "Standard_F1" + }, + { + "name": "StandardF2", + "value": "Standard_F2" + }, + { + "name": "StandardF4", + "value": "Standard_F4" + }, + { + "name": "StandardF8", + "value": "Standard_F8" + }, + { + "name": "StandardF16", + "value": "Standard_F16" + }, + { + "name": "StandardF1S", + "value": "Standard_F1s" + }, + { + "name": "StandardF2S", + "value": "Standard_F2s" + }, + { + "name": "StandardF4S", + "value": "Standard_F4s" + }, + { + "name": "StandardF8S", + "value": "Standard_F8s" + }, + { + "name": "StandardF16S", + "value": "Standard_F16s" + }, + { + "name": "StandardG1", + "value": "Standard_G1" + }, + { + "name": "StandardG2", + "value": "Standard_G2" + }, + { + "name": "StandardG3", + "value": "Standard_G3" + }, + { + "name": "StandardG4", + "value": "Standard_G4" + }, + { + "name": "StandardG5", + "value": "Standard_G5" + }, + { + "name": "StandardGS1", + "value": "Standard_GS1" + }, + { + "name": "StandardGS2", + "value": "Standard_GS2" + }, + { + "name": "StandardGS3", + "value": "Standard_GS3" + }, + { + "name": "StandardGS4", + "value": "Standard_GS4" + }, + { + "name": "StandardGS5", + "value": "Standard_GS5" + }, + { + "name": "StandardH8", + "value": "Standard_H8" + }, + { + "name": "StandardH16", + "value": "Standard_H16" + }, + { + "name": "StandardH8M", + "value": "Standard_H8m" + }, + { + "name": "StandardH16M", + "value": "Standard_H16m" + }, + { + "name": "StandardH16R", + "value": "Standard_H16r" + }, + { + "name": "StandardH16Mr", + "value": "Standard_H16mr" + }, + { + "name": "StandardL4S", + "value": "Standard_L4s" + }, + { + "name": "StandardL8S", + "value": "Standard_L8s" + }, + { + "name": "StandardL16S", + "value": "Standard_L16s" + }, + { + "name": "StandardL32S", + "value": "Standard_L32s" + }, + { + "name": "StandardD2SV3", + "value": "Standard_D2s_v3" + }, + { + "name": "StandardD4SV3", + "value": "Standard_D4s_v3" + }, + { + "name": "StandardD8SV3", + "value": "Standard_D8s_v3" + }, + { + "name": "StandardD16SV3", + "value": "Standard_D16s_v3" + }, + { + "name": "StandardD32SV3", + "value": "Standard_D32s_v3" + }, + { + "name": "StandardD64SV3", + "value": "Standard_D64s_v3" + }, + { + "name": "StandardD2V3", + "value": "Standard_D2_v3" + }, + { + "name": "StandardD4V3", + "value": "Standard_D4_v3" + }, + { + "name": "StandardD8V3", + "value": "Standard_D8_v3" + }, + { + "name": "StandardD16V3", + "value": "Standard_D16_v3" + }, + { + "name": "StandardD32V3", + "value": "Standard_D32_v3" + }, + { + "name": "StandardD64V3", + "value": "Standard_D64_v3" + }, + { + "name": "StandardF2SV2", + "value": "Standard_F2s_v2" + }, + { + "name": "StandardF4SV2", + "value": "Standard_F4s_v2" + }, + { + "name": "StandardF8SV2", + "value": "Standard_F8s_v2" + }, + { + "name": "StandardF16SV2", + "value": "Standard_F16s_v2" + }, + { + "name": "StandardF32SV2", + "value": "Standard_F32s_v2" + }, + { + "name": "StandardF64SV2", + "value": "Standard_F64s_v2" + }, + { + "name": "StandardF72SV2", + "value": "Standard_F72s_v2" + }, + { + "name": "StandardE2V3", + "value": "Standard_E2_v3" + }, + { + "name": "StandardE4V3", + "value": "Standard_E4_v3" + }, + { + "name": "StandardE8V3", + "value": "Standard_E8_v3" + }, + { + "name": "StandardE16V3", + "value": "Standard_E16_v3" + }, + { + "name": "StandardE32V3", + "value": "Standard_E32_v3" + }, + { + "name": "StandardE64V3", + "value": "Standard_E64_v3" + }, + { + "name": "StandardE2SV3", + "value": "Standard_E2s_v3" + }, + { + "name": "StandardE4SV3", + "value": "Standard_E4s_v3" + }, + { + "name": "StandardE8SV3", + "value": "Standard_E8s_v3" + }, + { + "name": "StandardE16SV3", + "value": "Standard_E16s_v3" + }, + { + "name": "StandardE32SV3", + "value": "Standard_E32s_v3" + }, + { + "name": "StandardE64SV3", + "value": "Standard_E64s_v3" + }, + { + "name": "StandardM64S", + "value": "Standard_M64s" + }, + { + "name": "StandardM64Ms", + "value": "Standard_M64ms" + }, + { + "name": "StandardM128S", + "value": "Standard_M128s" + }, + { + "name": "StandardM128Ms", + "value": "Standard_M128ms" + }, + { + "name": "StandardDC2S", + "value": "Standard_DC2s" + }, + { + "name": "StandardDC4S", + "value": "Standard_DC4s" + }, + { + "name": "StandardE20V3", + "value": "Standard_E20_v3" + }, + { + "name": "StandardE20SV3", + "value": "Standard_E20s_v3" + }, + { + "name": "StandardE64IV3", + "value": "Standard_E64i_v3" + }, + { + "name": "StandardE64IsV3", + "value": "Standard_E64is_v3" + }, + { + "name": "StandardM8Ms", + "value": "Standard_M8ms" + }, + { + "name": "StandardM16Ms", + "value": "Standard_M16ms" + }, + { + "name": "StandardM32Ls", + "value": "Standard_M32ls" + }, + { + "name": "StandardM32Ms", + "value": "Standard_M32ms" + }, + { + "name": "StandardM32Ts", + "value": "Standard_M32ts" + }, + { + "name": "StandardM64", + "value": "Standard_M64" + }, + { + "name": "StandardM64Ls", + "value": "Standard_M64ls" + }, + { + "name": "StandardM64M", + "value": "Standard_M64m" + }, + { + "name": "StandardM128", + "value": "Standard_M128" + }, + { + "name": "StandardM128M", + "value": "Standard_M128m" + }, + { + "name": "StandardL8SV2", + "value": "Standard_L8s_v2" + }, + { + "name": "StandardL16SV2", + "value": "Standard_L16s_v2" + }, + { + "name": "StandardL32SV2", + "value": "Standard_L32s_v2" + }, + { + "name": "StandardL48SV2", + "value": "Standard_L48s_v2" + }, + { + "name": "StandardL64SV2", + "value": "Standard_L64s_v2" + }, + { + "name": "StandardL80SV2", + "value": "Standard_L80s_v2" + }, + { + "name": "StandardD2V4", + "value": "Standard_D2_v4" + }, + { + "name": "StandardD4V4", + "value": "Standard_D4_v4" + }, + { + "name": "StandardD8V4", + "value": "Standard_D8_v4" + }, + { + "name": "StandardD16V4", + "value": "Standard_D16_v4" + }, + { + "name": "StandardD32V4", + "value": "Standard_D32_v4" + }, + { + "name": "StandardD48V4", + "value": "Standard_D48_v4" + }, + { + "name": "StandardD64V4", + "value": "Standard_D64_v4" + }, + { + "name": "StandardD2SV4", + "value": "Standard_D2s_v4" + }, + { + "name": "StandardD4SV4", + "value": "Standard_D4s_v4" + }, + { + "name": "StandardD8SV4", + "value": "Standard_D8s_v4" + }, + { + "name": "StandardD16SV4", + "value": "Standard_D16s_v4" + }, + { + "name": "StandardD32SV4", + "value": "Standard_D32s_v4" + }, + { + "name": "StandardD48SV4", + "value": "Standard_D48s_v4" + }, + { + "name": "StandardD64SV4", + "value": "Standard_D64s_v4" + }, + { + "name": "StandardD2DV4", + "value": "Standard_D2d_v4" + }, + { + "name": "StandardD4DV4", + "value": "Standard_D4d_v4" + }, + { + "name": "StandardD8DV4", + "value": "Standard_D8d_v4" + }, + { + "name": "StandardD16DV4", + "value": "Standard_D16d_v4" + }, + { + "name": "StandardD32DV4", + "value": "Standard_D32d_v4" + }, + { + "name": "StandardD48DV4", + "value": "Standard_D48d_v4" + }, + { + "name": "StandardD64DV4", + "value": "Standard_D64d_v4" + }, + { + "name": "StandardD2DsV4", + "value": "Standard_D2ds_v4" + }, + { + "name": "StandardD4DsV4", + "value": "Standard_D4ds_v4" + }, + { + "name": "StandardD8DsV4", + "value": "Standard_D8ds_v4" + }, + { + "name": "StandardD16DsV4", + "value": "Standard_D16ds_v4" + }, + { + "name": "StandardD32DsV4", + "value": "Standard_D32ds_v4" + }, + { + "name": "StandardD48DsV4", + "value": "Standard_D48ds_v4" + }, + { + "name": "StandardD64DsV4", + "value": "Standard_D64ds_v4" + }, + { + "name": "StandardE2V4", + "value": "Standard_E2_v4" + }, + { + "name": "StandardE4V4", + "value": "Standard_E4_v4" + }, + { + "name": "StandardE8V4", + "value": "Standard_E8_v4" + }, + { + "name": "StandardE16V4", + "value": "Standard_E16_v4" + }, + { + "name": "StandardE20V4", + "value": "Standard_E20_v4" + }, + { + "name": "StandardE32V4", + "value": "Standard_E32_v4" + }, + { + "name": "StandardE48V4", + "value": "Standard_E48_v4" + }, + { + "name": "StandardE64V4", + "value": "Standard_E64_v4" + }, + { + "name": "StandardE2SV4", + "value": "Standard_E2s_v4" + }, + { + "name": "StandardE4SV4", + "value": "Standard_E4s_v4" + }, + { + "name": "StandardE8SV4", + "value": "Standard_E8s_v4" + }, + { + "name": "StandardE16SV4", + "value": "Standard_E16s_v4" + }, + { + "name": "StandardE20SV4", + "value": "Standard_E20s_v4" + }, + { + "name": "StandardE32SV4", + "value": "Standard_E32s_v4" + }, + { + "name": "StandardE48SV4", + "value": "Standard_E48s_v4" + }, + { + "name": "StandardE64SV4", + "value": "Standard_E64s_v4" + }, + { + "name": "StandardE2DV4", + "value": "Standard_E2d_v4" + }, + { + "name": "StandardE4DV4", + "value": "Standard_E4d_v4" + }, + { + "name": "StandardE8DV4", + "value": "Standard_E8d_v4" + }, + { + "name": "StandardE16DV4", + "value": "Standard_E16d_v4" + }, + { + "name": "StandardE20DV4", + "value": "Standard_E20d_v4" + }, + { + "name": "StandardE32DV4", + "value": "Standard_E32d_v4" + }, + { + "name": "StandardE48DV4", + "value": "Standard_E48d_v4" + }, + { + "name": "StandardE64DV4", + "value": "Standard_E64d_v4" + }, + { + "name": "StandardE2DsV4", + "value": "Standard_E2ds_v4" + }, + { + "name": "StandardE4DsV4", + "value": "Standard_E4ds_v4" + }, + { + "name": "StandardE8DsV4", + "value": "Standard_E8ds_v4" + }, + { + "name": "StandardE16DsV4", + "value": "Standard_E16ds_v4" + }, + { + "name": "StandardE20DsV4", + "value": "Standard_E20ds_v4" + }, + { + "name": "StandardE32DsV4", + "value": "Standard_E32ds_v4" + }, + { + "name": "StandardE48DsV4", + "value": "Standard_E48ds_v4" + }, + { + "name": "StandardE64DsV4", + "value": "Standard_E64ds_v4" + }, + { + "name": "StandardE2AsV4", + "value": "Standard_E2as_v4" + }, + { + "name": "StandardE4AsV4", + "value": "Standard_E4as_v4" + }, + { + "name": "StandardE8AsV4", + "value": "Standard_E8as_v4" + }, + { + "name": "StandardE16AsV4", + "value": "Standard_E16as_v4" + }, + { + "name": "StandardE20AsV4", + "value": "Standard_E20as_v4" + }, + { + "name": "StandardE32AsV4", + "value": "Standard_E32as_v4" + }, + { + "name": "StandardE48AsV4", + "value": "Standard_E48as_v4" + }, + { + "name": "StandardE64AsV4", + "value": "Standard_E64as_v4" + }, + { + "name": "StandardE96AsV4", + "value": "Standard_E96as_v4" + }, + { + "name": "StandardD2AsV4", + "value": "Standard_D2as_v4" + }, + { + "name": "StandardD4AsV4", + "value": "Standard_D4as_v4" + }, + { + "name": "StandardD8AsV4", + "value": "Standard_D8as_v4" + }, + { + "name": "StandardD16AsV4", + "value": "Standard_D16as_v4" + }, + { + "name": "StandardD32AsV4", + "value": "Standard_D32as_v4" + }, + { + "name": "StandardD48AsV4", + "value": "Standard_D48as_v4" + }, + { + "name": "StandardD64AsV4", + "value": "Standard_D64as_v4" + }, + { + "name": "StandardD96AsV4", + "value": "Standard_D96as_v4" + }, + { + "name": "StandardM208MsV2", + "value": "Standard_M208ms_v2" + }, + { + "name": "StandardM208SV2", + "value": "Standard_M208s_v2" + }, + { + "name": "StandardM416MsV2", + "value": "Standard_M416ms_v2" + }, + { + "name": "StandardM416SV2", + "value": "Standard_M416s_v2" + }, + { + "name": "StandardF48SV2", + "value": "Standard_F48s_v2" + }, + { + "name": "StandardE48V3", + "value": "Standard_E48_v3" + }, + { + "name": "StandardE48SV3", + "value": "Standard_E48s_v3" + }, + { + "name": "StandardE80IsV4", + "value": "Standard_E80is_v4" + }, + { + "name": "StandardE80IdsV4", + "value": "Standard_E80ids_v4" + }, + { + "name": "StandardE2AV4", + "value": "Standard_E2a_v4" + }, + { + "name": "StandardE4AV4", + "value": "Standard_E4a_v4" + }, + { + "name": "StandardE8AV4", + "value": "Standard_E8a_v4" + }, + { + "name": "StandardE16AV4", + "value": "Standard_E16a_v4" + }, + { + "name": "StandardE20AV4", + "value": "Standard_E20a_v4" + }, + { + "name": "StandardE32AV4", + "value": "Standard_E32a_v4" + }, + { + "name": "StandardE48AV4", + "value": "Standard_E48a_v4" + }, + { + "name": "StandardE64AV4", + "value": "Standard_E64a_v4" + }, + { + "name": "StandardE96AV4", + "value": "Standard_E96a_v4" + }, + { + "name": "StandardD2AV4", + "value": "Standard_D2a_v4" + }, + { + "name": "StandardD4AV4", + "value": "Standard_D4a_v4" + }, + { + "name": "StandardD8AV4", + "value": "Standard_D8a_v4" + }, + { + "name": "StandardD16AV4", + "value": "Standard_D16a_v4" + }, + { + "name": "StandardD32AV4", + "value": "Standard_D32a_v4" + }, + { + "name": "StandardD48AV4", + "value": "Standard_D48a_v4" + }, + { + "name": "StandardD64AV4", + "value": "Standard_D64a_v4" + }, + { + "name": "StandardD96AV4", + "value": "Standard_D96a_v4" + }, + { + "name": "StandardM32MsV2", + "value": "Standard_M32ms_v2" + }, + { + "name": "StandardM64SV2", + "value": "Standard_M64s_v2" + }, + { + "name": "StandardM64MsV2", + "value": "Standard_M64ms_v2" + }, + { + "name": "StandardM128SV2", + "value": "Standard_M128s_v2" + }, + { + "name": "StandardM128MsV2", + "value": "Standard_M128ms_v2" + }, + { + "name": "StandardM192IsV2", + "value": "Standard_M192is_v2" + }, + { + "name": "StandardM192ImsV2", + "value": "Standard_M192ims_v2" + }, + { + "name": "StandardM32DmsV2", + "value": "Standard_M32dms_v2" + }, + { + "name": "StandardM64DsV2", + "value": "Standard_M64ds_v2" + }, + { + "name": "StandardM64DmsV2", + "value": "Standard_M64dms_v2" + }, + { + "name": "StandardM128DsV2", + "value": "Standard_M128ds_v2" + }, + { + "name": "StandardM128DmsV2", + "value": "Standard_M128dms_v2" + }, + { + "name": "StandardM192IdsV2", + "value": "Standard_M192ids_v2" + }, + { + "name": "StandardM192IdmsV2", + "value": "Standard_M192idms_v2" + }, + { + "name": "StandardD2V5", + "value": "Standard_D2_v5" + }, + { + "name": "StandardD4V5", + "value": "Standard_D4_v5" + }, + { + "name": "StandardD8V5", + "value": "Standard_D8_v5" + }, + { + "name": "StandardD16V5", + "value": "Standard_D16_v5" + }, + { + "name": "StandardD32V5", + "value": "Standard_D32_v5" + }, + { + "name": "StandardD48V5", + "value": "Standard_D48_v5" + }, + { + "name": "StandardD64V5", + "value": "Standard_D64_v5" + }, + { + "name": "StandardD96V5", + "value": "Standard_D96_v5" + }, + { + "name": "StandardD2SV5", + "value": "Standard_D2s_v5" + }, + { + "name": "StandardD4SV5", + "value": "Standard_D4s_v5" + }, + { + "name": "StandardD8SV5", + "value": "Standard_D8s_v5" + }, + { + "name": "StandardD16SV5", + "value": "Standard_D16s_v5" + }, + { + "name": "StandardD32SV5", + "value": "Standard_D32s_v5" + }, + { + "name": "StandardD48SV5", + "value": "Standard_D48s_v5" + }, + { + "name": "StandardD64SV5", + "value": "Standard_D64s_v5" + }, + { + "name": "StandardD96SV5", + "value": "Standard_D96s_v5" + }, + { + "name": "StandardD2DV5", + "value": "Standard_D2d_v5" + }, + { + "name": "StandardD4DV5", + "value": "Standard_D4d_v5" + }, + { + "name": "StandardD8DV5", + "value": "Standard_D8d_v5" + }, + { + "name": "StandardD16DV5", + "value": "Standard_D16d_v5" + }, + { + "name": "StandardD32DV5", + "value": "Standard_D32d_v5" + }, + { + "name": "StandardD48DV5", + "value": "Standard_D48d_v5" + }, + { + "name": "StandardD64DV5", + "value": "Standard_D64d_v5" + }, + { + "name": "StandardD96DV5", + "value": "Standard_D96d_v5" + }, + { + "name": "StandardD2DsV5", + "value": "Standard_D2ds_v5" + }, + { + "name": "StandardD4DsV5", + "value": "Standard_D4ds_v5" + }, + { + "name": "StandardD8DsV5", + "value": "Standard_D8ds_v5" + }, + { + "name": "StandardD16DsV5", + "value": "Standard_D16ds_v5" + }, + { + "name": "StandardD32DsV5", + "value": "Standard_D32ds_v5" + }, + { + "name": "StandardD48DsV5", + "value": "Standard_D48ds_v5" + }, + { + "name": "StandardD64DsV5", + "value": "Standard_D64ds_v5" + }, + { + "name": "StandardD96DsV5", + "value": "Standard_D96ds_v5" + }, + { + "name": "StandardD2AsV5", + "value": "Standard_D2as_v5" + }, + { + "name": "StandardD4AsV5", + "value": "Standard_D4as_v5" + }, + { + "name": "StandardD8AsV5", + "value": "Standard_D8as_v5" + }, + { + "name": "StandardD16AsV5", + "value": "Standard_D16as_v5" + }, + { + "name": "StandardD32AsV5", + "value": "Standard_D32as_v5" + }, + { + "name": "StandardD48AsV5", + "value": "Standard_D48as_v5" + }, + { + "name": "StandardD64AsV5", + "value": "Standard_D64as_v5" + }, + { + "name": "StandardD96AsV5", + "value": "Standard_D96as_v5" + }, + { + "name": "StandardD2AdsV5", + "value": "Standard_D2ads_v5" + }, + { + "name": "StandardD4AdsV5", + "value": "Standard_D4ads_v5" + }, + { + "name": "StandardD8AdsV5", + "value": "Standard_D8ads_v5" + }, + { + "name": "StandardD16AdsV5", + "value": "Standard_D16ads_v5" + }, + { + "name": "StandardD32AdsV5", + "value": "Standard_D32ads_v5" + }, + { + "name": "StandardD48AdsV5", + "value": "Standard_D48ads_v5" + }, + { + "name": "StandardD64AdsV5", + "value": "Standard_D64ads_v5" + }, + { + "name": "StandardD96AdsV5", + "value": "Standard_D96ads_v5" + }, + { + "name": "StandardE2V5", + "value": "Standard_E2_v5" + }, + { + "name": "StandardE4V5", + "value": "Standard_E4_v5" + }, + { + "name": "StandardE8V5", + "value": "Standard_E8_v5" + }, + { + "name": "StandardE16V5", + "value": "Standard_E16_v5" + }, + { + "name": "StandardE20V5", + "value": "Standard_E20_v5" + }, + { + "name": "StandardE32V5", + "value": "Standard_E32_v5" + }, + { + "name": "StandardE48V5", + "value": "Standard_E48_v5" + }, + { + "name": "StandardE64V5", + "value": "Standard_E64_v5" + }, + { + "name": "StandardE96V5", + "value": "Standard_E96_v5" + }, + { + "name": "StandardE104IV5", + "value": "Standard_E104i_v5" + }, + { + "name": "StandardE2SV5", + "value": "Standard_E2s_v5" + }, + { + "name": "StandardE4SV5", + "value": "Standard_E4s_v5" + }, + { + "name": "StandardE8SV5", + "value": "Standard_E8s_v5" + }, + { + "name": "StandardE16SV5", + "value": "Standard_E16s_v5" + }, + { + "name": "StandardE20SV5", + "value": "Standard_E20s_v5" + }, + { + "name": "StandardE32SV5", + "value": "Standard_E32s_v5" + }, + { + "name": "StandardE48SV5", + "value": "Standard_E48s_v5" + }, + { + "name": "StandardE64SV5", + "value": "Standard_E64s_v5" + }, + { + "name": "StandardE96SV5", + "value": "Standard_E96s_v5" + }, + { + "name": "StandardE104IsV5", + "value": "Standard_E104is_v5" + }, + { + "name": "StandardE2DV5", + "value": "Standard_E2d_v5" + }, + { + "name": "StandardE4DV5", + "value": "Standard_E4d_v5" + }, + { + "name": "StandardE8DV5", + "value": "Standard_E8d_v5" + }, + { + "name": "StandardE16DV5", + "value": "Standard_E16d_v5" + }, + { + "name": "StandardE20DV5", + "value": "Standard_E20d_v5" + }, + { + "name": "StandardE32DV5", + "value": "Standard_E32d_v5" + }, + { + "name": "StandardE48DV5", + "value": "Standard_E48d_v5" + }, + { + "name": "StandardE64DV5", + "value": "Standard_E64d_v5" + }, + { + "name": "StandardE96DV5", + "value": "Standard_E96d_v5" + }, + { + "name": "StandardE104IdV5", + "value": "Standard_E104id_v5" + }, + { + "name": "StandardE2DsV5", + "value": "Standard_E2ds_v5" + }, + { + "name": "StandardE4DsV5", + "value": "Standard_E4ds_v5" + }, + { + "name": "StandardE8DsV5", + "value": "Standard_E8ds_v5" + }, + { + "name": "StandardE16DsV5", + "value": "Standard_E16ds_v5" + }, + { + "name": "StandardE20DsV5", + "value": "Standard_E20ds_v5" + }, + { + "name": "StandardE32DsV5", + "value": "Standard_E32ds_v5" + }, + { + "name": "StandardE48DsV5", + "value": "Standard_E48ds_v5" + }, + { + "name": "StandardE64DsV5", + "value": "Standard_E64ds_v5" + }, + { + "name": "StandardE96DsV5", + "value": "Standard_E96ds_v5" + }, + { + "name": "StandardE104IdsV5", + "value": "Standard_E104ids_v5" + }, + { + "name": "StandardE2AsV5", + "value": "Standard_E2as_v5" + }, + { + "name": "StandardE4AsV5", + "value": "Standard_E4as_v5" + }, + { + "name": "StandardE8AsV5", + "value": "Standard_E8as_v5" + }, + { + "name": "StandardE16AsV5", + "value": "Standard_E16as_v5" + }, + { + "name": "StandardE20AsV5", + "value": "Standard_E20as_v5" + }, + { + "name": "StandardE32AsV5", + "value": "Standard_E32as_v5" + }, + { + "name": "StandardE48AsV5", + "value": "Standard_E48as_v5" + }, + { + "name": "StandardE64AsV5", + "value": "Standard_E64as_v5" + }, + { + "name": "StandardE96AsV5", + "value": "Standard_E96as_v5" + }, + { + "name": "StandardE2AdsV5", + "value": "Standard_E2ads_v5" + }, + { + "name": "StandardE4AdsV5", + "value": "Standard_E4ads_v5" + }, + { + "name": "StandardE8AdsV5", + "value": "Standard_E8ads_v5" + }, + { + "name": "StandardE16AdsV5", + "value": "Standard_E16ads_v5" + }, + { + "name": "StandardE20AdsV5", + "value": "Standard_E20ads_v5" + }, + { + "name": "StandardE32AdsV5", + "value": "Standard_E32ads_v5" + }, + { + "name": "StandardE48AdsV5", + "value": "Standard_E48ads_v5" + }, + { + "name": "StandardE64AdsV5", + "value": "Standard_E64ads_v5" + }, + { + "name": "StandardE96AdsV5", + "value": "Standard_E96ads_v5" + }, + { + "name": "StandardM82Ms", + "value": "Standard_M8_2ms" + }, + { + "name": "StandardM84Ms", + "value": "Standard_M8_4ms" + }, + { + "name": "StandardM164Ms", + "value": "Standard_M16_4ms" + }, + { + "name": "StandardM168Ms", + "value": "Standard_M16_8ms" + }, + { + "name": "StandardM328Ms", + "value": "Standard_M32_8ms" + }, + { + "name": "StandardM3216Ms", + "value": "Standard_M32_16ms" + }, + { + "name": "StandardM6432Ms", + "value": "Standard_M64_32ms" + }, + { + "name": "StandardM6416Ms", + "value": "Standard_M64_16ms" + }, + { + "name": "StandardM12864Ms", + "value": "Standard_M128_64ms" + }, + { + "name": "StandardM12832Ms", + "value": "Standard_M128_32ms" + }, + { + "name": "StandardE42SV3", + "value": "Standard_E4_2s_v3" + }, + { + "name": "StandardE84SV3", + "value": "Standard_E8_4s_v3" + }, + { + "name": "StandardE82SV3", + "value": "Standard_E8_2s_v3" + }, + { + "name": "StandardE168SV3", + "value": "Standard_E16_8s_v3" + }, + { + "name": "StandardE164SV3", + "value": "Standard_E16_4s_v3" + }, + { + "name": "StandardE3216SV3", + "value": "Standard_E32_16s_v3" + }, + { + "name": "StandardE328SV3", + "value": "Standard_E32_8s_v3" + }, + { + "name": "StandardE6432SV3", + "value": "Standard_E64_32s_v3" + }, + { + "name": "StandardE6416SV3", + "value": "Standard_E64_16s_v3" + }, + { + "name": "StandardE42SV4", + "value": "Standard_E4_2s_v4" + }, + { + "name": "StandardE84SV4", + "value": "Standard_E8_4s_v4" + }, + { + "name": "StandardE82SV4", + "value": "Standard_E8_2s_v4" + }, + { + "name": "StandardE168SV4", + "value": "Standard_E16_8s_v4" + }, + { + "name": "StandardE164SV4", + "value": "Standard_E16_4s_v4" + }, + { + "name": "StandardE3216SV4", + "value": "Standard_E32_16s_v4" + }, + { + "name": "StandardE328SV4", + "value": "Standard_E32_8s_v4" + }, + { + "name": "StandardE6432SV4", + "value": "Standard_E64_32s_v4" + }, + { + "name": "StandardE6416SV4", + "value": "Standard_E64_16s_v4" + }, + { + "name": "StandardE42DsV4", + "value": "Standard_E4_2ds_v4" + }, + { + "name": "StandardE84DsV4", + "value": "Standard_E8_4ds_v4" + }, + { + "name": "StandardE82DsV4", + "value": "Standard_E8_2ds_v4" + }, + { + "name": "StandardE168DsV4", + "value": "Standard_E16_8ds_v4" + }, + { + "name": "StandardE164DsV4", + "value": "Standard_E16_4ds_v4" + }, + { + "name": "StandardE3216DsV4", + "value": "Standard_E32_16ds_v4" + }, + { + "name": "StandardE328DsV4", + "value": "Standard_E32_8ds_v4" + }, + { + "name": "StandardE6432DsV4", + "value": "Standard_E64_32ds_v4" + }, + { + "name": "StandardE6416DsV4", + "value": "Standard_E64_16ds_v4" + }, + { + "name": "StandardE42AsV4", + "value": "Standard_E4_2as_v4" + }, + { + "name": "StandardE84AsV4", + "value": "Standard_E8_4as_v4" + }, + { + "name": "StandardE82AsV4", + "value": "Standard_E8_2as_v4" + }, + { + "name": "StandardE168AsV4", + "value": "Standard_E16_8as_v4" + }, + { + "name": "StandardE164AsV4", + "value": "Standard_E16_4as_v4" + }, + { + "name": "StandardE3216AsV4", + "value": "Standard_E32_16as_v4" + }, + { + "name": "StandardE328AsV4", + "value": "Standard_E32_8as_v4" + }, + { + "name": "StandardE6432AsV4", + "value": "Standard_E64_32as_v4" + }, + { + "name": "StandardE6416AsV4", + "value": "Standard_E64_16as_v4" + }, + { + "name": "StandardE9648AsV4", + "value": "Standard_E96_48as_v4" + }, + { + "name": "StandardE9624AsV4", + "value": "Standard_E96_24as_v4" + }, + { + "name": "StandardE42AdsV5", + "value": "Standard_E4_2ads_v5" + }, + { + "name": "StandardE84AdsV5", + "value": "Standard_E8_4ads_v5" + }, + { + "name": "StandardE82AdsV5", + "value": "Standard_E8_2ads_v5" + }, + { + "name": "StandardE168AdsV5", + "value": "Standard_E16_8ads_v5" + }, + { + "name": "StandardE164AdsV5", + "value": "Standard_E16_4ads_v5" + }, + { + "name": "StandardE3216AdsV5", + "value": "Standard_E32_16ads_v5" + }, + { + "name": "StandardE328AdsV5", + "value": "Standard_E32_8ads_v5" + }, + { + "name": "StandardE6432AdsV5", + "value": "Standard_E64_32ads_v5" + }, + { + "name": "StandardE6416AdsV5", + "value": "Standard_E64_16ads_v5" + }, + { + "name": "StandardE9648AdsV5", + "value": "Standard_E96_48ads_v5" + }, + { + "name": "StandardE9624AdsV5", + "value": "Standard_E96_24ads_v5" + }, + { + "name": "StandardE42SV5", + "value": "Standard_E4_2s_v5" + }, + { + "name": "StandardE84SV5", + "value": "Standard_E8_4s_v5" + }, + { + "name": "StandardE82SV5", + "value": "Standard_E8_2s_v5" + }, + { + "name": "StandardE168SV5", + "value": "Standard_E16_8s_v5" + }, + { + "name": "StandardE164SV5", + "value": "Standard_E16_4s_v5" + }, + { + "name": "StandardE3216SV5", + "value": "Standard_E32_16s_v5" + }, + { + "name": "StandardE328SV5", + "value": "Standard_E32_8s_v5" + }, + { + "name": "StandardE6432SV5", + "value": "Standard_E64_32s_v5" + }, + { + "name": "StandardE6416SV5", + "value": "Standard_E64_16s_v5" + }, + { + "name": "StandardE9648SV5", + "value": "Standard_E96_48s_v5" + }, + { + "name": "StandardE9624SV5", + "value": "Standard_E96_24s_v5" + }, + { + "name": "StandardE42DsV5", + "value": "Standard_E4_2ds_v5" + }, + { + "name": "StandardE84DsV5", + "value": "Standard_E8_4ds_v5" + }, + { + "name": "StandardE82DsV5", + "value": "Standard_E8_2ds_v5" + }, + { + "name": "StandardE168DsV5", + "value": "Standard_E16_8ds_v5" + }, + { + "name": "StandardE164DsV5", + "value": "Standard_E16_4ds_v5" + }, + { + "name": "StandardE3216DsV5", + "value": "Standard_E32_16ds_v5" + }, + { + "name": "StandardE328DsV5", + "value": "Standard_E32_8ds_v5" + }, + { + "name": "StandardE6432DsV5", + "value": "Standard_E64_32ds_v5" + }, + { + "name": "StandardE6416DsV5", + "value": "Standard_E64_16ds_v5" + }, + { + "name": "StandardE9648DsV5", + "value": "Standard_E96_48ds_v5" + }, + { + "name": "StandardE9624DsV5", + "value": "Standard_E96_24ds_v5" + }, + { + "name": "StandardE42AsV5", + "value": "Standard_E4_2as_v5" + }, + { + "name": "StandardE84AsV5", + "value": "Standard_E8_4as_v5" + }, + { + "name": "StandardE82AsV5", + "value": "Standard_E8_2as_v5" + }, + { + "name": "StandardE168AsV5", + "value": "Standard_E16_8as_v5" + }, + { + "name": "StandardE164AsV5", + "value": "Standard_E16_4as_v5" + }, + { + "name": "StandardE3216AsV5", + "value": "Standard_E32_16as_v5" + }, + { + "name": "StandardE328AsV5", + "value": "Standard_E32_8as_v5" + }, + { + "name": "StandardE6432AsV5", + "value": "Standard_E64_32as_v5" + }, + { + "name": "StandardE6416AsV5", + "value": "Standard_E64_16as_v5" + }, + { + "name": "StandardE9648AsV5", + "value": "Standard_E96_48as_v5" + }, + { + "name": "StandardE9624AsV5", + "value": "Standard_E96_24as_v5" + }, + { + "name": "StandardGS48", + "value": "Standard_GS4_8" + }, + { + "name": "StandardGS44", + "value": "Standard_GS4_4" + }, + { + "name": "StandardGS516", + "value": "Standard_GS5_16" + }, + { + "name": "StandardGS58", + "value": "Standard_GS5_8" + }, + { + "name": "StandardDS111V2", + "value": "Standard_DS11_1_v2" + }, + { + "name": "StandardDS122V2", + "value": "Standard_DS12_2_v2" + }, + { + "name": "StandardDS121V2", + "value": "Standard_DS12_1_v2" + }, + { + "name": "StandardDS134V2", + "value": "Standard_DS13_4_v2" + }, + { + "name": "StandardDS132V2", + "value": "Standard_DS13_2_v2" + }, + { + "name": "StandardDS148V2", + "value": "Standard_DS14_8_v2" + }, + { + "name": "StandardDS144V2", + "value": "Standard_DS14_4_v2" + }, + { + "name": "StandardM416208SV2", + "value": "Standard_M416_208s_v2" + }, + { + "name": "StandardM416208MsV2", + "value": "Standard_M416_208ms_v2" + }, + { + "name": "StandardE2BsV5", + "value": "Standard_E2bs_v5" + }, + { + "name": "StandardE4BsV5", + "value": "Standard_E4bs_v5" + }, + { + "name": "StandardE8BsV5", + "value": "Standard_E8bs_v5" + }, + { + "name": "StandardE16BsV5", + "value": "Standard_E16bs_v5" + }, + { + "name": "StandardE32BsV5", + "value": "Standard_E32bs_v5" + }, + { + "name": "StandardE48BsV5", + "value": "Standard_E48bs_v5" + }, + { + "name": "StandardE64BsV5", + "value": "Standard_E64bs_v5" + }, + { + "name": "StandardE2BdsV5", + "value": "Standard_E2bds_v5" + }, + { + "name": "StandardE4BdsV5", + "value": "Standard_E4bds_v5" + }, + { + "name": "StandardE8BdsV5", + "value": "Standard_E8bds_v5" + }, + { + "name": "StandardE16BdsV5", + "value": "Standard_E16bds_v5" + }, + { + "name": "StandardE32BdsV5", + "value": "Standard_E32bds_v5" + }, + { + "name": "StandardE48BdsV5", + "value": "Standard_E48bds_v5" + }, + { + "name": "StandardE64BdsV5", + "value": "Standard_E64bds_v5" + } + ] + } + }, + "AzureVmSuitabilityDetail": { + "type": "string", + "enum": [ + "None", + "RecommendedSizeHasLessNetworkAdapters", + "CannotReportComputeCost", + "CannotReportStorageCost", + "CannotReportBandwidthCosts", + "PercentageOfCoresUtilizedMissing", + "PercentageOfMemoryUtilizedMissing", + "PercentageOfCoresUtilizedOutOfRange", + "PercentageOfMemoryUtilizedOutOfRange" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityDetail", + "modelAsString": true + } + }, + "AzureVmSuitabilityExplanation": { + "type": "string", + "enum": [ + "Unknown", + "NotApplicable", + "GuestOperatingSystemArchitectureNotSupported", + "GuestOperatingSystemNotSupported", + "BootTypeNotSupported", + "MoreDisksThanSupported", + "NoSuitableVmSizeFound", + "OneOrMoreDisksNotSuitable", + "OneOrMoreAdaptersNotSuitable", + "InternalErrorOccurredDuringComputeEvaluation", + "InternalErrorOccurredDuringStorageEvaluation", + "InternalErrorOccurredDuringNetworkEvaluation", + "NoVmSizeSupportsStoragePerformance", + "NoVmSizeSupportsNetworkPerformance", + "NoVmSizeForSelectedPricingTier", + "NoVmSizeForSelectedAzureLocation", + "CheckRedHatLinuxVersion", + "CheckOpenSuseLinuxVersion", + "CheckWindowsServer2008R2Version", + "CheckCentOsVersion", + "CheckDebianLinuxVersion", + "CheckSuseLinuxVersion", + "CheckOracleLinuxVersion", + "CheckUbuntuLinuxVersion", + "CheckCoreOsLinuxVersion", + "WindowsServerVersionConditionallySupported", + "NoGuestOperatingSystemConditionallySupported", + "WindowsClientVersionsConditionallySupported", + "BootTypeUnknown", + "GuestOperatingSystemUnknown", + "WindowsServerVersionsSupportedWithCaveat", + "WindowsOSNoLongerUnderMSSupport", + "EndorsedWithConditionsLinuxDistributions", + "UnendorsedLinuxDistributions", + "NoVmSizeForStandardPricingTier", + "NoVmSizeForBasicPricingTier", + "NoVmSizeInSelectedFamilyFound", + "NoEaPriceFoundForVmSize", + "NoVmSizeFoundForOfferCurrencyReservedInstance" + ], + "x-ms-enum": { + "name": "AzureVmSuitabilityExplanation", + "modelAsString": true + } + }, + "AzureWebAppSuitabilityIssueCategory": { + "type": "string", + "enum": [ + "Unknown", + "Issue", + "Info" + ], + "x-ms-enum": { + "name": "AzureWebAppSuitabilityIssueCategory", + "modelAsString": true + } + }, + "AzureWebAppTargetType": { + "type": "string", + "enum": [ + "Unknown", + "AzureAppService", + "AzureAppServiceContainer" + ], + "x-ms-enum": { + "name": "AzureWebAppTargetType", + "modelAsString": true + } + }, + "AzureWebAppTier": { + "type": "string", + "enum": [ + "Unknown", + "Free", + "Premium_V2", + "Premium_V3", + "Isolated" + ], + "x-ms-enum": { + "name": "AzureWebAppTier", + "modelAsString": true + } + }, + "BusinessCase": { + "type": "object", + "description": "Business case resource.", + "properties": { + "properties": { + "$ref": "#/definitions/BusinessCaseProperties", + "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/ProxyResource" + } + ] + }, + "BusinessCaseCurrency": { + "type": "string", + "description": "Business case supported currency types.", + "enum": [ + "Unknown", + "USD", + "DKK", + "CAD", + "IDR", + "JPY", + "KRW", + "NZD", + "NOK", + "RUB", + "SAR", + "ZAR", + "SEK", + "TRY", + "GBP", + "MXN", + "MYR", + "INR", + "HKD", + "BRL", + "TWD", + "EUR", + "CHF", + "ARS", + "AUD", + "CNY" + ], + "x-ms-enum": { + "name": "BusinessCaseCurrency", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Currency Unknown." + }, + { + "name": "USD", + "value": "USD", + "description": "Currency USD." + }, + { + "name": "DKK", + "value": "DKK", + "description": "Currency DKK." + }, + { + "name": "CAD", + "value": "CAD", + "description": "Currency CAD." + }, + { + "name": "IDR", + "value": "IDR", + "description": "Currency IDR." + }, + { + "name": "JPY", + "value": "JPY", + "description": "Currency JPY." + }, + { + "name": "KRW", + "value": "KRW", + "description": "Currency KRW." + }, + { + "name": "NZD", + "value": "NZD", + "description": "Currency NZD." + }, + { + "name": "NOK", + "value": "NOK", + "description": "Currency NOK." + }, + { + "name": "RUB", + "value": "RUB", + "description": "Currency RUB." + }, + { + "name": "SAR", + "value": "SAR", + "description": "Currency SAR." + }, + { + "name": "ZAR", + "value": "ZAR", + "description": "Currency ZAR." + }, + { + "name": "SEK", + "value": "SEK", + "description": "Currency SEK." + }, + { + "name": "TRY", + "value": "TRY", + "description": "Currency TRY." + }, + { + "name": "GBP", + "value": "GBP", + "description": "Currency GBP." + }, + { + "name": "MXN", + "value": "MXN", + "description": "Currency MXN." + }, + { + "name": "MYR", + "value": "MYR", + "description": "Currency MYR." + }, + { + "name": "INR", + "value": "INR", + "description": "Currency INR." + }, + { + "name": "HKD", + "value": "HKD", + "description": "Currency HKD." + }, + { + "name": "BRL", + "value": "BRL", + "description": "Currency BRL." + }, + { + "name": "TWD", + "value": "TWD", + "description": "Currency TWD." + }, + { + "name": "EUR", + "value": "EUR", + "description": "Currency EUR." + }, + { + "name": "CHF", + "value": "CHF", + "description": "Currency CHF." + }, + { + "name": "ARS", + "value": "ARS", + "description": "Currency ARS." + }, + { + "name": "AUD", + "value": "AUD", + "description": "Currency AUD." + }, + { + "name": "CNY", + "value": "CNY", + "description": "Currency CNY." + } + ] + } + }, + "BusinessCaseListResult": { + "type": "object", + "description": "The response of a BusinessCase list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BusinessCase items on this page", + "items": { + "$ref": "#/definitions/BusinessCase" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BusinessCaseProperties": { + "type": "object", + "description": "Property bag for an\nMicrosoft.Azure.Migrate.BusinessCaseService.Api.V20220202_preview.Resources.BusinessCase\nresource.", + "properties": { + "settings": { + "$ref": "#/definitions/Settings", + "description": "Business case settings." + }, + "state": { + "$ref": "#/definitions/BusinessCaseState", + "description": "Business case state.", + "readOnly": true + }, + "reportStatusDetails": { + "type": "array", + "description": "Gets the state of business case reports.", + "items": { + "$ref": "#/definitions/ReportDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "BusinessCaseState": { + "type": "string", + "description": "Business case supported state types.", + "enum": [ + "Unknown", + "InProgress", + "Completed", + "OutDated", + "Invalid", + "OutOfSync", + "Failed" + ], + "x-ms-enum": { + "name": "BusinessCaseState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown State." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress State." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed State." + }, + { + "name": "OutDated", + "value": "OutDated", + "description": "OutDated State." + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Invalid State." + }, + { + "name": "OutOfSync", + "value": "OutOfSync", + "description": "OutOfSync State." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed State." + } + ] + } + }, + "Check": { + "type": "object", + "description": "Data model of Check or Rule for Suitability Analysis.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "behavior": { + "$ref": "#/definitions/CheckResult", + "description": "Gets behavior or check result.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Gets description.", + "readOnly": true + }, + "cause": { + "type": "string", + "description": "Gets cause.", + "readOnly": true + }, + "recommendation": { + "type": "string", + "description": "Gets recommendation.", + "readOnly": true + }, + "moreInfo": { + "$ref": "#/definitions/MoreInfo", + "description": "Gets more information about check or rule.", + "readOnly": true + } + }, + "required": [ + "name", + "behavior", + "description", + "cause", + "recommendation", + "moreInfo" + ] + }, + "CheckResult": { + "type": "string", + "description": "Suitability Check or Rule Result.", + "enum": [ + "Unknown", + "Issue", + "Warn", + "Pass" + ], + "x-ms-enum": { + "name": "CheckResult", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates missing value." + }, + { + "name": "Issue", + "value": "Issue", + "description": "Indicates Migration Issue." + }, + { + "name": "Warn", + "value": "Warn", + "description": "Indicates Migration Warning." + }, + { + "name": "Pass", + "value": "Pass", + "description": "Indicates check is passed." + } + ] + } + }, + "CloudSuitability": { + "type": "string", + "description": "Cloud Suitability for Azure.", + "enum": [ + "Unknown", + "NotSuitable", + "Suitable", + "ConditionallySuitable", + "ReadinessUnknown" + ], + "x-ms-enum": { + "name": "CloudSuitability", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + }, + { + "name": "ConditionallySuitable", + "value": "ConditionallySuitable", + "description": "Conditionally Suitable for Azure." + }, + { + "name": "ReadinessUnknown", + "value": "ReadinessUnknown", + "description": "Unknown Readiness for Azure." + } + ] + } + }, + "Cluster": { + "type": "object", + "description": "Data model of Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "nodePools": { + "type": "array", + "description": "Gets list of node pools.", + "items": { + "$ref": "#/definitions/NodePool" + }, + "readOnly": true + }, + "region": { + "type": "string", + "description": "Gets region.", + "readOnly": true + }, + "userNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node pool count.", + "readOnly": true + }, + "userNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets user node count.", + "readOnly": true + }, + "systemNodePoolCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node pool count.", + "readOnly": true + }, + "systemNodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets system node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "name", + "nodePools", + "region", + "userNodePoolCount", + "userNodeCount", + "systemNodePoolCount", + "systemNodeCount", + "podCount", + "monthlyCost" + ] + }, + "CollectorAgentPropertiesBase": { + "type": "object", + "description": "Collector agent property class.", + "properties": { + "id": { + "type": "string", + "description": "Gets the collector agent id." + }, + "version": { + "type": "string", + "description": "Gets the collector agent version." + }, + "lastHeartbeatUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the collector last heartbeat time." + }, + "spnDetails": { + "$ref": "#/definitions/CollectorAgentSpnPropertiesBase", + "description": "Gets or sets the SPN details." + } + } + }, + "CollectorAgentSpnPropertiesBase": { + "type": "object", + "description": "Collector agent SPN details class.", + "properties": { + "authority": { + "type": "string", + "description": "Gets the AAD authority endpoint." + }, + "applicationId": { + "type": "string", + "description": "Gets the AAD application id." + }, + "audience": { + "type": "string", + "description": "Gets the AAD audience url." + }, + "objectId": { + "type": "string", + "description": "Gets the object id of the AAD application." + }, + "tenantId": { + "type": "string", + "description": "Gets the tenant id of the AAD application." + } + } + }, + "CollectorPropertiesBase": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "CompareSummary": { + "type": "object", + "description": "Compare summary class.", + "properties": { + "azurePaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure PaaS cost.", + "readOnly": true + }, + "azureIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The azure IaaS cost.", + "readOnly": true + }, + "azureAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The AVS cost.", + "readOnly": true + }, + "onPremisesPaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS cost.", + "readOnly": true + }, + "onPremisesAvsCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS cost.", + "readOnly": true + }, + "onPremisesPaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesIaasDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises IaaS decommissioned cost.", + "readOnly": true + }, + "onPremisesAvsDecommissionedCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises AVS decommissioned cost.", + "readOnly": true + } + } + }, + "CompatibilityLevel": { + "type": "string", + "enum": [ + "Unknown", + "CompatLevel80", + "CompatLevel90", + "CompatLevel100", + "CompatLevel110", + "CompatLevel120", + "CompatLevel130", + "CompatLevel140", + "CompatLevel150" + ], + "x-ms-enum": { + "name": "CompatibilityLevel", + "modelAsString": true + } + }, + "ComputeResource": { + "type": "object", + "description": "Data model of Cores and Memory Compute Resource.", + "properties": { + "cores": { + "type": "number", + "format": "float", + "description": "Gets cores.", + "readOnly": true + }, + "memory": { + "type": "number", + "format": "float", + "description": "Gets memory.", + "readOnly": true + } + }, + "required": [ + "cores", + "memory" + ] + }, + "ComputeSettings": { + "type": "object", + "description": "Compute settings.", + "properties": { + "hyperthreadCoreToMemoryRatio": { + "type": "number", + "format": "float", + "description": "Hyperthread core to memory ratio." + }, + "price": { + "type": "number", + "format": "float", + "description": "Compute Price." + }, + "sqlServerLicensing": { + "type": "array", + "description": "SQL Server licensing settings.", + "items": { + "$ref": "#/definitions/SqlServerLicensingSettings" + }, + "x-ms-identifiers": [] + }, + "windowsServerLicensing": { + "$ref": "#/definitions/WindowsServerLicensingSettings", + "description": "Windows Server licensing settings." + }, + "rhelLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Rhel Server licensing settings." + }, + "suseLinuxServerLicensing": { + "$ref": "#/definitions/LinuxServerLicensingSettings", + "description": "Linux Suse Server licensing settings." + }, + "virtualizationSoftwareSettings": { + "$ref": "#/definitions/VirtualizationSoftwareSettings", + "description": "Virtualization software settings." + } + }, + "required": [ + "hyperthreadCoreToMemoryRatio", + "price", + "sqlServerLicensing", + "windowsServerLicensing", + "rhelLinuxServerLicensing", + "suseLinuxServerLicensing", + "virtualizationSoftwareSettings" + ] + }, + "ComputeTier": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Provisioned", + "Serverless" + ], + "x-ms-enum": { + "name": "ComputeTier", + "modelAsString": true + } + }, + "ConsolidationType": { + "type": "string", + "description": "Consolidation Type.", + "enum": [ + "Full", + "AsOnSource" + ], + "x-ms-enum": { + "name": "ConsolidationType", + "modelAsString": true, + "values": [ + { + "name": "Full", + "value": "Full", + "description": "Full Consolidation." + }, + { + "name": "AsOnSource", + "value": "AsOnSource", + "description": "As On Source or On Premises Consolidation." + } + ] + } + }, + "CostByStorageType": { + "type": "object", + "description": "The cost by storage type.", + "properties": { + "storageType": { + "type": "string", + "description": "The storage type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost per storage type.", + "readOnly": true + } + } + }, + "CostComponent": { + "type": "object", + "description": "Class to represent the component of the cost.", + "properties": { + "name": { + "$ref": "#/definitions/CostComponentName", + "description": "Gets the name of the component.", + "readOnly": true + }, + "value": { + "type": "number", + "format": "float", + "description": "The value of the component." + }, + "description": { + "type": "string", + "description": "The textual description of the component." + } + } + }, + "CostComponentName": { + "type": "string", + "description": "Enum to represent component name.", + "enum": [ + "Unknown", + "MonthlyAzureHybridCostSavings", + "MonthlySecurityCost", + "MonthlyPremiumV2StorageCost", + "MonthlyLinuxAzureHybridCostSavings", + "MonthlyAvsNodeCost", + "MonthlyAvsExternalStorageCost", + "MonthlyAvsNetworkCost", + "MonthlyVcfByolCostDifference" + ], + "x-ms-enum": { + "name": "CostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Default Cost Component name represented by Unknown." + }, + { + "name": "MonthlyAzureHybridCostSavings", + "value": "MonthlyAzureHybridCostSavings", + "description": "Cost Savings due to Windows Azure Hybrid on monthly basis." + }, + { + "name": "MonthlySecurityCost", + "value": "MonthlySecurityCost", + "description": "Monthly security cost." + }, + { + "name": "MonthlyPremiumV2StorageCost", + "value": "MonthlyPremiumV2StorageCost", + "description": "Monthly PremiumV2 Storage Cost." + }, + { + "name": "MonthlyLinuxAzureHybridCostSavings", + "value": "MonthlyLinuxAzureHybridCostSavings", + "description": "Cost Savings due to Linux Azure Hybrid on monthly basis." + }, + { + "name": "MonthlyAvsNodeCost", + "value": "MonthlyAvsNodeCost", + "description": "Monthly AVS Node cost" + }, + { + "name": "MonthlyAvsExternalStorageCost", + "value": "MonthlyAvsExternalStorageCost", + "description": "Monthly AVS External Storage cost" + }, + { + "name": "MonthlyAvsNetworkCost", + "value": "MonthlyAvsNetworkCost", + "description": "Monthly AVS Network cost" + }, + { + "name": "MonthlyVcfByolCostDifference", + "value": "MonthlyVcfByolCostDifference", + "description": "Monthly compute cost difference between VCF BYOL and non VCF BYOL SKUs" + } + ] + } + }, + "CostDetails": { + "type": "object", + "description": "The on premises PaaS cost.", + "properties": { + "storageCost": { + "type": "number", + "format": "float", + "description": "The storage cost.", + "readOnly": true + }, + "computeCost": { + "type": "number", + "format": "float", + "description": "The compute cost.", + "readOnly": true + }, + "itLaborCost": { + "type": "number", + "format": "float", + "description": "The IT labor cost.", + "readOnly": true + }, + "networkCost": { + "type": "number", + "format": "float", + "description": "The network cost.", + "readOnly": true + }, + "ahubSavings": { + "type": "number", + "format": "float", + "description": "The windows AhubSavings.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux AhubSavings.", + "readOnly": true + }, + "securityCost": { + "type": "number", + "format": "float", + "description": "Security Cost.", + "readOnly": true + }, + "managementCostDetails": { + "$ref": "#/definitions/ManagementCostDetails", + "description": "Management Cost Details.", + "readOnly": true + }, + "esuSavings": { + "type": "number", + "format": "float", + "description": "esu savings.", + "readOnly": true + } + } + }, + "DiscoveredEntitiesSummary": { + "type": "object", + "description": "Discovered entities summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Number of web servers", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Number of web apps", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines", + "readOnly": true + }, + "webServerSummary": { + "type": "object", + "description": "Web server summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "webAppSummary": { + "type": "object", + "description": "Web app summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "DiscoveredEntityLightSummary": { + "type": "object", + "description": "Discovered entity light summary.", + "properties": { + "numberOfServers": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of servers." + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of web apps." + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of machines." + } + }, + "required": [ + "numberOfServers", + "numberOfWebApps", + "numberOfMachines" + ] + }, + "DiscoverySource": { + "type": "string", + "description": "Business case supported Discovery source types.", + "enum": [ + "Unknown", + "Appliance", + "Import" + ], + "x-ms-enum": { + "name": "DiscoverySource", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Discovery Source." + }, + { + "name": "Appliance", + "value": "Appliance", + "description": "Appliance Discovery Source." + }, + { + "name": "Import", + "value": "Import", + "description": "Import Discovery Source." + } + ] + } + }, + "Disk": { + "type": "object", + "description": "A disk discovered on a machine.", + "properties": { + "gigabytesAllocated": { + "type": "number", + "format": "float", + "description": "Gigabytes of storage provisioned for this disk.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the disk.", + "readOnly": true + } + } + }, + "DistributionByOperatingSystem": { + "type": "object", + "description": "The distribution by operating system.", + "properties": { + "osClassificationType": { + "type": "string", + "description": "The Os classification type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the OS type classification.", + "readOnly": true + } + } + }, + "DistributionByType": { + "type": "object", + "description": "Distribution by Type.", + "properties": { + "type": { + "type": "string", + "description": "Distribution Type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Distribution Count.", + "readOnly": true + } + } + }, + "DistributionByVirtualization": { + "type": "object", + "description": "The distribution by virtualization.", + "properties": { + "virtualizationType": { + "type": "string", + "description": "The Virtualization type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of machines with the Virtualization type classification.", + "readOnly": true + } + } + }, + "DownloadUrl": { + "type": "object", + "description": "Data model of Download URL for assessment report.", + "properties": { + "assessmentReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + }, + "required": [ + "assessmentReportUrl", + "expirationTime" + ] + }, + "EntityUptime": { + "type": "object", + "description": "Entity Uptime.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Gets the days per month." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Gets the hours per day." + } + } + }, + "EnvironmentType": { + "type": "string", + "enum": [ + "Production", + "Test" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + } + }, + "Error": { + "type": "object", + "description": "Error web model class.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "Gets the error ID.", + "readOnly": true + }, + "code": { + "type": "string", + "description": "Gets the error code.", + "readOnly": true + }, + "runAsAccountId": { + "type": "string", + "description": "Gets the Run as account ID.", + "readOnly": true + }, + "applianceName": { + "type": "string", + "description": "Gets the Appliance name.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Gets the error message.", + "readOnly": true + }, + "summaryMessage": { + "type": "string", + "description": "Gets the error summary message.", + "readOnly": true + }, + "agentScenario": { + "type": "string", + "description": "Gets the agent scenario where this error occurred.", + "readOnly": true + }, + "possibleCauses": { + "type": "string", + "description": "Gets the error possible causes.", + "readOnly": true + }, + "recommendedAction": { + "type": "string", + "description": "Gets the recommended action for the error.", + "readOnly": true + }, + "severity": { + "type": "string", + "description": "Gets the error severity.", + "readOnly": true + }, + "messageParameters": { + "type": "object", + "description": "Gets the error message parameters.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Gets the time stamp when the error was updated.", + "readOnly": true + }, + "impactedAssessmentType": { + "type": "string", + "description": "Gets the type of assessment impacted by this error.", + "readOnly": true + } + } + }, + "ErrorSummary": { + "type": "object", + "description": "Error summary containing affected entities for each type of assessment.", + "properties": { + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Gets the assessment type.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Gets the affected entity count.", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error Details", + "properties": { + "code": { + "type": "string", + "description": "Error Code", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Description of the error occurred", + "readOnly": true + } + }, + "required": [ + "code", + "message" + ] + }, + "EstimatedCostByOffer": { + "type": "object", + "description": "The estimated cost by offer.", + "properties": { + "offerName": { + "type": "string", + "description": "The offer name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Cost for the offer.", + "readOnly": true + } + } + }, + "EstimatedCostByTarget": { + "type": "object", + "description": "Shows the estimated cost by target.", + "properties": { + "azureSqlMiCost": { + "type": "number", + "format": "float", + "description": "Azure SQL MI cost.", + "readOnly": true + }, + "azureSqlDbCost": { + "type": "number", + "format": "float", + "description": "Azure SQL DB cost.", + "readOnly": true + }, + "appServiceCost": { + "type": "number", + "format": "float", + "description": "Azure App Service cost.", + "readOnly": true + }, + "appServiceContainerCost": { + "type": "number", + "format": "float", + "description": "Azure App Service Containers cost.", + "readOnly": true + }, + "azureKubernetesServiceCost": { + "type": "number", + "format": "float", + "description": "Azure Kubernetes Service cost.", + "readOnly": true + } + } + }, + "EstimatedExternalStorage": { + "type": "object", + "description": "Estimated external storage", + "properties": { + "storageType": { + "$ref": "#/definitions/ExternalStorageType", + "description": "External storage type", + "readOnly": true + }, + "totalStorageInGB": { + "type": "number", + "format": "float", + "description": "Total storage allocation in GB", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "Percent storage utilization", + "readOnly": true + }, + "totalStorageCost": { + "type": "number", + "format": "float", + "description": "Total storage cost", + "readOnly": true + } + } + }, + "EstimatedNetwork": { + "type": "object", + "description": "Estimated network", + "properties": { + "skuType": { + "$ref": "#/definitions/NetworkSkuType", + "description": "Network SKU type.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "Network Sku type cost.", + "readOnly": true + } + } + }, + "EvaluatedAvsMachine": { + "type": "object", + "description": "Evaluated AVS machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedAvsMachineProperties", + "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/ProxyResource" + } + ] + }, + "EvaluatedAvsMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedAvsMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedAvsMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedAvsMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedAvsMachineProperties": { + "type": "object", + "description": "Evaluated AVS machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedMachine": { + "type": "object", + "description": "Evaluated machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedMachineProperties", + "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/ProxyResource" + } + ] + }, + "EvaluatedMachineListResult": { + "type": "object", + "description": "The response of a EvaluatedMachine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedMachine items on this page", + "items": { + "$ref": "#/definitions/EvaluatedMachine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedMachineProperties": { + "type": "object", + "description": "Evaluated machine properties class.", + "properties": { + "machineId": { + "type": "string", + "description": "Machine Id.", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Server Name.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "Virtualization type.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating System (OS) name.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedSqlEntity": { + "type": "object", + "description": "Evaluated sql entity resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedSqlEntityProperties", + "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/ProxyResource" + } + ] + }, + "EvaluatedSqlEntityListResult": { + "type": "object", + "description": "The response of a EvaluatedSqlEntity list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedSqlEntity items on this page", + "items": { + "$ref": "#/definitions/EvaluatedSqlEntity" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedSqlEntityProperties": { + "type": "object", + "description": "Evaluated sql entity properties class.", + "properties": { + "serverName": { + "type": "string", + "description": "Server name.", + "readOnly": true + }, + "activityState": { + "type": "string", + "description": "Activity state.", + "readOnly": true + }, + "sqlVersion": { + "type": "string", + "description": "SQL Server version.", + "readOnly": true + }, + "sqlEdition": { + "type": "string", + "description": "SQL Server edition.", + "readOnly": true + }, + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target.", + "readOnly": true + }, + "qualifyingOffer": { + "type": "string", + "description": "Qualifying offer.", + "readOnly": true + }, + "readyForMigration": { + "type": "string", + "description": "Is SQL Instance ready for migration.", + "readOnly": true + }, + "virtualizationType": { + "type": "string", + "description": "The virtualization type.", + "readOnly": true + }, + "dbCount": { + "type": "integer", + "format": "int32", + "description": "DB count in instance.", + "readOnly": true + }, + "supportStatus": { + "$ref": "#/definitions/SupportabilityStatus", + "description": "End of Support status.", + "readOnly": true + } + } + }, + "EvaluatedWebApp": { + "type": "object", + "description": "Evaluated web app resource.", + "properties": { + "properties": { + "$ref": "#/definitions/EvaluatedWebAppProperties", + "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/ProxyResource" + } + ] + }, + "EvaluatedWebAppListResult": { + "type": "object", + "description": "The response of a EvaluatedWebApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EvaluatedWebApp items on this page", + "items": { + "$ref": "#/definitions/EvaluatedWebApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EvaluatedWebAppProperties": { + "type": "object", + "description": "Evaluated web app properties class.", + "properties": { + "recommendedAzureTarget": { + "type": "string", + "description": "Recommended Azure target." + }, + "recommendedAzureSkuName": { + "type": "string", + "description": "Recommended Azure SKU name." + }, + "recommendedAzureSkuSize": { + "type": "string", + "description": "Recommended Azure SKU size." + }, + "serverName": { + "type": "string", + "description": "The server name." + }, + "workload": { + "type": "string", + "description": "The workload." + }, + "activityState": { + "type": "string", + "description": "The activity state." + }, + "readyForMigration": { + "type": "string", + "description": "Is machine ready for migration." + } + } + }, + "ExternalStorageType": { + "type": "string", + "description": "Different External storage skus.", + "enum": [ + "Unknown", + "None", + "AnfStandard", + "AnfPremium", + "AnfUltra" + ], + "x-ms-enum": { + "name": "ExternalStorageType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported external storage." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No external storage." + }, + { + "name": "AnfStandard", + "value": "AnfStandard", + "description": "ANF external storage with Standard SKU." + }, + { + "name": "AnfPremium", + "value": "AnfPremium", + "description": "ANF external storage with Premium SKU." + }, + { + "name": "AnfUltra", + "value": "AnfUltra", + "description": "ANF external storage with Ultra SKU." + } + ] + } + }, + "AvsAssessmentScenario": { + "type": "string", + "description": "Scenarios with which Avs Assessments can be created.", + "enum": [ + "Unknown", + "NewAvsSddc", + "AvsSddcExpansion" + ], + "x-ms-enum": { + "name": "AvsAssessmentScenario", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown assessment scenario" + }, + { + "name": "NewAvsSddc", + "value": "NewAvsSddc", + "description": "Create Assessment for new Avs Sddc" + }, + { + "name": "AvsSddcExpansion", + "value": "AvsSddcExpansion", + "description": "Create Assessment for existing Avs Sddc" + } + ] + } + }, + "FacilitySettings": { + "type": "object", + "description": "Facility settings.", + "properties": { + "facilitiesCost": { + "type": "number", + "format": "float", + "description": "The facilities cost." + } + }, + "required": [ + "facilitiesCost" + ] + }, + "FttAndRaidLevel": { + "type": "string", + "description": "FTT and RAID Level.", + "enum": [ + "Unknown", + "Ftt1Raid1", + "Ftt1Raid5", + "Ftt2Raid1", + "Ftt2Raid6", + "Ftt3Raid1" + ], + "x-ms-enum": { + "name": "FttAndRaidLevel", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown FTT and RAID Level." + }, + { + "name": "Ftt1Raid1", + "value": "Ftt1Raid1", + "description": "FTT 1 and RAID Level 1." + }, + { + "name": "Ftt1Raid5", + "value": "Ftt1Raid5", + "description": "FTT 1 and RAID Level 5." + }, + { + "name": "Ftt2Raid1", + "value": "Ftt2Raid1", + "description": "FTT 2 and RAID Level 1." + }, + { + "name": "Ftt2Raid6", + "value": "Ftt2Raid6", + "description": "FTT 2 and RAID Level 6." + }, + { + "name": "Ftt3Raid1", + "value": "Ftt3Raid1", + "description": "FTT 3 and RAID Level 1." + } + ] + } + }, + "Group": { + "type": "object", + "description": "Group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/GroupProperties", + "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/ProxyResource" + } + ] + }, + "GroupBodyProperties": { + "type": "object", + "description": "Body properties of group update.", + "properties": { + "operationType": { + "$ref": "#/definitions/GroupUpdateOperation", + "description": "Whether to add or remove the machines." + }, + "machines": { + "type": "array", + "description": "List of machine names that are part of this group.", + "items": { + "type": "string" + } + } + } + }, + "GroupListResult": { + "type": "object", + "description": "The response of a Group list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Group items on this page", + "items": { + "$ref": "#/definitions/Group" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GroupProperties": { + "type": "object", + "description": "Properties of group resource.", + "properties": { + "groupStatus": { + "$ref": "#/definitions/GroupStatus", + "description": "Whether the group has been created and is valid.", + "readOnly": true + }, + "machineCount": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of this group.", + "readOnly": true + }, + "assessments": { + "type": "array", + "description": "List of References to Assessments created on this group.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedAssessmentTypes": { + "type": "array", + "description": "List of assessment types supported on this group.", + "items": { + "$ref": "#/definitions/AssessmentType" + } + }, + "areAssessmentsRunning": { + "type": "boolean", + "description": "If the assessments are in running state.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this group was last updated. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "The type of group.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "GroupStatus": { + "type": "string", + "enum": [ + "Created", + "Updated", + "Running", + "Completed", + "Invalid" + ], + "x-ms-enum": { + "name": "GroupStatus", + "modelAsString": true + } + }, + "GroupType": { + "type": "string", + "enum": [ + "Default", + "Import" + ], + "x-ms-enum": { + "name": "GroupType", + "modelAsString": true + } + }, + "GroupUpdateOperation": { + "type": "string", + "enum": [ + "Add", + "Remove" + ], + "x-ms-enum": { + "name": "GroupUpdateOperation", + "modelAsString": true + } + }, + "GuestOperatingSystemArchitecture": { + "type": "string", + "enum": [ + "Unknown", + "X86", + "X64" + ], + "x-ms-enum": { + "name": "GuestOperatingSystemArchitecture", + "modelAsString": true + } + }, + "HardwareGeneration": { + "type": "string", + "enum": [ + "Unknown", + "Automatic", + "Gen5", + "Fsv2_series", + "M_series", + "DC_series" + ], + "x-ms-enum": { + "name": "HardwareGeneration", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "Automatic", + "value": "Automatic" + }, + { + "name": "Gen5", + "value": "Gen5" + }, + { + "name": "Fsv2Series", + "value": "Fsv2_series" + }, + { + "name": "MSeries", + "value": "M_series" + }, + { + "name": "DCSeries", + "value": "DC_series" + } + ] + } + }, + "HyperVLicenseType": { + "type": "string", + "description": "Business case supported HyperV License types.", + "enum": [ + "Unknown", + "Datacentre", + "Standard" + ], + "x-ms-enum": { + "name": "HyperVLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown HyperV License." + }, + { + "name": "Datacentre", + "value": "Datacentre", + "description": "Datacentre HyperV License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard HyperV License." + } + ] + } + }, + "HypervCollector": { + "type": "object", + "description": "Hyper-V collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "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/ProxyResource" + } + ] + }, + "HypervCollectorListResult": { + "type": "object", + "description": "The response of a HypervCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HypervCollector items on this page", + "items": { + "$ref": "#/definitions/HypervCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HypervLicense": { + "type": "object", + "description": "Representation of a licence.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "licenseType": { + "$ref": "#/definitions/HyperVLicenseType", + "description": "HyperV licence type." + } + }, + "required": [ + "licenseCost", + "licenseType" + ] + }, + "HypervVirtualizationManagementSettings": { + "type": "object", + "description": "HyperV Virtualization Management Settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance Cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/HypervLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "IaasOsDistribution": { + "type": "object", + "description": "Shows the infrastructure as a service machine OS distribution.", + "properties": { + "windows": { + "type": "integer", + "format": "int32", + "description": "Number of Windows servers.", + "readOnly": true + }, + "linux": { + "type": "integer", + "format": "int32", + "description": "Number of Linux servers.", + "readOnly": true + }, + "other": { + "type": "integer", + "format": "int32", + "description": "Number of servers neither Windows or Linux.", + "readOnly": true + } + } + }, + "IaasOsLicensingDetails": { + "type": "object", + "description": "The Iaas OS licensing details.", + "properties": { + "osType": { + "type": "string", + "description": "The OS type.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionCost": { + "type": "number", + "format": "float", + "description": "The decommission cost.", + "readOnly": true + } + } + }, + "IaasSummary": { + "type": "object", + "description": "Iaas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/IaasSummaryProperties", + "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/ProxyResource" + } + ] + }, + "IaasSummaryListResult": { + "type": "object", + "description": "The response of a IaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IaasSummary items on this page", + "items": { + "$ref": "#/definitions/IaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IaasSummaryProperties": { + "type": "object", + "description": "Iaas summary properties class.", + "properties": { + "azureIaasSummary": { + "$ref": "#/definitions/AzureIaasSummary", + "description": "The Azure IaaS summary.", + "readOnly": true + }, + "onPremisesIaasSummary": { + "$ref": "#/definitions/OnPremisesIaasSummary", + "description": "The on premises IaaS summary.", + "readOnly": true + } + } + }, + "ImpactedAssessmentObject": { + "type": "object", + "description": "Class representing the impacted objects.", + "properties": { + "objectName": { + "type": "string", + "description": "Gets the object name.", + "readOnly": true + }, + "objectType": { + "type": "string", + "description": "Gets the object type.", + "readOnly": true + } + } + }, + "ImportCollector": { + "type": "object", + "description": "Import collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBase", + "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/ProxyResource" + } + ] + }, + "ImportCollectorListResult": { + "type": "object", + "description": "The response of a ImportCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImportCollector items on this page", + "items": { + "$ref": "#/definitions/ImportCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LaborSettings": { + "type": "object", + "description": "Labour settings.", + "properties": { + "physicalServersPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Physical servers per administrator.", + "minimum": 1 + }, + "virtualMachinesPerAdmin": { + "type": "integer", + "format": "int32", + "description": "Virtual machines per administrator.", + "minimum": 1 + }, + "hourlyAdminCost": { + "type": "number", + "format": "float", + "description": "Hourly administrator cost." + } + }, + "required": [ + "physicalServersPerAdmin", + "virtualMachinesPerAdmin", + "hourlyAdminCost" + ] + }, + "LicenseType": { + "type": "string", + "description": "Business case supported VmWare License types.", + "enum": [ + "Unknown", + "VSphereStandard", + "VSphereEnterprisePlus" + ], + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereStandard", + "value": "VSphereStandard", + "description": "VSphereStandard License." + }, + { + "name": "VSphereEnterprisePlus", + "value": "VSphereEnterprisePlus", + "description": "VSphereEnterprisePlus License." + } + ] + } + }, + "LicensingProgram": { + "type": "string", + "description": "Licensing Program for Azure.", + "enum": [ + "Default", + "EA" + ], + "x-ms-enum": { + "name": "LicensingProgram", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default value. Indicates Pay As You Go." + }, + { + "name": "EA", + "value": "EA", + "description": "Enterprise Agreement." + } + ] + } + }, + "Machine": { + "type": "object", + "description": "Machine resource.", + "properties": { + "properties": { + "$ref": "#/definitions/MachineProperties", + "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/ProxyResource" + } + ] + }, + "MachineAssessmentProperties": { + "type": "object", + "description": "Properties of an assessment.", + "properties": { + "assessmentErrorSummary": { + "type": "object", + "description": "Gets or sets the assessment error summary.\n This is the number of\nmachines affected by each type of error in this assessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyUltraStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate ultra storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets enterprise agreement subscription id." + }, + "azurePricingTier": { + "$ref": "#/definitions/AzurePricingTier", + "description": "Gets or sets Azure Pricing Tier - Free, Basic, etc." + }, + "azureStorageRedundancy": { + "$ref": "#/definitions/AzureStorageRedundancy", + "description": "Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets the Azure Reserved Instance - 1-Year, 3-Year." + }, + "azureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the azure hybrid use\nbenefit." + }, + "linuxAzureHybridUseBenefit": { + "$ref": "#/definitions/AzureHybridUseBenefit", + "description": "Gets or sets the user configurable setting to display the linux azure hybrid use\nbenefit." + }, + "azureDiskTypes": { + "type": "array", + "description": "Gets or sets the azure storage type. Premium, Standard etc.", + "items": { + "$ref": "#/definitions/AzureDiskType" + } + }, + "azureVmFamilies": { + "type": "array", + "description": "Gets or sets the Azure VM families.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + } + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByOsName": { + "type": "object", + "description": "Gets the distribution by os name.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Compute Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyBandwidthCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Bandwidth Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate Storage Cost for all machines in the assessment.", + "readOnly": true + }, + "monthlyPremiumStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate premium storage cost for all machines in the\nassessment.", + "readOnly": true + }, + "monthlyStandardSsdStorageCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the aggregate standard SSD storage cost for all the machines in\nthe assessment.", + "readOnly": true + }, + "suitabilitySummary": { + "type": "object", + "description": "Gets or sets the Cloud suitability summary for all the machines in the\nassessment.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the Number of machines part of the assessment.", + "readOnly": true + }, + "vmUptime": { + "$ref": "#/definitions/VmUptime", + "description": "Gets or sets the duration for which the VMs are up in the on-premises\nenvironment." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment.", + "readOnly": true + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment.", + "readOnly": true + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage.", + "readOnly": true + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "MachineBootType": { + "type": "string", + "enum": [ + "Unknown", + "EFI", + "BIOS", + "NotSpecified" + ], + "x-ms-enum": { + "name": "MachineBootType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown" + }, + { + "name": "EFI", + "value": "EFI" + }, + { + "name": "Bios", + "value": "BIOS" + }, + { + "name": "NotSpecified", + "value": "NotSpecified" + } + ] + } + }, + "MachineListResult": { + "type": "object", + "description": "The response of a Machine list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Machine items on this page", + "items": { + "$ref": "#/definitions/Machine" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MachineProperties": { + "type": "object", + "description": "Properties of a machine.", + "properties": { + "workloadSummary": { + "$ref": "#/definitions/WorkloadSummary", + "description": "Gets or sets workload summary.", + "readOnly": true + }, + "errors": { + "type": "array", + "description": "List of errors for this machine.", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "hostProcessor": { + "$ref": "#/definitions/ProcessorInfo", + "description": "Gets Processor details of the host.", + "readOnly": true + }, + "productSupportStatus": { + "$ref": "#/definitions/ProductSupportStatus", + "description": "Gets the product support status related details.", + "readOnly": true + }, + "discoveryMachineArmId": { + "type": "string", + "description": "Site id of machine discovered in private data center.", + "readOnly": true + }, + "datacenterManagementServerArmId": { + "type": "string", + "description": "The data center management server ARM Id for the machine.", + "readOnly": true + }, + "datacenterManagementServerName": { + "type": "string", + "description": "The data center management server name for the machine.", + "readOnly": true + }, + "bootType": { + "$ref": "#/definitions/MachineBootType", + "description": "Boot type of machine discovered in private data center.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Machine.", + "readOnly": true + }, + "megabytesOfMemory": { + "type": "number", + "format": "float", + "description": "Megabytes of memory found allocated for the machine in private data center.", + "readOnly": true + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "Number of CPU cores found on the machine.", + "readOnly": true + }, + "operatingSystemType": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemName": { + "type": "string", + "description": "Operating system as reported by datacenter management solution.", + "readOnly": true + }, + "operatingSystemVersion": { + "type": "string", + "description": "Operating system version as reported by datacenter management solution.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description for the machine.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine first created.", + "readOnly": true + }, + "disks": { + "type": "object", + "description": "Disks attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/Disk" + }, + "readOnly": true + }, + "groups": { + "type": "array", + "description": "Gets the References to the groups that this machine is member of.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "networkAdapters": { + "type": "object", + "description": "Network adapters attached to the machine discovered in private data center.", + "additionalProperties": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + }, + "sqlInstances": { + "type": "array", + "description": "SQL instances discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "webApplications": { + "type": "array", + "description": "Web applications discovered on the machine.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was machine last updated.", + "readOnly": true + } + } + }, + "ManagementCostComponent": { + "type": "object", + "description": "Management Cost Component.", + "properties": { + "name": { + "$ref": "#/definitions/ManagementCostComponentName", + "description": "Name of Management Cost Component." + }, + "value": { + "type": "number", + "format": "float", + "description": "Cost of Management Component." + } + }, + "required": [ + "name" + ] + }, + "ManagementCostComponentName": { + "type": "string", + "description": "Management Cost Component Names.", + "enum": [ + "Unknown", + "SystemCenterLicenseCost", + "VSphereManagementCost", + "ThirdPartyManagementCost", + "OtherMonitoringCost", + "OtherDataProtectionCost", + "OtherPatchingCost", + "AzureMonitoringCost", + "AzurePatchingCost", + "AzureDataProtectionCost" + ], + "x-ms-enum": { + "name": "ManagementCostComponentName", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Management Cost Component." + }, + { + "name": "SystemCenterLicenseCost", + "value": "SystemCenterLicenseCost", + "description": "System Center License Cost." + }, + { + "name": "VSphereManagementCost", + "value": "VSphereManagementCost", + "description": "VSphere eManagement Cost." + }, + { + "name": "ThirdPartyManagementCost", + "value": "ThirdPartyManagementCost", + "description": "Third Party Management Cost." + }, + { + "name": "OtherMonitoringCost", + "value": "OtherMonitoringCost", + "description": "Other Monitoring Cost." + }, + { + "name": "OtherDataProtectionCost", + "value": "OtherDataProtectionCost", + "description": "Other Data Protection Cost." + }, + { + "name": "OtherPatchingCost", + "value": "OtherPatchingCost", + "description": "Other Patching Cost." + }, + { + "name": "AzureMonitoringCost", + "value": "AzureMonitoringCost", + "description": "Azure Monitoring Cost." + }, + { + "name": "AzurePatchingCost", + "value": "AzurePatchingCost", + "description": "Azure Patching Cost." + }, + { + "name": "AzureDataProtectionCost", + "value": "AzureDataProtectionCost", + "description": "Azure Data Protection Cost." + } + ] + } + }, + "ManagementCostDetails": { + "type": "object", + "description": "Management Cost Details.", + "properties": { + "managementCost": { + "type": "number", + "format": "float", + "description": "Management Cost.", + "readOnly": true + }, + "managementCostComponents": { + "type": "array", + "description": "Management Cost Components.", + "items": { + "$ref": "#/definitions/ManagementCostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ManagementSettings": { + "type": "object", + "description": "Management settings.", + "properties": { + "hypervVirtualizationManagementSettings": { + "$ref": "#/definitions/HypervVirtualizationManagementSettings", + "description": "HyperV Virtualization Management Settings." + }, + "vsphereManagementSettings": { + "$ref": "#/definitions/VsphereManagementSettings", + "description": "vSphere Management Settings." + }, + "thirdPartyManagementSettings": { + "$ref": "#/definitions/ThirdPartyManagementSettings", + "description": "Third Party Management Settings." + }, + "otherManagementCostsSettings": { + "$ref": "#/definitions/OtherManagementCostsSettings", + "description": "Other Management Costs Settings." + } + }, + "required": [ + "hypervVirtualizationManagementSettings", + "vsphereManagementSettings", + "thirdPartyManagementSettings", + "otherManagementCostsSettings" + ] + }, + "MigrationGuidelineContext": { + "type": "object", + "description": "Migration Guideline Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "MigrationStrategy": { + "type": "string", + "description": "Business case supported migration strategy types.", + "enum": [ + "Unknown", + "OptimizeForCost", + "IaaSOnly", + "OptimizeForPaas", + "AVSOnly" + ], + "x-ms-enum": { + "name": "MigrationStrategy", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Migration Strategy." + }, + { + "name": "OptimizeForCost", + "value": "OptimizeForCost", + "description": "Optimize for cost." + }, + { + "name": "IaaSOnly", + "value": "IaaSOnly", + "description": "IaaS only." + }, + { + "name": "OptimizeForPaas", + "value": "OptimizeForPaas", + "description": "Optimize for PaaS." + }, + { + "name": "AVSOnly", + "value": "AVSOnly", + "description": "Avs only." + } + ] + } + }, + "MoreInfo": { + "type": "object", + "description": "Data model of More information about check or rule.", + "properties": { + "title": { + "type": "string", + "description": "Gets title.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "Gets url.", + "readOnly": true + } + }, + "required": [ + "title", + "url" + ] + }, + "MultiSubnetIntent": { + "type": "string", + "enum": [ + "None", + "HighAvailability", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "MultiSubnetIntent", + "modelAsString": true + } + }, + "MutableArmResource": { + "type": "object", + "description": "ARM model of Assessment ARM object.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningStatus", + "description": "Gets the provisioning state.", + "readOnly": true + } + } + }, + "NetworkAdapter": { + "type": "object", + "description": "A network adapter discovered on a machine.", + "properties": { + "macAddress": { + "type": "string", + "description": "MAC Address of the network adapter.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "description": "List of IP Addresses on the network adapter.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "User friendly name of the network adapter.", + "readOnly": true + } + } + }, + "NetworkSettings": { + "type": "object", + "description": "Network settings.", + "properties": { + "hardwareSoftwareCostPercentage": { + "type": "number", + "format": "float", + "description": "Network hardware and software cost percentage.", + "minimum": 0, + "maximum": 100 + }, + "maintenanceCostPercentage": { + "type": "number", + "format": "float", + "description": "Network maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "hardwareSoftwareCostPercentage", + "maintenanceCostPercentage" + ] + }, + "NetworkSkuType": { + "type": "string", + "description": "Different network skus.", + "enum": [ + "Unknown", + "None", + "ExpressRouteUltra" + ], + "x-ms-enum": { + "name": "NetworkSkuType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Indicates un-supported network SKU." + }, + { + "name": "None", + "value": "None", + "description": "Indicates No network SKU." + }, + { + "name": "ExpressRouteUltra", + "value": "ExpressRouteUltra", + "description": "Express Route network type with Ultra SKU." + } + ] + } + }, + "NodePool": { + "type": "object", + "description": "Data model of Node Pool.", + "properties": { + "id": { + "type": "string", + "description": "Gets id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Gets name.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "mode": { + "$ref": "#/definitions/NodePoolMode", + "description": "Gets mode.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "armSkuName": { + "type": "string", + "description": "Gets arm sku name.", + "readOnly": true + }, + "nodeCount": { + "type": "integer", + "format": "int32", + "description": "Gets node count.", + "readOnly": true + }, + "podCount": { + "type": "integer", + "format": "int32", + "description": "Gets pod count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + }, + "podApproxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets pod approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "id", + "name", + "clusterName", + "mode", + "osType", + "armSkuName", + "nodeCount", + "podCount", + "monthlyCost", + "podApproxMonthlyCost" + ] + }, + "NodePoolMode": { + "type": "string", + "description": "Node Pool Mode.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "NodePoolMode", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Indicates User node pool." + }, + { + "name": "System", + "value": "System", + "description": "Indicates System node pool." + } + ] + } + }, + "OSType": { + "type": "string", + "description": "Operating System Type.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS Type." + }, + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS Type." + } + ] + } + }, + "OnPremiseSettings": { + "type": "object", + "description": "On-premise settings.", + "properties": { + "computeSettings": { + "$ref": "#/definitions/ComputeSettings", + "description": "Compute settings." + }, + "storageSettings": { + "$ref": "#/definitions/StorageSettings", + "description": "Storage settings." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "Network settings." + }, + "facilitySettings": { + "$ref": "#/definitions/FacilitySettings", + "description": "Facility settings." + }, + "laborSettings": { + "$ref": "#/definitions/LaborSettings", + "description": "Labour settings." + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security settings." + }, + "managementSettings": { + "$ref": "#/definitions/ManagementSettings", + "description": "Management settings." + } + }, + "required": [ + "computeSettings", + "storageSettings", + "networkSettings", + "facilitySettings", + "laborSettings", + "securitySettings" + ] + }, + "OnPremisesIaasSummary": { + "type": "object", + "description": "The on premises IAAS summary.", + "properties": { + "servers": { + "type": "integer", + "format": "int32", + "description": "The number of servers.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "The number of cores.", + "readOnly": true + }, + "memoryGb": { + "type": "number", + "format": "float", + "description": "Total memory in GB.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "The CPU utilization.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "The memory utilization.", + "readOnly": true + }, + "storageUtilization": { + "type": "number", + "format": "float", + "description": "The storage utilization.", + "readOnly": true + }, + "onPremisesIaasCostDetails": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesIaasCostForDecommissioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "osLicensingDetails": { + "type": "array", + "description": "The OS licensing details.", + "items": { + "$ref": "#/definitions/IaasOsLicensingDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionByOperatingSystem": { + "type": "array", + "description": "The distribution by operating system.", + "items": { + "$ref": "#/definitions/DistributionByOperatingSystem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "onPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionByVirtualization": { + "type": "array", + "description": "The distribution by virtualization.", + "items": { + "$ref": "#/definitions/DistributionByVirtualization" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "iaasOsSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas OS Support Status Distribution.", + "readOnly": true + }, + "iaasSqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Iaas Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + }, + "distributionByOperatingSystemVersion": { + "type": "array", + "description": "Distribution by Operating System Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by Sql Version.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesPaasLicensingCost": { + "type": "object", + "description": "The on premises paas licensing cost.", + "properties": { + "version": { + "type": "string", + "description": "The version.", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "float", + "description": "The total cost.", + "readOnly": true + }, + "decomissionServerCost": { + "type": "number", + "format": "float", + "description": "The decommissioned server cost.", + "readOnly": true + } + } + }, + "OnPremisesPaasSummary": { + "type": "object", + "description": "Shows platform as a service (PaaS) summary.", + "properties": { + "totalServers": { + "type": "integer", + "format": "int32", + "description": "Total servers.", + "readOnly": true + }, + "cpuUtilization": { + "type": "number", + "format": "float", + "description": "CPU utilization percentage.", + "readOnly": true + }, + "memoryUtilization": { + "type": "number", + "format": "float", + "description": "Memory utilization percentage.", + "readOnly": true + }, + "totalOnPremisesPaasCost": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasCostForDecommisioned": { + "$ref": "#/definitions/CostDetails", + "description": "The on premises PaaS cost.", + "readOnly": true + }, + "onPremisesPaasLicensingCost": { + "$ref": "#/definitions/OnPremisesPaasLicensingCost", + "description": "The on premises paas licensing cost.", + "readOnly": true + }, + "onPremisesSqlSummary": { + "$ref": "#/definitions/OnPremisesSqlSummary", + "description": "The on premises SQL summary.", + "readOnly": true + }, + "onPremisesWebAppSummary": { + "$ref": "#/definitions/OnPremisesWebAppSummary", + "description": "The on premises web application summary.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "osServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "OS Service Pack Insight.", + "readOnly": true + }, + "sqlServicePackInsight": { + "$ref": "#/definitions/ServicePackInsight", + "description": "Sql Service Pack Insight.", + "readOnly": true + } + } + }, + "OnPremisesSqlSummary": { + "type": "object", + "description": "The on premises SQL summary.", + "properties": { + "sqlInstances": { + "type": "integer", + "format": "int32", + "description": "The number of SQL instances.", + "readOnly": true + }, + "sqlDatabases": { + "type": "integer", + "format": "int32", + "description": "The number of SQL databases.", + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "array", + "description": "Distribution by SQL version.", + "items": { + "$ref": "#/definitions/SqlVersionDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sqlOnPremisesUtilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "array", + "description": "Distribution by Sql Edition.", + "items": { + "$ref": "#/definitions/DistributionByType" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "OnPremisesWebAppSummary": { + "type": "object", + "description": "The on premises web application summary.", + "properties": { + "numberOfWebServers": { + "type": "integer", + "format": "int32", + "description": "The number of web servers.", + "readOnly": true + }, + "numberOfWebApplications": { + "type": "integer", + "format": "int32", + "description": "The number of web applications.", + "readOnly": true + }, + "numberOfWebAppsPerType": { + "type": "object", + "description": "The number of web applications per web application type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "OptimizationLogic": { + "type": "string", + "enum": [ + "MinimizeCost", + "ModernizeToPaaS", + "ModernizeToAzureSqlMi", + "ModernizeToAzureSqlDb" + ], + "x-ms-enum": { + "name": "OptimizationLogic", + "modelAsString": true + } + }, + "OptionsArmPropertiesBase": { + "type": "object", + "description": "Base ARM model of ARM properties for assessment options.", + "properties": { + "edges": { + "type": "object", + "description": "Gets the mapping of Assessment Options in graph representation.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfStringArray" + }, + "readOnly": true + } + }, + "required": [ + "edges" + ] + }, + "OsLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "OsLicense", + "modelAsString": true + } + }, + "OtherManagementCostsSettings": { + "type": "object", + "description": "Other Management Costs Settings.", + "properties": { + "monitoringCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Monitoring Cost Per Server Per Year." + }, + "patchingCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Patching Cost Per Server Per Year." + }, + "dataProtectionCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Data Protection Cost Per Server Per Year." + } + }, + "required": [ + "monitoringCostPerServerPerYear", + "patchingCostPerServerPerYear", + "dataProtectionCostPerServerPerYear" + ] + }, + "OverviewSummary": { + "type": "object", + "description": "Overview summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/OverviewSummaryProperties", + "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/ProxyResource" + } + ] + }, + "OverviewSummaryListResult": { + "type": "object", + "description": "The response of a OverviewSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OverviewSummary items on this page", + "items": { + "$ref": "#/definitions/OverviewSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OverviewSummaryProperties": { + "type": "object", + "description": "Overview summary properties class.", + "properties": { + "totalAzureCost": { + "type": "number", + "format": "float", + "description": "The total Azure cost..", + "readOnly": true + }, + "totalAzureIaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure IaaS cost.", + "readOnly": true + }, + "totalAzurePaasCost": { + "type": "number", + "format": "float", + "description": "The total Azure PaaS cost.", + "readOnly": true + }, + "totalAzureAvsCost": { + "type": "number", + "format": "float", + "description": "The total Avs cost.", + "readOnly": true + }, + "windowsAhubSavings": { + "type": "number", + "format": "float", + "description": "The windows ahub saving.", + "readOnly": true + }, + "linuxAhubSavings": { + "type": "number", + "format": "float", + "description": "The linux ahub saving.", + "readOnly": true + }, + "sqlAhubSavings": { + "type": "number", + "format": "float", + "description": "The sql ahub saving.", + "readOnly": true + }, + "totalOnPremisesCost": { + "type": "number", + "format": "float", + "description": "The total on premises cost.", + "readOnly": true + }, + "esuSavingsFor4years": { + "type": "number", + "format": "float", + "description": "ESU Savings 4 Years.", + "readOnly": true + }, + "managementCostSavings": { + "type": "number", + "format": "float", + "description": "The management cost saving.", + "readOnly": true + }, + "securityCostSavings": { + "type": "number", + "format": "float", + "description": "The security cost saving.", + "readOnly": true + }, + "yearOnYearEstimates": { + "$ref": "#/definitions/YearOnYearEstimates", + "description": "Shows the year-on-year cost overall.", + "readOnly": true + }, + "serversDiscovered": { + "$ref": "#/definitions/ServersDiscovered", + "description": "Shows the discovered servers by virtualization platform.", + "readOnly": true + }, + "utilizationData": { + "$ref": "#/definitions/UtilizationData", + "description": "The SQL on premises utilization insights.", + "readOnly": true + }, + "iaasOsDistribution": { + "$ref": "#/definitions/IaasOsDistribution", + "description": "Shows the infrastructure as a service machine OS distribution.", + "readOnly": true + }, + "osSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "OS Support Status Distribution.", + "readOnly": true + }, + "sqlSupportStatusDistribution": { + "$ref": "#/definitions/SupportStatusDistribution", + "description": "Sql Support Status Distribution.", + "readOnly": true + }, + "paasDistribution": { + "$ref": "#/definitions/PaasDistribution", + "description": "Shows the distribution of platforms.", + "readOnly": true + } + } + }, + "POSAzurePricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Unknown", + "Standard" + ], + "x-ms-enum": { + "name": "POSAzurePricingTier", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + } + ] + } + }, + "PaasDistribution": { + "type": "object", + "description": "Shows the distribution of platforms.", + "properties": { + "sqlServers": { + "type": "integer", + "format": "int32", + "description": "Number of SQL Server machines.", + "readOnly": true + }, + "iisWebServers": { + "type": "integer", + "format": "int32", + "description": "Number of IIS Web servers.", + "readOnly": true + }, + "webAppDistribution": { + "type": "object", + "description": "Distribution of webapps for each target type.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + } + } + }, + "PaasSummary": { + "type": "object", + "description": "Paas summary REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/PaasSummaryProperties", + "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/ProxyResource" + } + ] + }, + "PaasSummaryListResult": { + "type": "object", + "description": "The response of a PaasSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PaasSummary items on this page", + "items": { + "$ref": "#/definitions/PaasSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PaasSummaryProperties": { + "type": "object", + "description": "Paas summary properties class.", + "properties": { + "azure": { + "$ref": "#/definitions/AzurePaasSummary", + "description": "Shows the PaaS Azure summary.", + "readOnly": true + }, + "onPremises": { + "$ref": "#/definitions/OnPremisesPaasSummary", + "description": "Shows platform as a service (PaaS) summary.", + "readOnly": true + } + } + }, + "Percentile": { + "type": "string", + "description": "Percentile for Performance Data.", + "enum": [ + "Percentile50", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "x-ms-enum": { + "name": "Percentile", + "modelAsString": true, + "values": [ + { + "name": "Percentile50", + "value": "Percentile50", + "description": "Percentile 50." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "Percentile 90." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "Percentile 95." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "Percentile 99." + } + ] + } + }, + "PerfDataSettings": { + "type": "object", + "description": "Data model of Performance Data Settings.", + "properties": { + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Gets perf data time range." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data start time." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets perf data end time." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Gets percentile utilization for performance data." + } + }, + "required": [ + "timeRange", + "percentile" + ] + }, + "PricingTier": { + "type": "string", + "description": "Pricing Tier for Azure.", + "enum": [ + "Standard", + "Free" + ], + "x-ms-enum": { + "name": "PricingTier", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard Pricing Tier." + }, + { + "name": "Free", + "value": "Free", + "description": "Free Pricing Tier." + } + ] + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "Private endpoint connection resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "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/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnection items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private link resource.", + "properties": { + "properties": { + "$ref": "../../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "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/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProcessorInfo": { + "type": "object", + "description": "Represents a information \\ details of a processor.", + "properties": { + "name": { + "type": "string", + "description": "Gets or sets the name \\ model of a processor." + }, + "numberOfSockets": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of sockets." + }, + "numberOfCoresPerSocket": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the number of cores in a socket." + } + } + }, + "ProductSupportStatus": { + "type": "object", + "description": "Class to represent the Product Support Status.", + "properties": { + "currentVersion": { + "type": "string", + "description": "Gets or sets current version of ServicePack.", + "readOnly": true + }, + "servicePackStatus": { + "type": "string", + "description": "Gets or sets ServicePack of the product.", + "readOnly": true + }, + "esuStatus": { + "type": "string", + "description": "Gets or sets the Extended Security Update ESU status.", + "readOnly": true + }, + "supportStatus": { + "type": "string", + "description": "Gets or sets the support status of the product.", + "readOnly": true + }, + "eta": { + "type": "integer", + "format": "int32", + "description": "Gets or sets the ETA.", + "readOnly": true + }, + "currentEsuYear": { + "type": "string", + "description": "Gets or sets the current ESU support year.", + "readOnly": true + }, + "mainstreamEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the main stream end date of the product.", + "readOnly": true + }, + "extendedSupportEndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended support end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear1EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 1 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear2EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 2 end date of the product.", + "readOnly": true + }, + "extendedSecurityUpdateYear3EndDate": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the extended security update year 3 end date of the product.", + "readOnly": true + } + } + }, + "ProjectProperties": { + "type": "object", + "description": "Properties of a project.", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was created. Date-Time represented in ISO-8601 format.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Time when this project was last updated. Date-Time represented in ISO-8601\nformat.", + "readOnly": true + }, + "serviceEndpoint": { + "type": "string", + "description": "Endpoint at which the collector agent can call agent REST API.", + "readOnly": true + }, + "assessmentSolutionId": { + "type": "string", + "description": "Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects." + }, + "projectStatus": { + "$ref": "#/definitions/ProjectStatus", + "description": "Assessment project status." + }, + "customerWorkspaceId": { + "type": "string", + "description": "The ARM id of service map workspace created by customer." + }, + "customerWorkspaceLocation": { + "type": "string", + "description": "Location of service map workspace created by customer." + }, + "publicNetworkAccess": { + "type": "string", + "description": "This value can be set to 'enabled' to avoid breaking changes on existing\ncustomer resources and templates. If set to 'disabled', traffic over public\ninterface is not allowed, and private endpoint connections would be the\nexclusive access method." + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections to the project.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "customerStorageAccountArmId": { + "type": "string", + "description": "The ARM id of the storage account used for interactions when public access is\ndisabled." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "ProjectStatus": { + "type": "string", + "description": "Project Status.", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Active Status." + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Inactive Status." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "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 being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + } + }, + "ProvisioningState2": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState2", + "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 being Provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Resource is being Updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Resource is being Deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource is being Accepted." + } + ] + }, + "readOnly": true + }, + "ProvisioningStatus": { + "type": "string", + "description": "Provisioning Status.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "InProgress" + ], + "x-ms-enum": { + "name": "ProvisioningStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates missing data." + }, + { + "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": "InProgress", + "value": "InProgress", + "description": "Provisioning is in Progress." + } + ] + }, + "readOnly": true + }, + "Readiness": { + "type": "string", + "description": "Readiness for Azure.", + "enum": [ + "Unknown", + "NotReady", + "ReadyWithConditions", + "Ready" + ], + "x-ms-enum": { + "name": "Readiness", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Readiness." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Not Ready." + }, + { + "name": "ReadyWithConditions", + "value": "ReadyWithConditions", + "description": "Ready with conditions." + }, + { + "name": "Ready", + "value": "Ready", + "description": "Ready for migration." + } + ] + } + }, + "RecommendationResult": { + "type": "object", + "description": "Data model of Recommendation Result.", + "properties": { + "request": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory request.", + "readOnly": true + }, + "limit": { + "$ref": "#/definitions/ComputeResource", + "description": "Gets cores and memory limit.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "Gets os type.", + "readOnly": true + }, + "clusterName": { + "type": "string", + "description": "Gets cluster name.", + "readOnly": true + }, + "nodePoolId": { + "type": "string", + "description": "Gets node pool id.", + "readOnly": true + }, + "nodePoolName": { + "type": "string", + "description": "Gets node pool name.", + "readOnly": true + }, + "nodePoolArmSkuName": { + "type": "string", + "description": "Gets node pool arm sku name.", + "readOnly": true + }, + "approxMonthlyCost": { + "type": "number", + "format": "float", + "description": "Gets approximate monthly cost.", + "readOnly": true + } + }, + "required": [ + "request", + "limit", + "osType", + "clusterName", + "nodePoolId", + "nodePoolName", + "nodePoolArmSkuName", + "approxMonthlyCost" + ] + }, + "RecommendedAvsNodeTypeSummary": { + "type": "object", + "description": "Azure Avs Node summary.", + "properties": { + "avsNodeType": { + "type": "string", + "description": "AVS node type.", + "readOnly": true + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "Number of nodes.", + "readOnly": true + }, + "failuresToTolerateAndRaidLevel": { + "$ref": "#/definitions/FttAndRaidLevel", + "description": "Failures to tolerate and RAID level for the Node.", + "readOnly": true + } + } + }, + "RecommendedSuitability": { + "type": "string", + "enum": [ + "Unknown", + "SuitableForSqlDB", + "SuitableForSqlMI", + "SuitableForVM", + "PotentiallySuitableForVM", + "ReadinessUnknown", + "NotSuitable", + "SuitableForSqlVM", + "ConditionallySuitableForSqlDB", + "ConditionallySuitableForSqlMI", + "ConditionallySuitableForVM", + "ConditionallySuitableForSqlVM" + ], + "x-ms-enum": { + "name": "RecommendedSuitability", + "modelAsString": true + } + }, + "RecommendedVmFamilySummary": { + "type": "object", + "description": "The recommended VM family summary.", + "properties": { + "azureVmFamily": { + "type": "string", + "description": "The Azure VM family.", + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "The number of machines.", + "readOnly": true + } + } + }, + "RecordOfInt": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "RecordOfStringArray": { + "type": "object", + "description": "Data Model for Dictionary.", + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "ReportDetails": { + "type": "object", + "description": "Business case report details.", + "properties": { + "reportType": { + "$ref": "#/definitions/ReportType", + "description": "Report type.", + "readOnly": true + }, + "reportStatus": { + "$ref": "#/definitions/ReportStatus", + "description": "Report status.", + "readOnly": true + } + } + }, + "ReportDownloadUrl": { + "type": "object", + "description": "Download URL for assessment report.", + "properties": { + "businessCaseReportUrl": { + "type": "string", + "description": "Hyperlink to download report.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "Expiry date of download url.", + "readOnly": true + } + } + }, + "ReportStatus": { + "type": "string", + "description": "Business case supported report status types.", + "enum": [ + "Unknown", + "None", + "InProgress", + "Failed", + "Completed" + ], + "x-ms-enum": { + "name": "ReportStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Status." + }, + { + "name": "None", + "value": "None", + "description": "None Report Status." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "InProgress Report Status." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Failed Report Status." + }, + { + "name": "Completed", + "value": "Completed", + "description": "Completed Report Status." + } + ] + } + }, + "ReportType": { + "type": "string", + "description": "Business case supported report types.", + "enum": [ + "Unknown", + "Excel" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Report Type." + }, + { + "name": "Excel", + "value": "Excel", + "description": "Excel Report Type." + } + ] + } + }, + "ResourceId": { + "type": "object", + "description": "ARM id for a resource.", + "properties": { + "id": { + "type": "string", + "description": "Gets the relative URL to get to this REST resource.", + "readOnly": true + } + } + }, + "SavingsOption": { + "type": "string", + "description": "Business case supported Savings Option types.", + "enum": [ + "Unknown", + "RI3Year", + "SavingsPlan3Year" + ], + "x-ms-enum": { + "name": "SavingsOption", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Savings Option." + }, + { + "name": "RI3Year", + "value": "RI3Year", + "description": "Reserved Instance 3 Year." + }, + { + "name": "SavingsPlan3Year", + "value": "SavingsPlan3Year", + "description": "Azure Savings Plan 3 Year." + } + ] + } + }, + "SavingsOptions": { + "type": "string", + "description": "Savings Options for Azure.", + "enum": [ + "None", + "OneYearSavings", + "ThreeYearsSavings", + "OneYearReserved", + "ThreeYearsReserved" + ], + "x-ms-enum": { + "name": "SavingsOptions", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Savings Options is not applicable." + }, + { + "name": "OneYearSavings", + "value": "OneYearSavings", + "description": "One Year Savings Plan." + }, + { + "name": "ThreeYearsSavings", + "value": "ThreeYearsSavings", + "description": "Three Years Savings Plan." + }, + { + "name": "OneYearReserved", + "value": "OneYearReserved", + "description": "One Year Reserved Instances." + }, + { + "name": "ThreeYearsReserved", + "value": "ThreeYearsReserved", + "description": "Three Years Reserved Instances." + } + ] + } + }, + "SecuritySettings": { + "type": "object", + "description": "Security settings.", + "properties": { + "serverSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Physical servers per administrator." + }, + "sqlServerSecurityCostPerServerPerYear": { + "type": "number", + "format": "float", + "description": "Virtual machines per administrator." + } + }, + "required": [ + "serverSecurityCostPerServerPerYear", + "sqlServerSecurityCostPerServerPerYear" + ] + }, + "ServerCollector": { + "type": "object", + "description": "Physical server collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "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/ProxyResource" + } + ] + }, + "ServerCollectorListResult": { + "type": "object", + "description": "The response of a ServerCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ServerCollector items on this page", + "items": { + "$ref": "#/definitions/ServerCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ServersDiscovered": { + "type": "object", + "description": "Shows the discovered servers by virtualization platform.", + "properties": { + "vmWare": { + "type": "integer", + "format": "int32", + "description": "Number of servers on VMWare.", + "readOnly": true + }, + "hyperV": { + "type": "integer", + "format": "int32", + "description": "Number of servers on HyperV.", + "readOnly": true + }, + "physical": { + "type": "integer", + "format": "int32", + "description": "Number of physical servers.", + "readOnly": true + }, + "notApplicable": { + "type": "integer", + "format": "int32", + "description": "Number of servers whose virtualization is unknown.", + "readOnly": true + } + } + }, + "ServicePackInsight": { + "type": "object", + "description": "Service Pack Insight.", + "properties": { + "unknownServicePack": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "patched": { + "type": "integer", + "format": "int32", + "description": "Patched Service Pack Insight.", + "readOnly": true + }, + "unpatched": { + "type": "integer", + "format": "int32", + "description": "Unpatched Service Pack Insight.", + "readOnly": true + } + } + }, + "Settings": { + "type": "object", + "description": "Business case settings.", + "properties": { + "azureSettings": { + "$ref": "#/definitions/AzureSettings", + "description": "Azure settings for a business case." + }, + "onPremiseSettings": { + "$ref": "#/definitions/OnPremiseSettings", + "description": "On-premise settings." + } + }, + "required": [ + "azureSettings" + ] + }, + "SharedResourcesDTO": { + "type": "object", + "description": "Shared Resources.", + "properties": { + "sharedDataDisks": { + "type": "array", + "description": "Gets the list of shared data disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedLogDisks": { + "type": "array", + "description": "Gets the list of shared log disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedTempDbDisks": { + "type": "array", + "description": "Gets the list of shared Temporary database disks.", + "items": { + "$ref": "#/definitions/AzureManagedDiskSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "numberOfMounts": { + "type": "integer", + "format": "int32", + "description": "Gets number of mounts of shared disks.", + "readOnly": true + }, + "quorumWitness": { + "$ref": "#/definitions/AzureQuorumWitnessDTO", + "description": "Gets quorum witness.", + "readOnly": true + } + } + }, + "SkuReplicationMode": { + "type": "string", + "enum": [ + "NotApplicable", + "ActiveGeoReplication", + "FailoverGroupInstance" + ], + "x-ms-enum": { + "name": "SkuReplicationMode", + "modelAsString": true + } + }, + "SqlAssessedNetworkAdapter": { + "type": "object", + "description": "SQL Assessed Network Adapter.", + "properties": { + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability." + }, + "suitabilityDetail": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityDetail", + "description": "Gets the suitability detail." + }, + "suitabilityExplanation": { + "$ref": "#/definitions/AzureNetworkAdapterSuitabilityExplanation", + "description": "Gets the suitability explanation." + }, + "monthlyBandwidthCosts": { + "type": "number", + "format": "float", + "description": "Gets the monthly bandwidth costs." + }, + "netGigabytesTransmittedPerMonth": { + "type": "number", + "format": "float", + "description": "Gets the net gigabytes transmitted per month." + }, + "name": { + "type": "string", + "description": "Gets the name." + }, + "displayName": { + "type": "string", + "description": "Gets the display name." + }, + "macAddress": { + "type": "string", + "description": "Gets the mac address." + }, + "ipAddresses": { + "type": "array", + "description": "Gets the ip addresses.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "megabytesPerSecondReceived": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second received." + }, + "megabytesPerSecondTransmitted": { + "type": "number", + "format": "float", + "description": "Gets the megabytes per second transmitted." + } + } + }, + "SqlAssessmentMigrationIssue": { + "type": "object", + "description": "Class representing the SQL migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets the issue id.", + "readOnly": true + }, + "issueCategory": { + "$ref": "#/definitions/SqlAssessmentMigrationIssueCategory", + "description": "Gets the issue category.", + "readOnly": true + }, + "impactedObjects": { + "type": "array", + "description": "Gets the list of impacted objects.", + "items": { + "$ref": "#/definitions/ImpactedAssessmentObject" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentMigrationIssueCategory": { + "type": "string", + "enum": [ + "Issue", + "Warning", + "Internal" + ], + "x-ms-enum": { + "name": "SqlAssessmentMigrationIssueCategory", + "modelAsString": true + } + }, + "SqlAssessmentOptions": { + "type": "object", + "description": "SQL Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentOptionsProperties", + "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/ProxyResource" + } + ] + }, + "SqlAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a SqlAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentOptionsProperties": { + "type": "object", + "description": "SQL Assessment options properties Web model object.", + "properties": { + "vmFamilies": { + "type": "array", + "description": "Gets the list of VM families.", + "items": { + "$ref": "#/definitions/VmFamilyOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "reservedInstanceVmFamilies": { + "type": "array", + "description": "Gets the Reserved Instance VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "premiumDiskVmFamilies": { + "type": "array", + "description": "Gets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanVmFamilies": { + "type": "array", + "description": "Gets or sets the Premium disk VM Families list.", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocationsForPaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for PAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocationsForIaas": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "sqlSkus": { + "type": "array", + "description": "Gets or sets the list of SQL target SKU properties for dropdowns.", + "items": { + "$ref": "#/definitions/SqlPaaSTargetOptions" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSqlTargets": { + "type": "array", + "description": "Gets or sets the Reserved Instance SQL target types.", + "items": { + "$ref": "#/definitions/TargetType" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "supportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for SQL assessments.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2Properties", + "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/ProxyResource" + } + ] + }, + "SqlAssessmentV2IaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL IAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO", + "description": "Gets the azure SQL IAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL IAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlIaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2ListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2PaasSuitabilityData": { + "type": "object", + "description": "Class representing Azure SQL PAAS suitability details.", + "properties": { + "azureSqlSku": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO", + "description": "Gets the azure SQL PAAS SKU.", + "readOnly": true + }, + "replicaAzureSqlSku": { + "type": "array", + "description": "Gets the replica azure SQL PAAS SKU.", + "items": { + "$ref": "#/definitions/AzureSqlPaasSkuDTO" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "sharedResources": { + "$ref": "#/definitions/SharedResourcesDTO", + "description": "Gets the shared resources.", + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Gets the collection of cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "x-ms-identifiers": [] + }, + "securitySuitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the suitability for Microsoft cloud defender.", + "readOnly": true + }, + "shouldProvisionReplicas": { + "type": "boolean", + "description": "Gets a value indicating whether replicas should be provisioned.", + "readOnly": true + }, + "skuReplicationMode": { + "$ref": "#/definitions/SkuReplicationMode", + "description": "Gets the replication mode.", + "readOnly": true + }, + "migrationGuidelines": { + "type": "array", + "description": "Gets the list of migration guidelines applicable to this target.", + "items": { + "$ref": "#/definitions/SqlMigrationGuideline" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "recommendationReasonings": { + "type": "array", + "description": "Gets the list of SQL recommendation Reasoning.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoning" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "migrationTargetPlatform": { + "$ref": "#/definitions/TargetType", + "description": "Gets the migration target platform.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/CloudSuitability", + "description": "Gets the azure suitability.", + "readOnly": true + }, + "migrationIssues": { + "type": "array", + "description": "Gets the list of migrations issues.", + "items": { + "$ref": "#/definitions/SqlAssessmentMigrationIssue" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlAssessmentV2Properties": { + "type": "object", + "description": "SQL assessment properties class.", + "properties": { + "osLicense": { + "$ref": "#/definitions/OsLicense", + "description": "Gets or sets user configurable setting to display the azure hybrid use benefit." + }, + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (SQL, VMs) are up in the\non-premises environment." + }, + "optimizationLogic": { + "$ref": "#/definitions/OptimizationLogic", + "description": "Gets or sets SQL optimization logic." + }, + "reservedInstanceForVm": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Gets or sets azure reserved instance for VM." + }, + "azureOfferCodeForVm": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Gets or sets Azure Offer Code for VM." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "azureSqlManagedInstanceSettings": { + "$ref": "#/definitions/SqlMiSettings", + "description": "Gets or sets user configurable SQL managed instance settings." + }, + "azureSqlDatabaseSettings": { + "$ref": "#/definitions/SqlDbSettings", + "description": "Gets or sets user configurable SQL database settings." + }, + "azureSqlVmSettings": { + "$ref": "#/definitions/SqlVmSettings", + "description": "Gets or sets user configurable SQL VM settings." + }, + "multiSubnetIntent": { + "$ref": "#/definitions/MultiSubnetIntent", + "description": "Gets or sets user preference indicating intent of multi-subnet configuration." + }, + "asyncCommitModeIntent": { + "$ref": "#/definitions/AsyncCommitModeIntent", + "description": "Gets or sets user preference indicating intent of async commit mode." + }, + "isInternetAccessAvailable": { + "type": "boolean", + "description": "Gets or sets a value indicating whether internet access is available." + }, + "disasterRecoveryLocation": { + "$ref": "#/definitions/AzureLocation", + "description": "Gets or sets the Azure Location or Azure region where to which the machines\nwill be migrated." + }, + "enableHadrAssessment": { + "type": "boolean", + "description": "Gets or sets a value indicating whether HADR assessments needs to be created." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "sqlServerLicense": { + "$ref": "#/definitions/SqlServerLicense", + "description": "SQL server license." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties" + } + ] + }, + "SqlAssessmentV2Summary": { + "type": "object", + "description": "SQL Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryProperties", + "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/ProxyResource" + } + ] + }, + "SqlAssessmentV2SummaryData": { + "type": "object", + "description": "SQL Assessment V2 summary data.", + "properties": { + "suitabilitySummary": { + "type": "object", + "description": "Sql assessment summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Monthly compute cost", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Monthly storage cost", + "readOnly": true + }, + "monthlyLicenseCost": { + "type": "number", + "format": "float", + "description": "Monthly license cost", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence Rating", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security cost", + "readOnly": true + } + } + }, + "SqlAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a SqlAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/SqlAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlAssessmentV2SummaryProperties": { + "type": "object", + "description": "SQL Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the Assessment summary.", + "additionalProperties": { + "$ref": "#/definitions/SqlAssessmentV2SummaryData" + }, + "readOnly": true + }, + "distributionBySupportStatus": { + "type": "object", + "description": "Gets the distribution of sqlInstances by support status.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionByServicePackInsight": { + "type": "object", + "description": "Gets the distribution distribution of sqlInstances by service pack insight.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlVersion": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql version.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "distributionBySqlEdition": { + "type": "object", + "description": "Gets the distribution of sqlInstances by sql edition.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "instanceDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the instance distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "databaseDistributionBySizingCriterion": { + "type": "object", + "description": "Gets the database distribution by sizing criterion.", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "numberOfMachines": { + "type": "integer", + "format": "int32", + "description": "Number of machines part of the assessment.", + "readOnly": true + }, + "numberOfSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSuccessfullyDiscoveredSqlInstances": { + "type": "integer", + "format": "int32", + "description": "Number of successfully discovered sql instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlDatabases": { + "type": "integer", + "format": "int32", + "description": "Number of sql databases part of the assessment.", + "readOnly": true + }, + "numberOfFciInstances": { + "type": "integer", + "format": "int32", + "description": "Number of sql failover cluster instances part of the assessment.", + "readOnly": true + }, + "numberOfSqlAvailabilityGroups": { + "type": "integer", + "format": "int32", + "description": "Number of sql availability groups part of the assessment.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupDataOverview": { + "type": "object", + "description": "Assessed Sql Availability Group Data Overview.", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "Gets the availability group id." + }, + "availabilityGroupName": { + "type": "string", + "description": "Gets the availability group name." + }, + "sqlAvailabilityGroupSdsArmId": { + "type": "string", + "description": "Gets the availability group arm id." + }, + "sqlAvailabilityGroupEntityId": { + "type": "string", + "description": "Gets the availability group entity id." + }, + "sqlAvailabilityReplicaId": { + "type": "string", + "description": "Gets the availability replica id." + } + } + }, + "SqlAvailabilityReplicaSummary": { + "type": "object", + "description": "Assessed Sql Availability Replica Summary.", + "properties": { + "numberOfSynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous read replicas." + }, + "numberOfSynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of synchronous non read replicas." + }, + "numberOfAsynchronousReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous read replicas." + }, + "numberOfAsynchronousNonReadReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of asynchronous non read replicas." + }, + "numberOfPrimaryReplicas": { + "type": "integer", + "format": "int32", + "description": "Gets the number Of primary replicas." + } + } + }, + "SqlCollector": { + "type": "object", + "description": "The SQL collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "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/ProxyResource" + } + ] + }, + "SqlCollectorListResult": { + "type": "object", + "description": "The response of a SqlCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqlCollector items on this page", + "items": { + "$ref": "#/definitions/SqlCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqlDbSettings": { + "type": "object", + "description": "SQL database assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlDataBaseType": { + "$ref": "#/definitions/AzureSqlDataBaseType", + "description": "Gets or sets the azure PAAS SQL instance type." + }, + "azureSqlComputeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the azure SQL compute tier." + }, + "azureSqlPurchaseModel": { + "$ref": "#/definitions/AzureSqlPurchaseModel", + "description": "Gets or sets the azure SQL purchase model." + } + } + }, + "SqlFCIMetadata": { + "type": "object", + "description": "Sql fci meta data.", + "properties": { + "state": { + "$ref": "#/definitions/SqlFCIMetadataState", + "description": "Gets the Sql fci meta data state." + }, + "isMultiSubnet": { + "type": "boolean", + "description": "Gets whether fci is multi subnet." + }, + "fciSharedDiskCount": { + "type": "integer", + "format": "int32", + "description": "Gets the fci shared disk count." + } + } + }, + "SqlFCIMetadataState": { + "type": "string", + "enum": [ + "Unknown", + "Inherited", + "Initializing", + "Online", + "Offline", + "Failed", + "Pending", + "OnlinePending", + "OfflinePending" + ], + "x-ms-enum": { + "name": "SqlFCIMetadataState", + "modelAsString": true + } + }, + "SqlFCIState": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Passive", + "NotApplicable" + ], + "x-ms-enum": { + "name": "SqlFCIState", + "modelAsString": true + } + }, + "SqlMiSettings": { + "type": "object", + "description": "SQL managed instance assessment settings.", + "properties": { + "azureSqlServiceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the azure SQL service tier." + }, + "azureSqlInstanceType": { + "$ref": "#/definitions/AzureSqlInstanceType", + "description": "Gets or sets the azure PAAS SQL instance type." + } + } + }, + "SqlMigrationGuideline": { + "type": "object", + "description": "Sql Migration Guideline.", + "properties": { + "guidelineId": { + "type": "string", + "description": "Gets the guideline id." + }, + "migrationGuidelineCategory": { + "$ref": "#/definitions/SqlMigrationGuidelineCategory", + "description": "Gets the migration guideline category." + }, + "migrationGuidelineContext": { + "type": "array", + "description": "Gets the migration guideline context.", + "items": { + "$ref": "#/definitions/MigrationGuidelineContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlMigrationGuidelineCategory": { + "type": "string", + "enum": [ + "Unknown", + "General", + "FailoverCluterInstanceGuideLine", + "AvailabilityGroupGuideline" + ], + "x-ms-enum": { + "name": "SqlMigrationGuidelineCategory", + "modelAsString": true + } + }, + "SqlPaaSTargetOptions": { + "type": "object", + "description": "SQL target options.", + "properties": { + "computeTier": { + "$ref": "#/definitions/ComputeTier", + "description": "Gets or sets the Azure SQL compute tier." + }, + "hardwareGeneration": { + "$ref": "#/definitions/HardwareGeneration", + "description": "Gets or sets the Azure SQL hardware generation." + }, + "targetType": { + "$ref": "#/definitions/TargetType", + "description": "Gets or sets the Azure SQL target type." + }, + "serviceTier": { + "$ref": "#/definitions/AzureSqlServiceTier", + "description": "Gets or sets the Azure SQL service tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoning": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning.", + "properties": { + "reasoningId": { + "type": "string", + "description": "Gets the reasoning id." + }, + "reasoningString": { + "type": "string", + "description": "Gets the reasoning status." + }, + "reasoningCategory": { + "type": "string", + "description": "Gets the reasoning category." + }, + "contextParameters": { + "type": "array", + "description": "Gets the Sql recommended reasoning parameters.", + "items": { + "$ref": "#/definitions/SqlRecommendationReasoningContext" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "SqlRecommendationReasoningContext": { + "type": "object", + "description": "Class representing Azure SQL Recommendation Reasoning Context.", + "properties": { + "contextKey": { + "type": "string", + "description": "Gets the reasoning context key." + }, + "contextValue": { + "type": "string", + "description": "Gets the reasoning context value." + } + } + }, + "SqlServerLicense": { + "type": "string", + "enum": [ + "Unknown", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "SqlServerLicense", + "modelAsString": true + } + }, + "SqlServerLicenseType": { + "type": "string", + "description": "Business case supported SQL Server License types.", + "enum": [ + "Unknown", + "Enterprise", + "Standard" + ], + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Sql Server License." + }, + { + "name": "Enterprise", + "value": "Enterprise", + "description": "Enterprise Sql Server License." + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard Sql Server License." + } + ] + } + }, + "SqlServerLicensingSettings": { + "type": "object", + "description": "SQL Server licensing settings.", + "properties": { + "version": { + "$ref": "#/definitions/SqlServerLicenseType", + "description": "SQL Server version." + }, + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + } + }, + "required": [ + "version", + "licenseCost", + "softwareAssuranceCost" + ] + }, + "SqlServiceTier": { + "type": "object", + "description": "The SQL service tier.", + "properties": { + "serviceTierName": { + "type": "string", + "description": "The service tier name.", + "readOnly": true + }, + "serviceTierNumber": { + "type": "number", + "format": "float", + "description": "The number of sql entities with this tier.", + "readOnly": true + } + } + }, + "SqlVersionDetails": { + "type": "object", + "description": "The SQL version details.", + "properties": { + "sqlVersion": { + "type": "string", + "description": "The SQL version.", + "readOnly": true + }, + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "Number of instances with the above SQL version.", + "readOnly": true + } + } + }, + "SqlVmSettings": { + "type": "object", + "description": "SQL VM assessment settings.", + "properties": { + "instanceSeries": { + "type": "array", + "description": "Gets or sets the Azure VM families (calling instance series to keep it\nconsistent with other targets).", + "items": { + "$ref": "#/definitions/AzureVmFamily" + }, + "x-ms-identifiers": [] + } + } + }, + "StorageSettings": { + "type": "object", + "description": "Storage settings.", + "properties": { + "costPerGbPerMonth": { + "type": "number", + "format": "float", + "description": "Cost per gigabyte per month." + }, + "maintainanceCostPercentageToAcquisitionCost": { + "type": "number", + "format": "float", + "description": "Maintenance cost percentage.", + "minimum": 0, + "maximum": 100 + } + }, + "required": [ + "costPerGbPerMonth", + "maintainanceCostPercentageToAcquisitionCost" + ] + }, + "SuggestedMigrationTool": { + "type": "string", + "description": "Suggested Migration Tool for Azure.", + "enum": [ + "None", + "WebAppMigration", + "ServerMigration" + ], + "x-ms-enum": { + "name": "SuggestedMigrationTool", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No Migration Tool is suggested." + }, + { + "name": "WebAppMigration", + "value": "WebAppMigration", + "description": "Web App Migration." + }, + { + "name": "ServerMigration", + "value": "ServerMigration", + "description": "Server Migration." + } + ] + } + }, + "Suitability": { + "type": "string", + "description": "Suitability for Azure.", + "enum": [ + "NotSuitable", + "Suitable" + ], + "x-ms-enum": { + "name": "Suitability", + "modelAsString": true, + "values": [ + { + "name": "NotSuitable", + "value": "NotSuitable", + "description": "Not Suitable for Azure." + }, + { + "name": "Suitable", + "value": "Suitable", + "description": "Suitable for Azure." + } + ] + } + }, + "SuitabilityResult": { + "type": "object", + "description": "Data model of Suitability Result.", + "properties": { + "readiness": { + "$ref": "#/definitions/Readiness", + "description": "Gets readiness.", + "readOnly": true + }, + "suitability": { + "$ref": "#/definitions/Suitability", + "description": "Gets suitability.", + "readOnly": true + }, + "failedChecks": { + "type": "array", + "description": "Gets list of failed Checks.", + "items": { + "$ref": "#/definitions/Check" + }, + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "suggestedMigrationTool": { + "$ref": "#/definitions/SuggestedMigrationTool", + "description": "Gets suggested migration tool.", + "readOnly": true + } + }, + "required": [ + "readiness", + "suitability", + "failedChecks", + "suggestedMigrationTool" + ] + }, + "SummaryDetails": { + "type": "object", + "description": "Data model of Summary Details.", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Gets count.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets monthly cost.", + "readOnly": true + } + }, + "required": [ + "count", + "monthlyCost" + ] + }, + "SummaryPropertiesBase": { + "type": "object", + "description": "Base ARM model of Assessment Summary ARM properties.", + "properties": { + "assessmentName": { + "type": "string", + "description": "Gets the assessment name.", + "readOnly": true + }, + "summaryName": { + "type": "string", + "description": "Gets the summary name.", + "readOnly": true + }, + "suitabilityPerTarget": { + "type": "object", + "description": "Gets the cloud suitability summary for all entities in the assessment per target.", + "additionalProperties": { + "$ref": "#/definitions/RecordOfInt" + }, + "readOnly": true + }, + "monthlyComputeCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly compute cost.", + "readOnly": true + }, + "monthlyStorageCost": { + "type": "number", + "format": "float", + "description": "Gets the monthly storage cost.", + "readOnly": true + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Gets the confidence score.", + "readOnly": true + } + }, + "required": [ + "assessmentName", + "summaryName", + "suitabilityPerTarget", + "monthlyComputeCost", + "monthlyStorageCost", + "confidenceScore" + ] + }, + "SupportStatusDistribution": { + "type": "object", + "description": "Support Status Distribution.", + "properties": { + "unknownSupport": { + "type": "integer", + "format": "int32", + "description": "Unknown support.", + "readOnly": true + }, + "mainStream": { + "type": "integer", + "format": "int32", + "description": "Mainstream support.", + "readOnly": true + }, + "extended": { + "type": "integer", + "format": "int32", + "description": "Extended support.", + "readOnly": true + }, + "outOfSupport": { + "type": "integer", + "format": "int32", + "description": "Out of support.", + "readOnly": true + } + } + }, + "SupportabilityStatus": { + "type": "string", + "description": "Supportability Status.", + "enum": [ + "Unknown", + "Mainstream", + "Extended", + "OutOfSupport" + ], + "x-ms-enum": { + "name": "SupportabilityStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Supportability Status." + }, + { + "name": "Mainstream", + "value": "Mainstream", + "description": "Mainstream Supportability Status." + }, + { + "name": "Extended", + "value": "Extended", + "description": "Extended Supportability Status." + }, + { + "name": "OutOfSupport", + "value": "OutOfSupport", + "description": "OutOfSupport Supportability Status." + } + ] + } + }, + "TargetSpecificResult": { + "type": "object", + "description": "Target specific result.", + "properties": { + "assessmentResult": { + "$ref": "#/definitions/AssessmentResult", + "description": "Gets or sets the assessment result." + }, + "migrationIssues": { + "type": "array", + "description": "Gets or sets the web app migration issues.", + "items": { + "$ref": "#/definitions/WebAppMigrationIssues" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "assessmentResult", + "migrationIssues" + ] + }, + "TargetSpecificSummary": { + "type": "object", + "description": "Web app target specific summary data.", + "properties": { + "readinessSummary": { + "type": "object", + "description": "Web app readiness summary data", + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "readOnly": true + }, + "recommendationResultSkuDetails": { + "type": "object", + "description": "Web app recommendation sku details data", + "additionalProperties": { + "$ref": "#/definitions/WebAppSkuDetails" + }, + "readOnly": true + } + } + }, + "TargetType": { + "type": "string", + "enum": [ + "Unknown", + "Recommended", + "AzureSqlDatabase", + "AzureSqlManagedInstance", + "AzureSqlVirtualMachine", + "AzureVirtualMachine" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true + } + }, + "ThirdPartyManagementSettings": { + "type": "object", + "description": "Third Party Management settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "License Cost." + }, + "supportCost": { + "type": "number", + "format": "float", + "description": "Support Cost." + } + }, + "required": [ + "licenseCost", + "supportCost" + ] + }, + "TimeRange": { + "type": "string", + "description": "Time Range for Performance Data.", + "enum": [ + "Day", + "Week", + "Month", + "Custom" + ], + "x-ms-enum": { + "name": "TimeRange", + "modelAsString": true, + "values": [ + { + "name": "Day", + "value": "Day", + "description": "Daily." + }, + { + "name": "Week", + "value": "Week", + "description": "Weekly." + }, + { + "name": "Month", + "value": "Month", + "description": "Monthly." + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom Time Range." + } + ] + } + }, + "UltraDiskAssessmentOptions": { + "type": "object", + "description": "Assessment options for Ultra disk type.", + "properties": { + "familyName": { + "type": "string", + "description": "Family name." + }, + "targetLocations": { + "type": "array", + "description": "List of locations where ultra disk is supported for this VMfamily.", + "items": { + "type": "string" + } + } + } + }, + "UpdateGroupBody": { + "type": "object", + "description": "Properties of group update.", + "properties": { + "eTag": { + "type": "string", + "description": "For optimistic concurrency control." + }, + "properties": { + "$ref": "#/definitions/GroupBodyProperties", + "description": "Properties of the group." + } + } + }, + "UtilizationData": { + "type": "object", + "description": "The SQL on premises utilization insights.", + "properties": { + "numberOfActiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of active entities.", + "readOnly": true + }, + "numberOfInactiveEntities": { + "type": "integer", + "format": "int32", + "description": "The number of inactive entities.", + "readOnly": true + }, + "numberOfDecommisionEntities": { + "type": "integer", + "format": "int32", + "description": "The number of decommission entities.", + "readOnly": true + }, + "numberOfUnknownEntities": { + "type": "integer", + "format": "int32", + "description": "The number of unknown entities.", + "readOnly": true + } + } + }, + "VirtualizationSoftwareSettings": { + "type": "object", + "description": "Virtualization software settings.", + "properties": { + "numberOfPhysicalCoresPerLicense": { + "type": "integer", + "format": "int32", + "description": "Number of physical cores per licence.", + "minimum": 1 + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software Assurance cost." + }, + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "numberOfPhysicalCoresPerLicense", + "softwareAssuranceCost", + "licenseAndSupportList" + ] + }, + "VmFamilyOptions": { + "type": "object", + "description": "VM family name, the list of targeted azure locations and the category of the\nfamily.", + "properties": { + "familyName": { + "type": "string", + "description": "Name of the VM family.", + "readOnly": true + }, + "targetLocations": { + "type": "array", + "description": "List of Azure regions.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "category": { + "type": "array", + "description": "Category of the VM family.", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "VmUptime": { + "type": "object", + "description": "Details on the total up-time for the VM.", + "properties": { + "daysPerMonth": { + "type": "integer", + "format": "int32", + "description": "Number of days in a month for VM uptime." + }, + "hoursPerDay": { + "type": "integer", + "format": "int32", + "description": "Number of hours per day for VM uptime." + } + } + }, + "VmwareCollector": { + "type": "object", + "description": "VMware collector resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CollectorPropertiesBaseWithAgent", + "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/ProxyResource" + } + ] + }, + "VmwareCollectorListResult": { + "type": "object", + "description": "The response of a VmwareCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VmwareCollector items on this page", + "items": { + "$ref": "#/definitions/VmwareCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VsphereLicense": { + "type": "object", + "description": "Representation of a vsphere licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/LicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereLicenseBase": { + "type": "object", + "description": "Representation of a vsphere licence base.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Cost of a licence." + }, + "basicSupportCost": { + "type": "number", + "format": "float", + "description": "Basic support cost." + }, + "productionSupportCost": { + "type": "number", + "format": "float", + "description": "Production support cost." + } + }, + "required": [ + "licenseCost", + "basicSupportCost", + "productionSupportCost" + ] + }, + "VsphereManagementLicense": { + "type": "object", + "description": "Representation of a vsphere management licence.", + "properties": { + "licenseType": { + "$ref": "#/definitions/VsphereManagementLicenseType", + "description": "VSphere licence type." + } + }, + "required": [ + "licenseType" + ], + "allOf": [ + { + "$ref": "#/definitions/VsphereLicenseBase" + } + ] + }, + "VsphereManagementLicenseType": { + "type": "string", + "description": "Business case supported Vsphere Management License types.", + "enum": [ + "Unknown", + "VSphereServerStandard" + ], + "x-ms-enum": { + "name": "VsphereManagementLicenseType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown License." + }, + { + "name": "VSphereServerStandard", + "value": "VSphereServerStandard", + "description": "VSphereServerStandard License." + } + ] + } + }, + "VsphereManagementSettings": { + "type": "object", + "description": "Vsphere management settings.", + "properties": { + "licenseAndSupportList": { + "type": "array", + "description": "Licence and support list.", + "items": { + "$ref": "#/definitions/VsphereManagementLicense" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "licenseAndSupportList" + ] + }, + "WebApp": { + "type": "object", + "description": "Data model of Web App.", + "properties": { + "discoveryArmId": { + "type": "string", + "description": "Gets discovery arm id.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Gets display name.", + "readOnly": true + }, + "webServerArmId": { + "type": "string", + "description": "Gets web server arm id.", + "readOnly": true + }, + "webServerDisplayName": { + "type": "string", + "description": "Gets web server display name.", + "readOnly": true + }, + "machineArmId": { + "type": "string", + "description": "Gets machine arm id.", + "readOnly": true + }, + "machineDisplayName": { + "type": "string", + "description": "Gets machine display name.", + "readOnly": true + }, + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets web app type.", + "readOnly": true + } + }, + "required": [ + "discoveryArmId", + "displayName", + "webServerArmId", + "webServerDisplayName", + "machineArmId", + "machineDisplayName", + "webAppType" + ] + }, + "WebAppAssessmentOptions": { + "type": "object", + "description": "Web app Assessment options web model object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentOptionsProperties", + "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/ProxyResource" + } + ] + }, + "WebAppAssessmentOptionsListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentOptions list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentOptions items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentOptions" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentOptionsProperties": { + "type": "object", + "description": "Web app Assessment options properties Web model object.", + "properties": { + "webAppSkus": { + "type": "array", + "description": "Gets the list of web app target options.", + "items": { + "$ref": "#/definitions/WebAppTargetOptions" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Saving Plans for IAAS.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedLocations": { + "type": "array", + "description": "Gets or sets the list of Azure locations supporting Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedCurrencies": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureCurrency" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedOffers": { + "type": "array", + "description": "Gets or sets the list of offers supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureOfferCode" + }, + "x-ms-identifiers": [] + }, + "reservedInstanceSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of currencies supported for Reserved Instances.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + }, + "savingsPlanSupportedWebAppTiers": { + "type": "array", + "description": "Gets or sets the list of Azure Offers supporting Saving Plans.", + "items": { + "$ref": "#/definitions/AzureWebAppTier" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppAssessmentV2": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2Properties", + "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/ProxyResource" + } + ] + }, + "WebAppAssessmentV2ListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2Properties": { + "type": "object", + "description": "Web app assessment properties class.", + "properties": { + "environmentType": { + "$ref": "#/definitions/EnvironmentType", + "description": "Gets or sets user configurable setting to display the environment type." + }, + "entityUptime": { + "$ref": "#/definitions/EntityUptime", + "description": "Gets or sets the duration for which the entity (Web app, VMs) are up in the\non-premises environment." + }, + "eaSubscriptionId": { + "type": "string", + "description": "Gets or sets the Enterprise agreement subscription id." + }, + "appSvcNativeSettings": { + "$ref": "#/definitions/AppSvcNativeSettings", + "description": "Gets or sets user configurable app service native settings." + }, + "appSvcContainerSettings": { + "$ref": "#/definitions/AppSvcContainerSettings", + "description": "Gets or sets user configurable app service container database settings." + }, + "discoveredEntityLightSummary": { + "$ref": "#/definitions/DiscoveredEntityLightSummary", + "description": "Gets or sets user configurable discovered entity settings." + }, + "azureSecurityOfferingType": { + "$ref": "#/definitions/AzureSecurityOfferingType", + "description": "Gets or sets a value indicating azure security offering type." + }, + "reservedInstance": { + "$ref": "#/definitions/AzureReservedInstance", + "description": "Reserved instance." + }, + "groupType": { + "$ref": "#/definitions/GroupType", + "description": "Gets the group type for the assessment." + }, + "assessmentType": { + "$ref": "#/definitions/AssessmentType", + "description": "Assessment type of the assessment." + }, + "azureLocation": { + "type": "string", + "description": "Azure Location or Azure region where to which the machines will be migrated." + }, + "azureOfferCode": { + "$ref": "#/definitions/AzureOfferCode", + "description": "Azure Offer Code." + }, + "currency": { + "$ref": "#/definitions/AzureCurrency", + "description": "Currency in which prices should be reported." + }, + "scalingFactor": { + "type": "number", + "format": "float", + "description": "Percentage of buffer that user wants on performance metrics when recommending\nAzure sizes." + }, + "percentile": { + "$ref": "#/definitions/Percentile", + "description": "Percentile of the utilization data values to be considered while assessing\nmachines." + }, + "timeRange": { + "$ref": "#/definitions/TimeRange", + "description": "Time Range for which the historic utilization data should be considered for\nassessment." + }, + "perfDataStartTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the start time to consider performance data for assessment." + }, + "perfDataEndTime": { + "type": "string", + "format": "date-time", + "description": "Gets or sets the end time to consider performance data for assessment." + }, + "stage": { + "$ref": "#/definitions/AssessmentStage", + "description": "User configurable setting to display the Stage of Assessment.", + "readOnly": true + }, + "discountPercentage": { + "type": "number", + "format": "float", + "description": "Custom discount percentage." + }, + "sizingCriterion": { + "$ref": "#/definitions/AssessmentSizingCriterion", + "description": "Assessment sizing criterion." + }, + "confidenceRatingInPercentage": { + "type": "number", + "format": "float", + "description": "Confidence Rating in Percentage." + }, + "pricesTimestamp": { + "type": "string", + "format": "date-time", + "description": "Last time when rates were queried.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Date and Time when assessment was last updated.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/AssessmentStatus", + "description": "Whether assessment is in valid state and all machines have been assessed.", + "readOnly": true + }, + "schemaVersion": { + "type": "string", + "description": "Schema version.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppAssessmentV2Summary": { + "type": "object", + "description": "Web app Assessment REST resource.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppAssessmentV2SummaryProperties", + "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/ProxyResource" + } + ] + }, + "WebAppAssessmentV2SummaryListResult": { + "type": "object", + "description": "The response of a WebAppAssessmentV2Summary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppAssessmentV2Summary items on this page", + "items": { + "$ref": "#/definitions/WebAppAssessmentV2Summary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppAssessmentV2SummaryProperties": { + "type": "object", + "description": "Web app Assessment V2 summary properties.", + "properties": { + "assessmentSummary": { + "type": "object", + "description": "Gets or sets the discovered entities summary.", + "additionalProperties": { + "$ref": "#/definitions/DiscoveredEntitiesSummary" + }, + "readOnly": true + }, + "targetSpecificSummary": { + "type": "object", + "description": "Gets the target specific summary.", + "additionalProperties": { + "$ref": "#/definitions/TargetSpecificSummary" + }, + "readOnly": true + } + } + }, + "WebAppCollector": { + "type": "object", + "description": "The web app collector REST object.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppCollectorPropertiesBaseWithAgent", + "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/ProxyResource" + } + ] + }, + "WebAppCollectorListResult": { + "type": "object", + "description": "The response of a WebAppCollector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppCollector items on this page", + "items": { + "$ref": "#/definitions/WebAppCollector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppCollectorPropertiesBaseWithAgent": { + "type": "object", + "description": "Collector properties class.", + "properties": { + "agentProperties": { + "$ref": "#/definitions/CollectorAgentPropertiesBase", + "description": "Gets or sets the collector agent properties." + }, + "discoverySiteId": { + "type": "string", + "description": "Gets the discovery site id." + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "Gets the Timestamp when collector was created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "Timestamp when collector was last updated.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceProperties2" + } + ] + }, + "WebAppDistribution": { + "type": "object", + "description": "The app type distribution.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppTypes", + "description": "WebApp type.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + } + } + }, + "WebAppMigrationIssues": { + "type": "object", + "description": "Web app migration issues.", + "properties": { + "issueId": { + "type": "string", + "description": "Gets or sets the issue Id." + }, + "issueCategory": { + "$ref": "#/definitions/AzureWebAppSuitabilityIssueCategory", + "description": "Gets or sets the issue category." + }, + "issueDescriptionList": { + "type": "array", + "description": "Gets or sets the issue description list.", + "items": { + "type": "string" + } + } + }, + "required": [ + "issueId", + "issueCategory", + "issueDescriptionList" + ] + }, + "WebAppServicePlanV2": { + "type": "object", + "description": "Assessed Web app web model class.", + "properties": { + "properties": { + "$ref": "#/definitions/WebAppServicePlanV2Properties", + "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/ProxyResource" + } + ] + }, + "WebAppServicePlanV2ListResult": { + "type": "object", + "description": "The response of a WebAppServicePlanV2 list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WebAppServicePlanV2 items on this page", + "items": { + "$ref": "#/definitions/WebAppServicePlanV2" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WebAppServicePlanV2Properties": { + "type": "object", + "description": "Assessed Web app database properties web model.", + "properties": { + "webAppType": { + "$ref": "#/definitions/WebAppType", + "description": "Gets or sets the web app type.", + "readOnly": true + }, + "webAppTargetType": { + "$ref": "#/definitions/AzureWebAppTargetType", + "description": "Gets or sets the target specific result.", + "readOnly": true + }, + "webAppServicePlanName": { + "type": "string", + "description": "Gets or sets the app service plan name.", + "readOnly": true + }, + "numberOfWebApps": { + "type": "integer", + "format": "int32", + "description": "Gets the machine name.", + "readOnly": true + }, + "monthlyCost": { + "type": "number", + "format": "float", + "description": "Gets or sets the server ARM Id.", + "readOnly": true + }, + "storage": { + "type": "number", + "format": "double", + "description": "Gets or sets the web server name.", + "readOnly": true + }, + "scaleOutInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets web app name.", + "readOnly": true + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Gets the discovered web app ID.", + "readOnly": true + }, + "ram": { + "type": "number", + "format": "double", + "description": "Machine arm id.", + "readOnly": true + }, + "webAppSkuName": { + "type": "string", + "description": "Web app sku name.", + "readOnly": true + }, + "webAppSkuSize": { + "type": "string", + "description": "Web app sku size.", + "readOnly": true + }, + "createdTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed SQL database first created.", + "readOnly": true + }, + "updatedTimestamp": { + "type": "string", + "format": "date-time", + "description": "When was assessed Web app database last updated.", + "readOnly": true + }, + "costComponents": { + "type": "array", + "description": "Cost components.", + "items": { + "$ref": "#/definitions/CostComponent" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "webAppServicePlanName", + "numberOfWebApps" + ] + }, + "WebAppSkuDetails": { + "type": "object", + "description": "Web app sku details.", + "properties": { + "totalMonthlyCost": { + "type": "number", + "format": "float", + "description": "Total monthly cost", + "readOnly": true + }, + "monthlySecurityCost": { + "type": "number", + "format": "float", + "description": "Monthly security data", + "readOnly": true + }, + "skuName": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "skuSize": { + "type": "string", + "description": "Sku size", + "readOnly": true + }, + "appServicePlanCount": { + "type": "integer", + "format": "int32", + "description": "App service plan count", + "readOnly": true + } + }, + "required": [ + "skuName", + "skuSize", + "appServicePlanCount" + ] + }, + "WebAppTargetOptions": { + "type": "object", + "description": "Web app target options.", + "properties": { + "webAppTier": { + "$ref": "#/definitions/AzureWebAppTier", + "description": "Gets or sets the Azure web app tier." + }, + "targetLocations": { + "type": "array", + "description": "Gets or sets the target location.", + "items": { + "$ref": "#/definitions/AzureLocation" + }, + "x-ms-identifiers": [] + } + } + }, + "WebAppTargetSku": { + "type": "object", + "description": "The Webapp target SKU with corresponding cost.", + "properties": { + "skuName": { + "type": "string", + "description": "The SKU name.", + "readOnly": true + }, + "cost": { + "type": "number", + "format": "float", + "description": "The cost details.", + "readOnly": true + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of service plans or node pools recommended.", + "readOnly": true + } + } + }, + "WebAppType": { + "type": "string", + "description": "Web App Type.", + "enum": [ + "Unknown", + "IIS", + "Tomcat" + ], + "x-ms-enum": { + "name": "WebAppType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown. Indicates Missing Data." + }, + { + "name": "IIS", + "value": "IIS", + "description": "ASP.NET Web App." + }, + { + "name": "Tomcat", + "value": "Tomcat", + "description": "Java Web App." + } + ] + } + }, + "WebAppTypes": { + "type": "string", + "description": "Business case supported WebApp types.", + "enum": [ + "Unknown", + "ASPNET", + "Java" + ], + "x-ms-enum": { + "name": "WebAppTypes", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown WebApp Type." + }, + { + "name": "ASPNET", + "value": "ASPNET", + "description": "ASPNET Type." + }, + { + "name": "Java", + "value": "Java", + "description": "Java Tomcat Type." + } + ] + } + }, + "WindowsServerLicensingSettings": { + "type": "object", + "description": "Windows Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + }, + "softwareAssuranceCost": { + "type": "number", + "format": "float", + "description": "Software assurance (SA) cost." + }, + "licensesPerCore": { + "type": "integer", + "format": "int32", + "description": "Licenses per core." + } + }, + "required": [ + "licenseCost", + "softwareAssuranceCost", + "licensesPerCore" + ] + }, + "LinuxServerLicensingSettings": { + "type": "object", + "description": "Linux Server licensing settings.", + "properties": { + "licenseCost": { + "type": "number", + "format": "float", + "description": "Licence Cost." + } + }, + "required": [ + "licenseCost" + ] + }, + "WorkloadSummary": { + "type": "object", + "description": "Workload summary.", + "properties": { + "oracleInstances": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + }, + "springApps": { + "type": "integer", + "format": "int32", + "description": "Gets or sets oracle databases." + } + } + }, + "YearOnYearEstimates": { + "type": "object", + "description": "Shows the year-on-year cost overall.", + "properties": { + "onPremisesCost": { + "type": "object", + "description": "Year-on-Year on-premises cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCost": { + "type": "object", + "description": "Year-on-Year Azure cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "savings": { + "type": "object", + "description": "Year-on-Year savings.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesCapexCost": { + "type": "object", + "description": "Year-on-Year on-premises capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "onPremisesOpexCost": { + "type": "object", + "description": "Year-on-Year on-premises opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureCapexCost": { + "type": "object", + "description": "Year-on-Year azure capex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "azureOpexCost": { + "type": "object", + "description": "Year-on-Year azure opex cost.", + "additionalProperties": { + "format": "float", + "type": "number" + }, + "readOnly": true + }, + "paybackPeriod": { + "type": "integer", + "format": "int32", + "description": "Payback period.", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/migrate/resource-manager/readme.md b/specification/migrate/resource-manager/readme.md index c0c31959e15f..54876c5524c4 100644 --- a/specification/migrate/resource-manager/readme.md +++ b/specification/migrate/resource-manager/readme.md @@ -20,6 +20,22 @@ batch: - tag: package-migrateengine-2022-05 ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` + ### Tag: package-migrate-2023-04 These settings apply only when `--tag=package-migrate-2023-04` is specified on the command line. @@ -40,6 +56,7 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` + ### Tag: package-2023-06 These settings apply only when `--tag=package-2023-06` is specified on the command line. @@ -202,6 +219,21 @@ These settings apply only when `--tag=package-preview-2023-10` is specified on t input-file: - Microsoft.OffAzure/preview/2023-10-01-preview/migrate.json ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/migrate.json +suppressions: + - code: AvoidAdditionalProperties + reason: Migrate feature is widely adopted and requires additionalProperties for these swagger properties. + - code: ProvisioningStateMustBeReadOnly + reason: The current swagger version only modifies the resources which do not have Provisioning states as readOnly and not introducing any new Resources, These are incorrectly flagged for previous versions. + - code: UnSupportedPatchProperties + reason: There is no patch operation that is introduced in this swagger version where it is not readOnly. This is incorrectly flagged for previous versions. +``` ### Tag: package-migrate-2023-03 diff --git a/specification/migrate/resource-manager/suppressions.yaml b/specification/migrate/resource-manager/suppressions.yaml new file mode 100644 index 000000000000..b421d614e1d1 --- /dev/null +++ b/specification/migrate/resource-manager/suppressions.yaml @@ -0,0 +1,7 @@ +- tool: TypeSpecRequirement + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Preview version, TypeScript will be added soon + +- tool: TagsAreNotAllowedForProxyResources + path: Microsoft.Migrate/AssessmentProjects/preview/2023-05-01-preview/**/*.json + reason: Adding this supression as this is a false positive alert \ No newline at end of file From e6fde2ac19d0202f0e72217a3e0f9edb63dba273 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Fri, 27 Sep 2024 14:37:42 +0800 Subject: [PATCH 005/101] remove examples-dir from python tspconfig (#30768) --- specification/ai/DocumentIntelligence/tspconfig.yaml | 1 - specification/ai/Face/tspconfig.yaml | 1 - .../HealthInsights.RadiologyInsights/tspconfig.yaml | 1 - specification/ai/ImageAnalysis/tspconfig.yaml | 1 - specification/apicenter/ApiCenter.DataApi/tspconfig.yaml | 1 - specification/appconfiguration/AppConfiguration/tspconfig.yaml | 1 - .../ApplicationInsights.LiveMetrics/tspconfig.yaml | 1 - specification/azurefleet/AzureFleet.Management/tspconfig.yaml | 1 - specification/batch/Azure.Batch/tspconfig.yaml | 1 - specification/cognitiveservices/ContentSafety/tspconfig.yaml | 1 - .../communication/Communication.JobRouter/tspconfig.yaml | 1 - .../communication/Communication.Messages/tspconfig.yaml | 1 - .../computeschedule/ComputeSchedule.Management/tspconfig.yaml | 1 - .../confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.Management/tspconfig.yaml | 1 - .../contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml | 1 - specification/devcenter/DevCenter/tspconfig.yaml | 1 - .../Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml | 1 - specification/edgezones/EdgeZones.Management/tspconfig.yaml | 1 - .../Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml | 1 - specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml | 1 - specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml | 1 - .../HealthDataAIServices.DeidServices/tspconfig.yaml | 1 - .../HealthDataAIServices.Management/tspconfig.yaml | 1 - .../iotoperations/IoTOperations.Management/tspconfig.yaml | 1 - .../KubernetesRuntime.Management/tspconfig.yaml | 1 - specification/loadtestservice/LoadTestService/tspconfig.yaml | 1 - .../machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml | 1 - .../machinelearningservices/AzureAI.Assets/tspconfig.yaml | 1 - .../DocumentDB.MongoCluster.Management/tspconfig.yaml | 1 - .../Azure.ProgrammableConnectivity/tspconfig.yaml | 1 - .../purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml | 1 - specification/schemaregistry/SchemaRegistry/tspconfig.yaml | 1 - specification/standbypool/StandbyPool.Management/tspconfig.yaml | 1 - .../translation/Azure.AI.DocumentTranslation/tspconfig.yaml | 1 - .../translation/Azure.AI.TextTranslation/tspconfig.yaml | 1 - specification/trustedsigning/TrustedSigning/tspconfig.yaml | 1 - 37 files changed, 37 deletions(-) diff --git a/specification/ai/DocumentIntelligence/tspconfig.yaml b/specification/ai/DocumentIntelligence/tspconfig.yaml index 42384ac0413f..35640ce9b98c 100644 --- a/specification/ai/DocumentIntelligence/tspconfig.yaml +++ b/specification/ai/DocumentIntelligence/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-documentintelligence" namespace: "com.azure.ai.documentintelligence" diff --git a/specification/ai/Face/tspconfig.yaml b/specification/ai/Face/tspconfig.yaml index 69333ed57336..5096759efa37 100644 --- a/specification/ai/Face/tspconfig.yaml +++ b/specification/ai/Face/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.Face" namespace: "{package-dir}" diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml index 8c105bfcd188..ef2b0ce1efdd 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -34,7 +34,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-health-insights-radiologyinsights" namespace: com.azure.health.insights.radiologyinsights diff --git a/specification/ai/ImageAnalysis/tspconfig.yaml b/specification/ai/ImageAnalysis/tspconfig.yaml index 968e244f118a..ec72fc3eb5af 100644 --- a/specification/ai/ImageAnalysis/tspconfig.yaml +++ b/specification/ai/ImageAnalysis/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.Vision.ImageAnalysis" namespace: "Azure.AI.Vision.ImageAnalysis" diff --git a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml index ed4d3f2e24f2..be755eb76687 100644 --- a/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml +++ b/specification/apicenter/ApiCenter.DataApi/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "azure.ApiCenter" namespace: "{package-dir}" diff --git a/specification/appconfiguration/AppConfiguration/tspconfig.yaml b/specification/appconfiguration/AppConfiguration/tspconfig.yaml index 5d2c31b98df7..984363d3eec1 100644 --- a/specification/appconfiguration/AppConfiguration/tspconfig.yaml +++ b/specification/appconfiguration/AppConfiguration/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Data.AppConfiguration" namespace: "{package-dir}" diff --git a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml index 1cf18afadc77..0c70abc1f25b 100644 --- a/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml +++ b/specification/applicationinsights/ApplicationInsights.LiveMetrics/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "LiveMetrics" namespace: "{package-dir}" diff --git a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml index 860e37107159..f75c6fb91687 100644 --- a/specification/azurefleet/AzureFleet.Management/tspconfig.yaml +++ b/specification/azurefleet/AzureFleet.Management/tspconfig.yaml @@ -30,7 +30,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-computefleet" diff --git a/specification/batch/Azure.Batch/tspconfig.yaml b/specification/batch/Azure.Batch/tspconfig.yaml index 024a4b79b0dc..1c66dcb9fc9e 100644 --- a/specification/batch/Azure.Batch/tspconfig.yaml +++ b/specification/batch/Azure.Batch/tspconfig.yaml @@ -31,7 +31,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "batch-rest" packageDetails: diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index 565abdc7cc74..e1b159922293 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -21,7 +21,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.AI.ContentSafety" namespace: "{package-dir}" diff --git a/specification/communication/Communication.JobRouter/tspconfig.yaml b/specification/communication/Communication.JobRouter/tspconfig.yaml index 5bbf6cf62172..eaac1149894e 100644 --- a/specification/communication/Communication.JobRouter/tspconfig.yaml +++ b/specification/communication/Communication.JobRouter/tspconfig.yaml @@ -43,7 +43,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-communication-jobrouter" package-dir: "azure-communication-jobrouter" diff --git a/specification/communication/Communication.Messages/tspconfig.yaml b/specification/communication/Communication.Messages/tspconfig.yaml index efa014db6fba..d6f5bcff1caf 100644 --- a/specification/communication/Communication.Messages/tspconfig.yaml +++ b/specification/communication/Communication.Messages/tspconfig.yaml @@ -44,7 +44,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-communication-messages" namespace: com.azure.communication.messages diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index c73e44824afb..0c5a91d3e011 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -14,7 +14,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.ResourceManager.ComputeSchedule" flavor: azure diff --git a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml index 3f7eb764893a..4b9dc7e146de 100644 --- a/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml +++ b/specification/confidentialledger/Microsoft.CodeTransparency/tspconfig.yaml @@ -20,7 +20,6 @@ options: models-mode: none generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": flavor: azure package-dir: "Azure.Security.CodeTransparency" diff --git a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml index d952a53f56e2..23b54895ca02 100644 --- a/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-contoso" diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml index 93dd9d6f2085..2633b3a76f34 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: azure "@azure-tools/typespec-csharp": package-dir: "Azure.Template.Contoso" diff --git a/specification/devcenter/DevCenter/tspconfig.yaml b/specification/devcenter/DevCenter/tspconfig.yaml index 476f295d6a7a..49e16784c6ee 100644 --- a/specification/devcenter/DevCenter/tspconfig.yaml +++ b/specification/devcenter/DevCenter/tspconfig.yaml @@ -26,7 +26,6 @@ options: api-version: "2023-04-01" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": title: "Azure Developer DevCenter" package-dir: "developer-devcenter-rest" diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml index a6de4688fc7d..6418c4fbe07c 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-devopsinfrastructure" flavor: "azure" diff --git a/specification/edgezones/EdgeZones.Management/tspconfig.yaml b/specification/edgezones/EdgeZones.Management/tspconfig.yaml index 87cf3b8931b1..59af0f9180d3 100644 --- a/specification/edgezones/EdgeZones.Management/tspconfig.yaml +++ b/specification/edgezones/EdgeZones.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" flavor: "azure" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-edgezones" diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml index 970d52f81e55..89e62a45f20a 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGrid.SystemEvents diff --git a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml index 8477281bc07d..62693d4eb767 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml +++ b/specification/eventgrid/Azure.Messaging.EventGrid/tspconfig.yaml @@ -24,7 +24,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # Uncomment this line and add "@azure-tools/typespec-csharp" to your package.json to generate C# code "@azure-tools/typespec-csharp": package-dir: Azure.Messaging.EventGridV2 diff --git a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml index f9653224cf9d..6d8ba54dd4eb 100644 --- a/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml +++ b/specification/fabric/Microsoft.Fabric.Management/tspconfig.yaml @@ -23,7 +23,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": azureSdkForJs: true isModularLibrary: true diff --git a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml index 2890f991aec3..d9da9d92e438 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.DeidServices/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Health.Deidentification" namespace: "{package-dir}" diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml index f45ad94de92c..b007e798dedd 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/tspconfig.yaml @@ -21,7 +21,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-healthdataaiservices" flavor: "azure" diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index 708bdfee191a..d28a739a8e06 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index bdfdb8ce28c5..8f4556678620 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: diff --git a/specification/loadtestservice/LoadTestService/tspconfig.yaml b/specification/loadtestservice/LoadTestService/tspconfig.yaml index 9c621ebbaced..bc6f069f006f 100644 --- a/specification/loadtestservice/LoadTestService/tspconfig.yaml +++ b/specification/loadtestservice/LoadTestService/tspconfig.yaml @@ -28,7 +28,6 @@ options: package-name: "{package-dir}" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" # emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" package-mode: azure-dataplane flavor: azure diff --git a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml index 04f2db45305a..af95819fba18 100644 --- a/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml +++ b/specification/machinelearning/Azure.AI.ChatProtocol/tspconfig.yaml @@ -27,7 +27,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-ts": package-dir: "ai-chat-protocol" isModularLibrary: true diff --git a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml index 64ee3f8728e1..eba014716a1c 100644 --- a/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml +++ b/specification/machinelearningservices/AzureAI.Assets/tspconfig.yaml @@ -16,7 +16,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml index 963bdd54531f..db2c9f14c801 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/tspconfig.yaml @@ -15,7 +15,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-resourcemanager-mongocluster" flavor: "azure" diff --git a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml index fe41d662bb95..e56bf1a91ef3 100644 --- a/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml +++ b/specification/programmableconnectivity/Azure.ProgrammableConnectivity/tspconfig.yaml @@ -25,7 +25,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" linter: extends: - "@azure-tools/typespec-azure-rulesets/data-plane" diff --git a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml index 3742712d1b88..db2051ab2039 100644 --- a/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml +++ b/specification/purview/Azure.Analytics.Purview.DataMap/tspconfig.yaml @@ -20,7 +20,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": package-dir: "Azure.Analytics.Purview.DataMap" namespace: "{package-dir}" diff --git a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml index 4ecd71e8a0ba..666346bbfdcc 100644 --- a/specification/schemaregistry/SchemaRegistry/tspconfig.yaml +++ b/specification/schemaregistry/SchemaRegistry/tspconfig.yaml @@ -23,7 +23,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-data-schemaregistry" namespace: com.azure.data.schemaregistry diff --git a/specification/standbypool/StandbyPool.Management/tspconfig.yaml b/specification/standbypool/StandbyPool.Management/tspconfig.yaml index 09ee2ea103a3..42e761955bfb 100644 --- a/specification/standbypool/StandbyPool.Management/tspconfig.yaml +++ b/specification/standbypool/StandbyPool.Management/tspconfig.yaml @@ -46,7 +46,6 @@ options: flavor: "azure" generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-go": service-dir: "sdk/resourcemanager/standbypool" package-dir: "armstandbypool" diff --git a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml index 5c2fcb0cef11..fbe351d6711b 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml @@ -31,7 +31,6 @@ options: generate-sample-project: false generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-document" namespace: com.azure.ai.translation.document diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index 8967858b9ba9..e1112abc09d8 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -29,7 +29,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-java": package-dir: "azure-ai-translation-text" namespace: com.azure.ai.translation.text diff --git a/specification/trustedsigning/TrustedSigning/tspconfig.yaml b/specification/trustedsigning/TrustedSigning/tspconfig.yaml index 25463f0e28f1..9445b6b1401c 100644 --- a/specification/trustedsigning/TrustedSigning/tspconfig.yaml +++ b/specification/trustedsigning/TrustedSigning/tspconfig.yaml @@ -19,7 +19,6 @@ options: flavor: azure generate-test: true generate-sample: true - examples-dir: "{project-root}/examples" "@azure-tools/typespec-csharp": clear-output-folder: true package-dir: "Azure.Developer.TrustedSigning" From 30ec6607bbcbeceb13b634de955667c5aa45766a Mon Sep 17 00:00:00 2001 From: rishavMS <99256759+rishavMS@users.noreply.github.com> Date: Fri, 27 Sep 2024 16:46:39 +0530 Subject: [PATCH 006/101] BilingRP subscrption api swagger update for offerId for 2024-04-01 (#30721) --- .../stable/2024-04-01/billingSubscription.json | 2 +- .../examples/billingSubscriptionsListByBillingProfileEA.json | 1 + .../examples/billingSubscriptionsListByEnrollmentAccount.json | 2 ++ 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json index 976b7926e0e9..a0ee06a94b7a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/billingSubscription.json @@ -1544,7 +1544,7 @@ "$ref": "#/definitions/NextBillingCycleDetails" }, "offerId": { - "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts.", + "description": "The offer ID for the subscription. This field is only available for the Microsoft Online Services Program billing accounts or billing accounts with agreement type Enterprise Agreement.", "type": "string", "readOnly": true }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json index d84a83a85a99..429e2bb6e50a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByBillingProfileEA.json @@ -17,6 +17,7 @@ "displayName": "My Subscription", "enrollmentAccountId": "172988", "enrollmentAccountDisplayName": "billtest332211@outlook.com", + "offerId": "MS-AZR-0017P", "status": "Active", "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3" }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json index 3c5cab3ccedd..416d3f92d781 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/billingSubscriptionsListByEnrollmentAccount.json @@ -19,6 +19,7 @@ "enrollmentAccountSubscriptionDetails": { "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z" }, + "offerId": "MS-AZR-0017P", "subscriptionId": "90000000-0000-0000-0000-000000000000" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" @@ -35,6 +36,7 @@ "enrollmentAccountStartDate": "2023-01-04T00:00:00.0000000Z", "subscriptionEnrollmentAccountStatus": "Deleted" }, + "offerId": "MS-AZR-0136P", "subscriptionId": "90000000-0000-0000-0000-000000000001" }, "type": "Microsoft.Billing/billingAccounts/billingSubscriptions" From c43b644ce1f34a83dcf850a73daff5c460cbc524 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Fri, 27 Sep 2024 19:45:58 +0800 Subject: [PATCH 007/101] add directive for containerservice (#30772) --- .../Microsoft.ContainerService/aks/readme.typescript.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md index 288ba334a779..e33bbf8ae14b 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/readme.typescript.md @@ -9,4 +9,10 @@ typescript: package-name: "@azure/arm-containerservice" output-folder: "$(typescript-sdks-folder)/sdk/containerservice/arm-containerservice" generate-metadata: true + +directive: + - from: managedClusters.json + where: $.definitions.MachineIpAddress + transform: > + $.properties.family["x-ms-enum"].name = "IpFamily" ``` From 5c26c3b83ddc9b459d6eece1b3495d2a56bffa5a Mon Sep 17 00:00:00 2001 From: jamesvoongms <104241521+jamesvoongms@users.noreply.github.com> Date: Fri, 27 Sep 2024 09:15:59 -0700 Subject: [PATCH 008/101] DNS Resolver Release 2023-07-01-Preview with new DNS Security Policy feature (#30707) * Add new folder for 2023-07-01-preview with stable 2022-07-01 as the base * Add changes for new DNS security policy feature * Fix linting issues * Add readme changes * Fix autorest issue by changing from v2 to v5 in dnsresolver module --- .../2023-07-01-preview/dnsresolver.json | 2675 +++++++++++++++++ .../2023-07-01-preview/dnsresolverpolicy.json | 1828 +++++++++++ .../examples/DnsForwardingRuleset_Delete.json | 18 + .../examples/DnsForwardingRuleset_Get.json | 40 + ...ForwardingRuleset_ListByResourceGroup.json | 72 + ...sForwardingRuleset_ListBySubscription.json | 71 + ...orwardingRuleset_ListByVirtualNetwork.json | 25 + .../examples/DnsForwardingRuleset_Patch.json | 51 + .../examples/DnsForwardingRuleset_Put.json | 92 + .../DnsResolverDomainList_Delete.json | 17 + .../examples/DnsResolverDomainList_Get.json | 35 + ...esolverDomainList_ListByResourceGroup.json | 62 + ...ResolverDomainList_ListBySubscription.json | 61 + .../examples/DnsResolverDomainList_Patch.json | 51 + .../examples/DnsResolverDomainList_Put.json | 71 + ...solverPolicyVirtualNetworkLink_Delete.json | 18 + ...sResolverPolicyVirtualNetworkLink_Get.json | 35 + ...ResolverPolicyVirtualNetworkLink_List.json | 39 + ...esolverPolicyVirtualNetworkLink_Patch.json | 46 + ...sResolverPolicyVirtualNetworkLink_Put.json | 76 + .../examples/DnsResolverPolicy_Delete.json | 17 + .../examples/DnsResolverPolicy_Get.json | 32 + ...DnsResolverPolicy_ListByResourceGroup.json | 56 + .../DnsResolverPolicy_ListBySubscription.json | 55 + ...nsResolverPolicy_ListByVirtualNetwork.json | 20 + .../examples/DnsResolverPolicy_Patch.json | 43 + .../examples/DnsResolverPolicy_Put.json | 60 + .../examples/DnsResolver_Delete.json | 18 + .../examples/DnsResolver_Get.json | 36 + .../DnsResolver_ListByResourceGroup.json | 64 + .../DnsResolver_ListBySubscription.json | 63 + .../DnsResolver_ListByVirtualNetwork.json | 20 + .../examples/DnsResolver_Patch.json | 47 + .../examples/DnsResolver_Put.json | 73 + .../examples/DnsSecurityRule_Delete.json | 18 + .../examples/DnsSecurityRule_Get.json | 43 + .../examples/DnsSecurityRule_List.json | 77 + .../examples/DnsSecurityRule_Patch.json | 56 + .../examples/DnsSecurityRule_Put.json | 100 + .../examples/ForwardingRule_Delete.json | 13 + .../examples/ForwardingRule_Get.json | 43 + .../examples/ForwardingRule_List.json | 77 + .../examples/ForwardingRule_Patch.json | 51 + .../examples/ForwardingRule_Put.json | 94 + .../examples/InboundEndpoint_Delete.json | 19 + .../examples/InboundEndpoint_Get.json | 42 + .../examples/InboundEndpoint_List.json | 75 + .../examples/InboundEndpoint_Patch.json | 53 + .../examples/InboundEndpoint_Put.json | 95 + .../examples/OutboundEndpoint_Delete.json | 19 + .../examples/OutboundEndpoint_Get.json | 36 + .../examples/OutboundEndpoint_List.json | 63 + .../examples/OutboundEndpoint_Patch.json | 47 + .../examples/OutboundEndpoint_Put.json | 77 + .../examples/VirtualNetworkLink_Delete.json | 19 + .../examples/VirtualNetworkLink_Get.json | 34 + .../examples/VirtualNetworkLink_List.json | 38 + .../examples/VirtualNetworkLink_Patch.json | 47 + .../examples/VirtualNetworkLink_Put.json | 73 + .../dnsresolver/resource-manager/readme.md | 17 +- 60 files changed, 7310 insertions(+), 3 deletions(-) create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json create mode 100644 specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json new file mode 100644 index 000000000000..51f0c433eeee --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json @@ -0,0 +1,2675 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverManagementClient", + "description": "The DNS Resolver Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}": { + "put": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_CreateOrUpdate", + "description": "Creates or updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolver" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to upsert DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Upsert DNS resolver": { + "$ref": "./examples/DnsResolver_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Update", + "description": "Updates a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "202": { + "description": "The operation to update DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Update DNS resolver": { + "$ref": "./examples/DnsResolver_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Delete", + "description": "Deletes a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS resolver 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 DNS resolver": { + "$ref": "./examples/DnsResolver_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_Get", + "description": "Gets properties of a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver was found.", + "schema": { + "$ref": "#/definitions/DnsResolver" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver": { + "$ref": "./examples/DnsResolver_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByResourceGroup", + "description": "Lists DNS resolvers within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "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 DNS resolvers by resource group": { + "$ref": "./examples/DnsResolver_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolvers": { + "get": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_List", + "description": "Lists DNS resolvers in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolvers in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverListResult" + } + }, + "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 DNS resolvers by subscription": { + "$ref": "./examples/DnsResolver_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints/{inboundEndpointName}": { + "put": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The inbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Upsert inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Update", + "description": "Updates an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "202": { + "description": "The operation to update inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Update inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Delete", + "description": "Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete inbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The inbound endpoint for the DNS resolver 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 inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_Get", + "description": "Gets properties of an inbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/InboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The inbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve inbound endpoint for DNS resolver": { + "$ref": "./examples/InboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/inboundEndpoints": { + "get": { + "tags": [ + "InboundEndpoints" + ], + "operationId": "InboundEndpoints_List", + "description": "Lists inbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of inbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/InboundEndpointListResult" + } + }, + "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 inbound endpoints by DNS resolver": { + "$ref": "./examples/InboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints/{outboundEndpointName}": { + "put": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_CreateOrUpdate", + "description": "Creates or updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The outbound endpoint for the DNS resolver has been created.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to upsert outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Upsert outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Put.json" + } + } + }, + "patch": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Update", + "description": "Updates an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OutboundEndpointPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been updated.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "202": { + "description": "The operation to update outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "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": { + "Update outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Patch.json" + } + } + }, + "delete": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Delete", + "description": "Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver has been deleted." + }, + "202": { + "description": "The operation to delete outbound endpoint for the DNS resolver has been accepted and will complete asynchronously." + }, + "204": { + "description": "The outbound endpoint for the DNS resolver 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 outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Delete.json" + } + } + }, + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_Get", + "description": "Gets properties of an outbound endpoint for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "#/parameters/OutboundEndpointNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The outbound endpoint for the DNS resolver was found.", + "schema": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve outbound endpoint for DNS resolver": { + "$ref": "./examples/OutboundEndpoint_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolvers/{dnsResolverName}/outboundEndpoints": { + "get": { + "tags": [ + "OutboundEndpoints" + ], + "operationId": "OutboundEndpoints_List", + "description": "Lists outbound endpoints for a DNS resolver.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of outbound endpoints for the DNS resolver.", + "schema": { + "$ref": "#/definitions/OutboundEndpointListResult" + } + }, + "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 outbound endpoints by DNS resolver": { + "$ref": "./examples/OutboundEndpoint_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}": { + "put": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_CreateOrUpdate", + "description": "Creates or updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to upsert DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "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": { + "Upsert DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Update", + "description": "Updates a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "202": { + "description": "The operation to update DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "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": { + "Update DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Delete", + "description": "Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The DNS forwarding ruleset 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 DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_Get", + "description": "Gets a DNS forwarding ruleset properties.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve DNS forwarding ruleset": { + "$ref": "./examples/DnsForwardingRuleset_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByResourceGroup", + "description": "Lists DNS forwarding rulesets within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the resource group.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "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 DNS forwarding rulesets by resource group": { + "$ref": "./examples/DnsForwardingRuleset_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsForwardingRulesets": { + "get": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_List", + "description": "Lists DNS forwarding rulesets in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding rulesets in the subscription.", + "schema": { + "$ref": "#/definitions/DnsForwardingRulesetListResult" + } + }, + "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 DNS forwarding rulesets by subscription": { + "$ref": "./examples/DnsForwardingRuleset_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules/{forwardingRuleName}": { + "put": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_CreateOrUpdate", + "description": "Creates or updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The forwarding rule has been created.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Upsert forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Update", + "description": "Updates a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForwardingRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been updated.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Delete", + "description": "Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule has been deleted." + }, + "204": { + "description": "The forwarding rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_Get", + "description": "Gets properties of a forwarding rule in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/ForwardingRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The forwarding rule was found.", + "schema": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve forwarding rule in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/forwardingRules": { + "get": { + "tags": [ + "ForwardingRules" + ], + "operationId": "ForwardingRules_List", + "description": "Lists forwarding rules in a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of forwarding rules in the DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/ForwardingRuleListResult" + } + }, + "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 forwarding rules in a DNS forwarding ruleset": { + "$ref": "./examples/ForwardingRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks/{virtualNetworkLinkName}": { + "put": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The virtual network link to the DNS forwarding ruleset has been created.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to upsert virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "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": { + "Upsert virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Update", + "description": "Updates a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been updated.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "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": { + "Update virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Delete", + "description": "Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to the DNS forwarding ruleset has been deleted." + }, + "202": { + "description": "The operation to delete virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously." + }, + "204": { + "description": "The virtual network link to the DNS forwarding ruleset 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 virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_Get", + "description": "Gets properties of a virtual network link to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The virtual network link to DNS forwarding ruleset was found.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Retrieve virtual network link to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks": { + "get": { + "tags": [ + "VirtualNetworkLinks" + ], + "operationId": "VirtualNetworkLinks_List", + "description": "Lists virtual network links to a DNS forwarding ruleset.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsForwardingRulesetNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of virtual network links to a DNS forwarding ruleset.", + "schema": { + "$ref": "#/definitions/VirtualNetworkLinkListResult" + } + }, + "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 virtual network links to a DNS forwarding ruleset": { + "$ref": "./examples/VirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolvers": { + "post": { + "tags": [ + "DnsResolvers" + ], + "operationId": "DnsResolvers_ListByVirtualNetwork", + "description": "Lists DNS resolver resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "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 DNS resolvers by virtual network": { + "$ref": "./examples/DnsResolver_ListByVirtualNetwork.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsForwardingRulesets": { + "post": { + "tags": [ + "DnsForwardingRulesets" + ], + "operationId": "DnsForwardingRulesets_ListByVirtualNetwork", + "description": "Lists DNS forwarding ruleset resource IDs attached to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS forwarding ruleset resource IDs and virtual network link resource IDs attached to the virtual network.", + "schema": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRulesetListResult" + } + }, + "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 DNS forwarding rulesets by virtual network": { + "$ref": "./examples/DnsForwardingRuleset_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverProperties": { + "description": "Represents the properties of a DNS resolver.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "dnsResolverState": { + "description": "The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "type": "string", + "enum": [ + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "DnsResolverState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolver": { + "description": "Describes a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver.", + "$ref": "#/definitions/DnsResolverProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPatch": { + "description": "Describes a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsResolverListResult": { + "description": "The response to an enumeration operation on DNS resolvers.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolvers.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolver" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InboundEndpointProperties": { + "description": "Represents the properties of an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "ipConfigurations" + ], + "properties": { + "ipConfigurations": { + "description": "IP configurations for the inbound endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/IpConfiguration" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "description": "The current provisioning state of the inbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the inbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "InboundEndpoint": { + "description": "Describes an inbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the inbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the inbound endpoint.", + "$ref": "#/definitions/InboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InboundEndpointPatch": { + "description": "Describes an inbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for inbound endpoint." + } + } + }, + "InboundEndpointListResult": { + "description": "The response to an enumeration operation on inbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the inbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEndpointProperties": { + "description": "Represents the properties of an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet used for the outbound endpoint.", + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid property of the outbound endpoint resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "OutboundEndpoint": { + "description": "Describes an outbound endpoint for a DNS resolver.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the outbound endpoint.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the outbound endpoint.", + "$ref": "#/definitions/OutboundEndpointProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OutboundEndpointPatch": { + "description": "Describes an outbound endpoint for a DNS resolver for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for outbound endpoint." + } + } + }, + "OutboundEndpointListResult": { + "description": "The response to an enumeration operation on outbound endpoints for a DNS resolver.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the outbound endpoints for a DNS resolver.", + "type": "array", + "items": { + "$ref": "#/definitions/OutboundEndpoint" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRulesetProperties": { + "description": "Represents the properties of a DNS forwarding ruleset.", + "type": "object", + "required": [ + "dnsResolverOutboundEndpoints" + ], + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS forwarding ruleset. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + }, + "resourceGuid": { + "description": "The resourceGuid for the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + } + } + }, + "DnsForwardingRuleset": { + "description": "Describes a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS forwarding ruleset.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS forwarding ruleset.", + "$ref": "#/definitions/DnsForwardingRulesetProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsForwardingRulesetPatch": { + "description": "Describes a DNS forwarding ruleset PATCH operation.", + "type": "object", + "properties": { + "dnsResolverOutboundEndpoints": { + "description": "The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS Resolver." + } + } + }, + "DnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on DNS forwarding rulesets.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS forwarding rulesets.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ForwardingRuleProperties": { + "description": "Represents the properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "domainName", + "targetDnsServers" + ], + "properties": { + "domainName": { + "description": "The domain name for the forwarding rule.", + "type": "string" + }, + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the forwarding rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ForwardingRule": { + "description": "Describes a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the forwarding rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ForwardingRulePatchProperties": { + "description": "Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "targetDnsServers": { + "description": "DNS servers to forward the DNS query to.", + "type": "array", + "items": { + "$ref": "#/definitions/TargetDnsServer" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "description": "Metadata attached to the forwarding rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "forwardingRuleState": { + "type": "string", + "description": "The state of forwarding rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "x-ms-enum": { + "name": "ForwardingRuleState", + "modelAsString": true + } + } + } + }, + "ForwardingRulePatch": { + "description": "Describes a forwarding rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the forwarding rule.", + "$ref": "#/definitions/ForwardingRulePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ForwardingRuleListResult": { + "description": "The response to an enumeration operation on forwarding rules within a DNS forwarding ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the forwarding rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ForwardingRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkProperties": { + "description": "Represents the properties of a virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "$ref": "#/definitions/SubResource" + }, + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "VirtualNetworkLink": { + "description": "Describes a virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "VirtualNetworkLinkPatchProperties": { + "description": "Represents the updatable properties of the virtual network link.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata attached to the virtual network link.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualNetworkLinkPatch": { + "description": "Describes a virtual network link for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the virtual network link.", + "$ref": "#/definitions/VirtualNetworkLinkPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "IpConfiguration": { + "description": "IP configuration.", + "type": "object", + "required": [ + "subnet" + ], + "properties": { + "subnet": { + "description": "The reference to the subnet bound to the IP configuration.", + "$ref": "#/definitions/SubResource" + }, + "privateIpAddress": { + "description": "Private IP address of the IP configuration.", + "type": "string" + }, + "privateIpAllocationMethod": { + "description": "Private IP address allocation method.", + "type": "string", + "enum": [ + "Static", + "Dynamic" + ], + "default": "Dynamic", + "x-ms-enum": { + "name": "IpAllocationMethod", + "modelAsString": true + } + } + } + }, + "TargetDnsServer": { + "description": "Describes a server to forward the DNS queries to.", + "type": "object", + "required": [ + "ipAddress" + ], + "properties": { + "ipAddress": { + "description": "DNS server IP address.", + "type": "string" + }, + "port": { + "description": "DNS server port.", + "type": "integer", + "format": "int32", + "default": 53 + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + }, + "VirtualNetworkDnsForwardingRulesetListResult": { + "description": "The response to an enumeration operation on Virtual Network DNS Forwarding Ruleset.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the Virtual Network DNS Forwarding Ruleset.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkDnsForwardingRuleset" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkLinkSubResourceProperties": { + "description": "The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network.", + "type": "object", + "properties": { + "virtualNetworkLink": { + "description": "The reference to the virtual network link.", + "$ref": "#/definitions/SubResource" + } + } + }, + "VirtualNetworkDnsForwardingRuleset": { + "description": "Reference to DNS forwarding ruleset and associated virtual network link.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "DNS Forwarding Ruleset Resource ID." + }, + "properties": { + "description": "Properties of the virtual network link sub-resource reference.", + "$ref": "#/definitions/VirtualNetworkLinkSubResourceProperties", + "x-ms-client-flatten": true + } + } + }, + "CloudError": { + "description": "An error message", + "type": "object", + "properties": { + "error": { + "description": "The error message body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "The body of an error message", + "type": "object", + "properties": { + "code": { + "description": "The error code", + "type": "string" + }, + "message": { + "description": "A description of what caused the error", + "type": "string" + }, + "target": { + "description": "The target resource of the error message", + "type": "string" + }, + "details": { + "description": "Extra error information", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-external": true + } + }, + "parameters": { + "DnsResolverNameParameter": { + "name": "dnsResolverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "InboundEndpointNameParameter": { + "name": "inboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "OutboundEndpointNameParameter": { + "name": "outboundEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound endpoint for the DNS resolver.", + "x-ms-parameter-location": "method" + }, + "DnsForwardingRulesetNameParameter": { + "name": "dnsForwardingRulesetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DNS forwarding ruleset.", + "x-ms-parameter-location": "method" + }, + "ForwardingRuleNameParameter": { + "name": "forwardingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the forwarding rule.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkLinkNameParameter": { + "name": "virtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network link.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json new file mode 100644 index 000000000000..f0415f04a869 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json @@ -0,0 +1,1828 @@ +{ + "swagger": "2.0", + "info": { + "title": "DnsResolverPolicyManagementClient", + "description": "The DNS Resolver Policy Management Client.", + "version": "2023-07-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}": { + "put": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Update", + "description": "Updates a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "202": { + "description": "The operation to update DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Delete", + "description": "Deletes a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver policy has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_Get", + "description": "Gets properties of a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicy_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByResourceGroup", + "description": "Lists DNS resolver policies within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by resource group": { + "$ref": "./examples/DnsResolverPolicy_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverPolicies": { + "get": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_List", + "description": "Lists DNS resolver policies in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policies in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by subscription": { + "$ref": "./examples/DnsResolverPolicy_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules/{dnsSecurityRuleName}": { + "put": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_CreateOrUpdate", + "description": "Creates or updates a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS security rule has been created.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS security rule": { + "$ref": "./examples/DnsSecurityRule_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Update", + "description": "Updates a DNS security rule.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsSecurityRulePatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule has been updated.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "202": { + "description": "The operation to update the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Delete", + "description": "Deletes a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS security rule has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS security rule was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_Get", + "description": "Gets properties of a DNS security rule for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsSecurityRuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS security rule was found.", + "schema": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS security rule for DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/dnsSecurityRules": { + "get": { + "tags": [ + "DnsSecurityRules" + ], + "operationId": "DnsSecurityRules_List", + "description": "Lists DNS security rules for a DNS resolver policy.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS security rules for the DNS resolver policy.", + "schema": { + "$ref": "#/definitions/DnsSecurityRuleListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS security rules by DNS resolver policy": { + "$ref": "./examples/DnsSecurityRule_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks/{dnsResolverPolicyVirtualNetworkLinkName}": { + "put": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_CreateOrUpdate", + "description": "Creates or updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver policy virtual network link has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Update", + "description": "Updates a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "202": { + "description": "The operation to update DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Delete", + "description": "Deletes a DNS resolver policy virtual network link. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete the DNS resolver policy virtual network link has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver policy virtual network link was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_Get", + "description": "Gets properties of a DNS resolver policy virtual network link.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyVirtualNetworkLinkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver policy virtual network link was found.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver policy virtual network link": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverPolicies/{dnsResolverPolicyName}/virtualNetworkLinks": { + "get": { + "tags": [ + "DnsResolverPolicyVirtualNetworkLinks" + ], + "operationId": "DnsResolverPolicyVirtualNetworkLinks_List", + "description": "Lists DNS resolver policy virtual network links.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy virtual network links.", + "schema": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policy virtual network links by DNS resolver policy": { + "$ref": "./examples/DnsResolverPolicyVirtualNetworkLink_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists/{dnsResolverDomainListName}": { + "put": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_CreateOrUpdate", + "description": "Creates or updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + }, + "description": "Parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + } + ], + "responses": { + "201": { + "description": "The DNS resolver domain list has been created.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Upsert DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Put.json" + } + } + }, + "patch": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Update", + "description": "Updates a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DnsResolverDomainListPatch" + }, + "description": "Parameters supplied to the Update operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list has been updated.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "202": { + "description": "The operation to update DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Delete", + "description": "Deletes a DNS resolver domain list. WARNING: This operation cannot be undone.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + } + ], + "responses": { + "202": { + "description": "The operation to delete DNS resolver domain list has been accepted and will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "The DNS resolver domain list was not found." + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Delete.json" + } + } + }, + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_Get", + "description": "Gets properties of a DNS resolver domain list.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DnsResolverDomainListNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The DNS resolver domain list was found.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieve DNS resolver domain list": { + "$ref": "./examples/DnsResolverDomainList_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_ListByResourceGroup", + "description": "Lists DNS resolver domain lists within a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the resource group.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by resource group": { + "$ref": "./examples/DnsResolverDomainList_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnsResolverDomainLists": { + "get": { + "tags": [ + "DnsResolverDomainLists" + ], + "operationId": "DnsResolverDomainLists_List", + "description": "Lists DNS resolver domain lists in all resource groups of a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver domain lists in the subscription.", + "schema": { + "$ref": "#/definitions/DnsResolverDomainListListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver domain lists by subscription": { + "$ref": "./examples/DnsResolverDomainList_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/listDnsResolverPolicies": { + "post": { + "tags": [ + "DnsResolverPolicies" + ], + "operationId": "DnsResolverPolicies_ListByVirtualNetwork", + "description": "Lists DNS resolver policy resource IDs linked to a virtual network.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of DNS resolver policy resource IDs linked to the virtual network.", + "schema": { + "$ref": "#/definitions/SubResourceListResult" + } + }, + "default": { + "description": "Default response. It will be deserialized as per the Error definition.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DNS resolver policies by virtual network": { + "$ref": "./examples/DnsResolverPolicy_ListByVirtualNetwork.json" + } + } + } + } + }, + "definitions": { + "DnsResolverPolicyProperties": { + "description": "Represents the properties of a DNS resolver policy.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver policy resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverPolicy": { + "description": "Describes a DNS resolver policy.", + "type": "object", + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy.", + "$ref": "#/definitions/DnsResolverPolicyProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyPatch": { + "description": "Describes a DNS resolver policy for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver policy." + } + } + }, + "DnsResolverPolicyListResult": { + "description": "The response to an enumeration operation on DNS resolver policies.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policies.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicy" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleProperties": { + "description": "Represents the properties of a DNS security rule.", + "type": "object", + "required": [ + "priority", + "action", + "dnsResolverDomainLists" + ], + "properties": { + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS security rule. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsSecurityRule": { + "description": "Describes a DNS security rule.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS security rule.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsSecurityRulePatchProperties": { + "description": "Represents the updatable properties of a DNS security rule.", + "type": "object", + "properties": { + "action": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRuleAction" + }, + "dnsResolverDomainLists": { + "description": "DNS resolver policy domains lists that the DNS security rule applies to.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "x-ms-identifiers": [] + }, + "dnsSecurityRuleState": { + "type": "string", + "description": "The state of DNS security rule.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "DnsSecurityRuleState", + "modelAsString": true + } + }, + "priority": { + "description": "The priority of the DNS security rule.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "DnsSecurityRulePatch": { + "description": "Describes a DNS security rule for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS security rule.", + "$ref": "#/definitions/DnsSecurityRulePatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS security rule." + } + } + }, + "DnsSecurityRuleListResult": { + "description": "The response to an enumeration operation on DNS security rules within a DNS resolver policy.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS security rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsSecurityRule" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsSecurityRuleAction": { + "description": "The action to take on DNS requests that match the DNS security rule.", + "type": "object", + "properties": { + "actionType": { + "type": "string", + "description": "The type of action to take.", + "enum": [ + "Allow", + "Alert", + "Block" + ], + "x-ms-enum": { + "name": "actionType", + "modelAsString": true + } + }, + "blockResponseCode": { + "type": "string", + "description": "The response code for block actions.", + "enum": [ + "SERVFAIL" + ], + "x-ms-enum": { + "name": "BlockResponseCode", + "modelAsString": true + } + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkProperties": { + "description": "Represents the properties of a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "virtualNetwork" + ], + "properties": { + "virtualNetwork": { + "description": "The reference to the virtual network. This cannot be changed after creation.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "#/definitions/SubResource" + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver policy virtual network link. This is a read-only property and any attempt to set this value will be ignored.", + "$ref": "#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DnsResolverPolicyVirtualNetworkLink": { + "description": "Describes a DNS resolver policy virtual network link.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver policy virtual network link.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLinkProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverPolicyVirtualNetworkLinkPatch": { + "description": "Describes a DNS resolver policy virtual network link for PATCH operation.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for the DNS resolver policy virtual network link." + } + } + }, + "DnsResolverPolicyVirtualNetworkLinkListResult": { + "description": "The response to an enumeration operation on DNS resolver policy virtual network links.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver policy virtual network links.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverPolicyVirtualNetworkLink" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DnsResolverDomainListProperties": { + "description": "Represents the properties of a DNS resolver domain list.", + "type": "object", + "required": [ + "domains" + ], + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "The current provisioning state of the DNS resolver domain list. This is a read-only property and any attempt to set this value will be ignored.", + "readOnly": true, + "$ref": "#/definitions/ProvisioningState" + }, + "resourceGuid": { + "description": "The resourceGuid property of the DNS resolver domain list resource.", + "readOnly": true, + "$ref": "#/definitions/ResourceGuid" + } + } + }, + "DnsResolverDomainList": { + "description": "Describes a DNS resolver domain list.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "etag": { + "description": "ETag of the DNS resolver domain list.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the DNS resolver domain list.", + "$ref": "#/definitions/DnsResolverDomainListProperties", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData", + "description": "Metadata pertaining to creation and last modification of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DnsResolverDomainListPatchProperties": { + "description": "Represents the updatable properties of a DNS resolver domain list.", + "type": "object", + "properties": { + "domains": { + "description": "The domains in the domain list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DnsResolverDomainListPatch": { + "description": "Describes a DNS resolver domain list for PATCH operation.", + "type": "object", + "properties": { + "properties": { + "description": "Updatable properties of the DNS resolver policy virtual network link.", + "$ref": "#/definitions/DnsResolverDomainListPatchProperties", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Tags for DNS resolver domain list." + } + } + }, + "DnsResolverDomainListListResult": { + "description": "The response to an enumeration operation on DNS resolver domain lists.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the DNS resolver domain lists.", + "type": "array", + "items": { + "$ref": "#/definitions/DnsResolverDomainList" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ProvisioningState": { + "description": "The current provisioning state of the resource.", + "type": "string", + "readOnly": true, + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceGuid": { + "type": "string", + "description": "The Guid property of the resource." + }, + "SubResourceListResult": { + "description": "The response to an enumeration operation on sub-resources.", + "type": "object", + "properties": { + "value": { + "description": "Enumeration of the sub-resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "nextLink": { + "description": "The continuation token for the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SubResource": { + "description": "Reference to another ARM resource.", + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "DnsResolverPolicyNameParameter": { + "name": "dnsResolverPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsSecurityRuleNameParameter": { + "name": "dnsSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS security rule.", + "x-ms-parameter-location": "method" + }, + "DnsResolverPolicyVirtualNetworkLinkNameParameter": { + "name": "dnsResolverPolicyVirtualNetworkLinkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver policy virtual network link for the DNS resolver policy.", + "x-ms-parameter-location": "method" + }, + "DnsResolverDomainListNameParameter": { + "name": "dnsResolverDomainListName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]([a-zA-Z0-9_\\-]*[a-zA-Z0-9])?$", + "minLength": 1, + "maxLength": 80, + "description": "The name of the DNS resolver domain list.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^.+$", + "minLength": 1, + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of results to return. If not specified, returns up to 100 results.", + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfMatch", + "description": "ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "x-ms-client-name": "IfNoneMatch", + "description": "Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json new file mode 100644 index 000000000000..7107b1f637dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRulesetName", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json new file mode 100644 index 000000000000..94c2a7a063cf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json new file mode 100644 index 000000000000..1f05389ae97c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "c2aed17a-708d-48d1-89c3-d6a9b648d222" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json new file mode 100644 index 000000000000..456dc7d6fb19 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset1", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-04T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-05T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint2" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint3" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsForwardingRulesets?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json new file mode 100644 index 000000000000..e525fd69f74c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_ListByVirtualNetwork.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "properties": { + "virtualNetworkLink": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json new file mode 100644 index 000000000000..1b9900f9de3c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json new file mode 100644 index 000000000000..80d0d41b1f0b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsForwardingRuleset_Put.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "samplednsForwardingRuleset", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset", + "name": "sampleDnsForwardingRuleset", + "type": "Microsoft.Network/dnsForwardingRulesets", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "dnsResolverOutboundEndpoints": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint0" + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json new file mode 100644 index 000000000000..34061d8643e9 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json new file mode 100644 index 000000000000..e8b62627ad8d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json new file mode 100644 index 000000000000..711a46672b21 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json new file mode 100644 index 000000000000..3243f2b0f3c2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_ListBySubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1", + "name": "sampleDnsResolverDomainList1", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2", + "name": "sampleDnsResolverDomainList2", + "type": "Microsoft.Network/dnsResolverDomainLists", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverDomainLists?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json new file mode 100644 index 000000000000..d307656d2f7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json new file mode 100644 index 000000000000..b8f9bf2ddb5c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverDomainList_Put.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverDomainListName": "sampleDnsResolverDomainList", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ] + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList", + "name": "sampleDnsResolverDomainList", + "type": "Microsoft.Network/dnsResolverDomainLists", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "domains": [ + "contoso.com" + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..a1e86cff9cc2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json new file mode 100644 index 000000000000..348e02fd2b7d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json new file mode 100644 index 000000000000..4a8f966a8a93 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..8c89c19d29dd --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json new file mode 100644 index 000000000000..909d98942841 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicyVirtualNetworkLink_Put.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsResolverPolicyVirtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicy/sampleDnsResolverPolicy/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsResolverPolicies/virtualNetworkLinks", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json new file mode 100644 index 000000000000..7166c3551217 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json new file mode 100644 index 000000000000..9a39f19360e0 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2023-07-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2023-07-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json new file mode 100644 index 000000000000..32c0a6a472e1 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json new file mode 100644 index 000000000000..9b8fedadb3e2 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1", + "name": "sampleDnsResolverPolicy1", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy2", + "name": "sampleDnsResolverPolicy2", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolverPolicies?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json new file mode 100644 index 000000000000..34220c360186 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json new file mode 100644 index 000000000000..9539b679c7c4 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Patch.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json new file mode 100644 index 000000000000..e6fb7d148f45 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolverPolicy_Put.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy", + "name": "sampleDnsResolverPolicy", + "type": "Microsoft.Network/dnsResolverPolicies", + "location": "westus2", + "tags": { + "key1": "value1" + }, + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json new file mode 100644 index 000000000000..ff36658d7bcb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json new file mode 100644 index 000000000000..a7e6b4c97012 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "a7e1a32c-498c-401c-a805-5bc3518257b8" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json new file mode 100644 index 000000000000..83152bce7a58 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-03T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-04T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json new file mode 100644 index 000000000000..fdd09c22f0da --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1", + "name": "sampleDnsResolver1", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork1" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "ad9c8da4-3bb2-4821-a878-c2cb07b01fb6" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver2", + "name": "sampleDnsResolver2", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork2" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/providers/Microsoft.Network/dnsResolvers?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json new file mode 100644 index 000000000000..9a2771152b70 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_ListByVirtualNetwork.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "virtualNetworkName": "sampleVirtualNetwork", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json new file mode 100644 index 000000000000..819a87624dbf --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json new file mode 100644 index 000000000000..20abcb40c39c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsResolver_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver", + "name": "sampleDnsResolver", + "type": "Microsoft.Network/dnsResolvers", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "dnsResolverState": "Connected", + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json new file mode 100644 index 000000000000..3734714233b6 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json new file mode 100644 index 000000000000..7e9cd2ffa48c --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json new file mode 100644 index 000000000000..448035790b96 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule1", + "name": "sampleDnsSecurityRule1", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 101, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList1" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsSecurityRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json new file mode 100644 index 000000000000..4b1acec7f6ca --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Patch.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "properties": { + "dnsSecurityRuleState": "Disabled" + }, + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Allow" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList2" + } + ], + "dnsSecurityRuleState": "Disabled", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json new file mode 100644 index 000000000000..afa3dc4c5de8 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/DnsSecurityRule_Put.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverPolicyName": "sampleDnsResolverPolicy", + "dnsSecurityRuleName": "sampleDnsSecurityRule", + "parameters": { + "location": "westus2", + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + }, + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverPolicies/sampleDnsResolverPolicy/dnsSecurityRules/sampleDnsSecurityRule", + "name": "sampleDnsSecurityRule", + "type": "Microsoft.Network/dnsResolverPolicies/dnsSecurityRules", + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "tags": { + "key1": "value1" + }, + "properties": { + "priority": 100, + "action": { + "actionType": "Block", + "blockResponseCode": "SERVFAIL" + }, + "dnsResolverDomainLists": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolverDomainLists/sampleDnsResolverDomainList" + } + ], + "dnsSecurityRuleState": "Enabled", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json new file mode 100644 index 000000000000..9d00277a78eb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json new file mode 100644 index 000000000000..475971f47cae --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json new file mode 100644 index 000000000000..18d7ad15ec3e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule1", + "name": "sampleForwardingRule1", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "foobar.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.3", + "port": 53 + }, + { + "ipAddress": "10.0.0.4", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/forwardingRules?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json new file mode 100644 index 000000000000..26a2bc01e5fb --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Patch.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "forwardingRuleState": "Disabled", + "metadata": { + "additionalProp2": "value2" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp2": "value2" + }, + "forwardingRuleState": "Disabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json new file mode 100644 index 000000000000..e3872ac7093d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/ForwardingRule_Put.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "forwardingRuleName": "sampleForwardingRule", + "parameters": { + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "forwardingRuleState": "Enabled", + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRulesets/sampleDnsForwardingRuleset/forwardingRules/sampleForwardingRule", + "name": "sampleForwardingRule", + "type": "Microsoft.Network/dnsForwardingRulesets/forwardingRules", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "domainName": "contoso.com.", + "targetDnsServers": [ + { + "ipAddress": "10.0.0.1", + "port": 53 + }, + { + "ipAddress": "10.0.0.2", + "port": 53 + } + ], + "metadata": { + "additionalProp1": "value1" + }, + "forwardingRuleState": "Enabled", + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json new file mode 100644 index 000000000000..ce839e23f78d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json new file mode 100644 index 000000000000..e5e6970c510b --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json new file mode 100644 index 000000000000..24a014617a36 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_List.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint1", + "name": "sampleInboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "255.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint2", + "name": "sampleInboundEndpoint2", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-02T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-03T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "privateIpAddress": "1.1.255.1", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json new file mode 100644 index 000000000000..11cf34e59b76 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Patch.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json new file mode 100644 index 000000000000..8ca756400a75 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/InboundEndpoint_Put.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "inboundEndpointName": "sampleInboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAllocationMethod": "Dynamic" + } + ] + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "b6b2d964-8588-4e3a-a7fe-8a5b7fe8eca5" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/inboundEndpoints/sampleInboundEndpoint", + "name": "sampleInboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/inboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "ipConfigurations": [ + { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "privateIpAddress": "255.255.255.255", + "privateIpAllocationMethod": "Dynamic" + } + ], + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json new file mode 100644 index 000000000000..fa4e867cc925 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json new file mode 100644 index 000000000000..7378b3bfd102 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json new file mode 100644 index 000000000000..8af4a68dee0e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + }, + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint1", + "name": "sampleOutboundEndpoint1", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet1" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + ], + "nextLink": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints?$skipToken=skipToken&api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json new file mode 100644 index 000000000000..0d0f9a015690 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succecced", + "resourceGuid": "b4d35f41-0c70-4ec7-bb3e-0cd9f8b7e4be" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json new file mode 100644 index 000000000000..a5c3ac17745e --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/OutboundEndpoint_Put.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsResolverName": "sampleDnsResolver", + "outboundEndpointName": "sampleOutboundEndpoint", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "westus2", + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/outboundEndpoints/sampleOutboundEndpoint", + "name": "sampleOutboundEndpoint", + "type": "Microsoft.Network/dnsResolvers/outboundEndpoints", + "tags": { + "key1": "value1" + }, + "location": "westus2", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "subnet": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork/subnets/sampleSubnet" + }, + "provisioningState": "Succeeded", + "resourceGuid": "87b3e20a-5833-4c40-8ad7-c5160bb1c5bd" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json new file mode 100644 index 000000000000..d9db418ffa06 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json new file mode 100644 index 000000000000..96c759001524 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json new file mode 100644 index 000000000000..0a4a10302b09 --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json new file mode 100644 index 000000000000..88473b3dbd0d --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Patch.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json new file mode 100644 index 000000000000..369f23d834ed --- /dev/null +++ b/specification/dnsresolver/resource-manager/Microsoft.Network/preview/2023-07-01-preview/examples/VirtualNetworkLink_Put.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "abdd4249-9f34-4cc6-8e42-c2e32110603e", + "resourceGroupName": "sampleResourceGroup", + "dnsForwardingRulesetName": "sampleDnsForwardingRuleset", + "virtualNetworkLinkName": "sampleVirtualNetworkLink", + "parameters": { + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + } + } + }, + "api-version": "2023-07-01-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsForwardingRuleset/sampleDnsForwardingRuleset/virtualNetworkLinks/sampleVirtualNetworkLink", + "name": "sampleVirtualNetworkLink", + "type": "Microsoft.Network/dnsForwardingRulesets/virtualNetworkLinks", + "etag": "00000000-0000-0000-0000-000000000000", + "systemData": { + "createdByType": "Application", + "createdAt": "2021-04-01T01:01:01.1075056Z", + "lastModifiedByType": "Application", + "lastModifiedAt": "2021-04-02T02:03:01.1974346Z" + }, + "properties": { + "virtualNetwork": { + "id": "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualNetwork" + }, + "metadata": { + "additionalProp1": "value1" + }, + "provisioningState": "Succecced" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationResults/asyncOperationId?api-version=2023-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/api/mresolver/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/locations/westus2/dnsResolverOperationStatuses/asyncOperationId?api-version=2023-07-01-preview" + } + } + } +} diff --git a/specification/dnsresolver/resource-manager/readme.md b/specification/dnsresolver/resource-manager/readme.md index 1143e778efef..b31bbb537eb1 100644 --- a/specification/dnsresolver/resource-manager/readme.md +++ b/specification/dnsresolver/resource-manager/readme.md @@ -25,8 +25,20 @@ To see additional help and options, run: These are the global settings for the DNS resolver API. ``` yaml +title: DnsResolverManagementClient +description: DNS Resolver Client openapi-type: arm -tag: package-2022-07 +tag: package-preview-2023-07 +``` + +### Tag: package-preview-2023-07 + +These settings apply only when `--tag=package-preview-2023-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-07' +input-file: + - Microsoft.Network/preview/2023-07-01-preview/dnsresolver.json + - Microsoft.Network/preview/2023-07-01-preview/dnsresolverpolicy.json ``` ### Tag: package-2022-07 @@ -57,7 +69,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net-track2 - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-go - repo: azure-powershell ``` @@ -129,4 +141,3 @@ uncomment the `exclude-file` section below and add the file paths. #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 157802f3c23879acabd2cba9384679de59fe6e10 Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Fri, 27 Sep 2024 10:17:56 -0700 Subject: [PATCH 009/101] Add new API version 2024-09-01 for Microsoft.Cdn (#30309) * Copy 2024-02-01 version to create 2024-09-01 version * Update readme.md * Changes for the new api version * Update readme.md * Fix api versions in examples * Update description * Update cdn.json Attempting to address lintdiff * Update cdn.json * Update cdn.json * Fix validation * Update cdn.json * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml * Update readme.md * Update readme.md * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi * Update specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json Co-authored-by: Chenjie Shi --------- Co-authored-by: Yuchao Yan Co-authored-by: Chenglong Liu <48578056+ChenglongLiu@users.noreply.github.com> Co-authored-by: Chenjie Shi --- .../Microsoft.Cdn/stable/2024-09-01/afdx.json | 6310 ++++++++++++++ .../Microsoft.Cdn/stable/2024-09-01/cdn.json | 7466 +++++++++++++++++ .../2024-09-01/cdnwebapplicationfirewall.json | 977 +++ .../examples/AFDCustomDomains_Create.json | 119 + .../examples/AFDCustomDomains_Delete.json | 18 + .../examples/AFDCustomDomains_Get.json | 42 + .../AFDCustomDomains_ListByProfile.json | 45 + ...DCustomDomains_RefreshValidationToken.json | 17 + .../examples/AFDCustomDomains_Update.json | 87 + .../examples/AFDEndpoints_Create.json | 70 + .../examples/AFDEndpoints_Delete.json | 18 + .../2024-09-01/examples/AFDEndpoints_Get.json | 27 + .../examples/AFDEndpoints_ListByProfile.json | 30 + .../AFDEndpoints_ListResourceUsage.json | 27 + .../examples/AFDEndpoints_PurgeContent.json | 25 + .../examples/AFDEndpoints_Update.json | 52 + .../AFDEndpoints_ValidateCustomDomain.json | 21 + .../examples/AFDOriginGroups_Create.json | 99 + .../examples/AFDOriginGroups_Delete.json | 18 + .../examples/AFDOriginGroups_Get.json | 34 + .../AFDOriginGroups_ListByProfile.json | 37 + .../AFDOriginGroups_ListResourceUsage.json | 27 + .../examples/AFDOriginGroups_Update.json | 76 + .../examples/AFDOrigins_Create.json | 87 + .../examples/AFDOrigins_Delete.json | 19 + .../2024-09-01/examples/AFDOrigins_Get.json | 33 + .../AFDOrigins_ListByOriginGroup.json | 36 + .../examples/AFDOrigins_Update.json | 65 + ...rofiles_CheckEndpointNameAvailability.json | 23 + ...AFDProfiles_CheckHostNameAvailability.json | 20 + .../AFDProfiles_ListResourceUsage.json | 26 + .../examples/AFDProfiles_Upgrade.json | 63 + .../examples/AFDProfiles_ValidateSecret.json | 22 + .../examples/CdnProfiles_CanMigrate.json | 26 + .../examples/CdnProfiles_Migrate.json | 31 + .../CheckEndpointNameAvailability.json | 22 + .../examples/CheckNameAvailability.json | 18 + ...CheckNameAvailabilityWithSubscription.json | 19 + .../examples/CustomDomains_Create.json | 65 + .../examples/CustomDomains_Delete.json | 32 + .../CustomDomains_DisableCustomHttps.json | 45 + ...tomDomains_EnableCustomHttpsUsingBYOC.json | 60 + ...CustomHttpsUsingCDNManagedCertificate.json | 54 + .../examples/CustomDomains_Get.json | 27 + .../CustomDomains_ListByEndpoint.json | 30 + .../2024-09-01/examples/EdgeNodes_List.json | 107 + .../2024-09-01/examples/Endpoints_Create.json | 546 ++ .../2024-09-01/examples/Endpoints_Delete.json | 18 + .../2024-09-01/examples/Endpoints_Get.json | 79 + .../examples/Endpoints_ListByProfile.json | 86 + .../examples/Endpoints_ListResourceUsage.json | 29 + .../examples/Endpoints_LoadContent.json | 22 + .../examples/Endpoints_PurgeContent.json | 22 + .../2024-09-01/examples/Endpoints_Start.json | 86 + .../2024-09-01/examples/Endpoints_Stop.json | 86 + .../2024-09-01/examples/Endpoints_Update.json | 141 + .../Endpoints_ValidateCustomDomain.json | 21 + ...LogAnalytics_GetLogAnalyticsLocations.json | 60 + .../LogAnalytics_GetLogAnalyticsMetrics.json | 71 + .../LogAnalytics_GetLogAnalyticsRankings.json | 82 + ...LogAnalytics_GetLogAnalyticsResources.json | 55 + ...ogAnalytics_GetWafLogAnalyticsMetrics.json | 132 + ...gAnalytics_GetWafLogAnalyticsRankings.json | 42 + .../2024-09-01/examples/Operations_List.json | 93 + .../examples/OriginGroups_Create.json | 112 + .../examples/OriginGroups_Delete.json | 19 + .../2024-09-01/examples/OriginGroups_Get.json | 44 + .../examples/OriginGroups_ListByEndpoint.json | 41 + .../examples/OriginGroups_Update.json | 74 + .../2024-09-01/examples/Origins_Create.json | 95 + .../2024-09-01/examples/Origins_Delete.json | 19 + .../2024-09-01/examples/Origins_Get.json | 33 + .../examples/Origins_ListByEndpoint.json | 36 + .../2024-09-01/examples/Origins_Update.json | 68 + .../examples/Profiles_CanMigrate.json | 31 + .../2024-09-01/examples/Profiles_Create.json | 98 + .../2024-09-01/examples/Profiles_Delete.json | 17 + .../examples/Profiles_GenerateSsoUri.json | 15 + .../2024-09-01/examples/Profiles_Get.json | 33 + .../2024-09-01/examples/Profiles_List.json | 56 + .../Profiles_ListByResourceGroup.json | 57 + .../examples/Profiles_ListResourceUsage.json | 22 + ...ofiles_ListSupportedOptimizationTypes.json | 18 + .../2024-09-01/examples/Profiles_Migrate.json | 43 + .../examples/Profiles_MigrationAbort.json | 15 + .../examples/Profiles_MigrationCommit.json | 16 + .../2024-09-01/examples/Profiles_Update.json | 68 + .../examples/ResourceUsage_List.json | 20 + .../2024-09-01/examples/Routes_Create.json | 196 + .../2024-09-01/examples/Routes_Delete.json | 19 + .../2024-09-01/examples/Routes_Get.json | 59 + .../examples/Routes_ListByEndpoint.json | 62 + .../2024-09-01/examples/Routes_Update.json | 148 + .../2024-09-01/examples/RuleSets_Create.json | 33 + .../2024-09-01/examples/RuleSets_Delete.json | 18 + .../2024-09-01/examples/RuleSets_Get.json | 22 + .../examples/RuleSets_ListByProfile.json | 25 + .../examples/RuleSets_ListResourceUsage.json | 27 + .../2024-09-01/examples/Rules_Create.json | 158 + .../2024-09-01/examples/Rules_Delete.json | 19 + .../stable/2024-09-01/examples/Rules_Get.json | 50 + .../examples/Rules_ListByRuleSet.json | 53 + .../2024-09-01/examples/Rules_Update.json | 107 + .../2024-09-01/examples/Secrets_Create.json | 107 + .../2024-09-01/examples/Secrets_Delete.json | 18 + .../2024-09-01/examples/Secrets_Get.json | 38 + .../examples/Secrets_ListByProfile.json | 55 + .../examples/SecurityPolicies_Create.json | 135 + .../examples/SecurityPolicies_Delete.json | 18 + .../examples/SecurityPolicies_Get.json | 43 + .../SecurityPolicies_ListByProfile.json | 46 + .../examples/SecurityPolicies_Patch.json | 103 + .../2024-09-01/examples/ValidateProbe.json | 18 + .../examples/WafListManagedRuleSets.json | 53 + .../2024-09-01/examples/WafListPolicies.json | 265 + .../2024-09-01/examples/WafPatchPolicy.json | 275 + .../examples/WafPolicyCreateOrUpdate.json | 508 ++ .../2024-09-01/examples/WafPolicyDelete.json | 12 + .../2024-09-01/examples/WafPolicyGet.json | 139 + .../AFDProfiles_Upgrade_WithoutWaf.yaml | 28 + specification/cdn/resource-manager/readme.md | 16 +- .../resource-manager/sdk-suppressions.yaml | 37 + 122 files changed, 22202 insertions(+), 1 deletion(-) create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json create mode 100644 specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json new file mode 100644 index 000000000000..0d5a749bea04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/afdx.json @@ -0,0 +1,6310 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/checkEndpointNameAvailability": { + "post": { + "tags": [ + "CheckEndpointNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.", + "operationId": "CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkEndpointNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Check the availability of an afdx endpoint name, and return the globally unique endpoint host name.", + "operationId": "AFDProfiles_CheckEndpointNameAvailability", + "x-ms-examples": { + "CheckEndpointNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckEndpointNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkEndpointNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckEndpointNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/usages": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDProfiles_ListResourceUsage", + "x-ms-examples": { + "AFDProfiles_ListResourceUsage": { + "$ref": "./examples/AFDProfiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkHostNameAvailability": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDProfiles_CheckHostNameAvailability", + "x-ms-examples": { + "AFDProfiles_CheckHostNameAvailability": { + "$ref": "./examples/AFDProfiles_CheckHostNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "checkHostNameAvailabilityInput", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckHostNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/validateSecret": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Validate a Secret in the profile.", + "operationId": "AFDProfiles_ValidateSecret", + "x-ms-examples": { + "Validate_Secret": { + "$ref": "./examples/AFDProfiles_ValidateSecret.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "validateSecretInput", + "in": "body", + "description": "The Secret source.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateSecretInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateSecretOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/upgrade": { + "post": { + "tags": [ + "AFDProfiles" + ], + "description": "Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.", + "operationId": "AFDProfiles_Upgrade", + "x-ms-examples": { + "AFDProfiles_Upgrade": { + "$ref": "./examples/AFDProfiles_Upgrade.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "name": "profileUpgradeParameters", + "in": "body", + "description": "Profile upgrade input parameter.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpgradeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "./cdn.json#/definitions/Profile" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Lists existing AzureFrontDoor domains.", + "operationId": "AFDCustomDomains_ListByProfile", + "x-ms-examples": { + "AFDCustomDomains_ListByProfile": { + "$ref": "./examples/AFDCustomDomains_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomainListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Get", + "x-ms-examples": { + "AFDCustomDomains_Get": { + "$ref": "./examples/AFDCustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Creates a new domain within the specified profile.", + "operationId": "AFDCustomDomains_Create", + "x-ms-examples": { + "AFDCustomDomains_Create": { + "$ref": "./examples/AFDCustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomain", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new domain has been created.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates an existing domain within a profile.", + "operationId": "AFDCustomDomains_Update", + "x-ms-examples": { + "AFDCustomDomains_Update": { + "$ref": "./examples/AFDCustomDomains_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "name": "customDomainUpdateProperties", + "in": "body", + "description": "Domain properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDDomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDDomain" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.", + "operationId": "AFDCustomDomains_Delete", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the domain was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}/refreshValidationToken": { + "post": { + "tags": [ + "AFDCustomDomains" + ], + "description": "Updates the domain validation token.", + "operationId": "AFDCustomDomains_RefreshValidationToken", + "x-ms-examples": { + "AFDCustomDomains_Delete": { + "$ref": "./examples/AFDCustomDomains_RefreshValidationToken.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the domain under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. Please poll the targeted custom domain and check the 'validationProperties' field for the new validation token values.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Lists existing AzureFrontDoor endpoints.", + "operationId": "AFDEndpoints_ListByProfile", + "x-ms-examples": { + "AFDEndpoints_ListByProfile": { + "$ref": "./examples/AFDEndpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpointListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}": { + "get": { + "tags": [ + "AFDEndpoints" + ], + "description": "Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Get", + "x-ms-examples": { + "AFDEndpoints_Get": { + "$ref": "./examples/AFDEndpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDEndpoints" + ], + "description": "Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Create", + "x-ms-examples": { + "AFDEndpoints_Create": { + "$ref": "./examples/AFDEndpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDEndpoints" + ], + "description": "Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.", + "operationId": "AFDEndpoints_Update", + "x-ms-examples": { + "AFDEndpoints_Update": { + "$ref": "./examples/AFDEndpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDEndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDEndpoint" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDEndpoints" + ], + "description": "Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "AFDEndpoints_Delete", + "x-ms-examples": { + "AFDEndpoints_Delete": { + "$ref": "./examples/AFDEndpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/purge": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Removes a content from AzureFrontDoor.", + "operationId": "AFDEndpoints_PurgeContent", + "x-ms-examples": { + "AFDEndpoints_PurgeContent": { + "$ref": "./examples/AFDEndpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contents", + "in": "body", + "description": "The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/AfdPurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/usages": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile.", + "operationId": "AFDEndpoints_ListResourceUsage", + "x-ms-examples": { + "AFDEndpoints_ListResourceUsage": { + "$ref": "./examples/AFDEndpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "AFDEndpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.", + "operationId": "AFDEndpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/AFDEndpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "./cdn.json#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Lists all of the existing origin groups within a profile.", + "operationId": "AFDOriginGroups_ListByProfile", + "x-ms-examples": { + "AFDOriginGroups_ListByProfile": { + "$ref": "./examples/AFDOriginGroups_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroupListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Gets an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Get", + "x-ms-examples": { + "AFDOriginGroups_Get": { + "$ref": "./examples/AFDOriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Creates a new origin group within the specified profile.", + "operationId": "AFDOriginGroups_Create", + "x-ms-examples": { + "AFDOriginGroups_Create": { + "$ref": "./examples/AFDOriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Updates an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Update", + "x-ms-examples": { + "AFDOriginGroups_Update": { + "$ref": "./examples/AFDOriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOriginGroup" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Deletes an existing origin group within a profile.", + "operationId": "AFDOriginGroups_Delete", + "x-ms-examples": { + "AFDOriginGroups_Delete": { + "$ref": "./examples/AFDOriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin group was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/usages": { + "post": { + "tags": [ + "AFDOriginGroups" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "AFDOriginGroups_ListResourceUsage", + "x-ms-examples": { + "AFDOriginGroups_ListResourceUsage": { + "$ref": "./examples/AFDOriginGroups_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Lists all of the existing origins within an origin group.", + "operationId": "AFDOrigins_ListByOriginGroup", + "x-ms-examples": { + "AFDOrigins_ListByOriginGroup": { + "$ref": "./examples/AFDOrigins_ListByOriginGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOriginListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/originGroups/{originGroupName}/origins/{originName}": { + "get": { + "tags": [ + "AFDOrigins" + ], + "description": "Gets an existing origin within an origin group.", + "operationId": "AFDOrigins_Get", + "x-ms-examples": { + "AFDOrigins_Get": { + "$ref": "./examples/AFDOrigins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AFDOrigins" + ], + "description": "Creates a new origin within the specified origin group.", + "operationId": "AFDOrigins_Create", + "x-ms-examples": { + "AFDOrigins_Create": { + "$ref": "./examples/AFDOrigins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AFDOrigins" + ], + "description": "Updates an existing origin within an origin group.", + "operationId": "AFDOrigins_Update", + "x-ms-examples": { + "AFDOrigins_Update": { + "$ref": "./examples/AFDOrigins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/AFDOriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AFDOrigin" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "AFDOrigins" + ], + "description": "Deletes an existing origin within an origin group.", + "operationId": "AFDOrigins_Delete", + "x-ms-examples": { + "AFDOrigins_Delete": { + "$ref": "./examples/AFDOrigins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "description": "Lists all of the existing origins within a profile.", + "operationId": "Routes_ListByEndpoint", + "x-ms-examples": { + "Routes_ListByEndpoint": { + "$ref": "./examples/Routes_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}": { + "get": { + "tags": [ + "Routes" + ], + "description": "Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Get", + "x-ms-examples": { + "Routes_Get": { + "$ref": "./examples/Routes_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "description": "Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Create", + "x-ms-examples": { + "Routes_Create": { + "$ref": "./examples/Routes_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "route", + "in": "body", + "description": "Route properties", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Routes" + ], + "description": "Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Update", + "x-ms-examples": { + "Routes_Update": { + "$ref": "./examples/Routes_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "name": "routeUpdateProperties", + "in": "body", + "description": "Route update properties", + "required": true, + "schema": { + "$ref": "#/definitions/RouteUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Routes" + ], + "description": "Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.", + "operationId": "Routes_Delete", + "x-ms-examples": { + "Routes_Delete": { + "$ref": "./examples/Routes_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "routeName", + "in": "path", + "description": "Name of the routing rule.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Lists existing AzureFrontDoor rule sets within a profile.", + "operationId": "RuleSets_ListByProfile", + "x-ms-examples": { + "RuleSets_ListByProfile": { + "$ref": "./examples/RuleSets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSetListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}": { + "get": { + "tags": [ + "RuleSets" + ], + "description": "Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Get", + "x-ms-examples": { + "RuleSets_Get": { + "$ref": "./examples/RuleSets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "RuleSets" + ], + "description": "Creates a new rule set within the specified profile.", + "operationId": "RuleSets_Create", + "x-ms-examples": { + "RuleSets_Create": { + "$ref": "./examples/RuleSets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new rule set has been created.", + "schema": { + "$ref": "#/definitions/RuleSet" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "RuleSets" + ], + "description": "Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.", + "operationId": "RuleSets_Delete", + "x-ms-examples": { + "RuleSets_Delete": { + "$ref": "./examples/RuleSets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the rule set was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/usages": { + "post": { + "tags": [ + "RuleSets" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door profile..", + "operationId": "RuleSets_ListResourceUsage", + "x-ms-examples": { + "RuleSets_ListResourceUsage": { + "$ref": "./examples/RuleSets_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules": { + "get": { + "tags": [ + "Rules" + ], + "description": "Lists all of the existing delivery rules within a rule set.", + "operationId": "Rules_ListByRuleSet", + "x-ms-examples": { + "Rules_ListByRuleSet": { + "$ref": "./examples/Rules_ListByRuleSet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RuleListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/ruleSets/{ruleSetName}/rules/{ruleName}": { + "get": { + "tags": [ + "Rules" + ], + "description": "Gets an existing delivery rule within a rule set.", + "operationId": "Rules_Get", + "x-ms-examples": { + "Rules_Get": { + "$ref": "./examples/Rules_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Rules" + ], + "description": "Creates a new delivery rule within the specified rule set.", + "operationId": "Rules_Create", + "x-ms-examples": { + "Rules_Create": { + "$ref": "./examples/Rules_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "rule", + "in": "body", + "description": "The delivery rule properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Rules" + ], + "description": "Updates an existing delivery rule within a rule set.", + "operationId": "Rules_Update", + "x-ms-examples": { + "Rules_Update": { + "$ref": "./examples/Rules_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "ruleUpdateProperties", + "in": "body", + "description": "Delivery rule properties", + "required": true, + "schema": { + "$ref": "#/definitions/RuleUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Rule" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Rules" + ], + "description": "Deletes an existing delivery rule within a rule set.", + "operationId": "Rules_Delete", + "x-ms-examples": { + "Rules_Delete": { + "$ref": "./examples/Rules_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "ruleSetName", + "in": "path", + "description": "Name of the rule set under the profile.", + "required": true, + "type": "string" + }, + { + "name": "ruleName", + "in": "path", + "description": "Name of the delivery rule which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Lists security policies associated with the profile", + "operationId": "SecurityPolicies_ListByProfile", + "x-ms-examples": { + "SecurityPolicies_ListByProfile": { + "$ref": "./examples/SecurityPolicies_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicyListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/securityPolicies/{securityPolicyName}": { + "get": { + "tags": [ + "SecurityPolicies" + ], + "description": "Gets an existing security policy within a profile.", + "operationId": "SecurityPolicies_Get", + "x-ms-examples": { + "SecurityPolicies_Get": { + "$ref": "./examples/SecurityPolicies_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "SecurityPolicies" + ], + "description": "Creates a new security policy within the specified profile.", + "operationId": "SecurityPolicies_Create", + "x-ms-examples": { + "SecurityPolicies_Create": { + "$ref": "./examples/SecurityPolicies_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicy", + "in": "body", + "description": "The security policy properties.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPolicies" + ], + "description": "Updates an existing security policy within a profile.", + "operationId": "SecurityPolicies_Patch", + "x-ms-examples": { + "SecurityPolicies_Patch": { + "$ref": "./examples/SecurityPolicies_Patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyUpdateProperties", + "in": "body", + "description": "Security policy update properties", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPolicyUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityPolicy" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SecurityPolicies" + ], + "description": "Deletes an existing security policy within profile.", + "operationId": "SecurityPolicies_Delete", + "x-ms-examples": { + "SecurityPolicies_Delete": { + "$ref": "./examples/SecurityPolicies_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "securityPolicyName", + "in": "path", + "description": "Name of the security policy under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Lists existing AzureFrontDoor secrets.", + "operationId": "Secrets_ListByProfile", + "x-ms-examples": { + "Secrets_ListByProfile": { + "$ref": "./examples/Secrets_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretListResult" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}": { + "get": { + "tags": [ + "Secrets" + ], + "description": "Gets an existing Secret within a profile.", + "operationId": "Secrets_Get", + "x-ms-examples": { + "Secrets_Get": { + "$ref": "./examples/Secrets_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Secrets" + ], + "description": "Creates a new Secret within the specified profile.", + "operationId": "Secrets_Create", + "x-ms-examples": { + "Secrets_Create": { + "$ref": "./examples/Secrets_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "The Secret properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new delivery rule has been created.", + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Secret" + } + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Secrets" + ], + "description": "Deletes an existing Secret within profile.", + "operationId": "Secrets_Delete", + "x-ms-examples": { + "Secrets_Delete": { + "$ref": "./examples/Secrets_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "secretName", + "in": "path", + "description": "Name of the Secret under the profile.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "Azure Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsMetrics": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsMetrics.json" + } + }, + "description": "Get log report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "clientRequestBandwidth", + "originRequestTraffic", + "originRequestBandwidth", + "totalLatency" + ], + "x-ms-enum": { + "name": "LogMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "LogMetricsGranularity", + "modelAsString": true + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "protocol", + "cacheStatus", + "countryOrRegion", + "customDomain" + ], + "x-ms-enum": { + "name": "LogMetricsGroupBy", + "modelAsString": true + } + } + }, + { + "name": "continents", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "countryOrRegions", + "type": "array", + "in": "query", + "collectionFormat": "multi", + "required": false, + "items": { + "type": "string" + } + }, + { + "name": "customDomains", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + }, + { + "name": "protocols", + "type": "array", + "required": true, + "collectionFormat": "multi", + "in": "query", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/MetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsRankings": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsRankings.json" + } + }, + "description": "Get log analytics ranking report for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "url", + "referrer", + "browser", + "userAgent", + "countryOrRegion" + ], + "x-ms-enum": { + "name": "LogRanking", + "modelAsString": true + } + } + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount", + "clientRequestTraffic", + "hitCount", + "missCount", + "userErrorCount", + "errorCount" + ], + "x-ms-enum": { + "name": "LogRankingMetric", + "modelAsString": true + } + } + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "customDomains", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/RankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsLocations": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsLocations", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsLocations": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsLocations.json" + } + }, + "description": "Get all available location names for AFD log analytics report.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ContinentsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getLogAnalyticsResources": { + "get": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_GetLogAnalyticsResources", + "x-ms-examples": { + "LogAnalytics_GetLogAnalyticsResources": { + "$ref": "./examples/LogAnalytics_GetLogAnalyticsResources.json" + } + }, + "description": "Get all endpoints and custom domains available for AFD log report", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/ResourcesResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsMetrics": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsMetrics", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsMetrics": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsMetrics.json" + } + }, + "description": "Get Waf related log analytics report for AFD profile.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "granularity", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafGranularity", + "modelAsString": true + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "groupBy", + "in": "query", + "type": "array", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "httpStatusCode", + "customDomain" + ], + "x-ms-enum": { + "name": "WafRankingGroupBy", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafMetricsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getWafLogAnalyticsRankings": { + "get": { + "tags": [ + "WafLogAnalytics" + ], + "operationId": "LogAnalytics_GetWafLogAnalyticsRankings", + "x-ms-examples": { + "LogAnalytics_GetWafLogAnalyticsRankings": { + "$ref": "./examples/LogAnalytics_GetWafLogAnalyticsRankings.json" + } + }, + "description": "Get WAF log analytics charts for AFD profile", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "metrics", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "clientRequestCount" + ], + "x-ms-enum": { + "name": "WafMetric", + "modelAsString": true + } + } + }, + { + "name": "dateTimeBegin", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "dateTimeEnd", + "type": "string", + "in": "query", + "required": true, + "format": "date-time" + }, + { + "name": "maxRanking", + "in": "query", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "rankings", + "type": "array", + "in": "query", + "required": true, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "action", + "ruleGroup", + "ruleId", + "userAgent", + "clientIp", + "url", + "countryOrRegion", + "ruleType" + ], + "x-ms-enum": { + "name": "WafRankingType", + "modelAsString": true + } + } + }, + { + "name": "actions", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "allow", + "block", + "log", + "redirect" + ], + "x-ms-enum": { + "name": "WafAction", + "modelAsString": true + } + } + }, + { + "name": "ruleTypes", + "type": "array", + "in": "query", + "required": false, + "collectionFormat": "multi", + "items": { + "type": "string", + "enum": [ + "managed", + "custom", + "bot" + ], + "x-ms-enum": { + "name": "WafRuleType", + "modelAsString": true + } + } + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/WafRankingsResponse" + } + }, + "default": { + "description": "Azure Front Door Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/AfdErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ProfileChangeSkuWafMapping": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "securityPolicyName", + "changeToWafPolicy" + ], + "properties": { + "securityPolicyName": { + "description": "The security policy name.", + "type": "string" + }, + "changeToWafPolicy": { + "description": "The new waf resource for the security policy to use.", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "ProfileUpgradeParameters": { + "type": "object", + "description": "Parameters required for profile upgrade.", + "required": [ + "wafMappingList" + ], + "properties": { + "wafMappingList": { + "description": "Web Application Firewall (WAF) and security policy mapping for the profile upgrade", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/ProfileChangeSkuWafMapping" + }, + "x-ms-identifiers": [] + } + } + }, + "AfdPurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + }, + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Certificate": { + "description": "Certificate used for https", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedCertificate": { + "description": "Managed Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "CustomerCertificate": { + "description": "Customer Certificate used for https", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Certificate version.", + "type": "string" + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificate": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "allOf": [ + { + "$ref": "#/definitions/Certificate" + } + ] + }, + "ValidateSecretInput": { + "description": "Input of the secret to be validated.", + "type": "object", + "required": [ + "secretSource", + "secretType" + ], + "properties": { + "secretType": { + "description": "The secret type.", + "$ref": "#/definitions/SecretType" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Secret version, if customer is using a specific version.", + "type": "string" + } + } + }, + "ValidateSecretOutput": { + "description": "Output of the validated secret.", + "type": "object", + "properties": { + "status": { + "description": "The validation status.", + "enum": [ + "Valid", + "Invalid", + "AccessDenied", + "CertificateExpired" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "message": { + "description": "Detailed error message", + "type": "string" + } + } + }, + "AFDDomainListResult": { + "description": "Result of the request to list domains. It contains a list of domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDDomain" + }, + "description": "List of AzureFrontDoor domains within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of domain objects if there are any." + } + } + }, + "AFDDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainProperties" + } + } + }, + "AFDDomainProperties": { + "description": "The JSON object that contains the properties of the domain to create.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "domainValidationState": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.", + "readOnly": true, + "enum": [ + "Unknown", + "Submitting", + "Pending", + "Rejected", + "TimedOut", + "PendingRevalidation", + "Approved", + "RefreshingValidationToken", + "InternalError" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainValidationState", + "modelAsString": true + } + }, + "hostName": { + "description": "The host name of the domain. Must be a domain name.", + "type": "string" + }, + "extendedProperties": { + "description": "Key-Value pair representing migration properties for domains.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "validationProperties": { + "description": "Values the customer needs to validate domain ownership", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/DomainValidationProperties" + } + } + }, + "AFDDomainUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDDomainUpdatePropertiesParameters" + } + } + }, + "AFDDomainUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the domain.", + "type": "string", + "readOnly": true + }, + "tlsSettings": { + "description": "The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.", + "type": "object", + "$ref": "#/definitions/AFDDomainHttpsParameters" + }, + "azureDnsZone": { + "description": "Resource reference to the Azure DNS zone", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "preValidatedCustomDomainResourceId": { + "description": "Resource reference to the Azure resource where custom domain ownership was prevalidated", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "DomainValidationProperties": { + "description": "The JSON object that contains the properties to validate a domain.", + "properties": { + "validationToken": { + "description": "Challenge used for DNS TXT record or file based validation", + "readOnly": true, + "type": "string" + }, + "expirationDate": { + "description": "The date time that the token expires", + "readOnly": true, + "type": "string" + } + } + }, + "AFDDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a domain.", + "required": [ + "certificateType" + ], + "properties": { + "certificateType": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdCertificateType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "AfdMinimumTlsVersion", + "modelAsString": false + } + }, + "secret": { + "description": "Resource reference to the secret. ie. subs/rg/profile/secret", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + } + } + }, + "SecurityPolicy": { + "description": "SecurityPolicy association for AzureFrontDoor profile", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyProperties" + } + } + }, + "SecurityPolicyProperties": { + "description": "The json object that contains properties required to create a security policy", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the security policy.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyUpdateParameters": { + "description": "The JSON object containing security policy update parameters.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPolicyUpdateProperties" + } + } + }, + "SecurityPolicyUpdateProperties": { + "description": "The json object that contains properties required to update a security policy", + "type": "object", + "properties": { + "parameters": { + "description": "object which contains security policy parameters", + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + } + }, + "SecurityPolicyPropertiesParameters": { + "description": "The json object containing security policy parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of the Security policy to create.", + "enum": [ + "WebApplicationFirewall" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityPolicyType", + "modelAsString": true + } + } + } + }, + "SecurityPolicyWebApplicationFirewallParameters": { + "description": "The json object containing security policy waf parameters", + "x-ms-discriminator-value": "WebApplicationFirewall", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecurityPolicyPropertiesParameters" + } + ], + "properties": { + "wafPolicy": { + "type": "object", + "description": "Resource ID.", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "associations": { + "description": "Waf associations", + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPolicyWebApplicationFirewallAssociation" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityPolicyWebApplicationFirewallAssociation": { + "description": "settings for security policy patterns to match", + "type": "object", + "properties": { + "domains": { + "description": "List of domains.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "patternsToMatch": { + "description": "List of paths", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SecurityPolicyListResult": { + "description": "Result of the request to list security policies. It contains a list of security policy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SecurityPolicy" + }, + "description": "List of Security policies within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of security policy objects if there is any." + } + } + }, + "AutoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "type": "string", + "x-ms-enum": { + "name": "AutoGeneratedDomainNameLabelScope", + "modelAsString": true + } + }, + "AFDEndpoint": { + "description": "Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointProperties" + } + } + }, + "AFDEndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "allOf": [ + { + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "AFDEndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDEndpoint" + }, + "description": "List of AzureFrontDoor endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "AFDEndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDEndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDEndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the endpoint.", + "type": "string", + "readOnly": true + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "CompressionSettings": { + "description": "settings for compression.", + "type": "object", + "properties": { + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + } + } + }, + "AFDEndpointProtocols": { + "description": "Supported protocols for the customer's endpoint.", + "enum": [ + "Http", + "Https" + ], + "type": "string", + "x-ms-enum": { + "name": "AFDEndpointProtocols", + "modelAsString": true + } + }, + "SecretListResult": { + "description": "Result of the request to list secrets. It contains a list of Secret objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Secret" + }, + "description": "List of AzureFrontDoor secrets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Secret objects if there are any." + } + } + }, + "Secret": { + "description": "Friendly Secret name mapping to the any Secret or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretProperties" + } + } + }, + "SecretProperties": { + "description": "The JSON object that contains the properties of the Secret to create.", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the secret.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "object which contains secret parameters", + "$ref": "#/definitions/SecretParameters" + } + } + }, + "SecretParameters": { + "description": "The json object containing secret parameters", + "discriminator": "type", + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/SecretType" + } + } + }, + "SecretType": { + "description": "The type of the secret resource.", + "enum": [ + "UrlSigningKey", + "CustomerCertificate", + "ManagedCertificate", + "AzureFirstPartyManagedCertificate" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true + } + }, + "UrlSigningKeyParameters": { + "description": "Url signing key parameters", + "x-ms-discriminator-value": "UrlSigningKey", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "keyId", + "secretSource" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "secretSource": { + "description": "Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + } + } + }, + "ManagedCertificateParameters": { + "description": "Managed Certificate used for https", + "x-ms-discriminator-value": "ManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "CustomerCertificateParameters": { + "description": "Customer Certificate used for https", + "x-ms-discriminator-value": "CustomerCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "required": [ + "secretSource" + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "secretVersion": { + "description": "Version of the secret to be used", + "type": "string" + }, + "useLatestVersion": { + "description": "Whether to use the latest version for the certificate", + "type": "boolean" + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFirstPartyManagedCertificateParameters": { + "description": "Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS.", + "x-ms-discriminator-value": "AzureFirstPartyManagedCertificate", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretParameters" + } + ], + "properties": { + "secretSource": { + "description": "Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "readOnly": true + }, + "subject": { + "description": "Subject name in the certificate.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "certificateAuthority": { + "description": "Certificate issuing authority.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "The list of SANs.", + "type": "array", + "items": { + "type": "string", + "readOnly": true + } + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + } + } + }, + "RuleSetListResult": { + "description": "Result of the request to list rule sets. It contains a list of rule set objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RuleSet" + }, + "description": "List of AzureFrontDoor rule sets within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule set objects if there are any." + } + } + }, + "RuleSet": { + "description": "Friendly RuleSet name mapping to the any RuleSet or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleSetProperties" + } + } + }, + "RuleSetProperties": { + "description": "The JSON object that contains the properties of the Rule Set to create.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "properties": { + "profileName": { + "description": "The name of the profile which holds the rule set.", + "type": "string", + "readOnly": true + } + } + }, + "AFDOrigin": { + "description": "Azure Front Door origin is the source of the content being delivered via Azure Front Door. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginProperties" + } + } + }, + "AFDOriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginUpdateParameters": { + "type": "object", + "description": "AFDOrigin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "originGroupName": { + "description": "The name of the origin group which contains this origin.", + "type": "string", + "readOnly": true + }, + "azureOrigin": { + "description": "Resource reference to the Azure origin resource.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 80 + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "format": "int32", + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "default": 443 + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "sharedPrivateLinkResource": { + "description": "The properties of the private link resource for private origin.", + "type": "object", + "$ref": "#/definitions/SharedPrivateLinkResourceProperties" + }, + "enabledState": { + "description": "Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + }, + "enforceCertificateNameCheck": { + "description": "Whether to enable certificate name check at origin level", + "type": "boolean", + "default": true + } + } + }, + "SharedPrivateLinkResourceProperties": { + "properties": { + "privateLink": { + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference", + "description": "The resource id of the resource the shared private link resource is for." + }, + "privateLinkLocation": { + "type": "string", + "description": "The location of the shared private link resource" + }, + "groupId": { + "type": "string", + "description": "The group id from the provider of resource the shared private link resource is for." + }, + "requestMessage": { + "type": "string", + "description": "The request message for requesting approval of the shared private link resource." + }, + "status": { + "type": "string", + "description": "Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "SharedPrivateLinkResourceStatus", + "modelAsString": false + } + } + }, + "description": "Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin." + }, + "AFDOriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOrigin" + }, + "description": "List of Azure Front Door origins within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "AFDOriginGroup": { + "description": "AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupProperties" + } + } + }, + "AFDOriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "AFDOriginGroupUpdateParameters": { + "type": "object", + "description": "AFDOrigin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AFDOriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "AFDOriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "profileName": { + "description": "The name of the profile which holds the origin group.", + "type": "string", + "readOnly": true + }, + "loadBalancingSettings": { + "description": "Load balancing settings for a backend pool", + "$ref": "#/definitions/LoadBalancingSettingsParameters" + }, + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "./cdn.json#/definitions/HealthProbeParameters" + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "sessionAffinityState": { + "description": "Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "LoadBalancingSettingsParameters": { + "description": "Round-Robin load balancing settings for a backend pool", + "type": "object", + "properties": { + "sampleSize": { + "description": "The number of samples to consider for load balancing decisions", + "type": "integer", + "format": "int32" + }, + "successfulSamplesRequired": { + "description": "The number of samples within the sample period that must succeed", + "type": "integer", + "format": "int32" + }, + "additionalLatencyInMilliseconds": { + "description": "The additional latency in milliseconds for probes to fall into the lowest latency bucket", + "type": "integer", + "format": "int32" + } + } + }, + "AFDOriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AFDOriginGroup" + }, + "description": "List of Azure Front Door origin groups within an Azure Front Door endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "RouteListResult": { + "description": "Result of the request to list routes. It contains a list of route objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Route" + }, + "description": "List of AzureFrontDoor routes within a profile." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of route objects if there are any." + } + } + }, + "Route": { + "description": "Friendly Routes name mapping to the any Routes or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteProperties" + } + } + }, + "RouteProperties": { + "description": "The JSON object that contains the properties of the Routes to create.", + "allOf": [ + { + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ], + "required": [ + "originGroup" + ] + }, + "RouteUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteUpdatePropertiesParameters" + } + } + }, + "RouteUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the domain to create.", + "properties": { + "endpointName": { + "description": "The name of the endpoint which holds the route.", + "type": "string", + "readOnly": true + }, + "customDomains": { + "description": "Domains referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/ActivatedResourceReference" + } + }, + "originGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "./cdn.json#/definitions/ResourceReference" + }, + "originPath": { + "description": "A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "ruleSets": { + "description": "rule sets referenced by this endpoint.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/ResourceReference" + } + }, + "supportedProtocols": { + "description": "List of supported protocols for this route.", + "type": "array", + "items": { + "$ref": "#/definitions/AFDEndpointProtocols" + }, + "default": [ + "Http", + "Https" + ] + }, + "patternsToMatch": { + "description": "The route patterns of the rule.", + "type": "array", + "items": { + "type": "string", + "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path." + } + }, + "cacheConfiguration": { + "description": "The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/AfdRouteCacheConfiguration" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + }, + "default": "MatchRequest" + }, + "linkToDefaultDomain": { + "description": "whether this route will be linked to the default endpoint domain.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LinkToDefaultDomain", + "modelAsString": true + }, + "default": "Disabled" + }, + "httpsRedirect": { + "description": "Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "httpsRedirect", + "modelAsString": true + }, + "default": "Disabled" + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnabledState", + "modelAsString": true + } + } + } + }, + "AfdRouteCacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "afdQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "compressionSettings": { + "description": "compression settings.", + "type": "object", + "$ref": "#/definitions/CompressionSettings" + } + } + }, + "RuleListResult": { + "description": "Result of the request to list rules. It contains a list of rule objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Rule" + }, + "description": "List of AzureFrontDoor rules within a rule set." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of rule objects if there are any." + } + } + }, + "Rule": { + "description": "Friendly Rules name mapping to the any Rules or secret related information.", + "type": "object", + "allOf": [ + { + "$ref": "./cdn.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleProperties" + } + } + }, + "RuleProperties": { + "description": "The JSON object that contains the properties of the Rules to create.", + "type": "object", + "required": [ + "order", + "actions" + ], + "allOf": [ + { + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + }, + { + "$ref": "#/definitions/AFDStateProperties" + } + ] + }, + "RuleUpdateParameters": { + "description": "The domain JSON object required for domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RuleUpdatePropertiesParameters" + } + } + }, + "RuleUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the rule to update.", + "properties": { + "ruleSetName": { + "description": "The name of the rule set containing the rule.", + "type": "string", + "readOnly": true + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "./cdn.json#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "matchProcessingBehavior": { + "description": "If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.", + "type": "string", + "enum": [ + "Continue", + "Stop" + ], + "x-ms-enum": { + "name": "MatchProcessingBehavior", + "modelAsString": true + }, + "default": "Continue" + } + } + }, + "CheckEndpointNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "./cdn.json#/definitions/ResourceType" + }, + "autoGeneratedDomainNameLabelScope": { + "description": "Indicates the endpoint name reuse scope. The default value is TenantReuse.", + "$ref": "#/definitions/AutoGeneratedDomainNameLabelScope" + } + } + }, + "CheckEndpointNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "availableHostname": { + "description": "Returns the available hostname generated based on the AutoGeneratedDomainNameLabelScope when the name is available, otherwise it returns empty string", + "readOnly": true, + "type": "string" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckHostNameAvailabilityInput": { + "description": "Input of CheckHostNameAvailability API.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name to validate.", + "type": "string" + } + } + }, + "ValidationToken": { + "description": "The validation token.", + "type": "object", + "properties": { + "token": { + "readOnly": true, + "type": "string" + } + } + }, + "AFDStateProperties": { + "description": "The tracking states for afd resources.", + "type": "object", + "properties": { + "provisioningState": { + "readOnly": true, + "description": "Provisioning status", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "AfdProvisioningState", + "modelAsString": true + } + }, + "deploymentStatus": { + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true + } + } + } + }, + "AfdErrorResponse": { + "title": "Error response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", + "properties": { + "error": { + "description": "The error object.", + "$ref": "./cdn.json#/definitions/ErrorDetail" + } + } + }, + "MetricsResponse": { + "description": "Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "MetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count", + "bytes", + "bitsPerSecond", + "milliSeconds" + ], + "x-ms-enum": { + "name": "MetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "RankingsResponse": { + "description": "Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "tables": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ranking": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "ContinentsResponse": { + "description": "Continents Response", + "properties": { + "continents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + } + } + } + }, + "countryOrRegions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "continentId": { + "type": "string" + } + } + } + } + } + }, + "ResourcesResponse": { + "description": "Resources Response", + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "history": { + "type": "boolean" + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + } + }, + "customDomains": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "endpointId": { + "type": "string" + }, + "history": { + "type": "boolean" + } + } + } + } + } + }, + "WafMetricsResponse": { + "description": "Waf Metrics Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "granularity": { + "type": "string", + "enum": [ + "PT5M", + "PT1H", + "P1D" + ], + "x-ms-enum": { + "name": "WafMetricsGranularity", + "modelAsString": true + } + }, + "series": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "unit": { + "type": "string", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "WafMetricsSeriesUnit", + "modelAsString": true + } + }, + "groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dateTime": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "number" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "WafRankingsResponse": { + "description": "Waf Rankings Response", + "properties": { + "dateTimeBegin": { + "type": "string", + "format": "date-time" + }, + "dateTimeEnd": { + "type": "string", + "format": "date-time" + }, + "groups": { + "type": "array", + "items": { + "type": "string" + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "groupValues": { + "type": "array", + "items": { + "type": "string" + } + }, + "metrics": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metric": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + }, + "percentage": { + "type": "number", + "format": "double" + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "x-ms-identifiers": [] + } + } + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + }, + "ActivatedResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "isActive": { + "readOnly": true, + "type": "boolean", + "description": "Whether the resource is active or inactive" + } + }, + "description": "Reference to another resource along with its state.", + "type": "object", + "x-ms-azure-resource": true + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json new file mode 100644 index 000000000000..8a76359927c1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdn.json @@ -0,0 +1,7466 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "CdnManagementClient", + "description": "Use these APIs to manage Azure CDN resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.", + "operationId": "Profiles_List", + "x-ms-examples": { + "Profiles_List": { + "$ref": "./examples/Profiles_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.", + "operationId": "Profiles_ListByResourceGroup", + "x-ms-examples": { + "Profiles_ListByResourceGroup": { + "$ref": "./examples/Profiles_ListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProfileListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}": { + "get": { + "tags": [ + "Profiles" + ], + "description": "Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Get", + "x-ms-examples": { + "Profiles_Get": { + "$ref": "./examples/Profiles_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Profiles" + ], + "description": "Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.", + "operationId": "Profiles_Create", + "x-ms-examples": { + "Profiles_Create": { + "$ref": "./examples/Profiles_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "description": "Profile properties needed to create a new profile.", + "in": "body", + "name": "profile", + "required": true, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new profile has been created.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Profiles" + ], + "description": "Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.", + "operationId": "Profiles_Update", + "x-ms-examples": { + "Profiles_Update": { + "$ref": "./examples/Profiles_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "profileUpdateParameters", + "in": "body", + "description": "Profile properties needed to update an existing profile.", + "required": true, + "schema": { + "$ref": "#/definitions/ProfileUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Profiles" + ], + "description": "Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.", + "operationId": "Profiles_Delete", + "x-ms-examples": { + "Profiles_Delete": { + "$ref": "./examples/Profiles_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the profile was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CanMigrate", + "x-ms-examples": { + "Profiles_CanMigrate": { + "$ref": "./examples/Profiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to check if cdn profile or classic frontdoor can be migrated.", + "in": "body", + "name": "canMigrateParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CanMigrateParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/migrate": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.", + "operationId": "Profiles_Migrate", + "x-ms-examples": { + "Profiles_Migrate": { + "$ref": "./examples/Profiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationCommit": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Commit the migrated Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_MigrationCommit", + "x-ms-examples": { + "Profiles_MigrationCommit": { + "$ref": "./examples/Profiles_MigrationCommit.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/generateSsoUri": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "operationId": "Profiles_GenerateSsoUri", + "x-ms-examples": { + "Profiles_GenerateSsoUri": { + "$ref": "./examples/Profiles_GenerateSsoUri.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SsoUri" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/getSupportedOptimizationTypes": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.", + "operationId": "Profiles_ListSupportedOptimizationTypes", + "x-ms-examples": { + "Profiles_ListSupportedOptimizationTypes": { + "$ref": "./examples/Profiles_ListSupportedOptimizationTypes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SupportedOptimizationTypesListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/checkResourceUsage": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.", + "operationId": "Profiles_ListResourceUsage", + "x-ms-examples": { + "Profiles_ListResourceUsage": { + "$ref": "./examples/Profiles_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Lists existing CDN endpoints.", + "operationId": "Endpoints_ListByProfile", + "x-ms-examples": { + "Endpoints_ListByProfile": { + "$ref": "./examples/Endpoints_ListByProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EndpointListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}": { + "get": { + "tags": [ + "Endpoints" + ], + "description": "Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Get", + "x-ms-examples": { + "Endpoints_Get": { + "$ref": "./examples/Endpoints_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Endpoints" + ], + "description": "Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Create", + "x-ms-examples": { + "Endpoints_Create": { + "$ref": "./examples/Endpoints_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpoint", + "in": "body", + "description": "Endpoint properties", + "required": true, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new endpoint has been created.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Endpoints" + ], + "description": "Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.", + "operationId": "Endpoints_Update", + "x-ms-examples": { + "Endpoints_Update": { + "$ref": "./examples/Endpoints_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "endpointUpdateProperties", + "in": "body", + "description": "Endpoint update properties", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Endpoints" + ], + "description": "Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.", + "operationId": "Endpoints_Delete", + "x-ms-examples": { + "Endpoints_Delete": { + "$ref": "./examples/Endpoints_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the endpoint was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Starts an existing CDN endpoint that is on a stopped state.", + "operationId": "Endpoints_Start", + "x-ms-examples": { + "Endpoints_Start": { + "$ref": "./examples/Endpoints_Start.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Stops an existing running CDN endpoint.", + "operationId": "Endpoints_Stop", + "x-ms-examples": { + "Endpoints_Stop": { + "$ref": "./examples/Endpoints_Stop.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Removes a content from CDN.", + "operationId": "Endpoints_PurgeContent", + "x-ms-examples": { + "Endpoints_PurgeContent": { + "$ref": "./examples/Endpoints_PurgeContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Pre-loads a content to CDN. Available for Verizon Profiles.", + "operationId": "Endpoints_LoadContent", + "x-ms-examples": { + "Endpoints_LoadContent": { + "$ref": "./examples/Endpoints_LoadContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", + "required": true, + "schema": { + "$ref": "#/definitions/LoadParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.", + "operationId": "Endpoints_ValidateCustomDomain", + "x-ms-examples": { + "Endpoints_ValidateCustomDomain": { + "$ref": "./examples/Endpoints_ValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage": { + "post": { + "tags": [ + "Endpoints" + ], + "description": "Checks the quota and usage of geo filters and custom domains under the given endpoint.", + "operationId": "Endpoints_ListResourceUsage", + "x-ms-examples": { + "Endpoints_ListResourceUsage": { + "$ref": "./examples/Endpoints_ListResourceUsage.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins": { + "get": { + "tags": [ + "Origins" + ], + "description": "Lists all of the existing origins within an endpoint.", + "operationId": "Origins_ListByEndpoint", + "x-ms-examples": { + "Origins_ListByEndpoint": { + "$ref": "./examples/Origins_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/origins/{originName}": { + "get": { + "tags": [ + "Origins" + ], + "description": "Gets an existing origin within an endpoint.", + "operationId": "Origins_Get", + "x-ms-examples": { + "Origins_Get": { + "$ref": "./examples/Origins_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Origins" + ], + "description": "Creates a new origin within the specified endpoint.", + "operationId": "Origins_Create", + "x-ms-examples": { + "Origins_Create": { + "$ref": "./examples/Origins_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin that is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "origin", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin has been created.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Origins" + ], + "description": "Updates an existing origin within an endpoint.", + "operationId": "Origins_Update", + "x-ms-examples": { + "Origins_Update": { + "$ref": "./examples/Origins_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originUpdateProperties", + "in": "body", + "description": "Origin properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Origin" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Origins" + ], + "description": "Deletes an existing origin within an endpoint.", + "operationId": "Origins_Delete", + "x-ms-examples": { + "Origins_Delete": { + "$ref": "./examples/Origins_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originName", + "in": "path", + "description": "Name of the origin which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Lists all of the existing origin groups within an endpoint.", + "operationId": "OriginGroups_ListByEndpoint", + "x-ms-examples": { + "OriginsGroups_ListByEndpoint": { + "$ref": "./examples/OriginGroups_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroupListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups/{originGroupName}": { + "get": { + "tags": [ + "OriginGroups" + ], + "description": "Gets an existing origin group within an endpoint.", + "operationId": "OriginGroups_Get", + "x-ms-examples": { + "OriginGroups_Get": { + "$ref": "./examples/OriginGroups_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "OriginGroups" + ], + "description": "Creates a new origin group within the specified endpoint.", + "operationId": "OriginGroups_Create", + "x-ms-examples": { + "OriginGroups_Create": { + "$ref": "./examples/OriginGroups_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroup", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new origin group has been created.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "OriginGroups" + ], + "description": "Updates an existing origin group within an endpoint.", + "operationId": "OriginGroups_Update", + "x-ms-examples": { + "OriginGroups_Update": { + "$ref": "./examples/OriginGroups_Update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "name": "originGroupUpdateProperties", + "in": "body", + "description": "Origin group properties", + "required": true, + "schema": { + "$ref": "#/definitions/OriginGroupUpdateParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OriginGroup" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "OriginGroups" + ], + "description": "Deletes an existing origin group within an endpoint.", + "operationId": "OriginGroups_Delete", + "x-ms-examples": { + "OriginGroups_Delete": { + "$ref": "./examples/OriginGroups_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "originGroupName", + "in": "path", + "description": "Name of the origin group which is unique within the endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content. The request has been accepted but the origin was not found." + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Lists all of the existing custom domains within an endpoint.", + "operationId": "CustomDomains_ListByEndpoint", + "x-ms-examples": { + "CustomDomains_ListByEndpoint": { + "$ref": "./examples/CustomDomains_ListByEndpoint.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomainListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}": { + "get": { + "tags": [ + "CustomDomains" + ], + "description": "Gets an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Get", + "x-ms-examples": { + "CustomDomains_Get": { + "$ref": "./examples/CustomDomains_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "CustomDomains" + ], + "description": "Creates a new custom domain within an endpoint.", + "operationId": "CustomDomains_Create", + "x-ms-examples": { + "CustomDomains_Create": { + "$ref": "./examples/CustomDomains_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Properties required to create a new custom domain.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomDomainParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new custom domain has been created.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomDomains" + ], + "description": "Deletes an existing custom domain within an endpoint.", + "operationId": "CustomDomains_Delete", + "x-ms-examples": { + "CustomDomains_Delete": { + "$ref": "./examples/CustomDomains_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "204": { + "description": "No Content. The request has been accepted but the custom domain was not found" + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/disableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Disable https delivery of the custom domain.", + "operationId": "CustomDomains_DisableCustomHttps", + "x-ms-examples": { + "CustomDomains_DisableCustomHttps": { + "$ref": "./examples/CustomDomains_DisableCustomHttps.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/customDomains/{customDomainName}/enableCustomHttps": { + "post": { + "tags": [ + "CustomDomains" + ], + "description": "Enable https delivery of the custom domain.", + "operationId": "CustomDomains_EnableCustomHttps", + "x-ms-examples": { + "CustomDomains_EnableCustomHttpsUsingYourOwnCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingBYOC.json" + }, + "CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate": { + "$ref": "./examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "profileName", + "in": "path", + "description": "Name of the CDN profile which is unique within the resource group.", + "required": true, + "type": "string" + }, + { + "name": "endpointName", + "in": "path", + "description": "Name of the endpoint under the profile which is unique globally.", + "required": true, + "type": "string" + }, + { + "name": "customDomainName", + "in": "path", + "description": "Name of the custom domain within an endpoint.", + "required": true, + "type": "string" + }, + { + "name": "customDomainHttpsParameters", + "in": "body", + "description": "The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user's own certificate. If not specified, enabling ssl uses CDN managed certificate by default.", + "required": false, + "schema": { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CustomDomain" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.", + "operationId": "CheckNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe": { + "post": { + "tags": [ + "ValidateProbe" + ], + "description": "Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.", + "operationId": "ValidateProbe", + "x-ms-examples": { + "ValidateProbe": { + "$ref": "./examples/ValidateProbe.json" + } + }, + "parameters": [ + { + "name": "validateProbeInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateProbeInput" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProbeOutput" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/checkResourceUsage": { + "post": { + "tags": [ + "CheckResourceUsage" + ], + "description": "Check the quota and actual usage of the CDN profiles under the given subscription.", + "operationId": "ResourceUsage_List", + "x-ms-examples": { + "ResourceUsage_List": { + "$ref": "./examples/ResourceUsage_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ResourceUsageListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available CDN REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Cdn/edgenodes": { + "get": { + "tags": [ + "Edgenodes" + ], + "description": "Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.", + "operationId": "EdgeNodes_List", + "x-ms-examples": { + "EdgeNodes_List": { + "$ref": "./examples/EdgeNodes_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EdgenodeResult" + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnCanMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.", + "operationId": "Profiles_CdnCanMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnCanMigrate": { + "$ref": "./examples/CdnProfiles_CanMigrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CanMigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/cdnMigrateToAfd": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. This step prepares the profile for migration and will be followed by Commit to finalize the migration.", + "operationId": "Profiles_CdnMigrateToAfd", + "x-ms-examples": { + "Profiles_CdnMigrate": { + "$ref": "./examples/CdnProfiles_Migrate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "description": "Properties needed to migrate the profile.", + "in": "body", + "name": "migrationParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnMigrationToAfdParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MigrateResult" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/migrationAbort": { + "post": { + "tags": [ + "Profiles" + ], + "description": "Abort the migration to Azure Frontdoor Premium/Standard.", + "operationId": "Profiles_MigrationAbort", + "x-ms-examples": { + "Profiles_CdnMigrationCommit": { + "$ref": "./examples/Profiles_MigrationAbort.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/profileNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + } + }, + "default": { + "description": "CDN error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Profile": { + "description": "A profile is a logical grouping of endpoints that share the same settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The pricing tier (defines Azure Front Door Standard or Premium or a CDN provider, feature list and rate) of the profile.", + "$ref": "#/definitions/Sku" + }, + "kind": { + "readOnly": true, + "type": "string", + "description": "Kind of the profile. Used by portal to differentiate traditional CDN profile and new AFD profile." + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfileProperties" + } + }, + "required": [ + "sku" + ] + }, + "ProfileProperties": { + "description": "The JSON object that contains the properties required to create a profile.", + "properties": { + "resourceState": { + "description": "Resource status of the profile.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting", + "Disabled", + "Migrating", + "Migrated", + "PendingMigrationCommit", + "CommittingMigration", + "AbortingMigration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProfileResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the profile.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "ProfileProvisioningState", + "modelAsString": true + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for profiles.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "frontDoorId": { + "readOnly": true, + "type": "string", + "description": "The Id of the frontdoor." + }, + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileLogScrubbing": { + "description": "Defines rules that scrub sensitive fields in the Azure Front Door profile logs.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "State of the log scrubbing config. Default value is Enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ProfileScrubbingState", + "modelAsString": true + } + }, + "scrubbingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ProfileScrubbingRules" + }, + "x-ms-identifiers": [], + "description": "List of log scrubbing rules applied to the Azure Front Door profile logs." + } + } + }, + "ProfileListResult": { + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Profile" + }, + "description": "List of CDN profiles within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of profile objects if there are any." + } + } + }, + "ProfileUpdateParameters": { + "type": "object", + "description": "Properties required to update a profile.", + "properties": { + "tags": { + "description": "Profile tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Managed service identity (system assigned and/or user assigned identities).", + "type": "object", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProfilePropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "ProfilePropertiesUpdateParameters": { + "type": "object", + "description": "The JSON object containing profile update parameters.", + "properties": { + "originResponseTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the origin. When timeout is reached, the request fails and returns.", + "type": "integer", + "format": "int32", + "minimum": 16, + "exclusiveMinimum": false + }, + "logScrubbing": { + "description": "Defines rules to scrub sensitive fields in logs", + "$ref": "#/definitions/ProfileLogScrubbing" + } + } + }, + "ProfileScrubbingRules": { + "description": "Defines the contents of the log scrubbing rules.", + "type": "object", + "required": [ + "matchVariable", + "selectorMatchOperator" + ], + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestIPAddress", + "RequestUri", + "QueryStringArgNames" + ], + "description": "The variable to be scrubbed from the logs.", + "x-ms-enum": { + "name": "scrubbingRuleEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to.", + "x-ms-enum": { + "name": " scrubbingRuleEntryMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to." + }, + "state": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Defines the state of a log scrubbing rule. Default value is enabled.", + "x-ms-enum": { + "name": " scrubbingRuleEntryState", + "modelAsString": true + } + } + } + }, + "CanMigrateResult": { + "type": "object", + "description": "Result for canMigrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CanMigrateProperties" + } + }, + "x-ms-azure-resource": true + }, + "CanMigrateProperties": { + "type": "object", + "properties": { + "canMigrate": { + "readOnly": true, + "description": "Flag that says if the profile can be migrated", + "type": "boolean" + }, + "defaultSku": { + "readOnly": true, + "description": "Recommended sku for the migration", + "type": "string", + "enum": [ + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor" + ], + "x-ms-enum": { + "name": "CanMigrateDefaultSku", + "modelAsString": true + } + }, + "errors": { + "items": { + "description": "List of migration errors", + "$ref": "#/definitions/MigrationErrorType" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "MigrationErrorType": { + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Resource which has the problem.", + "readOnly": true, + "type": "string" + }, + "errorMessage": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + }, + "nextSteps": { + "description": "Describes what needs to be done to fix the problem", + "readOnly": true, + "type": "string" + } + } + }, + "CanMigrateParameters": { + "type": "object", + "description": "Request body for CanMigrate operation.", + "required": [ + "classicResourceReference" + ], + "properties": { + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + } + }, + "x-ms-azure-resource": true + }, + "MigrationParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "classicResourceReference", + "sku", + "profileName" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "classicResourceReference": { + "description": "Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.", + "$ref": "#/definitions/ResourceReference" + }, + "profileName": { + "description": "Name of the new profile that need to be created.", + "type": "string" + }, + "migrationWebApplicationFirewallMappings": { + "description": "Waf mapping for the migrated profile", + "type": "array", + "items": { + "description": "List of waf mappings", + "$ref": "#/definitions/MigrationWebApplicationFirewallMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationWebApplicationFirewallMapping": { + "description": "Web Application Firewall Mapping ", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Migration From Waf policy", + "$ref": "#/definitions/ResourceReference" + }, + "migratedTo": { + "description": "Migration to Waf policy", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "MigrateResult": { + "type": "object", + "description": "Result for migrate operation.", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/MigrateResultProperties" + } + }, + "x-ms-azure-resource": true + }, + "MigrateResultProperties": { + "type": "object", + "properties": { + "migratedProfileResourceId": { + "readOnly": true, + "description": "Arm resource id of the migrated profile", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "SsoUri": { + "description": "The URI required to login to the supplemental portal from the Azure portal.", + "type": "object", + "properties": { + "ssoUriValue": { + "description": "The URI used to login to the supplemental portal.", + "readOnly": true, + "type": "string" + } + } + }, + "SupportedOptimizationTypesListResult": { + "description": "The result of the GetSupportedOptimizationTypes API", + "type": "object", + "properties": { + "supportedOptimizationTypes": { + "description": "Supported optimization types for a profile.", + "readOnly": true, + "items": { + "$ref": "#/definitions/OptimizationType" + }, + "type": "array" + } + } + }, + "DeliveryRuleConditionParameters": { + "description": "Defines the parameters for delivery rule match conditions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleRemoteAddressConditionParameters", + "DeliveryRuleRequestMethodConditionParameters", + "DeliveryRuleQueryStringConditionParameters", + "DeliveryRulePostArgsConditionParameters", + "DeliveryRuleRequestUriConditionParameters", + "DeliveryRuleRequestHeaderConditionParameters", + "DeliveryRuleRequestBodyConditionParameters", + "DeliveryRuleRequestSchemeConditionParameters", + "DeliveryRuleUrlPathMatchConditionParameters", + "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "DeliveryRuleUrlFilenameConditionParameters", + "DeliveryRuleHttpVersionConditionParameters", + "DeliveryRuleCookiesConditionParameters", + "DeliveryRuleIsDeviceConditionParameters", + "DeliveryRuleSocketAddrConditionParameters", + "DeliveryRuleClientPortConditionParameters", + "DeliveryRuleServerPortConditionParameters", + "DeliveryRuleHostNameConditionParameters", + "DeliveryRuleSslProtocolConditionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleConditionParametersType", + "modelAsString": true + } + } + } + }, + "DeliveryRuleActionParameters": { + "description": "Defines the parameters for delivery rule actions", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "DeliveryRuleUrlRedirectActionParameters", + "DeliveryRuleUrlSigningActionParameters", + "DeliveryRuleOriginGroupOverrideActionParameters", + "DeliveryRuleUrlRewriteActionParameters", + "DeliveryRuleHeaderActionParameters", + "DeliveryRuleCacheExpirationActionParameters", + "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "DeliveryRuleRouteConfigurationOverrideActionParameters" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionParametersType", + "modelAsString": true + } + } + } + }, + "CertificateSourceParameters": { + "description": "Defines the parameters for certificate source", + "type": "object", + "discriminator": "typeName", + "required": [ + "typeName" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "CdnCertificateSourceParameters", + "KeyVaultCertificateSourceParameters" + ], + "x-ms-enum": { + "name": "CertificateSourceParametersType", + "modelAsString": true + } + } + } + }, + "Endpoint": { + "description": "CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior. The CDN endpoint uses the URL format .azureedge.net.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointProperties" + } + } + }, + "EndpointProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + ], + "properties": { + "hostName": { + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", + "type": "string", + "readOnly": true + }, + "origins": { + "description": "The source of the content being delivered via CDN.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOrigin" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "originGroups": { + "description": "The origin groups comprising of origins that are used for load balancing the traffic based on availability.", + "type": "array", + "items": { + "$ref": "#/definitions/DeepCreatedOriginGroup" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "customDomains": { + "description": "The custom domains under the endpoint.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DeepCreatedCustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resourceState": { + "description": "Resource status of the endpoint.", + "readOnly": true, + "enum": [ + "Creating", + "Deleting", + "Running", + "Starting", + "Stopped", + "Stopping" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the endpoint.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "EndpointProvisioningState", + "modelAsString": true + } + } + } + }, + "EndpointListResult": { + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Endpoint" + }, + "description": "List of CDN endpoints within a profile" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of endpoint objects if there is any." + } + } + }, + "EndpointUpdateParameters": { + "type": "object", + "description": "Properties required to create or update an endpoint.", + "properties": { + "tags": { + "description": "Endpoint tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EndpointPropertiesUpdateParameters" + } + }, + "x-ms-azure-resource": true + }, + "EndpointPropertiesUpdateParameters": { + "description": "The JSON object containing endpoint update parameters.", + "properties": { + "originPath": { + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", + "type": "string" + }, + "contentTypesToCompress": { + "description": "List of content types on which compression applies. The value should be a valid MIME type.", + "type": "array", + "items": { + "type": "string" + } + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled on CDN. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "boolean" + }, + "isHttpAllowed": { + "description": "Indicates whether HTTP traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "isHttpsAllowed": { + "description": "Indicates whether HTTPS traffic is allowed on the endpoint. Default value is true. At least one protocol (HTTP or HTTPS) must be allowed.", + "type": "boolean", + "default": true + }, + "queryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "$ref": "#/definitions/QueryStringCachingBehavior", + "default": "NotSet" + }, + "optimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.", + "$ref": "#/definitions/OptimizationType" + }, + "probePath": { + "description": "Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.", + "type": "string" + }, + "geoFilters": { + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", + "type": "array", + "items": { + "$ref": "#/definitions/GeoFilter" + }, + "x-ms-identifiers": [] + }, + "defaultOriginGroup": { + "description": "A reference to the origin group.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "urlSigningKeys": { + "description": "List of keys used to validate the signed URL hashes.", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningKey" + }, + "x-ms-identifiers": [ + "keyId" + ] + }, + "deliveryPolicy": { + "description": "A policy that specifies the delivery rules to be used for an endpoint.", + "type": "object", + "required": [ + "rules" + ], + "properties": { + "description": { + "description": "User-friendly description of the policy.", + "type": "string" + }, + "rules": { + "description": "A list of the delivery rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for the endpoint (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "DeliveryRule": { + "description": "A rule that specifies a set of actions and conditions", + "type": "object", + "required": [ + "order", + "actions" + ], + "properties": { + "name": { + "description": "Name of the rule", + "type": "string" + }, + "order": { + "description": "The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.", + "type": "integer", + "format": "int32" + }, + "conditions": { + "description": "A list of conditions that must be matched for the actions to be executed", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleCondition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "actions": { + "description": "A list of actions that are executed when all the conditions of a rule are satisfied.", + "type": "array", + "items": { + "$ref": "#/definitions/DeliveryRuleAction" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DeliveryRuleCondition": { + "description": "A condition for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the condition for the delivery rule.", + "type": "string", + "enum": [ + "RemoteAddress", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "RequestScheme", + "UrlPath", + "UrlFileExtension", + "UrlFileName", + "HttpVersion", + "Cookies", + "IsDevice", + "SocketAddr", + "ClientPort", + "ServerPort", + "HostName", + "SslProtocol" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + } + } + }, + "DeliveryRuleRemoteAddressCondition": { + "description": "Defines the RemoteAddress condition for the delivery rule.", + "x-ms-discriminator-value": "RemoteAddress", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RemoteAddressMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestMethodCondition": { + "description": "Defines the RequestMethod condition for the delivery rule.", + "x-ms-discriminator-value": "RequestMethod", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestMethodMatchConditionParameters" + } + } + }, + "DeliveryRuleQueryStringCondition": { + "description": "Defines the QueryString condition for the delivery rule.", + "x-ms-discriminator-value": "QueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/QueryStringMatchConditionParameters" + } + } + }, + "DeliveryRulePostArgsCondition": { + "description": "Defines the PostArgs condition for the delivery rule.", + "x-ms-discriminator-value": "PostArgs", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/PostArgsMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestUriCondition": { + "description": "Defines the RequestUri condition for the delivery rule.", + "x-ms-discriminator-value": "RequestUri", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestUriMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestHeaderCondition": { + "description": "Defines the RequestHeader condition for the delivery rule.", + "x-ms-discriminator-value": "RequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestHeaderMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestBodyCondition": { + "description": "Defines the RequestBody condition for the delivery rule.", + "x-ms-discriminator-value": "RequestBody", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestBodyMatchConditionParameters" + } + } + }, + "DeliveryRuleRequestSchemeCondition": { + "description": "Defines the RequestScheme condition for the delivery rule.", + "x-ms-discriminator-value": "RequestScheme", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/RequestSchemeMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlPathCondition": { + "description": "Defines the UrlPath condition for the delivery rule.", + "x-ms-discriminator-value": "UrlPath", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlPathMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileExtensionCondition": { + "description": "Defines the UrlFileExtension condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileExtension", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileExtensionMatchConditionParameters" + } + } + }, + "DeliveryRuleUrlFileNameCondition": { + "description": "Defines the UrlFileName condition for the delivery rule.", + "x-ms-discriminator-value": "UrlFileName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/UrlFileNameMatchConditionParameters" + } + } + }, + "DeliveryRuleHttpVersionCondition": { + "description": "Defines the HttpVersion condition for the delivery rule.", + "x-ms-discriminator-value": "HttpVersion", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HttpVersionMatchConditionParameters" + } + } + }, + "DeliveryRuleCookiesCondition": { + "description": "Defines the Cookies condition for the delivery rule.", + "x-ms-discriminator-value": "Cookies", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/CookiesMatchConditionParameters" + } + } + }, + "DeliveryRuleIsDeviceCondition": { + "description": "Defines the IsDevice condition for the delivery rule.", + "x-ms-discriminator-value": "IsDevice", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/IsDeviceMatchConditionParameters" + } + } + }, + "DeliveryRuleSocketAddrCondition": { + "description": "Defines the SocketAddress condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SocketAddr", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SocketAddrMatchConditionParameters" + } + } + }, + "DeliveryRuleClientPortCondition": { + "description": "Defines the ClientPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ClientPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ClientPortMatchConditionParameters" + } + } + }, + "DeliveryRuleServerPortCondition": { + "description": "Defines the ServerPort condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "ServerPort", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/ServerPortMatchConditionParameters" + } + } + }, + "DeliveryRuleHostNameCondition": { + "description": "Defines the HostName condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "HostName", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/HostNameMatchConditionParameters" + } + } + }, + "DeliveryRuleSslProtocolCondition": { + "description": "Defines the SslProtocol condition for the delivery rule.", + "type": "object", + "x-ms-discriminator-value": "SslProtocol", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleCondition" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the condition.", + "$ref": "#/definitions/SslProtocolMatchConditionParameters" + } + } + }, + "RemoteAddressMatchConditionParameters": { + "description": "Defines the parameters for RemoteAddress match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRemoteAddressConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch" + ], + "x-ms-enum": { + "name": "RemoteAddressOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestMethodMatchConditionParameters": { + "description": "Defines the parameters for RequestMethod match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestMethodConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "RequestMethodOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "GET", + "HEAD", + "POST", + "PUT", + "DELETE", + "OPTIONS", + "TRACE" + ], + "x-ms-enum": { + "name": "RequestMethodMatchValue", + "modelAsString": true + } + } + } + } + }, + "QueryStringMatchConditionParameters": { + "description": "Defines the parameters for QueryString match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleQueryStringConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "QueryStringOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "PostArgsMatchConditionParameters": { + "description": "Defines the parameters for PostArgs match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRulePostArgsConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of PostArg to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "PostArgsOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestUriMatchConditionParameters": { + "description": "Defines the parameters for RequestUri match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestUriConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestUriOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestHeaderMatchConditionParameters": { + "description": "Defines the parameters for RequestHeader match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestHeaderConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Header to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestHeaderOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestBodyMatchConditionParameters": { + "description": "Defines the parameters for RequestBody match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestBodyConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "RequestBodyOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "RequestSchemeMatchConditionParameters": { + "description": "Defines the parameters for RequestScheme match conditions ", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleRequestSchemeConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ] + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "HTTP", + "HTTPS" + ], + "x-ms-enum": { + "name": "RequestSchemeMatchValue", + "modelAsString": true + } + } + } + } + }, + "UrlPathMatchConditionParameters": { + "description": "Defines the parameters for UrlPath match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlPathMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "Wildcard", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlPathOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileExtensionMatchConditionParameters": { + "description": "Defines the parameters for UrlFileExtension match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFileExtensionMatchConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileExtensionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "UrlFileNameMatchConditionParameters": { + "description": "Defines the parameters for UrlFilename match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlFilenameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "UrlFileNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HttpVersionMatchConditionParameters": { + "description": "Defines the parameters for HttpVersion match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHttpVersionConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "HttpVersionOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "CookiesMatchConditionParameters": { + "description": "Defines the parameters for Cookies match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleCookiesConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "selector": { + "description": "Name of Cookies to be matched", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "CookiesOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "IsDeviceMatchConditionParameters": { + "description": "Defines the parameters for IsDevice match conditions", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleIsDeviceConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "IsDeviceOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Mobile", + "Desktop" + ], + "x-ms-enum": { + "name": "IsDeviceMatchValue", + "modelAsString": true + } + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SocketAddrMatchConditionParameters": { + "description": "Defines the parameters for SocketAddress match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSocketAddrConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch" + ], + "x-ms-enum": { + "name": "SocketAddrOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ClientPortMatchConditionParameters": { + "description": "Defines the parameters for ClientPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleClientPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ClientPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ServerPortMatchConditionParameters": { + "description": "Defines the parameters for ServerPort match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleServerPortConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "ServerPortOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "HostNameMatchConditionParameters": { + "description": "Defines the parameters for HostName match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleHostNameConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "Equal", + "Contains", + "BeginsWith", + "EndsWith", + "LessThan", + "LessThanOrEqual", + "GreaterThan", + "GreaterThanOrEqual", + "RegEx" + ], + "x-ms-enum": { + "name": "HostNameOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "SslProtocolMatchConditionParameters": { + "description": "Defines the parameters for SslProtocol match conditions", + "type": "object", + "required": [ + "operator" + ], + "x-ms-discriminator-value": "DeliveryRuleSslProtocolConditionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleConditionParameters" + } + ], + "properties": { + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Equal" + ], + "x-ms-enum": { + "name": "SslProtocolOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean", + "default": false + }, + "matchValues": { + "description": "The match value for the condition of the delivery rule", + "type": "array", + "items": { + "$ref": "#/definitions/SslProtocol" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "DeliveryRuleAction": { + "description": "An action for the delivery rule.", + "discriminator": "name", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the action for the delivery rule.", + "type": "string", + "enum": [ + "CacheExpiration", + "CacheKeyQueryString", + "ModifyRequestHeader", + "ModifyResponseHeader", + "UrlRedirect", + "UrlRewrite", + "UrlSigning", + "OriginGroupOverride", + "RouteConfigurationOverride" + ], + "x-ms-enum": { + "name": "DeliveryRuleActionName", + "modelAsString": true + } + } + } + }, + "UrlRedirectAction": { + "description": "Defines the url redirect action for the delivery rule.", + "x-ms-discriminator-value": "UrlRedirect", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRedirectActionParameters" + } + } + }, + "UrlRedirectActionParameters": { + "description": "Defines the parameters for the url redirect action.", + "required": [ + "redirectType" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRedirectActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "RedirectType", + "modelAsString": true + } + }, + "destinationProtocol": { + "description": "Protocol to use for the redirect. The default value is MatchRequest", + "type": "string", + "enum": [ + "MatchRequest", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "DestinationProtocol", + "modelAsString": true + } + }, + "customPath": { + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.", + "type": "string" + }, + "customHostname": { + "description": "Host to redirect. Leave empty to use the incoming host as the destination host.", + "type": "string" + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them.", + "type": "string" + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + } + } + }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, + "UrlSigningActionParameters": { + "description": "Defines the parameters for the Url Signing action.", + "x-ms-discriminator-value": "DeliveryRuleUrlSigningActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "algorithm": { + "description": "Algorithm to use for URL signing", + "type": "string", + "enum": [ + "SHA256" + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } + }, + "parameterNameOverride": { + "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", + "type": "array", + "items": { + "$ref": "#/definitions/UrlSigningParamIdentifier" + }, + "x-ms-identifiers": [ + "paramName" + ] + } + } + }, + "UrlSigningParamIdentifier": { + "description": "Defines how to identify a parameter for a specific purpose e.g. expires", + "required": [ + "paramIndicator", + "paramName" + ], + "properties": { + "paramIndicator": { + "description": "Indicates the purpose of the parameter", + "type": "string", + "enum": [ + "Expires", + "KeyId", + "Signature" + ], + "x-ms-enum": { + "name": "paramIndicator", + "modelAsString": true + } + }, + "paramName": { + "description": "Parameter name", + "type": "string" + } + } + }, + "OriginGroupOverrideAction": { + "description": "Defines the origin group override action for the delivery rule.", + "x-ms-discriminator-value": "OriginGroupOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/OriginGroupOverrideActionParameters" + } + } + }, + "OriginGroupOverrideActionParameters": { + "description": "Defines the parameters for the origin group override action.", + "required": [ + "originGroup" + ], + "x-ms-discriminator-value": "DeliveryRuleOriginGroupOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + } + } + }, + "UrlRewriteAction": { + "description": "Defines the url rewrite action for the delivery rule.", + "x-ms-discriminator-value": "UrlRewrite", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlRewriteActionParameters" + } + } + }, + "UrlRewriteActionParameters": { + "description": "Defines the parameters for the url rewrite action.", + "required": [ + "sourcePattern", + "destination" + ], + "x-ms-discriminator-value": "DeliveryRuleUrlRewriteActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "sourcePattern": { + "description": "define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched.", + "type": "string" + }, + "destination": { + "description": "Define the relative URL to which the above requests will be rewritten by.", + "type": "string" + }, + "preserveUnmatchedPath": { + "description": "Whether to preserve unmatched path. Default value is true.", + "type": "boolean" + } + } + }, + "DeliveryRuleRequestHeaderAction": { + "description": "Defines the request header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyRequestHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "DeliveryRuleResponseHeaderAction": { + "description": "Defines the response header action for the delivery rule.", + "x-ms-discriminator-value": "ModifyResponseHeader", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/HeaderActionParameters" + } + } + }, + "HeaderActionParameters": { + "description": "Defines the parameters for the request header action.", + "required": [ + "headerAction", + "headerName" + ], + "x-ms-discriminator-value": "DeliveryRuleHeaderActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "headerAction": { + "description": "Action to perform", + "type": "string", + "enum": [ + "Append", + "Overwrite", + "Delete" + ], + "x-ms-enum": { + "name": "HeaderAction", + "modelAsString": true + } + }, + "headerName": { + "description": "Name of the header to modify", + "type": "string" + }, + "value": { + "description": "Value for the specified action", + "type": "string" + } + } + }, + "DeliveryRuleCacheExpirationAction": { + "description": "Defines the cache expiration action for the delivery rule.", + "x-ms-discriminator-value": "CacheExpiration", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheExpirationActionParameters" + } + } + }, + "CacheExpirationActionParameters": { + "description": "Defines the parameters for the cache expiration action.", + "required": [ + "cacheBehavior", + "cacheType" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheExpirationActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "BypassCache", + "Override", + "SetIfMissing" + ], + "x-ms-enum": { + "name": "cacheBehavior", + "modelAsString": true + } + }, + "cacheType": { + "description": "The level at which the content needs to be cached.", + "type": "string", + "enum": [ + "All" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleCacheKeyQueryStringAction": { + "description": "Defines the cache-key query string action for the delivery rule.", + "x-ms-discriminator-value": "CacheKeyQueryString", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/CacheKeyQueryStringActionParameters" + } + } + }, + "CacheKeyQueryStringActionParameters": { + "description": "Defines the parameters for the cache-key query string action.", + "required": [ + "queryStringBehavior" + ], + "x-ms-discriminator-value": "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "queryStringBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "Include", + "IncludeAll", + "Exclude", + "ExcludeAll" + ], + "x-ms-enum": { + "name": "queryStringBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string", + "x-nullable": true + } + } + }, + "DeliveryRuleRouteConfigurationOverrideAction": { + "description": "Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles.", + "type": "object", + "x-ms-discriminator-value": "RouteConfigurationOverride", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/RouteConfigurationOverrideActionParameters" + } + } + }, + "RouteConfigurationOverrideActionParameters": { + "description": "Defines the parameters for the route configuration override action.", + "type": "object", + "x-ms-discriminator-value": "DeliveryRuleRouteConfigurationOverrideActionParameters", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleActionParameters" + } + ], + "properties": { + "originGroupOverride": { + "description": "A reference to the origin group override configuration. Leave empty to use the default origin group on route.", + "type": "object", + "$ref": "#/definitions/OriginGroupOverride" + }, + "cacheConfiguration": { + "description": "The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "$ref": "#/definitions/CacheConfiguration" + } + } + }, + "OriginGroupOverride": { + "description": "Defines the parameters for the origin group override configuration.", + "type": "object", + "properties": { + "originGroup": { + "description": "defines the OriginGroup that would override the DefaultOriginGroup on route.", + "type": "object", + "$ref": "#/definitions/ResourceReference" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "ForwardingProtocol", + "modelAsString": true + } + } + } + }, + "CacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryStringCachingBehavior": { + "description": "Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.", + "enum": [ + "IgnoreQueryString", + "UseQueryString", + "IgnoreSpecifiedQueryStrings", + "IncludeSpecifiedQueryStrings" + ], + "type": "string", + "x-ms-enum": { + "name": "ruleQueryStringCachingBehavior", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "isCompressionEnabled": { + "description": "Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ruleIsCompressionEnabled", + "modelAsString": true + } + }, + "cacheBehavior": { + "description": "Caching behavior for the requests", + "type": "string", + "enum": [ + "HonorOrigin", + "OverrideAlways", + "OverrideIfOriginMissing" + ], + "x-ms-enum": { + "name": "ruleCacheBehavior", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "type": "string" + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "SslProtocol": { + "description": "The protocol of an established TLS connection.", + "type": "string", + "enum": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ], + "x-ms-enum": { + "name": "SslProtocol", + "modelAsString": true + } + }, + "DeepCreatedOrigin": { + "description": "The main origin of CDN content which is added when creating a CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin name which must be unique within the endpoint. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginProperties": { + "description": "Properties of the origin created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroup": { + "description": "The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Origin group name which must be unique within the endpoint.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedOriginGroupProperties" + } + }, + "x-ms-azure-resource": true + }, + "DeepCreatedOriginGroupProperties": { + "description": "Properties of the origin group created on the CDN endpoint.", + "type": "object", + "required": [ + "origins" + ], + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + }, + "x-ms-azure-resource": true + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another resource.", + "x-ms-azure-resource": true + }, + "GeoFilter": { + "description": "Rules defining user's geo access within a CDN endpoint.", + "type": "object", + "required": [ + "relativePath", + "action", + "countryCodes" + ], + "properties": { + "relativePath": { + "description": "Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.)", + "type": "string" + }, + "action": { + "description": "Action of the geo filter, i.e. allow or block access.", + "enum": [ + "Block", + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "GeoFilterActions", + "modelAsString": false + } + }, + "countryCodes": { + "description": "Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UrlSigningKey": { + "description": "Url signing key", + "required": [ + "keyId", + "keySourceParameters" + ], + "properties": { + "keyId": { + "description": "Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.", + "type": "string" + }, + "keySourceParameters": { + "description": "Defines the parameters for using customer key vault for Url Signing Key.", + "$ref": "#/definitions/KeyVaultSigningKeyParameters" + } + } + }, + "KeyVaultSigningKeyParameters": { + "description": "Describes the parameters for using a user's KeyVault for URL Signing Key.", + "required": [ + "typeName", + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "secretVersion" + ], + "properties": { + "typeName": { + "type": "string", + "enum": [ + "KeyVaultSigningKeyParameters" + ], + "x-ms-enum": { + "name": "KeyVaultSigningKeyParametersType", + "modelAsString": true + } + }, + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the secret", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the secret", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the secret", + "type": "string" + }, + "secretName": { + "description": "The name of secret in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of secret in Key Vault.", + "type": "string" + } + } + }, + "LoadParameters": { + "type": "object", + "description": "Parameters required for content load.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be loaded. Path should be a relative file URL of the origin.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Origin": { + "description": "CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginProperties" + } + } + }, + "OriginProperties": { + "description": "The JSON object that contains the properties of the origin.", + "required": [ + "hostName" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginProvisioningState", + "modelAsString": true + } + }, + "privateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "$ref": "#/definitions/PrivateEndpointStatus", + "type": "string", + "readOnly": true + } + } + }, + "OriginUpdateParameters": { + "type": "object", + "description": "Origin properties needed for origin update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin.", + "properties": { + "hostName": { + "description": "The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.", + "type": "string" + }, + "httpPort": { + "description": "The value of the HTTP port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The value of the HTTPS port. Must be between 1 and 65535.", + "type": "integer", + "format": "int32", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "originHostHeader": { + "description": "The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint", + "type": "string" + }, + "priority": { + "description": "Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5", + "type": "integer", + "format": "int32", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of the origin in given origin group for load balancing. Must be between 1 and 1000", + "type": "integer", + "format": "int32", + "maximum": 1000, + "minimum": 1 + }, + "enabled": { + "description": "Origin is enabled for load balancing or not", + "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" + } + } + }, + "OriginListResult": { + "description": "Result of the request to list origins. It contains a list of origin objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Origin" + }, + "description": "List of CDN origins within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "OriginGroup": { + "description": "Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupProperties" + } + } + }, + "OriginGroupProperties": { + "description": "The JSON object that contains the properties of the origin group.", + "type": "object", + "required": [ + "origins" + ], + "allOf": [ + { + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the origin group.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "OriginGroupResourceState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "description": "Provisioning status of the origin group.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Updating", + "Deleting", + "Creating" + ], + "x-ms-enum": { + "name": "OriginGroupProvisioningState", + "modelAsString": true + } + } + } + }, + "OriginGroupUpdateParameters": { + "type": "object", + "description": "Origin group properties needed for origin group creation or update.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OriginGroupUpdatePropertiesParameters" + } + }, + "x-ms-azure-resource": true + }, + "OriginGroupUpdatePropertiesParameters": { + "description": "The JSON object that contains the properties of the origin group.", + "properties": { + "healthProbeSettings": { + "description": "Health probe settings to the origin that is used to determine the health of the origin.", + "type": "object", + "$ref": "#/definitions/HealthProbeParameters" + }, + "origins": { + "description": "The source of the content being delivered via CDN within given origin group.", + "type": "array", + "items": { + "description": "A reference to a origin.", + "$ref": "#/definitions/ResourceReference" + } + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": { + "description": "Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.", + "type": "integer", + "format": "int32", + "maximum": 50, + "minimum": 0 + }, + "responseBasedOriginErrorDetectionSettings": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.", + "type": "object", + "$ref": "#/definitions/ResponseBasedOriginErrorDetectionParameters" + } + } + }, + "HealthProbeParameters": { + "description": "The JSON object that contains the properties to send health probes to origin.", + "properties": { + "probePath": { + "description": "The path relative to the origin that is used to determine the health of the origin.", + "type": "string" + }, + "probeRequestType": { + "description": "The type of health probe request that is made.", + "enum": [ + "NotSet", + "GET", + "HEAD" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthProbeRequestType", + "modelAsString": false + } + }, + "probeProtocol": { + "description": "Protocol to use for health probe.", + "type": "string", + "enum": [ + "NotSet", + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": false + } + }, + "probeIntervalInSeconds": { + "description": "The number of seconds between health probes.Default is 240sec.", + "type": "integer", + "format": "int32", + "maximum": 255, + "minimum": 1 + } + } + }, + "ResponseBasedOriginErrorDetectionParameters": { + "description": "The JSON object that contains the properties to determine origin health using real requests/responses.", + "properties": { + "responseBasedDetectedErrorTypes": { + "description": "Type of response errors for real user requests for which origin will be deemed unhealthy", + "type": "string", + "enum": [ + "None", + "TcpErrorsOnly", + "TcpAndHttpErrors" + ], + "x-ms-enum": { + "name": "ResponseBasedDetectedErrorTypes", + "modelAsString": false + } + }, + "responseBasedFailoverThresholdPercentage": { + "description": "The percentage of failed requests in the sample where failover should trigger.", + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0 + }, + "httpErrorRanges": { + "description": "The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpErrorRangeParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpErrorRangeParameters": { + "description": "The JSON object that represents the range for http status codes", + "properties": { + "begin": { + "description": "The inclusive start of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + }, + "end": { + "description": "The inclusive end of the http status code range.", + "type": "integer", + "format": "int32", + "maximum": 999, + "minimum": 100 + } + } + }, + "OriginGroupListResult": { + "description": "Result of the request to list origin groups. It contains a list of origin groups objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "description": "List of CDN origin groups within an endpoint" + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of origin objects if there are any." + } + } + }, + "DeepCreatedCustomDomain": { + "description": "Custom domains created on the CDN endpoint.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Custom domain name.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeepCreatedCustomDomainProperties" + } + } + }, + "DeepCreatedCustomDomainProperties": { + "description": "Properties of the custom domain created on the CDN endpoint.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainProperties" + } + } + }, + "CustomDomainProperties": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + }, + "resourceState": { + "description": "Resource status of the custom domain.", + "readOnly": true, + "enum": [ + "Creating", + "Active", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomDomainResourceState", + "modelAsString": true + } + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "customHttpsParameters": { + "description": "Certificate parameters for securing custom HTTPS", + "$ref": "#/definitions/CustomDomainHttpsParameters" + }, + "validationData": { + "description": "Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China.", + "type": "string" + }, + "provisioningState": { + "description": "Provisioning status of Custom Https of the custom domain.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + } + } + }, + "CustomDomainParameters": { + "description": "The customDomain JSON object required for custom domain creation or update.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomDomainPropertiesParameters" + } + } + }, + "CustomDomainPropertiesParameters": { + "description": "The JSON object that contains the properties of the custom domain to create.", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "CustomDomainHttpsParameters": { + "description": "The JSON object that contains the properties to secure a custom domain.", + "discriminator": "certificateSource", + "required": [ + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate.", + "enum": [ + "AzureKeyVault", + "Cdn" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery.", + "enum": [ + "ServerNameIndication", + "IPBased" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "TLS protocol version that will be used for Https", + "enum": [ + "None", + "TLS10", + "TLS12" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": false + } + } + } + }, + "CdnManagedHttpsParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "x-ms-discriminator-value": "Cdn", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using CDN managed certificate for enabling SSL.", + "$ref": "#/definitions/CdnCertificateSourceParameters" + } + } + }, + "CdnCertificateSourceParameters": { + "description": "Defines the parameters for using CDN managed certificate for securing custom domain.", + "required": [ + "certificateType" + ], + "x-ms-discriminator-value": "CdnCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "certificateType": { + "description": "Type of certificate used", + "enum": [ + "Shared", + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + }, + "UserManagedHttpsParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "x-ms-discriminator-value": "AzureKeyVault", + "allOf": [ + { + "$ref": "#/definitions/CustomDomainHttpsParameters" + } + ], + "required": [ + "certificateSourceParameters" + ], + "properties": { + "certificateSourceParameters": { + "description": "Defines the certificate source parameters using user's keyvault certificate for enabling SSL.", + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Describes the parameters for using a user's KeyVault certificate for securing custom domain.", + "required": [ + "subscriptionId", + "resourceGroupName", + "vaultName", + "secretName", + "updateRule", + "deleteRule" + ], + "x-ms-discriminator-value": "KeyVaultCertificateSourceParameters", + "allOf": [ + { + "$ref": "#/definitions/CertificateSourceParameters" + } + ], + "properties": { + "subscriptionId": { + "description": "Subscription Id of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "resourceGroupName": { + "description": "Resource group of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "vaultName": { + "description": "The name of the user's Key Vault containing the SSL certificate", + "type": "string" + }, + "secretName": { + "description": "The name of Key Vault Secret (representing the full certificate PFX) in Key Vault.", + "type": "string" + }, + "secretVersion": { + "description": "The version(GUID) of Key Vault Secret in Key Vault.", + "type": "string" + }, + "updateRule": { + "description": "Describes the action that shall be taken when the certificate is updated in Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "UpdateRule", + "modelAsString": true + } + }, + "deleteRule": { + "description": "Describes the action that shall be taken when the certificate is removed from Key Vault.", + "type": "string", + "enum": [ + "NoAction" + ], + "x-ms-enum": { + "name": "DeleteRule", + "modelAsString": true + } + } + } + }, + "CustomDomainListResult": { + "description": "Result of the request to list custom domains. It contains a list of custom domain objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "description": "List of CDN CustomDomains within an endpoint." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ValidateProbeInput": { + "description": "Input of the validate probe API.", + "properties": { + "probeURL": { + "description": "The probe URL to validate.", + "type": "string" + } + }, + "required": [ + "probeURL" + ], + "type": "object" + }, + "ValidateProbeOutput": { + "description": "Output of the validate probe API.", + "properties": { + "isValid": { + "description": "Indicates whether the probe URL is accepted or not.", + "readOnly": true, + "type": "boolean" + }, + "errorCode": { + "description": "Specifies the error code when the probe url is not accepted.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the probe URL is not accepted.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResourceUsageListResult": { + "description": "Output of check resource usage API.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "x-ms-identifiers": [ + "resourceType" + ], + "description": "List of resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of custom domain objects if there are any." + } + } + }, + "ResourceUsage": { + "description": "Output of check resource usage API.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "Resource type for which the usage is provided." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Unit of the usage. e.g. count.", + "enum": [ + "count" + ], + "x-ms-enum": { + "name": "ResourceUsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Actual value of usage on the specified resource type." + }, + "limit": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Quota of the specified resource type." + } + } + }, + "ResourceType": { + "description": "Type of CDN resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Cdn/Profiles/Endpoints", + "Microsoft.Cdn/Profiles/AfdEndpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true + } + }, + "OperationsListResult": { + "description": "Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of CDN operations supported by the CDN resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "CDN REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "readOnly": true, + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Cdn", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of operation.", + "readOnly": true, + "type": "string" + } + } + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of operations." + }, + "properties": { + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true, + "x-ms-client-name": "OperationProperties", + "$ref": "#/definitions/OperationProperties" + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include log specifications.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "Log specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "LogSpecification": { + "description": "Log specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of log specification." + }, + "displayName": { + "type": "string", + "description": "Display name of log specification." + }, + "blobDuration": { + "type": "string", + "description": "Blob duration of specification." + }, + "logFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "The metric unit. Possible values include: 'Bytes', 'Count', 'Milliseconds'." + }, + "aggregationType": { + "type": "string", + "description": "The metric aggregation type. Possible values include: 'Average', 'Count', 'Total'." + }, + "availabilities": { + "description": "Retention policies of a resource metric.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "dimensions": { + "type": "array", + "description": "The dimensions of metric", + "items": { + "$ref": "#/definitions/DimensionProperties" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Property to specify whether to fill gap with zero." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern to filter based on name" + }, + "isInternal": { + "type": "boolean", + "description": "Property to specify metric is internal or not." + } + } + }, + "DimensionProperties": { + "description": "Type of operation: get, read, delete, etc.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + }, + "internalName": { + "type": "string", + "description": "Internal name of dimension." + } + } + }, + "MetricAvailability": { + "description": "Retention policy of a resource metric.", + "type": "object", + "properties": { + "timeGrain": { + "type": "string" + }, + "blobDuration": { + "type": "string" + } + } + }, + "EdgenodeResult": { + "description": "Result of the request to list CDN edgenodes. It contains a list of ip address group and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EdgeNode" + }, + "description": "Edge node of CDN service." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of edgenode list results if there are any." + } + } + }, + "EdgeNode": { + "description": "Edgenode is a global Point of Presence (POP) location used to deliver CDN content to end users.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EdgeNodeProperties" + } + } + }, + "EdgeNodeProperties": { + "description": "The JSON object that contains the properties required to create an edgenode.", + "required": [ + "ipAddressGroups" + ], + "properties": { + "ipAddressGroups": { + "description": "List of ip address groups.", + "type": "array", + "items": { + "$ref": "#/definitions/IpAddressGroup" + }, + "x-ms-identifiers": [ + "deliveryRegion" + ] + } + } + }, + "IpAddressGroup": { + "description": "CDN Ip address group", + "type": "object", + "properties": { + "deliveryRegion": { + "description": "The delivery region of the ip address group", + "type": "string" + }, + "ipv4Addresses": { + "description": "The list of ip v4 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + }, + "ipv6Addresses": { + "description": "The list of ip v6 addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/cidrIpAddress" + }, + "x-ms-identifiers": [ + "baseIpAddress" + ] + } + } + }, + "cidrIpAddress": { + "description": "CIDR Ip address", + "type": "object", + "properties": { + "baseIpAddress": { + "description": "Ip address itself.", + "type": "string" + }, + "prefixLength": { + "description": "The length of the prefix of the ip address.", + "type": "integer", + "format": "int32" + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/SystemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "SystemData": { + "description": "Read only system data", + "readOnly": true, + "type": "object", + "properties": { + "createdBy": { + "type": "string", + "description": "An identifier for the identity that created the resource" + }, + "createdByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that created the resource" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)" + }, + "lastModifiedBy": { + "type": "string", + "description": "An identifier for the identity that last modified the resource" + }, + "lastModifiedByType": { + "$ref": "#/definitions/IdentityType", + "description": "The type of identity that last modified the resource" + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)" + } + } + }, + "IdentityType": { + "description": "The type of identity that creates/modifies resources", + "type": "string", + "enum": [ + "user", + "application", + "managedIdentity", + "key" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + }, + "required": [ + "location" + ] + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "QueryStringCachingBehavior": { + "description": "Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.", + "enum": [ + "IgnoreQueryString", + "BypassCaching", + "UseQueryString", + "NotSet" + ], + "type": "string", + "x-ms-enum": { + "name": "QueryStringCachingBehavior", + "modelAsString": false + } + }, + "PrivateEndpointStatus": { + "description": "The approval status for the connection to the Private Link", + "type": "string", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointStatus", + "modelAsString": true + } + }, + "Sku": { + "description": "Standard_Verizon = The SKU name for a Standard Verizon CDN profile.\nPremium_Verizon = The SKU name for a Premium Verizon CDN profile.\nCustom_Verizon = The SKU name for a Custom Verizon CDN profile.\nStandard_Akamai = The SKU name for an Akamai CDN profile.\nStandard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model.\nStandard_Microsoft = The SKU name for a Standard Microsoft CDN profile.\nStandard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile.\nPremium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile.\nStandard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model.\nStandard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model.\nStandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model.\nStandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model.\nStandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.\n", + "properties": { + "name": { + "description": "Name of the pricing tier.", + "enum": [ + "Standard_Verizon", + "Premium_Verizon", + "Custom_Verizon", + "Standard_Akamai", + "Standard_ChinaCdn", + "Standard_Microsoft", + "Standard_AzureFrontDoor", + "Premium_AzureFrontDoor", + "Standard_955BandWidth_ChinaCdn", + "Standard_AvgBandWidth_ChinaCdn", + "StandardPlus_ChinaCdn", + "StandardPlus_955BandWidth_ChinaCdn", + "StandardPlus_AvgBandWidth_ChinaCdn" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + } + }, + "type": "object" + }, + "OptimizationType": { + "description": "Specifies what scenario the customer wants this CDN endpoint to optimize, e.g. Download, Media services. With this information we can apply scenario driven optimization.", + "enum": [ + "GeneralWebDelivery", + "GeneralMediaStreaming", + "VideoOnDemandMediaStreaming", + "LargeFileDownload", + "DynamicSiteAcceleration" + ], + "type": "string", + "x-ms-enum": { + "name": "OptimizationType", + "modelAsString": true + } + }, + "ErrorResponse": { + "title": "Error response", + "description": "Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "ErrorDetail": { + "description": "The error detail.", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "CdnMigrationToAfdParameters": { + "type": "object", + "description": "Request body for Migrate operation.", + "required": [ + "sku" + ], + "properties": { + "sku": { + "description": "Sku for the migration", + "$ref": "#/definitions/Sku" + }, + "migrationEndpointMappings": { + "description": "A name map between classic CDN endpoints and AFD Premium/Standard endpoints.", + "type": "array", + "items": { + "description": "List of endpoint mappings", + "$ref": "#/definitions/MigrationEndpointMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-azure-resource": true + }, + "MigrationEndpointMapping": { + "description": "CDN Endpoint Mapping.", + "type": "object", + "properties": { + "migratedFrom": { + "description": "Name of the classic CDN profile endpoint.", + "type": "string" + }, + "migratedTo": { + "description": "Name of the newly created migrated Azure Frontdoor Standard/Premium profile endpoint. This name will replace the name of the classic CDN endpoint resource.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "profileNameParameter": { + "name": "profileName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 260, + "x-ms-parameter-location": "method", + "description": "Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json new file mode 100644 index 000000000000..ad37d1ab36ed --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json @@ -0,0 +1,977 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01", + "title": "Azure CDN WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules for Azure CDN" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/cdnWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicy", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group", + "operationId": "Policies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "description": "CdnWebApplicationFirewallPolicy parameters to be patched.", + "in": "body", + "name": "cdnWebApplicationFirewallPolicyPatchParameters", + "required": true, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyPatchParameters" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "headers": { + "location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPatchPolicy.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/cdnWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./cdn.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "CdnWebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies for Azure CDN. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnWebApplicationFirewallPolicy" + }, + "description": "List of Azure CDN WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "CdnWebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy for Azure CDN.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/CdnWebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "./cdn.json#/definitions/TrackedResource" + } + ] + }, + "CdnWebApplicationFirewallPolicyPatchParameters": { + "type": "object", + "description": "Properties required to update a CdnWebApplicationFirewallPolicy.", + "properties": { + "tags": { + "description": "CdnWebApplicationFirewallPolicy tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CdnWebApplicationFirewallPolicyProperties": { + "description": "Defines CDN web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes policySettings for policy", + "$ref": "#/definitions/policySettings" + }, + "rateLimitRules": { + "description": "Describes rate limit rules inside the policy.", + "$ref": "#/definitions/RateLimitRuleList" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "endpointLinks": { + "description": "Describes Azure CDN endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CdnEndpoint" + } + }, + "extendedProperties": { + "description": "Key-Value pair representing additional properties for Web Application Firewall policy.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the WebApplicationFirewallPolicy.", + "enum": [ + "Creating", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "policySettings": { + "description": "Defines contents of a web application firewall global configuration", + "properties": { + "enabledState": { + "description": "describes if the policy is in enabled state or disabled state", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "defaultRedirectUrl": { + "description": "If action type is redirect, this field represents the default redirect URL for the client.", + "type": "string" + }, + "defaultCustomBlockResponseStatusCode": { + "description": "If the action type is block, this field defines the default customer overridable http response status code.", + "type": "integer", + "format": "int32", + "enum": [ + 200, + 403, + 405, + 406, + 429 + ] + }, + "defaultCustomBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CdnEndpoint": { + "description": "Defines the ARM Resource ID for the linked endpoints", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "ARM Resource ID string." + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CustomRule": { + "description": "Defines the common attributes for a custom rule that can be included in a waf policy", + "type": "object", + "required": [ + "name", + "priority", + "matchConditions", + "action" + ], + "properties": { + "name": { + "description": "Defines the name of the custom rule", + "type": "string" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "priority": { + "description": "Defines in what order this rule be evaluated in the overall list of custom rules", + "type": "integer", + "format": "int32", + "maximum": 1000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + }, + "x-ms-identifiers": [] + }, + "action": { + "description": "Describes what action to be applied when rule matches", + "$ref": "#/definitions/ActionType" + } + } + }, + "RateLimitRuleList": { + "description": "Defines contents of rate limit rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/RateLimitRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "RateLimitRule": { + "description": "Defines a rate limiting rule that can be included in a waf policy", + "type": "object", + "required": [ + "rateLimitThreshold", + "rateLimitDurationInMinutes" + ], + "properties": { + "rateLimitThreshold": { + "description": "Defines rate limit threshold.", + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false + }, + "rateLimitDurationInMinutes": { + "description": "Defines rate limit duration. Default is 1 minute.", + "type": "integer", + "format": "int32", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomRule" + } + ] + }, + "MatchCondition": { + "description": "Define match conditions", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Match variable to compare against.", + "type": "string", + "enum": [ + "RemoteAddr", + "SocketAddr", + "RequestMethod", + "RequestHeader", + "RequestUri", + "QueryString", + "RequestBody", + "Cookies", + "PostArgs" + ], + "x-ms-enum": { + "name": "WafMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs.", + "type": "string" + }, + "operator": { + "description": "Describes operator to be matched", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "TransformType": { + "description": "Describes what transforms were applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "x-ms-identifiers": [ + "ruleSetType", + "ruleSetVersion" + ] + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "anomalyScore": { + "description": "Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests.", + "type": "integer", + "format": "int32", + "maximum": 20, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "ruleGroupOverrides": { + "description": "Defines the rule overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ] + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group within the rule set to override", + "type": "string" + }, + "rules": { + "description": "List of rules that will be enabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + }, + "x-ms-identifiers": [ + "ruleId" + ] + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes a managed rule set definition.", + "properties": { + "properties": { + "description": "Describes managed rule set definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + }, + "sku": { + "description": "The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.", + "$ref": "./cdn.json#/definitions/Sku" + } + }, + "allOf": [ + { + "$ref": "./cdn.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "x-ms-identifiers": [ + "ruleGroupName" + ], + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "x-ms-identifiers": [ + "ruleId" + ], + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2024-09-01." + }, + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the CdnWebApplicationFirewallPolicy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json new file mode 100644 index 000000000000..82f832ab5329 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Create.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomain": { + "properties": { + "hostName": "www.someDomain.net", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "", + "expirationDate": "" + }, + "domainValidationState": "Submitting", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json new file mode 100644 index 000000000000..742bcc835345 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json new file mode 100644 index 000000000000..a9346d866f3d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json new file mode 100644 index 000000000000..cd9790671b50 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_ListByProfile.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Pending", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json new file mode 100644 index 000000000000..307091c09977 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_RefreshValidationToken.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json new file mode 100644 index 000000000000..1ba8fae48008 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDCustomDomains_Update.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "customDomainName": "domain1", + "customDomainUpdateProperties": { + "properties": { + "tlsSettings": { + "certificateType": "CustomerCertificate", + "minimumTlsVersion": "TLS12" + }, + "azureDnsZone": { + "id": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1", + "name": "domain1", + "type": "Microsoft.Cdn/profiles/customdomains", + "properties": { + "profileName": "profile1", + "hostName": "www.contoso.com", + "tlsSettings": { + "certificateType": "ManagedCertificate", + "minimumTlsVersion": "TLS12", + "secret": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/mysecert" + } + }, + "azureDnsZone": { + "id": "" + }, + "preValidatedCustomDomainResourceId": { + "id": "" + }, + "validationProperties": { + "validationToken": "8c9912db-c615-4eeb-8465", + "expirationDate": "2009-06-15T13:45:43.0000000Z" + }, + "domainValidationState": "Approved", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json new file mode 100644 index 000000000000..66c04169a74d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Create.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "tags": {}, + "location": "global", + "properties": { + "enabledState": "Enabled", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "201": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json new file mode 100644 index 000000000000..42b5693fc898 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json new file mode 100644 index 000000000000..3f257645f15f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListByProfile.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json new file mode 100644 index 000000000000..849c34cc902f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "name": { + "value": "route", + "localizedValue": "route" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json new file mode 100644 index 000000000000..aa17f1fc7e06 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_PurgeContent.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contents": { + "contentPaths": [ + "/folder1" + ], + "domains": [ + "endpoint1-abcdefghijklmnop.z01.azurefd.net" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json new file mode 100644 index 000000000000..230fd0ec4084 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_Update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": {}, + "properties": { + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-ezh7ddcmguaeajfu.z01.azureedge.net", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/afdendpoints", + "tags": {}, + "location": "global", + "properties": { + "hostName": "endpoint1-abcdefghijklmnop.z01.azurefd.net", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDEndpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json new file mode 100644 index 000000000000..b9251255260e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json new file mode 100644 index 000000000000..0e80603e9db1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json new file mode 100644 index 000000000000..70388c913207 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json new file mode 100644 index 000000000000..d3c44b339b6b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListByProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json new file mode 100644 index 000000000000..238bc2a5b6cf --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "name": { + "value": "origin", + "localizedValue": "origin" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json new file mode 100644 index 000000000000..89ceff41d61b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOriginGroups_Update.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originGroupUpdateProperties": { + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path2", + "probeRequestType": "NotSet", + "probeProtocol": "NotSet", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1", + "type": "Microsoft.Cdn/profiles/origingroups", + "name": "origingroup1", + "properties": { + "loadBalancingSettings": { + "sampleSize": 3, + "successfulSamplesRequired": 3, + "additionalLatencyInMilliseconds": 1000 + }, + "healthProbeSettings": { + "probePath": "/path1", + "probeRequestType": "HEAD", + "probeProtocol": "Http", + "probeIntervalInSeconds": 10 + }, + "trafficRestorationTimeToHealedOrNewEndpointsInMinutes": 5, + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json new file mode 100644 index 000000000000..ec6e73455717 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Create.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "origin": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json new file mode 100644 index 000000000000..867defe0fc66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json new file mode 100644 index 000000000000..a5aa5e870ca2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json new file mode 100644 index 000000000000..3ebb1f0b0c22 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_ListByOriginGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json new file mode 100644 index 000000000000..d422643c50cd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDOrigins_Update.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "originGroupName": "origingroup1", + "originName": "origin1", + "originUpdateProperties": { + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/origingroups/origingroup1/origins/origin1", + "type": "Microsoft.Cdn/profiles/origingroups/origins", + "name": "origin1", + "properties": { + "hostName": "host1.blob.core.windows.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "host1.foo.com", + "priority": null, + "weight": null, + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted", + "originGroupName": "origingroup1", + "sharedPrivateLinkResource": null, + "enforceCertificateNameCheck": true + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..aea9ba6c4f6e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckEndpointNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "profileName": "profile1", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json new file mode 100644 index 000000000000..6805739e79bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_CheckHostNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "checkHostNameAvailabilityInput": { + "hostName": "www.someDomain.net" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Conflict", + "message": "The hostname 'www.someDomain.net' is already owned by another profile." + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json new file mode 100644 index 000000000000..8dcbcc84af69 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ListResourceUsage.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1", + "name": { + "value": "afdendpoint", + "localizedValue": "afdendpoint" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json new file mode 100644 index 000000000000..b3abe705d2e2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_Upgrade.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpgradeParameters": { + "wafMappingList": [ + { + "securityPolicyName": "securityPolicy1", + "changeToWafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "extendedProperties": {}, + "frontDoorId": "id", + "originResponseTimeoutSeconds": 60, + "provisioningState": "Succeeded", + "resourceState": "Enabled" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "name": "profile1", + "location": "Global", + "kind": "frontdoor", + "tags": {}, + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "properties": { + "originResponseTimeoutSeconds": 60, + "frontDoorId": "id", + "extendedProperties": {}, + "resourceState": "Upgrading", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json new file mode 100644 index 000000000000..e6a4beb9ead4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/AFDProfiles_ValidateSecret.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "validateSecretInput": { + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName" + }, + "secretType": "CustomerCertificate" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json new file mode 100644 index 000000000000..17cead852987 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_CanMigrate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/canmigrateresults/profile1", + "type": "Microsoft.Cdn/profiles/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json new file mode 100644 index 000000000000..b4373821c45d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CdnProfiles_Migrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/profiles/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json new file mode 100644 index 000000000000..0180d609966a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckEndpointNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "myResourceGroup", + "checkEndpointNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/AfdEndpoints", + "autoGeneratedDomainNameLabelScope": "TenantReuse" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available", + "availableHostname": "" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..12f321bebb66 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..48e658ba4073 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CheckNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "checkNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Cdn/Profiles/Endpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json new file mode 100644 index 000000000000..b86710e2eedd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customDomainProperties": { + "properties": { + "hostName": "www.someDomain.net" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json new file mode 100644 index 000000000000..6e3aab25e3c8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Delete.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json new file mode 100644 index 000000000000..9a712dfeb7bc --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_DisableCustomHttps.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "CertificateDeleted", + "validationData": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json new file mode 100644 index 000000000000..0ade08219414 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingBYOC.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "KeyVaultCertificateSourceParameters", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "vaultName": "kv", + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000", + "updateRule": "NoAction", + "deleteRule": "NoAction" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json new file mode 100644 index 000000000000..a6271e38a778 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_EnableCustomHttpsUsingCDNManagedCertificate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net", + "customHttpsParameters": { + "MinimumTLSVersion": "TLS12", + "certificateSource": "Cdn", + "protocolType": "ServerNameIndication", + "certificateSourceParameters": { + "typeName": "CdnCertificateSourceParameters", + "certificateType": "Shared" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabled", + "customHttpsProvisioningSubstate": "CertificateDeployed", + "validationData": "validationdata" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Enabling", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", + "validationData": "validationdata" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json new file mode 100644 index 000000000000..d4ce4ba35412 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json new file mode 100644 index 000000000000..818b57bff626 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/CustomDomains_ListByEndpoint.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/customdomains/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/customdomains", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "customHttpsProvisioningState": "Disabled", + "customHttpsProvisioningSubstate": "None", + "validationData": null + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json new file mode 100644 index 000000000000..267a380d29d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/EdgeNodes_List.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Standard_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "180.240.184.128", + "prefixLength": 25 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Premium_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Premium_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "152.195.27.0", + "prefixLength": 24 + } + ], + "ipv6Addresses": [ + { + "baseIpAddress": "2606:2800:60f2::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + }, + { + "name": "Custom_Verizon", + "id": "/providers/Microsoft.Cdn/edgenodes/Custom_Verizon", + "type": "Microsoft.Cdn/edgenodes", + "properties": { + "ipAddressGroups": [ + { + "deliveryRegion": "All", + "ipv4Addresses": [ + { + "baseIpAddress": "192.229.176.0", + "prefixLength": 24 + }, + { + "baseIpAddress": "2606:2800:420b::", + "prefixLength": 48 + }, + { + "baseIpAddress": "2606:2800:700c::", + "prefixLength": 48 + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json new file mode 100644 index 000000000000..d8ece8311e03 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Create.json @@ -0,0 +1,546 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpoint": { + "location": "WestUs", + "tags": { + "key1": "value1" + }, + "properties": { + "originHostHeader": "www.bing.com", + "originPath": "/photos", + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "typeName": "DeliveryRuleRemoteAddressConditionParameters" + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*", + "typeName": "DeliveryRuleHeaderActionParameters" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip", + "typeName": "DeliveryRuleHeaderActionParameters" + } + } + ] + } + ] + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint4899.azureedge-test.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "BypassCaching", + "originPath": "/photos", + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "origins": [ + { + "name": "origin1", + "properties": { + "hostName": "www.someDomain1.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain1.net", + "priority": 1, + "weight": 50, + "enabled": true + } + }, + { + "name": "origin2", + "properties": { + "hostName": "www.someDomain2.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + }, + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "deliveryPolicy": { + "description": "Test description for a policy.", + "rules": [ + { + "name": "rule1", + "order": 1, + "conditions": [ + { + "name": "RemoteAddress", + "parameters": { + "typeName": "DeliveryRuleRemoteAddressConditionParameters", + "operator": "IPMatch", + "negateCondition": true, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + } + ], + "actions": [ + { + "name": "CacheExpiration", + "parameters": { + "typeName": "DeliveryRuleCacheExpirationActionParameters", + "cacheBehavior": "Override", + "cacheDuration": "10:10:09", + "cacheType": "All" + } + }, + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Access-Control-Allow-Origin", + "value": "*" + } + }, + { + "name": "ModifyRequestHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "Accept-Encoding", + "value": "gzip" + } + } + ] + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json new file mode 100644 index 000000000000..28895b584392 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json new file mode 100644 index 000000000000..7fd7c0fc03a3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json new file mode 100644 index 000000000000..b8c6ccf7b7ec --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListByProfile.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": {}, + "location": "CentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Running", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ], + "customDomains": [ + { + "name": "www-someDomain-net", + "properties": { + "hostName": "www.someDomain.Net", + "validationData": null + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json new file mode 100644 index 000000000000..2c7150ddb144 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ListResourceUsage.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "customdomain", + "unit": "count", + "currentValue": 1, + "limit": 20 + }, + { + "resourceType": "geofilter", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_LoadContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json new file mode 100644 index 000000000000..90165c79b110 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_PurgeContent.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "contentFilePaths": { + "contentPaths": [ + "/folder1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json new file mode 100644 index 000000000000..8502040cc9b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Start.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Starting", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json new file mode 100644 index 000000000000..d29029942ae8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Stop.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint4899", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "kay1": "value1" + }, + "location": "WestUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": "www.bing.com", + "provisioningState": "Succeeded", + "resourceState": "Stopping", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "NotSet", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443 + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": "DynamicSiteAcceleration", + "probePath": "/image", + "geoFilters": [] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json new file mode 100644 index 000000000000..ebc284fb3f56 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_Update.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "endpointUpdateProperties": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + }, + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "endpoint1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1", + "type": "Microsoft.Cdn/profiles/endpoints", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "WestCentralUs", + "properties": { + "hostName": "endpoint1.azureedge.net", + "originHostHeader": null, + "provisioningState": "Creating", + "resourceState": "Creating", + "isHttpAllowed": true, + "isHttpsAllowed": true, + "queryStringCachingBehavior": "IgnoreQueryString", + "originPath": null, + "origins": [ + { + "name": "www-bing-com", + "properties": { + "hostName": "www.bing.com", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain2.net", + "priority": 2, + "weight": 50, + "enabled": true + } + } + ], + "originGroups": [ + { + "name": "originGroup1", + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-bing-com" + } + ] + } + } + ], + "contentTypesToCompress": [], + "isCompressionEnabled": false, + "optimizationType": null, + "probePath": null, + "geoFilters": [], + "defaultOriginGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json new file mode 100644 index 000000000000..4f3257ee5e53 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Endpoints_ValidateCustomDomain.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json new file mode 100644 index 000000000000..eb045204ff85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsLocations.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": "clientRequestCount", + "granularity": "PT5M", + "groupBy": "httpStatusCode", + "dateTimeBegin": "2020-11-04T05:00:00.000Z", + "dateTimeEnd": "2020-11-04T06:00:00.000Z" + }, + "responses": { + "200": { + "body": { + "continents": [ + { + "id": "africa" + }, + { + "id": "antarctica" + }, + { + "id": "asia" + }, + { + "id": "europe" + }, + { + "id": "northAmerica" + }, + { + "id": "oceania" + }, + { + "id": "southAmerica" + } + ], + "countryOrRegions": [ + { + "id": "dz", + "continentId": "africa" + }, + { + "id": "ao", + "continentId": "africa" + }, + { + "id": "bw", + "continentId": "africa" + }, + { + "id": "bi", + "continentId": "africa" + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json new file mode 100644 index 000000000000..c01c624bf25e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsMetrics.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "granularity": "PT5M", + "groupBy": [ + "protocol" + ], + "dateTimeBegin": "2020-11-04T04:30:00.000Z", + "dateTimeEnd": "2020-11-04T05:00:00.000Z", + "customDomains": [ + "customdomain1.azurecdn.net", + "customdomain2.azurecdn.net" + ], + "protocols": [ + "https" + ] + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T12:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T13:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [ + { + "name": "protocol", + "value": "https" + } + ], + "data": [ + { + "dateTime": "2020-11-04T04:35:00+00:00", + "value": 4250 + }, + { + "dateTime": "2020-11-04T04:40:00+00:00", + "value": 3120 + }, + { + "dateTime": "2020-11-04T04:45:00+00:00", + "value": 2221 + }, + { + "dateTime": "2020-11-04T04:50:00+00:00", + "value": 2466 + }, + { + "dateTime": "2020-11-04T04:55:00+00:00", + "value": 2654 + }, + { + "dateTime": "2020-11-04T05:00:00+00:00", + "value": 3565 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json new file mode 100644 index 000000000000..e6971f7109cb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsRankings.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "url" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "tables": [ + { + "ranking": "url", + "data": [ + { + "name": "https://testdomain.com/favicon.png", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2336, + "percentage": 8.28133862733976 + } + ] + }, + { + "name": "https://testdomain.com/js/app.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 2140, + "percentage": 7.586500283607488 + } + ] + }, + { + "name": "https://testdomain.com/js/lang/en.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1536, + "percentage": 5.445263754963131 + } + ] + }, + { + "name": "https://testdomain.com/js/lib.js", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1480, + "percentage": 5.246738513896767 + } + ] + }, + { + "name": "https://cdn.exam.net/css/lib.css", + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1452, + "percentage": 5.147475893363584 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json new file mode 100644 index 000000000000..b6c2d332d7b3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetLogAnalyticsResources.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "endpoints": [ + { + "id": "endpoint1", + "name": "endpoint1.azureedge.net", + "history": false, + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": "enbdpiont1", + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + ], + "customDomains": [ + { + "id": "customdomain1.azurecdn.net", + "name": "customdomain1.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain2.azurecdn.net", + "name": "customdomain2.azurecdn.net", + "endpointId": null, + "history": true + }, + { + "id": "customdomain3.azurecdn.net", + "name": "customdomain3.azurecdn.net", + "endpointId": null, + "history": true + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json new file mode 100644 index 000000000000..7c0009aa9554 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsMetrics.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "metrics": [ + "clientRequestCount" + ], + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z", + "actions": [ + "block", + "log" + ], + "granularity": "PT5M" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:30:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:00:27.554+08:00", + "granularity": "PT5M", + "series": [ + { + "metric": "clientRequestCount", + "unit": "count", + "groups": [], + "data": [ + { + "dateTime": "2020-11-04T07:05:00+00:00", + "value": 2 + }, + { + "dateTime": "2020-11-04T07:10:00+00:00", + "value": 32 + }, + { + "dateTime": "2020-11-04T07:15:00+00:00", + "value": 31 + }, + { + "dateTime": "2020-11-04T07:20:00+00:00", + "value": 63 + }, + { + "dateTime": "2020-11-04T07:25:00+00:00", + "value": 50 + }, + { + "dateTime": "2020-11-04T07:30:00+00:00", + "value": 12 + }, + { + "dateTime": "2020-11-04T07:35:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T07:40:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T07:45:00+00:00", + "value": 30 + }, + { + "dateTime": "2020-11-04T07:50:00+00:00", + "value": 18 + }, + { + "dateTime": "2020-11-04T07:55:00+00:00", + "value": 28 + }, + { + "dateTime": "2020-11-04T08:00:00+00:00", + "value": 3 + }, + { + "dateTime": "2020-11-04T08:05:00+00:00", + "value": 58 + }, + { + "dateTime": "2020-11-04T08:10:00+00:00", + "value": 42 + }, + { + "dateTime": "2020-11-04T08:15:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:20:00+00:00", + "value": 21 + }, + { + "dateTime": "2020-11-04T08:25:00+00:00", + "value": 41 + }, + { + "dateTime": "2020-11-04T08:30:00+00:00", + "value": 8 + }, + { + "dateTime": "2020-11-04T08:35:00+00:00", + "value": 15 + }, + { + "dateTime": "2020-11-04T08:40:00+00:00", + "value": 25 + }, + { + "dateTime": "2020-11-04T08:45:00+00:00", + "value": 13 + }, + { + "dateTime": "2020-11-04T08:50:00+00:00", + "value": 17 + }, + { + "dateTime": "2020-11-04T08:55:00+00:00", + "value": 29 + }, + { + "dateTime": "2020-11-04T09:00:00+00:00", + "value": 17 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json new file mode 100644 index 000000000000..d2639a42f3b2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/LogAnalytics_GetWafLogAnalyticsRankings.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "rankings": [ + "ruleId" + ], + "metrics": [ + "clientRequestCount" + ], + "maxRanking": "5", + "dateTimeBegin": "2020-11-04T06:49:27.554Z", + "dateTimeEnd": "2020-11-04T09:49:27.554Z" + }, + "responses": { + "200": { + "body": { + "dateTimeBegin": "2020-11-04T14:49:27.554+08:00", + "dateTimeEnd": "2020-11-04T17:49:27.554+08:00", + "groups": [ + "ruleId" + ], + "data": [ + { + "groupValues": [ + "BlockRateLimit" + ], + "metrics": [ + { + "metric": "clientRequestCount", + "value": 1268, + "percentage": 0 + } + ] + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json new file mode 100644 index 000000000000..5b6d6e7baa0e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Operations_List.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-09-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cdn/register/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Microsoft.Cdn Resource Provider", + "operation": "Registers the Microsoft.Cdn Resource Provider" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/edgenodes/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "EdgeNode", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/profiles/read", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "read" + } + }, + { + "name": "Microsoft.Cdn/profiles/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/write", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "write" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/delete", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "delete" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/CheckResourceUsage/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "CheckResourceUsage" + } + }, + { + "name": "Microsoft.Cdn/operationresults/profileresults/GenerateSsoUri/action", + "display": { + "provider": "Microsoft.Cdn", + "resource": "Profile", + "operation": "GenerateSsoUri" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json new file mode 100644 index 000000000000..e7e9180589da --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Create.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "origingroup1", + "originGroup": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "201": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "originGroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json new file mode 100644 index 000000000000..ea894397bde8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json new file mode 100644 index 000000000000..1e8dc056db4a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1" + }, + "responses": { + "200": { + "body": { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpAndHttpErrors", + "responseBasedFailoverThresholdPercentage": 10, + "httpErrorRanges": [ + { + "begin": 500, + "end": 505 + } + ] + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json new file mode 100644 index 000000000000..068d939278fe --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_ListByEndpoint.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "origingroup1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1", + "type": "Microsoft.Cdn/profiles/endpoints/origingroups", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1" + } + ], + "responseBasedOriginErrorDetectionSettings": { + "responseBasedDetectedErrorTypes": "TcpErrorsOnly", + "responseBasedFailoverThresholdPercentage": 10 + } + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json new file mode 100644 index 000000000000..3fde7708c5e1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/OriginGroups_Update.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originGroupName": "originGroup1", + "originGroupUpdateProperties": { + "properties": { + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "healthProbeSettings": { + "probePath": "/health.aspx", + "probeRequestType": "GET", + "probeProtocol": "Http", + "probeIntervalInSeconds": 120 + }, + "origins": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json new file mode 100644 index 000000000000..c1bfc3f8bbce --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Create.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "origin": { + "properties": { + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" + } + } + }, + "201": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 80, + "httpsPort": 443, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "", + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json new file mode 100644 index 000000000000..7ad9a804522e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "origin1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json new file mode 100644 index 000000000000..76fe7295bec6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net" + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json new file mode 100644 index 000000000000..1d55129f21e5 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_ListByEndpoint.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": null, + "httpsPort": null, + "originHostHeader": "www.someDomain.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json new file mode 100644 index 000000000000..46f6f4ba9525 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Origins_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "originName": "www-someDomain-net", + "originUpdateProperties": { + "properties": { + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "responses": { + "200": { + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "www-someDomain-net", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/www-someDomain-net", + "type": "Microsoft.Cdn/profiles/endpoints/origins", + "properties": { + "provisioningState": "Succeeded", + "resourceState": "Active", + "hostName": "www.someDomain.net", + "httpPort": 42, + "httpsPort": 43, + "originHostHeader": "www.someDomain2.net", + "priority": 1, + "weight": 50, + "enabled": true, + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "privateLinkAlias": "APPSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json new file mode 100644 index 000000000000..e990fcf0799c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_CanMigrate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "canMigrateParameters": { + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile", + "type": "Microsoft.Cdn/canmigrate", + "properties": { + "canMigrate": true, + "defaultSku": "Standard_AzureFrontDoor", + "errors": null + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json new file mode 100644 index 000000000000..5d71afbe2c2e --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Create.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profile": { + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "201": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [ + { + "matchVariable": "RequestIPAddress", + "selectorMatchOperator": "EqualsAny", + "selector": null, + "state": "Enabled" + } + ] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Creating", + "resourceState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json new file mode 100644 index 000000000000..0916458730c6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json new file mode 100644 index 000000000000..6b8bd50baefa --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_GenerateSsoUri.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "ssoUriValue": "https://someuri.com" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json new file mode 100644 index 000000000000..a82a4dfd3e04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json new file mode 100644 index 000000000000..c590a49088af --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_List.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG1/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json new file mode 100644 index 000000000000..e2f448df16bb --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + }, + { + "name": "profile2", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile2", + "type": "Microsoft.Cdn/profiles", + "tags": {}, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json new file mode 100644 index 000000000000..8697e399d591 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListResourceUsage.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "endpoint", + "unit": "count", + "currentValue": 0, + "limit": 25 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json new file mode 100644 index 000000000000..2b0b2c32d5a1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_ListSupportedOptimizationTypes.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "supportedOptimizationTypes": [ + "GeneralWebDelivery", + "DynamicSiteAcceleration" + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json new file mode 100644 index 000000000000..d9eb28c9dea8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Migrate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "migrationParameters": { + "sku": { + "name": "Standard_AzureFrontDoor" + }, + "classicResourceReference": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname" + }, + "profileName": "profile1" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1", + "type": "Microsoft.Cdn/migrate", + "properties": { + "migratedProfileResourceId": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1" + } + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json new file mode 100644 index 000000000000..cf5e080906d2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationAbort.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json new file mode 100644 index 000000000000..9d516c0d1760 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_MigrationCommit.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json new file mode 100644 index 000000000000..24082ad92c79 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Profiles_Update.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "profileUpdateParameters": { + "tags": { + "additionalProperties": "Tag1" + } + } + }, + "responses": { + "200": { + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Succeeded", + "resourceState": "Active" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "profile1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1", + "type": "Microsoft.Cdn/profiles", + "tags": { + "additionalProperties": "Tag1" + }, + "location": "global", + "sku": { + "name": "Premium_AzureFrontDoor" + }, + "kind": "frontdoor", + "properties": { + "originResponseTimeoutSeconds": 30, + "logScrubbing": { + "state": "Enabled", + "scrubbingRules": [] + }, + "frontDoorId": "3b4682da-b3e2-47a1-96ca-08ab3cb7294e", + "provisioningState": "Updating", + "resourceState": "Active" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json new file mode 100644 index 000000000000..01ac52f3af71 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ResourceUsage_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "profile", + "unit": "count", + "currentValue": 31, + "limit": 200 + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json new file mode 100644 index 000000000000..741d0f6a7627 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Create.json @@ -0,0 +1,196 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "route": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreSpecifiedQueryStrings", + "queryParameters": "querystring=test" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json new file mode 100644 index 000000000000..b9a57becda1c --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json new file mode 100644 index 000000000000..fef031e0b728 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Get.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json new file mode 100644 index 000000000000..0bb626dc275b --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_ListByEndpoint.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json new file mode 100644 index 000000000000..47e32c75b17f --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Routes_Update.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "endpointName": "endpoint1", + "routeName": "route1", + "routeUpdateProperties": { + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString" + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1", + "type": "Microsoft.Cdn/profiles/afdendpoints/routes", + "properties": { + "customDomains": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1" + } + ], + "originGroup": { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1" + }, + "originPath": null, + "ruleSets": [ + { + "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1" + } + ], + "supportedProtocols": [ + "Https", + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "cacheConfiguration": { + "compressionSettings": { + "contentTypesToCompress": [ + "text/html", + "application/octet-stream" + ], + "isCompressionEnabled": true + }, + "queryStringCachingBehavior": "IgnoreQueryString", + "queryParameters": null + }, + "forwardingProtocol": "MatchRequest", + "linkToDefaultDomain": "Enabled", + "httpsRedirect": "Enabled", + "enabledState": "Enabled", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json new file mode 100644 index 000000000000..eb0b3eb03bb7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Create.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json new file mode 100644 index 000000000000..5451157fbf6d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json new file mode 100644 index 000000000000..fb9c7c270b16 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json new file mode 100644 index 000000000000..cf8b9786c1b9 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListByProfile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleSet1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1", + "type": "Microsoft.Cdn/profiles/rulesets", + "properties": { + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json new file mode 100644 index 000000000000..80b4c18fdab4 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/RuleSets_ListResourceUsage.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 25, + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "name": { + "value": "rule", + "localizedValue": "rule" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json new file mode 100644 index 000000000000..6c5ddaaf1e0a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Create.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "rule": { + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Creating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json new file mode 100644 index 000000000000..a509654df62a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json new file mode 100644 index 000000000000..a62f63befd85 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json new file mode 100644 index 000000000000..20492a4573ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_ListByRuleSet.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json new file mode 100644 index 000000000000..96f31db989d1 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Rules_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "ruleSetName": "ruleSet1", + "ruleName": "rule1", + "ruleUpdateProperties": { + "properties": { + "order": 1, + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1/rules/rule1", + "type": "Microsoft.Cdn/profiles/rulesets/rules", + "properties": { + "order": 1, + "conditions": [ + { + "name": "RequestMethod", + "parameters": { + "typeName": "DeliveryRuleRequestMethodConditionParameters", + "operator": "Equal", + "matchValues": [ + "GET" + ], + "negateCondition": false, + "transforms": [] + } + } + ], + "actions": [ + { + "name": "ModifyResponseHeader", + "parameters": { + "typeName": "DeliveryRuleHeaderActionParameters", + "headerAction": "Overwrite", + "headerName": "X-CDN", + "value": "MSFT" + } + } + ], + "matchProcessingBehavior": "Continue", + "provisioningState": "Updating", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json new file mode 100644 index 000000000000..802db088a6d6 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Create.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1", + "secret": { + "properties": { + "parameters": { + "type": "CustomerCertificate", + "secretVersion": "abcdef1234578900abcdef1234567890", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/secrets/certificatename" + }, + "useLatestVersion": false + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "201": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json new file mode 100644 index 000000000000..77b2842a05b8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json new file mode 100644 index 000000000000..350516a84b04 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "secretName": "secret1" + }, + "responses": { + "200": { + "body": { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json new file mode 100644 index 000000000000..d04b5c8f79ff --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/Secrets_ListByProfile.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "secret1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1", + "type": "Microsoft.Cdn/profiles/secrets", + "properties": { + "parameters": { + "type": "CustomerCertificate", + "subject": "*.contoso.com", + "certificateAuthority": "Symantec", + "expirationDate": "2025-01-01T00:00:00-00:00", + "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12", + "secretSource": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename" + }, + "secretVersion": "abcdef1234578900abcdef1234567890", + "useLatestVersion": true, + "subjectAlternativeNames": [ + "foo.contoso.com", + "www3.foo.contoso.com" + ] + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name", + "type": "Microsoft.Cdn/profiles/secrets", + "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz", + "properties": { + "parameters": { + "type": "ManagedCertificate", + "subject": "bar.contoso.com", + "expirationDate": "2025-01-01T00:00:00-00:00" + }, + "provisioningState": "Succeeded", + "deploymentStatus": "NotStarted" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json new file mode 100644 index 000000000000..588c03856635 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Create.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicy": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json new file mode 100644 index 000000000000..50d4e6f69ec7 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + } + }, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json new file mode 100644 index 000000000000..982f8795d8e3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1" + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json new file mode 100644 index 000000000000..b0072b486db8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_ListByProfile.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json new file mode 100644 index 000000000000..c3d5b6c395f2 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/SecurityPolicies_Patch.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "RG", + "profileName": "profile1", + "securityPolicyName": "securityPolicy1", + "securityPolicyUpdateProperties": { + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "securityPolicy1", + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/securitypolicies/securityPolicy1", + "type": "Microsoft.Cdn/profiles/securitypolicies", + "properties": { + "parameters": { + "type": "WebApplicationFirewall", + "wafPolicy": { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/wafTest" + }, + "associations": [ + { + "domains": [ + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain1" + }, + { + "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/testdomain2" + } + ], + "patternsToMatch": [ + "/*" + ] + } + ] + }, + "deploymentStatus": "NotStarted", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json new file mode 100644 index 000000000000..d3728e5807c3 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/ValidateProbe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "validateProbeInput": { + "probeURL": "https://www.bing.com/image" + } + }, + "responses": { + "200": { + "body": { + "isValid": true, + "errorCode": "None", + "message": null + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..6fd17a80c19d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListManagedRuleSets.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallmanagedrulesets", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroups": [ + { + "ruleGroupName": "Group1", + "description": "Description for rule group 1.", + "rules": [ + { + "ruleId": "GROUP1-0001", + "description": "Generic managed web application firewall rule." + }, + { + "ruleId": "GROUP1-0002", + "description": "Generic managed web application firewall rule." + } + ] + }, + { + "ruleGroupName": "Group2", + "description": "Description for rule group 2.", + "rules": [ + { + "ruleId": "GROUP2-0001", + "description": "Generic managed web application firewall rule." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..3daa50835a0d --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafListPolicies.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + }, + { + "name": "VerizonStandardCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/VerizonStandardCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Verizon" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "ECRS", + "ruleSetVersion": "2018-11-2", + "ruleGroupOverrides": [ + { + "ruleGroupName": "XSS", + "rules": [ + { + "ruleId": "XSS-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "XSS-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json new file mode 100644 index 000000000000..2a3c080ad91a --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPatchPolicy.json @@ -0,0 +1,275 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicyPatchParameters": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "foo": "bar" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 403, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..abe3c83b1d08 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy", + "cdnWebApplicationFirewallPolicy": { + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "policySettings": { + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "201": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2024-09-01" + }, + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Creating", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 200, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 3, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..19b06efe8e72 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..7c3f34ff1bf8 --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/examples/WafPolicyGet.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2024-09-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "MicrosoftCdnWafPolicy" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftCdnWafPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/MicrosoftCdnWafPolicy", + "type": "Microsoft.Cdn/cdnwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "sku": { + "name": "Standard_Microsoft" + }, + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "defaultRedirectUrl": "http://www.bing.com", + "defaultCustomBlockResponseStatusCode": 429, + "defaultCustomBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "rateLimitRules": { + "rules": [ + { + "name": "RateLimitRule1", + "priority": 1, + "enabledState": "Enabled", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + } + ] + }, + "customRules": { + "rules": [ + { + "name": "CustomRule1", + "priority": 2, + "enabledState": "Enabled", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "transforms": [], + "matchValue": [ + "windows" + ] + }, + { + "matchVariable": "QueryString", + "selector": "search", + "operator": "Contains", + "negateCondition": false, + "transforms": [ + "UrlDecode", + "Lowercase" + ], + "matchValue": [ + "" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "preview-1.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "Group1", + "rules": [ + { + "ruleId": "GROUP1-0001", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "GROUP1-0002", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "endpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cdn/profiles/profile1/endpoints/testEndpoint2" + } + ] + } + } + } + } +} diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml new file mode 100644 index 000000000000..7259132992bd --- /dev/null +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-09-01/scenarios/AFDProfiles_Upgrade_WithoutWaf.yaml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json +scope: ResourceGroup +variables: + afdprofileName: + type: string + prefix: afdprofile +scenarios: + - scenario: GeneratedScenario + steps: + - step: CheckNameAvailabilityWithSubscription + operationId: CheckNameAvailabilityWithSubscription + exampleFile: ../examples/CheckNameAvailabilityWithSubscription.json + - step: AFDProfiles_Create + operationId: Profiles_Create + parameters: + profileName: $(afdprofileName) + profile: + location: "global" + sku: + name: Standard_AzureFrontDoor + identity: + type: "SystemAssigned" + - step: AFDProfiles_Upgrade + operationId: AFDProfiles_Upgrade + parameters: + profileName: $(afdprofileName) + profileUpgradeParameters: + wafMappingList: [] diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index d53eb61cf0ca..443c5a4a8a57 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -29,7 +29,21 @@ These are the global settings for the Cdn API. title: CdnManagementClient description: Cdn Management Client openapi-type: arm -tag: package-2024-02 +tag: package-2024-09 +``` + +### Tag: package-2024-09 + +These settings apply only when `--tag=package-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-2024-09' +input-file: + - Microsoft.Cdn/stable/2024-09-01/afdx.json + - Microsoft.Cdn/stable/2024-09-01/cdn.json + - Microsoft.Cdn/stable/2024-09-01/cdnwebapplicationfirewall.json +suppressions: + - code: MISSING_RESOURCE_ID + reason: Keeping it for legacy tooling ``` ### Tag: package-preview-2024-06 diff --git a/specification/cdn/resource-manager/sdk-suppressions.yaml b/specification/cdn/resource-manager/sdk-suppressions.yaml index 45f1cd17ed81..d9f6c6e4c768 100644 --- a/specification/cdn/resource-manager/sdk-suppressions.yaml +++ b/specification/cdn/resource-manager/sdk-suppressions.yaml @@ -106,3 +106,40 @@ suppressions: - Type of `URLRewriteActionParameters.TypeName` has been changed from `*URLRewriteActionParametersTypeName` to `*DeliveryRuleActionParametersType` - Type of `URLSigningAction.Name` has been changed from `*DeliveryRuleAction` to `*DeliveryRuleActionName` - Type of `URLSigningActionParameters.TypeName` has been changed from `*URLSigningActionParametersTypeName` to `*DeliveryRuleActionParametersType` + azure-sdk-for-python: + - package: azure-mgmt-cdn + breaking-changes: + - Deleted or renamed enum value `MatchProcessingBehavior.CONTINUE_ENUM` + - Deleted or renamed model `CacheExpirationActionParametersTypeName` + - Deleted or renamed model `CacheKeyQueryStringActionParametersTypeName` + - Deleted or renamed model `CdnCertificateSourceParametersTypeName` + - Deleted or renamed model `ClientPortMatchConditionParametersTypeName` + - Deleted or renamed model `CookiesMatchConditionParametersTypeName` + - Deleted or renamed model `HeaderActionParametersTypeName` + - Deleted or renamed model `HostNameMatchConditionParametersTypeName` + - Deleted or renamed model `HttpVersionMatchConditionParametersTypeName` + - Deleted or renamed model `IsDeviceMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `IsDeviceMatchConditionParametersTypeName` + - Deleted or renamed model `KeyVaultCertificateSourceParametersTypeName` + - Deleted or renamed model `KeyVaultSigningKeyParametersTypeName` + - Deleted or renamed model `OriginGroupOverrideActionParametersTypeName` + - Deleted or renamed model `PostArgsMatchConditionParametersTypeName` + - Deleted or renamed model `QueryStringMatchConditionParametersTypeName` + - Deleted or renamed model `RemoteAddressMatchConditionParametersTypeName` + - Deleted or renamed model `RequestBodyMatchConditionParametersTypeName` + - Deleted or renamed model `RequestHeaderMatchConditionParametersTypeName` + - Deleted or renamed model `RequestMethodMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestMethodMatchConditionParametersTypeName` + - Deleted or renamed model `RequestSchemeMatchConditionParametersMatchValuesItem` + - Deleted or renamed model `RequestSchemeMatchConditionParametersTypeName` + - Deleted or renamed model `RequestUriMatchConditionParametersTypeName` + - Deleted or renamed model `RouteConfigurationOverrideActionParametersTypeName` + - Deleted or renamed model `ServerPortMatchConditionParametersTypeName` + - Deleted or renamed model `SocketAddrMatchConditionParametersTypeName` + - Deleted or renamed model `SslProtocolMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileExtensionMatchConditionParametersTypeName` + - Deleted or renamed model `UrlFileNameMatchConditionParametersTypeName` + - Deleted or renamed model `UrlPathMatchConditionParametersTypeName` + - Deleted or renamed model `UrlRedirectActionParametersTypeName` + - Deleted or renamed model `UrlRewriteActionParametersTypeName` + - Deleted or renamed model `UrlSigningActionParametersTypeName` From ae95eb6a4701d844bada7d1c4f5ecf4a7444e5b8 Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Fri, 27 Sep 2024 12:40:18 -0500 Subject: [PATCH 010/101] Files Provisioned Billing V2 updates (#30752) --- .../stable/2025-01-05/file.json | 38 +++++++++++-------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json index fddbcfb61b94..904e160827cb 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json +++ b/specification/storage/data-plane/Microsoft.FileStorage/stable/2025-01-05/file.json @@ -328,19 +328,25 @@ "x-ms-client-name": "ShareProvisionedIops", "type": "integer", "format": "int64", - "description": "The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned IOPS of the share." }, "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ShareProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate)." + "description": "The provisioned throughput of the share." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "ShareIncludedBurstIops", "type": "integer", "format": "int64", - "description": "ShareIncludedBurstIops" + "description": "Returns the calculated burst IOPS of the share." + }, + "x-ms-share-max-burst-credits-for-iops": { + "x-ms-client-name": "MaxBurstCreditsForIops", + "description": "Returned the calculated maximum burst credits.", + "type": "integer", + "format": "int64" } } }, @@ -444,7 +450,7 @@ "x-ms-share-provisioned-bandwidth-mibps": { "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-lease-duration": { "x-ms-client-name": "LeaseDuration", @@ -559,13 +565,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -630,15 +636,15 @@ "format": "date-time-rfc1123", "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." }, - "x-ms-share-usage-bytes": { + "x-ms-file-share-usage-bytes": { "type": "integer", "format": "int64", - "description": "The \"live share\" portion of the data that the customer will be billed for in the soft-deleted capacity (logical storage size)." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used storage size of the share, in bytes." }, - "x-ms-share-snapshot-usage-bytes": { + "x-ms-file-share-snapshot-usage-bytes": { "type": "integer", "format": "int64", - "description": "The snapshot share portion of the data that the customer will be billed for in the soft-deleted capacity (this is the delta, or \"physical storage size\")." + "description": "Returned only for provisioned v2 file shares. Returns an approximate used snapshot storage size of the share, in bytes." } } }, @@ -1638,7 +1644,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -1660,13 +1666,13 @@ }, "x-ms-share-next-allowed-provisioned-iops-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedIopsDowngradeTime", - "description": "Return timestamp for provisioned IOPS following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned iops downgrade time.", "type": "string", "format": "date-time-rfc1123" }, "x-ms-share-next-allowed-provisioned-bandwidth-downgrade-time": { "x-ms-client-name": "NextAllowedProvisionedBandwidthDowngradeTime", - "description": "Return timestamp for provisioned throughput following existing rules for provisioned storage GiB.", + "description": "Returns the current share next allowed provisioned bandwidth downgrade time.", "type": "string", "format": "date-time-rfc1123" } @@ -2137,7 +2143,7 @@ "x-ms-client-name": "ProvisionedBandwidthMibps", "type": "integer", "format": "int64", - "description": "Returns the current share provisioned bandwidth in megabits per second." + "description": "Returns the current share provisioned bandwidth in mebibytes per second." }, "x-ms-share-included-burst-iops": { "x-ms-client-name": "IncludedBurstIops", @@ -7703,7 +7709,7 @@ "name": "x-ms-share-provisioned-iops", "x-ms-client-name": "shareProvisionedIops", "in": "header", - "description": "Optional. The provisioned IOPS of the share. If this is not specified, compute the recommended IOPS of the share using the formula for a share in this media tier (SSD/HDD as appropriate). The provisioned IOPS of the share is always explicitly stored on the share object, even if the recommendation formula is used.", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned number of input/output operations per second (IOPS) of the share. If this is not specified, the provisioned IOPS is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", @@ -7713,7 +7719,7 @@ "name": "x-ms-share-provisioned-bandwidth-mibps", "x-ms-client-name": "shareProvisionedBandwidthMibps", "in": "header", - "description": "Optional. The provisioned throughput of the share. If this is not specified, compute the recommended throughput of the share using the formula for a share in this media tier (SSD/HDD as appropriate).", + "description": "Optional. Supported in version 2025-01-05 and later. Only allowed for provisioned v2 file shares. Specifies the provisioned bandwidth of the share, in mebibytes per second (MiBps). If this is not specified, the provisioned bandwidth is set to value calculated based on recommendation formula.", "required": false, "type": "integer", "format": "int64", From 6e9a98ba9692ce2090945bcf5d63bd11f77fc9ff Mon Sep 17 00:00:00 2001 From: yijinglu-microsoft Date: Fri, 27 Sep 2024 13:15:32 -0700 Subject: [PATCH 011/101] Review request for Microsoft.Devices to add version preview/2025-02-01-preview (#30603) * Copied Content from Previous Api Version * Added MI features for IotHubs * Moved iothubs from Patch to Create * Reverted DPS Create Changes * Updated Description * Fixed Comments --- .../DPSCertificateCreateOrUpdate.json | 33 + .../examples/DPSCheckNameAvailability.json | 18 + .../examples/DPSCreate.json | 75 + ...eateOrUpdatePrivateEndpointConnection.json | 53 + .../examples/DPSDelete.json | 20 + .../examples/DPSDeleteCertificate.json | 14 + .../DPSDeletePrivateEndpointConnection.json | 51 + .../examples/DPSGenerateVerificationCode.json | 27 + .../2025-02-01-preview/examples/DPSGet.json | 47 + .../examples/DPSGetCertificate.json | 28 + .../examples/DPSGetCertificates.json | 31 + .../examples/DPSGetKey.json | 19 + .../examples/DPSGetOperationResult.json | 17 + .../DPSGetPrivateEndpointConnection.json | 28 + .../examples/DPSGetPrivateLinkResources.json | 27 + .../examples/DPSGetValidSku.json | 19 + .../examples/DPSListByResourceGroup.json | 83 + .../examples/DPSListBySubscription.json | 82 + .../examples/DPSListKeys.json | 28 + .../DPSListPrivateEndpointConnections.json | 29 + .../examples/DPSListPrivateLinkResources.json | 30 + .../examples/DPSOperations.json | 293 ++ .../2025-02-01-preview/examples/DPSPatch.json | 55 + .../examples/DPSUpdate.json | 103 + .../examples/DPSVerifyCertificate.json | 32 + .../preview/2025-02-01-preview/iotdps.json | 2602 +++++++++++++++++ .../resource-manager/readme.md | 10 +- 27 files changed, 3853 insertions(+), 1 deletion(-) create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json create mode 100644 specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json new file mode 100644 index 000000000000..d384a67892f1 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCertificateCreateOrUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "MA==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json new file mode 100644 index 000000000000..9a2550a599d0 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "arguments": { + "name": "test213123" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "name is valid" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json new file mode 100644 index 000000000000..ade2b482cfe3 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..e393b70cd333 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSCreateOrUpdatePrivateEndpointConnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json new file mode 100644 index 000000000000..93cfb7bacbc5 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "404": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json new file mode 100644 index 000000000000..192680070d18 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeleteCertificate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..b33bd8fcda96 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSDeletePrivateEndpointConnection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + }, + "headers": { + "Retry-After": "15", + "Location": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15", + "Azure-AsyncOperation": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2015-03-15" + } + }, + "204": {} + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json new file mode 100644 index 000000000000..906c9f322fa7 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGenerateVerificationCode.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "certificate": "MA==", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json new file mode 100644 index 000000000000..313e13101156 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json new file mode 100644 index 000000000000..4c79e9ed564b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "certificate": "MA==", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json new file mode 100644 index 000000000000..fdd7f9e93c67 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetCertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT", + "certificate": "MA==" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json new file mode 100644 index 000000000000..3aea3230851b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "testKey" + }, + "responses": { + "200": { + "body": { + "keyName": "testKey", + "primaryKey": "##################################", + "secondaryKey": "################################", + "rights": "RegistrationStatusWrite" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json new file mode 100644 index 000000000000..594c23b12226 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetOperationResult.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationId": "MTY5OTNmZDctODI5Yy00N2E2LTkxNDQtMDU1NGIyYzY1ZjRl", + "asyncinfo": "1508265712453" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..54f909fa8f3e --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateEndpointConnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json new file mode 100644 index 000000000000..9a88329068a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetPrivateLinkResources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotDps" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json new file mode 100644 index 000000000000..81468e225ea9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSGetValidSku.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "S1" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json new file mode 100644 index 000000000000..74995ef2de66 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "mySecondProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json new file mode 100644 index 000000000000..8675aa9965c4 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListBySubscription.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + }, + { + "etag": "AAAAAAAADGk=", + "name": "mySecondProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "01341f2b-d497-4117-b5c1-1f1d50b25444", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity2": { + "clientId": "8cd6d250-17dd-4c1b-9847-225237b94c55", + "principalId": "8785a11f-848a-4d5d-a55b-e381b9e15512" + } + } + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json new file mode 100644 index 000000000000..fcc4739fa765 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListKeys.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "key1", + "primaryKey": "#####################################", + "secondaryKey": "###################################", + "rights": "ServiceConfig" + }, + { + "keyName": "key2", + "primaryKey": "#######################################", + "secondaryKey": "####################################=", + "rights": "ServiceConfig" + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json new file mode 100644 index 000000000000..24a98070ae4b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateEndpointConnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/ProvisioningServices/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json new file mode 100644 index 000000000000..47b21410a6a9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/PrivateLinkResources/iotDps", + "name": "iotDps", + "type": "Microsoft.Devices/ProvisioningServices/PrivateLinkResources", + "properties": { + "groupId": "iotDps", + "requiredMembers": [ + "iotDps" + ], + "requiredZoneNames": [ + "privatelink.azure-devices-provisioning.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json new file mode 100644 index 000000000000..d5f1c5649b8b --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSOperations.json @@ -0,0 +1,293 @@ +{ + "parameters": { + "api-version": "2025-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json new file mode 100644 index 000000000000..fc501f9960dd --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSPatch.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/ProvisioningServices", + "ProvisioningServiceTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": { + "foo": "bar" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json new file mode 100644 index 000000000000..a3e15626d8e9 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSUpdate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotDpsDescription": { + "location": "East US", + "properties": { + "enableDataResidency": false + }, + "sku": { + "name": "S1", + "capacity": 1 + }, + "tags": {}, + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + }, + "201": { + "body": { + "etag": "AAAAAAAADGk=", + "name": "myFirstProvisioningService", + "location": "eastus", + "properties": { + "state": "Active", + "allocationPolicy": "Hashed", + "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net", + "deviceProvisioningHostName": "global.azure-devices-provisioning.net", + "idScope": "0ne00000012", + "authorizationPolicies": [], + "enableDataResidency": false, + "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net" + }, + "resourcegroup": "myResourceGroup", + "type": "Microsoft.Devices/ProvisioningServices", + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService", + "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0", + "tags": {}, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + }, + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd", + "userAssignedIdentities": { + "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": { + "clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323", + "principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9" + } + } + } + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json new file mode 100644 index 000000000000..e8b4d390e502 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/examples/DPSVerifyCertificate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "provisioningServiceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2025-02-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "request": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "certificate": "MA==", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/ProvisioningServices/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json new file mode 100644 index 000000000000..733eba185022 --- /dev/null +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2025-02-01-preview/iotdps.json @@ -0,0 +1,2602 @@ +{ + "swagger": "2.0", + "info": { + "version": "2025-02-01-preview", + "x-ms-code-generation-settings": { + "host": "management.azure.com" + }, + "title": "iotDpsClient", + "description": "API for using the Azure IoT Hub Device Provisioning Service features." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "DPSOperations": { + "$ref": "./examples/DPSOperations.json" + } + }, + "description": "Lists all of the available Microsoft.Devices REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Get", + "description": "Get the certificate from the provisioning service.", + "x-ms-examples": { + "DPSGetCertificate": { + "$ref": "./examples/DPSGetCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the certificate to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service the certificate is associated with." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Metadata for the specified certificate.", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "put": { + "tags": [ + "DpsCertificate" + ], + "summary": "Upload the certificate to the provisioning service.", + "description": "Add new certificate or update an existing certificate.", + "operationId": "DpsCertificate_CreateOrUpdate", + "x-ms-examples": { + "DPSCreateOrUpdateCertificate": { + "$ref": "./examples/DPSCertificateCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group identifier.", + "required": true, + "type": "string" + }, + { + "name": "provisioningServiceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate create or update.", + "required": true, + "type": "string", + "maxLength": 256 + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + } + ], + "responses": { + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_Delete", + "summary": "Delete the Provisioning Service Certificate.", + "description": "Deletes the specified certificate associated with the Provisioning Service", + "x-ms-examples": { + "DPSDeleteCertificate": { + "$ref": "./examples/DPSDeleteCertificate.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate" + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the provisioning service." + }, + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "This is a mandatory field, and is the logical name of the certificate that the provisioning service will access by." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "This is optional, and it is the Common Name of the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data within the certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "A description that mentions the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "description": "Time the certificate is created.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "description": "Time the certificate is last updated.", + "format": "date-time" + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains a private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "204": { + "description": "No content." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the non-security related metadata of the provisioning service.", + "description": "Get the metadata of the provisioning service without SAS keys.", + "operationId": "IotDpsResource_Get", + "x-ms-examples": { + "DPSGet": { + "$ref": "./examples/DPSGet.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service to retrieve." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning service description with no keys is included in the response.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "put": { + "tags": [ + "IotDpsResource" + ], + "summary": "Create or update the metadata of the provisioning service.", + "description": "Create or update the metadata of the provisioning service. The usual pattern to modify a property is to retrieve the provisioning service metadata and security metadata, and then combine them with the modified values in a new body to update the provisioning service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_CreateOrUpdate", + "x-ms-examples": { + "DPSCreate": { + "$ref": "./examples/DPSCreate.json" + }, + "DPSUpdate": { + "$ref": "./examples/DPSUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "iotDpsDescription", + "in": "body", + "required": true, + "description": "Description of the provisioning service to create or update.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the provisioning service. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "patch": { + "tags": [ + "IotDpsResource" + ], + "summary": "Update an existing provisioning service's tags.", + "description": "Update an existing provisioning service's tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Update", + "x-ms-examples": { + "DPSPatch": { + "$ref": "./examples/DPSPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to create or update." + }, + { + "name": "ProvisioningServiceTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the provisioning service instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Provisioning Service was successfully updated", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "IotDpsResource" + ], + "summary": "Delete the Provisioning Service", + "description": "Deletes the Provisioning Service.", + "x-ms-long-running-operation": true, + "operationId": "IotDpsResource_Delete", + "x-ms-examples": { + "DPSDelete": { + "$ref": "./examples/DPSDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to delete." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "202": { + "description": "The provisioning service resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the provisioning service status directly, or query the operation resource." + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state." + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the provisioning service metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the provisioning service metadata in the service." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates": { + "get": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_List", + "description": "Get all the certificates tied to the provisioning service.", + "x-ms-examples": { + "DPSGetCertificates": { + "$ref": "./examples/DPSGetCertificates.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service to retrieve certificates for." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of certificate descriptions in a JSON-serialized array.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get all the provisioning services in a subscription.", + "description": "List all the provisioning services for a given subscription id.", + "operationId": "IotDpsResource_ListBySubscription", + "x-ms-examples": { + "DPSListBySubscription": { + "$ref": "./examples/DPSListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the provisioning services in the subscription.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListByResourceGroup", + "description": "Get a list of all provisioning services in the given resource group.", + "x-ms-examples": { + "DPSListByResourceGroup": { + "$ref": "./examples/DPSListByResourceGroup.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "List of provisioning services in the resource group.", + "schema": { + "$ref": "#/definitions/ProvisioningServiceDescriptionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/operationresults/{operationId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_GetOperationResult", + "description": "Gets the status of a long running operation, such as create, update or delete a provisioning service.", + "x-ms-examples": { + "DPSGetOperationResult": { + "$ref": "./examples/DPSGetOperationResult.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "Operation id corresponding to long running operation. Use this to poll for the status." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service that the operation is running on." + }, + { + "name": "asyncinfo", + "in": "query", + "description": "Async header used to poll on the status of the operation, obtained while creating the long running operation.", + "required": true, + "type": "string", + "default": "true" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/skus": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the list of valid SKUs for a provisioning service.", + "description": "Gets the list of valid SKUs and tiers for a provisioning service.", + "operationId": "IotDpsResource_listValidSkus", + "x-ms-examples": { + "DPSGetValidSku": { + "$ref": "./examples/DPSGetValidSku.json" + } + }, + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of resource group." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this provisioning service.", + "schema": { + "$ref": "#/definitions/IotDpsSkuDefinitionListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_GenerateVerificationCode", + "description": "Generate verification code for Proof of Possession.", + "x-ms-examples": { + "DPSGenerateVerificationCode": { + "$ref": "./examples/DPSGenerateVerificationCode.json" + } + }, + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "name of resource group." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of provisioning service." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "type": "string", + "description": "Description mentioning the purpose of the certificate.", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Generated verification code for that certificate is returned.", + "schema": { + "$ref": "#/definitions/VerificationCodeResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "DpsCertificate" + ], + "operationId": "DpsCertificate_VerifyCertificate", + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "x-ms-examples": { + "DPSVerifyCertificate": { + "$ref": "./examples/DPSVerifyCertificate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "description": "The mandatory logical name of the certificate, that the provisioning service uses to access." + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the certificate." + }, + { + "name": "request", + "in": "body", + "required": true, + "description": "The name of the certificate", + "schema": { + "$ref": "#/definitions/VerificationCodeRequest" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name." + }, + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Provisioning service name." + }, + { + "name": "certificate.name", + "in": "query", + "required": false, + "type": "string", + "description": "Common Name for the certificate." + }, + { + "name": "certificate.rawBytes", + "in": "query", + "required": false, + "type": "string", + "format": "byte", + "description": "Raw data of certificate." + }, + { + "name": "certificate.isVerified", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate has been verified by owner of the private key." + }, + { + "name": "certificate.purpose", + "in": "query", + "required": false, + "description": "Describe the purpose of the certificate.", + "type": "string", + "enum": [ + "clientAuthentication", + "serverAuthentication" + ], + "x-ms-enum": { + "name": "CertificatePurpose", + "modelAsString": true + } + }, + { + "name": "certificate.created", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate creation time." + }, + { + "name": "certificate.lastUpdated", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "Certificate last updated time." + }, + { + "name": "certificate.hasPrivateKey", + "in": "query", + "required": false, + "type": "boolean", + "description": "Indicates if the certificate contains private key." + }, + { + "name": "certificate.nonce", + "in": "query", + "required": false, + "type": "string", + "description": "Random number generated to indicate Proof of Possession." + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CertificateResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_CheckProvisioningServiceNameAvailability", + "x-ms-examples": { + "DPSCheckName": { + "$ref": "./examples/DPSCheckNameAvailability.json" + } + }, + "summary": "Check if a provisioning service name is available.", + "description": "Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "arguments", + "in": "body", + "required": true, + "description": "Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.", + "schema": { + "$ref": "#/definitions/OperationInputs" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the provisioning service name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/NameAvailabilityInfo" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeys", + "x-ms-examples": { + "DPSListKeys": { + "$ref": "./examples/DPSListKeys.json" + } + }, + "summary": "Get the security metadata for a provisioning service.", + "description": "List the primary and secondary keys for a provisioning service.", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The provisioning service name to get the shared access keys for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "resource group name" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys": { + "post": { + "tags": [ + "IotDpsResource" + ], + "operationId": "IotDpsResource_ListKeysForKeyName", + "x-ms-examples": { + "DPSGetKey": { + "$ref": "./examples/DPSGetKey.json" + } + }, + "summary": "Get a shared access policy by name from a provisioning service.", + "description": "List primary and secondary keys for a specific key name", + "parameters": [ + { + "name": "provisioningServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the provisioning service." + }, + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "Logical key name to get key-values for." + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more provisioning service endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private link resources", + "description": "List private link resources for the given provisioning service", + "operationId": "IotDpsResource_ListPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given provisioning service", + "operationId": "IotDpsResource_GetPrivateLinkResources", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/DPSGetPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "IotDpsResource_ListPrivateEndpointConnections", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/DPSListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "IotDpsResource" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "IotDpsResource_GetPrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/DPSGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "IotDpsResource" + ], + "summary": "Create or update private endpoint connection", + "description": "Create or update the status of a private endpoint connection with the specified name", + "operationId": "IotDpsResource_CreateOrUpdatePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/DPSCreateOrUpdatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "IotDpsResource" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "IotDpsResource_DeletePrivateEndpointConnection", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/DPSDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Location": { + "type": "string", + "description": "Operation Status Location URI" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + } + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "AsyncOperationResult": { + "type": "object", + "description": "Result of a long running operation.", + "properties": { + "status": { + "description": "current status of a long running operation.", + "type": "string" + }, + "error": { + "description": "Error message containing code, description and details", + "$ref": "#/definitions/ErrorMessage" + } + } + }, + "ErrorMessage": { + "description": "Error response containing message and code.", + "type": "object", + "properties": { + "code": { + "description": "standard error code", + "type": "string" + }, + "message": { + "description": "standard error description", + "type": "string" + }, + "details": { + "description": "detailed summary of error", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateResponse" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "Base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + }, + "isVerified": { + "description": "True indicates that the certificate will be created in verified state and proof of possession will not be required.", + "type": "boolean" + } + } + }, + "CertificateResponse": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "description": "properties of a certificate", + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean" + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "description": "The certificate's creation date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + } + } + }, + "IotDpsSkuInfo": { + "type": "object", + "description": "List of possible provisioning service SKUs.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "Pricing tier name of the provisioning service." + }, + "capacity": { + "format": "int64", + "type": "integer", + "description": "The number of units to provision" + } + } + }, + "ProvisioningServiceDescription": { + "description": "The description of the provisioning service.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "Service specific properties for a provisioning service", + "$ref": "#/definitions/IotDpsPropertiesDescription" + }, + "sku": { + "description": "Sku info for a provisioning Service.", + "$ref": "#/definitions/IotDpsSkuInfo" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + }, + "identity": { + "description": "The managed identities for a provisioning service.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku", + "properties" + ] + }, + "IotDpsPropertiesDescription": { + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "type": "object", + "properties": { + "state": { + "description": "Current state of the provisioning service.", + "enum": [ + "Activating", + "Active", + "Deleting", + "Deleted", + "ActivationFailed", + "DeletionFailed", + "Transitioning", + "Suspending", + "Suspended", + "Resuming", + "FailingOver", + "FailoverFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The ARM provisioning state of the provisioning service.", + "type": "string" + }, + "iotHubs": { + "type": "array", + "description": "List of IoT hubs associated with this provisioning service.", + "items": { + "$ref": "#/definitions/IotHubDefinitionDescription" + } + }, + "allocationPolicy": { + "enum": [ + "Hashed", + "GeoLatency", + "Static" + ], + "type": "string", + "description": "Allocation policy to be used by this provisioning service.", + "x-ms-enum": { + "name": "AllocationPolicy", + "modelAsString": true + } + }, + "serviceOperationsHostName": { + "description": "Service endpoint for provisioning service.", + "type": "string", + "readOnly": true + }, + "deviceProvisioningHostName": { + "type": "string", + "description": "Device endpoint for this provisioning service.", + "readOnly": true + }, + "idScope": { + "type": "string", + "description": "Unique identifier of this provisioning service.", + "readOnly": true + }, + "authorizationPolicies": { + "description": "List of authorization keys for a provisioning service.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "enableDataResidency": { + "type": "boolean", + "description": "Optional.\nIndicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery." + }, + "portalOperationsHostName": { + "type": "string", + "description": "Portal endpoint to enable CORS for this provisioning service." + } + } + }, + "IotHubDefinitionDescription": { + "type": "object", + "description": "Description of the IoT hub.", + "properties": { + "applyAllocationPolicy": { + "description": "flag for applying allocationPolicy or not for a given iot hub.", + "type": "boolean" + }, + "allocationWeight": { + "description": "weight to apply for a given iot h.", + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Host name of the IoT hub." + }, + "connectionString": { + "type": "string", + "description": "Connection string of the IoT hub." + }, + "location": { + "type": "string", + "description": "ARM region of the IoT hub." + }, + "authenticationType": { + "description": "IotHub MI authentication type: KeyBased, UserAssigned, SystemAssigned.", + "enum": [ + "KeyBased", + "UserAssigned", + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubAuthenticationType", + "modelAsString": true + } + }, + "selectedUserAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "The selected user-assigned identity resource Id associated with IoT Hub. This is required when authenticationType is UserAssigned.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ] + } + } + }, + "required": [ + "location" + ] + }, + "IpFilterRule": { + "description": "The IP filter rules for a provisioning Service.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + }, + "target": { + "description": "Target for requests captured by this rule.", + "enum": [ + "all", + "serviceApi", + "deviceApi" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterTargetType", + "modelAsString": false + } + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for a provisioning service", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on a provisioning service", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties for a group information object", + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for a provisioning service", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of a provisioning service", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "description": "The properties of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "SharedAccessSignatureAuthorizationRule[AccessRightsDescription]": { + "type": "object", + "description": "Description of the shared access key.", + "properties": { + "keyName": { + "type": "string", + "description": "Name of the key." + }, + "primaryKey": { + "type": "string", + "description": "Primary SAS key value." + }, + "secondaryKey": { + "type": "string", + "description": "Secondary SAS key value." + }, + "rights": { + "description": "Rights that this key has.", + "enum": [ + "ServiceConfig", + "EnrollmentRead", + "EnrollmentWrite", + "DeviceConnect", + "RegistrationStatusRead", + "RegistrationStatusWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRightsDescription", + "modelAsString": true + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "resourcegroup": { + "type": "string", + "description": "The resource group of the resource." + }, + "subscriptionid": { + "type": "string", + "description": "The subscription id of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "OperationListResult": { + "description": "Result of the request to list provisioning service operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "Provisioning service operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Provisioning Service REST API operation.", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: ProvisioningServices." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation." + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "type": "object", + "description": "List of shared access keys.", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinitionListResult": { + "type": "object", + "description": "List of available SKUs.", + "properties": { + "value": { + "description": "The list of SKUs", + "type": "array", + "items": { + "$ref": "#/definitions/IotDpsSkuDefinition" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotDpsSkuDefinition": { + "type": "object", + "description": "Available SKUs of tier and units.", + "properties": { + "name": { + "description": "Sku name.", + "enum": [ + "S1" + ], + "type": "string", + "x-ms-enum": { + "name": "IotDpsSku", + "modelAsString": true + } + } + } + }, + "OperationInputs": { + "description": "Input values for operation results call.", + "type": "object", + "properties": { + "name": { + "description": "The name of the Provisioning Service to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "NameAvailabilityInfo": { + "type": "object", + "description": "Description of name availability.", + "properties": { + "nameAvailable": { + "description": "specifies if a name is available or not", + "type": "boolean" + }, + "reason": { + "description": "specifies the reason a name is unavailable", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true + } + }, + "message": { + "description": "message containing a detailed reason name is unavailable", + "type": "string" + } + } + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on a Provisioning Service instance." + }, + "ProvisioningServiceDescriptionListResult": { + "type": "object", + "description": "List of provisioning service descriptions.", + "properties": { + "value": { + "description": "List of provisioning service descriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/ProvisioningServiceDescription" + } + }, + "nextLink": { + "description": "the next link", + "type": "string", + "readOnly": true + } + } + }, + "VerificationCodeResponse": { + "type": "object", + "description": "Description of the response of the verification code.", + "properties": { + "name": { + "type": "string", + "description": "Name of certificate.", + "readOnly": true + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Request etag." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "type": "object", + "properties": { + "verificationCode": { + "type": "string", + "description": "Verification code." + }, + "subject": { + "type": "string", + "description": "Certificate subject." + }, + "expiry": { + "type": "string", + "description": "Code expiry." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "isVerified": { + "type": "boolean", + "description": "Indicate if the certificate is verified by owner of private key." + }, + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string", + "format": "byte" + }, + "created": { + "type": "string", + "description": "Certificate created time." + }, + "updated": { + "type": "string", + "description": "Certificate updated time." + } + } + } + }, + "x-ms-azure-resource": true + }, + "VerificationCodeRequest": { + "type": "object", + "description": "The JSON-serialized leaf certificate", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the provisioning service.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the provisioning service.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/deviceprovisioningservices/resource-manager/readme.md b/specification/deviceprovisioningservices/resource-manager/readme.md index 2bfdcf86e814..23b469e6f14a 100644 --- a/specification/deviceprovisioningservices/resource-manager/readme.md +++ b/specification/deviceprovisioningservices/resource-manager/readme.md @@ -27,10 +27,18 @@ These are the global settings for the API. ``` yaml openapi-type: arm azure-arm: true -tag: package-preview-2023-03 +tag: package-preview-2025-02 ``` +### Tag: package-preview-2025-02 + +These settings apply only when `--tag=package-preview-2025-02` is specified on the command line. + +```yaml $(tag) == 'package-preview-2025-02' +input-file: + - Microsoft.Devices/preview/2025-02-01-preview/iotdps.json +``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. From 39cc29c14aa67059b22e1fca64eafa53c9c3a593 Mon Sep 17 00:00:00 2001 From: Pan Shao <97225342+pshao25@users.noreply.github.com> Date: Sun, 29 Sep 2024 10:35:02 +0800 Subject: [PATCH 012/101] update document for DPG sdk-automation (#30457) * update document for DPG sdk-automation * update --------- Co-authored-by: Pan Shao --- .../.net/README.md | 28 +++++++------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/documentation/onboard-dpg-in-sdkautomation/.net/README.md b/documentation/onboard-dpg-in-sdkautomation/.net/README.md index c4d4ec97060b..3c071bd90db4 100644 --- a/documentation/onboard-dpg-in-sdkautomation/.net/README.md +++ b/documentation/onboard-dpg-in-sdkautomation/.net/README.md @@ -1,22 +1,14 @@ -# Add Autorest Configuration of .Net SDK +# Add TypeSpec Configuration of .Net SDK -## Parameter Description +Please copy the following configuration into `tspconfig.yaml` in your spec folder and replace `package-dir` and `namespace` to your own values. -- ``: The RP name, which is usually same as folder name in swagger. -- ``: Python package name. -- ``: SDK Client Name. It's optional if there is a title defined in spec readme.md file. - -## Autorest Configuration -Please copy the following configuration into spec PR comment. -~~~ -# azure-sdk-for-net-track2 ``` yaml -title: <Title> -output-folder: sdk/<ServiceName>/<NameSpace> -require: - - specification/<RPName>/data-plane/readme.md + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Vision.Face" + flavor: azure + namespace: "{package-dir}" ``` -~~~ -- `title`: If it's already defined in spec readme.md, you don't need to define it here again. (By default, there is no `title` defined in spec readme.md in multi client scenario.) -- `output-folder`: The relative path of destination to generate SDK. -- `require`: The item of the value is the relative path of spec readme.md file. + +- `package-dir`: Name of your package directory. It should be several parts concatenated with `.` and all the paerts should be pascal case. +- `flavor`: Always `azure` for Azure SDK. +- `namespace`: Should be the same as `package-dir`. From 778fdb20839c487eba95a6b161812ad9d9d6337d Mon Sep 17 00:00:00 2001 From: tsaiggo <yangcai@microsoft.com> Date: Sun, 29 Sep 2024 11:42:48 +0800 Subject: [PATCH 013/101] Fix PGSQL V2 missing auth type (#30552) * Fix PGSQL V2 missing auth type * Update sdk-suppressions.yaml --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../stable/2018-06-01/entityTypes/LinkedService.json | 8 +++++++- .../datafactory/resource-manager/sdk-suppressions.yaml | 1 + .../stable/2020-12-01/entityTypes/LinkedService.json | 7 ++++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 1d953301708b..3d5f1ee81e26 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -1939,6 +1939,11 @@ "x-ms-format": "dfe-string", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "x-ms-format": "dfe-int", @@ -2017,7 +2022,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { diff --git a/specification/datafactory/resource-manager/sdk-suppressions.yaml b/specification/datafactory/resource-manager/sdk-suppressions.yaml index b22077464b74..cbeef851b326 100644 --- a/specification/datafactory/resource-manager/sdk-suppressions.yaml +++ b/specification/datafactory/resource-manager/sdk-suppressions.yaml @@ -13,3 +13,4 @@ suppressions: - package: "@azure/arm-datafactory" breaking-changes: - Interface HDInsightOnDemandLinkedService has a new required parameter versionTypePropertiesVersion + - Interface PostgreSqlV2LinkedService has a new required parameter authenticationType diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 4eba34e78a99..b057e1e32b20 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -1680,6 +1680,10 @@ "type": "object", "description": "Database name for connection. Type: string." }, + "authenticationType": { + "type": "object", + "description": "The authentication type to use. Type: string." + }, "sslMode": { "type": "object", "description": "SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer." @@ -1745,7 +1749,8 @@ "server", "username", "database", - "sslMode" + "sslMode", + "authenticationType" ] }, "SybaseLinkedService": { From b61dcef24c4dbd9d1c26e321c9ea67465a5d8be7 Mon Sep 17 00:00:00 2001 From: t-ivrihikri <112947032+t-ivrihikri@users.noreply.github.com> Date: Sun, 29 Sep 2024 09:27:28 +0300 Subject: [PATCH 014/101] New API Version From 2024-04-01, Including Total Minutes Indexed (#30684) * First commit - deep copy * Added new field * Editting Readme * another update to readme * Last update for readme.md * Changed and compared to Mani's PR 5 months ago --- .../ViAccountCheckNameAvailabilityFree.json | 17 + .../ViAccountCheckNameAvailabilityTaken.json | 19 + .../examples/ViAccountDelete.json | 13 + .../examples/ViAccountGet.json | 46 + .../PatchAccountWithSystemAssignedMi.json | 49 + .../PatchAccountWithUserAssignedMi.json | 66 + ...ountToArmAccountUsingSystemAssignedMI.json | 72 ++ ...ccountToArmAccountUsingUserAssignedMi.json | 86 ++ ...teOrUpdateAccountWithSystemAssignedMi.json | 80 ++ ...eateOrUpdateAccountWithUserAssignedMi.json | 106 ++ .../examples/ViAccountsList.json | 49 + .../ViAccountsListByResourceGroup.json | 50 + ...GenerateAccountContributerAccessToken.json | 19 + .../ViGenerateAccountReaderAccessToken.json | 19 + ...GenerateProjectContributerAccessToken.json | 20 + .../ViGenerateProjectReaderAccessToken.json | 20 + ...ViGenerateVideoContributerAccessToken.json | 20 + .../ViGenerateVideoReaderAccessToken.json | 20 + ...ateAccountRestrictedViewerAccessToken.json | 18 + ...ateProjectRestrictedViewerAccessToken.json | 19 + ...erateVideoRestrictedViewerAccessToken.json | 19 + .../examples/ViOperationsList.json | 40 + .../preview/2024-09-23-preview/vi.json | 1076 +++++++++++++++++ specification/vi/resource-manager/readme.md | 11 + 24 files changed, 1954 insertions(+) create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json create mode 100644 specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json new file mode 100644 index 000000000000..e059a4547ac0 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityFree.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json new file mode 100644 index 000000000000..80885075d4d7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountCheckNameAvailabilityTaken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e", + "checkNameAvailabilityParameters": { + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Resource name already exists" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json new file mode 100644 index 000000000000..0225c76e84fe --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json new file mode 100644 index 000000000000..68526f20ed9d --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..4945fbc30995 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": {}, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..935bc4354167 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "properties": { + "storageServices": { + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json new file mode 100644 index 000000000000..1a7119f362c8 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json new file mode 100644 index 000000000000..c8883260a9a4 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json new file mode 100644 index 000000000000..264693ebf9cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "principalId": "43a83441-c17f-4e06-84a3-2eaf86668da7", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "type": "SystemAssigned" + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json new file mode 100644 index 000000000000..4a4964b182c6 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "location": "NorthEurope", + "properties": { + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": {}, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contosto-videoanalyzer", + "name": "contosto-videoanalyzer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoindexer", + "name": "contoso-videoindexer", + "location": "NorthEurope", + "type": "Microsoft.VideoIndexer/accounts", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contoso-videoindexer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoindexer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2" + }, + "totalSecondsIndexed": 0, + "totalMinutesIndexed": 0, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoindexer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoindexer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json new file mode 100644 index 000000000000..7db0770aac86 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Provisioning" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json new file mode 100644 index 000000000000..0ef3f06cbd1b --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViAccountsListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceGroupName": "contoso-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "586d4f48-8f08-4a4e-96b7-e1892d6dba9e" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/586d4f48-8f08-4a4e-96b7-e1892d6dba9e/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.VideoIndexer/accounts/contoso-videoanalyzer-rg", + "name": "vi1", + "type": "Microsoft.VideoIndexer/accounts", + "location": "NorthEurope", + "tags": {}, + "properties": { + "tenantId": "8c406f87-77ac-4ebb-a401-e8562450630e", + "accountId": "462af7c5-d1f6-4b91-86e3-8bc5e8a61574", + "accountName": "contosto-videoanalyzer", + "storageServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoanalyzer-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi" + }, + "openAiServices": { + "resourceId": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms", + "userAssignedIdentity": "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2" + }, + "provisioningState": "Succeeded" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi": { + "principalId": "a661c16c-ee39-46e7-93f6-7fb80d17ef13", + "clientId": "92e65ecf-0fae-432e-8272-fedb6edb96c7" + }, + "/subscriptions/xxx/resourceGroups/contoso-videoanalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoanalyzer-mi2": { + "principalId": "d2844978-40e3-4b7d-af13-cb6eeebd2726", + "clientId": "433ac7cb-6071-4052-ba31-65d9e26e21ed" + } + } + } + } + ], + "nextLink": "link" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json new file mode 100644 index 000000000000..fdba33d78933 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json new file mode 100644 index 000000000000..18fe4a67f055 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json new file mode 100644 index 000000000000..356c1057e431 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json new file mode 100644 index 000000000000..71587dfc5923 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json new file mode 100644 index 000000000000..142cac7282cc --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Contributor", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json new file mode 100644 index 000000000000..0f23754ea11f --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "contosto-videoanalyzer", + "resourceGroupName": "contosto-videoanalyzer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "permissionType": "Reader", + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cf6569bdac6c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Account" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..a90c27d34143 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Project", + "projectId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json new file mode 100644 index 000000000000..cc9a68e6e1a7 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "accountName": "contosto-azurevideoindexer", + "resourceGroupName": "contosto-azurevideoindexer-rg", + "api-version": "2024-09-23-preview", + "subscriptionId": "b04775c3-63fa-40f3-9430-139d2e5522d3", + "parameters": { + "scope": "Video", + "videoId": "07ec9e38d4" + } + }, + "responses": { + "200": { + "body": { + "accessToken": "<jwt token of 1260 characters length>" + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json new file mode 100644 index 000000000000..7c3fc03a4904 --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/examples/ViOperationsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-09-23-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.VideoIndexer/accounts/read", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Read accounts", + "description": "Read accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/write", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Update accounts", + "description": "Update accounts" + } + }, + { + "name": "Microsoft.VideoIndexer/accounts/delete", + "display": { + "provider": "Microsoft Azure Video Indexer", + "resource": "Account", + "operation": "Delete accounts", + "description": "Delete accounts" + } + } + ] + } + } + } +} diff --git a/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json new file mode 100644 index 000000000000..2f5048fe2f2c --- /dev/null +++ b/specification/vi/resource-manager/Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json @@ -0,0 +1,1076 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-23-preview", + "title": "vi", + "description": "Microsoft Azure Video Indexer" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.VideoIndexer/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Video Indexer provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/ViOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "operationId": "Accounts_CheckNameAvailability", + "description": "Checks that the Video Indexer account name is valid and is not already in use.", + "x-ms-examples": { + "Check free account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityFree.json" + }, + "Check taken account name availability": { + "$ref": "./examples/ViAccountCheckNameAvailabilityTaken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" + }, + "description": "The name of the Video Indexer account. Name must be unique globally" + } + ], + "responses": { + "200": { + "description": "OK - Operation to check the Video Indexer account name availability was successful. Ok does not indicate the name is available, the body of the response does.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_List", + "description": "List all Azure Video Indexer accounts available under the subscription", + "x-ms-examples": { + "List accounts": { + "$ref": "./examples/ViAccountsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_ListByResourceGroup", + "description": "List all Azure Video Indexer accounts available under the resource group", + "x-ms-examples": { + "List accounts by resource group": { + "$ref": "./examples/ViAccountsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Get", + "description": "Gets the properties of an Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get account": { + "$ref": "./examples/ViAccountGet.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Update", + "x-ms-long-running-operation": false, + "description": "Updates the properties of an existing Azure Video Indexer account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the current Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/AccountPatch" + } + } + ], + "responses": { + "200": { + "description": "The resource was updated successfully.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch account with system assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithSystemAssignedMi.json" + }, + "Patch account with user assigned Mi": { + "$ref": "./examples/ViAccountPatch/PatchAccountWithUserAssignedMi.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "description": "Creates or updates an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "description": "The parameters to provide for the Azure Video Indexer account.", + "schema": { + "$ref": "#/definitions/Account" + } + } + ], + "responses": { + "200": { + "description": "The resource was successfully updated.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "201": { + "description": "The resource was successfully created.", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update account with system assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithSystemAssignedMi.json" + }, + "Create or update account with user assigned Mi": { + "$ref": "./examples/ViAccountPut/CreateOrUpdateAccountWithUserAssignedMi.json" + }, + "Connect classic account to arm account using system assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingSystemAssignedMI.json" + }, + "Connect classic account to arm account using user assigned Mi": { + "$ref": "./examples/ViAccountPut/ConnectClassicAccountToArmAccountUsingUserAssignedMi.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "operationId": "Accounts_Delete", + "description": "Delete an Azure Video Indexer account.", + "x-ms-long-running-operation": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account was successfully deleted." + }, + "202": { + "description": "The Azure Video Indexer account will be deleted asynchronously." + }, + "204": { + "description": "The Azure Video Indexer account does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete account": { + "$ref": "./examples/ViAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_AccessToken", + "description": "Generate an Azure Video Indexer access token.", + "x-ms-examples": { + "Generate accessToken for video contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoContributerAccessToken.json" + }, + "Generate accessToken for video reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateVideoReaderAccessToken.json" + }, + "Generate accessToken for project contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectContributerAccessToken.json" + }, + "Generate accessToken for project reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateProjectReaderAccessToken.json" + }, + "Generate accessToken for account contributor": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountContributerAccessToken.json" + }, + "Generate accessToken for account reader": { + "$ref": "./examples/ViGenerateAccessToken/ViGenerateAccountReaderAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating access token", + "schema": { + "$ref": "#/definitions/GenerateAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VideoIndexer/accounts/{accountName}/generateRestrictedViewerAccessToken": { + "post": { + "tags": [ + "AccessToken" + ], + "operationId": "Generate_RestrictedViewerAccessToken", + "description": "Generate an Azure Video Indexer restricted viewer access token.", + "x-ms-examples": { + "Generate restricted viewer accessToken for video": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateVideoRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for project": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateProjectRestrictedViewerAccessToken.json" + }, + "Generate restricted viewer accessToken for account": { + "$ref": "./examples/ViGenerateRestrictedViewerAccessToken/ViGenerateAccountRestrictedViewerAccessToken.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "parameters", + "x-ms-client-flatten": true, + "description": "The parameters for generating restricted viewer access token", + "schema": { + "$ref": "#/definitions/GenerateRestrictedViewerAccessTokenParameters" + } + } + ], + "responses": { + "200": { + "description": "The Azure Video Indexer account's access token properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/AccessToken" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Tags": { + "type": "object", + "description": "Resource tags", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + } + }, + "Account": { + "description": "An Azure Video Indexer account.", + "type": "object", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPutRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ] + }, + "AccountPatch": { + "type": "object", + "description": "Azure Video Indexer account", + "properties": { + "properties": { + "description": "List of account properties", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccountPropertiesForPatchRequest" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Tags" + } + ] + }, + "AccountPropertiesForPutRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID. This can be set only when connecting an existing classic account", + "type": "string", + "default": "00000000-0000-0000-0000-000000000000", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "accountName": { + "description": "The account's name", + "type": "string", + "readOnly": true, + "example": "contoso-videoAnalyzer" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPutRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPutRequest" + }, + "totalSecondsIndexed": { + "description": "An integer representing the total seconds that have been indexed on the account", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "totalMinutesIndexed": { + "description": "An integer representing the total minutes that have been indexed on the account", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountPropertiesForPatchRequest": { + "description": "Azure Video Indexer account properties", + "type": "object", + "properties": { + "tenantId": { + "description": "The account's tenant id", + "type": "string", + "readOnly": true, + "example": "2b9bcf6d-39d5-460a-a6bb-7b40b7ccf139" + }, + "accountId": { + "description": "The account's data-plane ID", + "readOnly": true, + "type": "string", + "example": "3575690b-a569-449c-ab7b-11020f948f76" + }, + "storageServices": { + "description": "The storage services details", + "type": "object", + "$ref": "#/definitions/StorageServicesForPatchRequest" + }, + "openAiServices": { + "description": "The openAi services details", + "type": "object", + "$ref": "#/definitions/OpenAiServicesForPatchRequest" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the account at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "Deleting" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + } + } + }, + "AccountList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + }, + "description": "List of accounts and their properties." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{accountsOperation}?api-version={version}&%24skiptoken={token}" + } + }, + "description": "The list operation response, that contains the data pools and their properties.", + "type": "object" + }, + "GenerateAccessTokenParameters": { + "description": "Access token generation request's parameters", + "type": "object", + "required": [ + "permissionType", + "scope" + ], + "properties": { + "permissionType": { + "type": "string", + "description": "The requested permission", + "enum": [ + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "permissionType", + "modelAsString": true + } + }, + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "GenerateRestrictedViewerAccessTokenParameters": { + "description": "Restricted viewer access token generation request's parameters", + "type": "object", + "required": [ + "scope" + ], + "properties": { + "scope": { + "type": "string", + "description": "The requested media type", + "enum": [ + "Video", + "Account", + "Project" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } + }, + "videoId": { + "description": "The video ID", + "type": "string", + "example": "07ec9e38d4" + }, + "projectId": { + "description": "The project ID", + "type": "string" + } + } + }, + "StorageServicesForPutRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Storage/storageAccounts" + } + ] + }, + "description": "The storage services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.Storage/storageAccounts/contoso-videoAnalyzer-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "OpenAiServicesForPutRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "StorageServicesForPatchRequest": { + "description": "The storage services details", + "type": "object", + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "OpenAiServicesForPatchRequest": { + "description": "The openAi services details", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.CognitiveServices/accounts" + } + ] + }, + "description": "The openAi services resource id", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.CognitiveServices/accounts/contoso-viopenai-ms" + }, + "userAssignedIdentity": { + "type": "string", + "description": "The user assigned identity to be used to grant permissions", + "example": "/subscriptions/xxx/resourceGroups/contoso-videoAnalyzer-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-videoAnalyzer-mi" + } + } + }, + "AccessToken": { + "description": "Azure Video Indexer access token.", + "type": "object", + "properties": { + "accessToken": { + "type": "string", + "readOnly": true, + "description": "The access token.", + "x-ms-secret": true, + "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJPbmxpbmUgSldUIEJ1aWxkZXIiLCJpYXQiOjE2MjI0NDc3MzMsImV4cCI6MTY1Mzk4MzczMywiYXVkIjoid3d3LmV4YW1wbGUuY29tIiwic3ViIjoianJvY2tldEBleGFtcGxlLmNvbSIsIkdpdmVuTmFtZSI6IkpvaG5ueSIsIlN1cm5hbWUiOiJSb2NrZXQiLCJFbWFpbCI6Impyb2NrZXRAZXhhbXBsZS5jb20iLCJSb2xlIjpbIk1hbmFnZXIiLCJQcm9qZWN0IEFkbWluaXN0cmF0b3IiXX0" + } + } + }, + "Operation": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft.VideoIndexer/accounts/read" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "readOnly": true, + "type": "boolean", + "example": false + }, + "actionType": { + "description": "Indicates the action type.", + "readOnly": true, + "type": "string", + "example": "Internal" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "readOnly": true, + "type": "string", + "example": "user" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "readOnly": true, + "type": "string", + "example": "Microsoft Azure Video Indexer" + }, + "resource": { + "description": "Resource of the operation", + "readOnly": true, + "type": "string", + "example": "accounts" + }, + "operation": { + "description": "Localized friendly name for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts" + }, + "description": { + "description": "Localized friendly description for the operation", + "readOnly": true, + "type": "string", + "example": "Read accounts details" + } + } + }, + "OperationListResult": { + "description": "Available operations of the service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any.", + "example": "https://management.azure.com/{operation}?api-version={version}&%24skiptoken={token}" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "type": "object", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + }, + "AccountCheckNameAvailabilityParameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The VideoIndexer account name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.VideoIndexer/accounts" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + }, + "description": "The type of resource, Microsoft.VideoIndexer/accounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "The parameters used to check the availability of the Video Indexer account name." + }, + "CheckNameAvailabilityResult": { + "type": "object", + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken." + }, + "reason": { + "readOnly": true, + "type": "string", + "description": "Gets the reason that a Video Indexer account name could not be used. The Reason element is only returned if NameAvailable is false.", + "enum": [ + "AlreadyExists" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + } + }, + "parameters": { + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Video Indexer account.", + "pattern": "^[A-Za-z0-9-]+$", + "maxLength": 50, + "minLength": 3, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/vi/resource-manager/readme.md b/specification/vi/resource-manager/readme.md index ecf5ef8d23a9..949f1d71709c 100644 --- a/specification/vi/resource-manager/readme.md +++ b/specification/vi/resource-manager/readme.md @@ -31,6 +31,7 @@ directive: - Microsoft.VideoIndexer/preview/2022-07-20-preview/vi.json - Microsoft.VideoIndexer/preview/2024-04-01-preview/vi.json - Microsoft.VideoIndexer/preview/2024-06-01-preview/vi.json + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json - Microsoft.VideoIndexer/stable/2022-08-01/vi.json where: @@ -53,6 +54,16 @@ openapi-subtype: rpaas tag: package-2024-01 ``` +### Tag: package-2024-09-23-preview + +These settings apply only when `--tag=2024-09-23-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-09-23-preview' +version-with-underscores: 2024_09_23_preview +input-file: + - Microsoft.VideoIndexer/preview/2024-09-23-preview/vi.json +``` + ### Tag: package-2024-06-01-preview These settings apply only when `--tag=2024-06-01-preview` is specified on the command line. From 1e028c56972480c9c80187dbdbd6e73c931ff8ac Mon Sep 17 00:00:00 2001 From: manishpatil8149 <38776869+manishpatil8149@users.noreply.github.com> Date: Mon, 30 Sep 2024 17:38:35 +0530 Subject: [PATCH 015/101] Pre GA readiness changes (#30685) * base commit * added 2024-09-30 api version * fixed tsv validation * fixed prettier failures --------- Co-authored-by: Manish Patil (from Dev Box) <mapatil@microsoft.com> --- .../CertificateProfiles_Create.json | 68 + .../CertificateProfiles_Delete.json | 23 + .../CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../CodeSigningAccounts_Create.json | 48 + .../CodeSigningAccounts_Delete.json | 24 + .../CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../CodeSigningAccounts_Update.json | 40 + .../2024-09-30-preview/Operations_List.json | 44 + .../CodeSigning.Management/main.tsp | 2 + .../CodeSigning.Management/models.tsp | 28 +- .../codeSigningAccount.json | 1358 +++++++++++++++++ .../examples/CertificateProfiles_Create.json | 68 + .../examples/CertificateProfiles_Delete.json | 23 + .../examples/CertificateProfiles_Get.json | 42 + ...cateProfiles_ListByCodeSigningAccount.json | 45 + ...CertificateProfiles_RevokeCertificate.json | 21 + ...SigningAccounts_CheckNameAvailability.json | 18 + .../examples/CodeSigningAccounts_Create.json | 48 + .../examples/CodeSigningAccounts_Delete.json | 24 + .../examples/CodeSigningAccounts_Get.json | 29 + ...deSigningAccounts_ListByResourceGroup.json | 32 + ...odeSigningAccounts_ListBySubscription.json | 31 + .../examples/CodeSigningAccounts_Update.json | 40 + .../examples/Operations_List.json | 44 + .../codesigning/resource-manager/readme.md | 11 +- .../resource-manager/readme.python.md | 2 +- 31 files changed, 2327 insertions(+), 4 deletions(-) create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json create mode 100644 specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/CodeSigning.Management/examples/2024-09-30-preview/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/CodeSigning.Management/main.tsp b/specification/codesigning/CodeSigning.Management/main.tsp index 54a7a1eed540..12a7314db219 100644 --- a/specification/codesigning/CodeSigning.Management/main.tsp +++ b/specification/codesigning/CodeSigning.Management/main.tsp @@ -28,4 +28,6 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_02_05_preview: "2024-02-05-preview", + + v2024_09_30_preview: "2024-09-30-preview", } diff --git a/specification/codesigning/CodeSigning.Management/models.tsp b/specification/codesigning/CodeSigning.Management/models.tsp index bb8b69ae8130..9e0a56c48d02 100644 --- a/specification/codesigning/CodeSigning.Management/models.tsp +++ b/specification/codesigning/CodeSigning.Management/models.tsp @@ -4,6 +4,7 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/openapi"; import "@azure-tools/typespec-azure-resource-manager"; import "@azure-tools/typespec-client-generator-core"; +import "@typespec/versioning"; using TypeSpec.Rest; using TypeSpec.Http; @@ -11,6 +12,7 @@ using Azure.Core; using TypeSpec.OpenAPI; using Azure.ResourceManager; using Azure.ResourceManager.Foundations; +using TypeSpec.Versioning; namespace Microsoft.CodeSigning; @@ -158,7 +160,15 @@ model CodeSigningAccountPatch { @doc("Properties of the trusted signing account.") model CodeSigningAccountPatchProperties { @doc("SKU of the trusted signing account.") - sku?: AccountSku; + @typeChangedFrom(Versions.v2024_09_30_preview, AccountSku) + sku?: AccountSkuPatch; +} + +@doc("SKU of the trusted signing account.") +@added(Versions.v2024_09_30_preview) +model AccountSkuPatch { + @doc("Name of the SKU.") + name?: SkuName; } @doc("Properties of the certificate profile.") @@ -166,18 +176,22 @@ model CertificateProfileProperties { @doc("Profile type of the certificate.") profileType: ProfileType; + @removed(Versions.v2024_09_30_preview) @doc("Used as CN in the certificate subject name.") @visibility("read") commonName?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as O in the certificate subject name.") @visibility("read") organization?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as OU in the private trust certificate subject name.") @visibility("read") organizationUnit?: string; + @removed(Versions.v2024_09_30_preview) @doc("Used as STREET in the certificate subject name.") @visibility("read") streetAddress?: string; @@ -185,6 +199,7 @@ model CertificateProfileProperties { @doc("Whether to include STREET in the certificate subject name.") includeStreetAddress?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as L in the certificate subject name.") @visibility("read") city?: string; @@ -192,6 +207,7 @@ model CertificateProfileProperties { @doc("Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCity?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as S in the certificate subject name.") @visibility("read") state?: string; @@ -199,6 +215,7 @@ model CertificateProfileProperties { @doc("Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeState?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as C in the certificate subject name.") @visibility("read") country?: string; @@ -206,6 +223,7 @@ model CertificateProfileProperties { @doc("Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types") includeCountry?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Used as PC in the certificate subject name.") @visibility("read") postalCode?: string; @@ -213,12 +231,14 @@ model CertificateProfileProperties { @doc("Whether to include PC in the certificate subject name.") includePostalCode?: boolean = false; + @removed(Versions.v2024_09_30_preview) @doc("Enhanced key usage of the certificate.") @visibility("read") enhancedKeyUsage?: string; @doc("Identity validation id used for the certificate subject name.") - identityValidationId?: string; + @madeRequired(Versions.v2024_09_30_preview) + identityValidationId: string; @doc("Status of the current operation on certificate profile.") @visibility("read") @@ -241,6 +261,10 @@ model Certificate { @doc("Serial number of the certificate.") serialNumber?: string; + @doc("Enhanced key usage of the certificate.") + @added(Versions.v2024_09_30_preview) + enhancedKeyUsage?: string; + @doc("Subject name of the certificate.") subjectName?: string; diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json new file mode 100644 index 000000000000..1aa1997bdac2 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json @@ -0,0 +1,1358 @@ +{ + "swagger": "2.0", + "info": { + "title": "CodeSigningManagementClient", + "version": "2024-09-30-preview", + "description": "Code Signing resource provider api.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "CodeSigningAccounts" + }, + { + "name": "CertificateProfiles" + } + ], + "paths": { + "/providers/Microsoft.CodeSigning/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List trusted signing account operations.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/checkNameAvailability": { + "post": { + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Checks that the trusted signing account name is valid and is not already in use.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "body", + "in": "body", + "description": "The CheckAvailability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailability" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Checks that the trusted signing account name is available.": { + "$ref": "./examples/CodeSigningAccounts_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListBySubscription", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a subscription.", + "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/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a subscription.": { + "$ref": "./examples/CodeSigningAccounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts": { + "get": { + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Lists trusted signing accounts within a 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/CodeSigningAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Lists trusted signing accounts within a resource group.": { + "$ref": "./examples/CodeSigningAccounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}": { + "get": { + "operationId": "CodeSigningAccounts_Get", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Get a trusted Signing Account.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Trusted Signing Account": { + "$ref": "./examples/CodeSigningAccounts_Get.json" + } + } + }, + "put": { + "operationId": "CodeSigningAccounts_Create", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Create a trusted Signing Account.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CodeSigningAccount' update operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "201": { + "description": "Resource 'CodeSigningAccount' create operation succeeded", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + }, + "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": { + "Create a trusted Signing Account.": { + "$ref": "./examples/CodeSigningAccounts_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CodeSigningAccounts_Update", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Update a trusted signing account.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "properties", + "in": "body", + "description": "Parameters supplied to update the trusted signing account", + "required": true, + "schema": { + "$ref": "#/definitions/CodeSigningAccountPatch" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CodeSigningAccounts_Delete", + "tags": [ + "CodeSigningAccounts" + ], + "description": "Delete a trusted signing account.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-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": { + "Delete a trusted signing account.": { + "$ref": "./examples/CodeSigningAccounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles": { + "get": { + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "tags": [ + "CertificateProfiles" + ], + "description": "List certificate profiles under a trusted signing account.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfileListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List certificate profiles under a trusted signing account.": { + "$ref": "./examples/CertificateProfiles_ListByCodeSigningAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}": { + "get": { + "operationId": "CertificateProfiles_Get", + "tags": [ + "CertificateProfiles" + ], + "description": "Get details of a certificate profile.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get details of a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Get.json" + } + } + }, + "put": { + "operationId": "CertificateProfiles_Create", + "tags": [ + "CertificateProfiles" + ], + "description": "Create a certificate profile.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "resource", + "in": "body", + "description": "Parameters to create the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CertificateProfile' update operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "201": { + "description": "Resource 'CertificateProfile' create operation succeeded", + "schema": { + "$ref": "#/definitions/CertificateProfile" + }, + "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": { + "Create a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CertificateProfiles_Delete", + "tags": [ + "CertificateProfiles" + ], + "description": "Delete a certificate profile.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-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": { + "Delete a certificate profile.": { + "$ref": "./examples/CertificateProfiles_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CodeSigning/codeSigningAccounts/{accountName}/certificateProfiles/{profileName}/revokeCertificate": { + "post": { + "operationId": "CertificateProfiles_RevokeCertificate", + "tags": [ + "CertificateProfiles" + ], + "description": "Revoke a certificate under a certificate profile.", + "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": "accountName", + "in": "path", + "description": "Trusted Signing account name.", + "required": true, + "type": "string", + "pattern": "^(?=.{3,24}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "profileName", + "in": "path", + "description": "Certificate profile name.", + "required": true, + "type": "string", + "pattern": "^(?=.{5,100}$)[^0-9][A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$" + }, + { + "name": "body", + "in": "body", + "description": "Parameters to revoke the certificate profile", + "required": true, + "schema": { + "$ref": "#/definitions/RevokeCertificate" + } + } + ], + "responses": { + "204": { + "description": "Action completed successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Revoke a certificate under a certificate profile.": { + "$ref": "./examples/CertificateProfiles_RevokeCertificate.json" + } + } + } + } + }, + "definitions": { + "AccountSku": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + }, + "required": [ + "name" + ] + }, + "AccountSkuPatch": { + "type": "object", + "description": "SKU of the trusted signing account.", + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Name of the SKU." + } + } + }, + "Certificate": { + "type": "object", + "description": "Properties of the certificate.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "enhancedKeyUsage": { + "type": "string", + "description": "Enhanced key usage of the certificate." + }, + "subjectName": { + "type": "string", + "description": "Subject name of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "createdDate": { + "type": "string", + "description": "Certificate created date." + }, + "expiryDate": { + "type": "string", + "description": "Certificate expiry date." + }, + "status": { + "$ref": "#/definitions/CertificateStatus", + "description": "Status of the certificate." + }, + "revocation": { + "$ref": "#/definitions/Revocation", + "description": "Revocations history of a certificate.", + "x-ms-client-flatten": true + } + } + }, + "CertificateProfile": { + "type": "object", + "description": "Certificate profile resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProfileProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateProfileListResult": { + "type": "object", + "description": "The response of a CertificateProfile list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CertificateProfile items on this page", + "items": { + "$ref": "#/definitions/CertificateProfile" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CertificateProfileProperties": { + "type": "object", + "description": "Properties of the certificate profile.", + "properties": { + "profileType": { + "$ref": "#/definitions/ProfileType", + "description": "Profile type of the certificate." + }, + "includeStreetAddress": { + "type": "boolean", + "description": "Whether to include STREET in the certificate subject name.", + "default": false + }, + "includeCity": { + "type": "boolean", + "description": "Whether to include L in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeState": { + "type": "boolean", + "description": "Whether to include S in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includeCountry": { + "type": "boolean", + "description": "Whether to include C in the certificate subject name. Applicable only for private trust, private trust ci profile types", + "default": false + }, + "includePostalCode": { + "type": "boolean", + "description": "Whether to include PC in the certificate subject name.", + "default": false + }, + "identityValidationId": { + "type": "string", + "description": "Identity validation id used for the certificate subject name." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on certificate profile.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CertificateProfileStatus", + "description": "Status of the certificate profile.", + "readOnly": true + }, + "certificates": { + "type": "array", + "description": "List of renewed certificates.", + "items": { + "$ref": "#/definitions/Certificate" + }, + "readOnly": true, + "x-ms-client-flatten": true, + "x-ms-identifiers": [] + } + }, + "required": [ + "profileType", + "identityValidationId" + ] + }, + "CertificateProfileStatus": { + "type": "string", + "description": "Status of the certificate profiles.", + "enum": [ + "Active", + "Disabled", + "Suspended" + ], + "x-ms-enum": { + "name": "CertificateProfileStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate profile is active." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The certificate profile is disabled." + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "The certificate profile is suspended." + } + ] + } + }, + "CertificateStatus": { + "type": "string", + "description": "Status of the certificate", + "enum": [ + "Active", + "Expired", + "Revoked" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The certificate is active." + }, + { + "name": "Expired", + "value": "Expired", + "description": "The certificate is expired." + }, + { + "name": "Revoked", + "value": "Revoked", + "description": "The certificate is revoked." + } + ] + } + }, + "CheckNameAvailability": { + "type": "object", + "description": "The parameters used to check the availability of the trusted signing account name.", + "properties": { + "name": { + "type": "string", + "description": "Trusted signing account name." + } + }, + "required": [ + "name" + ] + }, + "CheckNameAvailabilityResult": { + "type": "object", + "description": "The CheckNameAvailability operation response.", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "A boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/NameUnavailabilityReason", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "An error message explaining the Reason value in more detail.", + "readOnly": true + } + } + }, + "CodeSigningAccount": { + "type": "object", + "description": "Trusted signing account resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CodeSigningAccountProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CodeSigningAccountListResult": { + "type": "object", + "description": "The response of a CodeSigningAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CodeSigningAccount items on this page", + "items": { + "$ref": "#/definitions/CodeSigningAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CodeSigningAccountPatch": { + "type": "object", + "description": "Parameters for creating or updating a trusted signing account.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/CodeSigningAccountPatchProperties", + "description": "Properties of the trusted signing account.", + "x-ms-client-flatten": true + } + } + }, + "CodeSigningAccountPatchProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "sku": { + "$ref": "#/definitions/AccountSkuPatch", + "description": "SKU of the trusted signing account." + } + } + }, + "CodeSigningAccountProperties": { + "type": "object", + "description": "Properties of the trusted signing account.", + "properties": { + "accountUri": { + "type": "string", + "description": "The URI of the trusted signing account which is used during signing files.", + "readOnly": true + }, + "sku": { + "$ref": "#/definitions/AccountSku", + "description": "SKU of the trusted signing account." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Status of the current operation on trusted signing account.", + "readOnly": true + } + } + }, + "NameUnavailabilityReason": { + "type": "string", + "description": "The reason that a trusted signing account name could not be used. The Reason element is only returned if nameAvailable is false.", + "enum": [ + "AccountNameInvalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameUnavailabilityReason", + "modelAsString": true, + "values": [ + { + "name": "AccountNameInvalid", + "value": "AccountNameInvalid", + "description": "Account name is invalid" + }, + { + "name": "AlreadyExists", + "value": "AlreadyExists", + "description": "Account name already exists" + } + ] + } + }, + "ProfileType": { + "type": "string", + "description": "Type of the certificate", + "enum": [ + "PublicTrust", + "PrivateTrust", + "PrivateTrustCIPolicy", + "VBSEnclave", + "PublicTrustTest" + ], + "x-ms-enum": { + "name": "ProfileType", + "modelAsString": true, + "values": [ + { + "name": "PublicTrust", + "value": "PublicTrust", + "description": "Used for signing files which are distributed publicly." + }, + { + "name": "PrivateTrust", + "value": "PrivateTrust", + "description": "Used for signing files which are distributed internally within organization or group boundary." + }, + { + "name": "PrivateTrustCIPolicy", + "value": "PrivateTrustCIPolicy", + "description": "Used for signing CI policy files." + }, + { + "name": "VBSEnclave", + "value": "VBSEnclave", + "description": "Used for signing files which are run in secure vbs enclave." + }, + { + "name": "PublicTrustTest", + "value": "PublicTrustTest", + "description": "Used for signing files for testing purpose." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "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": "Updating", + "value": "Updating", + "description": "Updating in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource creation started." + } + ] + }, + "readOnly": true + }, + "Revocation": { + "type": "object", + "description": "Revocation details of the certificate.", + "properties": { + "requestedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is requested." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + }, + "status": { + "$ref": "#/definitions/RevocationStatus", + "description": "Status of the revocation." + }, + "failureReason": { + "type": "string", + "description": "Reason for the revocation failure." + } + } + }, + "RevocationStatus": { + "type": "string", + "description": "Revocation status of the certificate.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "RevocationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Certificate revocation succeeded." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Certificate revocation is in progress." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Certificate revocation failed." + } + ] + }, + "readOnly": true + }, + "RevokeCertificate": { + "type": "object", + "description": "Defines the certificate revocation properties.", + "properties": { + "serialNumber": { + "type": "string", + "description": "Serial number of the certificate." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "effectiveAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the revocation is effective." + }, + "reason": { + "type": "string", + "description": "Reason for the revocation." + }, + "remarks": { + "type": "string", + "description": "Remarks for the revocation." + } + }, + "required": [ + "serialNumber", + "thumbprint", + "effectiveAt", + "reason" + ] + }, + "SkuName": { + "type": "string", + "description": "Name of the sku.", + "enum": [ + "Basic", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium sku." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json new file mode 100644 index 000000000000..8d6b159c024a --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "properties": { + "profileType": "PublicTrust", + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includePostalCode": true, + "includeStreetAddress": false + } + }, + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + }, + "201": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [], + "identityValidationId": "00000000-1234-5678-3333-444444444444", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "CertificateProfiles_Create", + "title": "Create a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json new file mode 100644 index 000000000000..e0a743a2cc25 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "CertificateProfiles_Delete", + "title": "Delete a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json new file mode 100644 index 000000000000..be65a4ceddde --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount/certificateProfiles/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + } + }, + "operationId": "CertificateProfiles_Get", + "title": "Get details of a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json new file mode 100644 index 000000000000..ba0db472226c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_ListByCodeSigningAccount.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "profileA", + "type": "Microsoft.CodeSigning/codeSigningAccounts/certificateProfiles", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/profileA", + "properties": { + "certificates": [ + { + "createdDate": "3/14/2023 5:27:49 PM", + "expiryDate": "3/17/2023 5:27:49 PM", + "enhancedKeyUsage": "1.3.6.1.4.1.311.yy.xxxxxxxx.xxxxxxxx.xxxxxxxxx.xxxxxxxx", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "status": "Active", + "subjectName": "CN=Contoso Inc, O=Contoso Inc, L=New York, S=New York, C=US", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + } + ], + "identityValidationId": "123456", + "includeCity": false, + "includeCountry": false, + "includePostalCode": true, + "includeState": false, + "includeStreetAddress": false, + "profileType": "PublicTrust", + "provisioningState": "Succeeded", + "status": "Active" + } + } + ] + } + } + }, + "operationId": "CertificateProfiles_ListByCodeSigningAccount", + "title": "List certificate profiles under a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json new file mode 100644 index 000000000000..17e9e7baa606 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CertificateProfiles_RevokeCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "profileName": "profileA", + "resourceGroupName": "MyResourceGroup", + "body": { + "effectiveAt": "2023-11-12T23:40:25+00:00", + "reason": "KeyCompromised", + "remarks": "test", + "serialNumber": "xxxxxxxxxxxxxxxxxx", + "thumbprint": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" + }, + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "204": {} + }, + "operationId": "CertificateProfiles_RevokeCertificate", + "title": "Revoke a certificate under a certificate profile." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json new file mode 100644 index 000000000000..ae1cfb811407 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_CheckNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "body": { + "name": "sample-account" + }, + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + }, + "operationId": "CodeSigningAccounts_CheckNameAvailability", + "title": "Checks that the trusted signing account name is available." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json new file mode 100644 index 000000000000..214d8e3aa374 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resource": { + "location": "westus", + "properties": { + "sku": { + "name": "Basic" + } + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + } + } + }, + "201": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Accepted", + "sku": { + "name": "Basic" + } + } + } + } + }, + "operationId": "CodeSigningAccounts_Create", + "title": "Create a trusted Signing Account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json new file mode 100644 index 000000000000..062f0fda1600 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Delete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Delete", + "title": "Delete a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json new file mode 100644 index 000000000000..f5d4e090907c --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + } + }, + "operationId": "CodeSigningAccounts_Get", + "title": "Get a Trusted Signing Account" +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..50fd72f56334 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListByResourceGroup", + "title": "Lists trusted signing accounts within a resource group." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json new file mode 100644 index 000000000000..5c14b6bc07bd --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_ListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-09-30-preview", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "alpha", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + ] + } + } + }, + "operationId": "CodeSigningAccounts_ListBySubscription", + "title": "Lists trusted signing accounts within a subscription." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json new file mode 100644 index 000000000000..1ed4f660a665 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/CodeSigningAccounts_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "MyAccount", + "api-version": "2024-09-30-preview", + "properties": { + "tags": { + "key1": "value1" + } + }, + "resourceGroupName": "MyResourceGroup", + "subscriptionId": "00000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "name": "MyAccount", + "type": "Microsoft.CodeSigning/codeSigningAccounts", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.CodeSigning/codeSigningAccounts/MyAccount", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Basic" + } + }, + "tags": { + "key1": "value1" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status", + "location": "http://azure.async.operation/status" + } + } + }, + "operationId": "CodeSigningAccounts_Update", + "title": "Update a trusted signing account." +} diff --git a/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json new file mode 100644 index 000000000000..e5f631eac339 --- /dev/null +++ b/specification/codesigning/resource-manager/Microsoft.CodeSigning/preview/2024-09-30-preview/examples/Operations_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "MyResourceGroup", + "api-version": "2024-09-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/write", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Create CodeSigningAccount", + "description": "Create any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/read", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Get CodeSigningAccount", + "description": "Get any CodeSigningAccount" + } + }, + { + "name": "Microsoft.CodeSigning/codeSigningAccounts/delete", + "display": { + "provider": "Microsoft.CodeSigning", + "resource": "codeSigningAccounts", + "operation": "Delete CodeSigningAccount", + "description": "Delete any CodeSigningAccount" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List trusted signing account operations." +} diff --git a/specification/codesigning/resource-manager/readme.md b/specification/codesigning/resource-manager/readme.md index e546f51a3f5d..cf10e999a1d8 100644 --- a/specification/codesigning/resource-manager/readme.md +++ b/specification/codesigning/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the CodeSigning API. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-02-05-preview +tag: package-2024-09-30-preview +``` + +### Tag: package-2024-09-30-preview + +These settings apply only when `--tag=package-2024-09-30-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-30-preview' +input-file: +- Microsoft.CodeSigning/preview/2024-09-30-preview/codeSigningAccount.json ``` ### Tag: package-2024-02-05-preview diff --git a/specification/codesigning/resource-manager/readme.python.md b/specification/codesigning/resource-manager/readme.python.md index f095e0bf7e39..7a142f8ff5c7 100644 --- a/specification/codesigning/resource-manager/readme.python.md +++ b/specification/codesigning/resource-manager/readme.python.md @@ -8,7 +8,7 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-trustedsigning namespace: azure.mgmt.trustedsigning -package-version: 1.0.0b1 +package-version: 1.0.0b2 clear-output-folder: true ``` From 1b9c5dafba0f4b5185279197f82b350a46fe43ba Mon Sep 17 00:00:00 2001 From: James Lim <125409279+MicroJamesLim@users.noreply.github.com> Date: Mon, 30 Sep 2024 12:54:21 -0400 Subject: [PATCH 016/101] Added Azure Container Instance API Version 2024-10-01-preview (#30569) * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * Copy files from stable/2023-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-10-01-preview Updated the API version from stable/2023-05-01 to preview/2024-10-01-preview. * Added tag for 2024-10-01-preview in readme file * added 2024-10-01-preview * remove additionalProperties * resolved PR comment * update from secrets to secretReferences * suppress additionalProperties * delete file * update to 'arm-id' format --------- Co-authored-by: jameszlim <limcheolhyun930421@gmail.com> --- .../2024-10-01-preview/containerInstance.json | 2610 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 182 ++ .../ContainerGroupEncryptionProperties.json | 192 ++ .../examples/ContainerGroupExtensions.json | 208 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 316 ++ ...erGroupsCreateOrUpdateSecretReference.json | 445 +++ .../ContainerGroupsCreatePriority.json | 120 + .../examples/ContainerGroupsDelete.json | 85 + .../examples/ContainerGroupsGetPriority.json | 87 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 79 + .../examples/ContainerGroupsList.json | 90 + .../ContainerGroupsListByResourceGroup.json | 82 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 17 +- 26 files changed, 4954 insertions(+), 1 deletion(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json new file mode 100644 index 000000000000..d6d69d152438 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json @@ -0,0 +1,2610 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupsCreateOrUpdateSecretReference": { + "$ref": "./examples/ContainerGroupsCreateOrUpdateSecretReference.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "SecretReference": { + "description": "A secret reference", + "type": "object", + "required": [ + "name", + "identity", + "secretReferenceUri" + ], + "properties": { + "name": { + "description": "The identifier of the secret reference", + "type": "string" + }, + "identity": { + "description": "The ARM resource id of the managed identity that has access to the secret in the key vault", + "type": "string", + "format": "arm-id" + }, + "secretReferenceUri": { + "description": "The URI to the secret in key vault", + "type": "string", + "format": "uri" + } + } + }, + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + }, + "storageAccountKeyReference": { + "description": "The reference to the storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "SecretReferenceVolume": { + "description": "The secret reference volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "secretReference": { + "description": "The secret reference volume.", + "$ref": "#/definitions/SecretReferenceVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "secretReferences": { + "type": "array", + "description": "The secret references that will be referenced within the container group.", + "items": { + "$ref": "#/definitions/SecretReference" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "passwordReference": { + "type": "string", + "description": "The reference for the private registry password." + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + }, + "secureValueReference": { + "type": "string", + "description": "The reference of the secure environment variable." + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "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", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..ed0d0d2363f5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..925e127e09db --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..77bd776e187d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..06ec0926cfaf --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..c96ab2b7b19e --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..5fb43920d62a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..4756b7442c1d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "<kubeconfig encoded string>" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..ecb826c3e487 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..9850e024b673 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json new file mode 100644 index 000000000000..c8d892255752 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreateOrUpdateSecretReference.json @@ -0,0 +1,445 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64" + }, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + }, + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "UserAssigned" + }, + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "secretReferences": [ + { + "name": "envSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/envSecret" + }, + { + "name": "accountKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/accountKey" + }, + { + "name": "volumeSecretRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/volumeSecret" + }, + { + "name": "privateRegistryKeyRef", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name", + "secretReferenceUri": "https://keyvaultname.vault.azure.net/secrets/privateRegistryKey" + } + ], + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [ + { + "name": "envSecret", + "secureValueReference": "envSecretRef" + } + ], + "image": "privateRegistryImage", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [ + { + "server": "demoregistry.azurecr.io", + "username": "registryUserName", + "passwordReference": "privateRegistryKeyRef" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKeyReference": "accountKeyRef" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {}, + "secretReference": { + "secretKey2": "volumeSecretRef" + } + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..c131ccea87ed --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..4c52d95afb11 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..beaad8bc9180 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..8c9f1d80ceb3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..4e824a241331 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..bc0ed9a5d99c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..df87822690b9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..c95afb0fdf8c --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..62b5ef24b019 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..dcc708e6bc8d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..85e3bb2cb061 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..7dbd9db81afe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..fb57e873a21b --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-10-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-10-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 6c4d309167c1..37a58d82b8e1 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-preview-2024-05 +tag: package-preview-2024-10 +``` + +### Tag: package-preview-2024-10 + +These settings apply only when `--tag=package-preview-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-10' +input-file: + - Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json ``` ### Tag: package-preview-2024-05 @@ -214,6 +223,12 @@ suppressions: - containerInstance.json where: - $.definitions.ConfigMap.properties.keyValuePairs + - code: AvoidAdditionalProperties + reason: additional feature addition to existing secretVolumes which is defined as a dictionary + from: + - containerInstance.json + where: + - $.definitions.SecretReferenceVolume ``` --- From 1736812b284437b88286035449806283f5d87e73 Mon Sep 17 00:00:00 2001 From: Ray Chen <raychen@microsoft.com> Date: Mon, 30 Sep 2024 13:57:10 -0700 Subject: [PATCH 017/101] Updated Go sdk support owner (#30801) --- documentation/ci-fix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 9ccbb91f092b..fc05ead8d05c 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -88,7 +88,7 @@ If you have an issue or with any of checks listed in the first column of the tab | Check name | Owner | |-----------------------------------|----------------| -| `SDK azure-sdk-for-go` | Ray Chen | +| `SDK azure-sdk-for-go` | Chenjie Shi | | `SDK azure-sdk-for-java` | Weidong Xu | | `SDK azure-sdk-for-js` | Qiaoqiao Zhang | | `SDK azure-sdk-for-net` | Wei Hu | From be9347d403c9ba3179321fe9500b956245e8f3e7 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Mon, 30 Sep 2024 15:33:18 -0700 Subject: [PATCH 018/101] [TypeSpecValidation] Apply "all" suppressions when core files changed (#30805) - Fixes #30521 --- eng/scripts/Get-TypeSpec-Folders.ps1 | 6 +++++- eng/scripts/TypeSpec-Validation.ps1 | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/eng/scripts/Get-TypeSpec-Folders.ps1 b/eng/scripts/Get-TypeSpec-Folders.ps1 index 1ddb8ef0fc55..e667216b0bdb 100644 --- a/eng/scripts/Get-TypeSpec-Folders.ps1 +++ b/eng/scripts/Get-TypeSpec-Folders.ps1 @@ -9,10 +9,13 @@ Set-StrictMode -Version 3 . $PSScriptRoot/ChangedFiles-Functions.ps1 $repoPath = Resolve-Path "$PSScriptRoot/../.." + $checkAllPath = ((Get-ChildItem "specification" -Directory).Name -replace '^', 'specification/') -replace '$', '/' +$checkedAll = $false if ($CheckAll) { $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = @(Get-ChangedFiles -baseCommitish $BaseCommitish -targetCommitish $TargetCommitish -diffFilter "") @@ -21,6 +24,7 @@ else { if ($coreChangedFiles) { Write-Verbose "Found changes to core eng or root files so checking all specs." $changedFiles = $checkAllPath + $checkedAll = $true } else { $changedFiles = Get-ChangedFilesUnderSpecification $changedFiles @@ -49,4 +53,4 @@ foreach ($skippedTypespecFolder in $skippedTypespecFolders | Select-Object -Uniq $typespecFolders = $typespecFolders | ForEach-Object { [IO.Path]::GetRelativePath($repoPath, $_) -replace '\\', '/' } | Sort-Object -Unique -return $typespecFolders +return @($typespecFolders, $checkedAll) diff --git a/eng/scripts/TypeSpec-Validation.ps1 b/eng/scripts/TypeSpec-Validation.ps1 index 30985a681fb7..031ae7d69000 100644 --- a/eng/scripts/TypeSpec-Validation.ps1 +++ b/eng/scripts/TypeSpec-Validation.ps1 @@ -10,7 +10,7 @@ param ( . $PSScriptRoot/Logging-Functions.ps1 . $PSScriptRoot/Suppressions-Functions.ps1 -$typespecFolders = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll +$typespecFolders, $checkedAll = &"$PSScriptRoot/Get-TypeSpec-Folders.ps1" -BaseCommitish:$BaseCommitish -TargetCommitish:$TargetCommitish -CheckAll:$CheckAll $typespecFoldersWithFailures = @() if ($typespecFolders) { @@ -18,7 +18,7 @@ if ($typespecFolders) { foreach ($typespecFolder in $typespecFolders) { LogGroupStart "Validating $typespecFolder" - if ($CheckAll) { + if ($checkedAll) { $suppression = Get-Suppression "TypeSpecValidationAll" $typespecFolder if ($suppression) { $reason = $suppression["reason"] ?? "<no reason specified>" From b4e2402f686dda5237ed140897d49624e6d2a462 Mon Sep 17 00:00:00 2001 From: Sean Wells <swells@users.noreply.github.com> Date: Mon, 30 Sep 2024 15:49:24 -0700 Subject: [PATCH 019/101] feat(azurearcdata): Welcome 2024-05-01-preview (#30613) * feat(azurearcdata): Welcome 2024-05-01-preview * fix(azurearcdata): update cSpell.json 2024-05-01-preview * fix(azurearcdata): 2024-05-01 Update readme.md * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * Update sqlServerAvailabilityGroups.json * chore(azurearcdata): prettier * chore(azurearcdata): prettier * chore(azurearcdata): sync from private * Update sqlServerDatabases.json --- cSpell.json | 15 + .../activeDirectoryConnectors.json | 240 ++ .../2024-05-01-preview/azurearcdata.json | 2193 +++++++++++++++++ .../preview/2024-05-01-preview/common.json | 159 ++ .../2024-05-01-preview/dataControllers.json | 253 ++ .../AddDatabasesToAvailabilityGroup.json | 120 + ...reateOrUpdateActiveDirectoryConnector.json | 134 + ...OrUpdateArcSqlServerAvailabilityGroup.json | 223 ++ .../CreateOrUpdateArcSqlServerDatabase.json | 156 ++ .../CreateOrUpdateDataController.json | 166 ++ .../examples/CreateOrUpdateFailoverGroup.json | 74 + .../CreateOrUpdatePostgresInstance.json | 172 ++ .../CreateOrUpdateSqlManagedInstance.json | 267 ++ .../CreateOrUpdateSqlServerEsuLicense.json | 83 + .../CreateOrUpdateSqlServerInstance.json | 179 ++ .../CreateOrUpdateSqlServerLicense.json | 81 + .../CreateSqlServerAvailabilityGroup.json | 187 ++ ...SqlServerDistributedAvailabilityGroup.json | 155 ++ .../DeleteActiveDirectoryConnector.json | 26 + .../DeleteArcSqlServerAvailabilityGroup.json | 21 + .../examples/DeleteArcSqlServerDatabase.json | 21 + .../examples/DeleteDataController.json | 25 + .../examples/DeleteFailoverGroup.json | 18 + .../examples/DeletePostgresInstance.json | 25 + .../examples/DeleteSqlManagedInstance.json | 25 + .../examples/DeleteSqlServerEsuLicense.json | 16 + .../examples/DeleteSqlServerInstance.json | 25 + .../examples/DeleteSqlServerLicense.json | 16 + ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ ...FailoverArcSqlServerAvailabilityGroup.json | 183 ++ .../examples/GetActiveDirectoryConnector.json | 57 + .../GetArcSqlServerAvailabilityGroup.json | 113 + .../examples/GetArcSqlServerDatabase.json | 92 + .../examples/GetDataController.json | 65 + .../examples/GetFailoverGroup.json | 38 + .../examples/GetPostgresInstance.json | 43 + .../examples/GetSqlManagedInstance.json | 99 + .../examples/GetSqlServerEsuLicense.json | 40 + .../examples/GetSqlServerInstance.json | 191 ++ .../GetSqlServerInstanceJobsStatus.json | 51 + .../GetSqlServerInstanceTelemetry.json | 154 ++ .../examples/GetSqlServerLicense.json | 39 + ...ataControllerActiveDirectoryConnector.json | 104 + .../ListByResourceGroupDataController.json | 115 + .../ListByResourceGroupPostgresInstance.json | 77 + ...ListByResourceGroupSqlManagedInstance.json | 162 ++ ...istByResourceGroupSqlServerEsuLicense.json | 71 + .../ListByResourceGroupSqlServerInstance.json | 248 ++ .../ListByResourceGroupSqlServerLicense.json | 69 + ...ListBySqlManagedInstanceFailoverGroup.json | 66 + ...tBySqlServerInstanceAvailabilityGroup.json | 215 ++ .../ListBySqlServerInstanceDatabase.json | 167 ++ .../examples/ListOperation.json | 353 +++ .../ListSubscriptionDataController.json | 119 + .../ListSubscriptionPostgresInstance.json | 76 + .../ListSubscriptionSqlManagedInstance.json | 163 ++ .../ListSubscriptionSqlServerEsuLicense.json | 70 + .../ListSubscriptionSqlServerInstance.json | 249 ++ .../ListSubscriptionSqlServerLicense.json | 68 + .../PostUpgradeSqlServerInstance.json | 77 + .../examples/PreUpgradeSqlServerInstance.json | 77 + .../RemoveDatabasesFromAvailabilityGroup.json | 118 + ...nMigrationAssessmentSqlServerInstance.json | 43 + .../UpdateArcSqlServerAvailabilityGroup.json | 123 + .../examples/UpdateDataController.json | 75 + .../examples/UpdatePostgresInstance.json | 48 + .../examples/UpdateSqlManagedInstance.json | 101 + .../examples/UpdateSqlServerDatabase.json | 102 + .../examples/UpdateSqlServerEsuLicense.json | 49 + .../examples/UpdateSqlServerInstance.json | 88 + .../examples/UpdateSqlServerLicense.json | 44 + .../ViewArcSqlServerAvailabilityGroup.json | 183 ++ .../2024-05-01-preview/failoverGroups.json | 157 ++ .../2024-05-01-preview/operations.json | 125 + .../2024-05-01-preview/postgresInstances.json | 174 ++ .../sqlManagedInstances.json | 403 +++ .../sqlServerAvailabilityGroups.json | 1573 ++++++++++++ .../sqlServerDatabases.json | 680 +++++ .../sqlServerEsuLicenses.json | 545 ++++ .../sqlServerInstances.json | 1367 ++++++++++ .../2024-05-01-preview/sqlServerLicenses.json | 259 ++ .../azurearcdata/resource-manager/readme.md | 23 +- 82 files changed, 15248 insertions(+), 1 deletion(-) create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json create mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json diff --git a/cSpell.json b/cSpell.json index 29ff06a9c8f4..e7aeb6374c29 100644 --- a/cSpell.json +++ b/cSpell.json @@ -47,6 +47,21 @@ "typescript" ], "overrides": [ + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/**/*.json", + "words": [ + "azurearcdata" + ] + }, + { + "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/**/*.json", + "words": [ + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ] + }, { "filename": "**/specification/batch/**/*.json", "words": [ diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json new file mode 100644 index 000000000000..76600b07efcc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json @@ -0,0 +1,240 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "ActiveDirectoryConnectorListResult": { + "description": "A list of active directory connectors", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ActiveDirectoryConnectorResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ActiveDirectoryConnectorResource": { + "type": "object", + "description": "Active directory connector resource", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActiveDirectoryConnectorProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "ActiveDirectoryConnectorProperties": { + "type": "object", + "description": "The properties of an Active Directory connector resource", + "properties": { + "domainServiceAccountLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for domain service account authentication." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Active Directory connector resource.", + "readOnly": true + }, + "spec": { + "$ref": "#/definitions/ActiveDirectoryConnectorSpec", + "description": "null", + "x-ms-client-flatten": false + }, + "status": { + "$ref": "#/definitions/ActiveDirectoryConnectorStatus", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "spec" + ] + }, + "ActiveDirectoryConnectorSpec": { + "description": "The specifications of the AD Kubernetes resource.", + "type": "object", + "properties": { + "activeDirectory": { + "$ref": "#/definitions/ActiveDirectoryConnectorDomainDetails", + "description": "null", + "x-ms-client-flatten": false + }, + "dns": { + "$ref": "#/definitions/ActiveDirectoryConnectorDNSDetails", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "activeDirectory", + "dns" + ] + }, + "ActiveDirectoryConnectorDomainDetails": { + "type": "object", + "description": "Active Directory domain details", + "properties": { + "realm": { + "type": "string", + "description": "Name (uppercase) of the Active Directory domain that this AD connector will be associated with." + }, + "netbiosDomainName": { + "type": "string", + "description": "NETBIOS name of the Active Directory domain." + }, + "serviceAccountProvisioning": { + "type": "string", + "enum": [ + "automatic", + "manual" + ], + "x-ms-enum": { + "name": "accountProvisioningMode", + "modelAsString": true + }, + "default": "manual", + "description": "The service account provisioning mode for this Active Directory connector." + }, + "ouDistinguishedName": { + "type": "string", + "description": "The distinguished name of the Active Directory Organizational Unit." + }, + "domainControllers": { + "$ref": "#/definitions/ActiveDirectoryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "realm" + ] + }, + "ActiveDirectoryConnectorDNSDetails": { + "type": "object", + "description": "DNS server details", + "properties": { + "domainName": { + "type": "string", + "description": "DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers." + }, + "nameserverIPAddresses": { + "type": "array", + "description": "List of Active Directory DNS server IP addresses.", + "items": { + "type": "string", + "minimum": 1 + } + }, + "replicas": { + "type": "integer", + "description": "Replica count for DNS proxy service. Default value is 1.", + "default": 1, + "format": "int64" + }, + "preferK8sDnsForPtrLookups": { + "type": "boolean", + "description": "Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups.", + "default": true + } + }, + "required": [ + "nameserverIPAddresses" + ] + }, + "ActiveDirectoryDomainControllers": { + "type": "object", + "description": "Details about the Active Directory domain controllers associated with this AD connector instance", + "properties": { + "primaryDomainController": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "Information about the Primary Domain Controller (PDC) in the AD domain.", + "x-ms-client-flatten": false + }, + "secondaryDomainControllers": { + "$ref": "#/definitions/ActiveDirectorySecondaryDomainControllers", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "ActiveDirectoryDomainController": { + "type": "object", + "description": "Information about a domain controller in the AD domain.", + "properties": { + "hostname": { + "type": "string", + "description": "Fully-qualified domain name of a domain controller in the AD domain." + } + }, + "required": [ + "hostname" + ] + }, + "ActiveDirectorySecondaryDomainControllers": { + "type": "array", + "description": "Information about the secondary domain controllers in the AD domain.", + "items": { + "$ref": "#/definitions/ActiveDirectoryDomainController", + "description": "List of the fully-qualified domain names of the secondary domain controllers in the AD domain.", + "x-ms-client-flatten": false + }, + "x-ms-identifiers": [ + "hostname" + ] + }, + "ActiveDirectoryConnectorStatus": { + "type": "object", + "description": "The status of the Kubernetes custom resource.", + "properties": { + "lastUpdateTime": { + "type": "string", + "description": "The time that the custom resource was last updated." + }, + "observedGeneration": { + "type": "integer", + "format": "int64", + "description": "The version of the replicaSet associated with the AD connector custom resource." + }, + "state": { + "type": "string", + "description": "The state of the AD connector custom resource." + } + }, + "additionalProperties": {} + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json new file mode 100644 index 000000000000..5f93b34b812f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json @@ -0,0 +1,2193 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.AzureArcData/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "./operations.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available Azure Data Services on Azure Arc API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "sqlManagedInstance", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a SQL Managed Instance": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups": { + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_List", + "summary": "List the failover groups associated with the given sql managed instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all failover groups associated with a sql managed instance.": { + "$ref": "./examples/ListBySqlManagedInstanceFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}": { + "put": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Create", + "description": "Creates or replaces a failover group resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "failoverGroupResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update a failover group instance.": { + "$ref": "./examples/CreateOrUpdateFailoverGroup.json" + } + } + }, + "delete": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Delete", + "description": "Deletes a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the failover group." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified failover group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a failover group instance.": { + "$ref": "./examples/DeleteFailoverGroup.json" + } + } + }, + "get": { + "tags": [ + "FailoverGroups" + ], + "operationId": "FailoverGroups_Get", + "description": "Retrieves a failover group resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlManagedInstanceName" + }, + { + "$ref": "#/parameters/failoverGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves a failover group resource.": { + "$ref": "./examples/GetFailoverGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_List", + "summary": "List sqlServerInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group.", + "summary": "List sqlServerInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { + "get": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/GetSqlServerInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstance", + "in": "body", + "description": "The SQL Server Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server Instance.": { + "$ref": "./examples/DeleteSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server Instance.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server Instance tags.": { + "$ref": "./examples/UpdateSqlServerInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getTelemetry": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getTelemetry", + "description": "Retrieves SQL Server instance telemetry", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "sqlServerInstanceTelemetryRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance telemetry.", + "required": true, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceTelemetryResponse" + } + }, + "202": { + "description": "Arc SQL Server telemetry retrieval is in progress.", + "headers": { + "Location": { + "type": "string", + "description": "The URL to retrieve the operation status." + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "operationName": "SqlServerInstances_PostInstanceTelemetry", + "itemName": "rows" + }, + "x-ms-examples": { + "Retrieves Arc SQL Server cpu utilization telemetry": { + "$ref": "./examples/GetSqlServerInstanceTelemetry.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/runMigrationAssessment": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_runMigrationAssessment", + "description": "Runs migration assessment for SQL Server instance", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceRunMigrationAssessmentResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Trigger migration assessment run on sql server instance": { + "$ref": "./examples/RunMigrationAssessmentSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/getJobsStatus": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "operationId": "SqlServerInstances_getJobsStatus", + "description": "Gets jobs status details for sql arc resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "name": "SqlServerInstanceJobsStatusRequest", + "in": "body", + "description": "Contains the parameters to get SQL Server instance agent jobs status.", + "required": false, + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusRequest" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceJobsStatusResponse" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves Arc SQL Server instance jobs status": { + "$ref": "./examples/GetSqlServerInstanceJobsStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/preUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Request Upgrade Permission before upgrading.", + "operationId": "SqlServerInstances_preUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested upgrade permission for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Prepare SQL server instance for AUM Upgrade.": { + "$ref": "./examples/PreUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/postUpgrade": { + "post": { + "tags": [ + "SqlServerInstances" + ], + "description": "Clean up after upgrading.", + "operationId": "SqlServerInstances_postUpgrade", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully clean up upgrade request for the instance.", + "schema": { + "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Post AUM Upgrade to complete SQL Instance Upgrade Process": { + "$ref": "./examples/PostUpgradeSqlServerInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_List", + "summary": "List sqlServerLicense resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_ListByResourceGroup", + "description": "Gets all sqlServerLicenses in a resource group.", + "summary": "List sqlServerLicense resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server license in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerLicenses/{sqlServerLicenseName}": { + "get": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Get", + "description": "Retrieves a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server license tags.": { + "$ref": "./examples/GetSqlServerLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Create", + "description": "Creates or replaces a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "sqlServerLicense", + "in": "body", + "description": "The SQL Server license to be created or updated.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server license tags.": { + "$ref": "./examples/CreateOrUpdateSqlServerLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Delete", + "description": "Deletes a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server license.": { + "$ref": "./examples/DeleteSqlServerLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerLicenses" + ], + "operationId": "SqlServerLicenses_Update", + "description": "Updates a SQL Server license resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server license.", + "required": true, + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicenseUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./sqlServerLicenses.json#/definitions/SqlServerLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server license tags.": { + "$ref": "./examples/UpdateSqlServerLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Data Controller.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a data controller.": { + "$ref": "./examples/GetDataController.json" + } + } + }, + "patch": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "dataControllerResource", + "description": "The update data controller resource", + "required": true, + "in": "body", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./dataControllers.json#/definitions/DataControllerResource" + } + }, + "202": { + "description": "Resource update is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors": { + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_List", + "summary": "List the active directory connectors associated with the given data controller.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Active Directory connectors associated with a data controller.": { + "$ref": "./examples/ListByDataControllerActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}": { + "put": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an Active Directory connector resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "activeDirectoryConnectorResource", + "description": "desc", + "required": true, + "in": "body", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or update an Active Directory connector instance.": { + "$ref": "./examples/CreateOrUpdateActiveDirectoryConnector.json" + } + } + }, + "delete": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the active directory connector." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified active directory connector does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes an Active Directory connector instance.": { + "$ref": "./examples/DeleteActiveDirectoryConnector.json" + } + } + }, + "get": { + "tags": [ + "ActiveDirectoryConnectors" + ], + "operationId": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an Active Directory connector resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/dataControllerName" + }, + { + "$ref": "#/parameters/activeDirectoryConnectorName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Active Directory connector resource.": { + "$ref": "./examples/GetActiveDirectoryConnector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_List", + "summary": "List postgres Instance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all Postgres Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_ListByResourceGroup", + "description": "Get a postgres Instances list by Resource group name.", + "summary": "List postgres Instance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all postgres Instances in a resource group.": { + "$ref": "./examples/ListByResourceGroupPostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}": { + "get": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Get", + "description": "Retrieves a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a postgres Instances.": { + "$ref": "./examples/GetPostgresInstance.json" + } + } + }, + "put": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Create", + "description": "Creates or replaces a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "resource", + "description": "The postgres instance", + "required": true, + "in": "body", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a Postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "202": { + "description": "Resource deletion is in progress." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/postgresInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./postgresInstances.json#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "dataControllerName": { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the data controller", + "x-ms-parameter-location": "method" + }, + "activeDirectoryConnectorName": { + "name": "activeDirectoryConnectorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Active Directory connector instance", + "x-ms-parameter-location": "method" + }, + "sqlManagedInstanceName": { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "failoverGroupName": { + "name": "failoverGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Failover Group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "sqlServerLicenseName": { + "name": "sqlServerLicenseName", + "description": "Name of SQL Server License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "postgresInstanceName": { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json new file mode 100644 index 000000000000..165fc4a44d4a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/common.json @@ -0,0 +1,159 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "CommonSku": { + "description": "The resource model definition representing SKU for ARM resources", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU. It is typically a letter+number code" + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." + } + }, + "required": [ + "name" + ] + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "BasicLoginInformation": { + "type": "object", + "description": "Username and password for basic login authentication.", + "properties": { + "username": { + "type": "string", + "description": "Login username." + }, + "password": { + "type": "string", + "description": "Login password.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ConnectionAuth": { + "type": "string", + "description": "The endpoint connection authentication type(s).", + "enum": [ + "Windows_NTLM", + "Windows_Kerberos", + "Windows_Negotiate", + "Certificate", + "Windows_NTLM_Certificate", + "Windows_Kerberos_Certificate", + "Windows_Negotiate_Certificate", + "Certificate_Windows_NTLM", + "Certificate_Windows_Kerberos", + "Certificate_Windows_Negotiate" + ], + "x-ms-enum": { + "name": "connectionAuth", + "modelAsString": true + } + }, + "EncryptionAlgorithm": { + "type": "string", + "description": "The encryption algorithm(s) used by the endpoint.", + "enum": [ + "NONE", + "RC4", + "AES", + "NONE, RC4", + "NONE, AES", + "RC4, AES", + "AES, RC4", + "NONE, RC4, AES", + "NONE, AES, RC4" + ], + "x-ms-enum": { + "name": "encryptionAlgorithm", + "modelAsString": true + } + }, + "SkuRecommendationResultsRecommendationStatus": { + "description": "The target recommendation Status for this database.", + "type": "string", + "enum": [ + "NotReady", + "Ready", + "Unknown" + ], + "x-ms-enum": { + "name": "recommendationStatus", + "modelAsString": true + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json new file mode 100644 index 000000000000..49ddde5fc14f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json @@ -0,0 +1,253 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "PageOfDataControllerResource": { + "type": "object", + "description": "A list of data controllers.", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array", + "description": "Array of results." + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + }, + "description": "Used for updating a data controller resource." + }, + "DataControllerProperties": { + "description": "The data controller properties.", + "type": "object", + "properties": { + "infrastructure": { + "type": "string", + "enum": [ + "azure", + "gcp", + "aws", + "alibaba", + "onpremises", + "other" + ], + "x-ms-enum": { + "name": "infrastructure", + "modelAsString": false + }, + "default": "other", + "description": "The infrastructure the data controller is running on." + }, + "onPremiseProperty": { + "$ref": "#/definitions/OnPremiseProperty" + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "uploadWatermark": { + "$ref": "#/definitions/UploadWatermark" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API." + }, + "metricsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for metrics dashboard on the Kubernetes cluster." + }, + "logsDashboardCredential": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Login credential for logs dashboard on the Kubernetes cluster." + }, + "logAnalyticsWorkspaceConfig": { + "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" + }, + "uploadServicePrincipal": { + "$ref": "#/definitions/UploadServicePrincipal", + "description": "Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc Data Controller resource.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "UploadWatermark": { + "description": "Properties on upload watermark. Mostly timestamp for each upload data type", + "type": "object", + "properties": { + "metrics": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" + }, + "logs": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" + }, + "usages": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" + } + } + }, + "OnPremiseProperty": { + "description": "Properties from the Kubernetes data controller", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "A globally unique ID identifying the associated Kubernetes cluster" + }, + "publicSigningKey": { + "type": "string", + "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" + }, + "signingCertificateThumbprint": { + "type": "string", + "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" + } + }, + "required": [ + "id", + "publicSigningKey" + ] + }, + "LogAnalyticsWorkspaceConfig": { + "type": "object", + "description": "Log analytics workspace id and primary key", + "properties": { + "workspaceId": { + "type": "string", + "format": "uuid", + "description": "Azure Log Analytics workspace ID" + }, + "primaryKey": { + "type": "string", + "description": "Primary key of the workspace", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "UploadServicePrincipal": { + "type": "object", + "description": "Service principal for uploading billing, metrics and logs.", + "properties": { + "clientId": { + "type": "string", + "format": "uuid", + "description": "Client ID of the service principal for uploading data." + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "Tenant ID of the service principal." + }, + "authority": { + "type": "string", + "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" + }, + "clientSecret": { + "type": "string", + "description": "Secret of the service principal", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json new file mode 100644 index 000000000000..10d381325fed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/AddDatabasesToAvailabilityGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1", + "db2", + "db3" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json new file mode 100644 index 000000000000..b14fcf3fda0e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateActiveDirectoryConnector.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview", + "activeDirectoryConnectorResource": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + } + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + }, + "201": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..5a7af1d03c87 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,223 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "secondaryRecoveryHealthDescription": null, + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "sessionTimeout": 10, + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1" + }, + { + "databaseName": "db2" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json new file mode 100644 index 000000000000..2fc04715ef44 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateArcSqlServerDatabase.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview", + "sqlServerDatabaseResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.0, + "spaceAvailableMB": 100.0, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..0073fe4ff49d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey" + }, + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "metricsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logsDashboardCredential": { + "username": "username", + "password": "********" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444", + "primaryKey": "********" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/", + "clientSecret": "********" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "201": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json new file mode 100644 index 000000000000..068b2580a5ff --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateFailoverGroup.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview", + "failoverGroupResource": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "partnerSyncMode": "async", + "role": "primary" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + }, + "201": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json new file mode 100644 index 000000000000..e6a865dc7e08 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdatePostgresInstance.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "resource": { + "location": "eastus", + "properties": { + "dataControllerId": "dataControllerId", + "admin": "admin", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "k8sRaw": { + "apiVersion": "apiVersion", + "kind": "postgresql-12", + "metadata": { + "creationTimestamp": "2020-08-25T14:55:10Z", + "generation": 1, + "name": "pg1", + "namespace": "test", + "resourceVersion": "527780", + "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", + "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" + }, + "spec": { + "backups": { + "deltaMinutes": 3, + "fullMinutes": 10, + "tiers": [ + { + "retention": { + "maximums": [ + "6", + "512MB" + ], + "minimums": [ + "3" + ] + }, + "storage": { + "volumeSize": "1Gi" + } + } + ] + }, + "engine": { + "extensions": [ + { + "name": "citus" + } + ] + }, + "scale": { + "shards": 3 + }, + "scheduling": { + "default": { + "resources": { + "requests": { + "memory": "256Mi" + } + } + } + }, + "service": { + "type": "NodePort" + }, + "storage": { + "data": { + "className": "local-storage", + "size": "5Gi" + }, + "logs": { + "className": "local-storage", + "size": "5Gi" + } + } + }, + "status": { + "externalEndpoint": null, + "readyPods": "4/4", + "state": "Ready" + } + } + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + }, + "201": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testsqlregistration", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..3d0384a2843c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "sqlManagedInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username", + "password": "********" + }, + "activeDirectoryInformation": { + "keytabInformation": { + "keytab": "********" + } + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..5c06a00b721d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerEsuLicense.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "sqlServerEsuLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense", + "name": "sqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json new file mode 100644 index 000000000000..4e7749baa078 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerInstance.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "sqlServerInstance": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "cores": "4", + "instanceName": "name of instance", + "hostType": "Physical Server", + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Registered", + "azureDefenderStatus": "Protected", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "201": { + "body": { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "status": "Connected", + "azureDefenderStatus": "Protected", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json new file mode 100644 index 000000000000..df774923e646 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateOrUpdateSqlServerLicense.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "sqlServerLicense": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + }, + "201": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense", + "name": "sqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..6387ac3dea93 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerAvailabilityGroup.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createAgConfiguration": { + "availabilityGroupName": "myNewAg", + "replicas": [ + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/", + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + }, + { + "serverInstance": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/", + "endpointName": "inst2DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityMode": "SYNCHRONOUS_COMMIT", + "failoverMode": "AUTOMATIC", + "seedingMode": "AUTOMATIC", + "backupPriority": 50, + "secondaryRoleAllowConnections": "ALL", + "secondaryRoleReadOnlyRoutingUrl": null, + "primaryRoleAllowConnections": "ALL", + "primaryRoleReadOnlyRoutingList": null, + "sessionTimeout": 10 + } + ], + "databases": [ + "database1", + "database2" + ], + "automatedBackupPreference": "SECONDARY", + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "dbFailover": "ON", + "dtcSupport": "NONE", + "requiredSynchronizedSecondariesToCommit": 0, + "clusterType": "WSFC", + "listener": { + "dnsName": "myNewAgListener", + "ipV4AddressesAndMasks": [ + { + "ipAddress": "192.1.168.5", + "mask": "255.255.255.0" + }, + { + "ipAddress": "10.1.168.5", + "mask": "255.255.255.0" + } + ], + "port": 1433 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewAg", + "name": "myNewag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json new file mode 100644 index 000000000000..bd9f3fd062c7 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/CreateSqlServerDistributedAvailabilityGroup.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "createDagConfiguration": { + "availabilityGroupName": "myNewDag", + "primaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "listenerUrl": "TCP://testAG1.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + }, + "secondaryAvailabilityGroup": { + "availabilityGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST2/availabilityGroups/testAG2", + "listenerUrl": "TCP://testAG2.contoso.com:5022", + "availabilityMode": "ASYNCHRONOUS_COMMIT", + "failoverMode": "MANUAL", + "seedingMode": "AUTOMATIC", + "certificateConfiguration": { + "certificateName": "myCert" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + }, + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/myNewDag", + "name": "myNewDag", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "isDistributed": true + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST1.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "PRIMARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + }, + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\Inst2", + "configure": { + "endpointName": "ins21DBMEndpoint", + "endpointUrl": "TCP://testSqlServer_INST2.testSqlserverDomain:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "AUTOMATIC", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "database1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "database2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json new file mode 100644 index 000000000000..3edead6e00e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteActiveDirectoryConnector.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..666b2db57f72 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerAvailabilityGroup.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlInstanceAvailabilityGroup", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json new file mode 100644 index 000000000000..8bcd13277d4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteArcSqlServerDatabase.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..73053e5c0e7c --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteDataController.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json new file mode 100644 index 000000000000..acaf1b6effbd --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteFailoverGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": {} + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json new file mode 100644 index 000000000000..f99fda21bf30 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeletePostgresInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..22b0c85fa325 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json new file mode 100644 index 000000000000..c204c14cfe32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerEsuLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json new file mode 100644 index 000000000000..a60bed533dab --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "202": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-AsyncOperation": "http://azure.async.operation/status" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json new file mode 100644 index 000000000000..f1b375d71a7d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/DeleteSqlServerLicense.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "204": { + "description": "Resource does not exist." + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/FailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ForceFailoverArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json new file mode 100644 index 000000000000..7a31dcc92155 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetActiveDirectoryConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "activeDirectoryConnectorName": "testADConnector", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", + "name": "testADConnector", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..091e1aef1546 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerAvailabilityGroup.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json new file mode 100644 index 000000000000..e524be7554ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetArcSqlServerDatabase.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "databaseName": "testdb", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json new file mode 100644 index 000000000000..047dfe542b35 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetDataController.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureArcData/dataControllers" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json new file mode 100644 index 000000000000..c6a830d76e1e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetFailoverGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testSqlManagedInstance", + "failoverGroupName": "testFailoverGroupName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json new file mode 100644 index 000000000000..35dcf6bd7f6a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetPostgresInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstances", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances", + "name": "testpostgresInstances", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..7014a0289953 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json new file mode 100644 index 000000000000..09a4286a647f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerEsuLicense.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json new file mode 100644 index 000000000000..877c6661c531 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstance.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "RC4", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json new file mode 100644 index 000000000000..6c842f3989d0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceJobsStatus.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "SqlServerInstanceJobsStatusRequest": { + "featureName": "MigrationAssessment", + "jobType": "Ondemand" + } + }, + "responses": { + "200": { + "body": { + "jobsStatus": [ + { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "Failed", + "jobException": "Something went wrong in collection suitability", + "backgroundJob": { + "state": "Completed", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": "2024-02-22T21:18:21.6083558-08:00", + "lastExecutionStatus": "Succeeded" + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "Completed", + "result": "Failed" + }, + { + "actionId": "system.last", + "state": "Completed", + "result": "Succeeded" + }, + { + "actionId": "system.first", + "state": "Completed", + "result": "Succeeded" + } + ] + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json new file mode 100644 index 000000000000..ee83800f4427 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerInstanceTelemetry.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview", + "sqlServerInstanceTelemetryRequest": { + "datasetName": "sqlserver_storage_io", + "startTime": "2023-09-30T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "columns": [ + { + "name": "row_id", + "type": "int" + }, + { + "name": "sample_time_utc", + "type": "datetime" + }, + { + "name": "database_id", + "type": "int" + }, + { + "name": "database_name", + "type": "string" + }, + { + "name": "file_id", + "type": "int" + }, + { + "name": "file_type", + "type": "string" + }, + { + "name": "file_size_mb", + "type": "double" + }, + { + "name": "file_max_size_mb", + "type": "double" + }, + { + "name": "io_stall_read_ms", + "type": "int" + }, + { + "name": "num_of_reads", + "type": "int" + }, + { + "name": "num_of_bytes_read", + "type": "int" + }, + { + "name": "io_stall_write_ms", + "type": "int" + }, + { + "name": "num_of_writes", + "type": "int" + }, + { + "name": "num_of_bytes_written", + "type": "int" + }, + { + "name": "io_stall_queued_read_ms", + "type": "int" + }, + { + "name": "io_stall_queued_write_ms", + "type": "int" + }, + { + "name": "size_on_disk_bytes", + "type": "int" + } + ], + "rows": [ + [ + "1", + "2023-09-30T00:00:00Z", + "1", + "master", + "1", + "Data", + "21.9375", + "0", + "88", + "56", + "3473408", + "2", + "3", + "24576", + "0", + "0", + "23003136" + ], + [ + "2", + "2023-09-30T00:00:00Z", + "5", + "arcDb", + "2", + "Log", + "0.625", + "0", + "12", + "11", + "208896", + "5989", + "853", + "3506176", + "0", + "0", + "4653056" + ], + [ + "3", + "2023-09-30T00:00:00Z", + "2", + "model", + "1", + "Data", + "4.4375", + "0", + "65", + "59", + "3284992", + "279", + "661", + "5922816", + "0", + "0", + "4653056" + ] + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/servers/testsqlserver/getTelemetry?api-version=2024-05-01-preview" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview", + "Location": "https://management.azure.com/providers/Microsoft.AzureArcData/locations/eastus2euap/operationStatuses/5abb198d-cc4b-46bd-9e6c-e3f0ba22015d?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json new file mode 100644 index 000000000000..10bc31bf0341 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/GetSqlServerLicense.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json new file mode 100644 index 000000000000..7749ce11b070 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByDataControllerActiveDirectoryConnector.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "dataControllerName": "testdataController" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc1.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc2.contoso.local" + }, + { + "hostname": "dc3.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector1", + "name": "testADConnector1", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + }, + { + "properties": { + "spec": { + "activeDirectory": { + "realm": "CONTOSO.LOCAL", + "serviceAccountProvisioning": "manual", + "domainControllers": { + "primaryDomainController": { + "hostname": "dc4.contoso.local" + }, + "secondaryDomainControllers": [ + { + "hostname": "dc5.contoso.local" + }, + { + "hostname": "dc6.contoso.local" + } + ] + }, + "netbiosDomainName": "CONTOSO" + }, + "dns": { + "nameserverIPAddresses": [ + "11.11.111.111", + "22.22.222.222" + ], + "replicas": 1, + "preferK8sDnsForPtrLookups": false, + "domainName": "contoso.local" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector2", + "name": "testADConnector2", + "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..e0c0038311ef --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json new file mode 100644 index 000000000000..e2459f3ecc1f --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupPostgresInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..ffc87618e06d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json new file mode 100644 index 000000000000..fe027b0ea133 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerEsuLicense.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json new file mode 100644 index 000000000000..c25935323139 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerInstance.json @@ -0,0 +1,248 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Connected", + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json new file mode 100644 index 000000000000..0aec26805c32 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListByResourceGroupSqlServerLicense.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json new file mode 100644 index 000000000000..f65fbde5de33 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlManagedInstanceFailoverGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2024-05-01-preview", + "sqlManagedInstanceName": "testSqlManagedInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + }, + { + "properties": { + "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", + "spec": { + "sharedName": "testSharedName", + "sourceMI": "sourceSQLMI", + "partnerMI": "partnerMI", + "partnerMirroringURL": "11.11.111.111:1111", + "partnerMirroringCert": "testCert", + "partnerSyncMode": "async", + "role": "primary" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", + "name": "testFailoverGroupName", + "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json new file mode 100644 index 000000000000..fe6cdaa40f73 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG1", + "name": "testAG1", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY" + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json new file mode 100644 index 000000000000..b7d6fe6058ed --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListBySqlServerInstanceDatabase.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "NotReady" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + }, + { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb1", + "name": "testdb1", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json new file mode 100644 index 000000000000..02c537b07e1b --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListOperation.json @@ -0,0 +1,353 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "read_OperationStatuses", + "description": "read OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/Locations/OperationStatuses/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Locations/OperationStatuses", + "operation": "write_OperationStatuses", + "description": "write OperationStatuses" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInSubscription", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_ListInGroup", + "description": "read dataControllers" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers", + "operation": "DataControllers_PatchDataController", + "description": "Updates a dataController resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_List", + "description": "read sqlManagedInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlManagedInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlManagedInstances", + "operation": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_List", + "description": "read sqlServerInstances" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_ListByResourceGroup", + "description": "Gets all sqlServerInstances in a resource group." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Get", + "description": "Retrieves a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Create", + "description": "Creates or replaces a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Delete", + "description": "Deletes a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_List", + "description": "List all database resources in a Sql Server Instance." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Get", + "description": "Retrieves a database resource" + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Create", + "description": "Creates or updates a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/databases/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances/databases", + "operation": "SqlServerDatabases_Delete", + "description": "Deletes a database resource." + } + }, + { + "name": "Microsoft.AzureArcData/sqlServerInstances/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "sqlServerInstances", + "operation": "SqlServerInstances_Update", + "description": "Updates a SQL Server Instance resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_List", + "description": "read activeDirectoryConnectors" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Get", + "description": "Retrieves an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Create", + "description": "Creates or replaces an active directory connector resource." + } + }, + { + "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "dataControllers/activeDirectoryConnectors", + "operation": "ActiveDirectoryConnectors_Delete", + "description": "Deletes an active directory connector resource" + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/read", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Get Postgres Instance details.", + "description": "Retrieves details of Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/write", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Create new or update existing Postgres Instances.", + "description": "Create a new or change properties of existing Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/postgresInstances/delete", + "isDataAction": false, + "display": { + "resource": "Microsoft.AzureArcData", + "provider": "Azure Arc Data Resource Provider.", + "operation": "Delete exisiting Postgres Instances.", + "description": "Delete exisiting Postgres Instances." + } + }, + { + "name": "Microsoft.AzureArcData/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Register the Microsoft.AzureArcData", + "description": "Register the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Microsoft.AzureArcData", + "operation": "Unregister the Microsoft.AzureArcData", + "description": "Unregister the subscription for Microsoft.AzureArcData" + } + }, + { + "name": "Microsoft.AzureArcData/Operations/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureArcData", + "resource": "Operations", + "operation": "read_Operations", + "description": "read Operations" + } + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..d72082c3a742 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + }, + { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension" + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureArcData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json new file mode 100644 index 000000000000..fc076ad558ea --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionPostgresInstance.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", + "name": "testpostgresInstances1", + "type": "Microsoft.AzureArcData/PostgresInstances" + }, + { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", + "name": "testpostgresInstances2", + "type": "Microsoft.AzureArcData/PostgresInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..3f125efbd360 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + }, + { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json new file mode 100644 index 000000000000..d75e8e6a340a --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerEsuLicense.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense1", + "name": "sqlServerEsuLicense1", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "version": "SQL Server 2012", + "uniqueId": "00000000-1111-2222-3333-444444444444", + "physicalCores": 24, + "activationState": "Inactive", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/sqlServerEsuLicense2", + "name": "sqlServerEsuLicense2", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json new file mode 100644 index 000000000000..28097d806c6e --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerInstance.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": false + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", + "name": "sqlServerInstance1", + "type": "Microsoft.AzureArcData/SqlServerInstances" + }, + { + "properties": { + "version": "SQL Server 2017", + "edition": "Developer", + "containerResourceId": "Arc Machine Name", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2008 R2", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "status": "Connected", + "databaseMirroringEndpoint": { + "endpointName": "testMirroringEndpoint", + "role": "PARTNER", + "isEncryptionEnabled": true, + "encryptionAlgorithm": "AES", + "connectionAuth": "Certificate", + "port": 12345, + "isDynamicPort": false, + "ipAddress": "123.124.125.126", + "certificateName": "testCertificateName" + }, + "monitoring": { + "enabled": false + }, + "migration": { + "assessment": { + "enabled": true, + "assessmentUploadTime": "2024-03-15T00:16:11.0000000Z", + "serverAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Resolving Transact-SQL differences during migration to SQL Database" + }, + { + "appliesToMigrationTargetPlatform": "AzureSqlManagedInstance", + "featureId": "TraceFlags", + "impactedObjects": [ + { + "impactDetail": "", + "name": "8017", + "objectType": "TraceFlag" + } + ], + "issueCategory": "Warning", + "moreInformation": "Trace Flags" + } + ], + "skuRecommendationResults": { + "azureSqlDatabase": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 245.13, + "storageCost": 0.18, + "totalCost": 245.31 + } + }, + "azureSqlManagedInstance": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "computeTier": "Provisioned", + "hardwareType": "Gen5", + "sqlPurchasingModel": "vCore", + "sqlServiceTier": "General Purpose", + "zoneRedundancyAvailable": false + } + }, + "monthlyCost": { + "computeCost": 490.26, + "storageCost": 0, + "totalCost": 490.26 + } + }, + "azureSqlVirtualMachine": { + "recommendationStatus": "Ready", + "numberOfServerBlockerIssues": 0, + "targetSku": { + "category": { + "availableVmSkus": [ + "Standard_D16as_v4", + "Standard_D2as_v4", + "Standard_D32as_v4", + "Standard_D48as_v4", + "Standard_D4as_v4", + "Standard_D64as_v4", + "Standard_D8as_v4", + "Standard_D96as_v4" + ], + "virtualMachineFamily": "standardDASv4Family" + } + }, + "monthlyCost": { + "computeCost": 81.98, + "storageCost": 2.4, + "totalCost": 84.38 + } + } + } + } + }, + "clientConnection": { + "enabled": false + }, + "serviceType": "SSRS" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", + "name": "sqlServerInstance2", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json new file mode 100644 index 000000000000..3628189c69cc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ListSubscriptionSqlServerLicense.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense1", + "name": "sqlServerLicense1", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + }, + { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/sqlServerLicense2", + "name": "sqlServerLicense2", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PostUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json new file mode 100644 index 000000000000..1b61623f7a4d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/PreUpgradeSqlServerInstance.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json new file mode 100644 index 000000000000..aa30961dbe28 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RemoveDatabasesFromAvailabilityGroup.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "databases": { + "values": [ + "db1" + ] + }, + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json new file mode 100644 index 000000000000..cc3d31a05092 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/RunMigrationAssessmentSqlServerInstance.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlserver", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/a5082b19-8a6e-4bc5-8fdd-8ef39dfebc39/resourceGroups/alzahedi-rg-easyup/providers/Microsoft.AzureArcData/sqlServerInstances/arcee-dev/jobs/235e045f:2D5237:2D38eb:2Db8fa:2Df0f549d1d7d9MigrationJobOnDemand", + "instanceName": "MSSQLSERVER", + "jobStatus": "InProgress", + "jobException": null, + "backgroundJob": { + "state": "Enabled", + "executionState": "Waiting", + "startTime": "2024-02-22T00:04:06.88265-08:00", + "endTime": "2024-03-15T02:04:06.88265-07:00", + "lastExecutionTime": null, + "lastExecutionStatus": null + }, + "sequencerActions": [ + { + "actionId": ":2Fsubscriptions:2Fa5082b19:2D8a6e:2D4bc5:2D8fdd:2D8ef39dfebc39:2FresourceGroups:2Falzahedi:2Drg:2Deasyup:2Fproviders:2FMicrosoft:2EAzureArcData:2FsqlServerInstances:2Farcee:2Ddev:2Faction:2FMicrosoft:2ESqlServer:2EManagement:2EMigrationAssessmentPlugin:2EActions:2ERunOnDemandMigrationJob", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.last", + "state": "NotStarted", + "result": "NotCompleted" + }, + { + "actionId": "system.first", + "state": "NotStarted", + "result": "NotCompleted" + } + ] + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..7b832da95c86 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateArcSqlServerAvailabilityGroup.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "api-version": "2024-05-01-preview", + "availabilityGroupName": "testAG", + "sqlServerAvailabilityGroupUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..0a9f86e48554 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateDataController.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2024-05-01-preview", + "dataControllerResource": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "onPremiseProperty": { + "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", + "publicSigningKey": "publicOnPremSigningKey", + "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" + }, + "basicLoginInformation": { + "username": "username" + }, + "metricsDashboardCredential": { + "username": "username" + }, + "logsDashboardCredential": { + "username": "username" + }, + "logAnalyticsWorkspaceConfig": { + "workspaceId": "00000000-1111-2222-3333-444444444444" + }, + "uploadServicePrincipal": { + "clientId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "authority": "https://login.microsoftonline.com/" + }, + "uploadWatermark": { + "metrics": "2020-01-01T17:18:19.1234567Z", + "logs": "2020-01-01T17:18:19.1234567Z", + "usages": "2020-01-01T17:18:19.1234567Z" + }, + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "infrastructure": "onpremises" + }, + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureArcData/dataControllers" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json new file mode 100644 index 000000000000..25f2a2d65b8d --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdatePostgresInstance.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "postgresInstanceName": "testpostgresInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "basicLoginInformation": { + "username": "username" + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "sku": { + "name": "default", + "tier": "Hyperscale", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", + "name": "testpostgresInstance", + "type": "Microsoft.AzureArcData/PostgresInstance" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..480c85ef5bfc --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "admin": "Admin user", + "startTime": "Instance start time", + "endTime": "Instance end time", + "basicLoginInformation": { + "username": "username" + }, + "activeDirectoryInformation": { + "keytabInformation": {} + }, + "licenseType": "LicenseIncluded", + "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", + "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", + "k8sRaw": { + "additionalProperty": 1234, + "spec": { + "replicas": 1, + "scheduling": { + "default": { + "resources": { + "requests": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + }, + "limits": { + "cpu": "1", + "memory": "8Gi", + "additionalProperty": "additionalValue" + } + } + } + }, + "security": { + "adminLoginSecret": "test-sql-login-secret", + "serviceCertificateSecret": "Service Certificate Secret", + "activeDirectory": { + "connector": { + "name": "Name of connector", + "namespace": "Namespace of connector" + }, + "accountName": "Account name", + "keytabSecret": "Key tab secret of account", + "encryptionTypes": [ + "Encryption type item1, Encryption type item2,..." + ] + }, + "transparentDataEncryption": { + "mode": "SystemManaged" + } + }, + "settings": { + "network": { + "forceencryption": 0, + "tlsciphers": "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384", + "tlsprotocols": "1.2" + } + } + } + } + }, + "location": "northeurope", + "extendedLocation": { + "type": "CustomLocation", + "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "sku": { + "name": "vCore", + "tier": "GeneralPurpose", + "dev": true + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureArcData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json new file mode 100644 index 000000000000..77de4a6e8db8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerDatabase.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlManagedInstance", + "api-version": "2024-05-01-preview", + "databaseName": "testdb", + "sqlServerDatabaseUpdate": { + "tags": { + "mytag": "myval1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", + "name": "testdb", + "type": "Microsoft.AzureArcData/sqlServerInstances/databases", + "properties": { + "collationName": "SQL_Latin1_General_CP1_CI_AS", + "databaseCreationDate": "2022-04-05T16:26:33.883Z", + "compatibilityLevel": 150, + "state": "Online", + "isReadOnly": true, + "recoveryMode": "Full", + "sizeMB": 150.00, + "spaceAvailableMB": 100.00, + "databaseOptions": { + "isAutoCloseOn": true, + "isAutoShrinkOn": true, + "isAutoCreateStatsOn": true, + "isAutoUpdateStatsOn": true, + "isMemoryOptimizationEnabled": true, + "isRemoteDataArchiveEnabled": true, + "isEncrypted": true, + "isTrustworthyOn": true + }, + "backupInformation": { + "lastFullBackup": "2022-05-05T16:26:33.883Z", + "lastLogBackup": "2022-05-10T16:26:33.883Z" + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "migration": { + "assessment": { + "assessmentUploadTime": "2024-03-15T00:14:52.0000000Z", + "databaseAssessments": [ + { + "appliesToMigrationTargetPlatform": "AzureSqlDatabase", + "featureId": "ServiceBroker", + "issueCategory": "Issue", + "moreInformation": "" + } + ], + "targetReadiness": { + "azureSqlDatabase": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlManagedInstance": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + }, + "azureSqlVirtualMachine": { + "numOfBlockerIssues": 0, + "recommendationStatus": "Ready" + } + } + } + }, + "earliestRestoreDate": "2022-05-10T16:26:33.883Z", + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/MyDatabase", + "restorePointInTime": "2022-05-05T16:26:33.883Z", + "lastDatabaseUploadTime": "2023-03-29T14:13:12Z" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json new file mode 100644 index 000000000000..9c8ec40997d8 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerEsuLicense.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerEsuLicenseName": "testsqlServerEsuLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "properties": { + "billingPlan": "Paid", + "physicalCores": 28, + "activationState": "Active" + }, + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "Paid", + "version": "SQL Server 2012", + "physicalCores": 28, + "activationState": "Active", + "scopeType": "Subscription", + "activatedAt": "2020-01-01T17:18:19.1234567Z", + "terminatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/testsqlServerEsuLicense", + "name": "testsqlServerEsuLicense", + "type": "Microsoft.AzureArcData/sqlServerEsuLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json new file mode 100644 index 000000000000..e51b1168d586 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerInstance.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testsqlServerInstance", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "version": "SQL Server 2012", + "edition": "Developer", + "containerResourceId": "Resource id of hosting Arc Machine", + "createTime": "01/01/2020 01:01:01", + "patchLevel": "patchlevel", + "collation": "collation", + "dbMasterKeyExists": true, + "isHadrEnabled": true, + "traceFlags": [ + 1800, + 9567 + ], + "currentVersion": "2012", + "instanceName": "name of instance", + "tcpDynamicPorts": "1433", + "tcpStaticPorts": "1433", + "productId": "sql id", + "vCore": "4", + "cores": "4", + "licenseType": "Free", + "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", + "azureDefenderStatus": "Protected", + "status": "Registered", + "hostType": "Physical Server", + "lastInventoryUploadTime": "2023-03-29T14:13:12Z", + "lastUsageUploadTime": "2023-03-29T14:13:12Z", + "alwaysOnRole": "FailoverClusterInstance", + "failoverCluster": { + "id": "f836af7e-85ed-4ea4-91fb-67709b34e323", + "networkName": "networkNameOfSQLFCI", + "sqlInstanceIds": [ + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer1", + "/subscriptions/dummySub/resourceGroups/dummyRG/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServer2" + ], + "hostNames": [ + "DEV-HOSTNAME1", + "DEV-HOSTNAME2" + ] + }, + "backupPolicy": { + "retentionPeriodDays": 1, + "fullBackupDays": 1, + "differentialBackupHours": 12, + "transactionLogBackupMinutes": 30 + }, + "upgradeLockedUntil": "2022-05-05T16:26:33.883Z", + "serviceType": "Engine" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", + "name": "testsqlServerInstance", + "type": "Microsoft.AzureArcData/SqlServerInstances" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json new file mode 100644 index 000000000000..8629697226b0 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/UpdateSqlServerLicense.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerLicenseName": "testsqlServerLicense", + "api-version": "2024-05-01-preview", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "billingPlan": "PAYG", + "licenseCategory": "Core", + "physicalCores": 24, + "activationState": "Deactivated", + "scopeType": "Subscription", + "lastActivatedAt": "2020-01-01T17:18:19.1234567Z", + "lastDeactivatedAt": "2020-01-01T17:18:19.1234567Z", + "tenantId": "89fdfcc3-4c62-41c3-93c4-16bae3bcf5ea" + }, + "location": "northeurope", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerLicenses/testsqlServerLicense", + "name": "testsqlServerLicense", + "type": "Microsoft.AzureArcData/SqlServerLicenses" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json new file mode 100644 index 000000000000..a329e153da55 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/examples/ViewArcSqlServerAvailabilityGroup.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlServerInstanceName": "testSqlServer_INST1", + "availabilityGroupName": "testAG", + "api-version": "2024-05-01-preview", + "sqlServerAvailabilityGroupResource": { + "location": "southeastasia", + "tags": { + "mytag": "myval" + }, + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "collectionTimestamp": "2022-05-05T16:26:33.883Z", + "info": { + "failureConditionLevel": 3, + "healthCheckTimeout": 30000, + "automatedBackupPreferenceDescription": "SECONDARY", + "version": 0, + "basicFeatures": false, + "dtcSupport": false, + "dbFailover": true, + "isDistributed": false, + "clusterTypeDescription": "WSFC", + "requiredSynchronizedSecondariesToCommit": 0, + "isContained": false, + "primaryReplica": "testSqlServer\\INST1", + "primaryRecoveryHealthDescription": "ONLINE", + "secondaryRecoveryHealthDescription": null, + "synchronizationHealthDescription": "HEALTHY", + "replicationPartnerType": null + }, + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServer\\INST1", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServer_INST1/availabilityGroups/testAG", + "name": "testAG", + "type": "Microsoft.AzureArcData/sqlServerInstances/availabilityGroups", + "properties": { + "availabilityGroupId": "00000000-1111-2222-3333-444444444444", + "serverName": "testSqlServer", + "instanceName": "INST1", + "replicas": { + "value": [ + { + "replicaId": "00000000-1111-2222-3333-444444444444", + "replicaName": "testSqlServerInstance", + "configure": { + "endpointName": "inst1DBMEndpoint", + "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", + "endpointConnectLogin": "NT Server\\MSSSQLSERVER", + "availabilityModeDescription": "SYNCHRONOUS_COMMIT", + "failoverModeDescription": "EXTERNAL", + "sessionTimeout": 10, + "primaryRoleAllowConnectionsDescription": "ALL", + "secondaryRoleAllowConnectionsDescription": "ALL", + "replicaCreateDate": null, + "replicaModifyDate": null, + "backupPriority": 50, + "readOnlyRoutingUrl": null, + "readWriteRoutingUrl": null, + "seedingModeDescription": "AUTOMATIC" + }, + "state": { + "availabilityGroupReplicaRole": "SECONDARY", + "operationalStateDescription": "ONLINE", + "recoveryHealthDescription": "ONLINE_IN_PROGRESS", + "synchronizationHealthDescription": "HEALTHY", + "connectedStateDescription": "CONNECTED", + "lastConnectErrorDescription": "", + "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" + } + } + ] + }, + "databases": { + "value": [ + { + "databaseName": "db1", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + }, + { + "databaseName": "db2", + "replicaName": "testSqlServer\\INST1", + "isLocal": true, + "isPrimaryReplica": true, + "synchronizationStateDescription": "SYNCHRONIZED", + "isCommitParticipant": true, + "synchronizationHealthDescription": "HEALTHY", + "databaseStateDescription": "ONLINE", + "isSuspended": false + } + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "tags": { + "mytag": "myval" + } + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json new file mode 100644 index 000000000000..396d72260627 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json @@ -0,0 +1,157 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "FailoverGroupListResult": { + "description": "A list of failover groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of failover group results.", + "type": "array", + "items": { + "$ref": "#/definitions/FailoverGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "FailoverGroupResource": { + "type": "object", + "description": "A failover group resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FailoverGroupProperties", + "description": "null", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "FailoverGroupProperties": { + "type": "object", + "description": "The properties of a failover group resource.", + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the failover group resource.", + "readOnly": true + }, + "partnerManagedInstanceId": { + "type": "string", + "description": "The resource ID of the partner SQL managed instance." + }, + "spec": { + "$ref": "#/definitions/FailoverGroupSpec", + "description": "The specifications of the failover group resource.", + "x-ms-client-flatten": false + }, + "status": { + "type": "object", + "description": "The status of the failover group custom resource." + } + }, + "additionalProperties": {}, + "required": [ + "partnerManagedInstanceId", + "spec" + ] + }, + "FailoverGroupSpec": { + "description": "The specifications of the failover group resource.", + "type": "object", + "properties": { + "sharedName": { + "type": "string", + "description": "The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name." + }, + "sourceMI": { + "type": "string", + "description": "The name of the SQL managed instance with this failover group role." + }, + "partnerMI": { + "type": "string", + "description": "The name of the partner SQL managed instance." + }, + "partnerMirroringURL": { + "type": "string", + "description": "The mirroring endpoint URL of the partner SQL managed instance." + }, + "partnerMirroringCert": { + "type": "string", + "description": "The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported." + }, + "partnerSyncMode": { + "type": "string", + "enum": [ + "async", + "sync" + ], + "x-ms-enum": { + "name": "failoverGroupPartnerSyncMode", + "modelAsString": true + }, + "default": "async", + "description": "The partner sync mode of the SQL managed instance." + }, + "role": { + "type": "string", + "enum": [ + "primary", + "secondary", + "force-primary-allow-data-loss", + "force-secondary" + ], + "x-ms-enum": { + "name": "instanceFailoverGroupRole", + "modelAsString": true + }, + "default": "primary", + "description": "The role of the SQL managed instance in this failover group." + } + }, + "additionalProperties": {}, + "required": [ + "role" + ] + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json new file mode 100644 index 000000000000..70d26a7889e9 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json @@ -0,0 +1,125 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "Operation": { + "description": "Azure Data Services on Azure Arc operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action." + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": {}, + "readOnly": true, + "x-ms-client-flatten": false + } + }, + "required": [ + "name", + "display", + "isDataAction" + ] + }, + "OperationListResult": { + "description": "Result of the request to list Azure Data Services on Azure Arc operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string" + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string" + } + }, + "required": [ + "provider", + "resource", + "operation", + "description" + ] + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json new file mode 100644 index 000000000000..9a494464f170 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json @@ -0,0 +1,174 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "PostgresInstanceSku": { + "description": "The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc", + "type": "object", + "properties": { + "tier": { + "type": "string", + "enum": [ + "Hyperscale" + ], + "x-ms-enum": { + "name": "PostgresInstanceSkuTier", + "modelAsString": false + }, + "default": "Hyperscale", + "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." + } + }, + "allOf": [ + { + "$ref": "./common.json#/definitions/CommonSku" + } + ] + }, + "PostgresInstanceProperties": { + "description": "Postgres Instance properties.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "The data controller id" + }, + "admin": { + "type": "string", + "description": "The instance admin" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "k8sRaw": { + "type": "object", + "description": "The raw kubernetes information" + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Azure Arc-enabled PostgreSQL instance." + } + } + }, + "PostgresInstance": { + "description": "A Postgres Instance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false, + "description": "null" + }, + "sku": { + "$ref": "#/definitions/PostgresInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "PostgresInstanceUpdate": { + "description": "An update to a Postgres Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PostgresInstanceProperties", + "x-ms-client-flatten": false + } + } + }, + "PostgresInstanceListResult": { + "description": "A list of PostgresInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/PostgresInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "location": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure region to use for the request", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json new file mode 100644 index 000000000000..86050e597106 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + }, + "extendedLocation": { + "$ref": "./common.json#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "sku": { + "$ref": "#/definitions/SqlManagedInstanceSku", + "description": "Resource sku." + } + }, + "required": [ + "properties" + ] + }, + "SqlManagedInstanceSku": { + "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", + "type": "object", + "properties": { + "name": { + "type": "string", + "enum": [ + "vCore" + ], + "description": "The name of the SKU.", + "x-ms-enum": { + "name": "SqlManagedInstanceSkuName", + "modelAsString": false + } + }, + "tier": { + "type": "string", + "enum": [ + "GeneralPurpose", + "BusinessCritical" + ], + "x-ms-enum": { + "name": "SqlManagedInstanceSkuTier", + "modelAsString": false + }, + "default": "GeneralPurpose", + "description": "The pricing tier for the instance." + }, + "dev": { + "type": "boolean", + "default": true, + "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " + }, + "size": { + "type": "string", + "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " + }, + "family": { + "type": "string", + "description": "The SKU family" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity" + } + }, + "required": [ + "name" + ] + }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + }, + "admin": { + "type": "string", + "description": "The instance admin user" + }, + "startTime": { + "type": "string", + "description": "The instance start time" + }, + "endTime": { + "type": "string", + "description": "The instance end time" + }, + "k8sRaw": { + "$ref": "#/definitions/SqlManagedInstanceK8sRaw", + "description": "The raw kubernetes information" + }, + "basicLoginInformation": { + "$ref": "./common.json#/definitions/BasicLoginInformation", + "description": "Username and password for basic authentication." + }, + "lastUploadedDate": { + "type": "string", + "format": "date-time", + "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the Arc-enabled SQL Managed Instance resource." + }, + "activeDirectoryInformation": { + "description": "Active Directory information related to this SQL Managed Instance.", + "$ref": "#/definitions/ActiveDirectoryInformation" + }, + "licenseType": { + "type": "string", + "enum": [ + "BasePrice", + "LicenseIncluded", + "DisasterRecovery" + ], + "x-ms-enum": { + "name": "arcSqlManagedInstanceLicenseType", + "modelAsString": true + }, + "default": "BasePrice", + "description": "The license type to apply for this managed instance." + }, + "clusterId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." + }, + "extensionId": { + "type": "string", + "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." + } + } + }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlManagedInstanceK8sRaw": { + "type": "object", + "description": "The raw kubernetes information.", + "properties": { + "spec": { + "$ref": "#/definitions/SqlManagedInstanceK8sSpec" + } + }, + "additionalProperties": {} + }, + "SqlManagedInstanceK8sSpec": { + "type": "object", + "description": "The kubernetes spec information.", + "properties": { + "scheduling": { + "$ref": "#/definitions/K8sScheduling" + }, + "replicas": { + "type": "integer", + "format": "int32", + "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'." + }, + "security": { + "$ref": "#/definitions/K8sSecurity" + }, + "settings": { + "$ref": "#/definitions/K8sSettings" + } + }, + "additionalProperties": {} + }, + "K8sScheduling": { + "type": "object", + "description": "The kubernetes scheduling information.", + "properties": { + "default": { + "$ref": "#/definitions/K8sSchedulingOptions" + } + }, + "additionalProperties": {} + }, + "K8sSchedulingOptions": { + "type": "object", + "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service", + "properties": { + "resources": { + "$ref": "#/definitions/K8sResourceRequirements" + } + }, + "additionalProperties": {} + }, + "K8sResourceRequirements": { + "type": "object", + "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.", + "properties": { + "requests": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + }, + "limits": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." + } + }, + "additionalProperties": {} + }, + "K8sSecurity": { + "type": "object", + "description": "The kubernetes security information.", + "properties": { + "adminLoginSecret": { + "type": "string", + "description": "Admin login secret key" + }, + "serviceCertificateSecret": { + "type": "string", + "description": "Service certificate secret used" + }, + "activeDirectory": { + "$ref": "#/definitions/K8sActiveDirectory" + }, + "transparentDataEncryption": { + "$ref": "#/definitions/k8stransparentDataEncryption" + } + }, + "additionalProperties": {} + }, + "K8sActiveDirectory": { + "type": "object", + "description": "The kubernetes active directory information.", + "properties": { + "connector": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the connector" + }, + "namespace": { + "type": "string", + "description": "Name space of the connector" + } + } + }, + "accountName": { + "type": "string", + "description": "Account name for AAD" + }, + "keytabSecret": { + "type": "string", + "description": "Keytab secret used to authenticate with Active Directory." + }, + "encryptionTypes": { + "type": "array", + "description": "An array of encryption types", + "items": { + "type": "string" + } + } + } + }, + "k8stransparentDataEncryption": { + "type": "object", + "description": "Transparent data encryption information.", + "properties": { + "mode": { + "type": "string", + "description": "Transparent data encryption mode. Can be Service Managed, Customer managed or disabled" + }, + "protectorSecret": { + "type": "string", + "description": "Protector secret for customer managed Transparent data encryption mode" + } + } + }, + "K8sSettings": { + "type": "object", + "description": "The kubernetes settings information.", + "properties": { + "network": { + "$ref": "#/definitions/K8sNetworkSettings" + } + }, + "additionalProperties": {} + }, + "K8sNetworkSettings": { + "type": "object", + "description": "The kubernetes network settings information.", + "properties": { + "forceencryption": { + "type": "integer", + "format": "int32", + "description": "If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0" + }, + "tlsciphers": { + "type": "string", + "description": "Specifies which ciphers are allowed by SQL Server for TLS" + }, + "tlsprotocols": { + "type": "string", + "description": "A comma-separated list of which TLS protocols are allowed by SQL Server" + } + } + }, + "KeytabInformation": { + "type": "object", + "description": "Keytab used for authenticate with Active Directory.", + "properties": { + "keytab": { + "type": "string", + "description": "A base64-encoded keytab.", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "ActiveDirectoryInformation": { + "type": "object", + "description": "Active Directory information that related to the resource.", + "properties": { + "keytabInformation": { + "description": "Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used.", + "$ref": "#/definitions/KeytabInformation" + } + } + }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json new file mode 100644 index 000000000000..74120bb67ff2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json @@ -0,0 +1,1573 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}": { + "put": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Create", + "description": "Creates or replaces an Arc Sql Server Availability Group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerAvailabilityGroupResource", + "description": "The request body for availability group resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Updated", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server availability group.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Delete", + "description": "Deletes an Arc Sql Server availability group resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified availability group does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a availability group resource": { + "$ref": "./examples/DeleteArcSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_Get", + "description": "Retrieves an Arc Sql Server availability group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server availability group resource.": { + "$ref": "./examples/GetArcSqlServerAvailabilityGroup.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Updates an existing Availability Group.", + "operationId": "SqlServerAvailabilityGroups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "sqlServerAvailabilityGroupUpdate", + "in": "body", + "description": "The requested server availability group resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update an availability group.": { + "$ref": "./examples/UpdateArcSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/getDetailView": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Retrieves detailed properties of the Availability Group.", + "operationId": "SqlServerAvailabilityGroups_DetailView", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the Run-time detailed properties of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "detail view for a server availability group.": { + "$ref": "./examples/ViewArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/failover": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request manual failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_Failover", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group manual failover to this server.": { + "$ref": "./examples/FailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/forceFailoverAllowDataLoss": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request forced failover of the availability group to this server.", + "operationId": "SqlServerAvailabilityGroups_ForceFailoverAllowDataLoss", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully requested forced failover of the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "availability group force failover to this server.": { + "$ref": "./examples/ForceFailoverArcSqlServerAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server availability group", + "operationId": "SqlServerAvailabilityGroups_CreateAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createAgConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create an availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/createDistributedAvailabilityGroup": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Create a SQL Server distributed availability group", + "operationId": "SqlServerAvailabilityGroups_CreateDistributedAvailabilityGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createDagConfiguration", + "in": "body", + "description": "The configuration for the new SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "202": { + "description": "Availability group creation is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a distributed availability group using this server for the primary replica.": { + "$ref": "./examples/CreateSqlServerDistributedAvailabilityGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/addDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request adding database(s) to an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_AddDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to add to the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested adding databases to Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "add databases to this availability group.": { + "$ref": "./examples/AddDatabasesToAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups/{availabilityGroupName}/removeDatabases": { + "post": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "description": "Request removing database(s) from an existing availability group.", + "operationId": "SqlServerAvailabilityGroups_RemoveDatabases", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/availabilityGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "databases", + "in": "body", + "description": "The database names to remove from the SQL Server availability group resource.", + "required": true, + "schema": { + "$ref": "#/definitions/databases" + } + } + ], + "responses": { + "200": { + "description": "Successfully requested removing databases from Availability Group.", + "schema": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "remove databases from this availability group.": { + "$ref": "./examples/RemoveDatabasesFromAvailabilityGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/availabilityGroups": { + "get": { + "tags": [ + "SqlServerAvailabilityGroups" + ], + "operationId": "SqlServerAvailabilityGroups_List", + "summary": "List the availability group associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerAvailabilityGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all availability groups associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceAvailabilityGroup.json" + } + } + } + } + }, + "definitions": { + "AvailabilityGroupConfigure": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the mirroring endpoint URL" + }, + "endpointUrl": { + "type": "string", + "description": "Mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint." + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "availabilityModeDescription": { + "type": "string", + "description": "The Availability Synchronization mode of the availability group replica.", + "readOnly": true + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "failoverModeDescription": { + "type": "string", + "description": "The failover mode of the availability group replica.", + "readOnly": true + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + }, + "primaryAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether the availability allows all connections or only read-write connections.", + "readOnly": true + }, + "secondaryAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleAllowConnectionsDescription": { + "type": "string", + "description": "Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients.", + "readOnly": true + }, + "replicaCreateDate": { + "type": "string", + "description": "Date that the replica was created.", + "format": "date-time", + "readOnly": true + }, + "replicaModifyDate": { + "type": "string", + "description": "Date that the replica was modified.", + "format": "date-time", + "readOnly": true + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "readOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "readWriteRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read write availability replica." + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "seedingModeDescription": { + "type": "string", + "description": "Describes seeding mode.", + "readOnly": true + } + } + }, + "AvailabilityGroupState": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "availabilityGroupReplicaRole": { + "type": "string", + "description": "Current Always On availability groups role of the availability group replica.", + "readOnly": true + }, + "operationalStateDescription": { + "type": "string", + "description": "Current operational state of the availability group replica", + "readOnly": true + }, + "recoveryHealthDescription": { + "type": "string", + "description": "Recovery health of the availability group replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica.", + "readOnly": true + }, + "connectedStateDescription": { + "type": "string", + "description": "Whether a secondary replica is currently connected to the primary replica.", + "readOnly": true + }, + "lastConnectErrorDescription": { + "type": "string", + "description": "Text description of the last connection error of the availability group replica.", + "readOnly": true + }, + "lastConnectErrorTimestamp": { + "type": "string", + "description": "Date and time timestamp indicating when the last connect error occurred.", + "format": "date-time", + "readOnly": true + } + } + }, + "AvailabilityGroupInfo": { + "description": "The specifications of the availability group state", + "type": "object", + "properties": { + "failureConditionLevel": { + "type": "integer", + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "automatedBackupPreferenceDescription": { + "type": "string", + "description": "Preferred location for performing backups on the availability databases in this availability group.", + "readOnly": true + }, + "version": { + "type": "integer", + "description": "SQL Server availability group current version.", + "format": "int32", + "readOnly": true + }, + "basicFeatures": { + "type": "boolean", + "description": "Specifies whether this is a basic availability group." + }, + "dtcSupport": { + "type": "boolean", + "description": "Specifies whether DTC support has been enabled for this availability group." + }, + "dbFailover": { + "type": "boolean", + "description": "Specifies whether the availability group supports failover for database health conditions." + }, + "isDistributed": { + "type": "boolean", + "description": "Specifies whether this is a distributed availability group." + }, + "clusterTypeDescription": { + "type": "string", + "description": "SQL Server availability group cluster type description", + "readOnly": true + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "isContained": { + "type": "boolean", + "description": "SQL Server availability group contained system databases." + }, + "primaryReplica": { + "type": "string", + "description": "Name of the server instance that is hosting the current primary replica.", + "readOnly": true + }, + "primaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of the primary replica.", + "readOnly": true + }, + "secondaryRecoveryHealthDescription": { + "type": "string", + "description": "Indicates the recovery health of a secondary replica.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Reflects a roll-up of the synchronization health of all availability replicas in the availability group.", + "readOnly": true + }, + "replicationPartnerType": { + "type": "string", + "enum": [ + "SQLServer", + "AzureSQLVM", + "AzureSQLManagedInstance", + "Unknown" + ], + "x-ms-enum": { + "name": "replicationPartnerType", + "modelAsString": false + }, + "readOnly": true + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating an availability group", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "replicas": { + "type": "array", + "description": "List of availability group replicas.", + "items": { + "$ref": "#/definitions/AvailabilityGroupCreateUpdateReplicaConfiguration" + }, + "x-ms-identifiers": [ + "serverInstance" + ] + }, + "databases": { + "type": "array", + "description": "List of databases to include in the availability group.", + "items": { + "type": "string" + } + }, + "automatedBackupPreference": { + "type": "string", + "description": "Preferred replica for running automated backups.", + "enum": [ + "PRIMARY", + "SECONDARY_ONLY", + "SECONDARY", + "NONE" + ], + "x-ms-enum": { + "name": "automatedBackupPreference", + "modelAsString": false + } + }, + "failureConditionLevel": { + "type": "integer", + "enum": [ + 1, + 2, + 3, + 4, + 5 + ], + "x-ms-enum": { + "name": "failureConditionLevel", + "modelAsString": false + }, + "description": "User-defined failure condition level under which an automatic failover must be triggered.", + "format": "int32" + }, + "healthCheckTimeout": { + "type": "integer", + "description": "Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding.", + "format": "int32" + }, + "dbFailover": { + "type": "string", + "description": "Specifies whether the availability group supports failover for database health conditions.", + "enum": [ + "ON", + "OFF" + ], + "x-ms-enum": { + "name": "dbFailover", + "modelAsString": false + } + }, + "dtcSupport": { + "type": "string", + "description": "Specifies whether DTC support has been enabled for this availability group.", + "enum": [ + "PER_DB", + "NONE" + ], + "x-ms-enum": { + "name": "dtcSupport", + "modelAsString": false + } + }, + "requiredSynchronizedSecondariesToCommit": { + "type": "integer", + "description": "The number of secondary replicas that must be in a synchronized state for a commit to complete.", + "format": "int32" + }, + "clusterType": { + "type": "string", + "description": "Set to WSFC when availability group is on a failover cluster instance on a Windows Server failover cluster. Set to NONE when availability group not using WSFC for cluster coordination.", + "enum": [ + "WSFC", + "NONE" + ], + "x-ms-enum": { + "name": "clusterType", + "modelAsString": false + } + }, + "listener": { + "description": "The listener for the sql server availability group", + "$ref": "#/definitions/SqlAvailabilityGroupStaticIPListenerProperties" + } + } + }, + "AvailabilityGroupCreateUpdateReplicaConfiguration": { + "description": "The specifications of the availability group replica configuration", + "type": "object", + "properties": { + "serverInstance": { + "type": "string", + "description": "the server instance hosting the replica." + }, + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint URL for the availability group replica" + }, + "endpointUrl": { + "type": "string", + "description": "Database mirroring endpoint URL of availability group replica" + }, + "endpointAuthenticationMode": { + "description": "Permitted authentication modes for the mirroring endpoint.", + "$ref": "./common.json#/definitions/ConnectionAuth" + }, + "certificateName": { + "type": "string", + "description": "Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified." + }, + "endpointConnectLogin": { + "type": "string", + "description": "The login which will connect to the mirroring endpoint" + }, + "availabilityMode": { + "type": "string", + "description": "Property that determines whether a given availability replica can run in synchronous-commit mode", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "Property to set the failover mode of the availability group replica", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "backupPriority": { + "type": "integer", + "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", + "format": "int32" + }, + "secondaryRoleAllowConnections": { + "type": "string", + "description": "Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections.", + "enum": [ + "NO", + "ALL", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "secondaryAllowConnections", + "modelAsString": false + } + }, + "secondaryRoleReadOnlyRoutingUrl": { + "type": "string", + "description": "Connectivity endpoint (URL) of the read only availability replica." + }, + "primaryRoleAllowConnections": { + "type": "string", + "description": "Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections)", + "enum": [ + "ALL", + "READ_WRITE" + ], + "x-ms-enum": { + "name": "primaryAllowConnections", + "modelAsString": false + } + }, + "primaryRoleReadOnlyRoutingList": { + "type": "array", + "description": "List of read only routing URLs.", + "items": { + "type": "string" + } + }, + "sessionTimeout": { + "type": "integer", + "description": "The time-out period of availability group session replica, in seconds.", + "format": "int32" + } + } + }, + "databases": { + "description": "List of database names.", + "type": "object", + "properties": { + "values": { + "description": "List of database names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ArcSqlServerAvailabilityGroupListResult": { + "description": "A list of Arc Sql Server Availability Groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server Availability Groups.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "DistributedAvailabilityGroupCreateUpdateConfiguration": { + "description": "Options used in creating a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroupName": { + "type": "string", + "description": "Name of the availability group." + }, + "primaryAvailabilityGroup": { + "description": "The initial primary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + }, + "secondaryAvailabilityGroup": { + "description": "The initial secondary availability group for the distributed availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupConfiguration": { + "description": "The availability group configuration specification for a distributed availability group.", + "type": "object", + "properties": { + "availabilityGroup": { + "type": "string", + "format": "arm-id", + "description": "The azure resource identifier for the availability group." + }, + "listenerUrl": { + "type": "string", + "format": "uri", + "description": "The listener URL of the availability group." + }, + "availabilityMode": { + "type": "string", + "description": "The availability mode of the availability group.", + "enum": [ + "SYNCHRONOUS_COMMIT", + "ASYNCHRONOUS_COMMIT" + ], + "x-ms-enum": { + "name": "arcSqlServerAvailabilityMode", + "modelAsString": true + } + }, + "failoverMode": { + "type": "string", + "description": "The failover mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "arcSqlServerFailoverMode", + "modelAsString": true + } + }, + "seedingMode": { + "type": "string", + "description": "The seeding mode of the availability group.", + "enum": [ + "AUTOMATIC", + "MANUAL" + ], + "x-ms-enum": { + "name": "seedingMode", + "modelAsString": false + } + }, + "certificateConfiguration": { + "description": "The certificate configuration for the availability group.", + "$ref": "#/definitions/DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration" + } + } + }, + "DistributedAvailabilityGroupCreateUpdateAvailabilityGroupCertificateConfiguration": { + "description": "The availability group certificate configuration.", + "type": "object", + "properties": { + "certificateName": { + "type": "string", + "description": "Name of the certificate." + } + } + }, + "SqlServerAvailabilityGroupResource": { + "type": "object", + "description": "Arc Sql Server Availability Group", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "Properties of Arc Sql Server availability group", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerAvailabilityGroupResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server availability group resource", + "properties": { + "availabilityGroupId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "the SQL server name.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "the SQL Server Instance name.", + "readOnly": true + }, + "collectionTimestamp": { + "description": "Timestamp for when the data was collected from the client machine.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "info": { + "$ref": "#/definitions/AvailabilityGroupInfo", + "description": "Availability Group Info", + "x-ms-client-flatten": false + }, + "replicas": { + "description": "A list of Availability Group Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "databases": { + "description": "A list of Availability Group Database Replicas.", + "type": "object", + "properties": { + "value": { + "description": "Array of Availability Group Database Replicas.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlAvailabilityGroupDatabaseReplicaResourceProperties" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", + "readOnly": true + } + } + }, + "SqlServerAvailabilityGroupUpdate": { + "description": "An update to availability group resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", + "description": "The Server Availability Group's properties", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group replica resource", + "properties": { + "replicaId": { + "type": "string", + "description": "ID GUID of the availability group.", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "replicaName": { + "type": "string", + "description": "the replica name." + }, + "configure": { + "$ref": "#/definitions/AvailabilityGroupConfigure", + "description": "null", + "x-ms-client-flatten": false + }, + "state": { + "$ref": "#/definitions/AvailabilityGroupState", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlAvailabilityGroupDatabaseReplicaResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql availability group database replica resource", + "properties": { + "databaseName": { + "type": "string", + "description": "the database name." + }, + "replicaName": { + "type": "string", + "description": "the database replica name.", + "readOnly": true + }, + "isLocal": { + "type": "boolean", + "description": "Whether the availability database is local.", + "readOnly": true + }, + "isPrimaryReplica": { + "type": "boolean", + "description": "Returns 1 if the replica is primary, or 0 if it is a secondary replica.", + "readOnly": true + }, + "synchronizationStateDescription": { + "type": "string", + "description": "Description of the data-movement state.", + "readOnly": true + }, + "isCommitParticipant": { + "type": "boolean", + "description": "Whether this replica is transaction committer.", + "readOnly": true + }, + "synchronizationHealthDescription": { + "type": "string", + "description": "Description of the health of database.", + "readOnly": true + }, + "databaseStateDescription": { + "type": "string", + "description": "Description of the database state of the availability replica.", + "readOnly": true + }, + "isSuspended": { + "type": "boolean", + "description": "Whether this data movement is suspended.", + "readOnly": true + }, + "suspendReasonDescription": { + "type": "string", + "description": "Description of the database suspended state reason.", + "readOnly": true + } + } + }, + "SqlAvailabilityGroupStaticIPListenerProperties": { + "type": "object", + "description": "The properties of a static IP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "ipV4AddressesAndMasks": { + "$ref": "#/definitions/SqlAvailabilityGroupIpV4AddressesAndMasksProperties", + "description": "IP V4 Addresses and masks for the listener." + }, + "ipV6Addresses": { + "type": "array", + "description": "IP V6 Addresses for the listener", + "items": { + "type": "string" + } + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + }, + "SqlAvailabilityGroupIpV4AddressesAndMasksProperties": { + "type": "array", + "description": "Address and netmask information for an IPv4 AG listener.", + "items": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "description": "IPV4 address" + }, + "mask": { + "type": "string", + "description": "IPV4 netmask" + } + } + }, + "x-ms-identifiers": [ + "ipAddress" + ] + }, + "SqlAvailabilityGroupDhcpListenerProperties": { + "type": "object", + "description": "The properties of a DHCP Arc Sql availability group listener", + "properties": { + "dnsName": { + "type": "string", + "description": "the DNS name for the listener." + }, + "subnet": { + "type": "string", + "description": "The IPV4 subnet for the listener." + }, + "mask": { + "type": "string", + "description": "The netmask for the listener." + }, + "port": { + "type": "integer", + "description": "Network port for the listener. Default is 1433.", + "format": "int32" + } + } + } + }, + "parameters": { + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "availabilityGroupName": { + "name": "availabilityGroupName", + "description": "Name of SQL Availability Group", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json new file mode 100644 index 000000000000..7da3f90ec544 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json @@ -0,0 +1,680 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}": { + "put": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Create", + "description": "Creates or replaces an Arc Sql Server Database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlServerDatabaseResource", + "description": "The request body for database resource.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a Arc Sql Server database.": { + "$ref": "./examples/CreateOrUpdateArcSqlServerDatabase.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Delete", + "description": "Deletes an Arc Sql Server database resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "202": { + "description": "Resource deletion is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deletes a database resource": { + "$ref": "./examples/DeleteArcSqlServerDatabase.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_Get", + "description": "Retrieves an Arc Sql Server database.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Retrieves an Arc Sql Server database resource.": { + "$ref": "./examples/GetArcSqlServerDatabase.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerDatabases" + ], + "description": "Updates an existing database.", + "operationId": "SqlServerDatabases_Update", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/databaseName" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "name": "sqlServerDatabaseUpdate", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerDatabaseUpdate" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/SqlServerDatabaseResource" + } + }, + "202": { + "description": "Resource update is in progress.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + } + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a database.": { + "$ref": "./examples/UpdateSqlServerDatabase.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases": { + "get": { + "tags": [ + "SqlServerDatabases" + ], + "operationId": "SqlServerDatabases_List", + "summary": "List the databases associated with the given Arc Sql Server.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/sqlServerInstanceName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSqlServerDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all databases associated with an Arc Enabled Sql server.": { + "$ref": "./examples/ListBySqlServerInstanceDatabase.json" + } + } + } + } + }, + "definitions": { + "ArcSqlServerDatabaseListResult": { + "description": "A list of Arc Sql Server database.", + "type": "object", + "properties": { + "value": { + "description": "Array of Arc Sql Server database.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerDatabaseResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "SqlServerDatabaseResource": { + "type": "object", + "description": "Arc Sql Server database", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "Properties of Arc Sql Server database", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerDatabaseResourceProperties": { + "type": "object", + "description": "The properties of Arc Sql Server database resource", + "properties": { + "collationName": { + "description": "Collation of the database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "databaseCreationDate": { + "format": "date-time", + "description": "Creation date of the database.", + "type": "string" + }, + "compatibilityLevel": { + "type": "integer", + "minimum": 80, + "maximum": 200, + "format": "int32", + "description": "Compatibility level of the database" + }, + "sizeMB": { + "type": "number", + "format": "float", + "description": "Size of the database." + }, + "spaceAvailableMB": { + "type": "number", + "format": "float", + "description": "Space left of the database." + }, + "state": { + "description": "State of the database.", + "enum": [ + "Online", + "Restoring", + "Recovering", + "RecoveryPending", + "Suspect", + "Emergency", + "Offline", + "Copying", + "OfflineSecondary" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseState", + "modelAsString": true + } + }, + "isReadOnly": { + "type": "boolean", + "description": "Whether the database is read only or not." + }, + "recoveryMode": { + "description": "Status of the database.", + "enum": [ + "Full", + "Bulk-logged", + "Simple" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryMode", + "modelAsString": true + } + }, + "databaseOptions": { + "type": "object", + "description": "List of features that are enabled for the database", + "properties": { + "isAutoCloseOn": { + "type": "boolean" + }, + "isAutoShrinkOn": { + "type": "boolean" + }, + "isAutoCreateStatsOn": { + "type": "boolean" + }, + "isAutoUpdateStatsOn": { + "type": "boolean" + }, + "isRemoteDataArchiveEnabled": { + "type": "boolean" + }, + "isMemoryOptimizationEnabled": { + "type": "boolean" + }, + "isEncrypted": { + "type": "boolean" + }, + "isTrustworthyOn": { + "type": "boolean" + } + } + }, + "backupInformation": { + "type": "object", + "properties": { + "lastFullBackup": { + "format": "date-time", + "description": "Date time of last full backup.", + "type": "string" + }, + "lastLogBackup": { + "format": "date-time", + "description": "Date time of last log backup.", + "type": "string" + } + } + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "earliestRestoreDate": { + "format": "date-time", + "description": "This records the earliest start date and time that restore is available for this database (ISO8601 format).", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "DatabaseCreateMode", + "modelAsString": true + } + }, + "sourceDatabaseId": { + "description": "The name of the source database associated with create operation of this database.", + "type": "string", + "format": "arm-id" + }, + "restorePointInTime": { + "format": "date-time", + "description": "Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server database resource.", + "readOnly": true + }, + "lastDatabaseUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful database upload was performed.", + "readOnly": true + }, + "migration": { + "$ref": "#/definitions/DataBaseMigration" + } + } + }, + "DataBaseMigration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/DataBaseMigrationAssessment" + } + } + }, + "DataBaseMigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "databaseAssessments": { + "$ref": "#/definitions/DatabaseAssessments" + }, + "targetReadiness": { + "$ref": "#/definitions/TargetReadiness" + } + } + }, + "DatabaseAssessments": { + "description": "Issues and warnings impacting the migration of Database to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "TargetReadiness": { + "description": "The target readiness for migration for this database.", + "type": "object", + "readOnly": true, + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationSummary" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationSummary" + } + } + }, + "SkuRecommendationSummary": { + "description": "The SKU recommendation summary.", + "type": "object", + "properties": { + "numOfBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfBlockerIssues" + }, + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + } + } + }, + "SkuRecommendationResultsNumberOfBlockerIssues": { + "description": "Number of blocker issues to fix before migrating this database to the target platform.", + "type": "integer", + "format": "int32" + }, + "SqlServerDatabaseUpdate": { + "description": "An update to database resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerDatabaseResourceProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": false + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Azure subscription", + "x-ms-parameter-location": "client" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure resource group", + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + }, + "sqlServerInstanceName": { + "name": "sqlServerInstanceName", + "description": "Name of SQL Server Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "databaseName": { + "name": "databaseName", + "description": "Name of the database", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json new file mode 100644 index 000000000000..61ac6e8af6e2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json @@ -0,0 +1,545 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_List", + "summary": "List sqlServerEsuLicense resources in the subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_ListByResourceGroup", + "description": "Gets all sqlServerEsuLicenses in a resource group.", + "summary": "List sqlServerEsuLicense resources in the resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Server ESU licenses in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlServerEsuLicense.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerEsuLicenses/{sqlServerEsuLicenseName}": { + "get": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Get", + "description": "Retrieves a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a SQL Server ESU license.": { + "$ref": "./examples/GetSqlServerEsuLicense.json" + } + } + }, + "put": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Create", + "description": "Creates or replaces a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "sqlServerEsuLicense", + "in": "body", + "description": "The SQL Server ESU license to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Updates a SQL Server ESU license.": { + "$ref": "./examples/CreateOrUpdateSqlServerEsuLicense.json" + } + } + }, + "delete": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Delete", + "description": "Deletes a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Server ESU license." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "204": { + "description": "The specified SQL Server ESU license does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Server ESU license.": { + "$ref": "./examples/DeleteSqlServerEsuLicense.json" + } + } + }, + "patch": { + "tags": [ + "SqlServerEsuLicenses" + ], + "operationId": "SqlServerEsuLicenses_Update", + "description": "Updates a SQL Server ESU license resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/sqlServerEsuLicenseName" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Server ESU license.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlServerEsuLicense" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch a SQL Server ESU license.": { + "$ref": "./examples/UpdateSqlServerEsuLicense.json" + } + } + } + } + }, + "definitions": { + "SqlServerEsuLicense": { + "description": "Describe SQL Server ESU license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseProperties", + "description": "SQL Server ESU license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerEsuLicenseProperties": { + "description": "Properties of SQL Server ESU license.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "version", + "physicalCores", + "scopeType", + "activationState" + ] + }, + "SqlServerEsuLicenseUpdateProperties": { + "description": "Properties of update SqlServerEsuLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server ESU license type.", + "enum": [ + "PAYG" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The SQL Server version the license covers.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014" + ], + "x-ms-enum": { + "name": "version", + "modelAsString": true + } + }, + "uniqueId": { + "type": "string", + "description": "The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$", + "readOnly": true + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Inactive", + "Active", + "Terminated" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "activatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "terminatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server ESU license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerEsuLicenseUpdate": { + "description": "An update to a SQL Server ESU license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerEsuLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerEsuLicenseListResult": { + "description": "A list of SQL Server ESU licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerEsuLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "sqlServerEsuLicenseName": { + "name": "sqlServerEsuLicenseName", + "description": "Name of SQL Server ESU License", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json new file mode 100644 index 000000000000..07fc363b51a2 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json @@ -0,0 +1,1367 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerInstance": { + "description": "A SqlServerInstance.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerInstanceProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceProperties": { + "description": "Properties of SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "databaseMirroringEndpoint": { + "description": "Database mirroring endpoint related properties.", + "$ref": "#/definitions/DBMEndpoint" + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "SqlServerInstanceUpdateProperties": { + "description": "Properties of update SqlServerInstance.", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "SQL Server version.", + "enum": [ + "SQL Server 2012", + "SQL Server 2014", + "SQL Server 2016", + "SQL Server 2017", + "SQL Server 2019", + "SQL Server 2022", + "Unknown" + ], + "x-ms-enum": { + "name": "sqlVersion", + "modelAsString": true + } + }, + "edition": { + "type": "string", + "description": "SQL Server edition.", + "enum": [ + "Evaluation", + "Enterprise", + "Standard", + "Web", + "Developer", + "Express", + "Business Intelligence" + ], + "x-ms-enum": { + "name": "editionType", + "modelAsString": true + } + }, + "containerResourceId": { + "type": "string", + "description": "ARM Resource id of the container resource (Azure Arc for Servers).", + "readOnly": true + }, + "createTime": { + "type": "string", + "description": "The time when the resource was created.", + "readOnly": true + }, + "vCore": { + "type": "string", + "description": "The number of logical processors used by the SQL Server instance.", + "readOnly": true + }, + "cores": { + "type": "string", + "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." + }, + "status": { + "type": "string", + "description": "The cloud connectivity status.", + "readOnly": true, + "enum": [ + "Connected", + "Disconnected", + "Registered", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "patchLevel": { + "type": "string", + "description": "SQL Server update level.", + "readOnly": true + }, + "collation": { + "type": "string", + "description": "SQL Server collation.", + "readOnly": true + }, + "dbMasterKeyExists": { + "type": "boolean", + "description": "Indicates whether database master key exists in SQL Server.", + "readOnly": true + }, + "isHadrEnabled": { + "type": "boolean", + "description": "Indicates whether always On availability groups is enabled in SQL Server.", + "readOnly": true + }, + "traceFlags": { + "type": "array", + "description": "An array of integers, where each value represents the enabled trace flags in SQL Server.", + "items": { + "type": "integer", + "format": "int32" + }, + "readOnly": true + }, + "currentVersion": { + "type": "string", + "description": "SQL Server current version.", + "readOnly": true + }, + "instanceName": { + "type": "string", + "description": "SQL Server instance name." + }, + "tcpDynamicPorts": { + "type": "string", + "description": "Dynamic TCP ports used by SQL Server.", + "readOnly": true + }, + "tcpStaticPorts": { + "type": "string", + "description": "Static TCP ports used by SQL Server.", + "readOnly": true + }, + "productId": { + "type": "string", + "description": "SQL Server product ID.", + "readOnly": true + }, + "licenseType": { + "type": "string", + "description": "SQL Server license type.", + "readOnly": true, + "enum": [ + "Undefined", + "Free", + "HADR", + "ServerCAL", + "LicenseOnly", + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "arcSqlServerLicenseType", + "modelAsString": true + } + }, + "azureDefenderStatusLastUpdated": { + "type": "string", + "format": "date-time", + "description": "Timestamp of last Azure Defender status update.", + "readOnly": true + }, + "azureDefenderStatus": { + "type": "string", + "description": "Status of Azure Defender.", + "readOnly": true, + "enum": [ + "Protected", + "Unprotected", + "Unknown" + ], + "x-ms-enum": { + "name": "defenderStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Arc-enabled SQL Server resource.", + "readOnly": true + }, + "lastInventoryUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful inventory upload was performed.", + "readOnly": true + }, + "lastUsageUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when last successful usage upload was performed.", + "readOnly": true + }, + "hostType": { + "type": "string", + "description": "Type of host for Azure Arc SQL Server", + "enum": [ + "Azure Virtual Machine", + "Azure VMWare Virtual Machine", + "Azure Kubernetes Service", + "AWS VMWare Virtual Machine", + "AWS Kubernetes Service", + "GCP VMWare Virtual Machine", + "GCP Kubernetes Service", + "Container", + "Virtual Machine", + "Physical Server", + "AWS Virtual Machine", + "GCP Virtual Machine", + "Other" + ], + "x-ms-enum": { + "name": "hostType", + "modelAsString": true + } + }, + "alwaysOnRole": { + "type": "string", + "description": "The role of the SQL Server, based on availability.", + "readOnly": true, + "enum": [ + "None", + "FailoverClusterInstance", + "FailoverClusterNode", + "AvailabilityGroupReplica" + ], + "x-ms-enum": { + "name": "alwaysOnRole", + "modelAsString": true + } + }, + "failoverCluster": { + "description": "Failover Cluster Instance properties.", + "$ref": "#/definitions/FailoverCluster" + }, + "backupPolicy": { + "description": "The backup profile for the SQL server.", + "$ref": "#/definitions/BackupPolicy" + }, + "upgradeLockedUntil": { + "description": "Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty.", + "type": "string", + "format": "date-time" + }, + "monitoring": { + "description": "The monitoring configuration.", + "$ref": "#/definitions/Monitoring" + }, + "migration": { + "description": "Migration related configuration.", + "$ref": "#/definitions/Migration" + }, + "clientConnection": { + "description": "Client connection related configuration.", + "$ref": "#/definitions/ClientConnection" + }, + "serviceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "$ref": "#/definitions/ServiceType" + } + } + }, + "DBMEndpoint": { + "type": "object", + "description": "Database mirroring endpoint related properties.", + "properties": { + "endpointName": { + "type": "string", + "description": "Name of the database mirroring endpoint.", + "readOnly": true + }, + "role": { + "type": "string", + "description": "Mirroring Role", + "readOnly": true, + "enum": [ + "NONE", + "PARTNER", + "WITNESS", + "ALL" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true + } + }, + "isEncryptionEnabled": { + "type": "boolean", + "description": "Is Encryption enabled", + "readOnly": true + }, + "encryptionAlgorithm": { + "description": "Encryption Algorithm", + "$ref": "./common.json#/definitions/EncryptionAlgorithm", + "readOnly": true + }, + "connectionAuth": { + "description": "The type of connection authentication required for connections to this endpoint", + "$ref": "./common.json#/definitions/ConnectionAuth", + "readOnly": true + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number that the endpoint is listening on.", + "readOnly": true + }, + "isDynamicPort": { + "type": "boolean", + "description": "Is the port number dynamically assigned.", + "readOnly": true + }, + "ipAddress": { + "type": "string", + "description": "Listener IP address.", + "readOnly": true + }, + "certificateName": { + "type": "string", + "description": "Name of the certificate.", + "readOnly": true + } + } + }, + "FailoverCluster": { + "type": "object", + "description": "Failover Cluster Instance properties.", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the SQL Server's underlying Failover Cluster.", + "readOnly": true + }, + "networkName": { + "type": "string", + "description": "The network name to connect to the SQL FCI.", + "readOnly": true + }, + "sqlInstanceIds": { + "type": "array", + "description": "The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "hostNames": { + "type": "array", + "description": "The host names which are part of the SQL FCI resource group.", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "SqlServerInstanceUpdate": { + "description": "An update to a SQL Server Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerInstanceUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerInstanceListResult": { + "description": "A list of SqlServerInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BackupPolicy": { + "description": "The backup profile for the SQL server.", + "type": "object", + "properties": { + "retentionPeriodDays": { + "type": "integer", + "description": "The retention period for all the databases in this managed instance.", + "minimum": 0, + "maximum": 35, + "format": "int32" + }, + "fullBackupDays": { + "type": "integer", + "description": "The value indicating days between full backups.", + "minimum": 0, + "maximum": 7, + "format": "int32" + }, + "differentialBackupHours": { + "description": "The differential backup interval in hours.", + "enum": [ + 12, + 24 + ], + "type": "integer", + "format": "int32", + "x-ms-enum": { + "name": "differentialBackupHours", + "modelAsString": false + } + }, + "transactionLogBackupMinutes": { + "type": "integer", + "description": "The value indicating minutes between transaction log backups.", + "minimum": 0, + "maximum": 60, + "format": "int32" + } + } + }, + "Monitoring": { + "description": "The monitoring configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if monitoring is enabled for this SQL Server instance." + } + } + }, + "Migration": { + "description": "Migration related configuration.", + "type": "object", + "properties": { + "assessment": { + "description": "Migration assessments related configuration.", + "$ref": "#/definitions/MigrationAssessment" + } + } + }, + "MigrationAssessment": { + "description": "The migration assessment related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if migration assessment is enabled for this SQL Server instance." + }, + "assessmentUploadTime": { + "type": "string", + "format": "date-time", + "description": "The time when Migration Assessment Report upload was last performed.", + "readOnly": true + }, + "serverAssessments": { + "$ref": "#/definitions/ServerAssessments" + }, + "skuRecommendationResults": { + "$ref": "#/definitions/SkuRecommendationResults" + } + } + }, + "ClientConnection": { + "description": "Client connection related configuration.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates if client connection is enabled for this SQL Server instance." + } + } + }, + "ServiceType": { + "description": "Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host.", + "type": "string", + "enum": [ + "Engine", + "SSRS", + "SSAS", + "SSIS", + "PBIRS" + ], + "x-ms-enum": { + "name": "serviceType", + "modelAsString": true, + "values": [ + { + "value": "Engine", + "description": "SQL Server Database Services." + }, + { + "value": "SSRS", + "description": "SQL Server Reporting Services." + }, + { + "value": "SSAS", + "description": "SQL Server Analysis Services." + }, + { + "value": "SSIS", + "description": "SQL Server Integration Services." + }, + { + "value": "PBIRS", + "description": "Power BI Report Server." + } + ] + } + }, + "ServerAssessments": { + "description": "Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target.", + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "properties": { + "appliesToMigrationTargetPlatform": { + "type": "string" + }, + "featureId": { + "type": "string" + }, + "impactedObjects": { + "type": "array", + "items": { + "type": "object", + "properties": { + "impactDetail": { + "type": "string" + }, + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + } + } + }, + "issueCategory": { + "type": "string" + }, + "moreInformation": { + "type": "string" + } + } + } + }, + "SkuRecommendationResults": { + "description": "SKU Recommendation results for Azure migration targets for SQL Server.", + "readOnly": true, + "type": "object", + "properties": { + "azureSqlDatabase": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlDatabase" + }, + "azureSqlManagedInstance": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlManagedInstance" + }, + "azureSqlVirtualMachine": { + "$ref": "#/definitions/SkuRecommendationResultsAzureSqlVirtualMachine" + } + } + }, + "SkuRecommendationResultsAzureSqlDatabase": { + "description": "SKU Recommendation results for Azure SQL Database.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlManagedInstance": { + "description": "SKU Recommendation results for Azure SQL Managed Instance.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "computeTier": { + "type": "string", + "description": "The compute tier of the target SKU." + }, + "hardwareType": { + "type": "string", + "description": "The hardware type of the target SKU." + }, + "sqlPurchasingModel": { + "type": "string", + "description": "The SQL purchasing model of the target SKU." + }, + "sqlServiceTier": { + "type": "string", + "description": "The SQL service tier of the target SKU." + }, + "zoneRedundancyAvailable": { + "type": "boolean", + "description": "Indicates if zone redundancy is available for the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsAzureSqlVirtualMachine": { + "description": "SKU Recommendation results for Azure SQL Virtual Machine.", + "type": "object", + "properties": { + "recommendationStatus": { + "$ref": "./common.json#/definitions/SkuRecommendationResultsRecommendationStatus" + }, + "numberOfServerBlockerIssues": { + "$ref": "#/definitions/SkuRecommendationResultsNumberOfServerBlockerIssues" + }, + "monthlyCost": { + "$ref": "#/definitions/SkuRecommendationResultsMonthlyCost" + }, + "targetSku": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "availableVmSkus": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Available VM SKUs for the Azure SQL Virtual Machine." + }, + "virtualMachineFamily": { + "type": "string", + "description": "The virtual machine family of the target SKU." + } + } + } + } + } + } + }, + "SkuRecommendationResultsNumberOfServerBlockerIssues": { + "description": "Number of blocker issues to fix before migrating to the target platform.", + "type": "integer", + "format": "int32" + }, + "SkuRecommendationResultsMonthlyCost": { + "description": "The Monthly cost of the particular SKU.", + "type": "object", + "properties": { + "computeCost": { + "format": "float", + "description": "Represents the Cost of Compute.", + "type": "number" + }, + "storageCost": { + "format": "float", + "description": "Represents the Cost of Storage.", + "type": "number" + }, + "totalCost": { + "format": "float", + "description": "Represents the Total Cost.", + "type": "number" + } + } + }, + "SqlServerInstanceTelemetryRequest": { + "description": "The Arc SQL Server instance telemetry retrieval request.", + "type": "object", + "properties": { + "datasetName": { + "type": "string", + "description": "The name of the telemetry dataset to retrieve." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the time range to fetch telemetry for. If not specified, the current time minus 1 hour is used." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the time range to fetch telemetry for. If not specified, the current time is used." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The time granularity to fetch telemetry for. This is an ISO8601 duration. Examples: PT15M, PT1H, P1D", + "default": "PT1H" + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type to use for the numerical columns in the dataset.", + "enum": [ + "Average", + "Minimum", + "Maximum", + "Sum", + "Count" + ], + "x-ms-enum": { + "name": "aggregationType", + "modelAsString": true + }, + "default": "Average" + }, + "databaseNames": { + "type": "array", + "description": "The list of database names to return telemetry for. If not specified, telemetry for all databases will be aggregated and returned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "datasetName" + ] + }, + "SqlServerInstanceTelemetryColumn": { + "description": "The telemetry column for the SQL Server instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the telemetry column." + }, + "type": { + "type": "string", + "description": "The type of the telemetry column.", + "enum": [ + "bool", + "datetime", + "int", + "long", + "double", + "string", + "guid", + "timespan" + ], + "x-ms-enum": { + "name": "SqlServerInstanceTelemetryColumnType", + "modelAsString": true + } + } + } + }, + "SqlServerInstanceTelemetryRow": { + "description": "An array of values representing a telemetry row for the SQL Server instance.", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "SqlServerInstanceTelemetryResponse": { + "description": "A section of the telemetry response for the SQL Server instance.", + "type": "object", + "properties": { + "columns": { + "description": "The columns of the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "A list of rows from the result telemetry table for the SQL Server instance.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerInstanceTelemetryRow" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link to the next section of rows of the telemetry response for the SQL Server instance. Null if no more sections are available.", + "readOnly": true + } + }, + "required": [ + "columns", + "rows" + ] + }, + "SqlServerInstanceRunMigrationAssessmentResponse": { + "description": "The response for running migration assessment on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "SqlServerInstanceJobsStatusRequest": { + "description": "The request for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "featureName": { + "type": "string", + "description": "The name of the feature to retrieve the job status for." + }, + "jobType": { + "type": "string", + "description": "The type of the job to retrieve the status for." + } + } + }, + "SqlServerInstanceJobsStatusResponse": { + "description": "The response for the status of the jobs running on the SQL Server instance.", + "type": "object", + "properties": { + "jobsStatus": { + "type": "array", + "description": "The list of jobs status running on the SQL Server instance.", + "items": { + "$ref": "#/definitions/SqlServerInstanceJobStatus" + }, + "x-ms-identifiers": [ + "id" + ] + } + } + }, + "SqlServerInstanceJobStatus": { + "description": "The status of the job running on the SQL Server instance.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the job." + }, + "instanceName": { + "type": "string", + "description": "The name of the SQL Server instance." + }, + "jobStatus": { + "type": "string", + "description": "The status of the job.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "jobStatus", + "modelAsString": true + } + }, + "jobException": { + "type": "string", + "description": "The exception message if the job failed." + }, + "backgroundJob": { + "type": "object", + "description": "The background job details.", + "$ref": "#/definitions/BackgroundJob" + }, + "sequencerActions": { + "type": "array", + "description": "The list of sequencer actions.", + "items": { + "$ref": "#/definitions/SequencerAction" + }, + "x-ms-identifiers": [ + "actionId" + ] + } + } + }, + "BackgroundJob": { + "description": "The background job details.", + "type": "object", + "properties": { + "state": { + "type": "string", + "description": "The state of the background job.", + "enum": [ + "Enabled", + "Disabled", + "Deleted", + "Completed", + "Faulted", + "Suspended" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "executionState": { + "type": "string", + "description": "The execution state of the background job.", + "enum": [ + "Waiting", + "Running" + ], + "x-ms-enum": { + "name": "executionState", + "modelAsString": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the background job." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the background job." + }, + "lastExecutionStatus": { + "type": "string", + "description": "The last execution status of the background job.", + "enum": [ + "Succeeded", + "Completed", + "Failed", + "Faulted", + "Postponed", + "Rescheduled" + ], + "x-ms-enum": { + "name": "lastExecutionStatus", + "modelAsString": true + } + }, + "lastExecutionTime": { + "type": "string", + "format": "date-time", + "description": "The last execution time of the background job." + } + } + }, + "SequencerAction": { + "description": "The sequencer action details.", + "type": "object", + "properties": { + "actionId": { + "type": "string", + "description": "The unique identifier of the sequencer action." + }, + "state": { + "type": "string", + "description": "The state of the sequencer action.", + "enum": [ + "NotStarted", + "WaitingPredecessors", + "ExecutingAction", + "CreatingSuccessors", + "Completed" + ], + "x-ms-enum": { + "name": "sequencerState", + "modelAsString": true + } + }, + "result": { + "type": "string", + "description": "The result of the sequencer action.", + "enum": [ + "NotCompleted", + "Succeeded", + "Failed", + "TimedOut", + "Skipped" + ], + "x-ms-enum": { + "name": "result", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json new file mode 100644 index 000000000000..a54c9f98d397 --- /dev/null +++ b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json @@ -0,0 +1,259 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-05-01-preview", + "title": "AzureArcDataManagementClient", + "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." + }, + "paths": {}, + "definitions": { + "SqlServerLicense": { + "description": "Describe SQL Server license resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlServerLicenseProperties", + "description": "SQL Server license properties", + "x-ms-client-flatten": false + } + }, + "required": [ + "properties" + ] + }, + "SqlServerLicenseProperties": { + "description": "Properties of SQL Server License.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + }, + "required": [ + "billingPlan", + "physicalCores", + "licenseCategory", + "scopeType", + "activationState" + ] + }, + "SqlServerLicenseUpdateProperties": { + "description": "Properties of update SqlServerLicense.", + "type": "object", + "properties": { + "billingPlan": { + "type": "string", + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "Paid" + ], + "x-ms-enum": { + "name": "billingPlan", + "modelAsString": true + } + }, + "physicalCores": { + "type": "integer", + "format": "int32", + "multipleOf": 2, + "minimum": 16, + "description": "The number of total cores of the license covers." + }, + "licenseCategory": { + "type": "string", + "description": "This property represents the choice between SQL Server Core and ESU licenses.", + "enum": [ + "Core" + ], + "x-ms-enum": { + "name": "licenseCategory", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "activationState": { + "type": "string", + "description": "The activation state of the license.", + "enum": [ + "Activated", + "Deactivated" + ], + "x-ms-enum": { + "name": "activationState", + "modelAsString": true + } + }, + "scopeType": { + "type": "string", + "description": "The Azure scope to which the license will apply.", + "enum": [ + "Tenant", + "Subscription", + "ResourceGroup" + ], + "x-ms-enum": { + "name": "scopeType", + "modelAsString": true + } + }, + "lastActivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent activation of the SqlServerLicense.", + "readOnly": true + }, + "lastDeactivatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the most recent deactivation of the SqlServerLicense.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenantId the SQL Server license resource subscription resides in.", + "readOnly": true + } + } + }, + "SqlServerLicenseUpdate": { + "description": "An update to a SQL Server license resource.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/SqlServerLicenseUpdateProperties", + "description": "null", + "x-ms-client-flatten": false + } + } + }, + "SqlServerLicenseListResult": { + "description": "A list of SQL Server licenses.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlServerLicense" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the request", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azurearcdata/resource-manager/readme.md b/specification/azurearcdata/resource-manager/readme.md index a8737cff2a94..f422b91b3609 100644 --- a/specification/azurearcdata/resource-manager/readme.md +++ b/specification/azurearcdata/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the azurearcdata. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-01 +tag: package-preview-2024-05 ``` ``` yaml @@ -44,6 +44,27 @@ directive: reason: No Unicode support for attribute pattern regex on sqlServerInstanceName and others. This should be fixed by tooling. ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.AzureArcData/preview/2024-05-01-preview/activeDirectoryConnectors.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/azurearcdata.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/common.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/dataControllers.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/failoverGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/operations.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/postgresInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlManagedInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerAvailabilityGroups.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerDatabases.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerEsuLicenses.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerInstances.json + - Microsoft.AzureArcData/preview/2024-05-01-preview/sqlServerLicenses.json +``` + ### Tag: package-2024-01 These settings apply only when `--tag=package-2024-01` is specified on the command line. From ad60d7f8eba124edc6999677c55aba2184e303b0 Mon Sep 17 00:00:00 2001 From: Sneha Nagendra <47864291+snehanagendra@users.noreply.github.com> Date: Mon, 30 Sep 2024 16:26:42 -0700 Subject: [PATCH 020/101] Add 2024-10-01-preview dataplane API version to the DevCenter (#30696) * Add base 2024-10-01-preview typespec changes, examples * Add SopOnNoConnect configuration for pool resource * Add LRO for capture snapshot, snapshot type enum * Add lastConnectedTime property on devbox * update comment per feedback --------- Co-authored-by: Sneha Nagendra <snnagen@microsoft.com> --- .../devcenter/DevCenter/DevBox/models.tsp | 66 + .../devcenter/DevCenter/DevBox/routes.tsp | 11 + .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../DevBoxes_CreateDevBox.json | 74 + .../DevBoxes_DelayAction.json | 29 + .../DevBoxes_DelayActions.json | 51 + .../DevBoxes_DelayActionsWithError.json | 43 + .../DevBoxes_DeleteDevBox.json | 26 + .../DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../DevBoxes_GetDevBoxByUser.json | 41 + .../DevBoxes_GetImagingTaskLog.json | 15 + .../DevBoxes_GetOperation.json | 25 + .../2024-10-01-preview/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../DevBoxes_GetScheduleByPool.json | 25 + .../DevBoxes_GetSnapshot.json | 21 + .../DevBoxes_ListActions.json | 42 + .../DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...s_ListCustomizationGroupsWithoutTasks.json | 32 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../DevBoxes_ListDevBoxesByUser.json | 44 + .../DevBoxes_ListOperations.json | 42 + .../DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../DevBoxes_ListSnapshots.json | 30 + .../DevBoxes_RepairDevBox.json | 25 + .../DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../DevBoxes_SkipAction.json | 15 + .../DevBoxes_StartDevBox.json | 25 + .../DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + ...teCustomizationTasksActionWithFailure.json | 53 + .../DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../Environments_GetAction.json | 26 + .../Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../Environments_GetOperation.json | 29 + .../Environments_GetOutputs.json | 51 + .../Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../Environments_SkipAction.json | 21 + .../OperationStatuses_Get.json | 19 + specification/devcenter/DevCenter/main.tsp | 4 + .../preview/2024-10-01-preview/devcenter.json | 7219 +++++++++++++++++ .../DevBoxes_CaptureSnapshotDevBox.json | 25 + .../DevBoxes_CreateCustomizationGroup.json | 57 + .../examples/DevBoxes_CreateDevBox.json | 74 + .../examples/DevBoxes_DelayAction.json | 29 + .../examples/DevBoxes_DelayActions.json | 51 + .../examples/DevBoxes_DeleteDevBox.json | 26 + .../examples/DevBoxes_GetAction.json | 27 + .../DevBoxes_GetCustomizationGroup.json | 44 + ...Boxes_GetCustomizationTaskDefinitions.json | 36 + .../DevBoxes_GetCustomizationTaskLog.json | 18 + .../examples/DevBoxes_GetDevBoxByUser.json | 41 + .../examples/DevBoxes_GetImagingTaskLog.json | 15 + .../examples/DevBoxes_GetOperation.json | 25 + .../examples/DevBoxes_GetPool.json | 45 + .../DevBoxes_GetRemoteConnection.json | 18 + .../examples/DevBoxes_GetScheduleByPool.json | 25 + .../examples/DevBoxes_GetSnapshot.json | 21 + .../examples/DevBoxes_ListActions.json | 42 + .../examples/DevBoxes_ListAllDevBoxes.json | 42 + .../DevBoxes_ListAllDevBoxesByUser.json | 44 + .../DevBoxes_ListCustomizationGroups.json | 68 + ...CustomizationTaskDefinitionsByProject.json | 53 + .../examples/DevBoxes_ListDevBoxesByUser.json | 44 + .../examples/DevBoxes_ListOperations.json | 42 + .../examples/DevBoxes_ListPools.json | 79 + .../DevBoxes_ListSchedulesByPool.json | 28 + .../DevBoxes_ListSchedulesByProject.json | 27 + .../examples/DevBoxes_ListSnapshots.json | 30 + .../examples/DevBoxes_RepairDevBox.json | 25 + .../examples/DevBoxes_RestartDevBox.json | 25 + .../DevBoxes_RestoreSnapshotDevBox.json | 26 + .../examples/DevBoxes_SkipAction.json | 15 + .../examples/DevBoxes_StartDevBox.json | 25 + .../examples/DevBoxes_StopDevBox.json | 26 + ...oxes_ValidateCustomizationTasksAction.json | 40 + .../examples/DevCenter_GetProject.json | 19 + .../DevCenter_GetProjectAbilities.json | 37 + .../examples/DevCenter_ListProjects.json | 22 + ...vironments_CreateOrReplaceEnvironment.json | 43 + .../examples/Environments_DelayAction.json | 27 + .../Environments_DeleteEnvironment.json | 26 + .../Environments_ForceDeleteEnvironment.json | 27 + .../examples/Environments_GetAction.json | 26 + .../examples/Environments_GetCatalog.json | 18 + .../Environments_GetEnvironmentByUser.json | 30 + ...Environments_GetEnvironmentDefinition.json | 58 + ...ironments_GetEnvironmentTypeAbilities.json | 28 + .../Environments_GetEnvironmentTypes.json | 21 + .../Environments_GetLogsByOperation.json | 17 + .../examples/Environments_GetOperation.json | 29 + .../examples/Environments_GetOutputs.json | 51 + .../examples/Environments_ListActions.json | 39 + .../Environments_ListCatalogsByProject.json | 21 + ...s_ListEnvironmentDefinitionsByCatalog.json | 69 + ...s_ListEnvironmentDefinitionsByProject.json | 68 + .../Environments_ListEnvironmentTypes.json | 24 + .../Environments_ListEnvironments.json | 32 + .../Environments_ListEnvironmentsByUser.json | 33 + .../examples/Environments_ListOperations.json | 32 + .../Environments_PatchEnvironment.json | 32 + .../examples/Environments_SkipAction.json | 21 + .../examples/OperationStatuses_Get.json | 19 + specification/devcenter/data-plane/readme.md | 17 +- 132 files changed, 11698 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json create mode 100644 specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json create mode 100644 specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json diff --git a/specification/devcenter/DevCenter/DevBox/models.tsp b/specification/devcenter/DevCenter/DevBox/models.tsp index 3300bbd0ba9e..a3f225c5ea4d 100644 --- a/specification/devcenter/DevCenter/DevBox/models.tsp +++ b/specification/devcenter/DevCenter/DevBox/models.tsp @@ -142,6 +142,18 @@ union StopOnDisconnectEnableStatus { string, } +@doc("Stop on no connect enable or disable status.") +@added(APIVersions.v2024_10_01_preview) +union StopOnNoConnectEnableStatus { + @doc("Stop on no connect is enabled on the Dev Box.") + Enabled: "Enabled", + + @doc("Stop on no connect is not enabled on the Dev Box.") + Disabled: "Disabled", + + string, +} + @doc("Pool status indicating whether a pool is available to create Dev Boxes.") union PoolHealthStatus { @doc("The pool health status is not known.") @@ -359,6 +371,10 @@ union DevBoxOperationKind { @added(APIVersions.v2024_09_01_preview) RestoreSnapshot: "RestoreSnapshot", + @doc("The operation represents a Dev Box manual snapshot creation.") + @added(APIVersions.v2024_10_01_preview) + CaptureSnapshot: "CaptureSnapshot", + string, } @@ -377,6 +393,18 @@ union DevBoxRepairOutcome { string, } +@doc("The type of snapshot.") +@added(APIVersions.v2024_10_01_preview) +union SnapshotType { + @doc("The snapshot type indicates that this is a manually taken snapshot.") + Manual: "Manual", + + @doc("The snapshot type indicates that this is an automatically taken snapshot.") + Automatic: "Automatic", + + string, +} + @doc("A pool of Dev Boxes.") @resource("pools") @parentResource(Project) @@ -420,6 +448,10 @@ model Pool { @doc("Stop on disconnect configuration settings for Dev Boxes created in this pool.") stopOnDisconnect?: StopOnDisconnectConfiguration; + @doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") + @added(APIVersions.v2024_10_01_preview) + stopOnNoConnect?: StopOnNoConnectConfiguration; + @doc(""" Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. @@ -500,6 +532,18 @@ model StopOnDisconnectConfiguration { gracePeriodMinutes?: int32; } +@doc("Stop on no connect configuration settings for Dev Boxes created in this pool.") +@added(APIVersions.v2024_10_01_preview) +model StopOnNoConnectConfiguration { + @doc(""" + Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed. + """) + status: StopOnNoConnectEnableStatus; + + @doc("The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled.") + gracePeriodMinutes?: int32; +} + alias ScheduleListResult = Azure.Core.Page<Schedule>; @doc("A Schedule to execute action.") @@ -631,6 +675,11 @@ model DevBox { @visibility("read") createdTime?: utcDateTime; + @doc("Last time a user connected to this Dev Box, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + lastConnectedTime?: utcDateTime; + @doc("Indicates whether the owner of the Dev Box is a local administrator.") @visibility("read", "create") localAdministrator?: LocalAdminStatus; @@ -803,6 +852,13 @@ model DevBoxRestoreSnapshotOperation extends DevBoxOperation { kind: DevBoxOperationKind.RestoreSnapshot; } +@doc("Information about a snapshot creation operation on a Dev Box.") +@added(APIVersions.v2024_10_01_preview) +model DevBoxCaptureSnapshotOperation extends DevBoxOperation { + @doc("The kind of operation that occurred.") + kind: DevBoxOperationKind.CaptureSnapshot; +} + @doc("The Customization Task list result.") model PagedCustomizationTaskDefinition is Azure.Core.Page<CustomizationTaskDefinition>; @@ -981,4 +1037,14 @@ model DevBoxSnapshot { @doc("The datetime that the snapshot was created, in RFC3339 format.") @visibility("read") createdTime: utcDateTime; + + @doc("The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + expirationTime?: utcDateTime; + + @doc("The type of the snapshot indicates whether it is manual or automatic.") + @visibility("read") + @added(APIVersions.v2024_10_01_preview) + snapshotType: SnapshotType; } diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index d43ef877e44c..b203fcedf8b0 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -439,4 +439,15 @@ interface DevBoxes { }, OperationStatus >; + + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Replacing Status Monitor" + @doc("Captures a manual snapshot of the Dev Box.") + @added(APIVersions.v2024_10_01_preview) + @pollingOperation(OperationStatuses.get) + @action("captureSnapshot") + captureSnapshotDevBox is DevCenterOps.LongRunningResourceAction< + DevBox, + {}, + OperationStatus + >; } diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json new file mode 100644 index 000000000000..f512eee91740 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DelayActionsWithError.json @@ -0,0 +1,43 @@ +{ + "title": "Delays all actions with an error.", + "operationId": "DevBoxes_DelayActionsWithError", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Failed", + "error": { + "code": "DelayOverMaxTime", + "message": "The schedule cannot be delayed more than 8 hours from the original invocation time." + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json new file mode 100644 index 000000000000..1f857f91d3d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationGroupsWithoutTasks.json @@ -0,0 +1,32 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroupsWithoutTasks", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json new file mode 100644 index 000000000000..e6de65937cf9 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_ValidateCustomizationTasksActionWithFailure.json @@ -0,0 +1,53 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksActionWithFailure", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Failed", + "errors": [ + { + "target": { + "name": "catalogName/write-to-file" + }, + "details": [ + { + "code": "TaskNotFound", + "message": "Could not find the referenced task catalogName/write-to-file." + } + ] + } + ] + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/DevCenter/main.tsp b/specification/devcenter/DevCenter/main.tsp index ef638853073c..fd5c466076c7 100644 --- a/specification/devcenter/DevCenter/main.tsp +++ b/specification/devcenter/DevCenter/main.tsp @@ -55,4 +55,8 @@ enum APIVersions { @doc("The 2024-09-01-preview service API version") @useDependency(Versions.v1_0_Preview_2) v2024_09_01_preview: "2024-09-01-preview", + + @doc("The 2024-10-01-preview service API version") + @useDependency(Versions.v1_0_Preview_2) + v2024_10_01_preview: "2024-10-01-preview", } diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json new file mode 100644 index 000000000000..78fedb94d760 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -0,0 +1,7219 @@ +{ + "swagger": "2.0", + "info": { + "title": "DevCenter", + "version": "2024-10-01-preview", + "description": "DevCenter service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "The DevCenter-specific URI to operate on.", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://devcenter.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://devcenter.azure.com/.default": "" + } + } + }, + "tags": [], + "paths": { + "/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxes", + "description": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes that the caller has access to in the DevCenter.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects": { + "get": { + "operationId": "DevCenter_ListProjects", + "description": "Lists all projects.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all projects in a Dev Center.": { + "$ref": "./examples/DevCenter_ListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}": { + "get": { + "operationId": "DevCenter_GetProject", + "description": "Gets a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a project.": { + "$ref": "./examples/DevCenter_GetProject.json" + } + } + } + }, + "/projects/{projectName}/catalogs": { + "get": { + "operationId": "Environments_ListCatalogsByProject", + "description": "Lists all of the catalogs available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCatalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all of the catalogs available for a project.": { + "$ref": "./examples/Environments_ListCatalogsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "operationId": "Environments_GetCatalog", + "description": "Gets the specified catalog within the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the specified catalog within the project.": { + "$ref": "./examples/Environments_GetCatalog.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/customizationTasks/{taskName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "description": "Gets a customization task.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "taskName", + "in": "path", + "description": "Full name of the task: {catalogName}/{taskName}.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskDefinitions.json" + } + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "description": "Lists all environment definitions available within a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "The name of the catalog", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available within a catalog.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}": { + "get": { + "operationId": "Environments_GetEnvironmentDefinition", + "description": "Get an environment definition from a catalog.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of the catalog.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "definitionName", + "in": "path", + "description": "Name of the environment definition.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment definition from a catalog.": { + "$ref": "./examples/Environments_GetEnvironmentDefinition.json" + } + } + } + }, + "/projects/{projectName}/customizationTasks": { + "get": { + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "description": "Lists all customization tasks available to the project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all customization tasks available to the project.": { + "$ref": "./examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/customizationTasks:validateGroup": { + "post": { + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "description": "Validates a list of customization tasks.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Customization tasks to validate.", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationTaskList" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListValidationOperationResult" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Validates a list of customization tasks.": { + "$ref": "./examples/DevBoxes_ValidateCustomizationTasksAction.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/environmentDefinitions": { + "get": { + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "description": "Lists all environment definitions available for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironmentDefinitionsByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes": { + "get": { + "operationId": "Environments_ListEnvironmentTypes", + "description": "Lists all environment types configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment types configured for a project.": { + "$ref": "./examples/Environments_ListEnvironmentTypes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "operationId": "Environments_GetEnvironmentTypes", + "description": "Get an environment type configured for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "Name of the environment type.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get an environment type configured for a project.": { + "$ref": "./examples/Environments_GetEnvironmentTypes.json" + } + } + } + }, + "/projects/{projectName}/environmentTypes/{environmentTypeName}/users/{userId}/abilities": { + "get": { + "operationId": "Environments_GetEnvironmentTypeAbilities", + "description": "Gets the signed-in user's permitted abilities in an environment type.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "environmentTypeName", + "in": "path", + "description": "The name of the environment type", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: 'top=10'.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in an environment type.": { + "$ref": "./examples/Environments_GetEnvironmentTypeAbilities.json" + } + } + } + }, + "/projects/{projectName}/environments": { + "get": { + "operationId": "Environments_ListEnvironments", + "description": "Lists the environments for a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all environment definitions available for a project.": { + "$ref": "./examples/Environments_ListEnvironments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/imageBuildLogs/{imageBuildLogId}": { + "get": { + "operationId": "DevBoxes_GetImagingTaskLog", + "description": "Gets the log for an imaging build task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "imageBuildLogId", + "in": "path", + "description": "An imaging build log id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for an imaging build task.": { + "$ref": "./examples/DevBoxes_GetImagingTaskLog.json" + } + } + } + }, + "/projects/{projectName}/operationstatuses/{operationId}": { + "get": { + "operationId": "OperationStatuses_Get", + "description": "Get the status of an operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "The operation id name.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get the status of an operation.": { + "$ref": "./examples/OperationStatuses_Get.json" + } + } + } + }, + "/projects/{projectName}/pools": { + "get": { + "operationId": "DevBoxes_ListPools", + "description": "Lists available pools.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedPool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists available pools.": { + "$ref": "./examples/DevBoxes_ListPools.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}": { + "get": { + "operationId": "DevBoxes_GetPool", + "description": "Gets a pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a pool.": { + "$ref": "./examples/DevBoxes_GetPool.json" + } + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByPool", + "description": "Lists all schedules within a pool that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "poolName", + "in": "path", + "description": "The name of a pool of Dev Boxes.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a pool that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "get": { + "operationId": "DevBoxes_GetScheduleByPool", + "description": "Gets a schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "poolName", + "in": "path", + "description": "Pool name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "scheduleName", + "in": "path", + "description": "Display name for the Schedule.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a schedule.": { + "$ref": "./examples/DevBoxes_GetScheduleByPool.json" + } + } + } + }, + "/projects/{projectName}/schedules": { + "get": { + "operationId": "DevBoxes_ListSchedulesByProject", + "description": "Lists all schedules within a project that are configured by your project administrator.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedSchedule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists all schedules within a project that are configured by your project administrator.": { + "$ref": "./examples/DevBoxes_ListSchedulesByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/abilities": { + "get": { + "operationId": "DevCenter_GetProjectAbilities", + "description": "Gets the signed-in user's permitted abilities in a project.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectAbilities" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the signed-in user's permitted abilities in a project.": { + "$ref": "./examples/DevCenter_GetProjectAbilities.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListDevBoxesByUser", + "description": "Lists Dev Boxes in the project for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}": { + "get": { + "operationId": "DevBoxes_GetDevBoxByUser", + "description": "Gets a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a Dev Box.": { + "$ref": "./examples/DevBoxes_GetDevBoxByUser.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateDevBox", + "description": "Creates or replaces a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/DevBox" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBox" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/DevBox" + }, + "headers": { + "Location": { + "type": "string", + "format": "uri", + "description": "The location of an instance of DevBox" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or replaces a Dev Box.": { + "$ref": "./examples/DevBoxes_CreateDevBox.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DevBoxes_DeleteDevBox", + "description": "Deletes a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes a Dev Box.": { + "$ref": "./examples/DevBoxes_DeleteDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:start": { + "post": { + "operationId": "DevBoxes_StartDevBox", + "description": "Starts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Starts a Dev Box.": { + "$ref": "./examples/DevBoxes_StartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:stop": { + "post": { + "operationId": "DevBoxes_StopDevBox", + "description": "Stops a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/HibernateQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stops a Dev Box.": { + "$ref": "./examples/DevBoxes_StopDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restart": { + "post": { + "operationId": "DevBoxes_RestartDevBox", + "description": "Restarts a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Restarts a Dev Box.": { + "$ref": "./examples/DevBoxes_RestartDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:repair": { + "post": { + "operationId": "DevBoxes_RepairDevBox", + "description": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.": { + "$ref": "./examples/DevBoxes_RepairDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot": { + "post": { + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "description": "Restores a Dev Box to a specified snapshot.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/SnapshotIdQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to restore the Dev Box to a selected snapshot.": { + "$ref": "./examples/DevBoxes_RestoreSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:captureSnapshot": { + "post": { + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "description": "Captures a manual snapshot of the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Attempts to capture the manual snapshot for the Dev Box.": { + "$ref": "./examples/DevBoxes_CaptureSnapshotDevBox.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions": { + "get": { + "operationId": "DevBoxes_ListActions", + "description": "Lists actions on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists actions on a Dev Box.": { + "$ref": "./examples/DevBoxes_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}": { + "get": { + "operationId": "DevBoxes_GetAction", + "description": "Gets an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an action.": { + "$ref": "./examples/DevBoxes_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:skip": { + "post": { + "operationId": "DevBoxes_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/DevBoxes_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions/{actionName}:delay": { + "post": { + "operationId": "DevBoxes_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "The name of the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/DevBoxes_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/actions:delay": { + "post": { + "operationId": "DevBoxes_DelayActions", + "description": "Delays all actions.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "$ref": "#/parameters/DelayUntilQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxActionDelayResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays all actions.": { + "$ref": "./examples/DevBoxes_DelayActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups": { + "get": { + "operationId": "DevBoxes_ListCustomizationGroups", + "description": " Lists customization groups on the Dev Box. Listed customization groups exclude \n task information unless specified via the include parameter.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "include", + "in": "query", + "description": "Optional query parameter to specify what properties should be included in the response.", + "required": false, + "type": "string", + "enum": [ + "tasks" + ], + "x-ms-enum": { + "name": "ListCustomizationGroupsIncludeProperty", + "modelAsString": true, + "values": [ + { + "name": "tasks", + "value": "tasks", + "description": "Include list of tasks in the response." + } + ] + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedCustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.": { + "$ref": "./examples/DevBoxes_ListCustomizationGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}": { + "get": { + "operationId": "DevBoxes_GetCustomizationGroup", + "description": " Gets a customization group.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "Name of the customization group.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a customization group.": { + "$ref": "./examples/DevBoxes_GetCustomizationGroup.json" + } + } + }, + "put": { + "operationId": "DevBoxes_CreateCustomizationGroup", + "description": "Applies customizations to the Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "body", + "in": "body", + "description": "Represents the body request of a Dev Box creation. Dev Box Pool name is required. Optionally set the owner of the Dev Box as local administrator", + "required": true, + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Applies customizations to the Dev Box.": { + "$ref": "./examples/DevBoxes_CreateCustomizationGroup.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/customizationGroups/{customizationGroupName}/logs/{customizationTaskId}": { + "get": { + "operationId": "DevBoxes_GetCustomizationTaskLog", + "description": "Gets the log for a customization task.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + }, + { + "name": "customizationGroupName", + "in": "path", + "description": "A customization group name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "customizationTaskId", + "in": "path", + "description": "A customization task ID.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the log for a customization task.": { + "$ref": "./examples/DevBoxes_GetCustomizationTaskLog.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations": { + "get": { + "operationId": "DevBoxes_ListOperations", + "description": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the Dev Box which have occurred within the past 90 days.": { + "$ref": "./examples/DevBoxes_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/operations/{operationId}": { + "get": { + "operationId": "DevBoxes_GetOperation", + "description": "Gets an operation on a Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the Dev Box operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an operation on a Dev Box.": { + "$ref": "./examples/DevBoxes_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/remoteConnection": { + "get": { + "operationId": "DevBoxes_GetRemoteConnection", + "description": "Gets RDP Connection info.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/DevBoxNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RemoteConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets RDP Connection info.": { + "$ref": "./examples/DevBoxes_GetRemoteConnection.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots": { + "get": { + "operationId": "DevBoxes_ListSnapshots", + "description": "Lists snapshots for this Dev Box.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists snapshots for this Dev Box.": { + "$ref": "./examples/DevBoxes_ListSnapshots.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/snapshots/{snapshotId}": { + "get": { + "operationId": "DevBoxes_GetSnapshot", + "description": "Gets a snapshot by snapshot id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "devBoxName", + "in": "path", + "description": "Display name for the Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "snapshotId", + "in": "path", + "description": "The id of the snapshot. Should be treated as opaque string.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets a snapshot by snapshot id.": { + "$ref": "./examples/DevBoxes_GetSnapshot.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments": { + "get": { + "operationId": "Environments_ListEnvironmentsByUser", + "description": "Lists the environments for a project and user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists the environments for a project and user.": { + "$ref": "./examples/Environments_ListEnvironmentsByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}": { + "get": { + "operationId": "Environments_GetEnvironmentByUser", + "description": "Gets an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment.": { + "$ref": "./examples/Environments_GetEnvironmentByUser.json" + } + } + }, + "put": { + "operationId": "Environments_CreateOrReplaceEnvironment", + "description": "Creates or updates an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/Environment" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Environment" + }, + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Creates or updates an environment.": { + "$ref": "./examples/Environments_CreateOrReplaceEnvironment.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Environments_PatchEnvironment", + "description": "Partially updates an environment.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an environment.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Environment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Partially updates an environment.": { + "$ref": "./examples/Environments_PatchEnvironment.json" + } + } + }, + "delete": { + "operationId": "Environments_DeleteEnvironment", + "description": "Deletes an environment and all its associated resources", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ForceDeleteEnvironmentQueryParameter" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + }, + "headers": { + "Location": { + "type": "string" + }, + "Operation-Location": { + "type": "string" + } + } + }, + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes an environment and all its associated resources.": { + "$ref": "./examples/Environments_DeleteEnvironment.json" + }, + "Deletes an environment and its resource group without the environment definition.": { + "$ref": "./examples/Environments_ForceDeleteEnvironment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions": { + "get": { + "operationId": "Environments_ListActions", + "description": "Get all scheduled actions for a user within an environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all scheduled actions for a user within an environment.": { + "$ref": "./examples/Environments_ListActions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}": { + "get": { + "operationId": "Environments_GetAction", + "description": "Retrieve a specific environment action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Retrieve a specific environment action.": { + "$ref": "./examples/Environments_GetAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:skip": { + "post": { + "operationId": "Environments_SkipAction", + "description": "Skips an occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Skips an occurrence of an action.": { + "$ref": "./examples/Environments_SkipAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/actions/{actionName}:delay": { + "post": { + "operationId": "Environments_DelayAction", + "description": "Delays the occurrence of an action.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "actionName", + "in": "path", + "description": "Uniquely identifies the action.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "until", + "in": "query", + "description": "The time to delay the Environment action until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentAction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delays the occurrence of an action.": { + "$ref": "./examples/Environments_DelayAction.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations": { + "get": { + "operationId": "Environments_ListOperations", + "description": "Lists operations on the environment which have occurred within the past 90 days", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedEnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists operations on the environment which have occurred within the past 90 days.": { + "$ref": "./examples/Environments_ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}": { + "get": { + "operationId": "Environments_GetOperation", + "description": "Gets an environment action result.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "Name of the project.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$" + }, + { + "name": "environmentName", + "in": "path", + "description": "Environment name.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$" + }, + { + "name": "operationId", + "in": "path", + "description": "Unique identifier for the environment operation.", + "required": true, + "type": "string", + "format": "uuid", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOperation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets an environment action result.": { + "$ref": "./examples/Environments_GetOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/operations/{operationId}/logs": { + "get": { + "operationId": "Environments_GetLogsByOperation", + "description": "Gets the logs for an operation on an environment.", + "produces": [ + "text/plain", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "description": "The id of the operation on an environment.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets the logs for an operation on an environment.": { + "$ref": "./examples/Environments_GetLogsByOperation.json" + } + } + } + }, + "/projects/{projectName}/users/{userId}/environments/{environmentName}/outputs": { + "get": { + "operationId": "Environments_GetOutputs", + "description": "Gets Outputs from the environment.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentOutputs" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Gets Outputs from the environment.": { + "$ref": "./examples/Environments_GetOutputs.json" + } + } + } + }, + "/users/{userId}/devboxes": { + "get": { + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "description": "Lists Dev Boxes in the Dev Center for a particular user.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedDevBox" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Lists Dev Boxes in the project for a particular user.": { + "$ref": "./examples/DevBoxes_ListAllDevBoxesByUser.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "Azure.Core.Foundations.OperationState": { + "type": "string", + "description": "Enum describing allowed operation states.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The operation has not started." + }, + { + "name": "Running", + "value": "Running", + "description": "The operation is in progress." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The operation has completed successfully." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The operation has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The operation has been canceled by the user." + } + ] + } + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "Catalog": { + "type": "object", + "description": "A catalog.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the catalog." + }, + "name": { + "type": "string", + "description": "Name of the catalog.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + } + }, + "required": [ + "uri", + "name" + ] + }, + "CustomizationGroup": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box.", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply. Note by default tasks are excluded from the response when\nlisting customization groups. To include them, use the `include=tasks` query\nparameter.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "uri": { + "type": "string", + "description": "The unique URI of the customization group.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of the customization group.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationGroupStatus", + "description": "Status of the customization group.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the customization group, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the customization group, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationGroupStatus": { + "type": "string", + "description": "Status of a customization group.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "ValidationFailed" + ], + "x-ms-enum": { + "name": "CustomizationGroupStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The customization group has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The customization group is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "All tasks in the customization group successfully executed." + }, + { + "name": "Failed", + "value": "Failed", + "description": "At least one task in the customization group failed." + }, + { + "name": "ValidationFailed", + "value": "ValidationFailed", + "description": "At least one task in the customization group failed validation." + } + ] + } + }, + "CustomizationTask": { + "type": "object", + "description": "A customization task to run on a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Name of the task.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "Display name to help differentiate multiple instances of the same task." + }, + "timeoutInSeconds": { + "type": "integer", + "format": "int32", + "description": "Timeout, in seconds. Overrides any timeout provided on the task definition." + }, + "runAs": { + "$ref": "#/definitions/CustomizationTaskExecutionAccount", + "description": "What account to run the task as." + }, + "id": { + "type": "string", + "description": "ID of the task instance.", + "readOnly": true + }, + "logUri": { + "type": "string", + "description": "The unique URI for retrieving the task logs.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CustomizationTaskStatus", + "description": "Status of the task.", + "readOnly": true + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the task, in RFC3339 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "End time of the task, in RFC3339 format.", + "readOnly": true + } + }, + "required": [ + "name" + ] + }, + "CustomizationTaskDefinition": { + "type": "object", + "description": "Represents a task to be used in customizing a Dev Box.", + "properties": { + "name": { + "type": "string", + "description": "Full name of the task: {catalogName}/{taskName}.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog that the task belongs to.", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the customization task.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the task." + }, + "parameters": { + "type": "object", + "description": "Parameters for the task.", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameter" + } + } + }, + "required": [ + "name", + "catalogName" + ] + }, + "CustomizationTaskDefinitionParameter": { + "type": "object", + "description": "Parameters for a customization task.", + "properties": { + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "type": { + "$ref": "#/definitions/CustomizationTaskDefinitionParameterType", + "description": "Type of the parameter." + }, + "required": { + "type": "boolean", + "description": "Whether or not the parameter is required.", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default value for the parameter." + }, + "allowed": { + "type": "array", + "description": "Allowed values for the parameter.", + "items": { + "type": "string" + } + } + }, + "required": [ + "type" + ] + }, + "CustomizationTaskDefinitionParameterType": { + "type": "string", + "description": "Type of the parameter.", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskDefinitionParameterType", + "modelAsString": true, + "values": [ + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + } + ] + } + }, + "CustomizationTaskExecutionAccount": { + "type": "string", + "description": "What account to run the task as.", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "CustomizationTaskExecutionAccount", + "modelAsString": true, + "values": [ + { + "name": "System", + "value": "System", + "description": "The SYSTEM account." + }, + { + "name": "User", + "value": "User", + "description": "The account of the signed in user." + } + ] + } + }, + "CustomizationTaskList": { + "type": "object", + "description": "Represents a list of tasks to apply to a Dev Box", + "properties": { + "tasks": { + "type": "array", + "description": "Tasks to apply.", + "items": { + "$ref": "#/definitions/CustomizationTask" + } + } + } + }, + "CustomizationTaskListValidationError": { + "type": "object", + "description": "All of the validation errors for a customization task.", + "properties": { + "target": { + "$ref": "#/definitions/CustomizationTask", + "description": "The customization task that the error is about." + }, + "details": { + "type": "array", + "description": "List of validation errors for the task.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "target", + "details" + ] + }, + "CustomizationTaskListValidationOperationResult": { + "type": "object", + "description": "The operation result of validating a list of customization tasks.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + }, + "result": { + "$ref": "#/definitions/CustomizationTaskListValidationResult", + "description": "Outcome of validation." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "CustomizationTaskListValidationResult": { + "type": "object", + "description": "The result of validating a list of customization tasks.", + "properties": { + "validationResult": { + "$ref": "#/definitions/CustomizationTaskListValidationStatus", + "description": "Outcome of validation." + }, + "errors": { + "type": "array", + "description": "List of validation errors. Absent if no errors.", + "items": { + "$ref": "#/definitions/CustomizationTaskListValidationError" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "validationResult" + ] + }, + "CustomizationTaskListValidationStatus": { + "type": "string", + "description": "Status of validating a list of customization tasks.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "CustomizationTaskListValidationStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Validation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Validation failed." + } + ] + } + }, + "CustomizationTaskStatus": { + "type": "string", + "description": "Status of a customization task.", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "FailedValidation", + "Skipped", + "TimedOut", + "Failed", + "WaitingForUserInputUac", + "WaitingForUserSession" + ], + "x-ms-enum": { + "name": "CustomizationTaskStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "The task has not yet started." + }, + { + "name": "Running", + "value": "Running", + "description": "The task is currently executing." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The task successfully executed." + }, + { + "name": "FailedValidation", + "value": "FailedValidation", + "description": "The task reference is not valid." + }, + { + "name": "Skipped", + "value": "Skipped", + "description": "he task was skipped." + }, + { + "name": "TimedOut", + "value": "TimedOut", + "description": "The task timed out." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The task failed to execute." + }, + { + "name": "WaitingForUserInputUac", + "value": "WaitingForUserInputUac", + "description": "The task is awaiting the User Account Control (UAC) prompt to be approved. (See more at: https://learn.microsoft.com/windows/security/application-security/application-control/user-account-control/)" + }, + { + "name": "WaitingForUserSession", + "value": "WaitingForUserSession", + "description": "The task is awaiting the user to connect to the Dev Box to execute." + } + ] + } + }, + "DevBox": { + "type": "object", + "description": "A Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the dev box.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name for the Dev Box.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "projectName": { + "type": "string", + "description": "Name of the project this Dev Box belongs to.", + "readOnly": true + }, + "poolName": { + "type": "string", + "description": "The name of the Dev Box pool this machine belongs to.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/DevBoxProvisioningState", + "description": "The current provisioning state of the Dev Box.", + "readOnly": true + }, + "actionState": { + "type": "string", + "description": "The current action state of the Dev Box. This is state is based on previous\naction performed by user.", + "readOnly": true + }, + "powerState": { + "$ref": "#/definitions/PowerState", + "description": "The current power state of the Dev Box.", + "readOnly": true + }, + "uniqueId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "A unique identifier for the Dev Box. This is a GUID-formatted string (e.g.\n00000000-0000-0000-0000-000000000000).", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or action error details. Populated only for error states.", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where this Dev Box is located. This will be the same region as the\nVirtual Network it is attached to.", + "readOnly": true + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of this Dev Box.", + "readOnly": true + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the user this Dev Box is assigned to.", + "readOnly": true + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Information about the Dev Box's hardware resources.", + "readOnly": true + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for this Dev Box.", + "readOnly": true + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Information about the image used for this Dev Box.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Creation time of this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "lastConnectedTime": { + "type": "string", + "format": "date-time", + "description": "Last time a user connected to this Dev Box, in RFC3339 format.", + "readOnly": true + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether the owner of the Dev Box is a local administrator.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "uri", + "name", + "poolName" + ] + }, + "DevBoxAction": { + "type": "object", + "description": "An action which will take place on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box action." + }, + "name": { + "type": "string", + "description": "The name of the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/DevBoxActionType", + "description": "The action that will be taken." + }, + "sourceId": { + "type": "string", + "description": "The id of the resource which triggered this action." + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource which triggered this action." + }, + "sourceType": { + "$ref": "#/definitions/DevBoxActionSourceType", + "description": "The type of the resource which triggered this action." + }, + "suspendedUntil": { + "type": "string", + "format": "date-time", + "description": "The earliest time that the action could occur (UTC), in RFC3339 format." + }, + "next": { + "$ref": "#/definitions/DevBoxNextAction", + "description": "Details about the next run of this action." + } + }, + "required": [ + "uri", + "name", + "actionType", + "sourceId", + "sourceUri", + "sourceType" + ] + }, + "DevBoxActionDelayResult": { + "type": "object", + "description": "The action delay result.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the action." + }, + "name": { + "type": "string", + "description": "The name of the action." + }, + "result": { + "$ref": "#/definitions/DevBoxActionDelayResultStatus", + "description": "The result of the delay operation on this action." + }, + "action": { + "$ref": "#/definitions/DevBoxAction", + "description": "The delayed action." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Information about the error that occurred. Only populated on error." + } + }, + "required": [ + "uri", + "name", + "result" + ] + }, + "DevBoxActionDelayResultStatus": { + "type": "string", + "description": "The result of the delay operation on this action.", + "enum": [ + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "DevBoxActionDelayResultStatus", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The delay operation succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The delay operation failed." + } + ] + } + }, + "DevBoxActionSourceType": { + "type": "string", + "description": "The type of the resource which triggered the action.", + "enum": [ + "Pool", + "Schedule" + ], + "x-ms-enum": { + "name": "DevBoxActionSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The action was triggered by a Dev Box pool." + }, + { + "name": "Schedule", + "value": "Schedule", + "description": "The action was triggered by a Dev Box schedule." + } + ] + } + }, + "DevBoxActionType": { + "type": "string", + "description": "The type of action which will take place on a Dev Box.", + "enum": [ + "Stop" + ], + "x-ms-enum": { + "name": "DevBoxActionType", + "modelAsString": true, + "values": [ + { + "name": "Stop", + "value": "Stop", + "description": "The action will stop the Dev Box." + } + ] + } + }, + "DevBoxCaptureSnapshotOperation": { + "type": "object", + "description": "Information about a snapshot creation operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "CaptureSnapshot" + }, + "DevBoxNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + }, + "required": [ + "scheduledTime" + ] + }, + "DevBoxOperation": { + "type": "object", + "description": "Information about an operation on a Dev Box.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the Dev Box operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the Dev Box operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/DevBoxOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "he time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "DevBoxOperationKind": { + "type": "string", + "description": "The type of Dev Box operation.", + "enum": [ + "Start", + "Stop", + "Restart", + "Repair", + "RestoreSnapshot", + "CaptureSnapshot" + ], + "x-ms-enum": { + "name": "DevBoxOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Start", + "value": "Start", + "description": "The operation represents a Dev Box start." + }, + { + "name": "Stop", + "value": "Stop", + "description": "The operation represents a Dev Box stop." + }, + { + "name": "Restart", + "value": "Restart", + "description": "The operation represents a Dev Box restart." + }, + { + "name": "Repair", + "value": "Repair", + "description": "The operation represents a Dev Box repair." + }, + { + "name": "RestoreSnapshot", + "value": "RestoreSnapshot", + "description": "The operation represents a Dev Box restore from snapshot." + }, + { + "name": "CaptureSnapshot", + "value": "CaptureSnapshot", + "description": "The operation represents a Dev Box manual snapshot creation." + } + ] + } + }, + "DevBoxProvisioningState": { + "type": "string", + "description": "Indicates the provisioning state of the Dev Box.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating", + "Starting", + "Stopping", + "Provisioning", + "ProvisionedWithWarning", + "InGracePeriod", + "NotProvisioned" + ], + "x-ms-enum": { + "name": "DevBoxProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Dev Box was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Dev Box failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Dev Box provision was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Dev Box is being created." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Dev Box is being deleted." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Dev Box is updating." + }, + { + "name": "Starting", + "value": "Starting", + "description": "Dev Box is starting." + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Dev Box is stopping." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Dev Box is provisioning." + }, + { + "name": "ProvisionedWithWarning", + "value": "ProvisionedWithWarning", + "description": "Dev Box was provisioned with warning." + }, + { + "name": "InGracePeriod", + "value": "InGracePeriod", + "description": "Dev Box is in grace period." + }, + { + "name": "NotProvisioned", + "value": "NotProvisioned", + "description": "Dev Box is not provisioned." + } + ] + } + }, + "DevBoxRepairOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "properties": { + "result": { + "$ref": "#/definitions/DevBoxRepairOperationResult", + "description": "The result of the repair operation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Repair" + }, + "DevBoxRepairOperationResult": { + "type": "object", + "description": "Information about the result of a repair operation on a Dev Box.", + "properties": { + "repairOutcome": { + "$ref": "#/definitions/DevBoxRepairOutcome", + "description": "The outcome of the repair operation." + }, + "code": { + "type": "string", + "description": "The result code associated with the repair operation." + }, + "message": { + "type": "string", + "description": "The result message associated with the repair operation." + } + } + }, + "DevBoxRepairOutcome": { + "type": "string", + "description": "The action taken during a repair operation.", + "enum": [ + "FixApplied", + "IssuesDetected", + "NoIssuesDetected" + ], + "x-ms-enum": { + "name": "DevBoxRepairOutcome", + "modelAsString": true, + "values": [ + { + "name": "FixApplied", + "value": "FixApplied", + "description": "A fix for an issue was automatically applied to the Dev Box." + }, + { + "name": "IssuesDetected", + "value": "IssuesDetected", + "description": "One or more issues was detected on the Dev Box, but they could not be fixed automatically." + }, + { + "name": "NoIssuesDetected", + "value": "NoIssuesDetected", + "description": "The service did not identify any issues on the Dev Box." + } + ] + } + }, + "DevBoxRestartOperation": { + "type": "object", + "description": "Information about a restart operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Restart" + }, + "DevBoxRestoreSnapshotOperation": { + "type": "object", + "description": "Information about a restore from snapshot operation on a Dev Box.", + "properties": { + "snapshotId": { + "type": "string", + "description": "Specifies the snapshot id that was used for the restore operation." + } + }, + "required": [ + "snapshotId" + ], + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "RestoreSnapshot" + }, + "DevBoxSnapshot": { + "type": "object", + "description": "A DevBox snapshot", + "properties": { + "snapshotId": { + "type": "string", + "description": "The id of the snapshot. Should be treated as opaque string.", + "readOnly": true + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "The datetime that the snapshot was created, in RFC3339 format.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "description": "The datetime when the snapshot expires, will only be shown for a manual snapshot, in RFC3339 format.", + "readOnly": true + }, + "snapshotType": { + "$ref": "#/definitions/SnapshotType", + "description": "The type of the snapshot indicates whether it is manual or automatic.", + "readOnly": true + } + }, + "required": [ + "snapshotId", + "createdTime", + "snapshotType" + ] + }, + "DevBoxStartOperation": { + "type": "object", + "description": "Information about a start operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Start" + }, + "DevBoxStopOperation": { + "type": "object", + "description": "Information about a stop operation on a Dev Box.", + "allOf": [ + { + "$ref": "#/definitions/DevBoxOperation" + } + ], + "x-ms-discriminator-value": "Stop" + }, + "Environment": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + }, + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Environment name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "environmentType": { + "type": "string", + "description": "Environment type.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "user": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The AAD object id of the owner of this Environment.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/EnvironmentProvisioningState", + "description": "The provisioning state of the environment.", + "readOnly": true + }, + "resourceGroupId": { + "type": "string", + "description": "The identifier of the resource group containing the environment's resources.", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "environmentDefinitionName": { + "type": "string", + "description": "Name of the environment definition.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning error details. Populated only for error states.", + "readOnly": true + } + }, + "required": [ + "uri", + "name", + "environmentType", + "catalogName", + "environmentDefinitionName" + ] + }, + "EnvironmentAction": { + "type": "object", + "description": "An upcoming Environment Action.", + "properties": { + "name": { + "type": "string", + "description": "Uniquely identifies the action.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "uri": { + "type": "string", + "format": "uri", + "description": "Uri of the action resource.", + "readOnly": true + }, + "actionType": { + "$ref": "#/definitions/EnvironmentActionType", + "description": "The action that will be taken." + }, + "next": { + "$ref": "#/definitions/EnvironmentNextAction", + "description": "Details about the next run of this action." + }, + "lastModifiedBy": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Object Id of the user who last modified the action.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "Time the object was last modified, in RFC3339 format." + } + }, + "required": [ + "name", + "uri", + "actionType" + ] + }, + "EnvironmentActionType": { + "type": "string", + "description": "The scheduled action types.", + "enum": [ + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentActionType", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "The action will delete the environment and associated resources." + } + ] + } + }, + "EnvironmentDefinition": { + "type": "object", + "description": "An environment definition.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment definition." + }, + "id": { + "type": "string", + "description": "The ID of the environment definition." + }, + "name": { + "type": "string", + "description": "Name of the environment definition.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "catalogName": { + "type": "string", + "description": "Name of the catalog." + }, + "description": { + "type": "string", + "description": "A short description of the environment definition." + }, + "parameters": { + "type": "array", + "description": "Input parameters passed to an environment.", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + } + }, + "parametersSchema": { + "type": "string", + "description": "JSON schema defining the parameters object passed to an environment." + }, + "templatePath": { + "type": "string", + "description": "Path to the Environment Definition entrypoint file." + } + }, + "required": [ + "uri", + "id", + "name", + "catalogName" + ] + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter." + }, + "name": { + "type": "string", + "description": "Display name of the parameter." + }, + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "default": { + "type": "string", + "description": "Default value of the parameter." + }, + "type": { + "$ref": "#/definitions/ParameterType", + "description": "A string of one of the basic JSON types (number, integer, array, object,\nboolean, string)." + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a\nvalue." + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required." + }, + "allowed": { + "type": "array", + "description": "An array of allowed values.", + "minItems": 1, + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "type", + "required" + ] + }, + "EnvironmentDeleteOperation": { + "type": "object", + "description": "Information about a delete operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "EnvironmentDeployOperation": { + "type": "object", + "description": "Information about a deploy operation on an environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentOperation" + } + ], + "x-ms-discriminator-value": "Deploy" + }, + "EnvironmentNextAction": { + "type": "object", + "description": "Details about the next run of an action.", + "properties": { + "scheduledTime": { + "type": "string", + "format": "date-time", + "description": "The time the action will be triggered (UTC), in RFC3339 format." + } + } + }, + "EnvironmentOperation": { + "type": "object", + "description": "Information about an operation on an environment.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI for the environment operation." + }, + "operationId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "Unique identifier for the environment operation.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/EnvironmentOperationKind", + "description": "The kind of operation that occurred." + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "The operation status." + }, + "createdByObjectId": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The object ID of the actor which initiated the operation." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation started, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the operation finished, in RFC3339 format." + }, + "environmentParameters": { + "type": "object", + "description": "Parameters object for the environment at the time of the operation.", + "additionalProperties": {} + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Provisioning or operation error details. Populated only for error states." + } + }, + "discriminator": "kind", + "required": [ + "uri", + "operationId", + "kind", + "status" + ] + }, + "EnvironmentOperationKind": { + "type": "string", + "description": "The type of environment operation.", + "enum": [ + "Deploy", + "Delete" + ], + "x-ms-enum": { + "name": "EnvironmentOperationKind", + "modelAsString": true, + "values": [ + { + "name": "Deploy", + "value": "Deploy", + "description": "The operation represents a deployment." + }, + { + "name": "Delete", + "value": "Delete", + "description": "The operation represents a delete." + } + ] + } + }, + "EnvironmentOutput": { + "type": "object", + "description": "Output from environment deployment.", + "properties": { + "type": { + "$ref": "#/definitions/EnvironmentOutputType", + "description": "Type of the output value." + }, + "value": { + "description": "The output value." + }, + "sensitive": { + "type": "boolean", + "description": "Indicates if the value is sensitive." + } + } + }, + "EnvironmentOutputType": { + "type": "string", + "description": "Type of the output value.", + "enum": [ + "array", + "boolean", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "EnvironmentOutputType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The output is an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The output is a boolean value." + }, + { + "name": "number", + "value": "number", + "description": "The output is a number value." + }, + { + "name": "object", + "value": "object", + "description": "The output is an object value." + }, + { + "name": "string", + "value": "string", + "description": "The output is a string value." + } + ] + } + }, + "EnvironmentOutputs": { + "type": "object", + "description": "Outputs from environment deployment.", + "properties": { + "outputs": { + "type": "object", + "description": "The outputs Names and Values.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentOutput" + } + } + } + }, + "EnvironmentProvisioningState": { + "type": "string", + "description": "The provisioning state of the environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Accepted", + "Deleting", + "Updating", + "Preparing", + "Running", + "Syncing", + "MovingResources", + "TransientFailure", + "StorageProvisioningFailed" + ], + "x-ms-enum": { + "name": "EnvironmentProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The environment was successfully provisioned." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The environment failed to provision." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The environment provisioning was canceled." + }, + { + "name": "Creating", + "value": "Creating", + "description": "The environment is creating." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The environment was accepted." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The environment is deleting." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The environment is updating." + }, + { + "name": "Preparing", + "value": "Preparing", + "description": "The environment is preparing." + }, + { + "name": "Running", + "value": "Running", + "description": "The environment is running." + }, + { + "name": "Syncing", + "value": "Syncing", + "description": "The environment is Syncing." + }, + { + "name": "MovingResources", + "value": "MovingResources", + "description": "The environment is moving resources." + }, + { + "name": "TransientFailure", + "value": "TransientFailure", + "description": "The environment has a transient failure." + }, + { + "name": "StorageProvisioningFailed", + "value": "StorageProvisioningFailed", + "description": "The environment storage provisioning failed." + } + ] + } + }, + "EnvironmentType": { + "type": "object", + "description": "Properties of an environment type.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the environment type." + }, + "name": { + "type": "string", + "description": "Name of the environment type.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "deploymentTargetId": { + "type": "string", + "description": "Id of a subscription or management group that the environment type will be\nmapped to. The environment's resources will be deployed into this subscription\nor management group." + }, + "status": { + "$ref": "#/definitions/EnvironmentTypeEnableStatus", + "description": "Indicates whether this environment type is enabled for use in this project." + }, + "displayName": { + "type": "string", + "description": "Display name of the environment type." + } + }, + "required": [ + "uri", + "name", + "deploymentTargetId", + "status" + ] + }, + "EnvironmentTypeAbilities": { + "type": "object", + "description": "Abilities a user has on an environment type.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as an admin.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the environment type as a developer.", + "items": { + "$ref": "#/definitions/EnvironmentTypeAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "EnvironmentTypeAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as an admin.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the environment type as a developer.", + "enum": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "EnvironmentTypeAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "EnvironmentTypeEnableStatus": { + "type": "string", + "description": "Indicates whether an environment type is enabled for use in a project.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The environment type is enabled for use in the project." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The environment type is not enabled for use in the project." + } + ] + } + }, + "EnvironmentUpdate": { + "type": "object", + "description": "Properties of an environment.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + }, + "parameters": { + "type": "object", + "description": "Parameters object for the environment.", + "additionalProperties": {} + } + } + }, + "HardwareProfile": { + "type": "object", + "description": "Hardware specifications for the Dev Box.", + "properties": { + "skuName": { + "$ref": "#/definitions/SkuName", + "description": "The name of the SKU.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "description": "The number of vCPUs available for the Dev Box.", + "readOnly": true + }, + "memoryGB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory available for the Dev Box.", + "readOnly": true + } + } + }, + "HibernateSupport": { + "type": "string", + "description": "Indicates whether hibernate is supported and enabled, disabled, or unsupported by the operating system. Unknown hibernate support is represented as null.", + "enum": [ + "Enabled", + "Disabled", + "OsUnsupported" + ], + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Hibernate is enabled." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Hibernate is not enabled." + }, + { + "name": "OsUnsupported", + "value": "OsUnsupported", + "description": "Hibernate is not supported by the operating system." + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image used.", + "properties": { + "name": { + "type": "string", + "description": "The name of the image used.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The version of the image.", + "readOnly": true + }, + "operatingSystem": { + "type": "string", + "description": "The operating system of the image.", + "readOnly": true + }, + "osBuildNumber": { + "type": "string", + "description": "The operating system build number of the image.", + "readOnly": true + }, + "publishedDate": { + "type": "string", + "format": "date-time", + "description": "The datetime that the backing image version was published, in RFC3339 format.", + "readOnly": true + } + } + }, + "LocalAdminStatus": { + "type": "string", + "description": "Indicates whether owners of Dev Boxes in a pool are local administrators on the Dev Boxes.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Owners of Dev Boxes in the pool are local administrators on the Dev Boxes." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Owners of Dev Boxes in the pool are not local administrators on the Dev Boxes." + } + ] + } + }, + "OperationStatus": { + "type": "object", + "description": "The current status of an async operation.", + "properties": { + "id": { + "type": "string", + "description": "Fully qualified ID for the operation status.", + "readOnly": true + }, + "name": { + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The operation id name.", + "minLength": 36, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/Azure.Core.Foundations.OperationState", + "description": "Provisioning state of the resource." + }, + "resourceId": { + "type": "string", + "description": "The id of the resource." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the operation, in RFC3339 format." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the operation, in RFC3339 format." + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "Percent of the operation that is complete.", + "minimum": 0, + "maximum": 100 + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation." + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Operation Error message." + } + }, + "required": [ + "id", + "name", + "status" + ] + }, + "OsDisk": { + "type": "object", + "description": "Settings for the operating system disk.", + "properties": { + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "The size of the OS Disk in gigabytes.", + "readOnly": true + } + } + }, + "OsType": { + "type": "string", + "description": "The operating system type.", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "The Windows operating system." + } + ] + } + }, + "PagedCatalog": { + "type": "object", + "description": "Paged collection of Catalog items", + "properties": { + "value": { + "type": "array", + "description": "The Catalog items on this page", + "items": { + "$ref": "#/definitions/Catalog" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationGroup": { + "type": "object", + "description": "Paged collection of CustomizationGroup items", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationGroup items on this page", + "items": { + "$ref": "#/definitions/CustomizationGroup" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedCustomizationTaskDefinition": { + "type": "object", + "description": "The Customization Task list result.", + "properties": { + "value": { + "type": "array", + "description": "The CustomizationTaskDefinition items on this page", + "items": { + "$ref": "#/definitions/CustomizationTaskDefinition" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBox": { + "type": "object", + "description": "Paged collection of DevBox items", + "properties": { + "value": { + "type": "array", + "description": "The DevBox items on this page", + "items": { + "$ref": "#/definitions/DevBox" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxAction": { + "type": "object", + "description": "Paged collection of DevBoxAction items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxAction items on this page", + "items": { + "$ref": "#/definitions/DevBoxAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxActionDelayResult": { + "type": "object", + "description": "Paged collection of DevBoxActionDelayResult items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxActionDelayResult items on this page", + "items": { + "$ref": "#/definitions/DevBoxActionDelayResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxOperation": { + "type": "object", + "description": "Paged collection of DevBoxOperation items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxOperation items on this page", + "items": { + "$ref": "#/definitions/DevBoxOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedDevBoxSnapshot": { + "type": "object", + "description": "Paged collection of DevBoxSnapshot items", + "properties": { + "value": { + "type": "array", + "description": "The DevBoxSnapshot items on this page", + "items": { + "$ref": "#/definitions/DevBoxSnapshot" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironment": { + "type": "object", + "description": "Paged collection of Environment items", + "properties": { + "value": { + "type": "array", + "description": "The Environment items on this page", + "items": { + "$ref": "#/definitions/Environment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentAction": { + "type": "object", + "description": "Paged collection of EnvironmentAction items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentAction items on this page", + "items": { + "$ref": "#/definitions/EnvironmentAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentDefinition": { + "type": "object", + "description": "Paged collection of EnvironmentDefinition items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentDefinition items on this page", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentOperation": { + "type": "object", + "description": "Paged collection of EnvironmentOperation items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentOperation items on this page", + "items": { + "$ref": "#/definitions/EnvironmentOperation" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedEnvironmentType": { + "type": "object", + "description": "Paged collection of EnvironmentType items", + "properties": { + "value": { + "type": "array", + "description": "The EnvironmentType items on this page", + "items": { + "$ref": "#/definitions/EnvironmentType" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedPool": { + "type": "object", + "description": "Paged collection of Pool items", + "properties": { + "value": { + "type": "array", + "description": "The Pool items on this page", + "items": { + "$ref": "#/definitions/Pool" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedProject": { + "type": "object", + "description": "Paged collection of Project items", + "properties": { + "value": { + "type": "array", + "description": "The Project items on this page", + "items": { + "$ref": "#/definitions/Project" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedSchedule": { + "type": "object", + "description": "Paged collection of Schedule items", + "properties": { + "value": { + "type": "array", + "description": "The Schedule items on this page", + "items": { + "$ref": "#/definitions/Schedule" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ParameterType": { + "type": "string", + "description": "The type of data a parameter accepts.", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "name": "array", + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "name": "boolean", + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "name": "integer", + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "name": "number", + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "name": "object", + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "name": "string", + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "Pool": { + "type": "object", + "description": "A pool of Dev Boxes.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the pool." + }, + "name": { + "type": "string", + "description": "Pool name.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Azure region where Dev Boxes in the pool are located." + }, + "osType": { + "$ref": "#/definitions/OsType", + "description": "The operating system type of Dev Boxes in this pool." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Hardware settings for the Dev Boxes created in this pool." + }, + "hibernateSupport": { + "$ref": "#/definitions/HibernateSupport", + "description": "Indicates whether hibernate is enabled/disabled or unknown." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Storage settings for Dev Box created in this pool." + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image settings for Dev Boxes create in this pool." + }, + "localAdministrator": { + "$ref": "#/definitions/LocalAdminStatus", + "description": "Indicates whether owners of Dev Boxes in this pool are local administrators on\nthe Dev Boxes." + }, + "stopOnDisconnect": { + "$ref": "#/definitions/StopOnDisconnectConfiguration", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool." + }, + "stopOnNoConnect": { + "$ref": "#/definitions/StopOnNoConnectConfiguration", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool." + }, + "healthStatus": { + "$ref": "#/definitions/PoolHealthStatus", + "description": "Overall health status of the Pool. Indicates whether or not the Pool is\navailable to create Dev Boxes." + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name", + "location", + "healthStatus" + ] + }, + "PoolHealthStatus": { + "type": "string", + "description": "Pool status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "x-ms-enum": { + "name": "PoolHealthStatus", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The pool health status is not known." + }, + { + "name": "Pending", + "value": "Pending", + "description": "The pool health status waiting for health checks to run." + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "The pool health status is healthy." + }, + { + "name": "Warning", + "value": "Warning", + "description": "The pool health status has one or more warnings." + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "The pool health status is not healthy." + } + ] + } + }, + "PowerState": { + "type": "string", + "description": "The power states of a Dev Box.", + "enum": [ + "Unknown", + "Running", + "Deallocated", + "PoweredOff", + "Hibernated" + ], + "x-ms-enum": { + "name": "PowerState", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "The Dev Box power state is not known." + }, + { + "name": "Running", + "value": "Running", + "description": "The Dev Box is running." + }, + { + "name": "Deallocated", + "value": "Deallocated", + "description": "The Dev Box is deallocated." + }, + { + "name": "PoweredOff", + "value": "PoweredOff", + "description": "The Dev Box is powered off." + }, + { + "name": "Hibernated", + "value": "Hibernated", + "description": "The Dev Box is hibernated." + } + ] + } + }, + "Project": { + "type": "object", + "description": "Project details.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the project." + }, + "name": { + "type": "string", + "description": "Name of the project.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "description": "When specified, indicates the maximum number of Dev Boxes a single user can\ncreate across all pools in the project.", + "minimum": 0 + }, + "displayName": { + "type": "string", + "description": "Display name of the pool." + } + }, + "required": [ + "uri", + "name" + ] + }, + "ProjectAbilities": { + "type": "object", + "description": "Abilities a user has on a project.", + "properties": { + "abilitiesAsAdmin": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as an admin.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsAdmin" + } + }, + "abilitiesAsDeveloper": { + "type": "array", + "description": "The abilities the user has to perform actions on the project as a developer.", + "items": { + "$ref": "#/definitions/ProjectAbilityAsDeveloper" + } + } + }, + "required": [ + "abilitiesAsAdmin", + "abilitiesAsDeveloper" + ] + }, + "ProjectAbilityAsAdmin": { + "type": "string", + "description": "An ability the user has to perform an action on the project as an admin.", + "enum": [ + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsAdmin", + "modelAsString": true, + "values": [ + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "ProjectAbilityAsDeveloper": { + "type": "string", + "description": "An ability the user has to perform an action on the project as a developer.", + "enum": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ], + "x-ms-enum": { + "name": "ProjectAbilityAsDeveloper", + "modelAsString": true, + "values": [ + { + "name": "CustomizeDevBoxes", + "value": "CustomizeDevBoxes", + "description": "User can customize their own dev boxes." + }, + { + "name": "DeleteDevBoxes", + "value": "DeleteDevBoxes", + "description": "User can delete their own dev boxes." + }, + { + "name": "DeleteEnvironments", + "value": "DeleteEnvironments", + "description": "User can delete environments." + }, + { + "name": "ManageDevBoxActions", + "value": "ManageDevBoxActions", + "description": "User can delay and skip actions on their own dev boxes." + }, + { + "name": "ManageEnvironmentActions", + "value": "ManageEnvironmentActions", + "description": "User can delay and skip actions on environments." + }, + { + "name": "ReadDevBoxActions", + "value": "ReadDevBoxActions", + "description": "User can read actions on their own dev boxes." + }, + { + "name": "ReadDevBoxes", + "value": "ReadDevBoxes", + "description": "User can read their own dev boxes." + }, + { + "name": "ReadEnvironmentActions", + "value": "ReadEnvironmentActions", + "description": "User can read actions on environments." + }, + { + "name": "ReadEnvironmentOutputs", + "value": "ReadEnvironmentOutputs", + "description": "User can read outputs on environments." + }, + { + "name": "ReadEnvironments", + "value": "ReadEnvironments", + "description": "User can read environments." + }, + { + "name": "ReadRemoteConnections", + "value": "ReadRemoteConnections", + "description": "User can read remote connections on their own dev boxes." + }, + { + "name": "StartDevBoxes", + "value": "StartDevBoxes", + "description": "User can start their own dev boxes." + }, + { + "name": "StopDevBoxes", + "value": "StopDevBoxes", + "description": "User can stop their own dev boxes." + }, + { + "name": "WriteDevBoxes", + "value": "WriteDevBoxes", + "description": "User can create dev boxes." + }, + { + "name": "WriteEnvironments", + "value": "WriteEnvironments", + "description": "User can create new environments or replace and update existing ones." + } + ] + } + }, + "RemoteConnection": { + "type": "object", + "description": "Provides remote connection information for a Dev Box.", + "properties": { + "webUrl": { + "type": "string", + "format": "uri", + "description": "URL to open a browser based RDP session." + }, + "rdpConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a Remote Desktop session." + }, + "cloudPcConnectionUrl": { + "type": "string", + "format": "uri", + "description": "Link to open a remote desktop session via a dev box's underlying Cloud PC (This will default to Windows App)." + } + } + }, + "Schedule": { + "type": "object", + "description": "A Schedule to execute action.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The unique URI of the schedule." + }, + "name": { + "type": "string", + "description": "Display name for the Schedule.", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "readOnly": true + }, + "sourceUri": { + "type": "string", + "format": "uri", + "description": "The URI of the resource that this schedule belongs to." + }, + "sourceType": { + "$ref": "#/definitions/ScheduleSourceType", + "description": "The type of the resource that this schedule belongs to." + }, + "type": { + "$ref": "#/definitions/ScheduledType", + "description": "Supported type this scheduled task represents." + }, + "frequency": { + "$ref": "#/definitions/ScheduledFrequency", + "description": "The frequency of this scheduled task." + }, + "time": { + "type": "string", + "description": "The target time to trigger the action. The format is HH:MM." + }, + "timeZone": { + "type": "string", + "description": "The IANA timezone id at which the schedule should execute." + } + }, + "required": [ + "uri", + "name", + "sourceUri", + "sourceType", + "type", + "frequency", + "time", + "timeZone" + ] + }, + "ScheduleSourceType": { + "type": "string", + "description": "The type of the resource that this schedule belongs to.", + "enum": [ + "Pool" + ], + "x-ms-enum": { + "name": "ScheduleSourceType", + "modelAsString": true, + "values": [ + { + "name": "Pool", + "value": "Pool", + "description": "The schedule source is a Dev Box pool." + } + ] + } + }, + "ScheduledFrequency": { + "type": "string", + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true, + "values": [ + { + "name": "Daily", + "value": "Daily", + "description": "The scheduled task will run every day." + } + ] + } + }, + "ScheduledType": { + "type": "string", + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true, + "values": [ + { + "name": "StopDevBox", + "value": "StopDevBox", + "description": "The scheduled task will stop impacted Dev Boxes." + } + ] + } + }, + "SkuName": { + "type": "string", + "description": "Indicates the Dev Box compute.", + "enum": [ + "general_i_8c32gb256ssd_v2", + "general_i_8c32gb512ssd_v2", + "general_i_8c32gb1024ssd_v2", + "general_i_8c32gb2048ssd_v2", + "general_i_16c64gb256ssd_v2", + "general_i_16c64gb512ssd_v2", + "general_i_16c64gb1024ssd_v2", + "general_i_16c64gb2048ssd_v2", + "general_i_32c128gb512ssd_v2", + "general_i_32c128gb1024ssd_v2", + "general_i_32c128gb2048ssd_v2", + "general_a_8c32gb256ssd_v2", + "general_a_8c32gb512ssd_v2", + "general_a_8c32gb1024ssd_v2", + "general_a_8c32gb2048ssd_v2", + "general_a_16c64gb256ssd_v2", + "general_a_16c64gb512ssd_v2", + "general_a_16c64gb1024ssd_v2", + "general_a_16c64gb2048ssd_v2", + "general_a_32c128gb512ssd_v2", + "general_a_32c128gb1024ssd_v2", + "general_a_32c128gb2048ssd_v2" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "name": "general_i_8c32gb256ssd_v2", + "value": "general_i_8c32gb256ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_8c32gb512ssd_v2", + "value": "general_i_8c32gb512ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_8c32gb1024ssd_v2", + "value": "general_i_8c32gb1024ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_8c32gb2048ssd_v2", + "value": "general_i_8c32gb2048ssd_v2", + "description": "Intel, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_16c64gb256ssd_v2", + "value": "general_i_16c64gb256ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_i_16c64gb512ssd_v2", + "value": "general_i_16c64gb512ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_16c64gb1024ssd_v2", + "value": "general_i_16c64gb1024ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_16c64gb2048ssd_v2", + "value": "general_i_16c64gb2048ssd_v2", + "description": "Intel, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_i_32c128gb512ssd_v2", + "value": "general_i_32c128gb512ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_i_32c128gb1024ssd_v2", + "value": "general_i_32c128gb1024ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_i_32c128gb2048ssd_v2", + "value": "general_i_32c128gb2048ssd_v2", + "description": "Intel, 32 vCPU, 128 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_8c32gb256ssd_v2", + "value": "general_a_8c32gb256ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_8c32gb512ssd_v2", + "value": "general_a_8c32gb512ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_8c32gb1024ssd_v2", + "value": "general_a_8c32gb1024ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_8c32gb2048ssd_v2", + "value": "general_a_8c32gb2048ssd_v2", + "description": "AMD, 8 vCPU, 32 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_16c64gb256ssd_v2", + "value": "general_a_16c64gb256ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 256 GB Storage." + }, + { + "name": "general_a_16c64gb512ssd_v2", + "value": "general_a_16c64gb512ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_16c64gb1024ssd_v2", + "value": "general_a_16c64gb1024ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_16c64gb2048ssd_v2", + "value": "general_a_16c64gb2048ssd_v2", + "description": "AMD, 16 vCPU, 64 GB RAM, 2048 GB Storage." + }, + { + "name": "general_a_32c128gb512ssd_v2", + "value": "general_a_32c128gb512ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 512 GB Storage." + }, + { + "name": "general_a_32c128gb1024ssd_v2", + "value": "general_a_32c128gb1024ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 1024 GB Storage." + }, + { + "name": "general_a_32c128gb2048ssd_v2", + "value": "general_a_32c128gb2048ssd_v2", + "description": "AMD, 32 vCPU, 128 GB RAM, 2048 GB Storage." + } + ] + } + }, + "SnapshotType": { + "type": "string", + "description": "The type of snapshot.", + "enum": [ + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "SnapshotType", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "The snapshot type indicates that this is a manually taken snapshot." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "The snapshot type indicates that this is an automatically taken snapshot." + } + ] + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnDisconnectEnableStatus", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace\nperiod has lapsed is enabled." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect\nis detected." + } + }, + "required": [ + "status" + ] + }, + "StopOnDisconnectEnableStatus": { + "type": "string", + "description": "Indicates whether the feature to stop the devbox on disconnect once the grace period has lapsed is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on disconnect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on disconnect is not enabled on the Dev Box." + } + ] + } + }, + "StopOnNoConnectConfiguration": { + "type": "object", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "$ref": "#/definitions/StopOnNoConnectEnableStatus", + "description": "Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed." + }, + "gracePeriodMinutes": { + "type": "integer", + "format": "int32", + "description": "The specified time in minutes to wait before stopping a Dev Box if no connection is made. This will only be present if stop on no connect is enabled." + } + }, + "required": [ + "status" + ] + }, + "StopOnNoConnectEnableStatus": { + "type": "string", + "description": "Stop on no connect enable or disable status.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StopOnNoConnectEnableStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Stop on no connect is enabled on the Dev Box." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Stop on no connect is not enabled on the Dev Box." + } + ] + } + }, + "StorageProfile": { + "type": "object", + "description": "Storage settings for the Dev Box's disks.", + "properties": { + "osDisk": { + "$ref": "#/definitions/OsDisk", + "description": "Settings for the operating system disk." + } + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "DelayUntilQueryParameter": { + "name": "until", + "in": "query", + "description": "The time to delay the Dev Box action or actions until, in RFC3339 format.", + "required": true, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method", + "x-ms-client-name": "delayUntil" + }, + "DevBoxNameParameter": { + "name": "devBoxName", + "in": "path", + "description": "The name of a Dev Box.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "ForceDeleteEnvironmentQueryParameter": { + "name": "force", + "in": "query", + "description": "The query option to force environment deletion even if the environment definition does not exist. This is a best-effort delete, and anything custom that forces resource creation beyond the associated resource group may not be deleted.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "HibernateQueryParameter": { + "name": "hibernate", + "in": "query", + "description": "Optional parameter to hibernate the dev box.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "description": "The DevCenter Project upon which to execute operations.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "x-ms-parameter-location": "method" + }, + "SnapshotIdQueryParameter": { + "name": "snapshotId", + "in": "query", + "description": "Required parameter that specifies the snapshot id to use for the restore operation.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "description": "The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json new file mode 100644 index 000000000000..1306f8183682 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts to capture the manual snapshot for the Dev Box.", + "operationId": "DevBoxes_CaptureSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json new file mode 100644 index 000000000000..0ce11d294f54 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateCustomizationGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Applies customizations to the Dev Box.", + "operationId": "DevBoxes_CreateCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "displayName": "Install VS Code", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-file", + "runAs": "User" + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "NotStarted", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "runAs": "User", + "status": "NotStarted", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "NotStarted" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json new file mode 100644 index 000000000000..3b2a85f411d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CreateDevBox.json @@ -0,0 +1,74 @@ +{ + "title": "Creates or replaces a Dev Box.", + "operationId": "DevBoxes_CreateDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "body": { + "poolName": "LargeDevWorkStationPool" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + }, + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Creating", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json new file mode 100644 index 000000000000..83f344d66d86 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayAction.json @@ -0,0 +1,29 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "DevBoxes_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json new file mode 100644 index 000000000000..89db45645b88 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DelayActions.json @@ -0,0 +1,51 @@ +{ + "title": "Delays all actions.", + "operationId": "DevBoxes_DelayActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "result": "Succeeded", + "action": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "suspendedUntil": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json new file mode 100644 index 000000000000..f4a9c9cf9b65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_DeleteDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes a Dev Box.", + "operationId": "DevBoxes_DeleteDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json new file mode 100644 index 000000000000..2d62c465e19d --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetAction.json @@ -0,0 +1,27 @@ +{ + "title": "Gets an action.", + "operationId": "DevBoxes_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json new file mode 100644 index 000000000000..df202ebc899f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationGroup.json @@ -0,0 +1,44 @@ +{ + "title": "Gets a customization group.", + "operationId": "DevBoxes_GetCustomizationGroup", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning" + }, + "responses": { + "200": { + "body": { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:00:00.000Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json new file mode 100644 index 000000000000..9922353497d3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskDefinitions.json @@ -0,0 +1,36 @@ +{ + "title": "Gets a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskDefinitions", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "catalogName": "myCatalog", + "taskName": "choco" + }, + "responses": { + "200": { + "body": { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json new file mode 100644 index 000000000000..a23db3682380 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetCustomizationTaskLog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the log for a customization task.", + "operationId": "DevBoxes_GetCustomizationTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "4863c6d0-e979-4a36-ac8d-80029debfd80", + "devBoxName": "MyDevBox", + "customizationGroupName": "Provisioning", + "customizationTaskId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json new file mode 100644 index 000000000000..4f37e7673039 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetDevBoxByUser.json @@ -0,0 +1,41 @@ +{ + "title": "Gets a Dev Box.", + "operationId": "DevBoxes_GetDevBoxByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json new file mode 100644 index 000000000000..cc7fabcf2337 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetImagingTaskLog.json @@ -0,0 +1,15 @@ +{ + "title": "Gets the log for an imaging build task.", + "operationId": "DevBoxes_GetImagingTaskLog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "imageBuildLogId": "91835dc0-ef5a-4f58-9e3a-099aea8481f4" + }, + "responses": { + "200": { + "body": "WzIwMjMtMDgtMTBUMTA6MTk6NTUuODIwMTAxKzAwOjAwXSBDaG9jb2xhdGV5IHYxLjMuMVxuWzIwMjMtMDgtMTBUMTA6MTk6NTUuOTEzMjk3KzAwOjAwXSAyIHZhbGlkYXRpb25zIHBlcmZvcm1lZC4gMSBzdWNjZXNzKGVzKSwgMSB3YXJuaW5nKHMpLCBhbmQgMCBlcnJvcihzKS4=" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json new file mode 100644 index 000000000000..a7f76d9d7c13 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetOperation.json @@ -0,0 +1,25 @@ +{ + "title": "Gets an operation on a Dev Box.", + "operationId": "DevBoxes_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json new file mode 100644 index 000000000000..06b37d499a33 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Gets a pool.", + "operationId": "DevBoxes_GetPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json new file mode 100644 index 000000000000..8f8f9dc03d70 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetRemoteConnection.json @@ -0,0 +1,18 @@ +{ + "title": "Gets RDP Connection info.", + "operationId": "DevBoxes_GetRemoteConnection", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "200": { + "body": { + "webUrl": "https://connectionUrl" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json new file mode 100644 index 000000000000..a0ed28a46bbc --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetScheduleByPool.json @@ -0,0 +1,25 @@ +{ + "title": "Gets a schedule.", + "operationId": "DevBoxes_GetScheduleByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview", + "poolName": "DevPool", + "scheduleName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json new file mode 100644 index 000000000000..f62c94303145 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_GetSnapshot.json @@ -0,0 +1,21 @@ +{ + "title": "Gets a snapshot by snapshot id.", + "operationId": "DevBoxes_GetSnapshot", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "200": { + "body": { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json new file mode 100644 index 000000000000..c73522362510 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListActions.json @@ -0,0 +1,42 @@ +{ + "title": "Lists actions on a Dev Box.", + "operationId": "DevBoxes_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/idle-hibernateondisconnect", + "name": "idle-hibernateondisconnect", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool", + "sourceType": "Pool", + "next": { + "scheduledTime": "2022-09-30T15:23:00Z" + } + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/actions/schedule-default", + "name": "schedule-default", + "actionType": "Stop", + "sourceId": "/projects/myProject/pools/myPool/schedules/default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/myPool/schedules/default", + "sourceType": "Schedule", + "suspendedUntil": "2022-09-30T17:00:00Z", + "next": { + "scheduledTime": "2022-09-30T17:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json new file mode 100644 index 000000000000..d191b87a886b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxes.json @@ -0,0 +1,42 @@ +{ + "title": "Lists Dev Boxes that the caller has access to in the DevCenter.", + "operationId": "DevBoxes_ListAllDevBoxes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json new file mode 100644 index 000000000000..f76e593664da --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListAllDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListAllDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json new file mode 100644 index 000000000000..25efb85d3eed --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationGroups.json @@ -0,0 +1,68 @@ +{ + "title": "Lists customization groups on the Dev Box. Listed customization groups exclude task information unless specified via the include parameter.", + "operationId": "DevBoxes_ListCustomizationGroups", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "include": "tasks" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Provisioning", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning", + "tasks": [ + { + "id": "a9202018-fb6a-4007-8b52-26d7c6d1c1fb", + "name": "catalogName/choco", + "displayName": "Install VS Code", + "status": "Succeeded", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + }, + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:00:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/a9202018-fb6a-4007-8b52-26d7c6d1c1fb" + }, + { + "id": "91835dc0-ef5a-4f58-9e3a-099aea8481f4", + "name": "catalogName/write-to-file", + "status": "Succeeded", + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Provisioning/logs/91835dc0-ef5a-4f58-9e3a-099aea8481f4" + } + ], + "status": "Succeeded", + "startTime": "2021-08-05T18:00:00.000Z", + "endTime": "2021-08-05T18:10:00.000Z" + }, + { + "name": "Personalizations", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations", + "tasks": [ + { + "id": "d8ec7648-23c9-4e86-8883-6d42ad6c9609", + "name": "catalogName/choco", + "displayName": "Install Git", + "status": "Running", + "parameters": { + "packageName": "git" + }, + "startTime": "2021-08-05T18:10:00.000Z", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox/customizationgroups/Personalizations/logs/d8ec7648-23c9-4e86-8883-6d42ad6c9609" + } + ], + "status": "Running", + "startTime": "2021-08-05T18:10:00.000Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json new file mode 100644 index 000000000000..6886b08fd453 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListCustomizationTaskDefinitionsByProject.json @@ -0,0 +1,53 @@ +{ + "title": "Lists all customization tasks available to the project.", + "operationId": "DevBoxes_ListCustomizationTaskDefinitionsByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myCatalog/choco", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/choco", + "description": "Install a package via chocolatey", + "parameters": { + "package": { + "description": "The package to install", + "type": "string", + "required": true + }, + "version": { + "description": "The version of the package", + "type": "string", + "default": "latest" + }, + "retryOnFail": { + "type": "boolean" + } + } + }, + { + "name": "myCatalog/powershell", + "catalogName": "myCatalog", + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/customizationtasks/powershell", + "description": "Runs an arbitrary Powershell command", + "parameters": { + "command": { + "type": "string", + "required": true + }, + "runAsAdmin": { + "type": "boolean" + } + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json new file mode 100644 index 000000000000..ee0a1c013dcd --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListDevBoxesByUser.json @@ -0,0 +1,44 @@ +{ + "title": "Lists Dev Boxes in the project for a particular user.", + "operationId": "DevBoxes_ListDevBoxesByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox", + "name": "MyDevBox", + "provisioningState": "Succeeded", + "projectName": "ContosoProject", + "poolName": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastConnectedTime": "2022-04-01T00:13:23.323Z", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json new file mode 100644 index 000000000000..fa770194c6af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListOperations.json @@ -0,0 +1,42 @@ +{ + "title": "Lists operations on the Dev Box which have occurred within the past 90 days.", + "operationId": "DevBoxes_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Start", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/devBoxes/myDevBox/operations/a6eb12ee-daa1-2215-9c44-63618dc2a781", + "operationId": "a6eb12ee-daa1-2215-9c44-63618dc2a781", + "status": "Succeeded", + "kind": "Repair", + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-10T19:31:20.7229492+00:00", + "endTime": "2022-09-10T19:57:41.7229492+00:00", + "result": { + "code": "ConnectivityFixApplied", + "message": "We resolved some connectivity issues with your Dev Box.", + "repairOutcome": "FixApplied" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json new file mode 100644 index 000000000000..065f2392a615 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListPools.json @@ -0,0 +1,79 @@ +{ + "title": "Lists available pools.", + "operationId": "DevBoxes_ListPools", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/LargeDevWorkStationPool", + "name": "LargeDevWorkStationPool", + "location": "centralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 8, + "memoryGB": 32 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "DevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "LargePool" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/SQLDevelopmentMachinePool", + "name": "SQLDevelopmentMachinePool", + "location": "southcentralus", + "osType": "Windows", + "hardwareProfile": { + "vCPUs": 16, + "memoryGB": 128 + }, + "storageProfile": { + "osDisk": { + "diskSizeGB": 1024 + } + }, + "hibernateSupport": "Enabled", + "imageReference": { + "name": "SqlDevImage", + "version": "1.0.0", + "publishedDate": "2022-03-01T00:13:23.323Z" + }, + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "displayName": "SQLPool" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json new file mode 100644 index 000000000000..3139ab52c06a --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByPool.json @@ -0,0 +1,28 @@ +{ + "title": "Lists all schedules within a pool that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByPool", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "poolName": "DevPool", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json new file mode 100644 index 000000000000..920494b62d99 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSchedulesByProject.json @@ -0,0 +1,27 @@ +{ + "title": "Lists all schedules within a project that are configured by your project administrator.", + "operationId": "DevBoxes_ListSchedulesByProject", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool/schedules/default", + "name": "default", + "sourceUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/pools/DevPool", + "sourceType": "Pool", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json new file mode 100644 index 000000000000..6cb959b2204e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ListSnapshots.json @@ -0,0 +1,30 @@ +{ + "title": "Lists snapshots for this Dev Box.", + "operationId": "DevBoxes_ListSnapshots", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797", + "createdTime": "2022-09-30T15:23:00Z", + "snapshotType": "Automatic" + }, + { + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6798", + "createdTime": "2022-09-30T15:23:00Z", + "expirationTime": "2024-10-30T15:23:00Z", + "snapshotType": "Manual" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json new file mode 100644 index 000000000000..ab297ebe0667 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RepairDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Attempts automated repair steps to resolve common problems on a Dev Box. The Dev Box may restart during this operation.", + "operationId": "DevBoxes_RepairDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json new file mode 100644 index 000000000000..acef706175e1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Restarts a Dev Box.", + "operationId": "DevBoxes_RestartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json new file mode 100644 index 000000000000..891948c547a0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Attempts to restore the Dev Box to a selected snapshot.", + "operationId": "DevBoxes_RestoreSnapshotDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "snapshotId": "CPC_974f0852-a0f4-4a9f-8ce7-d0d0d7a604cf_9b656834-3563-4bca-93c6-f90cfa3c6797" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json new file mode 100644 index 000000000000..bc83aa55f3c1 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_SkipAction.json @@ -0,0 +1,15 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "DevBoxes_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "myDevBox", + "actionName": "schedule-default" + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json new file mode 100644 index 000000000000..5c34fc1c57c2 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StartDevBox.json @@ -0,0 +1,25 @@ +{ + "title": "Starts a Dev Box.", + "operationId": "DevBoxes_StartDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json new file mode 100644 index 000000000000..99dd05cc7c03 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_StopDevBox.json @@ -0,0 +1,26 @@ +{ + "title": "Stops a Dev Box.", + "operationId": "DevBoxes_StopDevBox", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "devBoxName": "MyDevBox", + "hibernate": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json new file mode 100644 index 000000000000..7fa247cff7a6 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_ValidateCustomizationTasksAction.json @@ -0,0 +1,40 @@ +{ + "title": "Validates a list of customization tasks.", + "operationId": "DevBoxes_ValidateCustomizationTasksAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "body": { + "tasks": [ + { + "name": "catalogName/choco", + "parameters": { + "packageName": "vscode", + "packageVersion": "1.0.0" + } + }, + { + "name": "catalogName/write-to-disk" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Succeeded", + "startTime": "2023-02-01T12:43:54.122Z", + "result": { + "validationResult": "Succeeded" + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json new file mode 100644 index 000000000000..44331c0613ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProject.json @@ -0,0 +1,19 @@ +{ + "title": "Gets a project.", + "operationId": "DevCenter_GetProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevDiv", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json new file mode 100644 index 000000000000..1dd761dc9891 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_GetProjectAbilities.json @@ -0,0 +1,37 @@ +{ + "title": "Gets the signed-in user's permitted abilities in a project.", + "operationId": "DevCenter_GetProjectAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadDevBoxes", + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "CustomizeDevBoxes", + "DeleteDevBoxes", + "DeleteEnvironments", + "ManageDevBoxActions", + "ManageEnvironmentActions", + "ReadDevBoxActions", + "ReadDevBoxes", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "ReadRemoteConnections", + "StartDevBoxes", + "StopDevBoxes", + "WriteDevBoxes", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json new file mode 100644 index 000000000000..a7d9e2e31725 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenter_ListProjects.json @@ -0,0 +1,22 @@ +{ + "title": "Lists all projects in a Dev Center.", + "operationId": "DevCenter_ListProjects", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject", + "name": "DevDiv", + "description": "The developer division", + "displayName": "DeveloperDivision" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json new file mode 100644 index 000000000000..c31a9c1565a5 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_CreateOrReplaceEnvironment.json @@ -0,0 +1,43 @@ +{ + "title": "Creates or updates an environment.", + "operationId": "Environments_CreateOrReplaceEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Creating", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json new file mode 100644 index 000000000000..fedd0acb2c35 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DelayAction.json @@ -0,0 +1,27 @@ +{ + "title": "Delays the occurrence of an action.", + "operationId": "Environments_DelayAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnv", + "actionName": "default", + "until": "2022-09-30T17:00:00Z" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json new file mode 100644 index 000000000000..b12474e9fe84 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_DeleteEnvironment.json @@ -0,0 +1,26 @@ +{ + "title": "Deletes an environment and all its associated resources.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json new file mode 100644 index 000000000000..3305cb49fb0b --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ForceDeleteEnvironment.json @@ -0,0 +1,27 @@ +{ + "title": "Deletes an environment and its resource group without the environment definition.", + "operationId": "Environments_DeleteEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv", + "force": "true" + }, + "responses": { + "202": { + "headers": { + "Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "Operation-Location": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0" + }, + "body": { + "id": "/projects/myProject/operationstatuses/786a823c-8037-48ab-89b8-8599901e67d0", + "name": "786a823c-8037-48ab-89b8-8599901e67d0", + "status": "Running", + "startTime": "2023-02-01T12:43:54.122Z" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json new file mode 100644 index 000000000000..8c5dcee14079 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetAction.json @@ -0,0 +1,26 @@ +{ + "title": "Retrieve a specific environment action.", + "operationId": "Environments_GetAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "actionName": "default" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json new file mode 100644 index 000000000000..d0296c59168f --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetCatalog.json @@ -0,0 +1,18 @@ +{ + "title": "Gets the specified catalog within the project.", + "operationId": "Environments_GetCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json new file mode 100644 index 000000000000..fc09eaf09dec --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentByUser.json @@ -0,0 +1,30 @@ +{ + "title": "Gets an environment.", + "operationId": "Environments_GetEnvironmentByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json new file mode 100644 index 000000000000..6a2a39903855 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentDefinition.json @@ -0,0 +1,58 @@ +{ + "title": "Get an environment definition from a catalog.", + "operationId": "Environments_GetEnvironmentDefinition", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog", + "definitionName": "foo" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json new file mode 100644 index 000000000000..15bd60987c65 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypeAbilities.json @@ -0,0 +1,28 @@ +{ + "title": "Gets the signed-in user's permitted abilities in an environment type.", + "operationId": "Environments_GetEnvironmentTypeAbilities", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "userId": "me", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "abilitiesAsAdmin": [ + "ReadEnvironments" + ], + "abilitiesAsDeveloper": [ + "DeleteEnvironments", + "ManageEnvironmentActions", + "ReadEnvironmentActions", + "ReadEnvironmentOutputs", + "ReadEnvironments", + "WriteEnvironments" + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json new file mode 100644 index 000000000000..d41c0d94320e --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetEnvironmentTypes.json @@ -0,0 +1,21 @@ +{ + "title": "Get an environment type configured for a project.", + "operationId": "Environments_GetEnvironmentTypes", + "parameters": { + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/", + "projectName": "myProject", + "environmentTypeName": "devtestenv", + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json new file mode 100644 index 000000000000..5fb52d5225a3 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetLogsByOperation.json @@ -0,0 +1,17 @@ +{ + "title": "Gets the logs for an operation on an environment.", + "operationId": "Environments_GetLogsByOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json new file mode 100644 index 000000000000..6e4d5ac213af --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOperation.json @@ -0,0 +1,29 @@ +{ + "title": "Gets an environment action result.", + "operationId": "Environments_GetOperation", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680" + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json new file mode 100644 index 000000000000..20f9755f7101 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_GetOutputs.json @@ -0,0 +1,51 @@ +{ + "title": "Gets Outputs from the environment.", + "operationId": "Environments_GetOutputs", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "mydevenv" + }, + "responses": { + "200": { + "body": { + "outputs": { + "stringOutput": { + "type": "string", + "value": "Output1 value", + "sensitive": false + }, + "arrayOutput": { + "type": "array", + "value": [ + 1, + 2, + 3 + ], + "sensitive": false + }, + "boolOutput": { + "type": "bool", + "value": true, + "sensitive": false + }, + "intOutput": { + "type": "int", + "value": 1, + "sensitive": false + }, + "objectOutput": { + "type": "object", + "value": { + "name": "name", + "id": "id" + }, + "sensitive": false + } + } + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json new file mode 100644 index 000000000000..fec2e7db31bb --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListActions.json @@ -0,0 +1,39 @@ +{ + "title": "Get all scheduled actions for a user within an environment.", + "operationId": "Environments_ListActions", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/default", + "name": "default", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-10T17:00:00Z" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/environments/MyEnv/actions/expire", + "name": "expire", + "actionType": "Delete", + "next": { + "scheduledTime": "2023-10-30T17:00:00Z" + }, + "lastModifiedBy": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "lastModifiedAt": "2023-09-20T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json new file mode 100644 index 000000000000..d9fbc4eee5d0 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListCatalogsByProject.json @@ -0,0 +1,21 @@ +{ + "title": "Lists all of the catalogs available for a project.", + "operationId": "Environments_ListCatalogsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/foo", + "name": "foo" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json new file mode 100644 index 000000000000..72928b19772c --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByCatalog.json @@ -0,0 +1,69 @@ +{ + "title": "Lists all environment definitions available within a catalog.", + "operationId": "Environments_ListEnvironmentDefinitionsByCatalog", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json new file mode 100644 index 000000000000..3055da215535 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentDefinitionsByProject.json @@ -0,0 +1,68 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironmentDefinitionsByProject", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "id": "/projects/myProject/catalogs/myCatalog/environmentDefinitions/foo", + "name": "foo", + "catalogName": "myCatalog", + "description": "This environment definition is just for example purposes.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true, + "default": "dotnet", + "allowed": [ + "node", + "dotnet", + "java" + ] + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true, + "default": "Standard_LRS", + "allowed": [ + "Standard_LRS", + "Standard_GRS", + "Standard_RAGRS" + ] + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "default": "true", + "readOnly": true, + "required": true + } + ], + "parametersSchema": "{\"type\":\"object\",\"properties\":{\"functionAppRuntime\":{\"$id\":\"functionAppRuntime\",\"value\":\"dotnet\",\"displayName\":\"Function App Runtime\",\"type\":\"string\",\"enum\":[\"node\",\"dotnet\",\"java\"]},\"storageAccountType\":{\"$id\":\"storageAccountType\",\"value\":\"Standard_LRS\",\"displayName\":\"Storage Account Type\",\"type\":\"string\",\"enum\":[\"Standard_LRS\",\"Standard_GRS\",\"Standard_RAGRS\"]},\"httpsOnly\":{\"$id\":\"httpsOnly\",\"value\":true,\"displayName\":\"HTTPS only\",\"type\":\"boolean\"}},\"required\":[\"functionAppRuntime\",\"storageAccountType\"]}", + "templatePath": "azuredeploy.json" + }, + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/catalogs/myCatalog/environmentDefinitions/bar", + "id": "/projects/myProject/catalogs/myOtherCatalog/environmentDefinitions/bar", + "name": "bar", + "catalogName": "myOtherCatalog", + "description": "This environment definition is just for example purposes.", + "templatePath": "azuredeploy.json" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json new file mode 100644 index 000000000000..62e267038a17 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentTypes.json @@ -0,0 +1,24 @@ +{ + "title": "Lists all environment types configured for a project.", + "operationId": "Environments_ListEnvironmentTypes", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/environmentTypes/devtestenv", + "name": "devtestenv", + "status": "Enabled", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "displayName": "DevTestEnvironment" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json new file mode 100644 index 000000000000..037ce43b0111 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironments.json @@ -0,0 +1,32 @@ +{ + "title": "Lists all environment definitions available for a project.", + "operationId": "Environments_ListEnvironments", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json new file mode 100644 index 000000000000..a31423259000 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListEnvironmentsByUser.json @@ -0,0 +1,33 @@ +{ + "title": "Lists the environments for a project and user.", + "operationId": "Environments_ListEnvironmentsByUser", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "resourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg028321", + "expirationDate": "2023-09-10T17:00:00Z" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json new file mode 100644 index 000000000000..8386bc5476ab --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_ListOperations.json @@ -0,0 +1,32 @@ +{ + "title": "Lists operations on the environment which have occurred within the past 90 days.", + "operationId": "Environments_ListOperations", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "userId": "me", + "environmentName": "myEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/myEnvironment/operations/f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "operationId": "f5dbdfab-fa0e-4831-8d13-25359aa5e680", + "status": "Succeeded", + "kind": "Deploy", + "environmentParameters": { + "paramA": "valueA", + "paramB": "valueB" + }, + "createdByObjectId": "cf849cb0-3a05-4059-84b4-40c16abb1e93", + "startTime": "2022-09-06T16:58:51.7229492+00:00", + "endTime": "2022-09-06T16:59:51.7229492+00:00" + } + ] + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json new file mode 100644 index 000000000000..c31b552d4813 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_PatchEnvironment.json @@ -0,0 +1,32 @@ +{ + "title": "Partially updates an environment.", + "operationId": "Environments_PatchEnvironment", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "mydevenv", + "userId": "me", + "body": { + "expirationDate": "2023-09-10T17:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/cf849cb0-3a05-4059-84b4-40c16abb1e93/environments/mydevenv", + "name": "mydevenv", + "environmentType": "DevTest", + "catalogName": "main", + "environmentDefinitionName": "helloworld", + "parameters": { + "functionAppRuntime": "node", + "storageAccountType": "Standard_LRS" + }, + "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98", + "provisioningState": "Succeeded", + "expirationDate": "2023-09-10T17:00:00Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json new file mode 100644 index 000000000000..d620617d53de --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Environments_SkipAction.json @@ -0,0 +1,21 @@ +{ + "title": "Skips an occurrence of an action.", + "operationId": "Environments_SkipAction", + "parameters": { + "api-version": "2024-10-01-preview", + "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", + "projectName": "myProject", + "environmentName": "myEnv", + "userId": "me", + "actionName": "default", + "body": { + "actionType": "Delete", + "next": { + "scheduledTime": "2023-09-30T17:00:00Z" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json new file mode 100644 index 000000000000..c1d48444d062 --- /dev/null +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatuses_Get.json @@ -0,0 +1,19 @@ +{ + "title": "Get the status of an operation.", + "operationId": "OperationStatuses_Get", + "parameters": { + "api-version": "2024-10-01-preview", + "projectName": "myProject", + "operationId": "fa067167-e49d-41bd-8dd8-de719b9de3b3" + }, + "responses": { + "200": { + "body": { + "id": "/projects/myProject/operationStatuses/fa067167-e49d-41bd-8dd8-de719b9de3b3", + "name": "fa067167-e49d-41bd-8dd8-de719b9de3b3", + "status": "Running", + "startTime": "2024-01-24T21:14:58.472Z" + } + } + } +} diff --git a/specification/devcenter/data-plane/readme.md b/specification/devcenter/data-plane/readme.md index 4adfb0eb98b6..d1cdb23e358a 100644 --- a/specification/devcenter/data-plane/readme.md +++ b/specification/devcenter/data-plane/readme.md @@ -27,7 +27,22 @@ These are the global settings for the devcenter. ``` yaml openapi-type: data-plane azure-arm: false -tag: package-2024-09-01-preview +tag: package-2024-10-01-preview +``` + +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-10-01-preview' +input-file: + - Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json + +directive: + - suppress: HostParametersValidation + reason: Requires URL format for endpoint params, which violates R2003 and causes problems with codegen. + - suppress: OperationIdNounVerb + reason: DevBoxes and Environments are operations with multiple models. ``` ### Tag: package-2024-09-01-preview From 6d9e0951ddb28d567d54e4316bba6fa19626be43 Mon Sep 17 00:00:00 2001 From: reutgross <104348031+reutgross@users.noreply.github.com> Date: Tue, 1 Oct 2024 20:32:45 +0300 Subject: [PATCH 021/101] [Health Insights] New preview version 2024-08-01-preview (#30675) * add new version --- .../model.oncophenotype.tsp | 87 - .../route.oncophenotype.tsp | 36 - .../SuccessfulRadiologyInsightsRequest.json | 134 + .../SuccessfulRadiologyInsightsResponse.json | 33454 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 3009 ++ .../SuccessfulTrialMatcherResponse.json | 116 + .../HealthInsights.OpenAPI/main.tsp | 4 +- .../HealthInsights.OpenAPI/service.tsp | 3 + .../model.patienttimeline.tsp | 73 - .../route.patienttimeline.tsp | 36 - .../model.trialmatcher.tsp | 18 +- .../route.trialmatcher.tsp | 16 +- .../SuccessfulRadiologyInsightsRequest.json | 134 + .../SuccessfulRadiologyInsightsResponse.json | 33454 ++++++++++++++++ .../SuccessfulTrialMatcherRequest.json | 3009 ++ .../SuccessfulTrialMatcherResponse.json | 116 + .../preview/2024-08-01-preview/openapi.json | 4082 ++ .../ai/data-plane/HealthInsights/readme.md | 19 +- 18 files changed, 77548 insertions(+), 252 deletions(-) delete mode 100644 specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp delete mode 100644 specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json delete mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp delete mode 100644 specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json create mode 100644 specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp deleted file mode 100644 index 4523bb0b3283..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/model.oncophenotype.tsp +++ /dev/null @@ -1,87 +0,0 @@ -import "../HealthInsights.Common/model.common.request.tsp"; -import "../HealthInsights.Common/model.common.response.tsp"; -import "../HealthInsights.Common/model.common.shared.tsp"; -import "../HealthInsights.Common/model.common.fhir.elements.tsp"; - -using TypeSpec.Rest; - -namespace AzureHealthInsights; - -@doc("The body of the Onco Phenotype request.") -model OncoPhenotypeData { - ...Request; - - @doc("Configuration affecting the Onco Phenotype model's inference.") - configuration?: OncoPhenotypeModelConfiguration; -} - -@doc("The response for the Onco Phenotype request.") -@resource("onco-phenotype/jobs") -model OncoPhenotypeResult - is HealthInsightsOperationStatus<OncoPhenotypeInferenceResult>; - -@doc("The inference results for the Onco Phenotype request.") -model OncoPhenotypeInferenceResult { - @doc("Results for the patients given in the request.") - patientResults: OncoPhenotypePatientResult[]; - - @doc("The version of the model used for inference, expressed as the model date.") - modelVersion: ModelVersion; -} - -@doc("The results of the model's work for a single patient.") -model OncoPhenotypePatientResult { - @doc("The identifier given for the patient in the request.") - patientId: string; - - @doc("The model's inferences for the given patient.") - inferences: Array<OncoPhenotypeInference>; -} - -@doc("An inference made by the Onco Phenotype model regarding a patient.") -model OncoPhenotypeInference { - @doc("The type of the Onco Phenotype inference") - type: OncoPhenotypeInferenceType; - - ...Inference; - - @doc("The evidence corresponding to the inference value.") - evidence?: InferenceEvidence[]; - - @doc(""" - An identifier for a clinical case, if there are multiple clinical cases regarding the same patient. - """) - caseId?: string; -} - -@doc("Configuration affecting the Onco Phenotype model's inference.") -model OncoPhenotypeModelConfiguration { - ...ModelConfiguration; - - @doc(""" - A list of inference types to be inferred for the current request. - This could be used if only part of the Onco Phenotype inferences are required. - If this list is omitted or empty, the model will return all the inference types. - """) - inferenceTypes?: OncoPhenotypeInferenceType[]; - - @doc(""" - An indication whether to perform a preliminary step on the patient's documents to determine whether they relate to a Cancer case. - """) - checkForCancerCase?: boolean = false; -} - -#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update" -@doc("The type of the Onco Phenotype inference.") -union OncoPhenotypeInferenceType { - string, - TumorSite: "tumorSite", - Histology: "histology", - ClinicalStageT: "clinicalStageT", - ClinicalStageN: "clinicalStageN", - ClinicalStageM: "clinicalStageM", - PathologicStageT: "pathologicStageT", - PathologicStageN: "pathologicStageN", - PathologicStageM: "pathologicStageM", - DiagnosisDate: "diagnosisDate", -} diff --git a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp b/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp deleted file mode 100644 index 3bcfdf2454b3..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.OncoPhenotype/route.oncophenotype.tsp +++ /dev/null @@ -1,36 +0,0 @@ -import "@azure-tools/typespec-azure-core"; -import "@typespec/rest"; -import "@typespec/http"; - -import "./model.oncophenotype.tsp"; -import "../HealthInsights.Common/primitives.tsp"; - -using Azure.Core; -using TypeSpec.Rest; -using TypeSpec.Http; - -namespace AzureHealthInsights; - -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) -interface OncoPhenotype { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" - @summary("Get Onco Phenotype job details") - @tag("OncoPhenotype") - @doc("Gets the status and details of the Onco Phenotype job.") - @get - @route("/onco-phenotype/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<OncoPhenotypeResult>>; - - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" - @summary("Create Onco Phenotype job") - @tag("OncoPhenotype") - @doc("Creates an Onco Phenotype job with the given request body.") - @pollingOperation(OncoPhenotype.getJob) - @route("/onco-phenotype/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - OncoPhenotypeData, - OncoPhenotypeResult, - OncoPhenotypeInferenceResult - >; -} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..0217e4d6a9ab --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,134 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "resource": { + "jobData": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "details": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdAt": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..abbdff32da9a --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33454 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "communicatedAt": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdAt": "2024-01-29T19:50:52Z", + "expiresAt": "2024-01-30T19:50:52Z", + "updatedAt": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..7dba7841e236 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,3009 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d11", + "resource": { + "jobData": { + "patients": [ + { + "id": "Patient ID Example 2", + "details": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..5f4be4dcee12 --- /dev/null +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/examples/2024-08-01-preview/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,116 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdAt": "2021-11-28T09:13:11.046Z", + "expiresAt": "2021-11-28T09:13:11.046Z", + "updatedAt": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp index afc5036bef99..ec68311f831b 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/main.tsp @@ -1,6 +1,3 @@ -// import "../HealthInsights.TrialMatcher/route.trialmatcher.tsp"; -// import "../HealthInsights.OncoPhenotype/route.oncophenotype.tsp"; -// import "../HealthInsights.PatientTimeline/route.patienttimeline.tsp"; import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "@typespec/http"; @@ -8,6 +5,7 @@ import "@typespec/versioning"; import "./service.tsp"; import "../HealthInsights.RadiologyInsights/route.radiologyinsights.tsp"; +import "../HealthInsights.TrialMatcher/route.trialmatcher.tsp"; // FIXME: This is a workaround. Tracking issue: https://github.com/microsoft/typespec/issues/2826 alias _ForceOrderOfReslutionExtension_ = Fhir.R4.Extension; diff --git a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp index 69e543791ba8..cb2674da20b8 100644 --- a/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp +++ b/specification/ai/HealthInsights/HealthInsights.OpenAPI/service.tsp @@ -31,4 +31,7 @@ model EntraIdToken enum ApiVersion { @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2024_04_01: "2024-04-01", + + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_08_01_preview: "2024-08-01-preview", } diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp deleted file mode 100644 index 6e7f0bdfe3d2..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/model.patienttimeline.tsp +++ /dev/null @@ -1,73 +0,0 @@ -import "../HealthInsights.Common/model.common.request.tsp"; -import "../HealthInsights.Common/model.common.response.tsp"; -import "../HealthInsights.Common/model.common.shared.tsp"; -import "../HealthInsights.Common/model.common.fhir.elements.tsp"; -import "../HealthInsights.Common/model.common.fhir.resources.tsp"; - -using TypeSpec.Rest; - -namespace AzureHealthInsights; - -@doc("The body of the Patient Timeline request.") -model PatientTimelineData { - ...Request; - - @doc("Configuration affecting the Patient Timeline model's inference.") - configuration?: PatientTimelineModelConfiguration; -} - -@doc("Configuration affecting the Patient Timeline model's inference.") -model PatientTimelineModelConfiguration { - ...ModelConfiguration; -} - -@resource("patient-timeline/jobs") -@doc("The response for the Patient Timeline request.") -model PatientTimelineResult - is HealthInsightsOperationStatus<PatientTimelineInferenceResult>; - -@doc("The inference results for the Patient Timeline request.") -model PatientTimelineInferenceResult { - @doc("Results for the patients given in the request.") - patientResults: PatientTimelinePatientResult[]; - - @doc("The version of the model used for inference, expressed as the model date.") - modelVersion: ModelVersion; -} - -@doc("The results of the model's work for a single patient.") -model PatientTimelinePatientResult { - @doc("The identifier given for the patient in the request.") - patientId: string; - - @doc("The model's inferences for the given patient.") - inferences: Array<PatientTimelineInference>; -} - -@doc("An inference made by the Patient Timeline model regarding a patient.") -model PatientTimelineInference is Fhir.R4.Extendible { - @doc("The type of the Patient Timeline inference.") - type: PatientTimelineInferenceType; - - #suppress "@azure-tools/typespec-azure-core/bad-record-type" "model should have additionalProperties" - @doc(""" - FHIR 4.0 representation of the piece of clinical info. - additional dependent resources maybe contained (e.g. MedicationStatement may contain Medication) - -- In the SDK we will have custom mapping to map this type to JsonObject - """) - resource?: Fhir.R4.DomainResource; - - @doc("Time range relevant to this Timeline inference.") - period?: TimePeriod; -} - -@doc("The type of the Patient Timeline inference.") -union PatientTimelineInferenceType { - string, - - @doc("The inference is a timeline event.") - TimelineEvent: "timelineEvent", - - @doc("The inference is a summary item.") - SummaryItem: "summaryItem", -} diff --git a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp b/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp deleted file mode 100644 index bbb9c165dd4e..000000000000 --- a/specification/ai/HealthInsights/HealthInsights.PatientTimeline/route.patienttimeline.tsp +++ /dev/null @@ -1,36 +0,0 @@ -import "@azure-tools/typespec-azure-core"; -import "@typespec/rest"; -import "@typespec/http"; - -import "./model.patienttimeline.tsp"; -import "../HealthInsights.Common/primitives.tsp"; - -using Azure.Core; -using TypeSpec.Rest; -using TypeSpec.Http; - -namespace AzureHealthInsights; - -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) -interface PatientTimeline { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" - @summary("Get Patient Timeline job details") - @tag("PatientTimeline") - @doc("Gets the status and details of the Patient Timeline job.") - @get - @route("/patient-timeline/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<PatientTimelineResult>>; - - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" - @summary("Create Patient Timeline job") - @tag("PatientTimeline") - @doc("Creates a Patient Timeline job with the given request body.") - @pollingOperation(PatientTimeline.getJob) - @route("/patient-timeline/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - PatientTimelineData, - PatientTimelineResult, - PatientTimelineInferenceResult - >; -} diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp index 058ea91474e2..439947c432b6 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/model.trialmatcher.tsp @@ -5,6 +5,8 @@ import "../HealthInsights.Common/model.common.fhir.elements.tsp"; using TypeSpec.Rest; +using TypeSpec.Versioning; + namespace AzureHealthInsights; @doc("The body of the Trial Matcher request.") @@ -28,10 +30,20 @@ model TrialMatcherModelConfiguration { clinicalTrials: ClinicalTrials; } +@added(ApiVersion.v2024_08_01_preview) +@doc("Response for the Trial Matcher request.") @resource("trial-matcher/jobs") -@doc("The response for the Trial Matcher request.") -model TrialMatcherResult - is HealthInsightsOperationStatus<TrialMatcherInferenceResult>; +model TrialMatcherJob { + @doc("The request data for the operation.") + @visibility("read", "create") + jobData?: TrialMatcherData; + + @doc("The result of the operation.") + @visibility("read") + result?: TrialMatcherInferenceResult; + + ...HealthInsightsJobBase; +} @doc("The inference results for the Trial Matcher request.") model TrialMatcherInferenceResult { diff --git a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp index 4e627e65e67c..206c1c06f6f7 100644 --- a/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp +++ b/specification/ai/HealthInsights/HealthInsights.TrialMatcher/route.trialmatcher.tsp @@ -7,29 +7,21 @@ import "../HealthInsights.Common/primitives.tsp"; using Azure.Core; using TypeSpec.Rest; using TypeSpec.Http; +using TypeSpec.Versioning; namespace AzureHealthInsights; -@TypeSpec.Versioning.removed(AzureHealthInsights.ApiVersion.v2024_04_01) +@TypeSpec.Versioning.added(AzureHealthInsights.ApiVersion.v2024_08_01_preview) interface TrialMatcher { - #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Service uses a jobId in the path" @summary("Get Trial Matcher job details") @tag("TrialMatcher") @doc("Gets the status and details of the Trial Matcher job.") @get - @route("/trial-matcher/jobs/{id}") - getJob is HealthInsightsLongRunningPollOperation<BodyParameter<TrialMatcherResult>>; + getJob is HealthInsightsOperations.ResourceRead<TrialMatcherJob>; - #suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "Polling through operation-location" - #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" @summary("Create Trial Matcher job") @tag("TrialMatcher") @doc("Creates a Trial Matcher job with the given request body.") @pollingOperation(TrialMatcher.getJob) - @route("/trial-matcher/jobs") - createJob is HealthInsightsLongRunningRpcOperation< - TrialMatcherData, - TrialMatcherResult, - TrialMatcherInferenceResult - >; + createJob is HealthInsightsOperations.LongRunningResourceCreateOrReplace<TrialMatcherJob>; } diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json new file mode 100644 index 000000000000..0217e4d6a9ab --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsRequest.json @@ -0,0 +1,134 @@ +{ + "operationId": "RadiologyInsights_CreateJob", + "title": "Creates a Radiology Insights job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "resource": { + "jobData": { + "configuration": { + "inferenceOptions": { + "followupRecommendationOptions": { + "includeRecommendationsWithNoSpecifiedModality": false, + "includeRecommendationsInReferences": false, + "provideFocusedSentenceEvidence": false + }, + "findingOptions": { + "provideFocusedSentenceEvidence": false + } + }, + "inferenceTypes": [ + "finding", + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "criticalResult", + "criticalRecommendation", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "locale": "en-US", + "verbose": false, + "includeEvidence": true + }, + "patients": [ + { + "id": "sample id 1", + "details": { + "sex": "male", + "clinicalInfo": [ + { + "resourceType": "Observation", + "status": "unknown", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0018802", + "display": "MalignantNeoplasms" + } + ] + }, + "valueBoolean": "true" + } + ] + }, + "encounters": [ + { + "id": "encounterid1", + "period": { + "start": "2023-12-21T00:00:00", + "end": "2023-12-21T00:00:00" + }, + "class": "inpatient" + } + ], + "patientDocuments": [ + { + "type": "note", + "clinicalType": "radiologyReport", + "id": "docid1", + "language": "en", + "authors": [ + { + "id": "authorid1", + "fullName": "authorname1" + } + ], + "specialtyType": "radiology", + "createdAt": "2023-12-21T00:00:00", + "administrativeMetadata": { + "orderedProcedures": [ + { + "code": { + "coding": [ + { + "system": "Http://hl7.org/fhir/ValueSet/cpt-all", + "code": "111111", + "display": "CT ABD/PELVIS" + } + ] + }, + "description": "CT ABD/PELVIS" + } + ], + "encounterId": "encounterid1" + }, + "content": { + "sourceType": "inline", + "value": "[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\n[**Hospital 4**] MEDICAL CONDITION:\r\n52 year old man with urosepsis, s/p nephrostogram on [**4-12**], today with acute\r\nSOB, fever, rigors.\r\nREASON FOR THIS EXAMINATION:\r\n? PE, evidence of pneumonia\r\nNo contraindications for IV contrast\r\n______________________________________________________________________________\r\nFINAL REPORT\r\nINDICATION: History of urosepsis status post nephrostogram on [**4-12**], today\r\nwith acute shortness of breath, fevers, and rigors. Also reported hematocrit\r\ndrop. Evaluate for pulmonary embolism or hematoma.\r\nCOMPARISON: Non-contrast CT of the abdomen and pelvis dated [**2143-4-11**].\r\nTECHNIQUE: MDCT acquired images of the chest, abdomen, and pelvis were\r\nobtained before and after the administration of IV contrast. A true CT\r\nangiogram could not be performed due to lack of appropriate intravenous\r\naccess.\r\nCT OF THE CHEST WITHOUT AND WITH IV CONTRAST: Evaluation of the pulmonary\r\narteries is limited with no large central pulmonary embolism seen. Evaluation\r\nof the segmental and subsegmental branches is limited. There is a central\r\nvenous catheter that terminates in the right atrium. There are numerous small\r\nmesenteric and axillary lymph nodes that do not meet CT criteria for\r\npathologic enlargement. There are coronary artery calcifications. There are\r\nbilateral small layering pleural effusions with associated compressive\r\natelectasis. The images of the lungs are limited due to motion. There\r\nappears to be a patchy, predominantly ground-glass opacity in both lower\r\nlobes, left worse than right. The aorta appears intact. There is debris in\r\nthe trachea.\r\nCT OF THE ABDOMEN WITHOUT AND WITH IV CONTRAST: There is high-density\r\nmaterial tracking along the course of a dilated left ureter consistent with\r\nhemorrhage that is new compared to the previous study. New stranding in the\r\nleft retroperitoneum is also present consistent with retroperitoneal\r\nhemorrhage. Perinephric stranding is present, as was seen on the previous\r\nstudy. The degree of dilatation of the left ureter is unchanged. Several\r\nfoci of air outside of the collecting system are present, presumably\r\npostprocedural in nature. Contrast-enhanced images show abnormal perfusion of\r\nthe left kidney with a striated appearance, most severe at the upper pole with\r\nperipheral wedge-shaped hypoenhancing areas also present on top of the areas\r\nof reduced perfusion. No active extravasation of contrast is seen. The right\r\nkidney is normal. The liver, spleen, and adrenal glands are unremarkable.\r\nPancreas is unremarkable with slightly prominent distal common bile duct\r\nmeasuring up to 8-9 mm. There is a small cystic lesion measuring 5 mm at the\r\nhead of the pancreas (series 10, image 143). Small and large bowel are\r\n(Over)\r\n[**2143-4-13**] 5:04 PM\r\nCT ABD W&W/O C; CT CHEST W&W/O C Clip # [**Clip Number (Radiology) 38350**]\r\nCT PELVIS W&W/O C\r\nReason: ? PE, evidence of pneumonia\r\nAdmitting Diagnosis: SEPSIS\r\nField of view: 38 Contrast: OPTIRAY Amt: 130\r\n______________________________________________________________________________\r\nFINAL REPORT\r\n(Cont)\r\ngrossly unremarkable. The aorta, celiac artery, superior mesenteric artery,\r\ninferior mesenteric artery, and renal arteries appear patent.\r\nCT OF THE PELVIS WITHOUT AND WITH IV CONTRAST: The prostate gland is\r\nenlarged. Thickening of the bladder wall is again demonstrated. Several foci\r\nof air within the bladder are presumably secondary to the Foley catheter. The\r\nrectum and sigmoid colon are unremarkable.\r\nBONE WINDOWS: There are degenerative changes with no suspicious lytic or\r\nsclerotic lesions.\r\nIMPRESSION:\r\n1. New high-density material surrounding the left ureter and tracking within\r\nthe retroperitoneum consistent with hemorrhage.\r\n2. Abnormal perfusion of the left kidney, most severe at the upper pole.\r\nFindings are consistent with pyelonephritis. Edema and abnormal perfusion at\r\nthe upper pole and interpolar region medially with multiple peripheral\r\nhypoenhancing wedge- shaped regions likely represent ischemia and a component\r\nof infarction.\r\n3. Limited examination for pulmonary embolism due to suboptimal contrast\r\nbolus with no large central embolus seen. Evaluation of distal segmental and\r\nsubsegmental branches is limited.\r\n4. Small bilateral layering pleural effusions with associated compressive\r\natelectasis. Patchy predominantly ground-glass opacities in both lower lobes,\r\nleft worse than right could represent pneumonia or pneumonitis.\r\n5. 5mm cystic lesion in the head of the pancreas. Recommend 1 year follow up.\r\nThe above was discussed with Dr. [**First Name8 (NamePattern2) 951**] [**Last Name (NamePattern1) 1238**] at approximately 6:30 p.m. on\r\n[**2143-4-13**].\r\n" + } + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/radiology-insights/jobs/{id}?api-version=2024-04-01" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json new file mode 100644 index 000000000000..abbdff32da9a --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulRadiologyInsightsResponse.json @@ -0,0 +1,33454 @@ +{ + "operationId": "RadiologyInsights_GetJob", + "title": "Gets the status and details of the Radiology Insights job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "result": { + "patientResults": [ + { + "patientId": "sample id 1", + "inferences": [ + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6839", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4466 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4508 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6840", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246501002", + "display": "TECHNIQUE (ATTRIBUTE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4572 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4586 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4608 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4621 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4633 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6856", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 162 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6857", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 178 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6858", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 210 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6859", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 402 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 457 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6860", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 517 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6861", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 533 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for exam" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6862", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 700 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6863", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 867 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6864", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35566002", + "display": "HEMATOMA (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 857 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 879 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6865", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "81040000", + "display": "PULMONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID974", + "display": "PULMONARY ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28586", + "display": "SET OF PULMONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1262 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1273 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1301 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1307 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1315 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1325 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6866", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1658 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1668 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1691 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6867", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1683 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1717 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1730 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6868", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + }, + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2117 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6870", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3277 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6871", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3293 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "reason for encounter" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6872", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91302008", + "display": "SEPSIS (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3325 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "46241-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "HOSPITAL ADMISSION DIAGNOSIS - REPORTED" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6874", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4237 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6875", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52674009", + "display": "ISCHEMIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4412 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6876", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55641003", + "display": "INFARCT (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4441 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6877", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "bolus" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4492 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4529 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6878", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41699000", + "display": "EFFUSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "135650694", + "display": "CAUSES OF HARM (QUALIFIER VALUE)" + } + ] + }, + "valueString": "compressive;;atelectasis" + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "27123005", + "display": "BILIARY SLUDGE (DISORDER)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4647 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4653 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4663 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4680 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6879", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46621007", + "display": "ATELECTASIS (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71173004", + "display": "COMPRESSION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "3120008", + "display": "PLEURAL MEMBRANE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1362", + "display": "PLEURA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4672 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4706 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4719 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6882", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 464 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6883", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 469 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6884", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 476 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "11329-0" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "History" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6885", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "390870001", + "display": "SHORT OF BREATH DRESSING/UNDRESSING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64572001", + "display": "DISEASE (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 769 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 779 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 782 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6886", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "386661006", + "display": "FEVER (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 790 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6887", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43724002", + "display": "CHILL (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "16046003", + "display": "MUSCLE RIGIDITY (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "246452003", + "display": "CHRONICITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "255363002", + "display": "SUDDEN (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 763 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 802 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "18785-6" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Reason For Study" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6889", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "18115005", + "display": "PATHOLOGIC CALCIFICATION, CALCIFIED STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41801008", + "display": "CORONARY ARTERY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28727", + "display": "SET OF CORONARY ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID35862", + "display": "CORONARY ARTERY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1614 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1623 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1630 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6890", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1819 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1841 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1854 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1865 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1870 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1877 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1884 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1900 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6891", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "257159000", + "display": "DEBRIS (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "955009", + "display": "BRONCHIAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1247", + "display": "TRACHEA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1943 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1958 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6892", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2026 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2040 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6893", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2080 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2088 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2093 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6894", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2177 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2200 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6895", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "118247008", + "display": "RADIOLOGIC FINDING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2278 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2290 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6896", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "25322007", + "display": "DILATATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "58158008", + "display": "STABLE (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2363 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2381 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2386 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2396 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6897", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "outside" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2417 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2422 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2425 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2429 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6898", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272141005", + "display": "SEVERITIES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24484000", + "display": "SEVERE (SEVERITY MODIFIER) (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral;;wedge-shaped" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2616 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2630 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2636 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2647 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2658 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2671 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2675 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2685 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6899", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260400001", + "display": "REDUCED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "reduced" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2728 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2736 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6900", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "76676007", + "display": "EXTRAVASATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "active" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2751 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2758 + }, + { + "url": "length", + "valueInteger": 13 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2772 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2775 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6901", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2991 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2997 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3004 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3021 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3023 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3034 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3039 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3042 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3046 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6902", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89977008", + "display": "INCREASED THICKNESS (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30135", + "display": "WALL OF URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3704 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3715 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3718 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3722 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3730 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6903", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15158005", + "display": "AIR (SUBSTANCE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "89837001", + "display": "URINARY BLADDER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID237", + "display": "URINARY BLADDER" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3776 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3791 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6904", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362975008", + "display": "DEGENERATIVE DISORDER (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3922 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3935 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6905", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "43846000", + "display": "SCLEROSIS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "272673000", + "display": "BONE STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28569", + "display": "SET OF BONE ORGANS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13197", + "display": "BONE ORGAN" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "suspicious;;lytic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3897 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3951 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3962 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3972 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3982 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6907", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "267038008", + "display": "EDEMA (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45851105", + "display": "REGION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4254 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4306 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4317 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6908", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID205", + "display": "KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "peripheral" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4291 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4297 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4324 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4347 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4359 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4363 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4373 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4378 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4380 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4387 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6909", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260413007", + "display": "NONE (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "55584005", + "display": "EMBOLUS (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "large;;central" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4482 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4543 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4549 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4557 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6910", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "128305008", + "display": "ABNORMALLY OPAQUE STRUCTURE (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "51440002", + "display": "RIGHT AND LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "Patchy" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4732 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4753 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4766 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4779 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6911", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "367643001", + "display": "CYST (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "52988006", + "display": "LESION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID171", + "display": "HEAD OF PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "value": 5.0, + "unit": "MILLIMETER" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4867 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4868 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4871 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4878 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4892 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4897 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4900 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4904 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6912", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "164836004", + "display": "MUSCULOSKELETAL MOVEMENT (OBSERVABLE ENTITY)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1787 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6913", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID223", + "display": "RENAL COLLECTING SYSTEM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "postprocedural" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2444 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2455 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2487 + }, + { + "url": "length", + "valueInteger": 14 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6914", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29663", + "display": "LEFT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2571 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2576 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2590 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2599 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6915", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "28273000", + "display": "BILE DUCT STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID199", + "display": "COMMON BILE DUCT" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "4657009", + "display": "PROMINENT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://radlex.org", + "code": "246115007", + "display": "SIZE (ATTRIBUTE)" + } + ] + }, + "valueQuantity": { + "comparator": "<=" + }, + "interpretation": [ + { + "coding": [ + { + "code": "15240007", + "display": "CURRENT" + } + ] + } + ] + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2911 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2920 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2930 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2937 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2944 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2949 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2965 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2971 + }, + { + "url": "length", + "valueInteger": 3 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2975 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6916", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "260376009", + "display": "ENLARGED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "41216001", + "display": "PROSTATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID343", + "display": "PROSTATE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3674 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3683 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3689 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3693 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6917", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "397685007", + "display": "FINDING RELATED TO FOCUSING (FINDING)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3767 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3773 + }, + { + "url": "length", + "valueInteger": 2 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6921", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1912 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6922", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "64033007", + "display": "KIDNEY STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID29662", + "display": "RIGHT KIDNEY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2798 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2805 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6923", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23451007", + "display": "ADRENAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "10200004", + "display": "LIVER STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "78961009", + "display": "SPLENIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28752", + "display": "SET OF ADRENAL GLANDS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID88", + "display": "ADRENAL GLAND" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID58", + "display": "LIVER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID86", + "display": "SPLEEN" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2828 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2835 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2847 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2855 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6924", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15776009", + "display": "PANCREATIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID170", + "display": "PANCREAS" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2881 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6925", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281471001", + "display": "STRUCTURE OF ABDOMINAL BLOOD VESSEL (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "244261004", + "display": "ABDOMINAL VISCERAL ARTERY (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "56400007", + "display": "STRUCTURE OF RENAL VEIN (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "281157001", + "display": "SYSTEMIC VASCULAR STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID906", + "display": "CELIAC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID927", + "display": "SUPERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID939", + "display": "INFERIOR MESENTERIC ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID936", + "display": "RENAL ARTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID49729", + "display": "SET OF RENAL ARTERIES" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID480", + "display": "AORTA" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID50393", + "display": "SET OF ABDOMINAL ARTERIES" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3508 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3515 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3522 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3530 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3539 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3550 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3556 + }, + { + "url": "length", + "valueInteger": 1 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3559 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3591 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3597 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "final assessment" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6926", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "91722005", + "display": "PHYSICAL ANATOMICAL ENTITY (BODY STRUCTURE)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "17621005", + "display": "NORMAL (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "71854001", + "display": "COLON STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "34402009", + "display": "RECTUM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID162", + "display": "SIGMOID COLON" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID163", + "display": "RECTUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3853 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3864 + }, + { + "url": "length", + "valueInteger": 7 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 3872 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "displayName", + "valueString": "ct test" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6930", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6936", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "15425007", + "display": "PERITONEUM (SEROUS MEMBRANE) STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID33180", + "display": "MESENTERY" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1509 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6938", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "36692007", + "display": "KNOWN (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "30746006", + "display": "LYMPHADENOPATHY (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "47109002", + "display": "STRUCTURE OF LYMPH NODE OF THORAX (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID28849", + "display": "AXILLARY LYMPH NODE GROUP" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1517", + "display": "AXILLARY LYMPH NODE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "288533004", + "display": "CHANGE VALUES (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "35105006", + "display": "INCREASED (QUALIFIER VALUE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "362981000", + "display": "QUALIFIER VALUE (QUALIFIER VALUE)" + } + ] + }, + "valueString": "small;;pathologic" + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1502 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1524 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1533 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1539 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1579 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 1590 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "29306-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "SURGERY PROCEDURE" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6940", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "122489005", + "display": "URINARY SYSTEM STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID30845", + "display": "LEFT URETER" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4051 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4056 + }, + { + "url": "length", + "valueInteger": 6 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6943", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7147002", + "display": "NEW (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "127558001", + "display": "DENSITY FINDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4013 + }, + { + "url": "length", + "valueInteger": 12 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4026 + }, + { + "url": "length", + "valueInteger": 8 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6946", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6950", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4798 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "finding", + "finding": { + "resourceType": "Observation", + "id": "6952", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "23583003", + "display": "INFLAMMATION (MORPHOLOGIC ABNORMALITY)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4849 + }, + { + "url": "length", + "valueInteger": 11 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "code", + "valueString": "19005-8" + }, + { + "url": "codingSystem", + "valueString": "2.16.840.1.113883.6.1" + }, + { + "url": "codingSystemName", + "valueString": "http://loinc.org" + }, + { + "url": "displayName", + "valueString": "Impresssions" + } + ], + "url": "section" + } + ] + }, + { + "kind": "followupCommunication", + "communicatedAt": [ + "2023-12-21T18:30:00" + ], + "recipient": [ + "doctor" + ], + "wasAcknowledged": true, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4957 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4972 + }, + { + "url": "length", + "valueInteger": 76 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5066 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 5080 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6869", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2195 + }, + { + "url": "length", + "valueInteger": 4 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "7771000", + "display": "LEFT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2248 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 2265 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "RETROPERITONEAL HEMORRHAGE", + "finding": { + "resourceType": "Observation", + "id": "6933", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "162432007", + "display": "SYMPTOM: GENERALIZED (FINDING)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "2931005", + "display": "PROBABLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131148009", + "display": "BLEEDING (FINDING)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "699600004", + "display": "STRUCTURE OF RETROPERITONEAL SPACE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID431", + "display": "RETROPERITONEUM" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": false + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4088 + }, + { + "url": "length", + "valueInteger": 15 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4120 + }, + { + "url": "length", + "valueInteger": 10 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "kind": "criticalResult", + "result": { + "description": "PNEUMONIA", + "finding": { + "resourceType": "Observation", + "id": "6948", + "status": "unknown", + "category": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "439401001", + "display": "DIAGNOSIS (OBSERVABLE ENTITY)" + } + ] + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "404684003", + "display": "CLINICAL FINDING (FINDING)" + } + ] + }, + "interpretation": [ + { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "60022001", + "display": "POSSIBLE DIAGNOSIS (CONTEXTUAL QUALIFIER) (QUALIFIER VALUE)" + } + ] + } + ], + "component": [ + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "131195008", + "display": "SUBJECT OF INFORMATION (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "233604007", + "display": "PNEUMONIA (DISORDER)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "39607008", + "display": "LUNG STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID1301", + "display": "LUNG" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13437", + "display": "LUNGS" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "722871000000108", + "display": "ANATOMY (QUALIFIER VALUE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4784 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + }, + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4790 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://radlex.org", + "code": "RID13406", + "display": "ANATOMICAL LOBE" + } + ] + } + }, + { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "45651917", + "display": "LATERALITY (ATTRIBUTE)" + } + ] + }, + "valueCodeableConcept": { + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4814 + }, + { + "url": "length", + "valueInteger": 5 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "24028007", + "display": "RIGHT (QUALIFIER VALUE)" + } + ] + } + }, + { + "code": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "46150521", + "display": "MULTIPLE (QUALIFIER VALUE)" + } + ] + }, + "valueBoolean": true + } + ] + } + }, + "extension": [ + { + "extension": [ + { + "url": "reference", + "valueReference": { + "reference": "docid1" + } + }, + { + "url": "offset", + "valueInteger": 4836 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ] + }, + { + "procedureCodes": [ + { + "coding": [ + { + "system": "http://loinc.org", + "code": "44115-4", + "display": "CT ABDOMEN AND PELVIS" + } + ] + } + ], + "imagingProcedures": [ + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "113345001", + "display": "ABDOMINAL STRUCTURE (BODY STRUCTURE)" + } + ] + } + }, + { + "modality": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "77477000", + "display": "COMPUTERIZED AXIAL TOMOGRAPHY (PROCEDURE)" + } + ] + }, + "anatomy": { + "coding": [ + { + "system": "http://snomed.info/sct", + "code": "12921003", + "display": "PELVIC STRUCTURE (BODY STRUCTURE)" + } + ] + } + } + ], + "orderedProcedure": { + "code": { + "coding": [ + { + "code": "111111" + } + ] + }, + "description": "CT ABD/PELVIS." + }, + "kind": "radiologyProcedure" + } + ] + } + ], + "modelVersion": "2024-01-19-preview" + }, + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12", + "createdAt": "2024-01-29T19:50:52Z", + "expiresAt": "2024-01-30T19:50:52Z", + "updatedAt": "2024-01-29T19:51:12Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json new file mode 100644 index 000000000000..7dba7841e236 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherRequest.json @@ -0,0 +1,3009 @@ +{ + "operationId": "TrialMatcher_CreateJob", + "title": "Creates a Trial Matcher job with the given request body.", + "parameters": { + "endpoint": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version={api-version}", + "api-version": "2024-08-01-preview", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d11", + "resource": { + "jobData": { + "patients": [ + { + "id": "Patient ID Example 2", + "details": { + "sex": "female", + "birthDate": "1976-09-10", + "clinicalInfo": [ + { + "resourceType": "Condition", + "code": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "Tuberculosis" + } + ] + } + }, + { + "code": { + "coding": [ + { + "code": "C0006826", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + }, + { + "code": { + "coding": [ + { + "code": "C0018802", + "display": "MalignantNeoplasms", + "system": "http://www.nlm.nih.gov/research/umls" + } + ] + }, + "resourceType": "Observation", + "status": "unknown", + "valueBoolean": true + } + ] + } + } + ], + "configuration": { + "verbose": true, + "includeEvidence": true, + "clinicalTrials": { + "customTrials": [ + { + "resourceType": "ResearchStudy", + "contained": [ + { + "resourceType": "PlanDefinition", + "id": "1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "name": "Rilpivirine", + "title": "Rilpivirine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Rilpivirine", + "description": "Patients will receive rilpivirine tablet 25 milligram or adjusted dose orally once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "name": "Zidovudine", + "title": "Zidovudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Zidovudine", + "description": "Type=exact, form= appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8958e19c-17db-4152-874d-cf68c3918769", + "name": "Abacavir", + "title": "Abacavir", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Abacavir", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "name": "Tenofovir disoproxil fumarate", + "title": "Tenofovir disoproxil fumarate", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Tenofovir disoproxil fumarate", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "ec554338-0167-4034-98dd-ee1cd5860430", + "name": "Lamivudine", + "title": "Lamivudine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Lamivudine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "PlanDefinition", + "id": "8ddc695e-efab-441e-bd49-c1decfdb80bf", + "name": "Emtricitabine", + "title": "Emtricitabine", + "type": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type", + "code": "workflow-definition", + "display": "Workflow Definition" + } + ] + }, + "status": "active", + "action": [ + { + "title": "Emtricitabine", + "description": "Type=exact, form=appropriate pediatric formulation, unit=mg, route=oral. The patients will receive this selected NRTI once daily for 240 weeks.", + "code": [ + { + "text": "Drug" + } + ] + } + ] + }, + { + "resourceType": "Group", + "id": "73e459c6-9b92-479d-b122-0712d18a9131", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0723712", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "220281", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000046327", + "display": "therapeutic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "7381", + "display": "therapeutic" + } + ], + "text": "therapeutic" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0086413", + "display": "HIV vaccine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C1325", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "347399", + "display": "HIV vaccine" + }, + { + "system": "http://hl7.org/fhir/sid/cvx", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v2.5", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "61", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D016915", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000015914", + "display": "HIV vaccine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3059-5000", + "display": "HIV vaccine" + }, + { + "system": "http://loinc.org", + "code": "LP183501-8", + "display": "HIV vaccine" + } + ], + "text": "HIV vaccine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "127161fc-b30f-4efc-ae14-2d064dc6084b", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#73e459c6-9b92-479d-b122-0712d18a9131", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "HIV drug", + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "somecode", + "display": "somecode" + } + ] + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c26ff014-3da3-419b-9338-6e4b4d49031e", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "nevirapine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "nevirapine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "nevirapine" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "nevirapine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "nevirapine" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "nevirapine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "nevirapine" + } + ], + "text": "nevirapine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "zidovudine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "zidovudine" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "zidovudine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "zidovudine" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "zidovudine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "zidovudine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "zidovudine" + } + ], + "text": "zidovudine" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c26ff014-3da3-419b-9338-6e4b4d49031e", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "c31f130b-c0e7-411a-a32b-57f07ea62559", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#127161fc-b30f-4efc-ae14-2d064dc6084b", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#9ab418f5-9bf1-4bb7-a55f-0eed1244addb", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D019829", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00238", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000712787", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "99DK7FVK1H", + "display": "NVP" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4020991", + "display": "NVP" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C29277", + "display": "NVP" + }, + { + "system": "http://snomed.info/sctv", + "code": "108704001", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "75157", + "display": "NVP" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG01", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "006062", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "eiK..", + "display": "NVP" + }, + { + "system": "http://loinc.org", + "code": "LP21317-0", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "175112", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2010013984", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000016392", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2030", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "4007-0088", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "53654", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m56485", + "display": "NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000656", + "display": "NVP" + } + ], + "text": "NVP" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0043474", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040121", + "display": "AZT" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015215", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2109-4800", + "display": "AZT" + }, + { + "system": "http://snomed.info/sctv", + "code": "387151007", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "05223", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "41905", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB00495", + "display": "AZT" + }, + { + "system": "http://snomed.info/sct", + "code": "C-55B60", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "ei5..", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000013273", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044478", + "display": "AZT" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4019502", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "11413", + "display": "AZT" + }, + { + "system": "http://loinc.org", + "code": "LP16744-2", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0602670", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m89510", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "2650", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C947", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "4B9XT59T7S", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00034", + "display": "AZT" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AF01", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000671", + "display": "AZT" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "003019", + "display": "AZT" + } + ], + "text": "AZT" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#1d943af4-3b3e-4363-9e82-bc0e59b8c3e1", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0282474", + "display": "mother-to-child transmission" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D018445", + "display": "mother-to-child transmission" + } + ], + "text": "mother-to-child transmission" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationClass" + } + ], + "text": "ARVs" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "10160-0", + "display": "History of medication use" + } + ], + "text": "History of medication use" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#8eddc9da-cdfc-43d9-a9fc-5306d66362f3", + "type": "Group" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "583a9867-c95e-4225-bd19-47c324e26c0f", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "Plasma viral load" + }, + "valueQuantity": { + "value": 100000, + "comparator": ">" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "35d36257-564c-48e0-9c65-b2551870b0bb", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "MedicationName" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0132326", + "display": "with NVP" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D005838", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "20920", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000005452", + "display": "genotypic" + }, + { + "system": "http://loinc.org", + "code": "LP345004-8", + "display": "genotypic" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16631", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sctv", + "code": "145681002", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000660739", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000002877", + "display": "genotypic" + }, + { + "system": "http://snomed.info/sct", + "code": "F-E0280", + "display": "genotypic" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1258-5784", + "display": "genotypic" + } + ], + "text": "genotypic" + }, + "valueCodeableConcept": { + "text": "value:" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "SymptomOrSign" + } + ], + "text": "non-nucleoside reverse transcriptase inhibitor resistance" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "one-or-more", + "display": "One Or More" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0041296", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "41", + "display": "tuberculosis" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31051", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000012630", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sctv", + "code": "56717001", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A1...", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D014376", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "INFECT", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000513048", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU076452", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021870", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "0923", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-14800", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "A15-A19", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00198", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U004166", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://loinc.org", + "code": "LA10513-2", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85138408", + "display": "tuberculosis" + }, + { + "system": "http://snomed.info/sct", + "code": "D-0188", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U004809", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "A70012", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "A15-A19.9", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccs_10", + "code": "1", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C3423", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0368-2498", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004838", + "display": "tuberculosis" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "010-018.99", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "A70", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "754", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1018255", + "display": "tuberculosis" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "54410", + "display": "tuberculosis" + } + ], + "text": "tuberculosis" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "active" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "treated for tuberculosis" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + } + ] + }, + { + "resourceType": "Group", + "id": "2a43edc4-0000-0000-0000-000000000000", + "extension": [ + { + "id": "GroupQuantifier", + "valueCoding": { + "system": "http://hl7.org/fhir/action-selection-behavior", + "code": "all", + "display": "All" + } + } + ], + "type": "person", + "actual": false, + "characteristic": [ + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "text": "human immuno deficiency virus infection" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ExaminationName" + } + ], + "text": "HIV-1 plasma viral load" + }, + "valueQuantity": { + "value": 500, + "unit": "HIV-1" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#c31f130b-c0e7-411a-a32b-57f07ea62559", + "type": "Group" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#4ee79ae8-bf19-4474-a72e-3616ac0a9fdf", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#583a9867-c95e-4225-bd19-47c324e26c0f", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#35d36257-564c-48e0-9c65-b2551870b0bb", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "TreatmentName" + } + ], + "text": "disallowed concomitant therapy" + }, + "valueCodeableConcept": { + "coding": [ + { + "system": "http://loinc.org", + "code": "47519-4", + "display": "History of Procedures" + } + ], + "text": "History of Procedures" + }, + "exclude": false + }, + { + "code": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "Diagnosis" + } + ], + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "Acquired Immunodeficiency Syndrome" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "Acquired Immunodeficiency Syndrome" + } + ], + "text": "Acquired Immunodeficiency Syndrome" + }, + "valueCodeableConcept": { + "extension": [ + { + "id": "CharacteristicCodeType", + "valueString": "ConditionQualifier" + } + ], + "text": "currently active" + }, + "exclude": false + }, + { + "code": { + "text": "LogicalGroup" + }, + "valueReference": { + "reference": "#bdcbe31b-c0f7-4205-9b75-34a8418cfdb2", + "type": "Group" + }, + "exclude": true + }, + { + "code": { + "coding": [ + { + "system": "http://loinc.org", + "code": "63900-5", + "display": "age" + } + ], + "text": "age" + }, + "valueRange": { + "low": { + "value": 6, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + }, + "high": { + "value": 17, + "unit": "years", + "system": "http://unitsofmeasure.org", + "code": "a" + } + }, + "exclude": false + } + ] + } + ], + "identifier": [ + { + "use": "official", + "value": "CR002677", + "assigner": { + "display": "Janssen Sciences Ireland UC" + } + }, + { + "use": "usual", + "value": "NCTtesttest", + "assigner": { + "display": "ClinicalTrials.gov" + } + }, + { + "use": "secondary", + "value": "TMC278-TiDP38-C213" + }, + { + "use": "secondary", + "value": "2008-001696-30" + } + ], + "title": "A Study to Evaluate the Pharmacokinetics, Safety, Tolerability, and Antiviral Efficacy of Rilpivirine (TMC278) in Human Immunodeficiency Virus Infected Adolescents and Children Aged Greater Than or Equal to 6 Years", + "protocol": [ + { + "reference": "#1b5bc5d5-9413-43f7-9da6-70db2606b7cd", + "type": "PlanDefinition", + "display": "Rilpivirine" + }, + { + "reference": "#30f45f8a-a0f5-4eed-a5e1-4819137c10b2", + "type": "PlanDefinition", + "display": "Zidovudine" + }, + { + "reference": "#8958e19c-17db-4152-874d-cf68c3918769", + "type": "PlanDefinition", + "display": "Abacavir" + }, + { + "reference": "#bef1c7b6-1e1a-4fb4-8bcd-b9d965dd09e6", + "type": "PlanDefinition", + "display": "Tenofovir disoproxil fumarate" + }, + { + "reference": "#ec554338-0167-4034-98dd-ee1cd5860430", + "type": "PlanDefinition", + "display": "Lamivudine" + }, + { + "reference": "#8ddc695e-efab-441e-bd49-c1decfdb80bf", + "type": "PlanDefinition", + "display": "Emtricitabine" + } + ], + "status": "active", + "primaryPurposeType": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + "phase": { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-phase", + "version": "4.0.0", + "code": "phase-2", + "display": "Phase 2" + } + ], + "text": "Phase 2" + }, + "category": [ + { + "coding": [ + { + "system": "http://terminology.hl7.org/CodeSystem/research-study-prim-purp-type", + "version": "4.0.0", + "code": "treatment", + "display": "Treatment" + } + ], + "text": "Treatment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Interventional", + "display": "Interventional" + } + ], + "text": "Interventional" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "Single Group Assignment", + "display": "Single Group Assignment" + } + ], + "text": "Single Group Assignment" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "None (Open Label)", + "display": "None (Open Label)" + } + ], + "text": "None (Open Label)" + }, + { + "coding": [ + { + "system": "http://clinicaltrials.gov", + "code": "NoneRetained", + "display": "NoneRetained" + } + ], + "text": "NoneRetained" + } + ], + "focus": [ + { + "text": "Drug" + } + ], + "condition": [ + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + } + ], + "contact": [ + { + "name": "Use link at the bottom of the page to see if you qualify for an enrolling site (see list). If you still have questions:", + "telecom": [ + { + "system": "email", + "value": "JNJ.CT@sylogent.com", + "use": "work" + } + ] + }, + { + "name": "StudyDirector Janssen Sciences Ireland UC Clinical Trial" + } + ], + "keyword": [ + { + "text": "HIV Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0599685", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D044966", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "250564", + "display": "Antiretroviral" + }, + { + "system": "http://snomed.info/sctv", + "code": "713540004", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0715-4905", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh2003006231", + "display": "Antiretroviral" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000042059", + "display": "Antiretroviral" + } + ], + "text": "Antiretroviral" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0019704", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sctv", + "code": "243598007", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cdisc", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X73kd", + "display": "HIV-1" + }, + { + "system": "http://loinc.org", + "code": "MTHU009425", + "display": "HIV-1" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C14220", + "display": "HIV-1" + }, + { + "system": "http://snomed.info/sct", + "code": "L-35211", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10020455", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "3130-7357", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D015497", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ncbi", + "code": "11676", + "display": "HIV-1" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006190", + "display": "HIV-1" + } + ], + "text": "HIV-1" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0001175", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "B20", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ram", + "code": "DX272", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/qmr", + "code": "R0121441", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "A788z", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sctv", + "code": "186715004", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "1684", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000000649", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10000563", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "31779", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/psy", + "code": "00595", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000163", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000023174", + "display": "AIDS" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/cst", + "code": "HIV SYND", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B90001", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/icpc2eeng", + "code": "B90", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_cptac", + "code": "C2851", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medlineplus", + "code": "1", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/bi", + "code": "BI00716", + "display": "AIDS" + }, + { + "system": "http://snomed.info/sct", + "code": "DE-36310", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/who", + "code": "1233", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU080583", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000044365", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-6271", + "display": "AIDS" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "042", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "023", + "display": "AIDS" + }, + { + "system": "http://loinc.org", + "code": "LA10430-9", + "display": "AIDS" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1014998", + "display": "AIDS" + } + ], + "text": "AIDS" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0008059", + "display": "Children" + }, + { + "system": "http://snomed.info/sct", + "code": "S-10170", + "display": "Children" + }, + { + "system": "http://snomed.info/sctv", + "code": "67822003", + "display": "Children" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85023418", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000007008", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D002648", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000002765", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0060058", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "0635-1343", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch", + "code": "U005340", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hl7v3.0", + "code": "CHD", + "display": "Children" + }, + { + "system": "http://loinc.org", + "code": "LA9949-4", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C16423", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/dxp", + "code": "U000730", + "display": "Children" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "C16423", + "display": "Children" + } + ], + "text": "Children" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1566826", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "309423", + "display": "Rilpivirine" + }, + { + "system": "http://www.whocc.no/atc", + "code": "J05AG05", + "display": "Rilpivirine" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C76929", + "display": "Rilpivirine" + }, + { + "system": "http://snomed.info/sctv", + "code": "703777002", + "display": "Rilpivirine" + }, + { + "system": "http://loinc.org", + "code": "MTHU042155", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB08864", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d07776", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "FI96A8X663", + "display": "Rilpivirine" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4030730", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "1102270", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "4688", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m7163", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D000068696", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU002683", + "display": "Rilpivirine" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "013795", + "display": "Rilpivirine" + } + ], + "text": "Rilpivirine (TMC278)" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C1521725", + "display": "Pediatric" + }, + { + "system": "http://loinc.org", + "code": "LP100615-6", + "display": "Pediatric" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C39299", + "display": "Pediatric" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000046245", + "display": "Pediatric" + } + ], + "text": "Pediatric" + }, + { + "text": "Human Immuno Deficiency (HIV) Infection" + }, + { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0021051", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sctv", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "39922", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000045724", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10-cm", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-10", + "code": "D84.9", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "D-4600", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "1560-5885", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mdr", + "code": "10021460", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006602", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C3131", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/hpo", + "code": "HP:0002721", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/omim", + "code": "MTHU032911", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "234532001", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "B99011", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "2156", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007153", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nichd", + "code": "C39725", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icd-9-cm", + "code": "279.3", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "X20GZ", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://snomed.info/sct", + "code": "F-C0450", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/costar", + "code": "U000355", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://loinc.org", + "code": "MTHU054768", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nanda-i", + "code": "02515", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh85064574", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "1007151", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://hl7.org/fhir/sid/icpc-2", + "code": "MTHU037620", + "display": "Immunologic Deficiency Syndromes" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000004832", + "display": "Immunologic Deficiency Syndromes" + } + ], + "text": "Immunologic Deficiency Syndromes" + }, + { + "coding": [ + { + "system": "http://hl7.org/fhir/administrative-gender", + "code": "Unknown", + "display": "Unknown" + } + ], + "text": "Unknown" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "0", + "display": "Age keyword for indexing - 0" + } + ], + "text": "Age keyword for indexing - 0" + }, + { + "coding": [ + { + "system": "http://decades-value-set.ctm.microsoft.org", + "code": "10", + "display": "Age keyword for indexing - 10" + } + ], + "text": "Age keyword for indexing - 10" + } + ], + "description": "This is a Phase II, open-label (all people involved know the identity of the assigned drug)\r\n and single arm study. The study will consist of a screening period of maximum 8 weeks, an\r\n initial treatment period of 48 weeks, a post week 48 treatment extension period of 4 years,\r\n and a 4 week follow-up period. A follow-up period will take place regardless of the presence\r\n of serious adverse events (SAEs) if patients withdraw early (ie, before Week 48) or if\r\n patients do not participate in the extension after Week 48; after Week 48, a 4-week follow-up\r\n visit is only required in case of ongoing (S)AEs at the final on treatment visit. The initial\r\n 48-week treatment period will be structured into 2 age Cohorts; Cohort 1 (Aged greater than\r\n or equal to [>=] 12 to less than [<] 18 years) and Cohort 2 (Children Aged >= 6 to < 12\r\n years) and each Cohort will have 2 parts. The first part of the trial (Part 1) is designed to\r\n evaluate the steady-state pharmacokinetic (PK) profile and the short-term safety and\r\n antiviral activity of rilpivirine 25 mg or adjusted dose once daily when administered in\r\n combination with 2 NRTIs. At Week 2/4, intensive PK will be done and an analysis together\r\n with short-term safety and antiviral activity will be reviewed by a data monitoring committee\r\n (DMC). For adolescents (Cohort 1) if the mean steady-state exposure in this first group of\r\n patients is comparable to that of the adult population (ie, is within 80-125 percentage of\r\n the mean exposure of the 25 mg once daily dose group in study, TMC278-C204), and the Week 2/4\r\n safety and antiviral activity results have been reviewed and deemed satisfactory by the DMC,\r\n the second part of the trial will start. The second part of the trial will evaluate long-term\r\n (48 weeks and 240 weeks) safety, efficacy, and pharmacokinetics of rilpivirine in combination\r\n with the background regimen of 2 NRTIs with a primary analysis time point at 24 weeks. For\r\n patients aged greater than or equal to (>=) 6 to less than (<) 12 years (Cohort 2), after\r\n being treated for at least 4 weeks and the Week 2 intensive PK and Week 4 safety and\r\n antiviral activity have been reviewed and results are satisfactory, recruitment in Part 1\r\n will resume and additional subjects will be enrolled to have at least 10 subjects in Part 1.\r\n Once an appropriate RPV dose has been selected, Part 1 of Cohort 2 will be considered\r\n complete and Part 2 will start. All patients from Part 1 will roll over in Part 2 and\r\n additional patients will be recruited in Part 2 to have at least 25 subjects (including those\r\n from Part 1) overall. In both cohorts of the trial, the ART will consist of rilpivirine 25 mg\r\n or adjusted dose once daily and an investigator-selected background regimen containing 2\r\n NRTIs. Patients safety will be monitored throughout the study and during the follow up\r\n visits.", + "enrollment": [ + { + "reference": "#2a43edc4-0000-0000-0000-000000000000", + "type": "Group" + } + ], + "period": { + "start": "2011-01", + "end": "2027-08" + }, + "arm": [ + { + "name": "Rilpivirine (TMC278)", + "type": { + "text": "Experimental" + }, + "description": "The patients will receive rilpivirine with 2 nucleoside/nucleotide reverse transcriptase inhibitors (NRTIs) as a background regimen in Cohort 1 [Aged greater than or equal to (> =) 12 to less than (<) 18 years] and Cohort 2 (children aged > = 6 to < 12 years). The NRTIs includes zidovudine, abacavir, or tenofovir disoproxil fumarate in combination with lamivudine or emtricitabine." + } + ] + } + ], + "registryFilters": [ + { + "studyTypes": [ + "interventional", + "observational" + ], + "recruitmentStatuses": [ + "recruiting", + "enrollingByInvitation" + ], + "phases": [ + "phase2", + "phase3" + ], + "purposes": [ + "diagnostic", + "prevention", + "basicScience" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityLocations": [ + { + "city": "Basel", + "countryOrRegion": "Switzerland" + }, + { + "city": "Allschwil", + "countryOrRegion": "Switzerland" + } + ] + }, + { + "sponsors": [ + "Janssen" + ], + "sources": [ + "clinicaltrials.gov" + ], + "facilityAreas": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + 7.588576, + 47.559601 + ] + }, + "properties": { + "subType": "Circle", + "radius": 80000 + } + } + ] + }, + { + "ids": [ + "NCT04006015", + "NCT04545788", + "NCT04773711" + ], + "sources": [ + "clinicaltrials.gov" + ] + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + }, + "201": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a", + "Operation-Location": "{endpoint}/health-insights/trial-matcher/jobs/{id}?api-version=2024-08-01-preview" + }, + "body": { + "status": "notStarted", + "id": "ad28aef5-87f3-4d2d-97eb-5cdeb4519d12" + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json new file mode 100644 index 000000000000..5f4be4dcee12 --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/examples/SuccessfulTrialMatcherResponse.json @@ -0,0 +1,116 @@ +{ + "operationId": "TrialMatcher_GetJob", + "title": "Gets the status and details of the Trial Matcher job.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-08-01-preview", + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "c7e9a8d7-6b5f-4e3d-9a2c-1f8b0e2c3f4a" + }, + "body": { + "id": "a4d3d73e-2be3-4ca1-bd4f-66a5bdd19754", + "createdAt": "2021-11-28T09:13:11.046Z", + "expiresAt": "2021-11-28T09:13:11.046Z", + "updatedAt": "2021-11-28T09:13:11.046Z", + "status": "succeeded", + "result": { + "patientResults": [ + { + "patientId": "Patient ID Example 2", + "inferences": [ + { + "type": "trialEligibility", + "value": "Eligible", + "description": "SwEaTB - Diagnosing of Acute Tuberculosis", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "In-patients with acute tuberculosis", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0019046", + "name": "tuberculosis" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03667742", + "source": "clinicaltrials.gov", + "metadata": { + "phases": [ + "phase3" + ], + "studyType": "observational", + "recruitmentStatus": "recruiting", + "conditions": [ + "Tuberculosis" + ], + "sponsors": [ + "University Hospital, Basel, Switzerland" + ], + "contacts": [ + { + "name": "John Doe, PD Dr. Med", + "email": "John@contoso.com", + "phone": "+55-555-5555-55" + } + ], + "facilities": [ + { + "name": "University Hospital, Basel", + "city": "Basel", + "countryOrRegion": "Switzerland" + } + ] + } + }, + { + "type": "trialEligibility", + "value": "Ineligible", + "description": "Design of an Integrative Algorithm for Staging Tuberculosis (STAGE-TB)", + "confidenceScore": 1, + "evidence": [ + { + "eligibilityCriteriaEvidence": "negative for Quantiferon- TB Gold Plus Test or ELISpot", + "patientInfoEvidence": { + "system": "UMLS", + "code": "C0920508", + "name": "Enzyme-Linked Immunospot Assay", + "value": "30,000 PBMC cells per 10ul" + }, + "importance": 1 + } + ], + "clinicalTrialId": "NCT03691883", + "source": "clinicaltrials.gov" + } + ], + "neededClinicalInfo": [ + { + "system": "UMLS", + "code": "C4317078", + "name": "Mycobacterium Tuberculosis Measurement ", + "semanticType": "Laboratory Procedure", + "category": "EXAMINATION_NAME" + }, + { + "system": "UMLS", + "code": "C0008031", + "name": "Chest Pain", + "semanticType": "Sign or Symptom", + "category": "SYMPTOM_OR_SIGN" + } + ] + } + ], + "modelVersion": "2021-10-28", + "knowledgeGraphLastUpdateDate": "2021-11-26" + } + } + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json new file mode 100644 index 000000000000..a991c447368a --- /dev/null +++ b/specification/ai/data-plane/HealthInsights/preview/2024-08-01-preview/openapi.json @@ -0,0 +1,4082 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure AI Health Insights", + "version": "2024-08-01-preview", + "description": "Azure AI Health Insights provides an API that serves insight models, specific for Health & Life Sciences, that perform analysis and provide inferences to be used by a human.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/health-insights", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "AzureKey": [] + }, + { + "EntraIdToken": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "AzureKey": { + "type": "apiKey", + "description": "The secret key for your Azure Cognitive Services subscription.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "EntraIdToken": { + "type": "oauth2", + "description": "The Microsoft Entra Id Flow", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [ + { + "name": "RadiologyInsights" + }, + { + "name": "TrialMatcher" + } + ], + "paths": { + "/radiology-insights/jobs/{id}": { + "get": { + "operationId": "RadiologyInsights_GetJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Get Radiology Insights job details", + "description": "Gets the status and details of the Radiology Insights job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "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." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Radiology Insights job.": { + "$ref": "./examples/SuccessfulRadiologyInsightsResponse.json" + } + } + }, + "put": { + "operationId": "RadiologyInsights_CreateJob", + "tags": [ + "RadiologyInsights" + ], + "summary": "Create Radiology Insights job", + "description": "Creates a Radiology Insights job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/RadiologyInsightsJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Creates a Radiology Insights job with the given request body.": { + "$ref": "./examples/SuccessfulRadiologyInsightsRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/trial-matcher/jobs/{id}": { + "get": { + "operationId": "TrialMatcher_GetJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Get Trial Matcher job details", + "description": "Gets the status and details of the Trial Matcher job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "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." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Gets the status and details of the Trial Matcher job.": { + "$ref": "./examples/SuccessfulTrialMatcherResponse.json" + } + } + }, + "put": { + "operationId": "TrialMatcher_CreateJob", + "tags": [ + "TrialMatcher" + ], + "summary": "Create Trial Matcher job", + "description": "Creates a Trial Matcher job with the given request body.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "id", + "in": "path", + "description": "The unique ID of the job.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$" + }, + { + "$ref": "#/parameters/Azure.Core.ExpandQueryParameter" + }, + { + "name": "resource", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TrialMatcherJob" + }, + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/HealthInsightsErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + }, + "x-ms-request-id": { + "type": "string", + "format": "uuid", + "description": "An opaque, globally-unique, server-generated string identifier for the request." + } + } + } + }, + "x-ms-examples": { + "Creates a Trial Matcher job with the given request body.": { + "$ref": "./examples/SuccessfulTrialMatcherRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AgeMismatchInference": { + "type": "object", + "description": "A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information.", + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "ageMismatch" + }, + "AreaGeometry": { + "type": "object", + "description": "`GeoJSON` geometry, representing the area circle's center.", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonGeometryType", + "description": "`GeoJSON` geometry type." + }, + "coordinates": { + "type": "array", + "description": "Coordinates of the area circle's center, represented according to the `GeoJSON` standard.\nThis is an array of 2 decimal numbers, longitude and latitude (precisely in this order).", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "number", + "format": "float" + } + } + }, + "required": [ + "type", + "coordinates" + ] + }, + "AreaProperties": { + "type": "object", + "description": "`GeoJSON` object properties.", + "properties": { + "subType": { + "$ref": "#/definitions/GeoJsonPropertiesSubType", + "description": "`GeoJSON` object sub-type." + }, + "radius": { + "type": "number", + "format": "double", + "description": "The radius of the area's circle, in meters." + } + }, + "required": [ + "subType", + "radius" + ] + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "ClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + } + }, + "required": [ + "system", + "code" + ] + }, + "ClinicalDocumentType": { + "type": "string", + "description": "The type of the clinical document.", + "enum": [ + "consultation", + "dischargeSummary", + "historyAndPhysical", + "radiologyReport", + "procedure", + "progress", + "laboratory", + "pathologyReport" + ], + "x-ms-enum": { + "name": "ClinicalDocumentType", + "modelAsString": true, + "values": [ + { + "name": "Consultation", + "value": "consultation" + }, + { + "name": "DischargeSummary", + "value": "dischargeSummary" + }, + { + "name": "HistoryAndPhysical", + "value": "historyAndPhysical" + }, + { + "name": "RadiologyReport", + "value": "radiologyReport" + }, + { + "name": "Procedure", + "value": "procedure" + }, + { + "name": "Progress", + "value": "progress" + }, + { + "name": "Laboratory", + "value": "laboratory" + }, + { + "name": "PathologyReport", + "value": "pathologyReport" + } + ] + } + }, + "ClinicalNoteEvidence": { + "type": "object", + "description": "A piece of evidence from a clinical note (text document).", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the document containing the evidence." + }, + "text": { + "type": "string", + "description": "The actual text span which is evidence for the inference." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The start index of the evidence text span in the document (0 based).", + "minimum": 0 + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the evidence text span.", + "minimum": 1 + } + }, + "required": [ + "id", + "offset", + "length" + ] + }, + "ClinicalTrialMetadata": { + "type": "object", + "description": "Trial data which is of interest to the potential participant.", + "properties": { + "phases": { + "type": "array", + "description": "Phases which are relevant for the clinical trial.\nEach clinical trial can be in a certain phase or in multiple phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "studyType": { + "$ref": "#/definitions/ClinicalTrialStudyType", + "description": "Possible study types of a clinical trial." + }, + "recruitmentStatus": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus", + "description": "Possible recruitment status of a clinical trial." + }, + "conditions": { + "type": "array", + "description": "Medical conditions and their synonyms which are relevant for the clinical trial, given as strings.", + "minItems": 1, + "items": { + "type": "string" + } + }, + "sponsors": { + "type": "array", + "description": "Sponsors/collaborators involved with the trial.", + "items": { + "type": "string" + } + }, + "contacts": { + "type": "array", + "description": "Contact details of the trial administrators, for patients that want to participate in the trial.", + "items": { + "$ref": "#/definitions/ContactDetails" + }, + "x-ms-identifiers": [] + }, + "facilities": { + "type": "array", + "description": "Research facilities where the clinical trial is conducted.", + "items": { + "$ref": "#/definitions/ClinicalTrialResearchFacility" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "conditions" + ] + }, + "ClinicalTrialPhase": { + "type": "string", + "description": "Possible phases of a clinical trial.", + "enum": [ + "notApplicable", + "earlyPhase1", + "phase1", + "phase2", + "phase3", + "phase4" + ], + "x-ms-enum": { + "name": "ClinicalTrialPhase", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "EarlyPhase1", + "value": "earlyPhase1" + }, + { + "name": "Phase1", + "value": "phase1" + }, + { + "name": "Phase2", + "value": "phase2" + }, + { + "name": "Phase3", + "value": "phase3" + }, + { + "name": "Phase4", + "value": "phase4" + } + ] + } + }, + "ClinicalTrialPurpose": { + "type": "string", + "description": "Possible purposes of a clinical trial.", + "enum": [ + "notApplicable", + "screening", + "diagnostic", + "prevention", + "healthServicesResearch", + "treatment", + "deviceFeasibility", + "supportiveCare", + "basicScience", + "other" + ], + "x-ms-enum": { + "name": "ClinicalTrialPurpose", + "modelAsString": true, + "values": [ + { + "name": "NotApplicable", + "value": "notApplicable" + }, + { + "name": "Screening", + "value": "screening" + }, + { + "name": "Diagnostic", + "value": "diagnostic" + }, + { + "name": "Prevention", + "value": "prevention" + }, + { + "name": "HealthServicesResearch", + "value": "healthServicesResearch" + }, + { + "name": "Treatment", + "value": "treatment" + }, + { + "name": "DeviceFeasibility", + "value": "deviceFeasibility" + }, + { + "name": "SupportiveCare", + "value": "supportiveCare" + }, + { + "name": "BasicScience", + "value": "basicScience" + }, + { + "name": "Other", + "value": "other" + } + ] + } + }, + "ClinicalTrialRecruitmentStatus": { + "type": "string", + "description": "Possible recruitment status of a clinical trial.", + "enum": [ + "unknownStatus", + "notYetRecruiting", + "recruiting", + "enrollingByInvitation" + ], + "x-ms-enum": { + "name": "ClinicalTrialRecruitmentStatus", + "modelAsString": true, + "values": [ + { + "name": "UnknownStatus", + "value": "unknownStatus" + }, + { + "name": "NotYetRecruiting", + "value": "notYetRecruiting" + }, + { + "name": "Recruiting", + "value": "recruiting" + }, + { + "name": "EnrollingByInvitation", + "value": "enrollingByInvitation" + } + ] + } + }, + "ClinicalTrialRegistryFilter": { + "type": "object", + "description": "A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov).", + "properties": { + "conditions": { + "type": "array", + "description": "Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the medical conditions.", + "items": { + "type": "string" + } + }, + "studyTypes": { + "type": "array", + "description": "Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the study types.", + "items": { + "$ref": "#/definitions/ClinicalTrialStudyType" + } + }, + "recruitmentStatuses": { + "type": "array", + "description": "Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the recruitment statuses.", + "items": { + "$ref": "#/definitions/ClinicalTrialRecruitmentStatus" + } + }, + "sponsors": { + "type": "array", + "description": "Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sponsors.", + "items": { + "type": "string" + } + }, + "phases": { + "type": "array", + "description": "Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the phases.", + "items": { + "$ref": "#/definitions/ClinicalTrialPhase" + } + }, + "purposes": { + "type": "array", + "description": "Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the purposes.", + "items": { + "$ref": "#/definitions/ClinicalTrialPurpose" + } + }, + "ids": { + "type": "array", + "description": "Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial identifiers.", + "items": { + "type": "string" + } + }, + "sources": { + "type": "array", + "description": "Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the sources.", + "items": { + "$ref": "#/definitions/ClinicalTrialSource" + } + }, + "facilityNames": { + "type": "array", + "description": "Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility names.", + "items": { + "type": "string" + } + }, + "facilityLocations": { + "type": "array", + "description": "Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility locations.", + "items": { + "$ref": "#/definitions/GeographicLocation" + }, + "x-ms-identifiers": [] + }, + "facilityAreas": { + "type": "array", + "description": "Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied).\nLeaving this list empty will not limit the trial facility area boundaries.", + "items": { + "$ref": "#/definitions/GeographicArea" + }, + "x-ms-identifiers": [] + } + } + }, + "ClinicalTrialResearchFacility": { + "type": "object", + "description": "Details of a research facility where a clinical trial is conducted.", + "properties": { + "name": { + "type": "string", + "description": "The facility's name." + }, + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "name", + "countryOrRegion" + ] + }, + "ClinicalTrialSource": { + "type": "string", + "description": "Possible sources of a clinical trial.", + "enum": [ + "custom", + "clinicaltrials.gov" + ], + "x-ms-enum": { + "name": "ClinicalTrialSource", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "custom" + }, + { + "name": "ClinicaltrialsGov", + "value": "clinicaltrials.gov" + } + ] + } + }, + "ClinicalTrialStudyType": { + "type": "string", + "description": "Possible study types of a clinical trial.", + "enum": [ + "interventional", + "observational", + "expandedAccess", + "patientRegistries" + ], + "x-ms-enum": { + "name": "ClinicalTrialStudyType", + "modelAsString": true, + "values": [ + { + "name": "Interventional", + "value": "interventional" + }, + { + "name": "Observational", + "value": "observational" + }, + { + "name": "ExpandedAccess", + "value": "expandedAccess" + }, + { + "name": "PatientRegistries", + "value": "patientRegistries" + } + ] + } + }, + "ClinicalTrials": { + "type": "object", + "description": "The clinical trials that the patient(s) should be matched to.\nThe trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries.\nIn case both are given, the resulting trial set is a union of the two sets.", + "properties": { + "customTrials": { + "type": "array", + "description": "A list of clinical trials.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.ResearchStudy" + } + }, + "registryFilters": { + "type": "array", + "description": "A list of filters, each one creating a selection of trials from a given\nclinical trial registry.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ClinicalTrialRegistryFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "CompleteOrderDiscrepancyInference": { + "type": "object", + "description": "A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "missingBodyParts": { + "type": "array", + "description": "List of missing body parts required by a complete order : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "missingBodyPartMeasurements": { + "type": "array", + "description": "List of missing body parts that require measurement by a complete order : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "completeOrderDiscrepancy" + }, + "ContactDetails": { + "type": "object", + "description": "A person's contact details.", + "properties": { + "name": { + "type": "string", + "description": "The person's name." + }, + "email": { + "type": "string", + "description": "The person's email." + }, + "phone": { + "type": "string", + "description": "A person's phone number." + } + } + }, + "CriticalResult": { + "type": "object", + "description": "Critical Result consists of two properties.", + "properties": { + "description": { + "type": "string", + "description": "Description : medical problem." + }, + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to the critical result." + } + }, + "required": [ + "description" + ] + }, + "CriticalResultInference": { + "type": "object", + "description": "Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care.", + "properties": { + "result": { + "$ref": "#/definitions/CriticalResult", + "description": "The complete Critical Result, as outlined below, will be reused for the recommendation." + } + }, + "required": [ + "result" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "criticalResult" + }, + "DocumentAdministrativeMetadata": { + "type": "object", + "description": "Document administrative metadata", + "properties": { + "orderedProcedures": { + "type": "array", + "description": "List of procedure information associated with the document.", + "minItems": 1, + "items": { + "$ref": "#/definitions/OrderedProcedure" + }, + "x-ms-identifiers": [] + }, + "encounterId": { + "type": "string", + "description": "Reference to the encounter associated with the document." + } + } + }, + "DocumentAuthor": { + "type": "object", + "description": "Document author", + "properties": { + "id": { + "type": "string", + "description": "author id" + }, + "fullName": { + "type": "string", + "description": "Text representation of the full name" + } + } + }, + "DocumentContent": { + "type": "object", + "description": "The content of the patient document.", + "properties": { + "sourceType": { + "$ref": "#/definitions/DocumentContentSourceType", + "description": "The type of the content's source.\nIn case the source type is 'inline', the content is given as a string (for instance, text).\nIn case the source type is 'reference', the content is given as a URI." + }, + "value": { + "type": "string", + "description": "The content of the document, given either inline (as a string) or as a reference (URI)." + } + }, + "required": [ + "sourceType", + "value" + ] + }, + "DocumentContentSourceType": { + "type": "string", + "description": "The type of the content's source.\nIn case the source type is 'inline', the content is given as a string (for instance, text).\nIn case the source type is 'reference', the content is given as a URI.", + "enum": [ + "inline", + "reference" + ], + "x-ms-enum": { + "name": "DocumentContentSourceType", + "modelAsString": true, + "values": [ + { + "name": "Inline", + "value": "inline", + "description": "The content is given as a string (for instance, text)." + }, + { + "name": "Reference", + "value": "reference", + "description": "The content is given as a URI." + } + ] + } + }, + "DocumentType": { + "type": "string", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).", + "enum": [ + "note", + "fhirBundle", + "dicom", + "genomicSequencing" + ], + "x-ms-enum": { + "name": "DocumentType", + "modelAsString": true, + "values": [ + { + "name": "Note", + "value": "note" + }, + { + "name": "FhirBundle", + "value": "fhirBundle" + }, + { + "name": "Dicom", + "value": "dicom" + }, + { + "name": "GenomicSequencing", + "value": "genomicSequencing" + } + ] + } + }, + "EncounterClass": { + "type": "string", + "description": "Known values codes that can be used to indicate the class of encounter (TODO://Based on FHIR value set--http://....).", + "enum": [ + "inpatient", + "ambulatory", + "observation", + "emergency", + "virtual", + "healthHome" + ], + "x-ms-enum": { + "name": "EncounterClass", + "modelAsString": true, + "values": [ + { + "name": "InPatient", + "value": "inpatient", + "description": "A patient encounter where a patient is admitted by a hospital or equivalent facility, assigned to a location where patients generally stay at least overnight and provided with room, board, and continuous nursing service." + }, + { + "name": "Ambulatory", + "value": "ambulatory", + "description": "The term ambulatory usually implies that the patient has come to the location and is not assigned to a bed. Sometimes referred to as an outpatient encounter." + }, + { + "name": "Observation", + "value": "observation", + "description": "An encounter where the patient usually will start in different encounter, such as one in the emergency department but then transition to this type of encounter because they require a significant period of treatment and monitoring to determine whether or not their condition warrants an inpatient admission or discharge." + }, + { + "name": "Emergency", + "value": "emergency", + "description": "A patient encounter that takes place at a dedicated healthcare service delivery location where the patient receives immediate evaluation and treatment, provided until the patient can be discharged or responsibility for the patient's care is transferred elsewhere (for example, the patient could be admitted as an inpatient or transferred to another facility." + }, + { + "name": "Virtual", + "value": "virtual", + "description": "A patient encounter where the patient is not physically present for the encounter, such as in a telehealth encounter, phone call, or electronic communication." + }, + { + "name": "HealthHome", + "value": "healthHome", + "description": "Healthcare encounter that takes place in the residence of the patient or a designee" + } + ] + } + }, + "ExtendedClinicalCodedElement": { + "type": "object", + "description": "A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information.", + "properties": { + "system": { + "type": "string", + "description": "The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS." + }, + "code": { + "type": "string", + "description": "The code within the given clinical coding system." + }, + "name": { + "type": "string", + "description": "The name of this coded concept in the coding system." + }, + "value": { + "type": "string", + "description": "A value associated with the code within the given clinical coding system." + }, + "semanticType": { + "type": "string", + "description": "The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept." + }, + "category": { + "type": "string", + "description": "The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination." + } + }, + "required": [ + "system", + "code" + ] + }, + "Fhir.R4.Annotation": { + "type": "object", + "description": "A text note which also contains information about who made the statement and when\nBased on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)", + "properties": { + "authorString": { + "type": "string", + "description": "Individual responsible for the annotation" + }, + "time": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When the annotation was made" + }, + "text": { + "type": "string", + "description": "The annotation - text content (as markdown)" + } + }, + "required": [ + "text" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.CodeableConcept": { + "type": "object", + "description": "Concept - reference to a terminology or just text\nBased on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)", + "properties": { + "coding": { + "type": "array", + "description": "Code defined by a terminology system", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "text": { + "type": "string", + "description": "Plain text representation of the concept" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Coding": { + "type": "object", + "description": "A Coding is a representation of a defined concept using a symbol from a defined \"code system\".\nBased on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Identity of the terminology system" + }, + "version": { + "type": "string", + "description": "Version of the system - if relevant" + }, + "code": { + "type": "string", + "description": "Symbol in syntax defined by the system" + }, + "display": { + "type": "string", + "description": "Representation defined by the system" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Condition": { + "type": "object", + "description": "Detailed information about conditions, problems or diagnoses\nBased on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "identifier": { + "type": "array", + "description": "External Ids for this condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "clinicalStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "active | recurrence | relapse | inactive | remission | resolved" + }, + "verificationStatus": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "unconfirmed | provisional | differential | confirmed | refuted | entered-in-error" + }, + "category": { + "type": "array", + "description": "problem-list-item | encounter-diagnosis", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "severity": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Subjective severity of condition" + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Identification of the condition, problem or diagnosis" + }, + "bodySite": { + "type": "array", + "description": "Anatomical location, if relevant", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Encounter created as part of" + }, + "onsetDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Estimated or actual date, date-time, or age" + }, + "onsetString": { + "type": "string", + "description": "Estimated or actual date, date-time, or age" + }, + "abatementDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "When in resolution/remission" + }, + "abatementAge": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "When in resolution/remission" + }, + "abatementPeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When in resolution/remission" + }, + "abatementRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "When in resolution/remission" + }, + "abatementString": { + "type": "string", + "description": "When in resolution/remission" + }, + "recordedDate": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date record was first recorded" + }, + "stage": { + "type": "array", + "description": "stge/grade, usually assessed formally", + "items": { + "$ref": "#/definitions/Fhir.R4.ConditionStage" + }, + "x-ms-identifiers": [] + }, + "note": { + "type": "array", + "description": "Additional information about the Condition", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Condition" + }, + "Fhir.R4.ConditionStage": { + "type": "object", + "description": "Stage/grade, usually assessed formally\nBased on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)", + "properties": { + "summary": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Simple summary (disease specific)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Kind of staging" + } + } + }, + "Fhir.R4.ContactDetail": { + "type": "object", + "description": "Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail)", + "properties": { + "name": { + "type": "string", + "description": "Name of an individual to contact" + }, + "telecom": { + "type": "array", + "description": "Contact details for individual or organization", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactPoint" + }, + "x-ms-identifiers": [] + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ContactPoint": { + "type": "object", + "description": "Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.\nSee https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint", + "properties": { + "system": { + "$ref": "#/definitions/Fhir.R4.ContactPointSystem", + "description": "phone | fax | email | pager | url | sms | other" + }, + "value": { + "type": "string", + "description": "The actual contact point details" + }, + "use": { + "$ref": "#/definitions/Fhir.R4.ContactPointUse", + "description": "home | work | temp | old | mobile - purpose of this contact point" + }, + "rank": { + "type": "integer", + "format": "int32", + "description": "Specify preferred order of use (1 = highest)" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when the contact point was/is in use" + } + } + }, + "Fhir.R4.ContactPointSystem": { + "type": "string", + "description": "Contact Point System\nsee https://www.hl7.org/fhir/R4/valueset-contact-point-system.html", + "enum": [ + "phone", + "fax", + "email", + "pager", + "url", + "sms", + "other" + ], + "x-ms-enum": { + "name": "ContactPointSystem", + "modelAsString": true, + "values": [ + { + "name": "Phone", + "value": "phone", + "description": "Phone" + }, + { + "name": "Fax", + "value": "fax", + "description": "Fax" + }, + { + "name": "Email", + "value": "email", + "description": "Email" + }, + { + "name": "Pager", + "value": "pager", + "description": "Pager" + }, + { + "name": "Url", + "value": "url", + "description": "Url" + }, + { + "name": "Sms", + "value": "sms", + "description": "Sms" + }, + { + "name": "Other", + "value": "other", + "description": "Other" + } + ] + } + }, + "Fhir.R4.ContactPointUse": { + "type": "string", + "description": "Contact Point Use\nSee: \thttp://hl7.org/fhir/ValueSet/contact-point-use", + "enum": [ + "home", + "work", + "temp", + "old", + "mobile" + ], + "x-ms-enum": { + "name": "ContactPointUse", + "modelAsString": true, + "values": [ + { + "name": "Home", + "value": "home", + "description": "Home" + }, + { + "name": "Work", + "value": "work", + "description": "Work" + }, + { + "name": "Temp", + "value": "temp", + "description": "Temp" + }, + { + "name": "Old", + "value": "old", + "description": "Old" + }, + { + "name": "Mobile", + "value": "mobile", + "description": "Mobile" + } + ] + } + }, + "Fhir.R4.DomainResource": { + "type": "object", + "description": "A resource with narrative, extensions, and contained resources\nBased on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)", + "properties": { + "resourceType": { + "type": "string", + "description": "Discriminator property for DomainResource." + }, + "text": { + "$ref": "#/definitions/Fhir.R4.Narrative", + "description": "Text summary of the resource, for human interpretation" + }, + "contained": { + "type": "array", + "description": "Contained, inline Resources", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + }, + "modifierExtension": { + "type": "array", + "description": "Extensions that cannot be ignored", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "resourceType", + "required": [ + "resourceType" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Resource" + } + ] + }, + "Fhir.R4.Element": { + "type": "object", + "description": "The base definition for all elements contained inside a resource.\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", + "properties": { + "id": { + "type": "string", + "description": "Unique id for inter-element referencing" + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + } + }, + "Fhir.R4.Extension": { + "type": "object", + "description": "Base for all elements\nBased on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)", + "properties": { + "url": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Source of the definition for the extension code - a logical name or a URL." + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + } + }, + "required": [ + "url" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Identifier": { + "type": "object", + "description": "An identifier intended for computation\nBased on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)", + "properties": { + "use": { + "type": "string", + "description": "usual | official | temp | secondary | old (If known)" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Description of identifier" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "The namespace for the identifier value" + }, + "value": { + "type": "string", + "description": "The value that is unique" + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Time period when id is/was valid for use" + }, + "assigner": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that issued id (may be just text)" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Meta": { + "type": "object", + "description": "Metadata about a resource\nBased on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)", + "properties": { + "versionId": { + "type": "string", + "description": "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted." + }, + "lastUpdated": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "When the resource last changed - e.g. when the version changed." + }, + "source": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc." + }, + "profile": { + "type": "array", + "description": "A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url).", + "items": { + "$ref": "#/definitions/Fhir.R4.fhirUri" + } + }, + "security": { + "type": "array", + "description": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + }, + "tag": { + "type": "array", + "description": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", + "items": { + "$ref": "#/definitions/Fhir.R4.Coding" + } + } + } + }, + "Fhir.R4.Narrative": { + "type": "object", + "description": "Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human.\nBased on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)", + "properties": { + "status": { + "type": "string", + "description": "generated, extensions, additional, empty" + }, + "div": { + "type": "string", + "description": "xhtml" + } + }, + "required": [ + "status", + "div" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Observation": { + "type": "object", + "description": "Detailed information about observations\nBased on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ObservationStatusCodeType", + "description": "registered | preliminary | final | amended +" + }, + "category": { + "type": "array", + "description": "Classification of type of observation", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of observation (code / type)" + }, + "subject": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Who and/or what the observation is about" + }, + "encounter": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Healthcare event during which this observation is made" + }, + "effectiveDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Clinically relevant time/time-period for observation" + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Clinically relevant time/time-period for observation" + }, + "effectiveInstant": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Clinically relevant time/time-period for observation" + }, + "issued": { + "$ref": "#/definitions/Fhir.R4.fhirInstant", + "description": "Date/Time this version was made available" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Actual result" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Actual result" + }, + "valueString": { + "type": "string", + "description": "Actual result" + }, + "valueBoolean": { + "type": "boolean", + "description": "Actual result" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Actual result" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Actual result" + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Actual result" + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Actual result" + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Actual result" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Actual result" + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Actual result" + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "note": { + "type": "array", + "description": "Comments about the observation", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "bodySite": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Observed body part" + }, + "method": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "How it was done" + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + }, + "hasMember": { + "type": "array", + "description": "Related resource that belongs to the Observation group", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "derivedFrom": { + "type": "array", + "description": "Related measurements the observation is made from", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "component": { + "type": "array", + "description": "Component results", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationComponent" + } + } + }, + "required": [ + "status", + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "Observation" + }, + "Fhir.R4.ObservationComponent": { + "type": "object", + "description": "Component results\nBased on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Type of component observation (code / type)" + }, + "valueQuantity": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Value as Quantity" + }, + "valueCodeableConcept": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Value as CodeableConcept" + }, + "valueString": { + "type": "string", + "description": "Value as string" + }, + "valueBoolean": { + "type": "boolean", + "description": "Value as boolean" + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Value as integer" + }, + "valueRange": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Value as Range." + }, + "valueRatio": { + "$ref": "#/definitions/Fhir.R4.Ratio", + "description": "Value as Ratio." + }, + "valueSampledData": { + "$ref": "#/definitions/Fhir.R4.SampledData", + "description": "Value as SampledData." + }, + "valueTime": { + "type": "string", + "format": "time", + "description": "Value as time (hh:mm:ss)" + }, + "valueDateTime": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Value as dateTime." + }, + "valuePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "Value as Period." + }, + "valueReference": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Value as reference." + }, + "dataAbsentReason": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Why the component result is missing" + }, + "interpretation": { + "type": "array", + "description": "High, low, normal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "referenceRange": { + "type": "array", + "description": "Provides guide for interpretation of component result", + "items": { + "$ref": "#/definitions/Fhir.R4.ObservationReferenceRange" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ObservationReferenceRange": { + "type": "object", + "description": "Provides guide for interpretation of component result\nBased on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low Range, if relevant" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High Range, if relevant" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Reference range qualifier" + }, + "appliesTo": { + "type": "array", + "description": "Reference range population", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "age": { + "$ref": "#/definitions/Fhir.R4.Range", + "description": "Applicable age range, if relevant" + }, + "text": { + "type": "string", + "description": "Text based reference range in an observation" + } + } + }, + "Fhir.R4.ObservationStatusCodeType": { + "type": "string", + "description": "Observation Status\nBased on [FHIR ObservationStatus](https://www.hl7.org/fhir/R4/valueset-observation-status.html)", + "enum": [ + "registered", + "preliminary", + "final", + "amended", + "corrected", + "cancelled", + "entered-in-error", + "unknown" + ], + "x-ms-enum": { + "name": "ObservationStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Registered", + "value": "registered", + "description": "The existence of the observation is registered, but there is no result yet available." + }, + { + "name": "Preliminary", + "value": "preliminary", + "description": "This is an initial or interim observation: data may be incomplete or unverified." + }, + { + "name": "Final", + "value": "final", + "description": "The observation is complete and verified by an authorized person." + }, + { + "name": "Amended", + "value": "amended", + "description": "Subsequent to being Final, the observation has been modified subsequent. This includes updates/new information and corrections." + }, + { + "name": "Corrected", + "value": "corrected", + "description": "Subsequent to being Final, the observation has been modified to correct an error in the test result." + }, + { + "name": "Cancelled", + "value": "cancelled", + "description": "The observation is unavailable because the measurement was not started or not completed (also sometimes called \"aborted\")." + }, + { + "name": "EnteredInError", + "value": "entered-in-error", + "description": "The observation has been withdrawn following previous final release." + }, + { + "name": "Unknown", + "value": "unknown", + "description": "The observation status is unknown. Note that \"unknown\" is a value of last resort and every attempt should be made to provide a meaningful value other than \"unknown\"." + } + ] + } + }, + "Fhir.R4.Period": { + "type": "object", + "description": "A time period defined by a start and end date and optionally time\nBased on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)", + "properties": { + "start": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Starting time with inclusive boundary" + }, + "end": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "End time with inclusive boundary, if not ongoing" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Quantity": { + "type": "object", + "description": "A measured or measurable amount\nBased on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "Numerical value (with implicit precision)" + }, + "comparator": { + "type": "string", + "description": "< | <= | >= | > - how to understand the value" + }, + "unit": { + "type": "string", + "description": "Unit representation" + }, + "system": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "System that defines coded unit form" + }, + "code": { + "type": "string", + "description": "Coded form of the unit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Range": { + "type": "object", + "description": "A set of ordered Quantities defined by a low and high limit\nBased on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)", + "properties": { + "low": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Low limit" + }, + "high": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "High limit" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Ratio": { + "type": "object", + "description": "A ratio of two Quantity values - a numerator and a denominator\nBased on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)", + "properties": { + "numerator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Numerator value" + }, + "denominator": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Denominator value" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.Reference": { + "type": "object", + "description": "A reference from one resource to another\nBased on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)", + "properties": { + "reference": { + "type": "string", + "description": "Literal reference, Relative, internal or absolute URL" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "Type the reference refers to (e.g. \"Patient\")" + }, + "identifier": { + "$ref": "#/definitions/Fhir.R4.Identifier", + "description": "Logical reference, when literal reference is not known" + }, + "display": { + "type": "string", + "description": "Text alternative for the resource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.ResearchStudy": { + "type": "object", + "description": "Detailed information about Research Study\nBased on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)", + "properties": { + "identifier": { + "type": "array", + "description": "Business Identifier for study", + "items": { + "$ref": "#/definitions/Fhir.R4.Identifier" + } + }, + "title": { + "type": "string", + "description": "Name for this study" + }, + "protocol": { + "type": "array", + "description": "Steps followed in executing study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "partOf": { + "type": "array", + "description": "Part of larger study", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "status": { + "$ref": "#/definitions/Fhir.R4.ResearchStudyStatusCodeType", + "description": "active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn" + }, + "primaryPurposeType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility" + }, + "phase": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4" + }, + "category": { + "type": "array", + "description": "Classifications for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "focus": { + "type": "array", + "description": "Drugs, devices, etc. under study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "condition": { + "type": "array", + "description": "Condition being studied", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "contact": { + "type": "array", + "description": "Contact details for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.ContactDetail" + } + }, + "keyword": { + "type": "array", + "description": "Used to search for the study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "location": { + "type": "array", + "description": "Geographic region(s) for study", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "description": { + "type": "string", + "description": "What this is study doing" + }, + "enrollment": { + "type": "array", + "description": "Inclusion & exclusion criteria", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "period": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "When the study began and ended" + }, + "sponsor": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Organization that initiates and is legally responsible for the study" + }, + "principalInvestigator": { + "$ref": "#/definitions/Fhir.R4.Reference", + "description": "Researcher who oversees multiple aspects of the study" + }, + "site": { + "type": "array", + "description": "Facility where study activities are conducted", + "items": { + "$ref": "#/definitions/Fhir.R4.Reference" + } + }, + "reasonStopped": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design" + }, + "note": { + "type": "array", + "description": "Comments made about the study", + "items": { + "$ref": "#/definitions/Fhir.R4.Annotation" + } + }, + "arm": { + "type": "array", + "description": "Defined path through the study for a subject", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for study arm" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Categorization of study arm" + }, + "description": { + "type": "string", + "description": "Short explanation of study path" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + }, + "objective": { + "type": "array", + "description": "A goal for the study", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Label for the objective" + }, + "type": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "primary | secondary | exploratory" + } + }, + "required": [ + "name" + ] + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "status" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.DomainResource" + } + ], + "x-ms-discriminator-value": "ResearchStudy" + }, + "Fhir.R4.ResearchStudyStatusCodeType": { + "type": "string", + "description": "https://www.hl7.org/fhir/R4/codesystem-research-study-status.html", + "enum": [ + "active", + "administratively-completed", + "approved", + "closed-to-accrual", + "closed-to-accrual-and-intervention", + "completed", + "disapproved", + "in-review", + "temporarily-closed-to-accrual", + "temporarily-closed-to-accrual-and-intervention", + "withdrawn" + ], + "x-ms-enum": { + "name": "ResearchStudyStatusCodeType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The study is open for accrual." + }, + { + "name": "AdministrativelyCompleted", + "value": "administratively-completed", + "description": "Study is completed prematurely and will not resume; patients are no longer examined nor treated." + }, + { + "name": "Approved", + "value": "approved", + "description": "Protocol is approved by the review board." + }, + { + "name": "ClosedToAccrual", + "value": "closed-to-accrual", + "description": "Study is closed for accrual; patients can be examined and treated." + }, + { + "name": "ClosedToAccrualAndIntervention", + "value": "closed-to-accrual-and-intervention", + "description": "The study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Completed", + "value": "completed", + "description": "Study is closed to accrual and intervention, i.e. the study is closed to enrollment, all study subjects have completed treatment or intervention but are still being followed according to the primary objective of the study." + }, + { + "name": "Disapproved", + "value": "disapproved", + "description": "Protocol was disapproved by the review board." + }, + { + "name": "InReview", + "value": "in-review", + "description": "Protocol is submitted to the review board for approval." + }, + { + "name": "TemporarilyClosedToAccrual", + "value": "temporarily-closed-to-accrual", + "description": "The study is temporarily closed to accrual; a pause in accrual while study is reviewed, but is expected to resume." + }, + { + "name": "TemporarilyClosedToAccrualAndIntervention", + "value": "temporarily-closed-to-accrual-and-intervention", + "description": "Study is temporarily closed for accrual; can be potentially resumed in the future" + }, + { + "name": "Withdrawn", + "value": "withdrawn", + "description": "Protocol was withdrawn by the lead organization." + } + ] + } + }, + "Fhir.R4.Resource": { + "type": "object", + "description": "Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.\nBased on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource" + }, + "id": { + "type": "string", + "description": "Resource Id" + }, + "meta": { + "$ref": "#/definitions/Fhir.R4.Meta", + "description": "Metadata about the resource" + }, + "implicitRules": { + "$ref": "#/definitions/Fhir.R4.fhirUri", + "description": "A set of rules under which this content was created" + }, + "language": { + "type": "string", + "description": "Language of the resource content" + } + }, + "required": [ + "resourceType" + ], + "additionalProperties": {} + }, + "Fhir.R4.SampledData": { + "type": "object", + "description": "A series of measurements taken by a device\nBased on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)", + "properties": { + "origin": { + "$ref": "#/definitions/Fhir.R4.Quantity", + "description": "Zero value and units" + }, + "period": { + "type": "number", + "format": "double", + "description": "Number of milliseconds between samples" + }, + "factor": { + "type": "number", + "format": "double", + "description": "Multiply data by this before adding to origin" + }, + "lowerLimit": { + "type": "number", + "format": "double", + "description": "Lower limit of detection" + }, + "upperLimit": { + "type": "number", + "format": "double", + "description": "Upper limit of detection" + }, + "dimensions": { + "type": "integer", + "format": "int32", + "description": "Number of sample points at each time point", + "minimum": 1 + }, + "data": { + "type": "string", + "description": "Decimal values with spaces, or \"E\" | \"U\" | \"L\"" + } + }, + "required": [ + "origin", + "period", + "dimensions" + ], + "allOf": [ + { + "$ref": "#/definitions/Fhir.R4.Element" + } + ] + }, + "Fhir.R4.fhirDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?" + }, + "Fhir.R4.fhirInstant": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))" + }, + "Fhir.R4.fhirUri": { + "type": "string" + }, + "FindingInference": { + "type": "object", + "description": "Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area.", + "properties": { + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding data : contains extensions, fields and components linked with the finding." + } + }, + "required": [ + "finding" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "finding" + }, + "FindingOptions": { + "type": "object", + "description": "Finding options.", + "properties": { + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false." + } + } + }, + "FollowupCommunicationInference": { + "type": "object", + "description": "Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care.", + "properties": { + "communicatedAt": { + "type": "array", + "description": "Communication date and time.", + "minItems": 1, + "items": { + "type": "string", + "format": "date-time" + } + }, + "recipient": { + "type": "array", + "description": "Recipient of the communication.", + "minItems": 1, + "items": { + "$ref": "#/definitions/MedicalProfessionalType" + } + }, + "wasAcknowledged": { + "type": "boolean", + "description": "Communication was acknowledged." + } + }, + "required": [ + "wasAcknowledged" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupCommunication" + }, + "FollowupRecommendationInference": { + "type": "object", + "description": "Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies.", + "properties": { + "effectiveAt": { + "$ref": "#/definitions/Fhir.R4.fhirDateTime", + "description": "Date and time are displayed when the procedure is recommended to be done at a specific point in time." + }, + "effectivePeriod": { + "$ref": "#/definitions/Fhir.R4.Period", + "description": "The period is shown if a specific period is mentioned, with a start and end date-time." + }, + "findings": { + "type": "array", + "description": "Findings related to the recommendation.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RecommendationFinding" + }, + "x-ms-identifiers": [] + }, + "isConditional": { + "type": "boolean", + "description": "The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on." + }, + "isOption": { + "type": "boolean", + "description": "The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on." + }, + "isGuideline": { + "type": "boolean", + "description": "The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings." + }, + "isHedging": { + "type": "boolean", + "description": "Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on." + }, + "recommendedProcedure": { + "$ref": "#/definitions/ProcedureRecommendation", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure." + } + }, + "required": [ + "isConditional", + "isOption", + "isGuideline", + "isHedging", + "recommendedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "followupRecommendation" + }, + "FollowupRecommendationOptions": { + "type": "object", + "description": "Follow-up recommendation options.", + "properties": { + "includeRecommendationsWithNoSpecifiedModality": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false." + }, + "includeRecommendationsInReferences": { + "type": "boolean", + "description": "Include/Exclude follow-up recommendations in references to a guideline or article. Default is false." + }, + "provideFocusedSentenceEvidence": { + "type": "boolean", + "description": "If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false." + } + } + }, + "GenericProcedureRecommendation": { + "type": "object", + "description": "Generic procedure information.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure modality : SNOMED CT code." + }, + "description": { + "type": "string", + "description": "Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT." + } + }, + "required": [ + "code" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "genericProcedureRecommendation" + }, + "GeoJsonGeometryType": { + "type": "string", + "description": "`GeoJSON` geometry type.", + "enum": [ + "Point" + ], + "x-ms-enum": { + "name": "GeoJsonGeometryType", + "modelAsString": true, + "values": [ + { + "name": "Point", + "value": "Point" + } + ] + } + }, + "GeoJsonPropertiesSubType": { + "type": "string", + "description": "`GeoJSON` object sub-type.", + "enum": [ + "Circle" + ], + "x-ms-enum": { + "name": "GeoJsonPropertiesSubType", + "modelAsString": true, + "values": [ + { + "name": "Circle", + "value": "Circle" + } + ] + } + }, + "GeoJsonType": { + "type": "string", + "description": "`GeoJSON` type.", + "enum": [ + "Feature" + ], + "x-ms-enum": { + "name": "GeoJsonType", + "modelAsString": true, + "values": [ + { + "name": "Feature", + "value": "Feature" + } + ] + } + }, + "GeographicArea": { + "type": "object", + "description": "A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)).", + "properties": { + "type": { + "$ref": "#/definitions/GeoJsonType", + "description": "`GeoJSON` type." + }, + "geometry": { + "$ref": "#/definitions/AreaGeometry", + "description": "`GeoJSON` geometry, representing the area circle's center." + }, + "properties": { + "$ref": "#/definitions/AreaProperties", + "description": "`GeoJSON` object properties." + } + }, + "required": [ + "type", + "geometry", + "properties" + ] + }, + "GeographicLocation": { + "type": "object", + "description": "A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region.\nIn case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added.\nIn case a state is specified (without a city), country/region should be added.", + "properties": { + "city": { + "type": "string", + "description": "City name." + }, + "state": { + "type": "string", + "description": "State name." + }, + "countryOrRegion": { + "type": "string", + "description": "Country/region name." + } + }, + "required": [ + "countryOrRegion" + ] + }, + "HealthInsightsErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "ImagingProcedure": { + "type": "object", + "description": "Imaging procedure.", + "properties": { + "modality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Modality : SNOMED CT code." + }, + "anatomy": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Anatomy : SNOMED CT code." + }, + "laterality": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality : SNOMED CT code." + }, + "contrast": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "Contrast : see RadiologyCodeWithTypes (below)." + }, + "view": { + "$ref": "#/definitions/RadiologyCodeWithTypes", + "description": "View : see RadiologyCodeWithTypes (below)." + } + }, + "required": [ + "modality", + "anatomy" + ] + }, + "ImagingProcedureRecommendation": { + "type": "object", + "description": "Imaging procedures.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "imagingProcedures" + ], + "allOf": [ + { + "$ref": "#/definitions/ProcedureRecommendation" + } + ], + "x-ms-discriminator-value": "imagingProcedureRecommendation" + }, + "JobStatus": { + "type": "string", + "description": "The status of the processing job.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "canceled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "notStarted" + }, + { + "name": "Running", + "value": "running" + }, + { + "name": "Succeeded", + "value": "succeeded" + }, + { + "name": "Failed", + "value": "failed" + }, + { + "name": "Canceled", + "value": "canceled" + } + ] + } + }, + "LateralityDiscrepancyInference": { + "type": "object", + "description": "A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing).", + "properties": { + "lateralityIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Laterality indication : SNOMED CT code for laterality qualifier value." + }, + "discrepancyType": { + "$ref": "#/definitions/LateralityDiscrepancyType", + "description": "Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing." + } + }, + "required": [ + "discrepancyType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "lateralityDiscrepancy" + }, + "LateralityDiscrepancyType": { + "type": "string", + "description": "Laterality discrepancy type", + "enum": [ + "orderLateralityMismatch", + "textLateralityContradiction", + "textLateralityMissing" + ], + "x-ms-enum": { + "name": "LateralityDiscrepancyType", + "modelAsString": true, + "values": [ + { + "name": "OrderLateralityMismatch", + "value": "orderLateralityMismatch", + "description": "Mismatch between order and text" + }, + { + "name": "TextLateralityContradiction", + "value": "textLateralityContradiction", + "description": "Contradiction in text" + }, + { + "name": "TextLateralityMissing", + "value": "textLateralityMissing", + "description": "Missing laterality in text" + } + ] + } + }, + "LimitedOrderDiscrepancyInference": { + "type": "object", + "description": "A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document.", + "properties": { + "orderType": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast." + }, + "presentBodyParts": { + "type": "array", + "description": "List of body parts found in the document : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "presentBodyPartMeasurements": { + "type": "array", + "description": "List of body parts that are measured according to the document : SNOMED CT codes.", + "minItems": 1, + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "orderType" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "limitedOrderDiscrepancy" + }, + "MedicalProfessionalType": { + "type": "string", + "description": "Medical Professional Type", + "enum": [ + "unknown", + "doctor", + "nurse", + "midwife", + "physicianAssistant" + ], + "x-ms-enum": { + "name": "MedicalProfessionalType", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "unknown", + "description": "Unknown medical professional type" + }, + { + "name": "Doctor", + "value": "doctor", + "description": "Doctor medical professional type" + }, + { + "name": "Nurse", + "value": "nurse", + "description": "Nurse medical professional type" + }, + { + "name": "Midwife", + "value": "midwife", + "description": "Technician medical professional type" + }, + { + "name": "PhysicianAssistant", + "value": "physicianAssistant", + "description": "Technician medical professional type" + } + ] + } + }, + "ModelVersion": { + "type": "string", + "description": "The version of the model used for inference, expressed as the model date." + }, + "NeededClinicalInfo": { + "type": "array", + "description": "Clinical information which is needed to provide better trial matching results for the patient.", + "items": { + "$ref": "#/definitions/ExtendedClinicalCodedElement" + }, + "x-ms-identifiers": [] + }, + "OrderedProcedure": { + "type": "object", + "description": "Procedure information", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Procedure code" + }, + "description": { + "type": "string", + "description": "Procedure description" + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + } + }, + "PatientDetails": { + "type": "object", + "description": "Patient structured information, including demographics and known structured clinical information.", + "properties": { + "sex": { + "$ref": "#/definitions/PatientSex", + "description": "The patient's sex." + }, + "birthDate": { + "type": "string", + "format": "date", + "description": "The patient's date of birth." + }, + "clinicalInfo": { + "type": "array", + "description": "Known clinical information for the patient, structured.", + "items": { + "$ref": "#/definitions/Fhir.R4.Resource" + } + } + } + }, + "PatientDocument": { + "type": "object", + "description": "A clinical document related to a patient. Document here is in the wide sense - not just a text document (note).", + "properties": { + "type": { + "$ref": "#/definitions/DocumentType", + "description": "The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document)." + }, + "clinicalType": { + "$ref": "#/definitions/ClinicalDocumentType", + "description": "The type of the clinical document." + }, + "id": { + "type": "string", + "description": "A given identifier for the document. Has to be unique across all documents for a single patient.", + "minLength": 1 + }, + "language": { + "type": "string", + "description": "A 2 letter ISO 639-1 representation of the language of the document." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the document was created." + }, + "authors": { + "type": "array", + "description": "Document author(s)", + "minItems": 1, + "items": { + "$ref": "#/definitions/DocumentAuthor" + } + }, + "specialtyType": { + "$ref": "#/definitions/SpecialtyType", + "description": "specialty type the document" + }, + "administrativeMetadata": { + "$ref": "#/definitions/DocumentAdministrativeMetadata", + "description": "Administrative metadata for the document." + }, + "content": { + "$ref": "#/definitions/DocumentContent", + "description": "The content of the patient document." + } + }, + "required": [ + "type", + "id", + "content" + ] + }, + "PatientEncounter": { + "type": "object", + "description": "visit/encounter information", + "properties": { + "id": { + "type": "string", + "description": "The id of the visit.", + "minLength": 1 + }, + "period": { + "$ref": "#/definitions/TimePeriod", + "description": "Time period of the visit.\nIn case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time." + }, + "class": { + "$ref": "#/definitions/EncounterClass", + "description": "The class of the encounter." + } + }, + "required": [ + "id" + ] + }, + "PatientRecord": { + "type": "object", + "description": "A patient record, including their clinical information and data.", + "properties": { + "id": { + "type": "string", + "description": "A given identifier for the patient. Has to be unique across all patients in a single request.", + "minLength": 1 + }, + "details": { + "$ref": "#/definitions/PatientDetails", + "description": "Patient structured information, including demographics and known structured clinical information." + }, + "encounters": { + "type": "array", + "description": "Patient encounters/visits.", + "items": { + "$ref": "#/definitions/PatientEncounter" + } + }, + "patientDocuments": { + "type": "array", + "description": "Patient unstructured clinical data, given as documents.", + "items": { + "$ref": "#/definitions/PatientDocument" + } + } + }, + "required": [ + "id" + ] + }, + "PatientSex": { + "type": "string", + "description": "The patient's sex.", + "enum": [ + "female", + "male", + "unspecified" + ], + "x-ms-enum": { + "name": "PatientSex", + "modelAsString": true, + "values": [ + { + "name": "Female", + "value": "female" + }, + { + "name": "Male", + "value": "male" + }, + { + "name": "Unspecified", + "value": "unspecified" + } + ] + } + }, + "ProcedureRecommendation": { + "type": "object", + "description": "The procedure recommendation can be a generic procedure or an imaging procedure.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for ProcedureRecommendation." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyCodeWithTypes": { + "type": "object", + "description": "Radiology code with types : used in imaging procedure recommendation for contrast and view.", + "properties": { + "code": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views." + }, + "types": { + "type": "array", + "description": "The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + } + }, + "required": [ + "code", + "types" + ] + }, + "RadiologyInsightsData": { + "type": "object", + "description": "Contains the list of patients, and configuration data.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/RadiologyInsightsModelConfiguration", + "description": "Configuration affecting the Radiology Insights model's inference." + } + }, + "required": [ + "patients" + ] + }, + "RadiologyInsightsInference": { + "type": "object", + "description": "An inference made by the Radiology Insights model regarding a patient.\n - AgeMismatch\n - SexMismatch\n - LateralityDiscrepancy\n - CompleteOrderDiscrepancy\n - LimitedOrderDiscrepancy\n - Finding\n - CriticalResult\n - FollowupRecommendation\n - RadiologyProcedure\n - FollowupCommunication", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for RadiologyInsightsInference." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "RadiologyInsightsInferenceOptions": { + "type": "object", + "description": "Options regarding follow up recommendation inferences and finding inferences.", + "properties": { + "followupRecommendationOptions": { + "$ref": "#/definitions/FollowupRecommendationOptions", + "description": "Follow-up recommendation options." + }, + "findingOptions": { + "$ref": "#/definitions/FindingOptions", + "description": "Finding options." + } + } + }, + "RadiologyInsightsInferenceResult": { + "type": "object", + "description": "The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date.", + "pattern": "^(?:[2][0-9]{3}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])(?:-preview)?)$" + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "RadiologyInsightsInferenceType": { + "type": "string", + "description": "A Radiology Insights inference types.", + "enum": [ + "ageMismatch", + "lateralityDiscrepancy", + "sexMismatch", + "completeOrderDiscrepancy", + "limitedOrderDiscrepancy", + "finding", + "criticalResult", + "followupRecommendation", + "followupCommunication", + "radiologyProcedure" + ], + "x-ms-enum": { + "name": "RadiologyInsightsInferenceType", + "modelAsString": true, + "values": [ + { + "name": "AgeMismatch", + "value": "ageMismatch", + "description": "Age mismatch inference type" + }, + { + "name": "LateralityDiscrepancy", + "value": "lateralityDiscrepancy", + "description": "Laterality discrepancy inference type" + }, + { + "name": "SexMismatch", + "value": "sexMismatch", + "description": "Sex mismatch inference type" + }, + { + "name": "CompleteOrderDiscrepancy", + "value": "completeOrderDiscrepancy", + "description": "Complete order discrepancy inference type" + }, + { + "name": "LimitedOrderDiscrepancy", + "value": "limitedOrderDiscrepancy", + "description": "Limited order discrepancy inference type" + }, + { + "name": "Finding", + "value": "finding", + "description": "Finding inference type" + }, + { + "name": "CriticalResult", + "value": "criticalResult", + "description": "Critical finding inference type" + }, + { + "name": "FollowupRecommendation", + "value": "followupRecommendation", + "description": "Recommendation inference type" + }, + { + "name": "FollowupCommunication", + "value": "followupCommunication", + "description": "Followup Communication inference type" + }, + { + "name": "RadiologyProcedure", + "value": "radiologyProcedure", + "description": "Radiology Procedure inference type" + } + ] + } + }, + "RadiologyInsightsJob": { + "type": "object", + "description": "Response for the Radiology Insights request.", + "properties": { + "jobData": { + "$ref": "#/definitions/RadiologyInsightsData", + "description": "The request data for the operation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "result": { + "$ref": "#/definitions/RadiologyInsightsInferenceResult", + "description": "The result of the operation.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The unique ID of the job.", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\".", + "readOnly": true + } + }, + "required": [ + "id", + "status" + ] + }, + "RadiologyInsightsModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Radiology Insights model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "inferenceTypes": { + "type": "array", + "description": "This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsInferenceType" + } + }, + "inferenceOptions": { + "$ref": "#/definitions/RadiologyInsightsInferenceOptions", + "description": "Options regarding follow up recommendation inferences and finding inferences." + }, + "locale": { + "type": "string", + "description": "Local for the model to use. If not specified, the model will use the default locale." + } + } + }, + "RadiologyInsightsPatientResult": { + "type": "object", + "description": "Results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "Identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The model's inferences for the given patient.", + "minItems": 1, + "items": { + "$ref": "#/definitions/RadiologyInsightsInference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "patientId", + "inferences" + ] + }, + "RadiologyProcedureInference": { + "type": "object", + "description": "Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text.", + "properties": { + "procedureCodes": { + "type": "array", + "description": "LOINC codes for the procedure.", + "items": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept" + } + }, + "imagingProcedures": { + "type": "array", + "description": "Imaging procedures.", + "minItems": 1, + "items": { + "$ref": "#/definitions/ImagingProcedure" + }, + "x-ms-identifiers": [] + }, + "orderedProcedure": { + "$ref": "#/definitions/OrderedProcedure", + "description": "Ordered procedure information from the document information or text." + } + }, + "required": [ + "imagingProcedures", + "orderedProcedure" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "radiologyProcedure" + }, + "RecommendationFinding": { + "type": "object", + "description": "Finding reference for recommendation.", + "properties": { + "finding": { + "$ref": "#/definitions/Fhir.R4.Observation", + "description": "Finding linked to a recommendation." + }, + "criticalFinding": { + "$ref": "#/definitions/CriticalResult", + "description": "Critical result linked to a recommendation." + }, + "recommendationFindingStatus": { + "$ref": "#/definitions/RecommendationFindingStatusType", + "description": "Recommendation finding status." + }, + "extension": { + "type": "array", + "description": "Additional Content defined by implementations", + "items": { + "$ref": "#/definitions/Fhir.R4.Extension" + } + } + }, + "required": [ + "recommendationFindingStatus" + ] + }, + "RecommendationFindingStatusType": { + "type": "string", + "description": "Recommendation finding status", + "enum": [ + "present", + "differential", + "ruleOut", + "conditional" + ], + "x-ms-enum": { + "name": "RecommendationFindingStatusType", + "modelAsString": true, + "values": [ + { + "name": "Present", + "value": "present", + "description": "Present finding status" + }, + { + "name": "Differential", + "value": "differential", + "description": "Differential finding status" + }, + { + "name": "RuleOut", + "value": "ruleOut", + "description": "Rule out finding status" + }, + { + "name": "Conditional", + "value": "conditional", + "description": "Conditional finding status" + } + ] + } + }, + "SexMismatchInference": { + "type": "object", + "description": "A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information.", + "properties": { + "sexIndication": { + "$ref": "#/definitions/Fhir.R4.CodeableConcept", + "description": "Sex indication : SNOMED CT code for gender finding." + } + }, + "required": [ + "sexIndication" + ], + "allOf": [ + { + "$ref": "#/definitions/RadiologyInsightsInference" + } + ], + "x-ms-discriminator-value": "sexMismatch" + }, + "SpecialtyType": { + "type": "string", + "description": "Known values codes that can be used to indicate the type of the Specialty.", + "enum": [ + "pathology", + "radiology" + ], + "x-ms-enum": { + "name": "SpecialtyType", + "modelAsString": true, + "values": [ + { + "name": "Pathology", + "value": "pathology", + "description": "pathology" + }, + { + "name": "Radiology", + "value": "radiology", + "description": "radiology" + } + ] + } + }, + "TimePeriod": { + "type": "object", + "description": "A duration of time during which an event is happening", + "properties": { + "start": { + "type": "string", + "format": "date-time", + "description": "Starting time with inclusive boundary" + }, + "end": { + "type": "string", + "format": "date-time", + "description": "End time with inclusive boundary, if not ongoing" + } + } + }, + "TrialMatcherData": { + "type": "object", + "description": "The body of the Trial Matcher request.", + "properties": { + "patients": { + "type": "array", + "description": "The list of patients, including their clinical information and data.", + "items": { + "$ref": "#/definitions/PatientRecord" + } + }, + "configuration": { + "$ref": "#/definitions/TrialMatcherModelConfiguration", + "description": "Configuration affecting the Trial Matcher model's inference." + } + }, + "required": [ + "patients" + ] + }, + "TrialMatcherInference": { + "type": "object", + "description": "An inference made by the Trial Matcher model regarding a patient.", + "properties": { + "type": { + "$ref": "#/definitions/TrialMatcherInferenceType", + "description": "The type of the Trial Matcher inference." + }, + "value": { + "type": "string", + "description": "The value of the inference, as relevant for the given inference type." + }, + "description": { + "type": "string", + "description": "The description corresponding to the inference value." + }, + "confidenceScore": { + "type": "number", + "format": "float", + "description": "Confidence score for this inference.", + "minimum": 0, + "maximum": 1 + }, + "evidence": { + "type": "array", + "description": "The evidence corresponding to the inference value.", + "items": { + "$ref": "#/definitions/TrialMatcherInferenceEvidence" + }, + "x-ms-identifiers": [] + }, + "clinicalTrialId": { + "type": "string", + "description": "The identifier of the clinical trial.", + "minLength": 1 + }, + "source": { + "$ref": "#/definitions/ClinicalTrialSource", + "description": "Possible sources of a clinical trial." + }, + "metadata": { + "$ref": "#/definitions/ClinicalTrialMetadata", + "description": "Trial data which is of interest to the potential participant." + } + }, + "required": [ + "type", + "value" + ] + }, + "TrialMatcherInferenceEvidence": { + "type": "object", + "description": "A piece of evidence corresponding to a Trial Matcher inference.", + "properties": { + "eligibilityCriteriaEvidence": { + "type": "string", + "description": "A piece of evidence from the eligibility criteria text of a clinical trial." + }, + "patientDataEvidence": { + "$ref": "#/definitions/ClinicalNoteEvidence", + "description": "A piece of evidence from a clinical note (text document)." + }, + "patientInfoEvidence": { + "$ref": "#/definitions/ClinicalCodedElement", + "description": "A piece of clinical information, expressed as a code in a clinical coding\nsystem." + }, + "importance": { + "type": "number", + "format": "float", + "description": "A value indicating how important this piece of evidence is for the inference.", + "minimum": 0, + "maximum": 1 + } + } + }, + "TrialMatcherInferenceResult": { + "type": "object", + "description": "The inference results for the Trial Matcher request.", + "properties": { + "patientResults": { + "type": "array", + "description": "Results for the patients given in the request.", + "items": { + "$ref": "#/definitions/TrialMatcherPatientResult" + }, + "x-ms-identifiers": [] + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion", + "description": "The version of the model used for inference, expressed as the model date." + }, + "knowledgeGraphLastUpdateDate": { + "type": "string", + "format": "date", + "description": "The date when the clinical trials knowledge graph was last updated." + } + }, + "required": [ + "patientResults", + "modelVersion" + ] + }, + "TrialMatcherInferenceType": { + "type": "string", + "description": "The type of the Trial Matcher inference.", + "enum": [ + "trialEligibility" + ], + "x-ms-enum": { + "name": "TrialMatcherInferenceType", + "modelAsString": true, + "values": [ + { + "name": "TrialEligibility", + "value": "trialEligibility" + } + ] + } + }, + "TrialMatcherJob": { + "type": "object", + "description": "Response for the Trial Matcher request.", + "properties": { + "jobData": { + "$ref": "#/definitions/TrialMatcherData", + "description": "The request data for the operation.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "result": { + "$ref": "#/definitions/TrialMatcherInferenceResult", + "description": "The result of the operation.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The unique ID of the job.", + "minLength": 3, + "maxLength": 36, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The status of the job.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was created.", + "readOnly": true + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job is set to expire.", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The date and time when the processing job was last updated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "Error object that describes the error when status is \"Failed\".", + "readOnly": true + } + }, + "required": [ + "id", + "status" + ] + }, + "TrialMatcherModelConfiguration": { + "type": "object", + "description": "Configuration affecting the Trial Matcher model's inference.", + "properties": { + "verbose": { + "type": "boolean", + "description": "An indication whether the model should produce verbose output.", + "default": false + }, + "includeEvidence": { + "type": "boolean", + "description": "An indication whether the model's output should include evidence for the inferences.", + "default": true + }, + "clinicalTrials": { + "$ref": "#/definitions/ClinicalTrials", + "description": "The clinical trials that the patient(s) should be matched to. The trial\nselection can be given as a list of custom clinical trials and/or a list of\nfilters to known clinical trial registries. In case both are given, the\nresulting trial set is a union of the two sets." + } + }, + "required": [ + "clinicalTrials" + ] + }, + "TrialMatcherPatientResult": { + "type": "object", + "description": "The results of the model's work for a single patient.", + "properties": { + "patientId": { + "type": "string", + "description": "The identifier given for the patient in the request." + }, + "inferences": { + "type": "array", + "description": "The inference results for the patient.", + "items": { + "$ref": "#/definitions/TrialMatcherInference" + }, + "x-ms-identifiers": [] + }, + "neededClinicalInfo": { + "$ref": "#/definitions/NeededClinicalInfo", + "description": "Clinical information which is needed to provide better trial matching results for the patient." + } + }, + "required": [ + "patientId", + "inferences" + ] + } + }, + "parameters": { + "Azure.Core.ExpandQueryParameter": { + "name": "expand", + "in": "query", + "description": "Expand the indicated resources into the response.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-parameter-location": "method" + }, + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/ai/data-plane/HealthInsights/readme.md b/specification/ai/data-plane/HealthInsights/readme.md index 53968e027a2a..ff3bf66a5247 100644 --- a/specification/ai/data-plane/HealthInsights/readme.md +++ b/specification/ai/data-plane/HealthInsights/readme.md @@ -4,10 +4,10 @@ Configuration for generating Health Insights SDK. -The current release is `package-2024-04-01`. +The current release is `package-2024-08-01-preview`. ```yaml -tag: package-2024-04-01 +tag: package-2024-08-01-preview add-credentials: true openapi-type: data-plane ``` @@ -50,6 +50,21 @@ input-file: - stable/2024-04-01/openapi.json ``` +```yaml +directive: + - suppress: AvoidAnonymousTypes + reason: The spec is auto-generated. Tracking issue to fix is https://github.com/Azure/typespec-azure-pr/issues/3349 +``` + +### Release package-2024-08-01-preview + +These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-01-preview' +input-file: + - preview/2024-08-01-preview/openapi.json +``` + ```yaml directive: - suppress: AvoidAnonymousTypes From 4b16befec57ef1c6bfeabc7d0dd7e1a32a90cfc4 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 15:01:27 -0700 Subject: [PATCH 022/101] Upgrade dependencies (#30818) --- eng/tools/specs-model/package.json | 2 +- eng/tools/suppressions/package.json | 2 +- eng/tools/tsp-client-tests/package.json | 2 +- eng/tools/typespec-requirement/package.json | 2 +- eng/tools/typespec-validation/package.json | 2 +- package-lock.json | 579 ++++++++++++-------- package.json | 2 +- 7 files changed, 347 insertions(+), 244 deletions(-) diff --git a/eng/tools/specs-model/package.json b/eng/tools/specs-model/package.json index 76937a240e11..c2a7eb6d990a 100644 --- a/eng/tools/specs-model/package.json +++ b/eng/tools/specs-model/package.json @@ -29,7 +29,7 @@ "@vitest/coverage-v8": "^2.0.4", "eslint": "^8.57.0", "eslint-plugin-unicorn": "^54.0.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "typescript-eslint": "^7.16.0", "vitest": "^2.0.4" } diff --git a/eng/tools/suppressions/package.json b/eng/tools/suppressions/package.json index 5693ff57d0fa..0e7f38e7544c 100644 --- a/eng/tools/suppressions/package.json +++ b/eng/tools/suppressions/package.json @@ -24,7 +24,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" } } diff --git a/eng/tools/tsp-client-tests/package.json b/eng/tools/tsp-client-tests/package.json index 87ec1cd20bf8..84fab0c2c943 100644 --- a/eng/tools/tsp-client-tests/package.json +++ b/eng/tools/tsp-client-tests/package.json @@ -5,7 +5,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/eng/tools/typespec-requirement/package.json b/eng/tools/typespec-requirement/package.json index 9663be1b00bf..ca94512736c4 100644 --- a/eng/tools/typespec-requirement/package.json +++ b/eng/tools/typespec-requirement/package.json @@ -5,7 +5,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/eng/tools/typespec-validation/package.json b/eng/tools/typespec-validation/package.json index b55534c750ca..6edf0c431073 100644 --- a/eng/tools/typespec-validation/package.json +++ b/eng/tools/typespec-validation/package.json @@ -15,7 +15,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "scripts": { diff --git a/package-lock.json b/package-lock.json index e54bdd8e9b3c..91ee30a15277 100644 --- a/package-lock.json +++ b/package-lock.json @@ -25,7 +25,7 @@ "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", - "typescript": "~5.5.4" + "typescript": "~5.6.2" }, "engines": { "node": ">=18.0.0", @@ -44,9 +44,9 @@ } }, "eng/tools/node_modules/@types/node": { - "version": "18.19.50", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.50.tgz", - "integrity": "sha512-xonK+NRrMBRtkL1hVCc3G+uXtjh1Al4opBLjqVmipe5ZAaBYWW6cNAiBVZ1BvmkBhep698rP3UM3aRAdSALuhg==", + "version": "18.19.54", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.19.54.tgz", + "integrity": "sha512-+BRgt0G5gYjTvdLac9sIeE0iZcJxi4Jc4PV5EUzqi+88jmQLr+fRZdv2tCTV7IHKSGxM6SaLoOXQWWUiLUItMw==", "dev": true, "license": "MIT", "dependencies": { @@ -54,9 +54,9 @@ } }, "eng/tools/node_modules/@vitest/coverage-v8": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-2.1.0.tgz", - "integrity": "sha512-yqCkr2nrV4o58VcVMxTVkS6Ggxzy7pmSD8JbTbhbH5PsQfUIES1QT716VUzo33wf2lX9EcWYdT3Vl2MMmjR59g==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-2.1.1.tgz", + "integrity": "sha512-md/A7A3c42oTT8JUHSqjP5uKTWJejzUW4jalpvs+rZ27gsURsMU8DEb+8Jf8C6Kj2gwfSHJqobDNBuoqlm0cFw==", "dev": true, "license": "MIT", "dependencies": { @@ -77,8 +77,8 @@ "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "2.1.0", - "vitest": "2.1.0" + "@vitest/browser": "2.1.1", + "vitest": "2.1.1" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -86,6 +86,34 @@ } } }, + "eng/tools/node_modules/@vitest/mocker": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.1.tgz", + "integrity": "sha512-LNN5VwOEdJqCmJ/2XJBywB11DLlkbY0ooDJW3uRX5cZyYCrc4PI/ePX0iQhE3BiEGiQmK4GE7Q/PqCkkaiPnrA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@vitest/spy": "^2.1.0-beta.1", + "estree-walker": "^3.0.3", + "magic-string": "^0.30.11" + }, + "funding": { + "url": "https://opencollective.com/vitest" + }, + "peerDependencies": { + "@vitest/spy": "2.1.1", + "msw": "^2.3.5", + "vite": "^5.0.0" + }, + "peerDependenciesMeta": { + "msw": { + "optional": true + }, + "vite": { + "optional": true + } + } + }, "eng/tools/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -120,9 +148,9 @@ "license": "MIT" }, "eng/tools/node_modules/vite": { - "version": "5.4.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.4.tgz", - "integrity": "sha512-RHFCkULitycHVTtelJ6jQLd+KSAAzOgEYorV32R2q++M6COBjKJR6BxqClwp5sf0XaBDjVMuJ9wnNfyAJwjMkA==", + "version": "5.4.8", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.8.tgz", + "integrity": "sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==", "dev": true, "license": "MIT", "dependencies": { @@ -180,19 +208,19 @@ } }, "eng/tools/node_modules/vitest": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.0.tgz", - "integrity": "sha512-XuuEeyNkqbfr0FtAvd9vFbInSSNY1ykCQTYQ0sj9wPy4hx+1gR7gqVNdW0AX2wrrM1wWlN5fnJDjF9xG6mYRSQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-2.1.1.tgz", + "integrity": "sha512-97We7/VC0e9X5zBVkvt7SGQMGrRtn3KtySFQG5fpaMlS+l62eeXRQO633AYhSTC3z7IMebnPPNjGXVGNRFlxBA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/expect": "2.1.0", - "@vitest/mocker": "2.1.0", - "@vitest/pretty-format": "^2.1.0", - "@vitest/runner": "2.1.0", - "@vitest/snapshot": "2.1.0", - "@vitest/spy": "2.1.0", - "@vitest/utils": "2.1.0", + "@vitest/expect": "2.1.1", + "@vitest/mocker": "2.1.1", + "@vitest/pretty-format": "^2.1.1", + "@vitest/runner": "2.1.1", + "@vitest/snapshot": "2.1.1", + "@vitest/spy": "2.1.1", + "@vitest/utils": "2.1.1", "chai": "^5.1.1", "debug": "^4.3.6", "magic-string": "^0.30.11", @@ -203,7 +231,7 @@ "tinypool": "^1.0.0", "tinyrainbow": "^1.2.0", "vite": "^5.0.0", - "vite-node": "2.1.0", + "vite-node": "2.1.1", "why-is-node-running": "^2.3.0" }, "bin": { @@ -218,8 +246,8 @@ "peerDependencies": { "@edge-runtime/vm": "*", "@types/node": "^18.0.0 || >=20.0.0", - "@vitest/browser": "2.1.0", - "@vitest/ui": "2.1.0", + "@vitest/browser": "2.1.1", + "@vitest/ui": "2.1.1", "happy-dom": "*", "jsdom": "*" }, @@ -244,34 +272,6 @@ } } }, - "eng/tools/node_modules/vitest/node_modules/@vitest/mocker": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-2.1.0.tgz", - "integrity": "sha512-ZxENovUqhzl+QiOFpagiHUNUuZ1qPd5yYTCYHomGIZOFArzn4mgX2oxZmiAItJWAaXHG6bbpb/DpSPhlk5DgtA==", - "dev": true, - "license": "MIT", - "dependencies": { - "@vitest/spy": "^2.1.0-beta.1", - "estree-walker": "^3.0.3", - "magic-string": "^0.30.11" - }, - "funding": { - "url": "https://opencollective.com/vitest" - }, - "peerDependencies": { - "@vitest/spy": "2.1.0", - "msw": "^2.3.5", - "vite": "^5.0.0" - }, - "peerDependenciesMeta": { - "msw": { - "optional": true - }, - "vite": { - "optional": true - } - } - }, "eng/tools/specs-model": { "name": "@azure-tools/specs-model", "dev": true, @@ -287,7 +287,7 @@ "@vitest/coverage-v8": "^2.0.4", "eslint": "^8.57.0", "eslint-plugin-unicorn": "^54.0.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "typescript-eslint": "^7.16.0", "vitest": "^2.0.4" }, @@ -311,7 +311,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -325,7 +325,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -339,7 +339,7 @@ "devDependencies": { "@types/node": "^18.19.31", "execa": "^9.3.0", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -362,7 +362,7 @@ "devDependencies": { "@types/node": "^18.19.31", "@vitest/coverage-v8": "^2.0.4", - "typescript": "~5.5.4", + "typescript": "~5.6.2", "vitest": "^2.0.4" }, "engines": { @@ -1206,9 +1206,10 @@ } }, "node_modules/@azure/core-http": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.3.tgz", - "integrity": "sha512-QMib3wXotJMFhHgmJBPUF9YsyErw34H0XDFQd9CauH7TPB+RGcyl9Ayy7iURtJB04ngXhE6YwrQsWDXlSLrilg==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@azure/core-http/-/core-http-3.0.4.tgz", + "integrity": "sha512-Fok9VVhMdxAFOtqiiAtg74fL0UJkt0z3D+ouUUxcRLzZNBioPRAMJFVxiWoJljYpXsRi4GDQHzQHDc9AiYaIUQ==", + "deprecated": "This package is no longer supported. Please migrate to use @azure/core-rest-pipeline", "dev": true, "license": "MIT", "dependencies": { @@ -2046,9 +2047,9 @@ } }, "node_modules/@eslint-community/regexpp": { - "version": "4.11.0", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.0.tgz", - "integrity": "sha512-G/M/tIiMrTAxEWRfLfQJMmGNX28IxBg4PBz8XqQhqUHLFI6TL2htpIB1iQCj144V5ee/JaKyT9/WZ0MGZWfA7A==", + "version": "4.11.1", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.11.1.tgz", + "integrity": "sha512-m4DVN9ZqskZoLU5GlWZadwDnYo3vAEydiUayB9widCl9ffWx2IvPnp6n3on5rJmziJSw9Bv+Z3ChDVdMwXCY8Q==", "dev": true, "license": "MIT", "engines": { @@ -2104,9 +2105,9 @@ "license": "MIT" }, "node_modules/@eslint/js": { - "version": "9.10.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.10.0.tgz", - "integrity": "sha512-fuXtbiP5GWIn8Fz+LWoOMVf/Jxm+aajZYkhi6CuEm4SxymFM+eUWzbO9qXT+L0iCkL5+KGYMCSGxo686H19S1g==", + "version": "9.11.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.11.1.tgz", + "integrity": "sha512-/qu+TWz8WwPWc7/HcIJKi+c+MOm46GdVaSlTTQcaqaL53+GsoA6MxWp5PtTx48qbSP7ylM1Kn7nhvkugfJvRSA==", "dev": true, "license": "MIT", "engines": { @@ -2117,18 +2118,19 @@ "version": "5.5.3", "resolved": "https://registry.npmjs.org/@faker-js/faker/-/faker-5.5.3.tgz", "integrity": "sha512-R11tGE6yIFwqpaIqcfkcg7AICXzFg14+5h5v0TfF/9+RMDL6jhzCy/pxHVOfbALGdtVYdt6JdR21tuxEgl34dw==", + "deprecated": "Please update to a newer version.", "dev": true, "license": "MIT" }, "node_modules/@humanwhocodes/config-array": { - "version": "0.11.14", - "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", - "integrity": "sha512-3T8LkOmg45BV5FICb15QQMsyUSWrQ8AygVfC7ZG32zOalnqrilm018ZVCw0eapXux8FtA33q8PSRSstjee3jSg==", + "version": "0.13.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.13.0.tgz", + "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", "deprecated": "Use @eslint/config-array instead", "dev": true, "license": "Apache-2.0", "dependencies": { - "@humanwhocodes/object-schema": "^2.0.2", + "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", "minimatch": "^3.0.5" }, @@ -2580,9 +2582,9 @@ } }, "node_modules/@rollup/rollup-android-arm-eabi": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.21.3.tgz", - "integrity": "sha512-MmKSfaB9GX+zXl6E8z4koOr/xU63AMVleLEa64v7R0QF/ZloMs5vcD1sHgM64GXXS1csaJutG+ddtzcueI/BLg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.23.0.tgz", + "integrity": "sha512-8OR+Ok3SGEMsAZispLx8jruuXw0HVF16k+ub2eNXKHDmdxL4cf9NlNpAzhlOhNyXzKDEJuFeq0nZm+XlNb1IFw==", "cpu": [ "arm" ], @@ -2594,9 +2596,9 @@ ] }, "node_modules/@rollup/rollup-android-arm64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.21.3.tgz", - "integrity": "sha512-zrt8ecH07PE3sB4jPOggweBjJMzI1JG5xI2DIsUbkA+7K+Gkjys6eV7i9pOenNSDJH3eOr/jLb/PzqtmdwDq5g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.23.0.tgz", + "integrity": "sha512-rEFtX1nP8gqmLmPZsXRMoLVNB5JBwOzIAk/XAcEPuKrPa2nPJ+DuGGpfQUR0XjRm8KjHfTZLpWbKXkA5BoFL3w==", "cpu": [ "arm64" ], @@ -2608,9 +2610,9 @@ ] }, "node_modules/@rollup/rollup-darwin-arm64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.21.3.tgz", - "integrity": "sha512-P0UxIOrKNBFTQaXTxOH4RxuEBVCgEA5UTNV6Yz7z9QHnUJ7eLX9reOd/NYMO3+XZO2cco19mXTxDMXxit4R/eQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.23.0.tgz", + "integrity": "sha512-ZbqlMkJRMMPeapfaU4drYHns7Q5MIxjM/QeOO62qQZGPh9XWziap+NF9fsqPHT0KzEL6HaPspC7sOwpgyA3J9g==", "cpu": [ "arm64" ], @@ -2622,9 +2624,9 @@ ] }, "node_modules/@rollup/rollup-darwin-x64": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.21.3.tgz", - "integrity": "sha512-L1M0vKGO5ASKntqtsFEjTq/fD91vAqnzeaF6sfNAy55aD+Hi2pBI5DKwCO+UNDQHWsDViJLqshxOahXyLSh3EA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.23.0.tgz", + "integrity": "sha512-PfmgQp78xx5rBCgn2oYPQ1rQTtOaQCna0kRaBlc5w7RlA3TDGGo7m3XaptgitUZ54US9915i7KeVPHoy3/W8tA==", "cpu": [ "x64" ], @@ -2636,9 +2638,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-gnueabihf": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.21.3.tgz", - "integrity": "sha512-btVgIsCjuYFKUjopPoWiDqmoUXQDiW2A4C3Mtmp5vACm7/GnyuprqIDPNczeyR5W8rTXEbkmrJux7cJmD99D2g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.23.0.tgz", + "integrity": "sha512-WAeZfAAPus56eQgBioezXRRzArAjWJGjNo/M+BHZygUcs9EePIuGI1Wfc6U/Ki+tMW17FFGvhCfYnfcKPh18SA==", "cpu": [ "arm" ], @@ -2650,9 +2652,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm-musleabihf": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.21.3.tgz", - "integrity": "sha512-zmjbSphplZlau6ZTkxd3+NMtE4UKVy7U4aVFMmHcgO5CUbw17ZP6QCgyxhzGaU/wFFdTfiojjbLG3/0p9HhAqA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.23.0.tgz", + "integrity": "sha512-v7PGcp1O5XKZxKX8phTXtmJDVpE20Ub1eF6w9iMmI3qrrPak6yR9/5eeq7ziLMrMTjppkkskXyxnmm00HdtXjA==", "cpu": [ "arm" ], @@ -2664,9 +2666,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.21.3.tgz", - "integrity": "sha512-nSZfcZtAnQPRZmUkUQwZq2OjQciR6tEoJaZVFvLHsj0MF6QhNMg0fQ6mUOsiCUpTqxTx0/O6gX0V/nYc7LrgPw==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.23.0.tgz", + "integrity": "sha512-nAbWsDZ9UkU6xQiXEyXBNHAKbzSAi95H3gTStJq9UGiS1v+YVXwRHcQOQEF/3CHuhX5BVhShKoeOf6Q/1M+Zhg==", "cpu": [ "arm64" ], @@ -2678,9 +2680,9 @@ ] }, "node_modules/@rollup/rollup-linux-arm64-musl": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.21.3.tgz", - "integrity": "sha512-MnvSPGO8KJXIMGlQDYfvYS3IosFN2rKsvxRpPO2l2cum+Z3exiExLwVU+GExL96pn8IP+GdH8Tz70EpBhO0sIQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.23.0.tgz", + "integrity": "sha512-5QT/Di5FbGNPaVw8hHO1wETunwkPuZBIu6W+5GNArlKHD9fkMHy7vS8zGHJk38oObXfWdsuLMogD4sBySLJ54g==", "cpu": [ "arm64" ], @@ -2692,9 +2694,9 @@ ] }, "node_modules/@rollup/rollup-linux-powerpc64le-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.21.3.tgz", - "integrity": "sha512-+W+p/9QNDr2vE2AXU0qIy0qQE75E8RTwTwgqS2G5CRQ11vzq0tbnfBd6brWhS9bCRjAjepJe2fvvkvS3dno+iw==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-powerpc64le-gnu/-/rollup-linux-powerpc64le-gnu-4.23.0.tgz", + "integrity": "sha512-Sefl6vPyn5axzCsO13r1sHLcmPuiSOrKIImnq34CBurntcJ+lkQgAaTt/9JkgGmaZJ+OkaHmAJl4Bfd0DmdtOQ==", "cpu": [ "ppc64" ], @@ -2706,9 +2708,9 @@ ] }, "node_modules/@rollup/rollup-linux-riscv64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.21.3.tgz", - "integrity": "sha512-yXH6K6KfqGXaxHrtr+Uoy+JpNlUlI46BKVyonGiaD74ravdnF9BUNC+vV+SIuB96hUMGShhKV693rF9QDfO6nQ==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.23.0.tgz", + "integrity": "sha512-o4QI2KU/QbP7ZExMse6ULotdV3oJUYMrdx3rBZCgUF3ur3gJPfe8Fuasn6tia16c5kZBBw0aTmaUygad6VB/hQ==", "cpu": [ "riscv64" ], @@ -2720,9 +2722,9 @@ ] }, "node_modules/@rollup/rollup-linux-s390x-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.21.3.tgz", - "integrity": "sha512-R8cwY9wcnApN/KDYWTH4gV/ypvy9yZUHlbJvfaiXSB48JO3KpwSpjOGqO4jnGkLDSk1hgjYkTbTt6Q7uvPf8eg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.23.0.tgz", + "integrity": "sha512-+bxqx+V/D4FGrpXzPGKp/SEZIZ8cIW3K7wOtcJAoCrmXvzRtmdUhYNbgd+RztLzfDEfA2WtKj5F4tcbNPuqgeg==", "cpu": [ "s390x" ], @@ -2734,9 +2736,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-gnu": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.21.3.tgz", - "integrity": "sha512-kZPbX/NOPh0vhS5sI+dR8L1bU2cSO9FgxwM8r7wHzGydzfSjLRCFAT87GR5U9scj2rhzN3JPYVC7NoBbl4FZ0g==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.23.0.tgz", + "integrity": "sha512-I/eXsdVoCKtSgK9OwyQKPAfricWKUMNCwJKtatRYMmDo5N859tbO3UsBw5kT3dU1n6ZcM1JDzPRSGhAUkxfLxw==", "cpu": [ "x64" ], @@ -2748,9 +2750,9 @@ ] }, "node_modules/@rollup/rollup-linux-x64-musl": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.21.3.tgz", - "integrity": "sha512-S0Yq+xA1VEH66uiMNhijsWAafffydd2X5b77eLHfRmfLsRSpbiAWiRHV6DEpz6aOToPsgid7TI9rGd6zB1rhbg==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.23.0.tgz", + "integrity": "sha512-4ZoDZy5ShLbbe1KPSafbFh1vbl0asTVfkABC7eWqIs01+66ncM82YJxV2VtV3YVJTqq2P8HMx3DCoRSWB/N3rw==", "cpu": [ "x64" ], @@ -2762,9 +2764,9 @@ ] }, "node_modules/@rollup/rollup-win32-arm64-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.21.3.tgz", - "integrity": "sha512-9isNzeL34yquCPyerog+IMCNxKR8XYmGd0tHSV+OVx0TmE0aJOo9uw4fZfUuk2qxobP5sug6vNdZR6u7Mw7Q+Q==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.23.0.tgz", + "integrity": "sha512-+5Ky8dhft4STaOEbZu3/NU4QIyYssKO+r1cD3FzuusA0vO5gso15on7qGzKdNXnc1gOrsgCqZjRw1w+zL4y4hQ==", "cpu": [ "arm64" ], @@ -2776,9 +2778,9 @@ ] }, "node_modules/@rollup/rollup-win32-ia32-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.21.3.tgz", - "integrity": "sha512-nMIdKnfZfzn1Vsk+RuOvl43ONTZXoAPUUxgcU0tXooqg4YrAqzfKzVenqqk2g5efWh46/D28cKFrOzDSW28gTA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.23.0.tgz", + "integrity": "sha512-0SPJk4cPZQhq9qA1UhIRumSE3+JJIBBjtlGl5PNC///BoaByckNZd53rOYD0glpTkYFBQSt7AkMeLVPfx65+BQ==", "cpu": [ "ia32" ], @@ -2790,9 +2792,9 @@ ] }, "node_modules/@rollup/rollup-win32-x64-msvc": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.21.3.tgz", - "integrity": "sha512-fOvu7PCQjAj4eWDEuD8Xz5gpzFqXzGlxHZozHP4b9Jxv9APtdxL6STqztDzMLuRXEc4UpXGGhx029Xgm91QBeA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.23.0.tgz", + "integrity": "sha512-lqCK5GQC8fNo0+JvTSxcG7YB1UKYp8yrNLhsArlvPWN+16ovSZgoehlVHg6X0sSWPUkpjRBR5TuR12ZugowZ4g==", "cpu": [ "x64" ], @@ -3113,9 +3115,9 @@ } }, "node_modules/@types/estree": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.5.tgz", - "integrity": "sha512-/kYRxGDLWzHOB7q+wtSUQlFrtcdUccpfy+X+9iMBpHK8QLLhx2wIPYuS5DYtR9Wa/YlZAbIovy7qVdB1Aq6Lyw==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", + "integrity": "sha512-AYnb1nQyY49te+VRAVgmzfcgjYS91mY5P0TKUDCLEM+gNnA+3T6rWITXRLYCpahpqSQbN5cE+gHpnPyXjHWxcw==", "dev": true, "license": "MIT" }, @@ -3593,14 +3595,14 @@ "license": "ISC" }, "node_modules/@vitest/expect": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.0.tgz", - "integrity": "sha512-N3/xR4fSu0+6sVZETEtPT1orUs2+Y477JOXTcU3xKuu3uBlsgbD7/7Mz2LZ1Jr1XjwilEWlrIgSCj4N1+5ZmsQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-2.1.1.tgz", + "integrity": "sha512-YeueunS0HiHiQxk+KEOnq/QMzlUuOzbU1Go+PgAsHvvv3tUkJPm9xWt+6ITNTlzsMXUjmgm5T+U7KBPK2qQV6w==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/spy": "2.1.0", - "@vitest/utils": "2.1.0", + "@vitest/spy": "2.1.1", + "@vitest/utils": "2.1.1", "chai": "^5.1.1", "tinyrainbow": "^1.2.0" }, @@ -3609,9 +3611,9 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.0.tgz", - "integrity": "sha512-7sxf2F3DNYatgmzXXcTh6cq+/fxwB47RIQqZJFoSH883wnVAoccSRT6g+dTKemUBo8Q5N4OYYj1EBXLuRKvp3Q==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-2.1.1.tgz", + "integrity": "sha512-SjxPFOtuINDUW8/UkElJYQSFtnWX7tMksSGW0vfjxMneFqxVr8YJ979QpMbDW7g+BIiq88RAGDjf7en6rvLPPQ==", "dev": true, "license": "MIT", "dependencies": { @@ -3622,13 +3624,13 @@ } }, "node_modules/@vitest/runner": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.0.tgz", - "integrity": "sha512-D9+ZiB8MbMt7qWDRJc4CRNNUlne/8E1X7dcKhZVAbcOKG58MGGYVDqAq19xlhNfMFZsW0bpVKgztBwks38Ko0w==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-2.1.1.tgz", + "integrity": "sha512-uTPuY6PWOYitIkLPidaY5L3t0JJITdGTSwBtwMjKzo5O6RCOEncz9PUN+0pDidX8kTHYjO0EwUIvhlGpnGpxmA==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/utils": "2.1.0", + "@vitest/utils": "2.1.1", "pathe": "^1.1.2" }, "funding": { @@ -3636,13 +3638,13 @@ } }, "node_modules/@vitest/snapshot": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.0.tgz", - "integrity": "sha512-x69CygGMzt9VCO283K2/FYQ+nBrOj66OTKpsPykjCR4Ac3lLV+m85hj9reaIGmjBSsKzVvbxWmjWE3kF5ha3uQ==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-2.1.1.tgz", + "integrity": "sha512-BnSku1WFy7r4mm96ha2FzN99AZJgpZOWrAhtQfoxjUU5YMRpq1zmHRq7a5K9/NjqonebO7iVDla+VvZS8BOWMw==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.0", + "@vitest/pretty-format": "2.1.1", "magic-string": "^0.30.11", "pathe": "^1.1.2" }, @@ -3651,9 +3653,9 @@ } }, "node_modules/@vitest/spy": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.0.tgz", - "integrity": "sha512-IXX5NkbdgTYTog3F14i2LgnBc+20YmkXMx0IWai84mcxySUDRgm0ihbOfR4L0EVRBDFG85GjmQQEZNNKVVpkZw==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-2.1.1.tgz", + "integrity": "sha512-ZM39BnZ9t/xZ/nF4UwRH5il0Sw93QnZXd9NAZGRpIgj0yvVwPpLd702s/Cx955rGaMlyBQkZJ2Ir7qyY48VZ+g==", "dev": true, "license": "MIT", "dependencies": { @@ -3664,13 +3666,13 @@ } }, "node_modules/@vitest/utils": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.0.tgz", - "integrity": "sha512-rreyfVe0PuNqJfKYUwfPDfi6rrp0VSu0Wgvp5WBqJonP+4NvXHk48X6oBam1Lj47Hy6jbJtnMj3OcRdrkTP0tA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-2.1.1.tgz", + "integrity": "sha512-Y6Q9TsI+qJ2CC0ZKj6VBb+T8UPz593N113nnUykqwANqhgf3QkZeHFlusgKLTqrnVHbj/XDKZcDHol+dxVT+rQ==", "dev": true, "license": "MIT", "dependencies": { - "@vitest/pretty-format": "2.1.0", + "@vitest/pretty-format": "2.1.1", "loupe": "^3.1.1", "tinyrainbow": "^1.2.0" }, @@ -4011,9 +4013,9 @@ } }, "node_modules/browserslist": { - "version": "4.23.3", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.23.3.tgz", - "integrity": "sha512-btwCFJVjI4YWDNfau8RhZ+B1Q/VLoUITrm3RlP6y1tYGWIOa+InuYiRGXUBXo8nA1qKmHMyLB/iVQg5TT4eFoA==", + "version": "4.24.0", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.0.tgz", + "integrity": "sha512-Rmb62sR1Zpjql25eSanFGEhAxcFwfA1K0GuQcLoaJBAcENegrQut3hYdhXFF1obQfiDyqIW/cLM5HSJ/9k884A==", "dev": true, "funding": [ { @@ -4031,8 +4033,8 @@ ], "license": "MIT", "dependencies": { - "caniuse-lite": "^1.0.30001646", - "electron-to-chromium": "^1.5.4", + "caniuse-lite": "^1.0.30001663", + "electron-to-chromium": "^1.5.28", "node-releases": "^2.0.18", "update-browserslist-db": "^1.1.0" }, @@ -4043,6 +4045,31 @@ "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" } }, + "node_modules/buffer": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/buffer/-/buffer-6.0.3.tgz", + "integrity": "sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "MIT", + "dependencies": { + "base64-js": "^1.3.1", + "ieee754": "^1.2.1" + } + }, "node_modules/builtin-modules": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-3.3.0.tgz", @@ -4094,9 +4121,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001660", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001660.tgz", - "integrity": "sha512-GacvNTTuATm26qC74pt+ad1fW15mlQ/zuTzzY1ZoIzECTP8HURDfF43kNxPgf7H1jmelCBQTTbBNxdSXOA7Bqg==", + "version": "1.0.30001664", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001664.tgz", + "integrity": "sha512-AmE7k4dXiNKQipgn7a2xg558IRqPN3jMQY/rOsbxDhrd0tyChwbITBfiwtnqz8bi2M5mIWbxAYBvk7W7QBUS2g==", "dev": true, "funding": [ { @@ -4670,9 +4697,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.20", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.20.tgz", - "integrity": "sha512-74mdl6Fs1HHzK9SUX4CKFxAtAe3nUns48y79TskHNAG6fGOlLfyKA4j855x+0b5u8rWJIrlaG9tcTPstMlwjIw==", + "version": "1.5.30", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.30.tgz", + "integrity": "sha512-sXI35EBN4lYxzc/pIGorlymYNzDBOqkSlVRe6MkgBsW/hW1tpC/HDJ2fjG7XnjakzfLEuvdmux0Mjs6jHq4UOA==", "dev": true, "license": "ISC" }, @@ -4774,17 +4801,17 @@ } }, "node_modules/eslint": { - "version": "8.57.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.0.tgz", - "integrity": "sha512-dZ6+mexnaTIbSBZWgou51U6OmzIhYM2VcNdtiTtI7qPNZm35Akpr0f6vtw3w1Kmn5PYo+tZVfh13WrhpS6oLqQ==", + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.57.1.tgz", + "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", "dev": true, "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", "@eslint/eslintrc": "^2.1.4", - "@eslint/js": "8.57.0", - "@humanwhocodes/config-array": "^0.11.14", + "@eslint/js": "8.57.1", + "@humanwhocodes/config-array": "^0.13.0", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", "@ungap/structured-clone": "^1.2.0", @@ -4905,9 +4932,9 @@ } }, "node_modules/eslint-plugin-unicorn/node_modules/eslint-visitor-keys": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.0.0.tgz", - "integrity": "sha512-OtIRv/2GyiF6o/d8K7MYKKbXrOUBIK6SfkIRM4Z0dY3w+LiQ0vy3F57m0Z71bjbyeiWFiHJ8brqnmE6H6/jEuw==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-4.1.0.tgz", + "integrity": "sha512-Q7lok0mqMUSf5a/AdAZkA5a/gHcO6snwQClVNNvFKCAVlxXucdU8pKydU5ZVZjBx5xr37vGbFFWtLQYreLzrZg==", "dev": true, "license": "Apache-2.0", "engines": { @@ -4918,15 +4945,15 @@ } }, "node_modules/eslint-plugin-unicorn/node_modules/espree": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/espree/-/espree-10.1.0.tgz", - "integrity": "sha512-M1M6CpiE6ffoigIOWYO9UDP8TMUw9kqb21tf+08IgDYjCsOvCuDt4jQcZmoYxx+w7zlKw9/N0KXfto+I8/FrXA==", + "version": "10.2.0", + "resolved": "https://registry.npmjs.org/espree/-/espree-10.2.0.tgz", + "integrity": "sha512-upbkBJbckcCNBDBDXEbuhjbP68n+scUd3k/U2EkyM9nw+I/jPiL4cLF/Al06CF96wRltFda16sxDFrxsI1v0/g==", "dev": true, "license": "BSD-2-Clause", "dependencies": { "acorn": "^8.12.0", "acorn-jsx": "^5.3.2", - "eslint-visitor-keys": "^4.0.0" + "eslint-visitor-keys": "^4.1.0" }, "engines": { "node": "^18.18.0 || ^20.9.0 || >=21.1.0" @@ -4986,9 +5013,9 @@ } }, "node_modules/eslint/node_modules/@eslint/js": { - "version": "8.57.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz", - "integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==", + "version": "8.57.1", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", + "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", "dev": true, "license": "MIT", "engines": { @@ -5271,10 +5298,20 @@ "node": ">=6" } }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, "node_modules/execa": { - "version": "9.3.1", - "resolved": "https://registry.npmjs.org/execa/-/execa-9.3.1.tgz", - "integrity": "sha512-gdhefCCNy/8tpH/2+ajP9IQc14vXchNdd0weyzSJEFURhRMGncQ+zKFxwjAufIewPEJm9BPOaJnvg2UtlH2gPQ==", + "version": "9.4.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-9.4.0.tgz", + "integrity": "sha512-yKHlle2YGxZE842MERVIplWwNH5VYmqqcPFgtnlU//K8gxuFFXu0pwd/CrfXTumFpeEiufsP7+opT/bPJa1yVw==", "dev": true, "license": "MIT", "dependencies": { @@ -5285,7 +5322,7 @@ "human-signals": "^8.0.0", "is-plain-obj": "^4.1.0", "is-stream": "^4.0.1", - "npm-run-path": "^5.2.0", + "npm-run-path": "^6.0.0", "pretty-ms": "^9.0.0", "signal-exit": "^4.1.0", "strip-final-newline": "^4.0.0", @@ -5409,9 +5446,9 @@ "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.1.tgz", - "integrity": "sha512-MWipKbbYiYI0UC7cl8m/i/IWTqfC8YXsqjzybjddLsFjStroQzsHXkc73JutMvBiXmOvapk+axIl79ig5t55Bw==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.2.tgz", + "integrity": "sha512-GR6f0hD7XXyNJa25Tb9BuIdN0tdr+0BMi6/CJPH3wJO1JjNG3n/VsSw38AwRdKZABm8lGbPfakLRkYzx2V9row==", "dev": true, "license": "MIT" }, @@ -6101,6 +6138,27 @@ "node": ">=0.10.0" } }, + "node_modules/ieee754": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz", + "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "license": "BSD-3-Clause" + }, "node_modules/ignore": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", @@ -7294,16 +7352,17 @@ } }, "node_modules/npm-run-path": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz", - "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-6.0.0.tgz", + "integrity": "sha512-9qny7Z9DsQU8Ou39ERsPU4OZQlSTP47ShQzuKZ6PRXpYLtIFgl/DEBYEXKlvcEa+9tHVcK8CF81Y2V72qaZhWA==", "dev": true, "license": "MIT", "dependencies": { - "path-key": "^4.0.0" + "path-key": "^4.0.0", + "unicorn-magic": "^0.3.0" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -7322,6 +7381,19 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/npm-run-path/node_modules/unicorn-magic": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.3.0.tgz", + "integrity": "sha512-+QBBXBCvifc56fsbuxZQ6Sic3wqqc3WWaqxs58gvJrcOuN83HGTCwz3oS5phzU9LthRNE9VrJCFCLUgHeeFnfA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/oauth-sign": { "version": "0.9.0", "resolved": "https://registry.npmjs.org/oauth-sign/-/oauth-sign-0.9.0.tgz", @@ -7647,9 +7719,9 @@ } }, "node_modules/package-json-from-dist": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.0.tgz", - "integrity": "sha512-dATvCeZN/8wQsGywez1mzHtTlP22H8OEfPrVMLNr4/eGa+ijtLn/6M5f0dY8UKNrC2O9UCU6SSoG3qRKnt7STw==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", "dev": true, "license": "BlueOak-1.0.0" }, @@ -7831,9 +7903,9 @@ } }, "node_modules/postcss": { - "version": "8.4.45", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.45.tgz", - "integrity": "sha512-7KTLTdzdZZYscUc65XmjFiB73vBhBfbPztCYdUNvlaso9PrzjzcmjqBPR0lNGkcVlcO4BjiO5rK/qNz+XAen1Q==", + "version": "8.4.47", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.47.tgz", + "integrity": "sha512-56rxCq7G/XfB4EkXq9Egn5GCqugWvDFjafDOThIdMBsI15iqPqR5r15TfSr1YPYeEI19YeaXMCbY6u88Y76GLQ==", "dev": true, "funding": [ { @@ -7852,13 +7924,20 @@ "license": "MIT", "dependencies": { "nanoid": "^3.3.7", - "picocolors": "^1.0.1", - "source-map-js": "^1.2.0" + "picocolors": "^1.1.0", + "source-map-js": "^1.2.1" }, "engines": { "node": "^10 || ^12 || >=14" } }, + "node_modules/postcss/node_modules/picocolors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "dev": true, + "license": "ISC" + }, "node_modules/postman-collection": { "version": "4.5.0", "resolved": "https://registry.npmjs.org/postman-collection/-/postman-collection-4.5.0.tgz", @@ -8478,13 +8557,13 @@ } }, "node_modules/rollup": { - "version": "4.21.3", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.21.3.tgz", - "integrity": "sha512-7sqRtBNnEbcBtMeRVc6VRsJMmpI+JU1z9VTvW8D4gXIYQFz0aLcsE6rRkyghZkLfEgUZgVvOG7A5CVz/VW5GIA==", + "version": "4.23.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.23.0.tgz", + "integrity": "sha512-vXB4IT9/KLDrS2WRXmY22sVB2wTsTwkpxjB8Q3mnakTENcYw3FRmfdYDy/acNmls+lHmDazgrRjK/yQ6hQAtwA==", "dev": true, "license": "MIT", "dependencies": { - "@types/estree": "1.0.5" + "@types/estree": "1.0.6" }, "bin": { "rollup": "dist/bin/rollup" @@ -8494,22 +8573,22 @@ "npm": ">=8.0.0" }, "optionalDependencies": { - "@rollup/rollup-android-arm-eabi": "4.21.3", - "@rollup/rollup-android-arm64": "4.21.3", - "@rollup/rollup-darwin-arm64": "4.21.3", - "@rollup/rollup-darwin-x64": "4.21.3", - "@rollup/rollup-linux-arm-gnueabihf": "4.21.3", - "@rollup/rollup-linux-arm-musleabihf": "4.21.3", - "@rollup/rollup-linux-arm64-gnu": "4.21.3", - "@rollup/rollup-linux-arm64-musl": "4.21.3", - "@rollup/rollup-linux-powerpc64le-gnu": "4.21.3", - "@rollup/rollup-linux-riscv64-gnu": "4.21.3", - "@rollup/rollup-linux-s390x-gnu": "4.21.3", - "@rollup/rollup-linux-x64-gnu": "4.21.3", - "@rollup/rollup-linux-x64-musl": "4.21.3", - "@rollup/rollup-win32-arm64-msvc": "4.21.3", - "@rollup/rollup-win32-ia32-msvc": "4.21.3", - "@rollup/rollup-win32-x64-msvc": "4.21.3", + "@rollup/rollup-android-arm-eabi": "4.23.0", + "@rollup/rollup-android-arm64": "4.23.0", + "@rollup/rollup-darwin-arm64": "4.23.0", + "@rollup/rollup-darwin-x64": "4.23.0", + "@rollup/rollup-linux-arm-gnueabihf": "4.23.0", + "@rollup/rollup-linux-arm-musleabihf": "4.23.0", + "@rollup/rollup-linux-arm64-gnu": "4.23.0", + "@rollup/rollup-linux-arm64-musl": "4.23.0", + "@rollup/rollup-linux-powerpc64le-gnu": "4.23.0", + "@rollup/rollup-linux-riscv64-gnu": "4.23.0", + "@rollup/rollup-linux-s390x-gnu": "4.23.0", + "@rollup/rollup-linux-x64-gnu": "4.23.0", + "@rollup/rollup-linux-x64-musl": "4.23.0", + "@rollup/rollup-win32-arm64-msvc": "4.23.0", + "@rollup/rollup-win32-ia32-msvc": "4.23.0", + "@rollup/rollup-win32-x64-msvc": "4.23.0", "fsevents": "~2.3.2" } }, @@ -8676,9 +8755,9 @@ } }, "node_modules/simple-git": { - "version": "3.26.0", - "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.26.0.tgz", - "integrity": "sha512-5tbkCSzuskR6uA7uA23yjasmA0RzugVo8QM2bpsnxkrgP13eisFT7TMS4a+xKEJvbmr4qf+l0WT3eKa9IxxUyw==", + "version": "3.27.0", + "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-3.27.0.tgz", + "integrity": "sha512-ivHoFS9Yi9GY49ogc6/YAi3Fl9ROnF4VyubNylgCkA+RVqLaKWnDSzXOVzya8csELIaWaYNutsEuAhZrtOjozA==", "dev": true, "license": "MIT", "dependencies": { @@ -9321,9 +9400,9 @@ } }, "node_modules/typescript": { - "version": "5.5.4", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz", - "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==", + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", + "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==", "dev": true, "license": "Apache-2.0", "bin": { @@ -9413,9 +9492,9 @@ } }, "node_modules/update-browserslist-db": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.0.tgz", - "integrity": "sha512-EdRAaAyk2cUE1wOf2DkEhzxqOQvFOoRJFNS6NeyJ01Gp2beMRpBAINjM2iDXE3KCuKhwnvHIQCJm6ThL2Z+HzQ==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.1.tgz", + "integrity": "sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==", "dev": true, "funding": [ { @@ -9433,8 +9512,8 @@ ], "license": "MIT", "dependencies": { - "escalade": "^3.1.2", - "picocolors": "^1.0.1" + "escalade": "^3.2.0", + "picocolors": "^1.1.0" }, "bin": { "update-browserslist-db": "cli.js" @@ -9443,6 +9522,13 @@ "browserslist": ">= 4.21.0" } }, + "node_modules/update-browserslist-db/node_modules/picocolors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "dev": true, + "license": "ISC" + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -9538,9 +9624,9 @@ } }, "node_modules/vite-node": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.0.tgz", - "integrity": "sha512-+ybYqBVUjYyIscoLzMWodus2enQDZOpGhcU6HdOVD6n8WZdk12w1GFL3mbnxLs7hPtRtqs1Wo5YF6/Tsr6fmhg==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-2.1.1.tgz", + "integrity": "sha512-N/mGckI1suG/5wQI35XeR9rsMsPqKXzq1CdUndzVstBj/HvyxxGctwnK6WX43NGt5L3Z5tcRf83g4TITKJhPrA==", "dev": true, "license": "MIT", "dependencies": { @@ -9560,9 +9646,9 @@ } }, "node_modules/vite-node/node_modules/@types/node": { - "version": "22.5.4", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.5.4.tgz", - "integrity": "sha512-FDuKUJQm/ju9fT/SeX/6+gBzoPzlVCzfzmGkwKvRHQVxi4BntVbyIwf6a4Xn62mrvndLiml6z/UBXIdEVjQLXg==", + "version": "22.7.4", + "resolved": "https://registry.npmjs.org/@types/node/-/node-22.7.4.tgz", + "integrity": "sha512-y+NPi1rFzDs1NdQHHToqeiX2TIS79SWEAw9GYhkkx8bD0ChpfqC+n2j5OXOCpzfojBEBt6DnEnnG9MY0zk1XLg==", "dev": true, "license": "MIT", "optional": true, @@ -9581,9 +9667,9 @@ "peer": true }, "node_modules/vite-node/node_modules/vite": { - "version": "5.4.4", - "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.4.tgz", - "integrity": "sha512-RHFCkULitycHVTtelJ6jQLd+KSAAzOgEYorV32R2q++M6COBjKJR6BxqClwp5sf0XaBDjVMuJ9wnNfyAJwjMkA==", + "version": "5.4.8", + "resolved": "https://registry.npmjs.org/vite/-/vite-5.4.8.tgz", + "integrity": "sha512-FqrItQ4DT1NC4zCUqMB4c4AZORMKIa0m8/URVCZ77OZ/QSNeJ54bU1vrFADbDsuwfIPcgknRkmqakQcgnL4GiQ==", "dev": true, "license": "MIT", "dependencies": { @@ -9790,20 +9876,37 @@ } }, "node_modules/winston-transport": { - "version": "4.7.1", - "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.7.1.tgz", - "integrity": "sha512-wQCXXVgfv/wUPOfb2x0ruxzwkcZfxcktz6JIMUaPLmcNhO4bZTwA/WtDWK74xV3F2dKu8YadrFv0qhwYjVEwhA==", + "version": "4.8.0", + "resolved": "https://registry.npmjs.org/winston-transport/-/winston-transport-4.8.0.tgz", + "integrity": "sha512-qxSTKswC6llEMZKgCQdaWgDuMJQnhuvF5f2Nk3SNXc4byfQ+voo2mX1Px9dkNOuR8p0KAjfPG29PuYUSIb+vSA==", "dev": true, "license": "MIT", "dependencies": { "logform": "^2.6.1", - "readable-stream": "^3.6.2", + "readable-stream": "^4.5.2", "triple-beam": "^1.3.0" }, "engines": { "node": ">= 12.0.0" } }, + "node_modules/winston-transport/node_modules/readable-stream": { + "version": "4.5.2", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", + "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", + "dev": true, + "license": "MIT", + "dependencies": { + "abort-controller": "^3.0.0", + "buffer": "^6.0.3", + "events": "^3.3.0", + "process": "^0.11.10", + "string_decoder": "^1.3.0" + }, + "engines": { + "node": "^12.22.0 || ^14.17.0 || >=16.0.0" + } + }, "node_modules/winston/node_modules/@colors/colors": { "version": "1.6.0", "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.6.0.tgz", @@ -10093,9 +10196,9 @@ } }, "node_modules/zod-validation-error": { - "version": "3.3.1", - "resolved": "https://registry.npmjs.org/zod-validation-error/-/zod-validation-error-3.3.1.tgz", - "integrity": "sha512-uFzCZz7FQis256dqw4AhPQgD6f3pzNca/Zh62RNELavlumQB3nDIUFbF5JQfFLcMbO1s02Q7Xg/gpcOBlEnYZA==", + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/zod-validation-error/-/zod-validation-error-3.4.0.tgz", + "integrity": "sha512-ZOPR9SVY6Pb2qqO5XHt+MkkTRxGXb4EVtnjc9JpXUOtUB1T9Ru7mZOT361AN3MsetVe7R0a1KZshJDZdgp9miQ==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 2159e8f89683..2714200ab510 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", - "typescript": "~5.5.4" + "typescript": "~5.6.2" }, "engines": { "node": ">=18.0.0", From d92071355e45868bf36e45316aa83b199e69432a Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 15:14:00 -0700 Subject: [PATCH 023/101] [dependabot] Upgrade all packages under @azure-tools and @typespec scopes (#30817) --- .github/dependabot.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 2825b5913493..db134132a92a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,4 +5,9 @@ updates: schedule: interval: "daily" allow: - - dependency-name: "@azure-tools/typespec-client-generator-cli" + - dependency-name: "@azure-tools/*" + - dependency-name: "@typespec/*" + groups: + typespec: + patterns: + - "*" From 3b273b8566192ee0bd462f71dff7c4a4bb718e3f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 1 Oct 2024 15:58:25 -0700 Subject: [PATCH 024/101] Bump the typespec group with 2 updates (#30819) Bumps the typespec group with 2 updates: [@azure-tools/typespec-client-generator-core](https://github.com/Azure/typespec-azure) and [@typespec/compiler](https://github.com/microsoft/typespec). Updates `@azure-tools/typespec-client-generator-core` from 0.46.0 to 0.46.2 - [Release notes](https://github.com/Azure/typespec-azure/releases) - [Commits](https://github.com/Azure/typespec-azure/compare/typespec-azure@0.46.0...@azure-tools/typespec-client-generator-core@0.46.2) Updates `@typespec/compiler` from 0.60.0 to 0.60.1 - [Release notes](https://github.com/microsoft/typespec/releases) - [Commits](https://github.com/microsoft/typespec/compare/typespec@0.60.0...@typespec/compiler@0.60.1) --- updated-dependencies: - dependency-name: "@azure-tools/typespec-client-generator-core" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec - dependency-name: "@typespec/compiler" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 18 ++++++++---------- package.json | 4 ++-- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/package-lock.json b/package-lock.json index 91ee30a15277..28789aac7893 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,10 +13,10 @@ "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.0", + "@azure-tools/typespec-client-generator-core": "0.46.2", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.0", + "@typespec/compiler": "0.60.1", "@typespec/http": "0.60.0", "@typespec/openapi": "0.60.0", "@typespec/openapi3": "0.60.0", @@ -995,11 +995,10 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.0.tgz", - "integrity": "sha512-Ss0dNcOeTyc9CBsNFV6OToLV7OOKidAfeewmKePtY2qAHW+CqWZnVvUHunpFt2jFs6CqjFpgU9g+1wPbLCFj9A==", + "version": "0.46.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.2.tgz", + "integrity": "sha512-/HKeehCNDeylouOHMe7IwpcDcGJHRAuEy3a5FBnSY51m4EpMq4VMQzW9tka/8brFO2m5LLj7tyhOL/xnzi2fLg==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -3445,11 +3444,10 @@ } }, "node_modules/@typespec/compiler": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.0.tgz", - "integrity": "sha512-qAS99tJv6RvxSescfxRVal4QWSfdf3BzIOgE8+Az6emL68aTE/W8zQ0Ijpgmhax7sC2AnLTxCK1tM9kj1YguRw==", + "version": "0.60.1", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.1.tgz", + "integrity": "sha512-I6Vcpvd7mBP7SI5vCBh9rZGXAtVy95BKhAd33Enw32psswiSzRpA7zdyZhOMekTOGVXNS/+E5l2PGGCzQddB4w==", "dev": true, - "license": "MIT", "dependencies": { "@babel/code-frame": "~7.24.7", "ajv": "~8.17.1", diff --git a/package.json b/package.json index 2714200ab510..e9c2ab0f565d 100644 --- a/package.json +++ b/package.json @@ -8,10 +8,10 @@ "@azure-tools/typespec-azure-resource-manager": "0.46.1", "@azure-tools/typespec-azure-rulesets": "0.46.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.0", + "@azure-tools/typespec-client-generator-core": "0.46.2", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.0", + "@typespec/compiler": "0.60.1", "@typespec/http": "0.60.0", "@typespec/openapi": "0.60.0", "@typespec/openapi3": "0.60.0", From 482e8ac80343c22155665b8c8e3b43d8cbb3c39b Mon Sep 17 00:00:00 2001 From: Sandeep Prakash <sandep@microsoft.com> Date: Tue, 1 Oct 2024 17:11:47 -0700 Subject: [PATCH 025/101] Added support for NGroups operations (#30379) * Copy files from preview/2024-05-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-09-01-preview Updated the API version from preview/2024-05-01-preview to preview/2024-09-01-preview. * Added tag for 2024-09-01-preview in readme file * Added missing tags from the last release. * resource name pattern fix * match original? * updated delete response * try * common? * try to match * location header added and 200 removed from delete * more fixes * fix json * change camel case to be all lower in uri * missing type object errors * camel case fixes * fix paramaeter name to match case * Fixing XmsPageableForListCalls violation from containerInstance.json * removed post 204 response * removed 204 from post * fix some type obejct references * last camel case * vnet name with pattern * updated sku to get nextLink * fixed json * updated nextlink in paged response * Fixing OperationsApiResponseSchema violation from containerInstance.json * Fixing OperationsApiSchemaUsesCommonTypes violation from containerInstance.json * fixed lint errors * Fixing LroLocationHeader, LroErrorContent and MissingTypeObject violation from containerInstance.json * camel case last * attempt at some object type failures * capital g in resource group * wrap in tag * revert to only Ngroups initial change * readonly location in patch * readonly fix * revert path change and use common tracked resource schema * fix location resource and readonly * file not referenced * remove unreferenced property * npx make prettier * remove standby from update * added ngroups to cspell * npx prettier for all examples * Addressing PR feedback. * Baseline file from stable-2023-05-01 for reference. * Revert: Baseline file from stable-2023-05-01 for reference. * Fixing spell check and Lint error. * spellcheck fix * TrackedResource has a required field for location, which is not needed for PATCH operation. So reverted it. * spellcheck fix2 * nit * Location property in PAtch operation should be readOnly or immutable. * addressed comments * updated provisioningState * added headers in the PUT response * used common managedIdentity for nGroups * Revert "used common managedIdentity for nGroups" This reverts commit fb6a58fc010970930fece8a1690b19b9c54de27a. * added long-running-operation-options * updated long-running-operation-options * updated headers in response * fixed lint errors --------- Co-authored-by: John Richardson <jorichardson@microsoft.com> Co-authored-by: Shivam Gupta <shivg@microsoft.com> --- cSpell.json | 6 + .../2024-09-01-preview/containerInstance.json | 3195 +++++++++++++++++ .../examples/CachedImagesList.json | 27 + .../examples/CapabilitiesList.json | 39 + .../examples/ContainerAttach.json | 17 + .../examples/ContainerExec.json | 24 + .../ContainerGroupCreateConfidential.json | 182 + .../ContainerGroupEncryptionProperties.json | 192 + .../examples/ContainerGroupExtensions.json | 208 ++ .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 316 ++ .../ContainerGroupsCreatePriority.json | 120 + .../examples/ContainerGroupsDelete.json | 85 + .../examples/ContainerGroupsGetPriority.json | 87 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 79 + .../examples/ContainerGroupsList.json | 90 + .../ContainerGroupsListByResourceGroup.json | 82 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 16 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../examples/OperationsList.json | 23 + .../SubnetServiceAssociationLinkDelete.json | 18 + .../resource-manager/readme.md | 9 + 26 files changed, 5093 insertions(+) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json diff --git a/cSpell.json b/cSpell.json index e7aeb6374c29..3ee89cdd3c60 100644 --- a/cSpell.json +++ b/cSpell.json @@ -208,6 +208,12 @@ "Noreuse" ] }, + { + "filename": "**/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/**/containerInstance.json", + "words": [ + "ngroups" + ] + }, { "filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerService/aks/**/*json", "words": [ diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json new file mode 100644 index 000000000000..3c3cbf5216f6 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json @@ -0,0 +1,3195 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "ContainerInstanceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + }, + "ContainerGroupsGetWithPriority": { + "$ref": "./examples/ContainerGroupsGetPriority.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + }, + "ContainerGroupCreateWithExtensions": { + "$ref": "./examples/ContainerGroupExtensions.json" + }, + "ContainerGroupWithEncryptionProperties": { + "$ref": "./examples/ContainerGroupEncryptionProperties.json" + }, + "ConfidentialContainerGroup": { + "$ref": "./examples/ContainerGroupCreateConfidential.json" + }, + "ContainerGroupsCreateWithPriority": { + "$ref": "./examples/ContainerGroupsCreatePriority.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container group is starting." + }, + "204": { + "description": "Started - the container group is already running or starting." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer", + "format": "int32" + }, + { + "name": "timestamps", + "in": "query", + "description": "If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false.", + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach": { + "post": { + "operationId": "Containers_Attach", + "x-ms-examples": { + "ContainerAttach": { + "$ref": "./examples/ContainerAttach.json" + } + }, + "summary": "Attach to the output of a specific container instance.", + "description": "Attach to the output stream of a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAttachResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints": { + "get": { + "operationId": "ContainerGroups_GetOutboundNetworkDependenciesEndpoints", + "x-ms-examples": {}, + "summary": "Get all network dependencies for container group.", + "description": "Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkDependenciesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default": { + "delete": { + "operationId": "SubnetServiceAssociationLink_Delete", + "x-ms-examples": { + "SubnetServiceAssociationLinkDelete": { + "$ref": "./examples/SubnetServiceAssociationLinkDelete.json" + } + }, + "summary": "Delete container group virtual network association links.", + "description": "Delete container group virtual network association links. The operation does not delete other resources provided by the user.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkNameParameter" + }, + { + "$ref": "#/parameters/SubnetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/skus": { + "get": { + "operationId": "NGroupsSkus_Get", + "x-ms-examples": {}, + "summary": "Get the resource sku, resource type, and sku capacity of the n groups.", + "description": "Get the resource sku, resource type, and sku capacity of the n groups.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsSkusList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}": { + "get": { + "operationId": "NGroups_Get", + "x-ms-examples": {}, + "summary": "Display information about a specified nGroup.", + "description": "Get the properties of the specified n group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "NGroups_CreateOrUpdate", + "x-ms-examples": {}, + "description": "Create or update a nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "name": "nGroup", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NGroup" + }, + "description": "The nGroup object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/NGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "operationId": "NGroups_Update", + "x-ms-examples": {}, + "summary": "Update a specified nGroup.", + "description": "Update a specified nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NGroup" + }, + "description": "The nGroup object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "202": { + "description": "nGroup update started", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "NGroups_Delete", + "x-ms-examples": {}, + "summary": "Delete a nGroup.", + "description": "Deletes a nGroup.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/start": { + "post": { + "operationId": "NGroups_Start", + "x-ms-examples": {}, + "summary": "Starts all container groups in a nGroup.", + "description": "Starts all container groups in a nGroup. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "202": { + "description": "Started - the container groups are starting.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/stop": { + "post": { + "operationId": "NGroups_Stop", + "x-ms-examples": {}, + "summary": "Stops all container groups in a nGroup.", + "description": "Stops all container groups in a nGroup. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups/{ngroupsName}/restart": { + "post": { + "operationId": "NGroups_Restart", + "x-ms-examples": {}, + "summary": "Restarts all container groups in a nGroup.", + "description": "Restarts all container groups in a nGroup in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NGroupsNameParameter" + } + ], + "responses": { + "202": { + "description": "NoContent", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/ngroups": { + "get": { + "operationId": "NGroups_ListByResourceGroup", + "x-ms-examples": {}, + "summary": "Gets a list of all nGroups under a resource group.", + "description": "Gets a list of all nGroups under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/ngroups": { + "get": { + "operationId": "NGroups_List", + "x-ms-examples": {}, + "summary": "Gets a list of all nGroups under a subscription.", + "description": "Gets a list of all nGroups under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NGroupsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "SecurityContextDefinition": { + "description": "The security context for the container.", + "type": "object", + "properties": { + "privileged": { + "type": "boolean", + "description": "The flag to determine if the container permissions is elevated to Privileged." + }, + "allowPrivilegeEscalation": { + "type": "boolean", + "description": "A boolean value indicating whether the init process can elevate its privileges" + }, + "capabilities": { + "description": "The capabilities to add or drop from a container.", + "$ref": "#/definitions/SecurityContextCapabilitiesDefinition" + }, + "runAsGroup": { + "type": "integer", + "format": "int32", + "description": "Sets the User GID for the container." + }, + "runAsUser": { + "type": "integer", + "format": "int32", + "description": "Sets the User UID for the container." + }, + "seccompProfile": { + "type": "string", + "description": "a base64 encoded string containing the contents of the JSON in the seccomp profile" + } + } + }, + "SecurityContextCapabilitiesDefinition": { + "description": "The capabilities to add or drop from a container.", + "type": "object", + "properties": { + "add": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to add to the container." + }, + "drop": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The capabilities to drop from the container." + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + }, + "httpHeaders": { + "description": "The HTTP headers.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/ContainerGroupProperties" + } + ] + }, + "ContainerGroupProperties": { + "description": "The container group properties", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + }, + "x-ms-identifiers": [ + "username" + ] + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "subnetIds": { + "type": "array", + "description": "The subnet resource IDs for a container group.", + "items": { + "$ref": "#/definitions/ContainerGroupSubnetId" + } + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "extensions": { + "type": "array", + "description": "extensions used by virtual kubelet", + "items": { + "$ref": "#/definitions/DeploymentExtensionSpec" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "confidentialComputeProperties": { + "description": "The properties for confidential container group", + "$ref": "#/definitions/ConfidentialComputeProperties" + }, + "priority": { + "type": "string", + "description": "The priority of the container group.", + "enum": [ + "Regular", + "Spot" + ], + "x-ms-enum": { + "name": "ContainerGroupPriority", + "modelAsString": true + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + }, + "DeploymentExtensionSpec": { + "description": "Extension sidecars to be added to the deployment.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the extension." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Extension specific properties", + "properties": { + "extensionType": { + "type": "string", + "description": "Type of extension to be added." + }, + "version": { + "type": "string", + "description": "Version of the extension being used." + }, + "settings": { + "type": "object", + "description": "Settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings for the extension." + } + }, + "required": [ + "extensionType", + "version" + ] + } + }, + "required": [ + "name" + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group.", + "additionalProperties": { + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry.", + "x-ms-secret": true + }, + "identity": { + "type": "string", + "description": "The identity for the private registry." + }, + "identityUrl": { + "type": "string", + "description": "The identity URL for the private registry." + } + }, + "required": [ + "server" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string", + "x-ms-secret": true + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + }, + "workspaceResourceId": { + "description": "The workspace resource id for log analytics", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupSubnetId": { + "description": "Container group subnet information.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID of virtual network and subnet.", + "type": "string" + }, + "name": { + "description": "Friendly name for the subnet.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "autoGeneratedDomainNameLabelScope": { + "type": "string", + "description": "The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant.", + "enum": [ + "Unsecure", + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "Noreuse" + ], + "default": "Unsecure", + "x-ms-enum": { + "name": "dnsNameLabelReusePolicy", + "modelAsString": true + } + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable.", + "x-ms-secret": true + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the usage result" + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "format": "int32", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "format": "int32", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command.", + "x-ms-secret": true + } + } + }, + "ContainerAttachResponse": { + "description": "The information for the output stream from container attach.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the output stream from the attach." + }, + "password": { + "type": "string", + "description": "The password to the output stream from the attach. Send as an Authorization header value when connecting to the websocketUri.", + "x-ms-secret": true + } + } + }, + "HttpHeader": { + "description": "The HTTP header.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The header name." + }, + "value": { + "type": "string", + "description": "The header value." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "description": "The zones for the container group.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "x-ms-identifiers": [ + "image" + ], + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [ + "resourceType", + "location" + ], + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated", + "Confidential" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + }, + "identity": { + "type": "string", + "description": "The keyvault managed identity." + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + }, + "x-ms-identifiers": [ + "name", + "type" + ] + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "securityContext": { + "description": "The container security properties.", + "$ref": "#/definitions/SecurityContextDefinition" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "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", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + }, + "NetworkDependenciesResponse": { + "description": "Response for network dependencies, always empty list.", + "type": "array", + "items": { + "type": "string" + } + }, + "ConfidentialComputeProperties": { + "description": "The properties for confidential container group", + "type": "object", + "properties": { + "ccePolicy": { + "type": "string", + "description": "The base64 encoded confidential compute enforcement policy" + } + } + }, + "NGroupsSkusList": { + "description": "List of SKU definitions. NGroups offer a single sku", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NGroupSkus" + }, + "description": "The list of N Groups SKUs." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of N Groups SKUs." + } + } + }, + "NGroupSkus": { + "description": "The container probe, for liveness or readiness.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the sku is applied to." + }, + "sku": { + "type": "string", + "description": "The sku of the resource type" + }, + "skuCapacity": { + "type": "string", + "description": "The number of container groups of the nGroups." + } + } + }, + "NGroupsListResult": { + "description": "The nGroups list response that contains the nGroups properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NGroup" + }, + "description": "The list of N Groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of N Groups." + } + } + }, + "NGroup": { + "type": "object", + "properties": { + "systemData": { + "$ref": "../../../../../common-types/resource-management/v6/types.json#/definitions/systemData", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NGroupProperties" + }, + "identity": { + "$ref": "#/definitions/NGroupIdentity", + "description": "The identity of the nGroup, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The nGroups zones. NOTE: Availability zones can only be set when you create the scale set" + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a nGroup." + }, + "NGroupIdentity": { + "type": "object", + "description": "Identity for the nGroup.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the nGroup identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the nGroup. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the nGroup.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "additionalProperties": { + "type": "object", + "$ref": "../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/UserAssignedIdentity" + } + } + } + }, + "NGroupProperties": { + "type": "object", + "properties": { + "elasticProfile": { + "$ref": "#/definitions/ElasticProfile", + "description": "The elastic profile." + }, + "containerGroupProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroupProfileStub" + }, + "x-ms-identifiers": [], + "description": "The Container Group Profiles that could be used in a nGroup." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Updating", + "Failed", + "Succeeded", + "Canceled", + "Deleting", + "Migrating" + ], + "description": "The provisioning state, which only appears in the response.", + "x-ms-enum": { + "name": "NGroupProvisioningState", + "modelAsString": true + } + } + }, + "description": "Describes the properties of a Container Scale Set." + }, + "ElasticProfile": { + "type": "object", + "properties": { + "desiredCount": { + "type": "integer", + "format": "int32" + } + }, + "description": "Describes the elastic profile of the Container Scale Set" + }, + "ContainerGroupProfileStub": { + "type": "object", + "properties": { + "resource": { + "$ref": "#/definitions/ApiEntityReference" + } + }, + "description": "The object that contains a reference to a Container Group Profile" + }, + "ApiEntityReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "VirtualNetworkNameParameter": { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network.", + "x-ms-parameter-location": "method" + }, + "SubnetNameParameter": { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + }, + "NGroupsNameParameter": { + "name": "ngroupsName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "minLength": 1, + "maxLength": 63, + "description": "The N Groups name.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json new file mode 100644 index 000000000000..fefd8d0102c0 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json new file mode 100644 index 000000000000..779de5c4f0fc --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json new file mode 100644 index 000000000000..edac356d1e7a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerAttach.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1" + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json new file mode 100644 index 000000000000..88bffeeadafe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json new file mode 100644 index 000000000000..687fb2f7af50 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupCreateConfidential.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "westeurope", + "properties": { + "containers": [ + { + "name": "accdemo", + "properties": { + "command": [], + "environmentVariables": [], + "image": "confiimage", + "ports": [ + { + "port": 8000 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "osType": "Linux", + "sku": "Confidential", + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + }, + "201": { + "body": { + "properties": { + "sku": "Confidential", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "accdemo", + "properties": { + "image": "confiimage", + "command": [], + "ports": [ + { + "port": 8000 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + }, + "securityContext": { + "privileged": false, + "capabilities": { + "add": [ + "CAP_NET_ADMIN" + ] + } + } + } + } + ], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 8000 + } + ], + "type": "Public" + }, + "initContainers": [], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "confidentialComputeProperties": { + "ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "westeurope" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json new file mode 100644 index 000000000000..d0539125776a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupEncryptionProperties.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "<key version>", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "encryptionProperties": { + "vaultBaseUrl": "https://testkeyvault.vault.azure.net/", + "keyName": "test-key", + "keyVersion": "key version", + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity" + }, + "provisioningState": "Running", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public" + }, + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + } + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": { + "principalId": "<principal id>", + "clientId": "<client id>" + } + }, + "tenantId": "<tenant id>", + "type": "UserAssigned" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json new file mode 100644 index 000000000000..b24127918d4a --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupExtensions.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "eastus2", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + } + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Private" + }, + "osType": "Linux", + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + }, + "protectedSettings": { + "kubeConfig": "<kubeconfig encoded string>" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Pending" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Pending", + "containers": [ + { + "name": "demo1", + "properties": { + "image": "nginx", + "command": [], + "ports": [ + { + "port": 80 + } + ], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1.5, + "cpu": 1.0 + } + } + } + } + ], + "initContainers": [], + "extensions": [ + { + "name": "kube-proxy", + "properties": { + "extensionType": "kube-proxy", + "version": "1.0", + "settings": { + "clusterCidr": "10.240.0.0/16", + "kubeVersion": "v1.9.10" + } + } + }, + { + "name": "vk-realtime-metrics", + "properties": { + "extensionType": "realtime-metrics", + "version": "1.0" + } + } + ], + "imageRegistryCredentials": [], + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Running" + }, + "subnetIds": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet" + } + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus2" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..60bca4b4c9a6 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..9324b0919049 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,316 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "zones": [ + "1" + ], + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + }, + "workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace" + } + }, + "subnetIds": [ + { + "id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]" + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "autoGeneratedDomainNameLabelScope": "Unsecure", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json new file mode 100644 index 000000000000..87429dd0c245 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsCreatePriority.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "properties": { + "sku": "Standard", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "restartPolicy": "Never", + "osType": "Linux", + "priority": "Spot" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + }, + "201": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Created", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Created" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..e98e2da7886b --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsDelete.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json new file mode 100644 index 000000000000..4c73b3b469ae --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGetPriority.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "sku": "Standard", + "provisioningState": "Succeeded", + "containers": [ + { + "name": "test-container-001", + "properties": { + "image": "alpine:latest", + "command": [ + "/bin/sh", + "-c", + "sleep 10" + ], + "ports": [], + "environmentVariables": [], + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Terminated", + "startTime": "2022-11-11T19:33:44.217Z", + "exitCode": 0, + "finishTime": "2022-11-11T19:33:55.565Z", + "detailStatus": "Completed" + }, + "events": [ + { + "count": 2, + "firstTimestamp": "2022-11-11T19:28:22Z", + "lastTimestamp": "2022-11-11T19:32:09Z", + "name": "Pulling", + "message": "pulling image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 2, + "firstTimestamp": "2022-11-11T19:32:08Z", + "lastTimestamp": "2022-11-11T19:32:38Z", + "name": "Pulled", + "message": "Successfully pulled image \"alpine@sha256:1304f174557314a7ed9eddb4eab12fed12cb0cd9809e4c28f29af86979a3c870\"", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2022-11-11T19:33:44Z", + "lastTimestamp": "2022-11-11T19:33:44Z", + "name": "Started", + "message": "Started container", + "type": "Normal" + } + ] + }, + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + } + ], + "initContainers": [], + "restartPolicy": "Never", + "osType": "Linux", + "instanceView": { + "events": [], + "state": "Succeeded" + }, + "priority": "Spot" + }, + "id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "location": "eastus" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..7c2a1087e3a5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..dfaaba943d59 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..8636a3c35539 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsList.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..f768479644b9 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "zones": [ + "1" + ], + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..be2f897f0bf7 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..9e99a1dcea31 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStart.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..be2f897f0bf7 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..62bef19fc5c5 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json new file mode 100644 index 000000000000..45d8b1fb34fe --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..38cf7b181a1f --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json new file mode 100644 index 000000000000..fa165c2e8bc3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2024-09-01-preview/examples/SubnetServiceAssociationLinkDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2024-09-01-preview", + "resourceGroupName": "demo", + "virtualNetworkName": "demo2", + "subnetName": "demo3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/locations/location/operations/operationId?api-version=apiVersion" + } + }, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 37a58d82b8e1..e875793a7d4f 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -38,6 +38,15 @@ input-file: - Microsoft.ContainerInstance/preview/2024-10-01-preview/containerInstance.json ``` +### Tag: package-preview-2024-09 + +These settings apply only when `--tag=package-preview-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-09' +input-file: + - Microsoft.ContainerInstance/preview/2024-09-01-preview/containerInstance.json +``` + ### Tag: package-preview-2024-05 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. From bd27eca9d220ba4b53921207f51f1fe706ff08f2 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:06:14 -0700 Subject: [PATCH 026/101] [ProtectedFiles] Always allow changes from bot account 'azure-sdk' (#30826) --- .github/workflows/protected-files.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index eaba06462474..1811f69a93d8 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -6,6 +6,9 @@ jobs: protected-files: name: Protected Files + # Always allow bot account 'azure-sdk' to update protected files + if: ${{ github.event.pull_request.user.login != 'azure-sdk' }} + runs-on: ubuntu-latest steps: From cd206d59ba30286418cd60eb2f95baacc70a1ea7 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:19:45 -0700 Subject: [PATCH 027/101] [ProtectedFiles] Skip steps instead of job (#30827) - Check is required --- .github/workflows/protected-files.yaml | 52 +++++++++++++------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 1811f69a93d8..84a962a9726d 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -6,32 +6,34 @@ jobs: protected-files: name: Protected Files - # Always allow bot account 'azure-sdk' to update protected files - if: ${{ github.event.pull_request.user.login != 'azure-sdk' }} - runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - with: - # Required since "HEAD^" is passed to Get-ChangedFiles - fetch-depth: 2 - - - name: Detect changes to protected files - run: | - . eng/scripts/ChangedFiles-Functions.ps1 - - $protectedFiles = @("package.json", "package-lock.json") - $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") - $matchedFiles = @($protectedFiles | Where-Object { $changedFiles -contains $_}) - - if ($matchedFiles.Count -gt 0) { - foreach ($file in $matchedFiles) { - Write-Output "::error file=$file::File '$file' should only be updated by the Azure SDK team. If intentional, the PR may be merged by the Azure SDK team via bypassing the branch protections." + # Always allow bot account 'azure-sdk' to update protected files. + # Since check is required, the job itself cannot be skipped, but all steps can. + + - uses: actions/checkout@v4 + if: github.event.pull_request.user.login != 'azure-sdk' + with: + # Required since "HEAD^" is passed to Get-ChangedFiles + fetch-depth: 2 + + - name: Detect changes to protected files + if: github.event.pull_request.user.login != 'azure-sdk' + run: | + . eng/scripts/ChangedFiles-Functions.ps1 + + $protectedFiles = @("package.json", "package-lock.json") + $changedFiles = @(Get-ChangedFiles -baseCommitish HEAD^ -targetCommitish HEAD -diffFilter "") + $matchedFiles = @($protectedFiles | Where-Object { $changedFiles -contains $_}) + + if ($matchedFiles.Count -gt 0) { + foreach ($file in $matchedFiles) { + Write-Output "::error file=$file::File '$file' should only be updated by the Azure SDK team. If intentional, the PR may be merged by the Azure SDK team via bypassing the branch protections." + } + exit 1 + } + else { + Write-Output "No changes to protected files: [$($protectedFiles -join ', ')]" } - exit 1 - } - else { - Write-Output "No changes to protected files: [$($protectedFiles -join ', ')]" - } - shell: pwsh + shell: pwsh From dcceabad7ae50b3faecf1dee49339d639cd11a2c Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Tue, 1 Oct 2024 18:36:49 -0700 Subject: [PATCH 028/101] [ProtectedFiles] Log message for user 'azure-sdk' (#30828) --- .github/workflows/protected-files.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 84a962a9726d..37e7ae730f06 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -9,8 +9,11 @@ jobs: runs-on: ubuntu-latest steps: - # Always allow bot account 'azure-sdk' to update protected files. - # Since check is required, the job itself cannot be skipped, but all steps can. + # Allow bot account 'azure-sdk' to update protected files. + # Since check is required, the job itself cannot be skipped. + - name: Allow bot account 'azure-sdk' + if: github.event.pull_request.user.login == 'azure-sdk' + run: echo "Bot account 'azure-sdk' is allowed to update protected files" - uses: actions/checkout@v4 if: github.event.pull_request.user.login != 'azure-sdk' From 6286ea80b3ac7eecfc2f230d65b2034a656f10bf Mon Sep 17 00:00:00 2001 From: jovancevic123 <62032416+jovancevic123@users.noreply.github.com> Date: Wed, 2 Oct 2024 08:34:15 +0200 Subject: [PATCH 029/101] Changing the version of DistributedAvailabilityGroups API for Azure CLI development (#30079) * Chaning the version of DistributedAvailabilityGroups in package-composite-v5 tag section. * Moving new version of DAG to the bottom of v5 section. --------- Co-authored-by: jovancevic123 <jojovancevic@microsoft.com> --- specification/sql/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index ba724c774b9f..3e2716d8224f 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -1543,7 +1543,6 @@ input-file: - ./Microsoft.Sql/preview/2021-05-01-preview/LongTermRetentionManagedInstanceBackups.json - ./Microsoft.Sql/preview/2021-05-01-preview/RestorableDroppedManagedDatabases.json - ./Microsoft.Sql/preview/2021-05-01-preview/ServerConnectionPolicies.json -- ./Microsoft.Sql/preview/2021-11-01-preview/DistributedAvailabilityGroups.json - ./Microsoft.Sql/preview/2021-11-01-preview/ServerTrustCertificates.json - ./Microsoft.Sql/preview/2021-11-01-preview/EndpointCertificates.json - ./Microsoft.Sql/preview/2020-11-01-preview/ManagedDatabaseSensitivityLabels.json @@ -1592,6 +1591,7 @@ input-file: - ./Microsoft.Sql/preview/2023-05-01-preview/ManagedInstances.json - ./Microsoft.Sql/preview/2023-05-01-preview/Servers.json - ./Microsoft.Sql/preview/2023-05-01-preview/ReplicationLinks.json +- ./Microsoft.Sql/preview/2023-08-01-preview/DistributedAvailabilityGroups.json # Needed when there is more than one input file override-info: From a9183ee333c9a2ef163fc90e4116d72771401e16 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Wed, 2 Oct 2024 10:40:21 -0700 Subject: [PATCH 030/101] Use 1ES pool for Ubuntu images (#30822) --- .azure-pipelines/azure-pipelines-data-container.yml | 1 + azure-pipelines.yml | 1 + 2 files changed, 2 insertions(+) diff --git a/.azure-pipelines/azure-pipelines-data-container.yml b/.azure-pipelines/azure-pipelines-data-container.yml index 4617ad2fed07..d506d873153e 100644 --- a/.azure-pipelines/azure-pipelines-data-container.yml +++ b/.azure-pipelines/azure-pipelines-data-container.yml @@ -7,6 +7,7 @@ schedules: always: true pool: + name: azsdk-pool-mms-ubuntu-2204-general vmImage: 'Ubuntu-22.04' variables: diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 3bbdde1f7b21..d14435e27ff2 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,6 +1,7 @@ name: "Azure OpenAPI" pool: + name: azsdk-pool-mms-ubuntu-2004-general vmImage: 'Ubuntu-20.04' trigger: From 94ae2a78fb19fe69b48dec5afb6a61be54ff2810 Mon Sep 17 00:00:00 2001 From: YunsongB <39966392+YunsongB@users.noreply.github.com> Date: Wed, 2 Oct 2024 13:19:11 -0600 Subject: [PATCH 031/101] Add AOAI 2024-09-01-preview API version (#30821) * Add AOAI 2024-09-01-preview API version * Add changes; * Fix inference json and yml errors; * Fix prettierCheck; * Fix prettierCheck; * Fix spell check; --------- Co-authored-by: Yunsong Bai <yunba@microsoft.com> --- cSpell.json | 10 +- .../2024-09-01-preview/azureopenai.json | 3853 +++++ .../2024-09-01-preview/azureopenai.yaml | 2569 ++++ .../examples/cancel_batch.json | 41 + .../examples/cancel_batch.yaml | 33 + .../examples/cancel_finetuning_job.json | 37 + .../examples/cancel_finetuning_job.yaml | 34 + .../examples/delete_file.json | 13 + .../examples/delete_file.yaml | 9 + .../examples/delete_finetuning_job.json | 13 + .../examples/delete_finetuning_job.yaml | 9 + .../examples/get_batch.json | 41 + .../examples/get_batch.yaml | 33 + .../examples/get_batches.json | 48 + .../examples/get_batches.yaml | 37 + .../2024-09-01-preview/examples/get_file.json | 21 + .../2024-09-01-preview/examples/get_file.yaml | 16 + .../examples/get_file_content.json | 14 + .../examples/get_file_content.yaml | 9 + .../examples/get_files.json | 33 + .../examples/get_files.yaml | 24 + .../examples/get_finetuning_job.json | 42 + .../examples/get_finetuning_job.yaml | 36 + .../get_finetuning_job_checkpoints.json | 70 + .../get_finetuning_job_checkpoints.yaml | 54 + .../examples/get_finetuning_job_events.json | 43 + .../examples/get_finetuning_job_events.yaml | 33 + .../examples/get_finetuning_jobs.json | 47 + .../examples/get_finetuning_jobs.yaml | 38 + .../examples/get_ingestion_job.json | 27 + .../examples/get_ingestion_job.yaml | 21 + .../examples/get_ingestion_job_run.json | 30 + .../examples/get_ingestion_job_run.yaml | 18 + .../examples/get_model_base.json | 31 + .../examples/get_model_base.yaml | 25 + .../examples/get_model_finetune.json | 32 + .../examples/get_model_finetune.yaml | 24 + .../examples/get_models.json | 54 + .../examples/get_models.yaml | 41 + .../examples/import_file.json | 27 + .../examples/import_file.yaml | 47 + .../examples/list_ingestion_job_runs.json | 29 + .../examples/list_ingestion_job_runs.yaml | 16 + .../examples/list_ingestion_jobs.json | 22 + .../examples/list_ingestion_jobs.yaml | 12 + .../examples/post_batch.json | 49 + .../examples/post_batch.yaml | 39 + .../examples/post_finetuning_job.json | 54 + .../examples/post_finetuning_job.yaml | 51 + .../examples/put_ingestion_job_sc.json | 72 + .../examples/put_ingestion_job_sc.yaml | 51 + .../examples/put_ingestion_job_uc.json | 46 + .../examples/put_ingestion_job_uc.yaml | 39 + .../examples/upload_file.json | 24 + .../examples/upload_file.yaml | 19 + .../examples/upload_file_cancel.json | 31 + .../examples/upload_file_cancel.yaml | 25 + .../examples/upload_file_complete.json | 37 + .../examples/upload_file_complete.yaml | 30 + .../examples/upload_file_part.json | 22 + .../examples/upload_file_part.yaml | 16 + .../examples/upload_file_start.json | 38 + .../examples/upload_file_start.yaml | 30 + .../AzureOpenAI/authoring/readme.md | 41 + .../examples/audio_speech.json | 18 + .../examples/audio_speech.yaml | 12 + .../examples/audio_transcription_object.json | 15 + .../examples/audio_transcription_object.yaml | 9 + .../examples/audio_transcription_text.json | 15 + .../examples/audio_transcription_text.yaml | 19 + .../examples/audio_translation_object.json | 16 + .../examples/audio_translation_object.yaml | 21 + .../examples/audio_translation_text.json | 15 + .../examples/audio_translation_text.yaml | 21 + .../examples/cancel_run.json | 46 + .../examples/cancel_run.yaml | 35 + .../cancel_vector_store_file_batch.json | 27 + .../cancel_vector_store_file_batch.yaml | 20 + .../examples/chat_completions.json | 43 + .../examples/chat_completions.yaml | 45 + ...hat_completions_azure_search_advanced.json | 96 + ...hat_completions_azure_search_advanced.yaml | 63 + ...completions_azure_search_image_vector.json | 58 + ...completions_azure_search_image_vector.yaml | 36 + ...chat_completions_azure_search_minimum.json | 63 + ...chat_completions_azure_search_minimum.yaml | 39 + .../examples/chat_completions_cosmos_db.json | 77 + .../examples/chat_completions_cosmos_db.yaml | 49 + .../chat_completions_elasticsearch.json | 65 + .../chat_completions_elasticsearch.yaml | 41 + .../examples/chat_completions_mongo_db.json | 80 + .../examples/chat_completions_mongo_db.yaml | 52 + .../examples/chat_completions_pinecone.json | 77 + .../examples/chat_completions_pinecone.yaml | 51 + .../examples/completions.json | 38 + .../examples/create_assistant.json | 39 + .../examples/create_assistant.yaml | 26 + .../examples/create_message.json | 36 + .../examples/create_message.yaml | 25 + .../examples/create_run.json | 49 + .../examples/create_run.yaml | 38 + .../examples/create_thread.json | 17 + .../examples/create_thread.yaml | 11 + .../examples/create_thread_and_run.json | 54 + .../examples/create_thread_and_run.yaml | 42 + .../examples/create_vector_store.json | 28 + .../examples/create_vector_store.yaml | 20 + .../examples/create_vector_store_file.json | 24 + .../examples/create_vector_store_file.yaml | 17 + .../create_vector_store_file_batch.json | 30 + .../create_vector_store_file_batch.yaml | 22 + .../examples/delete_assistant.json | 17 + .../examples/delete_assistant.yaml | 11 + .../examples/delete_assistant_file.json | 18 + .../examples/delete_assistant_file.yaml | 12 + .../examples/delete_message.json | 18 + .../examples/delete_message.yaml | 12 + .../examples/delete_thread.json | 17 + .../examples/delete_thread.yaml | 11 + .../examples/delete_vector_store.json | 17 + .../examples/delete_vector_store.yaml | 11 + .../examples/delete_vector_store_file.json | 18 + .../examples/delete_vector_store_file.yaml | 12 + .../examples/embeddings.json | 1566 ++ .../examples/embeddings.yaml | 1553 ++ .../examples/generated_audio_speech.json | 19 + .../generated_audio_transcription_object.json | 17 + .../generated_audio_transcription_text.json | 16 + .../generated_audio_translation_object.json | 17 + .../generated_audio_translation_text.json | 16 + .../examples/generated_chat_completions.json | 45 + .../examples/generated_completions.json | 38 + .../examples/generated_embeddings.json | 1567 ++ ...extensions_chat_completions_aml_index.json | 62 + ...hat_completions_azure_search_advanced.json | 86 + ...completions_azure_search_image_vector.json | 67 + ...chat_completions_azure_search_minimum.json | 61 + ...extensions_chat_completions_cosmos_db.json | 78 + ...nsions_chat_completions_elasticsearch.json | 66 + ..._extensions_chat_completions_pinecone.json | 78 + .../examples/generated_image_generation.json | 31 + .../examples/get_assistant_file.json | 19 + .../examples/get_assistant_file.yaml | 13 + .../examples/get_message.json | 33 + .../examples/get_message.yaml | 23 + .../examples/get_message_file.json | 20 + .../examples/get_message_file.yaml | 14 + .../2024-09-01-preview/examples/get_run.json | 32 + .../2024-09-01-preview/examples/get_run.yaml | 26 + .../examples/get_run_step.json | 40 + .../examples/get_run_step.yaml | 31 + .../examples/image_generation.json | 71 + .../examples/image_generation.yaml | 49 + .../examples/list_assistant_files.json | 26 + .../examples/list_assistant_files.yaml | 17 + .../examples/list_assistants.json | 70 + .../examples/list_assistants.yaml | 54 + .../examples/list_message_files.json | 33 + .../examples/list_message_files.yaml | 22 + .../examples/list_messages.json | 60 + .../examples/list_messages.yaml | 41 + .../examples/list_run_steps.json | 47 + .../examples/list_run_steps.yaml | 35 + .../examples/list_runs.json | 112 + .../examples/list_runs.yaml | 85 + .../list_vector_store_file_batch.json | 33 + .../list_vector_store_file_batch.yaml | 22 + .../examples/list_vector_store_files.json | 32 + .../examples/list_vector_store_files.yaml | 21 + .../examples/list_vector_stores.json | 47 + .../examples/list_vector_stores.yaml | 51 + .../examples/modify_assistant.json | 44 + .../examples/modify_assistant.yaml | 29 + .../examples/modify_message.json | 42 + .../examples/modify_message.yaml | 29 + .../examples/modify_run.json | 66 + .../examples/modify_run.yaml | 55 + .../examples/modify_thread.json | 28 + .../examples/modify_thread.yaml | 19 + .../examples/modify_vector_store.json | 29 + .../examples/modify_vector_store.yaml | 21 + .../examples/retrieve_assistant.json | 30 + .../examples/retrieve_assistant.yaml | 21 + .../examples/retrieve_message.json | 33 + .../examples/retrieve_message.yaml | 23 + .../examples/retrieve_run.json | 51 + .../examples/retrieve_run.yaml | 40 + .../examples/retrieve_run_step.json | 40 + .../examples/retrieve_run_step.yaml | 31 + .../examples/retrieve_thread.json | 23 + .../examples/retrieve_thread.yaml | 15 + .../examples/retrieve_vector_store.json | 17 + .../examples/retrieve_vector_store.yaml | 11 + .../examples/retrieve_vector_store_file.json | 21 + .../examples/retrieve_vector_store_file.yaml | 15 + .../retrieve_vector_store_file_batch.json | 27 + .../retrieve_vector_store_file_batch.yaml | 20 + .../examples/submit_tool_outputs_to_run.json | 77 + .../examples/submit_tool_outputs_to_run.yaml | 57 + .../preview/2024-09-01-preview/inference.json | 12043 ++++++++++++++++ .../preview/2024-09-01-preview/inference.yaml | 8336 +++++++++++ .../AzureOpenAI/inference/readme.md | 15 + 202 files changed, 38212 insertions(+), 2 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml diff --git a/cSpell.json b/cSpell.json index 3ee89cdd3c60..12154bc72508 100644 --- a/cSpell.json +++ b/cSpell.json @@ -52,7 +52,7 @@ "words": [ "azurearcdata" ] - }, + }, { "filename": "**/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/**/*.json", "words": [ @@ -61,7 +61,7 @@ "SSIS", "PBIRS" ] - }, + }, { "filename": "**/specification/batch/**/*.json", "words": [ @@ -1402,6 +1402,12 @@ "rerank" ] }, + { + "filename": "**/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/**/*.json", + "words": [ + "wandb" + ] + }, { "filename": "**/specification/communication/data-plane/CallAutomation/**/*.json", "words": [ diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json new file mode 100644 index 000000000000..6719b00175c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.json @@ -0,0 +1,3853 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2024-09-01-preview", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2024-09-01-preview" + }, + "paths": { + "/batches": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets a list of all batches owned by the Azure OpenAI resource.", + "operationId": "Batch_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of batches to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BatchesList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all batches owned by this account.": { + "$ref": "./examples/get_batches.json" + } + } + }, + "post": { + "tags": [ + "Batch:" + ], + "summary": "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete.", + "operationId": "Batch_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "createBatchRequest", + "description": "The specification of the batch to create and execute.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCreateRequest" + } + } + ], + "responses": { + "201": { + "description": "The batch has been successfully created.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a batch.": { + "$ref": "./examples/post_batch.json" + } + } + } + }, + "/batches/{batch-id}": { + "get": { + "tags": [ + "Batch:" + ], + "summary": "Gets details for a single batch specified by the given batch-id.", + "operationId": "Batch_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a batch.": { + "$ref": "./examples/get_batch.json" + } + } + } + }, + "/batches/{batch-id}/cancel": { + "post": { + "tags": [ + "Batch:" + ], + "summary": "Cancels the processing of the batch specified by the given batch-id.", + "operationId": "Batch_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "batch-id", + "description": "The identifier of the batch.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The batch has been successfully canceled.", + "schema": { + "$ref": "#/definitions/Batch" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a batch.": { + "$ref": "./examples/cancel_batch.json" + } + } + } + }, + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "purpose", + "description": "Only return files with the given purpose.", + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The file was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/fine_tuning/jobs": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tuning jobs owned by this account.": { + "$ref": "./examples/get_finetuning_jobs.json" + } + } + }, + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTuning_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTuningJob", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuningJobCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTuningJob" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tuning job.": { + "$ref": "./examples/post_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tuning job.": { + "$ref": "./examples/get_finetuning_job.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tuning job.": { + "$ref": "./examples/delete_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/cancel": { + "post": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTuning_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tuning job.": { + "$ref": "./examples/cancel_finetuning_job.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training.", + "operationId": "FineTuning_GetCheckpoints", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last checkpoint ID from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of checkpoints to retrieve. Defaults to 10.", + "type": "integer", + "format": "int32", + "default": 10 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobCheckpointList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting checkpoints of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_checkpoints.json" + } + } + } + }, + "/fine_tuning/jobs/{fine-tuning-job-id}/events": { + "get": { + "tags": [ + "Fine-tuning:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTuning_GetEvents", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tuning-job-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "after", + "description": "Identifier for the last event from the previous pagination request.", + "type": "string" + }, + { + "in": "query", + "name": "limit", + "description": "Number of events to retrieve. Defaults to 20.", + "type": "integer", + "format": "int32", + "default": 20 + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuningJobEventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tuning job.": { + "$ref": "./examples/get_finetuning_job_events.json" + } + } + } + }, + "/ingestion/jobs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the ingestion jobs.", + "operationId": "IngestionJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all ingestion jobs": { + "$ref": "./examples/list_ingestion_jobs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}": { + "put": { + "tags": [ + "Ingestion:" + ], + "summary": "Creates an ingestion job with the specified job id.", + "operationId": "IngestionJobs_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "type": "string", + "description": "The id of the job that will be created." + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + }, + { + "in": "header", + "name": "aml-user-token", + "type": "string", + "description": "The token used to access the resources within the job in the workspace (needed only for user compute jobs)." + }, + { + "in": "body", + "name": "ingestionJob", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create a system-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_sc.json" + }, + "Create a user-compute ingestion job": { + "$ref": "./examples/put_ingestion_job_uc.json" + } + } + }, + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified job id.", + "operationId": "IngestionJobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJob" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job": { + "$ref": "./examples/get_ingestion_job.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Lists the runs of the specified job id.", + "operationId": "IngestionJobRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRunList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ingestion job runs": { + "$ref": "./examples/list_ingestion_job_runs.json" + } + } + } + }, + "/ingestion/jobs/{job-id}/runs/{run-id}": { + "get": { + "tags": [ + "Ingestion:" + ], + "summary": "Gets the details of the specified run id as part of the specified job id.", + "operationId": "IngestionJobRuns_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "path", + "name": "job-id", + "required": true, + "description": "The id of the job.", + "type": "string" + }, + { + "in": "path", + "name": "run-id", + "required": true, + "description": "The id of the run.", + "type": "string" + }, + { + "in": "header", + "name": "mgmt-user-token", + "type": "string", + "description": "The token used to access the workspace (needed only for user compute jobs)." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IngestionJobRun" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ingestion job runs": { + "$ref": "./examples/get_ingestion_job_run.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + }, + "/uploads": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file.", + "operationId": "UploadFile_Start", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileStartBody" + } + } + ], + "responses": { + "200": { + "description": "The upload has been successfully created.", + "schema": { + "$ref": "#/definitions/UploadResource" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a large file upload operation.": { + "$ref": "./examples/upload_file_start.json" + } + } + } + }, + "/uploads/{upload-id}/cancel": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled.", + "operationId": "UploadFile_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a large file upload operation.": { + "$ref": "./examples/upload_file_cancel.json" + } + } + } + }, + "/uploads/{upload-id}/complete": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed.", + "operationId": "UploadFile_Complete", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "requestBody", + "description": "The definition of the file to create including its purpose and the location on the local machine.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadFileCompleteBody" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Complete and validate a large file upload operation.": { + "$ref": "./examples/upload_file_complete.json" + } + } + } + }, + "/uploads/{upload-id}/parts": { + "post": { + "tags": [ + "UploadFile:" + ], + "summary": "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB.", + "operationId": "UploadFile_Part", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "upload-id", + "description": "The identifier of the upload.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "data", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UploadPartResource" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a part of large file upload operation.": { + "$ref": "./examples/upload_file_part.json" + } + } + } + } + }, + "definitions": { + "AzureAISearchIndex": { + "description": "Azure AI Search Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the Azure AI Search Index." + } + } + } + ], + "x-ms-discriminator-value": "AzureAISearch" + }, + "BaseConnection": { + "title": "BaseConnection", + "description": "A connection to a resource.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ConnectionType" + } + }, + "discriminator": "kind" + }, + "Batch": { + "title": "Batch", + "description": "Defines the values of a batch.", + "required": [ + "id", + "input_file_id" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string" + }, + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string", + "readOnly": true + }, + "errors": { + "$ref": "#/definitions/BatchErrors" + }, + "input_file_id": { + "description": "The ID of the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/BatchStatus" + }, + "output_file_id": { + "description": "The ID of the file containing outputs of successfully executed requests.", + "type": "string" + }, + "error_file_id": { + "description": "The ID of the file containing outputs of requests with errors.", + "type": "string" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this batch was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "in_progress_at": { + "format": "unixtime", + "description": "A timestamp when this batch started progressing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expires_at": { + "format": "unixtime", + "description": "A timestamp when this batch will expire (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "finalizing_at": { + "format": "unixtime", + "description": "A timestamp when this batch started finalizing (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "completed_at": { + "format": "unixtime", + "description": "A timestamp when this batch was completed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "failed_at": { + "format": "unixtime", + "description": "A timestamp when this batch failed (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "expired_at": { + "format": "unixtime", + "description": "A timestamp when this batch expired (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelling_at": { + "format": "unixtime", + "description": "A timestamp when this batch started cancelling (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "cancelled_at": { + "format": "unixtime", + "description": "A timestamp when this batch was cancelled (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "request_counts": { + "$ref": "#/definitions/BatchRequestCounts" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchCreateRequest": { + "title": "BatchCreateRequest", + "description": "Defines the request to create a batch.", + "required": [ + "input_file_id", + "endpoint", + "completion_window" + ], + "type": "object", + "properties": { + "input_file_id": { + "description": "The ID if the input file for the batch.", + "minLength": 1, + "type": "string" + }, + "endpoint": { + "description": "The API endpoint used by the batch.", + "type": "string" + }, + "completion_window": { + "description": "The time frame within which the batch should be processed.", + "type": "string" + }, + "metadata": { + "description": "A set of key-value pairs that can be attached to the batch. This can be useful for storing additional information about the batch in a structured format.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "BatchErrorData": { + "title": "BatchErrorData", + "description": "Error information for a failure in batch.", + "type": "object", + "properties": { + "code": { + "description": "An error code identifying the error type.", + "type": "string" + }, + "message": { + "description": "A human-readable message providing more details about the error.", + "type": "string" + }, + "param": { + "description": "The name of the parameter that caused the error, if applicable (can be null).", + "type": "string" + }, + "line": { + "description": "The line number of the input file where the error occurred, if applicable (can be null).", + "type": "string" + } + } + }, + "BatchErrors": { + "title": "BatchErrors", + "description": "For batches that have failed, this will contain more information on the cause of the failures.", + "type": "object", + "properties": { + "object": { + "description": "The type of the errors object. This is always 'list'.", + "type": "string" + }, + "data": { + "$ref": "#/definitions/BatchErrorData" + } + } + }, + "BatchRequestCounts": { + "title": "BatchRequestCounts", + "description": "The request counts for different statuses within the batch.", + "type": "object", + "properties": { + "total": { + "description": "The total number of requests in the batch.", + "type": "integer" + }, + "completed": { + "description": "The number of requests in the batch that have been completed successfully.", + "type": "integer" + }, + "failed": { + "description": "The number of requests in the batch that have failed.", + "type": "integer" + } + } + }, + "BatchStatus": { + "title": "BatchStatus", + "description": "The status of a batch.", + "enum": [ + "validating", + "failed", + "in_progress", + "finalizing", + "completed", + "expired", + "cancelling", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BatchStatus", + "modelAsString": true, + "values": [ + { + "value": "validating", + "description": "The input file is being validated before the batch can begin." + }, + { + "value": "failed", + "description": "The input file has failed the validation process." + }, + { + "value": "in_progress", + "description": "The input file was successfully validated and the batch is currently being executed." + }, + { + "value": "finalizing", + "description": "The batch has completed and the results are being prepared." + }, + { + "value": "completed", + "description": "The batch has been completed and the results are ready." + }, + { + "value": "expired", + "description": "The batch was not able to complete within the 24-hour time window." + }, + { + "value": "cancelling", + "description": "Cancellation of the batch has been initiated." + }, + { + "value": "cancelled", + "description": "The batch was cancelled." + } + ] + } + }, + "BatchesList": { + "title": "BatchList", + "description": "Represents a list of batches.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Batch" + } + }, + "first_id": { + "description": "The id of the first batch in the list of batches returned.", + "type": "string" + }, + "last_id": { + "description": "The id of the last batch in the list of batches returned.", + "type": "string" + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "ChunkingSettings": { + "type": "object", + "title": "ChunkingSettings", + "description": "Chunking settings", + "properties": { + "maxChunkSizeInTokens": { + "type": "integer" + } + } + }, + "CompletionAction": { + "type": "string", + "description": "The completion action.", + "enum": [ + "cleanUpTempAssets", + "keepAllAssets" + ], + "x-ms-enum": { + "name": "IngestionJobCompletionAction", + "modelAsString": true, + "values": [ + { + "name": "keepAllAssets", + "value": "keepAllAssets", + "description": "Will not clean up any of the intermediate assets created during the ingestion process." + }, + { + "name": "cleanUpTempAssets", + "value": "cleanUpTempAssets", + "description": "Will clean up intermediate assets created during the ingestion process." + } + ] + } + }, + "ComputeType": { + "type": "string", + "description": "The compute type.", + "enum": [ + "ServerlessCompute", + "CustomCompute" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true, + "values": [ + { + "name": "ServerlessCompute", + "value": "ServerlessCompute", + "description": "Serverless user compute." + }, + { + "name": "CustomCompute", + "value": "CustomCompute", + "description": "Custom user compute." + } + ] + } + }, + "ConnectionStringConnection": { + "description": "Connection string connection.", + "required": [ + "connectionString" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionString": { + "type": "string", + "description": "Connection string" + } + } + } + ], + "x-ms-discriminator-value": "ConnectionString" + }, + "ConnectionType": { + "type": "string", + "description": "The connection type.", + "enum": [ + "EndpointWithKey", + "ConnectionString", + "EndpointWithManagedIdentity", + "WorkspaceConnection", + "RelativeConnection" + ], + "x-ms-enum": { + "name": "ConnectionType", + "modelAsString": true, + "values": [ + { + "name": "EndpointWithKey", + "value": "EndpointWithKey", + "description": "Endpoint and key connection." + }, + { + "name": "ConnectionString", + "value": "ConnectionString", + "description": "Connection string." + }, + { + "name": "EndpointWithManagedIdentity", + "value": "EndpointWithManagedIdentity", + "description": "Endpoint and managed identity." + }, + { + "name": "WorkspaceConnection", + "value": "WorkspaceConnection", + "description": "AML Workspace connection." + }, + { + "name": "RelativeConnection", + "value": "RelativeConnection", + "description": "Relative deployment" + } + ] + } + }, + "CosmosDBIndex": { + "description": "CosmosDB Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the cosmos DB." + }, + "collectionName": { + "type": "string", + "description": "The name of the cosmos DB collection." + }, + "databaseName": { + "type": "string", + "description": "The name of the cosmos DB database." + } + } + } + ], + "x-ms-discriminator-value": "CosmosDB" + }, + "CrawlingSettings": { + "type": "object", + "title": "CrawlingSettings", + "description": "Crawling settings", + "properties": { + "maxCrawlDepth": { + "type": "integer" + }, + "maxCrawlTimeInMins": { + "type": "integer" + }, + "maxDownloadTimeInMins": { + "type": "integer" + }, + "maxFileSize": { + "type": "integer" + }, + "maxRedirects": { + "type": "integer" + }, + "maxFiles": { + "type": "integer" + } + } + }, + "CustomCompute": { + "description": "Custom compute.", + "required": [ + "computeId" + ], + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "computeId": { + "type": "string", + "description": "Id of the custom compute" + } + } + } + ], + "x-ms-discriminator-value": "CustomCompute" + }, + "DeploymentConnection": { + "description": "Relative deployment connection.", + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + } + ], + "x-ms-discriminator-value": "RelativeConnection" + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "EndpointKeyConnection": { + "description": "Endpoint key connection.", + "required": [ + "endpoint", + "key" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "key": { + "type": "string", + "description": "Key" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithKey" + }, + "EndpointMIConnection": { + "description": "Endpoint Managed Identity connection.", + "required": [ + "endpoint" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "endpoint": { + "type": "string", + "description": "Endpoint" + }, + "resourceId": { + "type": "string", + "description": "Resource Id" + } + } + } + ], + "x-ms-discriminator-value": "EndpointWithManagedIdentity" + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed", + "tooManyRequests", + "unauthorized", + "contentFilter" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "tooManyRequests", + "description": "Too many requests. Please retry later." + }, + { + "value": "unauthorized", + "description": "The current user/api key is not authorized for the operation." + }, + { + "value": "contentFilter", + "description": "Image generation failed as a result of our safety system." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EventType": { + "title": "EventType", + "description": "Defines the severity of a content filter result.", + "enum": [ + "message", + "metrics" + ], + "type": "string", + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "message", + "description": "Event only contains human readable messages." + }, + { + "value": "metrics", + "description": "Event contains metrics." + } + ] + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + } + }, + "readOnly": true + }, + "FileCreate": { + "title": "FileCreate", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileDetails": { + "title": "FileDetails", + "description": "A file detail is a document used by batch service to fetch file blob details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "path": { + "description": "The the relative path to the file within the container.", + "type": "string", + "readOnly": true + }, + "storage_account_uri": { + "format": "url", + "description": "The storage account url of this file.", + "type": "string", + "readOnly": true + }, + "storage_container_name": { + "description": "The Storage Container Name of this file blob.", + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FineTuningHyperParameters": { + "title": "FineTuningHyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + } + } + }, + "FineTuningJob": { + "title": "FineTuningJob", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_file": { + "description": "The file which is used for training.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file which is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "type": "string" + } + }, + "finished_at": { + "format": "int32", + "description": "A timestamp when this job or item has finished successfully (in unix epochs).", + "type": "integer" + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "trained_tokens": { + "format": "int32", + "description": "The total number of billable tokens processed by this fine tuning job.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/FineTuningJobError" + }, + "estimated_finish": { + "format": "int32", + "description": "The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.", + "type": "integer" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + } + } + }, + "FineTuningJobCheckpoint": { + "title": "FineTuningJobCheckpoint", + "required": [ + "created_at", + "fine_tuned_model_checkpoint", + "fine_tuning_job_id", + "metrics", + "step_number" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this checkpoint.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "The Unix timestamp (in seconds) for when the checkpoint was created.", + "type": "integer" + }, + "fine_tuned_model_checkpoint": { + "description": "The name of the fine-tuned checkpoint model that is created.", + "minLength": 1, + "type": "string" + }, + "step_number": { + "format": "int32", + "description": "The step number that the checkpoint was created at.", + "type": "integer" + }, + "metrics": { + "title": "Dictionary`2", + "description": "The metrics at the step number during the fine-tuning job.", + "type": "object", + "additionalProperties": { + "format": "double", + "type": "number" + } + }, + "fine_tuning_job_id": { + "description": "The name of the fine-tuning job that this checkpoint was created from..", + "minLength": 1, + "type": "string" + } + } + }, + "FineTuningJobCheckpointList": { + "title": "FineTuningJobCheckpointList", + "description": "Represents a list of checkpoints.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobCheckpoint" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobCreation": { + "title": "FineTuningJobCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "hyperparameters": { + "$ref": "#/definitions/FineTuningHyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "seed": { + "format": "int32", + "description": "The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you.", + "type": "integer" + }, + "integrations": { + "description": "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type.", + "type": "array", + "items": { + "$ref": "#/definitions/WandBIntegrationRequestWrapper" + } + } + } + }, + "FineTuningJobError": { + "title": "FineTuningJobError", + "description": "For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.", + "type": "object", + "properties": { + "code": { + "description": "The machine-readable error code..", + "type": "string" + }, + "message": { + "description": "The human-readable error message.", + "type": "string" + }, + "param": { + "description": "The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific.", + "type": "string" + } + } + }, + "FineTuningJobEvent": { + "title": "FineTuningJobEvent", + "required": [ + "created_at", + "level", + "message", + "type" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "id": { + "description": "The identity of this event.", + "type": "string", + "readOnly": true + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + }, + "type": { + "$ref": "#/definitions/EventType" + }, + "data": { + "description": "Machine readable data of this event." + } + } + }, + "FineTuningJobEventList": { + "title": "FineTuningJobEventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJobEvent" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningJobList": { + "title": "FineTuningJobList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTuningJob" + } + }, + "has_more": { + "description": "A value indicating whether the list contains more elements than returned.", + "type": "boolean" + } + } + }, + "FineTuningState": { + "title": "FineTuningState", + "description": "The state of a finetunes object or fine tuning job.", + "enum": [ + "created", + "pending", + "running", + "succeeded", + "cancelled", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "FineTuningState", + "modelAsString": true, + "values": [ + { + "value": "created", + "description": "The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state." + }, + { + "value": "pending", + "description": "The operation is not yet queued to be processed in the future. It can be categorized as an inactive state." + }, + { + "value": "running", + "description": "The operation has started to be processed. It can be categorized as an active state." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state." + }, + { + "value": "cancelled", + "description": "The operation has been cancelled and is incomplete. It can be categorized as a terminal state." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state." + } + ] + } + }, + "GenericEmbeddingSettings": { + "title": "ConnectionEmbeddingSettings", + "description": "Connection Embedding Settings", + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + }, + "IngestionError": { + "title": "IngestionError", + "description": "The details of the ingestion error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "innerErrors": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "IngestionJob": { + "title": "IngestionJob", + "description": "Represents the details of a job.", + "type": "object", + "required": [ + "kind" + ], + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/IngestionJobType" + }, + "jobId": { + "type": "string" + } + } + }, + "IngestionJobList": { + "title": "IngestionJobList", + "description": "Represents a list of ingestion jobs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJob" + } + } + } + }, + "IngestionJobProgress": { + "title": "IngestionJobProgress", + "type": "object", + "required": [ + "stageProgress" + ], + "properties": { + "stageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobRun": { + "title": "IngestionJobRun", + "description": "The details of a job run", + "type": "object", + "properties": { + "jobId": { + "type": "string" + }, + "runId": { + "type": "string" + }, + "status": { + "$ref": "#/definitions/OperationState" + }, + "error": { + "$ref": "#/definitions/IngestionError" + }, + "warnings": { + "type": "array", + "items": { + "type": "string" + } + }, + "progress": { + "$ref": "#/definitions/IngestionJobProgress" + } + } + }, + "IngestionJobRunList": { + "title": "IngestionJobRunList", + "description": "Represents a list of ingestion job runs.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link to the next page.", + "type": "string" + }, + "value": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobRun" + } + } + } + }, + "IngestionJobStageProgress": { + "title": "IngestionJobStageProgress", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "totalItems": { + "type": "integer", + "format": "int32" + }, + "processedItems": { + "type": "integer", + "format": "int32" + }, + "state": { + "$ref": "#/definitions/OperationState" + }, + "subStageProgress": { + "type": "array", + "items": { + "$ref": "#/definitions/IngestionJobStageProgress" + } + } + } + }, + "IngestionJobSystemCompute": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "searchServiceConnection": { + "$ref": "#/definitions/BaseConnection" + }, + "datasource": { + "$ref": "#/definitions/SystemComputeDatasource" + }, + "completionAction": { + "$ref": "#/definitions/CompletionAction" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "SystemCompute" + }, + "IngestionJobType": { + "title": "IngestionJobType", + "type": "string", + "description": "The job type.", + "enum": [ + "SystemCompute", + "UserCompute" + ], + "x-ms-enum": { + "name": "IngestionJobType", + "modelAsString": true, + "values": [ + { + "name": "SystemCompute", + "value": "SystemCompute", + "description": "Jobs that run on service owned resources." + }, + { + "name": "UserCompute", + "value": "UserCompute", + "description": "Jobs that run on user owned workspace." + } + ] + } + }, + "IngestionJobUserCompute": { + "type": "object", + "required": [ + "workspaceId" + ], + "allOf": [ + { + "$ref": "#/definitions/IngestionJob" + }, + { + "type": "object", + "properties": { + "workspaceId": { + "type": "string" + }, + "compute": { + "$ref": "#/definitions/JobCompute" + }, + "target": { + "$ref": "#/definitions/TargetIndex" + }, + "datasource": { + "$ref": "#/definitions/UserComputeDatasource" + }, + "dataRefreshIntervalInHours": { + "type": "integer" + } + } + } + ], + "x-ms-discriminator-value": "UserCompute" + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "IntegrationTypes": { + "title": "IntegrationTypes", + "description": "List of Fine Tune integrations available.", + "enum": [ + "wandb" + ], + "type": "string" + }, + "JobCompute": { + "title": "JobCompute", + "description": "The compute settings of the job.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ComputeType" + } + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/FineTuningState" + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "OperationState": { + "title": "OperationState", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation is not yet queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + } + ] + } + }, + "PineconeIndex": { + "description": "Pinecone Index.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/TargetIndex" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "The id of the connection pointing to the pinecone." + } + } + } + ], + "x-ms-discriminator-value": "Pinecone" + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results", + "assistants", + "assistants_output", + "batch", + "batch_output" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + }, + { + "value": "assistants", + "description": "This file contains data to be used in assistants." + }, + { + "value": "assistants_output", + "description": "This file contains the results of an assistant." + }, + { + "value": "batch", + "description": "This file contains the input data for a batch." + }, + { + "value": "batch_output", + "description": "This file contains the results of a batch." + } + ] + } + }, + "ServerlessCompute": { + "description": "Serverless compute.", + "allOf": [ + { + "$ref": "#/definitions/JobCompute" + }, + { + "type": "object", + "properties": { + "sku": { + "type": "string", + "description": "SKU Level" + }, + "instanceCount": { + "type": "integer", + "description": "The count of instances to run the job on." + } + } + } + ], + "x-ms-discriminator-value": "ServerlessCompute" + }, + "SystemComputeDatasource": { + "title": "SystemComputeDatasource", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/SystemComputeDatasourceType" + } + }, + "discriminator": "kind" + }, + "SystemComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Storage", + "Urls" + ], + "x-ms-enum": { + "name": "SystemComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Storage", + "value": "Storage", + "description": "Azure Storage Account." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "SystemComputeStorage": { + "title": "SystemComputeStorage", + "description": "Storage account", + "required": [ + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Storage", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "SystemComputeUrl": { + "title": "SystemComputeUrl", + "description": "Urls", + "required": [ + "urls", + "connection", + "containerName", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/SystemComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "connection": { + "$ref": "#/definitions/BaseConnection" + }, + "containerName": { + "type": "string", + "description": "container name" + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericEmbeddingSettings" + } + } + } + } + ] + }, + "TargetIndex": { + "title": "TargetIndex", + "description": "Information about the index to be created.", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/TargetType" + } + } + }, + "TargetType": { + "type": "string", + "description": "The target type.", + "enum": [ + "AzureAISearch", + "CosmosDB", + "Pinecone" + ], + "x-ms-enum": { + "name": "TargetType", + "modelAsString": true, + "values": [ + { + "name": "AzureAISearch", + "value": "AzureAISearch", + "description": "Azure AI Search Index." + }, + { + "name": "CosmosDB", + "value": "CosmosDB", + "description": "CosmosDB Index." + }, + { + "name": "Pinecone", + "value": "Pinecone", + "description": "Pinecone Index." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine_tuning.job", + "file", + "fine_tuning.job.event", + "fine_tuning.job.checkpoint", + "model", + "upload", + "upload.part" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine_tuning.job", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine_tuning.job.event", + "description": "This object represents an event of a fine tuning job." + }, + { + "value": "fine_tuning.job.checkpoint", + "description": "This object represents a checkpoint of a fine tuning job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base model or fine tune job result)." + }, + { + "value": "upload", + "description": "This object represents a file upload." + }, + { + "value": "upload.part", + "description": "This object represents part of a file upload." + }, + { + "value": "wandb", + "description": "This object represents the Weights and Biases Integration configuration." + } + ] + } + }, + "UploadFileCompleteBody": { + "title": "UploadFileCompleteBody", + "required": [ + "part_ids" + ], + "type": "object", + "properties": { + "part_ids": { + "title": "IList`1", + "type": "array", + "items": { + "type": "string" + } + }, + "md5": { + "type": "string" + } + } + }, + "UploadFileStartBody": { + "title": "UploadFileStartBody", + "required": [ + "bytes", + "filename", + "mime_type", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "minLength": 1, + "type": "string" + }, + "bytes": { + "format": "int64", + "type": "integer" + }, + "mime_type": { + "minLength": 1, + "type": "string" + } + } + }, + "UploadPartResource": { + "title": "UploadPartResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "upload_id": { + "type": "string", + "readOnly": true + }, + "azure_block_id": { + "type": "string", + "readOnly": true + } + } + }, + "UploadResource": { + "title": "UploadResource", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "type": "integer", + "readOnly": true + }, + "filename": { + "type": "string", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "status": { + "$ref": "#/definitions/UploadStatus" + }, + "expires_at": { + "format": "unixtime", + "type": "integer", + "readOnly": true + }, + "file": { + "$ref": "#/definitions/File" + } + } + }, + "UploadStatus": { + "title": "UploadStatus", + "enum": [ + "pending", + "expired", + "completed", + "cancelled" + ], + "type": "string", + "readOnly": true + }, + "UserComputeDataset": { + "type": "object", + "title": "UserComputeStorage", + "description": "Storage account", + "required": [ + "datasetId", + "datasetType" + ], + "x-ms-discriminator-value": "Dataset", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "datasetId": { + "type": "string" + }, + "datasetType": { + "type": "string" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "UserComputeDatasource": { + "title": "UserComputeDatasource", + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/UserComputeDatasourceType" + } + } + }, + "UserComputeDatasourceType": { + "type": "string", + "description": "The datasource type.", + "enum": [ + "Dataset", + "Urls" + ], + "x-ms-enum": { + "name": "UserComputeDatasourceType", + "modelAsString": true, + "values": [ + { + "name": "Dataset", + "value": "Dataset", + "description": "Workspace Dataset." + }, + { + "name": "Urls", + "value": "Urls", + "description": "URLs." + } + ] + } + }, + "UserComputeUrl": { + "type": "object", + "title": "UserComputeUrl", + "description": "Urls", + "required": [ + "urls", + "embeddings" + ], + "x-ms-discriminator-value": "Urls", + "allOf": [ + { + "$ref": "#/definitions/UserComputeDatasource" + }, + { + "type": "object", + "properties": { + "urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "crawling": { + "$ref": "#/definitions/CrawlingSettings" + }, + "chunking": { + "$ref": "#/definitions/ChunkingSettings" + }, + "embeddings": { + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceConnectionEmbeddingSettings" + } + } + } + } + ] + }, + "WandBIntegrationRequest": { + "title": "WandBIntegrationRequest", + "required": [ + "project" + ], + "type": "object", + "properties": { + "project": { + "minLength": 1, + "type": "string" + }, + "name": { + "type": "string", + "readOnly": true + }, + "entity": { + "type": "string", + "readOnly": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "WandBIntegrationRequestWrapper": { + "title": "WandBIntegrationRequestWrapper", + "required": [ + "type", + "wandb" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/IntegrationTypes" + }, + "wandb": { + "$ref": "#/definitions/WandBIntegrationRequest" + } + } + }, + "WorkspaceConnection": { + "description": "AML Workspace connection.", + "required": [ + "connectionId" + ], + "allOf": [ + { + "$ref": "#/definitions/BaseConnection" + }, + { + "type": "object", + "properties": { + "connectionId": { + "type": "string", + "description": "ConnectionId" + } + } + } + ], + "x-ms-discriminator-value": "WorkspaceConnection" + }, + "WorkspaceConnectionEmbeddingSettings": { + "title": "WorkspaceConnectionEmbeddingSettings", + "description": "Connection id to the embedding model", + "type": "object", + "properties": { + "connectionId": { + "type": "string" + }, + "deploymentName": { + "type": "string" + }, + "modelName": { + "type": "string" + } + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2024-09-01-preview", + "x-ms-parameter-location": "client" + } + }, + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "description": "API key authentication", + "type": "apiKey", + "name": "api-key", + "in": "header" + }, + "OAuth2Auth": { + "description": "OAuth2 authentication", + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + } + } + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml new file mode 100644 index 000000000000..3f8aa397e406 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/azureopenai.yaml @@ -0,0 +1,2569 @@ +swagger: "2.0" +info: + title: Azure OpenAI API version 2024-09-01-preview + description: APIs for fine-tuning and managing deployments of OpenAI models. + version: 2024-09-01-preview +paths: + /batches: + get: + tags: + - "Batch:" + summary: Gets a list of all batches owned by the Azure OpenAI resource. + operationId: Batch_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of batches to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/BatchesList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all batches owned by this account.: + $ref: ./examples/get_batches.json + post: + tags: + - "Batch:" + summary: "Creates and executes a batch from an uploaded file of requests.\r\nResponse includes details of the enqueued job including job status.\r\nThe ID of the result file is added to the response once complete." + operationId: Batch_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: createBatchRequest + description: The specification of the batch to create and execute. + required: true + schema: + $ref: "#/definitions/BatchCreateRequest" + responses: + "201": + description: The batch has been successfully created. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a batch.: + $ref: ./examples/post_batch.json + /batches/{batch-id}: + get: + tags: + - "Batch:" + summary: Gets details for a single batch specified by the given batch-id. + operationId: Batch_Get + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a batch.: + $ref: ./examples/get_batch.json + /batches/{batch-id}/cancel: + post: + tags: + - "Batch:" + summary: Cancels the processing of the batch specified by the given batch-id. + operationId: Batch_Cancel + produces: + - application/json + parameters: + - in: path + name: batch-id + description: The identifier of the batch. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The batch has been successfully canceled. + schema: + $ref: "#/definitions/Batch" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a batch.: + $ref: ./examples/cancel_batch.json + /files: + get: + tags: + - "Files:" + summary: "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job." + operationId: Files_List + produces: + - application/json + parameters: + - in: query + name: purpose + description: Only return files with the given purpose. + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + - batch_output + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - value: batch_output + description: This file contains the results of a batch. + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FileList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all files owned by this account.: + $ref: ./examples/get_files.yaml + post: + tags: + - "Files:" + summary: Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Upload + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + required: true + type: string + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + - batch + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + - value: batch + description: This file contains the input data for a batch. + - in: formData + name: file + description: Gets or sets the file to upload into Azure OpenAI. + required: true + type: file + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a file.: + $ref: ./examples/upload_file.yaml + /files/import: + post: + tags: + - "Files:" + summary: Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models. + operationId: Files_Import + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fileImport + description: The definition of the file to create including its purpose, the file name and the url of the file location. + required: true + schema: + $ref: "#/definitions/FileImport" + responses: + "201": + description: The file has been successfully created. + schema: + $ref: "#/definitions/File" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Importing a file with a blob url as source.: + $ref: ./examples/import_file.yaml + /files/{file-id}: + get: + tags: + - "Files:" + summary: Gets details for a single file specified by the given file-id including status, size, purpose, etc. + operationId: Files_Get + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/File" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a file.: + $ref: ./examples/get_file.yaml + delete: + tags: + - "Files:" + summary: "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job." + operationId: Files_Delete + produces: + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "204": + description: The file was successfully deleted. + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a file.: + $ref: ./examples/delete_file.yaml + /files/{file-id}/content: + get: + tags: + - "Files:" + summary: "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job." + operationId: Files_GetContent + produces: + - application/octet-stream + - application/json + parameters: + - in: path + name: file-id + description: The identifier of the file. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + type: file + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting the file content.: + $ref: ./examples/get_file_content.yaml + /fine_tuning/jobs: + get: + tags: + - "Fine-tuning:" + summary: "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_List + produces: + - application/json + parameters: + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all fine tuning jobs owned by this account.: + $ref: ./examples/get_finetuning_jobs.yaml + post: + tags: + - "Fine-tuning:" + summary: "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete." + operationId: FineTuning_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: fineTuningJob + description: "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can be optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others." + required: true + schema: + $ref: "#/definitions/FineTuningJobCreation" + responses: + "201": + description: The fine tune has been successfully created. + schema: + $ref: "#/definitions/FineTuningJob" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Creating a fine tuning job.: + $ref: ./examples/post_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}: + get: + tags: + - "Fine-tuning:" + summary: "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_Get + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a fine tuning job.: + $ref: ./examples/get_finetuning_job.yaml + delete: + tags: + - "Fine-tuning:" + summary: Deletes the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Delete + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "204": + description: The fine tune was successfully deleted. + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Deleting a fine tuning job.: + $ref: ./examples/delete_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/cancel: + post: + tags: + - "Fine-tuning:" + summary: Cancels the processing of the fine-tune job specified by the given fine-tune-id. + operationId: FineTuning_Cancel + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: The fine tune has been successfully canceled + schema: + $ref: "#/definitions/FineTuningJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Canceling a fine tuning job.: + $ref: ./examples/cancel_finetuning_job.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/checkpoints: + get: + tags: + - "Fine-tuning:" + summary: "Gets the checkpoints for the fine-tune job specified by the given fine-tune-id.\r\nCheckpoints are created at the end of successful epochs during training." + operationId: FineTuning_GetCheckpoints + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last checkpoint ID from the previous pagination request. + type: string + - in: query + name: limit + description: Number of checkpoints to retrieve. Defaults to 10. + type: integer + format: int32 + default: 10 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobCheckpointList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting checkpoints of a fine tuning job.: + $ref: ./examples/get_finetuning_job_checkpoints.yaml + /fine_tuning/jobs/{fine-tuning-job-id}/events: + get: + tags: + - "Fine-tuning:" + summary: "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded." + operationId: FineTuning_GetEvents + produces: + - application/json + parameters: + - in: path + name: fine-tuning-job-id + description: The identifier of the fine-tune job. + required: true + type: string + - in: query + name: after + description: Identifier for the last event from the previous pagination request. + type: string + - in: query + name: limit + description: Number of events to retrieve. Defaults to 20. + type: integer + format: int32 + default: 20 + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/FineTuningJobEventList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting events of a fine tuning job.: + $ref: ./examples/get_finetuning_job_events.yaml + /ingestion/jobs: + get: + tags: + - "Ingestion:" + summary: Lists the ingestion jobs. + operationId: IngestionJobs_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List all ingestion jobs: + $ref: ./examples/list_ingestion_jobs.json + /ingestion/jobs/{job-id}: + put: + tags: + - "Ingestion:" + summary: Creates an ingestion job with the specified job id. + operationId: IngestionJobs_Create + consumes: + - application/json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + type: string + description: The id of the job that will be created. + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + - in: header + name: aml-user-token + type: string + description: The token used to access the resources within the job in the workspace (needed only for user compute jobs). + - in: body + name: ingestionJob + schema: + $ref: "#/definitions/IngestionJob" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Create a system-compute ingestion job: + $ref: ./examples/put_ingestion_job_sc.json + Create a user-compute ingestion job: + $ref: ./examples/put_ingestion_job_uc.json + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified job id. + operationId: IngestionJobs_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJob" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job: + $ref: ./examples/get_ingestion_job.json + /ingestion/jobs/{job-id}/runs: + get: + tags: + - "Ingestion:" + summary: Lists the runs of the specified job id. + operationId: IngestionJobRuns_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRunList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + List ingestion job runs: + $ref: ./examples/list_ingestion_job_runs.json + /ingestion/jobs/{job-id}/runs/{run-id}: + get: + tags: + - "Ingestion:" + summary: Gets the details of the specified run id as part of the specified job id. + operationId: IngestionJobRuns_Get + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: path + name: job-id + required: true + description: The id of the job. + type: string + - in: path + name: run-id + required: true + description: The id of the run. + type: string + - in: header + name: mgmt-user-token + type: string + description: The token used to access the workspace (needed only for user compute jobs). + responses: + "200": + description: Success + schema: + $ref: "#/definitions/IngestionJobRun" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Get ingestion job runs: + $ref: ./examples/get_ingestion_job_run.json + /models: + get: + tags: + - "Models:" + summary: "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource." + operationId: Models_List + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/ModelList" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting all models owned by account.: + $ref: ./examples/get_models.yaml + /models/{model-id}: + get: + tags: + - "Models:" + summary: Gets details for the model specified by the given modelId. + operationId: Models_Get + produces: + - application/json + parameters: + - in: path + name: model-id + description: The identifier of the model. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/Model" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Getting a base model.: + $ref: ./examples/get_model_base.yaml + Getting a fine-tuned model.: + $ref: ./examples/get_model_finetune.yaml + /uploads: + post: + tags: + - "UploadFile:" + summary: "An intermediate Upload object is created, allowing you to add Parts to it. Currently, an Upload size can be a maximum of 9 GB in total and will expire two hours after being created.\r\nAfter the Upload is completed a File object will be generated, containing all the uploaded parts. This File object can then be used across our platform just like any other file." + operationId: UploadFile_Start + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileStartBody" + responses: + "200": + description: The upload has been successfully created. + schema: + $ref: "#/definitions/UploadResource" + headers: + Location: + description: The location of the newly created item. + type: string + format: url + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Start a large file upload operation.: + $ref: ./examples/upload_file_start.yaml + /uploads/{upload-id}/cancel: + post: + tags: + - "UploadFile:" + summary: "Cancels the Upload, and will lead to all uploaded parts to be deleted asynchronously.\r\nNo Parts may be added after an Upload is cancelled." + operationId: UploadFile_Cancel + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Cancel a large file upload operation.: + $ref: ./examples/upload_file_cancel.yaml + /uploads/{upload-id}/complete: + post: + tags: + - "UploadFile:" + summary: "This completes the Upload, and the returned Upload object contains a nested File object that is ready for use across the platform.\r\nYou can define the order of the Parts by providing an ordered list of Part IDs.\r\nThe total number of bytes uploaded must match the size originally specified when creating the Upload object.\r\nAfter this operation no additional Parts can be added once the Upload is completed." + operationId: UploadFile_Complete + consumes: + - application/json + - text/json + - application/*+json + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: body + name: requestBody + description: The definition of the file to create including its purpose and the location on the local machine. + required: true + schema: + $ref: "#/definitions/UploadFileCompleteBody" + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Complete and validate a large file upload operation.: + $ref: ./examples/upload_file_complete.yaml + /uploads/{upload-id}/parts: + post: + tags: + - "UploadFile:" + summary: "Adds a Part to an Upload object, where each Part represents a segment of the file you are uploading.\r\nEach Part can be up to the standard size limit for file upload, based on the File Purpose. You can continue adding Parts until reaching the Upload size limit of 9 GB." + operationId: UploadFile_Part + consumes: + - multipart/form-data + produces: + - application/json + parameters: + - in: path + name: upload-id + description: The identifier of the upload. + required: true + type: string + - $ref: "#/parameters/apiVersionQueryParameter" + - in: formData + name: data + required: true + type: file + responses: + "200": + description: Success + schema: + $ref: "#/definitions/UploadPartResource" + default: + description: An error occurred. + schema: + $ref: "#/definitions/ErrorResponse" + x-ms-examples: + Upload a part of large file upload operation.: + $ref: ./examples/upload_file_part.yaml +definitions: + AzureAISearchIndex: + description: Azure AI Search Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the Azure AI Search Index. + x-ms-discriminator-value: AzureAISearch + BaseConnection: + title: BaseConnection + description: A connection to a resource. + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/ConnectionType" + discriminator: kind + Batch: + title: Batch + description: Defines the values of a batch. + required: + - id + - input_file_id + type: object + properties: + id: + description: The identity of this item. + type: string + object: + $ref: "#/definitions/TypeDiscriminator" + endpoint: + description: The API endpoint used by the batch. + type: string + readOnly: true + errors: + $ref: "#/definitions/BatchErrors" + input_file_id: + description: The ID of the input file for the batch. + minLength: 1 + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + status: + $ref: "#/definitions/BatchStatus" + output_file_id: + description: The ID of the file containing outputs of successfully executed requests. + type: string + error_file_id: + description: The ID of the file containing outputs of requests with errors. + type: string + created_at: + format: unixtime + description: A timestamp when this batch was created (in unix epochs). + type: integer + readOnly: true + in_progress_at: + format: unixtime + description: A timestamp when this batch started progressing (in unix epochs). + type: integer + readOnly: true + expires_at: + format: unixtime + description: A timestamp when this batch will expire (in unix epochs). + type: integer + readOnly: true + finalizing_at: + format: unixtime + description: A timestamp when this batch started finalizing (in unix epochs). + type: integer + readOnly: true + completed_at: + format: unixtime + description: A timestamp when this batch was completed (in unix epochs). + type: integer + readOnly: true + failed_at: + format: unixtime + description: A timestamp when this batch failed (in unix epochs). + type: integer + readOnly: true + expired_at: + format: unixtime + description: A timestamp when this batch expired (in unix epochs). + type: integer + readOnly: true + cancelling_at: + format: unixtime + description: A timestamp when this batch started cancelling (in unix epochs). + type: integer + readOnly: true + cancelled_at: + format: unixtime + description: A timestamp when this batch was cancelled (in unix epochs). + type: integer + readOnly: true + request_counts: + $ref: "#/definitions/BatchRequestCounts" + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchCreateRequest: + title: BatchCreateRequest + description: Defines the request to create a batch. + required: + - input_file_id + - endpoint + - completion_window + type: object + properties: + input_file_id: + description: The ID if the input file for the batch. + minLength: 1 + type: string + endpoint: + description: The API endpoint used by the batch. + type: string + completion_window: + description: The time frame within which the batch should be processed. + type: string + metadata: + description: A set of key-value pairs that can be attached to the batch. This can be useful for storing additional infomration about the batch in a structured format. + type: object + additionalProperties: + type: string + BatchErrorData: + title: BatchErrorData + description: Error information for a failure in batch. + type: object + properties: + code: + description: An error code identifying the error type. + type: string + message: + description: A human-readable message providing more details about the error. + type: string + param: + description: The name of the parameter that caused the error, if applicable (can be null). + type: string + line: + description: The line number of the input file where the error occurred, if applicable (can be null). + type: string + BatchErrors: + title: BatchErrors + description: For batches that have failed, this will contain more information on the cause of the failures. + type: object + properties: + object: + description: The type of the errors object. This is always 'list'. + type: string + data: + $ref: "#/definitions/BatchErrorData" + BatchRequestCounts: + title: BatchRequestCounts + description: The request counts for different statuses within the batch. + type: object + properties: + total: + description: The total number of requests in the batch. + type: integer + completed: + description: The number of requests in the batch that have been completed successfully. + type: integer + failed: + description: The number of requests in the batch that have failed. + type: integer + BatchStatus: + title: BatchStatus + description: The status of a batch. + enum: + - validating + - failed + - in_progress + - finalizing + - completed + - expired + - cancelling + - cancelled + type: string + readOnly: true + x-ms-enum: + name: BatchStatus + modelAsString: true + values: + - value: validating + description: The input file is being validated before the batch can begin. + - value: failed + description: The input file has failed the validation process. + - value: in_progress + description: The input file was successfully validated and the batch is currently being executed. + - value: finalizing + description: The batch has completed and the results are being prepared. + - value: completed + description: The batch has been completed and the results are ready. + - value: expired + description: The batch was not able to complete within the 24-hour time window. + - value: cancelling + description: Cancellation of the batch has been initiated. + - value: cancelled + description: The batch was cancelled. + BatchesList: + title: BatchList + description: Represents a list of batches. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Batch" + first_id: + description: The id of the first batch in the list of batches returned. + type: string + last_id: + description: The id of the last batch in the list of batches returned. + type: string + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + Capabilities: + title: Capabilities + description: The capabilities of a base or fine tune model. + required: + - chat_completion + - completion + - embeddings + - fine_tune + - inference + type: object + properties: + fine_tune: + description: A value indicating whether a model can be used for fine tuning. + type: boolean + inference: + description: A value indicating whether a model can be deployed. + type: boolean + completion: + description: A value indicating whether a model supports completion. + type: boolean + chat_completion: + description: A value indicating whether a model supports chat completion. + type: boolean + embeddings: + description: A value indicating whether a model supports embeddings. + type: boolean + ChunkingSettings: + type: object + title: ChunkingSettings + description: Chunking settings + properties: + maxChunkSizeInTokens: + type: integer + CompletionAction: + type: string + description: The completion action. + enum: + - cleanUpTempAssets + - keepAllAssets + x-ms-enum: + name: IngestionJobCompletionAction + modelAsString: true + values: + - name: keepAllAssets + value: keepAllAssets + description: Will not clean up any of the intermediate assets created during the ingestion process. + - name: cleanUpTempAssets + value: cleanUpTempAssets + description: Will clean up intermediate assets created during the ingestion process. + ComputeType: + type: string + description: The compute type. + enum: + - ServerlessCompute + - CustomCompute + x-ms-enum: + name: ComputeType + modelAsString: true + values: + - name: ServerlessCompute + value: ServerlessCompute + description: Serverless user compute. + - name: CustomCompute + value: CustomCompute + description: Custom user compute. + ConnectionStringConnection: + description: Connection string connection. + required: + - connectionString + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionString: + type: string + description: Connection string + x-ms-discriminator-value: ConnectionString + ConnectionType: + type: string + description: The connection type. + enum: + - EndpointWithKey + - ConnectionString + - EndpointWithManagedIdentity + - WorkspaceConnection + - RelativeConnection + x-ms-enum: + name: ConnectionType + modelAsString: true + values: + - name: EndpointWithKey + value: EndpointWithKey + description: Endpoint and key connection. + - name: ConnectionString + value: ConnectionString + description: Connection string. + - name: EndpointWithManagedIdentity + value: EndpointWithManagedIdentity + description: Endpoint and managed identity. + - name: WorkspaceConnection + value: WorkspaceConnection + description: AML Workspace connection. + - name: RelativeConnection + value: RelativeConnection + description: Relative deployment + CosmosDBIndex: + description: CosmosDB Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the cosmos DB. + collectionName: + type: string + description: The name of the cosmos DB collection. + databaseName: + type: string + description: The name of the cosmos DB database. + x-ms-discriminator-value: CosmosDB + CrawlingSettings: + type: object + title: CrawlingSettings + description: Crawling settings + properties: + maxCrawlDepth: + type: integer + maxCrawlTimeInMins: + type: integer + maxDownloadTimeInMins: + type: integer + maxFileSize: + type: integer + maxRedirects: + type: integer + maxFiles: + type: integer + CustomCompute: + description: Custom compute. + required: + - computeId + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + computeId: + type: string + description: Id of the custom compute + x-ms-discriminator-value: CustomCompute + DeploymentConnection: + description: Relative deployment connection. + allOf: + - $ref: "#/definitions/BaseConnection" + x-ms-discriminator-value: RelativeConnection + Deprecation: + title: Deprecation + description: "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties." + required: + - inference + type: object + properties: + fine_tune: + format: unixtime + description: The end date of fine tune support of this model. Will be `null` for fine tune models. + type: integer + inference: + format: unixtime + description: The end date of inference support of this model. + type: integer + EndpointKeyConnection: + description: Endpoint key connection. + required: + - endpoint + - key + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + key: + type: string + description: Key + x-ms-discriminator-value: EndpointWithKey + EndpointMIConnection: + description: Endpoint Managed Identity connection. + required: + - endpoint + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + endpoint: + type: string + description: Endpoint + resourceId: + type: string + description: Resource Id + x-ms-discriminator-value: EndpointWithManagedIdentity + Error: + title: Error + description: "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - code + - message + type: object + properties: + code: + $ref: "#/definitions/ErrorCode" + message: + description: The message of this error. + minLength: 1 + type: string + target: + description: The location where the error happened if available. + type: string + details: + description: The error details if available. + type: array + items: + $ref: "#/definitions/Error" + innererror: + $ref: "#/definitions/InnerError" + ErrorCode: + title: ErrorCode + description: "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - conflict + - invalidPayload + - forbidden + - notFound + - unexpectedEntityState + - itemDoesAlreadyExist + - serviceUnavailable + - internalFailure + - quotaExceeded + - jsonlValidationFailed + - fileImportFailed + - tooManyRequests + - unauthorized + - contentFilter + type: string + x-ms-enum: + name: ErrorCode + modelAsString: true + values: + - value: conflict + description: The requested operation conflicts with the current resource state. + - value: invalidPayload + description: The request data is invalid for this operation. + - value: forbidden + description: The operation is forbidden for the current user/api key. + - value: notFound + description: The resource is not found. + - value: unexpectedEntityState + description: The operation cannot be executed in the current resource's state. + - value: itemDoesAlreadyExist + description: The item does already exist. + - value: serviceUnavailable + description: The service is currently not available. + - value: internalFailure + description: Internal error. Please retry. + - value: quotaExceeded + description: Quota exceeded. + - value: jsonlValidationFailed + description: Validation of jsonl data failed. + - value: fileImportFailed + description: Import of file failed. + - value: tooManyRequests + description: Too many requests. Please retry later. + - value: unauthorized + description: The current user/api key is not authorized for the operation. + - value: contentFilter + description: Image generation failed as a result of our safety system. + ErrorResponse: + title: ErrorResponse + description: "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + required: + - error + type: object + properties: + error: + $ref: "#/definitions/Error" + EventType: + title: EventType + description: Defines the severity of a content filter result. + enum: + - message + - metrics + type: string + x-ms-enum: + name: EventType + modelAsString: true + values: + - value: message + description: Event only contains human readable messages. + - value: metrics + description: Event contains metrics. + File: + title: File + description: A file is a document usable for training and validation. It can also be a service generated document with result details. + required: + - filename + - purpose + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + description: "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers." + type: integer + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + filename: + description: The name of the file. + minLength: 1 + type: string + readOnly: true + FileCreate: + title: FileCreate + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileDetails: + title: FileDetails + description: A file detail is a document used by batch service to fetch file blob details. + required: + - filename + - purpose + type: object + properties: + id: + description: The identity of this item. + type: string + readOnly: true + filename: + description: The name of the file. + minLength: 1 + type: string + path: + description: The the relative path to the file within the container. + type: string + readOnly: true + storage_account_uri: + format: url + description: The storage account url of this file. + type: string + readOnly: true + storage_container_name: + description: The Storage Container Name of this file blob. + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + FileImport: + title: FileImport + description: Defines a document to import from an external content url to be usable with Azure OpenAI. + required: + - content_url + - filename + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + description: "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples." + minLength: 1 + type: string + content_url: + format: url + description: The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request). + type: string + FileList: + title: FileList + description: Represents a list of files. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/File" + FineTuningHyperParameters: + title: FineTuningHyperParameters + description: The hyper parameter settings used in a fine tune job. + type: object + properties: + n_epochs: + format: int32 + description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. + type: integer + batch_size: + format: int32 + description: "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model." + type: integer + learning_rate_multiplier: + format: double + description: "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results." + type: number + FineTuningJob: + title: FineTuningJob + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The identifier (model-id) of the base model used for the fine-tune. + minLength: 1 + type: string + fine_tuned_model: + description: "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing." + type: string + training_file: + description: The file which is used for training. + minLength: 1 + type: string + validation_file: + description: The file which is used to evaluate the fine tuned model during training. + type: string + result_files: + description: "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs." + type: array + items: + type: string + finished_at: + format: int32 + description: A timestamp when this job or item has finished successfully (in unix epochs). + type: integer + organisation_id: + description: The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only. + type: string + trained_tokens: + format: int32 + description: The total number of billable tokens processed by this fine tuning job. + type: integer + readOnly: true + error: + $ref: "#/definitions/FineTuningJobError" + estimated_finish: + format: int32 + description: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running. + type: integer + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + FineTuningJobCheckpoint: + title: FineTuningJobCheckpoint + required: + - created_at + - fine_tuned_model_checkpoint + - fine_tuning_job_id + - metrics + - step_number + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + id: + description: The identity of this checkpoint. + type: string + readOnly: true + created_at: + format: unixtime + description: The Unix timestamp (in seconds) for when the checkpoint was created. + type: integer + fine_tuned_model_checkpoint: + description: The name of the fine-tuned checkpoint model that is created. + minLength: 1 + type: string + step_number: + format: int32 + description: The step number that the checkpoint was created at. + type: integer + metrics: + title: Dictionary`2 + description: The metrics at the step number during the fine-tuning job. + type: object + additionalProperties: + format: double + type: number + fine_tuning_job_id: + description: The name of the fine-tuning job that this checkpoint was created from.. + minLength: 1 + type: string + FineTuningJobCheckpointList: + title: FineTuningJobCheckpointList + description: Represents a list of checkpoints. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobCheckpoint" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobCreation: + title: FineTuningJobCreation + description: Defines the values of a fine tune job. + required: + - model + - training_file + type: object + properties: + model: + description: The identifier (model-id) of the base model used for this fine-tune. + minLength: 1 + type: string + training_file: + description: The file identity (file-id) that is used for training this fine tuned model. + minLength: 1 + type: string + validation_file: + description: The file identity (file-id) that is used to evaluate the fine tuned model during training. + type: string + hyperparameters: + $ref: "#/definitions/FineTuningHyperParameters" + suffix: + description: The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name. + type: string + seed: + format: int32 + description: The seed used for the finetuning job. Passing in the same seed and job parameters should produce the same results, but may differ in rare cases. If a seed is not specified, one will be generated for you. + type: integer + integrations: + type: array + items: + $ref: "#/definitions/WandBIntegrationRequestWrapper" + description: "A list configurations for integrations supporting the fine-tuning job.\r\nThere are many integrations planned, so make sure to check and act on the integration type." + FineTuningJobError: + title: FineTuningJobError + description: For fine-tuning jobs that have failed, this will contain more information on the cause of the failure. + type: object + properties: + code: + description: The machine-readable error code.. + type: string + message: + description: The human-readable error message. + type: string + param: + description: The parameter that was invalid, usually training_file or validation_file. This field will be null if the failure was not parameter-specific. + type: string + FineTuningJobEvent: + title: FineTuningJobEvent + required: + - created_at + - level + - message + - type + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + id: + description: The identity of this event. + type: string + readOnly: true + created_at: + format: unixtime + description: A timestamp when this event was created (in unix epochs). + type: integer + level: + $ref: "#/definitions/LogLevel" + message: + description: The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results. + minLength: 1 + type: string + type: + $ref: "#/definitions/EventType" + data: + description: Machine readable data of this event. + FineTuningJobEventList: + title: FineTuningJobEventList + description: Represents a list of events. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJobEvent" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningJobList: + title: FineTuningJobList + description: Represents a list of fine tunes. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/FineTuningJob" + has_more: + description: A value indicating whether the list contains more elements than returned. + type: boolean + FineTuningState: + title: FineTuningState + description: The state of a finetunes object or fine tuning job. + enum: + - created + - pending + - running + - succeeded + - cancelled + - failed + type: string + readOnly: true + x-ms-enum: + name: FineTuningState + modelAsString: true + values: + - value: created + description: The operation was created. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state. + - value: pending + description: The operation is not yet queued to be processed in the future. It can be categorized as an inactive state. + - value: running + description: The operation has started to be processed. It can be categorized as an active state. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state. + - value: cancelled + description: The operation has been cancelled and is incomplete. It can be categorized as a terminal state. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state. + GenericEmbeddingSettings: + title: ConnectionEmbeddingSettings + description: Connection Embedding Settings + type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + deploymentName: + type: string + modelName: + type: string + IngestionError: + title: IngestionError + description: The details of the ingestion error + type: object + properties: + message: + type: string + innerErrors: + type: array + items: + type: string + IngestionJob: + title: IngestionJob + description: Represents the details of a job. + type: object + required: + - kind + discriminator: kind + properties: + kind: + $ref: "#/definitions/IngestionJobType" + jobId: + type: string + IngestionJobList: + title: IngestionJobList + description: Represents a list of ingestion jobs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJob" + IngestionJobProgress: + title: IngestionJobProgress + type: object + required: + - stageProgress + properties: + stageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobRun: + title: IngestionJobRun + description: The details of a job run + type: object + properties: + jobId: + type: string + runId: + type: string + status: + $ref: "#/definitions/OperationState" + error: + $ref: "#/definitions/IngestionError" + warnings: + type: array + items: + type: string + progress: + $ref: "#/definitions/IngestionJobProgress" + IngestionJobRunList: + title: IngestionJobRunList + description: Represents a list of ingestion job runs. + type: object + properties: + nextLink: + description: The link to the next page. + type: string + value: + description: The list of items. + type: array + items: + $ref: "#/definitions/IngestionJobRun" + IngestionJobStageProgress: + title: IngestionJobStageProgress + type: object + properties: + name: + type: string + totalItems: + type: integer + format: int32 + processedItems: + type: integer + format: int32 + state: + $ref: "#/definitions/OperationState" + subStageProgress: + type: array + items: + $ref: "#/definitions/IngestionJobStageProgress" + IngestionJobSystemCompute: + type: object + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + searchServiceConnection: + $ref: "#/definitions/BaseConnection" + datasource: + $ref: "#/definitions/SystemComputeDatasource" + completionAction: + $ref: "#/definitions/CompletionAction" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: SystemCompute + IngestionJobType: + title: IngestionJobType + type: string + description: The job type. + enum: + - SystemCompute + - UserCompute + x-ms-enum: + name: IngestionJobType + modelAsString: true + values: + - name: SystemCompute + value: SystemCompute + description: Jobs that run on service owned resources. + - name: UserCompute + value: UserCompute + description: Jobs that run on user owned workspace. + IngestionJobUserCompute: + type: object + required: + - workspaceId + allOf: + - $ref: "#/definitions/IngestionJob" + - type: object + properties: + workspaceId: + type: string + compute: + $ref: "#/definitions/JobCompute" + target: + $ref: "#/definitions/TargetIndex" + datasource: + $ref: "#/definitions/UserComputeDatasource" + dataRefreshIntervalInHours: + type: integer + x-ms-discriminator-value: UserCompute + InnerError: + title: InnerError + description: "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + type: object + properties: + code: + $ref: "#/definitions/InnerErrorCode" + innererror: + $ref: "#/definitions/InnerError" + InnerErrorCode: + title: InnerErrorCode + description: "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)." + enum: + - invalidPayload + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: invalidPayload + description: The request data is invalid for this operation. + IntegrationTypes: + title: IntegrationTypes + enum: + - wandb + type: string + description: List of Fine Tune integrations available. + JobCompute: + title: JobCompute + description: The compute settings of the job. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/ComputeType" + LifeCycleStatus: + title: LifeCycleStatus + description: "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\"." + enum: + - preview + - generally-available + type: string + x-ms-enum: + name: LifeCycleStatus + modelAsString: true + values: + - value: preview + description: Model is in preview and covered by the service preview terms. + - value: generally-available + description: Model is generally available. + LogLevel: + title: LogLevel + description: The verbosity level of an event. + enum: + - info + - warning + - error + type: string + x-ms-enum: + name: LogLevel + modelAsString: true + values: + - value: info + description: This event is for information only. + - value: warning + description: This event represents a mitigated issue. + - value: error + description: This message represents a non recoverable issue. + Model: + title: Model + description: A model is either a base model or the result of a successful fine tune job. + required: + - capabilities + - deprecation + - lifecycle_status + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + status: + $ref: "#/definitions/FineTuningState" + model: + description: The base model identity (model-id) if this is a fine tune model; otherwise `null`. + type: string + fine_tune: + description: The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`. + type: string + capabilities: + $ref: "#/definitions/Capabilities" + lifecycle_status: + $ref: "#/definitions/LifeCycleStatus" + deprecation: + $ref: "#/definitions/Deprecation" + ModelList: + title: ModelList + description: Represents a list of models. + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + data: + description: The list of items. + type: array + items: + $ref: "#/definitions/Model" + OperationState: + title: OperationState + description: The state of a job or item. + enum: + - notRunning + - running + - succeeded + - failed + type: string + readOnly: true + x-ms-enum: + name: OperationState + modelAsString: true + values: + - value: notRunning + description: The operation is not yet queued to be processed in the future. + - value: running + description: The operation has started to be processed. + - value: succeeded + description: The operation has successfully be processed and is ready for consumption. + - value: failed + description: The operation has completed processing with a failure and cannot be further consumed. + PineconeIndex: + description: Pinecone Index. + required: + - connectionId + allOf: + - $ref: "#/definitions/TargetIndex" + - type: object + properties: + connectionId: + type: string + description: The id of the connection pointing to the pinecone. + x-ms-discriminator-value: Pinecone + Purpose: + title: Purpose + description: The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. + enum: + - fine-tune + - fine-tune-results + - assistants + - assistants_output + type: string + readOnly: true + x-ms-enum: + name: Purpose + modelAsString: true + values: + - value: fine-tune + description: This file contains training data for a fine tune job. + - value: fine-tune-results + description: This file contains the results of a fine tune job. + - value: assistants + description: This file contains data to be used in assistants. + - value: assistants_output + description: This file contains the results of an assistant. + ServerlessCompute: + description: Serverless compute. + allOf: + - $ref: "#/definitions/JobCompute" + - type: object + properties: + sku: + type: string + description: SKU Level + instanceCount: + type: integer + description: The count of instances to run the job on. + x-ms-discriminator-value: ServerlessCompute + SystemComputeDatasource: + title: SystemComputeDatasource + type: object + required: + - kind + properties: + kind: + $ref: "#/definitions/SystemComputeDatasourceType" + discriminator: kind + SystemComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Storage + - Urls + x-ms-enum: + name: SystemComputeDatasourceType + modelAsString: true + values: + - name: Storage + value: Storage + description: Azure Storage Account. + - name: Urls + value: Urls + description: URLs. + SystemComputeStorage: + title: SystemComputeStorage + description: Storage account + required: + - connection + - containerName + - embeddings + x-ms-discriminator-value: Storage + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + SystemComputeUrl: + title: SystemComputeUrl + description: Urls + required: + - urls + - connection + - containerName + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/SystemComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + connection: + $ref: "#/definitions/BaseConnection" + containerName: + type: string + description: container name + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/GenericEmbeddingSettings" + TargetIndex: + title: TargetIndex + description: Information about the index to be created. + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/TargetType" + TargetType: + type: string + description: The target type. + enum: + - AzureAISearch + - CosmosDB + - Pinecone + x-ms-enum: + name: TargetType + modelAsString: true + values: + - name: AzureAISearch + value: AzureAISearch + description: Azure AI Search Index. + - name: CosmosDB + value: CosmosDB + description: CosmosDB Index. + - name: Pinecone + value: Pinecone + description: Pinecone Index. + TypeDiscriminator: + title: TypeDiscriminator + description: Defines the type of an object. + enum: + - list + - fine_tuning.job + - file + - fine_tuning.job.event + - fine_tuning.job.checkpoint + - model + - upload + - upload.part + type: string + readOnly: true + x-ms-enum: + name: TypeDiscriminator + modelAsString: true + values: + - value: list + description: This object represents a list of other objects. + - value: fine_tuning.job + description: This object represents a fine tune job. + - value: file + description: This object represents a file. + - value: fine_tuning.job.event + description: This object represents an event of a fine tuning job. + - value: fine_tuning.job.checkpoint + description: This object represents a checkpoint of a fine tuning job. + - value: model + description: This object represents a model (can be a base model or fine tune job result). + - value: upload + description: This object represents a file upload. + - value: upload.part + description: This object represents part of a file upload. + UploadFileCompleteBody: + title: UploadFileCompleteBody + required: + - part_ids + type: object + properties: + part_ids: + title: IList`1 + type: array + items: + type: string + md5: + type: string + UploadFileStartBody: + title: UploadFileStartBody + required: + - bytes + - filename + - mime_type + - purpose + type: object + properties: + purpose: + $ref: "#/definitions/Purpose" + filename: + minLength: 1 + type: string + bytes: + format: int64 + type: integer + mime_type: + minLength: 1 + type: string + UploadPartResource: + title: UploadPartResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + upload_id: + type: string + readOnly: true + azure_block_id: + type: string + readOnly: true + UploadResource: + title: UploadResource + type: object + properties: + object: + $ref: "#/definitions/TypeDiscriminator" + created_at: + format: unixtime + description: A timestamp when this job or item was created (in unix epochs). + type: integer + readOnly: true + id: + description: The identity of this item. + type: string + readOnly: true + bytes: + format: int64 + type: integer + readOnly: true + filename: + type: string + readOnly: true + purpose: + $ref: "#/definitions/Purpose" + status: + $ref: "#/definitions/UploadStatus" + expires_at: + format: unixtime + type: integer + readOnly: true + file: + $ref: "#/definitions/File" + UploadStatus: + title: UploadStatus + enum: + - pending + - expired + - completed + - cancelled + type: string + readOnly: true + UserComputeDataset: + type: object + title: UserComputeStorage + description: Storage account + required: + - datasetId + - datasetType + x-ms-discriminator-value: Dataset + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + datasetId: + type: string + datasetType: + type: string + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + UserComputeDatasource: + title: UserComputeDatasource + type: object + discriminator: kind + required: + - kind + properties: + kind: + $ref: "#/definitions/UserComputeDatasourceType" + UserComputeDatasourceType: + type: string + description: The datasource type. + enum: + - Dataset + - Urls + x-ms-enum: + name: UserComputeDatasourceType + modelAsString: true + values: + - name: Dataset + value: Dataset + description: Workspace Dataset. + - name: Urls + value: Urls + description: URLs. + UserComputeUrl: + type: object + title: UserComputeUrl + description: Urls + required: + - urls + - embeddings + x-ms-discriminator-value: Urls + allOf: + - $ref: "#/definitions/UserComputeDatasource" + - type: object + properties: + urls: + type: array + items: + type: string + crawling: + $ref: "#/definitions/CrawlingSettings" + chunking: + $ref: "#/definitions/ChunkingSettings" + embeddings: + type: array + items: + $ref: "#/definitions/WorkspaceConnectionEmbeddingSettings" + WandBIntegrationRequest: + title: WandBIntegrationRequest + required: + - project + type: object + properties: + project: + minLength: 1 + type: string + name: + type: string + readOnly: true + entity: + type: string + readOnly: true + tags: + type: array + items: + type: string + readOnly: true + WandBIntegrationRequestWrapper: + title: WandBIntegrationRequestWrapper + required: + - type + - wandb + type: object + properties: + type: + $ref: '#/definitions/IntegrationTypes' + wandb: + $ref: "#/definitions/WandBIntegrationRequest" + WorkspaceConnection: + description: AML Workspace connection. + required: + - connectionId + allOf: + - $ref: "#/definitions/BaseConnection" + - type: object + properties: + connectionId: + type: string + description: ConnectionId + x-ms-discriminator-value: WorkspaceConnection + WorkspaceConnectionEmbeddingSettings: + title: WorkspaceConnectionEmbeddingSettings + description: Connection id to the embedding model + type: object + properties: + connectionId: + type: string + deploymentName: + type: string + modelName: + type: string +parameters: + endpoint: + in: path + name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name).' + required: true + type: string + format: url + x-ms-skip-url-encoding: true + x-ms-parameter-location: client + apiVersionQueryParameter: + in: query + name: api-version + description: The requested API version. + required: true + type: string + x-ms-client-default: 2024-09-01-preview + x-ms-parameter-location: client +security: + - ApiKeyAuth: [] + - OAuth2Auth: + - https://cognitiveservices.azure.com/.default +securityDefinitions: + ApiKeyAuth: + description: API key authentication + type: apiKey + name: api-key + in: header + OAuth2Auth: + description: OAuth2 authentication + type: oauth2 + flow: implicit + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: + https://cognitiveservices.azure.com/.default: "" +schemes: + - https +x-ms-parameterized-host: + hostTemplate: "{endpoint}/openai" + useSchemePrefix: false + parameters: + - $ref: "#/parameters/endpoint" diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json new file mode 100644 index 000000000000..06e90cf421b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "cancelling", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": 1646126138, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 100, + "failed": 5 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml new file mode 100644 index 000000000000..a7b0cae7114e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: cancelling + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: 1646126138 + cancelled_at: null + request_counts: + total: 500 + completed: 100 + failed: 5 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json new file mode 100644 index 000000000000..0d7b1e196793 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "cancelled", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "finished_at": 1646127311, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml new file mode 100644 index 000000000000..f448ba97c619 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/cancel_finetuning_job.yaml @@ -0,0 +1,34 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: cancelled + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: 1646127311 + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json new file mode 100644 index 000000000000..eaedd0df71ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml new file mode 100644 index 000000000000..6c9fea14e13b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_file.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json new file mode 100644 index 000000000000..f697bbe970c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml new file mode 100644 index 000000000000..eea04bda3d68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/delete_finetuning_job.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 204: + headers: {} + body: diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json new file mode 100644 index 000000000000..ba259ef7411a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml new file mode 100644 index 000000000000..059f28a8a8e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batch.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f +responses: + "200": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json new file mode 100644 index 000000000000..23eb1bd08d70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "completed", + "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b", + "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c", + "created_at": 1646126127, + "in_progress_at": 1646126130, + "expires_at": 1646126170, + "finalizing_at": 1646126134, + "completed_at": 1646126136, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 500, + "completed": 400, + "failed": 100 + }, + "first_id": "batch_abc123", + "last_id": "batch_abc456", + "metadata": { + "batch_description": "Evaluation job" + } + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml new file mode 100644 index 000000000000..416df037a551 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_batches.yaml @@ -0,0 +1,37 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + "200": + headers: {} + body: + has_more: false + data: + - object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: completed + output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b + error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c + created_at: 1646126127 + in_progress_at: 1646126130 + expires_at: 1646126170 + finalizing_at: 1646126134 + completed_at: 1646126136 + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 500 + completed: 400 + failed: 100 + first_id: batch_abc123 + last_id: batch_abc456 + metadata: + batch_description: Evaluation job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json new file mode 100644 index 000000000000..47a68258b6d9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml new file mode 100644 index 000000000000..d11929bbc1be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json new file mode 100644 index 000000000000..36c4ed963afc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml new file mode 100644 index 000000000000..3dac90507296 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_file_content.yaml @@ -0,0 +1,9 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + file-id: file-181a1cbdcdcf4677ada87f63a0928099 +responses: + 200: + headers: {} + body: raw file content diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json new file mode 100644 index 000000000000..0ad06c2cc933 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml new file mode 100644 index 000000000000..6d102f31519c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_files.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + data: + - metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + - metadata: + bytes: 32423 + purpose: fine-tune-results + filename: results.csv + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json new file mode 100644 index 000000000000..facaa880d303 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml new file mode 100644 index 000000000000..857e3aa404b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job.yaml @@ -0,0 +1,36 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json new file mode 100644 index 000000000000..b3fa3f4728e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P", + "created_at": 1646126127, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10", + "step_number": 10, + "metrics": { + "step": 10, + "train_loss": 0.478, + "train_mean_token_accuracy": 0.924, + "valid_loss": 10.112, + "valid_mean_token_accuracy": 0.145, + "full_valid_loss": 0.567, + "full_valid_mean_token_accuracy": 0.944 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_frtXDR2453C4FG67t03MLPs5", + "created_at": 1646126137, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20", + "step_number": 20, + "metrics": { + "step": 20, + "train_loss": 0.355, + "train_mean_token_accuracy": 0.947, + "valid_loss": 11.32, + "valid_mean_token_accuracy": 0.122, + "full_valid_loss": 0.317, + "full_valid_mean_token_accuracy": 0.955 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + }, + { + "id": "ftckpt_agLk6Gio560ORp14gl123fgd", + "created_at": 1646126147, + "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30", + "step_number": 30, + "metrics": { + "step": 30, + "train_loss": 0.155, + "train_mean_token_accuracy": 0.975, + "valid_loss": 9.31, + "valid_mean_token_accuracy": 0.092, + "full_valid_loss": 0.114, + "full_valid_mean_token_accuracy": 0.963 + }, + "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f", + "object": "fine_tuning.job.checkpoint" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml new file mode 100644 index 000000000000..724c1cfe494e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_checkpoints.yaml @@ -0,0 +1,54 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P + created_at: 1646126127 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10 + stepNumber: 10 + metrics: + step: 10 + train_loss: 0.478 + train_mean_token_accuracy: 0.924 + valid_loss: 10.112 + valid_mean_token_accuracy: 0.145 + full_valid_loss: 0.567 + full_valid_mean_token_accuracy: 0.944 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_frtXDR2453C4FG67t03MLPs5 + created_at: 1646126137 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20 + stepNumber: 20 + metrics: + step: 20 + train_loss: 0.355 + train_mean_token_accuracy: 0.947 + valid_loss: 11.32 + valid_mean_token_accuracy: 0.122 + full_valid_loss: 0.317 + full_valid_mean_token_accuracy: 0.955 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + - id: ftckpt_agLk6Gio560ORp14gl123fgd + created_at: 1646126147 + fineTunedModelCheckpoint: gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30 + stepNumber: 30 + metrics: + step: 30 + train_loss: 0.155 + train_mean_token_accuracy: 0.975 + valid_loss: 9.31 + valid_mean_token_accuracy: 0.092 + full_valid_loss: 0.114 + full_valid_mean_token_accuracy: 0.963 + fineTuningJobId: ftjob-72a2792ef7d24ba7b82c7fe4a37e379f + object: fine_tuning.job.checkpoint + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json new file mode 100644 index 000000000000..582aebd35d81 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05", + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f", + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "type": "message", + "object": "fine_tuning.job.event" + }, + { + "id": "ftevent-2d47d651d2f3484c8187c88c00078147", + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "type": "message", + "object": "fine_tuning.job.event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml new file mode 100644 index 000000000000..c8c894d808f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_job_events.yaml @@ -0,0 +1,33 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + has_more: false + data: + - id: ftevent-363dcd7cb4c74539bc53293c1dceef05 + created_at: 1646126127 + level: Info + message: Job enqueued. Waiting for jobs ahead to complete. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-8c2a44999790437cb3230e543fa2cf0f + created_at: 1646126169 + level: Info + message: Job started. + type: message + data: + object: fine_tuning.job.event + - id: ftevent-2d47d651d2f3484c8187c88c00078147 + created_at: 1646126192 + level: Info + message: Job succeeded. + type: message + data: + object: fine_tuning.job.event + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json new file mode 100644 index 000000000000..d83f41d8ecf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "has_more": false, + "data": [ + { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "succeeded", + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "result_files": [ + "file-181a1cbdcdcf4677ada87f63a0928099" + ], + "finished_at": 1646127311, + "trained_tokens": 2342, + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml new file mode 100644 index 000000000000..2a36bddb5ab7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_finetuning_jobs.yaml @@ -0,0 +1,38 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + has_more: false + data: + - hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: succeeded + model: curie + fine_tuned_model: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + - file-181a1cbdcdcf4677ada87f63a0928099 + finished_at: 1646127311 + organisation_id: + trained_tokens: 2342 + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json new file mode 100644 index 000000000000..2603849d78fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml new file mode 100644 index 000000000000..f83bd13a9172 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job +responses: + "200": + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json new file mode 100644 index 000000000000..cf2a9c7f6b30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "run-id": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b" + }, + "responses": { + "200": { + "body": { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running", + "progress": { + "stageProgress": [ + { + "name": "Preprocessing", + "totalItems": 14, + "processedItems": 0, + "state": "notRunning" + }, + { + "name": "Indexing", + "state": "notRunning" + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml new file mode 100644 index 000000000000..2ffcd8afe183 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_ingestion_job_run.yaml @@ -0,0 +1,18 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + run-id: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b +responses: + "200": + body: + jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running + progress: + stageProgress: + - name: Preprocessing + totalItems: 14 + processedItems: 0 + state: notRunning + - name: Indexing + state: notRunning diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json new file mode 100644 index 000000000000..86b4b72c70b0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml new file mode 100644 index 000000000000..1aac487f7eb7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_base.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + model-id: curie +responses: + 200: + headers: {} + body: + status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json new file mode 100644 index 000000000000..482e68e36a8c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml new file mode 100644 index 000000000000..81333da2bad3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_model_finetune.yaml @@ -0,0 +1,24 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + model-id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json new file mode 100644 index 000000000000..671fa6afea1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "status": "succeeded", + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "created_at": 1646126127, + "object": "model" + }, + { + "status": "succeeded", + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml new file mode 100644 index 000000000000..56a0bb3fc881 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/get_models.yaml @@ -0,0 +1,41 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview +responses: + 200: + headers: {} + body: + data: + - status: succeeded + model: + fine_tune: + capabilities: + fine_tune: true + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + fine_tune: 1677662127 + inference: 1709284527 + id: curie + created_at: 1646126127 + object: model + - status: succeeded + model: curie + fine_tune: ft-72a2792ef7d24ba7b82c7fe4a37e379f + capabilities: + fine_tune: false + inference: true + completion: true + chat_completion: false + embeddings: false + lifecycle_status: generally-available + deprecation: + inference: 1709284527 + id: curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: model + object: list diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json new file mode 100644 index 000000000000..a83f15a12134 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml new file mode 100644 index 000000000000..07630887e468 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/import_file.yaml @@ -0,0 +1,47 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + fileImport: + purpose: fine-tune + filename: puppy.jsonl + content_url: &o0 + absolutePath: /trainingdata/puppy.jsonl + absoluteUri: *o0 + localPath: /trainingdata/puppy.jsonl + authority: www.contoso.com + hostNameType: Dns + isDefaultPort: true + isFile: false + isLoopback: false + pathAndQuery: /trainingdata/puppy.jsonl + segments: + - / + - trainingdata/ + - puppy.jsonl + isUnc: false + host: www.contoso.com + port: 443 + query: "" + fragment: "" + scheme: https + originalString: *o0 + dnsSafeHost: www.contoso.com + idnHost: www.contoso.com + isAbsoluteUri: true + userEscaped: false + userInfo: "" + metadata: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json new file mode 100644 index 000000000000..f0ac20f776b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "ingestion-job", + "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036", + "status": "succeeded" + }, + { + "jobId": "ingestion-job", + "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd", + "status": "failed" + }, + { + "jobId": "ingestion-job", + "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b", + "status": "running" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml new file mode 100644 index 000000000000..9b66890ac1be --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_job_runs.yaml @@ -0,0 +1,16 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job +responses: + "200": + body: + value: + - jobId: ingestion-job + runId: f375b912-331c-4fc5-8e9f-2d7205e3e036 + status: succeeded + - jobId: ingestion-job + runId: 07f2d192-add7-4202-a2e3-858c2577f4fd + status: failed + - jobId: ingestion-job + runId: 5ef7a436-1147-4cbb-82e0-3d502bcc6a7b + status: running diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json new file mode 100644 index 000000000000..64f44cf47118 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "usercompute-ingestion-job", + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev" + }, + { + "jobId": "syscompute-ingestion-job", + "kind": "SystemCompute" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml new file mode 100644 index 000000000000..4450f0a260e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/list_ingestion_jobs.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2024-09-01-preview +responses: + "200": + body: + value: + - jobId: usercompute-ingestion-job + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + - jobId: syscompute-ingestion-job + kind: SystemCompute diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json new file mode 100644 index 000000000000..c5374beff4b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "batchCreateRequest": { + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "endpoint": "/chat/completions", + "completion_window": "24h", + "metadata": { + "batch_description": "Evaluation job" + } + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "object": "batch", + "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f", + "endpoint": "/chat/completions", + "errors": null, + "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f", + "completion_window": "24h", + "status": "validating", + "output_file_id": null, + "error_file_id": null, + "created_at": 1646126127, + "in_progress_at": null, + "expires_at": null, + "finalizing_at": null, + "completed_at": null, + "failed_at": null, + "expired_at": null, + "cancelling_at": null, + "cancelled_at": null, + "request_counts": { + "total": 0, + "completed": 0, + "failed": 0 + }, + "metadata": { + "batch_description": "Evaluation job" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml new file mode 100644 index 000000000000..198c171c71fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_batch.yaml @@ -0,0 +1,39 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + batchCreateRequest: + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + endpoint: /chat/completions + completion_window: 24h + metadata: + batch_description: Evaluation job + content-Type: application/json +responses: + "201": + headers: {} + body: + object: batch + id: batch_72a2792ef7d24ba7b82c7fe4a37e379f + endpoint: /chat/completions + errors: null + input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f + completion_window: 24h + status: validating + output_file_id: null + error_file_id: null + created_at: 1646126127 + in_progress_at: null + expires_at: null + finalizing_at: null + completed_at: null + failed_at: null + expired_at: null + cancelling_at: null + cancelled_at: null + request_counts: + total: 0 + completed: 0 + failed: 0 + metadata: + batch_description: Evaluation job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json new file mode 100644 index 000000000000..5f5bb21b38bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "fineTuningJob": { + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparameters": { + "n_epochs": -1 + }, + "integrations": [ + { + "type": "wandb", + "wandb": { + "project": "custom-wandb-project", + "tags": [ + "project:tag", + "lineage" + ] + } + } + ], + "status": "pending", + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099", + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "fine_tuning.job" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml new file mode 100644 index 000000000000..0308fd74e3e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/post_finetuning_job.yaml @@ -0,0 +1,51 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: '{api key}' + api-version: 2024-09-01-preview + fineTuningJob: + hyperparameters: + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + model: curie + trainingFile: file-181a1cbdcdcf4677ada87f63a0928099 + validationFile: + Content-Type: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f + body: + hyperparameters: + n_epochs: -1 + suffix: + seed: + integrations: + - type: wandb + wandb: + project: custom-wandb-project + name: + entity: + tags: + - project:tag + - lineage + status: pending + model: curie + fine_tuned_model: + training_file: file-181a1cbdcdcf4677ada87f63a0928099 + validation_file: + result_files: + finished_at: + organisation_id: + error: + id: ft-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: fine_tuning.job diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json new file mode 100644 index 000000000000..d28580c00aeb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "SystemCompute", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview" + }, + "body": { + "kind": "SystemCompute", + "jobId": "ingestion-job", + "searchServiceConnection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://aykame-dev-search.search.windows.net" + }, + "datasource": { + "kind": "Storage", + "connection": { + "kind": "EndpointWithManagedIdentity", + "endpoint": "https://mystorage.blob.core.windows.net/", + "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage" + }, + "containerName": "container", + "chunking": { + "maxChunkSizeInTokens": 2048 + }, + "embeddings": [ + { + "connection": { + "kind": "RelativeConnection" + }, + "deploymentName": "Ada" + } + ] + }, + "dataRefreshIntervalInHours": 24, + "completionAction": "keepAllAssets" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml new file mode 100644 index 000000000000..541bf997ba38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_sc.yaml @@ -0,0 +1,51 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + ingestionJob: + kind: SystemCompute + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview + body: + kind: SystemCompute + jobId: ingestion-job + searchServiceConnection: + kind: EndpointWithManagedIdentity + endpoint: "https://aykame-dev-search.search.windows.net" + datasource: + kind: Storage + connection: + kind: EndpointWithManagedIdentity + endpoint: "https://mystorage.blob.core.windows.net/" + resourceId: >- + /subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage + containerName: container + chunking: + maxChunkSizeInTokens: 2048 + embeddings: + - connection: + kind: RelativeConnection + deploymentName: Ada + dataRefreshIntervalInHours: 24 + completionAction: keepAllAssets diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json new file mode 100644 index 000000000000..4f600fd25b93 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview", + "job-id": "ingestion-job", + "ingestionJob": { + "kind": "UserCompute", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + }, + "responses": { + "200": { + "headers": { + "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview" + }, + "body": { + "kind": "UserCompute", + "jobId": "ingestion-job", + "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev", + "compute": { + "kind": "ServerlessCompute" + }, + "target": { + "kind": "AzureAISearch", + "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection" + }, + "datasource": { + "kind": "Dataset", + "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1", + "datasetType": "uri_folder" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml new file mode 100644 index 000000000000..26ee8911164e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/put_ingestion_job_uc.yaml @@ -0,0 +1,39 @@ +parameters: + api-version: 2024-09-01-preview + job-id: ingestion-job + ingestionJob: + kind: UserCompute + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder +responses: + "200": + headers: + operation-location: >- + https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2024-09-01-preview + body: + kind: UserCompute + jobId: ingestion-job + workspaceId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev + compute: + kind: ServerlessCompute + target: + kind: AzureAISearch + connectionId: >- + /subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection + datasource: + kind: Dataset + datasetId: >- + azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1 + datasetType: uri_folder diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json new file mode 100644 index 000000000000..fcd9e4b3e83f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml new file mode 100644 index 000000000000..adae7e4c1046 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file.yaml @@ -0,0 +1,19 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + purpose: fine-tune + Content-Type: multipart/form-data + file: raw file content +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099 + body: + metadata: + bytes: + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json new file mode 100644 index 000000000000..3e415bc1e4fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "cancelled", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml new file mode 100644 index 000000000000..fb0c72d1f816 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_cancel.yaml @@ -0,0 +1,25 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: cancelled + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json new file mode 100644 index 000000000000..192e0010133d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "body": { + "part_ids": [ + "LnmictL3p0u4LH/ko343nw==", + "LmmictL3p0u4LH/ko343nw==" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "completed", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml new file mode 100644 index 000000000000..6ab4ff431542 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_complete.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + part_ids: + - LnmictL3p0u4LH/ko343nw== + - LmmictL3p0u4LH/ko343nw== + md5: +responses: + 200: + headers: {} + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: completed + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json new file mode 100644 index 000000000000..a7c32b757f02 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "upload-id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "data": "raw file content", + "content-Type": "multipart/form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "azure_block_id": "LnmictL3p0u4LH/ko343nw==", + "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload.part" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml new file mode 100644 index 000000000000..a8d9603206d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_part.yaml @@ -0,0 +1,16 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + upload-id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + data: raw file content + Content-Type: multipart/form-data +responses: + 200: + headers: {} + body: + upload_id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + azure_block_id: LnmictL3p0u4LH/ko343nw== + id: uplprt-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload.part diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json new file mode 100644 index 000000000000..238249f7eabe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2024-09-01-preview", + "body": { + "purpose": "fine-tune", + "filename": "training_data_v21.jsonl", + "bytes": 2097152, + "mime_type": "application/json" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "bytes": 2097152, + "filename": "training_data_v21.jsonl", + "purpose": "fine-tune", + "status": "pending", + "expires_at": 1646133327, + "file": { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "created_at": 1646126127, + "object": "file" + }, + "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f", + "created_at": 1646126127, + "object": "upload" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml new file mode 100644 index 000000000000..e15117542a5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-09-01-preview/examples/upload_file_start.yaml @@ -0,0 +1,30 @@ +parameters: + endpoint: https://aoairesource.openai.azure.com + api-key: "{api key}" + api-version: 2024-09-01-preview + body: + purpose: fine-tune + filename: training_data_v21.jsonl + bytes: 2097152 + mimeType: application/json +responses: + 201: + headers: + Location: https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + body: + bytes: 2097152 + filename: training_data_v21.jsonl + purpose: fine-tune + status: pending + expires_at: 1646133327 + file: + metadata: + bytes: 140 + purpose: fine-tune + filename: puppy.jsonl + id: file-181a1cbdcdcf4677ada87f63a0928099 + created_at: 1646126127 + object: file + id: fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f + created_at: 1646126127 + object: upload diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index f946c4a17c65..97104e711bdc 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -349,3 +349,44 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + +## AzureOpenAI 2024-08-01-preview +These settings apply only when `--tag=release_2024_08_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_08_01_preview' +input-file: preview/2024-08-01-preview/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` + + +## AzureOpenAI 2024-09-01-preview +These settings apply only when `--tag=release_2024_09_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_09_01_preview' +input-file: preview/2024-09-01-preview/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json new file mode 100644 index 000000000000..a221dfb9d07d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.json @@ -0,0 +1,18 @@ +{ + "title": "Synthesizes audio from the provided text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "input": "Hi! What are you going to make?", + "voice": "fable", + "response_format": "mp3" + } + }, + "responses": { + "200": { + "body": "101010101" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml new file mode 100644 index 000000000000..6b1838089f61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_speech.yaml @@ -0,0 +1,12 @@ +parameters: + api-version: 2024-09-01-preview + body: + input: Hi! What are you going to make? + response_format: mp3 + voice: fable + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: "101010101" +title: Synthesizes audio from the provided text. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json new file mode 100644 index 000000000000..69160f691d40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml new file mode 100644 index 000000000000..4f951e1ea432 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_object.yaml @@ -0,0 +1,9 @@ +parameters: + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json new file mode 100644 index 000000000000..7ba01e8f58e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml new file mode 100644 index 000000000000..36014d364055 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_transcription_text.yaml @@ -0,0 +1,19 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: Gets transcribed text and associated metadata from provided spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json new file mode 100644 index 000000000000..f45df5a88426 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.json @@ -0,0 +1,16 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml new file mode 100644 index 000000000000..43b372977f87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_object.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + body: + text: A structured object when requesting json or verbose_json +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json new file mode 100644 index 000000000000..f4f07daf3b09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.json @@ -0,0 +1,15 @@ +{ + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--" + }, + "responses": { + "200": { + "type": "string", + "example": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml new file mode 100644 index 000000000000..6420a78a029c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/audio_translation_text.yaml @@ -0,0 +1,21 @@ +parameters: + api-version: 2024-09-01-preview + body: '---multipart-boundary + + Content-Disposition: form-data; name="file"; filename="file.wav" + + Content-Type: application/octet-stream + + + RIFF..audio.data.omitted + + ---multipart-boundary--' + deployment-id: <deployment-id> + endpoint: "{endpoint}" +responses: + "200": + example: plain text when requesting text, srt, or vtt + type: string +title: + Gets English language transcribed text and associated metadata from provided + spoken audio data. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json new file mode 100644 index 000000000000..93d353499279 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.json @@ -0,0 +1,46 @@ +{ + "title": "Cancels a run that is `in_progress`.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076126, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "cancelling", + "started_at": 1699076126, + "expires_at": 1699076726, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You summarize books.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [ + "vs_123" + ] + } + }, + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml new file mode 100644 index 000000000000..9d04a369faaf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_run.yaml @@ -0,0 +1,35 @@ +title: | + Cancels a run that is `in_progress`. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076126 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: cancelling + started_at: 1699076126 + expires_at: 1699076726 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: You summarize books. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: + - vs_123 + metadata: {} + usage: null + temperature: 1 + top_p: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json new file mode 100644 index 000000000000..f0227f1667c0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "cancelling", + "file_counts": { + "in_progress": 12, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 15 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml new file mode 100644 index 000000000000..d08cc5ccb9e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/cancel_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: cancelling + file_counts: + in_progress: 12 + completed: 3 + failed: 0 + cancelled: 0 + total: 15 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json new file mode 100644 index 000000000000..39307e5a4d61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.json @@ -0,0 +1,43 @@ +{ + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml new file mode 100644 index 000000000000..85de47e7dd33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions.yaml @@ -0,0 +1,45 @@ +title: Creates a completion for the provided prompt, parameters and chosen model. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: system + content: you are a helpful assistant that talks like a pirate + - role: user + content: can you tell me how to care for a parrot? +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: |- + Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy: + + 1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr! + + 2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh! + + 3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands! + + 4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh! + + 5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr! + + 6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag! + + 7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be. + + 8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners. + + So there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' "Yo-ho-ho" for many years to come! Good luck, sailor, and may the wind be at yer back! + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..f765e5a468d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.json @@ -0,0 +1,96 @@ +{ + "title": "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a cat?" + }, + { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "intent": "cat care" + } + }, + { + "role": "user", + "content": "how about dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content 2.", + "title": "Citation Title 2", + "filepath": "contoso2.txt", + "url": "https://contoso.blob.windows.net/container/contoso2.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml new file mode 100644 index 000000000000..1bc8bcc445cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_advanced.yaml @@ -0,0 +1,63 @@ +title: Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a cat? + - role: assistant + content: Content of the completion [doc1]. + context: + intent: cat care + - role: user + content: how about dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + authentication: + type: user_assigned_managed_identity + managed_identity_resource_id: /subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name} + index_name: "{index name}" + query_type: vector + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + in_scope: true + top_n_documents: 5 + strictness: 3 + role_information: You are an AI assistant that helps people find information. + fields_mapping: + content_fields_separator: \n + content_fields: + - content + filepath_field: filepath + title_field: title + url_field: url + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content 2. + title: Citation Title 2 + filepath: contoso2.txt + url: https://contoso.blob.windows.net/container/contoso2.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..ca5d71a0f222 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.json @@ -0,0 +1,58 @@ +{ + "title": "Creates a completion based on Azure Search image vector data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + }, + "authentication": { + "type": "api_key", + "key": "{api key}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion." + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml new file mode 100644 index 000000000000..e57b8737b194 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_image_vector.yaml @@ -0,0 +1,36 @@ +title: Creates a completion based on Azure Search image vector data. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + query_type: vector + fields_mapping: + image_vector_fields: + - image_vector + authentication: + type: api_key + key: "{api key}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion. + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..b4a93aa803dc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.json @@ -0,0 +1,63 @@ +{ + "title": "Creates a completion based on Azure Search data and system-assigned managed identity.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "authentication": { + "type": "system_assigned_managed_identity" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml new file mode 100644 index 000000000000..c11f7641c5bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_azure_search_minimum.yaml @@ -0,0 +1,39 @@ +title: Creates a completion based on Azure Search data and system-assigned managed identity. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_search + parameters: + endpoint: https://your-search-endpoint.search.windows.net/ + index_name: "{index name}" + authentication: + type: system_assigned_managed_identity +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json new file mode 100644 index 000000000000..782d5c005578 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Azure Cosmos DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml new file mode 100644 index 000000000000..8db15e42d918 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_cosmos_db.yaml @@ -0,0 +1,49 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: azure_cosmos_db + parameters: + authentication: + type: connection_string + connection_string: mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000 + database_name: vectordb + container_name: azuredocs + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json new file mode 100644 index 000000000000..0599afa0e10b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.json @@ -0,0 +1,65 @@ +{ + "title": "Creates a completion for the provided Elasticsearch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml new file mode 100644 index 000000000000..8bbf671e3349 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_elasticsearch.yaml @@ -0,0 +1,41 @@ +title: Creates a completion for the provided Elasticsearch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: elasticsearch + parameters: + endpoint: https://your-elasticsearch-endpoint.eastus.azurecontainer.io + index_name: "{index name}" + authentication: + type: key_and_key_id + key: "{key}" + key_id: "{key id}" +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json new file mode 100644 index 000000000000..9b68418a4602 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.json @@ -0,0 +1,80 @@ +{ + "title": "Creates a completion for the provided Mongo DB.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "mongo_db", + "parameters": { + "authentication": { + "type": "username_and_password", + "username": "<username>", + "password": "<password>" + }, + "endpoint": "<endpoint_name>", + "app_name": "<application name>", + "database_name": "sampledb", + "collection_name": "samplecollection", + "index_name": "sampleindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml new file mode 100644 index 000000000000..de0316d20c32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_mongo_db.yaml @@ -0,0 +1,52 @@ +title: Creates a completion for the provided Azure Cosmos DB. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: mongo_db + parameters: + authentication: + type: username_and_password + username: <username> + password: <password> + endpoint: <endpoint_name> + app_name: <application name> + database_name: sampledb + collection_name: samplecollection + index_name: azuredocindex + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + content_fields: + - content + vector_fields: + - contentvector +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json new file mode 100644 index 000000000000..eae9d2f987b4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.json @@ -0,0 +1,77 @@ +{ + "title": "Creates a completion for the provided Pinecone resource.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a dog?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Content of the completion [doc1].", + "context": { + "citations": [ + { + "content": "Citation content.", + "title": "Citation Title", + "filepath": "contoso.txt", + "url": "https://contoso.blob.windows.net/container/contoso.txt", + "chunk_id": "0" + } + ], + "intent": "dog care" + } + } + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml new file mode 100644 index 000000000000..f23fdc61cc7a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/chat_completions_pinecone.yaml @@ -0,0 +1,51 @@ +title: Creates a completion for the provided Pinecone resource. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: <deployment-id> + body: + messages: + - role: user + content: can you tell me how to care for a dog? + data_sources: + - type: pinecone + parameters: + authentication: + type: api_key + key: "{api key}" + environment: "{environment name}" + index_name: "{index name}" + embedding_dependency: + type: deployment_name + deployment_name: "{embedding deployment name}" + fields_mapping: + title_field: title + url_field: url + filepath_field: filepath + content_fields: + - content + content_fields_separator: |+ + +responses: + "200": + body: + id: chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn + created: 1686676106 + choices: + - index: 0 + finish_reason: stop + message: + role: assistant + content: Content of the completion [doc1]. + context: + citations: + - content: Citation content. + title: Citation Title + filepath: contoso.txt + url: https://contoso.blob.windows.net/container/contoso.txt + chunk_id: "0" + intent: dog care + usage: + completion_tokens: 557 + prompt_tokens: 33 + total_tokens: 590 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json new file mode 100644 index 000000000000..172e3e75914c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json new file mode 100644 index 000000000000..35a5010c75cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.json @@ -0,0 +1,39 @@ +{ + "title": "Create an assistant with a model and instructions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "body": { + "name": "Math Tutor", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "model": "gpt-4-1106-preview" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant", + "created_at": 1707295707, + "name": "Math Tutor", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml new file mode 100644 index 000000000000..56b1e0710802 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_assistant.yaml @@ -0,0 +1,26 @@ +title: Create an assistant with a model and instructions. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + body: + name: Math Tutor + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + model: gpt-4-1106-preview +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant + created_at: 1707295707 + name: Math Tutor + description: null + model: gpt-4-1106-preview + instructions: When a customer asks about a specific math problem, use Python to evaluate their query. + tools: + - type: code_interpreter + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json new file mode 100644 index 000000000000..5eae7c600986 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.json @@ -0,0 +1,36 @@ +{ + "title": "Create a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "role": "user", + "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces." + } + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "assistant_id": null, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml new file mode 100644 index 000000000000..b0c285823053 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_message.yaml @@ -0,0 +1,25 @@ +title: Create a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + role: user + content: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + assistant_id: null + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + run_id: null + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json new file mode 100644 index 000000000000..51832c964c5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.json @@ -0,0 +1,49 @@ +{ + "title": "Create a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "body": { + "assistant_id": "asst_abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml new file mode 100644 index 000000000000..e2ed5925c8fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_run.yaml @@ -0,0 +1,38 @@ +title: Create a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + body: + assistant_id: asst_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json new file mode 100644 index 000000000000..8ac7dd7f5f4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Creates a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml new file mode 100644 index 000000000000..c2c590df98e8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread.yaml @@ -0,0 +1,11 @@ +title: Creates a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json new file mode 100644 index 000000000000..ed6dbfcdac95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.json @@ -0,0 +1,54 @@ +{ + "title": "Create a thread and run it in one request.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "body": { + "assistant_id": "asst_abc123", + "thread": { + "messages": [ + { + "role": "user", + "content": "Explain deep learning to a 5 year old." + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699076792, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "queued", + "started_at": null, + "expires_at": 1699077392, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "required_action": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant.", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "temperature": 1.0, + "top_p": 1.0, + "max_completion_tokens": null, + "max_prompt_tokens": null, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "incomplete_details": null, + "usage": null, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml new file mode 100644 index 000000000000..9c87c3103b4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_thread_and_run.yaml @@ -0,0 +1,42 @@ +title: Create a thread and run it in one request. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + body: + assistant_id: asst_abc123 + thread: + messages: + - role: user + content: Explain deep learning to a 5 year old. +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699076792 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: queued + started_at: null + expires_at: 1699077392 + cancelled_at: null + failed_at: null + completed_at: null + required_action: null + last_error: null + model: gpt-4-turbo + instructions: You are a helpful assistant. + tools: [] + tool_resources: {} + metadata: {} + temperature: 1 + top_p: 1 + max_completion_tokens: null + max_prompt_tokens: null + truncation_strategy: + type: auto + last_messages: null + incomplete_details: null + usage: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json new file mode 100644 index 000000000000..9536d5d35e5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.json @@ -0,0 +1,28 @@ +{ + "title": "Creates a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "body": { + "name": "Support FAQ" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml new file mode 100644 index 000000000000..dd05ea8ef7bb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store.yaml @@ -0,0 +1,20 @@ +title: Creates a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview +body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json new file mode 100644 index 000000000000..7714990c5427 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.json @@ -0,0 +1,24 @@ +{ + "title": "Create a vector store file by attaching a File to a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_id": "file-abc123" + } + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "usage_bytes": 1234, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml new file mode 100644 index 000000000000..428a67027d7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file.yaml @@ -0,0 +1,17 @@ +title: Create a vector store file by attaching a File to a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + usage_bytes: 1234 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json new file mode 100644 index 000000000000..1fc5b139ef15 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.json @@ -0,0 +1,30 @@ +{ + "title": "Create a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "responses": { + "200": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml new file mode 100644 index 000000000000..e426327e81f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/create_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Create a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + file_ids: + - file-abc123 + - file-abc456 +responses: + "200": + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json new file mode 100644 index 000000000000..a9dca4a44596 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_4nsG2qgNzimRPE7MazXTXbU7" + }, + "responses": { + "200": { + "body": { + "id": "asst_4nsG2qgNzimRPE7MazXTXbU7", + "object": "assistant.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml new file mode 100644 index 000000000000..132248140a66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant.yaml @@ -0,0 +1,11 @@ +title: Deletes an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_4nsG2qgNzimRPE7MazXTXbU7 +responses: + "200": + body: + id: asst_4nsG2qgNzimRPE7MazXTXbU7 + object: assistant.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json new file mode 100644 index 000000000000..2b1f26c90adb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml new file mode 100644 index 000000000000..3591f15eb295 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_assistant_file.yaml @@ -0,0 +1,12 @@ +title: Deletes an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json new file mode 100644 index 000000000000..b181429b000c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.json @@ -0,0 +1,18 @@ +{ + "title": "Deletes a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml new file mode 100644 index 000000000000..abfb0cd7d0fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_message.yaml @@ -0,0 +1,12 @@ +title: Deletes a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json new file mode 100644 index 000000000000..bc92b99f37fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml new file mode 100644 index 000000000000..461e16ba52eb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_thread.yaml @@ -0,0 +1,11 @@ +title: Deletes a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json new file mode 100644 index 000000000000..3b74d2e2cf8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Deletes a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123 " + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml new file mode 100644 index 000000000000..c086c5296c97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store.yaml @@ -0,0 +1,11 @@ +title: Deletes a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: "vs_abc123 " +responses: + "200": + body: + id: vs_abc123 + object: vector_store.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json new file mode 100644 index 000000000000..d6ca3ba89746 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.json @@ -0,0 +1,18 @@ +{ + "title": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file_abc123", + "object": "vector_store.file.deleted", + "deleted": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml new file mode 100644 index 000000000000..c33582ba3789 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/delete_vector_store_file.yaml @@ -0,0 +1,12 @@ +title: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file_abc123 + object: vector_store.file.deleted + deleted: true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json new file mode 100644 index 000000000000..8f130c7d218e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.json @@ -0,0 +1,1566 @@ +{ + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml new file mode 100644 index 000000000000..b76897d64de0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/embeddings.yaml @@ -0,0 +1,1553 @@ +title: Return the embeddings for a given prompt. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + deployment-id: deployment-afa0669ca01e4693ae3a93baf40f26d6 + body: + input: + - this is a test +responses: + "200": + body: + data: + - index: 0 + embedding: + - -0.012838088 + - -0.007421397 + - -0.017617522 + - -0.028278312 + - -0.018666342 + - 0.01737855 + - -0.01821495 + - -0.006950092 + - -0.009937238 + - -0.038580645 + - 0.010674067 + - 0.02412286 + - -0.013647936 + - 0.013189907 + - 0.0021125758 + - 0.012406612 + - 0.020790534 + - 0.00074595667 + - 0.008397198 + - -0.00535031 + - 0.008968075 + - 0.014351576 + - -0.014086051 + - 0.015055214 + - -0.022211088 + - -0.025198232 + - 0.0065186154 + - -0.036350243 + - 0.009180495 + - -0.009698266 + - 0.009446018 + - -0.008463579 + - -0.0040426035 + - -0.03443847 + - -0.00091273896 + - -0.0019217303 + - 0.002349888 + - -0.021560553 + - 0.016515596 + - -0.015572986 + - 0.0038666942 + - -8.432463e-05 + - 0.0032178196 + - -0.020365695 + - -0.009631885 + - -0.007647093 + - 0.0033837722 + - -0.026764825 + - -0.010501476 + - 0.020219658 + - 0.024640633 + - -0.0066912062 + - -0.036456455 + - -0.0040923897 + - -0.013966565 + - 0.017816665 + - 0.005366905 + - 0.022835068 + - 0.0103488 + - -0.0010811808 + - -0.028942121 + - 0.0074280356 + - -0.017033368 + - 0.0074877786 + - 0.021640211 + - 0.002499245 + - 0.013316032 + - 0.0021524043 + - 0.010129742 + - 0.0054731146 + - 0.03143805 + - 0.014856071 + - 0.0023366117 + - -0.0008243692 + - 0.022781964 + - 0.003038591 + - -0.017617522 + - 0.0013309394 + - 0.0022154662 + - 0.00097414135 + - 0.012041516 + - -0.027906578 + - -0.023817508 + - 0.013302756 + - -0.003003741 + - -0.006890349 + - 0.0016744611 + - 0.023658194 + - -0.015851786 + - -0.0045305043 + - -0.003038591 + - 0.017710455 + - 0.019237218 + - 0.016037652 + - -0.022503164 + - 0.025795663 + - -0.001129307 + - 0.032500144 + - -0.008178141 + - -0.019940857 + - -0.009877495 + - 0.00018918588 + - 0.023060765 + - -0.005692172 + - -0.018347712 + - -0.011039163 + - -0.0062066247 + - -5.24047e-05 + - 0.020126723 + - -0.0011691356 + - -0.015811957 + - 0.020086896 + - -0.009114114 + - -0.03056182 + - 0.0029025099 + - -0.006591635 + - -0.014046223 + - -0.01590489 + - -0.02307404 + - -0.008861865 + - -0.004832538 + - 0.010030171 + - 0.02311387 + - -0.012652221 + - 0.024906157 + - 0.003860056 + - -0.01936998 + - -0.02957938 + - -0.008357369 + - -0.0016371218 + - 0.027800368 + - 0.0077333883 + - 0.021626934 + - 0.02140124 + - -0.030482162 + - 0.026406368 + - -0.008277712 + - 0.012884554 + - -0.043784916 + - -0.0145639945 + - -0.0070297495 + - 0.034889862 + - -0.00041508878 + - -0.010528029 + - -0.009572142 + - 0.015692472 + - 0.037810627 + - -0.0022021902 + - 0.008662722 + - -0.016794397 + - 0.0003090866 + - -0.0060506295 + - 0.015227805 + - 0.0006650548 + - 0.01842737 + - 0.036801632 + - -0.002461076 + - -0.0029390194 + - -0.0057120863 + - -0.012486269 + - -0.0046831807 + - -0.0017474802 + - -0.0036210844 + - -0.01178263 + - 0.017869769 + - 0.039111692 + - 0.010946229 + - 0.018467197 + - 0.0027780454 + - -0.005851486 + - -0.016489044 + - 0.03186289 + - -0.040333103 + - 0.016648358 + - -0.006870435 + - 0.0072687212 + - 2.370982e-06 + - 0.006465511 + - -0.018201673 + - -0.00020526254 + - -0.025410652 + - 0.02010017 + - 0.017537864 + - 0.022821793 + - 0.0064555537 + - -0.0012969191 + - 0.02157383 + - -0.0053536287 + - -0.0087622935 + - -0.010952868 + - 0.017564416 + - 0.02185263 + - 0.0004733796 + - 0.0018337755 + - -0.6954606 + - -0.011231667 + - 0.02748174 + - 0.003929756 + - 0.0144843375 + - 0.045192193 + - 0.01898497 + - -0.0070363875 + - -0.007813046 + - 0.017604245 + - -0.017790113 + - 0.011165286 + - -0.0036376796 + - -0.014736585 + - 0.0016421003 + - -0.019144284 + - -0.0072222543 + - -0.023127146 + - 0.006936816 + - 0.025198232 + - 0.0030219958 + - 0.011722887 + - -0.004271618 + - -0.0011127117 + - -0.0051047 + - 0.00077333883 + - 0.018599961 + - 0.0074877786 + - 0.010820106 + - 0.0033406245 + - -0.015055214 + - 0.02384406 + - 0.006090458 + - 0.00891497 + - 0.023366116 + - -0.011078991 + - -0.019582398 + - 0.0011566891 + - 0.015413672 + - 0.01793615 + - -0.014736585 + - 0.002492607 + - 0.027800368 + - 0.023923717 + - -0.007421397 + - 0.0016105693 + - 0.011337877 + - -0.015041938 + - -0.008768932 + - -0.003982861 + - 0.002884255 + - -0.007832959 + - 0.0025457118 + - -0.0023548664 + - -0.0061767534 + - -0.016754568 + - 0.0006036523 + - 0.0105346665 + - 0.0055361767 + - 0.01478969 + - -0.0011251582 + - 0.009605332 + - -0.0037140178 + - -0.017537864 + - -0.021733144 + - 0.012897831 + - -0.024481317 + - 0.022290744 + - 0.0056523434 + - -0.005366905 + - 0.0020412162 + - 0.013435517 + - -0.003408665 + - -0.01705992 + - 0.029446619 + - 0.022011945 + - 0.009226961 + - -0.003310753 + - -0.007939169 + - 0.021308305 + - 0.0026718357 + - 0.002129171 + - -0.020047067 + - -0.007474502 + - 0.021534001 + - -0.0110590765 + - -0.018374264 + - -0.001664504 + - -0.003923118 + - 0.015387119 + - 0.025516862 + - 0.0016421003 + - -0.017498035 + - -0.01825478 + - 0.01451089 + - -0.008198055 + - -0.011656506 + - 0.0044242945 + - 0.031491153 + - 0.01017621 + - -0.010408543 + - -0.009034456 + - -0.0023283141 + - 0.012021601 + - 0.015639367 + - 0.011736163 + - 0.007912617 + - 0.02031259 + - 0.022104878 + - -0.02241023 + - 0.00041156227 + - -0.009817752 + - -0.030880447 + - -0.0017823302 + - 0.0030933553 + - -0.04128899 + - -0.0007783174 + - 0.012393335 + - 0.0122273825 + - -0.009087561 + - 0.022728859 + - -0.002884255 + - 0.028065892 + - 0.0047396044 + - 0.008065294 + - 0.015519881 + - 0.0133956885 + - -0.02279524 + - -0.011729525 + - 0.0037206558 + - -0.0046732235 + - 0.003587894 + - 0.024401661 + - -0.013574918 + - 0.012685412 + - -0.0041620894 + - 0.020578114 + - 0.007394845 + - 0.014139156 + - -0.012512821 + - -0.021042781 + - 0.022423506 + - -0.015360567 + - 0.004009413 + - 0.0104550095 + - -0.024799947 + - -0.0081449505 + - -0.00063850236 + - 0.0070231115 + - -0.0009633545 + - -0.015705748 + - -0.0028942123 + - -0.008815398 + - 0.007461226 + - -0.014417957 + - -0.012931022 + - 0.0015674217 + - -0.02506547 + - -0.0063128346 + - -0.013422241 + - -0.0058614435 + - -0.0006007482 + - -0.015002109 + - 0.0037040606 + - -0.008410474 + - -0.0016089098 + - -0.018653065 + - 0.020538285 + - -0.016980262 + - -0.042244878 + - -0.017498035 + - 0.006727716 + - -0.01877255 + - 0.008987989 + - 0.00077665783 + - -0.0007119364 + - -0.0067243967 + - 0.0038467797 + - -0.018055636 + - -0.01440468 + - 0.007534245 + - 0.0051212953 + - 0.002741536 + - 0.011523744 + - -0.0018603279 + - 0.023684746 + - 0.016196968 + - 0.01731217 + - -0.01992758 + - 0.009372999 + - -0.01982137 + - 0.001150051 + - -0.014417957 + - 0.005672258 + - -0.015785405 + - 0.0049387473 + - -0.0051445286 + - 0.012632307 + - 0.0011666464 + - 0.024587527 + - 0.04259006 + - -0.0025672857 + - 0.02311387 + - -0.014524166 + - 0.0013848739 + - -0.04105002 + - -0.010089914 + - -0.009087561 + - 0.015440224 + - 0.009207047 + - 0.0128048975 + - -0.030216638 + - -0.02549031 + - 0.00499849 + - 0.02737553 + - 0.024985814 + - -0.015055214 + - 0.007580712 + - -0.003979542 + - 0.0016304837 + - 0.0010446712 + - 0.0033373055 + - 0.0066314633 + - -0.011948583 + - -0.021281753 + - 0.012161002 + - 0.030747686 + - 0.03555367 + - 0.023751127 + - -0.03159736 + - -0.0110590765 + - 0.015758853 + - -0.0012197511 + - -0.0023249951 + - -0.0007488608 + - 0.0074877786 + - 0.01643594 + - -0.008098484 + - 0.03730613 + - -0.0010056724 + - -3.4798173e-05 + - 0.011702972 + - 0.039563086 + - -0.012280487 + - 0.027747264 + - 0.018387541 + - 0.033057746 + - -0.004835857 + - -0.00471969 + - 0.025450481 + - -0.0051146573 + - 0.014603823 + - 0.00022258384 + - 0.00060863094 + - 0.015665919 + - -0.021626934 + - -0.013674489 + - 0.0062066247 + - 0.018560132 + - 0.031942543 + - 0.012054792 + - 0.004902238 + - 0.0028510645 + - -0.027667606 + - 0.009817752 + - -0.002580562 + - 0.0069036256 + - 0.020047067 + - -0.009704905 + - -0.012619031 + - -0.0056755766 + - -0.0036443176 + - 0.019383255 + - 0.0030701219 + - 0.024972538 + - 0.009100837 + - 0.026353262 + - 0.012758431 + - 0.029074885 + - 0.021202097 + - -0.0038102702 + - -0.032048754 + - 0.003996137 + - 0.0029738694 + - 0.0032277768 + - -0.026127568 + - -0.02213143 + - 0.0028742978 + - 0.0010637557 + - 0.000580419 + - 0.0021789568 + - 0.00083764544 + - 0.026924139 + - -0.03265946 + - 0.0059211864 + - 0.021892458 + - 0.01178263 + - 0.0018188398 + - 0.009718181 + - -0.020047067 + - 0.017989255 + - 0.0046035233 + - -0.010561219 + - -0.010342162 + - 0.009505761 + - -0.018334435 + - -0.00667793 + - -0.024534423 + - 0.00035347888 + - 0.00082561385 + - -0.006143563 + - 0.016820949 + - -0.0013500239 + - -0.0069832825 + - 0.015347291 + - -0.005094743 + - 0.001838754 + - 0.017073197 + - 0.02521151 + - 0.006209944 + - -0.015612815 + - -0.009744733 + - -0.019794818 + - 0.007786493 + - 0.037624758 + - 0.017564416 + - 0.0076802834 + - 0.0026203906 + - 0.0022403593 + - -0.024560975 + - -0.04062518 + - -0.016581977 + - 0.00789934 + - 0.0099305995 + - 0.006996559 + - 0.011078991 + - 0.016236795 + - -0.0068969876 + - 0.01374087 + - 0.014922452 + - -0.0042882133 + - 0.00022901449 + - -0.0006692036 + - 0.001359981 + - -7.581957e-05 + - 0.0042616613 + - 0.0066381013 + - 0.012512821 + - 0.021534001 + - 0.0032775626 + - 0.016913882 + - -0.00789934 + - -0.009200408 + - -0.020286039 + - -0.017033368 + - 0.014378128 + - 0.009233599 + - 0.0070828544 + - -0.013229736 + - 0.025928425 + - -0.011862287 + - 0.008383922 + - 0.012632307 + - -0.0003097089 + - 0.007593988 + - 0.0059079104 + - -0.0026369859 + - -0.0262205 + - 0.003335646 + - -0.0067609064 + - -0.0042882133 + - 0.008549875 + - -0.007600626 + - -0.012592479 + - 0.028623493 + - -0.0030502076 + - -0.006989921 + - -0.015785405 + - 0.010050085 + - 0.016714739 + - -0.023724575 + - -0.006346025 + - -0.014245366 + - -0.032154962 + - -0.03388087 + - -0.024308728 + - -0.002461076 + - -0.003733932 + - -0.02195884 + - -0.021069333 + - -0.022144707 + - -0.007872788 + - -0.017179407 + - -0.009034456 + - -0.010893124 + - -0.02478667 + - -0.020153277 + - -0.023976821 + - 0.014656927 + - 0.0005368565 + - -0.015878338 + - 0.010123105 + - -0.0030717815 + - 0.01555971 + - 0.0018321159 + - -0.036244035 + - 0.00017176087 + - -0.013375774 + - -0.010375353 + - 0.026512576 + - 0.016581977 + - 0.013847079 + - 0.015719024 + - 0.013223098 + - 0.004975257 + - -0.0010579474 + - -0.0034385365 + - -0.029048331 + - 0.017298892 + - -0.022529716 + - 0.008463579 + - -0.014723309 + - -0.005814977 + - -0.009027818 + - -0.009738095 + - -0.0104682855 + - -0.005044957 + - 0.007905979 + - 0.011656506 + - 0.003153098 + - -0.0005231654 + - 0.019954132 + - -0.021985391 + - -0.005307162 + - 0.0021839354 + - -0.025184957 + - 0.013926737 + - -0.0059908866 + - 0.0065717204 + - 0.009884133 + - -0.0062298584 + - 0.03388087 + - 0.0028577026 + - -0.015931444 + - 0.0010986058 + - -0.025808938 + - 0.0022835068 + - 0.014152432 + - 0.015227805 + - 0.013701041 + - -0.007872788 + - -0.030614924 + - -0.026393091 + - 0.0010753724 + - -0.016940435 + - 0.013647936 + - -0.007408121 + - -0.024308728 + - -0.031915992 + - -0.018161846 + - 0.00072521257 + - 0.028862465 + - 0.012234021 + - -0.019555846 + - -0.027641054 + - -0.00082810316 + - -0.0019150922 + - -0.016276624 + - -0.01125822 + - -0.034146395 + - -0.015294186 + - 0.006671292 + - -0.015533158 + - 0.013674489 + - -0.0011766035 + - -0.017325444 + - -0.023233354 + - -0.013189907 + - 0.0005580154 + - -0.03188944 + - -0.007056302 + - -0.0059942054 + - 0.03411984 + - 0.04317421 + - 0.029420065 + - 0.006488744 + - -0.0022436783 + - 0.013063784 + - 0.00012207884 + - 0.008118398 + - -0.023246631 + - 0.0051909955 + - -0.00894816 + - 0.0081316745 + - 0.0023200165 + - 0.011510468 + - -0.0005770999 + - 0.00016979019 + - 0.010129742 + - 0.015506605 + - -0.0073815687 + - 0.0031995648 + - -0.026578957 + - -0.016674912 + - 0.0049652997 + - 0.0072687212 + - -0.016568702 + - -0.001964878 + - -0.015692472 + - -0.0048955996 + - 0.027773816 + - 0.012864641 + - 0.01594472 + - 0.008244522 + - 0.017139578 + - -0.01772373 + - -0.0012521119 + - 0.011689696 + - 0.0111121815 + - -0.0036476366 + - 0.0012570905 + - -0.007826322 + - -0.016754568 + - 0.011948583 + - -0.0045968853 + - 0.023963546 + - -0.0052739717 + - 0.014656927 + - 0.009731457 + - 0.010727172 + - -0.01705992 + - -0.0026071144 + - 0.010760362 + - 0.000919377 + - -0.006365939 + - -0.03013698 + - -0.010554581 + - -0.018613236 + - 0.013886908 + - 0.029420065 + - -0.013030593 + - 0.016860778 + - -0.019237218 + - -0.022118153 + - 0.007919255 + - -0.0004003605 + - 0.046546366 + - 0.01349526 + - 0.006352663 + - 0.014258642 + - 0.0031813101 + - -0.027017072 + - 0.0070828544 + - -0.020219658 + - 0.0037140178 + - 0.023366116 + - 0.040386207 + - -0.016382834 + - -0.0023681426 + - 0.0064522345 + - 0.016528873 + - 0.0006804054 + - -0.02891557 + - -0.0043545947 + - 0.01101261 + - -0.0014778073 + - -0.018055636 + - -0.0077001974 + - -0.0358723 + - 0.003373815 + - -0.00071940426 + - -0.011822458 + - -0.024295451 + - -0.009791199 + - -0.026565682 + - 0.020989677 + - -0.035155386 + - 0.01832116 + - 0.014776413 + - -0.028012788 + - -0.007262083 + - 0.0030402504 + - -0.029446619 + - 0.00010174965 + - 0.009758009 + - 0.03767786 + - -0.0154535 + - 0.009346447 + - 0.016077481 + - 0.0041189417 + - -0.027800368 + - 0.01720596 + - -0.011158649 + - 0.027800368 + - -0.03003077 + - -0.0072819972 + - 0.0014296811 + - 0.0145374425 + - 0.0043280423 + - -0.017086472 + - -0.01611731 + - -0.01258584 + - -0.016927158 + - 0.007607264 + - 0.018825656 + - 0.011331239 + - -0.0057784673 + - 0.001569911 + - -0.013900184 + - -0.014776413 + - -0.0050814664 + - -0.0012454737 + - -0.0115967635 + - -0.017458206 + - -0.013203184 + - -0.0063692583 + - -0.01244644 + - 0.011882202 + - 0.0007708495 + - -0.02035242 + - 0.016250072 + - 0.018414093 + - -0.029526275 + - 0.012751793 + - -0.01555971 + - 0.0013840442 + - -0.019502742 + - 0.0063758963 + - 0.0037538463 + - -0.035686433 + - 0.027534844 + - -0.016409386 + - -0.03247359 + - -0.008782208 + - -0.0059842486 + - 0.014338299 + - 0.009233599 + - -0.0053171194 + - 0.006160158 + - 0.0072952732 + - 0.01401967 + - 0.008815398 + - -0.023790956 + - 0.013096974 + - -0.0031365028 + - 0.005044957 + - 0.0005356118 + - -0.009379637 + - 0.0066248253 + - -0.00010724682 + - 0.010289057 + - 0.008815398 + - -0.02279524 + - -0.019701885 + - -0.0027747264 + - 0.016183691 + - -0.014205537 + - -0.003933075 + - -0.013375774 + - -0.005751915 + - -0.010116466 + - 0.004988533 + - -0.005904591 + - -0.008656085 + - -0.017431654 + - -0.011988411 + - -0.01594472 + - 0.00660823 + - -0.027216217 + - 0.0073218257 + - -0.029977666 + - -0.004593566 + - -0.026671892 + - -0.028517283 + - -0.0050084474 + - 0.009844304 + - 0.025729282 + - -0.013780698 + - -0.026751548 + - 0.004905557 + - -0.035951957 + - -0.026738273 + - -0.019768266 + - 0.0048690476 + - 0.005250738 + - 0.0014603822 + - -0.018892037 + - 0.017683903 + - 0.0067177587 + - 0.027694158 + - -0.002618731 + - -0.012419888 + - 0.01772373 + - -0.0032593077 + - 0.006611549 + - 0.016648358 + - -0.03789028 + - -0.023100592 + - 0.023684746 + - 0.0031248862 + - 0.016382834 + - 0.019967409 + - -0.008941523 + - -0.02014 + - 0.0073882067 + - 0.011357792 + - -0.0031796505 + - -0.0030253148 + - -0.0010206081 + - -0.017577693 + - -0.009598695 + - 0.002915786 + - 0.001325131 + - -0.0029207645 + - -0.010780277 + - -0.00325101 + - -0.00811176 + - -0.00073434 + - -0.030083876 + - -0.012864641 + - -0.012745155 + - -0.011769353 + - 0.018785827 + - -0.008264436 + - -0.002675155 + - 0.024255622 + - 0.005483072 + - -0.018480474 + - -0.005426648 + - 0.015095043 + - 0.00044392303 + - 0.011271496 + - -0.0027548121 + - 0.0026884312 + - -0.00894816 + - -0.015161424 + - -0.014975557 + - -0.024600804 + - 0.004457485 + - -0.015519881 + - -0.012366783 + - -0.012579202 + - 0.01478969 + - 0.0075541595 + - -0.017962702 + - -0.0017441611 + - -0.014059499 + - 0.005499667 + - -0.0026884312 + - 0.0031929268 + - 0.0010853296 + - -0.008045379 + - 0.017471483 + - 0.02590187 + - -0.018546855 + - -0.007826322 + - 0.009333171 + - 0.0157323 + - 8.6036016e-05 + - 0.004776114 + - 0.22155327 + - 0.006787459 + - -0.0017823302 + - 0.024919434 + - 0.0023449094 + - 0.03210186 + - 0.0047329664 + - -0.010879848 + - 0.0044342517 + - 0.015334014 + - 0.029499723 + - 0.019715162 + - -0.008569789 + - -0.0018901994 + - -0.0077400263 + - -0.019210665 + - -0.005088105 + - -0.023153698 + - -0.032739118 + - -0.029313855 + - 0.00082146504 + - -0.0212552 + - 0.0044309325 + - -0.005446562 + - 0.018613236 + - -0.009751371 + - -0.013023955 + - -0.001996409 + - 0.01915756 + - 0.017431654 + - -0.031092867 + - -0.0070231115 + - 0.025330994 + - -0.00018099198 + - -0.025131851 + - -0.011025886 + - 0.0116498675 + - -0.02506547 + - 0.029234199 + - -0.012287126 + - 0.0069766445 + - 0.0018752636 + - 0.014271918 + - 0.005108019 + - -0.0109064 + - 0.014391404 + - 0.0062597296 + - -0.031411495 + - 0.00014935728 + - 0.013236375 + - -0.02891557 + - -0.0006671292 + - 0.008662722 + - 0.012161002 + - 0.020963125 + - -0.0133691365 + - 0.02653913 + - -0.017989255 + - 0.007978998 + - 0.0093398085 + - -0.02024621 + - 0.03265946 + - -0.02846418 + - 0.025397375 + - -0.024693737 + - -0.0027050264 + - -0.019330151 + - -0.0104417335 + - 0.015626092 + - -0.006541849 + - 0.004653309 + - -0.025118576 + - 0.0038268655 + - 0.004045923 + - -0.017564416 + - -0.02444149 + - 0.030296294 + - 0.028756255 + - 0.03927101 + - 0.010767001 + - -0.012034878 + - -0.007122683 + - -0.022476612 + - -0.034942966 + - -0.028411074 + - -0.03927101 + - -0.0037505273 + - -0.0038799702 + - -0.00037111135 + - -0.009718181 + - -0.013455432 + - -0.015400395 + - -0.0066978442 + - -0.010760362 + - 0.015121595 + - 0.03111942 + - 0.007992274 + - 0.0270569 + - -0.003104972 + - 0.010056724 + - -0.018414093 + - 0.006472149 + - 0.021281753 + - 0.0043579135 + - -0.00021490853 + - 0.0008546556 + - -0.01269205 + - -0.003936394 + - 0.0008870163 + - 0.0009816092 + - 0.0054664765 + - -0.031278733 + - 0.017245788 + - 0.00027734818 + - 0.005161124 + - 0.0048093046 + - -0.003923118 + - -0.027149836 + - 0.006950092 + - -0.00615352 + - 0.014205537 + - 0.0016620146 + - 0.0047396044 + - 0.0039994563 + - -0.015440224 + - -0.0055627287 + - -0.026273604 + - 0.0013276202 + - 0.0021009592 + - -0.034810204 + - 0.0064522345 + - 0.00042608313 + - 0.02307404 + - -0.005957696 + - 0.0016869075 + - -0.0032775626 + - -0.009041094 + - -0.01227385 + - -0.04349284 + - 0.015652644 + - 0.013468708 + - -0.0023249951 + - -0.011171925 + - 0.0030352718 + - -0.0061203293 + - -0.023153698 + - 0.046068422 + - -0.005582643 + - -0.02405648 + - 0.005433286 + - -0.02814555 + - -0.0036874653 + - 0.0067841397 + - 0.006628144 + - 0.029844904 + - -0.0044276137 + - -0.029127989 + - -0.04548427 + - 0.022091601 + - 0.0038069512 + - -0.030269742 + - 0.0051578046 + - 0.043572497 + - -0.0144843375 + - -0.02891557 + - -0.010461648 + - -0.17375894 + - 0.029154541 + - 0.019648781 + - -0.00038335036 + - 0.0029572742 + - -0.0026469429 + - 0.035925403 + - -0.012021601 + - 0.0015566348 + - -0.0033124126 + - 0.0010430117 + - -0.010620962 + - -0.022582822 + - 0.00601412 + - 0.008364008 + - -0.0016586956 + - -0.0011102224 + - -0.013860356 + - 0.022542993 + - 0.020564837 + - 0.018414093 + - -0.008908332 + - 0.032951534 + - -0.011908754 + - 0.010169571 + - -0.011198477 + - 0.0029108075 + - 0.033084296 + - 0.0029008503 + - -0.0010015236 + - -0.019794818 + - 0.005844848 + - 0.011669782 + - 0.0052208668 + - 0.010129742 + - 0.0037737607 + - 0.02880936 + - -0.018599961 + - -0.015095043 + - 0.026578957 + - 0.019662056 + - 0.006823968 + - -0.00045885876 + - -0.019396532 + - -0.0047993474 + - 0.017192682 + - 0.039589636 + - -0.00874238 + - 0.02146762 + - -0.007667007 + - 0.018785827 + - -0.012758431 + - -0.010010257 + - -0.02052501 + - 0.016090758 + - 0.0061867107 + - -0.0145507185 + - 0.008065294 + - 0.0104284575 + - -0.0022386997 + - -0.008324179 + - -0.021640211 + - 0.01705992 + - -0.010541305 + - -0.01639611 + - -0.0074413116 + - -0.034703992 + - 0.007016473 + - -0.003083398 + - 0.0013691084 + - -0.005108019 + - -0.007886064 + - 0.00053270767 + - -0.018865485 + - 0.025503585 + - 0.005101381 + - -0.027534844 + - 0.015028661 + - -0.009286704 + - 0.006233177 + - 4.343289e-05 + - 0.036031615 + - 0.00957878 + - 0.019250493 + - 0.0024411618 + - 0.0023664832 + - -0.0030269742 + - -0.007939169 + - 0.0058581247 + - 0.00587472 + - 0.036589216 + - -0.035288148 + - -0.012997403 + - -0.0110989055 + - -0.002492607 + - 0.008151589 + - -0.008085207 + - -0.00734174 + - -0.0016802694 + - 0.008403837 + - -0.007793131 + - -0.003913161 + - -0.025437204 + - 0.027123282 + - 0.019330151 + - -0.008729103 + - 0.003943032 + - 0.010289057 + - 0.029977666 + - 0.0014836156 + - -0.024282174 + - -0.0024361832 + - 0.0110325245 + - 0.021719867 + - 0.012844726 + - 0.015002109 + - 0.020737428 + - -0.013037231 + - 0.014802966 + - -0.0027332383 + - 0.041634172 + - -0.00926679 + - -0.018759275 + - 0.018666342 + - 0.005386819 + - -0.008822037 + - -0.068399 + - -0.054804165 + - 0.027800368 + - 0.04954679 + - -0.00437119 + - 0.029127989 + - 0.03180978 + - 0.021321582 + - -0.022503164 + - 0.010554581 + - -0.006823968 + - -0.021387963 + - -0.021865906 + - -0.0074479496 + - 0.0037206558 + - 0.004132218 + - 0.01073381 + - -0.0021673401 + - -0.0012819833 + - 0.041235887 + - -0.010202762 + - 0.004839176 + - 0.0081715025 + - -0.030402504 + - -0.023764404 + - -0.010800191 + - -0.018374264 + - 0.033641897 + - 0.005416691 + - -0.0055096243 + - -0.0032775626 + - -0.018095464 + - 0.008563151 + - -0.02339267 + - -0.013674489 + - 0.0023382711 + - -0.028411074 + - -0.0024063117 + - 0.026658615 + - -0.012413249 + - 0.009333171 + - 0.026446195 + - -0.009107475 + - -0.024560975 + - 0.0011085629 + - -0.02395027 + - 0.0013857037 + - 0.01926377 + - -0.0020710877 + - -0.031278733 + - -0.015095043 + - 0.0041720467 + - -0.012798259 + - 0.010162933 + - 0.0063128346 + - -0.010972782 + - 0.045617033 + - 0.016874054 + - -0.010368714 + - -0.0055992384 + - -0.0092999805 + - 0.0015782086 + - -0.013581555 + - 0.017843217 + - -0.01615714 + - 0.0036575939 + - -0.027110007 + - -0.013621384 + - 0.022197811 + - 0.0013964906 + - -0.007348378 + - 0.0145772705 + - -0.003996137 + - 0.0008364008 + - -0.03411984 + - 0.013030593 + - -0.021454344 + - -0.05034336 + - 0.021095887 + - -0.0055029863 + - -0.025623072 + - -0.023525432 + - 0.007335102 + - -0.043413185 + - 0.016316453 + - 0.016196968 + - 0.0093132565 + - -0.0110989055 + - 0.0154535 + - -0.045218747 + - 0.0037737607 + - 0.01639611 + - 0.019887751 + - -0.023366116 + - -0.024043202 + - 0.014258642 + - 0.004271618 + - -0.006877073 + - 0.021387963 + - -0.0019781543 + - -0.036350243 + - -0.009114114 + - -0.037359234 + - 0.01919739 + - 0.011829097 + - -0.015665919 + - -0.0015591241 + - 0.0144843375 + - -0.003139822 + - -0.024083031 + - -0.015307462 + - -0.0040990277 + - -0.013223098 + - 0.0024278855 + - -0.008702551 + - -0.0033207103 + - -0.009804476 + - -0.010554581 + - 0.031066315 + - 0.0044408897 + - 0.025370823 + - 0.009406189 + - 0.025583243 + - -0.002066109 + - 0.015267633 + - 0.008337456 + - -0.009426104 + - 0.01590489 + - -0.011716249 + - 0.007713474 + - -0.029552827 + - -0.013900184 + - 0.0050150855 + - -0.01650232 + - -0.0015757193 + - 0.008549875 + - -0.020471904 + - 0.008397198 + - -0.013136802 + - 0.021520725 + - 0.0060406723 + - 0.012858002 + - -0.004723009 + - -0.029313855 + - 0.009240237 + - -0.0212552 + - -0.028118998 + - 0.017803388 + - -0.0314646 + - 0.012353507 + - 0.029632485 + - -1.6128512e-05 + - 0.016966987 + - 0.009711542 + - -0.037253026 + - -0.015095043 + - 0.013442155 + - -0.00905437 + - -0.000982439 + - -0.0020495139 + - 0.008337456 + - -0.020644495 + - 0.042085562 + - -0.000744712 + - 0.021135716 + - -0.0072886352 + - 0.01643594 + - 0.013767422 + - -0.0044707614 + - -0.014763137 + - 0.018852208 + - -0.03080079 + - -0.0049188333 + - 0.0058846767 + - 0.008330817 + - 0.008257798 + - 0.024202518 + - 0.02307404 + - 0.011065715 + - 0.00036053188 + - -0.00049412367 + - 0.036270585 + - 0.027043626 + - 0.011902116 + - -0.027773816 + - 0.013289479 + - 0.018374264 + - -0.0033157317 + - 0.0016636741 + - 0.0020677685 + - -0.012293763 + - 0.008184779 + - -0.034252603 + - 0.010753725 + - 0.008675998 + - 0.00968499 + - -0.003793675 + - -0.011218391 + - 0.010375353 + - -0.0005737809 + - 0.019781543 + - 0.020591391 + - 0.019954132 + - -0.00053976063 + - -0.0059444197 + - -0.022675755 + - -0.010003619 + - 0.0038467797 + - -0.0212552 + - -0.033482585 + - -0.015572986 + - 0.0037737607 + - 0.01451089 + - 0.0036376796 + - 0.007454588 + - 0.013979842 + - -0.013402327 + - 0.014975557 + - -0.010435095 + - 0.0151747 + - -0.030375952 + - 0.023166973 + - -0.0024760119 + - -0.005881358 + - 0.019914305 + - -0.008596341 + - 0.017737007 + - -0.0036111271 + - 0.012499545 + - -0.02647275 + - 0.0053901384 + - 0.008556513 + - 0.019648781 + - 0.00874238 + - -0.012439802 + - -0.028623493 + - -0.022330573 + - -0.0029340407 + - -0.016303178 + - 0.007474502 + - -0.016555425 + - 0.060645696 + - 0.0023631642 + - -0.012054792 + - 0.017604245 + - 0.013103612 + - 0.026061187 + - 0.015533158 + - 0.025742557 + - 0.00013753316 + - -0.013940013 + - 0.02880936 + - 0.010109829 + - -0.0036111271 + - -0.012419888 + - -0.045457717 + - 0.022835068 + - -0.014139156 + - 0.007819683 + - -0.010461648 + - -0.012008325 + - 0.008895056 + - 0.015984548 + - 0.024043202 + - -0.00059825886 + - -0.0036376796 + - -0.007939169 + - 0.0242689 + - -0.022197811 + - -0.026313433 + - -0.026724996 + - 0.010939592 + - 0.0023449094 + - -0.012074706 + - -0.018493751 + - 0.017697178 + - -0.0052142288 + - -0.00360117 + - 0.0056058764 + - 0.01070062 + - 0.0035248317 + - 0.023671469 + - 0.030880447 + - -0.020299314 + - -0.0145905465 + - 0.018055636 + - -0.013727593 + - -0.023313012 + - 0.013236375 + - -0.0020113448 + usage: + prompt_tokens: 4 + total_tokens: 4 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json new file mode 100644 index 000000000000..7d1af9c002cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_speech.json @@ -0,0 +1,19 @@ +{ + "operationId": "GenerateSpeechFromText", + "title": "Generates text-to-speech audio from the input text.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "input": "The text to generate audio for", + "voice": "alloy" + } + }, + "responses": { + "200": { + "content-type": "application/octet-stream", + "body": "RIFF...audio.data.omitted" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json new file mode 100644 index 000000000000..fe26291868d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranscriptionAsResponseObject", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json new file mode 100644 index 000000000000..0ded5d22adfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_transcription_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranscriptionAsPlainText", + "title": "Gets transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json new file mode 100644 index 000000000000..5fca9edee75d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_object.json @@ -0,0 +1,17 @@ +{ + "operationId": "GetAudioTranslationAsResponseObject", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "body": { + "text": "A structured object when requesting json or verbose_json" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json new file mode 100644 index 000000000000..489cf486ff03 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_audio_translation_text.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetAudioTranslationAsPlainText", + "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "file": "U3dhZ2dlciByb2Nrcw==" + }, + "responses": { + "200": { + "type": "string", + "body": "plain text when requesting text, srt, or vtt" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json new file mode 100644 index 000000000000..fd4287afdf45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_chat_completions.json @@ -0,0 +1,45 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "system", + "content": "you are a helpful assistant that talks like a pirate" + }, + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!" + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json new file mode 100644 index 000000000000..d94a1de65122 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_completions.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetCompletions", + "title": "Creates a completion for the provided prompt, parameters and chosen model.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "prompt": [ + "tell me a joke about mango" + ], + "max_tokens": 32, + "temperature": 1.0, + "n": 1 + } + }, + "responses": { + "200": { + "body": { + "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq", + "created": 1686617332, + "choices": [ + { + "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.", + "index": 0, + "finish_reason": "stop", + "logprobs": null + } + ], + "usage": { + "completion_tokens": 20, + "prompt_tokens": 6, + "total_tokens": 26 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json new file mode 100644 index 000000000000..01b1b4ad928e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_embeddings.json @@ -0,0 +1,1567 @@ +{ + "operationId": "GetEmbeddings", + "title": "Return the embeddings for a given prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "deployment-afa0669ca01e4693ae3a93baf40f26d6", + "body": { + "input": [ + "this is a test" + ] + } + }, + "responses": { + "200": { + "body": { + "data": [ + { + "index": 0, + "embedding": [ + -0.012838088, + -0.007421397, + -0.017617522, + -0.028278312, + -0.018666342, + 0.01737855, + -0.01821495, + -0.006950092, + -0.009937238, + -0.038580645, + 0.010674067, + 0.02412286, + -0.013647936, + 0.013189907, + 0.0021125758, + 0.012406612, + 0.020790534, + 0.00074595667, + 0.008397198, + -0.00535031, + 0.008968075, + 0.014351576, + -0.014086051, + 0.015055214, + -0.022211088, + -0.025198232, + 0.0065186154, + -0.036350243, + 0.009180495, + -0.009698266, + 0.009446018, + -0.008463579, + -0.0040426035, + -0.03443847, + -0.00091273896, + -0.0019217303, + 0.002349888, + -0.021560553, + 0.016515596, + -0.015572986, + 0.0038666942, + -0.00008432463, + 0.0032178196, + -0.020365695, + -0.009631885, + -0.007647093, + 0.0033837722, + -0.026764825, + -0.010501476, + 0.020219658, + 0.024640633, + -0.0066912062, + -0.036456455, + -0.0040923897, + -0.013966565, + 0.017816665, + 0.005366905, + 0.022835068, + 0.0103488, + -0.0010811808, + -0.028942121, + 0.0074280356, + -0.017033368, + 0.0074877786, + 0.021640211, + 0.002499245, + 0.013316032, + 0.0021524043, + 0.010129742, + 0.0054731146, + 0.03143805, + 0.014856071, + 0.0023366117, + -0.0008243692, + 0.022781964, + 0.003038591, + -0.017617522, + 0.0013309394, + 0.0022154662, + 0.00097414135, + 0.012041516, + -0.027906578, + -0.023817508, + 0.013302756, + -0.003003741, + -0.006890349, + 0.0016744611, + 0.023658194, + -0.015851786, + -0.0045305043, + -0.003038591, + 0.017710455, + 0.019237218, + 0.016037652, + -0.022503164, + 0.025795663, + -0.001129307, + 0.032500144, + -0.008178141, + -0.019940857, + -0.009877495, + 0.00018918588, + 0.023060765, + -0.005692172, + -0.018347712, + -0.011039163, + -0.0062066247, + -0.0000524047, + 0.020126723, + -0.0011691356, + -0.015811957, + 0.020086896, + -0.009114114, + -0.03056182, + 0.0029025099, + -0.006591635, + -0.014046223, + -0.01590489, + -0.02307404, + -0.008861865, + -0.004832538, + 0.010030171, + 0.02311387, + -0.012652221, + 0.024906157, + 0.003860056, + -0.01936998, + -0.02957938, + -0.008357369, + -0.0016371218, + 0.027800368, + 0.0077333883, + 0.021626934, + 0.02140124, + -0.030482162, + 0.026406368, + -0.008277712, + 0.012884554, + -0.043784916, + -0.0145639945, + -0.0070297495, + 0.034889862, + -0.00041508878, + -0.010528029, + -0.009572142, + 0.015692472, + 0.037810627, + -0.0022021902, + 0.008662722, + -0.016794397, + 0.0003090866, + -0.0060506295, + 0.015227805, + 0.0006650548, + 0.01842737, + 0.036801632, + -0.002461076, + -0.0029390194, + -0.0057120863, + -0.012486269, + -0.0046831807, + -0.0017474802, + -0.0036210844, + -0.01178263, + 0.017869769, + 0.039111692, + 0.010946229, + 0.018467197, + 0.0027780454, + -0.005851486, + -0.016489044, + 0.03186289, + -0.040333103, + 0.016648358, + -0.006870435, + 0.0072687212, + 0.000002370982, + 0.006465511, + -0.018201673, + -0.00020526254, + -0.025410652, + 0.02010017, + 0.017537864, + 0.022821793, + 0.0064555537, + -0.0012969191, + 0.02157383, + -0.0053536287, + -0.0087622935, + -0.010952868, + 0.017564416, + 0.02185263, + 0.0004733796, + 0.0018337755, + -0.6954606, + -0.011231667, + 0.02748174, + 0.003929756, + 0.0144843375, + 0.045192193, + 0.01898497, + -0.0070363875, + -0.007813046, + 0.017604245, + -0.017790113, + 0.011165286, + -0.0036376796, + -0.014736585, + 0.0016421003, + -0.019144284, + -0.0072222543, + -0.023127146, + 0.006936816, + 0.025198232, + 0.0030219958, + 0.011722887, + -0.004271618, + -0.0011127117, + -0.0051047, + 0.00077333883, + 0.018599961, + 0.0074877786, + 0.010820106, + 0.0033406245, + -0.015055214, + 0.02384406, + 0.006090458, + 0.00891497, + 0.023366116, + -0.011078991, + -0.019582398, + 0.0011566891, + 0.015413672, + 0.01793615, + -0.014736585, + 0.002492607, + 0.027800368, + 0.023923717, + -0.007421397, + 0.0016105693, + 0.011337877, + -0.015041938, + -0.008768932, + -0.003982861, + 0.002884255, + -0.007832959, + 0.0025457118, + -0.0023548664, + -0.0061767534, + -0.016754568, + 0.0006036523, + 0.0105346665, + 0.0055361767, + 0.01478969, + -0.0011251582, + 0.009605332, + -0.0037140178, + -0.017537864, + -0.021733144, + 0.012897831, + -0.024481317, + 0.022290744, + 0.0056523434, + -0.005366905, + 0.0020412162, + 0.013435517, + -0.003408665, + -0.01705992, + 0.029446619, + 0.022011945, + 0.009226961, + -0.003310753, + -0.007939169, + 0.021308305, + 0.0026718357, + 0.002129171, + -0.020047067, + -0.007474502, + 0.021534001, + -0.0110590765, + -0.018374264, + -0.001664504, + -0.003923118, + 0.015387119, + 0.025516862, + 0.0016421003, + -0.017498035, + -0.01825478, + 0.01451089, + -0.008198055, + -0.011656506, + 0.0044242945, + 0.031491153, + 0.01017621, + -0.010408543, + -0.009034456, + -0.0023283141, + 0.012021601, + 0.015639367, + 0.011736163, + 0.007912617, + 0.02031259, + 0.022104878, + -0.02241023, + 0.00041156227, + -0.009817752, + -0.030880447, + -0.0017823302, + 0.0030933553, + -0.04128899, + -0.0007783174, + 0.012393335, + 0.0122273825, + -0.009087561, + 0.022728859, + -0.002884255, + 0.028065892, + 0.0047396044, + 0.008065294, + 0.015519881, + 0.0133956885, + -0.02279524, + -0.011729525, + 0.0037206558, + -0.0046732235, + 0.003587894, + 0.024401661, + -0.013574918, + 0.012685412, + -0.0041620894, + 0.020578114, + 0.007394845, + 0.014139156, + -0.012512821, + -0.021042781, + 0.022423506, + -0.015360567, + 0.004009413, + 0.0104550095, + -0.024799947, + -0.0081449505, + -0.00063850236, + 0.0070231115, + -0.0009633545, + -0.015705748, + -0.0028942123, + -0.008815398, + 0.007461226, + -0.014417957, + -0.012931022, + 0.0015674217, + -0.02506547, + -0.0063128346, + -0.013422241, + -0.0058614435, + -0.0006007482, + -0.015002109, + 0.0037040606, + -0.008410474, + -0.0016089098, + -0.018653065, + 0.020538285, + -0.016980262, + -0.042244878, + -0.017498035, + 0.006727716, + -0.01877255, + 0.008987989, + 0.00077665783, + -0.0007119364, + -0.0067243967, + 0.0038467797, + -0.018055636, + -0.01440468, + 0.007534245, + 0.0051212953, + 0.002741536, + 0.011523744, + -0.0018603279, + 0.023684746, + 0.016196968, + 0.01731217, + -0.01992758, + 0.009372999, + -0.01982137, + 0.001150051, + -0.014417957, + 0.005672258, + -0.015785405, + 0.0049387473, + -0.0051445286, + 0.012632307, + 0.0011666464, + 0.024587527, + 0.04259006, + -0.0025672857, + 0.02311387, + -0.014524166, + 0.0013848739, + -0.04105002, + -0.010089914, + -0.009087561, + 0.015440224, + 0.009207047, + 0.0128048975, + -0.030216638, + -0.02549031, + 0.00499849, + 0.02737553, + 0.024985814, + -0.015055214, + 0.007580712, + -0.003979542, + 0.0016304837, + 0.0010446712, + 0.0033373055, + 0.0066314633, + -0.011948583, + -0.021281753, + 0.012161002, + 0.030747686, + 0.03555367, + 0.023751127, + -0.03159736, + -0.0110590765, + 0.015758853, + -0.0012197511, + -0.0023249951, + -0.0007488608, + 0.0074877786, + 0.01643594, + -0.008098484, + 0.03730613, + -0.0010056724, + -0.000034798173, + 0.011702972, + 0.039563086, + -0.012280487, + 0.027747264, + 0.018387541, + 0.033057746, + -0.004835857, + -0.00471969, + 0.025450481, + -0.0051146573, + 0.014603823, + 0.00022258384, + 0.00060863094, + 0.015665919, + -0.021626934, + -0.013674489, + 0.0062066247, + 0.018560132, + 0.031942543, + 0.012054792, + 0.004902238, + 0.0028510645, + -0.027667606, + 0.009817752, + -0.002580562, + 0.0069036256, + 0.020047067, + -0.009704905, + -0.012619031, + -0.0056755766, + -0.0036443176, + 0.019383255, + 0.0030701219, + 0.024972538, + 0.009100837, + 0.026353262, + 0.012758431, + 0.029074885, + 0.021202097, + -0.0038102702, + -0.032048754, + 0.003996137, + 0.0029738694, + 0.0032277768, + -0.026127568, + -0.02213143, + 0.0028742978, + 0.0010637557, + 0.000580419, + 0.0021789568, + 0.00083764544, + 0.026924139, + -0.03265946, + 0.0059211864, + 0.021892458, + 0.01178263, + 0.0018188398, + 0.009718181, + -0.020047067, + 0.017989255, + 0.0046035233, + -0.010561219, + -0.010342162, + 0.009505761, + -0.018334435, + -0.00667793, + -0.024534423, + 0.00035347888, + 0.00082561385, + -0.006143563, + 0.016820949, + -0.0013500239, + -0.0069832825, + 0.015347291, + -0.005094743, + 0.001838754, + 0.017073197, + 0.02521151, + 0.006209944, + -0.015612815, + -0.009744733, + -0.019794818, + 0.007786493, + 0.037624758, + 0.017564416, + 0.0076802834, + 0.0026203906, + 0.0022403593, + -0.024560975, + -0.04062518, + -0.016581977, + 0.00789934, + 0.0099305995, + 0.006996559, + 0.011078991, + 0.016236795, + -0.0068969876, + 0.01374087, + 0.014922452, + -0.0042882133, + 0.00022901449, + -0.0006692036, + 0.001359981, + -0.00007581957, + 0.0042616613, + 0.0066381013, + 0.012512821, + 0.021534001, + 0.0032775626, + 0.016913882, + -0.00789934, + -0.009200408, + -0.020286039, + -0.017033368, + 0.014378128, + 0.009233599, + 0.0070828544, + -0.013229736, + 0.025928425, + -0.011862287, + 0.008383922, + 0.012632307, + -0.0003097089, + 0.007593988, + 0.0059079104, + -0.0026369859, + -0.0262205, + 0.003335646, + -0.0067609064, + -0.0042882133, + 0.008549875, + -0.007600626, + -0.012592479, + 0.028623493, + -0.0030502076, + -0.006989921, + -0.015785405, + 0.010050085, + 0.016714739, + -0.023724575, + -0.006346025, + -0.014245366, + -0.032154962, + -0.03388087, + -0.024308728, + -0.002461076, + -0.003733932, + -0.02195884, + -0.021069333, + -0.022144707, + -0.007872788, + -0.017179407, + -0.009034456, + -0.010893124, + -0.02478667, + -0.020153277, + -0.023976821, + 0.014656927, + 0.0005368565, + -0.015878338, + 0.010123105, + -0.0030717815, + 0.01555971, + 0.0018321159, + -0.036244035, + 0.00017176087, + -0.013375774, + -0.010375353, + 0.026512576, + 0.016581977, + 0.013847079, + 0.015719024, + 0.013223098, + 0.004975257, + -0.0010579474, + -0.0034385365, + -0.029048331, + 0.017298892, + -0.022529716, + 0.008463579, + -0.014723309, + -0.005814977, + -0.009027818, + -0.009738095, + -0.0104682855, + -0.005044957, + 0.007905979, + 0.011656506, + 0.003153098, + -0.0005231654, + 0.019954132, + -0.021985391, + -0.005307162, + 0.0021839354, + -0.025184957, + 0.013926737, + -0.0059908866, + 0.0065717204, + 0.009884133, + -0.0062298584, + 0.03388087, + 0.0028577026, + -0.015931444, + 0.0010986058, + -0.025808938, + 0.0022835068, + 0.014152432, + 0.015227805, + 0.013701041, + -0.007872788, + -0.030614924, + -0.026393091, + 0.0010753724, + -0.016940435, + 0.013647936, + -0.007408121, + -0.024308728, + -0.031915992, + -0.018161846, + 0.00072521257, + 0.028862465, + 0.012234021, + -0.019555846, + -0.027641054, + -0.00082810316, + -0.0019150922, + -0.016276624, + -0.01125822, + -0.034146395, + -0.015294186, + 0.006671292, + -0.015533158, + 0.013674489, + -0.0011766035, + -0.017325444, + -0.023233354, + -0.013189907, + 0.0005580154, + -0.03188944, + -0.007056302, + -0.0059942054, + 0.03411984, + 0.04317421, + 0.029420065, + 0.006488744, + -0.0022436783, + 0.013063784, + 0.00012207884, + 0.008118398, + -0.023246631, + 0.0051909955, + -0.00894816, + 0.0081316745, + 0.0023200165, + 0.011510468, + -0.0005770999, + 0.00016979019, + 0.010129742, + 0.015506605, + -0.0073815687, + 0.0031995648, + -0.026578957, + -0.016674912, + 0.0049652997, + 0.0072687212, + -0.016568702, + -0.001964878, + -0.015692472, + -0.0048955996, + 0.027773816, + 0.012864641, + 0.01594472, + 0.008244522, + 0.017139578, + -0.01772373, + -0.0012521119, + 0.011689696, + 0.0111121815, + -0.0036476366, + 0.0012570905, + -0.007826322, + -0.016754568, + 0.011948583, + -0.0045968853, + 0.023963546, + -0.0052739717, + 0.014656927, + 0.009731457, + 0.010727172, + -0.01705992, + -0.0026071144, + 0.010760362, + 0.000919377, + -0.006365939, + -0.03013698, + -0.010554581, + -0.018613236, + 0.013886908, + 0.029420065, + -0.013030593, + 0.016860778, + -0.019237218, + -0.022118153, + 0.007919255, + -0.0004003605, + 0.046546366, + 0.01349526, + 0.006352663, + 0.014258642, + 0.0031813101, + -0.027017072, + 0.0070828544, + -0.020219658, + 0.0037140178, + 0.023366116, + 0.040386207, + -0.016382834, + -0.0023681426, + 0.0064522345, + 0.016528873, + 0.0006804054, + -0.02891557, + -0.0043545947, + 0.01101261, + -0.0014778073, + -0.018055636, + -0.0077001974, + -0.0358723, + 0.003373815, + -0.00071940426, + -0.011822458, + -0.024295451, + -0.009791199, + -0.026565682, + 0.020989677, + -0.035155386, + 0.01832116, + 0.014776413, + -0.028012788, + -0.007262083, + 0.0030402504, + -0.029446619, + 0.00010174965, + 0.009758009, + 0.03767786, + -0.0154535, + 0.009346447, + 0.016077481, + 0.0041189417, + -0.027800368, + 0.01720596, + -0.011158649, + 0.027800368, + -0.03003077, + -0.0072819972, + 0.0014296811, + 0.0145374425, + 0.0043280423, + -0.017086472, + -0.01611731, + -0.01258584, + -0.016927158, + 0.007607264, + 0.018825656, + 0.011331239, + -0.0057784673, + 0.001569911, + -0.013900184, + -0.014776413, + -0.0050814664, + -0.0012454737, + -0.0115967635, + -0.017458206, + -0.013203184, + -0.0063692583, + -0.01244644, + 0.011882202, + 0.0007708495, + -0.02035242, + 0.016250072, + 0.018414093, + -0.029526275, + 0.012751793, + -0.01555971, + 0.0013840442, + -0.019502742, + 0.0063758963, + 0.0037538463, + -0.035686433, + 0.027534844, + -0.016409386, + -0.03247359, + -0.008782208, + -0.0059842486, + 0.014338299, + 0.009233599, + -0.0053171194, + 0.006160158, + 0.0072952732, + 0.01401967, + 0.008815398, + -0.023790956, + 0.013096974, + -0.0031365028, + 0.005044957, + 0.0005356118, + -0.009379637, + 0.0066248253, + -0.00010724682, + 0.010289057, + 0.008815398, + -0.02279524, + -0.019701885, + -0.0027747264, + 0.016183691, + -0.014205537, + -0.003933075, + -0.013375774, + -0.005751915, + -0.010116466, + 0.004988533, + -0.005904591, + -0.008656085, + -0.017431654, + -0.011988411, + -0.01594472, + 0.00660823, + -0.027216217, + 0.0073218257, + -0.029977666, + -0.004593566, + -0.026671892, + -0.028517283, + -0.0050084474, + 0.009844304, + 0.025729282, + -0.013780698, + -0.026751548, + 0.004905557, + -0.035951957, + -0.026738273, + -0.019768266, + 0.0048690476, + 0.005250738, + 0.0014603822, + -0.018892037, + 0.017683903, + 0.0067177587, + 0.027694158, + -0.002618731, + -0.012419888, + 0.01772373, + -0.0032593077, + 0.006611549, + 0.016648358, + -0.03789028, + -0.023100592, + 0.023684746, + 0.0031248862, + 0.016382834, + 0.019967409, + -0.008941523, + -0.02014, + 0.0073882067, + 0.011357792, + -0.0031796505, + -0.0030253148, + -0.0010206081, + -0.017577693, + -0.009598695, + 0.002915786, + 0.001325131, + -0.0029207645, + -0.010780277, + -0.00325101, + -0.00811176, + -0.00073434, + -0.030083876, + -0.012864641, + -0.012745155, + -0.011769353, + 0.018785827, + -0.008264436, + -0.002675155, + 0.024255622, + 0.005483072, + -0.018480474, + -0.005426648, + 0.015095043, + 0.00044392303, + 0.011271496, + -0.0027548121, + 0.0026884312, + -0.00894816, + -0.015161424, + -0.014975557, + -0.024600804, + 0.004457485, + -0.015519881, + -0.012366783, + -0.012579202, + 0.01478969, + 0.0075541595, + -0.017962702, + -0.0017441611, + -0.014059499, + 0.005499667, + -0.0026884312, + 0.0031929268, + 0.0010853296, + -0.008045379, + 0.017471483, + 0.02590187, + -0.018546855, + -0.007826322, + 0.009333171, + 0.0157323, + 0.000086036016, + 0.004776114, + 0.22155327, + 0.006787459, + -0.0017823302, + 0.024919434, + 0.0023449094, + 0.03210186, + 0.0047329664, + -0.010879848, + 0.0044342517, + 0.015334014, + 0.029499723, + 0.019715162, + -0.008569789, + -0.0018901994, + -0.0077400263, + -0.019210665, + -0.005088105, + -0.023153698, + -0.032739118, + -0.029313855, + 0.00082146504, + -0.0212552, + 0.0044309325, + -0.005446562, + 0.018613236, + -0.009751371, + -0.013023955, + -0.001996409, + 0.01915756, + 0.017431654, + -0.031092867, + -0.0070231115, + 0.025330994, + -0.00018099198, + -0.025131851, + -0.011025886, + 0.0116498675, + -0.02506547, + 0.029234199, + -0.012287126, + 0.0069766445, + 0.0018752636, + 0.014271918, + 0.005108019, + -0.0109064, + 0.014391404, + 0.0062597296, + -0.031411495, + 0.00014935728, + 0.013236375, + -0.02891557, + -0.0006671292, + 0.008662722, + 0.012161002, + 0.020963125, + -0.0133691365, + 0.02653913, + -0.017989255, + 0.007978998, + 0.0093398085, + -0.02024621, + 0.03265946, + -0.02846418, + 0.025397375, + -0.024693737, + -0.0027050264, + -0.019330151, + -0.0104417335, + 0.015626092, + -0.006541849, + 0.004653309, + -0.025118576, + 0.0038268655, + 0.004045923, + -0.017564416, + -0.02444149, + 0.030296294, + 0.028756255, + 0.03927101, + 0.010767001, + -0.012034878, + -0.007122683, + -0.022476612, + -0.034942966, + -0.028411074, + -0.03927101, + -0.0037505273, + -0.0038799702, + -0.00037111135, + -0.009718181, + -0.013455432, + -0.015400395, + -0.0066978442, + -0.010760362, + 0.015121595, + 0.03111942, + 0.007992274, + 0.0270569, + -0.003104972, + 0.010056724, + -0.018414093, + 0.006472149, + 0.021281753, + 0.0043579135, + -0.00021490853, + 0.0008546556, + -0.01269205, + -0.003936394, + 0.0008870163, + 0.0009816092, + 0.0054664765, + -0.031278733, + 0.017245788, + 0.00027734818, + 0.005161124, + 0.0048093046, + -0.003923118, + -0.027149836, + 0.006950092, + -0.00615352, + 0.014205537, + 0.0016620146, + 0.0047396044, + 0.0039994563, + -0.015440224, + -0.0055627287, + -0.026273604, + 0.0013276202, + 0.0021009592, + -0.034810204, + 0.0064522345, + 0.00042608313, + 0.02307404, + -0.005957696, + 0.0016869075, + -0.0032775626, + -0.009041094, + -0.01227385, + -0.04349284, + 0.015652644, + 0.013468708, + -0.0023249951, + -0.011171925, + 0.0030352718, + -0.0061203293, + -0.023153698, + 0.046068422, + -0.005582643, + -0.02405648, + 0.005433286, + -0.02814555, + -0.0036874653, + 0.0067841397, + 0.006628144, + 0.029844904, + -0.0044276137, + -0.029127989, + -0.04548427, + 0.022091601, + 0.0038069512, + -0.030269742, + 0.0051578046, + 0.043572497, + -0.0144843375, + -0.02891557, + -0.010461648, + -0.17375894, + 0.029154541, + 0.019648781, + -0.00038335036, + 0.0029572742, + -0.0026469429, + 0.035925403, + -0.012021601, + 0.0015566348, + -0.0033124126, + 0.0010430117, + -0.010620962, + -0.022582822, + 0.00601412, + 0.008364008, + -0.0016586956, + -0.0011102224, + -0.013860356, + 0.022542993, + 0.020564837, + 0.018414093, + -0.008908332, + 0.032951534, + -0.011908754, + 0.010169571, + -0.011198477, + 0.0029108075, + 0.033084296, + 0.0029008503, + -0.0010015236, + -0.019794818, + 0.005844848, + 0.011669782, + 0.0052208668, + 0.010129742, + 0.0037737607, + 0.02880936, + -0.018599961, + -0.015095043, + 0.026578957, + 0.019662056, + 0.006823968, + -0.00045885876, + -0.019396532, + -0.0047993474, + 0.017192682, + 0.039589636, + -0.00874238, + 0.02146762, + -0.007667007, + 0.018785827, + -0.012758431, + -0.010010257, + -0.02052501, + 0.016090758, + 0.0061867107, + -0.0145507185, + 0.008065294, + 0.0104284575, + -0.0022386997, + -0.008324179, + -0.021640211, + 0.01705992, + -0.010541305, + -0.01639611, + -0.0074413116, + -0.034703992, + 0.007016473, + -0.003083398, + 0.0013691084, + -0.005108019, + -0.007886064, + 0.00053270767, + -0.018865485, + 0.025503585, + 0.005101381, + -0.027534844, + 0.015028661, + -0.009286704, + 0.006233177, + 0.00004343289, + 0.036031615, + 0.00957878, + 0.019250493, + 0.0024411618, + 0.0023664832, + -0.0030269742, + -0.007939169, + 0.0058581247, + 0.00587472, + 0.036589216, + -0.035288148, + -0.012997403, + -0.0110989055, + -0.002492607, + 0.008151589, + -0.008085207, + -0.00734174, + -0.0016802694, + 0.008403837, + -0.007793131, + -0.003913161, + -0.025437204, + 0.027123282, + 0.019330151, + -0.008729103, + 0.003943032, + 0.010289057, + 0.029977666, + 0.0014836156, + -0.024282174, + -0.0024361832, + 0.0110325245, + 0.021719867, + 0.012844726, + 0.015002109, + 0.020737428, + -0.013037231, + 0.014802966, + -0.0027332383, + 0.041634172, + -0.00926679, + -0.018759275, + 0.018666342, + 0.005386819, + -0.008822037, + -0.068399, + -0.054804165, + 0.027800368, + 0.04954679, + -0.00437119, + 0.029127989, + 0.03180978, + 0.021321582, + -0.022503164, + 0.010554581, + -0.006823968, + -0.021387963, + -0.021865906, + -0.0074479496, + 0.0037206558, + 0.004132218, + 0.01073381, + -0.0021673401, + -0.0012819833, + 0.041235887, + -0.010202762, + 0.004839176, + 0.0081715025, + -0.030402504, + -0.023764404, + -0.010800191, + -0.018374264, + 0.033641897, + 0.005416691, + -0.0055096243, + -0.0032775626, + -0.018095464, + 0.008563151, + -0.02339267, + -0.013674489, + 0.0023382711, + -0.028411074, + -0.0024063117, + 0.026658615, + -0.012413249, + 0.009333171, + 0.026446195, + -0.009107475, + -0.024560975, + 0.0011085629, + -0.02395027, + 0.0013857037, + 0.01926377, + -0.0020710877, + -0.031278733, + -0.015095043, + 0.0041720467, + -0.012798259, + 0.010162933, + 0.0063128346, + -0.010972782, + 0.045617033, + 0.016874054, + -0.010368714, + -0.0055992384, + -0.0092999805, + 0.0015782086, + -0.013581555, + 0.017843217, + -0.01615714, + 0.0036575939, + -0.027110007, + -0.013621384, + 0.022197811, + 0.0013964906, + -0.007348378, + 0.0145772705, + -0.003996137, + 0.0008364008, + -0.03411984, + 0.013030593, + -0.021454344, + -0.05034336, + 0.021095887, + -0.0055029863, + -0.025623072, + -0.023525432, + 0.007335102, + -0.043413185, + 0.016316453, + 0.016196968, + 0.0093132565, + -0.0110989055, + 0.0154535, + -0.045218747, + 0.0037737607, + 0.01639611, + 0.019887751, + -0.023366116, + -0.024043202, + 0.014258642, + 0.004271618, + -0.006877073, + 0.021387963, + -0.0019781543, + -0.036350243, + -0.009114114, + -0.037359234, + 0.01919739, + 0.011829097, + -0.015665919, + -0.0015591241, + 0.0144843375, + -0.003139822, + -0.024083031, + -0.015307462, + -0.0040990277, + -0.013223098, + 0.0024278855, + -0.008702551, + -0.0033207103, + -0.009804476, + -0.010554581, + 0.031066315, + 0.0044408897, + 0.025370823, + 0.009406189, + 0.025583243, + -0.002066109, + 0.015267633, + 0.008337456, + -0.009426104, + 0.01590489, + -0.011716249, + 0.007713474, + -0.029552827, + -0.013900184, + 0.0050150855, + -0.01650232, + -0.0015757193, + 0.008549875, + -0.020471904, + 0.008397198, + -0.013136802, + 0.021520725, + 0.0060406723, + 0.012858002, + -0.004723009, + -0.029313855, + 0.009240237, + -0.0212552, + -0.028118998, + 0.017803388, + -0.0314646, + 0.012353507, + 0.029632485, + -0.000016128512, + 0.016966987, + 0.009711542, + -0.037253026, + -0.015095043, + 0.013442155, + -0.00905437, + -0.000982439, + -0.0020495139, + 0.008337456, + -0.020644495, + 0.042085562, + -0.000744712, + 0.021135716, + -0.0072886352, + 0.01643594, + 0.013767422, + -0.0044707614, + -0.014763137, + 0.018852208, + -0.03080079, + -0.0049188333, + 0.0058846767, + 0.008330817, + 0.008257798, + 0.024202518, + 0.02307404, + 0.011065715, + 0.00036053188, + -0.00049412367, + 0.036270585, + 0.027043626, + 0.011902116, + -0.027773816, + 0.013289479, + 0.018374264, + -0.0033157317, + 0.0016636741, + 0.0020677685, + -0.012293763, + 0.008184779, + -0.034252603, + 0.010753725, + 0.008675998, + 0.00968499, + -0.003793675, + -0.011218391, + 0.010375353, + -0.0005737809, + 0.019781543, + 0.020591391, + 0.019954132, + -0.00053976063, + -0.0059444197, + -0.022675755, + -0.010003619, + 0.0038467797, + -0.0212552, + -0.033482585, + -0.015572986, + 0.0037737607, + 0.01451089, + 0.0036376796, + 0.007454588, + 0.013979842, + -0.013402327, + 0.014975557, + -0.010435095, + 0.0151747, + -0.030375952, + 0.023166973, + -0.0024760119, + -0.005881358, + 0.019914305, + -0.008596341, + 0.017737007, + -0.0036111271, + 0.012499545, + -0.02647275, + 0.0053901384, + 0.008556513, + 0.019648781, + 0.00874238, + -0.012439802, + -0.028623493, + -0.022330573, + -0.0029340407, + -0.016303178, + 0.007474502, + -0.016555425, + 0.060645696, + 0.0023631642, + -0.012054792, + 0.017604245, + 0.013103612, + 0.026061187, + 0.015533158, + 0.025742557, + 0.00013753316, + -0.013940013, + 0.02880936, + 0.010109829, + -0.0036111271, + -0.012419888, + -0.045457717, + 0.022835068, + -0.014139156, + 0.007819683, + -0.010461648, + -0.012008325, + 0.008895056, + 0.015984548, + 0.024043202, + -0.00059825886, + -0.0036376796, + -0.007939169, + 0.0242689, + -0.022197811, + -0.026313433, + -0.026724996, + 0.010939592, + 0.0023449094, + -0.012074706, + -0.018493751, + 0.017697178, + -0.0052142288, + -0.00360117, + 0.0056058764, + 0.01070062, + 0.0035248317, + 0.023671469, + 0.030880447, + -0.020299314, + -0.0145905465, + 0.018055636, + -0.013727593, + -0.023313012, + 0.013236375, + -0.0020113448 + ] + } + ], + "usage": { + "prompt_tokens": 4, + "total_tokens": 4 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json new file mode 100644 index 000000000000..5cb1d840081b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_aml_index.json @@ -0,0 +1,62 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided AML index. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_ml_index", + "parameters": { + "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}", + "name": "gm-cars", + "version": "5" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json new file mode 100644 index 000000000000..c47d97c1984e --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_advanced.json @@ -0,0 +1,86 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services vector data and user-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "authentication": { + "type": "user_assigned_managed_identity", + "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}" + }, + "index_name": "{index name}", + "query_type": "vector", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "in_scope": true, + "top_n_documents": 5, + "strictness": 3, + "role_information": "You are an AI assistant that helps people find information.", + "fields_mapping": { + "content_fields_separator": "\\n", + "content_fields": [ + "content" + ], + "filepath_field": "filepath", + "title_field": "title", + "url_field": "url", + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json new file mode 100644 index 000000000000..1699f6235d2c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_image_vector.json @@ -0,0 +1,67 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services image vector data. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}", + "query_type": "vector", + "fields_mapping": { + "image_vector_fields": [ + "image_vector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json new file mode 100644 index 000000000000..b0cae005e699 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_azure_search_minimum.json @@ -0,0 +1,61 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion based on Azure Cognitive Services data and system-assigned managed identity. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_search", + "parameters": { + "endpoint": "https://your-search-endpoint.search.windows.net/", + "index_name": "{index name}" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json new file mode 100644 index 000000000000..a3c6c93ecf32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_cosmos_db.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Azure Cosmos DB. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "azure_cosmos_db", + "parameters": { + "authentication": { + "type": "connection_string", + "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000" + }, + "database_name": "vectordb", + "container_name": "azuredocs", + "index_name": "azuredocindex", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "content_fields": [ + "content" + ], + "vector_fields": [ + "contentvector" + ] + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json new file mode 100644 index 000000000000..42c38d6e1e5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_elasticsearch.json @@ -0,0 +1,66 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Elasticsearch. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "elasticsearch", + "parameters": { + "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io", + "index_name": "{index name}", + "authentication": { + "type": "key_and_key_id", + "key": "{key}", + "key_id": "{key id}" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json new file mode 100644 index 000000000000..0c5c47d71096 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_extensions_chat_completions_pinecone.json @@ -0,0 +1,78 @@ +{ + "operationId": "GetChatCompletions", + "title": "Creates a completion for the provided Pinecone resource. Uses Azure OpenAI chat extensions.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "messages": [ + { + "role": "user", + "content": "can you tell me how to care for a parrot?" + } + ], + "data_sources": [ + { + "type": "pinecone", + "parameters": { + "authentication": { + "type": "api_key", + "key": "{api key}" + }, + "environment": "{environment name}", + "index_name": "{index name}", + "embedding_dependency": { + "type": "deployment_name", + "deployment_name": "{embedding deployment name}" + }, + "fields_mapping": { + "title_field": "title", + "url_field": "url", + "filepath_field": "filepath", + "content_fields": [ + "content" + ], + "content_fields_separator": "\n" + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn", + "created": 1686676106, + "choices": [ + { + "index": 0, + "finish_reason": "stop", + "message": { + "role": "assistant", + "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!", + "context": { + "citations": [ + { + "content": "Content of the citation", + "url": "https://www.example.com", + "title": "Title of the citation", + "filepath": "path/to/file", + "chunk_id": "chunk-id" + } + ] + } + }, + "logprobs": null + } + ], + "usage": { + "completion_tokens": 557, + "prompt_tokens": 33, + "total_tokens": 590 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json new file mode 100644 index 000000000000..29795a2c140a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/generated_image_generation.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetImageGenerations", + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deploymentId": "<deployment-id>", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + }, + { + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_01.png?se=2023-10-27T17%3A45%3A09Z&...", + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json new file mode 100644 index 000000000000..29ec22d7bac7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.json @@ -0,0 +1,19 @@ +{ + "title": "Retrieves an AssistantFile.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA", + "file_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX" + }, + "responses": { + "200": { + "body": { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml new file mode 100644 index 000000000000..6eee6f078e42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_assistant_file.yaml @@ -0,0 +1,13 @@ +title: Retrieves an AssistantFile. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + file_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX +responses: + "200": + body: + id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json new file mode 100644 index 000000000000..9a550cb58094 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieve a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "message_id": "msg_as3XIk1tpVP3hdHjWBGg3uG4" + }, + "responses": { + "200": { + "body": { + "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4", + "object": "thread.message", + "created_at": 1707298421, + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.", + "annotations": [] + } + } + ], + "file_ids": [], + "assistant_id": null, + "run_id": null, + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml new file mode 100644 index 000000000000..fa03465fd4bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message.yaml @@ -0,0 +1,23 @@ +title: Retrieve a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + message_id: msg_as3XIk1tpVP3hdHjWBGg3uG4 +responses: + "200": + body: + id: msg_as3XIk1tpVP3hdHjWBGg3uG4 + object: thread.message + created_at: 1707298421 + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + role: user + content: + - type: text + text: + value: What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces. + annotations: [] + file_ids: [] + assistant_id: null + run_id: null + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json new file mode 100644 index 000000000000..461c91870ab1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.json @@ -0,0 +1,20 @@ +{ + "title": "Retrieves a message file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123", + "file_id": "file_abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml new file mode 100644 index 000000000000..6ecd21611f33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_message_file.yaml @@ -0,0 +1,14 @@ +title: Retrieves a message file. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 + file_id: file_abc123 +responses: + "200": + body: + id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json new file mode 100644 index 000000000000..24d2144a2de2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.json @@ -0,0 +1,32 @@ +{ + "title": "Gets a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q" + }, + "responses": { + "200": { + "body": { + "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "object": "thread.run", + "created_at": 1707303196, + "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "status": "completed", + "started_at": 1707303197, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1707303201, + "last_error": null, + "model": "gpt-4-1106-preview", + "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.", + "tools": [], + "file_ids": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml new file mode 100644 index 000000000000..f2c2d5018aec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run.yaml @@ -0,0 +1,26 @@ +title: Gets a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q +responses: + "200": + body: + id: run_HsO8tYM4K5AAMAHgK0J3om8Q + object: thread.run + created_at: 1707303196 + assistant_id: asst_JtTwHk28cIocgFXZPCBxhOzl + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + status: completed + started_at: 1707303197 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1707303201 + last_error: null + model: gpt-4-1106-preview + instructions: You are an AI model that empowers every person and every organization on the planet to achieve more. + tools: [] + file_ids: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json new file mode 100644 index 000000000000..2c2d2bcf175f --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh", + "run_id": "run_HsO8tYM4K5AAMAHgK0J3om8Q", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml new file mode 100644 index 000000000000..bb7817db59bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/get_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_eRNwflE3ncDYak1np6MdMHJh + run_id: run_HsO8tYM4K5AAMAHgK0J3om8Q + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json new file mode 100644 index 000000000000..7c0a8629147c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.json @@ -0,0 +1,71 @@ +{ + "title": "Creates images given a prompt.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "deployment-id": "<deployment-id>", + "body": { + "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.", + "n": 1, + "style": "natural", + "quality": "standard" + } + }, + "responses": { + "200": { + "body": { + "created": 1698342300, + "data": [ + { + "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.", + "prompt_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + }, + "profanity": { + "detected": false, + "filtered": false + }, + "custom_blocklists": { + "filtered": false, + "details": [] + } + }, + "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...", + "content_filter_results": { + "sexual": { + "severity": "safe", + "filtered": false + }, + "violence": { + "severity": "safe", + "filtered": false + }, + "hate": { + "severity": "safe", + "filtered": false + }, + "self_harm": { + "severity": "safe", + "filtered": false + } + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml new file mode 100644 index 000000000000..7d6565c27d96 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/image_generation.yaml @@ -0,0 +1,49 @@ +title: "Creates images given a prompt." +parameters: + endpoint: "{endpoint}" + api-version: "2024-09-01-preview" + deployment-id: "<deployment-id>" + body: + prompt: "In the style of WordArt, Microsoft Clippy wearing a cowboy hat." + n: 1 + style: "natural" + quality: "standard" +responses: + "200": + body: + created: 1698342300 + data: + - revised_prompt: "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat." + prompt_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false + profanity: + detected: false + filtered: false + custom_blocklists: + filtered: false + details: [] + url: "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&..." + content_filter_results: + sexual: + severity: "safe" + filtered: false + violence: + severity: "safe" + filtered: false + hate: + severity: "safe" + filtered: false + self_harm: + severity: "safe" + filtered: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json new file mode 100644 index 000000000000..31f785c226a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.json @@ -0,0 +1,26 @@ +{ + "title": "Returns a list of assistant files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "object": "assistant.file", + "created_at": 1707324164, + "assistant_id": "asst_diz3BOIsXHMnqNnoMCyO9jlA" + } + ], + "first_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "last_id": "assistant-Vau3gDQ1MfiBJk4flihOxwZX", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml new file mode 100644 index 000000000000..92c75a510af7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistant_files.yaml @@ -0,0 +1,17 @@ +title: Returns a list of assistant files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA +responses: + "200": + body: + object: list + data: + - id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + object: assistant.file + created_at: 1707324164 + assistant_id: asst_diz3BOIsXHMnqNnoMCyO9jlA + first_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + last_id: assistant-Vau3gDQ1MfiBJk4flihOxwZX + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json new file mode 100644 index 000000000000..f4a76a772dec --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.json @@ -0,0 +1,70 @@ +{ + "title": "Returns a list of assistants.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "order": "desc", + "limit": 20 + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1707257477, + "name": "Stock Analyst", + "description": null, + "model": "gpt-4-1106-preview", + "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.", + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc456", + "object": "assistant", + "created_at": 1698982718, + "name": "My Assistant", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are a helpful assistant designed to make me better at coding!", + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + }, + { + "id": "asst_abc789", + "object": "assistant", + "created_at": 1698982643, + "name": null, + "description": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [], + "tool_resources": {}, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + ], + "first_id": "asst_abc123", + "last_id": "asst_abc789", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml new file mode 100644 index 000000000000..dad9fa73c64d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_assistants.yaml @@ -0,0 +1,54 @@ +title: Returns a list of assistants. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + order: desc + limit: 20 +responses: + "200": + body: + object: list + data: + - id: asst_abc123 + object: assistant + created_at: 1707257477 + name: Stock Analyst + description: null + model: gpt-4-1106-preview + instructions: You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs. + tools: + - type: code_interpreter + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc456 + object: assistant + created_at: 1698982718 + name: My Assistant + description: null + model: gpt-4-turbo + instructions: You are a helpful assistant designed to make me better at coding! + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + - id: asst_abc789 + object: assistant + created_at: 1698982643 + name: null + description: null + model: gpt-4-turbo + instructions: null + tools: [] + tool_resources: {} + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto + first_id: asst_abc123 + last_id: asst_abc789 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json new file mode 100644 index 000000000000..d572b8884185 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of message files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + }, + { + "id": "file-abc123", + "object": "thread.message.file", + "created_at": 1699061776, + "message_id": "msg_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc123", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml new file mode 100644 index 000000000000..caa7a4a4d8ef --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_message_files.yaml @@ -0,0 +1,22 @@ +title: Returns a list of message files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + - id: file-abc123 + object: thread.message.file + created_at: 1699061776 + message_id: msg_abc123 + first_id: file-abc123 + last_id: file-abc123 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json new file mode 100644 index 000000000000..d52370c6be20 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.json @@ -0,0 +1,60 @@ +{ + "title": "List Messages", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + }, + { + "id": "msg_abc456", + "object": "thread.message", + "created_at": 1699016383, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "Hello, what is AI?", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + ], + "first_id": "msg_abc123", + "last_id": "msg_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml new file mode 100644 index 000000000000..70e6ce9e569d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_messages.yaml @@ -0,0 +1,41 @@ +title: List Messages +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: msg_abc123 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} + - id: msg_abc456 + object: thread.message + created_at: 1699016383 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: Hello, what is AI? + annotations: [] + attachments: [] + metadata: {} + first_id: msg_abc123 + last_id: msg_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json new file mode 100644 index 000000000000..dc4d16ef63fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of run steps belonging to a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + ], + "first_id": "step_abc123", + "last_id": "step_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml new file mode 100644 index 000000000000..3a5bb39ce519 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_run_steps.yaml @@ -0,0 +1,35 @@ +title: Returns a list of run steps belonging to a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + object: list + data: + - id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + first_id: step_abc123 + last_id: step_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json new file mode 100644 index 000000000000..3fc2080000a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.json @@ -0,0 +1,112 @@ +{ + "title": "Returns a list of runs belonging to a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + }, + { + "id": "run_abc456", + "object": "thread.run", + "created_at": 1699063290, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699063290, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699063291, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + ], + "first_id": "run_abc123", + "last_id": "run_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml new file mode 100644 index 000000000000..b25871083c0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_runs.yaml @@ -0,0 +1,85 @@ +title: Returns a list of runs belonging to a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 +responses: + "200": + body: + object: list + data: + - id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + - id: run_abc456 + object: thread.run + created_at: 1699063290 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699063290 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699063291 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + tool_resources: + code_interpreter: + file_ids: + - file-abc123 + - file-abc456 + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto + first_id: run_abc123 + last_id: run_abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json new file mode 100644 index 000000000000..ae13119d54c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.json @@ -0,0 +1,33 @@ +{ + "title": "Returns a list of vector store files in a batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml new file mode 100644 index 000000000000..3e0c13a705c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_file_batch.yaml @@ -0,0 +1,22 @@ +title: Returns a list of vector store files in a batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json new file mode 100644 index 000000000000..6959a228ef94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.json @@ -0,0 +1,32 @@ +{ + "title": "Returns a list of vector store files.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + }, + { + "id": "file-abc456", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abc123" + } + ], + "first_id": "file-abc123", + "last_id": "file-abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml new file mode 100644 index 000000000000..e29484eae667 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_store_files.yaml @@ -0,0 +1,21 @@ +title: Returns a list of vector store files. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + object: list + data: + - id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + - id: file-abc456 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abc123 + first_id: file-abc123 + last_id: file-abc456 + has_more: false diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json new file mode 100644 index 000000000000..f11095daaa53 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.json @@ -0,0 +1,47 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "object": "list", + "data": [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml new file mode 100644 index 000000000000..2d8c453d3c4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/list_vector_stores.yaml @@ -0,0 +1,51 @@ +{ + "title": "Returns a list of vector stores.", + "parameters": + { "endpoint": "{endpoint}", "api-version": "2024-09-01-preview" }, + "responses": + { + "200": + { + "body": + { + "object": "list", + "data": + [ + { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + { + "id": "vs_abc456", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ v2", + "bytes": 139920, + "file_counts": + { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3, + }, + }, + ], + "first_id": "vs_abc123", + "last_id": "vs_abc456", + "has_more": false, + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json new file mode 100644 index 000000000000..243a12679843 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.json @@ -0,0 +1,44 @@ +{ + "title": "Modifies an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_abc123", + "body": { + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "model": "gpt-4-turbo" + } + }, + "responses": { + "200": { + "body": { + "id": "asst_123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.", + "tools": [ + { + "type": "file_search" + } + ], + "tool_resources": { + "file_search": { + "vector_store_ids": [] + } + }, + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml new file mode 100644 index 000000000000..d950b17bee07 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_assistant.yaml @@ -0,0 +1,29 @@ +title: Modifies an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_abc123 + body: + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + model: gpt-4-turbo +responses: + "200": + body: + id: asst_123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files. + tools: + - type: file_search + tool_resources: + file_search: + vector_store_ids: [] + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json new file mode 100644 index 000000000000..cd2bdf2378e7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.json @@ -0,0 +1,42 @@ +{ + "title": "Modify a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123 ", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "file_ids": [], + "metadata": { + "modified": "true", + "user": "abc123" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml new file mode 100644 index 000000000000..91c015766fe8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_message.yaml @@ -0,0 +1,29 @@ +title: Modify a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: "msg_abc123 " + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + file_ids: [] + metadata: + modified: "true" + user: abc123 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json new file mode 100644 index 000000000000..99524da44988 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.json @@ -0,0 +1,66 @@ +{ + "title": "Modifies a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { + "metadata": { + "user_id": "user_abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "tool_resources": { + "code_interpreter": { + "file_ids": [ + "file-abc123", + "file-abc456" + ] + } + }, + "metadata": { + "user_id": "user_abc123" + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml new file mode 100644 index 000000000000..7933976c0973 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_run.yaml @@ -0,0 +1,55 @@ +{ + "title": "Modifies a run.", + "parameters": + { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "body": { "metadata": { "user_id": "user_abc123" } }, + }, + "responses": + { + "200": + { + "body": + { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [{ "type": "code_interpreter" }], + "tool_resources": + { + "code_interpreter": + { "file_ids": ["file-abc123", "file-abc456"] }, + }, + "metadata": { "user_id": "user_abc123" }, + "usage": + { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579, + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { "type": "auto", "last_messages": null }, + "response_format": "auto", + "tool_choice": "auto", + }, + }, + }, +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json new file mode 100644 index 000000000000..6aaaebeea592 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.json @@ -0,0 +1,28 @@ +{ + "title": "Modifies a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "body": { + "metadata": { + "modified": "true", + "user": "abc123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": { + "modified": "true", + "user": "abc123" + }, + "tool_resources": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml new file mode 100644 index 000000000000..1b5d1bfdde6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_thread.yaml @@ -0,0 +1,19 @@ +title: Modifies a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx + body: + metadata: + modified: "true" + user: abc123 +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: + modified: "true" + user: abc123 + tool_resources: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json new file mode 100644 index 000000000000..35e295f4f080 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.json @@ -0,0 +1,29 @@ +{ + "title": "Modifies a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "body": { + "name": "Support FAQ" + } + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776, + "name": "Support FAQ", + "bytes": 139920, + "file_counts": { + "in_progress": 0, + "completed": 3, + "failed": 0, + "cancelled": 0, + "total": 3 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml new file mode 100644 index 000000000000..ddc3879fee79 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/modify_vector_store.yaml @@ -0,0 +1,21 @@ +title: Modifies a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + body: + name: Support FAQ +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 + name: Support FAQ + bytes: 139920 + file_counts: + in_progress: 0 + completed: 3 + failed: 0 + cancelled: 0 + total: 3 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json new file mode 100644 index 000000000000..90cf5d8b1d9a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.json @@ -0,0 +1,30 @@ +{ + "title": "Retrieves an assistant.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "assistant_id": "asst_abc123" + }, + "responses": { + "200": { + "body": { + "id": "asst_abc123", + "object": "assistant", + "created_at": 1699009709, + "name": "HR Helper", + "description": null, + "model": "gpt-4-turbo", + "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.", + "tools": [ + { + "type": "file_search" + } + ], + "metadata": {}, + "top_p": 1.0, + "temperature": 1.0, + "response_format": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml new file mode 100644 index 000000000000..c98fe77bbe8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_assistant.yaml @@ -0,0 +1,21 @@ +title: Retrieves an assistant. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + assistant_id: asst_abc123 +responses: + "200": + body: + id: asst_abc123 + object: assistant + created_at: 1699009709 + name: HR Helper + description: null + model: gpt-4-turbo + instructions: You are an HR bot, and you have access to files to answer employee questions about company policies. + tools: + - type: file_search + metadata: {} + top_p: 1 + temperature: 1 + response_format: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json new file mode 100644 index 000000000000..2c79c290e8fd --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.json @@ -0,0 +1,33 @@ +{ + "title": "Retrieves a message.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "message_id": "msg_abc123" + }, + "responses": { + "200": { + "body": { + "id": "msg_abc123", + "object": "thread.message", + "created_at": 1699017614, + "assistant_id": null, + "thread_id": "thread_abc123", + "run_id": null, + "role": "user", + "content": [ + { + "type": "text", + "text": { + "value": "How does AI work? Explain it in simple terms.", + "annotations": [] + } + } + ], + "attachments": [], + "metadata": {} + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml new file mode 100644 index 000000000000..4421dd91cb1a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_message.yaml @@ -0,0 +1,23 @@ +title: Retrieves a message. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + message_id: msg_abc123 +responses: + "200": + body: + id: msg_abc123 + object: thread.message + created_at: 1699017614 + assistant_id: null + thread_id: thread_abc123 + run_id: null + role: user + content: + - type: text + text: + value: How does AI work? Explain it in simple terms. + annotations: [] + attachments: [] + metadata: {} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json new file mode 100644 index 000000000000..ede9a4a06f59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.json @@ -0,0 +1,51 @@ +{ + "title": "Retrieves a run.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123" + }, + "responses": { + "200": { + "body": { + "id": "run_abc123", + "object": "thread.run", + "created_at": 1699075072, + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "status": "completed", + "started_at": 1699075072, + "expires_at": null, + "cancelled_at": null, + "failed_at": null, + "completed_at": 1699075073, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "incomplete_details": null, + "tools": [ + { + "type": "code_interpreter" + } + ], + "metadata": {}, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + }, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml new file mode 100644 index 000000000000..41f1160397ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run.yaml @@ -0,0 +1,40 @@ +title: Retrieves a run. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 +responses: + "200": + body: + id: run_abc123 + object: thread.run + created_at: 1699075072 + assistant_id: asst_abc123 + thread_id: thread_abc123 + status: completed + started_at: 1699075072 + expires_at: null + cancelled_at: null + failed_at: null + completed_at: 1699075073 + last_error: null + model: gpt-4-turbo + instructions: null + incomplete_details: null + tools: + - type: code_interpreter + metadata: {} + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json new file mode 100644 index 000000000000..517db84138e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.json @@ -0,0 +1,40 @@ +{ + "title": "Retrieves a run step.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_abc123", + "run_id": "run_abc123", + "step_id": "step_abc123" + }, + "responses": { + "200": { + "body": { + "id": "step_abc123", + "object": "thread.run.step", + "created_at": 1699063291, + "run_id": "run_abc123", + "assistant_id": "asst_abc123", + "thread_id": "thread_abc123", + "type": "message_creation", + "status": "completed", + "cancelled_at": null, + "completed_at": 1699063291, + "expired_at": null, + "failed_at": null, + "last_error": null, + "step_details": { + "type": "message_creation", + "message_creation": { + "message_id": "msg_abc123" + } + }, + "usage": { + "prompt_tokens": 123, + "completion_tokens": 456, + "total_tokens": 579 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml new file mode 100644 index 000000000000..567775bf38c9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_run_step.yaml @@ -0,0 +1,31 @@ +title: Retrieves a run step. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_abc123 + run_id: run_abc123 + step_id: step_abc123 +responses: + "200": + body: + id: step_abc123 + object: thread.run.step + created_at: 1699063291 + run_id: run_abc123 + assistant_id: asst_abc123 + thread_id: thread_abc123 + type: message_creation + status: completed + cancelled_at: null + completed_at: 1699063291 + expired_at: null + failed_at: null + last_error: null + step_details: + type: message_creation + message_creation: + message_id: msg_abc123 + usage: + prompt_tokens: 123 + completion_tokens: 456 + total_tokens: 579 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json new file mode 100644 index 000000000000..437233e6c135 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.json @@ -0,0 +1,23 @@ +{ + "title": "Retrieves a thread.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx" + }, + "responses": { + "200": { + "body": { + "id": "thread_v7V4csrNOxtNmgcwGg496Smx", + "object": "thread", + "created_at": 1707297136, + "metadata": {}, + "tool_resources": { + "code_interpreter": { + "file_ids": [] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml new file mode 100644 index 000000000000..e3e9046858f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_thread.yaml @@ -0,0 +1,15 @@ +title: Retrieves a thread. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_v7V4csrNOxtNmgcwGg496Smx +responses: + "200": + body: + id: thread_v7V4csrNOxtNmgcwGg496Smx + object: thread + created_at: 1707297136 + metadata: {} + tool_resources: + code_interpreter: + file_ids: [] diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json new file mode 100644 index 000000000000..d961c14ca4db --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.json @@ -0,0 +1,17 @@ +{ + "title": "Retrieves a vector store.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vs_abc123", + "object": "vector_store", + "created_at": 1699061776 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml new file mode 100644 index 000000000000..b8c1d099df73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store.yaml @@ -0,0 +1,11 @@ +title: Retrieves a vector store. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 +responses: + "200": + body: + id: vs_abc123 + object: vector_store + created_at: 1699061776 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json new file mode 100644 index 000000000000..0786a19ff5d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.json @@ -0,0 +1,21 @@ +{ + "title": "Retrieves a vector store file.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "file_id": "file-abc123" + }, + "responses": { + "200": { + "body": { + "id": "file-abc123", + "object": "vector_store.file", + "created_at": 1699061776, + "vector_store_id": "vs_abcd", + "status": "completed", + "last_error": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml new file mode 100644 index 000000000000..0601c2490c0a --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file.yaml @@ -0,0 +1,15 @@ +title: Retrieves a vector store file. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + file_id: file-abc123 +responses: + "200": + body: + id: file-abc123 + object: vector_store.file + created_at: 1699061776 + vector_store_id: vs_abcd + status: completed + last_error: null diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json new file mode 100644 index 000000000000..128b84bf8206 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.json @@ -0,0 +1,27 @@ +{ + "title": "Retrieves a vector store file batch.", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "vector_store_id": "vs_abc123", + "batch_id": "vsfb_abc123" + }, + "responses": { + "200": { + "body": { + "id": "vsfb_abc123", + "object": "vector_store.file_batch", + "created_at": 1699061776, + "vector_store_id": "vs_abc123", + "status": "in_progress", + "file_counts": { + "in_progress": 1, + "completed": 1, + "failed": 0, + "cancelled": 0, + "total": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml new file mode 100644 index 000000000000..66df30f983ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/retrieve_vector_store_file_batch.yaml @@ -0,0 +1,20 @@ +title: Retrieves a vector store file batch. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + vector_store_id: vs_abc123 + batch_id: vsfb_abc123 +responses: + "200": + body: + id: vsfb_abc123 + object: vector_store.file_batch + created_at: 1699061776 + vector_store_id: vs_abc123 + status: in_progress + file_counts: + in_progress: 1 + completed: 1 + failed: 0 + cancelled: 0 + total: 0 diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json new file mode 100644 index 000000000000..d327d5ddace9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.json @@ -0,0 +1,77 @@ +{ + "title": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": { + "endpoint": "{endpoint}", + "api-version": "2024-09-01-preview", + "thread_id": "thread_123", + "run_id": "run_123", + "body": { + "tool_outputs": [ + { + "tool_call_id": "call_001", + "output": "70 degrees and sunny." + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "run_123", + "object": "thread.run", + "created_at": 1699075592, + "assistant_id": "asst_123", + "thread_id": "thread_123", + "status": "queued", + "started_at": 1699075592, + "expires_at": 1699076192, + "cancelled_at": null, + "failed_at": null, + "completed_at": null, + "last_error": null, + "model": "gpt-4-turbo", + "instructions": null, + "tools": [ + { + "type": "function", + "function": { + "name": "get_current_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location" + ] + } + } + } + ], + "metadata": {}, + "usage": null, + "temperature": 1.0, + "top_p": 1.0, + "max_prompt_tokens": 1000, + "max_completion_tokens": 1000, + "truncation_strategy": { + "type": "auto", + "last_messages": null + }, + "response_format": "auto", + "tool_choice": "auto" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml new file mode 100644 index 000000000000..5b1d569c4cfc --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/examples/submit_tool_outputs_to_run.yaml @@ -0,0 +1,57 @@ +title: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. +parameters: + endpoint: "{endpoint}" + api-version: 2024-09-01-preview + thread_id: thread_123 + run_id: run_123 + body: + tool_outputs: + - tool_call_id: call_001 + output: 70 degrees and sunny. +responses: + "200": + body: + id: run_123 + object: thread.run + created_at: 1699075592 + assistant_id: asst_123 + thread_id: thread_123 + status: queued + started_at: 1699075592 + expires_at: 1699076192 + cancelled_at: null + failed_at: null + completed_at: null + last_error: null + model: gpt-4-turbo + instructions: null + tools: + - type: function + function: + name: get_current_weather + description: Get the current weather in a given location + parameters: + type: object + properties: + location: + type: string + description: The city and state, e.g. San Francisco, CA + unit: + type: string + enum: + - celsius + - fahrenheit + required: + - location + metadata: {} + usage: null + temperature: 1 + top_p: 1 + max_prompt_tokens: 1000 + max_completion_tokens: 1000 + truncation_strategy: + type: auto + last_messages: null + response_format: auto + tool_choice: auto diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json new file mode 100644 index 000000000000..3be6ffd7734d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json @@ -0,0 +1,12043 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2024-09-01-preview" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionRequest" + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createCompletionResponse" + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a completion.": { + "$ref": "./examples/completions.json" + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length.\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "encoding_format": { + "description": "The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`.", + "type": "string", + "example": "float", + "nullable": true + }, + "dimensions": { + "description": "The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.", + "type": "integer", + "example": 1, + "nullable": true + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + }, + "x-ms-examples": { + "Create a embeddings.": { + "$ref": "./examples/embeddings.json" + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createChatCompletionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/createChatCompletionResponse" + }, + { + "$ref": "#/components/schemas/createChatCompletionStreamResponse" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + }, + "x-ms-examples": { + "Create a chat completion.": { + "$ref": "./examples/chat_completions.json" + }, + "Creates a completion based on Azure Search data and system-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_minimum.json" + }, + "Creates a completion based on Azure Search image vector data.": { + "$ref": "./examples/chat_completions_azure_search_image_vector.json" + }, + "Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.": { + "$ref": "./examples/chat_completions_azure_search_advanced.json" + }, + "Creates a completion for the provided Azure Cosmos DB.": { + "$ref": "./examples/chat_completions_cosmos_db.json" + }, + "Creates a completion for the provided Mongo DB.": { + "$ref": "./examples/chat_completions_mongo_db.json" + }, + "Creates a completion for the provided Elasticsearch.": { + "$ref": "./examples/chat_completions_elasticsearch.json" + }, + "Creates a completion for the provided Pinecone resource.": { + "$ref": "./examples/chat_completions_pinecone.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/transcriptions": { + "post": { + "summary": "Transcribes audio into the input language.", + "operationId": "Transcriptions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranscriptionRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio transcription with json response format.": { + "$ref": "./examples/audio_transcription_object.json" + }, + "Create an audio transcription with text response format.": { + "$ref": "./examples/audio_transcription_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/translations": { + "post": { + "summary": "Transcribes and translates input audio into English text.", + "operationId": "Translations_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "whisper", + "description": "Deployment id of the whisper model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createTranslationRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "$ref": "#/components/schemas/audioVerboseResponse" + } + ] + } + }, + "text/plain": { + "schema": { + "type": "string", + "description": "Transcribed text in the output format (when response_format was one of text, vtt or srt)." + } + } + } + } + }, + "x-ms-examples": { + "Create an audio translation with json response format.": { + "$ref": "./examples/audio_translation_object.json" + }, + "Create an audio translation with text response format.": { + "$ref": "./examples/audio_translation_text.json" + } + } + } + }, + "/deployments/{deployment-id}/audio/speech": { + "post": { + "summary": "Generates audio from the input text.", + "operationId": "Speech_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "tts-1", + "description": "Deployment id of the tts model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/createSpeechRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + }, + "x-ms-examples": { + "Create an audio from text with response format mp3.": { + "$ref": "./examples/audio_speech.json" + } + } + } + }, + "/deployments/{deployment-id}/images/generations": { + "post": { + "summary": "Generates a batch of images from a text caption on a given DALLE model deployment", + "operationId": "ImageGenerations_Create", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/imageGenerationsRequest" + } + } + } + }, + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "dalle-deployment", + "description": "Deployment id of the dalle model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generateImagesResponse" + } + } + } + }, + "default": { + "description": "An error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dalleErrorResponse" + } + } + } + } + }, + "x-ms-examples": { + "Create an image.": { + "$ref": "./examples/image_generation.json" + } + } + } + }, + "/assistants": { + "get": { + "operationId": "List_Assistants", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of assistants.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListAssistantsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listAssistantsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all assistants.": { + "$ref": "./examples/list_assistants.json" + } + } + }, + "post": { + "operationId": "Create_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Create an assistant with a model and instructions.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Create an assistant.": { + "$ref": "./examples/create_assistant.json" + } + } + } + }, + "/assistants/{assistant_id}": { + "get": { + "operationId": "Get_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Retrieves an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieves an assistant.": { + "$ref": "./examples/retrieve_assistant.json" + } + } + }, + "post": { + "operationId": "Modify_Assistant", + "tags": [ + "Assistant" + ], + "summary": "Modifies an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyAssistantRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/assistantObject" + } + } + } + } + }, + "x-ms-examples": { + "Modifies an assistant.": { + "$ref": "./examples/modify_assistant.json" + } + } + }, + "delete": { + "operationId": "Delete_Assistant", + "tags": [ + "Assistants" + ], + "summary": "Delete an assistant.", + "parameters": [ + { + "in": "path", + "name": "assistant_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the assistant to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteAssistantResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete an assistant.": { + "$ref": "./examples/delete_assistant.json" + } + } + } + }, + "/threads": { + "post": { + "operationId": "Create_Thread", + "tags": [ + "Assistants" + ], + "summary": "Create a thread.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread.": { + "$ref": "./examples/create_thread.json" + } + } + } + }, + "/threads/{thread_id}": { + "get": { + "operationId": "Get_Thread", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a thread.": { + "$ref": "./examples/retrieve_thread.json" + } + } + }, + "post": { + "operationId": "Modify_Thread", + "tags": [ + "Assistants" + ], + "summary": "Modifies a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to modify. Only the `metadata` can be modified." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyThreadRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/threadObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a thread.": { + "$ref": "./examples/modify_thread.json" + } + } + }, + "delete": { + "operationId": "Delete_Thread", + "tags": [ + "Assistants" + ], + "summary": "Delete a thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteThreadResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a thread.": { + "$ref": "./examples/delete_thread.json" + } + } + } + }, + "/threads/{thread_id}/messages": { + "get": { + "operationId": "List_Messages", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of messages for a given thread.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) the messages belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListMessagesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "in": "query", + "description": "Filter messages by the run ID that generated them.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listMessagesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all messages.": { + "$ref": "./examples/list_messages.json" + } + } + }, + "post": { + "operationId": "Create_Message", + "tags": [ + "Assistants" + ], + "summary": "Create a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to create a message for." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a message.": { + "$ref": "./examples/create_message.json" + } + } + } + }, + "/threads/{thread_id}/messages/{message_id}": { + "get": { + "operationId": "Get_Message", + "tags": [ + "Assistants" + ], + "summary": "Retrieve a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a message.": { + "$ref": "./examples/get_message.json" + } + } + }, + "post": { + "operationId": "Modify_Message", + "tags": [ + "Assistants" + ], + "summary": "Modifies a message.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this message belongs." + }, + { + "in": "path", + "name": "message_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the message to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyMessageRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a message.": { + "$ref": "./examples/modify_message.json" + } + } + } + }, + "/threads/runs": { + "post": { + "operationId": "Create_Thread_And_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a thread and run it in one request.", + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createThreadAndRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a thread and run it.": { + "$ref": "./examples/create_thread_and_run.json" + } + } + } + }, + "/threads/{thread_id}/runs": { + "get": { + "operationId": "List_Runs", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of runs belonging to a thread.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run belongs to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all runs.": { + "$ref": "./examples/list_runs.json" + } + } + }, + "post": { + "operationId": "Create_Run", + "tags": [ + "Assistants" + ], + "summary": "Create a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to run." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a run.": { + "$ref": "./examples/create_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}": { + "get": { + "operationId": "Get_Run", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run.": { + "$ref": "./examples/get_run.json" + } + } + }, + "post": { + "operationId": "Modify_Run", + "tags": [ + "Assistants" + ], + "summary": "Modifies a run.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) that was run." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a run.": { + "$ref": "./examples/modify_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/submit_tool_outputs": { + "post": { + "operationId": "Submit_Tool_Outputs_To_Run", + "tags": [ + "Assistants" + ], + "summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.\n", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the [thread](/docs/api-reference/threads) to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run that requires the tool output submission." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/submitToolOutputsRunRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Submit tool outputs to a run.": { + "$ref": "./examples/submit_tool_outputs_to_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/cancel": { + "post": { + "operationId": "Cancel_Run", + "tags": [ + "Assistants" + ], + "summary": "Cancels a run that is `in_progress`.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which this run belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a run.": { + "$ref": "./examples/cancel_run.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps": { + "get": { + "operationId": "List_Run_Steps", + "tags": [ + "Assistants" + ], + "summary": "Returns a list of run steps belonging to a run.", + "parameters": [ + { + "name": "thread_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread the run and run steps belong to." + }, + { + "name": "run_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run the run steps belong to." + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListRunStepsOrder", + "modelAsString": true, + "values": [ + { + "value": "asc", + "description": "Order results in ascending order" + }, + { + "value": "desc", + "description": "Order results in descending order" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listRunStepsResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all run steps.": { + "$ref": "./examples/list_run_steps.json" + } + } + } + }, + "/threads/{thread_id}/runs/{run_id}/steps/{step_id}": { + "get": { + "operationId": "Get_Run_Step", + "tags": [ + "Assistants" + ], + "summary": "Retrieves a run step.", + "parameters": [ + { + "in": "path", + "name": "thread_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the thread to which the run and run step belongs." + }, + { + "in": "path", + "name": "run_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run to which the run step belongs." + }, + { + "in": "path", + "name": "step_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the run step to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview", + "description": "api version" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/runStepObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a run step.": { + "$ref": "./examples/get_run_step.json" + } + } + } + }, + "/vector_stores": { + "get": { + "operationId": "List_Vector_Stores", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector stores.", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoresOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoresResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector stores.": { + "$ref": "./examples/list_vector_stores.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store.", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreRequest" + } + } + } + }, + "parameters": [ + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store.": { + "$ref": "./examples/create_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}": { + "get": { + "operationId": "Get_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to retrieve." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store.": { + "$ref": "./examples/retrieve_vector_store.json" + } + } + }, + "post": { + "operationId": "Modify_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Modifies a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to modify." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/updateVectorStoreRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreObject" + } + } + } + } + }, + "x-ms-examples": { + "Modify a vector store.": { + "$ref": "./examples/modify_vector_store.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store.": { + "$ref": "./examples/delete_vector_store.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files": { + "get": { + "operationId": "List_Vector_Store_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + }, + "post": { + "operationId": "Create_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file.": { + "$ref": "./examples/create_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/files/{file_id}": { + "get": { + "operationId": "Get_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string", + "example": "file-abc123" + }, + "description": "The ID of the file being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file.": { + "$ref": "./examples/retrieve_vector_store_file.json" + } + } + }, + "delete": { + "operationId": "Delete_Vector_Store_File", + "tags": [ + "Vector Stores" + ], + "summary": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file belongs to." + }, + { + "in": "path", + "name": "file_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file to delete." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteVectorStoreFileResponse" + } + } + } + } + }, + "x-ms-examples": { + "Delete a vector store file.": { + "$ref": "./examples/delete_vector_store_file.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches": { + "post": { + "operationId": "Create_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Create a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store for which to create a File Batch.\n" + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createVectorStoreFileBatchRequest" + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Create a vector store file batch.": { + "$ref": "./examples/create_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}": { + "get": { + "operationId": "Get_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Retrieves a vector store file batch.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_abc123" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string", + "example": "vs_b_abc123" + }, + "description": "The ID of the file batch being retrieved." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Retrieve a vector store file batch.": { + "$ref": "./examples/retrieve_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel": { + "post": { + "operationId": "Cancel_Vector_Store_File_Batch", + "tags": [ + "Vector Stores" + ], + "summary": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.", + "parameters": [ + { + "in": "path", + "name": "vector_store_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the vector store that the file batch belongs to." + }, + { + "in": "path", + "name": "batch_id", + "required": true, + "schema": { + "type": "string" + }, + "description": "The ID of the file batch to cancel." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vectorStoreFileBatchObject" + } + } + } + } + }, + "x-ms-examples": { + "Cancel a vector store file batch.": { + "$ref": "./examples/cancel_vector_store_file_batch.json" + } + } + } + }, + "/vector_stores/{vector_store_id}/file_batches/{batch_id}/files": { + "get": { + "operationId": "List_Vector_Store_File_Batch_Files", + "tags": [ + "Vector Stores" + ], + "summary": "Returns a list of vector store files in a batch.", + "parameters": [ + { + "name": "vector_store_id", + "in": "path", + "description": "The ID of the vector store that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "batch_id", + "in": "path", + "description": "The ID of the file batch that the files belong to.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n", + "required": false, + "schema": { + "type": "integer", + "default": 20 + } + }, + { + "name": "order", + "in": "query", + "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n", + "schema": { + "type": "string", + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesOrder", + "modelAsString": true, + "values": [ + { + "value": "asc" + }, + { + "value": "desc" + } + ] + } + } + }, + { + "name": "after", + "in": "query", + "description": "A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "before", + "in": "query", + "description": "A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.\n", + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "in": "query", + "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.", + "schema": { + "type": "string", + "enum": [ + "in_progress", + "completed", + "failed", + "cancelled" + ], + "x-ms-enum": { + "name": "ListVectorStoreFilesFilter", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "failed" + }, + { + "value": "cancelled" + } + ] + } + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2024-09-01-preview" + }, + "description": "api version" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/listVectorStoreFilesResponse" + } + } + } + } + }, + "x-ms-examples": { + "List all vector store files in a batch.": { + "$ref": "./examples/list_vector_store_files.json" + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/error" + } + } + }, + "errorBase": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/innerError" + } + } + }, + "innerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "innerErrorCode": { + "description": "Error codes for the inner error object.", + "enum": [ + "ResponsibleAIPolicyViolation" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "ResponsibleAIPolicyViolation", + "description": "The prompt violated one of more content filter rules." + } + ] + } + }, + "dalleErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/components/schemas/dalleError" + } + } + }, + "dalleError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/errorBase" + } + ], + "properties": { + "param": { + "type": "string" + }, + "type": { + "type": "string" + }, + "inner_error": { + "$ref": "#/components/schemas/dalleInnerError" + } + } + }, + "dalleInnerError": { + "description": "Inner error with additional details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/innerErrorCode" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + } + } + }, + "contentFilterResultBase": { + "type": "object", + "properties": { + "filtered": { + "type": "boolean" + } + }, + "required": [ + "filtered" + ] + }, + "contentFilterSeverityResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "severity": { + "type": "string", + "enum": [ + "safe", + "low", + "medium", + "high" + ], + "x-ms-enum": { + "name": "ContentFilterSeverity", + "modelAsString": true, + "values": [ + { + "value": "safe", + "description": "General content or related content in generic or non-harmful contexts." + }, + { + "value": "low", + "description": "Harmful content at a low intensity and risk level." + }, + { + "value": "medium", + "description": "Harmful content at a medium intensity and risk level." + }, + { + "value": "high", + "description": "Harmful content at a high intensity and risk level." + } + ] + } + } + } + } + ], + "required": [ + "severity", + "filtered" + ] + }, + "contentFilterDetectedResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "detected": { + "type": "boolean" + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterDetectedWithCitationResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + { + "properties": { + "citation": { + "type": "object", + "properties": { + "URL": { + "type": "string" + }, + "license": { + "type": "string" + } + } + } + } + } + ], + "required": [ + "detected", + "filtered" + ] + }, + "contentFilterIdResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "id": { + "type": "string" + } + } + } + ], + "required": [ + "id", + "filtered" + ] + }, + "contentFilterResultsBase": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + }, + "error": { + "$ref": "#/components/schemas/errorBase" + } + } + }, + "contentFilterPromptResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "indirect_attack": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + } + ] + }, + "contentFilterChoiceResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultsBase" + }, + { + "properties": { + "protected_material_text": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + } + } + }, + { + "properties": { + "protected_material_code": { + "$ref": "#/components/schemas/contentFilterDetectedWithCitationResult" + } + } + } + ] + }, + "contentFilterDetailedResults": { + "type": "object", + "description": "Content filtering results with a detail of content filter ids for the filtered segments.", + "allOf": [ + { + "$ref": "#/components/schemas/contentFilterResultBase" + }, + { + "properties": { + "details": { + "items": { + "$ref": "#/components/schemas/contentFilterIdResult" + }, + "type": "array" + } + } + } + ], + "required": [ + "filtered", + "details" + ] + }, + "promptFilterResult": { + "type": "object", + "description": "Content filtering results for a single prompt in the request.", + "properties": { + "prompt_index": { + "type": "integer" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterPromptResults" + } + } + }, + "promptFilterResults": { + "type": "array", + "description": "Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.", + "items": { + "$ref": "#/components/schemas/promptFilterResult" + } + }, + "dalleContentFilterResults": { + "type": "object", + "description": "Information about the content filtering results.", + "properties": { + "sexual": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "violence": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "hate": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + }, + "self_harm": { + "$ref": "#/components/schemas/contentFilterSeverityResult" + } + } + }, + "dalleFilterResults": { + "type": "object", + "description": "Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id.", + "allOf": [ + { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + { + "properties": { + "profanity": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "jailbreak": { + "$ref": "#/components/schemas/contentFilterDetectedResult" + }, + "custom_blocklists": { + "$ref": "#/components/schemas/contentFilterDetailedResults" + } + } + } + ] + }, + "chatCompletionsRequestCommon": { + "type": "object", + "properties": { + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models.", + "type": "integer", + "default": 4096 + }, + "max_completion_tokens": { + "description": "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.", + "type": "integer", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + } + }, + "createCompletionRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n", + "default": "<|endoftext|>", + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test." + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test." + } + } + ] + }, + "best_of": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20, + "nullable": true, + "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "echo": { + "type": "boolean", + "default": false, + "nullable": true, + "description": "Echo back the prompt in addition to the completion\n" + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "x-oaiTypeLabel": "map", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n" + }, + "logprobs": { + "type": "integer", + "minimum": 0, + "maximum": 5, + "default": null, + "nullable": true, + "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n" + }, + "max_tokens": { + "type": "integer", + "minimum": 0, + "default": 16, + "example": 16, + "nullable": true, + "description": "The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n" + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n" + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.\n", + "default": null, + "nullable": true, + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string", + "example": "[\"\\n\"]" + } + } + ] + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "suffix": { + "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n", + "default": null, + "nullable": true, + "type": "string", + "example": "test." + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "prompt" + ] + }, + "createCompletionResponse": { + "type": "object", + "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the completion." + }, + "choices": { + "type": "array", + "description": "The list of completion choices the model generated for the input prompt.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "logprobs", + "text" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\nor `content_filter` if content was omitted due to a flag from our content filters.\n", + "enum": [ + "stop", + "length", + "content_filter" + ] + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "nullable": true, + "properties": { + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + } + } + }, + "text": { + "type": "string" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the completion was created." + }, + "model": { + "type": "string", + "description": "The model used for completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always \"text_completion\"", + "enum": [ + "text_completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "createChatCompletionRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionsRequestCommon" + }, + { + "properties": { + "messages": { + "description": "A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb).", + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + } + }, + "data_sources": { + "type": "array", + "description": " The configuration entries for Azure OpenAI chat extensions that use them.\n This additional specification is only compatible with Azure OpenAI.", + "items": { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + } + }, + "frequency_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n" + }, + "logit_bias": { + "type": "object", + "default": null, + "nullable": true, + "additionalProperties": { + "type": "integer" + }, + "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n" + }, + "logprobs": { + "description": "Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.", + "type": "boolean", + "default": false, + "nullable": true + }, + "top_logprobs": { + "description": "An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", + "type": "integer", + "minimum": 0, + "maximum": 20, + "nullable": true + }, + "max_tokens": { + "description": "The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.\n\nThe total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n", + "type": "integer", + "nullable": true + }, + "n": { + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true, + "description": "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs." + }, + "presence_penalty": { + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2, + "nullable": true, + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" + }, + "response_format": { + "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/ResponseFormatText" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonObject" + }, + { + "$ref": "#/components/schemas/ResponseFormatJsonSchema" + } + ], + "x-oaiExpandable": true + }, + "seed": { + "type": "integer", + "minimum": -9223372036854775808, + "maximum": 9223372036854775807, + "nullable": true, + "description": "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n" + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.\n", + "default": null, + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "type": "string" + } + } + ] + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", + "type": "boolean", + "nullable": true, + "default": false + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n" + }, + "tools": { + "type": "array", + "description": "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n", + "items": { + "$ref": "#/components/schemas/chatCompletionTool" + } + }, + "tool_choice": { + "$ref": "#/components/schemas/chatCompletionToolChoiceOption" + }, + "function_call": { + "deprecated": true, + "description": "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionFunctionCallOption" + } + ], + "x-oaiExpandable": true + }, + "functions": { + "deprecated": true, + "description": "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", + "type": "array", + "minItems": 1, + "maxItems": 128, + "items": { + "$ref": "#/components/schemas/chatCompletionFunctions" + } + }, + "user": { + "type": "string", + "example": "user-1234", + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.\n" + } + }, + "required": [ + "messages" + ] + } + ] + }, + "chatCompletionFunctions": { + "type": "object", + "deprecated": true, + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionCallOption": { + "type": "object", + "description": "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + }, + "chatCompletionFunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.", + "additionalProperties": true + }, + "chatCompletionRequestMessage": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestUserMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestToolMessage" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestFunctionMessage" + } + ] + }, + "chatCompletionRequestSystemMessage": { + "type": "object", + "title": "System message", + "properties": { + "content": { + "description": "The contents of the system message.", + "oneOf": [ + { + "type": "string", + "description": "The contents of the system message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For system messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + }, + "minItems": 1 + } + ] + }, + "role": { + "type": "string", + "enum": [ + "system" + ], + "description": "The role of the messages author, in this case `system`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestUserMessage": { + "type": "object", + "title": "User message", + "properties": { + "content": { + "description": "The contents of the user message.\n", + "oneOf": [ + { + "type": "string", + "description": "The text contents of the message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestUserMessageContentPart" + }, + "minItems": 1 + } + ], + "x-oaiExpandable": true + }, + "role": { + "type": "string", + "enum": [ + "user" + ], + "description": "The role of the messages author, in this case `user`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + } + }, + "required": [ + "content", + "role" + ] + }, + "chatCompletionRequestAssistantMessage": { + "type": "object", + "title": "Assistant message", + "properties": { + "content": { + "nullable": true, + "oneOf": [ + { + "type": "string", + "description": "The contents of the assistant message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n" + }, + "refusal": { + "nullable": true, + "type": "string", + "description": "The refusal message by the assistant." + }, + "role": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the messages author, in this case `assistant`." + }, + "name": { + "type": "string", + "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role." + }, + "tool_calls": { + "$ref": "#/components/schemas/chatCompletionMessageToolCalls" + }, + "function_call": { + "type": "object", + "deprecated": true, + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "nullable": true, + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "arguments", + "name" + ] + } + }, + "required": [ + "role" + ] + }, + "chatCompletionRequestToolMessage": { + "type": "object", + "title": "Tool message", + "properties": { + "role": { + "type": "string", + "enum": [ + "tool" + ], + "description": "The role of the messages author, in this case `tool`." + }, + "content": { + "oneOf": [ + { + "type": "string", + "description": "The contents of the tool message.", + "title": "Text content" + }, + { + "type": "array", + "description": "An array of content parts with a defined type. For tool messages, only type `text` is supported.", + "title": "Array of content parts", + "items": { + "$ref": "#/components/schemas/chatCompletionRequestToolMessageContentPart" + }, + "minItems": 1 + } + ], + "description": "The contents of the tool message." + }, + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + } + }, + "required": [ + "role", + "content", + "tool_call_id" + ] + }, + "chatCompletionRequestFunctionMessage": { + "type": "object", + "title": "Function message", + "deprecated": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "content": { + "nullable": true, + "type": "string", + "description": "The contents of the function message." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "role", + "content", + "name" + ] + }, + "chatCompletionRequestSystemMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestUserMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartImage" + } + ] + }, + "chatCompletionRequestAssistantMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + }, + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + } + ] + }, + "chatCompletionRequestToolMessageContentPart": { + "oneOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessageContentPartText" + } + ] + }, + "chatCompletionRequestMessageContentPartText": { + "type": "object", + "title": "Text content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "text" + ], + "description": "The type of the content part." + }, + "text": { + "type": "string", + "description": "The text content." + } + }, + "required": [ + "type", + "text" + ] + }, + "chatCompletionRequestMessageContentPartImage": { + "type": "object", + "title": "Image content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "image_url" + ], + "description": "The type of the content part." + }, + "image_url": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "Either a URL of the image or the base64 encoded image data.", + "format": "uri" + }, + "detail": { + "type": "string", + "description": "Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto).", + "enum": [ + "auto", + "low", + "high" + ], + "default": "auto" + } + }, + "required": [ + "url" + ] + } + }, + "required": [ + "type", + "image_url" + ] + }, + "chatCompletionRequestMessageContentPartRefusal": { + "type": "object", + "title": "Refusal content part", + "properties": { + "type": { + "type": "string", + "enum": [ + "refusal" + ], + "description": "The type of the content part." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model." + } + }, + "required": [ + "type", + "refusal" + ] + }, + "azureChatExtensionConfiguration": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/azureChatExtensionType" + } + }, + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "discriminator": { + "propertyName": "type", + "mapping": { + "azure_search": "#/components/schemas/azureSearchChatExtensionConfiguration", + "azure_cosmos_db": "#/components/schemas/azureCosmosDBChatExtensionConfiguration", + "elasticsearch": "#/components/schemas/elasticsearchChatExtensionConfiguration", + "mongo_db": "#/components/schemas/mongoDBChatExtensionConfiguration", + "pinecone": "#/components/schemas/pineconeChatExtensionConfiguration" + } + } + }, + "azureChatExtensionType": { + "type": "string", + "description": " A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat\n completions request that should use Azure OpenAI chat extensions to augment the response behavior.\n The use of this configuration is compatible only with Azure OpenAI.", + "enum": [ + "azure_search", + "azure_cosmos_db", + "elasticsearch", + "mongo_db", + "pinecone" + ], + "x-ms-enum": { + "name": "AzureChatExtensionType", + "modelAsString": true, + "values": [ + { + "name": "azureSearch", + "value": "azure_search", + "description": "Represents the use of Azure Search as an Azure OpenAI chat extension." + }, + { + "name": "azureCosmosDB", + "value": "azure_cosmos_db", + "description": "Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension." + }, + { + "name": "elasticsearch", + "value": "elasticsearch", + "description": "Represents the use of Elasticsearch® index as an Azure OpenAI chat extension." + }, + { + "name": "mongoDB", + "value": "mongo_db", + "description": "Represents the use of Mongo DB as an Azure OpenAI chat extension." + }, + { + "name": "pinecone", + "value": "pinecone", + "description": "Represents the use of Pinecone index as an Azure OpenAI chat extension." + } + ] + } + }, + "azureSearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureSearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_search" + }, + "azureSearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The absolute endpoint path for the Azure Search resource to use.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The name of the index to use as available in the referenced Azure Search resource." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureSearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/azureSearchQueryType" + }, + "semantic_configuration": { + "type": "string", + "description": "The additional semantic configuration for the query." + }, + "filter": { + "type": "string", + "description": "Search filter." + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataIntegratedVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for Azure Search when used as an Azure OpenAI chat extension." + }, + "azureSearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + }, + "image_vector_fields": { + "type": "array", + "description": "The names of fields that represent image vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Search resource." + }, + "azureSearchQueryType": { + "type": "string", + "description": "The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "semantic", + "vector", + "vector_simple_hybrid", + "vector_semantic_hybrid" + ], + "x-ms-enum": { + "name": "AzureSearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "semantic", + "value": "semantic", + "description": "Represents the semantic query parser for advanced semantic modeling." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + }, + { + "name": "vectorSimpleHybrid", + "value": "vector_simple_hybrid", + "description": "Represents a combination of the simple query strategy with vector data." + }, + { + "name": "vectorSemanticHybrid", + "value": "vector_semantic_hybrid", + "description": "Represents a combination of semantic search and vector data querying." + } + ] + } + }, + "azureCosmosDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/azureCosmosDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "azure_cosmos_db" + }, + "azureCosmosDBChatExtensionParameters": { + "required": [ + "authentication", + "container_name", + "database_name", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "database_name": { + "type": "string", + "description": "The MongoDB vCore database name to use with Azure Cosmos DB." + }, + "container_name": { + "type": "string", + "description": "The name of the Azure Cosmos DB resource container." + }, + "index_name": { + "type": "string", + "description": "The MongoDB vCore index name to use with Azure Cosmos DB." + }, + "fields_mapping": { + "$ref": "#/components/schemas/azureCosmosDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for\nMongoDB vCore." + }, + "azureCosmosDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource." + }, + "elasticsearchChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/elasticsearchChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "elasticsearch" + }, + "elasticsearchChatExtensionParameters": { + "required": [ + "authentication", + "endpoint", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + } + ] + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The endpoint of Elasticsearch®.", + "format": "uri" + }, + "index_name": { + "type": "string", + "description": "The index name of Elasticsearch®." + }, + "fields_mapping": { + "$ref": "#/components/schemas/elasticsearchIndexFieldMappingOptions" + }, + "query_type": { + "$ref": "#/components/schemas/elasticsearchQueryType" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + }, + "elasticsearchIndexFieldMappingOptions": { + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Elasticsearch® resource." + }, + "elasticsearchQueryType": { + "type": "string", + "description": "The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.", + "enum": [ + "simple", + "vector" + ], + "x-ms-enum": { + "name": "ElasticsearchQueryType", + "modelAsString": true, + "values": [ + { + "name": "simple", + "value": "simple", + "description": "Represents the default, simple query parser." + }, + { + "name": "vector", + "value": "vector", + "description": "Represents vector search over computed data." + } + ] + } + }, + "mongoDBChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/mongoDBChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "mongo_db" + }, + "mongoDBChatExtensionParameters": { + "required": [ + "authentication", + "app_name", + "collection_name", + "database_name", + "endpoint", + "embedding_dependency", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "endpoint": { + "type": "string", + "description": "The name of the Mongo DB cluster endpoint." + }, + "database_name": { + "type": "string", + "description": "The name of the Mongo DB database." + }, + "collection_name": { + "type": "string", + "description": "The name of the Mongo DB Collection." + }, + "app_name": { + "type": "string", + "description": "The name of the Mongo DB Application." + }, + "index_name": { + "type": "string", + "description": "The The name of the Mongo DB index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/mongoDBFieldMappingOptions" + }, + "embedding_dependency": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataEndpointVectorizationSource" + }, + { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + } + ] + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB." + }, + "mongoDBFieldMappingOptions": { + "required": [ + "content_fields", + "vector_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + }, + "vector_fields": { + "type": "array", + "description": "The names of fields that represent vector data.", + "items": { + "type": "string" + } + } + }, + "description": "Optional settings to control how fields are processed when using a configured Mongo DB resource." + }, + "pineconeChatExtensionConfiguration": { + "required": [ + "parameters" + ], + "description": "A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat\nextension.", + "allOf": [ + { + "$ref": "#/components/schemas/azureChatExtensionConfiguration" + }, + { + "properties": { + "parameters": { + "$ref": "#/components/schemas/pineconeChatExtensionParameters" + } + } + } + ], + "x-ms-discriminator-value": "pinecone" + }, + "pineconeChatExtensionParameters": { + "required": [ + "authentication", + "embedding_dependency", + "environment", + "fields_mapping", + "index_name" + ], + "type": "object", + "properties": { + "authentication": { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + "top_n_documents": { + "type": "integer", + "description": "The configured top number of documents to feature for the configured query.", + "format": "int32" + }, + "max_search_queries": { + "type": "integer", + "description": "The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send.", + "format": "int32" + }, + "allow_partial_result": { + "type": "boolean", + "default": false, + "description": "If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails." + }, + "in_scope": { + "type": "boolean", + "description": "Whether queries should be restricted to use of indexed data." + }, + "strictness": { + "maximum": 5, + "minimum": 1, + "type": "integer", + "description": "The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer.", + "format": "int32" + }, + "environment": { + "type": "string", + "description": "The environment name of Pinecone." + }, + "index_name": { + "type": "string", + "description": "The name of the Pinecone database index." + }, + "fields_mapping": { + "$ref": "#/components/schemas/pineconeFieldMappingOptions" + }, + "embedding_dependency": { + "$ref": "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + }, + "include_contexts": { + "type": "array", + "description": "The included properties of the output context. If not specified, the default value is `citations` and `intent`.", + "items": { + "$ref": "#/components/schemas/onYourDataContextProperty" + } + } + }, + "description": "Parameters for configuring Azure OpenAI Pinecone chat extensions." + }, + "pineconeFieldMappingOptions": { + "required": [ + "content_fields" + ], + "type": "object", + "properties": { + "title_field": { + "type": "string", + "description": "The name of the index field to use as a title." + }, + "url_field": { + "type": "string", + "description": "The name of the index field to use as a URL." + }, + "filepath_field": { + "type": "string", + "description": "The name of the index field to use as a filepath." + }, + "content_fields": { + "type": "array", + "description": "The names of index fields that should be treated as content.", + "items": { + "type": "string" + } + }, + "content_fields_separator": { + "type": "string", + "description": "The separator pattern that content fields should use." + } + }, + "description": "Optional settings to control how fields are processed when using a configured Pinecone resource." + }, + "onYourDataAuthenticationOptions": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataAuthenticationType" + } + }, + "description": "The authentication options for Azure OpenAI On Your Data.", + "discriminator": { + "propertyName": "type", + "mapping": { + "api_key": "#/components/schemas/onYourDataApiKeyAuthenticationOptions", + "connection_string": "#/components/schemas/onYourDataConnectionStringAuthenticationOptions", + "key_and_key_id": "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions", + "encoded_api_key": "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions", + "access_token": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions", + "system_assigned_managed_identity": "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions", + "user_assigned_managed_identity": "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions", + "username_and_password": "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + } + } + }, + "onYourDataContextProperty": { + "type": "string", + "description": "The context property.", + "enum": [ + "citations", + "intent", + "all_retrieved_documents" + ], + "x-ms-enum": { + "name": "OnYourDataContextProperty", + "modelAsString": true, + "values": [ + { + "name": "citations", + "value": "citations", + "description": "The `citations` property." + }, + { + "name": "intent", + "value": "intent", + "description": "The `intent` property." + }, + { + "name": "allRetrievedDocuments", + "value": "all_retrieved_documents", + "description": "The `all_retrieved_documents` property." + } + ] + } + }, + "onYourDataAuthenticationType": { + "type": "string", + "description": "The authentication types supported with Azure OpenAI On Your Data.", + "enum": [ + "api_key", + "connection_string", + "key_and_key_id", + "encoded_api_key", + "access_token", + "system_assigned_managed_identity", + "user_assigned_managed_identity", + "username_and_password" + ], + "x-ms-enum": { + "name": "OnYourDataAuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "apiKey", + "value": "api_key", + "description": "Authentication via API key." + }, + { + "name": "connectionString", + "value": "connection_string", + "description": "Authentication via connection string." + }, + { + "name": "keyAndKeyId", + "value": "key_and_key_id", + "description": "Authentication via key and key ID pair." + }, + { + "name": "encodedApiKey", + "value": "encoded_api_key", + "description": "Authentication via encoded API key." + }, + { + "name": "accessToken", + "value": "access_token", + "description": "Authentication via access token." + }, + { + "name": "systemAssignedManagedIdentity", + "value": "system_assigned_managed_identity", + "description": "Authentication via system-assigned managed identity." + }, + { + "name": "userAssignedManagedIdentity", + "value": "user_assigned_managed_identity", + "description": "Authentication via user-assigned managed identity." + }, + { + "name": "usernameAndPassword", + "value": "username_and_password", + "description": "Authentication via username and password." + } + ] + } + }, + "onYourDataApiKeyAuthenticationOptions": { + "required": [ + "key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "api_key" + }, + "onYourDataConnectionStringAuthenticationOptions": { + "required": [ + "connection_string" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a connection string.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "connection_string": { + "type": "string", + "description": "The connection string to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "connection_string" + }, + "onYourDataKeyAndKeyIdAuthenticationOptions": { + "required": [ + "key", + "key_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "key": { + "type": "string", + "description": "The Elasticsearch key to use for authentication." + }, + "key_id": { + "type": "string", + "description": "The Elasticsearch key ID to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "key_and_key_id" + }, + "onYourDataEncodedApiKeyAuthenticationOptions": { + "required": [ + "encoded_api_key" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "encoded_api_key": { + "type": "string", + "description": "The Elasticsearch encoded API key to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "encoded_api_key" + }, + "onYourDataAccessTokenAuthenticationOptions": { + "required": [ + "access_token" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using access token.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "access_token": { + "type": "string", + "description": "The access token to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "access_token" + }, + "onYourDataSystemAssignedManagedIdentityAuthenticationOptions": { + "description": "The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + } + ], + "x-ms-discriminator-value": "system_assigned_managed_identity" + }, + "onYourDataUserAssignedManagedIdentityAuthenticationOptions": { + "required": [ + "managed_identity_resource_id" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "managed_identity_resource_id": { + "type": "string", + "description": "The resource ID of the user-assigned managed identity to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "user_assigned_managed_identity" + }, + "onYourDataUsernameAndPasswordAuthenticationOptions": { + "required": [ + "username", + "password" + ], + "description": "The authentication options for Azure OpenAI On Your Data when using a username and a password.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataAuthenticationOptions" + }, + { + "properties": { + "username": { + "type": "string", + "description": "The username to use for authentication." + }, + "password": { + "type": "string", + "description": "The password. to use for authentication." + } + } + } + ], + "x-ms-discriminator-value": "username_and_password" + }, + "onYourDataVectorizationSource": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/onYourDataVectorizationSourceType" + } + }, + "description": "An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.", + "discriminator": { + "propertyName": "type", + "mapping": { + "endpoint": "#/components/schemas/onYourDataEndpointVectorizationSource", + "deployment_name": "#/components/schemas/onYourDataDeploymentNameVectorizationSource", + "integrated": "#/components/schemas/onYourDataIntegratedVectorizationSource", + "model_id": "#/components/schemas/onYourDataModelIdVectorizationSource" + } + } + }, + "onYourDataVectorizationSourceType": { + "type": "string", + "description": "Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with\nvector search.", + "enum": [ + "endpoint", + "deployment_name", + "integrated", + "model_id" + ], + "x-ms-enum": { + "name": "OnYourDataVectorizationSourceType", + "modelAsString": true, + "values": [ + { + "name": "endpoint", + "value": "endpoint", + "description": "Represents vectorization performed by public service calls to an Azure OpenAI embedding model." + }, + { + "name": "deploymentName", + "value": "deployment_name", + "description": "Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but\nOn Your Data will use this model deployment via an internal call rather than a public one, which enables vector\nsearch even in private networks." + }, + { + "name": "integrated", + "value": "integrated", + "description": "Represents the integrated vectorizer defined within the search resource." + }, + { + "name": "modelId", + "value": "model_id", + "description": "Represents a specific embedding model ID as defined in the search service.\nCurrently only supported by Elasticsearch®." + } + ] + } + }, + "onYourDataEndpointVectorizationSource": { + "required": [ + "authentication", + "endpoint" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a public Azure OpenAI endpoint call for embeddings.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "endpoint": { + "type": "string", + "description": "Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.", + "format": "uri" + }, + "authentication": { + "oneOf": [ + { + "$ref": "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + }, + { + "$ref": "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + } + ] + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "endpoint" + }, + "onYourDataDeploymentNameVectorizationSource": { + "required": [ + "deployment_name" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non an internal embeddings model deployment name in the same Azure OpenAI resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "deployment_name": { + "type": "string", + "description": "Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks." + }, + "dimensions": { + "type": "integer", + "description": "The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models.", + "format": "int32" + } + } + } + ], + "x-ms-discriminator-value": "deployment_name" + }, + "onYourDataIntegratedVectorizationSource": { + "description": "Represents the integrated vectorizer defined within the search resource.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + } + ], + "x-ms-discriminator-value": "integrated" + }, + "onYourDataModelIdVectorizationSource": { + "required": [ + "model_id" + ], + "description": "The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based\non a search service model ID. Currently only supported by Elasticsearch®.", + "allOf": [ + { + "$ref": "#/components/schemas/onYourDataVectorizationSource" + }, + { + "properties": { + "model_id": { + "type": "string", + "description": "Specifies the model ID to use for vectorization. This model ID must be defined in the search service." + } + } + } + ], + "x-ms-discriminator-value": "model_id" + }, + "azureChatExtensionsMessageContext": { + "type": "object", + "properties": { + "citations": { + "type": "array", + "description": "The data source retrieval result, used to generate the assistant message in the response.", + "items": { + "$ref": "#/components/schemas/citation" + }, + "x-ms-identifiers": [] + }, + "intent": { + "type": "string", + "description": "The detected intent from the chat history, used to pass to the next turn to carry over the context." + }, + "all_retrieved_documents": { + "type": "array", + "description": "All the retrieved documents.", + "items": { + "$ref": "#/components/schemas/retrievedDocument" + } + } + }, + "description": " A representation of the additional context information available when Azure OpenAI chat extensions are involved\n in the generation of a corresponding chat completions response. This context information is only populated when\n using an Azure OpenAI request configured to use a matching extension." + }, + "citation": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the citation." + }, + "title": { + "type": "string", + "description": "The title of the citation." + }, + "url": { + "type": "string", + "description": "The URL of the citation." + }, + "filepath": { + "type": "string", + "description": "The file path of the citation." + }, + "chunk_id": { + "type": "string", + "description": "The chunk ID of the citation." + }, + "rerank_score": { + "type": "number", + "description": "The rerank score of the retrieved document.", + "format": "double" + } + }, + "description": "citation information for a chat completions response message." + }, + "retrievedDocument": { + "type": "object", + "description": "The retrieved document.", + "required": [ + "search_queries", + "data_source_index", + "original_search_score" + ], + "allOf": [ + { + "$ref": "#/components/schemas/citation" + }, + { + "properties": { + "search_queries": { + "type": "array", + "description": "The search queries used to retrieve the document.", + "items": { + "type": "string" + } + }, + "data_source_index": { + "type": "integer", + "description": "The index of the data source.", + "format": "int32" + }, + "original_search_score": { + "type": "number", + "description": "The original search score of the retrieved document.", + "format": "double" + }, + "filter_reason": { + "$ref": "#/components/schemas/filterReason", + "description": "Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset." + } + } + } + ] + }, + "filterReason": { + "type": "string", + "description": "The filtering reason of the retrieved document.", + "enum": [ + "score", + "rerank" + ], + "x-ms-enum": { + "name": "FilterReason", + "modelAsString": true, + "values": [ + { + "name": "score", + "value": "score", + "description": "The document is filtered by original search score threshold defined by `strictness` configure." + }, + { + "name": "rerank", + "value": "rerank", + "description": "The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure." + } + ] + } + }, + "chatCompletionMessageToolCall": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "$ref": "#/components/schemas/toolCallType" + }, + "function": { + "type": "object", + "description": "The function that the model called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "toolCallType": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool call, in this case `function`.", + "x-ms-enum": { + "name": "ToolCallType", + "modelAsString": true, + "values": [ + { + "value": "function", + "description": "The tool call type is function." + } + ] + } + }, + "chatCompletionRequestMessageTool": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "nullable": true, + "properties": { + "tool_call_id": { + "type": "string", + "description": "Tool call that this message is responding to." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "tool_call_id", + "content" + ] + }, + "chatCompletionRequestMessageFunction": { + "allOf": [ + { + "$ref": "#/components/schemas/chatCompletionRequestMessage" + }, + { + "type": "object", + "description": "Deprecated. Message that represents a function.", + "nullable": true, + "properties": { + "role": { + "type": "string", + "enum": [ + "function" + ], + "description": "The role of the messages author, in this case `function`." + }, + "name": { + "type": "string", + "description": "The contents of the message." + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + } + } + } + ], + "required": [ + "function_call_id", + "content" + ] + }, + "createChatCompletionResponse": { + "type": "object", + "description": "Represents a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/promptFilterResults" + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1.", + "items": { + "type": "object", + "required": [ + "finish_reason", + "index", + "message", + "logprobs" + ], + "properties": { + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ] + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + }, + "message": { + "$ref": "#/components/schemas/chatCompletionResponseMessage" + }, + "content_filter_results": { + "$ref": "#/components/schemas/contentFilterChoiceResults" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created." + }, + "model": { + "type": "string", + "description": "The model used for the chat completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion`.", + "enum": [ + "chat.completion" + ] + }, + "usage": { + "$ref": "#/components/schemas/completionUsage" + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "createChatCompletionStreamResponse": { + "type": "object", + "description": "Represents a streamed chunk of a chat completion response returned by model, based on the provided input.", + "properties": { + "id": { + "type": "string", + "description": "A unique identifier for the chat completion. Each chunk has the same ID." + }, + "choices": { + "type": "array", + "description": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1.\n", + "items": { + "type": "object", + "required": [ + "delta", + "finish_reason", + "index" + ], + "properties": { + "delta": { + "$ref": "#/components/schemas/chatCompletionStreamResponseDelta" + }, + "logprobs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content", + "refusal" + ] + }, + "finish_reason": { + "type": "string", + "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n", + "enum": [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call" + ], + "nullable": true + }, + "index": { + "type": "integer", + "description": "The index of the choice in the list of choices." + } + } + } + }, + "created": { + "type": "integer", + "description": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp." + }, + "model": { + "type": "string", + "description": "The model to generate the completion." + }, + "system_fingerprint": { + "type": "string", + "description": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n" + }, + "object": { + "type": "string", + "description": "The object type, which is always `chat.completion.chunk`.", + "enum": [ + "chat.completion.chunk" + ], + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + } + }, + "required": [ + "choices", + "created", + "id", + "model", + "object" + ] + }, + "chatCompletionStreamResponseDelta": { + "type": "object", + "description": "A chat completion delta generated by streamed model responses.", + "properties": { + "content": { + "type": "string", + "description": "The contents of the chunk message.", + "nullable": true + }, + "function_call": { + "deprecated": true, + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + }, + "name": { + "type": "string", + "description": "The name of the function to call." + } + } + }, + "tool_calls": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCallChunk" + } + }, + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool" + ], + "description": "The role of the author of this message." + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + } + } + }, + "chatCompletionMessageToolCallChunk": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + } + } + }, + "required": [ + "index" + ] + }, + "chatCompletionStreamOptions": { + "description": "Options for streaming response. Only set this when you set `stream: true`.\n", + "type": "object", + "nullable": true, + "default": null, + "properties": { + "include_usage": { + "type": "boolean", + "description": "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.\n" + } + } + }, + "chatCompletionChoiceLogProbs": { + "description": "Log probability information for the choice.", + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "A list of message content tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + }, + "refusal": { + "description": "A list of message refusal tokens with log probability information.", + "type": "array", + "items": { + "$ref": "#/components/schemas/chatCompletionTokenLogprob" + }, + "nullable": true + } + }, + "required": [ + "content" + ] + }, + "chatCompletionTokenLogprob": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + }, + "top_logprobs": { + "description": "List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned.", + "type": "array", + "items": { + "type": "object", + "properties": { + "token": { + "description": "The token.", + "type": "string" + }, + "logprob": { + "description": "The log probability of this token.", + "type": "number" + }, + "bytes": { + "description": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.", + "type": "array", + "items": { + "type": "integer" + }, + "nullable": true + } + }, + "required": [ + "token", + "logprob", + "bytes" + ] + } + } + }, + "required": [ + "token", + "logprob", + "bytes", + "top_logprobs" + ] + }, + "chatCompletionResponseMessage": { + "type": "object", + "description": "A chat completion message generated by the model.", + "properties": { + "role": { + "$ref": "#/components/schemas/chatCompletionResponseMessageRole" + }, + "refusal": { + "type": "string", + "description": "The refusal message generated by the model.", + "nullable": true + }, + "content": { + "type": "string", + "description": "The contents of the message.", + "nullable": true + }, + "tool_calls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "function_call": { + "$ref": "#/components/schemas/chatCompletionFunctionCall" + }, + "context": { + "$ref": "#/components/schemas/azureChatExtensionsMessageContext" + } + }, + "required": [ + "role", + "content", + "refusal" + ] + }, + "chatCompletionResponseMessageRole": { + "type": "string", + "enum": [ + "assistant" + ], + "description": "The role of the author of the response message." + }, + "chatCompletionToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools. Specifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool. `none` is the default when no tools are present. `auto` is the default if tools are present.", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.", + "enum": [ + "none", + "auto", + "required" + ] + }, + { + "$ref": "#/components/schemas/chatCompletionNamedToolChoice" + } + ] + }, + "chatCompletionNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific function.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "ParallelToolCalls": { + "type": "boolean", + "description": "Whether to enable parallel function calling during tool use.", + "default": true + }, + "chatCompletionMessageToolCalls": { + "type": "array", + "description": "The tool calls generated by the model, such as function calls.", + "items": { + "$ref": "#/components/schemas/chatCompletionMessageToolCall" + } + }, + "chatCompletionFunctionCall": { + "type": "object", + "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + }, + "arguments": { + "type": "string", + "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." + } + }, + "required": [ + "name", + "arguments" + ] + }, + "completionUsage": { + "type": "object", + "description": "Usage statistics for the completion request.", + "properties": { + "prompt_tokens": { + "type": "integer", + "description": "Number of tokens in the prompt." + }, + "completion_tokens": { + "type": "integer", + "description": "Number of tokens in the generated completion." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used in the request (prompt + completion)." + }, + "completion_tokens_details": { + "type": "object", + "description": "Breakdown of tokens used in a completion.", + "properties": { + "reasoning_tokens": { + "type": "integer", + "description": "Tokens generated by the model for reasoning." + } + } + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + }, + "chatCompletionTool": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "function" + ], + "description": "The type of the tool. Currently, only `function` is supported." + }, + "function": { + "$ref": "#/components/schemas/FunctionObject" + } + }, + "required": [ + "type", + "function" + ] + }, + "FunctionParameters": { + "type": "object", + "description": "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list.", + "additionalProperties": true + }, + "FunctionObject": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/FunctionParameters" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling)." + } + }, + "required": [ + "name" + ] + }, + "ResponseFormatText": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `text`", + "enum": [ + "text" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonObject": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_object`", + "enum": [ + "json_object" + ] + } + }, + "required": [ + "type" + ] + }, + "ResponseFormatJsonSchemaSchema": { + "type": "object", + "description": "The schema for the response format, described as a JSON Schema object.", + "additionalProperties": true + }, + "ResponseFormatJsonSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of response format being defined: `json_schema`", + "enum": [ + "json_schema" + ] + }, + "json_schema": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A description of what the response format is for, used by the model to determine how to respond in the format." + }, + "name": { + "type": "string", + "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "schema": { + "$ref": "#/components/schemas/ResponseFormatJsonSchemaSchema" + }, + "strict": { + "type": "boolean", + "nullable": true, + "default": false, + "description": "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`." + } + }, + "required": [ + "type", + "name" + ] + } + }, + "required": [ + "type", + "json_schema" + ] + }, + "chatCompletionChoiceCommon": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "finish_reason": { + "type": "string" + } + } + }, + "createTranslationRequest": { + "type": "object", + "description": "Translation request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file to translate.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + } + }, + "required": [ + "file" + ] + }, + "audioResponse": { + "description": "Translation or transcription response when response_format was json", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Translated or transcribed text." + } + }, + "required": [ + "text" + ] + }, + "audioVerboseResponse": { + "description": "Translation or transcription response when response_format was verbose_json", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/audioResponse" + }, + { + "properties": { + "task": { + "type": "string", + "description": "Type of audio task.", + "enum": [ + "transcribe", + "translate" + ], + "x-ms-enum": { + "modelAsString": true + } + }, + "language": { + "type": "string", + "description": "Language." + }, + "duration": { + "type": "number", + "description": "Duration." + }, + "segments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioSegment" + } + }, + "words": { + "type": "array", + "items": { + "$ref": "#/components/schemas/audioWord" + } + } + } + } + ], + "required": [ + "text" + ] + }, + "audioResponseFormat": { + "title": "AudioResponseFormat", + "description": "Defines the format of the output.", + "enum": [ + "json", + "text", + "srt", + "verbose_json", + "vtt" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true + } + }, + "createTranscriptionRequest": { + "type": "object", + "description": "Transcription request.", + "properties": { + "file": { + "type": "string", + "description": "The audio file object to transcribe.", + "format": "binary" + }, + "prompt": { + "type": "string", + "description": "An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language." + }, + "response_format": { + "$ref": "#/components/schemas/audioResponseFormat" + }, + "temperature": { + "type": "number", + "default": 0, + "description": "The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit." + }, + "language": { + "type": "string", + "description": "The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency." + }, + "timestamp_granularities[]": { + "type": "array", + "description": "The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency.", + "items": { + "type": "string", + "enum": [ + "word", + "segment" + ] + }, + "default": [ + "segment" + ] + } + }, + "required": [ + "file" + ] + }, + "audioSegment": { + "type": "object", + "description": "Transcription or translation segment.", + "properties": { + "id": { + "type": "integer", + "description": "Segment identifier." + }, + "seek": { + "type": "number", + "description": "Offset of the segment." + }, + "start": { + "type": "number", + "description": "Segment start offset." + }, + "end": { + "type": "number", + "description": "Segment end offset." + }, + "text": { + "type": "string", + "description": "Segment text." + }, + "tokens": { + "type": "array", + "items": { + "type": "number", + "nullable": false + }, + "description": "Tokens of the text." + }, + "temperature": { + "type": "number", + "description": "Temperature." + }, + "avg_logprob": { + "type": "number", + "description": "Average log probability." + }, + "compression_ratio": { + "type": "number", + "description": "Compression ratio." + }, + "no_speech_prob": { + "type": "number", + "description": "Probability of 'no speech'." + } + } + }, + "audioWord": { + "type": "object", + "description": "Transcription or translation word.", + "properties": { + "word": { + "type": "string", + "description": "Word" + }, + "start": { + "type": "number", + "description": "Word start offset." + }, + "end": { + "type": "number", + "description": "Word end offset." + } + } + }, + "createSpeechRequest": { + "type": "object", + "description": "Speech request.", + "properties": { + "input": { + "type": "string", + "description": "The text to synthesize audio for. The maximum length is 4096 characters.", + "maxLength": 4096 + }, + "voice": { + "type": "string", + "description": "The voice to use for speech synthesis.", + "enum": [ + "alloy", + "echo", + "fable", + "onyx", + "nova", + "shimmer" + ] + }, + "response_format": { + "type": "string", + "description": "The format to synthesize the audio in.", + "enum": [ + "mp3", + "opus", + "aac", + "flac", + "wav", + "pcm" + ] + }, + "speed": { + "description": "The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default.", + "type": "number", + "default": 1.0, + "minimum": 0.25, + "maximum": 4.0 + } + }, + "required": [ + "input", + "voice" + ] + }, + "imageQuality": { + "description": "The quality of the image that will be generated.", + "type": "string", + "enum": [ + "standard", + "hd" + ], + "default": "standard", + "x-ms-enum": { + "name": "Quality", + "modelAsString": true, + "values": [ + { + "value": "standard", + "description": "Standard quality creates images with standard quality.", + "name": "Standard" + }, + { + "value": "hd", + "description": "HD quality creates images with finer details and greater consistency across the image.", + "name": "HD" + } + ] + } + }, + "imagesResponseFormat": { + "description": "The format in which the generated images are returned.", + "type": "string", + "enum": [ + "url", + "b64_json" + ], + "default": "url", + "x-ms-enum": { + "name": "ImagesResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "url", + "description": "The URL that provides temporary access to download the generated images.", + "name": "Url" + }, + { + "value": "b64_json", + "description": "The generated images are returned as base64 encoded string.", + "name": "Base64Json" + } + ] + } + }, + "imageSize": { + "description": "The size of the generated images.", + "type": "string", + "enum": [ + "256x256", + "512x512", + "1792x1024", + "1024x1792", + "1024x1024" + ], + "default": "1024x1024", + "x-ms-enum": { + "name": "Size", + "modelAsString": true, + "values": [ + { + "value": "256x256", + "description": "The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2.", + "name": "Size256x256" + }, + { + "value": "512x512", + "description": "The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2.", + "name": "Size512x512" + }, + { + "value": "1792x1024", + "description": "The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3.", + "name": "Size1792x1024" + }, + { + "value": "1024x1792", + "description": "The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3.", + "name": "Size1024x1792" + }, + { + "value": "1024x1024", + "description": "The desired size of the generated image is 1024x1024 pixels.", + "name": "Size1024x1024" + } + ] + } + }, + "imageStyle": { + "description": "The style of the generated images.", + "type": "string", + "enum": [ + "vivid", + "natural" + ], + "default": "vivid", + "x-ms-enum": { + "name": "Style", + "modelAsString": true, + "values": [ + { + "value": "vivid", + "description": "Vivid creates images that are hyper-realistic and dramatic.", + "name": "Vivid" + }, + { + "value": "natural", + "description": "Natural creates images that are more natural and less hyper-realistic.", + "name": "Natural" + } + ] + } + }, + "imageGenerationsRequest": { + "type": "object", + "properties": { + "prompt": { + "description": "A text description of the desired image(s). The maximum length is 4000 characters.", + "type": "string", + "format": "string", + "example": "a corgi in a field", + "minLength": 1 + }, + "n": { + "description": "The number of images to generate.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "default": 1 + }, + "size": { + "$ref": "#/components/schemas/imageSize" + }, + "response_format": { + "$ref": "#/components/schemas/imagesResponseFormat" + }, + "user": { + "description": "A unique identifier representing your end-user, which can help to monitor and detect abuse.", + "type": "string", + "format": "string", + "example": "user123456" + }, + "quality": { + "$ref": "#/components/schemas/imageQuality" + }, + "style": { + "$ref": "#/components/schemas/imageStyle" + } + }, + "required": [ + "prompt" + ] + }, + "generateImagesResponse": { + "type": "object", + "properties": { + "created": { + "type": "integer", + "format": "unixtime", + "description": "The unix timestamp when the operation was created.", + "example": "1676540381" + }, + "data": { + "type": "array", + "description": "The result data of the operation, if successful", + "items": { + "$ref": "#/components/schemas/imageResult" + } + } + }, + "required": [ + "created", + "data" + ] + }, + "imageResult": { + "type": "object", + "description": "The image url or encoded image if successful, and an error otherwise.", + "properties": { + "url": { + "type": "string", + "description": "The image url.", + "example": "https://www.contoso.com" + }, + "b64_json": { + "type": "string", + "description": "The base64 encoded image" + }, + "content_filter_results": { + "$ref": "#/components/schemas/dalleContentFilterResults" + }, + "revised_prompt": { + "type": "string", + "description": "The prompt that was used to generate the image, if there was any revision to the prompt." + }, + "prompt_filter_results": { + "$ref": "#/components/schemas/dalleFilterResults" + } + } + }, + "line": { + "type": "object", + "description": "A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.", + "properties": { + "text": { + "type": "string" + }, + "spans": { + "type": "array", + "description": "An array of spans that represent detected objects and its bounding box information.", + "items": { + "$ref": "#/components/schemas/span" + } + } + }, + "required": [ + "text", + "spans" + ] + }, + "span": { + "type": "object", + "description": "A span object that represents a detected object and its bounding box information.", + "properties": { + "text": { + "type": "string", + "description": "The text content of the span that represents the detected object." + }, + "offset": { + "type": "integer", + "description": "The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints." + }, + "length": { + "type": "integer", + "description": "The length of the span in characters, measured in Unicode codepoints." + }, + "polygon": { + "type": "array", + "description": "An array of objects representing points in the polygon that encloses the detected object.", + "items": { + "type": "object", + "properties": { + "x": { + "type": "number", + "description": "The x-coordinate of the point." + }, + "y": { + "type": "number", + "description": "The y-coordinate of the point." + } + } + } + } + }, + "required": [ + "text", + "offset", + "length", + "polygon" + ] + }, + "runCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.).", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "runStepCompletionUsage": { + "type": "object", + "description": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`.", + "properties": { + "completion_tokens": { + "type": "integer", + "description": "Number of completion tokens used over the course of the run step." + }, + "prompt_tokens": { + "type": "integer", + "description": "Number of prompt tokens used over the course of the run step." + }, + "total_tokens": { + "type": "integer", + "description": "Total number of tokens used (prompt + completion)." + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ], + "nullable": true + }, + "assistantsApiResponseFormatOption": { + "description": "Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", + "oneOf": [ + { + "type": "string", + "description": "`auto` is the default value\n", + "enum": [ + "none", + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormatOption", + "modelAsString": true, + "values": [ + { + "value": "none" + }, + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/assistantsApiResponseFormat" + } + ] + }, + "assistantsApiResponseFormat": { + "type": "object", + "description": "An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed.\n", + "properties": { + "type": { + "type": "string", + "enum": [ + "text", + "json_object" + ], + "x-ms-enum": { + "name": "AssistantsApiResponseFormat", + "modelAsString": true, + "values": [ + { + "value": "text" + }, + { + "value": "json_object" + } + ] + }, + "example": "json_object", + "default": "text", + "description": "Must be one of `text` or `json_object`." + } + } + }, + "assistantObject": { + "type": "object", + "title": "Assistant", + "description": "Represents an `assistant` that can call the model and use tools.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant`.", + "type": "string", + "enum": [ + "assistant" + ], + "x-ms-enum": { + "name": "AssistantObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant", + "description": "The object type, which is always assistant" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the assistant was created.", + "type": "integer" + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "maxLength": 256, + "nullable": true + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "maxLength": 512, + "nullable": true + }, + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "type": "string" + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "maxLength": 256000, + "nullable": true + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "name", + "description", + "model", + "instructions", + "tools", + "metadata" + ] + }, + "createAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 256,000 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256000 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "x-oaiTypeLabel": "map" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "model" + ] + }, + "modifyAssistantRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "model": { + "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.\n", + "anyOf": [ + { + "type": "string" + } + ] + }, + "name": { + "description": "The name of the assistant. The maximum length is 256 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 256 + }, + "description": { + "description": "The description of the assistant. The maximum length is 512 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 512 + }, + "instructions": { + "description": "The system instructions that the assistant uses. The maximum length is 32768 characters.\n", + "type": "string", + "nullable": true, + "maxLength": 32768 + }, + "tools": { + "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.\n", + "default": [], + "type": "array", + "maxItems": 128, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + } + }, + "deleteAssistantResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "assistant.deleted" + ], + "x-ms-enum": { + "name": "DeleteAssistantResponseState", + "modelAsString": true, + "values": [ + { + "value": "assistant.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listAssistantsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/assistantObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "assistantToolsCode": { + "type": "object", + "title": "Code interpreter tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `code_interpreter`", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "assistantToolsCodeType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearch": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "Overrides for the file search tool.", + "properties": { + "max_num_results": { + "type": "integer", + "minimum": 1, + "maximum": 50, + "description": "The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search/number-of-chunks-returned) for more information.\n" + } + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFileSearchTypeOnly": { + "type": "object", + "title": "FileSearch tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `file_search`", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "assistantToolsFileSearchType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "assistantToolsFunction": { + "type": "object", + "title": "Function tool", + "properties": { + "type": { + "type": "string", + "description": "The type of tool being defined: `function`", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "assistantToolsFunction", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "description": { + "type": "string", + "description": "A description of what the function does, used by the model to choose when and how to call the function." + }, + "name": { + "type": "string", + "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." + }, + "parameters": { + "$ref": "#/components/schemas/chatCompletionFunctionParameters" + } + }, + "required": [ + "name", + "parameters", + "description" + ] + } + }, + "required": [ + "type", + "function" + ] + }, + "truncationObject": { + "type": "object", + "title": "Thread Truncation Controls", + "description": "Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.", + "properties": { + "type": { + "type": "string", + "description": "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.", + "enum": [ + "auto", + "last_messages" + ], + "x-ms-enum": { + "name": "TruncationType", + "modelAsString": true, + "values": [ + { + "value": "auto" + }, + { + "value": "last_messages" + } + ] + } + }, + "last_messages": { + "type": "integer", + "description": "The number of most recent messages from the thread when constructing the context for the run.", + "minimum": 1, + "nullable": true + } + }, + "required": [ + "type" + ] + }, + "assistantsApiToolChoiceOption": { + "description": "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and means the model can pick between generating a message or calling a tool.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n", + "oneOf": [ + { + "type": "string", + "description": "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", + "enum": [ + "none", + "auto" + ], + "x-ms-enum": { + "name": "AssistantsApiToolChoiceOption", + "modelAsString": true, + "values": [ + { + "value": "none" + }, + { + "value": "auto" + } + ] + } + }, + { + "$ref": "#/components/schemas/assistantsNamedToolChoice" + } + ] + }, + "assistantsNamedToolChoice": { + "type": "object", + "description": "Specifies a tool the model should use. Use to force the model to call a specific tool.", + "properties": { + "type": { + "type": "string", + "enum": [ + "function", + "code_interpreter", + "file_search" + ], + "description": "The type of the tool. If type is `function`, the function name must be set", + "x-ms-enum": { + "name": "AssistantsNamedToolChoiceType", + "modelAsString": true, + "values": [ + { + "value": "function" + }, + { + "value": "code_interpreter" + }, + { + "value": "file_search" + } + ] + } + }, + "function": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the function to call." + } + }, + "required": [ + "name" + ] + } + }, + "required": [ + "type" + ] + }, + "runObject": { + "type": "object", + "title": "A run on a thread", + "description": "Represents an execution run on a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run`.", + "type": "string", + "enum": [ + "thread.run" + ], + "x-ms-enum": { + "name": "runObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run", + "description": "The run object type which is always thread.run" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run was created.", + "type": "integer" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run.", + "type": "string" + }, + "assistant_id": { + "description": "The ID of the assistant used for execution of this run.", + "type": "string" + }, + "status": { + "description": "The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "requires_action", + "cancelling", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "queued", + "description": "The queued state" + }, + { + "value": "in_progress", + "description": "The in_progress state" + }, + { + "value": "requires_action", + "description": "The required_action state" + }, + { + "value": "cancelling", + "description": "The cancelling state" + }, + { + "value": "cancelled", + "description": "The cancelled state" + }, + { + "value": "failed", + "description": "The failed state" + }, + { + "value": "completed", + "description": "The completed state" + }, + { + "value": "expired", + "description": "The expired state" + } + ] + } + }, + "required_action": { + "type": "object", + "description": "Details on the action required to continue the run. Will be `null` if no action is required.", + "nullable": true, + "properties": { + "type": { + "description": "For now, this is always `submit_tool_outputs`.", + "type": "string", + "enum": [ + "submit_tool_outputs" + ] + }, + "submit_tool_outputs": { + "type": "object", + "description": "Details on the tool outputs needed for this run to continue.", + "properties": { + "tool_calls": { + "type": "array", + "description": "A list of the relevant tool calls.", + "items": { + "$ref": "#/components/schemas/runToolCallObject" + } + } + }, + "required": [ + "tool_calls" + ] + } + }, + "required": [ + "type", + "submit_tool_outputs" + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server failed to respond to request due to server error" + }, + { + "value": "rate_limit_exceeded", + "description": "The server failed to respond to request due to rate limit exceeded" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the run will expire.", + "type": "integer" + }, + "started_at": { + "description": "The Unix timestamp (in seconds) for when the run was started.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_details": { + "description": "Details on why the run is incomplete. Will be `null` if the run is not incomplete.", + "type": "object", + "nullable": true, + "properties": { + "reason": { + "description": "The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.", + "type": "string", + "enum": [ + "max_completion_tokens", + "max_prompt_tokens" + ], + "x-ms-enum": { + "name": "IncompleteDetailsReason", + "modelAsString": true, + "values": [ + { + "value": "max_completion_tokens" + }, + { + "value": "max_prompt_tokens" + } + ] + } + } + } + }, + "model": { + "description": "The model that the assistant used for this run.", + "type": "string" + }, + "instructions": { + "description": "The instructions that the assistant used for this run.", + "type": "string" + }, + "tools": { + "description": "The list of tools that the assistant used for this run.", + "default": [], + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "usage": { + "$ref": "#/components/schemas/runCompletionUsage" + }, + "temperature": { + "description": "The sampling temperature used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "top_p": { + "description": "The nucleus sampling value used for this run. If not set, defaults to 1.", + "type": "number", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens specified to have been used over the course of the run.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "assistant_id", + "status", + "required_action", + "last_error", + "expires_at", + "started_at", + "cancelled_at", + "failed_at", + "completed_at", + "model", + "instructions", + "tools", + "metadata", + "usage", + "incomplete_details", + "max_prompt_tokens", + "max_completion_tokens", + "truncation_strategy", + "tool_choice", + "response_format" + ] + }, + "createRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "model": { + "description": "The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "additional_instructions": { + "description": "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.", + "type": "string", + "nullable": true + }, + "additional_messages": { + "description": "Adds additional messages to the thread before creating the run.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + }, + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "listRunsResponse": { + "type": "object", + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "modifyRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "submitToolOutputsRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_outputs": { + "description": "A list of tools for which the outputs are being submitted.", + "type": "array", + "items": { + "type": "object", + "properties": { + "tool_call_id": { + "type": "string", + "description": "The ID of the tool call in the `required_action` object within the run object the output is being submitted for." + }, + "output": { + "type": "string", + "description": "The output of the tool call to be submitted to continue the run." + } + } + } + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + } + }, + "required": [ + "tool_outputs" + ] + }, + "runToolCallObject": { + "type": "object", + "description": "Tool call objects", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint." + }, + "type": { + "type": "string", + "description": "The type of tool call the output is required for. For now, this is always `function`.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunToolCallObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The function definition.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments that the model expects you to pass to the function." + } + }, + "required": [ + "name", + "arguments" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "createThreadAndRunRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "assistant_id": { + "description": "The ID of the assistant to use to execute this run.", + "type": "string" + }, + "thread": { + "$ref": "#/components/schemas/createThreadRequest", + "description": "If no thread is provided, an empty thread will be created." + }, + "model": { + "description": "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.", + "type": "string", + "nullable": true + }, + "instructions": { + "description": "Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.", + "type": "string", + "nullable": true + }, + "tools": { + "description": "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.", + "nullable": true, + "type": "array", + "maxItems": 20, + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearch" + }, + { + "$ref": "#/components/schemas/assistantToolsFunction" + } + ] + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + }, + "temperature": { + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true, + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n" + }, + "top_p": { + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true, + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or temperature but not both.\n" + }, + "stream": { + "type": "boolean", + "nullable": true, + "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" + }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, + "max_prompt_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "max_completion_tokens": { + "type": "integer", + "nullable": true, + "description": "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n", + "minimum": 256 + }, + "truncation_strategy": { + "$ref": "#/components/schemas/truncationObject", + "nullable": true + }, + "tool_choice": { + "$ref": "#/components/schemas/assistantsApiToolChoiceOption", + "nullable": true + }, + "response_format": { + "$ref": "#/components/schemas/assistantsApiResponseFormatOption", + "nullable": true + } + }, + "required": [ + "thread_id", + "assistant_id" + ] + }, + "threadObject": { + "type": "object", + "title": "Thread", + "description": "Represents a thread that contains [messages](/docs/api-reference/messages).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread`.", + "type": "string", + "enum": [ + "thread" + ], + "x-ms-enum": { + "name": "ThreadObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread", + "description": "The type of thread object which is always `thread`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the thread was created.", + "type": "integer" + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "tool_resources", + "metadata" + ] + }, + "createThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "messages": { + "description": "A list of [messages](/docs/api-reference/messages) to start the thread with.", + "type": "array", + "items": { + "$ref": "#/components/schemas/createMessageRequest" + } + }, + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + }, + "vector_stores": { + "type": "array", + "description": "A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store.\n", + "maxItems": 10000, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ], + "x-ms-enum": { + "name": "AutoChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "auto" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + } + }, + "required": [ + "type", + "static" + ] + } + ] + }, + "metadata": { + "type": "object", + "description": "Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "vector_store_ids" + ] + }, + { + "required": [ + "vector_stores" + ] + } + ] + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyThreadRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "tool_resources": { + "type": "object", + "description": "A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n", + "properties": { + "code_interpreter": { + "type": "object", + "properties": { + "file_ids": { + "type": "array", + "description": "A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n", + "default": [], + "maxItems": 20, + "items": { + "type": "string" + } + } + } + }, + "file_search": { + "type": "object", + "properties": { + "vector_store_ids": { + "type": "array", + "description": "The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread.\n", + "maxItems": 1, + "items": { + "type": "string" + } + } + } + } + }, + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteThreadResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.deleted" + ], + "x-ms-enum": { + "name": "DeleteThreadResponseObjectState", + "modelAsString": true, + "values": [ + { + "value": "thread.deleted", + "description": "The delete thread response object state which is `thread.deleted`" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listThreadsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/threadObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageObject": { + "type": "object", + "title": "The message object", + "description": "Represents a message within a [thread](/docs/api-reference/threads).", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message`.", + "type": "string", + "enum": [ + "thread.message" + ], + "x-ms-enum": { + "name": "MessageObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message", + "description": "The message object type which is `thread.message`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the message was created.", + "type": "integer" + }, + "thread_id": { + "description": "The [thread](/docs/api-reference/threads) ID that this message belongs to.", + "type": "string" + }, + "status": { + "description": "The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.", + "type": "string", + "enum": [ + "in_progress", + "incomplete", + "completed" + ], + "x-ms-enum": { + "name": "MessageObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "incomplete" + }, + { + "value": "completed" + } + ] + } + }, + "incomplete_details": { + "description": "On an incomplete message, details about why the message is incomplete.", + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason the message is incomplete.", + "enum": [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed" + ], + "x-ms-enum": { + "name": "MessageObjectIncompleteReason", + "modelAsString": true, + "values": [ + { + "value": "content_filter" + }, + { + "value": "max_tokens" + }, + { + "value": "run_cancelled" + }, + { + "value": "run_expired" + }, + { + "value": "run_failed" + } + ] + } + } + }, + "nullable": true, + "required": [ + "reason" + ] + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the message was completed.", + "type": "integer", + "nullable": true + }, + "incomplete_at": { + "description": "The Unix timestamp (in seconds) for when the message was marked as incomplete.", + "type": "integer", + "nullable": true + }, + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageObjectRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageContentTextObject" + } + ] + } + }, + "assistant_id": { + "description": "If applicable, the ID of the assistant that authored this message.", + "type": "string", + "nullable": true + }, + "run_id": { + "description": "If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message.", + "type": "string", + "nullable": true + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they were added to.", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "thread_id", + "status", + "incomplete_details", + "completed_at", + "incomplete_at", + "role", + "content", + "assistant_id", + "run_id", + "attachments", + "metadata" + ] + }, + "messageDeltaObject": { + "type": "object", + "title": "Message delta object", + "description": "Represents a message delta i.e. any changed fields on a message during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the message, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.message.delta`.", + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the Message.", + "type": "object", + "properties": { + "role": { + "description": "The entity that produced the message. One of `user` or `assistant`.", + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "MessageDeltaObjectDeltaRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + } + }, + "content": { + "description": "The content of the message in array of text and/or images.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentImageFileObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "createMessageRequest": { + "type": "object", + "additionalProperties": false, + "required": [ + "role", + "content" + ], + "properties": { + "role": { + "type": "string", + "enum": [ + "user", + "assistant" + ], + "x-ms-enum": { + "name": "CreateMessageRequestRole", + "modelAsString": true, + "values": [ + { + "value": "user" + }, + { + "value": "assistant" + } + ] + }, + "description": "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.\n" + }, + "content": { + "type": "string", + "minLength": 1, + "maxLength": 256000, + "description": "The content of the message." + }, + "attachments": { + "type": "array", + "items": { + "type": "object", + "properties": { + "file_id": { + "type": "string", + "description": "The ID of the file to attach to the message." + }, + "tools": { + "description": "The tools to add this file to.", + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/assistantToolsCode" + }, + { + "$ref": "#/components/schemas/assistantToolsFileSearchTypeOnly" + } + ] + } + } + } + }, + "description": "A list of files attached to the message, and the tools they should be added to.", + "required": [ + "file_id", + "tools" + ], + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "modifyMessageRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "deleteMessageResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "thread.message.deleted" + ], + "x-ms-enum": { + "name": "DeleteMessageResponseObject", + "modelAsString": true, + "values": [ + { + "value": "thread.message.deleted", + "description": "The delete message response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "listMessagesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "messageContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file", + "description": "The message content image file type" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image_file" + ] + }, + "messageContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "messageContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text", + "description": "The message content text Object type" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageContentTextAnnotationsFilePathObject" + } + ] + } + } + }, + "required": [ + "value", + "annotations" + ] + } + }, + "required": [ + "type", + "text" + ] + }, + "messageContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"retrieval\" tool to search files.", + "properties": { + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "FileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation", + "description": "The file citation object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_citation", + "start_index", + "end_index" + ] + }, + "messageContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "FilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path", + "description": "The file path object type" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "type", + "text", + "file_path", + "start_index", + "end_index" + ] + }, + "messageDeltaContentImageFileObject": { + "title": "Image file", + "type": "object", + "description": "References an image File in the content of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `image_file`.", + "type": "string", + "enum": [ + "image_file" + ], + "x-ms-enum": { + "name": "MessageDeltaContentImageFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "image_file" + } + ] + } + }, + "image_file": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image in the message content.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextObject": { + "title": "Text", + "type": "object", + "description": "The text content that is part of a message.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the content part in the message." + }, + "type": { + "description": "Always `text`.", + "type": "string", + "enum": [ + "text" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextObjectType", + "modelAsString": true, + "values": [ + { + "value": "text" + } + ] + } + }, + "text": { + "type": "object", + "properties": { + "value": { + "description": "The data that makes up the text.", + "type": "string" + }, + "annotations": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + }, + { + "$ref": "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFileCitationObject": { + "title": "File citation", + "type": "object", + "description": "A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the \"file_search\" tool to search files.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_citation`.", + "type": "string", + "enum": [ + "file_citation" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFileCitationObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_citation" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_citation": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the specific File the citation is from.", + "type": "string" + }, + "quote": { + "description": "The specific quote in the file.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "messageDeltaContentTextAnnotationsFilePathObject": { + "title": "File path", + "type": "object", + "description": "A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the annotation in the text content part." + }, + "type": { + "description": "Always `file_path`.", + "type": "string", + "enum": [ + "file_path" + ], + "x-ms-enum": { + "name": "MessageDeltaContentTextAnnotationsFilePathObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_path" + } + ] + } + }, + "text": { + "description": "The text in the message content that needs to be replaced.", + "type": "string" + }, + "file_path": { + "type": "object", + "properties": { + "file_id": { + "description": "The ID of the file that was generated.", + "type": "string" + } + } + }, + "start_index": { + "type": "integer", + "minimum": 0 + }, + "end_index": { + "type": "integer", + "minimum": 0 + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepObject": { + "type": "object", + "title": "Run steps", + "description": "Represents a step in execution of a run.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `assistant.run.step``.", + "type": "string", + "enum": [ + "assistant.run.step" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "assistant.run.step", + "description": "The object type, which is always `assistant.run.step`" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the run step was created.", + "type": "integer" + }, + "assistant_id": { + "description": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step.", + "type": "string" + }, + "thread_id": { + "description": "The ID of the [thread](/docs/api-reference/threads) that was run.", + "type": "string" + }, + "run_id": { + "description": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of.", + "type": "string" + }, + "type": { + "description": "The type of run step, which can be either `message_creation` or `tool_calls`.", + "type": "string", + "enum": [ + "message_creation", + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation", + "description": "The message_creation run step" + }, + { + "value": "tool_calls", + "description": "The tool_calls run step" + } + ] + } + }, + "status": { + "description": "The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`.", + "type": "string", + "enum": [ + "in_progress", + "cancelled", + "failed", + "completed", + "expired" + ], + "x-ms-enum": { + "name": "RunStepObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress", + "description": "The in_progress run status" + }, + { + "value": "cancelled", + "description": "The cancelled run status" + }, + { + "value": "failed", + "description": "The cancelled run status" + }, + { + "value": "completed", + "description": "The cancelled run status" + }, + { + "value": "expired", + "description": "The cancelled run status" + } + ] + } + }, + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsObject" + } + ] + }, + "last_error": { + "type": "object", + "description": "The last error associated with this run step. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "server_error", + "rate_limit_exceeded" + ], + "x-ms-enum": { + "name": "LastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "server_error", + "description": "The server_error" + }, + { + "value": "rate_limit_exceeded", + "description": "The rate_limit_exceeded status" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "expired_at": { + "description": "The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired.", + "type": "integer", + "nullable": true + }, + "cancelled_at": { + "description": "The Unix timestamp (in seconds) for when the run step was cancelled.", + "type": "integer", + "nullable": true + }, + "failed_at": { + "description": "The Unix timestamp (in seconds) for when the run step failed.", + "type": "integer", + "nullable": true + }, + "completed_at": { + "description": "The Unix timestamp (in seconds) for when the run step completed.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "created_at", + "assistant_id", + "thread_id", + "run_id", + "type", + "status", + "step_details", + "last_error", + "expired_at", + "cancelled_at", + "failed_at", + "completed_at", + "metadata" + ] + }, + "runStepDeltaObject": { + "type": "object", + "title": "Run step delta object", + "description": "Represents a run step delta i.e. any changed fields on a run step during streaming.\n", + "properties": { + "id": { + "description": "The identifier of the run step, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `thread.run.step.delta`.", + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepDeltaObjectType", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "delta": { + "description": "The delta containing the fields that have changed on the run step.", + "type": "object", + "properties": { + "step_details": { + "type": "object", + "description": "The details of the run step.", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + } + ] + } + } + } + }, + "required": [ + "id", + "object", + "delta" + ] + }, + "listRunStepsResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "first_id": { + "type": "string" + }, + "last_id": { + "type": "string" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "runStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation``.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + }, + "required": [ + "message_id" + ] + } + }, + "required": [ + "type", + "message_creation" + ] + }, + "runStepDeltaStepDetailsMessageCreationObject": { + "title": "Message creation", + "type": "object", + "description": "Details of the message creation by the run step.", + "properties": { + "type": { + "description": "Always `message_creation`.", + "type": "string", + "enum": [ + "message_creation" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsMessageCreationObjectType", + "modelAsString": true, + "values": [ + { + "value": "message_creation" + } + ] + } + }, + "message_creation": { + "type": "object", + "properties": { + "message_id": { + "type": "string", + "description": "The ID of the message that was created by this run step." + } + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`.\n", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type", + "tool_calls" + ] + }, + "runStepDeltaStepDetailsToolCallsObject": { + "title": "Tool calls", + "type": "object", + "description": "Details of the tool call.", + "properties": { + "type": { + "description": "Always `tool_calls`.", + "type": "string", + "enum": [ + "tool_calls" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsObjectType", + "modelAsString": true, + "values": [ + { + "value": "tool_calls" + } + ] + } + }, + "tool_calls": { + "type": "array", + "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`.\n", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "runStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "required": [ + "input", + "outputs" + ], + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "id", + "type", + "code_interpreter" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeObject": { + "title": "Code interpreter tool call", + "type": "object", + "description": "Details of the Code Interpreter tool call the run step was involved in.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call.", + "enum": [ + "code_interpreter" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeObjectType", + "modelAsString": true, + "values": [ + { + "value": "code_interpreter" + } + ] + } + }, + "code_interpreter": { + "type": "object", + "description": "The Code Interpreter tool call definition.", + "properties": { + "input": { + "type": "string", + "description": "The input to the Code Interpreter tool call." + }, + "outputs": { + "type": "array", + "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.", + "items": { + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + }, + { + "$ref": "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + } + ] + } + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "type", + "logs" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputLogsObject": { + "title": "Code interpreter log output", + "type": "object", + "description": "Text output from the Code Interpreter tool call as part of a run step.", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `logs`.", + "type": "string", + "enum": [ + "logs" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType", + "modelAsString": true, + "values": [ + { + "value": "logs" + } + ] + } + }, + "logs": { + "type": "string", + "description": "The text output from the Code Interpreter tool call." + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsCodeOutputImageObjectType", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The File ID of the image.", + "type": "string" + } + }, + "required": [ + "file_id" + ] + } + }, + "required": [ + "type", + "image" + ] + }, + "runStepDeltaStepDetailsToolCallsCodeOutputImageObject": { + "title": "Code interpreter image output", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the output in the outputs array." + }, + "type": { + "description": "Always `image`.", + "type": "string", + "enum": [ + "image" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsCodeOutputImageObject", + "modelAsString": true, + "values": [ + { + "value": "image" + } + ] + } + }, + "image": { + "type": "object", + "properties": { + "file_id": { + "description": "The file ID of the image.", + "type": "string" + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "runStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `file_search` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "id", + "type", + "file_search" + ] + }, + "runStepDeltaStepDetailsToolCallsFileSearchObject": { + "title": "File search tool call", + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `retrieval` for this type of tool call.", + "enum": [ + "file_search" + ], + "x-ms-enum": { + "name": "RunStepDeltaStepDetailsToolCallsFileSearchObjectType", + "modelAsString": true, + "values": [ + { + "value": "file_search" + } + ] + } + }, + "file_search": { + "type": "object", + "description": "For now, this is always going to be an empty object." + } + }, + "required": [ + "index", + "type", + "file_search" + ] + }, + "runStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.", + "nullable": true + } + }, + "required": [ + "name", + "arguments", + "output" + ] + } + }, + "required": [ + "id", + "type", + "function" + ] + }, + "runStepDeltaStepDetailsToolCallsFunctionObject": { + "type": "object", + "title": "Function tool call", + "properties": { + "index": { + "type": "integer", + "description": "The index of the tool call in the tool calls array." + }, + "id": { + "type": "string", + "description": "The ID of the tool call object." + }, + "type": { + "type": "string", + "description": "The type of tool call. This is always going to be `function` for this type of tool call.", + "enum": [ + "function" + ], + "x-ms-enum": { + "name": "RunStepDetailsToolCallsFunctionObjectType", + "modelAsString": true, + "values": [ + { + "value": "function" + } + ] + } + }, + "function": { + "type": "object", + "description": "The definition of the function that was called.", + "properties": { + "name": { + "type": "string", + "description": "The name of the function." + }, + "arguments": { + "type": "string", + "description": "The arguments passed to the function." + }, + "output": { + "type": "string", + "description": "The output of the function. This will be `null` if the outputs have not been submitted yet.", + "nullable": true + } + } + } + }, + "required": [ + "index", + "type" + ] + }, + "vectorStoreExpirationAfter": { + "type": "object", + "title": "Vector store expiration policy", + "description": "The expiration policy for a vector store.", + "properties": { + "anchor": { + "description": "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`.", + "type": "string", + "enum": [ + "last_active_at" + ], + "x-ms-enum": { + "name": "VectorStoreExpirationAfterAnchor", + "modelAsString": true, + "values": [ + { + "value": "last_active_at", + "description": "The anchor timestamp after which the expiration policy applies." + } + ] + } + }, + "days": { + "description": "The number of days after the anchor time that the vector store will expire.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + }, + "required": [ + "anchor", + "days" + ] + }, + "vectorStoreObject": { + "type": "object", + "title": "Vector store", + "description": "A vector store is a collection of processed files can be used by the `file_search` tool.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store`.", + "type": "string", + "enum": [ + "vector_store" + ] + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was created.", + "type": "integer" + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "usage_bytes": { + "description": "The total number of bytes used by the files in the vector store.", + "type": "integer" + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been successfully processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that were cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "failed", + "cancelled", + "total" + ] + }, + "status": { + "description": "The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.", + "type": "string", + "enum": [ + "expired", + "in_progress", + "completed" + ], + "x-ms-enum": { + "name": "VectorStoreObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "expired" + }, + { + "value": "in_progress" + }, + { + "value": "completed" + } + ] + } + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "expires_at": { + "description": "The Unix timestamp (in seconds) for when the vector store will expire.", + "type": "integer", + "nullable": true + }, + "last_active_at": { + "description": "The Unix timestamp (in seconds) for when the vector store was last active.", + "type": "integer", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "status", + "last_active_at", + "name", + "bytes", + "file_counts", + "metadata" + ] + }, + "createVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "maxItems": 500, + "items": { + "type": "string" + } + }, + "name": { + "description": "The name of the vector store.", + "type": "string" + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter" + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "updateVectorStoreRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "name": { + "description": "The name of the vector store.", + "type": "string", + "nullable": true + }, + "expires_after": { + "$ref": "#/components/schemas/vectorStoreExpirationAfter", + "nullable": true + }, + "metadata": { + "description": "Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.\n", + "type": "object", + "nullable": true + } + } + }, + "listVectorStoresResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreObject" + } + }, + "first_id": { + "type": "string", + "example": "vs_abc123" + }, + "last_id": { + "type": "string", + "example": "vs_abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.deleted", + "description": "The delete vector store response object state" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileObject": { + "type": "object", + "title": "Vector store files", + "description": "A list of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file`.", + "type": "string", + "enum": [ + "vector_store.file" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file" + } + ] + } + }, + "usage_bytes": { + "description": "The total vector store usage in bytes. Note that this may be different from the original file size.", + "type": "integer" + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store file was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the file is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "last_error": { + "type": "object", + "description": "The last error associated with this vector store file. Will be `null` if there are no errors.", + "nullable": true, + "properties": { + "code": { + "type": "string", + "description": "One of `server_error` or `rate_limit_exceeded`.", + "enum": [ + "internal_error", + "file_not_found", + "parsing_error", + "unhandled_mime_type" + ], + "x-ms-enum": { + "name": "VectorStoreFileObjectLastErrorCode", + "modelAsString": true, + "values": [ + { + "value": "internal_error" + }, + { + "value": "file_not_found" + }, + { + "value": "parsing_error" + }, + { + "value": "unhandled_mime_type" + } + ] + } + }, + "message": { + "type": "string", + "description": "A human-readable description of the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "chunking_strategy": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. Only applicable if `file_ids` is non-empty.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + } + }, + "required": [ + "id", + "object", + "usage_bytes", + "created_at", + "vector_store_id", + "status", + "last_error" + ] + }, + "otherChunkingStrategyResponseParam": { + "type": "object", + "title": "Other Chunking Strategy", + "description": "This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the `chunking_strategy` concept was introduced in the API.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `other`.", + "enum": [ + "other" + ], + "x-ms-enum": { + "name": "OtherChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "other" + } + ] + } + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyResponseParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ], + "x-ms-enum": { + "name": "StaticChunkingStrategyResponseParamType", + "modelAsString": true, + "values": [ + { + "value": "static" + } + ] + } + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "staticChunkingStrategy": { + "type": "object", + "additionalProperties": false, + "properties": { + "max_chunk_size_tokens": { + "type": "integer", + "minimum": 100, + "maximum": 4096, + "description": "The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`." + }, + "chunk_overlap_tokens": { + "type": "integer", + "description": "The number of tokens that overlap between chunks. The default value is `400`.\n\nNote that the overlap must not exceed half of `max_chunk_size_tokens`.\n" + } + }, + "required": [ + "max_chunk_size_tokens", + "chunk_overlap_tokens" + ] + }, + "autoChunkingStrategyRequestParam": { + "type": "object", + "title": "Auto Chunking Strategy", + "description": "The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `auto`.", + "enum": [ + "auto" + ] + } + }, + "required": [ + "type" + ] + }, + "staticChunkingStrategyRequestParam": { + "type": "object", + "title": "Static Chunking Strategy", + "additionalProperties": false, + "properties": { + "type": { + "type": "string", + "description": "Always `static`.", + "enum": [ + "static" + ] + }, + "static": { + "$ref": "#/components/schemas/staticChunkingStrategy" + } + }, + "required": [ + "type", + "static" + ] + }, + "chunkingStrategyRequestParam": { + "type": "object", + "description": "The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.", + "oneOf": [ + { + "$ref": "#/components/schemas/autoChunkingStrategyRequestParam" + }, + { + "$ref": "#/components/schemas/staticChunkingStrategyRequestParam" + } + ] + }, + "createVectorStoreFileRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_id": { + "description": "A File ID that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "string" + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_id" + ] + }, + "listVectorStoreFilesResponse": { + "properties": { + "object": { + "type": "string", + "example": "list" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/vectorStoreFileObject" + } + }, + "first_id": { + "type": "string", + "example": "file-abc123" + }, + "last_id": { + "type": "string", + "example": "file-abc456" + }, + "has_more": { + "type": "boolean", + "example": false + } + }, + "required": [ + "object", + "data", + "first_id", + "last_id", + "has_more" + ] + }, + "deleteVectorStoreFileResponse": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "object": { + "type": "string", + "enum": [ + "vector_store.file.deleted" + ], + "x-ms-enum": { + "name": "DeleteVectorStoreFileResponseObject", + "modelAsString": true, + "values": [ + { + "value": "vector_store.file.deleted" + } + ] + } + } + }, + "required": [ + "id", + "object", + "deleted" + ] + }, + "vectorStoreFileBatchObject": { + "type": "object", + "title": "Vector store file batch", + "description": "A batch of files attached to a vector store.", + "properties": { + "id": { + "description": "The identifier, which can be referenced in API endpoints.", + "type": "string" + }, + "object": { + "description": "The object type, which is always `vector_store.file_batch`.", + "type": "string", + "enum": [ + "vector_store.files_batch" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectType", + "modelAsString": true, + "values": [ + { + "value": "vector_store.files_batch" + } + ] + } + }, + "created_at": { + "description": "The Unix timestamp (in seconds) for when the vector store files batch was created.", + "type": "integer" + }, + "vector_store_id": { + "description": "The ID of the vector store that the File is attached to.", + "type": "string" + }, + "status": { + "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`.", + "type": "string", + "enum": [ + "in_progress", + "completed", + "cancelled", + "failed" + ], + "x-ms-enum": { + "name": "VectorStoreFileBatchObjectStatus", + "modelAsString": true, + "values": [ + { + "value": "in_progress" + }, + { + "value": "completed" + }, + { + "value": "cancelled" + }, + { + "value": "failed" + } + ] + } + }, + "file_counts": { + "type": "object", + "properties": { + "in_progress": { + "description": "The number of files that are currently being processed.", + "type": "integer" + }, + "completed": { + "description": "The number of files that have been processed.", + "type": "integer" + }, + "failed": { + "description": "The number of files that have failed to process.", + "type": "integer" + }, + "cancelled": { + "description": "The number of files that where cancelled.", + "type": "integer" + }, + "total": { + "description": "The total number of files.", + "type": "integer" + } + }, + "required": [ + "in_progress", + "completed", + "cancelled", + "failed", + "total" + ] + } + }, + "required": [ + "id", + "object", + "created_at", + "vector_store_id", + "status", + "file_counts" + ] + }, + "createVectorStoreFileBatchRequest": { + "type": "object", + "additionalProperties": false, + "properties": { + "file_ids": { + "description": "A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files.", + "type": "array", + "minItems": 1, + "maxItems": 500, + "items": { + "type": "string" + } + }, + "chunking_strategy": { + "$ref": "#/components/schemas/chunkingStrategyRequestParam" + } + }, + "required": [ + "file_ids" + ] + }, + "assistantStreamEvent": { + "description": "Represents an event emitted when streaming a Run.\n\nEach event in a server-sent events stream has an `event` and `data` property:\n\n```\nevent: thread.created\ndata: {\"id\": \"thread_123\", \"object\": \"thread\", ...}\n```\n\nWe emit events whenever a new object is created, transitions to a new state, or is being\nstreamed in parts (deltas). For example, we emit `thread.run.created` when a new run\nis created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses\nto create a message during a run, we emit a `thread.message.created event`, a\n`thread.message.in_progress` event, many `thread.message.delta` events, and finally a\n`thread.message.completed` event.\n\nWe may add additional events over time, so we recommend handling unknown events gracefully\nin your code. See the [Assistants API quick start](/docs/assistants/overview) to learn how to\nintegrate the Assistants API with streaming.\n", + "oneOf": [ + { + "$ref": "#/components/schemas/threadStreamEvent" + }, + { + "$ref": "#/components/schemas/runStreamEvent" + }, + { + "$ref": "#/components/schemas/runStepStreamEvent" + }, + { + "$ref": "#/components/schemas/messageStreamEvent" + }, + { + "$ref": "#/components/schemas/errorEvent" + }, + { + "$ref": "#/components/schemas/doneEvent" + } + ] + }, + "threadStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.created" + ], + "x-ms-enum": { + "name": "ThreadStreamEventEnum", + "modelAsString": true, + "values": [ + { + "value": "thread.created", + "description": "The thread created event" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/threadObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new thread is created." + } + ] + }, + "runStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.created" + ], + "x-ms-enum": { + "name": "RunStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a new run is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.queued" + ], + "x-ms-enum": { + "name": "RunStreamEventQueued", + "modelAsString": true, + "values": [ + { + "value": "thread.run.queued" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `queued` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.in_progress" + ], + "x-ms-enum": { + "name": "RunStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to an `in_progress` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.requires_action" + ], + "x-ms-enum": { + "name": "RunStreamEventRequiresAction", + "modelAsString": true, + "values": [ + { + "value": "thread.run.requires_action" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `requires_action` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.completed" + ], + "x-ms-enum": { + "name": "RunStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.failed" + ], + "x-ms-enum": { + "name": "RunStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelling" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelling", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelling" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run moves to a `cancelling` status." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.cancelled" + ], + "x-ms-enum": { + "name": "RunStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.expired" + ], + "x-ms-enum": { + "name": "RunStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run expires." + } + ] + }, + "runStepStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.created" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.in_progress" + ], + "x-ms-enum": { + "name": "RunStepStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.delta" + ], + "x-ms-enum": { + "name": "RunStepStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a run step are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.completed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.failed" + ], + "x-ms-enum": { + "name": "RunStepStreamEventFailed", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.failed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step fails." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.cancelled" + ], + "x-ms-enum": { + "name": "RunStepStreamEventCancelled", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.cancelled" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step is cancelled." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.run.step.expired" + ], + "x-ms-enum": { + "name": "RunStepStreamEventExpired", + "modelAsString": true, + "values": [ + { + "value": "thread.run.step.expired" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/runStepObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a run step expires." + } + ] + }, + "messageStreamEvent": { + "oneOf": [ + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.created" + ], + "x-ms-enum": { + "name": "MessageStreamEventCreated", + "modelAsString": true, + "values": [ + { + "value": "thread.message.created" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is created." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.in_progress" + ], + "x-ms-enum": { + "name": "MessageStreamEventInProgress", + "modelAsString": true, + "values": [ + { + "value": "thread.message.in_progress" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message moves to an `in_progress` state." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.delta" + ], + "x-ms-enum": { + "name": "MessageStreamEventDelta", + "modelAsString": true, + "values": [ + { + "value": "thread.message.delta" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageDeltaObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when parts of a message are being streamed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.completed" + ], + "x-ms-enum": { + "name": "MessageStreamEventCompleted", + "modelAsString": true, + "values": [ + { + "value": "thread.message.completed" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message is completed." + }, + { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "thread.message.incomplete" + ], + "x-ms-enum": { + "name": "MessageStreamEventIncomplete", + "modelAsString": true, + "values": [ + { + "value": "thread.message.incomplete" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/messageObject" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a message ends before it is completed." + } + ] + }, + "errorEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "error" + ], + "x-ms-enum": { + "name": "ErrorEventEnum", + "modelAsString": true, + "values": [ + { + "value": "error" + } + ] + } + }, + "data": { + "$ref": "#/components/schemas/error" + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when an error occurs. This can happen due to an internal server error or a timeout." + }, + "doneEvent": { + "type": "object", + "properties": { + "event": { + "type": "string", + "enum": [ + "done" + ], + "x-ms-enum": { + "name": "DoneEventEnum", + "modelAsString": true, + "values": [ + { + "value": "done" + } + ] + } + }, + "data": { + "type": "string", + "enum": [ + "[DONE]" + ], + "x-ms-enum": { + "name": "DoneEventDataEnum", + "modelAsString": true, + "values": [ + { + "value": "[DONE]" + } + ] + } + } + }, + "required": [ + "event", + "data" + ], + "description": "Occurs when a stream ends." + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml new file mode 100644 index 000000000000..aa5051f82553 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml @@ -0,0 +1,8336 @@ +openapi: 3.0.0 +info: + title: Azure OpenAI Service API + description: Azure OpenAI APIs for completions and search + version: 2024-09-01-preview +servers: + - url: https://{endpoint}/openai + variables: + endpoint: + default: your-resource-name.openai.azure.com +security: + - bearer: + - api.read + - apiKey: [] +paths: + /deployments/{deployment-id}/completions: + post: + summary: Creates a completion for the provided prompt, parameters and chosen model. + operationId: Completions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: davinci + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionRequest" + example: + prompt: |- + Negate the following sentence.The price for bubblegum increased on thursday. + + Negated Sentence: + max_tokens: 50 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/createCompletionResponse" + example: + model: davinci + object: text_completion + id: cmpl-4509KAos68kxOqpE2uYGw81j6m7uo + created: 1637097562 + choices: + - index: 0 + text: The price for bubblegum decreased on thursday. + logprobs: null + finish_reason: stop + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + /deployments/{deployment-id}/embeddings: + post: + summary: Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. + operationId: embeddings_create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: ada-search-index-v1 + description: The deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: true + properties: + input: + description: |- + Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. + Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present. + oneOf: + - type: string + default: "" + example: This is a test. + nullable: true + - type: array + minItems: 1 + maxItems: 2048 + items: + type: string + minLength: 1 + example: This is a test. + nullable: false + user: + description: A unique identifier representing your end-user, which can help monitoring and detecting abuse. + type: string + nullable: false + input_type: + description: input type of embedding search to use + type: string + example: query + encoding_format: + description: The format to return the embeddings in. Can be either `float` or `base64`. Defaults to `float`. + type: string + example: base64 + nullable: true + dimensions: + description: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. + type: integer + example: 1 + nullable: true + required: + - input + responses: + "200": + description: OK + content: + application/json: + schema: + type: object + properties: + object: + type: string + model: + type: string + data: + type: array + items: + type: object + properties: + index: + type: integer + object: + type: string + embedding: + type: array + items: + type: number + required: + - index + - object + - embedding + usage: + type: object + properties: + prompt_tokens: + type: integer + total_tokens: + type: integer + required: + - prompt_tokens + - total_tokens + required: + - object + - model + - data + - usage + x-ms-examples: + Create a embeddings.: + $ref: ./examples/embeddings.yaml + /deployments/{deployment-id}/chat/completions: + post: + summary: Creates a completion for the chat message + operationId: ChatCompletions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + description: Deployment id of the model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createChatCompletionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/createChatCompletionResponse" + - $ref: "#/components/schemas/createChatCompletionStreamResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + default: + description: Service unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/errorResponse" + headers: + apim-request-id: + description: Request ID for troubleshooting purposes + schema: + type: string + x-ms-examples: + Create a chat completion.: + $ref: ./examples/chat_completions.yaml + Creates a completion based on Azure Search data and system-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_minimum.yaml + Creates a completion based on Azure Search image vector data.: + $ref: ./examples/chat_completions_azure_search_image_vector.yaml + Creates a completion based on Azure Search vector data, previous assistant message and user-assigned managed identity.: + $ref: ./examples/chat_completions_azure_search_advanced.yaml + Creates a completion for the provided Azure Cosmos DB.: + $ref: ./examples/chat_completions_cosmos_db.yaml + Creates a completion for the provided Mongo DB.: + $ref: ./examples/chat_completions_mongo_db.yaml + Creates a completion for the provided Elasticsearch.: + $ref: ./examples/chat_completions_elasticsearch.yaml + Creates a completion for the provided Pinecone resource.: + $ref: ./examples/chat_completions_pinecone.yaml + /deployments/{deployment-id}/audio/transcriptions: + post: + summary: Transcribes audio into the input language. + operationId: Transcriptions_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranscriptionRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio transcription with json response format.: + $ref: ./examples/audio_transcription_object.yaml + Create an audio transcription with text response format.: + $ref: ./examples/audio_transcription_text.yaml + /deployments/{deployment-id}/audio/translations: + post: + summary: Transcribes and translates input audio into English text. + operationId: Translations_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: whisper + description: Deployment id of the whisper model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createTranslationRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/audioResponse" + - $ref: "#/components/schemas/audioVerboseResponse" + text/plain: + schema: + type: string + description: Transcribed text in the output format (when response_format was one of text, vtt or srt). + x-ms-examples: + Create an audio translation with json response format.: + $ref: ./examples/audio_translation_object.yaml + Create an audio translation with text response format.: + $ref: ./examples/audio_translation_text.yaml + /deployments/{deployment-id}/audio/speech: + post: + summary: Generates audio from the input text. + operationId: Speech_Create + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: tts-1 + description: Deployment id of the tts model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + multipart/form-data: + schema: + $ref: "#/components/schemas/createSpeechRequest" + responses: + "200": + description: OK + content: + application/octet-stream: + schema: + type: string + format: binary + x-ms-examples: + Create an audio from text with response format mp3.: + $ref: ./examples/audio_speech.yaml + /deployments/{deployment-id}/images/generations: + post: + summary: Generates a batch of images from a text caption on a given DALLE model deployment + operationId: ImageGenerations_Create + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/imageGenerationsRequest" + parameters: + - in: path + name: deployment-id + required: true + schema: + type: string + example: dalle-deployment + description: Deployment id of the dalle model which was deployed. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: Ok + content: + application/json: + schema: + $ref: "#/components/schemas/generateImagesResponse" + default: + description: An error occurred. + content: + application/json: + schema: + $ref: "#/components/schemas/dalleErrorResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/image_generation.yaml + /assistants: + get: + operationId: List_Assistants + tags: + - Assistants + summary: Returns a list of assistants. + parameters: + - name: limit + in: query + description: &pagination_limit_param_description | + A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: &pagination_order_param_description | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListAssistantsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: &pagination_after_param_description | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: &pagination_before_param_description | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listAssistantsResponse" + x-ms-examples: + Create an image.: + $ref: ./examples/list_assistants.yaml + post: + operationId: Create_Assistant + tags: + - Assistants + summary: Create an assistant with a model and instructions. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/create_assistant.yaml + + /assistants/{assistant_id}: + get: + operationId: Get_Assistant + tags: + - Assistants + summary: Retrieves an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/retrieve_assistant.yaml + post: + operationId: Modify_Assistant + tags: + - Assistant + summary: Modifies an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyAssistantRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/assistantObject" + x-ms-examples: + Create an assistant.: + $ref: ./examples/modify_assistant.yaml + delete: + operationId: Delete_Assistant + tags: + - Assistants + summary: Delete an assistant. + parameters: + - in: path + name: assistant_id + required: true + schema: + type: string + description: The ID of the assistant to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteAssistantResponse" + x-ms-examples: + Create an assistant.: + $ref: ./examples/delete_assistant.yaml + /threads: + post: + operationId: Create_Thread + tags: + - Assistants + summary: Create a thread. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/create_thread.yaml + /threads/{thread_id}: + get: + operationId: Get_Thread + tags: + - Assistants + summary: Retrieves a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Create a thread.: + $ref: ./examples/retrieve_thread.yaml + post: + operationId: Modify_Thread + tags: + - Assistants + summary: Modifies a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to modify. Only the `metadata` can be modified. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyThreadRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/threadObject" + x-ms-examples: + Modify a thread.: + $ref: ./examples/modify_thread.yaml + delete: + operationId: Delete_Thread + tags: + - Assistants + summary: Delete a thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteThreadResponse" + x-ms-examples: + Delete a thread.: + $ref: ./examples/delete_thread.yaml + /threads/{thread_id}/messages: + get: + operationId: List_Messages + tags: + - Assistants + summary: Returns a list of messages for a given thread. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) the messages belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: | + Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order. + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListMessagesOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: | + A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. + schema: + type: string + - name: before + in: query + description: | + A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. + schema: + type: string + - name: run_id + in: query + description: | + Filter messages by the run ID that generated them. + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listMessagesResponse" + x-ms-examples: + List messages.: + $ref: ./examples/list_messages.yaml + post: + operationId: Create_Message + tags: + - Assistants + summary: Create a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to create a message for. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Create a message.: + $ref: ./examples/create_message.yaml + /threads/{thread_id}/messages/{message_id}: + get: + operationId: Get_Message + tags: + - Assistants + summary: Retrieve a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Retrieve a message.: + $ref: ./examples/get_message.yaml + post: + operationId: Modify_Message + tags: + - Assistants + summary: Modifies a message. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this message belongs. + - in: path + name: message_id + required: true + schema: + type: string + description: The ID of the message to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyMessageRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/messageObject" + x-ms-examples: + Modify a message.: + $ref: ./examples/modify_message.yaml + /threads/runs: + post: + operationId: Create_Thread_And_Run + tags: + - Assistants + summary: Create a thread and run it in one request. + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createThreadAndRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a thread and run it.: + $ref: ./examples/create_thread_and_run.yaml + /threads/{thread_id}/runs: + get: + operationId: List_Runs + tags: + - Assistants + summary: Returns a list of runs belonging to a thread. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run belongs to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunsResponse" + x-ms-examples: + List runs.: + $ref: ./examples/list_runs.yaml + post: + operationId: Create_Run + tags: + - Assistants + summary: Create a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to run. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Create a run.: + $ref: ./examples/create_run.yaml + /threads/{thread_id}/runs/{run_id}: + get: + operationId: Get_Run + tags: + - Assistants + summary: Retrieves a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Retrieve a run.: + $ref: ./examples/get_run.yaml + post: + operationId: Modify_Run + tags: + - Assistants + summary: Modifies a run. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) that was run. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/modifyRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Modify a run.: + $ref: ./examples/modify_run.yaml + /threads/{thread_id}/runs/{run_id}/submit_tool_outputs: + post: + operationId: Submit_Tool_Outputs_To_Run + tags: + - Assistants + summary: | + When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the [thread](/docs/api-reference/threads) to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run that requires the tool output submission. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/submitToolOutputsRunRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Submit tool outputs to a run.: + $ref: ./examples/submit_tool_outputs_to_run.yaml + /threads/{thread_id}/runs/{run_id}/cancel: + post: + operationId: Cancel_Run + tags: + - Assistants + summary: Cancels a run that is `in_progress`. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which this run belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runObject" + x-ms-examples: + Cancel a run.: + $ref: ./examples/cancel_run.yaml + /threads/{thread_id}/runs/{run_id}/steps: + get: + operationId: List_Run_Steps + tags: + - Assistants + summary: Returns a list of run steps belonging to a run. + parameters: + - name: thread_id + in: path + required: true + schema: + type: string + description: The ID of the thread the run and run steps belong to. + - name: run_id + in: path + required: true + schema: + type: string + description: The ID of the run the run steps belong to. + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: + - asc + - desc + x-ms-enum: + name: ListRunStepsOrder + modelAsString: true + values: + - value: asc + description: Order results in ascending order + - value: desc + description: Order results in descending order + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listRunStepsResponse" + x-ms-examples: + List run steps.: + $ref: ./examples/list_run_steps.yaml + /threads/{thread_id}/runs/{run_id}/steps/{step_id}: + get: + operationId: Get_Run_Step + tags: + - Assistants + summary: Retrieves a run step. + parameters: + - in: path + name: thread_id + required: true + schema: + type: string + description: The ID of the thread to which the run and run step belongs. + - in: path + name: run_id + required: true + schema: + type: string + description: The ID of the run to which the run step belongs. + - in: path + name: step_id + required: true + schema: + type: string + description: The ID of the run step to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/runStepObject" + x-ms-examples: + Retrieve a run step.: + $ref: ./examples/get_run_step.yaml + /vector_stores: + get: + operationId: List_Vector_Stores + tags: + - Vector Stores + summary: Returns a list of vector stores. + parameters: + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoresOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoresResponse" + x-ms-examples: + List vector stores.: + $ref: ./examples/list_vector_stores.yaml + post: + operationId: Create_Vector_Store + tags: + - Vector Stores + summary: Create a vector store. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreRequest" + parameters: + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Create a vector store.: + $ref: ./examples/create_vector_store.yaml + + /vector_stores/{vector_store_id}: + get: + operationId: Get_Vector_Store + tags: + - Vector Stores + summary: Retrieves a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to retrieve. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Retrieve a vector store.: + $ref: ./examples/retrieve_vector_store.yaml + post: + operationId: Modify_Vector_Store + tags: + - Vector Stores + summary: Modifies a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to modify. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/updateVectorStoreRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreObject" + x-ms-examples: + Modify a vector store.: + $ref: ./examples/modify_vector_store.yaml + + delete: + operationId: Delete_Vector_Store + tags: + - Vector Stores + summary: Delete a vector store. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreResponse" + x-ms-examples: + Delete a vector store.: + $ref: ./examples/delete_vector_store.yaml + + /vector_stores/{vector_store_id}/files: + get: + operationId: List_Vector_Store_Files + tags: + - Vector Stores + summary: Returns a list of vector store files. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files.: + $ref: ./examples/list_vector_store_files.yaml + post: + operationId: Create_Vector_Store_File + tags: + - Vector Stores + summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object). + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Create a vector store file.: + $ref: ./examples/create_vector_store_file.yaml + + /vector_stores/{vector_store_id}/files/{file_id}: + get: + operationId: Get_Vector_Store_File + tags: + - Vector Stores + summary: Retrieves a vector store file. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + example: file-abc123 + description: The ID of the file being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileObject" + x-ms-examples: + Retrieve a vector store file.: + $ref: ./examples/retrieve_vector_store_file.yaml + delete: + operationId: Delete_Vector_Store_File + tags: + - Vector Stores + summary: Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file belongs to. + - in: path + name: file_id + required: true + schema: + type: string + description: The ID of the file to delete. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/deleteVectorStoreFileResponse" + x-ms-examples: + Delete a vector store file.: + $ref: ./examples/delete_vector_store_file.yaml + + /vector_stores/{vector_store_id}/file_batches: + post: + operationId: Create_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Create a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: | + The ID of the vector store for which to create a File Batch. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/createVectorStoreFileBatchRequest" + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Create a vector store file batch.: + $ref: ./examples/create_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}: + get: + operationId: Get_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Retrieves a vector store file batch. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + example: vs_abc123 + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + example: vsfb_abc123 + description: The ID of the file batch being retrieved. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Retrieve a vector store file batch.: + $ref: ./examples/retrieve_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel: + post: + operationId: Cancel_Vector_Store_File_Batch + tags: + - Vector Stores + summary: Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible. + parameters: + - in: path + name: vector_store_id + required: true + schema: + type: string + description: The ID of the vector store that the file batch belongs to. + - in: path + name: batch_id + required: true + schema: + type: string + description: The ID of the file batch to cancel. + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/vectorStoreFileBatchObject" + x-ms-examples: + Cancel a vector store file batch.: + $ref: ./examples/cancel_vector_store_file_batch.yaml + + /vector_stores/{vector_store_id}/file_batches/{batch_id}/files: + get: + operationId: List_Vector_Store_File_Batch_Files + tags: + - Vector Stores + summary: Returns a list of vector store files in a batch. + parameters: + - name: vector_store_id + in: path + description: The ID of the vector store that the files belong to. + required: true + schema: + type: string + - name: batch_id + in: path + description: The ID of the file batch that the files belong to. + required: true + schema: + type: string + - name: limit + in: query + description: *pagination_limit_param_description + required: false + schema: + type: integer + default: 20 + - name: order + in: query + description: *pagination_order_param_description + schema: + type: string + default: desc + enum: ["asc", "desc"] + x-ms-enum: + name: ListVectorStoreFilesOrder + modelAsString: true + values: + - value: asc + - value: desc + - name: after + in: query + description: *pagination_after_param_description + schema: + type: string + - name: before + in: query + description: *pagination_before_param_description + schema: + type: string + - name: filter + in: query + description: "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`." + schema: + type: string + enum: ["in_progress", "completed", "failed", "cancelled"] + x-ms-enum: + name: ListVectorStoreFilesFilter + modelAsString: true + values: + - value: in_progress + - value: completed + - value: failed + - value: cancelled + - in: query + name: api-version + required: true + schema: + type: string + example: 2024-09-01-preview + description: api version + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/listVectorStoreFilesResponse" + x-ms-examples: + List vector store files in a batch.: + $ref: ./examples/list_vector_store_file_batch.yaml + +components: + schemas: + errorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/error" + errorBase: + type: object + properties: + code: + type: string + message: + type: string + error: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/innerError" + innerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + innerErrorCode: + description: Error codes for the inner error object. + enum: + - ResponsibleAIPolicyViolation + type: string + x-ms-enum: + name: InnerErrorCode + modelAsString: true + values: + - value: ResponsibleAIPolicyViolation + description: The prompt violated one of more content filter rules. + dalleErrorResponse: + type: object + properties: + error: + $ref: "#/components/schemas/dalleError" + dalleError: + type: object + allOf: + - $ref: "#/components/schemas/errorBase" + properties: + param: + type: string + type: + type: string + inner_error: + $ref: "#/components/schemas/dalleInnerError" + dalleInnerError: + description: Inner error with additional details. + type: object + properties: + code: + $ref: "#/components/schemas/innerErrorCode" + content_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + contentFilterResultBase: + type: object + properties: + filtered: + type: boolean + required: + - filtered + contentFilterSeverityResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + severity: + type: string + enum: + - safe + - low + - medium + - high + x-ms-enum: + name: ContentFilterSeverity + modelAsString: true + values: + - value: safe + description: General content or related content in generic or non-harmful contexts. + - value: low + description: Harmful content at a low intensity and risk level. + - value: medium + description: Harmful content at a medium intensity and risk level. + - value: high + description: Harmful content at a high intensity and risk level. + required: + - severity + - filtered + contentFilterDetectedResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + detected: + type: boolean + required: + - detected + - filtered + contentFilterDetectedWithCitationResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + citation: + type: object + properties: + URL: + type: string + license: + type: string + required: + - detected + - filtered + contentFilterIdResult: + type: object + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + id: + type: string + required: + - id + - filtered + contentFilterResultsBase: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + error: + $ref: "#/components/schemas/errorBase" + contentFilterPromptResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + indirect_attack: + $ref: "#/components/schemas/contentFilterDetectedResult" + contentFilterChoiceResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about third party text and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/contentFilterResultsBase" + - properties: + protected_material_text: + $ref: "#/components/schemas/contentFilterDetectedResult" + - properties: + protected_material_code: + $ref: "#/components/schemas/contentFilterDetectedWithCitationResult" + contentFilterDetailedResults: + type: object + description: Content filtering results with a detail of content filter ids for the filtered segments. + allOf: + - $ref: "#/components/schemas/contentFilterResultBase" + - properties: + details: + items: + $ref: "#/components/schemas/contentFilterIdResult" + type: array + required: + - filtered + - details + promptFilterResult: + type: object + description: Content filtering results for a single prompt in the request. + properties: + prompt_index: + type: integer + content_filter_results: + $ref: "#/components/schemas/contentFilterPromptResults" + promptFilterResults: + type: array + description: Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders. + items: + $ref: "#/components/schemas/promptFilterResult" + dalleContentFilterResults: + type: object + description: Information about the content filtering results. + properties: + sexual: + $ref: "#/components/schemas/contentFilterSeverityResult" + violence: + $ref: "#/components/schemas/contentFilterSeverityResult" + hate: + $ref: "#/components/schemas/contentFilterSeverityResult" + self_harm: + $ref: "#/components/schemas/contentFilterSeverityResult" + dalleFilterResults: + type: object + description: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not. Information about jailbreak content and profanity, if it has been detected, and if it has been filtered or not. And information about customer block list, if it has been filtered and its id. + allOf: + - $ref: "#/components/schemas/dalleContentFilterResults" + - properties: + profanity: + $ref: "#/components/schemas/contentFilterDetectedResult" + jailbreak: + $ref: "#/components/schemas/contentFilterDetectedResult" + custom_blocklists: + $ref: "#/components/schemas/contentFilterDetailedResults" + chatCompletionsRequestCommon: + type: object + properties: + temperature: + description: |- + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + We generally recommend altering this or `top_p` but not both. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + description: |- + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + We generally recommend altering this or `temperature` but not both. + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + stream: + description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message." + type: boolean + nullable: true + default: false + stop: + description: Up to 4 sequences where the API will stop generating further tokens. + oneOf: + - type: string + nullable: true + - type: array + items: + type: string + nullable: false + minItems: 1 + maxItems: 4 + description: Array minimum size of 1 and maximum of 4 + default: null + max_tokens: + description: | + The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). + + This value is now deprecated in favor of `max_completion_tokens`, and is not compatible with o1 series models. + type: integer + default: 4096 + max_completion_tokens: + description: | + An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. + + type: integer + nullable: true + presence_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + type: number + default: 0 + minimum: -2 + maximum: 2 + frequency_penalty: + description: Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + type: number + default: 0 + minimum: -2 + maximum: 2 + logit_bias: + description: Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + type: object + nullable: true + user: + description: A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse. + type: string + example: user-1234 + nullable: false + createCompletionRequest: + type: object + properties: + prompt: + description: &completions_prompt_description | + The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays. + + Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. + default: "<|endoftext|>" + nullable: true + oneOf: + - type: string + default: "" + example: "This is a test." + - type: array + items: + type: string + default: "" + example: "This is a test." + best_of: + type: integer + default: 1 + minimum: 0 + maximum: 20 + nullable: true + description: &completions_best_of_description | + Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed. + + When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + echo: + type: boolean + default: false + nullable: true + description: &completions_echo_description > + Echo back the prompt in addition to the completion + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_frequency_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. + + logit_bias: &completions_logit_bias + type: object + x-oaiTypeLabel: map + default: null + nullable: true + additionalProperties: + type: integer + description: &completions_logit_bias_description | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](https://platform.openai.com/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + + As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated. + logprobs: &completions_logprobs_configuration + type: integer + minimum: 0 + maximum: 5 + default: null + nullable: true + description: &completions_logprobs_description | + Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response. + + The maximum value for `logprobs` is 5. + max_tokens: + type: integer + minimum: 0 + default: 16 + example: 16 + nullable: true + description: &completions_max_tokens_description | + The maximum number of [tokens](https://platform.openai.com/tokenizer) that can be generated in the completion. + + The token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: &completions_completions_description | + How many completions to generate for each prompt. + + **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: &completions_presence_penalty_description | + Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. + seed: &completions_seed_param + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: &completions_stop_description > + Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. + default: null + nullable: true + oneOf: + - type: string + default: <|endoftext|> + example: "\n" + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + example: '["\n"]' + stream: + description: > + Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + suffix: + description: | + The suffix that comes after a completion of inserted text. + + This parameter is only supported for `gpt-3.5-turbo-instruct`. + default: null + nullable: true + type: string + example: "test." + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: &completions_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + + We generally recommend altering this or `top_p` but not both. + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &completions_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or `temperature` but not both. + user: &end_user_param_configuration + type: string + example: user-1234 + description: | + A unique identifier representing your end-user, which can help to monitor and detect abuse. + required: + - prompt + + createCompletionResponse: + type: object + description: | + Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). + properties: + id: + type: string + description: A unique identifier for the completion. + choices: + type: array + description: The list of completion choices the model generated for the input prompt. + items: + type: object + required: + - finish_reason + - index + - logprobs + - text + properties: + finish_reason: + type: string + description: &completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + or `content_filter` if content was omitted due to a flag from our content filters. + enum: ["stop", "length", "content_filter"] + index: + type: integer + logprobs: + type: object + nullable: true + properties: + text_offset: + type: array + items: + type: integer + token_logprobs: + type: array + items: + type: number + tokens: + type: array + items: + type: string + top_logprobs: + type: array + items: + type: object + additionalProperties: + type: number + text: + type: string + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + created: + type: integer + description: The Unix timestamp (in seconds) of when the completion was created. + model: + type: string + description: The model used for completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always "text_completion" + enum: [text_completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - id + - object + - created + - model + - choices + + createChatCompletionRequest: + type: object + allOf: + - $ref: "#/components/schemas/chatCompletionsRequestCommon" + - properties: + messages: + description: A list of messages comprising the conversation so far. [Example Python code](https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb). + type: array + minItems: 1 + items: + $ref: "#/components/schemas/chatCompletionRequestMessage" + data_sources: + type: array + description: |2- + The configuration entries for Azure OpenAI chat extensions that use them. + This additional specification is only compatible with Azure OpenAI. + items: + $ref: "#/components/schemas/azureChatExtensionConfiguration" + frequency_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_frequency_penalty_description + logit_bias: + type: object + default: null + nullable: true + additionalProperties: + type: integer + description: | + Modify the likelihood of specified tokens appearing in the completion. + + Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. + logprobs: + description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. + type: boolean + default: false + nullable: true + top_logprobs: + description: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. + type: integer + minimum: 0 + maximum: 20 + nullable: true + max_tokens: + description: | + The maximum number of [tokens](/tokenizer) that can be generated in the chat completion. + + The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. + type: integer + nullable: true + n: + type: integer + minimum: 1 + maximum: 128 + default: 1 + example: 1 + nullable: true + description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + presence_penalty: + type: number + default: 0 + minimum: -2 + maximum: 2 + nullable: true + description: *completions_presence_penalty_description + response_format: + description: | + An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - $ref: "#/components/schemas/ResponseFormatText" + - $ref: "#/components/schemas/ResponseFormatJsonObject" + - $ref: "#/components/schemas/ResponseFormatJsonSchema" + x-oaiExpandable: true + seed: + type: integer + minimum: -9223372036854775808 + maximum: 9223372036854775807 + nullable: true + description: | + This feature is in Beta. + If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. + Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. + stop: + description: | + Up to 4 sequences where the API will stop generating further tokens. + default: null + oneOf: + - type: string + nullable: true + - type: array + minItems: 1 + maxItems: 4 + items: + type: string + stream: + description: > + If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) + as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). + type: boolean + nullable: true + default: false + stream_options: + $ref: "#/components/schemas/chatCompletionStreamOptions" + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *completions_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *completions_top_p_description + tools: + type: array + description: > + A list of tools the model may call. Currently, only functions are supported as a tool. + Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. + items: + $ref: "#/components/schemas/chatCompletionTool" + tool_choice: + $ref: "#/components/schemas/chatCompletionToolChoiceOption" + function_call: + deprecated: true + description: | + Deprecated in favor of `tool_choice`. + + Controls which (if any) function is called by the model. + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + + `none` is the default when no functions are present. `auto` is the default if functions are present. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + - $ref: "#/components/schemas/chatCompletionFunctionCallOption" + x-oaiExpandable: true + functions: + deprecated: true + description: | + Deprecated in favor of `tools`. + + A list of functions the model may generate JSON inputs for. + type: array + minItems: 1 + maxItems: 128 + items: + $ref: "#/components/schemas/chatCompletionFunctions" + user: *end_user_param_configuration + + required: + - messages + + chatCompletionFunctions: + type: object + deprecated: true + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + required: + - name + + chatCompletionFunctionCallOption: + type: object + description: > + Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. + properties: + name: + type: string + description: The name of the function to call. + required: + - name + + chatCompletionFunctionParameters: + type: object + description: The parameters the functions accepts, described as a JSON Schema object. See the [guide/](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. + additionalProperties: true + + chatCompletionRequestMessage: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestSystemMessage" + - $ref: "#/components/schemas/chatCompletionRequestUserMessage" + - $ref: "#/components/schemas/chatCompletionRequestAssistantMessage" + - $ref: "#/components/schemas/chatCompletionRequestToolMessage" + - $ref: "#/components/schemas/chatCompletionRequestFunctionMessage" + + chatCompletionRequestSystemMessage: + type: object + title: System message + properties: + content: + description: The contents of the system message. + oneOf: + - type: string + description: The contents of the system message. + title: Text content + - type: array + description: An array of content parts with a defined type. For system messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestSystemMessageContentPart" + minItems: 1 + role: + type: string + enum: ["system"] + description: The role of the messages author, in this case `system`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestUserMessage: + type: object + title: User message + properties: + content: + description: | + The contents of the user message. + oneOf: + - type: string + description: The text contents of the message. + title: Text content + - type: array + description: An array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4o` model. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestUserMessageContentPart" + minItems: 1 + x-oaiExpandable: true + role: + type: string + enum: ["user"] + description: The role of the messages author, in this case `user`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + required: + - content + - role + + chatCompletionRequestAssistantMessage: + type: object + title: Assistant message + properties: + content: + nullable: true + oneOf: + - type: string + description: The contents of the assistant message. + title: Text content + - type: array + description: An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestAssistantMessageContentPart" + minItems: 1 + description: | + The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. + refusal: + nullable: true + type: string + description: The refusal message by the assistant. + role: + type: string + enum: ["assistant"] + description: The role of the messages author, in this case `assistant`. + name: + type: string + description: An optional name for the participant. Provides the model information to differentiate between participants of the same role. + tool_calls: + $ref: "#/components/schemas/chatCompletionMessageToolCalls" + function_call: + type: object + deprecated: true + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + nullable: true + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + required: + - arguments + - name + required: + - role + + chatCompletionRequestToolMessage: + type: object + title: Tool message + properties: + role: + type: string + enum: ["tool"] + description: The role of the messages author, in this case `tool`. + content: + oneOf: + - type: string + description: The contents of the tool message. + title: Text content + - type: array + description: An array of content parts with a defined type. For tool messages, only type `text` is supported. + title: Array of content parts + items: + $ref: "#/components/schemas/chatCompletionRequestToolMessageContentPart" + minItems: 1 + description: The contents of the tool message. + tool_call_id: + type: string + description: Tool call that this message is responding to. + required: + - role + - content + - tool_call_id + + chatCompletionRequestFunctionMessage: + type: object + title: Function message + deprecated: true + properties: + role: + type: string + enum: ["function"] + description: The role of the messages author, in this case `function`. + content: + nullable: true + type: string + description: The contents of the function message. + name: + type: string + description: The name of the function to call. + required: + - role + - content + - name + + chatCompletionRequestSystemMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestUserMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartImage" + + chatCompletionRequestAssistantMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartRefusal" + + chatCompletionRequestToolMessageContentPart: + oneOf: + - $ref: "#/components/schemas/chatCompletionRequestMessageContentPartText" + + chatCompletionRequestMessageContentPartText: + type: object + title: Text content part + properties: + type: + type: string + enum: ["text"] + description: The type of the content part. + text: + type: string + description: The text content. + required: + - type + - text + + chatCompletionRequestMessageContentPartImage: + type: object + title: Image content part + properties: + type: + type: string + enum: ["image_url"] + description: The type of the content part. + image_url: + type: object + properties: + url: + type: string + description: Either a URL of the image or the base64 encoded image data. + format: uri + detail: + type: string + description: Specifies the detail level of the image. Learn more in the [Vision guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/gpt-with-vision?tabs=rest%2Csystem-assigned%2Cresource#detail-parameter-settings-in-image-processing-low-high-auto). + enum: ["auto", "low", "high"] + default: "auto" + required: + - url + required: + - type + - image_url + + chatCompletionRequestMessageContentPartRefusal: + type: object + title: Refusal content part + properties: + type: + type: string + enum: ["refusal"] + description: The type of the content part. + refusal: + type: string + description: The refusal message generated by the model. + required: + - type + - refusal + azureChatExtensionConfiguration: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/azureChatExtensionType" + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + discriminator: + propertyName: type + mapping: + azure_search: "#/components/schemas/azureSearchChatExtensionConfiguration" + azure_cosmos_db: "#/components/schemas/azureCosmosDBChatExtensionConfiguration" + elasticsearch: "#/components/schemas/elasticsearchChatExtensionConfiguration" + mongo_db: "#/components/schemas/mongoDBChatExtensionConfiguration" + pinecone: "#/components/schemas/pineconeChatExtensionConfiguration" + azureChatExtensionType: + type: string + description: |2- + A representation of configuration data for a single Azure OpenAI chat extension. This will be used by a chat + completions request that should use Azure OpenAI chat extensions to augment the response behavior. + The use of this configuration is compatible only with Azure OpenAI. + enum: + - azure_search + - azure_cosmos_db + - elasticsearch + - mongo_db + - pinecone + x-ms-enum: + name: AzureChatExtensionType + modelAsString: true + values: + - name: azureSearch + value: azure_search + description: Represents the use of Azure Search as an Azure OpenAI chat extension. + - name: azureCosmosDB + value: azure_cosmos_db + description: Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension. + - name: elasticsearch + value: elasticsearch + description: Represents the use of Elasticsearch® index as an Azure OpenAI chat extension. + - name: mongoDB + value: mongo_db + description: Represents the use of Mongo DB as an Azure OpenAI chat extension. + - name: pinecone + value: pinecone + description: Represents the use of Pinecone index as an Azure OpenAI chat extension. + azureSearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureSearchChatExtensionParameters" + x-ms-discriminator-value: azure_search + azureSearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The absolute endpoint path for the Azure Search resource to use. + format: uri + index_name: + type: string + description: The name of the index to use as available in the referenced Azure Search resource. + fields_mapping: + $ref: "#/components/schemas/azureSearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/azureSearchQueryType" + semantic_configuration: + type: string + description: The additional semantic configuration for the query. + filter: + type: string + description: Search filter. + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataIntegratedVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for Azure Search when used as an Azure OpenAI chat extension. + azureSearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + image_vector_fields: + type: array + description: The names of fields that represent image vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Search resource. + azureSearchQueryType: + type: string + description: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - semantic + - vector + - vector_simple_hybrid + - vector_semantic_hybrid + x-ms-enum: + name: AzureSearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: semantic + value: semantic + description: Represents the semantic query parser for advanced semantic modeling. + - name: vector + value: vector + description: Represents vector search over computed data. + - name: vectorSimpleHybrid + value: vector_simple_hybrid + description: Represents a combination of the simple query strategy with vector data. + - name: vectorSemanticHybrid + value: vector_semantic_hybrid + description: Represents a combination of semantic search and vector data querying. + azureCosmosDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/azureCosmosDBChatExtensionParameters" + x-ms-discriminator-value: azure_cosmos_db + azureCosmosDBChatExtensionParameters: + required: + - authentication + - container_name + - database_name + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + database_name: + type: string + description: The MongoDB vCore database name to use with Azure Cosmos DB. + container_name: + type: string + description: The name of the Azure Cosmos DB resource container. + index_name: + type: string + description: The MongoDB vCore index name to use with Azure Cosmos DB. + fields_mapping: + $ref: "#/components/schemas/azureCosmosDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for + MongoDB vCore. + azureCosmosDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource. + elasticsearchChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/elasticsearchChatExtensionParameters" + x-ms-discriminator-value: elasticsearch + elasticsearchChatExtensionParameters: + required: + - authentication + - endpoint + - index_name + type: object + properties: + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The endpoint of Elasticsearch®. + format: uri + index_name: + type: string + description: The index name of Elasticsearch®. + fields_mapping: + $ref: "#/components/schemas/elasticsearchIndexFieldMappingOptions" + query_type: + $ref: "#/components/schemas/elasticsearchQueryType" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + - $ref: "#/components/schemas/onYourDataModelIdVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: "Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. " + elasticsearchIndexFieldMappingOptions: + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Elasticsearch® resource. + elasticsearchQueryType: + type: string + description: The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension. + enum: + - simple + - vector + x-ms-enum: + name: ElasticsearchQueryType + modelAsString: true + values: + - name: simple + value: simple + description: Represents the default, simple query parser. + - name: vector + value: vector + description: Represents vector search over computed data. + mongoDBChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Mongo DB when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/mongoDBChatExtensionParameters" + x-ms-discriminator-value: mongo_db + mongoDBChatExtensionParameters: + required: + - authentication + - app_name + - collection_name + - database_name + - endpoint + - embedding_dependency + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + endpoint: + type: string + description: The name of the Mongo DB cluster endpoint. + database_name: + type: string + description: The name of the Mongo DB database. + collection_name: + type: string + description: The name of the Mongo DB Collection. + app_name: + type: string + description: The name of the Mongo DB Application. + index_name: + type: string + description: The The name of the Mongo DB index. + fields_mapping: + $ref: "#/components/schemas/mongoDBFieldMappingOptions" + embedding_dependency: + oneOf: + - $ref: "#/components/schemas/onYourDataEndpointVectorizationSource" + - $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: |- + Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Mongo DB. + + mongoDBFieldMappingOptions: + required: + - content_fields + - vector_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + vector_fields: + type: array + description: The names of fields that represent vector data. + items: + type: string + description: Optional settings to control how fields are processed when using a configured Mongo DB resource. + + pineconeChatExtensionConfiguration: + required: + - parameters + description: |- + A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat + extension. + allOf: + - $ref: "#/components/schemas/azureChatExtensionConfiguration" + - properties: + parameters: + $ref: "#/components/schemas/pineconeChatExtensionParameters" + x-ms-discriminator-value: pinecone + pineconeChatExtensionParameters: + required: + - authentication + - embedding_dependency + - environment + - fields_mapping + - index_name + type: object + properties: + authentication: + $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + top_n_documents: + type: integer + description: The configured top number of documents to feature for the configured query. + format: int32 + max_search_queries: + type: integer + description: The max number of rewritten queries should be send to search provider for one user message. If not specified, the system will decide the number of queries to send. + format: int32 + allow_partial_result: + type: boolean + default: false + description: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail. If not specified, or specified as false, the request will fail if any search query fails. + in_scope: + type: boolean + description: Whether queries should be restricted to use of indexed data. + strictness: + maximum: 5 + minimum: 1 + type: integer + description: The configured strictness of the search relevance filtering. The higher of strictness, the higher of the precision but lower recall of the answer. + format: int32 + environment: + type: string + description: The environment name of Pinecone. + index_name: + type: string + description: The name of the Pinecone database index. + fields_mapping: + $ref: "#/components/schemas/pineconeFieldMappingOptions" + embedding_dependency: + $ref: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + include_contexts: + type: array + description: The included properties of the output context. If not specified, the default value is `citations` and `intent`. + items: + $ref: "#/components/schemas/onYourDataContextProperty" + description: Parameters for configuring Azure OpenAI Pinecone chat extensions. + pineconeFieldMappingOptions: + required: + - content_fields + type: object + properties: + title_field: + type: string + description: The name of the index field to use as a title. + url_field: + type: string + description: The name of the index field to use as a URL. + filepath_field: + type: string + description: The name of the index field to use as a filepath. + content_fields: + type: array + description: The names of index fields that should be treated as content. + items: + type: string + content_fields_separator: + type: string + description: The separator pattern that content fields should use. + description: Optional settings to control how fields are processed when using a configured Pinecone resource. + onYourDataAuthenticationOptions: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataAuthenticationType" + description: The authentication options for Azure OpenAI On Your Data. + discriminator: + propertyName: type + mapping: + api_key: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + connection_string: "#/components/schemas/onYourDataConnectionStringAuthenticationOptions" + key_and_key_id: "#/components/schemas/onYourDataKeyAndKeyIdAuthenticationOptions" + encoded_api_key: "#/components/schemas/onYourDataEncodedApiKeyAuthenticationOptions" + access_token: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + system_assigned_managed_identity: "#/components/schemas/onYourDataSystemAssignedManagedIdentityAuthenticationOptions" + user_assigned_managed_identity: "#/components/schemas/onYourDataUserAssignedManagedIdentityAuthenticationOptions" + username_and_password: "#/components/schemas/onYourDataUsernameAndPasswordAuthenticationOptions" + onYourDataContextProperty: + type: string + description: The context property. + enum: + - citations + - intent + - all_retrieved_documents + x-ms-enum: + name: OnYourDataContextProperty + modelAsString: true + values: + - name: citations + value: citations + description: The `citations` property. + - name: intent + value: intent + description: The `intent` property. + - name: allRetrievedDocuments + value: all_retrieved_documents + description: The `all_retrieved_documents` property. + onYourDataAuthenticationType: + type: string + description: The authentication types supported with Azure OpenAI On Your Data. + enum: + - api_key + - connection_string + - key_and_key_id + - encoded_api_key + - access_token + - system_assigned_managed_identity + - user_assigned_managed_identity + - username_and_password + x-ms-enum: + name: OnYourDataAuthenticationType + modelAsString: true + values: + - name: apiKey + value: api_key + description: Authentication via API key. + - name: connectionString + value: connection_string + description: Authentication via connection string. + - name: keyAndKeyId + value: key_and_key_id + description: Authentication via key and key ID pair. + - name: encodedApiKey + value: encoded_api_key + description: Authentication via encoded API key. + - name: accessToken + value: access_token + description: Authentication via access token. + - name: systemAssignedManagedIdentity + value: system_assigned_managed_identity + description: Authentication via system-assigned managed identity. + - name: userAssignedManagedIdentity + value: user_assigned_managed_identity + description: Authentication via user-assigned managed identity. + - name: usernameAndPassword + value: username_and_password + description: Authentication via username and password. + onYourDataApiKeyAuthenticationOptions: + required: + - key + description: The authentication options for Azure OpenAI On Your Data when using an API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The API key to use for authentication. + x-ms-discriminator-value: api_key + onYourDataConnectionStringAuthenticationOptions: + required: + - connection_string + description: The authentication options for Azure OpenAI On Your Data when using a connection string. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + connection_string: + type: string + description: The connection string to use for authentication. + x-ms-discriminator-value: connection_string + onYourDataKeyAndKeyIdAuthenticationOptions: + required: + - key + - key_id + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + key: + type: string + description: The Elasticsearch key to use for authentication. + key_id: + type: string + description: The Elasticsearch key ID to use for authentication. + x-ms-discriminator-value: key_and_key_id + onYourDataEncodedApiKeyAuthenticationOptions: + required: + - encoded_api_key + description: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + encoded_api_key: + type: string + description: The Elasticsearch encoded API key to use for authentication. + x-ms-discriminator-value: encoded_api_key + onYourDataAccessTokenAuthenticationOptions: + required: + - access_token + description: The authentication options for Azure OpenAI On Your Data when using access token. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + access_token: + type: string + description: The access token to use for authentication. + x-ms-discriminator-value: access_token + onYourDataSystemAssignedManagedIdentityAuthenticationOptions: + description: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + x-ms-discriminator-value: system_assigned_managed_identity + onYourDataUserAssignedManagedIdentityAuthenticationOptions: + required: + - managed_identity_resource_id + description: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + managed_identity_resource_id: + type: string + description: The resource ID of the user-assigned managed identity to use for authentication. + x-ms-discriminator-value: user_assigned_managed_identity + onYourDataUsernameAndPasswordAuthenticationOptions: + required: + - username + - password + description: The authentication options for Azure OpenAI On Your Data when using a username and a password. + allOf: + - $ref: "#/components/schemas/onYourDataAuthenticationOptions" + - properties: + username: + type: string + description: The username to use for authentication. + password: + type: string + description: The password. to use for authentication. + x-ms-discriminator-value: username_and_password + onYourDataVectorizationSource: + required: + - type + type: object + properties: + type: + $ref: "#/components/schemas/onYourDataVectorizationSourceType" + description: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search. + discriminator: + propertyName: type + mapping: + endpoint: "#/components/schemas/onYourDataEndpointVectorizationSource" + deployment_name: "#/components/schemas/onYourDataDeploymentNameVectorizationSource" + integrated: "#/components/schemas/onYourDataIntegratedVectorizationSource" + model_id: "#/components/schemas/onYourDataModelIdVectorizationSource" + onYourDataVectorizationSourceType: + type: string + description: |- + Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with + vector search. + enum: + - endpoint + - deployment_name + - integrated + - model_id + x-ms-enum: + name: OnYourDataVectorizationSourceType + modelAsString: true + values: + - name: endpoint + value: endpoint + description: Represents vectorization performed by public service calls to an Azure OpenAI embedding model. + - name: deploymentName + value: deployment_name + description: |- + Represents an Ada model deployment name to use. This model deployment must be in the same Azure OpenAI resource, but + On Your Data will use this model deployment via an internal call rather than a public one, which enables vector + search even in private networks. + - name: integrated + value: integrated + description: Represents the integrated vectorizer defined within the search resource. + - name: modelId + value: model_id + description: |- + Represents a specific embedding model ID as defined in the search service. + Currently only supported by Elasticsearch®. + onYourDataEndpointVectorizationSource: + required: + - authentication + - endpoint + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a public Azure OpenAI endpoint call for embeddings. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + endpoint: + type: string + description: Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed. + format: uri + authentication: + oneOf: + - $ref: "#/components/schemas/onYourDataApiKeyAuthenticationOptions" + - $ref: "#/components/schemas/onYourDataAccessTokenAuthenticationOptions" + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: endpoint + onYourDataDeploymentNameVectorizationSource: + required: + - deployment_name + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on an internal embeddings model deployment name in the same Azure OpenAI resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + deployment_name: + type: string + description: Specifies the name of the model deployment to use for vectorization. This model deployment must be in the same Azure OpenAI resource, but On Your Data will use this model deployment via an internal call rather than a public one, which enables vector search even in private networks. + dimensions: + type: integer + description: The number of dimensions the embeddings should have. Only supported in `text-embedding-3` and later models. + format: int32 + x-ms-discriminator-value: deployment_name + onYourDataIntegratedVectorizationSource: + description: |- + Represents the integrated vectorizer defined within the search resource. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + x-ms-discriminator-value: integrated + onYourDataModelIdVectorizationSource: + required: + - model_id + description: |- + The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based + on a search service model ID. Currently only supported by Elasticsearch®. + allOf: + - $ref: "#/components/schemas/onYourDataVectorizationSource" + - properties: + model_id: + type: string + description: Specifies the model ID to use for vectorization. This model ID must be defined in the search service. + x-ms-discriminator-value: model_id + azureChatExtensionsMessageContext: + type: object + properties: + citations: + type: array + description: The data source retrieval result, used to generate the assistant message in the response. + items: + $ref: "#/components/schemas/citation" + x-ms-identifiers: [] + intent: + type: string + description: The detected intent from the chat history, used to pass to the next turn to carry over the context. + all_retrieved_documents: + type: array + description: All the retrieved documents. + items: + $ref: "#/components/schemas/retrievedDocument" + + description: |2- + A representation of the additional context information available when Azure OpenAI chat extensions are involved + in the generation of a corresponding chat completions response. This context information is only populated when + using an Azure OpenAI request configured to use a matching extension. + citation: + required: + - content + type: object + properties: + content: + type: string + description: The content of the citation. + title: + type: string + description: The title of the citation. + url: + type: string + description: The URL of the citation. + filepath: + type: string + description: The file path of the citation. + chunk_id: + type: string + description: The chunk ID of the citation. + rerank_score: + type: number + description: The rerank score of the retrieved document. + format: double + description: citation information for a chat completions response message. + retrievedDocument: + type: object + description: The retrieved document. + required: + - search_queries + - data_source_index + allOf: + - $ref: "#/components/schemas/citation" + - properties: + search_queries: + type: array + description: The search queries used to retrieve the document. + items: + type: string + data_source_index: + type: integer + description: The index of the data source. + format: int32 + original_search_score: + type: number + description: The original search score of the retrieved document. + format: double + filter_reason: + $ref: "#/components/schemas/filterReason" + description: Represents the rationale for filtering the document. If the document does not undergo filtering, this field will remain unset. + + filterReason: + type: string + description: The filtering reason of the retrieved document. + enum: + - score + - rerank + x-ms-enum: + name: FilterReason + modelAsString: true + values: + - name: score + value: score + description: The document is filtered by original search score threshold defined by `strictness` configure. + - name: rerank + value: rerank + description: The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure. + + chatCompletionMessageToolCall: + type: object + properties: + id: + type: string + description: The ID of the tool call. + type: + $ref: "#/components/schemas/toolCallType" + function: + type: object + description: The function that the model called. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + required: + - id + - type + - function + toolCallType: + type: string + enum: + - function + description: The type of the tool call, in this case `function`. + x-ms-enum: + name: ToolCallType + modelAsString: true + values: + - value: function + description: The tool call type is function. + chatCompletionRequestMessageTool: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + nullable: true + properties: + tool_call_id: + type: string + description: Tool call that this message is responding to. + content: + type: string + description: The contents of the message. + nullable: true + required: + - tool_call_id + - content + chatCompletionRequestMessageFunction: + allOf: + - $ref: "#/components/schemas/chatCompletionRequestMessage" + - type: object + description: Deprecated. Message that represents a function. + nullable: true + properties: + role: + type: string + enum: + - function + description: The role of the messages author, in this case `function`. + name: + type: string + description: The contents of the message. + content: + type: string + description: The contents of the message. + nullable: true + required: + - function_call_id + - content + createChatCompletionResponse: + type: object + description: Represents a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. + prompt_filter_results: + $ref: "#/components/schemas/promptFilterResults" + choices: + type: array + description: A list of chat completion choices. Can be more than one if `n` is greater than 1. + items: + type: object + required: + - finish_reason + - index + - message + - logprobs + properties: + finish_reason: + type: string + description: &chat_completion_finish_reason_description | + The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, + `length` if the maximum number of tokens specified in the request was reached, + `content_filter` if content was omitted due to a flag from our content filters, + `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + index: + type: integer + description: The index of the choice in the list of choices. + message: + $ref: "#/components/schemas/chatCompletionResponseMessage" + content_filter_results: + $ref: "#/components/schemas/contentFilterChoiceResults" + logprobs: &chat_completion_response_logprobs + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + - refusal + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. + model: + type: string + description: The model used for the chat completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion`. + enum: [chat.completion] + usage: + $ref: "#/components/schemas/completionUsage" + required: + - choices + - created + - id + - model + - object + + createChatCompletionStreamResponse: + type: object + description: Represents a streamed chunk of a chat completion response returned by model, based on the provided input. + properties: + id: + type: string + description: A unique identifier for the chat completion. Each chunk has the same ID. + choices: + type: array + description: | + A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. + items: + type: object + required: + - delta + - finish_reason + - index + properties: + delta: + $ref: "#/components/schemas/chatCompletionStreamResponseDelta" + logprobs: *chat_completion_response_logprobs + finish_reason: + type: string + description: *chat_completion_finish_reason_description + enum: + [ + "stop", + "length", + "tool_calls", + "content_filter", + "function_call", + ] + nullable: true + index: + type: integer + description: The index of the choice in the list of choices. + created: + type: integer + description: The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. + model: + type: string + description: The model to generate the completion. + system_fingerprint: + type: string + description: | + This fingerprint represents the backend configuration that the model runs with. + Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + object: + type: string + description: The object type, which is always `chat.completion.chunk`. + enum: [chat.completion.chunk] + required: + - prompt_tokens + - completion_tokens + - total_tokens + required: + - choices + - created + - id + - model + - object + + chatCompletionStreamResponseDelta: + type: object + description: A chat completion delta generated by streamed model responses. + properties: + content: + type: string + description: The contents of the chunk message. + nullable: true + function_call: + deprecated: true + type: object + description: "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model." + properties: + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + name: + type: string + description: The name of the function to call. + tool_calls: + type: array + items: + $ref: "#/components/schemas/chatCompletionMessageToolCallChunk" + role: + type: string + enum: ["system", "user", "assistant", "tool"] + description: The role of the author of this message. + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + + chatCompletionMessageToolCallChunk: + type: object + properties: + index: + type: integer + id: + type: string + description: The ID of the tool call. + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - index + + chatCompletionStreamOptions: + description: | + Options for streaming response. Only set this when you set `stream: true`. + type: object + nullable: true + default: null + properties: + include_usage: + type: boolean + description: | + If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. + + chatCompletionChoiceLogProbs: + description: Log probability information for the choice. + type: object + nullable: true + properties: + content: + description: A list of message content tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + refusal: + description: A list of message refusal tokens with log probability information. + type: array + items: + $ref: "#/components/schemas/chatCompletionTokenLogprob" + nullable: true + required: + - content + chatCompletionTokenLogprob: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + top_logprobs: + description: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned. + type: array + items: + type: object + properties: + token: + description: The token. + type: string + logprob: + description: The log probability of this token. + type: number + bytes: + description: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. + type: array + items: + type: integer + nullable: true + required: + - token + - logprob + - bytes + required: + - token + - logprob + - bytes + - top_logprobs + + chatCompletionResponseMessage: + type: object + description: A chat completion message generated by the model. + properties: + role: + $ref: "#/components/schemas/chatCompletionResponseMessageRole" + refusal: + type: string + description: The refusal message generated by the model. + nullable: true + content: + type: string + description: The contents of the message. + nullable: true + tool_calls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + function_call: + $ref: "#/components/schemas/chatCompletionFunctionCall" + context: + $ref: "#/components/schemas/azureChatExtensionsMessageContext" + required: + - role + - content + - refusal + chatCompletionResponseMessageRole: + type: string + enum: + - assistant + description: The role of the author of the response message. + chatCompletionToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + `none` is the default when no tools are present. `auto` is the default if tools are present. + oneOf: + - type: string + description: > + `none` means the model will not call any tool and instead generates a message. + `auto` means the model can pick between generating a message or calling one or more tools. + `required` means the model must call one or more tools. + enum: + - none + - auto + - required + - $ref: "#/components/schemas/chatCompletionNamedToolChoice" + chatCompletionNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific function. + properties: + type: + type: string + enum: + - "function" + description: The type of the tool. Currently, only `function` is supported. + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + - function + + ParallelToolCalls: + description: Whether to enable parallel function calling during tool use. + type: boolean + default: true + + chatCompletionMessageToolCalls: + type: array + description: The tool calls generated by the model, such as function calls. + items: + $ref: "#/components/schemas/chatCompletionMessageToolCall" + + chatCompletionFunctionCall: + type: object + description: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model. + properties: + name: + type: string + description: The name of the function to call. + arguments: + type: string + description: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function. + required: + - name + - arguments + completionUsage: + type: object + description: Usage statistics for the completion request. + properties: + prompt_tokens: + type: integer + description: Number of tokens in the prompt. + completion_tokens: + type: integer + description: Number of tokens in the generated completion. + total_tokens: + type: integer + description: Total number of tokens used in the request (prompt + completion). + completion_tokens_details: + type: object + description: Breakdown of tokens used in a completion. + properties: + reasoning_tokens: + type: integer + description: Tokens generated by the model for reasoning. + required: + - prompt_tokens + - completion_tokens + - total_tokens + chatCompletionTool: + type: object + properties: + type: + type: string + enum: ["function"] + description: The type of the tool. Currently, only `function` is supported. + function: + $ref: "#/components/schemas/FunctionObject" + required: + - type + - function + + FunctionParameters: + type: object + description: "The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." + additionalProperties: true + + FunctionObject: + type: object + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/FunctionParameters" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling). + required: + - name + + ResponseFormatText: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `text`" + enum: ["text"] + required: + - type + + ResponseFormatJsonObject: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_object`" + enum: ["json_object"] + required: + - type + + ResponseFormatJsonSchemaSchema: + type: object + description: "The schema for the response format, described as a JSON Schema object." + additionalProperties: true + + ResponseFormatJsonSchema: + type: object + properties: + type: + type: string + description: "The type of response format being defined: `json_schema`" + enum: ["json_schema"] + json_schema: + type: object + properties: + description: + type: string + description: A description of what the response format is for, used by the model to determine how to respond in the format. + name: + type: string + description: The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + schema: + $ref: "#/components/schemas/ResponseFormatJsonSchemaSchema" + strict: + type: boolean + nullable: true + default: false + description: Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. + required: + - type + - name + required: + - type + - json_schema + + chatCompletionChoiceCommon: + type: object + properties: + index: + type: integer + finish_reason: + type: string + createTranslationRequest: + type: object + description: Translation request. + properties: + file: + type: string + description: The audio file to translate. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + required: + - file + audioResponse: + description: Translation or transcription response when response_format was json + type: object + properties: + text: + type: string + description: Translated or transcribed text. + required: + - text + audioVerboseResponse: + description: Translation or transcription response when response_format was verbose_json + type: object + allOf: + - $ref: "#/components/schemas/audioResponse" + - properties: + task: + type: string + description: Type of audio task. + enum: + - transcribe + - translate + x-ms-enum: + modelAsString: true + language: + type: string + description: Language. + duration: + type: number + description: Duration. + segments: + type: array + items: + $ref: "#/components/schemas/audioSegment" + words: + type: array + items: + $ref: "#/components/schemas/audioWord" + + required: + - text + audioResponseFormat: + title: AudioResponseFormat + description: Defines the format of the output. + enum: + - json + - text + - srt + - verbose_json + - vtt + type: string + x-ms-enum: + modelAsString: true + createTranscriptionRequest: + type: object + description: Transcription request. + properties: + file: + type: string + description: The audio file object to transcribe. + format: binary + prompt: + type: string + description: An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language. + response_format: + $ref: "#/components/schemas/audioResponseFormat" + temperature: + type: number + default: 0 + description: The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit. + language: + type: string + description: The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency. + timestamp_granularities[]: + description: | + The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. + type: array + items: + type: string + enum: + - word + - segment + default: [segment] + required: + - file + audioSegment: + type: object + description: Transcription or translation segment. + properties: + id: + type: integer + description: Segment identifier. + seek: + type: number + description: Offset of the segment. + start: + type: number + description: Segment start offset. + end: + type: number + description: Segment end offset. + text: + type: string + description: Segment text. + tokens: + type: array + items: + type: number + nullable: false + description: Tokens of the text. + temperature: + type: number + description: Temperature. + avg_logprob: + type: number + description: Average log probability. + compression_ratio: + type: number + description: Compression ratio. + no_speech_prob: + type: number + description: Probability of 'no speech'. + audioWord: + type: object + description: Transcription or translation word. + properties: + word: + type: string + description: Word + start: + type: number + description: Word start offset. + end: + type: number + description: Word end offset. + createSpeechRequest: + type: object + description: Speech request. + properties: + input: + type: string + description: The text to synthesize audio for. The maximum length is 4096 characters. + maxLength: 4096 + voice: + type: string + description: The voice to use for speech synthesis. + enum: + - alloy + - echo + - fable + - onyx + - nova + - shimmer + response_format: + type: string + description: The format to synthesize the audio in. + enum: + - mp3 + - opus + - aac + - flac + - wav + - pcm + speed: + description: The speed of the synthesize audio. Select a value from `0.25` to `4.0`. `1.0` is the default. + type: number + default: 1 + minimum: 0.25 + maximum: 4 + required: + - input + - voice + imageQuality: + description: The quality of the image that will be generated. + type: string + enum: + - standard + - hd + default: standard + x-ms-enum: + name: Quality + modelAsString: true + values: + - value: standard + description: Standard quality creates images with standard quality. + name: Standard + - value: hd + description: HD quality creates images with finer details and greater consistency across the image. + name: HD + imagesResponseFormat: + description: The format in which the generated images are returned. + type: string + enum: + - url + - b64_json + default: url + x-ms-enum: + name: ImagesResponseFormat + modelAsString: true + values: + - value: url + description: The URL that provides temporary access to download the generated images. + name: Url + - value: b64_json + description: The generated images are returned as base64 encoded string. + name: Base64Json + imageSize: + description: The size of the generated images. + type: string + enum: + - 256x256 + - 512x512 + - 1792x1024 + - 1024x1792 + - 1024x1024 + default: 1024x1024 + x-ms-enum: + name: Size + modelAsString: true + values: + - value: 256x256 + description: The desired size of the generated image is 256x256 pixels. Only supported for dall-e-2. + name: Size256x256 + - value: 512x512 + description: The desired size of the generated image is 512x512 pixels. Only supported for dall-e-2. + name: Size512x512 + - value: 1792x1024 + description: The desired size of the generated image is 1792x1024 pixels. Only supported for dall-e-3. + name: Size1792x1024 + - value: 1024x1792 + description: The desired size of the generated image is 1024x1792 pixels. Only supported for dall-e-3. + name: Size1024x1792 + - value: 1024x1024 + description: The desired size of the generated image is 1024x1024 pixels. + name: Size1024x1024 + imageStyle: + description: The style of the generated images. + type: string + enum: + - vivid + - natural + default: vivid + x-ms-enum: + name: Style + modelAsString: true + values: + - value: vivid + description: Vivid creates images that are hyper-realistic and dramatic. + name: Vivid + - value: natural + description: Natural creates images that are more natural and less hyper-realistic. + name: Natural + imageGenerationsRequest: + type: object + properties: + prompt: + description: A text description of the desired image(s). The maximum length is 4000 characters. + type: string + format: string + example: a corgi in a field + minLength: 1 + "n": + description: The number of images to generate. + type: integer + minimum: 1 + maximum: 1 + default: 1 + size: + $ref: "#/components/schemas/imageSize" + response_format: + $ref: "#/components/schemas/imagesResponseFormat" + user: + description: A unique identifier representing your end-user, which can help to monitor and detect abuse. + type: string + format: string + example: user123456 + quality: + $ref: "#/components/schemas/imageQuality" + style: + $ref: "#/components/schemas/imageStyle" + required: + - prompt + generateImagesResponse: + type: object + properties: + created: + type: integer + format: unixtime + description: The unix timestamp when the operation was created. + example: "1676540381" + data: + type: array + description: The result data of the operation, if successful + items: + $ref: "#/components/schemas/imageResult" + required: + - created + - data + imageResult: + type: object + description: The image url or encoded image if successful, and an error otherwise. + properties: + url: + type: string + description: The image url. + example: https://www.contoso.com + b64_json: + type: string + description: The base64 encoded image + content_filter_results: + $ref: "#/components/schemas/dalleContentFilterResults" + revised_prompt: + type: string + description: The prompt that was used to generate the image, if there was any revision to the prompt. + prompt_filter_results: + $ref: "#/components/schemas/dalleFilterResults" + line: + type: object + description: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks. + properties: + text: + type: string + spans: + type: array + description: An array of spans that represent detected objects and its bounding box information. + items: + $ref: "#/components/schemas/span" + required: + - text + - spans + span: + type: object + description: A span object that represents a detected object and its bounding box information. + properties: + text: + type: string + description: The text content of the span that represents the detected object. + offset: + type: integer + description: The character offset within the text where the span begins. This offset is defined as the position of the first character of the span, counting from the start of the text as Unicode codepoints. + length: + type: integer + description: The length of the span in characters, measured in Unicode codepoints. + polygon: + type: array + description: An array of objects representing points in the polygon that encloses the detected object. + items: + type: object + properties: + x: + type: number + description: The x-coordinate of the point. + "y": + type: number + description: The y-coordinate of the point. + required: + - text + - offset + - length + - polygon + + runCompletionUsage: + type: object + description: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.). + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + runStepCompletionUsage: + type: object + description: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`. + properties: + completion_tokens: + type: integer + description: Number of completion tokens used over the course of the run step. + prompt_tokens: + type: integer + description: Number of prompt tokens used over the course of the run step. + total_tokens: + type: integer + description: Total number of tokens used (prompt + completion). + required: + - prompt_tokens + - completion_tokens + - total_tokens + nullable: true + + assistantsApiResponseFormatOption: + description: | + Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`. + + Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON. + + **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. + oneOf: + - type: string + description: > + `auto` is the default value + enum: [none, auto] + x-ms-enum: + name: AssistantsApiResponseFormatOption + modelAsString: true + values: + - value: none + - value: auto + - $ref: "#/components/schemas/assistantsApiResponseFormat" + + assistantsApiResponseFormat: + type: object + description: | + An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run. If `text` the model can return text or any value needed. + properties: + type: + type: string + enum: ["text", "json_object"] + x-ms-enum: + name: AssistantsApiResponseFormat + modelAsString: true + values: + - value: text + - value: json_object + example: "json_object" + default: "text" + description: Must be one of `text` or `json_object`. + + assistantObject: + type: object + title: Assistant + description: Represents an `assistant` that can call the model and use tools. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant`. + type: string + enum: + - assistant + x-ms-enum: + name: AssistantObjectType + modelAsString: true + values: + - value: assistant + created_at: + type: integer + description: The Unix timestamp (in seconds) for when the assistant was created. + name: + description: &assistant_name_param_description | + The name of the assistant. The maximum length is 256 characters. + type: string + maxLength: 256 + nullable: true + description: + description: &assistant_description_param_description | + The description of the assistant. The maximum length is 512 characters. + type: string + maxLength: 512 + nullable: true + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + type: string + instructions: + description: &assistant_instructions_param_description | + The system instructions that the assistant uses. The maximum length is 256,000 characters. + type: string + maxLength: 256000 + nullable: true + tools: + description: &assistant_tools_param_description | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: &metadata_description | + Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + type: object + nullable: true + temperature: + description: &run_temperature_description | + What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: &run_top_p_description | + An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. + + We generally recommend altering this or temperature but not both. + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - name + - description + - model + - instructions + - tools + - metadata + + createAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: *assistant_name_param_description + type: string + nullable: true + maxLength: 256 + description: + description: *assistant_description_param_description + type: string + nullable: true + maxLength: 512 + instructions: + description: *assistant_instructions_param_description + type: string + nullable: true + maxLength: 256000 + tools: + description: *assistant_tools_param_description + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - model + + modifyAssistantRequest: + type: object + additionalProperties: false + properties: + model: + description: | + ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. + anyOf: + - type: string + name: + description: | + The name of the assistant. The maximum length is 256 characters. + type: string + nullable: true + maxLength: 256 + description: + description: | + The description of the assistant. The maximum length is 512 characters. + type: string + nullable: true + maxLength: 512 + instructions: + description: | + The system instructions that the assistant uses. The maximum length is 32768 characters. + type: string + nullable: true + maxLength: 32768 + tools: + description: | + A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`. + default: [] + type: array + maxItems: 128 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + Overrides the list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + Overrides the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + description: *run_temperature_description + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + + deleteAssistantResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - assistant.deleted + x-ms-enum: + name: DeleteAssistantResponseState + modelAsString: true + values: + - value: assistant.deleted + required: + - id + - object + - deleted + + listAssistantsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/assistantObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + assistantToolsCode: + type: object + title: Code interpreter tool + properties: + type: + type: string + description: "The type of tool being defined: `code_interpreter`" + enum: + - code_interpreter + x-ms-enum: + name: assistantToolsCodeType + modelAsString: true + values: + - value: code_interpreter + required: + - type + + assistantToolsFileSearch: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: Overrides for the file search tool. + properties: + max_num_results: + type: integer + minimum: 1 + maximum: 50 + description: | + The maximum number of results the file search tool should output. The + default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number + should be between 1 and 50 inclusive. + + + Note that the file search tool may output fewer than `max_num_results` + results. See the [file search tool + documentation](/docs/assistants/tools/file-search/number-of-chunks-returned) + for more information. + required: + - type + + assistantToolsFileSearchTypeOnly: + type: object + title: FileSearch tool + properties: + type: + type: string + description: "The type of tool being defined: `file_search`" + enum: + - file_search + x-ms-enum: + name: assistantToolsFileSearchType + modelAsString: true + values: + - value: file_search + required: + - type + + assistantToolsFunction: + type: object + title: Function tool + properties: + type: + type: string + description: "The type of tool being defined: `function`" + enum: + - function + x-ms-enum: + name: assistantToolsFunction + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + description: + type: string + description: A description of what the function does, used by the model to choose when and how to call the function. + name: + type: string + description: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + parameters: + $ref: "#/components/schemas/chatCompletionFunctionParameters" + required: + - name + - parameters + - description + required: + - type + - function + + truncationObject: + type: object + title: Thread Truncation Controls + description: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run. + properties: + type: + type: string + description: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`. + enum: ["auto", "last_messages"] + x-ms-enum: + name: TruncationType + modelAsString: true + values: + - value: auto + - value: last_messages + last_messages: + type: integer + description: The number of most recent messages from the thread when constructing the context for the run. + minimum: 1 + nullable: true + required: + - type + + assistantsApiToolChoiceOption: + description: | + Controls which (if any) tool is called by the model. + `none` means the model will not call any tools and instead generates a message. + `auto` is the default value and means the model can pick between generating a message or calling a tool. + Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. + oneOf: + - type: string + description: > + `none` means the model will not call a function and instead generates a message. + `auto` means the model can pick between generating a message or calling a function. + enum: [none, auto] + x-ms-enum: + name: AssistantsApiToolChoiceOption + modelAsString: true + values: + - value: none + - value: auto + - $ref: "#/components/schemas/assistantsNamedToolChoice" + + assistantsNamedToolChoice: + type: object + description: Specifies a tool the model should use. Use to force the model to call a specific tool. + properties: + type: + type: string + enum: ["function", "code_interpreter", "file_search"] + description: The type of the tool. If type is `function`, the function name must be set + x-ms-enum: + name: AssistantsNamedToolChoiceType + modelAsString: true + values: + - value: function + - value: code_interpreter + - value: file_search + function: + type: object + properties: + name: + type: string + description: The name of the function to call. + required: + - name + required: + - type + + runObject: + type: object + title: A run on a thread + description: Represents an execution run on a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run`. + type: string + enum: + - thread.run + x-ms-enum: + name: runObjectType + modelAsString: true + values: + - value: thread.run + description: The run object type which is always thread.run + created_at: + description: The Unix timestamp (in seconds) for when the run was created. + type: integer + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run. + type: string + assistant_id: + description: The ID of the assistant used for execution of this run. + type: string + status: + description: The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - queued + - in_progress + - requires_action + - cancelling + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunObjectStatus + modelAsString: true + values: + - value: queued + description: The queued state + - value: in_progress + description: The in_progress state + - value: requires_action + description: The required_action state + - value: cancelling + description: The cancelling state + - value: cancelled + description: The cancelled state + - value: failed + description: The failed state + - value: completed + description: The completed state + - value: expired + description: The expired state + required_action: + type: object + description: Details on the action required to continue the run. Will be `null` if no action is required. + nullable: true + properties: + type: + description: For now, this is always `submit_tool_outputs`. + type: string + enum: + - submit_tool_outputs + submit_tool_outputs: + type: object + description: Details on the tool outputs needed for this run to continue. + properties: + tool_calls: + type: array + description: A list of the relevant tool calls. + items: + $ref: "#/components/schemas/runToolCallObject" + required: + - tool_calls + required: + - type + - submit_tool_outputs + last_error: + type: object + description: The last error associated with this run. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server failed to respond to request due to server error + - value: rate_limit_exceeded + description: The server failed to respond to request due to rate limit exceeded + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expires_at: + description: The Unix timestamp (in seconds) for when the run will expire. + type: integer + started_at: + description: The Unix timestamp (in seconds) for when the run was started. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run was completed. + type: integer + nullable: true + incomplete_details: + description: Details on why the run is incomplete. Will be `null` if the run is not incomplete. + type: object + nullable: true + properties: + reason: + description: The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run. + type: string + enum: ["max_completion_tokens", "max_prompt_tokens"] + x-ms-enum: + name: IncompleteDetailsReason + modelAsString: true + values: + - value: max_completion_tokens + - value: max_prompt_tokens + model: + description: The model that the assistant used for this run. + type: string + instructions: + description: The instructions that the assistant used for this run. + type: string + tools: + description: The list of tools that the assistant used for this run. + default: [] + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + usage: + $ref: "#/components/schemas/runCompletionUsage" + temperature: + description: The sampling temperature used for this run. If not set, defaults to 1. + type: number + nullable: true + top_p: + description: The nucleus sampling value used for this run. If not set, defaults to 1. + type: number + nullable: true + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens specified to have been used over the course of the run. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens specified to have been used over the course of the run. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - id + - object + - created_at + - thread_id + - assistant_id + - status + - required_action + - last_error + - expires_at + - started_at + - cancelled_at + - failed_at + - completed_at + - model + - instructions + - tools + - metadata + - usage + - incomplete_details + - max_prompt_tokens + - max_completion_tokens + - truncation_strategy + - tool_choice + - response_format + + createRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + model: + description: The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + additional_instructions: + description: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions. + type: string + nullable: true + additional_messages: + description: Adds additional messages to the thread before creating the run. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + listRunsResponse: + type: object + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runObject" + first_id: + type: string + example: run_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: run_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + modifyRunRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + + submitToolOutputsRunRequest: + type: object + additionalProperties: false + properties: + tool_outputs: + description: A list of tools for which the outputs are being submitted. + type: array + items: + type: object + properties: + tool_call_id: + type: string + description: The ID of the tool call in the `required_action` object within the run object the output is being submitted for. + output: + type: string + description: The output of the tool call to be submitted to continue the run. + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + required: + - tool_outputs + + runToolCallObject: + type: object + description: Tool call objects + properties: + id: + type: string + description: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint. + type: + type: string + description: The type of tool call the output is required for. For now, this is always `function`. + enum: + - function + x-ms-enum: + name: RunToolCallObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The function definition. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments that the model expects you to pass to the function. + required: + - name + - arguments + required: + - id + - type + - function + + createThreadAndRunRequest: + type: object + additionalProperties: false + properties: + assistant_id: + description: The ID of the assistant to use to execute this run. + type: string + thread: + $ref: "#/components/schemas/createThreadRequest" + description: If no thread is provided, an empty thread will be created. + model: + description: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used. + type: string + nullable: true + instructions: + description: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. + type: string + nullable: true + tools: + description: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. + nullable: true + type: array + maxItems: 20 + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearch" + - $ref: "#/components/schemas/assistantToolsFunction" + tool_resources: + type: object + description: | + A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + temperature: + type: number + minimum: 0 + maximum: 2 + default: 1 + example: 1 + nullable: true + description: *run_temperature_description + top_p: + type: number + minimum: 0 + maximum: 1 + default: 1 + example: 1 + nullable: true + description: *run_top_p_description + stream: + type: boolean + nullable: true + description: | + If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. + max_prompt_tokens: + type: integer + nullable: true + description: | + The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + max_completion_tokens: + type: integer + nullable: true + description: | + The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. + minimum: 256 + truncation_strategy: + $ref: "#/components/schemas/truncationObject" + nullable: true + tool_choice: + $ref: "#/components/schemas/assistantsApiToolChoiceOption" + nullable: true + response_format: + $ref: "#/components/schemas/assistantsApiResponseFormatOption" + nullable: true + required: + - thread_id + - assistant_id + + threadObject: + type: object + title: Thread + description: Represents a thread that contains [messages](/docs/api-reference/messages). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread`. + type: string + enum: + - thread + x-ms-enum: + name: ThreadObjectType + modelAsString: true + values: + - value: thread + description: The type of thread object which is always `thread` + created_at: + description: The Unix timestamp (in seconds) for when the thread was created. + type: integer + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - tool_resources + - metadata + + createThreadRequest: + type: object + additionalProperties: false + properties: + messages: + description: A list of messages to start the thread with. + type: array + items: + $ref: "#/components/schemas/createMessageRequest" + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + vector_stores: + type: array + description: | + A helper to create a vector store with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: object + properties: + file_ids: + type: array + description: | + A list of file IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. + maxItems: 10000 + items: + type: string + chunking_strategy: + # Ideally we'd reuse the chunking strategy schema here, but it doesn't expand properly + type: object + description: The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy. + oneOf: + - type: object + title: Auto Chunking Strategy + description: The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: ["auto"] + x-ms-enum: + name: AutoChunkingStrategyType + modelAsString: true + values: + - value: auto + required: + - type + - type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: ["static"] + x-ms-enum: + name: StaticChunkingStrategyType + modelAsString: true + values: + - value: static + static: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: The maximum number of tokens in each chunk. The default value is `800`. The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: | + The number of tokens that overlap between chunks. The default value is `400`. + + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + required: + - type + - static + metadata: + type: object + description: | + Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. + oneOf: + - required: [vector_store_ids] + - required: [vector_stores] + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + modifyThreadRequest: + type: object + additionalProperties: false + properties: + tool_resources: + type: object + description: | + A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. + properties: + code_interpreter: + type: object + properties: + file_ids: + type: array + description: | + A list of File IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool. + default: [] + maxItems: 20 + items: + type: string + file_search: + type: object + properties: + vector_store_ids: + type: array + description: | + The vector store attached to this thread. There can be a maximum of 1 vector store attached to the thread. + maxItems: 1 + items: + type: string + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + deleteThreadResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.deleted + x-ms-enum: + name: DeleteThreadResponseObjectState + modelAsString: true + values: + - value: thread.deleted + description: The delete thread response object state which is `thread.deleted` + required: + - id + - object + - deleted + + listThreadsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/threadObject" + first_id: + type: string + example: asst_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: asst_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageObject: + type: object + title: The message object + description: Represents a message within a [thread](/docs/api-reference/threads). + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message`. + type: string + enum: + - thread.message + x-ms-enum: + name: MessageObjectType + modelAsString: true + values: + - value: thread.message + description: The message object type which is `thread.message` + created_at: + description: The Unix timestamp (in seconds) for when the message was created. + type: integer + thread_id: + description: The [thread](/docs/api-reference/threads) ID that this message belongs to. + type: string + status: + description: The status of the message, which can be either `in_progress`, `incomplete`, or `completed`. + type: string + enum: ["in_progress", "incomplete", "completed"] + x-ms-enum: + name: MessageObjectStatus + modelAsString: true + values: + - value: in_progress + - value: incomplete + - value: completed + incomplete_details: + description: On an incomplete message, details about why the message is incomplete. + type: object + properties: + reason: + type: string + description: The reason the message is incomplete. + enum: + [ + "content_filter", + "max_tokens", + "run_cancelled", + "run_expired", + "run_failed", + ] + x-ms-enum: + name: MessageObjectIncompleteReason + modelAsString: true + values: + - value: content_filter + - value: max_tokens + - value: run_cancelled + - value: run_expired + - value: run_failed + nullable: true + required: + - reason + completed_at: + description: The Unix timestamp (in seconds) for when the message was completed. + type: integer + nullable: true + incomplete_at: + description: The Unix timestamp (in seconds) for when the message was marked as incomplete. + type: integer + nullable: true + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: + - user + - assistant + x-ms-enum: + name: MessageObjectRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentImageFileObject" + - $ref: "#/components/schemas/messageContentTextObject" + assistant_id: + description: If applicable, the ID of the assistant that authored this message. + type: string + nullable: true + run_id: + description: If applicable, the ID of the [run](/docs/api-reference/runs) associated with the authoring of this message. + type: string + nullable: true + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + description: A list of files attached to the message, and the tools they were added to. + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - thread_id + - status + - incomplete_details + - completed_at + - incomplete_at + - role + - content + - assistant_id + - run_id + - attachments + - metadata + + messageDeltaObject: + type: object + title: Message delta object + description: | + Represents a message delta i.e. any changed fields on a message during streaming. + properties: + id: + description: The identifier of the message, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.message.delta`. + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageDeltaObjectType + modelAsString: true + values: + - value: thread.message.delta + delta: + description: The delta containing the fields that have changed on the Message. + type: object + properties: + role: + description: The entity that produced the message. One of `user` or `assistant`. + type: string + enum: ["user", "assistant"] + x-ms-enum: + name: MessageDeltaObjectDeltaRole + modelAsString: true + values: + - value: user + - value: assistant + content: + description: The content of the message in array of text and/or images. + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentImageFileObject" + - $ref: "#/components/schemas/messageDeltaContentTextObject" + required: + - id + - object + - delta + + createMessageRequest: + type: object + additionalProperties: false + required: + - role + - content + properties: + role: + type: string + enum: + - user + - assistant + x-ms-enum: + name: CreateMessageRequestRole + modelAsString: true + values: + - value: user + - value: assistant + description: | + The role of the entity that is creating the message. Allowed values include: + - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. + - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. + content: + type: string + minLength: 1 + maxLength: 256000 + description: The content of the message. + attachments: + type: array + items: + type: object + properties: + file_id: + type: string + description: The ID of the file to attach to the message. + tools: + description: The tools to add this file to. + type: array + items: + oneOf: + - $ref: "#/components/schemas/assistantToolsCode" + - $ref: "#/components/schemas/assistantToolsFileSearchTypeOnly" + x-oaiExpandable: true + description: A list of files attached to the message, and the tools they should be added to. + required: + - file_id + - tools + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + modifyMessageRequest: + type: object + additionalProperties: false + properties: + metadata: + description: *metadata_description + type: object + nullable: true + deleteMessageResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: + - thread.message.deleted + x-ms-enum: + name: DeleteMessageResponseObject + modelAsString: true + values: + - value: thread.message.deleted + description: The delete message response object state + required: + - id + - object + - deleted + listMessagesResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/messageObject" + first_id: + type: string + example: msg_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: msg_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + messageContentImageFileObject: + title: Image file + type: object + description: References an image file in the content of a message. + properties: + type: + description: Always `image_file`. + type: string + enum: + - image_file + x-ms-enum: + name: MessageContentImageFileObjectType + modelAsString: true + values: + - value: image_file + description: The message content image file type + image_file: + type: object + properties: + file_id: + description: The file ID of the image in the message content. + type: string + required: + - file_id + required: + - type + - image_file + + messageContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + type: + description: Always `text`. + type: string + enum: + - text + x-ms-enum: + name: messageContentTextObjectType + modelAsString: true + values: + - value: text + description: The message content text Object type + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageContentTextAnnotationsFilePathObject" + required: + - value + - annotations + required: + - type + - text + + messageContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files. + properties: + type: + description: Always `file_citation`. + type: string + enum: + - file_citation + x-ms-enum: + name: FileCitationObjectType + modelAsString: true + values: + - value: file_citation + description: The file citation object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_citation + - start_index + - end_index + + messageContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + type: + description: Always `file_path`. + type: string + enum: + - file_path + x-ms-enum: + name: FilePathObjectType + modelAsString: true + values: + - value: file_path + description: The file path object type + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + required: + - file_id + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - type + - text + - file_path + - start_index + - end_index + + messageDeltaContentImageFileObject: + title: Image file + type: object + description: References an image File in the content of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `image_file`. + type: string + enum: ["image_file"] + x-ms-enum: + name: MessageDeltaContentImageFileObjectType + modelAsString: true + values: + - value: image_file + image_file: + type: object + properties: + file_id: + description: The File ID of the image in the message content. + type: string + required: + - index + - type + + messageDeltaContentTextObject: + title: Text + type: object + description: The text content that is part of a message. + properties: + index: + type: integer + description: The index of the content part in the message. + type: + description: Always `text`. + type: string + enum: ["text"] + x-ms-enum: + name: MessageDeltaContentTextObjectType + modelAsString: true + values: + - value: text + text: + type: object + properties: + value: + description: The data that makes up the text. + type: string + annotations: + type: array + items: + oneOf: + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFileCitationObject" + - $ref: "#/components/schemas/messageDeltaContentTextAnnotationsFilePathObject" + required: + - index + - type + + messageDeltaContentTextAnnotationsFileCitationObject: + title: File citation + type: object + description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_citation`. + type: string + enum: ["file_citation"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFileCitationObjectType + modelAsString: true + values: + - value: file_citation + text: + description: The text in the message content that needs to be replaced. + type: string + file_citation: + type: object + properties: + file_id: + description: The ID of the specific File the citation is from. + type: string + quote: + description: The specific quote in the file. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + messageDeltaContentTextAnnotationsFilePathObject: + title: File path + type: object + description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file. + properties: + index: + type: integer + description: The index of the annotation in the text content part. + type: + description: Always `file_path`. + type: string + enum: ["file_path"] + x-ms-enum: + name: MessageDeltaContentTextAnnotationsFilePathObjectType + modelAsString: true + values: + - value: file_path + text: + description: The text in the message content that needs to be replaced. + type: string + file_path: + type: object + properties: + file_id: + description: The ID of the file that was generated. + type: string + start_index: + type: integer + minimum: 0 + end_index: + type: integer + minimum: 0 + required: + - index + - type + + runStepObject: + type: object + title: Run steps + description: | + Represents a step in execution of a run. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `assistant.run.step``. + type: string + enum: + - assistant.run.step + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: assistant.run.step + description: The object type, which is always `assistant.run.step` + created_at: + description: The Unix timestamp (in seconds) for when the run step was created. + type: integer + assistant_id: + description: The ID of the assistant associated with the run step. + type: string + thread_id: + description: The ID of the [thread](/docs/api-reference/threads) that was run. + type: string + run_id: + description: The ID of the [run](/docs/api-reference/runs) that this run step is a part of. + type: string + type: + description: The type of run step, which can be either `message_creation` or `tool_calls`. + type: string + enum: + - message_creation + - tool_calls + x-ms-enum: + name: RunStepObjectType + modelAsString: true + values: + - value: message_creation + description: The message_creation run step + - value: tool_calls + description: The tool_calls run step + status: + description: The status of the run, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`. + type: string + enum: + - in_progress + - cancelled + - failed + - completed + - expired + x-ms-enum: + name: RunStepObjectStatus + modelAsString: true + values: + - value: in_progress + description: The in_progress run status + - value: cancelled + description: The cancelled run status + - value: failed + description: The cancelled run status + - value: completed + description: The cancelled run status + - value: expired + description: The cancelled run status + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsObject" + last_error: + type: object + description: The last error associated with this run step. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + - server_error + - rate_limit_exceeded + x-ms-enum: + name: LastErrorCode + modelAsString: true + values: + - value: server_error + description: The server_error + - value: rate_limit_exceeded + description: The rate_limit_exceeded status + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + expired_at: + description: The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired. + type: integer + nullable: true + cancelled_at: + description: The Unix timestamp (in seconds) for when the run step was cancelled. + type: integer + nullable: true + failed_at: + description: The Unix timestamp (in seconds) for when the run step failed. + type: integer + nullable: true + completed_at: + description: The Unix timestamp (in seconds) for when the run step completed. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - created_at + - assistant_id + - thread_id + - run_id + - type + - status + - step_details + - last_error + - expired_at + - cancelled_at + - failed_at + - completed_at + - metadata + + runStepDeltaObject: + type: object + title: Run step delta object + description: | + Represents a run step delta i.e. any changed fields on a run step during streaming. + properties: + id: + description: The identifier of the run step, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `thread.run.step.delta`. + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepDeltaObjectType + modelAsString: true + values: + - value: thread.run.step.delta + delta: + description: The delta containing the fields that have changed on the run step. + type: object + properties: + step_details: + type: object + description: The details of the run step. + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsMessageCreationObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsObject" + required: + - id + - object + - delta + + listRunStepsResponse: + properties: + object: + type: string + example: list + data: + type: array + items: + $ref: "#/components/schemas/runStepObject" + first_id: + type: string + example: step_hLBK7PXBv5Lr2NQT7KLY0ag1 + last_id: + type: string + example: step_QLoItBbqwyAJEzlTy4y9kOMM + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + runStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation``. + type: string + enum: + - message_creation + x-ms-enum: + name: RunStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - message_id + required: + - type + - message_creation + + runStepDeltaStepDetailsMessageCreationObject: + title: Message creation + type: object + description: Details of the message creation by the run step. + properties: + type: + description: Always `message_creation`. + type: string + enum: ["message_creation"] + x-ms-enum: + name: RunStepDeltaStepDetailsMessageCreationObjectType + modelAsString: true + values: + - value: message_creation + message_creation: + type: object + properties: + message_id: + type: string + description: The ID of the message that was created by this run step. + required: + - type + + runStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: + - tool_calls + x-ms-enum: + name: RunStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `retrieval` or `function`. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsFunctionObject" + required: + - type + - tool_calls + + runStepDeltaStepDetailsToolCallsObject: + title: Tool calls + type: object + description: Details of the tool call. + properties: + type: + description: Always `tool_calls`. + type: string + enum: ["tool_calls"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsObjectType + modelAsString: true + values: + - value: tool_calls + tool_calls: + type: array + description: | + An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search` or `function`. + items: + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFileSearchObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsFunctionObject" + required: + - type + + runStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: + - code_interpreter + x-ms-enum: + name: RunStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + required: + - input + - outputs + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject" + required: + - id + - type + - code_interpreter + + runStepDeltaStepDetailsToolCallsCodeObject: + title: Code interpreter tool call + type: object + description: Details of the Code Interpreter tool call the run step was involved in. + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call. + type: + type: string + description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call. + enum: ["code_interpreter"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeObjectType + modelAsString: true + values: + - value: code_interpreter + code_interpreter: + type: object + description: The Code Interpreter tool call definition. + properties: + input: + type: string + description: The input to the Code Interpreter tool call. + outputs: + type: array + description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type. + items: + type: object + oneOf: + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject" + - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject" + required: + - index + - type + + runStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + type: + description: Always `logs`. + type: string + enum: + - logs + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - type + - logs + + runStepDeltaStepDetailsToolCallsCodeOutputLogsObject: + title: Code interpreter log output + type: object + description: Text output from the Code Interpreter tool call as part of a run step. + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `logs`. + type: string + enum: ["logs"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType + modelAsString: true + values: + - value: logs + logs: + type: string + description: The text output from the Code Interpreter tool call. + required: + - index + - type + + runStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + type: + description: Always `image`. + type: string + enum: + - image + x-ms-enum: + name: RunStepDetailsToolCallsCodeOutputImageObjectType + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - file_id + required: + - type + - image + + runStepDeltaStepDetailsToolCallsCodeOutputImageObject: + title: Code interpreter image output + type: object + properties: + index: + type: integer + description: The index of the output in the outputs array. + type: + description: Always `image`. + type: string + enum: ["image"] + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject + modelAsString: true + values: + - value: image + image: + type: object + properties: + file_id: + description: The file ID of the image. + type: string + required: + - index + - type + + runStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `file_search` for this type of tool call. + enum: ["file_search"] + x-ms-enum: + name: RunStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + required: + - id + - type + - file_search + + runStepDeltaStepDetailsToolCallsFileSearchObject: + title: File search tool call + type: object + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `retrieval` for this type of tool call. + enum: + - file_search + x-ms-enum: + name: RunStepDeltaStepDetailsToolCallsFileSearchObjectType + modelAsString: true + values: + - value: file_search + file_search: + type: object + description: For now, this is always going to be an empty object. + required: + - index + - type + - file_search + + runStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: + - function + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet. + nullable: true + required: + - name + - arguments + - output + required: + - id + - type + - function + + runStepDeltaStepDetailsToolCallsFunctionObject: + type: object + title: Function tool call + properties: + index: + type: integer + description: The index of the tool call in the tool calls array. + id: + type: string + description: The ID of the tool call object. + type: + type: string + description: The type of tool call. This is always going to be `function` for this type of tool call. + enum: ["function"] + x-ms-enum: + name: RunStepDetailsToolCallsFunctionObjectType + modelAsString: true + values: + - value: function + function: + type: object + description: The definition of the function that was called. + properties: + name: + type: string + description: The name of the function. + arguments: + type: string + description: The arguments passed to the function. + output: + type: string + description: The output of the function. This will be `null` if the outputs have not been submitted yet. + nullable: true + required: + - index + - type + + vectorStoreExpirationAfter: + type: object + title: Vector store expiration policy + description: The expiration policy for a vector store. + properties: + anchor: + description: "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`." + type: string + enum: ["last_active_at"] + x-ms-enum: + name: VectorStoreExpirationAfterAnchor + modelAsString: true + values: + - value: last_active_at + description: The anchor timestamp after which the expiration policy applies. + days: + description: The number of days after the anchor time that the vector store will expire. + type: integer + minimum: 1 + maximum: 365 + required: + - anchor + - days + + vectorStoreObject: + type: object + title: Vector store + description: A vector store is a collection of processed files can be used by the `file_search` tool. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store`. + type: string + enum: ["vector_store"] + created_at: + description: The Unix timestamp (in seconds) for when the vector store was created. + type: integer + name: + description: The name of the vector store. + type: string + usage_bytes: + description: The total number of bytes used by the files in the vector store. + type: integer + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been successfully processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that were cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - failed + - cancelled + - total + status: + description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use. + type: string + enum: ["expired", "in_progress", "completed"] + x-ms-enum: + name: VectorStoreObjectStatus + modelAsString: true + values: + - value: expired + - value: in_progress + - value: completed + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + expires_at: + description: The Unix timestamp (in seconds) for when the vector store will expire. + type: integer + nullable: true + last_active_at: + description: The Unix timestamp (in seconds) for when the vector store was last active. + type: integer + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + required: + - id + - object + - usage_bytes + - created_at + - status + - last_active_at + - name + - bytes + - file_counts + - metadata + + createVectorStoreRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + maxItems: 500 + items: + type: string + name: + description: The name of the vector store. + type: string + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + chunking_strategy: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + metadata: + description: *metadata_description + type: object + nullable: true + + updateVectorStoreRequest: + type: object + additionalProperties: false + properties: + name: + description: The name of the vector store. + type: string + nullable: true + expires_after: + $ref: "#/components/schemas/vectorStoreExpirationAfter" + nullable: true + metadata: + description: *metadata_description + type: object + nullable: true + + listVectorStoresResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreObject" + first_id: + type: string + example: "vs_abc123" + last_id: + type: string + example: "vs_abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.deleted] + x-ms-enum: + name: DeleteVectorStoreResponseObject + modelAsString: true + values: + - value: vector_store.deleted + description: The delete vector store response object state + required: + - id + - object + - deleted + + vectorStoreFileObject: + type: object + title: Vector store files + description: A list of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file`. + type: string + enum: ["vector_store.file"] + x-ms-enum: + name: VectorStoreFileObjectType + modelAsString: true + values: + - value: vector_store.file + usage_bytes: + description: The total vector store usage in bytes. Note that this may be different from the original file size. + type: integer + created_at: + description: The Unix timestamp (in seconds) for when the vector store file was created. + type: integer + vector_store_id: + description: The ID of the vector store that the file is attached to. + type: string + status: + description: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + last_error: + type: object + description: The last error associated with this vector store file. Will be `null` if there are no errors. + nullable: true + properties: + code: + type: string + description: One of `server_error` or `rate_limit_exceeded`. + enum: + [ + "internal_error", + "file_not_found", + "parsing_error", + "unhandled_mime_type", + ] + x-ms-enum: + name: VectorStoreFileObjectLastErrorCode + modelAsString: true + values: + - value: internal_error + - value: file_not_found + - value: parsing_error + - value: unhandled_mime_type + message: + type: string + description: A human-readable description of the error. + required: + - code + - message + chunking_strategy: + type: object + description: | + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. Only applicable if `file_ids` is non-empty. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + required: + - id + - object + - usage_bytes + - created_at + - vector_store_id + - status + - last_error + + otherChunkingStrategyResponseParam: + type: object + title: Other Chunking Strategy + description: | + This is returned when the chunking strategy is unknown. Typically, this is + because the file was indexed before the `chunking_strategy` concept was + introduced in the API. + additionalProperties: false + properties: + type: + type: string + description: Always `other`. + enum: + - other + x-ms-enum: + name: OtherChunkingStrategyResponseParamType + modelAsString: true + values: + - value: other + required: + - type + + staticChunkingStrategyResponseParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + x-ms-enum: + name: StaticChunkingStrategyResponseParamType + modelAsString: true + values: + - value: static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + staticChunkingStrategy: + type: object + additionalProperties: false + properties: + max_chunk_size_tokens: + type: integer + minimum: 100 + maximum: 4096 + description: | + The maximum number of tokens in each chunk. The default value is `800`. + The minimum value is `100` and the maximum value is `4096`. + chunk_overlap_tokens: + type: integer + description: > + The number of tokens that overlap between chunks. The default value is + `400`. + Note that the overlap must not exceed half of `max_chunk_size_tokens`. + required: + - max_chunk_size_tokens + - chunk_overlap_tokens + + autoChunkingStrategyRequestParam: + type: object + title: Auto Chunking Strategy + description: | + The default strategy. This strategy currently uses a `max_chunk_size_tokens` + of `800` and `chunk_overlap_tokens` of `400`. + additionalProperties: false + properties: + type: + type: string + description: Always `auto`. + enum: + - auto + required: + - type + + staticChunkingStrategyRequestParam: + type: object + title: Static Chunking Strategy + additionalProperties: false + properties: + type: + type: string + description: Always `static`. + enum: + - static + static: + $ref: "#/components/schemas/staticChunkingStrategy" + required: + - type + - static + + chunkingStrategyRequestParam: + type: object + description: >- + The chunking strategy used to chunk the file(s). If not set, will use the + `auto` strategy. + oneOf: + - $ref: "#/components/schemas/autoChunkingStrategyRequestParam" + - $ref: "#/components/schemas/staticChunkingStrategyRequestParam" + + createVectorStoreFileRequest: + type: object + additionalProperties: false + properties: + file_id: + description: A File ID that the vector store should use. Useful for tools like `file_search` that can access files. + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_id + + listVectorStoreFilesResponse: + properties: + object: + type: string + example: "list" + data: + type: array + items: + $ref: "#/components/schemas/vectorStoreFileObject" + first_id: + type: string + example: "file-abc123" + last_id: + type: string + example: "file-abc456" + has_more: + type: boolean + example: false + required: + - object + - data + - first_id + - last_id + - has_more + + deleteVectorStoreFileResponse: + type: object + properties: + id: + type: string + deleted: + type: boolean + object: + type: string + enum: [vector_store.file.deleted] + x-ms-enum: + name: DeleteVectorStoreFileResponseObject + modelAsString: true + values: + - value: vector_store.file.deleted + required: + - id + - object + - deleted + + vectorStoreFileBatchObject: + type: object + title: Vector store file batch + description: A batch of files attached to a vector store. + properties: + id: + description: The identifier, which can be referenced in API endpoints. + type: string + object: + description: The object type, which is always `vector_store.file_batch`. + type: string + enum: ["vector_store.files_batch"] + x-ms-enum: + name: VectorStoreFileBatchObjectType + modelAsString: true + values: + - value: vector_store.files_batch + created_at: + description: The Unix timestamp (in seconds) for when the vector store files batch was created. + type: integer + vector_store_id: + description: The ID of the vector store that the File is attached to. + type: string + status: + description: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`. + type: string + enum: ["in_progress", "completed", "cancelled", "failed"] + x-ms-enum: + name: VectorStoreFileBatchObjectStatus + modelAsString: true + values: + - value: in_progress + - value: completed + - value: cancelled + - value: failed + file_counts: + type: object + properties: + in_progress: + description: The number of files that are currently being processed. + type: integer + completed: + description: The number of files that have been processed. + type: integer + failed: + description: The number of files that have failed to process. + type: integer + cancelled: + description: The number of files that where cancelled. + type: integer + total: + description: The total number of files. + type: integer + required: + - in_progress + - completed + - cancelled + - failed + - total + required: + - id + - object + - created_at + - vector_store_id + - status + - file_counts + + createVectorStoreFileBatchRequest: + type: object + additionalProperties: false + properties: + file_ids: + description: A list of File IDs that the vector store should use. Useful for tools like `file_search` that can access files. + type: array + minItems: 1 + maxItems: 500 + items: + type: string + chunking_strategy: + $ref: "#/components/schemas/chunkingStrategyRequestParam" + required: + - file_ids + + assistantStreamEvent: + description: | + Represents an event emitted when streaming a Run. + + Each event in a server-sent events stream has an `event` and `data` property: + + ``` + event: thread.created + data: {"id": "thread_123", "object": "thread", ...} + ``` + + We emit events whenever a new object is created, transitions to a new state, or is being + streamed in parts (deltas). For example, we emit `thread.run.created` when a new run + is created, `thread.run.completed` when a run completes, and so on. When an Assistant chooses + to create a message during a run, we emit a `thread.message.created event`, a + `thread.message.in_progress` event, many `thread.message.delta` events, and finally a + `thread.message.completed` event. + + We may add additional events over time, so we recommend handling unknown events gracefully + in your code. See the [Assistants API quickstart](/docs/assistants/overview) to learn how to + integrate the Assistants API with streaming. + oneOf: + - $ref: "#/components/schemas/threadStreamEvent" + - $ref: "#/components/schemas/runStreamEvent" + - $ref: "#/components/schemas/runStepStreamEvent" + - $ref: "#/components/schemas/messageStreamEvent" + - $ref: "#/components/schemas/errorEvent" + - $ref: "#/components/schemas/doneEvent" + + threadStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.created"] + x-ms-enum: + name: ThreadStreamEventEnum + modelAsString: true + values: + - value: thread.created + description: The thread created event + data: + $ref: "#/components/schemas/threadObject" + required: + - event + - data + description: Occurs when a new thread is created. + + runStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.created"] + x-ms-enum: + name: RunStreamEventCreated + modelAsString: true + values: + - value: thread.run.created + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a new run is created. + - type: object + properties: + event: + type: string + enum: ["thread.run.queued"] + x-ms-enum: + name: RunStreamEventQueued + modelAsString: true + values: + - value: thread.run.queued + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `queued` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.in_progress"] + x-ms-enum: + name: RunStreamEventInProgress + modelAsString: true + values: + - value: thread.run.in_progress + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to an `in_progress` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.requires_action"] + x-ms-enum: + name: RunStreamEventRequiresAction + modelAsString: true + values: + - value: thread.run.requires_action + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `requires_action` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.completed"] + x-ms-enum: + name: RunStreamEventCompleted + modelAsString: true + values: + - value: thread.run.completed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.failed"] + x-ms-enum: + name: RunStreamEventFailed + modelAsString: true + values: + - value: thread.run.failed + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelling"] + x-ms-enum: + name: RunStreamEventCancelling + modelAsString: true + values: + - value: thread.run.cancelling + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run moves to a `cancelling` status. + - type: object + properties: + event: + type: string + enum: ["thread.run.cancelled"] + x-ms-enum: + name: RunStreamEventCancelled + modelAsString: true + values: + - value: thread.run.cancelled + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.expired"] + x-ms-enum: + name: RunStreamEventExpired + modelAsString: true + values: + - value: thread.run.expired + data: + $ref: "#/components/schemas/runObject" + required: + - event + - data + description: Occurs when a run expires. + + runStepStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.run.step.created"] + x-ms-enum: + name: RunStepStreamEventCreated + modelAsString: true + values: + - value: thread.run.step.created + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is created. + + - type: object + properties: + event: + type: string + enum: ["thread.run.step.in_progress"] + x-ms-enum: + name: RunStepStreamEventInProgress + modelAsString: true + values: + - value: thread.run.step.in_progress + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.delta"] + x-ms-enum: + name: RunStepStreamEventDelta + modelAsString: true + values: + - value: thread.run.step.delta + data: + $ref: "#/components/schemas/runStepDeltaObject" + required: + - event + - data + description: Occurs when parts of a run step are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.completed"] + x-ms-enum: + name: RunStepStreamEventCompleted + modelAsString: true + values: + - value: thread.run.step.completed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is completed. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.failed"] + x-ms-enum: + name: RunStepStreamEventFailed + modelAsString: true + values: + - value: thread.run.step.failed + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step fails. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.cancelled"] + x-ms-enum: + name: RunStepStreamEventCancelled + modelAsString: true + values: + - value: thread.run.step.cancelled + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step is cancelled. + - type: object + properties: + event: + type: string + enum: ["thread.run.step.expired"] + x-ms-enum: + name: RunStepStreamEventExpired + modelAsString: true + values: + - value: thread.run.step.expired + data: + $ref: "#/components/schemas/runStepObject" + required: + - event + - data + description: Occurs when a run step expires. + + messageStreamEvent: + oneOf: + - type: object + properties: + event: + type: string + enum: ["thread.message.created"] + x-ms-enum: + name: MessageStreamEventCreated + modelAsString: true + values: + - value: thread.message.created + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is created. + - type: object + properties: + event: + type: string + enum: ["thread.message.in_progress"] + x-ms-enum: + name: MessageStreamEventInProgress + modelAsString: true + values: + - value: thread.message.in_progress + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message moves to an `in_progress` state. + - type: object + properties: + event: + type: string + enum: ["thread.message.delta"] + x-ms-enum: + name: MessageStreamEventDelta + modelAsString: true + values: + - value: thread.message.delta + data: + $ref: "#/components/schemas/messageDeltaObject" + required: + - event + - data + description: Occurs when parts of a message are being streamed. + - type: object + properties: + event: + type: string + enum: ["thread.message.completed"] + x-ms-enum: + name: MessageStreamEventCompleted + modelAsString: true + values: + - value: thread.message.completed + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message is completed. + - type: object + properties: + event: + type: string + enum: ["thread.message.incomplete"] + x-ms-enum: + name: MessageStreamEventIncomplete + modelAsString: true + values: + - value: thread.message.incomplete + data: + $ref: "#/components/schemas/messageObject" + required: + - event + - data + description: Occurs when a message ends before it is completed. + + errorEvent: + type: object + properties: + event: + type: string + enum: ["error"] + x-ms-enum: + name: ErrorEventEnum + modelAsString: true + values: + - value: error + data: + $ref: "#/components/schemas/error" + required: + - event + - data + description: Occurs when an error occurs. This can happen due to an internal server error or a timeout. + + doneEvent: + type: object + properties: + event: + type: string + enum: ["done"] + x-ms-enum: + name: DoneEventEnum + modelAsString: true + values: + - value: done + data: + type: string + enum: ["[DONE]"] + x-ms-enum: + name: DoneEventDataEnum + modelAsString: true + values: + - value: "[DONE]" + required: + - event + - data + description: Occurs when a stream ends. + securitySchemes: + bearer: + type: oauth2 + flows: + implicit: + authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize + scopes: {} + x-tokenInfoFunc: api.middleware.auth.bearer_auth + x-scopeValidateFunc: api.middleware.auth.validate_scopes + apiKey: + type: apiKey + name: api-key + in: header diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md index 340fdd0967f3..9f30703c02fe 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/readme.md @@ -252,3 +252,18 @@ These settings apply only when `--tag=release_2024_07_01_preview_autogen` is spe ``` yaml $(tag) == 'release_2024_07_01_preview_autogen' input-file: preview/2024-07-01-preview/generated.json ``` + +## AzureOpenAI 2024-08-01-preview +These settings apply only when `--tag=release_2024_08_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_08_01_preview' +input-file: preview/2024-08-01-preview/inference.json +``` + + +## AzureOpenAI 2024-09-01-preview +These settings apply only when `--tag=release_2024_09_01_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2024_09_01_preview' +input-file: preview/2024-09-01-preview/inference.json +``` From 987a8f38ab2a8359d085e149be042267a9ecc66f Mon Sep 17 00:00:00 2001 From: amruthashree18 <110563260+amruthashree18@users.noreply.github.com> Date: Wed, 2 Oct 2024 15:06:37 -0500 Subject: [PATCH 032/101] =?UTF-8?q?Updating=20the=20API=20specification=20?= =?UTF-8?q?for=20confidential=20ledger=20for=20custom=20endpoints=20an?= =?UTF-8?q?=E2=80=A6=20(#30290)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updating the API spec for confidential ledger for custom endpoints and custom roles change * Updating endpoint name and few minor changes * Updating API version and some minor spec updates * Fixing validation errors * Fixing swagger validation errors * Updating JSON reference * Fixing schema validation issues * Fixing minor issue * Fixing schema validation errors * Fixing schema validation errors * Fixing validation errors * Fixing validation errors * Fixinf validation errors * Fixing errors * Fixinf schema * Updating user role schema * Updating role name and action schema * Updating schema * Fixing schema validation * Updating API parameters * Fixinf schema errors * Updating properties * Updating definition * Updating paramter names * Fixinf schema errors * Fixing schema validation * Fixing schematic errors * Fixing minor issue * Fixing errors * Fixing property errors * Validation errors fixing * Fixing schema definition errors * Fixing validation errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Fixing type errors * Addressing PR review comments * Updating query body for patch runtime options * Updating Assignedroles * Addressing review comments from https://github.com/Azure/azure-rest-api-specs/issues/30481 * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing schema * Fixing stable version differences * Fixing schema * Fixing additional properties of metadata * Fixing additional properties of Metadata * Adding new endpoint to return multiple user roles * Updating schema * Updating schema * Updating app/users endpoint * Updating schema * Adding new endpoint for user Id lookup for app/users endpoint * Updating schema * Updating API version and schema * Updating user roles definition * Updating user details parameter * Updating user parameter * Updating Addressing review comments * Updated module parameter * Updating get response for modules endpoint * Updating response body in examples * Updating new endpoint names * Updating filenames * Updating example * Updating role name parameter * Fixing the lint errors * Reverting * Addressing some of review comments --- .npmrc | 2 +- .../preview/2024-08-22-preview/common.json | 47 + .../confidentialledger.json | 1863 +++++++++++++++++ .../examples/identity/GetLedgerIdentity.json | 14 + .../examples/ledger/CreateLedgerEntry.json | 19 + .../ledger/CreateOrUpdateLedgerUsers.json | 24 + .../examples/ledger/CreateOrUpdateUser.json | 18 + .../ledger/CreateUserDefinedEndpoint.json | 29 + .../examples/ledger/DeleteUser.json | 10 + .../ledger/DeleteUserDefinedRole.json | 11 + .../examples/ledger/GetConstitution.json | 14 + .../ledger/GetCurrentLedgerEntry.json | 15 + .../examples/ledger/GetEnclaveQuotes.json | 27 + .../examples/ledger/GetLedgerEntry.json | 19 + .../examples/ledger/GetLedgerUsers.json | 18 + .../examples/ledger/GetReceipt.json | 50 + .../examples/ledger/GetRuntimeOptions.json | 18 + .../examples/ledger/GetTransactionStatus.json | 15 + .../examples/ledger/GetUser.json | 15 + .../ledger/GetUserDefinedEndpoint.json | 28 + .../ledger/GetUserDefinedEndpointsModule.json | 15 + .../examples/ledger/GetUserDefinedRole.json | 17 + .../examples/ledger/ListCollections.json | 21 + .../ledger/ListConsortiumMembers.json | 19 + .../examples/ledger/ListLedgerEntries.json | 23 + .../examples/ledger/ListLedgerUsers.json | 35 + .../examples/ledger/ListUsers.json | 27 + .../examples/ledger/PatchRuntimeOptions.json | 22 + .../examples/ledger/PatchUserDefinedRole.json | 16 + .../examples/ledger/PutUserDefinedRole.json | 16 + .../2024-08-22-preview/identityservice.json | 90 + .../confidentialledger/data-plane/readme.md | 23 +- 32 files changed, 2577 insertions(+), 3 deletions(-) create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json create mode 100644 specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json diff --git a/.npmrc b/.npmrc index b6f27f135954..4fd021952d5a 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -engine-strict=true +engine-strict=true \ No newline at end of file diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json new file mode 100644 index 000000000000..faeb586d4b36 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/common.json @@ -0,0 +1,47 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerClient", + "description": "The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service." + }, + "paths": {}, + "definitions": { + "ConfidentialLedgerError": { + "description": "An error response from Confidential Ledger.", + "properties": { + "error": { + "readOnly": true, + "$ref": "#/definitions/ConfidentialLedgerErrorBody" + } + }, + "type": "object" + }, + "ConfidentialLedgerErrorBody": { + "description": "An error response from Confidential Ledger.", + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "The error code." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The error message." + } + }, + "x-nullable": true, + "type": "object" + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json new file mode 100644 index 000000000000..590149878f02 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json @@ -0,0 +1,1863 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerClient", + "description": "The ConfidentialLedgerClient writes and retrieves ledger entries against the Confidential Ledger service." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "endpoint", + "description": "The Confidential Ledger URL, for example https://contoso.confidentialledger.azure.com", + "required": true, + "type": "string", + "in": "path", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/app/governance/constitution": { + "get": { + "operationId": "GetConstitution", + "x-ms-examples": { + "GetConstitution": { + "$ref": "./examples/ledger/GetConstitution.json" + } + }, + "summary": "Gets the constitution used for governance.", + "description": "The constitution is a script that assesses and applies proposals from consortium members.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The constitution.", + "schema": { + "$ref": "#/definitions/Constitution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/governance/members": { + "get": { + "operationId": "ListConsortiumMembers", + "x-ms-examples": { + "ListConsortiumMembers": { + "$ref": "./examples/ledger/ListConsortiumMembers.json" + } + }, + "x-ms-pageable": { + "itemName": "members", + "nextLinkName": "nextLink" + }, + "summary": "Lists the consortium members.", + "description": "Consortium members can manage the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of consortium members.", + "schema": { + "$ref": "#/definitions/Consortium" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/enclaveQuotes": { + "get": { + "operationId": "GetEnclaveQuotes", + "x-ms-examples": { + "GetEnclaveQuotes": { + "$ref": "./examples/ledger/GetEnclaveQuotes.json" + } + }, + "summary": "Gets quotes for all nodes of the Confidential Ledger.", + "description": "A quote is an SGX enclave measurement that can be used to verify the validity of a node and its enclave.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Response containing enclave quotes.", + "schema": { + "$ref": "#/definitions/ConfidentialLedgerEnclaves" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/collections": { + "get": { + "operationId": "ListCollections", + "x-ms-examples": { + "GetCollectionIds": { + "$ref": "./examples/ledger/ListCollections.json" + } + }, + "x-ms-pageable": { + "itemName": "collections", + "nextLinkName": "nextLink" + }, + "summary": "Retrieves a list of collection ids present in the Confidential Ledger", + "description": "Collection ids are user-created collections of ledger entries", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of collections", + "schema": { + "$ref": "#/definitions/PagedCollections" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions": { + "get": { + "operationId": "ListLedgerEntries", + "x-ms-examples": { + "ListLedgerEntries": { + "$ref": "./examples/ledger/ListLedgerEntries.json" + } + }, + "x-ms-pageable": { + "itemName": "entries", + "nextLinkName": "nextLink" + }, + "summary": "Gets ledger entries from a collection corresponding to a range.", + "description": "A collection id may optionally be specified. Only entries in the specified (or default) collection will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/TransactionIdFromParameter" + }, + { + "$ref": "#/parameters/TransactionIdToParameter" + } + ], + "responses": { + "200": { + "description": "Ledger entries in the specified range.", + "schema": { + "$ref": "#/definitions/PagedLedgerEntries" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "post": { + "operationId": "CreateLedgerEntry", + "x-ms-examples": { + "CreateLedgerEntry": { + "$ref": "./examples/ledger/CreateLedgerEntry.json" + } + }, + "summary": "Writes a ledger entry.", + "description": "A collection id may optionally be specified.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "in": "body", + "name": "entry", + "description": "Ledger entry.", + "required": true, + "schema": { + "$ref": "#/definitions/LedgerEntry" + } + } + ], + "responses": { + "200": { + "description": "Returns the transaction id at which the write will be durably stored.", + "headers": { + "x-ms-ccf-transaction-id": { + "type": "string", + "description": "The transaction id at which this write will become durable." + } + }, + "schema": { + "$ref": "#/definitions/LedgerWriteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}": { + "get": { + "operationId": "GetLedgerEntry", + "x-ms-examples": { + "GetLedgerEntry": { + "$ref": "./examples/ledger/GetLedgerEntry.json" + } + }, + "summary": "Gets the ledger entry at the specified transaction id. A collection id may optionally be specified to indicate the collection from which to fetch the value.", + "description": "To return older ledger entries, the relevant sections of the ledger must be read from disk and validated. To prevent blocking within the enclave, the response will indicate whether the entry is ready and part of the response, or if the loading is still ongoing.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of querying the Confidential Ledger.", + "schema": { + "$ref": "#/definitions/LedgerQueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}/receipt": { + "get": { + "operationId": "GetReceipt", + "x-ms-examples": { + "GetReceipt": { + "$ref": "./examples/ledger/GetReceipt.json" + } + }, + "summary": "Gets a receipt certifying ledger contents at a particular transaction id.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The receipt for the write occurring at the transaction id.", + "schema": { + "$ref": "#/definitions/TransactionReceipt" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/{transactionId}/status": { + "get": { + "operationId": "GetTransactionStatus", + "x-ms-examples": { + "GetTransactionStatus": { + "$ref": "./examples/ledger/GetTransactionStatus.json" + } + }, + "summary": "Gets the status of an entry identified by a transaction id.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TransactionIdParameter" + } + ], + "responses": { + "200": { + "description": "The status of the entry recorded at the specified transaction id.", + "schema": { + "$ref": "#/definitions/TransactionStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/transactions/current": { + "get": { + "operationId": "GetCurrentLedgerEntry", + "x-ms-examples": { + "GetCurrentLedgerEntry": { + "$ref": "./examples/ledger/GetCurrentLedgerEntry.json" + } + }, + "summary": "Gets the current value available in the ledger.", + "description": "A collection id may optionally be specified.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/CollectionIdParameter" + } + ], + "responses": { + "200": { + "description": "The current ledger entry available on the receiving node. Non-primary nodes may return older values.", + "schema": { + "$ref": "#/definitions/LedgerEntry" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/users": { + "get": { + "operationId": "ListUsers", + "x-ms-examples": { + "ListUserEntries": { + "$ref": "./examples/ledger/ListUsers.json" + } + }, + "x-ms-pageable": { + "itemName": "ledgerUsers", + "nextLinkName": "nextLink" + }, + "summary": "Gets details on a list of users.", + "description": "All users' object IDs and single role per user will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Users in the paged specified range.", + "schema": { + "$ref": "#/definitions/PagedUsers" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/ledgerUsers": { + "get": { + "operationId": "ListLedgerUsers", + "x-ms-examples": { + "ListLedgerUsersEntries": { + "$ref": "./examples/ledger/ListLedgerUsers.json" + } + }, + "x-ms-pageable": { + "itemName": "ledgerUsers", + "nextLinkName": "nextLink" + }, + "summary": "Gets details on a list of users.", + "description": "All users' object IDs and multiple roles will be returned.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Users in the paged specified range.", + "schema": { + "$ref": "#/definitions/PagedLedgerUsers" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/users/{userId}": { + "delete": { + "operationId": "DeleteUser", + "x-ms-examples": { + "DeleteUser": { + "$ref": "./examples/ledger/DeleteUser.json" + } + }, + "summary": "Deletes a user from the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "204": { + "description": "The specified user is deleted." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "get": { + "operationId": "GetUser", + "x-ms-examples": { + "GetUser": { + "$ref": "./examples/ledger/GetUser.json" + } + }, + "summary": "Gets a user.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "Details about the specified user.", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "CreateOrUpdateUser", + "x-ms-examples": { + "CreateOrUpdateUser": { + "$ref": "./examples/ledger/CreateOrUpdateUser.json" + } + }, + "summary": "Adds a user or updates a user's fields.", + "description": "A JSON merge patch is applied for existing users", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/UserDetailsParameter" + } + ], + "responses": { + "200": { + "description": "User created or updated successfully.", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/ledgerUsers/{userId}": { + "delete": { + "operationId": "DeleteLedgerUsers", + "x-ms-examples": { + "DeleteUser": { + "$ref": "./examples/ledger/DeleteUser.json" + } + }, + "summary": "Deletes a user with multiple roles from the Confidential Ledger.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "204": { + "description": "The specified user is deleted." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "get": { + "operationId": "GetLedgerUsers", + "x-ms-examples": { + "GetLedgerUsers": { + "$ref": "./examples/ledger/GetLedgerUsers.json" + } + }, + "summary": "Gets a user with multiple roles.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + } + ], + "responses": { + "200": { + "description": "Details about the specified user.", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "CreateOrUpdateLedgerUsers", + "x-ms-examples": { + "CreateOrUpdateLedgerUsers": { + "$ref": "./examples/ledger/CreateOrUpdateLedgerUsers.json" + } + }, + "summary": "Adds a user or updates a user's fields.", + "description": "A JSON merge patch is applied for existing users", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserIdParameter" + }, + { + "$ref": "#/parameters/UserMultipleRolesParameter" + } + ], + "responses": { + "200": { + "description": "User created or updated successfully.", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints": { + "get": { + "operationId": "GetUserDefinedEndpoint", + "x-ms-examples": { + "GetUserDefinedEndpoint": { + "$ref": "./examples/ledger/GetUserDefinedEndpoint.json" + } + }, + "summary": "Gets a user defined endpoint.", + "description": "Returns the user defined endpoint in the ACL instance", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Gets the user defined endpoints.", + "schema": { + "$ref": "#/definitions/Bundle" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "put": { + "operationId": "CreateUserDefinedEndpoint", + "x-ms-examples": { + "CreateUserDefinedEndpoint": { + "$ref": "./examples/ledger/CreateUserDefinedEndpoint.json" + } + }, + "summary": "Creates a user defined endpoint.", + "description": "Creates the user defined endpoint in the ACL instance ", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/BundleParameter" + } + ], + "responses": { + "201": { + "description": "The user defined endpoint is created." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints/runTimeOptions": { + "get": { + "operationId": "GetRuntimeOptions", + "x-ms-examples": { + "GetRuntimeOptions": { + "$ref": "./examples/ledger/GetRuntimeOptions.json" + } + }, + "summary": "Runtime options for user defined endpoints.", + "description": "It returns the runtime options", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": " Runtime options for user defined endpoints.", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "PatchRuntimeOptions", + "x-ms-examples": { + "PatchRuntimeOptions": { + "$ref": "./examples/ledger/PatchRuntimeOptions.json" + } + }, + "summary": "Runtime options for user defined endpoints.", + "description": "Updates the runtime options.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JSRuntimeOptionsParameter" + } + ], + "responses": { + "200": { + "description": " Runtime options for user defined endpoints.", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/userDefinedEndpoints/modules": { + "get": { + "operationId": "GetUserDefinedEndpointsModule", + "x-ms-examples": { + "GetUserDefinedEndpointsModule": { + "$ref": "./examples/ledger/GetUserDefinedEndpointsModule.json" + } + }, + "summary": "Module for user defined endpoints.", + "description": "It gets the module for the user defined endpoint.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ModuleNameParameter" + } + ], + "responses": { + "200": { + "description": "Module for user defined endpoints.", + "schema": { + "$ref": "#/definitions/ModuleDef" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + }, + "/app/roles": { + "get": { + "operationId": "GetUserDefinedRole", + "x-ms-examples": { + "GetUserDefinedRole": { + "$ref": "./examples/ledger/GetUserDefinedRole.json" + } + }, + "summary": "Gets role actions for user defined roles", + "description": "user defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleNameParameter" + } + ], + "responses": { + "200": { + "description": "Gets role actions for user defined roles", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "put": { + "operationId": "PutUserDefinedRole", + "x-ms-examples": { + "PutUserDefinedRole": { + "$ref": "./examples/ledger/PutUserDefinedRole.json" + } + }, + "summary": "Creates new roles and their actions", + "description": "User defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleParameter" + } + ], + "responses": { + "200": { + "description": "Successfully added the roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "patch": { + "operationId": "PatchUserDefinedRole", + "x-ms-examples": { + "PatchUserDefinedRole": { + "$ref": "./examples/ledger/PatchUserDefinedRole.json" + } + }, + "summary": "Patch replaces the allowed action on existing roles", + "description": "User defined roles allow users to define and manage app specific AuthZ policy.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleParameter" + } + ], + "responses": { + "200": { + "description": "Successfully patched the roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + }, + "delete": { + "operationId": "DeleteUserDefinedRole", + "x-ms-examples": { + "DeleteUserDefinedRole": { + "$ref": "./examples/ledger/DeleteUserDefinedRole.json" + } + }, + "summary": "Deletes user defined roles", + "description": "A user defined role allows the users to create and manage their own role actions using the API.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RoleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user roles." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + } + }, + "definitions": { + "ApplicationClaims": { + "description": "List of application claims.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationClaim" + } + }, + "ApplicationClaim": { + "description": "A claim of a ledger application.", + "required": [ + "kind" + ], + "properties": { + "digest": { + "$ref": "#/definitions/ClaimDigest" + }, + "kind": { + "$ref": "#/definitions/ApplicationClaimKind" + }, + "ledgerEntry": { + "$ref": "#/definitions/LedgerEntryClaim" + } + }, + "type": "object" + }, + "ApplicationClaimKind": { + "type": "string", + "description": "Represents the kind of an application claim.", + "enum": [ + "LedgerEntry", + "ClaimDigest" + ], + "x-ms-enum": { + "name": "ApplicationClaimKind", + "modelAsString": true + } + }, + "ApplicationClaimProtocol": { + "type": "string", + "description": "Represents the protocol to be used to compute the digest of a claim from the given claim data.", + "enum": [ + "LedgerEntryV1" + ], + "x-ms-enum": { + "name": "ApplicationClaimProtocol", + "modelAsString": true + } + }, + "ClaimDigest": { + "description": "An application claim in digested form.", + "required": [ + "protocol" + ], + "properties": { + "value": { + "type": "string", + "description": "The digest of the application claim, in hexadecimal form." + }, + "protocol": { + "$ref": "#/definitions/ApplicationClaimProtocol" + } + }, + "type": "object" + }, + "LedgerEntryClaim": { + "description": "An application claim derived from ledger entry data.", + "required": [ + "protocol" + ], + "properties": { + "collectionId": { + "description": "Identifier of a collection.", + "type": "string" + }, + "contents": { + "description": "Contents of a ledger entry.", + "type": "string" + }, + "secretKey": { + "type": "string", + "description": "Base64-encoded secret key." + }, + "protocol": { + "$ref": "#/definitions/ApplicationClaimProtocol" + } + }, + "type": "object" + }, + "ConfidentialLedgerEnclaves": { + "description": "Information about the enclaves running the Confidential Ledger.", + "required": [ + "currentNodeId", + "enclaveQuotes" + ], + "properties": { + "currentNodeId": { + "description": "Id of the Confidential Ledger node responding to the request.", + "$ref": "#/definitions/EntityId" + }, + "enclaveQuotes": { + "$ref": "#/definitions/EnclaveQuotes" + } + }, + "type": "object" + }, + "Consortium": { + "description": "List of members in the consortium.", + "required": [ + "members" + ], + "properties": { + "members": { + "type": "array", + "items": { + "$ref": "#/definitions/ConsortiumMember" + } + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ConsortiumMember": { + "description": "Describes a member of the consortium.", + "required": [ + "certificate", + "id" + ], + "properties": { + "certificate": { + "type": "string", + "description": "PEM-encoded certificate associated with the member." + }, + "id": { + "description": "Identifier assigned to the member.", + "$ref": "#/definitions/EntityId" + } + }, + "type": "object" + }, + "Constitution": { + "description": "The governance script for the application.", + "required": [ + "digest", + "script" + ], + "properties": { + "digest": { + "description": "SHA256 digest of the constitution script.", + "type": "string" + }, + "script": { + "description": "Contents of the constitution.", + "type": "string" + } + }, + "type": "object" + }, + "EnclaveQuote": { + "description": "Contains the enclave quote.", + "required": [ + "nodeId", + "quoteVersion", + "raw" + ], + "properties": { + "nodeId": { + "description": "ID assigned to this node.", + "$ref": "#/definitions/EntityId" + }, + "mrenclave": { + "description": "MRENCLAVE value of the code running in the enclave.", + "type": "string" + }, + "quoteVersion": { + "description": "Version of the quote presented.", + "type": "string" + }, + "raw": { + "description": "Raw SGX quote, parsable by tools like Open Enclave's oeverify.", + "type": "string" + } + }, + "type": "object" + }, + "EnclaveQuotes": { + "description": "Dictionary of enclave quotes, indexed by node id.", + "additionalProperties": { + "$ref": "#/definitions/EnclaveQuote" + }, + "type": "object" + }, + "EntityId": { + "description": "Identifier for an entity.", + "type": "string" + }, + "LedgerEntries": { + "description": "Array of ledger entries.", + "type": "array", + "items": { + "$ref": "#/definitions/LedgerEntry" + } + }, + "LedgerEntry": { + "description": "An entry in the ledger.", + "required": [ + "contents" + ], + "properties": { + "contents": { + "type": "string", + "description": "Contents of the ledger entry." + }, + "collectionId": { + "type": "string", + "readOnly": true + }, + "transactionId": { + "$ref": "#/definitions/TransactionId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerQueryResult": { + "description": "The result of querying for a ledger entry from an older transaction id. The ledger entry is available in the response only if the returned state is Ready.", + "required": [ + "state" + ], + "properties": { + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "entry": { + "description": "The ledger entry found as a result of the query. This is only available if the query is in Ready state.", + "$ref": "#/definitions/LedgerEntry" + } + }, + "type": "object" + }, + "LedgerQueryState": { + "description": "State of a ledger query.", + "type": "string", + "enum": [ + "Loading", + "Ready" + ], + "x-ms-enum": { + "name": "ConfidentialLedgerQueryState", + "modelAsString": true + } + }, + "LedgerUser": { + "description": "Details about a Confidential Ledger user.", + "required": [ + "assignedRole" + ], + "properties": { + "assignedRole": { + "$ref": "#/definitions/LedgerUserRole" + }, + "userId": { + "$ref": "#/definitions/UserId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerUserMultipleRoles": { + "description": "Details about a Confidential Ledger user.", + "required": [ + "assignedRoles" + ], + "properties": { + "assignedRoles": { + "$ref": "#/definitions/LedgerUserMultipleRolesDef" + }, + "userId": { + "$ref": "#/definitions/UserId", + "readOnly": true + } + }, + "type": "object" + }, + "LedgerUserRole": { + "type": "string", + "description": "Represents an assignable role.", + "enum": [ + "Administrator", + "Contributor", + "Reader" + ], + "x-ms-enum": { + "name": "ConfidentialLedgerUserRoleName", + "modelAsString": true + } + }, + "LedgerUserMultipleRolesDef": { + "description": "Represents an assignable role.", + "type": "array", + "items": { + "$ref": "#/definitions/MultipleRolesList" + } + }, + "MultipleRolesList": { + "description": "Represents list of roles for single user", + "type": "string", + "enum": [ + "Administrator", + "Contributor", + "Reader" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidentialLedgerUserRoleName" + } + }, + "LedgerWriteResult": { + "description": "Returned as a result of a write to the Confidential Ledger, the transaction id in the response indicates when the write will become durable.", + "required": [ + "collectionId" + ], + "properties": { + "collectionId": { + "type": "string" + } + }, + "type": "object" + }, + "MerkleProof": { + "description": "The Merkle proof verifying a transaction.", + "type": "array", + "items": { + "$ref": "#/definitions/MerkleProofElement" + } + }, + "MerkleProofElement": { + "description": "An item in the Merkle proof.", + "type": "object", + "properties": { + "left": { + "type": "string" + }, + "right": { + "type": "string" + } + } + }, + "PagedLedgerEntries": { + "description": "Paginated ledger entries returned in response to a query.", + "type": "object", + "required": [ + "state", + "entries" + ], + "properties": { + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + }, + "entries": { + "$ref": "#/definitions/LedgerEntries" + } + } + }, + "Pem": { + "type": "string" + }, + "PemArray": { + "items": { + "$ref": "#/definitions/Pem" + }, + "type": "array" + }, + "ReceiptContents": { + "properties": { + "cert": { + "type": "string" + }, + "leaf": { + "type": "string" + }, + "leafComponents": { + "$ref": "#/definitions/ReceiptLeafComponents" + }, + "nodeId": { + "type": "string" + }, + "proof": { + "$ref": "#/definitions/ReceiptElementArray" + }, + "root": { + "type": "string" + }, + "serviceEndorsements": { + "$ref": "#/definitions/PemArray" + }, + "signature": { + "type": "string" + } + }, + "required": [ + "signature", + "proof", + "nodeId" + ], + "type": "object" + }, + "ReceiptElement": { + "properties": { + "left": { + "type": "string" + }, + "right": { + "type": "string" + } + }, + "type": "object" + }, + "ReceiptElementArray": { + "items": { + "$ref": "#/definitions/ReceiptElement" + }, + "type": "array" + }, + "ReceiptLeafComponents": { + "properties": { + "claimsDigest": { + "type": "string" + }, + "commitEvidence": { + "type": "string" + }, + "writeSetDigest": { + "type": "string" + } + }, + "type": "object" + }, + "RoleAssignment": { + "description": "Object for assigning a role to a user.", + "required": [ + "roleName" + ], + "properties": { + "roleName": { + "$ref": "#/definitions/LedgerUserRole" + }, + "description": { + "description": "Description of the role.", + "type": "string" + } + }, + "type": "object" + }, + "Collection": { + "description": "Identifier for collections.", + "required": [ + "collectionId" + ], + "properties": { + "collectionId": { + "type": "string" + } + }, + "type": "object" + }, + "PagedCollections": { + "description": "Paginated collections returned in response to a query.", + "type": "object", + "required": [ + "collections" + ], + "properties": { + "collections": { + "items": { + "$ref": "#/definitions/Collection" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "PagedUsers": { + "description": "Paginated users returned in response to a query.", + "type": "object", + "properties": { + "ledgerUsers": { + "items": { + "$ref": "#/definitions/LedgerUser" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "PagedLedgerUsers": { + "description": "Paginated users returned in response to a query.", + "type": "object", + "properties": { + "ledgerUsers": { + "items": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + }, + "type": "array" + }, + "nextLink": { + "description": "Path from which to retrieve the next page of results.", + "type": "string" + } + } + }, + "TransactionId": { + "description": "A unique identifier for the state of the ledger. If returned as part of a LedgerEntry, it indicates the state from which the entry was read.", + "type": "string" + }, + "TransactionReceipt": { + "description": "A receipt certifying the transaction at the specified id.", + "required": [ + "state", + "transactionId" + ], + "properties": { + "applicationClaims": { + "$ref": "#/definitions/ApplicationClaims" + }, + "receipt": { + "$ref": "#/definitions/ReceiptContents" + }, + "state": { + "$ref": "#/definitions/LedgerQueryState" + }, + "transactionId": { + "$ref": "#/definitions/TransactionId" + } + }, + "type": "object" + }, + "TransactionState": { + "type": "string", + "description": "Represents the state of the transaction.", + "enum": [ + "Committed", + "Pending" + ], + "x-ms-enum": { + "name": "TransactionState", + "modelAsString": true + } + }, + "TransactionStatus": { + "description": "Response returned to a query for the transaction status", + "required": [ + "state", + "transactionId" + ], + "properties": { + "state": { + "$ref": "#/definitions/TransactionState" + }, + "transactionId": { + "$ref": "#/definitions/TransactionId" + } + }, + "type": "object" + }, + "UserId": { + "description": "Identifier for the user. This must either be an AAD object id or a certificate fingerprint.", + "type": "string" + }, + "Bundle": { + "description": "bundle for the user defined endpoints", + "properties": { + "metadata": { + "$ref": "#/definitions/Metadata" + }, + "modules": { + "$ref": "#/definitions/ModuleDef_array" + } + }, + "required": [ + "modules", + "metadata" + ], + "type": "object" + }, + "Metadata": { + "properties": { + "endpoints": { + "$ref": "#/definitions/path" + } + }, + "required": [ + "endpoints" + ], + "type": "object" + }, + "path": { + "description": "A map of path to method endpoints for the path", + "additionalProperties": { + "$ref": "#/definitions/method_to_EndpointProperties" + }, + "type": "object" + }, + "method_to_EndpointProperties": { + "properties": { + "get": { + "$ref": "#/definitions/EndpointProperties" + }, + "put": { + "$ref": "#/definitions/EndpointProperties" + }, + "patch": { + "$ref": "#/definitions/EndpointProperties" + }, + "delete": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "type": "object" + }, + "EndpointProperties": { + "properties": { + "authn_policies": { + "$ref": "#/definitions/json_array" + }, + "forwarding_required": { + "$ref": "#/definitions/ForwardingRequired" + }, + "interpreter_reuse": { + "$ref": "#/definitions/InterpreterReusePolicy" + }, + "js_function": { + "type": "string" + }, + "js_module": { + "type": "string" + }, + "mode": { + "$ref": "#/definitions/Mode" + }, + "openapi": { + "$ref": "#/definitions/json" + }, + "openapi_hidden": { + "$ref": "#/definitions/boolean" + }, + "redirection_strategy": { + "$ref": "#/definitions/RedirectionStrategy" + } + }, + "required": [ + "forwarding_required", + "authn_policies" + ], + "type": "object" + }, + "json": {}, + "json_array": { + "items": { + "$ref": "#/definitions/json" + }, + "type": "array" + }, + "ForwardingRequired": { + "enum": [ + "sometimes", + "always", + "never" + ], + "x-ms-enum": { + "name": "ForwardingRequired", + "modelAsString": true + }, + "type": "string" + }, + "InterpreterReusePolicy": { + "properties": { + "key": { + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object" + }, + "Mode": { + "enum": [ + "readwrite", + "readonly", + "historical" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true + }, + "type": "string" + }, + "RedirectionStrategy": { + "enum": [ + "none", + "to_primary", + "to_backup" + ], + "x-ms-enum": { + "name": "RedirectionStrategy", + "modelAsString": true + }, + "type": "string" + }, + "ModuleDef": { + "properties": { + "module": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "name", + "module" + ], + "type": "object" + }, + "ModuleDef_array": { + "items": { + "$ref": "#/definitions/ModuleDef" + }, + "type": "object" + }, + "JSRuntimeOptions": { + "description": "JS runtime options for user defined endpoints", + "properties": { + "log_exception_details": { + "$ref": "#/definitions/boolean" + }, + "max_cached_interpreters": { + "$ref": "#/definitions/uint64" + }, + "max_execution_time_ms": { + "$ref": "#/definitions/uint64" + }, + "max_heap_bytes": { + "$ref": "#/definitions/uint64" + }, + "max_stack_bytes": { + "$ref": "#/definitions/uint64" + }, + "return_exception_details": { + "$ref": "#/definitions/boolean" + } + }, + "type": "object" + }, + "uint64": { + "minimum": 0, + "type": "integer", + "format": "int64" + }, + "boolean": { + "type": "boolean" + }, + "Role": { + "description": "Definition for roles", + "type": "object", + "properties": { + "roleName": { + "description": "name of the user defined role", + "type": "string" + }, + "roleActions": { + "items": { + "$ref": "#/definitions/RoleActionDef" + }, + "type": "object" + } + } + }, + "RoleActionDef": { + "properties": { + "roleActions": { + "description": "action of the user defined role", + "type": "string" + } + }, + "required": [ + "roleActions" + ], + "type": "string" + } + }, + "parameters": { + "CommitParameter": { + "name": "commit", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "description": "The commit in the consensus protocol." + }, + "CollectionIdParameter": { + "name": "collectionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "The collection id.", + "type": "string" + }, + "TransactionIdParameter": { + "name": "transactionId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "Identifies a write transaction.", + "type": "string" + }, + "TransactionIdFromParameter": { + "name": "fromTransactionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specify the first transaction ID in a range.", + "type": "string" + }, + "TransactionIdToParameter": { + "name": "toTransactionId", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "Specify the last transaction ID in a range.", + "type": "string" + }, + "UserDetailsParameter": { + "name": "userDetails", + "description": "Details about a Confidential Ledger user.", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/LedgerUser" + } + }, + "UserMultipleRolesParameter": { + "name": "userMultipleRoles", + "description": "Details about a Confidential Ledger user with multiple roles.", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/LedgerUserMultipleRoles" + } + }, + "UserIdParameter": { + "name": "userId", + "in": "path", + "required": true, + "description": "The user id, either an AAD object ID or certificate fingerprint.", + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "BundleParameter": { + "name": "bundle", + "description": "bundle parameter description", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Bundle" + } + }, + "ModuleNameParameter": { + "name": "module", + "required": true, + "description": "module name of the user defined endpoint", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string" + }, + "JSRuntimeOptionsParameter": { + "name": "JSRuntimeOptions", + "description": "JS runtime options", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/JSRuntimeOptions" + } + }, + "RoleParameter": { + "name": "role", + "description": "user defined role", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "RoleNameParameter": { + "name": "roleName", + "description": "user defined role name", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json new file mode 100644 index 000000000000..9362923dcc23 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/identity/GetLedgerIdentity.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerId": "contoso-ledger-12345", + "certificateEndpoint": "identity.confidential-ledger.core.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerTlsCertificate": "-----BEGIN CERTIFICATE-----\nMIIBvjCCAUKgAwIBAgIQVL+0VqZp3VzMyFKqD4Cs8zAMBggqhkjOPQQDAwUAMBYx\nFDASBgNVBAMMC0NDRiBOZXR3b3JrMB4XDTE5MTEwMTAwMDAwMFoXDTIxMTIzMTIz\nNTk1OVowFjEUMBIGA1UEAwwLQ0NGIE5ldHdvcmswdjAQBgcqhkjOPQIBBgUrgQQA\nIgNiAATBm4jNV4Kyj6bc/iMKDEXTCyU6P6U1KWAiDodl+Jd8aDJsBwLimtg4QCug\n1mpHnVPmcbPAbNM11+xrLHuFEfuZlS3DI+CCX8FUB2VvDVT3SfWLDVmr1xLStTDH\nuN4YjBOjUzBRMA8GA1UdEwQIMAYBAf8CAQAwHQYDVR0OBBYEFGSdsThwxrTOEQxb\nZ2NsslNvJRYkMB8GA1UdIwQYMBaAFGSdsThwxrTOEQxbZ2NsslNvJRYkMAwGCCqG\nSM49BAMDBQADaAAwZQIwJLLWllNZ83ym/HQuvtGGSdF/RCZwUoh+yhad/vUfVnhE\n2dYLDDEJOORpxpEIVfXgAjEA/CLcRwSZxzEmLDYe1y4puXKuSDCUiu+bKYgdvRLj\nRQJgTygutcTdI64sSweqPveK\n-----END CERTIFICATE-----\n\u0000" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json new file mode 100644 index 000000000000..240b5ed04929 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateLedgerEntry.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "entry": { + "contents": "New ledger entry contents." + } + }, + "responses": { + "200": { + "headers": { + "x-ms-ccf-transaction-id": "2.15" + }, + "body": { + "collectionId": "subledger:0" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json new file mode 100644 index 000000000000..215928b14f2b --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateLedgerUsers.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id", + "userMultipleRoles": { + "assignedRoles": [ + "Reader", + "Writer" + ] + } + }, + "responses": { + "200": { + "body": { + "assignedRoles": [ + "Reader", + "Writer" + ], + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json new file mode 100644 index 000000000000..e5e40e36b421 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateOrUpdateUser.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id", + "userDetails": { + "assignedRole": "Reader" + } + }, + "responses": { + "200": { + "body": { + "assignedRole": "Reader", + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json new file mode 100644 index 000000000000..009d67407ff0 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/CreateUserDefinedEndpoint.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "description": "User definied endpoint.", + "bundle": { + "metadata": { + "endpoints": { + "/content": { + "get": { + "forwarding_required": "always", + "authn_policies": [ + {} + ] + } + } + } + }, + "modules": { + "name": "test.js", + "module": "TESTJS" + } + } + }, + "responses": { + "201": { + "description": "The custom endpoint." + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json new file mode 100644 index 000000000000..4c35e312a9d1 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUser.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "204": {} + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json new file mode 100644 index 000000000000..635506d708e5 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/DeleteUserDefinedRole.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "roleName": "reader" + }, + "responses": { + "200": { + "description": "Get user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json new file mode 100644 index 000000000000..b544a6449d79 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetConstitution.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "digest": "cd04f484d93a13df44eab4235c14df37e20907b3216c5a37b9e484a363a76c8e", + "script": "<constitution script contents>" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json new file mode 100644 index 000000000000..9bd31b82a365 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetCurrentLedgerEntry.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "contents": "Current ledger entry contents.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json new file mode 100644 index 000000000000..e24e328c5523 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetEnclaveQuotes.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "currentNodeId": "0", + "enclaveQuotes": { + "0": { + "mrenclave": "9b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d7", + "nodeId": "0", + "raw": "0100000002000000e811000000000000030002000000000005000a00939a7233f79c4ca9940a0db3957f06074b17f6b893ef49abff5c9b689576dc08000000000f0f0305ff80060000000000000000000000000000000000000000000000000000000000000000000000000000000000050000000000000007000000000000009b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d700000000000000000000000000000000000000000000000000000000000000005bebf77a60c142b06ec46417957f4374b42102092d2ac7465daa3af9a62fcd7f000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a7c7f007fe7242cb20ad7d6eda114b47dfd92b1f615ae728a777852ce1377e2000000000000000000000000000000000000000000000000000000000000000034100000014d855131f932a590d06f9d6d6e0f2ade47054c7a9c5de61d38ccc2f35f4c00aa83ec2b3c3642af9aa050555a23c1272c1cdb0563a4e4264552a6a8514f5671378f81f331f54a8a2965275d64c061246d64c18df5b3383a498d3b5a4e997734bb35a09b0e8374bb039889dc168523251a90d8d96d921f697efb342a6534333c0f0f0305ff8006000000000000000000000000000000000000000000000000000000000000000000000000000000000015000000000000000700000000000000cdcadfb7db22ada5fd603455cde1bf9fa258fa5f284dcd6e0c63392f633a110500000000000000000000000000000000000000000000000000000000000000008c4f5775d796503e96137f77c68a829a0056ac8ded70140b081b094490c57bff000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010005000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004cb3dda245424884c47313c09366c2103703cbdef3a75f20316a2796d9243e6b0000000000000000000000000000000000000000000000000000000000000000326e8be8be9b1e8f3fb3a44d8743ca30d4cde23750294f51f282401adf08334ff280afdb1b6d912b39e2c7931837f2ac91f17689ca9cb943f5a491d60bb314332000000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f0500cc0d00002d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d494945674443434243616741774942416749555576735257764147614b502b724b36424449515776477948656a6777436759494b6f5a497a6a3045417749770a6354456a4d4345474131554541777761535735305a577767553064594946424453794251636d396a5a584e7a6233496751304578476a415942674e5642416f4d0a45556c756447567349454e76636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155450a4341774351304578437a414a42674e5642415954416c56544d423458445449774d4459784f4441774d5449304f466f58445449334d4459784f4441774d5449300a4f466f77634445694d434147413155454177775a535735305a5777675530645949464244537942445a584a3061575a70593246305a5445614d426747413155450a43677752535735305a577767513239796347397959585270623234784644415342674e564241634d43314e68626e526849454e7359584a684d517377435159440a5651514944414a445154454c4d416b474131554542684d4356564d775754415442676371686b6a4f5051494242676771686b6a4f50514d4242774e43414154570a663645447136324762714844326677574564656538645853645179694e665039493945594a59472b3770475a586b326173775370374f3876456d58425a52345a0a6b713075452f65687233435935793774323246786f3449436d7a434341706377487759445652306a42426777466f4155304f6971326e58582b53354a463567380a6578526c304e587957553077587759445652306642466777566a42556f464b6755495a4f6148523063484d364c79396863476b7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253397a5a3367765932567964476c6d61574e6864476c76626939324d6939775932746a636d772f593245390a63484a765932567a633239794d4230474131556444675157424253334b5969495a66795a7449432b4f4b7a4c365142446c5465384144414f42674e56485138420a4166384542414d434273417744415944565230544151482f42414977414443434164514743537147534962345451454e4151534341635577676748424d4234470a43697147534962345451454e415145454547462f622f39427666662b6c75427a75747a6d646d34776767466b42676f71686b69472b453042445145434d4949420a5644415142677371686b69472b4530424451454341514942447a415142677371686b69472b4530424451454341674942447a415142677371686b69472b4530420a4451454341774942416a415142677371686b69472b45304244514543424149424244415142677371686b69472b453042445145434251494241544152426773710a686b69472b4530424451454342674943414941774541594c4b6f5a496876684e4151304241676343415159774541594c4b6f5a496876684e41513042416767430a415141774541594c4b6f5a496876684e4151304241676b43415141774541594c4b6f5a496876684e4151304241676f43415141774541594c4b6f5a496876684e0a4151304241677343415141774541594c4b6f5a496876684e4151304241677743415141774541594c4b6f5a496876684e4151304241673043415141774541594c0a4b6f5a496876684e4151304241673443415141774541594c4b6f5a496876684e4151304241673843415141774541594c4b6f5a496876684e41513042416841430a415141774541594c4b6f5a496876684e415130424168454341516f774877594c4b6f5a496876684e4151304241684945454138504167514267415941414141410a41414141414141774541594b4b6f5a496876684e4151304241775143414141774641594b4b6f5a496876684e4151304242415147414a4275315141414d4138470a43697147534962345451454e4151554b41514177436759494b6f5a497a6a3045417749445341417752514968414b582b324343704b525652654d2b4d7543366a0a7477634d502b2b4645396667365a4f696d55464a55474478416941684d6a743258323651662b4247344965456f665547537070364f792b68494e704d48626d7a0a4f4a596279513d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436c7a4343416a36674177494241674956414e446f71747031312f6b7553526559504873555a644456386c6c4e4d416f4743437147534d343942414d430a4d476778476a415942674e5642414d4d45556c756447567349464e48574342536232393049454e424d526f77474159445651514b4442464a626e526c624342440a62334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e424d5173770a435159445651514745774a56557a4165467730784f4441314d6a45784d4451314d4468614677307a4d7a41314d6a45784d4451314d4468614d484578497a41680a42674e5642414d4d476b6c756447567349464e48574342515130736755484a765932567a6332397949454e424d526f77474159445651514b4442464a626e526c0a6243424462334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e420a4d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941424c39712b4e4d7032494f670a74646c31626b2f75575a352b5447516d38614369387a373866732b664b435133642b75447a586e56544154325a68444369667949754a77764e33774e427039690a484253534d4a4d4a72424f6a6762737767626777487759445652306a42426777466f4155496d554d316c71644e496e7a6737535655723951477a6b6e427177770a556759445652306642457377535442486f45576751345a426148523063484d364c79396a5a584a3061575a70593246305a584d7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253394a626e526c62464e4857464a76623352445153356a636d7777485159445652304f42425945464e446f0a71747031312f6b7553526559504873555a644456386c6c4e4d41344741315564447745422f77514541774942426a415342674e5648524d4241663845434441470a4151482f416745414d416f4743437147534d343942414d43413063414d45514349432f396a2b3834542b487a74564f2f734f5142574a6253642b2f327565784b0a342b6141306a6346424c63704169413364684d72463563443532743646714d764149706a385864476d79326265656c6a4c4a4b2b707a706352413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436a6a4343416a53674177494241674955496d554d316c71644e496e7a6737535655723951477a6b6e42717777436759494b6f5a497a6a3045417749770a614445614d4267474131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e760a636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a0a42674e5642415954416c56544d423458445445344d4455794d5445774e4445784d566f5844544d7a4d4455794d5445774e4445784d466f77614445614d4267470a4131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e76636e4276636d46300a615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a42674e56424159540a416c56544d466b77457759484b6f5a497a6a3043415159494b6f5a497a6a3044415163445167414543366e45774d4449595a4f6a2f69505773437a61454b69370a314f694f534c52466857476a626e42564a66566e6b59347533496a6b4459594c304d784f346d717379596a6c42616c54565978465032734a424b357a6c4b4f420a757a43427544416642674e5648534d4547444157674251695a517a575770303069664f44744a5653763141624f5363477244425342674e5648523845537a424a0a4d45656752614244686b466f64485277637a6f764c324e6c636e52705a6d6c6a5958526c63793530636e567a6447566b63325679646d6c6a5a584d75615735300a5a577775593239744c306c756447567355306459556d397664454e424c6d4e796244416442674e564851344546675155496d554d316c71644e496e7a673753560a55723951477a6b6e4271777744675944565230504151482f42415144416745474d42494741315564457745422f7751494d4159424166384341514577436759490a4b6f5a497a6a30454177494453414177525149675151732f30387279636450617543466b3855505158434d416c736c6f4265374e7761514754636470613045430a495143557438534776784b6d6a70634d2f7a3057503944766f3868326b3564753169574464426b416e2b306969413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a00", + "quoteVersion": "sgx-quote-1" + }, + "1": { + "mrenclave": "9b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d7", + "nodeId": "1", + "raw": "0100000002000000e811000000000000030002000000000005000a00939a7233f79c4ca9940a0db3957f06074b17f6b893ef49abff5c9b689576dc08000000000f0f0305ff80060000000000000000000000000000000000000000000000000000000000000000000000000000000000050000000000000007000000000000009b4b6890a5fff10854e3ca4fa5af5801dae57a46bfef3f23749bf47a61a1b1d700000000000000000000000000000000000000000000000000000000000000005bebf77a60c142b06ec46417957f4374b42102092d2ac7465daa3af9a62fcd7f000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000002a7c7f007fe7242cb20ad7d6eda114b47dfd92b1f615ae728a777852ce1377e2000000000000000000000000000000000000000000000000000000000000000034100000014d855131f932a590d06f9d6d6e0f2ade47054c7a9c5de61d38ccc2f35f4c00aa83ec2b3c3642af9aa050555a23c1272c1cdb0563a4e4264552a6a8514f5671378f81f331f54a8a2965275d64c061246d64c18df5b3383a498d3b5a4e997734bb35a09b0e8374bb039889dc168523251a90d8d96d921f697efb342a6534333c0f0f0305ff8006000000000000000000000000000000000000000000000000000000000000000000000000000000000015000000000000000700000000000000cdcadfb7db22ada5fd603455cde1bf9fa258fa5f284dcd6e0c63392f633a110500000000000000000000000000000000000000000000000000000000000000008c4f5775d796503e96137f77c68a829a0056ac8ded70140b081b094490c57bff000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010005000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004cb3dda245424884c47313c09366c2103703cbdef3a75f20316a2796d9243e6b0000000000000000000000000000000000000000000000000000000000000000326e8be8be9b1e8f3fb3a44d8743ca30d4cde23750294f51f282401adf08334ff280afdb1b6d912b39e2c7931837f2ac91f17689ca9cb943f5a491d60bb314332000000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f0500cc0d00002d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d494945674443434243616741774942416749555576735257764147614b502b724b36424449515776477948656a6777436759494b6f5a497a6a3045417749770a6354456a4d4345474131554541777761535735305a577767553064594946424453794251636d396a5a584e7a6233496751304578476a415942674e5642416f4d0a45556c756447567349454e76636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155450a4341774351304578437a414a42674e5642415954416c56544d423458445449774d4459784f4441774d5449304f466f58445449334d4459784f4441774d5449300a4f466f77634445694d434147413155454177775a535735305a5777675530645949464244537942445a584a3061575a70593246305a5445614d426747413155450a43677752535735305a577767513239796347397959585270623234784644415342674e564241634d43314e68626e526849454e7359584a684d517377435159440a5651514944414a445154454c4d416b474131554542684d4356564d775754415442676371686b6a4f5051494242676771686b6a4f50514d4242774e43414154570a663645447136324762714844326677574564656538645853645179694e665039493945594a59472b3770475a586b326173775370374f3876456d58425a52345a0a6b713075452f65687233435935793774323246786f3449436d7a434341706377487759445652306a42426777466f4155304f6971326e58582b53354a463567380a6578526c304e587957553077587759445652306642466777566a42556f464b6755495a4f6148523063484d364c79396863476b7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253397a5a3367765932567964476c6d61574e6864476c76626939324d6939775932746a636d772f593245390a63484a765932567a633239794d4230474131556444675157424253334b5969495a66795a7449432b4f4b7a4c365142446c5465384144414f42674e56485138420a4166384542414d434273417744415944565230544151482f42414977414443434164514743537147534962345451454e4151534341635577676748424d4234470a43697147534962345451454e415145454547462f622f39427666662b6c75427a75747a6d646d34776767466b42676f71686b69472b453042445145434d4949420a5644415142677371686b69472b4530424451454341514942447a415142677371686b69472b4530424451454341674942447a415142677371686b69472b4530420a4451454341774942416a415142677371686b69472b45304244514543424149424244415142677371686b69472b453042445145434251494241544152426773710a686b69472b4530424451454342674943414941774541594c4b6f5a496876684e4151304241676343415159774541594c4b6f5a496876684e41513042416767430a415141774541594c4b6f5a496876684e4151304241676b43415141774541594c4b6f5a496876684e4151304241676f43415141774541594c4b6f5a496876684e0a4151304241677343415141774541594c4b6f5a496876684e4151304241677743415141774541594c4b6f5a496876684e4151304241673043415141774541594c0a4b6f5a496876684e4151304241673443415141774541594c4b6f5a496876684e4151304241673843415141774541594c4b6f5a496876684e41513042416841430a415141774541594c4b6f5a496876684e415130424168454341516f774877594c4b6f5a496876684e4151304241684945454138504167514267415941414141410a41414141414141774541594b4b6f5a496876684e4151304241775143414141774641594b4b6f5a496876684e4151304242415147414a4275315141414d4138470a43697147534962345451454e4151554b41514177436759494b6f5a497a6a3045417749445341417752514968414b582b324343704b525652654d2b4d7543366a0a7477634d502b2b4645396667365a4f696d55464a55474478416941684d6a743258323651662b4247344965456f665547537070364f792b68494e704d48626d7a0a4f4a596279513d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436c7a4343416a36674177494241674956414e446f71747031312f6b7553526559504873555a644456386c6c4e4d416f4743437147534d343942414d430a4d476778476a415942674e5642414d4d45556c756447567349464e48574342536232393049454e424d526f77474159445651514b4442464a626e526c624342440a62334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e424d5173770a435159445651514745774a56557a4165467730784f4441314d6a45784d4451314d4468614677307a4d7a41314d6a45784d4451314d4468614d484578497a41680a42674e5642414d4d476b6c756447567349464e48574342515130736755484a765932567a6332397949454e424d526f77474159445651514b4442464a626e526c0a6243424462334a7762334a6864476c76626a45554d424947413155454277774c553246756447456751327868636d4578437a414a42674e564241674d416b4e420a4d517377435159445651514745774a56557a425a4d424d4742797147534d34394167454743437147534d34394177454841304941424c39712b4e4d7032494f670a74646c31626b2f75575a352b5447516d38614369387a373866732b664b435133642b75447a586e56544154325a68444369667949754a77764e33774e427039690a484253534d4a4d4a72424f6a6762737767626777487759445652306a42426777466f4155496d554d316c71644e496e7a6737535655723951477a6b6e427177770a556759445652306642457377535442486f45576751345a426148523063484d364c79396a5a584a3061575a70593246305a584d7564484a316333526c5a484e6c0a636e5a705932567a4c6d6c75644756734c6d4e766253394a626e526c62464e4857464a76623352445153356a636d7777485159445652304f42425945464e446f0a71747031312f6b7553526559504873555a644456386c6c4e4d41344741315564447745422f77514541774942426a415342674e5648524d4241663845434441470a4151482f416745414d416f4743437147534d343942414d43413063414d45514349432f396a2b3834542b487a74564f2f734f5142574a6253642b2f327565784b0a342b6141306a6346424c63704169413364684d72463563443532743646714d764149706a385864476d79326265656c6a4c4a4b2b707a706352413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a2d2d2d2d2d424547494e2043455254494649434154452d2d2d2d2d0a4d4949436a6a4343416a53674177494241674955496d554d316c71644e496e7a6737535655723951477a6b6e42717777436759494b6f5a497a6a3045417749770a614445614d4267474131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e760a636e4276636d4630615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a0a42674e5642415954416c56544d423458445445344d4455794d5445774e4445784d566f5844544d7a4d4455794d5445774e4445784d466f77614445614d4267470a4131554541777752535735305a5777675530645949464a766233516751304578476a415942674e5642416f4d45556c756447567349454e76636e4276636d46300a615739754d5251774567594456515148444174545957353059534244624746795954454c4d416b47413155454341774351304578437a414a42674e56424159540a416c56544d466b77457759484b6f5a497a6a3043415159494b6f5a497a6a3044415163445167414543366e45774d4449595a4f6a2f69505773437a61454b69370a314f694f534c52466857476a626e42564a66566e6b59347533496a6b4459594c304d784f346d717379596a6c42616c54565978465032734a424b357a6c4b4f420a757a43427544416642674e5648534d4547444157674251695a517a575770303069664f44744a5653763141624f5363477244425342674e5648523845537a424a0a4d45656752614244686b466f64485277637a6f764c324e6c636e52705a6d6c6a5958526c63793530636e567a6447566b63325679646d6c6a5a584d75615735300a5a577775593239744c306c756447567355306459556d397664454e424c6d4e796244416442674e564851344546675155496d554d316c71644e496e7a673753560a55723951477a6b6e4271777744675944565230504151482f42415144416745474d42494741315564457745422f7751494d4159424166384341514577436759490a4b6f5a497a6a30454177494453414177525149675151732f30387279636450617543466b3855505158434d416c736c6f4265374e7761514754636470613045430a495143557438534776784b6d6a70634d2f7a3057503944766f3868326b3564753169574464426b416e2b306969413d3d0a2d2d2d2d2d454e442043455254494649434154452d2d2d2d2d0a00", + "quoteVersion": "sgx-quote-1" + } + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json new file mode 100644 index 000000000000..92ec8e5a566d --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerEntry.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "transactionId": "2.15", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "state": "Ready", + "entry": { + "contents": "Ledger entry contents at transaction id 2.15.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json new file mode 100644 index 000000000000..45c8a57a926a --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetLedgerUsers.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "200": { + "body": { + "assignedRoles": [ + "Administrator", + "Reader" + ], + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json new file mode 100644 index 000000000000..ab3ce2f4e25d --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetReceipt.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "transactionId": "2.15" + }, + "responses": { + "200": { + "body": { + "applicationClaims": [ + { + "kind": "LedgerEntry", + "ledgerEntry": { + "protocol": "LedgerEntryV1", + "collectionId": "subledger:0", + "contents": "Ledger entry contents at transaction id 2.15", + "secretKey": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=" + } + } + ], + "receipt": { + "cert": "-----BEGIN CERTIFICATE-----\nMIIBwzCCAUmgAwIBAgIRAMRXRsojcLOzbz90rSp67xQwCgYIKoZIzj0EAwMwFjEU\nMBIGA1UEAwwLQ0NGIE5ldHdvcmswHhcNMjIxMTI1MTE1NzM1WhcNMjMwMjIzMTE1\nNzM0WjATMREwDwYDVQQDDAhDQ0YgTm9kZTB2MBAGByqGSM49AgEGBSuBBAAiA2IA\nBFjnt5PbiuXlBDdWWJvR1d0niMIzx6hxRCs06d8MUwG49UvdqRc8aY2eeCuoGupG\n9uWA3WBaZoe3QcqUr0+S+WLYXP0TYRx0xQncbKZgSWa3bcFNqaosw1KnjbLaSIRR\nJKNeMFwwCQYDVR0TBAIwADAdBgNVHQ4EFgQUHOauq1jxw2NJMh0UrzkrWi/Vuxkw\nHwYDVR0jBBgwFoAUSyn9seKhGp3n74by4boUVRXOpvcwDwYDVR0RBAgwBocEfwAA\nATAKBggqhkjOPQQDAwNoADBlAjBuhyVaon0EVXKUnO59acJVcfN8fYbz8keieiov\nOHqVqSCc60mdNGugn1kUmCKtHWYCMQDDMnOFtyeTfHPCo4n48nyoCHdaTVyS/XIF\n83P94iQITIiCX9ZDxf/eqc8rcEvm63A=\n-----END CERTIFICATE-----\n", + "leafComponents": { + "commitEvidence": "ce:2.15:3cc2bfd0e14c9fb8b3d4838d3dce19704ca83fa04720e044512f25581fc9b0a7", + "writeSetDigest": "f71b60aa93a6ae36bfcadaf852b2eb43e7f868bd95053c84dd4b67d11c05d516" + }, + "nodeId": "ff9bf39b7150510ad437977d7010aa733e718b407df755b52b961e4c3b2708fd", + "proof": [ + { + "left": "65e4256d7e7cbff2723de58dc1d8931e4683a328e720ba7c784a82b65d027b4a" + }, + { + "left": "ef24f237b9208cfa51cdfa56b84927adce7074f3b5502abc0a6111bbd1317438" + }, + { + "left": "067d74a552d2f96d236e8fe94ed40ffd8ae665f890d6b8721783a7795a1b3dec" + }, + { + "left": "1a64045485d3e9137978cb4de06a422a76738d36489d8efa829bbf7bdd262ac1" + } + ], + "serviceEndorsements": [], + "signature": "MGYCMQCYbEjjClnK63cpkb+LBM4XFugq99zPM8KLN9yKvXwV576mXd3fyUOrF84HJbAbO6gCMQCiebUALQkaSixwh4q3l3v+rd9pgBnH2HZpnby6vvJLGkYBDUAdR0kyYV5OEJva6N0=" + }, + "state": "Ready", + "transactionId": "2.15" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json new file mode 100644 index 000000000000..6e354702c2b2 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetRuntimeOptions.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "Runtime options for custom endpoint.", + "body": { + "max_heap_bytes": 1024, + "max_stack_bytes": 1024, + "max_execution_time_ms": 1200, + "log_exception_details": false, + "return_exception_details": false, + "max_cached_interpreters": 1024 + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json new file mode 100644 index 000000000000..57ebe899b53b --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetTransactionStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "transactionId": "4.2" + }, + "responses": { + "200": { + "body": { + "state": "Committed", + "transactionId": "4.2" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json new file mode 100644 index 000000000000..23884ecf8143 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUser.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com", + "userId": "AAD object id" + }, + "responses": { + "200": { + "body": { + "assignedRole": "Administrator", + "userId": "AAD object id" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json new file mode 100644 index 000000000000..f2e5afe052e8 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpoint.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "The custom endpoint.", + "body": { + "metadata": { + "endpoints": { + "/content": { + "get": { + "forwarding_required": "always", + "authn_policies": [ + {} + ] + } + } + } + }, + "modules": { + "name": "test.js", + "module": "TESTJS" + } + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json new file mode 100644 index 000000000000..31605205fee8 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedEndpointsModule.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "module": "TESTJS" + }, + "responses": { + "200": { + "description": "The custom endpoint.", + "body": { + "name": "test.js", + "module": "TESTJS" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json new file mode 100644 index 000000000000..4947c9699328 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/GetUserDefinedRole.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "roleName": "reader", + "api-version": "2024-08-22-preview" + }, + "responses": { + "200": { + "description": "Get user defined roles and actions", + "body": { + "roleName": "reader", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/read" + ] + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json new file mode 100644 index 000000000000..eb7b58123d82 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListCollections.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "collections": [ + { + "collectionId": "first" + }, + { + "collectionId": "second" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json new file mode 100644 index 000000000000..b18a75188df0 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListConsortiumMembers.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "members": [ + { + "certificate": "<PEM certificate>", + "id": "0" + } + ], + "nextLink": "<link>" + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json new file mode 100644 index 000000000000..91a125b83dbc --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerEntries.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "fromTransactionId": "2.15", + "toTransactionId": "2.20", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "state": "Ready", + "nextLink": "/app/transactions?fromTransactionId=3.15&toTransactionId=3.42&collectionId=0&api-version=0.1-preview", + "entries": [ + { + "contents": "Ledger entry contents at transaction id 2.15.", + "collectionId": "subledger:0", + "transactionId": "2.15" + } + ] + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json new file mode 100644 index 000000000000..2d84285befea --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListLedgerUsers.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerUsers": [ + { + "assignedRoles": [ + "Administrator", + "Reader" + ], + "userId": "Certificate object id 1" + }, + { + "assignedRoles": [ + "Contributor", + "Reader" + ], + "userId": "AAD object id 2" + }, + { + "assignedRoles": [ + "Reader" + ], + "userId": "AAD object id 3" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json new file mode 100644 index 000000000000..e9e9ab082709 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/ListUsers.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "ledgerUri": "myledger.confidentialledger.azure.com" + }, + "responses": { + "200": { + "body": { + "ledgerUsers": [ + { + "assignedRole": "Administrator", + "userId": "Certificate object id 1" + }, + { + "assignedRole": "Contributor", + "userId": "AAD object id 2" + }, + { + "assignedRole": "Reader", + "userId": "AAD object id 3" + } + ] + }, + "nextLink": "<link>" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json new file mode 100644 index 000000000000..afacdf2c7264 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchRuntimeOptions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "JSRuntimeOptions": { + "log_exception_details": false, + "max_execution_time_ms": 1200 + } + }, + "responses": { + "200": { + "description": "Runtime options for custom endpoint.", + "body": { + "max_heap_bytes": 1024, + "max_stack_bytes": 1024, + "max_execution_time_ms": 1200, + "log_exception_details": false, + "return_exception_details": false, + "max_cached_interpreters": 1024 + } + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json new file mode 100644 index 000000000000..640552d1632e --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PatchUserDefinedRole.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "role": { + "roleName": "administrator", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/write" + ] + } + }, + "responses": { + "200": { + "description": "Created new user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json new file mode 100644 index 000000000000..640552d1632e --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/examples/ledger/PutUserDefinedRole.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-08-22-preview", + "role": { + "roleName": "administrator", + "roleActions": [ + "Microsoft.ConfidentialLedger/ledger/users/write" + ] + } + }, + "responses": { + "200": { + "description": "Created new user defined roles and actions" + } + } +} diff --git a/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json new file mode 100644 index 000000000000..c6ac389de4b1 --- /dev/null +++ b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json @@ -0,0 +1,90 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-22-preview", + "title": "ConfidentialLedgerCertificateClient", + "description": "The ConfidentialLedgerCertificateClient is used to retrieve the TLS certificate required for connecting to a Confidential Ledger." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "endpoint", + "description": "The certificate endpoint (or \"Identity Service Endpoint\" in the Azure portal), for example https://identity.confidential-ledger.core.azure.com", + "required": true, + "type": "string", + "in": "path", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/ledgerIdentity/{ledgerId}": { + "get": { + "operationId": "GetLedgerIdentity", + "x-ms-examples": { + "GetLedgerIdentity": { + "$ref": "./examples/identity/GetLedgerIdentity.json" + } + }, + "summary": "Gets identity information for a Confidential Ledger instance.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "ledgerId", + "description": "Id of the Confidential Ledger instance to get information for", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Returns ledger information.", + "schema": { + "$ref": "#/definitions/LedgerIdentityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "common.json#/definitions/ConfidentialLedgerError" + } + } + } + } + } + }, + "definitions": { + "LedgerIdentityInformation": { + "description": "Contains the information about a Confidential Ledger.", + "required": [ + "ledgerTlsCertificate" + ], + "properties": { + "ledgerId": { + "description": "Id for the ledger.", + "type": "string", + "readOnly": true + }, + "ledgerTlsCertificate": { + "description": "PEM-encoded certificate used for TLS by the Confidential Ledger.", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/confidentialledger/data-plane/readme.md b/specification/confidentialledger/data-plane/readme.md index e97f24cebc38..33a35d78b5f6 100644 --- a/specification/confidentialledger/data-plane/readme.md +++ b/specification/confidentialledger/data-plane/readme.md @@ -12,7 +12,7 @@ Please look to the files `Microsoft.ConfidentialLedger/preview/2023-01-18-previe > see https://aka.ms/autorest ``` yaml -tag: package-2024-01-26-preview-identity +tag: package-2024-08-22-preview-ledger openapi-type: data-plane ``` @@ -139,4 +139,23 @@ These settings apply only when `--tag=package-2024-01-26-preview-identity` is sp ```yaml $(tag) == 'package-2024-01-26-preview-identity' input-file: - - Microsoft.ConfidentialLedger/preview/2024-01-26-preview/identityservice.json \ No newline at end of file + - Microsoft.ConfidentialLedger/preview/2024-01-26-preview/identityservice.json +``` + +### Tag: package-2024-08-22-preview-ledger + +These settings apply only when `--tag=package-2024-08-22-preview-ledger` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-22-preview-ledger' +input-file: + - Microsoft.ConfidentialLedger/preview/2024-08-22-preview/confidentialledger.json +``` + +### Tag: package-2024-08-22-preview-identity + +These settings apply only when `--tag=package-2024-08-22-preview-identity` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-22-preview-identity' +input-file: + - Microsoft.ConfidentialLedger/preview/2024-08-22-preview/identityservice.json +``` \ No newline at end of file From ea92b3e301ab803ec9b76737c77b17845ea14989 Mon Sep 17 00:00:00 2001 From: sidsinghms <88089677+sidsinghms@users.noreply.github.com> Date: Thu, 3 Oct 2024 18:03:59 +0530 Subject: [PATCH 033/101] [SCVMM] Make the request body optional for VirtualMachineInstances/Stop (#30401) * Make the stop machine request body optional * [tsp compile] Update scvmm.json for 2023-10-07 * [tsp compile] Update scvmm.json for 2024-06-01 * Create sdk-suppressions.yaml --------- Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../scvmm/ScVmm.Management/VirtualMachineInstance.tsp | 6 +++++- .../Microsoft.ScVmm/stable/2023-10-07/scvmm.json | 2 +- .../Microsoft.ScVmm/stable/2024-06-01/scvmm.json | 2 +- specification/scvmm/resource-manager/sdk-suppressions.yaml | 6 ++++++ 4 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 specification/scvmm/resource-manager/sdk-suppressions.yaml diff --git a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp index 74559c5c70f8..71ca59eb3ce5 100644 --- a/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp +++ b/specification/scvmm/ScVmm.Management/VirtualMachineInstance.tsp @@ -106,7 +106,11 @@ interface VirtualMachineInstances { @summary("Implements the operation to stop a virtual machine.") stop is ArmResourceActionNoResponseContentAsync< VirtualMachineInstance, - StopVirtualMachineOptions + { + /** The content of the action request */ + @body + body?: StopVirtualMachineOptions; + } >; /** The operation to start a virtual machine instance. */ @summary("Implements the operation to start a virtual machine.") diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json index d53c2c453e9c..a47208794c03 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2023-10-07/scvmm.json @@ -940,7 +940,7 @@ "name": "body", "in": "body", "description": "The content of the action request", - "required": true, + "required": false, "schema": { "$ref": "#/definitions/StopVirtualMachineOptions" } diff --git a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json index a1043382dec9..0f5d03c0273c 100644 --- a/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json +++ b/specification/scvmm/resource-manager/Microsoft.ScVmm/stable/2024-06-01/scvmm.json @@ -940,7 +940,7 @@ "name": "body", "in": "body", "description": "The content of the action request", - "required": true, + "required": false, "schema": { "$ref": "#/definitions/StopVirtualMachineOptions" } diff --git a/specification/scvmm/resource-manager/sdk-suppressions.yaml b/specification/scvmm/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..1ac7d2cd31f1 --- /dev/null +++ b/specification/scvmm/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,6 @@ +suppressions: + azure-sdk-for-js: + - package: "@azure/arm-scvmm" + breaking-changes: + - Operation VirtualMachineInstances.beginStop has a new signature + - Operation VirtualMachineInstances.beginStopAndWait has a new signature \ No newline at end of file From afbae2a372b50a68763124f9cc3c302b3e383205 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Thu, 3 Oct 2024 09:34:27 -0700 Subject: [PATCH 034/101] Change 'The asynchronous responses are stored for 14 days.' to 24 days. (#30831) * Change 'The asynchronous responses are stored for 14 days.' to 24 days. * Added TypeSpecRequirement suppression for Route v1. --- .../maps/data-plane/Route/preview/1.0/route.json | 8 ++++---- specification/maps/suppressions.yaml | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 specification/maps/suppressions.yaml diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index 301fe9e9d10e..92ae9d2a3e68 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -887,7 +887,7 @@ "/route/matrix/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.", - "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -993,7 +993,7 @@ }, "get": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.", - "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1034,7 +1034,7 @@ "/route/matrix/sync/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request.", - "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1659,7 +1659,7 @@ "/route/directions/batch/{format}": { "post": { "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", - "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **14** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, diff --git a/specification/maps/suppressions.yaml b/specification/maps/suppressions.yaml new file mode 100644 index 000000000000..499e360ba175 --- /dev/null +++ b/specification/maps/suppressions.yaml @@ -0,0 +1,3 @@ +- tool: TypeSpecRequirement + path: ./data-plane/Route/preview/1.0/route.json + reason: Brownfield service not ready to migrate From 2aaea3e587bef7a20e62f8a90fc75c9e73354497 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Thu, 3 Oct 2024 10:19:58 -0700 Subject: [PATCH 035/101] [.npmrc] Restore trailing newline accidentally removed in #30290 (#30846) --- .npmrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.npmrc b/.npmrc index 4fd021952d5a..b6f27f135954 100644 --- a/.npmrc +++ b/.npmrc @@ -1 +1 @@ -engine-strict=true \ No newline at end of file +engine-strict=true From 5cc68885f97d19b0b49eb4433b8a7f2725ffcf44 Mon Sep 17 00:00:00 2001 From: amber-ccc <v-xiongchen@microsoft.com> Date: Thu, 3 Oct 2024 12:27:58 -0700 Subject: [PATCH 036/101] - Converting Authoring Analyzeconversations of 2023-04-15-preview and 2023-04-01 version to Typespec. (#30499) * - initiated the first version of typespec. * - deleted testing swagger for authoring conversations - added testing json for authoring conversations 2023-04-15-preview * - added long running operations * - added a createOrUpdate operation with 201 response * - modified the operationId in SuccesfulCopyProjectAuthorization.json - compiled * - added SuccessfulGetDeploymentDeleteFromResourcesStatus.json - compiled * - modified model EvaluationResults - compiled * - fixed Swagger SpellCheck - compiled * - adjusted the map of map structure of ConfusionMatrix - compiled * - modified the map of map structure of IntentsEvaluationSummary - compiled * - add 2023-04-01 version information * - added testing json for 2023-04-01 - compiled * - changed all the Azure.Core.Paged to model definition of array and nextLink (String) * - modified the parameter name of some testing json of 2023-04-01 * - deleted the analyzeconversations-authoring folder under example of 2023-04-01 * - modified the name of models to add prefix ConversationAnalysisAuthoring - compiled * - add version 2023-04-15-preview to CustomConversationSummarization of ConversationalAnalysisAuthoringProjectKind - compiled * - changed the way of calling Azure.Core.Foundations.Error to definitions/error - compiled * - changed the appId type to uuid - compiled * - removed maxLength of projectName of ProjecteMetaData - compiled * - added version 2023-04-15-preview to storageInputContainerName of ProjectMetaData * - added Versions 2023_04_15_preview to some properties - compiled * - add Versions v2023_04_15_preview to ConversationalAnalysisAuthoringCreateDeploymentOptions.properties.assignedResourceIds - compiled * - used npx command to fix TypeSpec Validation errors * - fixed TypeSpec Validation - compiled * - made ConversationalAnalysisAuthoringCreateProjectOptions the request payload of the patch CreateProject operation, and made some of the properties optional - compiled * - fixed typespec validation in Language.AnalyzeConversations-authoring - compiled * - modified the titles of each testing json - compiled * - revert to the `main` version package-lock.json and package.json * - modified the title of testing json SuccessfulSwapDeployment - compiled * - used npx tsv command to fix TypeSpec Validation * - added resource template for ProjectMetaData - used ResourceAction and LongRunningResourceAction for Resource ProjectMetaData (Operation authorize-copy and copy) - compiled * - added child Resource ProjectDeployment - implemented Resource ProjectDeployment Template for getDeploymentsList - compiled * - added CopyProjectJobState as child Resource of ProjectMetaData - implemented CopyProjectJobState by ResourceRead - compiled * - completed all the LongRunningResourceAction for resource ProjectMetadata - compiled * - used resource template for resource ProjectDeployment (Child of ProjectMetadata) - used ResourceRead template for resource DeploymentJobState (Child of ProjectDeployment) - compiled * - added operation templates for resource ProjectTrainedModel - compiled * - added some JobState as children of ProjectTrainedModel - used ResourceRead Template for these JobState resource - compiled * - added Resource resources and used some of its resource template - compiled * - add resource "train/jobs" for TrainingJobState - used some resource template of TrainingJobState - compiled * - added DeploymentDeleteFromResourcesJobState and SwapDeploymentsJobState to fix duplicated DeploymentJobState resource issue - compiled * - added two more jobstate ExportProjectJobState and ImportProjectJobState as resource - used ResourceRead template for thess two resources - compiled * - modified the operation name copy to copyProject - added action("copy") for this - compiled * - used npx tsv command to resolve TypeSpec Validation * - removed the "read" for @visibility of JobState.jobId - compiled * - added @actionSeparator("/:") to solve the RemovedPath and AddedPath issue - compiled * - reverted protected files to main version * - removed all the "read" from @visibility in order to remove the readOnly properties in new swagger - compiled * - introduced the low-level LongRunning Operation to remove the status monitor in response - compiled * - removed all the FIXME of utcDateTime properties * - used npx tsv command to resolve TypeSpec Validation * - removed all the prefix of union and make the x-ms-enum same as old version - compiled * - gave concrete example to the uri in SuccessfulGetModelEvaluation testing json, trying to fix Swagger ModelValidation - compiled * - modified the namespace, adding Conversations at the end - compiled --- .../SuccessfulCancelTrainingJob.json | 2 + .../2023-04-01}/SuccessfulCreateProject.json | 2 + .../SuccessfulDeleteDeployment.json | 2 + .../2023-04-01}/SuccessfulDeleteModel.json | 2 + .../2023-04-01}/SuccessfulDeleteProject.json | 2 + .../2023-04-01}/SuccessfulDeployProject.json | 2 + .../2023-04-01}/SuccessfulExportProject.json | 2 + .../2023-04-01}/SuccessfulGetDeployment.json | 2 + .../SuccessfulGetDeploymentStatus.json | 2 + .../2023-04-01/SuccessfulGetExportResult.json | 36 + .../SuccessfulGetExportStatus.json | 2 + .../SuccessfulGetImportStatus.json | 2 + .../SuccessfulGetLoadSnapshotStatus.json | 2 + .../2023-04-01}/SuccessfulGetModel.json | 2 + .../SuccessfulGetModelEvaluation.json | 4 +- .../SuccessfulGetModelEvaluationSummary.json | 2 + .../2023-04-01}/SuccessfulGetProject.json | 2 + .../SuccessfulGetProjectDeletionStatus.json | 2 + .../SuccessfulGetSupportedLanguages.json | 2 + ...uccessfulGetSupportedPrebuiltEntities.json | 2 + ...fulGetSupportedTrainingConfigVersions.json | 2 + .../SuccessfulGetSwapDeploymentsStatus.json | 2 + .../2023-04-01}/SuccessfulGetTrainStatus.json | 2 + .../2023-04-01}/SuccessfulImportProject.json | 2 + .../SuccessfulListDeployments.json | 2 + .../2023-04-01}/SuccessfulListModels.json | 2 + .../2023-04-01}/SuccessfulListProjects.json | 2 + .../SuccessfulListTrainingJobs.json | 2 + .../2023-04-01}/SuccessfulLoadSnapshot.json | 2 + .../SuccessfulSwapDeployments.json | 2 + .../2023-04-01}/SuccessfulTrainProject.json | 2 + .../SuccessfulAssignDeploymentResources.json | 2 + .../SuccessfulCancelTrainingJob.json | 2 + .../SuccessfulCopyProject.json | 2 + .../SuccessfulCopyProjectAuthorization.json | 2 + .../SuccessfulCreateProject.json | 2 + .../SuccessfulDeleteDeployment.json | 2 + ...ccessfulDeleteDeploymentFromResources.json | 2 + .../SuccessfulDeleteModel.json | 2 + .../SuccessfulDeleteProject.json | 2 + .../SuccessfulDeployProject.json | 2 + .../SuccessfulEvaluationProject.json | 2 + .../SuccessfulExportProject.json | 2 + ...ulGetAssignDeploymentResourcesStatus.json} | 2 + .../SuccessfulGetCopyProjectStatus.json | 2 + .../SuccessfulGetDeployment.json | 2 + ...etDeploymentDeleteFromResourcesStatus.json | 24 + .../SuccessfulGetDeploymentStatus.json | 2 + .../SuccessfulGetEvaluationStatus.json | 2 + .../SuccessfulGetExportStatus.json | 2 + .../SuccessfulGetImportStatus.json | 2 + .../SuccessfulGetLoadSnapshotStatus.json | 2 + .../SuccessfulGetModel.json | 2 + .../SuccessfulGetModelEvaluation.json | 4 +- .../SuccessfulGetModelEvaluationSummary.json | 2 + .../SuccessfulGetProject.json | 2 + .../SuccessfulGetProjectDeletionStatus.json | 2 + .../SuccessfulGetSupportedLanguages.json | 2 + ...uccessfulGetSupportedPrebuiltEntities.json | 2 + ...fulGetSupportedTrainingConfigVersions.json | 2 + .../SuccessfulGetSwapDeploymentsStatus.json | 2 + .../SuccessfulGetTrainStatus.json | 2 + ...lGetUnassignDeploymentResourcesStatus.json | 23 + .../SuccessfulImportProject.json | 2 + ...essfulListAssignedResourceDeployments.json | 2 + .../SuccessfulListDeploymentResources.json | 2 + .../SuccessfulListDeployments.json | 2 + .../SuccessfulListModels.json | 2 + .../SuccessfulListProjects.json | 2 + .../SuccessfulListTrainingJobs.json | 2 + .../SuccessfulLoadSnapshot.json | 2 + .../SuccessfulSwapDeployments.json | 2 + .../SuccessfulTrainProject.json | 2 + ...SuccessfulUnassignDeploymentResources.json | 2 + .../main.tsp | 65 + .../models.tsp | 2061 +++++++ .../routes.tsp | 852 +++ .../tspconfig.yaml | 21 + .../analyzeconversations-authoring.json | 4955 ++++++++++------- .../SuccessfulAssignDeploymentResources.json | 31 + .../examples/SuccessfulCancelTrainingJob.json | 18 + .../examples/SuccessfulCopyProject.json | 25 + .../SuccessfulCopyProjectAuthorization.json | 27 + .../examples/SuccessfulCreateProject.json | 46 + .../examples/SuccessfulDeleteDeployment.json | 18 + ...ccessfulDeleteDeploymentFromResources.json | 23 + .../examples/SuccessfulDeleteModel.json | 14 + .../examples/SuccessfulDeleteProject.json | 17 + .../examples/SuccessfulDeployProject.json | 25 + .../examples/SuccessfulEvaluationProject.json | 23 + .../examples/SuccessfulExportProject.json | 18 + ...fulGetAssignDeploymentResourcesStatus.json | 23 + ...on => SuccessfulGetCopyProjectStatus.json} | 2 + .../examples/SuccessfulGetDeployment.json | 34 + ...etDeploymentDeleteFromResourcesStatus.json | 24 + .../SuccessfulGetDeploymentStatus.json | 24 + .../SuccessfulGetEvaluationStatus.json | 34 + .../examples/SuccessfulGetExportStatus.json | 24 + .../examples/SuccessfulGetImportStatus.json | 23 + .../SuccessfulGetLoadSnapshotStatus.json | 24 + .../examples/SuccessfulGetModel.json | 25 + .../SuccessfulGetModelEvaluation.json | 286 + .../SuccessfulGetModelEvaluationSummary.json | 528 ++ .../examples/SuccessfulGetProject.json | 26 + .../SuccessfulGetProjectDeletionStatus.json | 22 + .../SuccessfulGetSupportedLanguages.json | 400 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 100 + ...fulGetSupportedTrainingConfigVersions.json | 24 + .../SuccessfulGetSwapDeploymentsStatus.json | 23 + .../examples/SuccessfulGetTrainStatus.json | 38 + ...lGetUnassignDeploymentResourcesStatus.json | 23 + .../examples/SuccessfulImportProject.json | 80 + ...essfulListAssignedResourceDeployments.json | 28 + .../SuccessfulListDeploymentResources.json | 27 + .../examples/SuccessfulListDeployments.json | 51 + .../examples/SuccessfulListModels.json | 38 + .../examples/SuccessfulListProjects.json | 37 + .../examples/SuccessfulListTrainingJobs.json | 92 + .../examples/SuccessfulLoadSnapshot.json | 18 + .../examples/SuccessfulSwapDeployments.json | 21 + .../examples/SuccessfulTrainProject.json | 27 + ...SuccessfulUnassignDeploymentResources.json | 23 + .../analyzeconversations-authoring.json | 3869 +++++++------ .../examples/SuccessfulCancelTrainingJob.json | 18 + .../examples/SuccessfulCreateProject.json | 46 + .../examples/SuccessfulDeleteDeployment.json | 18 + .../examples/SuccessfulDeleteModel.json | 14 + .../examples/SuccessfulDeleteProject.json | 17 + .../examples/SuccessfulDeployProject.json | 21 + .../examples/SuccessfulExportProject.json | 18 + .../examples/SuccessfulGetDeployment.json | 24 + .../SuccessfulGetDeploymentStatus.json | 24 + .../examples/SuccessfulGetExportStatus.json | 24 + .../examples/SuccessfulGetImportStatus.json | 23 + .../SuccessfulGetLoadSnapshotStatus.json | 24 + .../examples/SuccessfulGetModel.json | 25 + .../SuccessfulGetModelEvaluation.json | 286 + .../SuccessfulGetModelEvaluationSummary.json | 528 ++ .../examples/SuccessfulGetProject.json | 26 + .../SuccessfulGetProjectDeletionStatus.json | 22 + .../SuccessfulGetSupportedLanguages.json | 400 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 100 + ...fulGetSupportedTrainingConfigVersions.json | 24 + .../SuccessfulGetSwapDeploymentsStatus.json | 23 + .../examples/SuccessfulGetTrainStatus.json | 38 + .../examples/SuccessfulImportProject.json | 80 + .../examples/SuccessfulListDeployments.json | 35 + .../examples/SuccessfulListModels.json | 38 + .../examples/SuccessfulListProjects.json | 37 + .../examples/SuccessfulListTrainingJobs.json | 92 + .../examples/SuccessfulLoadSnapshot.json | 18 + .../examples/SuccessfulSwapDeployments.json | 21 + .../examples/SuccessfulTrainProject.json | 27 + 153 files changed, 13011 insertions(+), 3566 deletions(-) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulCancelTrainingJob.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulCreateProject.json (92%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteDeployment.json (80%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteModel.json (68%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeleteProject.json (80%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulDeployProject.json (84%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulExportProject.json (82%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetDeployment.json (85%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetDeploymentStatus.json (84%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetExportStatus.json (87%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetImportStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetLoadSnapshotStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModel.json (85%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModelEvaluation.json (96%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetModelEvaluationSummary.json (99%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetProject.json (86%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetProjectDeletionStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedLanguages.json (98%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedPrebuiltEntities.json (95%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSupportedTrainingConfigVersions.json (75%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetSwapDeploymentsStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulGetTrainStatus.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulImportProject.json (95%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListDeployments.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListModels.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListProjects.json (90%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulListTrainingJobs.json (96%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulLoadSnapshot.json (82%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulSwapDeployments.json (83%) rename specification/cognitiveservices/{data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-01}/SuccessfulTrainProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulAssignDeploymentResources.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCancelTrainingJob.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCopyProject.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCopyProjectAuthorization.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulCreateProject.json (92%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteDeployment.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteDeploymentFromResources.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteModel.json (69%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeleteProject.json (80%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulDeployProject.json (89%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulEvaluationProject.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulExportProject.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json} (79%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetCopyProjectStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetDeployment.json (91%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetDeploymentStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetEvaluationStatus.json (88%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetExportStatus.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetImportStatus.json (84%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetLoadSnapshotStatus.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModel.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModelEvaluation.json (96%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetModelEvaluationSummary.json (99%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetProjectDeletionStatus.json (81%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedLanguages.json (98%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedPrebuiltEntities.json (95%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSupportedTrainingConfigVersions.json (75%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetSwapDeploymentsStatus.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulGetTrainStatus.json (90%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulImportProject.json (95%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListAssignedResourceDeployments.json (79%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListDeploymentResources.json (85%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListDeployments.json (94%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListModels.json (90%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListProjects.json (90%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulListTrainingJobs.json (96%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulLoadSnapshot.json (82%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulSwapDeployments.json (83%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulTrainProject.json (87%) rename specification/cognitiveservices/{data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring => Language.AnalyzeConversations-authoring/examples/2023-04-15-preview}/SuccessfulUnassignDeploymentResources.json (83%) create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp create mode 100644 specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json rename specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/{analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json => SuccessfulGetCopyProjectStatus.json} (83%) create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json index 88fb6767655e..4a5adb1de3cf 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCancelTrainingJob.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json similarity index 92% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json index 98007ecafe72..eb8e9f98c34b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulCreateProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json index 74ba10ef7f11..501a4d76422e 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json similarity index 68% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json index 7aaeb03f6752..d26273b5afc1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json index 86397edb0efc..a3acdc62663c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeleteProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json index c115c10978e7..6126317b23a7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulDeployProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json index 4c84fa0276a7..35a62393cb4b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulExportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json index e90d172ebf9c..67f138a743fc 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json index 6129720003e3..9b395ff4f3e3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetDeploymentStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json new file mode 100644 index 000000000000..7b018cb88759 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportResult.json @@ -0,0 +1,36 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportResult", + "title": "Successful Get Export Result", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "SampleProject", + "jobId": "job12345" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectFileVersion": "1.0.0", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "projectName": "SampleProject", + "language": "en", + "settings": { + "confidenceThreshold": 0.8, + "normalizeCasing": true, + "augmentDiacritics": false + }, + "storageInputContainerName": "project-container", + "multilingual": false, + "description": "Sample project description" + }, + "assets": { + "projectKind": "Conversation" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json index 8e3275eb0950..396fde0729d1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetExportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json index 0554591835a2..4b70711fba95 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetImportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json index dc21261da3bb..52e7fb4e3bfe 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetLoadSnapshotStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json index 30d7b001de6a..5bb2e9921127 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json index 8dc4b6f88e33..4dd48dfb5cc2 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluation.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", @@ -277,7 +279,7 @@ } } ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100" } } } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json similarity index 99% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json index 8fb25eb99c9c..6daf3fcfb0b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetModelEvaluationSummary.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json similarity index 86% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json index 50b53ae6415a..ae7d1bd2b688 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json index 73c8d1cf0647..59061c1f7931 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetProjectDeletionStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json index ed6b0478cdd7..545214c68df8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedLanguages.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json index 7e288d169478..9bea82d1eed2 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedPrebuiltEntities.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 75% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json index 06780f7fa92b..baf3e1d78dfc 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSupportedTrainingConfigVersions.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json index 0aac88c8d145..a904361d0a70 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetSwapDeploymentsStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json index 5f28035def5e..e95467f15ac6 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulGetTrainStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json index 61d70d484c59..3cf13bd844f8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulImportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json index c968d5123219..c92e5ebd7bfe 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json index 0a9e351e22bb..12bc75279ea3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListModels.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json index 8b52f2c1adce..b3e66b3d7364 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListProjects.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json index 5772f4670098..b601958cdf62 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulListTrainingJobs.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json index 9409332d34df..b82ac165a0b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulLoadSnapshot.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json index 5ac2aa6d1bea..305893a716b8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulSwapDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json index a86428a5b7ea..74a43e3c0c8e 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-01/SuccessfulTrainProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json index 4e7006c865d6..b8577067d66b 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulAssignDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json index c2176658ab8c..a87a5e05d24b 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCancelTrainingJob.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json index 07cb874e9f07..3bffe749e1a3 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CopyProject", + "title": "Successful Copy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json index 1edbbf55e89a..559d5a6cbc42 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCopyProjectAuthorization.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json similarity index 92% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json index 86ead630d411..b97424b580db 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulCreateProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json index 84b39ba95dec..f39bc67461ae 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json index 461e83b08f4d..1b5cdb84bc8d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteDeploymentFromResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json similarity index 69% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json index eeeb258682b5..9c02021b969c 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json similarity index 80% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json index 80f1824da7a3..38cc03250ae8 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeleteProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json index 3910787f949e..e50c76314cc4 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulDeployProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json index 7082ccfb9ac4..6671e82372c2 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulEvaluationProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", + "title": "Successful Evaluation Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json index 161bd80214eb..c23a7eeefb98 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulExportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json similarity index 79% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json index aa6548d7266f..79fcbc9ccb39 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json index aa6548d7266f..16ac708cf150 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetCopyProjectStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json similarity index 91% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json index 83e4c0a84d4b..a26e6fe5fad7 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeployment.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..5d0b5e353b44 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json index 78b5d9d10b94..d065933efcbc 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetDeploymentStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json similarity index 88% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json index 41883e8d6fad..42402bfff47f 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetEvaluationStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json index bc0548bdc831..c33e21494512 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetExportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json similarity index 84% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json index be17017d6851..0348df4ec820 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetImportStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json index f23c49aeb135..b462a1000dd2 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetLoadSnapshotStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json index 8f39a1061ba8..f88377461b06 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModel.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json index 808a4b33a079..76875d700b52 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluation.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", @@ -277,7 +279,7 @@ } } ], - "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip=100&maxpagesize=100" } } } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json similarity index 99% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json index 02b7ff45d595..c72f475a6bb0 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetModelEvaluationSummary.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json index 54356dd6a1e8..a94bb114d32d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json similarity index 81% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json index e19af641d407..811552fb4422 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetProjectDeletionStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json index 9d3ff98c1179..7899bc7d77a7 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedLanguages.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json index 085f8653624c..a1e8e439638e 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedPrebuiltEntities.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 75% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json index 3e529aa6e8cf..67633ed31525 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSupportedTrainingConfigVersions.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json index b253ab021bdd..5acc8e3f9682 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetSwapDeploymentsStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json index 38b0ff4f00e9..f906c7ce7db4 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetTrainStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..070f83815b28 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json index 2401bf8e11fe..162fe542788a 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulImportProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json similarity index 79% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json index 3624e3454baa..a6a825669663 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListAssignedResourceDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json similarity index 85% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json index 844b5dc1abce..0d43121bc1b1 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", + "title": "Successful List Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json index 45d74c29ee23..5d285673c9d9 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json index ff63d8e11bee..b8f3ea2f2997 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListModels.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json similarity index 90% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json index c552715ef07a..78aaca5ce95d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListProjects.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json index 52e1310e383e..b09d2909bb85 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulListTrainingJobs.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json similarity index 82% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json index 46dc941317e6..56580a2abafb 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulLoadSnapshot.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json index 4a8d99eed7b3..c1a56e4c4962 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulSwapDeployments.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json similarity index 87% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json index b5ca19f3979f..cb70afa30274 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulTrainProject.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json rename to specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json index 2148033164b5..d2d38edbbc3d 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/examples/2023-04-15-preview/SuccessfulUnassignDeploymentResources.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp new file mode 100644 index 000000000000..5a78591767e3 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/main.tsp @@ -0,0 +1,65 @@ +/** + * PLEASE DO NOT REMOVE - USED FOR CONVERTER METRICS + * Generated by package: @autorest/openapi-to-typespec + * Version: 0.9.0 + * Date: 2024-09-10T19:37:44.296Z + */ +import "@typespec/rest"; +import "@typespec/http"; +import "./routes.tsp"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +/** + * The language service API is a suite of natural language processing (NLP) skills + * built with best-in-class Microsoft machine learning algorithms. The API can be + * used to analyze unstructured text for tasks such as sentiment analysis, key + * phrase extraction, language detection and question answering. Further + * documentation can be found in <a + * href="https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>. + */ +/** The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection. */ +@useAuth( + ApiKeyAuth<ApiKeyLocation.header, "Ocp-Apim-Subscription-Key"> | OAuth2Auth<[ + { + type: OAuth2FlowType.authorizationCode, + authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize", + tokenUrl: "https://login.microsoftonline.com/common/oauth2/token", + scopes: ["https://cognitiveservices.azure.com/.default"], + } + ]> +) +@service({ + title: "Microsoft Cognitive Language Service - Analyze Conversations Authoring", +}) +@versioned(Versions) +@server( + "{Endpoint}/language", + "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.", + { + /** + * Supported Cognitive Services endpoint (e.g., + * https://<resource-name>.api.cognitiveservices.azure.com). + */ + endpoint: string, + + Endpoint: string, + } +) +namespace Language.Authoring.Conversations; + +/** + * The available API versions. + */ +enum Versions { + /** Version 2023-04-01 */ + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_04_01: "2023-04-01", + + /** + * The 2023-04-15-preview API version. + */ + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_04_15_preview: "2023-04-15-preview", +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp new file mode 100644 index 000000000000..f950e7dce494 --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp @@ -0,0 +1,2061 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; + +namespace Language.Authoring.Conversations; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ProjectKind { + string, + + /** + * A project to build natural language into apps, bots, and IoT devices. + */ + Conversation: "Conversation", + + /** + * A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project. + */ + Orchestration: "Orchestration", + + /** + * A project to build conversation summarization models which are able to summarize long conversations. + */ + @added(Versions.v2023_04_15_preview) + CustomConversationSummarization: "CustomConversationSummarization", +} + +/** + * Human-readable error code. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ErrorCode { + string, + InvalidRequest: "InvalidRequest", + InvalidArgument: "InvalidArgument", + Unauthorized: "Unauthorized", + Forbidden: "Forbidden", + NotFound: "NotFound", + ProjectNotFound: "ProjectNotFound", + OperationNotFound: "OperationNotFound", + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + AzureCognitiveSearchIndexNotFound: "AzureCognitiveSearchIndexNotFound", + TooManyRequests: "TooManyRequests", + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + AzureCognitiveSearchIndexLimitReached: "AzureCognitiveSearchIndexLimitReached", + InternalServerError: "InternalServerError", + ServiceUnavailable: "ServiceUnavailable", + Timeout: "Timeout", + QuotaExceeded: "QuotaExceeded", + Conflict: "Conflict", + Warning: "Warning", +} + +/** + * Human-readable error code. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union InnerErrorCode { + string, + InvalidRequest: "InvalidRequest", + InvalidParameterValue: "InvalidParameterValue", + KnowledgeBaseNotFound: "KnowledgeBaseNotFound", + AzureCognitiveSearchNotFound: "AzureCognitiveSearchNotFound", + AzureCognitiveSearchThrottling: "AzureCognitiveSearchThrottling", + ExtractionFailure: "ExtractionFailure", + InvalidRequestBodyFormat: "InvalidRequestBodyFormat", + EmptyRequest: "EmptyRequest", + MissingInputDocuments: "MissingInputDocuments", + InvalidDocument: "InvalidDocument", + ModelVersionIncorrect: "ModelVersionIncorrect", + InvalidDocumentBatch: "InvalidDocumentBatch", + UnsupportedLanguageCode: "UnsupportedLanguageCode", + InvalidCountryHint: "InvalidCountryHint", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union ExportedProjectFormat { + string, + + /** + * Specifies the format for a conversational project. + */ + Conversation: "Conversation", + + /** + * Specifies the format for an application that was exported from LUIS. + */ + Luis: "Luis", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("StringIndexType", "csharp") +union StringIndexType { + string, + + /** + * The offset and length values will correspond to UTF-16 code units. Use this + * option if your application is written in a language that support Unicode, for + * example Java, JavaScript. + */ + Utf16CodeUnit: "Utf16CodeUnit", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union TrainingMode { + string, + + /** + * Trains using fine-tuned neural network transformer models. Can train + * multilingual projects. + */ + advanced: "advanced", + + /** + * Faster training times for quicker iterations. + */ + standard: "standard", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union EvaluationKind { + string, + + /** + * Split the data into training and test sets according to user-defined + * percentages. + */ + percentage: "percentage", + + /** + * Split the data according to the chosen dataset for every example in the data. + */ + manual: "manual", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@lroStatus +union JobStatus { + string, + notStarted: "notStarted", + running: "running", + + @lroSucceeded + succeeded: "succeeded", + + @lroFailed + failed: "failed", + + @lroCanceled + cancelled: "cancelled", + + cancelling: "cancelling", + partiallyCompleted: "partiallyCompleted", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +union CompositionSetting { + string, + + /** + * When two or more components are found in the text and overlap, the component + * with the longest set of characters is returned. + */ + returnLongestOverlap: "returnLongestOverlap", + + /** + * All components must overlap at the exact same characters in the text for the + * entity to return. If one of the defined components is not matched or predicted, + * the entity will not return. + */ + requireExactOverlap: "requireExactOverlap", + + /** + * Every component's match or prediction is returned as a separate instance of the + * entity. + */ + separateComponents: "separateComponents", + + /** + * When two or more components are found in the text and overlap, the components' + * spans are merged together into one span combining all of them. + */ + combineComponents: "combineComponents", +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("OrchestrationTargetProjectKind", "csharp") +union OrchestrationTargetProjectKind { + string, + Luis: "Luis", + Conversation: "Conversation", + QuestionAnswering: "QuestionAnswering", +} + +/** + * Represents a list of retrieved projects' metadata. + */ +@clientName("ProjectsMetadata", "csharp") +model ConversationalAnalysisAuthoringProjectsMetadata { + /** + * The list of projects. + */ + value: ConversationalAnalysisAuthoringProjectMetadata[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the metadata of a project. + */ +@resource("authoring/analyze-conversations/projects") +@clientName("ProjectMetadata", "csharp") +model ConversationalAnalysisAuthoringProjectMetadata { + /** + * Represents the project creation datetime. + */ + createdDateTime: utcDateTime; + + /** + * Represents the project creation datetime. + */ + lastModifiedDateTime: utcDateTime; + + /** + * Represents the project last trained datetime. + */ + lastTrainedDateTime?: utcDateTime; + + /** + * Represents the project last deployed datetime. + */ + lastDeployedDateTime?: utcDateTime; + + /** + * Represents the project kind. + */ + @visibility("create", "read") + projectKind: ProjectKind; + + /** + * The project settings. + */ + @visibility("create", "read") + settings?: ConversationalAnalysisAuthoringProjectSettings; + + /** + * The storage container name in case of conversation summarization. + */ + @visibility("create", "read") + @added(Versions.v2023_04_15_preview) + storageInputContainerName?: string; + + /** + * The new project name. + */ + @key("projectName") + @visibility("create", "read") + @maxLength(100) + projectName: string; + + /** + * Whether the project would be used for multiple languages or not. + */ + @visibility("create", "read") + multilingual?: boolean; + + /** + * The project description. + */ + @visibility("create", "read") + description?: string; + + /** + * The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + @visibility("create", "read") + language: string; +} + +/** + * Represents the settings used to define the project behavior. + */ +@clientName("ProjectSettings", "csharp") +model ConversationalAnalysisAuthoringProjectSettings { + /** + * The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. + */ + confidenceThreshold: float32; +} + +/** + * Error response. + */ +@error +model ErrorResponse { + /** + * The error object. + */ + error: Error; +} + +/** + * The error object. + */ +model Error { + /** + * One of a server-defined set of error codes. + */ + code: ErrorCode; + + /** + * A human-readable representation of the error. + */ + message: string; + + /** + * The target of the error. + */ + target?: string; + + /** + * An array of details about specific errors that led to this reported error. + */ + details?: Error[]; + + /** + * An object containing more specific information than the current object about + * the error. + */ + innererror?: InnerErrorModel; +} + +/** + * An object containing more specific information about the error. As per + * Microsoft One API guidelines - + * https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. + */ +model InnerErrorModel { + /** + * One of a server-defined set of error codes. + */ + code: InnerErrorCode; + + /** + * Error message. + */ + message: string; + + /** + * Error details. + */ + details?: Record<string>; + + /** + * Error target. + */ + target?: string; + + /** + * An object containing more specific information than the current object about + * the error. + */ + innererror?: InnerErrorModel; +} + +/** + * Represents the options used to create or update a project. + */ +@clientName("CreateProjectOptions", "csharp") +model ConversationalAnalysisAuthoringCreateProjectOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The project settings. + */ + settings?: ConversationalAnalysisAuthoringProjectSettings; + + /** + * The storage container name in case of conversation summarization. + */ + @added(Versions.v2023_04_15_preview) + storageInputContainerName?: string; + + /** + * The new project name. + */ + projectName: string; + + /** + * Whether the project would be used for multiple languages or not. + */ + multilingual?: boolean; + + /** + * The project description. + */ + description?: string; + + /** + * The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + language: string; +} + +/** + * Represents the options for authorizing a project copy to the current Azure resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyAuthorizationOptions", "csharp") +model ConversationalAnalysisAuthoringCopyAuthorizationOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The name of the storage container. + */ + storageInputContainerName?: string; + + /** + * Whether to allow an existing project to be overwritten using the resulting copy authorization. + */ + allowOverwrite?: boolean; +} + +/** + * Represents the options for copying an existing project to another Azure + * resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyProjectOptions", "csharp") +model ConversationalAnalysisAuthoringCopyProjectOptions { + /** + * Represents the project kind. + */ + projectKind: ProjectKind; + + /** + * The project name to be copied-into. + */ + targetProjectName: string; + + /** + * The access token. + */ + accessToken: string; + + /** + * The expiration of the access token. + */ + expiresAt: utcDateTime; + + /** + * Represents the target Azure resource ID. + */ + targetResourceId: string; + + /** + * Represents the target Azure resource region. + */ + targetResourceRegion: string; +} + +/** + * Represents an exported project. + */ +@clientName("ExportedProject", "csharp") +model ConversationalAnalysisAuthoringExportedProject { + /** + * The version of the exported file. + */ + projectFileVersion: string; + + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + stringIndexType: StringIndexType; + + /** + * Represents the project metadata. + */ + metadata: ConversationalAnalysisAuthoringCreateProjectOptions; + + /** + * Represents the project assets. + */ + assets?: ConversationalAnalysisAuthoringExportedProjectAssets; +} + +/** + * Represents the assets of an exported project. + */ +@discriminator("projectKind") +@clientName("ExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * The type of project containing the assets. + */ + projectKind: ProjectKind; +} + +/** + * Represents the options for starting a new training job. + */ +@clientName("TrainingJobOptions", "csharp") +model ConversationalAnalysisAuthoringTrainingJobOptions { + /** + * Represents the output model label. + */ + modelLabel: string; + + /** + * Represents training config version. By default, "latest" value is used which + * uses the latest released training config version. + */ + trainingConfigVersion?: string; + + /** + * Represents the mode of the training operation. + */ + trainingMode: TrainingMode; + + /** + * Represents the evaluation options. By default, the evaluation kind is + * percentage, with training split percentage as 80, and testing split percentage + * as 20. + */ + evaluationOptions?: ConversationalAnalysisAuthoringEvaluationOptions; +} + +/** + * Represents the options used running the evaluation. + */ +@clientName("EvaluationOptions", "csharp") +model ConversationalAnalysisAuthoringEvaluationOptions { + /** + * Represents the evaluation kind. By default, the evaluation kind is set to + * percentage. + */ + kind?: EvaluationKind; + + /** + * Represents the training dataset split percentage. Only needed in case the + * evaluation kind is percentage. + */ + trainingSplitPercentage?: int32; + + /** + * Represents the testing dataset split percentage. Only needed in case the + * evaluation kind is percentage. + */ + testingSplitPercentage?: int32; +} + +/** + * Represents the state of a copy job. + */ +@added(Versions.v2023_04_15_preview) +@clientName("CopyProjectJobState", "csharp") +@resource("copy/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringCopyProjectJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a job's state. + */ +@clientName("JobState", "csharp") +model ConversationalAnalysisAuthoringJobState { + /** + * The job ID. + */ + @key("jobId") + @visibility + jobId: string; + + /** + * The creation date time of the job. + */ + createdDateTime: utcDateTime; + + /** + * The last date time the job was updated. + */ + lastUpdatedDateTime: utcDateTime; + + /** + * The expiration date time of the job. + */ + expirationDateTime?: utcDateTime; + + /** + * The job status. + */ + status: JobStatus; + + /** + * The warnings that were encountered while executing the job. + */ + warnings?: Warning[]; + + /** + * The errors encountered while executing the job. + */ + errors?: Error[]; +} + +/** + * Represents a warning that was encountered while executing the request. + */ +model Warning { + /** + * The warning code. + */ + code: string; + + /** + * The warning message. + */ + message: string; +} + +/** + * Represents a list of retrieved deployments. + */ +@clientName("ProjectDeployments", "csharp") +model ConversationalAnalysisAuthoringProjectDeployments { + /** + * The list of retrieved deployments. + */ + value: ConversationalAnalysisAuthoringProjectDeployment[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a project deployment. + */ +@clientName("ProjectDeployment", "csharp") +@resource("deployments") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringProjectDeployment { + /** + * Represents deployment name. + */ + @key("deploymentName") + @visibility + deploymentName: string; + + /** + * Represents deployment modelId. + */ + modelId: string; + + /** + * Represents deployment last trained time. + */ + lastTrainedDateTime: utcDateTime; + + /** + * Represents deployment last deployed time. + */ + lastDeployedDateTime: utcDateTime; + + /** + * Represents deployment expiration date in the runtime. + */ + deploymentExpirationDate: plainDate; + + /** + * Represents model training config version. + */ + modelTrainingConfigVersion: string; + + /** + * Represents the metadata of the assigned Azure resources. + */ + @added(Versions.v2023_04_15_preview) + assignedResources: ConversationalAnalysisAuthoringDeploymentResource[]; +} + +/** + * Represents an Azure resource assigned to a deployment. + */ +@clientName("DeploymentResource", "csharp") +model ConversationalAnalysisAuthoringDeploymentResource { + /** + * Represents the Azure resource Id. + */ + resourceId: string; + + /** + * Represents the resource region. + */ + region: string; +} + +/** + * Represents the options for creating or updating a project deployment. + */ +@clientName("CreateDeploymentOptions", "csharp") +model ConversationalAnalysisAuthoringCreateDeploymentOptions { + /** + * Represents the trained model label. + */ + trainedModelLabel: string; + + /** + * Represents the resource IDs to be assigned to the deployment. + * If provided, the deployment will be rolled out to the resources + * provided here as well as the original resource in which the project is created. + */ + @added(Versions.v2023_04_15_preview) + assignedResourceIds?: string[]; +} + +/** + * Represents the options for deleting a project deployment. + */ +@clientName("DeleteDeploymentOptions", "csharp") +model ConversationalAnalysisAuthoringDeleteDeploymentOptions { + /** + * Represents the resource IDs to delete the deployment from. + * If not provided, the deployment will be rolled out from all the + * resources it is deployed to. + * If provided, it will delete the deployment only from the specified + * assigned resources, and leave it for the rest. + */ + assignedResourceIds?: string[]; +} + +/** + * Represents the state of a deployment job. + */ +@clientName("DeploymentJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectDeployment) +@resource("jobs") +model ConversationalAnalysisAuthoringDeploymentJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the state of an existing delete deployment from specific resources job. + */ +@clientName("DeploymentDeleteFromResourcesJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectDeployment) +@resource("delete-from-resources/jobs") +model ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the state of a deployment job. + */ +@clientName("SwapDeploymentsJobState", "csharp") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +@resource("deployments/swap/jobs") +model ConversationalAnalysisAuthoringSwapDeploymentsJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the options for swapping two deployments together. + */ +@clientName("SwapDeploymentsOptions", "csharp") +model ConversationalAnalysisAuthoringSwapDeploymentsOptions { + /** + * Represents the first deployment name. + */ + firstDeploymentName: string; + + /** + * Represents the second deployment name. + */ + secondDeploymentName: string; +} + +/** + * Represents the state of an export job. + */ +@clientName("ExportProjectJobState", "csharp") +@resource("export/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringExportProjectJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * The URL to use in order to download the exported project. + */ + resultUrl?: string; +} + +/** + * Represents the state of an import job. + */ +@clientName("ImportProjectJobState", "csharp") +@resource("import/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringImportProjectJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a list of retrieved trained models. + */ +@clientName("ProjectTrainedModels", "csharp") +model ConversationalAnalysisAuthoringProjectTrainedModels { + /** + * The list of trained models. + */ + value: ConversationalAnalysisAuthoringProjectTrainedModel[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a trained model. + */ +@clientName("ProjectTrainedModel", "csharp") +@resource("models") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringProjectTrainedModel { + /** + * The trained model label. + */ + @key("trainedModelLabel") + @visibility + label: string; + + /** + * The model ID. + */ + modelId: string; + + /** + * The last trained date time of the model. + */ + lastTrainedDateTime: utcDateTime; + + /** + * The duration of the model's last training request in seconds. + */ + lastTrainingDurationInSeconds: int32; + + /** + * The model expiration date. + */ + modelExpirationDate: plainDate; + + /** + * The model training config version. + */ + modelTrainingConfigVersion: string; + + /** + * The flag to indicate if the trained model has a snapshot ready. + */ + hasSnapshot: boolean; +} + +/** + * Represents the state of a evaluation job. + */ +@clientName("EvaluationJobState", "csharp") +@resource("evaluate/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringEvaluationJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * Represents evaluation task detailed result. + */ + result: ConversationalAnalysisAuthoringEvaluationJobResult; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("EvaluationJobResult", "csharp") +model ConversationalAnalysisAuthoringEvaluationJobResult { + /** + * Represents the options used running the evaluation. + */ + evaluationOptions: ConversationalAnalysisAuthoringEvaluationOptions; + + /** + * Represents trained model label. + */ + modelLabel: string; + + /** + * Represents training config version. + */ + trainingConfigVersion: string; + + /** + * Represents progress percentage. + */ + percentComplete: int32; +} + +/** + * Represent a list of utterances' evaluation results. + */ +@clientName("EvaluationResults", "csharp") +model ConversationalAnalysisAuthoringEvaluationResults { + /** + * The utterances evaluation results. + */ + value: ConversationalAnalysisAuthoringUtteranceEvaluationResult[]; + + /** + * The next page link. + */ + nextLink: string; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +model StringIndexTypeQueryParameter { + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + @query("stringIndexType") + stringIndexType: StringIndexType; +} + +/** + * Represents the evaluation result for an utterance. + */ +@clientName("UtteranceEvaluationResult", "csharp") +@resource("evaluation/result") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringUtteranceEvaluationResult { + /** + * Represents the utterance text. + */ + @key + @visibility + text: string; + + /** + * Represents the utterance language. This is BCP-47 representation of a language. + * For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish + * etc. + */ + language: string; + + /** + * Represents the entities results for the utterance. + */ + entitiesResult: ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult; + + /** + * Represents the intents results for the utterance. + */ + intentsResult: ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult; +} + +/** + * Represents the comparison between the expected and predicted entities for an + * utterance. + */ +@clientName("UtteranceEntitiesEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult { + /** + * Represents the expected entity labels. + */ + expectedEntities: ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]; + + /** + * Represents the predicted entity labels. + */ + predictedEntities: ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]; +} + +/** + * Represents the evaluation output of an entity label or prediction. + */ +@clientName("UtteranceEntityEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult { + /** + * Represents the entity category. + */ + category: string; + + /** + * Represents the entity offset index relative to the original text. + */ + offset: int32; + + /** + * Represents the entity length. + */ + length: int32; +} + +/** + * Represents the comparison between the expected and the predicted intent for an + * utterance. + */ +@clientName("UtteranceIntentsEvaluationResult", "csharp") +model ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult { + /** + * Represents the utterance's expected intent. + */ + expectedIntent: string; + + /** + * Represents the utterance's predicted intent. + */ + predictedIntent: string; +} + +/** + * Represents the evaluation result summary. + */ +@clientName("EvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEvaluationSummary { + /** + * Contains the data related to entities evaluation. + */ + entitiesEvaluation: ConversationalAnalysisAuthoringEntitiesEvaluationSummary; + + /** + * Contains the data related to intents evaluation. + */ + intentsEvaluation: ConversationalAnalysisAuthoringIntentsEvaluationSummary; + + /** + * The options that were used while running the evaluation. + */ + evaluationOptions?: ConversationalAnalysisAuthoringEvaluationOptions; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConfusionMatrix", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrix + is Record<ConversationalAnalysisAuthoringConfusionMatrixRow>; + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConfusionMatrixRow", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrixRow + is Record<ConversationalAnalysisAuthoringConfusionMatrixCell>; + +/** + * Represents the evaluation result summary for the project's entities. + */ +@clientName("EntitiesEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEntitiesEvaluationSummary { + /** + * Represents the confusion matrix between two entities (the two entities can be + * the same). The matrix is between the entity that was labelled and the entity + * that was predicted. + */ + confusionMatrix: ConversationalAnalysisAuthoringConfusionMatrix; + + /** + * Represents the entities evaluation summary. + */ + entities: Record<ConversationalAnalysisAuthoringEntityEvaluationSummary>; + + /** + * Represents the micro F1. Expected value is a float between 0 and 1 inclusive. + */ + microF1: float32; + + /** + * Represents the micro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + microPrecision: float32; + + /** + * Represents the micro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + microRecall: float32; + + /** + * Represents the macro F1. Expected value is a float between 0 and 1 inclusive. + */ + macroF1: float32; + + /** + * Represents the macro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + macroPrecision: float32; + + /** + * Represents the macro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + macroRecall: float32; +} + +/** + * Represents a cell in a confusion matrix. + */ +@clientName("ConfusionMatrixCell", "csharp") +model ConversationalAnalysisAuthoringConfusionMatrixCell { + /** + * Represents normalized value in percentages. + */ + normalizedValue: float32; + + /** + * Represents raw value. + */ + rawValue: float32; +} + +/** + * Represents the evaluation result for an entity. + */ +@clientName("EntityEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringEntityEvaluationSummary { + /** + * Represents the model precision + */ + f1: float64; + + /** + * Represents the model recall + */ + precision: float64; + + /** + * Represents the model F1 score + */ + recall: float64; + + /** + * Represents the count of true positive + */ + truePositiveCount: int32; + + /** + * Represents the count of true negative + */ + trueNegativeCount: int32; + + /** + * Represents the count of false positive + */ + falsePositiveCount: int32; + + /** + * Represents the count of false negative + */ + falseNegativeCount: int32; +} + +/** + * Represents the evaluation summary for the project's intents. + */ +@clientName("IntentsEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringIntentsEvaluationSummary { + /** + * Represents the confusion matrix between two intents (the two intents can be the + * same). The matrix is between the intent that was labelled and the intent that + * was predicted. + */ + confusionMatrix: ConversationalAnalysisAuthoringConfusionMatrix; + + /** + * Represents the intents evaluation summary. + */ + intents: Record<ConversationalAnalysisAuthoringIntentEvaluationSummary>; + + /** + * Represents the micro F1. Expected value is a float between 0 and 1 inclusive. + */ + microF1: float32; + + /** + * Represents the micro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + microPrecision: float32; + + /** + * Represents the micro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + microRecall: float32; + + /** + * Represents the macro F1. Expected value is a float between 0 and 1 inclusive. + */ + macroF1: float32; + + /** + * Represents the macro precision. Expected value is a float between 0 and 1 + * inclusive. + */ + macroPrecision: float32; + + /** + * Represents the macro recall. Expected value is a float between 0 and 1 + * inclusive. + */ + macroRecall: float32; +} + +/** + * The evaluation summary for an intent. + */ +@clientName("IntentEvaluationSummary", "csharp") +model ConversationalAnalysisAuthoringIntentEvaluationSummary { + /** + * Represents the model precision + */ + f1: float64; + + /** + * Represents the model recall + */ + precision: float64; + + /** + * Represents the model F1 score + */ + recall: float64; + + /** + * Represents the count of true positive + */ + truePositiveCount: int32; + + /** + * Represents the count of true negative + */ + trueNegativeCount: int32; + + /** + * Represents the count of false positive + */ + falsePositiveCount: int32; + + /** + * Represents the count of false negative + */ + falseNegativeCount: int32; +} + +/** + * Represents the state of loading a snapshot job. + */ +@clientName("LoadSnapshotJobState", "csharp") +@resource("load-snapshot/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectTrainedModel) +model ConversationalAnalysisAuthoringLoadSnapshotJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the assigned deployment resources. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedDeploymentResources", "csharp") +model ConversationalAnalysisAuthoringAssignedDeploymentResources { + /** + * The list of assigned deployment resources. + */ + value: ConversationalAnalysisAuthoringAssignedDeploymentResource[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the assigned deployment resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedDeploymentResource", "csharp") +@resource("resources") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringAssignedDeploymentResource { + /** + * The resource ID. + */ + @key + @visibility + azureResourceId: string; + + /** + * The resource region. + */ + region: string; +} + +/** + * Represents the options for assigning Azure resources to a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignDeploymentResourcesOptions", "csharp") +model ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions { + /** + * Represents the metadata for the resources to be assigned. + */ + resourcesMetadata: ConversationalAnalysisAuthoringResourceMetadata[]; +} + +/** + * Represents metadata for the Azure resource.. + */ +@clientName("ResourceMetadata", "csharp") +model ConversationalAnalysisAuthoringResourceMetadata { + /** + * Represents the Azure resource ID. + */ + azureResourceId: string; + + /** + * Represents the Azure resource custom domain. + */ + customDomain: string; + + /** + * Represents the Azure resource region. + */ + region: string; +} + +/** + * Represents the options to unassign Azure resources from a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("UnassignDeploymentResourcesOptions", "csharp") +model ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions { + /** + * Represents the assigned resource IDs to be unassigned. + */ + assignedResourceIds: string[]; +} + +/** + * Represents the state of a deployment resources job. + */ +@added(Versions.v2023_04_15_preview) +@clientName("DeploymentResourcesJobState", "csharp") +@resource("resources/assign/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringDeploymentResourcesJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents a list of retrieved training jobs. + */ +@clientName("TrainingJobs", "csharp") +model ConversationalAnalysisAuthoringTrainingJobs { + /** + * The list of jobs. + */ + value: ConversationalAnalysisAuthoringTrainingJobState[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the state of a training job. + */ +@clientName("TrainingJobState", "csharp") +@resource("train/jobs") +@parentResource(ConversationalAnalysisAuthoringProjectMetadata) +model ConversationalAnalysisAuthoringTrainingJobState { + ...ConversationalAnalysisAuthoringJobState; + + /** + * Represents training tasks detailed result. + */ + result: ConversationalAnalysisAuthoringTrainingJobResult; +} + +/** + * Represents the output of a training job. + */ +@clientName("TrainingJobResult", "csharp") +model ConversationalAnalysisAuthoringTrainingJobResult { + /** + * Represents trained model label. + */ + modelLabel: string; + + /** + * Represents training config version. + */ + trainingConfigVersion: string; + + /** + * Represents the mode of the training operation. + */ + trainingMode?: TrainingMode; + + /** + * Represents the model training status. + */ + trainingStatus: ConversationalAnalysisAuthoringSubTrainingJobState; + + /** + * Represents model evaluation status. + */ + evaluationStatus?: ConversationalAnalysisAuthoringSubTrainingJobState; + + /** + * Represents the estimated end date time for training and evaluation. + */ + estimatedEndDateTime?: utcDateTime; +} + +/** + * Represents the detailed state of a training sub-operation. + */ +@clientName("SubTrainingJobState", "csharp") +model ConversationalAnalysisAuthoringSubTrainingJobState { + /** + * Represents progress percentage. + */ + percentComplete: int32; + + /** + * Represents the start date time. + */ + startDateTime?: utcDateTime; + + /** + * Represents the end date time. + */ + endDateTime?: utcDateTime; + + /** + * Represents the status of the sub-operation. + */ + status: JobStatus; +} + +/** + * Represents the state of a project deletion job. + */ +@clientName("ProjectDeletionJobState", "csharp") +model ConversationalAnalysisAuthoringProjectDeletionJobState { + ...ConversationalAnalysisAuthoringJobState; +} + +/** + * Represents the metadata for deployments assigned to a resource. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedResourceDeploymentsMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata { + /** + * The list of retrieved assigned project deployments. + */ + value: ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents the metadata for assigned deployments for a project. + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedProjectDeploymentsMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata { + /** + * Represents the project name. + */ + projectName: string; + + /** + * Represents the resource region. + */ + deploymentsMetadata: ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata[]; +} + +/** + * Represents the metadata for an assigned deployment + */ +@added(Versions.v2023_04_15_preview) +@clientName("AssignedProjectDeploymentMetadata", "csharp") +model ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata { + /** + * Represents the deployment name. + */ + deploymentName: string; + + /** + * Represents deployment last deployed time. + */ + lastDeployedDateTime: utcDateTime; + + /** + * Represents deployment expiration date in the runtime. + */ + deploymentExpirationDate: plainDate; +} + +/** + * Represents a list of retrieved languages. + */ +@clientName("SupportedLanguages", "csharp") +model ConversationalAnalysisAuthoringSupportedLanguages { + /** + * The list of the languages. + */ + value: ConversationalAnalysisAuthoringSupportedLanguage[]; + + /** + * The next page link. + */ + nextLink?: string; +} +/** + * Represents a supported language. + */ +@clientName("SupportedLanguage", "csharp") +model ConversationalAnalysisAuthoringSupportedLanguage { + /** + * The language name. + */ + languageName: string; + + /** + * The language code. This is BCP-47 representation of a language. For example, + * "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + languageCode: string; +} + +/** + * Represents a list of the retrieved supported prebuilt entities. + */ +@clientName("PrebuiltEntities", "csharp") +model ConversationalAnalysisAuthoringPrebuiltEntities { + /** + * The supported prebuilt entities. + */ + value: ConversationalAnalysisAuthoringPrebuiltEntity[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a supported prebuilt entity. + */ +@clientName("PrebuiltEntity", "csharp") +model ConversationalAnalysisAuthoringPrebuiltEntity { + /** + * The prebuilt entity category. + */ + category: string; + + /** + * The description. + */ + description: string; + + /** + * English examples for the entity. + */ + examples: string; +} + +/** + * Represents a list of training config versions. + */ +@clientName("TrainingConfigVersions", "csharp") +model ConversationalAnalysisAuthoringTrainingConfigVersions { + /** + * The list of the training config versions. + */ + value: ConversationalAnalysisAuthoringTrainingConfigVersion[]; + + /** + * The next page link. + */ + nextLink?: string; +} + +/** + * Represents a training config version. + */ +@clientName("TrainingConfigVersion", "csharp") +model ConversationalAnalysisAuthoringTrainingConfigVersion { + /** + * Represents the version of the config. + */ + trainingConfigVersion: string; + + /** + * Represents the training config version expiration date. + */ + modelExpirationDate: plainDate; +} + +/** + * Represents an entity with its components. + */ +@clientName("ConversationExportedEntity", "csharp") +model ConversationalAnalysisAuthoringConversationExportedEntity { + /** + * The category of the entity. + */ + category: string; + + /** + * The behavior to follow when the entity's components overlap with each other. + */ + compositionSetting?: CompositionSetting; + + /** + * The list component of the entity. + */ + list?: ConversationalAnalysisAuthoringExportedEntityList; + + /** + * The prebuilt entities components. + */ + prebuilts?: ConversationalAnalysisAuthoringExportedPrebuiltEntity[]; + + /** + * The regex component of the entity. + */ + regex?: ConversationalAnalysisAuthoringExportedEntityRegex; + + /** + * The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'. + */ + requiredComponents?: string[]; +} + +/** + * Represents a list component of an entity. + */ +@clientName("ExportedEntityList", "csharp") +model ConversationalAnalysisAuthoringExportedEntityList { + /** + * The sub-lists of the list component. + */ + sublists?: ConversationalAnalysisAuthoringExportedEntitySublist[]; +} + +/** + * Represents a sub-list inside a list component. + */ +@clientName("ExportedEntitySublist", "csharp") +model ConversationalAnalysisAuthoringExportedEntitySublist { + /** + * The key of the sub-list. + */ + listKey?: string; + + /** + * The phrases of that correspond to the sub-list. + */ + synonyms?: ConversationalAnalysisAuthoringExportedEntityListSynonym[]; +} + +/** + * Represents a list of synonyms inside a list component + */ +@clientName("ExportedEntityListSynonym", "csharp") +model ConversationalAnalysisAuthoringExportedEntityListSynonym { + /** + * Represents the language of the synonyms. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The list of synonyms. + */ + values?: string[]; +} + +/** + * Represents an exported prebuilt entity component + */ +@clientName("ExportedPrebuiltEntity", "csharp") +model ConversationalAnalysisAuthoringExportedPrebuiltEntity { + /** + * The prebuilt entity category. + */ + category: string; +} + +/** + * Represents a regex component of an entity. + */ +@clientName("ExportedEntityRegex", "csharp") +model ConversationalAnalysisAuthoringExportedEntityRegex { + /** + * The regex expressions of the regex component. These expressions follow the .NET + * regex syntax. For reference, check here: + * https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions + */ + expressions?: ConversationalAnalysisAuthoringExportedEntityRegexExpression[]; +} + +/** + * Represents a regex expression inside a regex component. This expression follows + * the .NET regex syntax. For reference, check here: + * https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions + */ +@clientName("ExportedEntityRegexExpression", "csharp") +model ConversationalAnalysisAuthoringExportedEntityRegexExpression { + /** + * The key of the regex expression. + */ + regexKey?: string; + + /** + * Represents the language of the regex expression. This is BCP-47 representation + * of a language. For example, use "en" for English, "en-gb" for English (UK), + * "es" for Spanish etc. + */ + language?: string; + + /** + * The regex pattern. + */ + regexPattern?: string; +} + +/** + * Represents an exported intent of a conversational project. + */ +@clientName("ConversationExportedIntent", "csharp") +model ConversationalAnalysisAuthoringConversationExportedIntent { + /** + * The intent category. + */ + category: string; +} + +/** + * Represents the exported assets of a conversational project. + */ +@clientName("ConversationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringConversationExportedProjectAssets + extends ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * The intents defined in the project. + */ + intents?: ConversationalAnalysisAuthoringConversationExportedIntent[]; + + /** + * The entities defined in the project. + */ + entities?: ConversationalAnalysisAuthoringConversationExportedEntity[]; + + /** + * The utterances defined in the project. + */ + utterances?: ConversationalAnalysisAuthoringConversationExportedUtterance[]; + + /** + * The type of project containing the assets. + */ + projectKind: "Conversation"; +} + +/** + * Represents an exported utterance for a conversational project. + */ +@clientName("ConversationExportedUtterance", "csharp") +model ConversationalAnalysisAuthoringConversationExportedUtterance { + /** + * Represents the entity labels of the utterance. + */ + entities?: ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]; + + /** + * The utterance text. + */ + text: string; + + /** + * Represents the utterance's language. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The intent of the utterance. + */ + intent: string; + + /** + * The dataset for this utterance. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} + +/** + * Represents an entity label for an utterance. + */ +@clientName("ExportedUtteranceEntityLabel", "csharp") +model ConversationalAnalysisAuthoringExportedUtteranceEntityLabel { + /** + * The category of the entity label. + */ + category: string; + + /** + * Start position for the entity text. + */ + offset: int32; + + /** + * Length for the entity text. + */ + length: int32; +} + +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("ConversationSummarizationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets { + /** + * Represents the conversations of the project. + */ + conversations?: ConversationalAnalysisAuthoringCustomConversationSummarizationConversation[]; +} + +/** + * Represents an exported conversation for a custom conversation summarization. + */ +#suppress "@azure-tools/typespec-azure-core/documentation-required" +@clientName("CustomConversationSummarizationConversation", "csharp") +model ConversationalAnalysisAuthoringCustomConversationSummarizationConversation { + summaryLocation?: string; + + /** + * Represents the conversation file location in the blob store container + * associated with the project. + */ + location: string; + + /** + * Represents the language. This is BCP-47 representation of a language. For + * example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + language?: string; + + /** + * The dataset for this conversation. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} + +/** + * Defines the orchestration details for a Conversational project target. + */ +@clientName("ExportedConversationOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedConversationOrchestration { + /** + * The name of the targeted project. + */ + projectName: string; + + /** + * The name of the targeted deployment. + */ + deploymentName: string; +} + +/** + * Represents the orchestration options for a Conversational project target. + */ +@clientName("ExportedConversationOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The Conversational project target details. + */ + conversationOrchestration: ConversationalAnalysisAuthoringExportedConversationOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "Conversation"; +} + +/** + * Represents the options used to define the orchestration behavior of an intent. + */ +@discriminator("targetProjectKind") +@clientName("ExportedOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedOrchestrationOptions { + targetProjectKind: OrchestrationTargetProjectKind; +} + +/** + * Defines the orchestration details for a LUIS application target. + */ +@clientName("ExportedLuisOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedLuisOrchestration { + /** + * The LUIS application ID. + */ + appId: uuid; + + /** + * The targeted version Id. + */ + appVersion?: string; + + /** + * The targeted slot name. + */ + slotName?: string; +} + +/** + * Represents the orchestration options for a LUIS application target. + */ +@clientName("ExportedLuisOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The LUIS application target details. + */ + luisOrchestration: ConversationalAnalysisAuthoringExportedLuisOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "Luis"; +} + +/** + * Defines the orchestration details for a Question Answering project target. + */ +@clientName("ExportedQuestionAnsweringOrchestration", "csharp") +model ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration { + /** + * The name of the target project. + */ + projectName: string; +} + +/** + * Represents the orchestration options for a Question Answering project target. + */ +@clientName("ExportedQuestionAnsweringOrchestrationOptions", "csharp") +model ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions + extends ConversationalAnalysisAuthoringExportedOrchestrationOptions { + /** + * The Question Answering project details. + */ + questionAnsweringOrchestration: ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration; + + /** + * The kind of the target used in the orchestration flow. + */ + targetProjectKind: "QuestionAnswering"; +} + +/** + * Represents an exported intent for an orchestration project. + */ +@clientName("OrchestrationExportedIntent", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedIntent { + /** + * Specifies the behavior of this intent in the orchestration flow. + */ + orchestration?: ConversationalAnalysisAuthoringExportedOrchestrationOptions; + + /** + * The intent category. + */ + category: string; +} + +/** + * Represents the assets of an orchestration project. + */ +@clientName("OrchestrationExportedProjectAssets", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets + extends ConversationalAnalysisAuthoringExportedProjectAssets { + /** + * Represents the intents of the project. + */ + intents?: ConversationalAnalysisAuthoringOrchestrationExportedIntent[]; + + /** + * Represents the utterances of the project. + */ + utterances?: ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]; + + /** + * The type of project containing the assets. + */ + projectKind: "Orchestration"; +} + +/** + * Represents an utterance of an orchestration project. + */ +@clientName("OrchestrationExportedUtterance", "csharp") +model ConversationalAnalysisAuthoringOrchestrationExportedUtterance { + /** + * The utterance text. + */ + text: string; + + /** + * Represents the utterance's language. This is BCP-47 representation of a + * language. For example, use "en" for English, "en-gb" for English (UK), "es" for + * Spanish etc. + */ + language?: string; + + /** + * The intent of the utterance. + */ + intent: string; + + /** + * The dataset for this utterance. Allowed values are 'Train' and 'Test'. + */ + dataset?: string; +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp new file mode 100644 index 000000000000..4c0e4621b32f --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp @@ -0,0 +1,852 @@ +import "@azure-tools/typespec-azure-core"; +import "@typespec/rest"; +import "./models.tsp"; +import "@typespec/http"; +import "@typespec/versioning"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using Azure.Core; +using Azure.Core.Traits; +using Azure.ClientGenerator.Core; +using TypeSpec.Versioning; + +namespace Language.Authoring.Conversations; + +alias ServiceTraits = NoRepeatableRequests & + NoConditionalRequests & + NoClientRequestId; + +alias languageOperations = ResourceOperations<ServiceTraits, ErrorResponse>; + +interface ConversationalAnalysisAuthoring { + /** + * Lists the existing projects. + */ + listProjects is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectMetadata, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the details of a project. + */ + getProject is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectMetadata>; + + /** + * Creates a new project or updates an existing one. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Need to rename the body" + @createsOrUpdatesResource(ConversationalAnalysisAuthoringProjectMetadata) + @parameterVisibility + @patch + createProject is Foundations.ResourceOperation< + ConversationalAnalysisAuthoringProjectMetadata, + { + @doc("This request has a JSON Merge Patch body.") + @TypeSpec.Http.header("Content-Type") + contentType: "application/merge-patch+json"; + + /** The request body */ + @bodyRoot body: ConversationalAnalysisAuthoringCreateProjectOptions; + }, + Foundations.ResourceCreatedOrOkResponse<ConversationalAnalysisAuthoringProjectMetadata>, + {}, + ErrorResponse + >; + + /** + * Deletes a project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}") + @delete + @pollingOperation(ConversationalAnalysisAuthoring.getProjectDeletionStatus) + deleteProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Generates a copy project operation authorization to the current target Azure + * resource. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @post + @added(Versions.v2023_04_15_preview) + @actionSeparator("/:") + @action("authorize-copy") + copyProjectAuthorization is languageOperations.ResourceAction< + ConversationalAnalysisAuthoringProjectMetadata, + ConversationalAnalysisAuthoringCopyAuthorizationOptions, + ConversationalAnalysisAuthoringCopyProjectOptions + >; + + /** + * Copies an existing project to another Azure resource. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:copy") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getCopyProjectStatus) + @added(Versions.v2023_04_15_preview) + copyProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The copy project info. + */ + @body + body: ConversationalAnalysisAuthoringCopyProjectOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a job to export a project's data. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:export") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getExportStatus) + export is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The format of the exported project file to use. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("format") + ExportedProjectFormat?: ExportedProjectFormat; + + /** + * Specifies the method used to interpret string offsets. For additional + * information see https://aka.ms/text-analytics-offsets. + */ + @query("stringIndexType") + stringIndexType: StringIndexType; + + /** + * Kind of asset to export. + */ + @query("assetKind") + assetKind?: string; + + /** + * Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. + */ + @query("trainedModelLabel") + trainedModelLabel?: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a job to import a project. If a project with the same name already + * exists, the data of that project is replaced. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:import") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getImportStatus) + `import` is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The format of the exported project file to use. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("format") + ExportedProjectFormat?: ExportedProjectFormat; + + /** + * The project data to import. + */ + @body + body: ConversationalAnalysisAuthoringExportedProject; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Triggers a training job for a project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/:train") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getTrainingStatus) + train is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The training input parameters. + */ + @body + body: ConversationalAnalysisAuthoringTrainingJobOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing copy project job. + */ + @added(Versions.v2023_04_15_preview) + getCopyProjectStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringCopyProjectJobState>; + + /** + * Lists the deployments belonging to a project. + */ + listDeployments is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectDeployment, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Swaps two existing deployments with each other. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/:swap") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getSwapDeploymentsStatus) + swapDeployments is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job object to swap two deployments. + */ + @body + body: ConversationalAnalysisAuthoringSwapDeploymentsOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the details of a deployment. + */ + @get + getDeployment is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectDeployment>; + + /** + * Creates a new deployment or replaces an existing one. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}") + @put + @pollingOperation(ConversationalAnalysisAuthoring.getDeploymentStatus) + deployProject is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + + /** + * The new deployment info. + */ + @body + body: ConversationalAnalysisAuthoringCreateDeploymentOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Deletes a project deployment. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}") + @delete + @pollingOperation(ConversationalAnalysisAuthoring.getDeploymentStatus) + deleteDeployment is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Deletes a project deployment from the specified assigned resources. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getDeploymentDeleteFromResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + deleteDeploymentFromResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The name of the specific deployment of the project to use. + */ + @path + deploymentName: string; + + /** + * The options for deleting the deployment. + */ + @body + body: ConversationalAnalysisAuthoringDeleteDeploymentOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing delete deployment from specific resources job. + */ + @added(Versions.v2023_04_15_preview) + getDeploymentDeleteFromResourcesStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState>; + + /** + * Gets the status of an existing deployment job. + */ + getDeploymentStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentJobState>; + + /** + * Gets the status of an existing swap deployment job. + */ + getSwapDeploymentsStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringSwapDeploymentsJobState>; + + /** + * Gets the status of an export job. Once job completes, returns the project + * metadata, and assets. + */ + getExportStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringExportProjectJobState>; + + /** + * Gets the status for an import. + */ + getImportStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringImportProjectJobState>; + + /** + * Lists the trained models belonging to a project. + */ + listTrainedModels is languageOperations.ResourceList< + ConversationalAnalysisAuthoringProjectTrainedModel, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the details of a trained model. + */ + getTrainedModel is languageOperations.ResourceRead<ConversationalAnalysisAuthoringProjectTrainedModel>; + + /** + * Deletes an existing trained model. + */ + deleteTrainedModel is languageOperations.ResourceDelete<ConversationalAnalysisAuthoringProjectTrainedModel>; + + /** + * Triggers evaluation operation on a trained model. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getEvaluationStatus) + @added(Versions.v2023_04_15_preview) + evaluateModel is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + + /** + * The training input parameters. + */ + @body + body: ConversationalAnalysisAuthoringEvaluationOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Restores the snapshot of this trained model to be the current working directory + * of the project. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getLoadSnapshotStatus) + loadSnapshot is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status for an evaluation job. + */ + @added(Versions.v2023_04_15_preview) + getEvaluationStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringEvaluationJobState>; + + /** + * Gets the detailed results of the evaluation for a trained model. This includes + * the raw inference results for the data included in the evaluation process. + */ + getModelEvaluationResults is languageOperations.ResourceList< + ConversationalAnalysisAuthoringUtteranceEvaluationResult, + ListQueryParametersTrait<StandardListQueryParameters & + StringIndexTypeQueryParameter> + >; + + /** + * Gets the evaluation summary of a trained model. The summary includes high level + * performance measurements of the model e.g., F1, Precision, Recall, etc. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result") + @get + getModelEvaluationSummary is Foundations.Operation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The trained model label. + */ + @path + trainedModelLabel: string; + }, + ConversationalAnalysisAuthoringEvaluationSummary, + {}, + ErrorResponse + >; + + /** + * Gets the status for loading a snapshot. + */ + getLoadSnapshotStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringLoadSnapshotJobState>; + + /** + * Lists the deployments resources assigned to the project. + */ + @added(Versions.v2023_04_15_preview) + listDeploymentResources is languageOperations.ResourceList< + ConversationalAnalysisAuthoringAssignedDeploymentResource, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Assign new Azure resources to a project to allow deploying new deployments to + * them. This API is available only via AAD authentication and not supported via + * subscription key authentication. For more details about AAD authentication, + * check here: + * https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/:assign") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getAssignDeploymentResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + assignDeploymentResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The new project resources info. + */ + @body + body: ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Unassign resources from a project. This disallows deploying new deployments to + * these resources, and deletes existing deployments assigned to them. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/:unassign") + @post + @pollingOperation( + ConversationalAnalysisAuthoring.getUnassignDeploymentResourcesStatus + ) + @added(Versions.v2023_04_15_preview) + unassignDeploymentResources is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The info for the deployment resources to be deleted. + */ + @body + body: ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status of an existing assign deployment resources job. + */ + @added(Versions.v2023_04_15_preview) + getAssignDeploymentResourcesStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringDeploymentResourcesJobState>; + + /** + * Gets the status of an existing unassign deployment resources job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}") + @get + @added(Versions.v2023_04_15_preview) + getUnassignDeploymentResourcesStatus is Azure.Core.Foundations.Operation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job ID. + */ + @path + jobId: string; + }, + ConversationalAnalysisAuthoringDeploymentResourcesJobState, + {}, + ErrorResponse + >; + + /** + * Lists the non-expired training jobs created for a project. + */ + listTrainingJobs is languageOperations.ResourceList< + ConversationalAnalysisAuthoringTrainingJobState, + ListQueryParametersTrait<StandardListQueryParameters> + >; + + /** + * Gets the status for a training job. + */ + getTrainingStatus is languageOperations.ResourceRead<ConversationalAnalysisAuthoringTrainingJobState>; + + /** + * Triggers a cancellation for a running training job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel") + @post + @pollingOperation(ConversationalAnalysisAuthoring.getTrainingStatus) + cancelTrainingJob is Foundations.LongRunningOperation< + { + /** + * The name of the project to use. + */ + @maxLength(100) + @path + projectName: string; + + /** + * The job ID. + */ + @path + jobId: string; + }, + AcceptedResponse, + {}, + ErrorResponse + >; + + /** + * Gets the status for a project deletion job. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}") + @get + getProjectDeletionStatus is Azure.Core.Foundations.Operation< + { + /** + * The job ID. + */ + @path + jobId: string; + }, + ConversationalAnalysisAuthoringProjectDeletionJobState, + {}, + ErrorResponse + >; + + /** + * Lists the deployments to which an Azure resource is assigned. This doesn't + * return deployments belonging to projects owned by this resource. It only + * returns deployments belonging to projects owned by other resources. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/deployments/resources") + @get + @added(Versions.v2023_04_15_preview) + listAssignedResourceDeployments is Azure.Core.Foundations.Operation< + { + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata, + {}, + ErrorResponse + >; + + /** + * Lists the supported languages for the given project type. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/languages") + @get + getSupportedLanguages is Azure.Core.Foundations.Operation< + { + /** + * The project kind. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("projectKind") + ProjectKind: ProjectKind; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringSupportedLanguages, + {}, + ErrorResponse + >; + + /** + * Lists the supported prebuilt entities that can be used while creating composed + * entities. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/prebuilt-entities") + @get + getSupportedPrebuiltEntities is Azure.Core.Foundations.Operation< + { + /** + * The language to get supported prebuilt entities for. Required if multilingual + * is false. This is BCP-47 representation of a language. For example, use "en" + * for English, "en-gb" for English (UK), "es" for Spanish etc. + */ + @query("language") + language?: string; + + /** + * Whether to get the support prebuilt entities for multilingual or monolingual + * projects. If true, the language parameter is ignored. + */ + @query("multilingual") + multilingual?: string; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringPrebuiltEntities, + {}, + ErrorResponse + >; + + /** + * Lists the support training config version for a given project type. + */ + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" + @route("/authoring/analyze-conversations/projects/global/training-config-versions") + @get + listTrainingConfigVersions is Azure.Core.Foundations.Operation< + { + /** + * The project kind. + */ + #suppress "@azure-tools/typespec-azure-core/casing-style" + @query("projectKind") + ProjectKind: ProjectKind; + + /** + * The maximum number of resources to return from the collection. + */ + @query("top") + top?: int32; + + /** + * An offset into the collection of the first resource to be returned. + */ + @query("skip") + skip?: int32; + + /** + * The maximum number of resources to include in a single response. + */ + @query("maxpagesize") + maxpagesize?: int32; + }, + ConversationalAnalysisAuthoringTrainingConfigVersions, + {}, + ErrorResponse + >; +} diff --git a/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml new file mode 100644 index 000000000000..3100367bac7a --- /dev/null +++ b/specification/cognitiveservices/Language.AnalyzeConversations-authoring/tspconfig.yaml @@ -0,0 +1,21 @@ +parameters: + "service-dir": + default: "sdk/cognitivelanguage/authoring/analyzeconversations" +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/data-plane" +options: + "@azure-tools/typespec-autorest": + omit-unreachable-types: true + azure-resource-provider-folder: "data-plane" + emit-lro-options: "none" + emitter-output-dir: "{project-root}/.." + output-file: "{azure-resource-provider-folder}/Language/{version-status}/{version}/analyzeconversations-authoring.json" + "@azure-tools/typespec-csharp": + package-dir: "Azure.AI.Language.Authoring.Analyzeconversations" + clear-output-folder: true + model-namespace: true + namespace: "Azure.AI.Language.Authoring.Analyzeconversations" + flavor: azure diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json index 71303391acbd..2c7df6972a0a 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json @@ -3,212 +3,239 @@ "info": { "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", "version": "2023-04-15-preview", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + "description": "The language service API is a suite of natural language processing (NLP) skills\nbuilt with best-in-class Microsoft machine learning algorithms. The API can be\nused to analyze unstructured text for tasks such as sentiment analysis, key\nphrase extraction, language detection and question answering. Further\ndocumentation can be found in <a\nhref=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } + ] }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } + "schemes": [ + "https" ], "x-ms-parameterized-host": { "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { - "$ref": "common.json#/parameters/Endpoint" + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g.,\nhttps://<resource-name>.api.cognitiveservices.azure.com).", + "required": true, + "type": "string" + }, + { + "name": "Endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], "paths": { "/authoring/analyze-conversations/projects": { "get": { - "description": "Lists the existing projects.", "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], + "description": "Lists the existing projects.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The metadata of projects.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + "$ref": "./examples/SuccessfulListProjects.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "description": "Gets the details of a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "The project parameters.", + "name": "projectName", + "in": "path", + "description": "The new project name.", "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "type": "string", + "maxLength": 100 } ], "responses": { "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + "Successful Get Project": { + "$ref": "./examples/SuccessfulGetProject.json" } } }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" + "patch": { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } } ], "responses": { "200": { - "description": "The metadata of the project.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + "Successful Create Project": { + "$ref": "./examples/SuccessfulCreateProject.json" } } }, "delete": { - "description": "Deletes a project.", "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], + "description": "Deletes a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + "$ref": "./examples/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -216,99 +243,97 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { "post": { - "description": "Generates a copy project operation authorization to the current target Azure resource.", "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Generates a copy project operation authorization to the current target Azure\nresource.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", - "description": "The copy project authorization info.", + "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyAuthorizationOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { - "description": "Payload to send to source resource to initiate project copying.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Copy Project Authorization": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" + "$ref": "./examples/SuccessfulCopyProjectAuthorization.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/:copy": { "post": { - "description": "Copies an existing project to another Azure resource.", "operationId": "ConversationalAnalysisAuthoring_CopyProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Copies an existing project to another Azure resource.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The copy project info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Copy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" + "$ref": "./examples/SuccessfulCopyProject.json" } }, "x-ms-long-running-operation": true @@ -316,59 +341,105 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "description": "Triggers a job to export a project's data.", "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], + "description": "Triggers a job to export a project's data.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } }, { - "in": "query", "name": "assetKind", + "in": "query", "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" + "required": false, + "type": "string" }, { - "in": "query", "name": "trainedModelLabel", + "in": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "required": false, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + "$ref": "./examples/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -376,54 +447,79 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a job to import a project. If a project with the same name already\nexists, the data of that project is replaced.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" }, { - "in": "body", "name": "body", + "in": "body", "description": "The project data to import.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + "$ref": "./examples/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -431,51 +527,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "description": "Triggers a training job for a project.", "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a training job for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + "$ref": "./examples/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -483,272 +579,244 @@ }, "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing copy project job.", "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing copy project job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Copy Project Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" + "$ref": "./examples/SuccessfulGetCopyProjectStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "description": "Lists the deployments belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all deployments.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + "$ref": "./examples/SuccessfulListDeployments.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "description": "Gets the details of a deployment.", "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], + "description": "Gets the details of a deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The Deployment info.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + "$ref": "./examples/SuccessfulGetDeployment.json" } } }, "put": { - "description": "Creates a new deployment or replaces an existing one.", "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The new deployment info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + "$ref": "./examples/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true }, "delete": { - "description": "Deletes a project deployment.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -756,54 +824,58 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { "post": { - "description": "Deletes a project deployment from the specified assigned resources.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment from the specified assigned resources.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The options for deleting the deployment.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeleteDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" + "Successful Delete Deployment From Resources": { + "$ref": "./examples/SuccessfulDeleteDeploymentFromResources.json" } }, "x-ms-long-running-operation": true @@ -811,377 +883,484 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing delete deployment from specific resources job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing delete deployment from specific resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Delete Deployment From Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "Successful Get Deployment Status": { + "$ref": "./examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/SuccessfulGetDeploymentStatus.json" } } } }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "description": "Swaps two existing deployments with each other.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing swap deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing swap deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The swap deployment job result.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + "$ref": "./examples/SuccessfulGetSwapDeploymentsStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an export job. Once job completes, returns the project\nmetadata, and assets.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/SuccessfulGetExportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "description": "Gets the status for an import.", "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an import.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/SuccessfulGetImportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "description": "Lists the trained models belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], + "description": "Lists the trained models belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all trained models.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + "$ref": "./examples/SuccessfulListModels.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "description": "Gets the details of a trained model.", "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], + "description": "Gets the details of a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Trained model info", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + "$ref": "./examples/SuccessfulGetModel.json" } } }, "delete": { - "description": "Deletes an existing trained model.", "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], + "description": "Deletes an existing trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "Deleted successfully." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + "$ref": "./examples/SuccessfulDeleteModel.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { "post": { - "description": "Triggers evaluation operation on a trained model.", "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers evaluation operation on a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" + "Successful Evaluation Project": { + "$ref": "./examples/SuccessfulEvaluationProject.json" } }, "x-ms-long-running-operation": true @@ -1189,42 +1368,49 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], + "description": "Restores the snapshot of this trained model to be the current working directory\nof the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + "$ref": "./examples/SuccessfulLoadSnapshot.json" } }, "x-ms-long-running-operation": true @@ -1232,278 +1418,310 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { "get": { - "description": "Gets the status for an evaluation job.", "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an evaluation job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The evaluation job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Evaluation Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" + "$ref": "./examples/SuccessfulGetEvaluationStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], + "description": "Gets the detailed results of the evaluation for a trained model. This includes\nthe raw inference results for the data included in the evaluation process.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/StringIndexTypeQueryParameter" } ], "responses": { "200": { - "description": "List of the evaluation predictions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], + "description": "Gets the evaluation summary of a trained model. The summary includes high level\nperformance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "List of all evaluation results.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/SuccessfulGetModelEvaluationSummary.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "description": "Gets the status for loading a snapshot.", "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for loading a snapshot.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + "$ref": "./examples/SuccessfulGetLoadSnapshotStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources": { "get": { - "description": "Lists the deployments resources assigned to the project.", "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", - "produces": [ - "application/json" - ], + "description": "Lists the deployments resources assigned to the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The assigned deployment resources.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResources" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringAssignedDeploymentResource" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" + "$ref": "./examples/SuccessfulListDeploymentResources.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { "post": { - "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Assign new Azure resources to a project to allow deploying new deployments to\nthem. This API is available only via AAD authentication and not supported via\nsubscription key authentication. For more details about AAD authentication,\ncheck here:\nhttps://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The new project resources info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" + "$ref": "./examples/SuccessfulAssignDeploymentResources.json" } }, "x-ms-long-running-operation": true @@ -1511,51 +1729,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { "post": { - "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Unassign resources from a project. This disallows deploying new deployments to\nthese resources, and deletes existing deployments assigned to them.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The info for the deployment resources to be deleted.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" + "$ref": "./examples/SuccessfulUnassignDeploymentResources.json" } }, "x-ms-long-running-operation": true @@ -1563,208 +1781,234 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing assign deployment resources job.", "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing assign deployment resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The assign deployment resources job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" + "$ref": "./examples/SuccessfulGetAssignDeploymentResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing unassign deployment resources job.", "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing unassign deployment resources job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The unassign deployment resources job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" + "$ref": "./examples/SuccessfulGetUnassignDeploymentResourcesStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "description": "Lists the non-expired training jobs created for a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], + "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of the training jobs.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "description": "Gets the status for a training job.", "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The training job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/SuccessfulGetTrainStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "description": "Triggers a cancellation for a running training job.", "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], + "description": "Triggers a cancellation for a running training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/SuccessfulCancelTrainingJob.json" } }, "x-ms-long-running-operation": true @@ -1772,2486 +2016,3061 @@ }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "description": "Gets the status for a project deletion job.", "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a project deletion job.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The project deletion job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/SuccessfulGetProjectDeletionStatus.json" } } } }, "/authoring/analyze-conversations/projects/global/deployments/resources": { "get": { - "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments to which an Azure resource is assigned. This doesn't\nreturn deployments belonging to projects owned by this resource. It only\nreturns deployments belonging to projects owned by other resources.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The assigned deployments metadata for the resource.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" + "$ref": "./examples/SuccessfulListAssignedResourceDeployments.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "description": "Lists the supported languages for the given project type.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], + "description": "Lists the supported languages for the given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" - }, - { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported languages.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + "Successful Get Supported Languages": { + "$ref": "./examples/SuccessfulGetSupportedLanguages.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], + "description": "Lists the supported prebuilt entities that can be used while creating composed\nentities.", "parameters": [ { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "language", "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" + "description": "The language to get supported prebuilt entities for. Required if multilingual\nis false. This is BCP-47 representation of a language. For example, use \"en\"\nfor English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual\nprojects. If true, the language parameter is ignored.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported prebuilt entities.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + "$ref": "./examples/SuccessfulGetSupportedPrebuiltEntities.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "description": "Lists the support training config version for a given project type.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], + "description": "Lists the support training config version for a given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "name": "CustomConversationSummarization", + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "List of config versions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/SuccessfulGetSupportedTrainingConfigVersions.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } } }, "definitions": { - "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { - "description": "Represents the options for assigning Azure resources to a project.", - "required": [ - "resourcesMetadata" + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" ], + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "name": "returnLongestOverlap", + "value": "returnLongestOverlap", + "description": "When two or more components are found in the text and overlap, the component\nwith the longest set of characters is returned." + }, + { + "name": "requireExactOverlap", + "value": "requireExactOverlap", + "description": "All components must overlap at the exact same characters in the text for the\nentity to return. If one of the defined components is not matched or predicted,\nthe entity will not return." + }, + { + "name": "separateComponents", + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the\nentity." + }, + { + "name": "combineComponents", + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components'\nspans are merged together into one span combining all of them." + } + ] + } + }, + "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { "type": "object", + "description": "Represents the options for assigning Azure resources to a project.", "properties": { "resourcesMetadata": { - "description": "Represents the metadata for the resources to be assigned.", "type": "array", + "description": "Represents the metadata for the resources to be assigned.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringResourceMetadata" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "AssignDeploymentResourcesOptions" + "required": [ + "resourcesMetadata" + ] }, "ConversationalAnalysisAuthoringAssignedDeploymentResource": { - "description": "Represents the assigned deployment resource.", - "required": [ - "azureResourceId", - "region" - ], "type": "object", + "description": "Represents the assigned deployment resource.", "properties": { "azureResourceId": { - "description": "The resource ID.", - "type": "string" + "type": "string", + "description": "The resource ID." }, "region": { - "description": "The resource region.", - "type": "string" - } - }, - "x-ms-client-name": "AssignedDeploymentResource" - }, - "ConversationalAnalysisAuthoringAssignedDeploymentResources": { - "description": "Represents the assigned deployment resources.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of assigned deployment resources.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" - } - }, - "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The resource region." } }, - "x-ms-client-name": "AssignedDeploymentResources" + "required": [ + "azureResourceId", + "region" + ] }, "ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata": { - "description": "Represents the metadata for an assigned deployment", - "required": [ - "deploymentName", - "lastDeployedDateTime", - "deploymentExpirationDate" - ], "type": "object", + "description": "Represents the metadata for an assigned deployment", "properties": { "deploymentName": { - "description": "Represents the deployment name.", - "type": "string" + "type": "string", + "description": "Represents the deployment name." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." } }, - "x-ms-client-name": "AssignedProjectDeploymentMetadata" + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ] }, "ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata": { - "description": "Represents the metadata for assigned deployments for a project.", - "required": [ - "projectName", - "deploymentsMetadata" - ], "type": "object", + "description": "Represents the metadata for assigned deployments for a project.", "properties": { "projectName": { - "description": "Represents the project name.", - "type": "string" + "type": "string", + "description": "Represents the project name." }, "deploymentsMetadata": { - "description": "Represents the resource region.", "type": "array", + "description": "Represents the resource region.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "AssignedProjectDeploymentsMetadata" + "required": [ + "projectName", + "deploymentsMetadata" + ] }, "ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata": { - "description": "Represents the metadata for deployments assigned to a resource.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents the metadata for deployments assigned to a resource.", "properties": { "value": { - "description": "The list of retrieved assigned project deployments.", "type": "array", + "description": "The list of retrieved assigned project deployments.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "AssignedResourceDeploymentsMetadata" - }, - "ConversationalAnalysisAuthoringCompositionSetting": { - "enum": [ - "returnLongestOverlap", - "requireExactOverlap", - "separateComponents", - "combineComponents" - ], - "type": "string", - "x-ms-enum": { - "name": "CompositionSetting", - "modelAsString": true, - "values": [ - { - "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." - }, - { - "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." - }, - { - "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." - }, - { - "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." - } - ] - }, - "x-ms-client-name": "CompositionSetting" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringConfusionMatrix": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" + } }, "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], "type": "object", + "description": "Represents a cell in a confusion matrix.", "properties": { "normalizedValue": { + "type": "number", "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" + "description": "Represents normalized value in percentages." }, "rawValue": { + "type": "number", "format": "float", - "description": "Represents raw value.", - "type": "number" + "description": "Represents raw value." } }, - "x-ms-client-name": "ConfusionMatrixCell" + "required": [ + "normalizedValue", + "rawValue" + ] }, "ConversationalAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" + } }, "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an entity with its components.", "properties": { "category": { - "description": "The category of the entity.", - "type": "string" + "type": "string", + "description": "The category of the entity." }, "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." }, "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList", + "description": "The list component of the entity." }, "prebuilts": { - "description": "The prebuilt entities components.", "type": "array", + "description": "The prebuilt entities components.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "regex": { - "description": "The regex component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex", + "description": "The regex component of the entity." }, "requiredComponents": { - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "items": { "type": "string" } } }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", "required": [ "category" - ], + ] + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { "type": "object", + "description": "Represents an exported intent of a conversational project.", "properties": { "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "ConversationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the exported assets of a conversational project.", "properties": { "intents": { - "description": "The intents defined in the project.", "type": "array", + "description": "The intents defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "entities": { - "description": "The entities defined in the project.", "type": "array", + "description": "The entities defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "The utterances defined in the project.", "type": "array", + "description": "The utterances defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an exported utterance for a conversational project.", "properties": { "entities": { - "description": "Represents the entity labels of the utterance.", "type": "array", + "description": "Represents the entity labels of the utterance.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } + }, + "x-ms-identifiers": [] }, "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "ConversationExportedUtterance" - }, - "ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets": { - "type": "object", - "properties": { - "conversations": { - "description": "Represents the conversations of the project.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCustomConversationSummarizationConversation" - } + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "ConversationSummarizationExportedProjectAssets" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringCopyAuthorizationOptions": { - "description": "Represents the options for authorizing a project copy to the current Azure resource.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the options for authorizing a project copy to the current Azure resource.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "storageInputContainerName": { - "description": "The name of the storage container.", - "type": "string" + "type": "string", + "description": "The name of the storage container." }, "allowOverwrite": { - "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization.", - "type": "boolean" + "type": "boolean", + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization." } }, - "x-ms-client-name": "CopyAuthorizationOptions" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringCopyProjectJobState": { - "description": "Represents the state of a copy job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "CopyProjectJobState" + "description": "Represents the state of a copy job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringCopyProjectOptions": { - "description": "Represents the options for copying an existing project to another Azure resource.", - "required": [ - "projectKind", - "targetProjectName", - "accessToken", - "expiresAt", - "targetResourceId", - "targetResourceRegion" - ], "type": "object", + "description": "Represents the options for copying an existing project to another Azure\nresource.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "targetProjectName": { - "description": "The project name to be copied-into.", - "type": "string" + "type": "string", + "description": "The project name to be copied-into." }, "accessToken": { - "description": "The access token.", - "type": "string" + "type": "string", + "description": "The access token." }, "expiresAt": { + "type": "string", "format": "date-time", - "description": "The expiration of the access token.", - "type": "string" + "description": "The expiration of the access token." }, "targetResourceId": { - "description": "Represents the target Azure resource ID.", - "type": "string" + "type": "string", + "description": "Represents the target Azure resource ID." }, "targetResourceRegion": { - "description": "Represents the target Azure resource region.", - "type": "string" + "type": "string", + "description": "Represents the target Azure resource region." } }, - "x-ms-client-name": "CopyProjectOptions" + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ] }, "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], "type": "object", + "description": "Represents the options for creating or updating a project deployment.", "properties": { "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" + "type": "string", + "description": "Represents the trained model label." }, "assignedResourceIds": { - "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", "type": "array", + "description": "Represents the resource IDs to be assigned to the deployment.\nIf provided, the deployment will be rolled out to the resources\nprovided here as well as the original resource in which the project is created.", "items": { "type": "string" } } }, - "x-ms-client-name": "CreateDeploymentOptions" + "required": [ + "trainedModelLabel" + ] }, "ConversationalAnalysisAuthoringCreateProjectOptions": { - "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the options used to create or update a project.", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", + "description": "The project settings." }, "storageInputContainerName": { - "description": "The storage container name in case of conversation summarization.", - "type": "string" + "type": "string", + "description": "The storage container name in case of conversation summarization." }, "projectName": { - "description": "The new project name.", - "type": "string" + "type": "string", + "description": "The new project name." }, "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." }, "description": { - "description": "The project description.", - "type": "string" + "type": "string", + "description": "The project description." }, "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "CreateProjectOptions" - }, - "ConversationalAnalysisAuthoringCustomConversationSummarizationConversation": { - "description": "Represents an exported conversation for a custom conversation summarization.", "required": [ - "location" - ], - "type": "object", - "properties": { - "summaryLocation": { - "type": "string" - }, - "location": { - "description": "Represents the conversation file location in the blob store container associated with the project.", - "type": "string" - }, - "language": { - "description": "Represents the language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" - }, - "dataset": { - "description": "The dataset for this conversation. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - }, - "x-ms-client-name": "CustomConversationSummarizationConversation" + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringDeleteDeploymentOptions": { - "description": "Represents the options for deleting a project deployment.", "type": "object", + "description": "Represents the options for deleting a project deployment.", "properties": { "assignedResourceIds": { - "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", "type": "array", + "description": "Represents the resource IDs to delete the deployment from.\nIf not provided, the deployment will be rolled out from all the\nresources it is deployed to.\nIf provided, it will delete the deployment only from the specified\nassigned resources, and leave it for the rest.", "items": { "type": "string" } } + } + }, + "ConversationalAnalysisAuthoringDeploymentDeleteFromResourcesJobState": { + "type": "object", + "description": "Represents the state of an existing delete deployment from specific resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } }, - "x-ms-client-name": "DeleteDeploymentOptions" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringDeploymentResource": { - "description": "Represents an Azure resource assigned to a deployment.", - "required": [ - "resourceId", - "region" - ], "type": "object", + "description": "Represents an Azure resource assigned to a deployment.", "properties": { "resourceId": { - "description": "Represents the Azure resource Id.", - "type": "string" + "type": "string", + "description": "Represents the Azure resource Id." }, "region": { - "description": "Represents the resource region.", - "type": "string" + "type": "string", + "description": "Represents the resource region." } }, - "x-ms-client-name": "DeploymentResource" + "required": [ + "resourceId", + "region" + ] }, "ConversationalAnalysisAuthoringDeploymentResourcesJobState": { - "description": "Represents the state of a deployment resources job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment resources job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentResourcesJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two entities (the two entities can be\nthe same). The matrix is between the entity that was labelled and the entity\nthat was predicted." }, "entities": { - "description": "Represents the entities evaluation summary.", "type": "object", + "description": "Represents the entities evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "EntitiesEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringEntityEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result for an entity.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "EntityEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringEvaluationJobResult": { - "required": [ - "evaluationOptions", - "modelLabel", - "trainingConfigVersion", - "percentComplete" - ], "type": "object", "properties": { "evaluationOptions": { - "description": "Represents the options used running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the options used running the evaluation." }, "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "percentComplete": { + "type": "integer", "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" + "description": "Represents progress percentage." } }, - "x-ms-client-name": "EvaluationJobResult" + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ] }, "ConversationalAnalysisAuthoringEvaluationJobState": { - "description": "Represents the state of a evaluation job.", - "required": [ - "result" - ], "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of a evaluation job.", "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, "result": { - "description": "Represents evaluation task detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobResult", + "description": "Represents evaluation task detailed result." } }, - "x-ms-client-name": "EvaluationJobState" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", + "result" + ] }, "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", "type": "object", + "description": "Represents the options used running the evaluation.", "properties": { "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage." }, "trainingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage." }, "testingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage." } - }, - "x-ms-client-name": "EvaluationOptions" + } }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], + "ConversationalAnalysisAuthoringEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result summary.", "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } + "entitiesEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "intentsEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." } }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", "required": [ "entitiesEvaluation", "intentsEvaluation" - ], + ] + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { "type": "object", + "description": "Represents the state of an export job.", "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + "jobId": { + "type": "string", + "description": "The job ID." }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." } }, - "x-ms-client-name": "EvaluationSummary" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", "properties": { "projectName": { - "description": "The name of the targeted project.", - "type": "string" + "type": "string", + "description": "The name of the targeted project." }, "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" + "type": "string", + "description": "The name of the targeted deployment." } }, - "x-ms-client-name": "ExportedConversationOrchestration" + "required": [ + "projectName", + "deploymentName" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, "required": [ "conversationOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", "type": "object", + "description": "Represents a list component of an entity.", "properties": { "sublists": { - "description": "The sub-lists of the list component.", "type": "array", + "description": "The sub-lists of the list component.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityList" + } }, "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", "type": "object", + "description": "Represents a list of synonyms inside a list component", "properties": { "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "values": { - "description": "The list of synonyms.", "type": "array", + "description": "The list of synonyms.", "items": { "type": "string" } } - }, - "x-ms-client-name": "ExportedEntityListSynonym" + } }, "ConversationalAnalysisAuthoringExportedEntityRegex": { - "description": "Represents a regex component of an entity.", "type": "object", + "description": "Represents a regex component of an entity.", "properties": { "expressions": { - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET\nregex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityRegex" + } }, "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows\nthe .NET regex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "properties": { "regexKey": { - "description": "The key of the regex expression.", - "type": "string" + "type": "string", + "description": "The key of the regex expression." }, "language": { - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation\nof a language. For example, use \"en\" for English, \"en-gb\" for English (UK),\n\"es\" for Spanish etc." }, "regexPattern": { - "description": "The regex pattern.", - "type": "string" + "type": "string", + "description": "The regex pattern." } - }, - "x-ms-client-name": "ExportedEntityRegexExpression" + } }, "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", "type": "object", + "description": "Represents a sub-list inside a list component.", "properties": { "listKey": { - "description": "The key of the sub-list.", - "type": "string" + "type": "string", + "description": "The key of the sub-list." }, "synonyms": { - "description": "The phrases of that correspond to the sub-list.", "type": "array", + "description": "The phrases of that correspond to the sub-list.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntitySublist" + } }, "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", "properties": { "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." }, "appVersion": { - "description": "The targeted version Id.", - "type": "string" + "type": "string", + "description": "The targeted version Id." }, "slotName": { - "description": "The targeted slot name.", - "type": "string" + "type": "string", + "description": "The targeted slot name." } }, - "x-ms-client-name": "ExportedLuisOrchestration" + "required": [ + "appId" + ] }, "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, "required": [ "luisOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" + "x-ms-discriminator-value": "Luis" }, "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", "properties": { "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + "$ref": "#/definitions/OrchestrationTargetProjectKind" } }, "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" - }, - "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", "required": [ - "category" - ], + "targetProjectKind" + ] + }, + "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { "type": "object", + "description": "Represents an exported prebuilt entity component", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." } }, - "x-ms-client-name": "ExportedPrebuiltEntity" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], "type": "object", + "description": "Represents an exported project.", "properties": { "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" + "type": "string", + "description": "The version of the exported file." }, "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets." }, "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions", + "description": "Represents the project metadata." }, "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets", + "description": "Represents the project assets." } }, - "x-ms-client-name": "ExportedProject" + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] }, "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the assets of an exported project.", "properties": { "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." } }, "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", "properties": { "projectName": { - "description": "The name of the target project.", - "type": "string" + "type": "string", + "description": "The name of the target project." } }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + "required": [ + "projectName" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, "required": [ "questionAnsweringOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + "x-ms-discriminator-value": "QuestionAnswering" }, "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents an entity label for an utterance.", "properties": { "category": { - "description": "The category of the entity label.", - "type": "string" + "type": "string", + "description": "The category of the entity label." }, "offset": { + "type": "integer", "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" + "description": "Start position for the entity text." }, "length": { + "type": "integer", "format": "int32", - "description": "Length for the entity text.", - "type": "integer" + "description": "Length for the entity text." } }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" + "required": [ + "category", + "offset", + "length" + ] }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", + "ConversationalAnalysisAuthoringImportProjectJobState": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of an import job.", "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "The evaluation summary for an intent.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "IntentEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation summary for the project's intents.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two intents (the two intents can be the\nsame). The matrix is between the intent that was labelled and the intent that\nwas predicted." }, "intents": { - "description": "Represents the intents evaluation summary.", "type": "object", + "description": "Represents the intents evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringLoadSnapshotJobState": { "type": "object", + "description": "Represents the state of loading a snapshot job.", "properties": { "jobId": { - "description": "The job ID.", - "type": "string" + "type": "string", + "description": "The job ID." }, "createdDateTime": { + "type": "string", "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" + "description": "The creation date time of the job." }, "lastUpdatedDateTime": { + "type": "string", "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" + "description": "The last date time the job was updated." }, "expirationDateTime": { + "type": "string", "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" + "description": "The expiration date time of the job." }, "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "The job status." }, "warnings": { - "description": "The warnings that were encountered while executing the job.", "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, "errors": { - "description": "The errors encountered while executing the job.", "type": "array", + "description": "The errors encountered while executing the job.", "items": { - "$ref": "common.json#/definitions/Error" - } + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported intent for an orchestration project.", "properties": { "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." }, "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "OrchestrationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the assets of an orchestration project.", "properties": { "intents": { - "description": "Represents the intents of the project.", "type": "array", + "description": "Represents the intents of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "Represents the utterances of the project.", "type": "array", + "description": "Represents the utterances of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" }, "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { + "type": "object", "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], - "type": "object", "properties": { "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of the retrieved supported prebuilt entities.", "properties": { "value": { - "description": "The supported prebuilt entities.", "type": "array", + "description": "The supported prebuilt entities.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "PrebuiltEntities" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], "type": "object", + "description": "Represents a supported prebuilt entity.", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." }, "description": { - "description": "The description.", - "type": "string" + "type": "string", + "description": "The description." }, "examples": { - "description": "English examples for the entity.", - "type": "string" + "type": "string", + "description": "English examples for the entity." } }, - "x-ms-client-name": "PrebuiltEntity" + "required": [ + "category", + "description", + "examples" + ] }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "ProjectDeletionJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion", - "assignedResources" - ], "type": "object", + "description": "Represents a project deployment.", "properties": { "deploymentName": { - "description": "Represents deployment name.", - "type": "string" + "type": "string", + "description": "Represents deployment name." }, "modelId": { - "description": "Represents deployment modelId.", - "type": "string" + "type": "string", + "description": "Represents deployment modelId." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" + "description": "Represents deployment last trained time." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." }, "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" + "type": "string", + "description": "Represents model training config version." }, "assignedResources": { - "description": "Represents the metadata of the assigned Azure resources.", "type": "array", + "description": "Represents the metadata of the assigned Azure resources.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResource" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration", - "CustomConversationSummarization" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - }, - { - "value": "CustomConversationSummarization", - "description": "A project to build conversation summarization models which are able to summarize long conversations." - } - ] - }, - "x-ms-client-name": "ProjectKind" + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ] }, "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the metadata of a project.", "properties": { "createdDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastModifiedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" + "description": "Represents the project last trained datetime." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" + "description": "Represents the project last deployed datetime." }, "projectKind": { + "$ref": "#/definitions/ProjectKind", "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "x-ms-mutability": [ + "read", + "create" + ] }, "settings": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "x-ms-mutability": [ + "read", + "create" + ] }, "storageInputContainerName": { + "type": "string", "description": "The storage container name in case of conversation summarization.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "projectName": { + "type": "string", "description": "The new project name.", - "type": "string" + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] }, "multilingual": { + "type": "boolean", "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "x-ms-mutability": [ + "read", + "create" + ] }, "description": { + "type": "string", "description": "The project description.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "language": { + "type": "string", "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] } }, - "x-ms-client-name": "ProjectMetadata" + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], "type": "object", + "description": "Represents the settings used to define the project behavior.", "properties": { "confidenceThreshold": { + "type": "number", "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." } }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" + "confidenceThreshold" + ] }, "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ], "type": "object", + "description": "Represents a trained model.", "properties": { "label": { - "description": "The trained model label.", - "type": "string" + "type": "string", + "description": "The trained model label." }, "modelId": { - "description": "The model ID.", - "type": "string" + "type": "string", + "description": "The model ID." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" + "description": "The last trained date time of the model." }, "lastTrainingDurationInSeconds": { + "type": "integer", "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" + "description": "The duration of the model's last training request in seconds." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "The model expiration date.", - "type": "string" + "description": "The model expiration date." }, "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" + "type": "string", + "description": "The model training config version." }, "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." } }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", "required": [ - "value", - "nextLink" - ], + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "ConversationalAnalysisAuthoringResourceMetadata": { "type": "object", + "description": "Represents metadata for the Azure resource..", "properties": { - "value": { - "description": "The list of trained models.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } + "azureResourceId": { + "type": "string", + "description": "Represents the Azure resource ID." }, - "nextLink": { - "description": "The next page link.", + "customDomain": { + "type": "string", + "description": "Represents the Azure resource custom domain." + }, + "region": { "type": "string", - "x-nullable": true + "description": "Represents the Azure resource region." } }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringResourceMetadata": { - "description": "Represents metadata for the Azure resource..", "required": [ "azureResourceId", "customDomain", "region" - ], + ] + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { "type": "object", + "description": "Represents the detailed state of a training sub-operation.", "properties": { - "azureResourceId": { - "description": "Represents the Azure resource ID.", - "type": "string" - }, - "customDomain": { - "description": "Represents the Azure resource custom domain.", - "type": "string" - }, - "region": { - "description": "Represents the Azure resource region.", - "type": "string" - } - }, - "x-ms-client-name": "ResourceMetadata" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", - "required": [ - "percentComplete", - "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." }, "startDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the start date time.", - "type": "string" + "description": "Represents the start date time." }, "endDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the end date time.", - "type": "string" + "description": "Represents the end date time." }, "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." } }, - "x-ms-client-name": "SubTrainingJobState" + "required": [ + "percentComplete", + "status" + ] }, "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], "type": "object", + "description": "Represents a supported language.", "properties": { "languageName": { - "description": "The language name.", - "type": "string" + "type": "string", + "description": "The language name." }, "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example,\n\"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "SupportedLanguage" + "required": [ + "languageName", + "languageCode" + ] }, "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of retrieved languages.", "properties": { "value": { - "description": "The list of the languages.", "type": "array", + "description": "The list of the languages.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "SupportedLanguages" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", + "ConversationalAnalysisAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { "type": "object", + "description": "Represents the options for swapping two deployments together.", "properties": { "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" + "type": "string", + "description": "Represents the first deployment name." }, "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" + "type": "string", + "description": "Represents the second deployment name." } }, - "x-ms-client-name": "SwapDeploymentsOptions" + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], "type": "object", + "description": "Represents a training config version.", "properties": { "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" + "type": "string", + "description": "Represents the version of the config." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" + "description": "Represents the training config version expiration date." } }, - "x-ms-client-name": "TrainingConfigVersion" + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of training config versions.", "properties": { "value": { - "description": "The list of the training config versions.", "type": "array", + "description": "The list of the training config versions.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "TrainingConfigVersions" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], "type": "object", + "description": "Represents the options for starting a new training job.", "properties": { "modelLabel": { - "description": "Represents the output model label.", - "type": "string" + "type": "string", + "description": "Represents the output model label." }, "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which\nuses the latest released training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is\npercentage, with training split percentage as 80, and testing split percentage\nas 20." } }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", "required": [ "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], + "trainingMode" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { "type": "object", + "description": "Represents the output of a training job.", "properties": { "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents the model training status." }, "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." }, "estimatedEndDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" + "description": "Represents the estimated end date time for training and evaluation." } }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", "required": [ - "value", - "nextLink" - ], + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobState": { "type": "object", + "description": "Represents the state of a training job.", "properties": { - "value": { - "description": "The list of jobs.", + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "result": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." } }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" + ] }, "ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions": { - "description": "Represents the options to unassign Azure resources from a project.", - "required": [ - "assignedResourceIds" - ], "type": "object", + "description": "Represents the options to unassign Azure resources from a project.", "properties": { "assignedResourceIds": { - "description": "Represents the assigned resource IDs to be unassigned.", "type": "array", + "description": "Represents the assigned resource IDs to be unassigned.", "items": { "type": "string" } } }, - "x-ms-client-name": "UnassignDeploymentResourcesOptions" + "required": [ + "assignedResourceIds" + ] }, "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an\nutterance.", "properties": { "expectedEntities": { - "description": "Represents the expected entity labels.", "type": "array", + "description": "Represents the expected entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] }, "predictedEntities": { - "description": "Represents the predicted entity labels.", "type": "array", + "description": "Represents the predicted entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + "required": [ + "expectedEntities", + "predictedEntities" + ] }, "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { + "type": "object", "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], - "type": "object", "properties": { "category": { - "description": "Represents the entity category.", - "type": "string" + "type": "string", + "description": "Represents the entity category." }, "offset": { + "type": "integer", "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" + "description": "Represents the entity offset index relative to the original text." }, "length": { + "type": "integer", "format": "int32", - "description": "Represents the entity length.", - "type": "integer" + "description": "Represents the entity length." } }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" + "required": [ + "category", + "offset", + "length" + ] }, "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { - "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], "type": "object", + "description": "Represents the evaluation result for an utterance.", "properties": { "text": { - "description": "Represents the utterance text.", - "type": "string" + "type": "string", + "description": "Represents the utterance text." }, "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language.\nFor example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish\netc." }, "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." }, "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." } }, - "x-ms-client-name": "UtteranceEvaluationResult" + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] }, "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an\nutterance.", "properties": { "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's expected intent." }, "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's predicted intent." } }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" + "required": [ + "expectedIntent", + "predictedIntent" + ] }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." + } + }, "required": [ "code", "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument" + }, + { + "name": "Unauthorized", + "value": "Unauthorized" + }, + { + "name": "Forbidden", + "value": "Forbidden" + }, + { + "name": "NotFound", + "value": "NotFound" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached" + }, + { + "name": "InternalServerError", + "value": "InternalServerError" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable" + }, + { + "name": "Timeout", + "value": "Timeout" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded" + }, + { + "name": "Conflict", + "value": "Conflict" + }, + { + "name": "Warning", + "value": "Warning" + } + ] + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined\npercentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint" + } + ] + } + }, + "InnerErrorModel": { "type": "object", + "description": "An object containing more specific information about the error. As per\nMicrosoft One API guidelines -\nhttps://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { "code": { - "description": "The warning code.", - "type": "string" + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." }, "message": { - "description": "The warning message.", - "type": "string" + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." } }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", + "required": [ + "code", + "message" + ] + }, + "JobStatus": { "type": "string", "enum": [ - "Conversation", - "Luis" + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" ], "x-ms-enum": { - "name": "ExportedProjectFormat", + "name": "JobStatus", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "Specifies the format for a conversational project." + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" }, { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" } ] - }, - "x-ms-parameter-location": "method" + } }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, + "OrchestrationTargetProjectKind": { "type": "string", "enum": [ - "Utf16CodeUnit" + "Luis", + "Conversation", + "QuestionAnswering" ], "x-ms-enum": { - "name": "StringIndexType", + "name": "OrchestrationTargetProjectKind", "modelAsString": true, "values": [ { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + "name": "Luis", + "value": "Luis" + }, + { + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" } ] + } + }, + "PagedConversationalAnalysisAuthoringAssignedDeploymentResource": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringAssignedDeploymentResource items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringAssignedDeploymentResource items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } }, - "x-ms-parameter-location": "method" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "PagedConversationalAnalysisAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" + "PagedConversationalAnalysisAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { - "in": "query", - "name": "projectKind", - "description": "The project kind.", - "required": true, + "PagedConversationalAnalysisAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { "type": "string", "enum": [ "Conversation", @@ -4263,18 +5082,140 @@ "modelAsString": true, "values": [ { + "name": "Conversation", "value": "Conversation", "description": "A project to build natural language into apps, bots, and IoT devices." }, { + "name": "Orchestration", "value": "Orchestration", "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." }, { + "name": "CustomConversationSummarization", "value": "CustomConversationSummarization", "description": "A project to build conversation summarization models which are able to summarize long conversations." } ] + } + }, + "StringIndexType": { + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } + }, + "TrainingMode": { + "type": "string", + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train\nmultilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } + }, + "Warning": { + "type": "object", + "description": "Represents a warning that was encountered while executing the request.", + "properties": { + "code": { + "type": "string", + "description": "The warning code." + }, + "message": { + "type": "string", + "description": "The warning message." + } + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] }, "x-ms-parameter-location": "method" } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..b8577067d66b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,31 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", + "title": "Successful Assign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..a87a5e05d24b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json new file mode 100644 index 000000000000..3bffe749e1a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CopyProject", + "title": "Successful Copy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..559d5a6cbc42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", + "title": "Successful Copy Project Authorization", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json new file mode 100644 index 000000000000..b97424b580db --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-04-15-preview", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..f39bc67461ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..1b5cdb84bc8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", + "title": "Successful Delete Deployment From Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..9c02021b969c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..38cc03250ae8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json new file mode 100644 index 000000000000..e50c76314cc4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulDeployProject.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..6671e82372c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulEvaluationProject.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", + "title": "Successful Evaluation Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json new file mode 100644 index 000000000000..c23a7eeefb98 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..79fcbc9ccb39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "title": "Successful Get Assign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json similarity index 83% rename from specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json rename to specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json index aa6548d7266f..16ac708cf150 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetCopyProjectStatus.json @@ -1,4 +1,6 @@ { + "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", + "title": "Successful Get Copy Project Status", "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "{API key}", diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..a26e6fe5fad7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeployment.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json new file mode 100644 index 000000000000..5d0b5e353b44 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..d065933efcbc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..42402bfff47f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,34 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", + "title": "Successful Get Evaluation Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..c33e21494512 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..0348df4ec820 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..b462a1000dd2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json new file mode 100644 index 000000000000..f88377461b06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..76875d700b52 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-15-preview&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..c72f475a6bb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json new file mode 100644 index 000000000000..a94bb114d32d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..811552fb4422 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..7899bc7d77a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..a1e8e439638e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..67633ed31525 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..5acc8e3f9682 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..f906c7ce7db4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetTrainStatus.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..070f83815b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "title": "Successful Get Unassign Deployment Resources Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json new file mode 100644 index 000000000000..162fe542788a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulImportProject.json @@ -0,0 +1,80 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + }, + { + "category": "Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..a6a825669663 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,28 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", + "title": "Successful List Assigned Resource Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..0d43121bc1b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeploymentResources.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", + "title": "Successful List Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json new file mode 100644 index 000000000000..5d285673c9d9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListDeployments.json @@ -0,0 +1,51 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json new file mode 100644 index 000000000000..b8f3ea2f2997 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json new file mode 100644 index 000000000000..78aaca5ce95d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b09d2909bb85 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulListTrainingJobs.json @@ -0,0 +1,92 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..56580a2abafb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..c1a56e4c4962 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json new file mode 100644 index 000000000000..cb70afa30274 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulTrainProject.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..d2d38edbbc3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/examples/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", + "title": "Successful Unassign Deployment Resources", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json index 78906d295c9a..29e06dce5769 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json @@ -3,212 +3,239 @@ "info": { "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", "version": "2023-04-01", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in <a href=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>." - }, - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + "description": "The language service API is a suite of natural language processing (NLP) skills\nbuilt with best-in-class Microsoft machine learning algorithms. The API can be\nused to analyze unstructured text for tasks such as sentiment analysis, key\nphrase extraction, language detection and question answering. Further\ndocumentation can be found in <a\nhref=\"https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview\">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\\n\\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" } - }, - "apim_key": { - "type": "apiKey", - "description": "A subscription key for a Language service resource.", - "name": "Ocp-Apim-Subscription-Key", - "in": "header" - } + ] }, - "security": [ - { - "AADToken": [ - "https://cognitiveservices.azure.com/.default" - ] - }, - { - "apim_key": [] - } + "schemes": [ + "https" ], "x-ms-parameterized-host": { "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { - "$ref": "common.json#/parameters/Endpoint" + "name": "endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoint (e.g.,\nhttps://<resource-name>.api.cognitiveservices.azure.com).", + "required": true, + "type": "string" + }, + { + "name": "Endpoint", + "in": "path", + "required": true, + "type": "string" } ] }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + }, + { + "OAuth2Auth": [ + "https://cognitiveservices.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "OAuth2Auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "https://cognitiveservices.azure.com/.default": "" + }, + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token" + } + }, + "tags": [], "paths": { "/authoring/analyze-conversations/projects": { "get": { - "description": "Lists the existing projects.", "operationId": "ConversationalAnalysisAuthoring_ListProjects", - "produces": [ - "application/json" - ], + "description": "Lists the existing projects.", "parameters": [ { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "The metadata of projects.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + "$ref": "./examples/SuccessfulListProjects.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}": { - "patch": { - "description": "Creates a new project or updates an existing one.", - "operationId": "ConversationalAnalysisAuthoring_CreateProject", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "description": "Gets the details of a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "in": "body", - "name": "body", - "description": "The project parameters.", + "name": "projectName", + "in": "path", + "description": "The new project name.", "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "type": "string", + "maxLength": 100 } ], "responses": { "200": { - "description": "The metadata of the updated project, if it already exists.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "201": { - "description": "The metadata of the created project.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + "Successful Get Project": { + "$ref": "./examples/SuccessfulGetProject.json" } } }, - "get": { - "description": "Gets the details of a project.", - "operationId": "ConversationalAnalysisAuthoring_GetProject", - "produces": [ - "application/json" + "patch": { + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "description": "Creates a new project or updates an existing one.", + "consumes": [ + "application/merge-patch+json" ], "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The request body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } } ], "responses": { "200": { - "description": "The metadata of the project.", + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + "Successful Create Project": { + "$ref": "./examples/SuccessfulCreateProject.json" } } }, "delete": { - "description": "Deletes a project.", "operationId": "ConversationalAnalysisAuthoring_DeleteProject", - "produces": [ - "application/json" - ], + "description": "Deletes a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + "$ref": "./examples/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -216,59 +243,105 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "description": "Triggers a job to export a project's data.", "operationId": "ConversationalAnalysisAuthoring_Export", - "produces": [ - "application/json" - ], + "description": "Triggers a job to export a project's data.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." + } + ] + } }, { - "in": "query", "name": "assetKind", + "in": "query", "description": "Kind of asset to export.", - "type": "string", - "x-ms-parameter-location": "method" + "required": false, + "type": "string" }, { - "in": "query", "name": "trainedModelLabel", + "in": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" + "required": false, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + "$ref": "./examples/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -276,54 +349,79 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "operationId": "ConversationalAnalysisAuthoring_Import", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a job to import a project. If a project with the same name already\nexists, the data of that project is replaced.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "format", + "in": "query", + "description": "The format of the exported project file to use.", + "required": false, + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "name": "Luis", + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" }, { - "in": "body", "name": "body", + "in": "body", "description": "The project data to import.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + "$ref": "./examples/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -331,51 +429,51 @@ }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "description": "Triggers a training job for a project.", "operationId": "ConversationalAnalysisAuthoring_Train", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Triggers a training job for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "in": "body", "name": "body", + "in": "body", "description": "The training input parameters.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + "$ref": "./examples/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -383,233 +481,199 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "description": "Lists the deployments belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListDeployments", - "produces": [ - "application/json" - ], + "description": "Lists the deployments belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all deployments.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + "$ref": "./examples/SuccessfulListDeployments.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { - "post": { - "description": "Swaps two existing deployments with each other.", - "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "body", - "name": "body", - "description": "The job object to swap two deployments.", - "required": true, - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" - } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", - "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" - } - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, - "x-ms-long-running-operation": true - } - }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "description": "Gets the details of a deployment.", "operationId": "ConversationalAnalysisAuthoring_GetDeployment", - "produces": [ - "application/json" - ], + "description": "Gets the details of a deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The Deployment info.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + "$ref": "./examples/SuccessfulGetDeployment.json" } } }, "put": { - "description": "Creates a new deployment or replaces an existing one.", "operationId": "ConversationalAnalysisAuthoring_DeployProject", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" }, { - "in": "body", "name": "body", + "in": "body", "description": "The new deployment info.", "required": true, "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" } - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + "$ref": "./examples/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true }, "delete": { - "description": "Deletes a project deployment.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", - "produces": [ - "application/json" - ], + "description": "Deletes a project deployment.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "deploymentName", + "in": "path", + "description": "The name of the specific deployment of the project to use.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -617,323 +681,423 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "description": "Gets the status of an existing deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an existing deployment job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/DeploymentNamePathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "deploymentName", + "in": "path", + "description": "Represents deployment name.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The deployment job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/SuccessfulGetDeploymentStatus.json" } } } }, - "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { - "get": { - "description": "Gets the status of an existing swap deployment job.", - "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", - "produces": [ - "application/json" - ], + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "description": "Swaps two existing deployments with each other.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "body", + "in": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } } ], "responses": { - "200": { - "description": "The swap deployment job result.", - "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." + } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + "Successful Swap Deployments": { + "$ref": "./examples/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "description": "Gets the status of an existing swap deployment job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 + }, + { + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsJobState" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/SuccessfulGetSwapDeploymentsStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status of an export job. Once job completes, returns the project\nmetadata, and assets.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The status of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/SuccessfulGetExportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "description": "Gets the status for an import.", "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for an import.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/SuccessfulGetImportStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "description": "Lists the trained models belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", - "produces": [ - "application/json" - ], + "description": "Lists the trained models belonging to a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of all trained models.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + "$ref": "./examples/SuccessfulListModels.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "description": "Gets the details of a trained model.", "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", - "produces": [ - "application/json" - ], + "description": "Gets the details of a trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "Trained model info", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + "$ref": "./examples/SuccessfulGetModel.json" } } }, "delete": { - "description": "Deletes an existing trained model.", "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", - "produces": [ - "application/json" - ], + "description": "Deletes an existing trained model.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "204": { - "description": "Deleted successfully." + "description": "There is no content to send for this request, but the headers may be useful. " }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + "$ref": "./examples/SuccessfulDeleteModel.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", - "produces": [ - "application/json" - ], + "description": "Restores the snapshot of this trained model to be the current working directory\nof the project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the created job.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" + "$ref": "./examples/SuccessfulLoadSnapshot.json" } }, "x-ms-long-running-operation": true @@ -941,266 +1105,301 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", - "produces": [ - "application/json" - ], + "description": "Gets the detailed results of the evaluation for a trained model. This includes\nthe raw inference results for the data included in the evaluation process.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/StringIndexTypeQueryParameter" } ], "responses": { "200": { - "description": "List of the evaluation predictions.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", - "produces": [ - "application/json" - ], + "description": "Gets the evaluation summary of a trained model. The summary includes high level\nperformance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "List of all evaluation results.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/SuccessfulGetModelEvaluationSummary.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "description": "Gets the status for loading a snapshot.", "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for loading a snapshot.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "trainedModelLabel", + "in": "path", + "description": "The trained model label.", + "required": true, + "type": "string" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The details of the long running operation.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + "$ref": "./examples/SuccessfulGetLoadSnapshotStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "description": "Lists the non-expired training jobs created for a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", - "produces": [ - "application/json" - ], + "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/SkipParameter" + "$ref": "#/parameters/Azure.Core.TopQueryParameter" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" } ], "responses": { "200": { - "description": "List of the training jobs.", + "description": "The request has succeeded.", "schema": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + "$ref": "#/definitions/PagedConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" + "nextLinkName": "nextLink" } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "description": "Gets the status for a training job.", "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The new project name.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The training job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/SuccessfulGetTrainStatus.json" } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "description": "Triggers a cancellation for a running training job.", "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", - "produces": [ - "application/json" - ], + "description": "Triggers a cancellation for a running training job.", "parameters": [ { - "$ref": "common.json#/parameters/ProjectNamePathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "name": "projectName", + "in": "path", + "description": "The name of the project to use.", + "required": true, + "type": "string", + "maxLength": 100 }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "202": { - "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "description": "The request has been accepted for processing, but processing has not yet completed.", "headers": { - "operation-location": { - "description": "The location of the status API for monitoring the job cancellation.", - "type": "string" + "Operation-Location": { + "type": "string", + "format": "uri", + "description": "The location for monitoring the operation state." } } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/SuccessfulCancelTrainingJob.json" } }, "x-ms-long-running-operation": true @@ -1208,2003 +1407,2498 @@ }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "description": "Gets the status for a project deletion job.", "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", - "produces": [ - "application/json" - ], + "description": "Gets the status for a project deletion job.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "jobId", + "in": "path", + "description": "The job ID.", + "required": true, + "type": "string" } ], "responses": { "200": { - "description": "The project deletion job result.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/SuccessfulGetProjectDeletionStatus.json" } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "description": "Lists the supported languages for the given project type.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", - "produces": [ - "application/json" - ], + "description": "Lists the supported languages for the given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported languages.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { - "Successful Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + "Successful Get Supported Languages": { + "$ref": "./examples/SuccessfulGetSupportedLanguages.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", - "produces": [ - "application/json" - ], + "description": "Lists the supported prebuilt entities that can be used while creating composed\nentities.", "parameters": [ { - "in": "query", - "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string", - "x-ms-parameter-location": "method" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { + "name": "language", "in": "query", - "name": "multilingual", - "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", - "type": "string", - "x-ms-parameter-location": "method" + "description": "The language to get supported prebuilt entities for. Required if multilingual\nis false. This is BCP-47 representation of a language. For example, use \"en\"\nfor English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/TopParameter" + "name": "multilingual", + "in": "query", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual\nprojects. If true, the language parameter is ignored.", + "required": false, + "type": "string" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "The list of supported prebuilt entities.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + "$ref": "./examples/SuccessfulGetSupportedPrebuiltEntities.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "description": "Lists the support training config version for a given project type.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", - "produces": [ - "application/json" - ], + "description": "Lists the support training config version for a given project type.", "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" - }, - { - "$ref": "common.json#/parameters/TopParameter" + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { - "$ref": "common.json#/parameters/SkipParameter" + "name": "projectKind", + "in": "query", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/MaxPageSizeParameter" + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "required": false, + "type": "integer", + "format": "int32" }, { - "$ref": "common.json#/parameters/ApiVersionParameter" + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "required": false, + "type": "integer", + "format": "int32" } ], "responses": { "200": { - "description": "List of config versions.", + "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" } }, "default": { - "description": "Error response.", + "description": "An unexpected error response.", "schema": { - "$ref": "common.json#/definitions/ErrorResponse" + "$ref": "#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/SuccessfulGetSupportedTrainingConfigVersions.json" } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "value" } } } }, "definitions": { - "ConversationalAnalysisAuthoringCompositionSetting": { + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, + "CompositionSetting": { + "type": "string", "enum": [ "returnLongestOverlap", "requireExactOverlap", "separateComponents", "combineComponents" ], - "type": "string", "x-ms-enum": { "name": "CompositionSetting", "modelAsString": true, "values": [ { + "name": "returnLongestOverlap", "value": "returnLongestOverlap", - "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." + "description": "When two or more components are found in the text and overlap, the component\nwith the longest set of characters is returned." }, { + "name": "requireExactOverlap", "value": "requireExactOverlap", - "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." + "description": "All components must overlap at the exact same characters in the text for the\nentity to return. If one of the defined components is not matched or predicted,\nthe entity will not return." }, { + "name": "separateComponents", "value": "separateComponents", - "description": "Every component's match or prediction is returned as a separate instance of the entity." + "description": "Every component's match or prediction is returned as a separate instance of the\nentity." }, { + "name": "combineComponents", "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + "description": "When two or more components are found in the text and overlap, the components'\nspans are merged together into one span combining all of them." } ] - }, - "x-ms-client-name": "CompositionSetting" + } }, "ConversationalAnalysisAuthoringConfusionMatrix": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" - }, - "x-ms-client-name": "ConfusionMatrix" + } }, "ConversationalAnalysisAuthoringConfusionMatrixCell": { - "description": "Represents a cell in a confusion matrix.", - "required": [ - "normalizedValue", - "rawValue" - ], "type": "object", + "description": "Represents a cell in a confusion matrix.", "properties": { "normalizedValue": { + "type": "number", "format": "float", - "description": "Represents normalized value in percentages.", - "type": "number" + "description": "Represents normalized value in percentages." }, "rawValue": { + "type": "number", "format": "float", - "description": "Represents raw value.", - "type": "number" + "description": "Represents raw value." } }, - "x-ms-client-name": "ConfusionMatrixCell" + "required": [ + "normalizedValue", + "rawValue" + ] }, "ConversationalAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" - }, - "x-ms-client-name": "ConfusionMatrixRow" + } }, "ConversationalAnalysisAuthoringConversationExportedEntity": { - "description": "Represents an entity with its components.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an entity with its components.", "properties": { "category": { - "description": "The category of the entity.", - "type": "string" + "type": "string", + "description": "The category of the entity." }, "compositionSetting": { - "description": "The behavior to follow when the entity's components overlap with each other.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + "$ref": "#/definitions/CompositionSetting", + "description": "The behavior to follow when the entity's components overlap with each other." }, "list": { - "description": "The list component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList", + "description": "The list component of the entity." }, "prebuilts": { - "description": "The prebuilt entities components.", "type": "array", + "description": "The prebuilt entities components.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "regex": { - "description": "The regex component of the entity.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex", + "description": "The regex component of the entity." }, "requiredComponents": { - "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "type": "array", + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", "items": { "type": "string" } } }, - "x-ms-client-name": "ConversationExportedEntity" - }, - "ConversationalAnalysisAuthoringConversationExportedIntent": { - "description": "Represents an exported intent of a conversational project.", "required": [ "category" - ], + ] + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { "type": "object", + "description": "Represents an exported intent of a conversational project.", "properties": { "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "ConversationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { - "description": "Represents the exported assets of a conversational project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the exported assets of a conversational project.", "properties": { "intents": { - "description": "The intents defined in the project.", "type": "array", + "description": "The intents defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "entities": { - "description": "The entities defined in the project.", "type": "array", + "description": "The entities defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "The utterances defined in the project.", "type": "array", + "description": "The utterances defined in the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ConversationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringConversationExportedUtterance": { - "description": "Represents an exported utterance for a conversational project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an exported utterance for a conversational project.", "properties": { "entities": { - "description": "Represents the entity labels of the utterance.", "type": "array", + "description": "Represents the entity labels of the utterance.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" - } + }, + "x-ms-identifiers": [] }, "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "ConversationExportedUtterance" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringCreateDeploymentOptions": { - "description": "Represents the options for creating or updating a project deployment.", - "required": [ - "trainedModelLabel" - ], "type": "object", + "description": "Represents the options for creating or updating a project deployment.", "properties": { "trainedModelLabel": { - "description": "Represents the trained model label.", - "type": "string" + "type": "string", + "description": "Represents the trained model label." } }, - "x-ms-client-name": "CreateDeploymentOptions" + "required": [ + "trainedModelLabel" + ] }, "ConversationalAnalysisAuthoringCreateProjectOptions": { + "type": "object", "description": "Represents the options used to create or update a project.", - "required": [ - "projectKind", - "projectName", - "language" - ], - "type": "object", "properties": { "projectKind": { - "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "Represents the project kind." }, "settings": { - "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", + "description": "The project settings." }, "projectName": { - "description": "The new project name.", - "type": "string" + "type": "string", + "description": "The new project name." }, "multilingual": { - "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "type": "boolean", + "description": "Whether the project would be used for multiple languages or not." }, "description": { - "description": "The project description.", - "type": "string" + "type": "string", + "description": "The project description." }, "language": { - "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "CreateProjectOptions" + "required": [ + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringDeploymentJobState": { - "description": "Represents the state of a deployment job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "DeploymentJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { - "description": "Represents the evaluation result summary for the project's entities.", - "required": [ - "confusionMatrix", - "entities", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation result summary for the project's entities.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two entities (the two entities can be\nthe same). The matrix is between the entity that was labelled and the entity\nthat was predicted." }, "entities": { - "description": "Represents the entities evaluation summary.", "type": "object", + "description": "Represents the entities evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "EntitiesEvaluationSummary" + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] }, "ConversationalAnalysisAuthoringEntityEvaluationSummary": { - "description": "Represents the evaluation result for an entity.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "Represents the evaluation result for an entity.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "EntityEvaluationSummary" - }, - "ConversationalAnalysisAuthoringEvaluationKind": { - "enum": [ - "percentage", - "manual" - ], - "type": "string", - "x-ms-enum": { - "name": "EvaluationKind", - "modelAsString": true, - "values": [ - { - "value": "percentage", - "description": "Split the data into training and test sets according to user-defined percentages." - }, - { - "value": "manual", - "description": "Split the data according to the chosen dataset for every example in the data." - } - ] - }, - "x-ms-client-name": "EvaluationKind" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringEvaluationOptions": { - "description": "Represents the options used running the evaluation.", "type": "object", + "description": "Represents the options used running the evaluation.", "properties": { "kind": { - "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + "$ref": "#/definitions/EvaluationKind", + "description": "Represents the evaluation kind. By default, the evaluation kind is set to\npercentage." }, "trainingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the training dataset split percentage. Only needed in case the\nevaluation kind is percentage." }, "testingSplitPercentage": { + "type": "integer", "format": "int32", - "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", - "type": "integer" + "description": "Represents the testing dataset split percentage. Only needed in case the\nevaluation kind is percentage." } - }, - "x-ms-client-name": "EvaluationOptions" + } }, - "ConversationalAnalysisAuthoringEvaluationResults": { - "description": "Represent a list of utterances' evaluation results.", - "required": [ - "value", - "nextLink" - ], + "ConversationalAnalysisAuthoringEvaluationSummary": { "type": "object", + "description": "Represents the evaluation result summary.", "properties": { - "value": { - "description": "The utterances evaluation results.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" - } + "entitiesEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary", + "description": "Contains the data related to entities evaluation." }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "intentsEvaluation": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary", + "description": "Contains the data related to intents evaluation." + }, + "evaluationOptions": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "The options that were used while running the evaluation." } }, - "x-ms-client-name": "EvaluationResults" - }, - "ConversationalAnalysisAuthoringEvaluationSummary": { - "description": "Represents the evaluation result summary.", "required": [ "entitiesEvaluation", "intentsEvaluation" - ], + ] + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { "type": "object", + "description": "Represents the state of an export job.", "properties": { - "entitiesEvaluation": { - "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + "jobId": { + "type": "string", + "description": "The job ID." }, - "intentsEvaluation": { - "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." }, - "evaluationOptions": { - "description": "The options that were used while running the evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "resultUrl": { + "type": "string", + "description": "The URL to use in order to download the exported project." } }, - "x-ms-client-name": "EvaluationSummary" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestration": { - "description": "Defines the orchestration details for a Conversational project target.", - "required": [ - "projectName", - "deploymentName" - ], "type": "object", + "description": "Defines the orchestration details for a Conversational project target.", "properties": { "projectName": { - "description": "The name of the targeted project.", - "type": "string" + "type": "string", + "description": "The name of the targeted project." }, "deploymentName": { - "description": "The name of the targeted deployment.", - "type": "string" + "type": "string", + "description": "The name of the targeted deployment." } }, - "x-ms-client-name": "ExportedConversationOrchestration" + "required": [ + "projectName", + "deploymentName" + ] }, "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Conversational project target.", + "properties": { + "conversationOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration", + "description": "The Conversational project target details." + } + }, "required": [ "conversationOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "conversationOrchestration": { - "description": "The Conversational project target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" - } - }, - "x-ms-discriminator-value": "Conversation", - "x-ms-client-name": "ExportedConversationOrchestrationOptions" + "x-ms-discriminator-value": "Conversation" }, "ConversationalAnalysisAuthoringExportedEntityList": { - "description": "Represents a list component of an entity.", "type": "object", + "description": "Represents a list component of an entity.", "properties": { "sublists": { - "description": "The sub-lists of the list component.", "type": "array", + "description": "The sub-lists of the list component.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityList" + } }, "ConversationalAnalysisAuthoringExportedEntityListSynonym": { - "description": "Represents a list of synonyms inside a list component", "type": "object", + "description": "Represents a list of synonyms inside a list component", "properties": { "language": { - "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the synonyms. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "values": { - "description": "The list of synonyms.", "type": "array", + "description": "The list of synonyms.", "items": { "type": "string" } } - }, - "x-ms-client-name": "ExportedEntityListSynonym" + } }, "ConversationalAnalysisAuthoringExportedEntityRegex": { - "description": "Represents a regex component of an entity.", "type": "object", + "description": "Represents a regex component of an entity.", "properties": { "expressions": { - "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "array", + "description": "The regex expressions of the regex component. These expressions follow the .NET\nregex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntityRegex" + } }, "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { - "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "type": "object", + "description": "Represents a regex expression inside a regex component. This expression follows\nthe .NET regex syntax. For reference, check here:\nhttps://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", "properties": { "regexKey": { - "description": "The key of the regex expression.", - "type": "string" + "type": "string", + "description": "The key of the regex expression." }, "language": { - "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the language of the regex expression. This is BCP-47 representation\nof a language. For example, use \"en\" for English, \"en-gb\" for English (UK),\n\"es\" for Spanish etc." }, "regexPattern": { - "description": "The regex pattern.", - "type": "string" + "type": "string", + "description": "The regex pattern." } - }, - "x-ms-client-name": "ExportedEntityRegexExpression" + } }, "ConversationalAnalysisAuthoringExportedEntitySublist": { - "description": "Represents a sub-list inside a list component.", "type": "object", + "description": "Represents a sub-list inside a list component.", "properties": { "listKey": { - "description": "The key of the sub-list.", - "type": "string" + "type": "string", + "description": "The key of the sub-list." }, "synonyms": { - "description": "The phrases of that correspond to the sub-list.", "type": "array", + "description": "The phrases of that correspond to the sub-list.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" - } + }, + "x-ms-identifiers": [] } - }, - "x-ms-client-name": "ExportedEntitySublist" + } }, "ConversationalAnalysisAuthoringExportedLuisOrchestration": { - "description": "Defines the orchestration details for a LUIS application target.", - "required": [ - "appId" - ], "type": "object", + "description": "Defines the orchestration details for a LUIS application target.", "properties": { "appId": { - "format": "uuid", - "description": "The LUIS application ID.", - "type": "string", - "example": "00000000-0000-0000-0000-000000000000" + "$ref": "#/definitions/Azure.Core.uuid", + "description": "The LUIS application ID." }, "appVersion": { - "description": "The targeted version Id.", - "type": "string" + "type": "string", + "description": "The targeted version Id." }, "slotName": { - "description": "The targeted slot name.", - "type": "string" + "type": "string", + "description": "The targeted slot name." } }, - "x-ms-client-name": "ExportedLuisOrchestration" - }, - "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "required": [ + "appId" + ] + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a LUIS application target.", + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration", + "description": "The LUIS application target details." + } + }, "required": [ "luisOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "luisOrchestration": { - "description": "The LUIS application target details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" - } - }, - "x-ms-discriminator-value": "Luis", - "x-ms-client-name": "ExportedLuisOrchestrationOptions" + "x-ms-discriminator-value": "Luis" }, "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { - "description": "Represents the options used to define the orchestration behavior of an intent.", - "required": [ - "targetProjectKind" - ], "type": "object", + "description": "Represents the options used to define the orchestration behavior of an intent.", "properties": { "targetProjectKind": { - "description": "The kind of the target used in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + "$ref": "#/definitions/OrchestrationTargetProjectKind" } }, "discriminator": "targetProjectKind", - "x-ms-client-name": "ExportedOrchestrationOptions" + "required": [ + "targetProjectKind" + ] }, "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { - "description": "Represents an exported prebuilt entity component", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported prebuilt entity component", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." } }, - "x-ms-client-name": "ExportedPrebuiltEntity" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringExportedProject": { - "description": "Represents an exported project.", - "required": [ - "projectFileVersion", - "stringIndexType", - "metadata" - ], "type": "object", + "description": "Represents an exported project.", "properties": { "projectFileVersion": { - "description": "The version of the exported file.", - "type": "string" + "type": "string", + "description": "The version of the exported file." }, "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + "$ref": "#/definitions/StringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets." }, "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions", + "description": "Represents the project metadata." }, "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets", + "description": "Represents the project assets." } }, - "x-ms-client-name": "ExportedProject" + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ] }, "ConversationalAnalysisAuthoringExportedProjectAssets": { - "description": "Represents the assets of an exported project.", - "required": [ - "projectKind" - ], "type": "object", + "description": "Represents the assets of an exported project.", "properties": { "projectKind": { - "description": "The type of project containing the assets.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "$ref": "#/definitions/ProjectKind", + "description": "The type of project containing the assets." } }, "discriminator": "projectKind", - "x-ms-client-name": "ExportedProjectAssets" - }, - "ConversationalAnalysisAuthoringExportedProjectFormat": { - "enum": [ - "Conversation", - "Luis" - ], - "type": "string", - "x-ms-enum": { - "name": "ExportedProjectFormat", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "Specifies the format for a conversational project." - }, - { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." - } - ] - }, - "x-ms-client-name": "ExportedProjectFormat" + "required": [ + "projectKind" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { - "description": "Defines the orchestration details for a Question Answering project target.", - "required": [ - "projectName" - ], "type": "object", + "description": "Defines the orchestration details for a Question Answering project target.", "properties": { "projectName": { - "description": "The name of the target project.", - "type": "string" + "type": "string", + "description": "The name of the target project." } }, - "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + "required": [ + "projectName" + ] }, "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "type": "object", "description": "Represents the orchestration options for a Question Answering project target.", + "properties": { + "questionAnsweringOrchestration": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration", + "description": "The Question Answering project details." + } + }, "required": [ "questionAnsweringOrchestration" ], - "type": "object", "allOf": [ { "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], - "properties": { - "questionAnsweringOrchestration": { - "description": "The Question Answering project details.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" - } - }, - "x-ms-discriminator-value": "QuestionAnswering", - "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + "x-ms-discriminator-value": "QuestionAnswering" }, "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { - "description": "Represents an entity label for an utterance.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents an entity label for an utterance.", "properties": { "category": { - "description": "The category of the entity label.", - "type": "string" + "type": "string", + "description": "The category of the entity label." }, "offset": { + "type": "integer", "format": "int32", - "description": "Start position for the entity text.", - "type": "integer" + "description": "Start position for the entity text." }, "length": { + "type": "integer", "format": "int32", - "description": "Length for the entity text.", - "type": "integer" + "description": "Length for the entity text." } }, - "x-ms-client-name": "ExportedUtteranceEntityLabel" + "required": [ + "category", + "offset", + "length" + ] }, - "ConversationalAnalysisAuthoringExportProjectJobState": { - "description": "Represents the state of an export job.", + "ConversationalAnalysisAuthoringImportProjectJobState": { "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], + "description": "Represents the state of an import job.", "properties": { - "resultUrl": { - "description": "The URL to use in order to download the exported project.", - "type": "string" + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "ExportProjectJobState" - }, - "ConversationalAnalysisAuthoringImportProjectJobState": { - "description": "Represents the state of an import job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "ImportProjectJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringIntentEvaluationSummary": { - "description": "The evaluation summary for an intent.", - "required": [ - "f1", - "precision", - "recall", - "truePositiveCount", - "trueNegativeCount", - "falsePositiveCount", - "falseNegativeCount" - ], "type": "object", + "description": "The evaluation summary for an intent.", "properties": { "f1": { + "type": "number", "format": "double", - "description": "Represents the model precision", - "type": "number" + "description": "Represents the model precision" }, "precision": { + "type": "number", "format": "double", - "description": "Represents the model recall", - "type": "number" + "description": "Represents the model recall" }, "recall": { + "type": "number", "format": "double", - "description": "Represents the model F1 score", - "type": "number" + "description": "Represents the model F1 score" }, "truePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true positive", - "type": "integer" + "description": "Represents the count of true positive" }, "trueNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of true negative", - "type": "integer" + "description": "Represents the count of true negative" }, "falsePositiveCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false positive", - "type": "integer" + "description": "Represents the count of false positive" }, "falseNegativeCount": { + "type": "integer", "format": "int32", - "description": "Represents the count of false negative", - "type": "integer" + "description": "Represents the count of false negative" } }, - "x-ms-client-name": "IntentEvaluationSummary" + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ] }, "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { - "description": "Represents the evaluation summary for the project's intents.", - "required": [ - "confusionMatrix", - "intents", - "microF1", - "microPrecision", - "microRecall", - "macroF1", - "macroPrecision", - "macroRecall" - ], "type": "object", + "description": "Represents the evaluation summary for the project's intents.", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix", + "description": "Represents the confusion matrix between two intents (the two intents can be the\nsame). The matrix is between the intent that was labelled and the intent that\nwas predicted." }, "intents": { - "description": "Represents the intents evaluation summary.", "type": "object", + "description": "Represents the intents evaluation summary.", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" } }, "microF1": { + "type": "number", "format": "float", - "description": "Represents the micro F1", - "type": "number" + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive." }, "microPrecision": { + "type": "number", "format": "float", - "description": "Represents the micro precision", - "type": "number" + "description": "Represents the micro precision. Expected value is a float between 0 and 1\ninclusive." }, "microRecall": { + "type": "number", "format": "float", - "description": "Represents the micro recall", - "type": "number" + "description": "Represents the micro recall. Expected value is a float between 0 and 1\ninclusive." }, "macroF1": { + "type": "number", "format": "float", - "description": "Represents the macro F1", - "type": "number" + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive." }, "macroPrecision": { + "type": "number", "format": "float", - "description": "Represents the macro precision", - "type": "number" + "description": "Represents the macro precision. Expected value is a float between 0 and 1\ninclusive." }, "macroRecall": { + "type": "number", "format": "float", - "description": "Represents the macro recall", - "type": "number" + "description": "Represents the macro recall. Expected value is a float between 0 and 1\ninclusive." } }, - "x-ms-client-name": "IntentsEvaluationSummary" - }, - "ConversationalAnalysisAuthoringJobState": { - "description": "Represents a job's state.", "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "status" - ], + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ] + }, + "ConversationalAnalysisAuthoringLoadSnapshotJobState": { "type": "object", + "description": "Represents the state of loading a snapshot job.", "properties": { "jobId": { - "description": "The job ID.", - "type": "string" + "type": "string", + "description": "The job ID." }, "createdDateTime": { + "type": "string", "format": "date-time", - "description": "The creation date time of the job.", - "type": "string" + "description": "The creation date time of the job." }, "lastUpdatedDateTime": { + "type": "string", "format": "date-time", - "description": "The last date time the job was updated.", - "type": "string" + "description": "The last date time the job was updated." }, "expirationDateTime": { + "type": "string", "format": "date-time", - "description": "The expiration date time of the job.", - "type": "string" + "description": "The expiration date time of the job." }, "status": { - "description": "The job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + "$ref": "#/definitions/JobStatus", + "description": "The job status." }, "warnings": { - "description": "The warnings that were encountered while executing the job.", "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, "errors": { - "description": "The errors encountered while executing the job.", "type": "array", + "description": "The errors encountered while executing the job.", "items": { - "$ref": "common.json#/definitions/Error" - } + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "JobState" - }, - "ConversationalAnalysisAuthoringJobStatus": { - "enum": [ - "notStarted", - "running", - "succeeded", - "failed", - "cancelled", - "cancelling", - "partiallyCompleted" - ], - "type": "string", - "x-ms-enum": { - "name": "JobStatus", - "modelAsString": true - }, - "x-ms-client-name": "JobStatus" - }, - "ConversationalAnalysisAuthoringLoadSnapshotJobState": { - "description": "Represents the state of loading a snapshot job.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "x-ms-client-name": "LoadSnapshotJobState" + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { - "description": "Represents an exported intent for an orchestration project.", - "required": [ - "category" - ], "type": "object", + "description": "Represents an exported intent for an orchestration project.", "properties": { "orchestration": { - "description": "Specifies the behavior of this intent in the orchestration flow.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions", + "description": "Specifies the behavior of this intent in the orchestration flow." }, "category": { - "description": "The intent category.", - "type": "string" + "type": "string", + "description": "The intent category." } }, - "x-ms-client-name": "OrchestrationExportedIntent" + "required": [ + "category" + ] }, "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { - "description": "Represents the assets of an orchestration project.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" - } - ], + "description": "Represents the assets of an orchestration project.", "properties": { "intents": { - "description": "Represents the intents of the project.", "type": "array", + "description": "Represents the intents of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" - } + }, + "x-ms-identifiers": [] }, "utterances": { - "description": "Represents the utterances of the project.", "type": "array", + "description": "Represents the utterances of the project.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-discriminator-value": "Orchestration", - "x-ms-client-name": "OrchestrationExportedProjectAssets" + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "x-ms-discriminator-value": "Orchestration" }, "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { - "description": "Represents an utterance of an orchestration project.", - "required": [ - "text", - "intent" - ], "type": "object", + "description": "Represents an utterance of an orchestration project.", "properties": { "text": { - "description": "The utterance text.", - "type": "string" + "type": "string", + "description": "The utterance text." }, "language": { - "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance's language. This is BCP-47 representation of a\nlanguage. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for\nSpanish etc." }, "intent": { - "description": "The intent of the utterance.", - "type": "string" + "type": "string", + "description": "The intent of the utterance." }, "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" + "type": "string", + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'." } }, - "x-ms-client-name": "OrchestrationExportedUtterance" - }, - "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { - "enum": [ - "Luis", - "Conversation", - "QuestionAnswering" - ], - "type": "string", - "x-ms-enum": { - "name": "OrchestrationTargetProjectKind", - "modelAsString": true - }, - "x-ms-client-name": "OrchestrationTargetProjectKind" + "required": [ + "text", + "intent" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntities": { - "description": "Represents a list of the retrieved supported prebuilt entities.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of the retrieved supported prebuilt entities.", "properties": { "value": { - "description": "The supported prebuilt entities.", "type": "array", + "description": "The supported prebuilt entities.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "PrebuiltEntities" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringPrebuiltEntity": { - "description": "Represents a supported prebuilt entity.", - "required": [ - "category", - "description", - "examples" - ], "type": "object", + "description": "Represents a supported prebuilt entity.", "properties": { "category": { - "description": "The prebuilt entity category.", - "type": "string" + "type": "string", + "description": "The prebuilt entity category." }, "description": { - "description": "The description.", - "type": "string" + "type": "string", + "description": "The description." }, "examples": { - "description": "English examples for the entity.", - "type": "string" + "type": "string", + "description": "English examples for the entity." } }, - "x-ms-client-name": "PrebuiltEntity" + "required": [ + "category", + "description", + "examples" + ] }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "description": "Represents the state of a project deletion job.", "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + "description": "Represents the state of a project deletion job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] } - ], - "x-ms-client-name": "ProjectDeletionJobState" + }, + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] }, "ConversationalAnalysisAuthoringProjectDeployment": { - "description": "Represents a project deployment.", - "required": [ - "deploymentName", - "modelId", - "lastTrainedDateTime", - "lastDeployedDateTime", - "deploymentExpirationDate", - "modelTrainingConfigVersion" - ], "type": "object", + "description": "Represents a project deployment.", "properties": { "deploymentName": { - "description": "Represents deployment name.", - "type": "string" + "type": "string", + "description": "Represents deployment name." }, "modelId": { - "description": "Represents deployment modelId.", - "type": "string" + "type": "string", + "description": "Represents deployment modelId." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last trained time.", - "type": "string" + "description": "Represents deployment last trained time." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents deployment last deployed time.", - "type": "string" + "description": "Represents deployment last deployed time." }, "deploymentExpirationDate": { + "type": "string", "format": "date", - "description": "Represents deployment expiration date in the runtime.", - "type": "string" + "description": "Represents deployment expiration date in the runtime." }, "modelTrainingConfigVersion": { - "description": "Represents model training config version.", - "type": "string" - } - }, - "x-ms-client-name": "ProjectDeployment" - }, - "ConversationalAnalysisAuthoringProjectDeployments": { - "description": "Represents a list of retrieved deployments.", - "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of retrieved deployments.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" - } - }, - "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "Represents model training config version." } }, - "x-ms-client-name": "ProjectDeployments" - }, - "ConversationalAnalysisAuthoringProjectKind": { - "enum": [ - "Conversation", - "Orchestration" - ], - "type": "string", - "x-ms-enum": { - "name": "ProjectKind", - "modelAsString": true, - "values": [ - { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." - } - ] - }, - "x-ms-client-name": "ProjectKind" + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion" + ] }, "ConversationalAnalysisAuthoringProjectMetadata": { - "description": "Represents the metadata of a project.", - "required": [ - "createdDateTime", - "lastModifiedDateTime", - "projectKind", - "projectName", - "language" - ], "type": "object", + "description": "Represents the metadata of a project.", "properties": { "createdDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastModifiedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project creation datetime.", - "type": "string" + "description": "Represents the project creation datetime." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last trained datetime.", - "type": "string" + "description": "Represents the project last trained datetime." }, "lastDeployedDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the project last deployed datetime.", - "type": "string" + "description": "Represents the project last deployed datetime." }, "projectKind": { + "$ref": "#/definitions/ProjectKind", "description": "Represents the project kind.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + "x-ms-mutability": [ + "read", + "create" + ] }, "settings": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings", "description": "The project settings.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + "x-ms-mutability": [ + "read", + "create" + ] }, "projectName": { + "type": "string", "description": "The new project name.", - "type": "string" + "maxLength": 100, + "x-ms-mutability": [ + "read", + "create" + ] }, "multilingual": { + "type": "boolean", "description": "Whether the project would be used for multiple languages or not.", - "type": "boolean" + "x-ms-mutability": [ + "read", + "create" + ] }, "description": { + "type": "string", "description": "The project description.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] }, "language": { + "type": "string", "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "x-ms-mutability": [ + "read", + "create" + ] } }, - "x-ms-client-name": "ProjectMetadata" + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ] }, "ConversationalAnalysisAuthoringProjectSettings": { - "description": "Represents the settings used to define the project behavior.", - "required": [ - "confidenceThreshold" - ], "type": "object", + "description": "Represents the settings used to define the project behavior.", "properties": { "confidenceThreshold": { + "type": "number", "format": "float", - "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", - "type": "number" + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive." } }, - "x-ms-client-name": "ProjectSettings" - }, - "ConversationalAnalysisAuthoringProjectsMetadata": { - "description": "Represents a list of retrieved projects' metadata.", "required": [ - "value", - "nextLink" - ], - "type": "object", - "properties": { - "value": { - "description": "The list of projects.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" - } - }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true - } - }, - "x-ms-client-name": "ProjectsMetadata" + "confidenceThreshold" + ] }, "ConversationalAnalysisAuthoringProjectTrainedModel": { - "description": "Represents a trained model.", - "required": [ - "label", - "modelId", - "lastTrainedDateTime", - "lastTrainingDurationInSeconds", - "modelExpirationDate", - "modelTrainingConfigVersion", - "hasSnapshot" - ], "type": "object", + "description": "Represents a trained model.", "properties": { "label": { - "description": "The trained model label.", - "type": "string" + "type": "string", + "description": "The trained model label." }, "modelId": { - "description": "The model ID.", - "type": "string" + "type": "string", + "description": "The model ID." }, "lastTrainedDateTime": { + "type": "string", "format": "date-time", - "description": "The last trained date time of the model.", - "type": "string" + "description": "The last trained date time of the model." }, "lastTrainingDurationInSeconds": { + "type": "integer", "format": "int32", - "description": "The duration of the model's last training request in seconds.", - "type": "integer" + "description": "The duration of the model's last training request in seconds." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "The model expiration date.", - "type": "string" + "description": "The model expiration date." }, "modelTrainingConfigVersion": { - "description": "The model training config version.", - "type": "string" + "type": "string", + "description": "The model training config version." }, "hasSnapshot": { - "description": "The flag to indicate if the trained model has a snapshot ready.", - "type": "boolean" + "type": "boolean", + "description": "The flag to indicate if the trained model has a snapshot ready." } }, - "x-ms-client-name": "ProjectTrainedModel" - }, - "ConversationalAnalysisAuthoringProjectTrainedModels": { - "description": "Represents a list of retrieved trained models.", "required": [ - "value", - "nextLink" - ], + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ] + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { "type": "object", + "description": "Represents the detailed state of a training sub-operation.", "properties": { - "value": { - "description": "The list of retrieved jobs.", - "type": "array", - "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" - } + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "Represents progress percentage." }, - "nextLink": { - "description": "The next page link.", + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Represents the start date time." + }, + "endDateTime": { "type": "string", - "x-nullable": true + "format": "date-time", + "description": "Represents the end date time." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Represents the status of the sub-operation." } }, - "x-ms-client-name": "ProjectTrainedModels" - }, - "ConversationalAnalysisAuthoringStringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true, - "values": [ - { - "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." - } - ] - }, - "x-ms-client-name": "StringIndexType" - }, - "ConversationalAnalysisAuthoringSubTrainingJobState": { - "description": "Represents the detailed state of a training sub-operation.", "required": [ "percentComplete", "status" - ], - "type": "object", - "properties": { - "percentComplete": { - "format": "int32", - "description": "Represents progress percentage.", - "type": "integer" - }, - "startDateTime": { - "format": "date-time", - "description": "Represents the start date time.", - "type": "string" - }, - "endDateTime": { - "format": "date-time", - "description": "Represents the end date time.", - "type": "string" - }, - "status": { - "description": "Represents the status of the sub-operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - } - }, - "x-ms-client-name": "SubTrainingJobState" + ] }, "ConversationalAnalysisAuthoringSupportedLanguage": { - "description": "Represents a supported language.", - "required": [ - "languageName", - "languageCode" - ], "type": "object", + "description": "Represents a supported language.", "properties": { "languageName": { - "description": "The language name.", - "type": "string" + "type": "string", + "description": "The language name." }, "languageCode": { - "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "The language code. This is BCP-47 representation of a language. For example,\n\"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc." } }, - "x-ms-client-name": "SupportedLanguage" + "required": [ + "languageName", + "languageCode" + ] }, "ConversationalAnalysisAuthoringSupportedLanguages": { - "description": "Represents a list of retrieved languages.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of retrieved languages.", "properties": { "value": { - "description": "The list of the languages.", "type": "array", + "description": "The list of the languages.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "SupportedLanguages" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { - "description": "Represents the options for swapping two deployments together.", + "ConversationalAnalysisAuthoringSwapDeploymentsJobState": { + "type": "object", + "description": "Represents the state of a deployment job.", + "properties": { + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { + "type": "array", + "description": "The warnings that were encountered while executing the job.", + "items": { + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] + }, + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + } + }, "required": [ - "firstDeploymentName", - "secondDeploymentName" - ], + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ] + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { "type": "object", + "description": "Represents the options for swapping two deployments together.", "properties": { "firstDeploymentName": { - "description": "Represents the first deployment name.", - "type": "string" + "type": "string", + "description": "Represents the first deployment name." }, "secondDeploymentName": { - "description": "Represents the second deployment name.", - "type": "string" + "type": "string", + "description": "Represents the second deployment name." } }, - "x-ms-client-name": "SwapDeploymentsOptions" + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersion": { - "description": "Represents a training config version.", - "required": [ - "trainingConfigVersion", - "modelExpirationDate" - ], "type": "object", + "description": "Represents a training config version.", "properties": { "trainingConfigVersion": { - "description": "Represents the version of the config.", - "type": "string" + "type": "string", + "description": "Represents the version of the config." }, "modelExpirationDate": { + "type": "string", "format": "date", - "description": "Represents the training config version expiration date.", - "type": "string" + "description": "Represents the training config version expiration date." } }, - "x-ms-client-name": "TrainingConfigVersion" + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ] }, "ConversationalAnalysisAuthoringTrainingConfigVersions": { - "description": "Represents a list of training config versions.", - "required": [ - "value", - "nextLink" - ], "type": "object", + "description": "Represents a list of training config versions.", "properties": { "value": { - "description": "The list of the training config versions.", "type": "array", + "description": "The list of the training config versions.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" - } + }, + "x-ms-identifiers": [] }, "nextLink": { - "description": "The next page link.", "type": "string", - "x-nullable": true + "description": "The next page link." } }, - "x-ms-client-name": "TrainingConfigVersions" + "required": [ + "value" + ] }, "ConversationalAnalysisAuthoringTrainingJobOptions": { - "description": "Represents the options for starting a new training job.", - "required": [ - "modelLabel", - "trainingMode" - ], "type": "object", + "description": "Represents the options for starting a new training job.", "properties": { "modelLabel": { - "description": "Represents the output model label.", - "type": "string" + "type": "string", + "description": "Represents the output model label." }, "trainingConfigVersion": { - "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version. By default, \"latest\" value is used which\nuses the latest released training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "evaluationOptions": { - "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions", + "description": "Represents the evaluation options. By default, the evaluation kind is\npercentage, with training split percentage as 80, and testing split percentage\nas 20." } }, - "x-ms-client-name": "TrainingJobOptions" - }, - "ConversationalAnalysisAuthoringTrainingJobResult": { - "description": "Represents the output of a training job.", "required": [ "modelLabel", - "trainingConfigVersion", - "trainingStatus" - ], + "trainingMode" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { "type": "object", + "description": "Represents the output of a training job.", "properties": { "modelLabel": { - "description": "Represents trained model label.", - "type": "string" + "type": "string", + "description": "Represents trained model label." }, "trainingConfigVersion": { - "description": "Represents training config version.", - "type": "string" + "type": "string", + "description": "Represents training config version." }, "trainingMode": { - "description": "Represents the mode of the training operation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + "$ref": "#/definitions/TrainingMode", + "description": "Represents the mode of the training operation." }, "trainingStatus": { - "description": "Represents the model training status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents the model training status." }, "evaluationStatus": { - "description": "Represents model evaluation status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState", + "description": "Represents model evaluation status." }, "estimatedEndDateTime": { + "type": "string", "format": "date-time", - "description": "Represents the estimated end date time for training and evaluation.", - "type": "string" + "description": "Represents the estimated end date time for training and evaluation." } }, - "x-ms-client-name": "TrainingJobResult" - }, - "ConversationalAnalysisAuthoringTrainingJobs": { - "description": "Represents a list of retrieved training jobs.", "required": [ - "value", - "nextLink" - ], + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ] + }, + "ConversationalAnalysisAuthoringTrainingJobState": { "type": "object", + "description": "Represents the state of a training job.", "properties": { - "value": { - "description": "The list of jobs.", + "jobId": { + "type": "string", + "description": "The job ID." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation date time of the job." + }, + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last date time the job was updated." + }, + "expirationDateTime": { + "type": "string", + "format": "date-time", + "description": "The expiration date time of the job." + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "The job status." + }, + "warnings": { "type": "array", + "description": "The warnings that were encountered while executing the job.", "items": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" - } + "$ref": "#/definitions/Warning" + }, + "x-ms-identifiers": [] }, - "nextLink": { - "description": "The next page link.", - "type": "string", - "x-nullable": true + "errors": { + "type": "array", + "description": "The errors encountered while executing the job.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "result": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult", + "description": "Represents training tasks detailed result." } }, - "x-ms-client-name": "TrainingJobs" - }, - "ConversationalAnalysisAuthoringTrainingJobState": { - "description": "Represents the state of a training job.", "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status", "result" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" - } - ], - "properties": { - "result": { - "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - } - }, - "x-ms-client-name": "TrainingJobState" - }, - "ConversationalAnalysisAuthoringTrainingMode": { - "enum": [ - "advanced", - "standard" - ], - "type": "string", - "x-ms-enum": { - "name": "TrainingMode", - "modelAsString": true, - "values": [ - { - "value": "advanced", - "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." - }, - { - "value": "standard", - "description": "Faster training times for quicker iterations." - } - ] - }, - "x-ms-client-name": "TrainingMode" + ] }, "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expected and predicted entities for an utterance.", - "required": [ - "expectedEntities", - "predictedEntities" - ], "type": "object", + "description": "Represents the comparison between the expected and predicted entities for an\nutterance.", "properties": { "expectedEntities": { - "description": "Represents the expected entity labels.", "type": "array", + "description": "Represents the expected entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] }, "predictedEntities": { - "description": "Represents the predicted entity labels.", "type": "array", + "description": "Represents the predicted entity labels.", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" - } + }, + "x-ms-identifiers": [] } }, - "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + "required": [ + "expectedEntities", + "predictedEntities" + ] }, "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { - "description": "Represents the evaluation output of an entity label or prediction.", - "required": [ - "category", - "offset", - "length" - ], "type": "object", + "description": "Represents the evaluation output of an entity label or prediction.", "properties": { "category": { - "description": "Represents the entity category.", - "type": "string" + "type": "string", + "description": "Represents the entity category." }, "offset": { + "type": "integer", "format": "int32", - "description": "Represents the entity offset index relative to the original text.", - "type": "integer" + "description": "Represents the entity offset index relative to the original text." }, "length": { + "type": "integer", "format": "int32", - "description": "Represents the entity length.", - "type": "integer" + "description": "Represents the entity length." } }, - "x-ms-client-name": "UtteranceEntityEvaluationResult" + "required": [ + "category", + "offset", + "length" + ] }, "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", "description": "Represents the evaluation result for an utterance.", - "required": [ - "text", - "language", - "entitiesResult", - "intentsResult" - ], - "type": "object", "properties": { "text": { - "description": "Represents the utterance text.", - "type": "string" + "type": "string", + "description": "Represents the utterance text." }, "language": { - "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", - "type": "string" + "type": "string", + "description": "Represents the utterance language. This is BCP-47 representation of a language.\nFor example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish\netc." }, "entitiesResult": { - "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult", + "description": "Represents the entities results for the utterance." }, "intentsResult": { - "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult", + "description": "Represents the intents results for the utterance." } }, - "x-ms-client-name": "UtteranceEvaluationResult" + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ] }, "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { - "description": "Represents the comparison between the expected and the predicted intent for an utterance.", - "required": [ - "expectedIntent", - "predictedIntent" - ], "type": "object", + "description": "Represents the comparison between the expected and the predicted intent for an\nutterance.", "properties": { "expectedIntent": { - "description": "Represents the utterance's expected intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's expected intent." }, "predictedIntent": { - "description": "Represents the utterance's predicted intent.", - "type": "string" + "type": "string", + "description": "Represents the utterance's predicted intent." } }, - "x-ms-client-name": "UtteranceIntentsEvaluationResult" + "required": [ + "expectedIntent", + "predictedIntent" + ] }, - "ConversationalAnalysisAuthoringWarning": { - "description": "Represents a warning that was encountered while executing the request.", + "Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." + } + }, "required": [ "code", "message" + ] + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidArgument", + "value": "InvalidArgument" + }, + { + "name": "Unauthorized", + "value": "Unauthorized" + }, + { + "name": "Forbidden", + "value": "Forbidden" + }, + { + "name": "NotFound", + "value": "NotFound" + }, + { + "name": "ProjectNotFound", + "value": "ProjectNotFound" + }, + { + "name": "OperationNotFound", + "value": "OperationNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchIndexNotFound", + "value": "AzureCognitiveSearchIndexNotFound" + }, + { + "name": "TooManyRequests", + "value": "TooManyRequests" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "AzureCognitiveSearchIndexLimitReached", + "value": "AzureCognitiveSearchIndexLimitReached" + }, + { + "name": "InternalServerError", + "value": "InternalServerError" + }, + { + "name": "ServiceUnavailable", + "value": "ServiceUnavailable" + }, + { + "name": "Timeout", + "value": "Timeout" + }, + { + "name": "QuotaExceeded", + "value": "QuotaExceeded" + }, + { + "name": "Conflict", + "value": "Conflict" + }, + { + "name": "Warning", + "value": "Warning" + } + ] + } + }, + "ErrorResponse": { "type": "object", + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "EvaluationKind": { + "type": "string", + "enum": [ + "percentage", + "manual" + ], + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "name": "percentage", + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined\npercentages." + }, + { + "name": "manual", + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + } + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ], + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "name": "InvalidRequest", + "value": "InvalidRequest" + }, + { + "name": "InvalidParameterValue", + "value": "InvalidParameterValue" + }, + { + "name": "KnowledgeBaseNotFound", + "value": "KnowledgeBaseNotFound" + }, + { + "name": "AzureCognitiveSearchNotFound", + "value": "AzureCognitiveSearchNotFound" + }, + { + "name": "AzureCognitiveSearchThrottling", + "value": "AzureCognitiveSearchThrottling" + }, + { + "name": "ExtractionFailure", + "value": "ExtractionFailure" + }, + { + "name": "InvalidRequestBodyFormat", + "value": "InvalidRequestBodyFormat" + }, + { + "name": "EmptyRequest", + "value": "EmptyRequest" + }, + { + "name": "MissingInputDocuments", + "value": "MissingInputDocuments" + }, + { + "name": "InvalidDocument", + "value": "InvalidDocument" + }, + { + "name": "ModelVersionIncorrect", + "value": "ModelVersionIncorrect" + }, + { + "name": "InvalidDocumentBatch", + "value": "InvalidDocumentBatch" + }, + { + "name": "UnsupportedLanguageCode", + "value": "UnsupportedLanguageCode" + }, + { + "name": "InvalidCountryHint", + "value": "InvalidCountryHint" + } + ] + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per\nMicrosoft One API guidelines -\nhttps://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", "properties": { "code": { - "description": "The warning code.", - "type": "string" + "$ref": "#/definitions/InnerErrorCode", + "description": "One of a server-defined set of error codes." }, "message": { - "description": "The warning message.", - "type": "string" + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "description": "Error details.", + "additionalProperties": { + "type": "string" + } + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "$ref": "#/definitions/InnerErrorModel", + "description": "An object containing more specific information than the current object about\nthe error." } }, - "x-ms-client-name": "Warning" - } - }, - "parameters": { - "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { - "in": "query", - "name": "format", - "description": "The format of the exported project file to use.", + "required": [ + "code", + "message" + ] + }, + "JobStatus": { "type": "string", "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "notStarted", + "value": "notStarted" + }, + { + "name": "running", + "value": "running" + }, + { + "name": "succeeded", + "value": "succeeded" + }, + { + "name": "failed", + "value": "failed" + }, + { + "name": "cancelled", + "value": "cancelled" + }, + { + "name": "cancelling", + "value": "cancelling" + }, + { + "name": "partiallyCompleted", + "value": "partiallyCompleted" + } + ] + } + }, + "OrchestrationTargetProjectKind": { + "type": "string", + "enum": [ + "Luis", "Conversation", - "Luis" + "QuestionAnswering" ], "x-ms-enum": { - "name": "ExportedProjectFormat", + "name": "OrchestrationTargetProjectKind", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "Specifies the format for a conversational project." + "name": "Luis", + "value": "Luis" }, { - "value": "Luis", - "description": "Specifies the format for an application that was exported from LUIS." + "name": "Conversation", + "value": "Conversation" + }, + { + "name": "QuestionAnswering", + "value": "QuestionAnswering" } ] + } + }, + "PagedConversationalAnalysisAuthoringProjectDeployment": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectDeployment items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectDeployment items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } }, - "x-ms-parameter-location": "method" + "required": [ + "value" + ] }, - "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { - "in": "query", - "name": "stringIndexType", - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "required": true, + "PagedConversationalAnalysisAuthoringProjectMetadata": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectMetadata items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectMetadata items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringProjectTrainedModel": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringProjectTrainedModel items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringProjectTrainedModel items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringTrainingJobState": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringTrainingJobState items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringTrainingJobState items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "type": "object", + "description": "Paged collection of ConversationalAnalysisAuthoringUtteranceEvaluationResult items", + "properties": { + "value": { + "type": "array", + "description": "The ConversationalAnalysisAuthoringUtteranceEvaluationResult items on this page", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProjectKind": { + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "name": "Conversation", + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "name": "Orchestration", + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + } + }, + "StringIndexType": { "type": "string", "enum": [ "Utf16CodeUnit" @@ -3214,50 +3908,111 @@ "modelAsString": true, "values": [ { + "name": "Utf16CodeUnit", "value": "Utf16CodeUnit", - "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." } ] - }, - "x-ms-parameter-location": "method" + } }, - "ConversationalAnalysisAuthoringJobIdPathParameter": { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, + "TrainingMode": { "type": "string", - "x-ms-parameter-location": "method" + "enum": [ + "advanced", + "standard" + ], + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "name": "advanced", + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train\nmultilingual projects." + }, + { + "name": "standard", + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + } }, - "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model label.", + "Warning": { + "type": "object", + "description": "Represents a warning that was encountered while executing the request.", + "properties": { + "code": { + "type": "string", + "description": "The warning code." + }, + "message": { + "type": "string", + "description": "The warning message." + } + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", "required": true, "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0, "x-ms-parameter-location": "method" }, - "ConversationalAnalysisAuthoringProjectKindQueryParameter": { + "Azure.Core.TopQueryParameter": { + "name": "top", "in": "query", - "name": "projectKind", - "description": "The project kind.", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "StringIndexTypeQueryParameter": { + "name": "stringIndexType", + "in": "query", + "description": "Specifies the method used to interpret string offsets. For additional\ninformation see https://aka.ms/text-analytics-offsets.", "required": true, "type": "string", "enum": [ - "Conversation", - "Orchestration" + "Utf16CodeUnit" ], "x-ms-enum": { - "name": "ProjectKind", + "name": "StringIndexType", "modelAsString": true, "values": [ { - "value": "Conversation", - "description": "A project to build natural language into apps, bots, and IoT devices." - }, - { - "value": "Orchestration", - "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + "name": "Utf16CodeUnit", + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this\noption if your application is written in a language that support Unicode, for\nexample Java, JavaScript." } ] }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..4a5adb1de3cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCancelTrainingJob.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "title": "Successful Cancel Training Job", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json new file mode 100644 index 000000000000..eb8e9f98c34b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulCreateProject.json @@ -0,0 +1,46 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "title": "Successful Create Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-04-01", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..501a4d76422e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteDeployment.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "title": "Successful Delete Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..d26273b5afc1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteModel.json @@ -0,0 +1,14 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "title": "Successful Delete Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..a3acdc62663c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "title": "Successful Delete Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json new file mode 100644 index 000000000000..6126317b23a7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulDeployProject.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "title": "Successful Deploy Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json new file mode 100644 index 000000000000..35a62393cb4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulExportProject.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Export", + "title": "Successful Export Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..67f138a743fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeployment.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "title": "Successful Get Deployment", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..9b395ff4f3e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "title": "Successful Get Deployment Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..396fde0729d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetExportStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "title": "Successful Get Export Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-01", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..4b70711fba95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetImportStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "title": "Successful Get Import Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..52e7fb4e3bfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "title": "Successful Get Load Snapshot Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json new file mode 100644 index 000000000000..5bb2e9921127 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModel.json @@ -0,0 +1,25 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "title": "Successful Get Model", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..4dd48dfb5cc2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluation.json @@ -0,0 +1,286 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "title": "Successful Get Model Evaluation", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..6daf3fcfb0b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,528 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "title": "Successful Get Model Evaluation Summary", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json new file mode 100644 index 000000000000..ae7d1bd2b688 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProject.json @@ -0,0 +1,26 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "title": "Successful Get Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..59061c1f7931 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "title": "Successful Get Project Deletion Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..545214c68df8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,400 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "title": "Successful Get Supported Languages", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..9bea82d1eed2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,100 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "title": "Successful Get Supported Prebuilt Entities", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..baf3e1d78dfc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,24 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "title": "Successful Get Supported Training Config Versions", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..a904361d0a70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,23 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "title": "Successful Get Swap Deployments Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..e95467f15ac6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulGetTrainStatus.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "title": "Successful Get Train Status", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json new file mode 100644 index 000000000000..3cf13bd844f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulImportProject.json @@ -0,0 +1,80 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Import", + "title": "Successful Import Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + }, + { + "category": "Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json new file mode 100644 index 000000000000..c92e5ebd7bfe --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListDeployments.json @@ -0,0 +1,35 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "title": "Successful List Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json new file mode 100644 index 000000000000..12bc75279ea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListModels.json @@ -0,0 +1,38 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "title": "Successful List Models", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json new file mode 100644 index 000000000000..b3e66b3d7364 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "title": "Successful List Projects", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b601958cdf62 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulListTrainingJobs.json @@ -0,0 +1,92 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "title": "Successful List Training Jobs", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..b82ac165a0b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulLoadSnapshot.json @@ -0,0 +1,18 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "title": "Successful Load Snapshot", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..305893a716b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulSwapDeployments.json @@ -0,0 +1,21 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "title": "Successful Swap Deployments", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json new file mode 100644 index 000000000000..74a43e3c0c8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/examples/SuccessfulTrainProject.json @@ -0,0 +1,27 @@ +{ + "operationId": "ConversationalAnalysisAuthoring_Train", + "title": "Successful Train Project", + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-04-01", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01" + } + } + } +} From ba369115837301f1e70353de1af33e87281736c9 Mon Sep 17 00:00:00 2001 From: Chinonso Chukwuogor <nonsochukwuogor@gmail.com> Date: Thu, 3 Oct 2024 14:06:01 -0700 Subject: [PATCH 037/101] AIO M3 preview (#30429) * Remove service name default * no change * add new type * tsv * move to auth * format changes * add non-empty * chnge back * push readme * fix * fix examples * 9-15 * tsv * non-empty string * get rid of components * schema registry id * components examples * Case * schema registry id * schema registry id * fix surpression * fix sub id * changed * schema reg ref * schemaref * fix schema ref * Instance update * format * add batching * Revert "add batching" This reverts commit 3f67f9489407d6ff794bbac841b64b9500b36e76. * remove otel config --------- Co-authored-by: John Lian <jlian@users.noreply.github.com> --- ...Authentication_CreateOrUpdate_Complex.json | 180 + ...ication_CreateOrUpdate_MaximumSet_Gen.json | 168 + ...rAuthentication_Delete_MaximumSet_Gen.json | 20 + ...okerAuthentication_Get_MaximumSet_Gen.json | 69 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...rAuthorization_CreateOrUpdate_Complex.json | 243 + ...ization_CreateOrUpdate_MaximumSet_Gen.json | 189 + ...erAuthorization_CreateOrUpdate_Simple.json | 186 + ...erAuthorization_Delete_MaximumSet_Gen.json | 20 + ...rokerAuthorization_Get_MaximumSet_Gen.json | 76 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 80 + ...BrokerListener_CreateOrUpdate_Complex.json | 182 + ...istener_CreateOrUpdate_MaximumSet_Gen.json | 186 + .../BrokerListener_CreateOrUpdate_Simple.json | 88 + .../BrokerListener_Delete_MaximumSet_Gen.json | 20 + .../BrokerListener_Get_MaximumSet_Gen.json | 75 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 79 + .../Broker_CreateOrUpdate_Complex.json | 122 + .../Broker_CreateOrUpdate_MaximumSet_Gen.json | 500 ++ .../Broker_CreateOrUpdate_Minimal.json | 357 + .../Broker_CreateOrUpdate_Simple.json | 371 + .../Broker_Delete_MaximumSet_Gen.json | 19 + .../Broker_Get_MaximumSet_Gen.json | 179 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 183 + ...ataflowEndpoint_CreateOrUpdate_ADLSv2.json | 98 + .../DataflowEndpoint_CreateOrUpdate_ADX.json | 107 + .../DataflowEndpoint_CreateOrUpdate_AIO.json | 110 + ...flowEndpoint_CreateOrUpdate_EventGrid.json | 101 + ...aflowEndpoint_CreateOrUpdate_EventHub.json | 104 + ...ataflowEndpoint_CreateOrUpdate_Fabric.json | 107 + ...DataflowEndpoint_CreateOrUpdate_Kafka.json | 149 + ...wEndpoint_CreateOrUpdate_LocalStorage.json | 80 + .../DataflowEndpoint_CreateOrUpdate_MQTT.json | 128 + ...ndpoint_CreateOrUpdate_MaximumSet_Gen.json | 476 ++ ...ataflowEndpoint_Delete_MaximumSet_Gen.json | 19 + .../DataflowEndpoint_Get_MaximumSet_Gen.json | 171 + ...nt_ListByResourceGroup_MaximumSet_Gen.json | 175 + ...Profile_CreateOrUpdate_MaximumSet_Gen.json | 95 + ...ataflowProfile_CreateOrUpdate_Minimal.json | 71 + .../DataflowProfile_CreateOrUpdate_Multi.json | 71 + ...DataflowProfile_Delete_MaximumSet_Gen.json | 19 + .../DataflowProfile_Get_MaximumSet_Gen.json | 44 + ...le_ListByResourceGroup_MaximumSet_Gen.json | 48 + ...eateOrUpdate_ComplexContextualization.json | 222 + ...taflow_CreateOrUpdate_ComplexEventHub.json | 255 + ...Dataflow_CreateOrUpdate_FilterToTopic.json | 210 + ...ataflow_CreateOrUpdate_MaximumSet_Gen.json | 237 + ...taflow_CreateOrUpdate_SimpleEventGrid.json | 132 + .../Dataflow_CreateOrUpdate_SimpleFabric.json | 153 + .../Dataflow_Delete_MaximumSet_Gen.json | 20 + .../Dataflow_Get_MaximumSet_Gen.json | 92 + ..._ListByProfileResource_MaximumSet_Gen.json | 96 + ...nstance_CreateOrUpdate_MaximumSet_Gen.json | 103 + .../Instance_Delete_MaximumSet_Gen.json | 18 + .../Instance_Get_MaximumSet_Gen.json | 47 + ...ce_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...nce_ListBySubscription_MaximumSet_Gen.json | 50 + .../Instance_Update_MaximumSet_Gen.json | 54 + .../Operations_List_MaximumSet_Gen.json | 28 + .../IoTOperations.Management/main.tsp | 4 +- .../IoTOperations.Management/models/base.tsp | 36 +- .../models/broker/brokers.tsp | 3 - .../models/broker/listeners.tsp | 2 +- .../models/dataflows/dataflowEndpoints.tsp | 4 +- .../models/dataflows/dataflows.tsp | 4 +- .../models/instance.tsp | 64 +- ...Authentication_CreateOrUpdate_Complex.json | 180 + ...ication_CreateOrUpdate_MaximumSet_Gen.json | 168 + ...rAuthentication_Delete_MaximumSet_Gen.json | 20 + ...okerAuthentication_Get_MaximumSet_Gen.json | 69 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 73 + ...rAuthorization_CreateOrUpdate_Complex.json | 243 + ...ization_CreateOrUpdate_MaximumSet_Gen.json | 189 + ...erAuthorization_CreateOrUpdate_Simple.json | 186 + ...erAuthorization_Delete_MaximumSet_Gen.json | 20 + ...rokerAuthorization_Get_MaximumSet_Gen.json | 76 + ...on_ListByResourceGroup_MaximumSet_Gen.json | 80 + ...BrokerListener_CreateOrUpdate_Complex.json | 182 + ...istener_CreateOrUpdate_MaximumSet_Gen.json | 186 + .../BrokerListener_CreateOrUpdate_Simple.json | 88 + .../BrokerListener_Delete_MaximumSet_Gen.json | 20 + .../BrokerListener_Get_MaximumSet_Gen.json | 75 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 79 + .../Broker_CreateOrUpdate_Complex.json | 122 + .../Broker_CreateOrUpdate_MaximumSet_Gen.json | 500 ++ .../Broker_CreateOrUpdate_Minimal.json | 357 + .../Broker_CreateOrUpdate_Simple.json | 371 + .../Broker_Delete_MaximumSet_Gen.json | 19 + .../examples/Broker_Get_MaximumSet_Gen.json | 179 + ...er_ListByResourceGroup_MaximumSet_Gen.json | 183 + ...ataflowEndpoint_CreateOrUpdate_ADLSv2.json | 98 + .../DataflowEndpoint_CreateOrUpdate_ADX.json | 107 + .../DataflowEndpoint_CreateOrUpdate_AIO.json | 110 + ...flowEndpoint_CreateOrUpdate_EventGrid.json | 101 + ...aflowEndpoint_CreateOrUpdate_EventHub.json | 104 + ...ataflowEndpoint_CreateOrUpdate_Fabric.json | 107 + ...DataflowEndpoint_CreateOrUpdate_Kafka.json | 149 + ...wEndpoint_CreateOrUpdate_LocalStorage.json | 80 + .../DataflowEndpoint_CreateOrUpdate_MQTT.json | 128 + ...ndpoint_CreateOrUpdate_MaximumSet_Gen.json | 476 ++ ...ataflowEndpoint_Delete_MaximumSet_Gen.json | 19 + .../DataflowEndpoint_Get_MaximumSet_Gen.json | 171 + ...nt_ListByResourceGroup_MaximumSet_Gen.json | 175 + ...Profile_CreateOrUpdate_MaximumSet_Gen.json | 95 + ...ataflowProfile_CreateOrUpdate_Minimal.json | 71 + .../DataflowProfile_CreateOrUpdate_Multi.json | 71 + ...DataflowProfile_Delete_MaximumSet_Gen.json | 19 + .../DataflowProfile_Get_MaximumSet_Gen.json | 44 + ...le_ListByResourceGroup_MaximumSet_Gen.json | 48 + ...eateOrUpdate_ComplexContextualization.json | 222 + ...taflow_CreateOrUpdate_ComplexEventHub.json | 255 + ...Dataflow_CreateOrUpdate_FilterToTopic.json | 210 + ...ataflow_CreateOrUpdate_MaximumSet_Gen.json | 237 + ...taflow_CreateOrUpdate_SimpleEventGrid.json | 132 + .../Dataflow_CreateOrUpdate_SimpleFabric.json | 153 + .../Dataflow_Delete_MaximumSet_Gen.json | 20 + .../examples/Dataflow_Get_MaximumSet_Gen.json | 92 + ..._ListByProfileResource_MaximumSet_Gen.json | 96 + ...nstance_CreateOrUpdate_MaximumSet_Gen.json | 103 + .../Instance_Delete_MaximumSet_Gen.json | 18 + .../examples/Instance_Get_MaximumSet_Gen.json | 47 + ...ce_ListByResourceGroup_MaximumSet_Gen.json | 51 + ...nce_ListBySubscription_MaximumSet_Gen.json | 50 + .../Instance_Update_MaximumSet_Gen.json | 54 + .../Operations_List_MaximumSet_Gen.json | 28 + .../2024-09-15-preview/iotoperations.json | 6569 +++++++++++++++++ .../iotoperations/resource-manager/readme.md | 11 +- 127 files changed, 21814 insertions(+), 95 deletions(-) create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json create mode 100644 specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..99df45a1ca21 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_Complex.json @@ -0,0 +1,180 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate_Complex", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..56d2d89e12ab --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,168 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c7aa364f3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthentication_Delete", + "operationId": "BrokerAuthentication_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..533d1b8f9a3a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "BrokerAuthentication_Get", + "operationId": "BrokerAuthentication_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8037bfab1583 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "BrokerAuthentication_ListByResourceGroup", + "operationId": "BrokerAuthentication_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..74ccc622f5c2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Complex.json @@ -0,0 +1,243 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Complex", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..13af93f825f8 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,189 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..3c5e60f84d3b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_CreateOrUpdate_Simple.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Simple", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9576e1bff109 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthorization_Delete", + "operationId": "BrokerAuthorization_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e1df47ac23a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_Get_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "BrokerAuthorization_Get", + "operationId": "BrokerAuthorization_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..44ef2bacbea2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "BrokerAuthorization_ListByResourceGroup", + "operationId": "BrokerAuthorization_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..fab5938b5e49 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Complex.json @@ -0,0 +1,182 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Complex", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..673225b32522 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerListener_CreateOrUpdate", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..70613eca4838 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_CreateOrUpdate_Simple.json @@ -0,0 +1,88 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Simple", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "ports": [ + { + "port": 1883 + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eae4091f973 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerListener_Delete", + "operationId": "BrokerListener_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e0142b23e6b9 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_Get_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "BrokerListener_Get", + "operationId": "BrokerListener_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8eaf998413a --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "BrokerListener_ListByResourceGroup", + "operationId": "BrokerListener_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..8f9965aa69f7 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Complex.json @@ -0,0 +1,122 @@ +{ + "title": "Broker_CreateOrUpdate_Complex", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Accepted" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a9202c793fc --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,500 @@ +{ + "title": "Broker_CreateOrUpdate", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..db21f2f9961d --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Minimal.json @@ -0,0 +1,357 @@ +{ + "title": "Broker_CreateOrUpdate_Minimal", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..e163401612c6 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_CreateOrUpdate_Simple.json @@ -0,0 +1,371 @@ +{ + "title": "Broker_CreateOrUpdate_Simple", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Low" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8cc056cc7fbd --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Broker_Delete", + "operationId": "Broker_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..170aa26bcd86 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_Get_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "Broker_Get", + "operationId": "Broker_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..1c1a1bf57ec5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Broker_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,183 @@ +{ + "title": "Broker_ListByResourceGroup", + "operationId": "Broker_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json new file mode 100644 index 000000000000..3b8475111cd2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADLSv2.json @@ -0,0 +1,98 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADLSv2", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adlsv2-endpoint", + "resource": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json new file mode 100644 index 000000000000..db63d70425bb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_ADX.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADX", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adx-endpoint", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json new file mode 100644 index 000000000000..18cef846e282 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_AIO.json @@ -0,0 +1,110 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_AIO", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "aio-builtin-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json new file mode 100644 index 000000000000..09a2283578b4 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventGrid.json @@ -0,0 +1,101 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventGrid", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-grid-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json new file mode 100644 index 000000000000..f6730880e2b6 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_EventHub.json @@ -0,0 +1,104 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventHub", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-hub-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json new file mode 100644 index 000000000000..d4393e8da225 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Fabric.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Fabric", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "fabric-endpoint", + "resource": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json new file mode 100644 index 000000000000..34ea2ac53f03 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_Kafka.json @@ -0,0 +1,149 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Kafka", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-kafka-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json new file mode 100644 index 000000000000..6c498588c715 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_LocalStorage.json @@ -0,0 +1,80 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_LocalStorage", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "local-storage-endpoint", + "resource": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json new file mode 100644 index 000000000000..b420b27e3664 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MQTT.json @@ -0,0 +1,128 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_MQTT", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-mqtt-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fe7b32d00a5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,476 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a67f12a1e4da --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowEndpoint_Delete", + "operationId": "DataflowEndpoint_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..be8c1f8d0ac3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_Get_MaximumSet_Gen.json @@ -0,0 +1,171 @@ +{ + "title": "DataflowEndpoint_Get", + "operationId": "DataflowEndpoint_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f9b75de4d82e --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,175 @@ +{ + "title": "DataflowEndpoint_ListByResourceGroup", + "operationId": "DataflowEndpoint_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a8a90c8ec9e --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "DataflowProfile_CreateOrUpdate", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "resource": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..8a08b7c71f41 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Minimal.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Minimal", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 1 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json new file mode 100644 index 000000000000..1358bf219347 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_CreateOrUpdate_Multi.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Multi", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 3 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..92c5a7d32c78 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowProfile_Delete", + "operationId": "DataflowProfile_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..992da0ba07f8 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "DataflowProfile_Get", + "operationId": "DataflowProfile_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e7d80009c85 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "DataflowProfile_ListByResourceGroup", + "operationId": "DataflowProfile_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json new file mode 100644 index 000000000000..6706efedf55b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexContextualization.json @@ -0,0 +1,222 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexContextualization", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-adx-contexualized", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json new file mode 100644 index 000000000000..e10915972919 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_ComplexEventHub.json @@ -0,0 +1,255 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexEventHub", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-hub-transformed", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "filter": [ + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "($1+$2)/2", + "output": "AvgTemp.Value" + }, + { + "inputs": [], + "expression": "true", + "output": "dataflow-processed" + }, + { + "inputs": [ + "temperature.SourceTimestamp" + ], + "expression": "", + "output": "" + }, + { + "inputs": [ + "\"Tag 10\"" + ], + "expression": "", + "output": "pressure" + }, + { + "inputs": [ + "temperature.Value" + ], + "expression": "cToF($1)", + "output": "temperatureF.Value" + }, + { + "inputs": [ + "\"Tag 10\".Value" + ], + "expression": "scale ($1,0,10,0,100)", + "output": "\"Scale Tag 10\".Value" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-hub-endpoint", + "dataDestination": "myuniqueeventhub" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json new file mode 100644 index 000000000000..3ff5c1c6c7f3 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_FilterToTopic.json @@ -0,0 +1,210 @@ +{ + "title": "Dataflow_CreateOrUpdate_FilterToTopic", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "mqtt-filter-to-topic", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d4a894ae46b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,237 @@ +{ + "title": "Dataflow_CreateOrUpdate", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json new file mode 100644 index 000000000000..73a3038d8527 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleEventGrid.json @@ -0,0 +1,132 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleEventGrid", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-grid", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json new file mode 100644 index 000000000000..f4f3e6a89ecb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_CreateOrUpdate_SimpleFabric.json @@ -0,0 +1,153 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleFabric", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-fabric", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8617fc9681eb --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Dataflow_Delete", + "operationId": "Dataflow_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6daa2b11a21d --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_Get_MaximumSet_Gen.json @@ -0,0 +1,92 @@ +{ + "title": "Dataflow_Get", + "operationId": "Dataflow_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..d38f51c50759 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Dataflow_ListByProfileResource_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "Dataflow_ListByProfileResource", + "operationId": "Dataflow_ListByProfileResource", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac7583a4acb2 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "Instance_CreateOrUpdate", + "operationId": "Instance_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "resource": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b63d7261b0b --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Instance_Delete", + "operationId": "Instance_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..03f4b416dda5 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "Instance_Get", + "operationId": "Instance_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "rlfvvnnhcypp", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4bedfb0b6ce --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "Instance_ListByResourceGroup", + "operationId": "Instance_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "vmujggxdvxk" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7229d3116831 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "Instance_ListBySubscription", + "operationId": "Instance_ListBySubscription", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "empgqmbhvklcqlyahmdsjemlep" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..406c4a22b316 --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Instance_Update_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Instance_Update", + "operationId": "Instance_Update", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "properties": { + "tags": {}, + "identity": { + "type": "None", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "wwihkapmgjbyrtyaj", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0429eca83eed --- /dev/null +++ b/specification/iotoperations/IoTOperations.Management/examples/2024-09-15-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "xzxqfusky", + "isDataAction": true, + "display": { + "provider": "lrveskajtuwf", + "resource": "d", + "operation": "icuckgobartrrgmirax", + "description": "dsbfnxzvnoqdm" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/IoTOperations.Management/main.tsp b/specification/iotoperations/IoTOperations.Management/main.tsp index d0f76ba18550..33037af05c59 100644 --- a/specification/iotoperations/IoTOperations.Management/main.tsp +++ b/specification/iotoperations/IoTOperations.Management/main.tsp @@ -33,10 +33,10 @@ namespace Microsoft.IoTOperations; /** Api versions */ enum Versions { - /** 2024-08-15-preview version */ + /** 2024-09-15-preview version */ @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) - `2024-08-15-preview`, + `2024-09-15-preview`, } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/iotoperations/IoTOperations.Management/models/base.tsp b/specification/iotoperations/IoTOperations.Management/models/base.tsp index 6bc94b68d6cd..736cb2878627 100644 --- a/specification/iotoperations/IoTOperations.Management/models/base.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/base.tsp @@ -4,6 +4,10 @@ using Azure.ResourceManager; namespace Microsoft.IoTOperations; +@doc("A string with a minimum length of 1.") +@minLength(1) +scalar NonEmptyString extends string; + @doc("Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.") model ExtendedLocation { @doc("The name of the extended location.") @@ -52,37 +56,12 @@ union OperationalMode { @doc("Diagnostic Log properties") model DiagnosticsLogs { - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryLogExportConfig; - @doc("The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.") level?: string = "info"; } -@doc("OpenTelemetry Log Export Configuration properties") -model OpenTelemetryLogExportConfig { - ...OpenTelemetryExportConfig; - - @doc("The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.") - level?: string = "error"; -} - -@doc("OpenTelemetry Export Configuration properties") -model OpenTelemetryExportConfig { - @doc("The open telemetry collector endpoint to export to.") - otlpGrpcEndpoint: string; - - @doc("How often to export the metrics to the open telemetry collector.") - @minValue(1) - @maxValue(300) - intervalSeconds?: int32 = 30; -} - @doc("Diagnostic Metrics properties") model Metrics { - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryExportConfig; - @doc("The prometheus port to expose the metrics.") @minValue(0) @maxValue(65535) @@ -243,3 +222,10 @@ union ServiceAccountTokenMethod { @doc("ServiceAccountToken Option") ServiceAccountToken: ServiceAccountToken, } + +scalar SchemaRegistryID + extends Azure.Core.armResourceIdentifier<[ + { + type: "Microsoft.DeviceRegistry/schemaRegistries", + } + ]>; diff --git a/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp b/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp index a3cd53d8af7f..7f2cd7e7265f 100644 --- a/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/broker/brokers.tsp @@ -145,9 +145,6 @@ model Traces { @doc("The toggle to enable/disable traces.") mode?: OperationalMode = OperationalMode.Enabled; - @doc("The open telemetry export configuration.") - opentelemetryExportConfig?: OpenTelemetryExportConfig; - @doc("The cache size in megabytes.") @minValue(1) @maxValue(128) diff --git a/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp b/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp index 9f4b43cccfdf..e53eb67b5ef8 100644 --- a/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/broker/listeners.tsp @@ -33,7 +33,7 @@ model BrokerListenerResource is ProxyResource<BrokerListenerProperties> { @doc("Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.") model BrokerListenerProperties { @doc("Kubernetes Service name of this listener.") - serviceName?: string = "aio-mq-dmqtt-frontend"; + serviceName?: string; @doc("Ports on which this listener accepts client connections.") @OpenAPI.extension("x-ms-identifiers", ["port"]) diff --git a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp index ab49733743ad..253af812af74 100644 --- a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflowEndpoints.tsp @@ -329,7 +329,7 @@ model DataflowEndpointLocalStorage { @doc("Broker endpoint properties") model DataflowEndpointMqtt { - @doc("authentication properties. DEFAULT: kubernetes.audience=aio-mq-internal. NOTE - Enum field only property is allowed") + @doc("authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed") authentication: DataflowEndpointMqttAuthentication; @doc("Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted.") @@ -375,7 +375,7 @@ model DataflowEndpointMqttAuthentication { ...ManagedIdentity; - @doc("Kubernetes service account token authentication. Default audience if not set is aio-mq-internal") + @doc("Kubernetes service account token authentication. Default audience if not set is aio-internal") serviceAccountTokenSettings?: DataflowEndpointAuthenticationServiceAccountToken; @doc("X.509 certificate authentication.") diff --git a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp index bc12024292e7..4d84a7f82da8 100644 --- a/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/dataflows/dataflows.tsp @@ -212,7 +212,7 @@ model DataflowDestinationOperationSettings { endpointRef: string; @doc("Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription.") - dataDestination: string; + dataDestination: NonEmptyString; } @doc("Dataflow Source Operation properties") @@ -230,5 +230,5 @@ model DataflowSourceOperationSettings { schemaRef?: string; @doc("List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.") - dataSources: string[]; + dataSources: NonEmptyString[]; } diff --git a/specification/iotoperations/IoTOperations.Management/models/instance.tsp b/specification/iotoperations/IoTOperations.Management/models/instance.tsp index de89df9f4ae9..1626412c71f6 100644 --- a/specification/iotoperations/IoTOperations.Management/models/instance.tsp +++ b/specification/iotoperations/IoTOperations.Management/models/instance.tsp @@ -52,65 +52,11 @@ model InstanceProperties { version?: string; @doc("The reference to the Schema Registry for this AIO Instance.") - @pattern("^[a-z0-9][a-z0-9-]*[a-z0-9]$") - schemaRegistryNamespace: string; - - @doc("The configuration for components of the AIO Instance.") - components?: Components = #{}; -} - -@doc("The configuration for components of the AIO Instance.") -model Components { - @doc("The properties of the ADR instance.") - adr?: AdrProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the AKRI instance.") - akri?: AkriInstanceProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the connectors instance.") - connectors?: ConnectorInstanceProperties = #{ - state: OperationalMode.Enabled, - }; - - @doc("The properties of the dataflows instance.") - dataflows?: DataflowInstanceProperties = #{ state: OperationalMode.Enabled }; - - @doc("The properties of the device provisioning instance.") - schemaRegistry?: SchemaRegistryInstanceProperties = #{ - state: OperationalMode.Enabled, - }; -} - -@doc("The properties of an ADR instance.") -model AdrProperties { - @doc("This determines if the ADR service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} -@doc("The properties of an AKRI instance.") -model AkriInstanceProperties { - @doc("This determines if the AKRI service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} - -@doc("The properties of a Connector instance.") -model ConnectorInstanceProperties { - @doc("This determines if the Connector service is enabled.") - @visibility("create", "read") - state: OperationalMode; -} - -@doc("The properties of an Dataflow instance.") -model DataflowInstanceProperties { - @doc("This determines if the Dataflow service is enabled.") - @visibility("create", "read") - state: OperationalMode; + schemaRegistryRef: SchemaRegistryRef; } -@doc("The properties of a Schema Registry instance.") -model SchemaRegistryInstanceProperties { - @doc("This determines if the Schema Registry service is enabled.") - @visibility("create", "read") - state: OperationalMode; +@doc("The reference to the Schema Registry for this AIO Instance.") +model SchemaRegistryRef { + @doc("The resource ID of the Schema Registry.") + resourceId: SchemaRegistryID; } diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..99df45a1ca21 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_Complex.json @@ -0,0 +1,180 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate_Complex", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "ServiceAccountToken", + "serviceAccountTokenSettings": { + "audiences": [ + "aio-internal" + ] + } + }, + { + "method": "X509", + "x509Settings": { + "trustedClientCaCert": "my-ca", + "authorizationAttributes": { + "root": { + "subject": "CN = Contoso Root CA Cert, OU = Engineering, C = US", + "attributes": { + "organization": "contoso" + } + }, + "intermediate": { + "subject": "CN = Contoso Intermediate CA", + "attributes": { + "city": "seattle", + "foo": "bar" + } + }, + "smart-fan": { + "subject": "CN = smart-fan", + "attributes": { + "building": "17" + } + } + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..56d2d89e12ab --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,168 @@ +{ + "title": "BrokerAuthentication_CreateOrUpdate", + "operationId": "BrokerAuthentication_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123", + "resource": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2e8c7aa364f3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthentication_Delete", + "operationId": "BrokerAuthentication_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..533d1b8f9a3a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "BrokerAuthentication_Get", + "operationId": "BrokerAuthentication_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authenticationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8037bfab1583 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "BrokerAuthentication_ListByResourceGroup", + "operationId": "BrokerAuthentication_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authenticationMethods": [ + { + "method": "Custom", + "customSettings": { + "auth": { + "x509": { + "secretRef": "secret-name" + } + }, + "caCertConfigMap": "pdecudefqyolvncbus", + "endpoint": "https://www.example.com", + "headers": { + "key8518": "bwityjy" + } + }, + "serviceAccountTokenSettings": { + "audiences": [ + "jqyhyqatuydg" + ] + }, + "x509Settings": { + "authorizationAttributes": { + "key3384": { + "attributes": { + "key186": "ucpajramsz" + }, + "subject": "jpgwctfeixitptfgfnqhua" + } + }, + "trustedClientCaCert": "vlctsqddl" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authentications/resource-name123", + "name": "lwucizfvtsdpx", + "type": "kvtilkgcxanlfozrd", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..74ccc622f5c2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Complex.json @@ -0,0 +1,243 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Complex", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "usernames": [ + "temperature-sensor", + "humidity-sensor" + ], + "attributes": [ + { + "building": "17", + "organization": "contoso" + } + ] + }, + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "{principal.attributes.building}*" + ] + }, + { + "method": "Publish", + "topics": [ + "sensors/{principal.attributes.building}/{principal.clientId}/telemetry/*" + ] + }, + { + "method": "Subscribe", + "topics": [ + "commands/{principal.attributes.organization}" + ] + } + ], + "stateStoreResources": [ + { + "method": "Read", + "keyType": "Pattern", + "keys": [ + "myreadkey", + "myotherkey?", + "mynumerickeysuffix[0-9]", + "clients:{principal.clientId}:*" + ] + }, + { + "method": "ReadWrite", + "keyType": "Binary", + "keys": [ + "MTE2IDEwMSAxMTUgMTE2" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..13af93f825f8 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,189 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..3c5e60f84d3b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_CreateOrUpdate_Simple.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerAuthorization_CreateOrUpdate_Simple", + "operationId": "BrokerAuthorization_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123", + "resource": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "principals": { + "clientIds": [ + "my-client-id" + ], + "attributes": [ + { + "floor": "floor1", + "site": "site1" + } + ] + }, + "brokerResources": [ + { + "method": "Connect" + }, + { + "method": "Subscribe", + "topics": [ + "topic", + "topic/with/wildcard/#" + ] + } + ], + "stateStoreResources": [ + { + "method": "ReadWrite", + "keyType": "Pattern", + "keys": [ + "*" + ] + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..9576e1bff109 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerAuthorization_Delete", + "operationId": "BrokerAuthorization_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..1e1df47ac23a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_Get_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "BrokerAuthorization_Get", + "operationId": "BrokerAuthorization_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "authorizationName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..44ef2bacbea2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,80 @@ +{ + "title": "BrokerAuthorization_ListByResourceGroup", + "operationId": "BrokerAuthorization_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "authorizationPolicies": { + "cache": "Enabled", + "rules": [ + { + "brokerResources": [ + { + "method": "Connect", + "clientIds": [ + "nlc" + ], + "topics": [ + "wvuca" + ] + } + ], + "principals": { + "attributes": [ + { + "key5526": "nydhzdhbldygqcn" + } + ], + "clientIds": [ + "smopeaeddsygz" + ], + "usernames": [ + "iozngyqndrteikszkbasinzdjtm" + ] + }, + "stateStoreResources": [ + { + "keyType": "Pattern", + "keys": [ + "tkounsqtwvzyaklxjqoerpu" + ], + "method": "Read" + } + ] + } + ] + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/authorizations/resource-name123", + "name": "anqrqsvrjmlvzkrbuav", + "type": "yjlsfarshqoxojvgmy", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..fab5938b5e49 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Complex.json @@ -0,0 +1,182 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Complex", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 8080, + "authenticationRef": "example-authentication", + "protocol": "WebSockets" + }, + { + "port": 8443, + "authenticationRef": "example-authentication", + "protocol": "WebSockets", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "name": "example-issuer", + "kind": "Issuer" + } + } + } + }, + { + "port": 1883, + "authenticationRef": "example-authentication" + }, + { + "port": 8883, + "authenticationRef": "example-authentication", + "tls": { + "mode": "Manual", + "manual": { + "secretRef": "example-secret" + } + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..673225b32522 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,186 @@ +{ + "title": "BrokerListener_CreateOrUpdate", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..70613eca4838 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_CreateOrUpdate_Simple.json @@ -0,0 +1,88 @@ +{ + "title": "BrokerListener_CreateOrUpdate_Simple", + "operationId": "BrokerListener_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123", + "resource": { + "properties": { + "ports": [ + { + "port": 1883 + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "serviceType": "LoadBalancer", + "ports": [ + { + "port": 1883 + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..2eae4091f973 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "BrokerListener_Delete", + "operationId": "BrokerListener_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..e0142b23e6b9 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_Get_MaximumSet_Gen.json @@ -0,0 +1,75 @@ +{ + "title": "BrokerListener_Get", + "operationId": "BrokerListener_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "listenerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..d8eaf998413a --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,79 @@ +{ + "title": "BrokerListener_ListByResourceGroup", + "operationId": "BrokerListener_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "serviceName": "tpfiszlapdpxktx", + "ports": [ + { + "authenticationRef": "tjvdroaqqy", + "authorizationRef": "inxhvxnwswyrvt", + "nodePort": 7281, + "port": 1268, + "protocol": "Mqtt", + "tls": { + "mode": "Automatic", + "certManagerCertificateSpec": { + "duration": "qmpeffoksron", + "secretName": "oagi", + "renewBefore": "hutno", + "issuerRef": { + "group": "jtmuladdkpasfpoyvewekmiy", + "kind": "Issuer", + "name": "ocwoqpgucvjrsuudtjhb" + }, + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + }, + "san": { + "dns": [ + "xhvmhrrhgfsapocjeebqtnzarlj" + ], + "ip": [ + "zbgugfzcgsmegevzktsnibyuyp" + ] + } + }, + "manual": { + "secretRef": "secret-name" + } + } + } + ], + "serviceType": "ClusterIp", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123/listeners/resource-name123", + "name": "hoqjaachratt", + "type": "hizbknwegcdaeh", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..8f9965aa69f7 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Complex.json @@ -0,0 +1,122 @@ +{ + "title": "Broker_CreateOrUpdate_Complex", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "50M" + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Medium", + "provisioningState": "Accepted" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1a9202c793fc --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,500 @@ +{ + "title": "Broker_CreateOrUpdate", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..db21f2f9961d --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Minimal.json @@ -0,0 +1,357 @@ +{ + "title": "Broker_CreateOrUpdate_Minimal", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "memoryProfile": "Tiny" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..e163401612c6 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_CreateOrUpdate_Simple.json @@ -0,0 +1,371 @@ +{ + "title": "Broker_CreateOrUpdate_Simple", + "operationId": "Broker_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123", + "resource": { + "properties": { + "cardinality": { + "backendChain": { + "partitions": 2, + "redundancyFactor": 2, + "workers": 2 + }, + "frontend": { + "replicas": 2, + "workers": 2 + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Low" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8cc056cc7fbd --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "Broker_Delete", + "operationId": "Broker_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..170aa26bcd86 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_Get_MaximumSet_Gen.json @@ -0,0 +1,179 @@ +{ + "title": "Broker_Get", + "operationId": "Broker_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "brokerName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..1c1a1bf57ec5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Broker_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,183 @@ +{ + "title": "Broker_ListByResourceGroup", + "operationId": "Broker_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "advanced": { + "clients": { + "maxSessionExpirySeconds": 3859, + "maxMessageExpirySeconds": 3263, + "maxPacketSizeBytes": 3029, + "subscriberQueueLimit": { + "length": 6, + "strategy": "None" + }, + "maxReceiveMaximum": 2365, + "maxKeepAliveSeconds": 3744 + }, + "encryptInternalTraffic": "Enabled", + "internalCerts": { + "duration": "bchrc", + "renewBefore": "xkafmpgjfifkwwrhkswtopdnne", + "privateKey": { + "algorithm": "Ec256", + "rotationPolicy": "Always" + } + } + }, + "cardinality": { + "backendChain": { + "partitions": 11, + "redundancyFactor": 5, + "workers": 15 + }, + "frontend": { + "replicas": 2, + "workers": 6 + } + }, + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + }, + "selfCheck": { + "mode": "Enabled", + "intervalSeconds": 158, + "timeoutSeconds": 14 + }, + "traces": { + "mode": "Enabled", + "cacheSizeMegabytes": 28, + "selfTracing": { + "mode": "Enabled", + "intervalSeconds": 22 + }, + "spanChannelCapacity": 1000 + } + }, + "diskBackedMessageBuffer": { + "maxSize": "500M", + "ephemeralVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + }, + "persistentVolumeClaimSpec": { + "volumeName": "c", + "volumeMode": "rxvpksjuuugqnqzeiprocknbn", + "storageClassName": "sseyhrjptkhrqvpdpjmornkqvon", + "accessModes": [ + "nuluhigrbb" + ], + "dataSource": { + "apiGroup": "npqapyksvvpkohujx", + "kind": "wazgyb", + "name": "cwhsgxxcxsyppoefm" + }, + "dataSourceRef": { + "apiGroup": "mnfnykznjjsoqpfsgdqioupt", + "kind": "odynqzekfzsnawrctaxg", + "name": "envszivbbmixbyddzg", + "namespace": "etcfzvxqd" + }, + "resources": { + "limits": { + "key2719": "hmphcrgctu" + }, + "requests": { + "key2909": "txocprnyrsgvhfrg" + } + }, + "selector": { + "matchExpressions": [ + { + "key": "e", + "operator": "In", + "values": [ + "slmpajlywqvuyknipgztsonqyybt" + ] + } + ], + "matchLabels": { + "key6673": "wlngfalznwxnurzpgxomcxhbqefpr" + } + } + } + }, + "generateResourceLimits": { + "cpu": "Enabled" + }, + "memoryProfile": "Tiny", + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/brokers/resource-name123", + "name": "dowrkel", + "type": "xshjnsdgadygb", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json new file mode 100644 index 000000000000..3b8475111cd2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json @@ -0,0 +1,98 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADLSv2", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adlsv2-endpoint", + "resource": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataLakeStorage", + "dataLakeStorageSettings": { + "host": "example.blob.core.windows.net", + "authentication": { + "method": "AccessToken", + "accessTokenSettings": { + "secretRef": "my-secret" + } + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json new file mode 100644 index 000000000000..db63d70425bb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_ADX.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_ADX", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "adx-endpoint", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "host": "example.westeurope.kusto.windows.net", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "database": "example-database", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json new file mode 100644 index 000000000000..18cef846e282 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_AIO.json @@ -0,0 +1,110 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_AIO", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "aio-builtin-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "aio-broker:18883", + "authentication": { + "method": "Kubernetes", + "serviceAccountTokenSettings": { + "audience": "aio-internal" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "aio-ca-trust-bundle-test-only" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json new file mode 100644 index 000000000000..09a2283578b4 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json @@ -0,0 +1,101 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventGrid", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-grid-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.westeurope-1.ts.eventgrid.azure.net:8883", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + } + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json new file mode 100644 index 000000000000..f6730880e2b6 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_EventHub.json @@ -0,0 +1,104 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_EventHub", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "event-hub-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.servicebus.windows.net:9093", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "tls": { + "mode": "Enabled" + }, + "consumerGroupId": "aiodataflows" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json new file mode 100644 index 000000000000..d4393e8da225 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Fabric.json @@ -0,0 +1,107 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Fabric", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "fabric-endpoint", + "resource": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "FabricOneLake", + "fabricOneLakeSettings": { + "host": "onelake.dfs.fabric.microsoft.com", + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": {} + }, + "names": { + "workspaceName": "example-workspace", + "lakehouseName": "example-lakehouse" + }, + "oneLakePathType": "Tables" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json new file mode 100644 index 000000000000..34ea2ac53f03 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_Kafka.json @@ -0,0 +1,149 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_Kafka", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-kafka-endpoint", + "resource": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Kafka", + "kafkaSettings": { + "host": "example.kafka.local:9093", + "authentication": { + "method": "Sasl", + "saslSettings": { + "saslType": "Plain", + "secretRef": "my-secret" + } + }, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "ca-certificates" + }, + "consumerGroupId": "dataflows", + "compression": "Gzip", + "batching": { + "mode": "Enabled", + "latencyMs": 5, + "maxBytes": 1000000, + "maxMessages": 100000 + }, + "partitionStrategy": "Default", + "kafkaAcks": "All", + "copyMqttProperties": "Enabled", + "cloudEventAttributes": "Propagate" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json new file mode 100644 index 000000000000..6c498588c715 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json @@ -0,0 +1,80 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_LocalStorage", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "local-storage-endpoint", + "resource": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "LocalStorage", + "localStorageSettings": { + "persistentVolumeClaimRef": "example-pvc" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json new file mode 100644 index 000000000000..b420b27e3664 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MQTT.json @@ -0,0 +1,128 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate_MQTT", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "generic-mqtt-broker-endpoint", + "resource": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "Mqtt", + "mqttSettings": { + "host": "example.broker.local:1883", + "authentication": { + "method": "X509Certificate", + "x509CertificateSettings": { + "secretRef": "example-secret" + } + }, + "tls": { + "mode": "Disabled" + }, + "clientIdPrefix": "factory-gateway", + "retain": "Keep", + "sessionExpirySeconds": 3600, + "qos": 1, + "protocol": "WebSockets", + "maxInflightMessages": 100, + "keepAliveSeconds": 60 + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..1fe7b32d00a5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,476 @@ +{ + "title": "DataflowEndpoint_CreateOrUpdate", + "operationId": "DataflowEndpoint_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123", + "resource": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 9312, + "maxMessages": 9028 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + } + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..a67f12a1e4da --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowEndpoint_Delete", + "operationId": "DataflowEndpoint_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..be8c1f8d0ac3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_Get_MaximumSet_Gen.json @@ -0,0 +1,171 @@ +{ + "title": "DataflowEndpoint_Get", + "operationId": "DataflowEndpoint_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowEndpointName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..f9b75de4d82e --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,175 @@ +{ + "title": "DataflowEndpoint_ListByResourceGroup", + "operationId": "DataflowEndpoint_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "DataExplorer", + "dataExplorerSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "database": "yqcdpjsifm", + "host": "<cluster>.<region>.kusto.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "dataLakeStorageSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "accessTokenSettings": { + "secretRef": "sevriyphcvnlrnfudqzejecwa" + }, + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "host": "<account>.blob.core.windows.net", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "fabricOneLakeSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + } + }, + "names": { + "lakehouseName": "wpeathi", + "workspaceName": "nwgmitkbljztgms" + }, + "oneLakePathType": "Files", + "host": "https://<host>.fabric.microsoft.com", + "batching": { + "latencySeconds": 1228, + "maxMessages": 171 + } + }, + "kafkaSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "saslSettings": { + "saslType": "Plain", + "secretRef": "visyxoztqnylvbyokhtmpdkwes" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "consumerGroupId": "ukkzcjiyenhxokat", + "host": "pwcqfiqclcgneolpewnyavoulbip", + "batching": { + "mode": "Enabled", + "latencyMs": 3679, + "maxBytes": 8887, + "maxMessages": 2174 + }, + "copyMqttProperties": "Enabled", + "compression": "None", + "kafkaAcks": "Zero", + "partitionStrategy": "Default", + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "localStorageSettings": { + "persistentVolumeClaimRef": "jjwqwvd" + }, + "mqttSettings": { + "authentication": { + "method": "SystemAssignedManagedIdentity", + "systemAssignedManagedIdentitySettings": { + "audience": "psxomrfbhoflycm" + }, + "userAssignedManagedIdentitySettings": { + "clientId": "fb90f267-8872-431a-a76a-a1cec5d3c4d2", + "scope": "zop", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "serviceAccountTokenSettings": { + "audience": "ejbklrbxgjaqleoycgpje" + }, + "x509CertificateSettings": { + "secretRef": "afwizrystfslkfqd" + } + }, + "clientIdPrefix": "kkljsdxdirfhwxtkavldekeqhv", + "host": "nyhnxqnbspstctl", + "protocol": "Mqtt", + "keepAliveSeconds": 0, + "retain": "Keep", + "maxInflightMessages": 0, + "qos": 1, + "sessionExpirySeconds": 0, + "tls": { + "mode": "Enabled", + "trustedCaCertificateConfigMapRef": "tectjjvukvelsreihwadh" + }, + "cloudEventAttributes": "PassThrough" + }, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowEndpoints/resource-name123", + "name": "zyhxscudobzfacetvgyjiav", + "type": "iay", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..2a8a90c8ec9e --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,95 @@ +{ + "title": "DataflowProfile_CreateOrUpdate", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "resource": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json new file mode 100644 index 000000000000..8a08b7c71f41 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Minimal.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Minimal", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 1 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 1, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json new file mode 100644 index 000000000000..1358bf219347 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_CreateOrUpdate_Multi.json @@ -0,0 +1,71 @@ +{ + "title": "DataflowProfile_CreateOrUpdate_Multi", + "operationId": "DataflowProfile_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "aio-dataflowprofile", + "resource": { + "properties": { + "instanceCount": 3 + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "instanceCount": 3, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..92c5a7d32c78 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "DataflowProfile_Delete", + "operationId": "DataflowProfile_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..992da0ba07f8 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_Get_MaximumSet_Gen.json @@ -0,0 +1,44 @@ +{ + "title": "DataflowProfile_Get", + "operationId": "DataflowProfile_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..8e7d80009c85 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,48 @@ +{ + "title": "DataflowProfile_ListByResourceGroup", + "operationId": "DataflowProfile_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "diagnostics": { + "logs": { + "level": "rnmwokumdmebpmfxxxzvvjfdywotav" + }, + "metrics": { + "prometheusPort": 7581 + } + }, + "instanceCount": 14, + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123", + "name": "bwhcjsnnfnrmbixamyxjau", + "type": "ejvancsomtbapgztnerhlvx", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json new file mode 100644 index 000000000000..6706efedf55b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexContextualization.json @@ -0,0 +1,222 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexContextualization", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-adx-contexualized", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json new file mode 100644 index 000000000000..e10915972919 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_ComplexEventHub.json @@ -0,0 +1,255 @@ +{ + "title": "Dataflow_CreateOrUpdate_ComplexEventHub", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-hub-transformed", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "filter": [ + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "($1+$2)/2", + "output": "AvgTemp.Value" + }, + { + "inputs": [], + "expression": "true", + "output": "dataflow-processed" + }, + { + "inputs": [ + "temperature.SourceTimestamp" + ], + "expression": "", + "output": "" + }, + { + "inputs": [ + "\"Tag 10\"" + ], + "expression": "", + "output": "pressure" + }, + { + "inputs": [ + "temperature.Value" + ], + "expression": "cToF($1)", + "output": "temperatureF.Value" + }, + { + "inputs": [ + "\"Tag 10\".Value" + ], + "expression": "scale ($1,0,10,0,100)", + "output": "\"Scale Tag 10\".Value" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-hub-endpoint", + "dataDestination": "myuniqueeventhub" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "map": [ + { + "inputs": [ + "*" + ], + "output": "*" + }, + { + "inputs": [ + "$context(quality).*" + ], + "output": "enriched.*" + } + ], + "datasets": [ + { + "key": "quality", + "inputs": [ + "$source.country", + "$context.country" + ], + "expression": "$1 == $2" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "adx-endpoint", + "dataDestination": "mytable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json new file mode 100644 index 000000000000..3ff5c1c6c7f3 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_FilterToTopic.json @@ -0,0 +1,210 @@ +{ + "title": "Dataflow_CreateOrUpdate_FilterToTopic", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "mqtt-filter-to-topic", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "name": "transformation1", + "builtInTransformationSettings": { + "filter": [ + { + "type": "Filter", + "description": "filter-datapoint", + "inputs": [ + "temperature.Value", + "\"Tag 10\".Value" + ], + "expression": "$1 > 9000 && $2 >= 8000" + } + ], + "map": [ + { + "type": "PassThrough", + "inputs": [ + "*" + ], + "output": "*" + } + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataDestination": "data/filtered/thermostat" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..9d4a894ae46b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,237 @@ +{ + "title": "Dataflow_CreateOrUpdate", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json new file mode 100644 index 000000000000..73a3038d8527 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json @@ -0,0 +1,132 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleEventGrid", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-event-grid", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "thermostats/+/telemetry/temperature/#" + ] + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "event-grid-endpoint", + "dataDestination": "factory/telemetry" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json new file mode 100644 index 000000000000..f4f3e6a89ecb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_CreateOrUpdate_SimpleFabric.json @@ -0,0 +1,153 @@ +{ + "title": "Dataflow_CreateOrUpdate_SimpleFabric", + "operationId": "Dataflow_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "aio-to-fabric", + "resource": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ] + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "source1", + "sourceSettings": { + "endpointRef": "aio-builtin-broker-endpoint", + "dataSources": [ + "azure-iot-operations/data/thermostat" + ] + } + }, + { + "operationType": "BuiltInTransformation", + "builtInTransformationSettings": { + "serializationFormat": "Parquet", + "schemaRef": "aio-sr://exampleNamespace/exmapleParquetSchema:1.0.0" + } + }, + { + "operationType": "Destination", + "name": "destination1", + "destinationSettings": { + "endpointRef": "fabric-endpoint", + "dataDestination": "telemetryTable" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..8617fc9681eb --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Delete_MaximumSet_Gen.json @@ -0,0 +1,20 @@ +{ + "title": "Dataflow_Delete", + "operationId": "Dataflow_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..6daa2b11a21d --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_Get_MaximumSet_Gen.json @@ -0,0 +1,92 @@ +{ + "title": "Dataflow_Get", + "operationId": "Dataflow_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123", + "dataflowName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json new file mode 100644 index 000000000000..d38f51c50759 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json @@ -0,0 +1,96 @@ +{ + "title": "Dataflow_ListByProfileResource", + "operationId": "Dataflow_ListByProfileResource", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "resource-name123", + "dataflowProfileName": "resource-name123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "mode": "Enabled", + "operations": [ + { + "operationType": "Source", + "name": "knnafvkwoeakm", + "sourceSettings": { + "endpointRef": "iixotodhvhkkfcfyrkoveslqig", + "assetRef": "zayyykwmckaocywdkohmu", + "serializationFormat": "Json", + "schemaRef": "pknmdzqll", + "dataSources": [ + "chkkpymxhp" + ] + }, + "builtInTransformationSettings": { + "serializationFormat": "Delta", + "schemaRef": "mcdc", + "datasets": [ + { + "key": "qsfqcgxaxnhfumrsdsokwyv", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "schemaRef": "n", + "inputs": [ + "mosffpsslifkq" + ], + "expression": "aatbwomvflemsxialv" + } + ], + "filter": [ + { + "type": "Filter", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "sxmjkbntgb" + ], + "expression": "n" + } + ], + "map": [ + { + "type": "NewProperties", + "description": "Lorem ipsum odor amet, consectetuer adipiscing elit.", + "inputs": [ + "xsbxuk" + ], + "expression": "txoiltogsarwkzalsphvlmt", + "output": "nvgtmkfl" + } + ] + }, + "destinationSettings": { + "endpointRef": "kybkchnzimerguekuvqlqiqdvvrt", + "dataDestination": "cbrh" + } + } + ], + "provisioningState": "Succeeded" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123/dataflowProfiles/resource-name123/dataflows/resource-name123", + "name": "jxhcpwgfkxqasbexkookvxk", + "type": "zkuozvgjseokfchkscoswthzjdry", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..ac7583a4acb2 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,103 @@ +{ + "title": "Instance_CreateOrUpdate", + "operationId": "Instance_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "resource": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "kpqtgocs", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..0b63d7261b0b --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Instance_Delete", + "operationId": "Instance_Delete", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..03f4b416dda5 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Get_MaximumSet_Gen.json @@ -0,0 +1,47 @@ +{ + "title": "Instance_Get", + "operationId": "Instance_Get", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance" + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "rlfvvnnhcypp", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..c4bedfb0b6ce --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,51 @@ +{ + "title": "Instance_ListByResourceGroup", + "operationId": "Instance_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "vmujggxdvxk" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..7229d3116831 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,50 @@ +{ + "title": "Instance_ListBySubscription", + "operationId": "Instance_ListBySubscription", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti", + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "empgqmbhvklcqlyahmdsjemlep" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..406c4a22b316 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Instance_Update_MaximumSet_Gen.json @@ -0,0 +1,54 @@ +{ + "title": "Instance_Update", + "operationId": "Instance_Update", + "parameters": { + "api-version": "2024-09-15-preview", + "subscriptionId": "F8C729F9-DF9C-4743-848F-96EE433D8E53", + "resourceGroupName": "rgiotoperations", + "instanceName": "aio-instance", + "properties": { + "tags": {}, + "identity": { + "type": "None", + "userAssignedIdentities": {} + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "schemaRegistryRef": { + "resourceId": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.DeviceRegistry/schemaRegistries/resource-name123" + }, + "description": "wwihkapmgjbyrtyaj", + "provisioningState": "Succeeded", + "version": "vjjbmunthiphfmekvxgxcxkzdwjti" + }, + "extendedLocation": { + "name": "qmbrfwcpwwhggszhrdjv", + "type": "CustomLocation" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "4a6e4195-75b8-4685-aa0c-0b5704779327", + "tenantId": "ed060aa2-71ff-4d3f-99c4-a9138356fdec" + }, + "tags": {}, + "location": "xvewadyhycrjpu", + "id": "/subscriptions/0000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup123/providers/Microsoft.IoTOperations/instances/resource-name123", + "name": "llptmlifnqqwairx", + "type": "qwrfzxjfxvismlqvigot", + "systemData": { + "createdBy": "ssvaslsmudloholronopqyxjcu", + "createdByType": "User", + "createdAt": "2024-08-09T18:13:29.389Z", + "lastModifiedBy": "gnicpuszwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-08-09T18:13:29.389Z" + } + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0429eca83eed --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "xzxqfusky", + "isDataAction": true, + "display": { + "provider": "lrveskajtuwf", + "resource": "d", + "operation": "icuckgobartrrgmirax", + "description": "dsbfnxzvnoqdm" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json new file mode 100644 index 000000000000..98bff7afc2e1 --- /dev/null +++ b/specification/iotoperations/resource-manager/Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json @@ -0,0 +1,6569 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.IoTOperations management service.", + "version": "2024-09-15-preview", + "description": "Microsoft.IoTOperations Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Instance" + }, + { + "name": "Broker" + }, + { + "name": "BrokerListener" + }, + { + "name": "BrokerAuthentication" + }, + { + "name": "BrokerAuthorization" + }, + { + "name": "DataflowProfile" + }, + { + "name": "Dataflow" + }, + { + "name": "DataflowEndpoint" + } + ], + "paths": { + "/providers/Microsoft.IoTOperations/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTOperations/instances": { + "get": { + "operationId": "Instance_ListBySubscription", + "tags": [ + "Instance" + ], + "description": "List InstanceResource resources 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/InstanceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_ListBySubscription": { + "$ref": "./examples/Instance_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances": { + "get": { + "operationId": "Instance_ListByResourceGroup", + "tags": [ + "Instance" + ], + "description": "List InstanceResource resources 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/InstanceResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_ListByResourceGroup": { + "$ref": "./examples/Instance_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}": { + "get": { + "operationId": "Instance_Get", + "tags": [ + "Instance" + ], + "description": "Get a InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_Get": { + "$ref": "./examples/Instance_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Instance_CreateOrUpdate", + "tags": [ + "Instance" + ], + "description": "Create a InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/InstanceResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'InstanceResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "201": { + "description": "Resource 'InstanceResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/InstanceResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Instance_CreateOrUpdate": { + "$ref": "./examples/Instance_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Instance_Update", + "tags": [ + "Instance" + ], + "description": "Update a InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/InstancePatchModel" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/InstanceResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Instance_Update": { + "$ref": "./examples/Instance_Update_MaximumSet_Gen.json" + } + } + }, + "delete": { + "operationId": "Instance_Delete", + "tags": [ + "Instance" + ], + "description": "Delete a InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "Instance_Delete": { + "$ref": "./examples/Instance_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers": { + "get": { + "operationId": "Broker_ListByResourceGroup", + "tags": [ + "Broker" + ], + "description": "List BrokerResource resources by InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_ListByResourceGroup": { + "$ref": "./examples/Broker_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}": { + "get": { + "operationId": "Broker_Get", + "tags": [ + "Broker" + ], + "description": "Get a BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Broker_Get": { + "$ref": "./examples/Broker_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Broker_CreateOrUpdate", + "tags": [ + "Broker" + ], + "description": "Create a BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerResource" + } + }, + "201": { + "description": "Resource 'BrokerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Broker_CreateOrUpdate": { + "$ref": "./examples/Broker_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Broker_CreateOrUpdate_Complex": { + "$ref": "./examples/Broker_CreateOrUpdate_Complex.json" + }, + "Broker_CreateOrUpdate_Minimal": { + "$ref": "./examples/Broker_CreateOrUpdate_Minimal.json" + }, + "Broker_CreateOrUpdate_Simple": { + "$ref": "./examples/Broker_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Broker_Delete", + "tags": [ + "Broker" + ], + "description": "Delete a BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "Broker_Delete": { + "$ref": "./examples/Broker_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications": { + "get": { + "operationId": "BrokerAuthentication_ListByResourceGroup", + "tags": [ + "BrokerAuthentication" + ], + "description": "List BrokerAuthenticationResource resources by BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_ListByResourceGroup": { + "$ref": "./examples/BrokerAuthentication_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}": { + "get": { + "operationId": "BrokerAuthentication_Get", + "tags": [ + "BrokerAuthentication" + ], + "description": "Get a BrokerAuthenticationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthentication_Get": { + "$ref": "./examples/BrokerAuthentication_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerAuthentication_CreateOrUpdate", + "tags": [ + "BrokerAuthentication" + ], + "description": "Create a BrokerAuthenticationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerAuthenticationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "201": { + "description": "Resource 'BrokerAuthenticationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthenticationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "BrokerAuthentication_CreateOrUpdate": { + "$ref": "./examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerAuthentication_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerAuthentication_CreateOrUpdate_Complex.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerAuthentication_Delete", + "tags": [ + "BrokerAuthentication" + ], + "description": "Delete a BrokerAuthenticationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authenticationName", + "in": "path", + "description": "Name of Instance broker authentication resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "BrokerAuthentication_Delete": { + "$ref": "./examples/BrokerAuthentication_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations": { + "get": { + "operationId": "BrokerAuthorization_ListByResourceGroup", + "tags": [ + "BrokerAuthorization" + ], + "description": "List BrokerAuthorizationResource resources by BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_ListByResourceGroup": { + "$ref": "./examples/BrokerAuthorization_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}": { + "get": { + "operationId": "BrokerAuthorization_Get", + "tags": [ + "BrokerAuthorization" + ], + "description": "Get a BrokerAuthorizationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerAuthorization_Get": { + "$ref": "./examples/BrokerAuthorization_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerAuthorization_CreateOrUpdate", + "tags": [ + "BrokerAuthorization" + ], + "description": "Create a BrokerAuthorizationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerAuthorizationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "201": { + "description": "Resource 'BrokerAuthorizationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerAuthorizationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "BrokerAuthorization_CreateOrUpdate": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerAuthorization_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_Complex.json" + }, + "BrokerAuthorization_CreateOrUpdate_Simple": { + "$ref": "./examples/BrokerAuthorization_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerAuthorization_Delete", + "tags": [ + "BrokerAuthorization" + ], + "description": "Delete a BrokerAuthorizationResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "authorizationName", + "in": "path", + "description": "Name of Instance broker authorization resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "BrokerAuthorization_Delete": { + "$ref": "./examples/BrokerAuthorization_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners": { + "get": { + "operationId": "BrokerListener_ListByResourceGroup", + "tags": [ + "BrokerListener" + ], + "description": "List BrokerListenerResource resources by BrokerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerListenerResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_ListByResourceGroup": { + "$ref": "./examples/BrokerListener_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}": { + "get": { + "operationId": "BrokerListener_Get", + "tags": [ + "BrokerListener" + ], + "description": "Get a BrokerListenerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BrokerListener_Get": { + "$ref": "./examples/BrokerListener_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "BrokerListener_CreateOrUpdate", + "tags": [ + "BrokerListener" + ], + "description": "Create a BrokerListenerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'BrokerListenerResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "201": { + "description": "Resource 'BrokerListenerResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/BrokerListenerResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "BrokerListener_CreateOrUpdate": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_MaximumSet_Gen.json" + }, + "BrokerListener_CreateOrUpdate_Complex": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_Complex.json" + }, + "BrokerListener_CreateOrUpdate_Simple": { + "$ref": "./examples/BrokerListener_CreateOrUpdate_Simple.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "BrokerListener_Delete", + "tags": [ + "BrokerListener" + ], + "description": "Delete a BrokerListenerResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "brokerName", + "in": "path", + "description": "Name of broker.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "listenerName", + "in": "path", + "description": "Name of Instance broker listener resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "BrokerListener_Delete": { + "$ref": "./examples/BrokerListener_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints": { + "get": { + "operationId": "DataflowEndpoint_ListByResourceGroup", + "tags": [ + "DataflowEndpoint" + ], + "description": "List DataflowEndpointResource resources by InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowEndpointResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_ListByResourceGroup": { + "$ref": "./examples/DataflowEndpoint_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints/{dataflowEndpointName}": { + "get": { + "operationId": "DataflowEndpoint_Get", + "tags": [ + "DataflowEndpoint" + ], + "description": "Get a DataflowEndpointResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowEndpoint_Get": { + "$ref": "./examples/DataflowEndpoint_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DataflowEndpoint_CreateOrUpdate", + "tags": [ + "DataflowEndpoint" + ], + "description": "Create a DataflowEndpointResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowEndpointResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "201": { + "description": "Resource 'DataflowEndpointResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowEndpointResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DataflowEndpoint_CreateOrUpdate": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_MaximumSet_Gen.json" + }, + "DataflowEndpoint_CreateOrUpdate_ADLSv2": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_ADLSv2.json" + }, + "DataflowEndpoint_CreateOrUpdate_ADX": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_ADX.json" + }, + "DataflowEndpoint_CreateOrUpdate_AIO": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_AIO.json" + }, + "DataflowEndpoint_CreateOrUpdate_EventGrid": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_EventGrid.json" + }, + "DataflowEndpoint_CreateOrUpdate_EventHub": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_EventHub.json" + }, + "DataflowEndpoint_CreateOrUpdate_Fabric": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_Fabric.json" + }, + "DataflowEndpoint_CreateOrUpdate_Kafka": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_Kafka.json" + }, + "DataflowEndpoint_CreateOrUpdate_LocalStorage": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_LocalStorage.json" + }, + "DataflowEndpoint_CreateOrUpdate_MQTT": { + "$ref": "./examples/DataflowEndpoint_CreateOrUpdate_MQTT.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DataflowEndpoint_Delete", + "tags": [ + "DataflowEndpoint" + ], + "description": "Delete a DataflowEndpointResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowEndpointName", + "in": "path", + "description": "Name of Instance dataflowEndpoint resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "DataflowEndpoint_Delete": { + "$ref": "./examples/DataflowEndpoint_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles": { + "get": { + "operationId": "DataflowProfile_ListByResourceGroup", + "tags": [ + "DataflowProfile" + ], + "description": "List DataflowProfileResource resources by InstanceResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowProfileResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_ListByResourceGroup": { + "$ref": "./examples/DataflowProfile_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}": { + "get": { + "operationId": "DataflowProfile_Get", + "tags": [ + "DataflowProfile" + ], + "description": "Get a DataflowProfileResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DataflowProfile_Get": { + "$ref": "./examples/DataflowProfile_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DataflowProfile_CreateOrUpdate", + "tags": [ + "DataflowProfile" + ], + "description": "Create a DataflowProfileResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowProfileResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "201": { + "description": "Resource 'DataflowProfileResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowProfileResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DataflowProfile_CreateOrUpdate": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_MaximumSet_Gen.json" + }, + "DataflowProfile_CreateOrUpdate_Minimal": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_Minimal.json" + }, + "DataflowProfile_CreateOrUpdate_Multi": { + "$ref": "./examples/DataflowProfile_CreateOrUpdate_Multi.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DataflowProfile_Delete", + "tags": [ + "DataflowProfile" + ], + "description": "Delete a DataflowProfileResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "DataflowProfile_Delete": { + "$ref": "./examples/DataflowProfile_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows": { + "get": { + "operationId": "Dataflow_ListByProfileResource", + "tags": [ + "Dataflow" + ], + "description": "List DataflowResource resources by DataflowProfileResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_ListByProfileResource": { + "$ref": "./examples/Dataflow_ListByProfileResource_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}": { + "get": { + "operationId": "Dataflow_Get", + "tags": [ + "Dataflow" + ], + "description": "Get a DataflowResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DataflowResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Dataflow_Get": { + "$ref": "./examples/Dataflow_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Dataflow_CreateOrUpdate", + "tags": [ + "Dataflow" + ], + "description": "Create a DataflowResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataflowResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DataflowResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowResource" + } + }, + "201": { + "description": "Resource 'DataflowResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/DataflowResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Dataflow_CreateOrUpdate": { + "$ref": "./examples/Dataflow_CreateOrUpdate_MaximumSet_Gen.json" + }, + "Dataflow_CreateOrUpdate_ComplexContextualization": { + "$ref": "./examples/Dataflow_CreateOrUpdate_ComplexContextualization.json" + }, + "Dataflow_CreateOrUpdate_ComplexEventHub": { + "$ref": "./examples/Dataflow_CreateOrUpdate_ComplexEventHub.json" + }, + "Dataflow_CreateOrUpdate_FilterToTopic": { + "$ref": "./examples/Dataflow_CreateOrUpdate_FilterToTopic.json" + }, + "Dataflow_CreateOrUpdate_SimpleEventGrid": { + "$ref": "./examples/Dataflow_CreateOrUpdate_SimpleEventGrid.json" + }, + "Dataflow_CreateOrUpdate_SimpleFabric": { + "$ref": "./examples/Dataflow_CreateOrUpdate_SimpleFabric.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Dataflow_Delete", + "tags": [ + "Dataflow" + ], + "description": "Delete a DataflowResource", + "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": "instanceName", + "in": "path", + "description": "Name of instance.", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowProfileName", + "in": "path", + "description": "Name of Instance dataflowProfile resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]$" + }, + { + "name": "dataflowName", + "in": "path", + "description": "Name of Instance dataflowProfile dataflow resource", + "required": true, + "type": "string", + "minLength": 3, + "maxLength": 63, + "pattern": "^[a-z0-9][a-z0-9-]*[a-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": { + "Dataflow_Delete": { + "$ref": "./examples/Dataflow_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessTokenMethod": { + "type": "string", + "description": "Access Token Method", + "enum": [ + "AccessToken" + ], + "x-ms-enum": { + "name": "AccessTokenMethod", + "modelAsString": true, + "values": [ + { + "name": "AccessToken", + "value": "AccessToken", + "description": "AccessToken Option" + } + ] + } + }, + "AdvancedSettings": { + "type": "object", + "description": "Broker Advanced Settings", + "properties": { + "clients": { + "$ref": "#/definitions/ClientConfig", + "description": "Configurations related to All Clients." + }, + "encryptInternalTraffic": { + "type": "string", + "description": "The setting to enable or disable encryption of internal Traffic.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "internalCerts": { + "$ref": "#/definitions/CertManagerCertOptions", + "description": "Certificate rotation and private key configuration." + } + } + }, + "AnonymousMethod": { + "type": "string", + "description": "x509 Certificate Method", + "enum": [ + "Anonymous" + ], + "x-ms-enum": { + "name": "AnonymousMethod", + "modelAsString": true, + "values": [ + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "AuthorizationConfig": { + "type": "object", + "description": "Broker AuthorizationConfig properties", + "properties": { + "cache": { + "type": "string", + "description": "Enable caching of the authorization rules.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "rules": { + "type": "array", + "description": "The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll.", + "items": { + "$ref": "#/definitions/AuthorizationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "AuthorizationRule": { + "type": "object", + "description": "AuthorizationConfig Rule Properties", + "properties": { + "brokerResources": { + "type": "array", + "description": "Give access to Broker methods and topics.", + "items": { + "$ref": "#/definitions/BrokerResourceRule" + }, + "x-ms-identifiers": [] + }, + "principals": { + "$ref": "#/definitions/PrincipalDefinition", + "description": "Give access to clients based on the following properties." + }, + "stateStoreResources": { + "type": "array", + "description": "Give access to state store resources.", + "items": { + "$ref": "#/definitions/StateStoreResourceRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "brokerResources", + "principals" + ] + }, + "BackendChain": { + "type": "object", + "description": "Desired properties of the backend instances of the broker", + "properties": { + "partitions": { + "type": "integer", + "format": "int32", + "description": "The desired number of physical backend partitions.", + "minimum": 1, + "maximum": 16 + }, + "redundancyFactor": { + "type": "integer", + "format": "int32", + "description": "The desired numbers of backend replicas (pods) in a physical partition.", + "minimum": 1, + "maximum": 5 + }, + "workers": { + "type": "integer", + "format": "int32", + "description": "Number of logical backend workers per replica (pod).", + "default": 1, + "minimum": 1, + "maximum": 16 + } + }, + "required": [ + "partitions", + "redundancyFactor" + ] + }, + "BatchingConfiguration": { + "type": "object", + "description": "Batching configuration", + "properties": { + "latencySeconds": { + "type": "integer", + "format": "int32", + "description": "Batching latency in seconds.", + "default": 60, + "minimum": 0, + "maximum": 65535 + }, + "maxMessages": { + "type": "integer", + "format": "int32", + "description": "Maximum number of messages in a batch.", + "default": 100000, + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "BrokerAuthenticationMethod": { + "type": "string", + "description": "Broker Authentication Mode", + "enum": [ + "Custom", + "ServiceAccountToken", + "X509" + ], + "x-ms-enum": { + "name": "BrokerAuthenticationMethod", + "modelAsString": true, + "values": [ + { + "name": "Custom", + "value": "Custom", + "description": "Custom authentication configuration." + }, + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken authentication configuration." + }, + { + "name": "X509", + "value": "X509", + "description": "X.509 authentication configuration." + } + ] + } + }, + "BrokerAuthenticationProperties": { + "type": "object", + "description": "BrokerAuthentication Resource properties", + "properties": { + "authenticationMethods": { + "type": "array", + "description": "Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported.", + "items": { + "$ref": "#/definitions/BrokerAuthenticatorMethods" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "authenticationMethods" + ] + }, + "BrokerAuthenticationResource": { + "type": "object", + "description": "Instance broker authentication resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerAuthenticationProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerAuthenticationResourceListResult": { + "type": "object", + "description": "The response of a BrokerAuthenticationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerAuthenticationResource items on this page", + "items": { + "$ref": "#/definitions/BrokerAuthenticationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerAuthenticatorCustomAuth": { + "type": "object", + "description": "Custom Authentication properties", + "properties": { + "x509": { + "$ref": "#/definitions/X509ManualCertificate", + "description": "X509 Custom Auth type details." + } + }, + "required": [ + "x509" + ] + }, + "BrokerAuthenticatorMethodCustom": { + "type": "object", + "description": "Custom method for BrokerAuthentication", + "properties": { + "auth": { + "$ref": "#/definitions/BrokerAuthenticatorCustomAuth", + "description": "Optional authentication needed for authenticating with the custom authentication server." + }, + "caCertConfigMap": { + "type": "string", + "description": "Optional CA certificate for validating the custom authentication server's certificate." + }, + "endpoint": { + "type": "string", + "format": "uri", + "description": "Endpoint of the custom authentication server. Must be an HTTPS endpoint.", + "pattern": "^https://.*$" + }, + "headers": { + "type": "object", + "description": "Additional HTTP headers to pass to the custom authentication server.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "endpoint" + ] + }, + "BrokerAuthenticatorMethodSat": { + "type": "object", + "description": "Service Account Token for BrokerAuthentication", + "properties": { + "audiences": { + "type": "array", + "description": "List of allowed audience.", + "items": { + "type": "string" + } + } + }, + "required": [ + "audiences" + ] + }, + "BrokerAuthenticatorMethodX509": { + "type": "object", + "description": "X509 for BrokerAuthentication.", + "properties": { + "authorizationAttributes": { + "type": "object", + "description": "X509 authorization attributes properties.", + "additionalProperties": { + "$ref": "#/definitions/BrokerAuthenticatorMethodX509Attributes" + } + }, + "trustedClientCaCert": { + "type": "string", + "description": "Name of the trusted client ca cert resource.", + "default": "client-ca" + } + } + }, + "BrokerAuthenticatorMethodX509Attributes": { + "type": "object", + "description": "BrokerAuthenticatorMethodX509Attributes properties.", + "properties": { + "attributes": { + "type": "object", + "description": "Attributes object.", + "additionalProperties": { + "type": "string" + } + }, + "subject": { + "type": "string", + "description": "Subject of the X509 attribute." + } + }, + "required": [ + "attributes", + "subject" + ] + }, + "BrokerAuthenticatorMethods": { + "type": "object", + "description": "Set of broker authentication policies. Only one method is supported for each entry.", + "properties": { + "method": { + "$ref": "#/definitions/BrokerAuthenticationMethod", + "description": "Custom authentication configuration." + }, + "customSettings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodCustom", + "description": "Custom authentication configuration." + }, + "serviceAccountTokenSettings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodSat", + "description": "ServiceAccountToken authentication configuration." + }, + "x509Settings": { + "$ref": "#/definitions/BrokerAuthenticatorMethodX509", + "description": "X.509 authentication configuration." + } + }, + "required": [ + "method" + ] + }, + "BrokerAuthorizationProperties": { + "type": "object", + "description": "BrokerAuthorization Resource properties", + "properties": { + "authorizationPolicies": { + "$ref": "#/definitions/AuthorizationConfig", + "description": "The list of authorization policies supported by the Authorization Resource." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "authorizationPolicies" + ] + }, + "BrokerAuthorizationResource": { + "type": "object", + "description": "Instance broker authorizations resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerAuthorizationProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerAuthorizationResourceListResult": { + "type": "object", + "description": "The response of a BrokerAuthorizationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerAuthorizationResource items on this page", + "items": { + "$ref": "#/definitions/BrokerAuthorizationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerDiagnostics": { + "type": "object", + "description": "Broker Diagnostic Setting properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + }, + "selfCheck": { + "$ref": "#/definitions/SelfCheck", + "description": "The self check properties." + }, + "traces": { + "$ref": "#/definitions/Traces", + "description": "The trace properties." + } + } + }, + "BrokerListenerProperties": { + "type": "object", + "description": "Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients.", + "properties": { + "serviceName": { + "type": "string", + "description": "Kubernetes Service name of this listener." + }, + "ports": { + "type": "array", + "description": "Ports on which this listener accepts client connections.", + "items": { + "$ref": "#/definitions/ListenerPort" + }, + "x-ms-identifiers": [ + "port" + ] + }, + "serviceType": { + "type": "string", + "description": "Kubernetes Service type of this listener.", + "default": "ClusterIp", + "enum": [ + "ClusterIp", + "LoadBalancer", + "NodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "ClusterIp", + "value": "ClusterIp", + "description": "Cluster IP Service." + }, + { + "name": "LoadBalancer", + "value": "LoadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "NodePort", + "value": "NodePort", + "description": "Node Port Service." + } + ] + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "ports" + ] + }, + "BrokerListenerResource": { + "type": "object", + "description": "Instance broker resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerListenerProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerListenerResourceListResult": { + "type": "object", + "description": "The response of a BrokerListenerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerListenerResource items on this page", + "items": { + "$ref": "#/definitions/BrokerListenerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerMemoryProfile": { + "type": "string", + "description": "The memory profile settings of the Broker", + "enum": [ + "Tiny", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "Tiny", + "value": "Tiny", + "description": "Tiny memory profile." + }, + { + "name": "Low", + "value": "Low", + "description": "Low memory profile." + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium memory profile." + }, + { + "name": "High", + "value": "High", + "description": "High memory profile." + } + ] + } + }, + "BrokerProperties": { + "type": "object", + "description": "Broker Resource properties", + "properties": { + "advanced": { + "$ref": "#/definitions/AdvancedSettings", + "description": "Advanced settings of Broker.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "cardinality": { + "$ref": "#/definitions/Cardinality", + "description": "The cardinality details of the broker.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "diagnostics": { + "$ref": "#/definitions/BrokerDiagnostics", + "description": "Spec defines the desired identities of Broker diagnostics settings." + }, + "diskBackedMessageBuffer": { + "$ref": "#/definitions/DiskBackedMessageBuffer", + "description": "Settings of Disk Backed Message Buffer.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "generateResourceLimits": { + "$ref": "#/definitions/GenerateResourceLimits", + "description": "This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "memoryProfile": { + "type": "string", + "description": "Memory profile of Broker.", + "default": "Medium", + "enum": [ + "Tiny", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "BrokerMemoryProfile", + "modelAsString": true, + "values": [ + { + "name": "Tiny", + "value": "Tiny", + "description": "Tiny memory profile." + }, + { + "name": "Low", + "value": "Low", + "description": "Low memory profile." + }, + { + "name": "Medium", + "value": "Medium", + "description": "Medium memory profile." + }, + { + "name": "High", + "value": "High", + "description": "High memory profile." + } + ] + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "BrokerProtocolType": { + "type": "string", + "description": "Broker Protocol types", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "BrokerResource": { + "type": "object", + "description": "Instance broker resource", + "properties": { + "properties": { + "$ref": "#/definitions/BrokerProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BrokerResourceDefinitionMethods": { + "type": "string", + "description": "BrokerResourceDefinitionMethods methods allowed", + "enum": [ + "Connect", + "Publish", + "Subscribe" + ], + "x-ms-enum": { + "name": "BrokerResourceDefinitionMethods", + "modelAsString": true, + "values": [ + { + "name": "Connect", + "value": "Connect", + "description": "Allowed Connecting to Broker" + }, + { + "name": "Publish", + "value": "Publish", + "description": "Allowed Publishing to Broker" + }, + { + "name": "Subscribe", + "value": "Subscribe", + "description": "Allowed Subscribing to Broker" + } + ] + } + }, + "BrokerResourceListResult": { + "type": "object", + "description": "The response of a BrokerResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The BrokerResource items on this page", + "items": { + "$ref": "#/definitions/BrokerResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "BrokerResourceRule": { + "type": "object", + "description": "Broker Resource Rule properties. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc.", + "properties": { + "method": { + "$ref": "#/definitions/BrokerResourceDefinitionMethods", + "description": "Give access for a Broker method (i.e., Connect, Subscribe, or Publish)." + }, + "clientIds": { + "type": "array", + "description": "A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect.", + "default": [], + "items": { + "type": "string" + } + }, + "topics": { + "type": "array", + "description": "A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.", + "default": [], + "items": { + "type": "string" + } + } + }, + "required": [ + "method" + ] + }, + "Cardinality": { + "type": "object", + "description": "Cardinality properties", + "properties": { + "backendChain": { + "$ref": "#/definitions/BackendChain", + "description": "The backend broker desired properties" + }, + "frontend": { + "$ref": "#/definitions/Frontend", + "description": "The frontend desired properties" + } + }, + "required": [ + "backendChain", + "frontend" + ] + }, + "CertManagerCertOptions": { + "type": "object", + "description": "Cert Manager Cert properties", + "properties": { + "duration": { + "type": "string", + "description": "Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "renewBefore": { + "type": "string", + "description": "When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "privateKey": { + "$ref": "#/definitions/CertManagerPrivateKey", + "description": "Configuration of certificate private key." + } + }, + "required": [ + "duration", + "renewBefore", + "privateKey" + ] + }, + "CertManagerCertificateSpec": { + "type": "object", + "description": "Automatic TLS server certificate management with cert-manager", + "properties": { + "duration": { + "type": "string", + "description": "Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "secretName": { + "type": "string", + "description": "Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself." + }, + "renewBefore": { + "type": "string", + "description": "When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes." + }, + "issuerRef": { + "$ref": "#/definitions/CertManagerIssuerRef", + "description": "cert-manager issuerRef." + }, + "privateKey": { + "$ref": "#/definitions/CertManagerPrivateKey", + "description": "Type of certificate private key." + }, + "san": { + "$ref": "#/definitions/SanForCert", + "description": "Additional Subject Alternative Names (SANs) to include in the certificate." + } + }, + "required": [ + "issuerRef" + ] + }, + "CertManagerIssuerKind": { + "type": "string", + "description": "CertManagerIssuerKind properties", + "enum": [ + "Issuer", + "ClusterIssuer" + ], + "x-ms-enum": { + "name": "CertManagerIssuerKind", + "modelAsString": true, + "values": [ + { + "name": "Issuer", + "value": "Issuer", + "description": "Issuer kind." + }, + { + "name": "ClusterIssuer", + "value": "ClusterIssuer", + "description": "ClusterIssuer kind." + } + ] + } + }, + "CertManagerIssuerRef": { + "type": "object", + "description": "Cert-Manager issuerRef properties", + "properties": { + "group": { + "type": "string", + "description": "group of issuer.", + "default": "cert-manager.io" + }, + "kind": { + "$ref": "#/definitions/CertManagerIssuerKind", + "description": "kind of issuer (Issuer or ClusterIssuer)." + }, + "name": { + "type": "string", + "description": "name of issuer." + } + }, + "required": [ + "group", + "kind", + "name" + ] + }, + "CertManagerPrivateKey": { + "type": "object", + "description": "Cert Manager private key properties", + "properties": { + "algorithm": { + "$ref": "#/definitions/PrivateKeyAlgorithm", + "description": "algorithm for private key." + }, + "rotationPolicy": { + "$ref": "#/definitions/PrivateKeyRotationPolicy", + "description": "cert-manager private key rotationPolicy." + } + }, + "required": [ + "algorithm", + "rotationPolicy" + ] + }, + "ClientConfig": { + "type": "object", + "description": "The settings of Client Config.", + "properties": { + "maxSessionExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Session Expiry Interval, in seconds.", + "minimum": 1, + "maximum": 4294967295 + }, + "maxMessageExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Message Expiry Interval, in seconds.", + "minimum": 1, + "maximum": 4294967295 + }, + "maxPacketSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Max message size for a packet in Bytes.", + "minimum": 1, + "maximum": 268435456 + }, + "subscriberQueueLimit": { + "$ref": "#/definitions/SubscriberQueueLimit", + "description": "The limit on the number of queued messages for a subscriber." + }, + "maxReceiveMaximum": { + "type": "integer", + "format": "int32", + "description": "Upper bound of Receive Maximum that a client can request in the CONNECT packet.", + "minimum": 1, + "maximum": 65535 + }, + "maxKeepAliveSeconds": { + "type": "integer", + "format": "int32", + "description": "Upper bound of a client's Keep Alive, in seconds.", + "minimum": 0, + "maximum": 65535 + } + } + }, + "CloudEventAttributeType": { + "type": "string", + "description": "How to map events to the cloud.", + "enum": [ + "Propagate", + "CreateOrRemap" + ], + "x-ms-enum": { + "name": "CloudEventAttributeType", + "modelAsString": true, + "values": [ + { + "name": "Propagate", + "value": "Propagate", + "description": "Propagate type" + }, + { + "name": "CreateOrRemap", + "value": "CreateOrRemap", + "description": "CreateOrRemap type" + } + ] + } + }, + "DataExplorerAuthMethod": { + "$ref": "#/definitions/ManagedIdentityMethod", + "x-nullable": false + }, + "DataLakeStorageAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Data Lake Storage Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "AccessToken" + ], + "x-ms-enum": { + "name": "DataLakeStorageAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "AccessToken", + "value": "AccessToken", + "description": "AccessToken Option" + } + ] + } + }, + "DataflowBuiltInTransformationDataset": { + "type": "object", + "description": "Dataflow BuiltIn Transformation dataset properties", + "properties": { + "key": { + "type": "string", + "description": "The key of the dataset.", + "maxLength": 64 + }, + "description": { + "type": "string", + "description": "A user provided optional description of the dataset.", + "maxLength": 256 + }, + "schemaRef": { + "type": "string", + "description": "The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7." + }, + "inputs": { + "type": "array", + "description": "List of fields for enriching from the Broker State Store.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided)" + } + }, + "required": [ + "key", + "inputs" + ] + }, + "DataflowBuiltInTransformationFilter": { + "type": "object", + "description": "Dataflow BuiltIn Transformation filter properties", + "properties": { + "type": { + "type": "string", + "description": "The type of dataflow operation.", + "default": "Filter", + "enum": [ + "Filter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": true, + "values": [ + { + "name": "Filter", + "value": "Filter", + "description": "Filter type" + } + ] + } + }, + "description": { + "type": "string", + "description": "A user provided optional description of the filter.", + "maxLength": 256 + }, + "inputs": { + "type": "array", + "description": "List of fields for filtering in JSON path expression.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided)" + } + }, + "required": [ + "inputs", + "expression" + ] + }, + "DataflowBuiltInTransformationMap": { + "type": "object", + "description": "Dataflow BuiltIn Transformation map properties", + "properties": { + "type": { + "$ref": "#/definitions/DataflowMappingType", + "description": "Type of transformation." + }, + "description": { + "type": "string", + "description": "A user provided optional description of the mapping function.", + "maxLength": 256 + }, + "inputs": { + "type": "array", + "description": "List of fields for mapping in JSON path expression.", + "items": { + "type": "string" + } + }, + "expression": { + "type": "string", + "description": "Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided)" + }, + "output": { + "type": "string", + "description": "Where and how the input fields to be organized in the output record." + } + }, + "required": [ + "inputs", + "output" + ] + }, + "DataflowBuiltInTransformationSettings": { + "type": "object", + "description": "Dataflow BuiltIn Transformation properties", + "properties": { + "serializationFormat": { + "type": "string", + "description": "Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json", + "default": "Json", + "enum": [ + "Delta", + "Json", + "Parquet" + ], + "x-ms-enum": { + "name": "TransformationSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Delta", + "value": "Delta", + "description": "Delta Format" + }, + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + }, + { + "name": "Parquet", + "value": "Parquet", + "description": "Parquet Format" + } + ] + } + }, + "schemaRef": { + "type": "string", + "description": "Reference to the schema that describes the output of the transformation." + }, + "datasets": { + "type": "array", + "description": "Enrich data from Broker State Store. Dataset references a key in Broker State Store.", + "default": [], + "maxItems": 1, + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationDataset" + }, + "x-ms-identifiers": [] + }, + "filter": { + "type": "array", + "description": "Filters input record or datapoints based on condition.", + "default": [], + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationFilter" + }, + "x-ms-identifiers": [] + }, + "map": { + "type": "array", + "description": "Maps input to output message.", + "default": [], + "items": { + "$ref": "#/definitions/DataflowBuiltInTransformationMap" + }, + "x-ms-identifiers": [] + } + } + }, + "DataflowDestinationOperationSettings": { + "type": "object", + "description": "Dataflow Destination Operation properties", + "properties": { + "endpointRef": { + "type": "string", + "description": "Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type." + }, + "dataDestination": { + "$ref": "#/definitions/NonEmptyString", + "description": "Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription." + } + }, + "required": [ + "endpointRef", + "dataDestination" + ] + }, + "DataflowEndpointAuthenticationAccessToken": { + "type": "object", + "description": "DataflowEndpoint Authentication Access Token properties", + "properties": { + "secretRef": { + "type": "string", + "description": "Token secret name." + } + }, + "required": [ + "secretRef" + ] + }, + "DataflowEndpointAuthenticationSasl": { + "type": "object", + "description": "DataflowEndpoint Authentication Sasl properties", + "properties": { + "saslType": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSaslType", + "description": "Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512." + }, + "secretRef": { + "type": "string", + "description": "Token secret name." + } + }, + "required": [ + "saslType", + "secretRef" + ] + }, + "DataflowEndpointAuthenticationSaslType": { + "type": "string", + "description": "DataflowEndpoint Authentication Sasl Type properties", + "enum": [ + "Plain", + "ScramSha256", + "ScramSha512" + ], + "x-ms-enum": { + "name": "DataflowEndpointAuthenticationSaslType", + "modelAsString": true, + "values": [ + { + "name": "Plain", + "value": "Plain", + "description": "PLAIN Type" + }, + { + "name": "ScramSha256", + "value": "ScramSha256", + "description": "SCRAM_SHA_256 Type" + }, + { + "name": "ScramSha512", + "value": "ScramSha512", + "description": "SCRAM_SHA_512 Type" + } + ] + } + }, + "DataflowEndpointAuthenticationServiceAccountToken": { + "type": "object", + "description": "Service Account Token for BrokerAuthentication", + "properties": { + "audience": { + "type": "string", + "description": "Audience of the service account. Optional, defaults to the broker internal service account audience." + } + }, + "required": [ + "audience" + ] + }, + "DataflowEndpointAuthenticationSystemAssignedManagedIdentity": { + "type": "object", + "description": "DataflowEndpoint Authentication SystemAssignedManagedIdentity properties", + "properties": { + "audience": { + "type": "string", + "description": "Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration." + } + } + }, + "DataflowEndpointAuthenticationUserAssignedManagedIdentity": { + "type": "object", + "description": "DataflowEndpoint Authentication UserAssignedManagedIdentity properties", + "properties": { + "clientId": { + "type": "string", + "description": "Client ID for the user-assigned managed identity." + }, + "scope": { + "type": "string", + "description": "Resource identifier (application ID URI) of the resource, affixed with the .default suffix." + }, + "tenantId": { + "type": "string", + "description": "Tenant ID." + } + }, + "required": [ + "clientId", + "tenantId" + ] + }, + "DataflowEndpointAuthenticationX509": { + "type": "object", + "description": "DataflowEndpoint Authentication X509 properties", + "properties": { + "secretRef": { + "type": "string", + "description": "Secret reference of the X.509 certificate." + } + }, + "required": [ + "secretRef" + ] + }, + "DataflowEndpointDataExplorer": { + "type": "object", + "description": "Azure Data Explorer endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointDataExplorerAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "database": { + "type": "string", + "description": "Database name." + }, + "host": { + "type": "string", + "description": "Host of the Azure Data Explorer in the form of <cluster>.<region>.kusto.windows.net .", + "pattern": ".+\\..+\\.kusto\\.windows\\.net" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Azure Data Explorer endpoint batching configuration." + } + }, + "required": [ + "authentication", + "database", + "host" + ] + }, + "DataflowEndpointDataExplorerAuthentication": { + "type": "object", + "description": "Azure Data Explorer Authentication properties. NOTE - only authentication property is allowed per entry.", + "properties": { + "method": { + "$ref": "#/definitions/DataExplorerAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointDataLakeStorage": { + "type": "object", + "description": "Azure Data Lake endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointDataLakeStorageAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "host": { + "type": "string", + "description": "Host of the Azure Data Lake in the form of <account>.blob.core.windows.net .", + "pattern": ".+\\.blob\\.core\\.windows\\.net" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Azure Data Lake endpoint batching configuration." + } + }, + "required": [ + "authentication", + "host" + ] + }, + "DataflowEndpointDataLakeStorageAuthentication": { + "type": "object", + "description": "Azure Data Lake endpoint Authentication properties. NOTE Enum - Only one method is supported for one entry", + "properties": { + "method": { + "$ref": "#/definitions/DataLakeStorageAuthMethod", + "description": "Mode of Authentication." + }, + "accessTokenSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationAccessToken", + "description": "SAS token authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointFabricOneLake": { + "type": "object", + "description": "Microsoft Fabric endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointFabricOneLakeAuthentication", + "description": "Authentication configuration. NOTE - only one authentication property is allowed per entry." + }, + "names": { + "$ref": "#/definitions/DataflowEndpointFabricOneLakeNames", + "description": "Names of the workspace and lakehouse." + }, + "oneLakePathType": { + "$ref": "#/definitions/DataflowEndpointFabricPathType", + "description": "Type of location of the data in the workspace. Can be either tables or files." + }, + "host": { + "type": "string", + "description": "Host of the Microsoft Fabric in the form of https://<host>.fabric.microsoft.com.", + "pattern": ".+\\.fabric\\.microsoft\\.com" + }, + "batching": { + "$ref": "#/definitions/BatchingConfiguration", + "description": "Batching configuration." + } + }, + "required": [ + "authentication", + "names", + "oneLakePathType", + "host" + ] + }, + "DataflowEndpointFabricOneLakeAuthentication": { + "type": "object", + "description": "Microsoft Fabric endpoint. Authentication properties. NOTE - Only one method is supported for one entry", + "properties": { + "method": { + "$ref": "#/definitions/FabricOneLakeAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointFabricOneLakeNames": { + "type": "object", + "description": "Microsoft Fabric endpoint Names properties", + "properties": { + "lakehouseName": { + "type": "string", + "description": "Lakehouse name." + }, + "workspaceName": { + "type": "string", + "description": "Workspace name." + } + }, + "required": [ + "lakehouseName", + "workspaceName" + ] + }, + "DataflowEndpointFabricPathType": { + "type": "string", + "description": "DataflowEndpoint Fabric Path Type properties", + "enum": [ + "Files", + "Tables" + ], + "x-ms-enum": { + "name": "DataflowEndpointFabricPathType", + "modelAsString": true, + "values": [ + { + "name": "Files", + "value": "Files", + "description": "FILES Type" + }, + { + "name": "Tables", + "value": "Tables", + "description": "TABLES Type" + } + ] + } + }, + "DataflowEndpointKafka": { + "type": "object", + "description": "Kafka endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointKafkaAuthentication", + "description": "Authentication configuration. NOTE - only authentication property is allowed per entry." + }, + "consumerGroupId": { + "type": "string", + "description": "Consumer group ID." + }, + "host": { + "type": "string", + "description": "Kafka endpoint host." + }, + "batching": { + "$ref": "#/definitions/DataflowEndpointKafkaBatching", + "description": "Batching configuration." + }, + "copyMqttProperties": { + "type": "string", + "description": "Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "compression": { + "type": "string", + "description": "Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source.", + "default": "None", + "enum": [ + "None", + "Gzip", + "Snappy", + "Lz4" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaCompression", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "NONE Option" + }, + { + "name": "Gzip", + "value": "Gzip", + "description": "Gzip Option" + }, + { + "name": "Snappy", + "value": "Snappy", + "description": "SNAPPY Option" + }, + { + "name": "Lz4", + "value": "Lz4", + "description": "LZ4 Option" + } + ] + } + }, + "kafkaAcks": { + "type": "string", + "description": "Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source.", + "default": "All", + "enum": [ + "Zero", + "One", + "All" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaAcks", + "modelAsString": true, + "values": [ + { + "name": "Zero", + "value": "Zero", + "description": "ZERO Option" + }, + { + "name": "One", + "value": "One", + "description": "ONE Option" + }, + { + "name": "All", + "value": "All", + "description": "ALL Option" + } + ] + } + }, + "partitionStrategy": { + "type": "string", + "description": "Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source.", + "default": "Default", + "enum": [ + "Default", + "Static", + "Topic", + "Property" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default: Assigns messages to random partitions, using a round-robin algorithm." + }, + { + "name": "Static", + "value": "Static", + "description": "Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow." + }, + { + "name": "Topic", + "value": "Topic", + "description": "TOPIC Option" + }, + { + "name": "Property", + "value": "Property", + "description": "PROPERTY Option" + } + ] + } + }, + "tls": { + "$ref": "#/definitions/TlsProperties", + "description": "TLS configuration." + }, + "cloudEventAttributes": { + "$ref": "#/definitions/CloudEventAttributeType", + "description": "Cloud event mapping config." + } + }, + "required": [ + "authentication", + "host" + ] + }, + "DataflowEndpointKafkaAcks": { + "type": "string", + "description": "DataflowEndpoint Kafka Acks properties", + "enum": [ + "Zero", + "One", + "All" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaAcks", + "modelAsString": true, + "values": [ + { + "name": "Zero", + "value": "Zero", + "description": "ZERO Option" + }, + { + "name": "One", + "value": "One", + "description": "ONE Option" + }, + { + "name": "All", + "value": "All", + "description": "ALL Option" + } + ] + } + }, + "DataflowEndpointKafkaAuthentication": { + "type": "object", + "description": "Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry", + "properties": { + "method": { + "$ref": "#/definitions/KafkaAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + }, + "saslSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSasl", + "description": "SASL authentication." + }, + "x509CertificateSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationX509", + "description": "X.509 certificate authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointKafkaBatching": { + "type": "object", + "description": "Kafka endpoint Batching properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for batching.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "latencyMs": { + "type": "integer", + "format": "int32", + "description": "Batching latency in milliseconds.", + "default": 5, + "minimum": 0, + "maximum": 65535 + }, + "maxBytes": { + "type": "integer", + "format": "int32", + "description": "Maximum number of bytes in a batch.", + "default": 1000000, + "minimum": 0, + "maximum": 4294967295 + }, + "maxMessages": { + "type": "integer", + "format": "int32", + "description": "Maximum number of messages in a batch.", + "default": 100000, + "minimum": 0, + "maximum": 4294967295 + } + } + }, + "DataflowEndpointKafkaCompression": { + "type": "string", + "description": "Kafka endpoint Compression properties", + "enum": [ + "None", + "Gzip", + "Snappy", + "Lz4" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaCompression", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "NONE Option" + }, + { + "name": "Gzip", + "value": "Gzip", + "description": "Gzip Option" + }, + { + "name": "Snappy", + "value": "Snappy", + "description": "SNAPPY Option" + }, + { + "name": "Lz4", + "value": "Lz4", + "description": "LZ4 Option" + } + ] + } + }, + "DataflowEndpointKafkaPartitionStrategy": { + "type": "string", + "description": "DataflowEndpoint Kafka Partition Strategy properties", + "enum": [ + "Default", + "Static", + "Topic", + "Property" + ], + "x-ms-enum": { + "name": "DataflowEndpointKafkaPartitionStrategy", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default: Assigns messages to random partitions, using a round-robin algorithm." + }, + { + "name": "Static", + "value": "Static", + "description": "Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow." + }, + { + "name": "Topic", + "value": "Topic", + "description": "TOPIC Option" + }, + { + "name": "Property", + "value": "Property", + "description": "PROPERTY Option" + } + ] + } + }, + "DataflowEndpointLocalStorage": { + "type": "object", + "description": "Local persistent volume endpoint properties", + "properties": { + "persistentVolumeClaimRef": { + "type": "string", + "description": "Persistent volume claim name." + } + }, + "required": [ + "persistentVolumeClaimRef" + ] + }, + "DataflowEndpointMqtt": { + "type": "object", + "description": "Broker endpoint properties", + "properties": { + "authentication": { + "$ref": "#/definitions/DataflowEndpointMqttAuthentication", + "description": "authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed" + }, + "clientIdPrefix": { + "type": "string", + "description": "Client ID prefix. Client ID generated by the dataflow is <prefix>-TBD. Optional; no prefix if omitted." + }, + "host": { + "type": "string", + "description": "Host of the Broker in the form of <hostname>:<port>. Optional; connects to Broker if omitted." + }, + "protocol": { + "type": "string", + "description": "Enable or disable websockets.", + "default": "Mqtt", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "keepAliveSeconds": { + "type": "integer", + "format": "int32", + "description": "Broker KeepAlive for connection in seconds.", + "default": 60, + "minimum": 0 + }, + "retain": { + "type": "string", + "description": "Whether or not to keep the retain setting.", + "default": "Keep", + "enum": [ + "Keep", + "Never" + ], + "x-ms-enum": { + "name": "MqttRetainType", + "modelAsString": true, + "values": [ + { + "name": "Keep", + "value": "Keep", + "description": "Retain the messages." + }, + { + "name": "Never", + "value": "Never", + "description": "Never retain messages." + } + ] + } + }, + "maxInflightMessages": { + "type": "integer", + "format": "int32", + "description": "The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack.", + "default": 100, + "minimum": 0 + }, + "qos": { + "type": "integer", + "format": "int32", + "description": "Qos for Broker connection.", + "default": 1, + "minimum": 0, + "maximum": 1 + }, + "sessionExpirySeconds": { + "type": "integer", + "format": "int32", + "description": "Session expiry in seconds.", + "default": 3600, + "minimum": 0 + }, + "tls": { + "$ref": "#/definitions/TlsProperties", + "description": "TLS configuration." + }, + "cloudEventAttributes": { + "$ref": "#/definitions/CloudEventAttributeType", + "description": "Cloud event mapping config." + } + }, + "required": [ + "authentication" + ] + }, + "DataflowEndpointMqttAuthentication": { + "type": "object", + "description": "Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry.", + "properties": { + "method": { + "$ref": "#/definitions/MqttAuthMethod", + "description": "Mode of Authentication." + }, + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + }, + "serviceAccountTokenSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationServiceAccountToken", + "description": "Kubernetes service account token authentication. Default audience if not set is aio-internal" + }, + "x509CertificateSettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationX509", + "description": "X.509 certificate authentication." + } + }, + "required": [ + "method" + ] + }, + "DataflowEndpointProperties": { + "type": "object", + "description": "DataflowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource", + "properties": { + "endpointType": { + "$ref": "#/definitions/EndpointType", + "description": "Endpoint Type." + }, + "dataExplorerSettings": { + "$ref": "#/definitions/DataflowEndpointDataExplorer", + "description": "Azure Data Explorer endpoint." + }, + "dataLakeStorageSettings": { + "$ref": "#/definitions/DataflowEndpointDataLakeStorage", + "description": "Azure Data Lake endpoint." + }, + "fabricOneLakeSettings": { + "$ref": "#/definitions/DataflowEndpointFabricOneLake", + "description": "Microsoft Fabric endpoint." + }, + "kafkaSettings": { + "$ref": "#/definitions/DataflowEndpointKafka", + "description": "Kafka endpoint." + }, + "localStorageSettings": { + "$ref": "#/definitions/DataflowEndpointLocalStorage", + "description": "Local persistent volume endpoint." + }, + "mqttSettings": { + "$ref": "#/definitions/DataflowEndpointMqtt", + "description": "Broker endpoint." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "endpointType" + ] + }, + "DataflowEndpointResource": { + "type": "object", + "description": "Instance dataflowEndpoint resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowEndpointProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowEndpointResourceListResult": { + "type": "object", + "description": "The response of a DataflowEndpointResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowEndpointResource items on this page", + "items": { + "$ref": "#/definitions/DataflowEndpointResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowMappingType": { + "type": "string", + "description": "Dataflow type mapping properties", + "enum": [ + "NewProperties", + "Rename", + "Compute", + "PassThrough", + "BuiltInFunction" + ], + "x-ms-enum": { + "name": "DataflowMappingType", + "modelAsString": true, + "values": [ + { + "name": "NewProperties", + "value": "NewProperties", + "description": "New Properties type" + }, + { + "name": "Rename", + "value": "Rename", + "description": "Rename type" + }, + { + "name": "Compute", + "value": "Compute", + "description": "Compute type" + }, + { + "name": "PassThrough", + "value": "PassThrough", + "description": "Pass-through type" + }, + { + "name": "BuiltInFunction", + "value": "BuiltInFunction", + "description": "Built in function type" + } + ] + } + }, + "DataflowOperation": { + "type": "object", + "description": "Dataflow Operation properties. NOTE - One only method is allowed to be used for one entry.", + "properties": { + "operationType": { + "$ref": "#/definitions/OperationType", + "description": "Type of operation." + }, + "name": { + "type": "string", + "description": "Optional user provided name of the transformation.", + "maxLength": 64 + }, + "sourceSettings": { + "$ref": "#/definitions/DataflowSourceOperationSettings", + "description": "Source configuration." + }, + "builtInTransformationSettings": { + "$ref": "#/definitions/DataflowBuiltInTransformationSettings", + "description": "Built In Transformation configuration." + }, + "destinationSettings": { + "$ref": "#/definitions/DataflowDestinationOperationSettings", + "description": "Destination configuration." + } + }, + "required": [ + "operationType" + ] + }, + "DataflowProfileProperties": { + "type": "object", + "description": "DataflowProfile Resource properties", + "properties": { + "diagnostics": { + "$ref": "#/definitions/ProfileDiagnostics", + "description": "Spec defines the desired identities of NBC diagnostics settings." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "To manually scale the dataflow profile, specify the maximum number of instances you want to run.", + "default": 1, + "minimum": 1, + "maximum": 20 + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DataflowProfileResource": { + "type": "object", + "description": "Instance dataflowProfile resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowProfileProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowProfileResourceListResult": { + "type": "object", + "description": "The response of a DataflowProfileResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowProfileResource items on this page", + "items": { + "$ref": "#/definitions/DataflowProfileResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowProperties": { + "type": "object", + "description": "Dataflow Resource properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for Dataflow. Optional; defaults to Enabled.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "operations": { + "type": "array", + "description": "List of operations including source and destination references as well as transformation.", + "items": { + "$ref": "#/definitions/DataflowOperation" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "operations" + ] + }, + "DataflowResource": { + "type": "object", + "description": "Instance dataflowProfile dataflow resource", + "properties": { + "properties": { + "$ref": "#/definitions/DataflowProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "DataflowResourceListResult": { + "type": "object", + "description": "The response of a DataflowResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DataflowResource items on this page", + "items": { + "$ref": "#/definitions/DataflowResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DataflowSourceOperationSettings": { + "type": "object", + "description": "Dataflow Source Operation properties", + "properties": { + "endpointRef": { + "type": "string", + "description": "Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type." + }, + "assetRef": { + "type": "string", + "description": "Reference to the resource in Azure Device Registry where the data in the endpoint originates from." + }, + "serializationFormat": { + "type": "string", + "description": "Content is a JSON Schema. Allowed: JSON Schema/draft-7.", + "default": "Json", + "enum": [ + "Json" + ], + "x-ms-enum": { + "name": "SourceSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + } + ] + } + }, + "schemaRef": { + "type": "string", + "description": "Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match." + }, + "dataSources": { + "type": "array", + "description": "List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +.", + "items": { + "$ref": "#/definitions/NonEmptyString" + } + } + }, + "required": [ + "endpointRef", + "dataSources" + ] + }, + "DiagnosticsLogs": { + "type": "object", + "description": "Diagnostic Log properties", + "properties": { + "level": { + "type": "string", + "description": "The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'.", + "default": "info" + } + } + }, + "DiskBackedMessageBuffer": { + "type": "object", + "description": "DiskBackedMessageBuffer properties", + "properties": { + "maxSize": { + "type": "string", + "description": "The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See <https://kubernetes.io/docs/concepts/storage/volumes/#emptydir> for details.", + "pattern": "^[0-9]+[KMGTPE]$" + }, + "ephemeralVolumeClaimSpec": { + "$ref": "#/definitions/VolumeClaimSpec", + "description": "Use the specified persistent volume claim template to mount a \"generic ephemeral volume\" for the message buffer. See <https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes> for details." + }, + "persistentVolumeClaimSpec": { + "$ref": "#/definitions/VolumeClaimSpec", + "description": "Use the specified persistent volume claim template to mount a persistent volume for the message buffer." + } + }, + "required": [ + "maxSize" + ] + }, + "EndpointType": { + "type": "string", + "description": "DataflowEndpoint Type properties", + "enum": [ + "DataExplorer", + "DataLakeStorage", + "FabricOneLake", + "Kafka", + "LocalStorage", + "Mqtt" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true, + "values": [ + { + "name": "DataExplorer", + "value": "DataExplorer", + "description": "Azure Data Explorer Type" + }, + { + "name": "DataLakeStorage", + "value": "DataLakeStorage", + "description": "Azure Data Lake Type" + }, + { + "name": "FabricOneLake", + "value": "FabricOneLake", + "description": "Microsoft Fabric Type" + }, + { + "name": "Kafka", + "value": "Kafka", + "description": "Kafka Type" + }, + { + "name": "LocalStorage", + "value": "LocalStorage", + "description": "Local Storage Type" + }, + { + "name": "Mqtt", + "value": "Mqtt", + "description": "Broker Type" + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "Type of ExtendedLocation." + } + }, + "required": [ + "name", + "type" + ] + }, + "ExtendedLocationType": { + "type": "string", + "description": "The enum defining type of ExtendedLocation accepted.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationType", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "CustomLocation type" + } + ] + } + }, + "FabricOneLakeAuthMethod": { + "$ref": "#/definitions/ManagedIdentityMethod", + "x-nullable": false + }, + "FilterType": { + "type": "string", + "description": "Filter Type properties", + "enum": [ + "Filter" + ], + "x-ms-enum": { + "name": "FilterType", + "modelAsString": true, + "values": [ + { + "name": "Filter", + "value": "Filter", + "description": "Filter type" + } + ] + } + }, + "Frontend": { + "type": "object", + "description": "The desired properties of the frontend instances of the Broker", + "properties": { + "replicas": { + "type": "integer", + "format": "int32", + "description": "The desired number of frontend instances (pods).", + "minimum": 1, + "maximum": 16 + }, + "workers": { + "type": "integer", + "format": "int32", + "description": "Number of logical frontend workers per instance (pod).", + "default": 2, + "minimum": 1, + "maximum": 16 + } + }, + "required": [ + "replicas" + ] + }, + "GenerateResourceLimits": { + "type": "object", + "description": "GenerateResourceLimits properties", + "properties": { + "cpu": { + "type": "string", + "description": "The toggle to enable/disable cpu resource limits.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + } + } + }, + "InstancePatchModel": { + "type": "object", + "description": "The Instance update model.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + } + }, + "InstanceProperties": { + "type": "object", + "description": "The properties of the Instance resource.", + "properties": { + "description": { + "type": "string", + "description": "Detailed description of the Instance." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "version": { + "type": "string", + "description": "The Azure IoT Operations version.", + "readOnly": true + }, + "schemaRegistryRef": { + "$ref": "#/definitions/SchemaRegistryRef", + "description": "The reference to the Schema Registry for this AIO Instance." + } + }, + "required": [ + "schemaRegistryRef" + ] + }, + "InstanceResource": { + "type": "object", + "description": "A Instance resource is a logical container for a set of child resources.", + "properties": { + "properties": { + "$ref": "#/definitions/InstanceProperties", + "description": "The resource-specific properties for this resource." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Edge location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "required": [ + "extendedLocation" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "InstanceResourceListResult": { + "type": "object", + "description": "The response of a InstanceResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The InstanceResource items on this page", + "items": { + "$ref": "#/definitions/InstanceResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "KafkaAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Kafka Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "Sasl", + "X509Certificate", + "Anonymous" + ], + "x-ms-enum": { + "name": "KafkaAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "Sasl", + "value": "Sasl", + "description": "Sasl Option" + }, + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + }, + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "KubernetesReference": { + "type": "object", + "description": "Kubernetes reference", + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + }, + "namespace": { + "type": "string", + "description": "Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace." + } + }, + "required": [ + "kind", + "name" + ] + }, + "ListenerPort": { + "type": "object", + "description": "Defines a TCP port on which a `BrokerListener` listens.", + "properties": { + "authenticationRef": { + "type": "string", + "description": "Reference to client authentication settings. Omit to disable authentication." + }, + "authorizationRef": { + "type": "string", + "description": "Reference to client authorization settings. Omit to disable authorization." + }, + "nodePort": { + "type": "integer", + "format": "int32", + "description": "Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener.", + "minimum": 0, + "maximum": 65535 + }, + "port": { + "type": "integer", + "format": "int32", + "description": "TCP port for accepting client connections.", + "minimum": 0, + "maximum": 65535 + }, + "protocol": { + "type": "string", + "description": "Protocol to use for client connections.", + "default": "Mqtt", + "enum": [ + "Mqtt", + "WebSockets" + ], + "x-ms-enum": { + "name": "BrokerProtocolType", + "modelAsString": true, + "values": [ + { + "name": "Mqtt", + "value": "Mqtt", + "description": "protocol broker" + }, + { + "name": "WebSockets", + "value": "WebSockets", + "description": "protocol websocket" + } + ] + } + }, + "tls": { + "$ref": "#/definitions/TlsCertMethod", + "description": "TLS server certificate settings for this port. Omit to disable TLS." + } + }, + "required": [ + "port" + ] + }, + "LocalKubernetesReference": { + "type": "object", + "description": "Kubernetes reference", + "properties": { + "apiGroup": { + "type": "string", + "description": "APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required." + }, + "kind": { + "type": "string", + "description": "Kind is the type of resource being referenced" + }, + "name": { + "type": "string", + "description": "Name is the name of resource being referenced" + } + }, + "required": [ + "kind", + "name" + ] + }, + "ManagedIdentity": { + "type": "object", + "description": "System and Use Assigned Managed Identity properties", + "properties": { + "systemAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationSystemAssignedManagedIdentity", + "description": "System-assigned managed identity authentication." + }, + "userAssignedManagedIdentitySettings": { + "$ref": "#/definitions/DataflowEndpointAuthenticationUserAssignedManagedIdentity", + "description": "User-assigned managed identity authentication." + } + } + }, + "ManagedIdentityMethod": { + "type": "string", + "description": "Managed Identity Method", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity" + ], + "x-ms-enum": { + "name": "ManagedIdentityMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + } + ] + } + }, + "MetricProperties": { + "type": "object", + "description": "Metric properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + } + } + }, + "Metrics": { + "type": "object", + "description": "Diagnostic Metrics properties", + "properties": { + "prometheusPort": { + "type": "integer", + "format": "int32", + "description": "The prometheus port to expose the metrics.", + "default": 9600, + "minimum": 0, + "maximum": 65535 + } + } + }, + "MqttAuthMethod": { + "type": "string", + "description": "DataflowEndpoint Mqtt Authentication Method properties", + "enum": [ + "SystemAssignedManagedIdentity", + "UserAssignedManagedIdentity", + "ServiceAccountToken", + "X509Certificate", + "Anonymous" + ], + "x-ms-enum": { + "name": "MqttAuthMethod", + "modelAsString": true, + "values": [ + { + "name": "SystemAssignedManagedIdentity", + "value": "SystemAssignedManagedIdentity", + "description": "SystemAssignedManagedIdentity type" + }, + { + "name": "UserAssignedManagedIdentity", + "value": "UserAssignedManagedIdentity", + "description": "UserAssignedManagedIdentity type" + }, + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" + }, + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + }, + { + "name": "Anonymous", + "value": "Anonymous", + "description": "Anonymous Option" + } + ] + } + }, + "MqttRetainType": { + "type": "string", + "description": "Broker Retain types", + "enum": [ + "Keep", + "Never" + ], + "x-ms-enum": { + "name": "MqttRetainType", + "modelAsString": true, + "values": [ + { + "name": "Keep", + "value": "Keep", + "description": "Retain the messages." + }, + { + "name": "Never", + "value": "Never", + "description": "Never retain messages." + } + ] + } + }, + "NonEmptyString": { + "type": "string", + "description": "A string with a minimum length of 1.", + "minLength": 1 + }, + "OperationType": { + "type": "string", + "description": "Dataflow Operation Type properties", + "enum": [ + "Source", + "Destination", + "BuiltInTransformation" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "name": "Source", + "value": "Source", + "description": "Dataflow Source Operation" + }, + { + "name": "Destination", + "value": "Destination", + "description": "Dataflow Destination Operation" + }, + { + "name": "BuiltInTransformation", + "value": "BuiltInTransformation", + "description": "Dataflow BuiltIn Transformation Operation" + } + ] + } + }, + "OperationalMode": { + "type": "string", + "description": "Mode properties", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "OperatorValues": { + "type": "string", + "description": "Valid operators are In, NotIn, Exists and DoesNotExist.", + "enum": [ + "In", + "NotIn", + "Exists", + "DoesNotExist" + ], + "x-ms-enum": { + "name": "OperatorValues", + "modelAsString": true, + "values": [ + { + "name": "In", + "value": "In", + "description": "In operator." + }, + { + "name": "NotIn", + "value": "NotIn", + "description": "NotIn operator." + }, + { + "name": "Exists", + "value": "Exists", + "description": "Exists operator." + }, + { + "name": "DoesNotExist", + "value": "DoesNotExist", + "description": "DoesNotExist operator." + } + ] + } + }, + "PrincipalDefinition": { + "type": "object", + "description": "PrincipalDefinition properties of Rule", + "properties": { + "attributes": { + "type": "array", + "description": "A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.", + "default": [], + "items": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "x-ms-identifiers": [] + }, + "clientIds": { + "type": "array", + "description": "A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.", + "default": [], + "items": { + "type": "string" + } + }, + "usernames": { + "type": "array", + "description": "A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.", + "default": [], + "items": { + "type": "string" + } + } + } + }, + "PrivateKeyAlgorithm": { + "type": "string", + "description": "Private key algorithm types.", + "enum": [ + "Ec256", + "Ec384", + "Ec521", + "Ed25519", + "Rsa2048", + "Rsa4096", + "Rsa8192" + ], + "x-ms-enum": { + "name": "PrivateKeyAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "Ec256", + "value": "Ec256", + "description": "Algorithm - ec256." + }, + { + "name": "Ec384", + "value": "Ec384", + "description": "Algorithm - ec384." + }, + { + "name": "Ec521", + "value": "Ec521", + "description": "Algorithm - ec521." + }, + { + "name": "Ed25519", + "value": "Ed25519", + "description": "Algorithm - ed25519." + }, + { + "name": "Rsa2048", + "value": "Rsa2048", + "description": "Algorithm - rsa2048." + }, + { + "name": "Rsa4096", + "value": "Rsa4096", + "description": "Algorithm - rsa4096." + }, + { + "name": "Rsa8192", + "value": "Rsa8192", + "description": "Algorithm - rsa8192." + } + ] + } + }, + "PrivateKeyRotationPolicy": { + "type": "string", + "description": "Private key rotation policy.", + "enum": [ + "Always", + "Never" + ], + "x-ms-enum": { + "name": "PrivateKeyRotationPolicy", + "modelAsString": true, + "values": [ + { + "name": "Always", + "value": "Always", + "description": "Rotation Policy - Always." + }, + { + "name": "Never", + "value": "Never", + "description": "Rotation Policy - Never." + } + ] + } + }, + "ProfileDiagnostics": { + "type": "object", + "description": "DataflowProfile Diagnostics properties", + "properties": { + "logs": { + "$ref": "#/definitions/DiagnosticsLogs", + "description": "Diagnostic log settings for the resource." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "The metrics settings for the resource." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The enum defining status of 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 Deleting." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Resource has been Accepted." + } + ] + }, + "readOnly": true + }, + "SanForCert": { + "type": "object", + "description": "Subject Alternative Names (SANs) for certificate.", + "properties": { + "dns": { + "type": "array", + "description": "DNS SANs.", + "default": [], + "items": { + "type": "string" + } + }, + "ip": { + "type": "array", + "description": "IP address SANs.", + "default": [], + "items": { + "type": "string" + } + } + }, + "required": [ + "dns", + "ip" + ] + }, + "SaslMethod": { + "type": "string", + "description": "Sasl Method", + "enum": [ + "Sasl" + ], + "x-ms-enum": { + "name": "SaslMethod", + "modelAsString": true, + "values": [ + { + "name": "Sasl", + "value": "Sasl", + "description": "Sasl Option" + } + ] + } + }, + "SchemaRegistryID": { + "type": "string", + "format": "arm-id", + "description": "A type definition that refers the id to an Azure Resource Manager resource.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.DeviceRegistry/schemaRegistries" + } + ] + } + }, + "SchemaRegistryRef": { + "type": "object", + "description": "The reference to the Schema Registry for this AIO Instance.", + "properties": { + "resourceId": { + "$ref": "#/definitions/SchemaRegistryID", + "description": "The resource ID of the Schema Registry." + } + }, + "required": [ + "resourceId" + ] + }, + "SelfCheck": { + "type": "object", + "description": "Broker Diagnostic Self check properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable self check.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "intervalSeconds": { + "type": "integer", + "format": "int32", + "description": "The self check interval.", + "default": 30, + "minimum": 30, + "maximum": 300 + }, + "timeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The timeout for self check.", + "default": 15, + "minimum": 5, + "maximum": 120 + } + } + }, + "SelfTracing": { + "type": "object", + "description": "Diagnostic Self tracing properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable self tracing.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "intervalSeconds": { + "type": "integer", + "format": "int32", + "description": "The self tracing interval.", + "default": 30, + "minimum": 1, + "maximum": 300 + } + } + }, + "ServiceAccountTokenMethod": { + "type": "string", + "description": "Service Account Token Method", + "enum": [ + "ServiceAccountToken" + ], + "x-ms-enum": { + "name": "ServiceAccountTokenMethod", + "modelAsString": true, + "values": [ + { + "name": "ServiceAccountToken", + "value": "ServiceAccountToken", + "description": "ServiceAccountToken Option" + } + ] + } + }, + "ServiceType": { + "type": "string", + "description": "Kubernetes Service Types supported by Listener", + "enum": [ + "ClusterIp", + "LoadBalancer", + "NodePort" + ], + "x-ms-enum": { + "name": "ServiceType", + "modelAsString": true, + "values": [ + { + "name": "ClusterIp", + "value": "ClusterIp", + "description": "Cluster IP Service." + }, + { + "name": "LoadBalancer", + "value": "LoadBalancer", + "description": "Load Balancer Service." + }, + { + "name": "NodePort", + "value": "NodePort", + "description": "Node Port Service." + } + ] + } + }, + "SourceSerializationFormat": { + "type": "string", + "description": "Serialization Format properties", + "enum": [ + "Json" + ], + "x-ms-enum": { + "name": "SourceSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + } + ] + } + }, + "StateStoreResourceDefinitionMethods": { + "type": "string", + "description": "StateStoreResourceDefinitionMethods methods allowed", + "enum": [ + "Read", + "Write", + "ReadWrite" + ], + "x-ms-enum": { + "name": "StateStoreResourceDefinitionMethods", + "modelAsString": true, + "values": [ + { + "name": "Read", + "value": "Read", + "description": "Get/KeyNotify from Store" + }, + { + "name": "Write", + "value": "Write", + "description": "Set/Delete in Store" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "Allowed all operations on Store - Get/KeyNotify/Set/Delete" + } + ] + } + }, + "StateStoreResourceKeyTypes": { + "type": "string", + "description": "StateStoreResourceKeyTypes properties", + "enum": [ + "Pattern", + "String", + "Binary" + ], + "x-ms-enum": { + "name": "StateStoreResourceKeyTypes", + "modelAsString": true, + "values": [ + { + "name": "Pattern", + "value": "Pattern", + "description": "Key type - pattern" + }, + { + "name": "String", + "value": "String", + "description": "Key type - string" + }, + { + "name": "Binary", + "value": "Binary", + "description": "Key type - binary" + } + ] + } + }, + "StateStoreResourceRule": { + "type": "object", + "description": "State Store Resource Rule properties.", + "properties": { + "keyType": { + "$ref": "#/definitions/StateStoreResourceKeyTypes", + "description": "Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys." + }, + "keys": { + "type": "array", + "description": "Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*').", + "items": { + "type": "string" + } + }, + "method": { + "$ref": "#/definitions/StateStoreResourceDefinitionMethods", + "description": "Give access for `Read`, `Write` and `ReadWrite` access level." + } + }, + "required": [ + "keyType", + "keys", + "method" + ] + }, + "SubscriberMessageDropStrategy": { + "type": "string", + "description": "The enum defining strategies for dropping messages from the subscriber queue.", + "enum": [ + "None", + "DropOldest" + ], + "x-ms-enum": { + "name": "SubscriberMessageDropStrategy", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Messages are never dropped." + }, + { + "name": "DropOldest", + "value": "DropOldest", + "description": "The oldest message is dropped." + } + ] + } + }, + "SubscriberQueueLimit": { + "type": "object", + "description": "The settings of Subscriber Queue Limit.", + "properties": { + "length": { + "type": "integer", + "format": "int64", + "description": "The maximum length of the queue before messages start getting dropped.", + "minimum": 1 + }, + "strategy": { + "type": "string", + "description": "The strategy to use for dropping messages from the queue.", + "default": "None", + "enum": [ + "None", + "DropOldest" + ], + "x-ms-enum": { + "name": "SubscriberMessageDropStrategy", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Messages are never dropped." + }, + { + "name": "DropOldest", + "value": "DropOldest", + "description": "The oldest message is dropped." + } + ] + } + } + } + }, + "TlsCertMethod": { + "type": "object", + "description": "Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported", + "properties": { + "mode": { + "$ref": "#/definitions/TlsCertMethodMode", + "description": "Mode of TLS server certificate management." + }, + "certManagerCertificateSpec": { + "$ref": "#/definitions/CertManagerCertificateSpec", + "description": "Option 1 - Automatic TLS server certificate management with cert-manager." + }, + "manual": { + "$ref": "#/definitions/X509ManualCertificate", + "description": "Option 2 - Manual TLS server certificate management through a defined secret." + } + }, + "required": [ + "mode" + ] + }, + "TlsCertMethodMode": { + "type": "string", + "description": "Broker Authentication Mode", + "enum": [ + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "TlsCertMethodMode", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "Automatic", + "description": "Automatic TLS server certificate configuration." + }, + { + "name": "Manual", + "value": "Manual", + "description": "Manual TLS server certificate configuration." + } + ] + } + }, + "TlsProperties": { + "type": "object", + "description": "Tls properties", + "properties": { + "mode": { + "type": "string", + "description": "Mode for TLS.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "trustedCaCertificateConfigMapRef": { + "type": "string", + "description": "Trusted CA certificate config map." + } + } + }, + "Traces": { + "type": "object", + "description": "Broker Diagnostic Trace properties", + "properties": { + "mode": { + "type": "string", + "description": "The toggle to enable/disable traces.", + "default": "Enabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "OperationalMode", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Enabled is equivalent to True" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Disabled is equivalent to False." + } + ] + } + }, + "cacheSizeMegabytes": { + "type": "integer", + "format": "int32", + "description": "The cache size in megabytes.", + "default": 16, + "minimum": 1, + "maximum": 128 + }, + "selfTracing": { + "$ref": "#/definitions/SelfTracing", + "description": "The self tracing properties." + }, + "spanChannelCapacity": { + "type": "integer", + "format": "int32", + "description": "The span channel capacity.", + "default": 1000, + "minimum": 1000, + "maximum": 100000 + } + } + }, + "TransformationSerializationFormat": { + "type": "string", + "description": "Transformation Format properties", + "enum": [ + "Delta", + "Json", + "Parquet" + ], + "x-ms-enum": { + "name": "TransformationSerializationFormat", + "modelAsString": true, + "values": [ + { + "name": "Delta", + "value": "Delta", + "description": "Delta Format" + }, + { + "name": "Json", + "value": "Json", + "description": "JSON Format" + }, + { + "name": "Parquet", + "value": "Parquet", + "description": "Parquet Format" + } + ] + } + }, + "VolumeClaimResourceRequirements": { + "type": "object", + "description": "VolumeClaimResourceRequirements properties", + "properties": { + "limits": { + "type": "object", + "description": "Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "additionalProperties": { + "type": "string" + } + }, + "requests": { + "type": "object", + "description": "Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeClaimSpec": { + "type": "object", + "description": "VolumeClaimSpec properties", + "properties": { + "volumeName": { + "type": "string", + "description": "VolumeName is the binding reference to the PersistentVolume backing this claim." + }, + "volumeMode": { + "type": "string", + "description": "volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature." + }, + "storageClassName": { + "type": "string", + "description": "Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + }, + "accessModes": { + "type": "array", + "description": "AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dataSource": { + "$ref": "#/definitions/LocalKubernetesReference", + "description": "This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field." + }, + "dataSourceRef": { + "$ref": "#/definitions/KubernetesReference", + "description": "Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled." + }, + "resources": { + "$ref": "#/definitions/VolumeClaimResourceRequirements", + "description": "Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + }, + "selector": { + "$ref": "#/definitions/VolumeClaimSpecSelector", + "description": "A label query over volumes to consider for binding." + } + } + }, + "VolumeClaimSpecSelector": { + "type": "object", + "description": "VolumeClaimSpecSelector properties", + "properties": { + "matchExpressions": { + "type": "array", + "description": "MatchExpressions is a list of label selector requirements. The requirements are ANDed.", + "items": { + "$ref": "#/definitions/VolumeClaimSpecSelectorMatchExpressions" + }, + "x-ms-identifiers": [] + }, + "matchLabels": { + "type": "object", + "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VolumeClaimSpecSelectorMatchExpressions": { + "type": "object", + "description": "VolumeClaimSpecSelectorMatchExpressions properties", + "properties": { + "key": { + "type": "string", + "description": "key is the label key that the selector applies to." + }, + "operator": { + "$ref": "#/definitions/OperatorValues", + "description": "operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist." + }, + "values": { + "type": "array", + "description": "values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "operator" + ] + }, + "X509ManualCertificate": { + "type": "object", + "description": "X509 Certificate Authentication properties.", + "properties": { + "secretRef": { + "type": "string", + "description": "Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself." + } + }, + "required": [ + "secretRef" + ] + }, + "x509CertificateMethod": { + "type": "string", + "description": "x509 Certificate Method", + "enum": [ + "X509Certificate" + ], + "x-ms-enum": { + "name": "x509CertificateMethod", + "modelAsString": true, + "values": [ + { + "name": "X509Certificate", + "value": "X509Certificate", + "description": "x509Certificate Option" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/iotoperations/resource-manager/readme.md b/specification/iotoperations/resource-manager/readme.md index 6335d57f3037..6deadd255fd2 100644 --- a/specification/iotoperations/resource-manager/readme.md +++ b/specification/iotoperations/resource-manager/readme.md @@ -59,7 +59,7 @@ These are the global settings for the IoTOperations. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-08-15-preview +tag: package-2024-09-15-preview ``` ### Tag: package-2024-07-01-preview @@ -78,4 +78,13 @@ These settings apply only when `--tag=package-2024-08-15-preview` is specified o ```yaml $(tag) == 'package-2024-08-15-preview' input-file: - Microsoft.IoTOperations/preview/2024-08-15-preview/iotoperations.json +``` + +### Tag: package-2024-09-15-preview + +These settings apply only when `--tag=package-2024-09-15-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-15-preview' +input-file: + - Microsoft.IoTOperations/preview/2024-09-15-preview/iotoperations.json ``` \ No newline at end of file From 1150213d71602e9a8482a4bbc785eaa6694f3fe9 Mon Sep 17 00:00:00 2001 From: Ben Broderick Phillips <bebroder@microsoft.com> Date: Thu, 3 Oct 2024 17:06:48 -0400 Subject: [PATCH 038/101] Remove out of date codeowners (#30848) --- .github/CODEOWNERS | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 93f36b82c2c7..f3c6ce1ab338 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -111,7 +111,7 @@ /specification/deviceregistry/ @marcodalessandro @rohankhandelwal @riteshrao # PRLabel: %Device Update -/specification/deviceupdate/data-plane/ @mikekistler @Azure/api-stewardship-board +/specification/deviceupdate/data-plane/ @Azure/api-stewardship-board /specification/documentdb/ @dmakwana @@ -142,7 +142,7 @@ /specification/keyvault/ @heaths @randallilama @jlichwa # PRLabel: %Load Test Service -/specification/loadtestservice/data-plane/ @mikekistler @Azure/api-stewardship-board +/specification/loadtestservice/data-plane/ @Azure/api-stewardship-board # PRLabel: %Logic App /specification/logic/ @pankajsn @tonytang-microsoft-com @@ -182,7 +182,7 @@ /specification/powerbidedicated/ @tarostok # PRLabel: %Purview -/specification/purview/data-plane @mikekistler @Azure/api-stewardship-board +/specification/purview/data-plane @Azure/api-stewardship-board # PRLabel: %PostgreSQL /specification/postgresql/** @Azure/azure-sdk-write-postgresql @@ -288,4 +288,4 @@ /.github/ @weshaggard @mikeharder @benbp /eng/ @weshaggard @mikeharder @benbp /scripts/ @weshaggard @mikeharder -/.github/CODEOWNERS @Azure/azure-sdk-eng \ No newline at end of file +/.github/CODEOWNERS @Azure/azure-sdk-eng From 51cdc876974de35d1815df071fb77537d159505c Mon Sep 17 00:00:00 2001 From: nasc17 <69922333+nasc17@users.noreply.github.com> Date: Thu, 3 Oct 2024 17:19:56 -0400 Subject: [PATCH 039/101] Review request for Microsoft.DBforPostgreSQL to add stable release of version 2024-08-01 (#30737) * 20240801 copied from previous 20240301preview * Update api version within files * Update readme * Quota Usages not for GA * Update description of configuraiton properties * Update title to PostgreSQLServerManagementClient and add to suppression path * remove where clause in readme suppresions --- .../stable/2024-08-01/Administrators.json | 406 ++++ .../stable/2024-08-01/Backups.json | 315 +++ .../stable/2024-08-01/Capabilities.json | 587 +++++ .../2024-08-01/CheckNameAvailability.json | 155 ++ .../stable/2024-08-01/Configuration.json | 395 +++ .../stable/2024-08-01/Databases.json | 317 +++ .../stable/2024-08-01/FirewallRules.json | 323 +++ .../stable/2024-08-01/FlexibleServers.json | 1211 +++++++++ .../LongTermRetentionOperation.json | 524 ++++ .../stable/2024-08-01/Migrations.json | 1296 ++++++++++ .../stable/2024-08-01/Operations.json | 164 ++ .../stable/2024-08-01/PrivateDnsZone.json | 77 + .../PrivateEndpointConnections.json | 270 +++ .../2024-08-01/PrivateLinkResources.json | 155 ++ .../stable/2024-08-01/Replicas.json | 83 + .../stable/2024-08-01/ServerLogs.json | 148 ++ .../2024-08-01/ServerStartStopRestart.json | 229 ++ .../stable/2024-08-01/ThreatProtection.json | 280 +++ .../stable/2024-08-01/VirtualEndpoints.json | 403 +++ .../stable/2024-08-01/VirtualNetwork.json | 142 ++ .../2024-08-01/examples/AdministratorAdd.json | 43 + .../examples/AdministratorDelete.json | 19 + .../2024-08-01/examples/AdministratorGet.json | 24 + .../examples/AdministratorsListByServer.json | 36 + .../2024-08-01/examples/BackupCreate.json | 36 + .../2024-08-01/examples/BackupDelete.json | 18 + .../stable/2024-08-01/examples/BackupGet.json | 23 + .../examples/BackupListByServer.json | 126 + .../examples/CapabilitiesByLocation.json | 2153 ++++++++++++++++ .../CheckMigrationNameAvailability.json | 23 + .../examples/CheckNameAvailability.json | 20 + .../CheckNameAvailabilityLocationBased.json | 21 + .../2024-08-01/examples/ConfigurationGet.json | 26 + .../examples/ConfigurationListByServer.json | 1902 +++++++++++++++ .../examples/ConfigurationUpdate.json | 53 + .../2024-08-01/examples/DatabaseCreate.json | 45 + .../2024-08-01/examples/DatabaseDelete.json | 19 + .../2024-08-01/examples/DatabaseGet.json | 22 + .../examples/DatabasesListByServer.json | 34 + .../examples/FirewallRuleCreate.json | 45 + .../examples/FirewallRuleDelete.json | 19 + .../2024-08-01/examples/FirewallRuleGet.json | 22 + .../examples/FirewallRuleListByServer.json | 35 + .../examples/GetPrivateDnsZoneSuffix.json | 11 + .../examples/LogFilesListByServer.json | 28 + .../examples/LongTermRetentionBackup.json | 39 + .../LongTermRetentionOperationGet.json | 28 + ...ongTermRetentionOperationListByServer.json | 31 + .../examples/LongTermRetentionPreBackup.json | 22 + .../examples/Migrations_Cancel.json | 59 + .../examples/Migrations_Create.json | 104 + ...te_Other_SourceTypes_Validate_Migrate.json | 107 + .../Migrations_Create_Validate_Only.json | 100 + .../Migrations_Create_With_Other_Users.json | 101 + ...s_Create_With_PrivateEndpoint_Servers.json | 104 + .../Migrations_Create_With_Roles.json | 102 + .../examples/Migrations_Delete.json | 14 + .../2024-08-01/examples/Migrations_Get.json | 62 + ...nWithSuccessfulValidationAndMigration.json | 100 + ...ccessfulValidationButMigrationFailure.json | 98 + ...MigrationWithSuccessfulValidationOnly.json | 82 + ...ns_GetMigrationWithValidationFailures.json | 198 ++ .../Migrations_ListByTargetServer.json | 65 + .../examples/Migrations_Update.json | 67 + .../2024-08-01/examples/OperationList.json | 176 ++ .../PrivateEndpointConnectionDelete.json | 18 + .../PrivateEndpointConnectionGet.json | 32 + .../PrivateEndpointConnectionList.json | 54 + .../PrivateEndpointConnectionUpdate.json | 67 + .../examples/PrivateLinkResourcesGet.json | 27 + .../examples/PrivateLinkResourcesList.json | 30 + ...romoteReplicaAsForcedStandaloneServer.json | 85 + .../PromoteReplicaAsForcedSwitchover.json | 85 + ...omoteReplicaAsPlannedStandaloneServer.json | 85 + .../PromoteReplicaAsPlannedSwitchover.json | 85 + .../examples/ReplicasListByServer.json | 75 + .../examples/ServerCapabilities.json | 2154 +++++++++++++++++ .../2024-08-01/examples/ServerCreate.json | 158 ++ ...teGeoRestoreWithDataEncryptionEnabled.json | 179 ++ .../ServerCreatePointInTimeRestore.json | 127 + .../examples/ServerCreateReplica.json | 180 ++ .../examples/ServerCreateReviveDropped.json | 125 + .../ServerCreateWithAadAuthEnabled.json | 165 ++ ...ServerCreateWithDataEncryptionEnabled.json | 194 ++ .../2024-08-01/examples/ServerDelete.json | 18 + .../stable/2024-08-01/examples/ServerGet.json | 61 + .../ServerGetWithPrivateEndpoints.json | 82 + .../examples/ServerGetWithVnet.json | 64 + .../2024-08-01/examples/ServerList.json | 102 + .../examples/ServerListByResourceGroup.json | 105 + .../2024-08-01/examples/ServerRestart.json | 17 + .../examples/ServerRestartWithFailover.json | 21 + .../2024-08-01/examples/ServerStart.json | 17 + .../2024-08-01/examples/ServerStop.json | 17 + ...hreatProtectionSettingsCreateOrUpdate.json | 39 + .../ServerThreatProtectionSettingsGet.json | 22 + ...rThreatProtectionSettingsListByServer.json | 25 + .../2024-08-01/examples/ServerUpdate.json | 91 + .../ServerUpdateWithAadAuthEnabled.json | 97 + ...erUpdateWithCustomerMaintenanceWindow.json | 84 + ...ServerUpdateWithDataEncryptionEnabled.json | 123 + .../ServerUpdateWithMajorVersionUpgrade.json | 79 + .../examples/VirtualEndpointCreate.json | 63 + .../examples/VirtualEndpointDelete.json | 22 + .../examples/VirtualEndpointUpdate.json | 46 + .../examples/VirtualEndpointsGet.json | 28 + .../VirtualEndpointsListByServer.json | 31 + .../examples/VirtualNetworkSubnetUsage.json | 28 + .../postgresql/resource-manager/readme.md | 58 +- 109 files changed, 19204 insertions(+), 3 deletions(-) create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json new file mode 100644 index 000000000000..1b558e897af8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators/{objectId}": { + "put": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Create", + "x-ms-examples": { + "Adds an Active DIrectory Administrator for the server": { + "$ref": "./examples/AdministratorAdd.json" + } + }, + "description": "Creates a new server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministratorAdd" + }, + "description": "The required parameters for adding an active directory administrator for a server." + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Delete", + "x-ms-examples": { + "AdministratorDelete": { + "$ref": "./examples/AdministratorDelete.json" + } + }, + "description": "Deletes an Active Directory Administrator associated with the server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/AdministratorGet.json" + } + }, + "description": "Gets information about a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ObjectIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/administrators": { + "get": { + "tags": [ + "Administrators" + ], + "operationId": "Administrators_ListByServer", + "x-ms-examples": { + "AdministratorsListByServer": { + "$ref": "./examples/AdministratorsListByServer.json" + } + }, + "description": "List all the AAD administrators for a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AdministratorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ActiveDirectoryAdministratorAdd": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdministratorPropertiesForAdd", + "x-ms-client-flatten": true, + "description": "Properties of the active directory administrator." + } + }, + "description": "Represents an Active Directory administrator." + }, + "AdministratorPropertiesForAdd": { + "type": "object", + "properties": { + "principalType": { + "type": "string", + "description": "The principal type used to represent the type of Active Directory Administrator.", + "enum": [ + "Unknown", + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "principalName": { + "type": "string", + "description": "Active Directory administrator principal name.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "tenantId": { + "type": "string", + "description": "The tenantId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update" + ] + } + }, + "description": "The properties of an Active Directory administrator." + }, + "AdministratorProperties": { + "type": "object", + "properties": { + "principalType": { + "type": "string", + "description": "The principal type used to represent the type of Active Directory Administrator.", + "enum": [ + "Unknown", + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "principalName": { + "type": "string", + "description": "Active Directory administrator principal name.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "objectId": { + "type": "string", + "description": "The objectId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + }, + "tenantId": { + "type": "string", + "description": "The tenantId of the Active Directory administrator.", + "x-ms-mutability": [ + "create", + "update", + "read" + ] + } + }, + "description": "The properties of an Active Directory administrator." + }, + "ActiveDirectoryAdministrator": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AdministratorProperties", + "x-ms-client-flatten": true, + "description": "Properties of the active directory administrator." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents an Active Directory administrator." + }, + "AdministratorListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActiveDirectoryAdministrator" + }, + "description": "The list of active directory administrators" + }, + "nextLink": { + "description": "The link used to get the next page of active directory.", + "type": "string" + } + }, + "description": "A list of active directory administrators." + } + }, + "parameters": { + "ObjectIdParameter": { + "name": "objectId", + "in": "path", + "required": true, + "type": "string", + "description": "Guid of the objectId for the administrator.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json new file mode 100644 index 000000000000..177e1d45d15d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups/{backupName}": { + "put": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Create", + "x-ms-examples": { + "Create a new Backup for a flexible server": { + "$ref": "./examples/BackupCreate.json" + } + }, + "description": "Create a specific backup for PostgreSQL flexible server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "201": { + "description": "Successfully created backup", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Delete", + "x-ms-examples": { + "Delete a specific backup": { + "$ref": "./examples/BackupDelete.json" + } + }, + "description": "Deletes a specific backup.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "x-ms-examples": { + "Get a backup for a server": { + "$ref": "./examples/BackupGet.json" + } + }, + "description": "Get specific backup for a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "operationId": "Backups_ListByServer", + "x-ms-examples": { + "List backups for a server": { + "$ref": "./examples/BackupListByServer.json" + } + }, + "description": "List all the backups for a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerBackupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerBackupProperties": { + "type": "object", + "properties": { + "backupType": { + "type": "string", + "description": "Backup type.", + "enum": [ + "Full", + "Customer On-Demand" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + } + }, + "completedTime": { + "type": "string", + "format": "date-time", + "description": "Backup completed time (ISO8601 format)." + }, + "source": { + "type": "string", + "description": "Backup source" + } + }, + "description": "The properties of a server backup." + }, + "ServerBackup": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ServerBackupProperties", + "x-ms-client-flatten": true, + "description": "The properties of a server backup." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Server backup properties" + }, + "ServerBackupListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerBackup" + }, + "description": "The list of backups of a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server backups." + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json new file mode 100644 index 000000000000..a41aac1fc41e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json @@ -0,0 +1,587 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/capabilities": { + "get": { + "tags": [ + "LocationBasedCapabilities" + ], + "operationId": "LocationBasedCapabilities_Execute", + "x-ms-examples": { + "CapabilitiesList": { + "$ref": "./examples/CapabilitiesByLocation.json" + } + }, + "description": "Get capabilities at specified location in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/capabilities": { + "get": { + "tags": [ + "FlexibleServerCapabilities" + ], + "operationId": "ServerCapabilities_List", + "x-ms-examples": { + "ServerCapabilitiesList": { + "$ref": "./examples/ServerCapabilities.json" + } + }, + "description": "Get capabilities for a flexible server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "StorageTierCapability": { + "type": "object", + "description": "Represents capability of a storage tier", + "properties": { + "name": { + "type": "string", + "description": "Name to represent Storage tier capability", + "readOnly": true + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS for this storage tier", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ] + }, + "StorageMbCapability": { + "type": "object", + "properties": { + "supportedIops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS", + "readOnly": true + }, + "supportedMaximumIops": { + "type": "integer", + "format": "int32", + "description": "Maximum IOPS supported by this #Vcores or PremiumV2_LRS Storage Size", + "readOnly": true + }, + "storageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Storage size in MB", + "readOnly": true + }, + "maximumStorageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Maximum value of Storage size in MB", + "readOnly": true + }, + "supportedThroughput": { + "type": "integer", + "format": "int32", + "description": "Values of throughput in MB/s", + "readOnly": true + }, + "supportedMaximumThroughput": { + "type": "integer", + "format": "int32", + "description": "Maximum values of throughput in MB/s", + "readOnly": true + }, + "defaultIopsTier": { + "type": "string", + "description": "Default tier for IOPS", + "readOnly": true + }, + "supportedIopsTiers": { + "type": "array", + "description": "List of available options to upgrade the storage performance", + "items": { + "$ref": "#/definitions/StorageTierCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "storage size in MB capability" + }, + "ServerSkuCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Sku name", + "readOnly": true + }, + "vCores": { + "type": "integer", + "format": "int32", + "description": "Supported vCores", + "readOnly": true + }, + "supportedIops": { + "type": "integer", + "format": "int32", + "description": "Supported IOPS", + "readOnly": true + }, + "supportedMemoryPerVcoreMb": { + "type": "integer", + "format": "int64", + "description": "Supported memory per vCore in MB", + "readOnly": true + }, + "supportedZones": { + "type": "array", + "description": "List of supported Availability Zones. E.g. \"1\", \"2\", \"3\"", + "items": { + "type": "string" + }, + "readOnly": true + }, + "supportedHaMode": { + "type": "array", + "items": { + "type": "string", + "description": "HA mode supported for a server.", + "enum": [ + "SameZone", + "ZoneRedundant" + ], + "x-ms-enum": { + "name": "HaMode", + "modelAsString": true + } + }, + "description": "Supported high availability mode", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Sku capability" + }, + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "16", + "15", + "14", + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "ServerVersionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Server version", + "readOnly": true + }, + "supportedVersionsToUpgrade": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Supported servers versions to upgrade", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Server version capabilities." + }, + "StorageEditionCapability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Storage edition name", + "readOnly": true + }, + "defaultStorageSizeMb": { + "type": "integer", + "format": "int64", + "description": "Default storage size in MB for storage edition", + "readOnly": true + }, + "supportedStorageMb": { + "type": "array", + "description": "Flexible server supported storage range in MB", + "items": { + "$ref": "#/definitions/StorageMbCapability" + }, + "x-ms-identifiers": [ + "storageSizeMb" + ], + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "description": "Storage edition capability" + }, + "FastProvisioningEditionCapability": { + "type": "object", + "description": "Represents capability of a fast provisioning edition", + "properties": { + "supportedTier": { + "type": "string", + "description": "Fast provisioning supported tier name", + "readOnly": true + }, + "supportedSku": { + "type": "string", + "description": "Fast provisioning supported sku name", + "readOnly": true + }, + "supportedStorageGb": { + "type": "integer", + "format": "int32", + "description": "Fast provisioning supported storage in Gb", + "readOnly": true + }, + "supportedServerVersions": { + "type": "string", + "description": "Fast provisioning supported version", + "readOnly": true + }, + "serverCount": { + "type": "integer", + "description": "Count of servers in cache matching the spec", + "format": "int32", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ] + }, + "FlexibleServerEditionCapability": { + "type": "object", + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Server edition name", + "readOnly": true + }, + "defaultSkuName": { + "type": "string", + "description": "Default sku name for the server edition", + "readOnly": true + }, + "supportedStorageEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageEditionCapability" + }, + "description": "The list of editions supported by this server edition.", + "readOnly": true, + "x-ms-identifiers": [ + "name" + ] + }, + "supportedServerSkus": { + "type": "array", + "description": "List of supported server SKUs.", + "items": { + "$ref": "#/definitions/ServerSkuCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + } + }, + "description": "Flexible server edition capabilities." + }, + "FlexibleServerCapability": { + "type": "object", + "allOf": [ + { + "$ref": "../../../types/common-types.json#/definitions/CapabilityBase" + } + ], + "properties": { + "name": { + "type": "string", + "description": "Name of flexible servers capability" + }, + "supportedServerEditions": { + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerEditionCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true, + "description": "List of supported flexible server editions" + }, + "supportedServerVersions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServerVersionCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of server versions supported for this capability.", + "readOnly": true + }, + "fastProvisioningSupported": { + "type": "string", + "description": "Gets a value indicating whether fast provisioning is supported. \"Enabled\" means fast provisioning is supported. \"Disabled\" stands for fast provisioning is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fastProvisioningSupportedEnum", + "modelAsString": true + } + }, + "supportedFastProvisioningEditions": { + "type": "array", + "description": "List of supported server editions for fast provisioning", + "items": { + "$ref": "#/definitions/FastProvisioningEditionCapability" + }, + "x-ms-identifiers": [ + "supportedSku" + ], + "readOnly": true + }, + "geoBackupSupported": { + "type": "string", + "description": "Determines if geo-backup is supported in this region. \"Enabled\" means geo-backup is supported. \"Disabled\" stands for geo-back is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "geoBackupSupportedEnum", + "modelAsString": true + } + }, + "zoneRedundantHaSupported": { + "type": "string", + "description": "A value indicating whether Zone Redundant HA is supported in this region. \"Enabled\" means zone redundant HA is supported. \"Disabled\" stands for zone redundant HA is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "zoneRedundantHaSupportedEnum", + "modelAsString": true + } + }, + "zoneRedundantHaAndGeoBackupSupported": { + "type": "string", + "description": "A value indicating whether Zone Redundant HA and Geo-backup is supported in this region. \"Enabled\" means zone redundant HA and geo-backup is supported. \"Disabled\" stands for zone redundant HA and geo-backup is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "zoneRedundantHaAndGeoBackupSupportedEnum", + "modelAsString": true + } + }, + "storageAutoGrowthSupported": { + "type": "string", + "description": "A value indicating whether storage auto-grow is supported in this region. \"Enabled\" means storage auto-grow is supported. \"Disabled\" stands for storage auto-grow is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "storageAutoGrowthSupportedEnum", + "modelAsString": true + } + }, + "onlineResizeSupported": { + "type": "string", + "description": "A value indicating whether online resize is supported in this region for the given subscription. \"Enabled\" means storage online resize is supported. \"Disabled\" means storage online resize is not supported.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "onlineResizeSupportedEnum", + "modelAsString": true + } + }, + "restricted": { + "type": "string", + "description": "A value indicating whether this region is restricted. \"Enabled\" means region is restricted. \"Disabled\" stands for region is not restricted.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "restrictedEnum", + "modelAsString": true + } + } + }, + "description": "Capability for the PostgreSQL server" + }, + "CapabilitiesListResult": { + "type": "object", + "properties": { + "value": { + "description": "A list of supported capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/FlexibleServerCapability" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + }, + "description": "Capability for the PostgreSQL server" + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json new file mode 100644 index 000000000000..b8d61cc81504 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json @@ -0,0 +1,155 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailabilityWithLocation_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailabilityLocationBased.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NameAvailability": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "name of the PostgreSQL server.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the server", + "readOnly": true + } + }, + "description": "Represents a resource name availability.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/CheckNameAvailabilityResponse" + } + ] + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json new file mode 100644 index 000000000000..97116aad59f7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json @@ -0,0 +1,395 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_ListByServer", + "x-ms-examples": { + "ConfigurationList": { + "$ref": "./examples/ConfigurationListByServer.json" + } + }, + "description": "List all the configurations in a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/configurations/{configurationName}": { + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "x-ms-examples": { + "ConfigurationGet": { + "$ref": "./examples/ConfigurationGet.json" + } + }, + "description": "Gets information about a configuration of server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationForUpdate" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "put": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Put", + "x-ms-examples": { + "Update a user configuration": { + "$ref": "./examples/ConfigurationUpdate.json" + } + }, + "description": "Updates a configuration of a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Configuration" + }, + "description": "The required parameters for updating a server configuration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Configuration" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ConfigurationProperties": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Value of the configuration. Required to update the configuration." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the configuration." + }, + "defaultValue": { + "type": "string", + "readOnly": true, + "description": "Default value of the configuration." + }, + "dataType": { + "type": "string", + "readOnly": true, + "description": "Data type of the configuration.", + "enum": [ + "Boolean", + "Numeric", + "Integer", + "Enumeration" + ], + "x-ms-enum": { + "name": "ConfigurationDataType", + "modelAsString": true + } + }, + "allowedValues": { + "type": "string", + "readOnly": true, + "description": "Allowed values of the configuration." + }, + "source": { + "type": "string", + "description": "Source of the configuration. Required to update the configuration." + }, + "isDynamicConfig": { + "type": "boolean", + "readOnly": true, + "description": "Configuration dynamic or static." + }, + "isReadOnly": { + "type": "boolean", + "readOnly": true, + "description": "Configuration read-only or not." + }, + "isConfigPendingRestart": { + "type": "boolean", + "readOnly": true, + "description": "Configuration is pending restart or not." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Configuration unit." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "Configuration documentation link." + } + }, + "description": "The properties of a configuration." + }, + "Configuration": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Configuration." + }, + "ConfigurationForUpdate": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationProperties", + "x-ms-client-flatten": true, + "description": "The properties of a configuration." + } + }, + "description": "Represents a Configuration." + }, + "ConfigurationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Configuration" + }, + "description": "The list of server configurations." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of server configurations." + } + }, + "parameters": { + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server configuration.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json new file mode 100644 index 000000000000..c95fce456bae --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json @@ -0,0 +1,317 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases/{databaseName}": { + "put": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Create", + "x-ms-examples": { + "Create a database": { + "$ref": "./examples/DatabaseCreate.json" + } + }, + "description": "Creates a new database or updates an existing database.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The required parameters for creating or updating a database." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Delete", + "x-ms-examples": { + "Delete a database": { + "$ref": "./examples/DatabaseDelete.json" + } + }, + "description": "Deletes a database.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_Get", + "x-ms-examples": { + "Get a database": { + "$ref": "./examples/DatabaseGet.json" + } + }, + "description": "Gets information about a database.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "operationId": "Databases_ListByServer", + "x-ms-examples": { + "List databases in a server": { + "$ref": "./examples/DatabasesListByServer.json" + } + }, + "description": "List all the databases in a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DatabaseProperties": { + "type": "object", + "properties": { + "charset": { + "type": "string", + "description": "The charset of the database.", + "pattern": "^[a-zA-Z]+\\w*$" + }, + "collation": { + "type": "string", + "description": "The collation of the database.", + "pattern": "^[a-zA-Z\\-]+([. ]|\\w)*$" + } + }, + "description": "The properties of a database." + }, + "Database": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseProperties", + "x-ms-client-flatten": true, + "description": "The properties of a database." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a Database." + }, + "DatabaseListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of databases housed in a server" + }, + "nextLink": { + "description": "The link used to get the next page of databases.", + "type": "string", + "format": "uri" + } + }, + "description": "A List of databases." + } + }, + "parameters": { + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the database.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json new file mode 100644 index 000000000000..0717265eca1c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules/{firewallRuleName}": { + "put": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "x-ms-examples": { + "FirewallRuleCreate": { + "$ref": "./examples/FirewallRuleCreate.json" + } + }, + "description": "Creates a new firewall rule or updates an existing firewall rule.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The required parameters for creating or updating a firewall rule." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "x-ms-examples": { + "FirewallRuleDelete": { + "$ref": "./examples/FirewallRuleDelete.json" + } + }, + "description": "Deletes a PostgreSQL server firewall rule.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleGet.json" + } + }, + "description": "List all the firewall rules in a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/FirewallRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/firewallRules": { + "get": { + "tags": [ + "FirewallRules" + ], + "operationId": "FirewallRules_ListByServer", + "x-ms-examples": { + "FirewallRuleList": { + "$ref": "./examples/FirewallRuleListByServer.json" + } + }, + "description": "List all the firewall rules in a given PostgreSQL server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "FirewallRuleProperties": { + "type": "object", + "properties": { + "startIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The start IP address of the server firewall rule. Must be IPv4 format." + }, + "endIpAddress": { + "type": "string", + "pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$", + "description": "The end IP address of the server firewall rule. Must be IPv4 format." + } + }, + "required": [ + "startIpAddress", + "endIpAddress" + ], + "description": "The properties of a server firewall rule." + }, + "FirewallRule": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FirewallRuleProperties", + "x-ms-client-flatten": true, + "description": "The properties of a firewall rule." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "required": [ + "properties" + ], + "description": "Represents a server firewall rule." + }, + "FirewallRuleListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallRule" + }, + "description": "The list of firewall rules in a server." + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of firewall rules." + } + }, + "parameters": { + "FirewallRuleNameParameter": { + "name": "firewallRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server firewall rule.", + "minLength": 1, + "pattern": "^[-\\w\\._]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json new file mode 100644 index 000000000000..6248c0441bd2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json @@ -0,0 +1,1211 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}": { + "put": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Create", + "x-ms-examples": { + "Create a new server": { + "$ref": "./examples/ServerCreate.json" + }, + "Create a new server with active directory authentication enabled": { + "$ref": "./examples/ServerCreateWithAadAuthEnabled.json" + }, + "ServerCreateWithDataEncryptionEnabled": { + "$ref": "./examples/ServerCreateWithDataEncryptionEnabled.json" + }, + "Create a database as a point in time restore": { + "$ref": "./examples/ServerCreatePointInTimeRestore.json" + }, + "Create a database as a geo-restore in geo-paired location": { + "$ref": "./examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json" + }, + "ServerCreateReplica": { + "$ref": "./examples/ServerCreateReplica.json" + }, + "ServerCreateReviveDropped": { + "$ref": "./examples/ServerCreateReviveDropped.json" + } + }, + "description": "Creates a new server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Server" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.json" + }, + "ServerUpdateWithAadAuthEnabled": { + "$ref": "./examples/ServerUpdateWithAadAuthEnabled.json" + }, + "ServerUpdateWithDataEncryptionEnabled": { + "$ref": "./examples/ServerUpdateWithDataEncryptionEnabled.json" + }, + "ServerUpdateWithCustomerMaintenanceWindow": { + "$ref": "./examples/ServerUpdateWithCustomerMaintenanceWindow.json" + }, + "ServerUpdateWithMajorVersionUpgrade": { + "$ref": "./examples/ServerUpdateWithMajorVersionUpgrade.json" + }, + "Promote a replica server as a Standalone server as planned, i.e. it will wait for replication to complete.": { + "$ref": "./examples/PromoteReplicaAsPlannedStandaloneServer.json" + }, + "Promote a replica server as a Standalone server as forced, i.e. it will promote a replica server immediately without waiting for primary and replica to be in sync.": { + "$ref": "./examples/PromoteReplicaAsForcedStandaloneServer.json" + }, + "SwitchOver a replica server as planned, i.e. it will wait for replication to complete before promoting replica as Primary and original primary as replica.": { + "$ref": "./examples/PromoteReplicaAsPlannedSwitchover.json" + }, + "SwitchOver a replica server as forced, i.e. it will replica as Primary and original primary as replica immediately without waiting for primary and replica to be in sync.": { + "$ref": "./examples/PromoteReplicaAsForcedSwitchover.json" + } + }, + "description": "Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServerForUpdate" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Delete", + "x-ms-examples": { + "ServerDelete": { + "$ref": "./examples/ServerDelete.json" + } + }, + "description": "Deletes a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_Get", + "x-ms-examples": { + "ServerGet": { + "$ref": "./examples/ServerGet.json" + }, + "ServerGetWithVnet": { + "$ref": "./examples/ServerGetWithVnet.json" + }, + "ServerGetWithPrivateEndpoints": { + "$ref": "./examples/ServerGetWithPrivateEndpoints.json" + } + }, + "description": "Gets information about a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Server" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_ListByResourceGroup", + "x-ms-examples": { + "ServerListByResourceGroup": { + "$ref": "./examples/ServerListByResourceGroup.json" + } + }, + "description": "List all the servers in a given 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": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/flexibleServers": { + "get": { + "tags": [ + "Servers" + ], + "operationId": "Servers_List", + "x-ms-examples": { + "ServerList": { + "$ref": "./examples/ServerList.json" + } + }, + "description": "List all the servers in a given subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "16", + "15", + "14", + "13", + "12", + "11" + ], + "x-ms-enum": { + "name": "ServerVersion", + "modelAsString": true + } + }, + "Replica": { + "type": "object", + "description": "Replica properties of a server", + "properties": { + "role": { + "$ref": "#/definitions/ReplicationRole", + "description": "Used to indicate role of the server in replication set." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Replicas allowed for a server.", + "readOnly": true + }, + "replicationState": { + "type": "string", + "enum": [ + "Active", + "Catchup", + "Provisioning", + "Updating", + "Broken", + "Reconfiguring" + ], + "x-ms-enum": { + "name": "ReplicationState", + "modelAsString": true + }, + "description": "Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring", + "readOnly": true + }, + "promoteMode": { + "type": "string", + "description": "Sets the promote mode for a replica server. This is a write only property.", + "enum": [ + "standalone", + "switchover" + ], + "x-ms-enum": { + "name": "ReadReplicaPromoteMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + }, + "promoteOption": { + "type": "string", + "description": "Sets the promote options for a replica server. This is a write only property.", + "enum": [ + "planned", + "forced" + ], + "x-ms-enum": { + "name": "ReplicationPromoteOption", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + } + } + }, + "ServerProperties": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "description": "The administrator login password (required for server creation).", + "x-ms-secret": true, + "format": "password", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "minorVersion": { + "type": "string", + "description": "The minor version of the server.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "A state of a server that is visible to user.", + "readOnly": true, + "enum": [ + "Ready", + "Dropping", + "Disabled", + "Starting", + "Stopping", + "Stopped", + "Updating" + ], + "x-ms-enum": { + "name": "ServerState", + "modelAsString": true + } + }, + "fullyQualifiedDomainName": { + "type": "string", + "description": "The fully qualified domain name of a server.", + "readOnly": true + }, + "storage": { + "$ref": "#/definitions/Storage", + "default": null, + "description": "Storage properties of a server." + }, + "authConfig": { + "$ref": "#/definitions/AuthConfig", + "default": null, + "description": "AuthConfig properties of a server." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "default": null, + "description": "Data encryption properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "default": null, + "description": "Backup properties of a server." + }, + "network": { + "$ref": "#/definitions/Network", + "default": null, + "description": "Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "default": null, + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "default": null, + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "sourceServerResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + }, + "description": "The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "pointInTimeUTC": { + "type": "string", + "format": "date-time", + "description": "Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'ReviveDropped'.", + "x-ms-mutability": [ + "create" + ] + }, + "availabilityZone": { + "type": "string", + "default": "", + "description": "availability zone information of the server.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "Replication role of the server" + }, + "replicaCapacity": { + "type": "integer", + "format": "int32", + "description": "Replicas allowed for a server.", + "readOnly": true + }, + "replica": { + "$ref": "#/definitions/Replica", + "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "Create", + "Update", + "PointInTimeRestore", + "GeoRestore", + "Replica", + "ReviveDropped" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connections associated with the specified resource.", + "readOnly": true + } + }, + "description": "The properties of a server." + }, + "Server": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Describes the identity of the application." + }, + "properties": { + "$ref": "#/definitions/ServerProperties", + "x-ms-client-flatten": true, + "description": "Properties of the server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a server." + }, + "ServerPropertiesForUpdate": { + "type": "object", + "properties": { + "administratorLogin": { + "type": "string", + "description": "The administrator's login name of a server. Can only be specified when the server is trying to switch to password authentication and does not have default administrator login.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "administratorLoginPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "The password of the administrator login.", + "x-ms-mutability": [ + "update" + ] + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version. Version 16 is currently not supported for MVU." + }, + "storage": { + "$ref": "#/definitions/Storage", + "default": null, + "description": "Storage properties of a server." + }, + "backup": { + "$ref": "#/definitions/Backup", + "default": null, + "description": "Backup properties of a server." + }, + "highAvailability": { + "$ref": "#/definitions/HighAvailability", + "default": null, + "description": "High availability properties of a server." + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "default": null, + "description": "Maintenance window properties of a server.", + "x-ms-mutability": [ + "update", + "read" + ] + }, + "authConfig": { + "$ref": "#/definitions/AuthConfig", + "default": null, + "description": "AuthConfig properties of a server." + }, + "dataEncryption": { + "$ref": "#/definitions/DataEncryption", + "default": null, + "description": "Data encryption properties of a server." + }, + "createMode": { + "type": "string", + "description": "The mode to update a new PostgreSQL server.", + "enum": [ + "Default", + "Update" + ], + "x-ms-enum": { + "name": "CreateModeForUpdate", + "modelAsString": true + }, + "x-ms-mutability": [ + "update" + ] + }, + "replicationRole": { + "$ref": "#/definitions/ReplicationRole", + "description": "Replication role of the server" + }, + "replica": { + "$ref": "#/definitions/Replica", + "description": "Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.", + "x-ms-mutability": [ + "read", + "update" + ] + }, + "network": { + "$ref": "#/definitions/Network", + "default": null, + "description": "Network properties of a server. These are required to be passed only in case if server is a private access server." + } + } + }, + "ServerForUpdate": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU (pricing tier) of the server." + }, + "identity": { + "$ref": "#/definitions/UserAssignedIdentity", + "description": "Describes the identity of the application." + }, + "properties": { + "$ref": "#/definitions/ServerPropertiesForUpdate", + "x-ms-client-flatten": true, + "description": "Properties of the server." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a server to be updated." + }, + "ServerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "The list of flexible servers" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of servers." + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name", + "tier" + ], + "description": "Sku information related properties of a server." + }, + "Storage": { + "type": "object", + "properties": { + "storageSizeGB": { + "type": "integer", + "format": "int32", + "description": "Max storage allowed for a server." + }, + "autoGrow": { + "type": "string", + "description": "Flag to enable / disable Storage Auto grow for flexible server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "StorageAutoGrow", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Name of storage tier for IOPS.", + "enum": [ + "P1", + "P2", + "P3", + "P4", + "P6", + "P10", + "P15", + "P20", + "P30", + "P40", + "P50", + "P60", + "P70", + "P80" + ], + "x-ms-enum": { + "name": "AzureManagedDiskPerformanceTiers", + "modelAsString": true + } + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS" + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS" + }, + "type": { + "type": "string", + "enum": [ + "Premium_LRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + }, + "description": "Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified" + } + }, + "description": "Storage properties of a server" + }, + "AuthConfig": { + "type": "object", + "properties": { + "activeDirectoryAuth": { + "type": "string", + "description": "If Enabled, Azure Active Directory authentication is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "activeDirectoryAuthEnum", + "modelAsString": true + } + }, + "passwordAuth": { + "type": "string", + "default": "Enabled", + "description": "If Enabled, Password authentication is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "passwordAuthEnum", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "default": "", + "description": "Tenant id of the server." + } + }, + "description": "Authentication configuration properties of a server" + }, + "DataEncryption": { + "type": "object", + "properties": { + "primaryKeyURI": { + "type": "string", + "description": "URI for the key in keyvault for data encryption of the primary server." + }, + "primaryUserAssignedIdentityId": { + "type": "string", + "description": "Resource Id for the User assigned identity to be used for data encryption of the primary server." + }, + "geoBackupKeyURI": { + "type": "string", + "description": "URI for the key in keyvault for data encryption for geo-backup of server." + }, + "geoBackupUserAssignedIdentityId": { + "type": "string", + "description": "Resource Id for the User assigned identity to be used for data encryption for geo-backup of server." + }, + "type": { + "type": "string", + "description": "Data encryption type to depict if it is System Managed vs Azure Key vault.", + "enum": [ + "SystemManaged", + "AzureKeyVault" + ], + "x-ms-enum": { + "name": "ArmServerKeyType", + "modelAsString": true + } + }, + "primaryEncryptionKeyStatus": { + "type": "string", + "description": "Primary encryption key status for Data encryption enabled server.", + "x-ms-mutability": [ + "read" + ], + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "name": "keyStatusEnum", + "modelAsString": true + } + }, + "geoBackupEncryptionKeyStatus": { + "type": "string", + "description": "Geo-backup encryption key status for Data encryption enabled server.", + "x-ms-mutability": [ + "read" + ], + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "name": "keyStatusEnum", + "modelAsString": true + } + } + }, + "description": "Data encryption properties of a server" + }, + "UserIdentity": { + "description": "Describes a single user-assigned identity associated with the application.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "the object identifier of the Service Principal which this identity represents." + }, + "clientId": { + "type": "string", + "description": "the client identifier of the Service Principal which this identity represents." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "Defines a map that contains user assigned identities.", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap", + "description": "represents user assigned identities map." + }, + "type": { + "type": "string", + "description": "the types of identities associated with this resource; currently restricted to 'None and UserAssigned'", + "enum": [ + "None", + "UserAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "description": "Tenant id of the server.", + "readOnly": true + } + }, + "required": [ + "type" + ], + "description": "Information describing the identities associated with this application." + }, + "ReplicationRole": { + "type": "string", + "description": "Used to indicate role of the server in replication set.", + "enum": [ + "None", + "Primary", + "AsyncReplica", + "GeoAsyncReplica" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": true + } + }, + "Backup": { + "type": "object", + "properties": { + "backupRetentionDays": { + "type": "integer", + "format": "int32", + "default": 7, + "description": "Backup retention days for the server." + }, + "geoRedundantBackup": { + "type": "string", + "default": "Disabled", + "description": "A value indicating whether Geo-Redundant backup is enabled on the server.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "GeoRedundantBackupEnum", + "modelAsString": true + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "earliestRestoreDate": { + "type": "string", + "format": "date-time", + "description": "The earliest restore point time (ISO8601 format) for server.", + "readOnly": true + } + }, + "description": "Backup properties of a server" + }, + "Network": { + "type": "object", + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "public network access is enabled or not", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ServerPublicNetworkAccessState", + "modelAsString": true + } + }, + "delegatedSubnetResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + }, + "privateDnsZoneArmResourceId": { + "type": "string", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateDnsZones" + } + ] + }, + "description": "Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone." + } + }, + "description": "Network properties of a server." + }, + "HighAvailability": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "default": "Disabled", + "description": "The HA mode for the server.", + "enum": [ + "Disabled", + "ZoneRedundant", + "SameZone" + ], + "x-ms-enum": { + "name": "HighAvailabilityMode", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "A state of a HA server that is visible to user.", + "enum": [ + "NotEnabled", + "CreatingStandby", + "ReplicatingData", + "FailingOver", + "Healthy", + "RemovingStandby" + ], + "x-ms-enum": { + "name": "ServerHAState", + "modelAsString": true + }, + "readOnly": true + }, + "standbyAvailabilityZone": { + "type": "string", + "default": "", + "description": "availability zone information of the standby." + } + }, + "description": "High availability properties of a server" + }, + "MaintenanceWindow": { + "type": "object", + "description": "Maintenance window properties of a server.", + "properties": { + "customWindow": { + "type": "string", + "default": "Disabled", + "description": "indicates whether custom window is enabled or disabled" + }, + "startHour": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "start hour for maintenance window" + }, + "startMinute": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "start minute for maintenance window" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "day of week for maintenance window" + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json new file mode 100644 index 000000000000..7fca5b14d9bb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json @@ -0,0 +1,524 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrPreBackup": { + "post": { + "description": "PreBackup operation performs all the checks that are needed for the subsequent long term retention backup operation to succeed.", + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "FlexibleServer_TriggerLtrPreBackup", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/LtrPreBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Ok. API finished synchronously with Success.", + "schema": { + "$ref": "#/definitions/LtrPreBackupResponse" + }, + "headers": { + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + }, + "default": { + "description": "Error Scenario 4xx/5xx", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "ErrorCode string in the event of a failure.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Sample_Prebackup": { + "$ref": "./examples/LongTermRetentionPreBackup.json" + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/startLtrBackup": { + "post": { + "description": "Start the Long Term Retention Backup operation", + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "FlexibleServer_StartLtrBackup", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/LtrBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Ok. API finished synchronously with Success.", + "schema": { + "$ref": "#/definitions/LtrBackupResponse" + }, + "headers": { + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + }, + "202": { + "description": "Accepted.", + "headers": { + "Retry-After": { + "description": "The number of seconds to wait before checking the status of the asynchronous operation.", + "type": "integer", + "format": "int32" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + }, + "Location": { + "description": "URL to retrieve the final result after operation completes.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URL for checking the ongoing status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error Scenario 4xx/5xx", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "ErrorCode string in the event of a failure.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A unique ID for the current operation, service generated. All the resource providers must return this value in the response headers to facilitate debugging.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Sample_ExecuteBackup": { + "$ref": "./examples/LongTermRetentionBackup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations/{backupName}": { + "get": { + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "ltrBackupOperations_Get", + "x-ms-examples": { + "Sample": { + "$ref": "./examples/LongTermRetentionOperationGet.json" + } + }, + "description": "Gets the result of the give long term retention backup operation for the flexible server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/BackupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LtrServerBackupOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/ltrBackupOperations": { + "get": { + "tags": [ + "LongTermRetentionBackup" + ], + "operationId": "ltrBackupOperations_ListByServer", + "x-ms-examples": { + "Sample List of Long Tern Retention Operations by Flexible Server": { + "$ref": "./examples/LongTermRetentionOperationListByServer.json" + } + }, + "description": "Gets the result of the give long term retention backup operations for the flexible server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LtrServerBackupOperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BackupRequestBase": { + "description": "BackupRequestBase is the base for all backup request.", + "required": [ + "backupSettings" + ], + "type": "object", + "properties": { + "backupSettings": { + "$ref": "#/definitions/BackupSettings", + "description": "Backup Settings" + } + } + }, + "LtrBackupRequest": { + "description": "The request that is made for a long term retention backup.", + "type": "object", + "properties": { + "targetDetails": { + "$ref": "#/definitions/BackupStoreDetails", + "description": "Backup store detail for target server" + } + }, + "allOf": [ + { + "$ref": "#/definitions/BackupRequestBase" + } + ], + "required": [ + "targetDetails" + ] + }, + "LtrPreBackupRequest": { + "description": "A request that is made for pre-backup.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequestBase" + } + ] + }, + "BackupSettings": { + "description": "The settings for the long term backup.", + "type": "object", + "required": [ + "backupName" + ], + "properties": { + "backupName": { + "type": "string", + "description": "Backup Name for the current backup" + } + } + }, + "BackupStoreDetails": { + "description": "Details about the target where the backup content will be stored.", + "required": [ + "sasUriList" + ], + "type": "object", + "properties": { + "sasUriList": { + "description": "List of SAS uri of storage containers where backup data is to be streamed/copied.", + "type": "array", + "items": { + "type": "string", + "description": "SAS URI of Azure Storage Account Container.", + "x-ms-secret": true + } + } + } + }, + "LtrPreBackupResponseProperties": { + "description": "Response for the pre-backup request.", + "type": "object", + "required": [ + "numberOfContainers" + ], + "properties": { + "numberOfContainers": { + "format": "int32", + "description": "Number of storage containers the plugin will use during backup. More than one containers may be used for size limitations, parallelism, or redundancy etc.", + "type": "integer" + } + } + }, + "LtrBackupOperationResponseProperties": { + "description": "Response for the backup request.", + "type": "object", + "required": [ + "status", + "startTime" + ], + "properties": { + "datasourceSizeInBytes": { + "format": "int64", + "description": "Size of datasource in bytes", + "type": "integer" + }, + "dataTransferredInBytes": { + "format": "int64", + "description": "Data transferred in bytes", + "type": "integer" + }, + "backupName": { + "description": "Name of Backup operation", + "type": "string" + }, + "backupMetadata": { + "description": "Metadata to be stored in RP. Store everything that will be required to perform a successful restore using this Recovery point. e.g. Versions, DataFormat etc", + "type": "string" + }, + "status": { + "description": "Service-set extensible enum indicating the status of operation", + "enum": [ + "Running", + "Cancelled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time of the operation.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "End time of the operation.", + "format": "date-time", + "type": "string" + }, + "percentComplete": { + "description": "PercentageCompleted", + "format": "double", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "errorCode": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "errorMessage": { + "readOnly": true, + "type": "string", + "description": "The error message." + } + } + }, + "LtrBackupResponse": { + "description": "Response for the LTR backup API call", + "type": "object", + "properties": { + "properties": { + "description": "Long Term Retention Backup Operation Resource Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrBackupOperationResponseProperties" + } + } + }, + "LtrServerBackupOperation": { + "description": "Response for the LTR backup Operation API call", + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "properties": { + "description": "Long Term Retention Backup Operation Resource Properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrBackupOperationResponseProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LtrServerBackupOperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LtrServerBackupOperation" + }, + "description": "The list of long term retention server backup operations" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of long term retention backup operations for server." + }, + "LtrPreBackupResponse": { + "description": "Response for the LTR pre-backup API call", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "description": "Additional Properties for the pre backup response", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LtrPreBackupResponseProperties" + } + } + } + }, + "parameters": { + "BackupNameParameter": { + "name": "backupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backup.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json new file mode 100644 index 000000000000..7f3e2460d0b4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json @@ -0,0 +1,1296 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "description": "Azure Active Directory OAuth2 Flow", + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations/{migrationName}": { + "put": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Create", + "x-ms-examples": { + "Migrations_Create": { + "$ref": "./examples/Migrations_Create.json" + }, + "Migrations Create by passing user names": { + "$ref": "./examples/Migrations_Create_With_Other_Users.json" + }, + "Migrations Create with roles": { + "$ref": "./examples/Migrations_Create_With_Roles.json" + }, + "Migrations Create with private endpoint": { + "$ref": "./examples/Migrations_Create_With_PrivateEndpoint_Servers.json" + }, + "Create Migration with other source types for Validate and Migrate": { + "$ref": "./examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json" + }, + "Create Pre-migration Validation": { + "$ref": "./examples/Migrations_Create_Validate_Only.json" + } + }, + "description": "Creates a new migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResource" + }, + "description": "The required parameters for creating a migration." + } + ], + "responses": { + "200": { + "description": "Successfully set or update the Migration for a server", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Get", + "x-ms-examples": { + "Migrations_Get": { + "$ref": "./examples/Migrations_Get.json" + }, + "Migrations_GetMigrationWithValidationFailures": { + "$ref": "./examples/Migrations_GetMigrationWithValidationFailures.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationOnly": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json" + }, + "Migrations_GetMigrationWithSuccessfulValidationAndMigration": { + "$ref": "./examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json" + } + }, + "description": "Gets details of a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Update", + "x-ms-examples": { + "Migrations_Update": { + "$ref": "./examples/Migrations_Update.json" + }, + "Cancel migration": { + "$ref": "./examples/Migrations_Cancel.json" + } + }, + "description": "Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationResourceForPatch" + }, + "description": "The required parameters for updating a migration." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_Delete", + "x-ms-examples": { + "Migrations_Delete": { + "$ref": "./examples/Migrations_Delete.json" + } + }, + "description": "Deletes a migration.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/migrations": { + "get": { + "tags": [ + "Migrations" + ], + "operationId": "Migrations_ListByTargetServer", + "x-ms-examples": { + "Migrations_ListByTargetServer": { + "$ref": "./examples/Migrations_ListByTargetServer.json" + } + }, + "description": "List all the migrations on a given target server.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "$ref": "#/parameters/MigrationListFilter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MigrationResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{targetDbServerName}/checkMigrationNameAvailability": { + "post": { + "summary": "Check migration name validity and availability", + "description": "This method checks whether a proposed migration name is valid and available.", + "tags": [ + "Custom operation", + "POST" + ], + "operationId": "CheckMigrationNameAvailability", + "x-ms-examples": { + "CheckMigrationNameAvailability": { + "$ref": "./examples/CheckMigrationNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TargetDbServerSubscriptionIdParameter" + }, + { + "$ref": "#/parameters/TargetDbServerResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TargetDbServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + }, + "description": "The required parameters for checking if a migration name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationNameAvailabilityResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "MigrationResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourceProperties", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "Represents a migration resource." + }, + "MigrationResourceProperties": { + "type": "object", + "properties": { + "migrationId": { + "type": "string", + "readOnly": true, + "description": "ID for migration, a GUID." + }, + "currentStatus": { + "$ref": "#/definitions/MigrationStatus", + "readOnly": true, + "description": "Current status of migration" + }, + "migrationInstanceResourceId": { + "type": "string", + "format": "arm-id", + "description": "ResourceId of the private endpoint migration instance" + }, + "migrationMode": { + "$ref": "#/definitions/MigrationMode", + "description": "There are two types of migration modes Online and Offline" + }, + "migrationOption": { + "$ref": "#/definitions/MigrationOption", + "description": "This indicates the supported Migration option for the migration" + }, + "sourceType": { + "$ref": "#/definitions/SourceType", + "description": "migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB" + }, + "sslMode": { + "$ref": "#/definitions/SslMode", + "description": "SSL modes for migration. Default SSL mode for PostgreSQLSingleServer is VerifyFull and Prefer for other source types" + }, + "sourceDbServerMetadata": { + "$ref": "#/definitions/DbServerMetadata", + "readOnly": true, + "description": "Metadata of the source database server" + }, + "targetDbServerMetadata": { + "$ref": "#/definitions/DbServerMetadata", + "readOnly": true, + "description": "Metadata of the target database server" + }, + "sourceDbServerResourceId": { + "type": "string", + "description": "ResourceId of the source database server in case the sourceType is PostgreSQLSingleServer. For other source types this should be ipaddress:port@username or hostname:port@username" + }, + "sourceDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "targetDbServerResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId of the source database server" + }, + "targetDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters", + "description": "Migration secret parameters" + }, + "dbsToMigrate": { + "maxItems": 50, + "type": "array", + "items": { + "type": "string" + }, + "description": "Number of databases to migrate", + "x-ms-identifiers": [] + }, + "setupLogicalReplicationOnSourceDbIfNeeded": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "LogicalReplicationOnSourceDbEnum", + "modelAsString": true + }, + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + }, + "overwriteDbsInTarget": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "OverwriteDbsInTargetEnum", + "modelAsString": true + }, + "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "Start time in UTC for migration window" + }, + "migrationWindowEndTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "End time in UTC for migration window" + }, + "migrateRoles": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "MigrateRolesEnum", + "modelAsString": true + }, + "description": "To migrate roles and permissions we need to send this flag as True" + }, + "startDataMigration": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "StartDataMigrationEnum", + "modelAsString": true + }, + "description": "Indicates whether the data migration should start right away" + }, + "triggerCutover": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "TriggerCutoverEnum", + "modelAsString": true + }, + "description": "To trigger cutover for entire migration we need to send this flag as True" + }, + "dbsToTriggerCutoverOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "cancel": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "CancelEnum", + "modelAsString": true + }, + "description": "To trigger cancel for entire migration we need to send this flag as True" + }, + "dbsToCancelMigrationOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "x-ms-identifiers": [] + } + }, + "description": "Migration resource properties." + }, + "MigrationResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MigrationResource" + }, + "readOnly": true, + "description": "A list of migration resources.", + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "The link used to get the next page of migrations.", + "type": "string", + "readOnly": true + } + }, + "description": "A list of migration resources." + }, + "MigrationResourceForPatch": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrationResourcePropertiesForPatch", + "description": "Migration resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + }, + "description": "Represents a migration resource for patch." + }, + "MigrationResourcePropertiesForPatch": { + "type": "object", + "properties": { + "sourceDbServerResourceId": { + "type": "string", + "description": "ResourceId of the source database server" + }, + "sourceDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Source server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "targetDbServerFullyQualifiedDomainName": { + "type": "string", + "description": "Target server fully qualified domain name (FQDN) or IP address. It is a optional value, if customer provide it, migration service will always use it for connection" + }, + "secretParameters": { + "$ref": "#/definitions/MigrationSecretParameters", + "description": "Migration secret parameters" + }, + "dbsToMigrate": { + "maxItems": 50, + "type": "array", + "items": { + "type": "string" + }, + "description": "Number of databases to migrate", + "x-ms-identifiers": [] + }, + "setupLogicalReplicationOnSourceDbIfNeeded": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "LogicalReplicationOnSourceDbEnum", + "modelAsString": true + }, + "description": "Indicates whether to setup LogicalReplicationOnSourceDb, if needed" + }, + "overwriteDbsInTarget": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "OverwriteDbsInTargetEnum", + "modelAsString": true + }, + "description": "Indicates whether the databases on the target server can be overwritten, if already present. If set to False, the migration workflow will wait for a confirmation, if it detects that the database already exists." + }, + "migrationWindowStartTimeInUtc": { + "format": "date-time", + "type": "string", + "description": "Start time in UTC for migration window" + }, + "migrateRoles": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "MigrateRolesEnum", + "modelAsString": true + }, + "description": "To migrate roles and permissions we need to send this flag as True" + }, + "startDataMigration": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "StartDataMigrationEnum", + "modelAsString": true + }, + "description": "Indicates whether the data migration should start right away" + }, + "triggerCutover": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "TriggerCutoverEnum", + "modelAsString": true + }, + "description": "To trigger cutover for entire migration we need to send this flag as True" + }, + "dbsToTriggerCutoverOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cutover for specific databases send triggerCutover flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "cancel": { + "type": "string", + "enum": [ + "True", + "False" + ], + "x-ms-enum": { + "name": "CancelEnum", + "modelAsString": true + }, + "description": "To trigger cancel for entire migration we need to send this flag as True" + }, + "dbsToCancelMigrationOn": { + "type": "array", + "items": { + "type": "string" + }, + "description": "When you want to trigger cancel for specific databases send cancel flag as True and database names in this array", + "x-ms-identifiers": [] + }, + "migrationMode": { + "$ref": "#/definitions/MigrationMode", + "description": "There are two types of migration modes Online and Offline" + } + }, + "description": "Migration resource properties for patch." + }, + "MigrationSecretParameters": { + "required": [ + "adminCredentials" + ], + "type": "object", + "properties": { + "adminCredentials": { + "x-ms-secret": true, + "x-ms-external": true, + "$ref": "#/definitions/AdminCredentials", + "description": "Admin credentials for source and target servers" + }, + "sourceServerUsername": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Gets or sets the username for the source server. This user need not be an admin." + }, + "targetServerUsername": { + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Gets or sets the username for the target server. This user need not be an admin." + } + }, + "description": "Migration secret parameters." + }, + "AdminCredentials": { + "type": "object", + "required": [ + "sourceServerPassword", + "targetServerPassword" + ], + "properties": { + "sourceServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Password for source server." + }, + "targetServerPassword": { + "type": "string", + "x-ms-secret": true, + "x-ms-external": true, + "x-ms-mutability": [ + "create", + "update" + ], + "description": "Password for target server." + } + }, + "description": "Server admin credentials." + }, + "DbServerMetadata": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Location of database server", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "version": { + "type": "string", + "description": "Version for database engine" + }, + "storageMb": { + "format": "int32", + "type": "integer", + "description": "Storage size in MB for database server" + }, + "sku": { + "$ref": "#/definitions/ServerSku", + "description": "SKU for the database server. This object is empty for PG single server" + } + }, + "description": "Database server metadata." + }, + "MigrationDetailsLevel": { + "enum": [ + "Default", + "Summary", + "Full" + ], + "type": "string", + "description": "Migration details level.", + "x-ms-enum": { + "name": "MigrationDetailsLevel", + "modelAsString": true + } + }, + "MigrationMode": { + "enum": [ + "Offline", + "Online" + ], + "type": "string", + "description": "There are two types of migration modes Online and Offline", + "x-ms-enum": { + "name": "MigrationMode", + "modelAsString": true + } + }, + "MigrationOption": { + "enum": [ + "Validate", + "Migrate", + "ValidateAndMigrate" + ], + "type": "string", + "description": "Supported types of migration request include Validate, Migrate and ValidateAndMigrate", + "x-ms-enum": { + "name": "MigrationOption", + "modelAsString": true + } + }, + "MigrationState": { + "enum": [ + "InProgress", + "WaitingForUserAction", + "Canceled", + "Failed", + "Succeeded", + "ValidationFailed", + "CleaningUp" + ], + "type": "string", + "description": "Migration state.", + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "MigrationStatus": { + "type": "object", + "properties": { + "state": { + "$ref": "#/definitions/MigrationState", + "readOnly": true, + "description": "State of migration" + }, + "error": { + "type": "string", + "readOnly": true, + "description": "Error message, if any, for the migration state" + }, + "currentSubStateDetails": { + "$ref": "#/definitions/MigrationSubStateDetails", + "readOnly": true, + "description": "Current Migration sub state details." + } + }, + "description": "Migration status." + }, + "MigrationSubState": { + "enum": [ + "PerformingPreRequisiteSteps", + "WaitingForLogicalReplicationSetupRequestOnSourceDB", + "WaitingForDBsToMigrateSpecification", + "WaitingForTargetDBOverwriteConfirmation", + "WaitingForDataMigrationScheduling", + "WaitingForDataMigrationWindow", + "MigratingData", + "WaitingForCutoverTrigger", + "CompletingMigration", + "Completed", + "CancelingRequestedDBMigrations", + "ValidationInProgress" + ], + "type": "string", + "description": "Migration sub state.", + "x-ms-enum": { + "name": "MigrationSubState", + "modelAsString": true + } + }, + "MigrationSubStateDetails": { + "type": "object", + "properties": { + "currentSubState": { + "$ref": "#/definitions/MigrationSubState", + "readOnly": true + }, + "dbDetails": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/DbMigrationStatus" + } + }, + "validationDetails": { + "$ref": "#/definitions/ValidationDetails" + } + }, + "description": "Migration sub state details." + }, + "DbMigrationStatus": { + "type": "object", + "description": "Migration status of an individual database", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "migrationState": { + "type": "string", + "description": "Migration db state of an individual database", + "enum": [ + "InProgress", + "WaitingForCutoverTrigger", + "Failed", + "Canceled", + "Succeeded", + "Canceling" + ], + "x-ms-enum": { + "name": "MigrationDbState", + "modelAsString": true + } + }, + "migrationOperation": { + "type": "string", + "description": "Migration operation of an individual database" + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Start date-time of a migration state" + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "End date-time of a migration state" + }, + "fullLoadQueuedTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables queued for the migration of a DB" + }, + "fullLoadErroredTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables errored out during the migration of a DB" + }, + "fullLoadLoadingTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables loading during the migration of a DB" + }, + "fullLoadCompletedTables": { + "format": "int32", + "type": "integer", + "description": "Number of tables loaded during the migration of a DB" + }, + "cdcUpdateCounter": { + "format": "int32", + "type": "integer", + "description": "CDC update counter" + }, + "cdcDeleteCounter": { + "format": "int32", + "type": "integer", + "description": "CDC delete counter" + }, + "cdcInsertCounter": { + "format": "int32", + "type": "integer", + "description": "CDC insert counter" + }, + "appliedChanges": { + "format": "int32", + "type": "integer", + "description": "CDC applied changes counter" + }, + "incomingChanges": { + "format": "int32", + "type": "integer", + "description": "CDC incoming changes counter" + }, + "latency": { + "format": "int32", + "type": "integer", + "description": "Lag in seconds between source and target during online phase" + }, + "message": { + "type": "string", + "description": "Error message, if any, for the migration state" + } + } + }, + "ValidationDetails": { + "type": "object", + "description": "Details for the validation for migration", + "properties": { + "status": { + "$ref": "#/definitions/ValidationState" + }, + "validationStartTimeInUtc": { + "type": "string", + "format": "date-time", + "description": "Validation Start date-time in UTC" + }, + "validationEndTimeInUtc": { + "type": "string", + "format": "date-time", + "description": "Validation End date-time in UTC" + }, + "serverLevelValidationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationSummaryItem" + }, + "description": "Details of server level validations", + "x-ms-identifiers": [] + }, + "dbLevelValidationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/DbLevelValidationStatus" + }, + "description": "Details of server level validations", + "x-ms-identifiers": [ + "databaseName" + ] + } + } + }, + "DbLevelValidationStatus": { + "type": "object", + "description": "Validation status summary for an individual database", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Start date-time of a database level validation" + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "End date-time of a database level validation" + }, + "summary": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationSummaryItem" + }, + "description": "Summary of database level validations", + "x-ms-identifiers": [] + } + } + }, + "ValidationSummaryItem": { + "type": "object", + "description": "Validation summary object", + "properties": { + "type": { + "type": "string", + "description": "Validation type" + }, + "state": { + "$ref": "#/definitions/ValidationState" + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/ValidationMessage" + }, + "description": "Validation messages", + "x-ms-identifiers": [] + } + } + }, + "ValidationMessage": { + "type": "object", + "description": "Validation message object", + "properties": { + "state": { + "$ref": "#/definitions/ValidationState", + "description": "Severity of validation message" + }, + "message": { + "type": "string", + "description": "Validation message string" + } + } + }, + "ValidationState": { + "type": "string", + "description": "Validation status for migration", + "enum": [ + "Failed", + "Succeeded", + "Warning" + ], + "x-ms-enum": { + "name": "ValidationState", + "modelAsString": true + } + }, + "SourceType": { + "enum": [ + "OnPremises", + "AWS", + "GCP", + "AzureVM", + "PostgreSQLSingleServer", + "AWS_RDS", + "AWS_AURORA", + "AWS_EC2", + "GCP_CloudSQL", + "GCP_AlloyDB", + "GCP_Compute", + "EDB" + ], + "type": "string", + "description": "Migration source server type : OnPremises, AWS, GCP, AzureVM, PostgreSQLSingleServer, AWS_RDS, AWS_AURORA, AWS_EC2, GCP_CloudSQL, GCP_AlloyDB, GCP_Compute, or EDB", + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true + } + }, + "SslMode": { + "enum": [ + "Prefer", + "Require", + "VerifyCA", + "VerifyFull" + ], + "type": "string", + "description": "Supported SSL modes for migration. VerifyFull is the recommended SSL mode for Single server migration. Prefer, Require are recommended SSL modes for other source types", + "x-ms-enum": { + "name": "SslMode", + "modelAsString": true + } + }, + "ServerSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3." + }, + "tier": { + "type": "string", + "description": "The tier of the particular SKU, e.g. Burstable.", + "enum": [ + "Burstable", + "GeneralPurpose", + "MemoryOptimized" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "description": "Sku information related properties of a server." + }, + "MigrationNameAvailabilityReason": { + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "description": "Migration name availability reason.", + "x-ms-enum": { + "name": "MigrationNameAvailabilityReason", + "modelAsString": true + } + }, + "MigrationNameAvailabilityResource": { + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The resource name to verify." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "nameAvailable": { + "type": "boolean", + "description": "Indicates whether the resource name is available.", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/MigrationNameAvailabilityReason", + "description": "Migration name availability reason", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration name availability message.", + "readOnly": true + } + }, + "description": "Represents a migration name's availability." + } + }, + "parameters": { + "TargetDbServerSubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription ID of the target database server.", + "pattern": "([a-z0-9]){8,8}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){4,4}[-]([a-z0-9]){12,12}", + "x-ms-parameter-location": "method" + }, + "TargetDbServerResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the target database server.", + "pattern": "^[-a-z0-9A-Z._()]+[^.]$", + "x-ms-parameter-location": "method" + }, + "TargetDbServerNameParameter": { + "name": "targetDbServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the target database server.", + "pattern": "([-a-z0-9]){3,63}", + "x-ms-parameter-location": "method" + }, + "MigrationNameParameter": { + "name": "migrationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the migration.", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "MigrationListFilter": { + "name": "migrationListFilter", + "in": "query", + "required": false, + "enum": [ + "Active", + "All" + ], + "type": "string", + "description": "Migration list filter. Retrieves either active migrations or all migrations.", + "x-ms-enum": { + "name": "MigrationListFilter", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json new file mode 100644 index 000000000000..01d625da13f3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json @@ -0,0 +1,164 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DBforPostgreSQL/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "description": "Lists all of the available REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "readOnly": true, + "description": "Operation resource provider name." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "readOnly": true, + "description": "Localized friendly name for the operation." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Operation description." + } + }, + "description": "Display metadata associated with the operation." + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the operation being performed on this particular object." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "readOnly": true, + "description": "The localized display information for this particular operation or action." + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The intended executor of the operation.", + "enum": [ + "NotSpecified", + "user", + "system" + ], + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false, + "description": "Additional descriptions for the operation." + } + }, + "description": "REST API operation definition." + }, + "OperationListResult": { + "description": "A list of resource provider operations.", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json new file mode 100644 index 000000000000..8a8e8ea82d6d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json @@ -0,0 +1,77 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-01", + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.DBforPostgreSQL/getPrivateDnsZoneSuffix": { + "post": { + "tags": [ + "GetPrivateDnsZoneSuffix" + ], + "operationId": "GetPrivateDnsZoneSuffix_Execute", + "x-ms-examples": { + "GetPrivateDnsZoneSuffix": { + "$ref": "./examples/GetPrivateDnsZoneSuffix.json" + } + }, + "description": "Get private DNS zone suffix in the cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneSuffix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "PrivateDnsZoneSuffix": { + "type": "string", + "description": "Represents a resource name availability." + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json new file mode 100644 index 000000000000..def9b6815c9b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json @@ -0,0 +1,270 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets private endpoint connection.": { + "$ref": "./examples/PrivateEndpointConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Approve or reject a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnection_Update", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The required parameters for updating private endpoint connection." + } + ], + "responses": { + "200": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Successfully approved or rejected private endpoint connection.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Approve or reject a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection with a given name.", + "operationId": "PrivateEndpointConnection_Delete", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Deletes a private endpoint connection with a given name.": { + "$ref": "./examples/PrivateEndpointConnectionDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Gets all private endpoint connections on a server.", + "operationId": "PrivateEndpointConnections_ListByServer", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets list of private endpoint connections on a server.": { + "$ref": "./examples/PrivateEndpointConnectionList.json" + } + } + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "description": "A list of private endpoint connections.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "The URL to get the next set of results.", + "type": "string", + "format": "uri", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json new file mode 100644 index 000000000000..9e188d7a5e44 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json @@ -0,0 +1,155 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets the private link resources for PostgreSQL server.", + "operationId": "PrivateLinkResources_ListByServer", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets private link resources for PostgreSQL.": { + "$ref": "./examples/PrivateLinkResourcesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "description": "Gets a private link resource for PostgreSQL server.", + "operationId": "PrivateLinkResources_Get", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource.", + "required": true, + "type": "string", + "pattern": "^.*$" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Gets a private link resource for PostgreSQL.": { + "$ref": "./examples/PrivateLinkResourcesGet.json" + } + } + } + } + }, + "definitions": { + "PrivateLinkResourceListResult": { + "description": "A list of private link resources", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResource" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json new file mode 100644 index 000000000000..89ea828d91f7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json @@ -0,0 +1,83 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/replicas": { + "get": { + "tags": [ + "Replicas" + ], + "operationId": "Replicas_ListByServer", + "x-ms-examples": { + "ReplicasListByServer": { + "$ref": "./examples/ReplicasListByServer.json" + } + }, + "description": "List all the replicas for a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./FlexibleServers.json#/definitions/ServerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json new file mode 100644 index 000000000000..35221ee855db --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json @@ -0,0 +1,148 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/logFiles": { + "get": { + "tags": [ + "LogFiles" + ], + "operationId": "LogFiles_ListByServer", + "x-ms-examples": { + "List all server log files for a server": { + "$ref": "./examples/LogFilesListByServer.json" + } + }, + "description": "List all the server log files in a given server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogFileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "LogFileProperties": { + "type": "object", + "properties": { + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp of the log file." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified timestamp of the log file." + }, + "sizeInKb": { + "type": "integer", + "format": "int64", + "description": "The size in kb of the logFile." + }, + "type": { + "type": "string", + "description": "Type of the log file." + }, + "url": { + "type": "string", + "description": "The url to download the log file from." + } + }, + "description": "The properties of a logFile." + }, + "LogFile": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LogFileProperties", + "x-ms-client-flatten": true, + "description": "The properties of a logFile." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "description": "Represents a logFile." + }, + "LogFileListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LogFile" + }, + "description": "The list of logFiles in a server" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A List of logFiles." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json new file mode 100644 index 000000000000..edffb5872aba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json @@ -0,0 +1,229 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/restart": { + "post": { + "tags": [ + "ServerRestart" + ], + "operationId": "Servers_Restart", + "x-ms-examples": { + "ServerRestart": { + "$ref": "./examples/ServerRestart.json" + }, + "ServerRestartWithFailover": { + "$ref": "./examples/ServerRestartWithFailover.json" + } + }, + "description": "Restarts a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "schema": { + "$ref": "#/definitions/RestartParameter" + }, + "description": "The parameters for restarting a server." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/start": { + "post": { + "tags": [ + "ServerStart" + ], + "operationId": "Servers_Start", + "x-ms-examples": { + "ServerStart": { + "$ref": "./examples/ServerStart.json" + } + }, + "description": "Starts a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/stop": { + "post": { + "tags": [ + "ServerStop" + ], + "operationId": "Servers_Stop", + "x-ms-examples": { + "ServerStop": { + "$ref": "./examples/ServerStop.json" + } + }, + "description": "Stops a server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RestartParameter": { + "type": "object", + "properties": { + "restartWithFailover": { + "type": "boolean", + "description": "Indicates whether to restart the server with failover." + }, + "failoverMode": { + "type": "string", + "description": "Failover mode.", + "enum": [ + "PlannedFailover", + "ForcedFailover", + "PlannedSwitchover", + "ForcedSwitchover" + ], + "x-ms-enum": { + "name": "FailoverMode", + "modelAsString": true + } + } + }, + "description": "Represents server restart parameters." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json new file mode 100644 index 000000000000..63e17023e7b7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json @@ -0,0 +1,280 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, administrators, log files, configurations, migrations, advanced threat protection settings with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Get a list of server's Threat Protection state.", + "operationId": "ServerThreatProtectionSettings_ListByServer", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation of advanced threat protection on the flexible server failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a server's Advanced Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsListByServer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/advancedThreatProtectionSettings/{threatProtectionName}": { + "get": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Get a server's Advanced Threat Protection settings.", + "operationId": "ServerThreatProtectionSettings_Get", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ThreatProtectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server advanced threat protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "default": { + "description": "Error response describing why the operation of threat protection on the flexible server failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a server's Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsGet.json" + } + } + }, + "put": { + "tags": [ + "AdvancedThreatProtectionSettings" + ], + "description": "Creates or updates a server's Advanced Threat Protection settings.", + "operationId": "ServerThreatProtectionSettings_CreateOrUpdate", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/ThreatProtectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The Advanced Threat Protection state for the flexible server.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + } + ], + "responses": { + "200": { + "description": "Successfully set or update the server Threat Protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "default": { + "description": "Error response describing why the operation of setting Threat Protection failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + }, + "201": { + "description": "Successfully created the server Threat Protection settings.", + "schema": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Update a server's Threat Protection settings": { + "$ref": "./examples/ServerThreatProtectionSettingsCreateOrUpdate.json" + } + } + } + } + }, + "definitions": { + "ServerThreatProtectionProperties": { + "description": "Properties of server Threat Protection state.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the Threat Protection, whether it is enabled or disabled or a state has not been applied yet on the specific server.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ThreatProtectionState", + "modelAsString": false + } + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ServerThreatProtectionSettingsModel": { + "description": "Server's Advanced Threat Protection settings.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServerThreatProtectionProperties", + "description": "Advanced Threat Protection properties.", + "x-ms-client-flatten": true + } + } + }, + "ServerThreatProtectionListResult": { + "description": "A list of the server's Advanced Threat Protection settings.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerThreatProtectionSettingsModel" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ThreatProtectionNameParameter": { + "name": "threatProtectionName", + "in": "path", + "description": "The name of the Threat Protection state.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "ThreatProtectionName", + "modelAsString": true + }, + "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json new file mode 100644 index 000000000000..5795994b6d8f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints/{virtualEndpointName}": { + "put": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Create", + "x-ms-examples": { + "Create a new virtual endpoint for a flexible server": { + "$ref": "./examples/VirtualEndpointCreate.json" + } + }, + "description": "Creates a new virtual endpoint for PostgreSQL flexible server.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + }, + "description": "The required parameters for creating or updating virtual endpoints." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Update", + "x-ms-examples": { + "Update a virtual endpoint for a server to update the ": { + "$ref": "./examples/VirtualEndpointUpdate.json" + } + }, + "description": "Updates an existing virtual endpoint. The request body can contain one to many of the properties present in the normal virtual endpoint definition.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualEndpointResourceForPatch" + }, + "description": "The required parameters for updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Delete", + "x-ms-examples": { + "Delete a virtual endpoint": { + "$ref": "./examples/VirtualEndpointDelete.json" + } + }, + "description": "Deletes a virtual endpoint.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_Get", + "x-ms-examples": { + "Get a virtual endpoint": { + "$ref": "./examples/VirtualEndpointsGet.json" + } + }, + "description": "Gets information about a virtual endpoint.", + "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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/VirtualEndpointNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/flexibleServers/{serverName}/virtualendpoints": { + "get": { + "tags": [ + "VirtualEndpoints" + ], + "operationId": "VirtualEndpoints_ListByServer", + "x-ms-examples": { + "VirtualEndpointListByServer": { + "$ref": "./examples/VirtualEndpointsListByServer.json" + } + }, + "description": "List all the servers in a given 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" + }, + { + "$ref": "../../../types/common-types.json#/parameters/ServerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualEndpointsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualEndpointResourceProperties": { + "type": "object", + "properties": { + "endpointType": { + "type": "string", + "description": "The endpoint type for the virtual endpoint.", + "enum": [ + "ReadWrite" + ], + "x-ms-enum": { + "name": "VirtualEndpointType", + "modelAsString": true + } + }, + "members": { + "type": "array", + "items": { + "type": "string", + "description": "Member for the virtual endpoint." + }, + "description": "List of members for a virtual endpoint" + }, + "virtualEndpoints": { + "type": "array", + "items": { + "type": "string", + "description": "Virtual endpoint for a server." + }, + "description": "List of virtual endpoints for a server", + "readOnly": true + } + }, + "description": "The properties of a virtual endpoint." + }, + "VirtualEndpointResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VirtualEndpointResourceForPatch" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "Represents a virtual endpoint for a server." + }, + "VirtualEndpointResourceForPatch": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualEndpointResourceProperties", + "x-ms-client-flatten": true, + "description": "Properties of the virtual endpoint resource." + } + }, + "description": "Represents a virtual endpoint for a server." + }, + "VirtualEndpointsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualEndpointResource" + }, + "description": "The list of virtual endpoints" + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + } + }, + "description": "A list of virtual endpoints." + } + }, + "parameters": { + "VirtualEndpointNameParameter": { + "name": "virtualEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual endpoint.", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?<!-)$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json new file mode 100644 index 000000000000..ea74116c1885 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json @@ -0,0 +1,142 @@ +{ + "swagger": "2.0", + "info": { + "title": "PostgreSQLServerManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.", + "version": "2024-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/checkVirtualNetworkSubnetUsage": { + "post": { + "tags": [ + "VirtualNetworkSubnetUsage" + ], + "operationId": "VirtualNetworkSubnetUsage_Execute", + "x-ms-examples": { + "VirtualNetworkSubnetUsageList": { + "$ref": "./examples/VirtualNetworkSubnetUsage.json" + } + }, + "description": "Get virtual network subnet usage for a given vNet resource id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../types/common-types.json#/parameters/LocationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageParameter" + }, + "description": "The required parameters for creating or updating a server." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualNetworkSubnetUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "VirtualNetworkSubnetUsageParameter": { + "type": "object", + "properties": { + "virtualNetworkArmResourceId": { + "type": "string", + "description": "Virtual network resource id." + } + }, + "description": "Virtual network subnet usage parameter" + }, + "VirtualNetworkSubnetUsageResult": { + "type": "object", + "properties": { + "delegatedSubnetsUsage": { + "type": "array", + "items": { + "$ref": "#/definitions/DelegatedSubnetUsage" + }, + "readOnly": true, + "x-ms-identifiers": [ + "subnetName" + ] + }, + "location": { + "type": "string", + "readOnly": true, + "description": "location of the delegated subnet usage" + }, + "subscriptionId": { + "type": "string", + "readOnly": true, + "description": "subscriptionId of the delegated subnet usage" + } + }, + "description": "Virtual network subnet usage data." + }, + "DelegatedSubnetUsage": { + "type": "object", + "properties": { + "subnetName": { + "type": "string", + "readOnly": true, + "description": "Name of the delegated subnet for which IP addresses are in use" + }, + "usage": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Number of IP addresses used by the delegated subnet" + } + }, + "description": "Delegated subnet usage data." + } + }, + "parameters": {} +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json new file mode 100644 index 000000000000..a534fb4567e6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorAdd.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "parameters": { + "properties": { + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt", + "principalType": "User", + "principalName": "testuser1@microsoft.com" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuser1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + }, + "201": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuser1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json new file mode 100644 index 000000000000..0887c138a662 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json new file mode 100644 index 000000000000..caac178f3a67 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo" + }, + "responses": { + "200": { + "body": { + "properties": { + "principalType": "User", + "principalName": "testuer1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "name": "testuser1@microsoft.com", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json new file mode 100644 index 000000000000..ee0bd6ba8efe --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/AdministratorsListByServer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "principalType": "User", + "principalName": "testuer1@microsoft.com", + "objectId": "oooooooo-oooo-oooo-oooo-oooooooooooo", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/oooooooo-oooo-oooo-oooo-oooooooooooo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + }, + { + "properties": { + "principalType": "Group", + "principalName": "testgroup1@microsoft.com", + "objectId": "gggggggg-gggg-gggg-gggg-gggggggggggg", + "tenantId": "tttttttt-tttt-tttt-tttt-tttttttttttt" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1/administrators/gggggggg-gggg-gggg-gggg-gggggggggggg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json new file mode 100644 index 000000000000..75a019877eba --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "backupName": "backup_20210615T160516", + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "Customer On-Demand", + "source": "Customer Initiated", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/backup_20210615T160516", + "name": "backup_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + }, + "201": { + "body": { + "properties": { + "backupType": "Customer On-Demand", + "source": "Customer Initiated", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/backup_20210615T160516", + "name": "backup_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json new file mode 100644 index 000000000000..d814e23ead0c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "backupName": "backup_20210615T160516", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json new file mode 100644 index 000000000000..c15882d0a1a0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "backupName": "daily_20210615T160516", + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json new file mode 100644 index 000000000000..5baf3cd77779 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/BackupListByServer.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "serverName": "postgresqltestserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-15T16:05:19.902522+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210615T160516", + "name": "daily_20210615T160516", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-16T16:05:23.9243453+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210616T160520", + "name": "daily_20210616T160520", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-17T16:05:28.1247488+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210617T160525", + "name": "daily_20210617T160525", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-18T16:05:32.2736701+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210618T160529", + "name": "daily_20210618T160529", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-19T16:05:36.8603354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210619T160533", + "name": "daily_20210619T160533", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-20T16:05:41.9200138+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210620T160538", + "name": "daily_20210620T160538", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-21T16:05:48.8528447+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210621T160543", + "name": "daily_20210621T160543", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-22T16:08:06.3121688+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210622T160803", + "name": "daily_20210622T160803", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-22T21:08:10.5057354+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210622T210807", + "name": "daily_20210622T210807", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-23T21:24:16.9401531+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210623T212413", + "name": "daily_20210623T212413", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + }, + { + "properties": { + "backupType": "Full", + "source": "Automatic", + "completedTime": "2021-06-24T06:13:31.4962137+00:00" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestserver/backups/daily_20210624T061328", + "name": "daily_20210624T061328", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/backups" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json new file mode 100644 index 000000000000..e0bd505c0dc4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CapabilitiesByLocation.json @@ -0,0 +1,2153 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "FlexibleServerCapabilities", + "supportedServerEditions": [ + { + "name": "Burstable", + "defaultSkuName": "Standard_B1ms", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2ms", + "vCores": 2, + "supportedIops": 1920, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B4ms", + "vCores": 4, + "supportedIops": 2880, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B8ms", + "vCores": 8, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B12ms", + "vCores": 12, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B16ms", + "vCores": 16, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B20ms", + "vCores": 20, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "GeneralPurpose", + "defaultSkuName": "Standard_D4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ads_v5", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "MemoryOptimized", + "defaultSkuName": "Standard_E4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ads_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ads_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVersionsToUpgrade": [ + "12", + "13", + "14", + "15", + "16" + ] + }, + { + "name": "12", + "supportedVersionsToUpgrade": [ + "13", + "14", + "15", + "16" + ] + }, + { + "name": "13", + "supportedVersionsToUpgrade": [ + "14", + "15", + "16" + ] + }, + { + "name": "14", + "supportedVersionsToUpgrade": [ + "15", + "16" + ] + }, + { + "name": "15", + "supportedVersionsToUpgrade": [ + "16" + ] + }, + { + "name": "16", + "supportedVersionsToUpgrade": [] + } + ], + "fastProvisioningSupported": "Enabled", + "supportedFastProvisioningEditions": [ + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "15", + "serverCount": 0 + } + ], + "geoBackupSupported": "Enabled", + "zoneRedundantHaSupported": "Enabled", + "zoneRedundantHaAndGeoBackupSupported": "Enabled", + "storageAutoGrowthSupported": "Enabled", + "onlineResizeSupported": "Enabled", + "restricted": "Disabled" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json new file mode 100644 index 000000000000..0700e877e679 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckMigrationNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "parameters": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations" + } + }, + "responses": { + "200": { + "body": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations", + "nameAvailable": true, + "reason": null, + "message": null + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..39cc33978565 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json new file mode 100644 index 000000000000..f084ec37bf95 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/CheckNameAvailabilityLocationBased.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "", + "name": "name1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json new file mode 100644 index 000000000000..d0627c81f2d6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "on", + "description": "Enable input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..758d7e202805 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations?api-version=2024-08-01&$top=200&$skiptoken=skiptoken", + "value": [ + { + "properties": { + "value": "", + "description": "Sets the application name to be reported in statistics and logs.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._-]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/application_name", + "name": "application_name", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables input of NULL elements in arrays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/array_nulls", + "name": "array_nulls", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Starts the autovacuum subprocess.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum", + "name": "autovacuum", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Number of tuple inserts, updates, or deletes prior to analyze as a fraction of reltuples.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_scale_factor", + "name": "autovacuum_analyze_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple inserts, updates, or deletes prior to analyze.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_analyze_threshold", + "name": "autovacuum_analyze_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "60", + "description": "Time to sleep between autovacuum runs.", + "defaultValue": "60", + "dataType": "Integer", + "allowedValues": "1-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_naptime", + "name": "autovacuum_naptime", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Vacuum cost delay in milliseconds, for autovacuum.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "-1-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_delay", + "name": "autovacuum_vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Vacuum cost amount available before napping, for autovacuum.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_cost_limit", + "name": "autovacuum_vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.2", + "description": "Number of tuple updates or deletes prior to vacuum as a fraction of reltuples.", + "defaultValue": "0.2", + "dataType": "Numeric", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_scale_factor", + "name": "autovacuum_vacuum_scale_factor", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50", + "description": "Minimum number of tuple updates or deletes prior to vacuum.", + "defaultValue": "50", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_vacuum_threshold", + "name": "autovacuum_vacuum_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the maximum memory to be used by each autovacuum worker process.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/autovacuum_work_mem", + "name": "autovacuum_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backend_flush_after", + "name": "backend_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "safe_encoding", + "description": "Sets whether \"\\'\" is allowed in string literals.", + "defaultValue": "safe_encoding", + "dataType": "Enumeration", + "allowedValues": "safe_encoding,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/backslash_quote", + "name": "backslash_quote", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Background writer sleep time between rounds.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "10-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_delay", + "name": "bgwriter_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Number of pages after which previously performed writes are flushed to disk.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-256", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_flush_after", + "name": "bgwriter_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Background writer maximum number of LRU pages to flush per round.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "0-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_maxpages", + "name": "bgwriter_lru_maxpages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Multiple of the average buffer usage to free per round.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "0-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bgwriter_lru_multiplier", + "name": "bgwriter_lru_multiplier", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "hex", + "description": "Sets the output format for bytea.", + "defaultValue": "hex", + "dataType": "Enumeration", + "allowedValues": "escape,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/bytea_output", + "name": "bytea_output", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Checks function bodies during CREATE FUNCTION.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/check_function_bodies", + "name": "check_function_bodies", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.5", + "description": "Time spent flushing dirty buffers during checkpoint, as fraction of checkpoint interval.", + "defaultValue": "0.5", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_completion_target", + "name": "checkpoint_completion_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "300", + "description": "Sets the maximum time between automatic WAL checkpoints.", + "defaultValue": "300", + "dataType": "Integer", + "allowedValues": "30-86400", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_timeout", + "name": "checkpoint_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Enables warnings if checkpoint segments are filled more frequently than this.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/checkpoint_warning", + "name": "checkpoint_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "sql_ascii", + "description": "Sets the client's character set encoding.", + "defaultValue": "sql_ascii", + "dataType": "Enumeration", + "allowedValues": "BIG5,EUC_CN,EUC_JP,EUC_JIS_2004,EUC_KR,EUC_TW,GB18030,GBK,ISO_8859_5,ISO_8859_6,ISO_8859_7,ISO_8859_8,JOHAB,KOI8R,KOI8U,LATIN1,LATIN2,LATIN3,LATIN4,LATIN5,LATIN6,LATIN7,LATIN8,LATIN9,LATIN10,MULE_INTERNAL,SJIS,SHIFT_JIS_2004,SQL_ASCII,UHC,UTF8,WIN866,WIN874,WIN1250,WIN1251,WIN1252,WIN1253,WIN1254,WIN1255,WIN1256,WIN1257,WIN1258", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_encoding", + "name": "client_encoding", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "notice", + "description": "Sets the message levels that are sent to the client.", + "defaultValue": "notice", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,log,notice,warning,error", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/client_min_messages", + "name": "client_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the delay in microseconds between transaction commit and flushing WAL to disk.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_delay", + "name": "commit_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "Sets the minimum concurrent open transactions before performing commit_delay.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "0-1000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/commit_siblings", + "name": "commit_siblings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "partition", + "description": "Enables the planner to use constraints to optimize queries.", + "defaultValue": "partition", + "dataType": "Enumeration", + "allowedValues": "partition,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/constraint_exclusion", + "name": "constraint_exclusion", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.005", + "description": "Sets the planner's estimate of the cost of processing each index entry during an index scan.", + "defaultValue": "0.005", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_index_tuple_cost", + "name": "cpu_index_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.0025", + "description": "Sets the planner's estimate of the cost of processing each operator or function call.", + "defaultValue": "0.0025", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_operator_cost", + "name": "cpu_operator_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.01", + "description": "Sets the planner's estimate of the cost of processing each tuple (row).", + "defaultValue": "0.01", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cpu_tuple_cost", + "name": "cpu_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the fraction of a cursor's rows that will be retrieved.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/cursor_tuple_fraction", + "name": "cursor_tuple_fraction", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "ISO, MDY", + "description": "Sets the display format for date and time values.", + "defaultValue": "ISO, MDY", + "dataType": "String", + "allowedValues": "(ISO|POSTGRES|SQL|GERMAN)(, (DMY|MDY|YMD))?", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/DateStyle", + "name": "DateStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the amount of time, in milliseconds, to wait on a lock before checking for deadlock.", + "defaultValue": "1000", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/deadlock_timeout", + "name": "deadlock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Indents parse and plan tree displays.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_pretty_print", + "name": "debug_pretty_print", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_parse", + "name": "debug_print_parse", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's execution plan.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_plan", + "name": "debug_print_plan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each query's rewritten parse tree.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/debug_print_rewritten", + "name": "debug_print_rewritten", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "100", + "description": "Sets the default statistics target.", + "defaultValue": "100", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_statistics_target", + "name": "default_statistics_target", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the default tablespace to create tables and indexes in.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_tablespace", + "name": "default_tablespace", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "pg_catalog.english", + "description": "Sets default text search configuration.", + "defaultValue": "pg_catalog.english", + "dataType": "String", + "allowedValues": "[A-Za-z._]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_text_search_config", + "name": "default_text_search_config", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default deferrable status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_deferrable", + "name": "default_transaction_deferrable", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "read committed", + "description": "Sets the transaction isolation level of each new transaction.", + "defaultValue": "read committed", + "dataType": "Enumeration", + "allowedValues": "serializable,repeatable read,read committed,read uncommitted", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_isolation", + "name": "default_transaction_isolation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Sets the default read-only status of new transactions.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_transaction_read_only", + "name": "default_transaction_read_only", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Creates new tables with OIDs by default.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/default_with_oids", + "name": "default_with_oids", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "3145728", + "description": "Sets the planner's assumption about the size of the disk cache.", + "defaultValue": "3145728", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/effective_cache_size", + "name": "effective_cache_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of bitmap-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_bitmapscan", + "name": "enable_bitmapscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of gather merge plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_gathermerge", + "name": "enable_gathermerge", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hashed aggregation plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashagg", + "name": "enable_hashagg", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of hash join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_hashjoin", + "name": "enable_hashjoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-only-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexonlyscan", + "name": "enable_indexonlyscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of index-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_indexscan", + "name": "enable_indexscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of materialization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_material", + "name": "enable_material", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of merge join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_mergejoin", + "name": "enable_mergejoin", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of nested loop join plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_nestloop", + "name": "enable_nestloop", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of sequential-scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_seqscan", + "name": "enable_seqscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of explicit sort steps.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_sort", + "name": "enable_sort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables the planner's use of TID scan plans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/enable_tidscan", + "name": "enable_tidscan", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Warns about backslash escapes in ordinary string literals.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/escape_string_warning", + "name": "escape_string_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Terminates session on any error.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/exit_on_error", + "name": "exit_on_error", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the number of digits displayed for floating-point values.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "-15-3", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/extra_float_digits", + "name": "extra_float_digits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Forces use of parallel query facilities.", + "defaultValue": "off", + "dataType": "Enumeration", + "allowedValues": "off,on,regress", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/force_parallel_mode", + "name": "force_parallel_mode", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which subqueries are not collapsed.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/from_collapse_limit", + "name": "from_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables genetic query optimization.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo", + "name": "geqo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5", + "description": "GEQO: effort is used to set the default for other GEQO parameters.", + "defaultValue": "5", + "dataType": "Integer", + "allowedValues": "1-10", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_effort", + "name": "geqo_effort", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of iterations of the algorithm.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_generations", + "name": "geqo_generations", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: number of individuals in the population.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_pool_size", + "name": "geqo_pool_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "GEQO: seed for random path selection.", + "defaultValue": "0", + "dataType": "Numeric", + "allowedValues": "0-1", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_seed", + "name": "geqo_seed", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "GEQO: selective pressure within the population.", + "defaultValue": "2", + "dataType": "Numeric", + "allowedValues": "1.5-2", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_selection_bias", + "name": "geqo_selection_bias", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "12", + "description": "Sets the threshold of FROM items beyond which GEQO is used.", + "defaultValue": "12", + "dataType": "Integer", + "allowedValues": "2-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/geqo_threshold", + "name": "geqo_threshold", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed result for exact search by GIN.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_fuzzy_search_limit", + "name": "gin_fuzzy_search_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4096", + "description": "Sets the maximum size of the pending list for GIN index.", + "defaultValue": "4096", + "dataType": "Integer", + "allowedValues": "64-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/gin_pending_list_limit", + "name": "gin_pending_list_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration of any idling transaction.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/idle_in_transaction_session_timeout", + "name": "idle_in_transaction_session_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "postgres", + "description": "Sets the display format for interval values.", + "defaultValue": "postgres", + "dataType": "Enumeration", + "allowedValues": "postgres,postgres_verbose,sql_standard,iso_8601", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/IntervalStyle", + "name": "IntervalStyle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the FROM-list size beyond which JOIN constructs are not flattened.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/join_collapse_limit", + "name": "join_collapse_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting monetary amounts.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_monetary", + "name": "lc_monetary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "en_US.utf-8", + "description": "Sets the locale for formatting numbers.", + "defaultValue": "en_US.utf-8", + "dataType": "String", + "allowedValues": "[A-Za-z0-9._ -]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lc_numeric", + "name": "lc_numeric", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Enables backward compatibility mode for privilege checks on large objects.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lo_compat_privileges", + "name": "lo_compat_privileges", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any wait for a lock. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/lock_timeout", + "name": "lock_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time above which autovacuum actions will be logged.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_autovacuum_min_duration", + "name": "log_autovacuum_min_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each checkpoint.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_checkpoints", + "name": "log_checkpoints", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Logs each successful connection.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_connections", + "name": "log_connections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "stderr", + "description": "Sets the destination for server log output.", + "defaultValue": "stderr", + "dataType": "Enumeration", + "allowedValues": "stderr,csvlog", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_destination", + "name": "log_destination", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs end of a session, including duration.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_disconnections", + "name": "log_disconnections", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs the duration of each completed SQL statement.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_duration", + "name": "log_duration", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "default", + "description": "Sets the verbosity of logged messages.", + "defaultValue": "default", + "dataType": "Enumeration", + "allowedValues": "terse,default,verbose", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_error_verbosity", + "name": "log_error_verbosity", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs long lock waits.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_lock_waits", + "name": "log_lock_waits", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Sets the minimum execution time (in milliseconds) above which statements will be logged. -1 disables logging statement durations.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_duration_statement", + "name": "log_min_duration_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "error", + "description": "Causes all statements generating error at or above this level to be logged.", + "defaultValue": "error", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_error_statement", + "name": "log_min_error_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "warning", + "description": "Sets the message levels that are logged.", + "defaultValue": "warning", + "dataType": "Enumeration", + "allowedValues": "debug5,debug4,debug3,debug2,debug1,info,notice,warning,error,log,fatal,panic", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_min_messages", + "name": "log_min_messages", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Logs each replication command.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_replication_commands", + "name": "log_replication_commands", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Sets the type of statements logged.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,ddl,mod,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement", + "name": "log_statement", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "For each query, writes cumulative performance statistics to the server log.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_statement_stats", + "name": "log_statement_stats", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-1", + "description": "Logs the use of temporary files larger than this number of kilobytes.", + "defaultValue": "-1", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/log_temp_files", + "name": "log_temp_files", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "332800", + "description": "Sets the maximum memory to be used for maintenance operations.", + "defaultValue": "332800", + "dataType": "Integer", + "allowedValues": "1024-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/maintenance_work_mem", + "name": "maintenance_work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "8", + "description": "Sets the maximum number of parallel workers than can be active at one time.", + "defaultValue": "8", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers", + "name": "max_parallel_workers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of parallel processes per executor node.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-1024", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_parallel_workers_per_gather", + "name": "max_parallel_workers_per_gather", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Sets the maximum number of predicate-locked tuples per page.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_page", + "name": "max_pred_locks_per_page", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "-2", + "description": "Sets the maximum number of predicate-locked pages and tuples per relation.", + "defaultValue": "-2", + "dataType": "Integer", + "allowedValues": "-2147483648-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_pred_locks_per_relation", + "name": "max_pred_locks_per_relation", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing archived WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_archive_delay", + "name": "max_standby_archive_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30000", + "description": "Sets the maximum delay before canceling queries when a hot standby server is processing streamed WAL data.", + "defaultValue": "30000", + "dataType": "Integer", + "allowedValues": "-1-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_standby_streaming_delay", + "name": "max_standby_streaming_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "2", + "description": "Maximum number of table synchronization workers per subscription.", + "defaultValue": "2", + "dataType": "Integer", + "allowedValues": "0-262143", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_sync_workers_per_subscription", + "name": "max_sync_workers_per_subscription", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the WAL size that triggers a checkpoint.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/max_wal_size", + "name": "max_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "64", + "description": "Sets the minimum amount of index data for a parallel scan.", + "defaultValue": "64", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_index_scan_size", + "name": "min_parallel_index_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the minimum amount of table data for a parallel scan.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "0-715827882", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_parallel_table_scan_size", + "name": "min_parallel_table_scan_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "80", + "description": "Sets the minimum size to shrink the WAL to.", + "defaultValue": "80", + "dataType": "Integer", + "allowedValues": "2-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/min_wal_size", + "name": "min_wal_size", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Emits a warning for constructs that changed meaning since PostgreSQL 9.4.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/operator_precedence_warning", + "name": "operator_precedence_warning", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1000", + "description": "Sets the planner's estimate of the cost of starting up worker processes for parallel query.", + "defaultValue": "1000", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_setup_cost", + "name": "parallel_setup_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0.1", + "description": "Sets the planner's estimate of the cost of passing each tuple (row) from worker to master backend.", + "defaultValue": "0.1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/parallel_tuple_cost", + "name": "parallel_tuple_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "When generating SQL fragments, quotes all identifiers.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/quote_all_identifiers", + "name": "quote_all_identifiers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "4", + "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", + "defaultValue": "4", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/random_page_cost", + "name": "random_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables row security.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/row_security", + "name": "row_security", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "\"$user\", public", + "description": "Sets the schema search order for names that are not schema-qualified.", + "defaultValue": "\"$user\", public", + "dataType": "String", + "allowedValues": "[A-Za-z.\"$, ]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/search_path", + "name": "search_path", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", + "defaultValue": "1", + "dataType": "Numeric", + "allowedValues": "0-1.79769e+308", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/seq_page_cost", + "name": "seq_page_cost", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "origin", + "description": "Sets the session's behavior for triggers and rewrite rules.", + "defaultValue": "origin", + "dataType": "Enumeration", + "allowedValues": "origin,replica,local", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/session_replication_role", + "name": "session_replication_role", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Causes '...' strings to treat backslashes literally.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/standard_conforming_strings", + "name": "standard_conforming_strings", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Sets the maximum allowed duration (in milliseconds) of any statement. 0 turns this off.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/statement_timeout", + "name": "statement_timeout", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Enables synchronized sequential scans.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronize_seqscans", + "name": "synchronize_seqscans", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Sets the current transaction's synchronization level.", + "defaultValue": "on", + "dataType": "Enumeration", + "allowedValues": "local,remote_write,on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/synchronous_commit", + "name": "synchronous_commit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "9", + "description": "Maximum number of TCP keepalive retransmits.", + "defaultValue": "9", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_count", + "name": "tcp_keepalives_count", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "120", + "description": "Time between issuing TCP keepalives.", + "defaultValue": "120", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_idle", + "name": "tcp_keepalives_idle", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "30", + "description": "Time between TCP keepalive retransmits.", + "defaultValue": "30", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/tcp_keepalives_interval", + "name": "tcp_keepalives_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1024", + "description": "Sets the maximum number of temporary buffers used by each database session.", + "defaultValue": "1024", + "dataType": "Integer", + "allowedValues": "100-1073741823", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_buffers", + "name": "temp_buffers", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "", + "description": "Sets the tablespace(s) to use for temporary tables and sort files.", + "defaultValue": "", + "dataType": "String", + "allowedValues": "[A-Za-z._]*", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/temp_tablespaces", + "name": "temp_tablespaces", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "UTC", + "description": "Sets the time zone for displaying and interpreting time stamps.", + "defaultValue": "UTC", + "dataType": "String", + "allowedValues": "[A-Za-z0-9/+_-]+", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/TimeZone", + "name": "TimeZone", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects information about executing commands.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_activities", + "name": "track_activities", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "on", + "description": "Collects statistics on database activity.", + "defaultValue": "on", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_counts", + "name": "track_counts", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "none", + "description": "Collects function-level statistics on database activity.", + "defaultValue": "none", + "dataType": "Enumeration", + "allowedValues": "none,pl,all", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_functions", + "name": "track_functions", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Collects timing statistics for database I/O activity.", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/track_io_timing", + "name": "track_io_timing", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "off", + "description": "Treats \"expr=NULL\" as \"expr IS NULL\".", + "defaultValue": "off", + "dataType": "Boolean", + "allowedValues": "on,off", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/transform_null_equals", + "name": "transform_null_equals", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Vacuum cost delay in milliseconds.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-100", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_delay", + "name": "vacuum_cost_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Vacuum cost amount available before napping.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_limit", + "name": "vacuum_cost_limit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "20", + "description": "Vacuum cost for a page dirtied by vacuum.", + "defaultValue": "20", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_dirty", + "name": "vacuum_cost_page_dirty", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "1", + "description": "Vacuum cost for a page found in the buffer cache.", + "defaultValue": "1", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_hit", + "name": "vacuum_cost_page_hit", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Vacuum cost for a page not found in the buffer cache.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_cost_page_miss", + "name": "vacuum_cost_page_miss", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "0", + "description": "Number of transactions by which VACUUM and HOT cleanup should be deferred, if any.", + "defaultValue": "0", + "dataType": "Integer", + "allowedValues": "0-1000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_defer_cleanup_age", + "name": "vacuum_defer_cleanup_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "50000000", + "description": "Minimum age at which VACUUM should freeze a table row.", + "defaultValue": "50000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_min_age", + "name": "vacuum_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_freeze_table_age", + "name": "vacuum_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "5000000", + "description": "Minimum age at which VACUUM should freeze a MultiXactId in a table row.", + "defaultValue": "5000000", + "dataType": "Integer", + "allowedValues": "0-1000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_min_age", + "name": "vacuum_multixact_freeze_min_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "150000000", + "description": "Multixact age at which VACUUM should scan whole table to freeze tuples.", + "defaultValue": "150000000", + "dataType": "Integer", + "allowedValues": "0-2000000000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/vacuum_multixact_freeze_table_age", + "name": "vacuum_multixact_freeze_table_age", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "10", + "description": "Sets the maximum interval between WAL receiver status reports to the primary.", + "defaultValue": "10", + "dataType": "Integer", + "allowedValues": "0-2147483", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_receiver_status_interval", + "name": "wal_receiver_status_interval", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "200", + "description": "Time between WAL flushes performed in the WAL writer.", + "defaultValue": "200", + "dataType": "Integer", + "allowedValues": "1-10000", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_delay", + "name": "wal_writer_delay", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "128", + "description": "Amount of WAL written out by WAL writer that triggers a flush.", + "defaultValue": "128", + "dataType": "Integer", + "allowedValues": "0-2147483647", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/wal_writer_flush_after", + "name": "wal_writer_flush_after", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "115712", + "description": "Sets the amount of memory to be used by internal sort operations and hash tables before writing to temporary disk files.", + "defaultValue": "115712", + "dataType": "Integer", + "allowedValues": "4096-2097151", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/work_mem", + "name": "work_mem", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "base64", + "description": "Sets how binary values are to be encoded in XML.", + "defaultValue": "base64", + "dataType": "Enumeration", + "allowedValues": "base64,hex", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmlbinary", + "name": "xmlbinary", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + }, + { + "properties": { + "value": "content", + "description": "Sets whether XML data in implicit parsing and serialization operations is to be considered as documents or content fragments.", + "defaultValue": "content", + "dataType": "Enumeration", + "allowedValues": "content,document", + "source": "system-default" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/xmloption", + "name": "xmloption", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json new file mode 100644 index 000000000000..b89bd87d1359 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ConfigurationUpdate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "serverName": "testserver", + "configurationName": "event_scheduler", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "value": "on", + "source": "user-override" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "201": { + "body": { + "properties": { + "value": "ON", + "description": "Indicates the status of the Event Scheduler.", + "defaultValue": "OFF", + "dataType": "Enumeration", + "allowedValues": "ON,OFF,DISABLED", + "source": "user-override" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/configurations/event_scheduler", + "name": "event_scheduler", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/configurations" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json new file mode 100644 index 000000000000..51ef07630ae0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json new file mode 100644 index 000000000000..5f8b1d3159d3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json new file mode 100644 index 000000000000..d4983f9f3c85 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabaseGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "databaseName": "db1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json new file mode 100644 index 000000000000..449bd646fe7b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/DatabasesListByServer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db1", + "name": "db1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/databases/db2", + "name": "db2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/databases", + "properties": { + "charset": "utf8", + "collation": "en_US.utf8" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..e8eaba3ed0d6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..ca6f8c0e994b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..a5b83aeca6c6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..8f8080d52c88 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff//resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules?api-version=2024-08-01&$top=2&$skiptoken=skiptoken", + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "0.0.0.0", + "endIpAddress": "255.255.255.255" + } + }, + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testserver/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules", + "properties": { + "startIpAddress": "1.0.0.0", + "endIpAddress": "255.0.0.0" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json new file mode 100644 index 000000000000..a779e14c0918 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/GetPrivateDnsZoneSuffix.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": "postgres.database.azure.com" + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json new file mode 100644 index 000000000000..711a4841b62a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LogFilesListByServer.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serverName": "postgresqltestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "sizeInKb": 1, + "createdTime": "0001-01-01T00:00:00+00:00", + "lastModifiedTime": "2018-03-01T06:09:20+00:00", + "type": "slowlog", + "url": "https://wasd2prodwus1afse42.file.core.windows.net/833c99b2f36c47349e5554b903fe0440/serverlogs/postgresql-slow-postgresqltestsvc1-2018022823.log?sv=2015-04-05&sr=f&se=2018-03-01T07%3A12%3A13Z&sp=r" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/postgresqltestsvc1/logFiles/postgresql-slow-postgresqltestsvc1-2018022823.log", + "name": "postgresql-slow-postgresqltestsvc1-2018022823.log", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/logFiles" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json new file mode 100644 index 000000000000..9d0f0f15e0c8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionBackup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "parameters": { + "backupSettings": { + "backupName": "backup1" + }, + "targetDetails": { + "sasUriList": [ + "sasuri" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "datasourceSizeInBytes": 23, + "dataTransferredInBytes": 23, + "backupMetadata": "backupmetadata", + "status": "Running", + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z", + "percentComplete": 100 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/operationResults/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2024-08-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/westcentralus/azureAsyncOperation/ffc80e91-03db-4534-b5de-bacb77aa6a81?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json new file mode 100644 index 000000000000..d0052f12e428 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "backupName": "backup1" + }, + "responses": { + "200": { + "body": { + "properties": { + "backupName": "backup1", + "datasourceSizeInBytes": 21, + "dataTransferredInBytes": 9, + "backupMetadata": "backupMetadata", + "status": "Running", + "percentComplete": 4, + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rgLongTermRetention/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgsqlltrtestserver", + "name": "backup1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/ltrbackupOperations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json new file mode 100644 index 000000000000..45479950d71b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionOperationListByServer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/rgLongTermRetention/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgsqlltrtestserver", + "name": "backup1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/ltrbackupOperations", + "properties": { + "backupName": "backup1", + "datasourceSizeInBytes": 21, + "dataTransferredInBytes": 9, + "backupMetadata": "backupMetadata", + "status": "Running", + "percentComplete": 4, + "startTime": "2023-04-13T01:32:30.128Z", + "endTime": "2023-04-13T01:32:30.128Z" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json new file mode 100644 index 000000000000..1b4488d9bb81 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/LongTermRetentionPreBackup.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "rgLongTermRetention", + "serverName": "pgsqlltrtestserver", + "parameters": { + "backupSettings": { + "backupName": "backup1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "numberOfContainers": 1 + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json new file mode 100644 index 000000000000..61a844350451 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Cancel.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Online", + "parameters": { + "properties": { + "cancel": "True" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "Canceled", + "currentSubStateDetails": { + "currentSubState": "Completed" + } + }, + "migrationMode": "Online", + "migrationWindowEndTimeInUtc": "2023-05-15T07:23:56.3260822Z", + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "postgres" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-05-15T07:22:57.7001251Z", + "migrateRoles": "False", + "sourceDbServerMetadata": { + "location": "eastasia", + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "East Asia", + "sku": { + "name": "Standard_D2ds_v4", + "tier": "Standard_D2ds_v4" + } + } + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json new file mode 100644 index 000000000000..549c98233086 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json new file mode 100644 index 000000000000..7046573af57f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Other_SourceTypes_Validate_Migrate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "testsource:5432@pguser", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "testsource:5432@pguser", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "testsource:5432@pguser", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate", + "sslMode": "Prefer", + "sourceType": "OnPremises" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json new file mode 100644 index 000000000000..ed2e832debc2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_Validate_Only.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True", + "migrationOption": "Validate" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "ValidationInProgress" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json new file mode 100644 index 000000000000..aa3617170cef --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Other_Users.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + }, + "sourceServerUsername": "newadmin@testsource", + "targetServerUsername": "targetadmin" + }, + "migrationMode": "Offline" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "migrationMode": "Offline", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "migrationMode": "Offline", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json new file mode 100644 index 000000000000..549c98233086 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_PrivateEndpoint_Servers.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False", + "migrationInstanceResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testsourcemigration" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json new file mode 100644 index 000000000000..9b8d0b921316 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Create_With_Roles.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "parameters": { + "properties": { + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "secretParameters": { + "adminCredentials": { + "sourceServerPassword": "xxxxxxxx", + "targetServerPassword": "xxxxxxxx" + } + }, + "migrationMode": "Offline", + "migrateRoles": "True", + "overwriteDbsInTarget": "True" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "True" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + }, + "201": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "True" + }, + "tags": { + "key1624": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json new file mode 100644 index 000000000000..29f0dd25b619 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Offline" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json new file mode 100644 index 000000000000..f8e107edac63 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigration" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json new file mode 100644 index 000000000000..681c36dd9edf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationAndMigration.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigrationwithsuccessfulvalidationandmigration" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "f2354e72-2828-4a19-ad20-b4cd9e2673c1", + "currentStatus": { + "state": "Succeeded", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": { + "testdb3": { + "databaseName": "testdb3", + "migrationState": "Succeeded", + "startedOn": "2023-10-12T05:55:28.9955656Z", + "endedOn": "2023-10-12T05:55:49.6813037Z", + "fullLoadErroredTables": 0, + "fullLoadQueuedTables": 0, + "fullLoadLoadingTables": 0, + "fullLoadCompletedTables": 10, + "cdcUpdateCounter": 0, + "cdcDeleteCounter": 0, + "cdcInsertCounter": 0, + "appliedChanges": 0, + "incomingChanges": 0, + "latency": 0 + } + }, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-10-12T05:54:28.0774816Z", + "validationEndTimeInUtc": "2023-10-12T05:55:00.4998326Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "testdb3", + "startedOn": "2023-10-12T05:54:29.5531609Z", + "endedOn": "2023-10-12T05:54:29.8948914Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-12T05:57:30.7364856Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "testdb3" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-12T05:54:15.9991596Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate" + }, + "location": "eastus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationandmigration", + "name": "testmigrationwithsuccessfulvalidationandmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json new file mode 100644 index 000000000000..a7b9cf474546 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationButMigrationFailure.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationMode": "Offline", + "migrationName": "testmigrationwithsuccessfulvalidationbutmigrationfailure" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "da52db29-cfeb-4670-a1ad-683edb14c621", + "currentStatus": { + "state": "Failed", + "error": "testdb6: Collation/Encoding not Supported Error: User defined Collations are present in the source database. Please drop them before retrying the migration. ", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": { + "testdb6": { + "databaseName": "testdb6", + "migrationState": "Failed", + "startedOn": "2023-08-21T13:09:52.9226008Z", + "endedOn": "2023-08-21T13:09:53.2526436Z", + "fullLoadErroredTables": 0, + "fullLoadQueuedTables": 0, + "fullLoadLoadingTables": 0, + "fullLoadCompletedTables": 0, + "cdcUpdateCounter": 0, + "cdcDeleteCounter": 0, + "cdcInsertCounter": 0, + "appliedChanges": 0, + "incomingChanges": 0, + "latency": 0, + "message": "Collation/Encoding not Supported Error: User defined Collations are present in the source database. Please drop them before retrying the migration." + } + }, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-08-21T13:04:21.6230786Z", + "validationEndTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "address_standardizer", + "startedOn": "2023-08-21T13:04:24.5659891+00:00", + "endedOn": "2023-08-21T13:04:24.5659891+00:00", + "summary": [ + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/source-rg/providers/Microsoft.DBforPostgreSQL/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget", + "dbsToMigrate": [ + "testdb6" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-08-21T13:04:24.5659891Z", + "sourceDbServerMetadata": { + "location": "eastus2", + "storageMb": 102400, + "sku": {} + }, + "targetDbServerMetadata": { + "location": "East US 2", + "storageMb": 131072, + "sku": { + "name": "Standard_D2ds_v4", + "tier": "Standard_D2ds_v4" + } + }, + "migrateRoles": "False", + "migrationOption": "ValidateAndMigrate" + }, + "location": "eastus2", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationbutmigrationfailure", + "name": "testmigrationwithsuccessfulvalidationbutmigrationfailure", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json new file mode 100644 index 000000000000..34c1e47cb3a6 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithSuccessfulValidationOnly.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigrationwithsuccessfulvalidationonly" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "77840327-7be8-44b8-adc0-af0ccccfeb36", + "currentStatus": { + "state": "Succeeded", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": {}, + "validationDetails": { + "status": "Succeeded", + "validationStartTimeInUtc": "2023-10-16T05:29:35.634943Z", + "validationEndTimeInUtc": "2023-10-16T05:29:39.6663198Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "UnknownCollationTest", + "startedOn": "2023-10-16T05:29:38.904366Z", + "endedOn": "2023-10-16T05:29:39.2488086Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-16T05:30:05.8854373Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "UnknownCollationTest" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-16T05:28:58.7751329Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigrationwithsuccessfulvalidationonly", + "name": "testmigrationwithsuccessfulvalidationonly", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json new file mode 100644 index 000000000000..e2e93f79f6a4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_GetMigrationWithValidationFailures.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigrationwithvalidationfailure" + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "a3e2d3cc-b139-4201-9431-e4f3003140fd", + "currentStatus": { + "state": "ValidationFailed", + "currentSubStateDetails": { + "currentSubState": "Completed", + "dbDetails": {}, + "validationDetails": { + "status": "Failed", + "validationStartTimeInUtc": "2023-10-17T19:19:59.91782Z", + "validationEndTimeInUtc": "2023-10-17T19:20:33.1368946Z", + "serverLevelValidationDetails": [ + { + "type": "AuthenticationAndConnectivityValidation", + "state": "Succeeded" + }, + { + "type": "SourceVersionValidation", + "state": "Succeeded" + }, + { + "type": "ServerParametersValidation", + "state": "Succeeded" + } + ], + "dbLevelValidationDetails": [ + { + "databaseName": "c.utf-8", + "startedOn": "2023-10-17T19:20:01.830801Z", + "endedOn": "2023-10-17T19:20:02.810871Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Failed", + "messages": [ + { + "state": "Failed", + "message": "Unsupported Extension. Single to Flex migration tool does not support migration of databases having postgres_fdw extension. Consider performing the migration through other migration tools such as pg_dump/pg_restore (https://aka.ms/migrate-using-pgdump-restore)" + } + ] + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "postgres", + "startedOn": "2023-10-17T19:20:01.8309442Z", + "endedOn": "2023-10-17T19:20:02.8109414Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "readme_to_recover", + "startedOn": "2023-10-17T19:20:01.8309447Z", + "endedOn": "2023-10-17T19:20:02.8109415Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + }, + { + "type": "CollationsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testdb1", + "startedOn": "2023-10-17T19:20:01.8309448Z", + "endedOn": "2023-10-17T19:20:02.8109416Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testdb2", + "startedOn": "2023-10-17T19:20:01.830945Z", + "endedOn": "2023-10-17T19:20:02.8109418Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "testSchema", + "startedOn": "2023-10-17T19:20:01.8309464Z", + "endedOn": "2023-10-17T19:20:02.8109419Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Succeeded" + } + ] + }, + { + "databaseName": "UnknownCollationTest", + "startedOn": "2023-10-17T19:20:01.8309465Z", + "endedOn": "2023-10-17T19:20:02.810942Z", + "summary": [ + { + "type": "SchemaValidation", + "state": "Succeeded" + }, + { + "type": "ExtensionsValidation", + "state": "Failed", + "messages": [ + { + "state": "Failed", + "message": "Unsupported Extension. Single to Flex migration tool does not support migration of databases having postgres_fdw extension. Consider performing the migration through other migration tools such as pg_dump/pg_restore (https://aka.ms/migrate-using-pgdump-restore)" + } + ] + } + ] + } + ] + } + } + }, + "migrationMode": "Offline", + "migrationWindowEndTimeInUtc": "2023-10-17T19:21:00.0434143Z", + "sourceDbServerResourceId": "20.228.214.65:5432@postgres", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget", + "dbsToMigrate": [ + "c.utf-8", + "postgres", + "readme_to_recover", + "testdb1", + "testdb2", + "testSchema", + "UnknownCollationTest" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "True", + "migrationWindowStartTimeInUtc": "2023-10-17T19:19:47.4488908Z", + "triggerCutover": "True", + "migrateRoles": "False", + "migrationOption": "Validate" + }, + "location": "East US", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/testtarget/migrations/testmigrationwithvalidationfailure", + "name": "testmigrationwithvalidationfailure", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json new file mode 100644 index 000000000000..71ba3ef6acd8 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_ListByTargetServer.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationListFilter": "All" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "False", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json new file mode 100644 index 000000000000..291832a2720b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/Migrations_Update.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "testrg", + "targetDbServerName": "testtarget", + "migrationName": "testmigration", + "migrationMode": "Offline", + "parameters": { + "properties": { + "setupLogicalReplicationOnSourceDbIfNeeded": "True" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "migrationId": "d3ceacbb-a5fd-43dc-a9db-6022b5154856", + "currentStatus": { + "state": "InProgress", + "error": "", + "currentSubStateDetails": { + "currentSubState": "PerformingPreRequisiteSteps" + } + }, + "sourceDbServerMetadata": { + "location": "westus", + "version": "10", + "storageMb": 1024, + "sku": { + "name": "B_Gen5_2", + "tier": "Basic" + } + }, + "targetDbServerMetadata": { + "location": "westus", + "version": "11", + "storageMb": 2048, + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + } + }, + "sourceDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/servers/testsource", + "targetDbServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget", + "dbsToMigrate": [ + "db1", + "db2", + "db3", + "db4" + ], + "setupLogicalReplicationOnSourceDbIfNeeded": "True", + "overwriteDbsInTarget": "False", + "migrationWindowStartTimeInUtc": "2021-05-06T16:05:58.895Z", + "startDataMigration": "False", + "triggerCutover": "False", + "migrateRoles": "False" + }, + "location": "westus", + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBForPostgreSql/flexibleServers/testtarget/migrations/testmigration", + "name": "testmigration", + "type": "Microsoft.DBForPostgreSql/flexibleServers/migrations" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json new file mode 100644 index 000000000000..3f20a67540e2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "List/Get PostgreSQL Servers", + "description": "Return the list of servers or gets the properties for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Create/Update PostgreSQL Server", + "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "PostgreSQL Server", + "operation": "Delete PostgreSQL Server", + "description": "Deletes an existing server." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "List/Get Firewall Rules", + "description": "Return the list of firewall rules for a server or gets the properties for the specified firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Create/Update Firewall Rule", + "description": "Creates a firewall rule with the specified parameters or update an existing rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/firewallRules/delete", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Firewall Rules", + "operation": "Delete Firewall Rule", + "description": "Deletes an existing firewall rule." + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Get database metric definitions", + "description": "Return types of metrics that are available for databases" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "cpu_percent", + "displayName": "CPU percent", + "displayDescription": "CPU percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "compute_limit", + "displayName": "Compute Unit limit", + "displayDescription": "Compute Unit limit", + "unit": "Count", + "aggregationType": "Average" + }, + { + "name": "compute_consumption_percent", + "displayName": "Compute Unit percentage", + "displayDescription": "Compute Unit percentage", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "memory_percent", + "displayName": "Memory percent", + "displayDescription": "Memory percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "io_consumption_percent", + "displayName": "IO percent", + "displayDescription": "IO percent", + "unit": "Percent", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "storage_percent", + "displayName": "Storage percentage", + "displayDescription": "Storage percentage", + "unit": "Percent", + "aggregationType": "Average" + }, + { + "name": "storage_used", + "displayName": "Storage used", + "displayDescription": "Storage used", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "storage_limit", + "displayName": "Storage limit", + "displayDescription": "Storage limit", + "unit": "Bytes", + "aggregationType": "Average" + }, + { + "name": "active_connections", + "displayName": "Total active connections", + "displayDescription": "Total active connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + }, + { + "name": "connections_failed", + "displayName": "Total failed connections", + "displayDescription": "Total failed connections", + "unit": "Count", + "aggregationType": "Average", + "fillGapWithZero": true + } + ] + } + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Read diagnostic setting", + "description": "Gets the disagnostic setting for the resource" + } + }, + { + "name": "Microsoft.DBforPostgreSQL/flexibleServers/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft DB for PostgreSQL", + "resource": "Database Metric Definition", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..0713d9153e76 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..ab1d1bf2c879 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json new file mode 100644 index 000000000000..c7ce34bf9c64 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name-2.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..8d6f796d91fe --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateEndpointConnectionUpdate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "privateEndpointConnectionName": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "api-version": "2024-08-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateEndpointConnections/private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "private-endpoint-connection-name.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections", + "properties": { + "provisioningState": "Ready", + "privateEndpoint": { + "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name" + }, + "groupIds": [ + "postgresqlServer" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json new file mode 100644 index 000000000000..7a0e05d8fea3 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "groupName": "plr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateLinkResources/plr", + "name": "plr", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateLinkResources", + "properties": { + "groupId": "postgresqlServer", + "requiredMembers": [ + "postgresqlServer" + ], + "requiredZoneNames": [ + "privatelink.meru.com" + ] + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json new file mode 100644 index 000000000000..ab8f7af523a7 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PrivateLinkResourcesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "Default", + "serverName": "test-svr", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/flexibleServers/test-svr/privateLinkResources/plr", + "name": "plr", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateLinkResources", + "properties": { + "groupId": "postgresqlServer", + "requiredMembers": [ + "postgresqlServer" + ], + "requiredZoneNames": [ + "privatelink.meru.com" + ] + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json new file mode 100644 index 000000000000..e457d257474f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedStandaloneServer.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "standalone", + "promoteOption": "forced" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "None", + "capacity": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json new file mode 100644 index 000000000000..687db5fe6629 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsForcedSwitchover.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "switchover", + "promoteOption": "forced" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "Primary", + "capacity": 5 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json new file mode 100644 index 000000000000..036925086d22 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedStandaloneServer.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "standalone", + "promoteOption": "planned" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "None", + "capacity": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json new file mode 100644 index 000000000000..b6225e6163af --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/PromoteReplicaAsPlannedSwitchover.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "serverName": "pgtestsvc4-replica", + "resourceGroupName": "testResourceGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "replica": { + "promoteMode": "switchover", + "promoteOption": "planned" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc4-replica.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replica": { + "role": "Primary", + "capacity": 5 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4-replica", + "name": "pgtestsvc4-replica", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json new file mode 100644 index 000000000000..18c1f4e71a68 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ReplicasListByServer.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "serverName": "sourcepgservername", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json new file mode 100644 index 000000000000..842608f58c5f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCapabilities.json @@ -0,0 +1,2154 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "FlexibleServerCapabilities", + "supportedServerEditions": [ + { + "name": "Burstable", + "defaultSkuName": "Standard_B1ms", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 32768, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_B1ms", + "vCores": 1, + "supportedIops": 640, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2s", + "vCores": 2, + "supportedIops": 1280, + "supportedMemoryPerVcoreMb": 2048, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B2ms", + "vCores": 2, + "supportedIops": 1920, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B4ms", + "vCores": 4, + "supportedIops": 2880, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B8ms", + "vCores": 8, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B12ms", + "vCores": 12, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B16ms", + "vCores": 16, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_B20ms", + "vCores": 20, + "supportedIops": 4320, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "GeneralPurpose", + "defaultSkuName": "Standard_D4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 65536, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_D2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32s_v3", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48s_v3", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64s_v3", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ads_v5", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_D96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 4096, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + }, + { + "name": "MemoryOptimized", + "defaultSkuName": "Standard_E4ads_v5", + "supportedStorageEditions": [ + { + "name": "ManagedDisk", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 120, + "storageSizeMb": 32768, + "defaultIopsTier": "P4", + "supportedIopsTiers": [ + { + "name": "P4", + "iops": 120 + }, + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 240, + "storageSizeMb": 65536, + "defaultIopsTier": "P6", + "supportedIopsTiers": [ + { + "name": "P6", + "iops": 240 + }, + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 500, + "storageSizeMb": 131072, + "defaultIopsTier": "P10", + "supportedIopsTiers": [ + { + "name": "P10", + "iops": 500 + }, + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 1100, + "storageSizeMb": 262144, + "defaultIopsTier": "P15", + "supportedIopsTiers": [ + { + "name": "P15", + "iops": 1100 + }, + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 2300, + "storageSizeMb": 524288, + "defaultIopsTier": "P20", + "supportedIopsTiers": [ + { + "name": "P20", + "iops": 2300 + }, + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 5000, + "storageSizeMb": 1048576, + "defaultIopsTier": "P30", + "supportedIopsTiers": [ + { + "name": "P30", + "iops": 5000 + }, + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 2097152, + "defaultIopsTier": "P40", + "supportedIopsTiers": [ + { + "name": "P40", + "iops": 7500 + }, + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4193280, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 7500, + "storageSizeMb": 4194304, + "defaultIopsTier": "P50", + "supportedIopsTiers": [ + { + "name": "P50", + "iops": 7500 + } + ] + }, + { + "supportedIops": 16000, + "storageSizeMb": 8388608, + "defaultIopsTier": "P60", + "supportedIopsTiers": [ + { + "name": "P60", + "iops": 16000 + }, + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 18000, + "storageSizeMb": 16777216, + "defaultIopsTier": "P70", + "supportedIopsTiers": [ + { + "name": "P70", + "iops": 18000 + }, + { + "name": "P80", + "iops": 20000 + } + ] + }, + { + "supportedIops": 20000, + "storageSizeMb": 33553408, + "defaultIopsTier": "P80", + "supportedIopsTiers": [ + { + "name": "P80", + "iops": 20000 + } + ] + } + ] + }, + { + "name": "ManagedDiskV2", + "defaultStorageSizeMb": 131072, + "supportedStorageMb": [ + { + "supportedIops": 3000, + "supportedMaximumIops": 80000, + "storageSizeMb": 32768, + "maximumStorageSizeMb": 67108864, + "supportedThroughput": 125, + "supportedMaximumThroughput": 1200, + "defaultIopsTier": "None", + "supportedIopsTiers": [ + { + "name": "None", + "iops": 0 + } + ] + } + ] + } + ], + "supportedServerSkus": [ + { + "name": "Standard_E2s_v3", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4s_v3", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8s_v3", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16s_v3", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32s_v3", + "vCores": 32, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48s_v3", + "vCores": 48, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64s_v3", + "vCores": 64, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v4", + "vCores": 2, + "supportedIops": 3200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v4", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v4", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v4", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v4", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v4", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v4", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v4", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 6912, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ads_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ads_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ads_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ads_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ads_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ads_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ads_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ads_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ads_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E2ds_v5", + "vCores": 2, + "supportedIops": 3750, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E4ds_v5", + "vCores": 4, + "supportedIops": 6400, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E8ds_v5", + "vCores": 8, + "supportedIops": 12800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E16ds_v5", + "vCores": 16, + "supportedIops": 25600, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E20ds_v5", + "vCores": 20, + "supportedIops": 32000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E32ds_v5", + "vCores": 32, + "supportedIops": 51200, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E48ds_v5", + "vCores": 48, + "supportedIops": 76800, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E64ds_v5", + "vCores": 64, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 8192, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + }, + { + "name": "Standard_E96ds_v5", + "vCores": 96, + "supportedIops": 80000, + "supportedMemoryPerVcoreMb": 7168, + "supportedZones": [ + "1", + "2", + "3" + ], + "supportedHaMode": [ + "SameZone", + "ZoneRedundant" + ] + } + ] + } + ], + "supportedServerVersions": [ + { + "name": "11", + "supportedVersionsToUpgrade": [ + "12", + "13", + "14", + "15", + "16" + ] + }, + { + "name": "12", + "supportedVersionsToUpgrade": [ + "13", + "14", + "15", + "16" + ] + }, + { + "name": "13", + "supportedVersionsToUpgrade": [ + "14", + "15", + "16" + ] + }, + { + "name": "14", + "supportedVersionsToUpgrade": [ + "15", + "16" + ] + }, + { + "name": "15", + "supportedVersionsToUpgrade": [ + "16" + ] + }, + { + "name": "16", + "supportedVersionsToUpgrade": [] + } + ], + "fastProvisioningSupported": "Enabled", + "supportedFastProvisioningEditions": [ + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "12", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "13", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "14", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b1ms", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "Burstable", + "supportedSku": "standard_b2s", + "supportedStorageGb": 32, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2s_v3", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "GeneralPurpose", + "supportedSku": "standard_d2ds_v4", + "supportedStorageGb": 128, + "supportedServerVersions": "15", + "serverCount": 0 + }, + { + "supportedTier": "MemoryOptimized", + "supportedSku": "standard_e2ds_v4", + "supportedStorageGb": 512, + "supportedServerVersions": "15", + "serverCount": 0 + } + ], + "geoBackupSupported": "Enabled", + "zoneRedundantHaSupported": "Enabled", + "zoneRedundantHaAndGeoBackupSupported": "Enabled", + "storageAutoGrowthSupported": "Enabled", + "onlineResizeSupported": "Enabled", + "restricted": "Disabled" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json new file mode 100644 index 000000000000..e44426b5557d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreate.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..beee3658c5f9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateGeoRestoreWithDataEncryptionEnabled.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "serverName": "pgtestsvc5geo", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "eastus", + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {}, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "createMode": "GeoRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5geo.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5geo", + "name": "pgtestsvc5geo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5geo.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5geo", + "name": "pgtestsvc5geo", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..45e8878b9d92 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "serverName": "pgtestsvc5", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "PointInTimeRestore", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "name": "pgtestsvc5", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json new file mode 100644 index 000000000000..a3a0cb692979 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReplica.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "serverName": "pgtestsvc5rep", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "createMode": "Replica", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "pointInTimeUTC": "2021-06-27T00:04:59.4078005+00:00", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "", + "geoBackupUserAssignedIdentityId": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5rep.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/sourcepgservername", + "replicationRole": "AsyncReplica", + "replicaCapacity": 0, + "replica": { + "role": "AsyncReplica", + "capacity": 0, + "replicationState": "Active" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5rep", + "name": "pgtestsvc5rep", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json new file mode 100644 index 000000000000..5ebe9a0c36c4 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateReviveDropped.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "serverName": "pgtestsvc5-rev", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "properties": { + "createMode": "ReviveDropped", + "sourceServerResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5", + "pointInTimeUTC": "2023-04-27T00:04:59.4078005+00:00" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5-rev.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Primary", + "replicaCapacity": 0 + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5-rev", + "name": "pgtestsvc5-rev", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc5-rev.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "2", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-27T00:28:17.7279547+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "replicationRole": "Primary", + "replicaCapacity": 0 + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc5-rev", + "name": "pgtestsvc5-rev", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json new file mode 100644 index 000000000000..278791298a69 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithAadAuthEnabled.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..8f2a4e4c1be9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerCreateWithDataEncryptionEnabled.json @@ -0,0 +1,194 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D4s_v3" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "availabilityZone": "1", + "createMode": "Create", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "", + "geoBackupUserAssignedIdentityId": "" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled" + }, + "network": { + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourcegroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant" + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:08:06.7197478+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json new file mode 100644 index 000000000000..398bce38088f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json new file mode 100644 index 000000000000..f88efbd46832 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json new file mode 100644 index 000000000000..344a7184cd58 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithPrivateEndpoints.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "serverName": "pgtestsvc2", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc2.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:07:25.8166567+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + }, + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/pe-test-rg/providers/Microsoft.Network/privateEndpoints/asdfasdfa" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + }, + "groupIds": [ + "postgresqlServer" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2/privateEndpointConnections/asdfasdfa.40c899c7-5847-493e-9c9e-d0a0c90aaf92", + "name": "asdfasdfa.40c899c7-5847-493e-9c9e-d0a0c90aaf92", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/privateEndpointConnections" + } + ] + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc2", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..6eea644856cb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerGetWithVnet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json new file mode 100644 index 000000000000..1a5aaf01c5eb --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerList.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-08-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Enabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "eastus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..ef02ebfb109c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerListByResourceGroup.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "nextLink": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers?api-version=2024-08-01&$top=3&$skiptoken=skiptoken", + "value": [ + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + }, + { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "pgtestsvc1.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T23:15:38.8131437+00:00" + }, + "network": { + "publicNetworkAccess": "Enabled" + }, + "highAvailability": { + "mode": "Disabled", + "state": "NotEnabled" + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc1", + "name": "pgtestsvc1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json new file mode 100644 index 000000000000..6f81de8ca3b2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerRestartWithFailover.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "restartWithFailover": true, + "failoverMode": "ForcedFailover" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json new file mode 100644 index 000000000000..f3b6f105afbc --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerStop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json new file mode 100644 index 000000000000..782bec5adf30 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsCreateOrUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-4799", + "serverName": "threatprotection-6440", + "threatProtectionName": "Default", + "api-version": "2024-08-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json new file mode 100644 index 000000000000..a052d16ad6f9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "threatProtectionName": "Default", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-4799/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-6440/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json new file mode 100644 index 000000000000..054c19e01f64 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerThreatProtectionSettingsListByServer.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "threatprotection-6852", + "serverName": "threatprotection-2080", + "api-version": "2024-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/threatprotection-6852/providers/Microsoft.DBforPostgreSQL/flexibleServers/threatprotection-2080/advancedThreatProtectionSettings/Default", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/advancedThreatProtectionSettings", + "properties": { + "state": "Enabled", + "creationTime": "2023-09-03T04:41:33.937Z" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json new file mode 100644 index 000000000000..874fd6bc1757 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdate.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Enabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json new file mode 100644 index 000000000000..3b7883119d4f --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithAadAuthEnabled.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Enabled", + "passwordAuth": "Enabled", + "tenantId": "tttttt-tttt-tttt-tttt-tttttttttttt" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json new file mode 100644 index 000000000000..786ceea825c1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithCustomerMaintenanceWindow.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "createMode": "Update", + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Disabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Enabled", + "dayOfWeek": 0, + "startHour": 8, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json new file mode 100644 index 000000000000..e9e2eabfd969 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithDataEncryptionEnabled.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "sku": { + "tier": "GeneralPurpose", + "name": "Standard_D8s_v3" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": {}, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": {} + }, + "type": "UserAssigned" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "createMode": "Update", + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity" + }, + "backup": { + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D8s_v3", + "tier": "GeneralPurpose" + }, + "identity": { + "userAssignedIdentities": { + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity-1": { + "principalId": "90008082-e024-4cc3-8fcf-63bcdb9cf6b6", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity": { + "principalId": "0a4e0c6e-7751-4078-ae1f-a477306c11e9", + "clientId": "72f988bf-86f1-41af-91ab-2d7cd011db47" + } + }, + "type": "UserAssigned" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "12", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "dataEncryption": { + "type": "AzureKeyVault", + "primaryKeyURI": "https://test-kv.vault.azure.net/keys/test-key1/77f57315bab34b0189daa113fbc78787", + "primaryUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-usermanagedidentity", + "geoBackupKeyURI": "https://test-geo-kv.vault.azure.net/keys/test-key1/66f57315bab34b0189daa113fbc78787", + "geoBackupUserAssignedIdentityId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testresourcegroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-geo-usermanagedidentity", + "primaryEncryptionKeyStatus": "Valid", + "geoBackupEncryptionKeyStatus": "Valid" + }, + "storage": { + "storageSizeGB": 1024, + "autoGrow": "Disabled", + "tier": "P30", + "iops": 5000 + }, + "backup": { + "backupRetentionDays": 20, + "geoRedundantBackup": "Enabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json new file mode 100644 index 000000000000..fdf825196d26 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/ServerUpdateWithMajorVersionUpgrade.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "properties": { + "createMode": "Update", + "version": "14" + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_D4s_v3", + "tier": "GeneralPurpose" + }, + "properties": { + "fullyQualifiedDomainName": "c7d7483a8ceb.test-private-dns-zone.postgres.database.azure.com", + "version": "14", + "minorVersion": "6", + "administratorLogin": "cloudsa", + "state": "Ready", + "availabilityZone": "1", + "storage": { + "storageSizeGB": 512, + "autoGrow": "Enabled", + "tier": "P20", + "iops": 2300 + }, + "dataEncryption": { + "type": "SystemManaged" + }, + "authConfig": { + "activeDirectoryAuth": "Disabled", + "passwordAuth": "Enabled" + }, + "backup": { + "backupRetentionDays": 7, + "geoRedundantBackup": "Disabled", + "earliestRestoreDate": "2021-05-26T01:16:58.3723361+00:00" + }, + "network": { + "publicNetworkAccess": "Disabled", + "delegatedSubnetResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-vnet-subnet", + "privateDnsZoneArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/privateDnsZones/test-private-dns-zone.postgres.database.azure.com" + }, + "highAvailability": { + "mode": "ZoneRedundant", + "state": "Healthy", + "standbyAvailabilityZone": "2" + }, + "maintenanceWindow": { + "customWindow": "Disabled", + "dayOfWeek": 0, + "startHour": 0, + "startMinute": 0 + } + }, + "location": "westus", + "tags": { + "ElasticServer": "1" + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4", + "name": "pgtestsvc4", + "type": "Microsoft.DBforPostgreSQL/flexibleServers" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json new file mode 100644 index 000000000000..b05b7c4f7278 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointCreate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1", + "parameters": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testPrimary1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "202": { + "content": { + "operation": "ReplicaGroupCreateManagementOperation", + "startTime": "2023-08-07T16:55:22.403Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json new file mode 100644 index 000000000000..e080d654d6e9 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointDelete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1" + }, + "responses": { + "202": { + "content": { + "operation": "VirtualEndpointDropManagementOperation", + "startTime": "2023-10-09T11:55:21.123Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + }, + "204": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json new file mode 100644 index 000000000000..bc386b47741d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointUpdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1", + "parameters": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + }, + "202": { + "content": { + "operation": "ReplicaGroupUpdateManagementOperation", + "startTime": "2023-08-07T16:55:22.403Z" + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01", + "Location": "https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforPostgreSQL/locations/southeastasia/operationResults/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2024-08-01" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json new file mode 100644 index 000000000000..958f21c52d0c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "virtualEndpointName": "pgVirtualEndpoint1" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json new file mode 100644 index 000000000000..690d631c1e7b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualEndpointsListByServer.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpointType": "ReadWrite", + "members": [ + "testReplica1" + ], + "virtualEndpoints": [ + "pgVirtualEndpoint1.reader.postgres.database.azure.com", + "pgVirtualEndpoint1.writer.postgres.database.azure.com" + ] + }, + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforPostgreSQL/flexibleServers/pgtestsvc4/virtualEndpoints/pgVirtualEndpoint1", + "name": "pgVirtualEndpoint1", + "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualEndpoints" + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json new file mode 100644 index 000000000000..ea780f532648 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2024-08-01/examples/VirtualNetworkSubnetUsage.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "locationName": "westus", + "parameters": { + "virtualNetworkArmResourceId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/testvnet" + } + }, + "responses": { + "200": { + "body": { + "delegatedSubnetsUsage": [ + { + "subnetName": "test-subnet-1", + "usage": 2 + }, + { + "subnetName": "test-subnet-2", + "usage": 3 + } + ], + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "location": "westus" + } + } + } +} diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 25f710721f48..a7976abf1690 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -25,20 +25,72 @@ To see additional help and options, run: These are the global settings for the PostgreSQL API. ``` yaml -title: PostgreSQLManagementClient +title: PostgreSQLServerManagementClient description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model. openapi-type: arm -tag: package-flexibleserver-2024-03-01-preview +tag: package-flexibleserver-2024-08-01 ``` ``` yaml $(package-flexibleservers) -tag: package-flexibleserver-2024-03-01-preview +tag: package-flexibleserver-2024-08-01 ``` ``` yaml $(package-singleservers) tag: package-2020-01-01 ``` +### Tag: package-flexibleserver-2024-08-01 + +These settings apply only when `--tag=package-flexibleserver-2024-08-01` is specified on the command line. + +``` yaml $(tag) == 'package-flexibleserver-2024-08-01' +input-file: + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Administrators.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Backups.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Capabilities.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/CheckNameAvailability.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Configuration.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Databases.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/FirewallRules.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/FlexibleServers.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/LongTermRetentionOperation.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Migrations.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Operations.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateDnsZone.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateEndpointConnections.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/PrivateLinkResources.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/Replicas.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerLogs.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ServerStartStopRestart.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/ThreatProtection.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualEndpoints.json + - Microsoft.DBforPostgreSQL/stable/2024-08-01/VirtualNetwork.json +suppressions: + - code: PutResponseCodes + from: PrivateEndpointConnections.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: ThreatProtection.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: ThreatProtection.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPatch + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: VirtualEndpoints.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: PutResponseCodes + from: Backups.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. + - code: ProvisioningStateSpecifiedForLROPut + from: Backups.json + reason: FlexibleServers namespace is already returning 202 as response for PUT. These APIs are under same namespace and hence keeping it as-is. +``` ### Tag: package-flexibleserver-2024-03-preview From b89db98a274e55321fd1aa978bc26a27fd30cd98 Mon Sep 17 00:00:00 2001 From: xudong-an <131921227+xudong-an@users.noreply.github.com> Date: Thu, 3 Oct 2024 15:34:13 -0700 Subject: [PATCH 040/101] Add new api version and schema changes for resource manager in new API version 2024-09-01-preview (#30836) * create new preview API version 2024-09-01-preview (just copied, no content change in this commit) * schema changes in new API version 2024-09-01-preview --- .../EligibleChildResources.json | 154 +++ .../RoleAssignmentSchedule.json | 420 ++++++ .../RoleAssignmentScheduleInstance.json | 427 ++++++ .../RoleAssignmentScheduleRequest.json | 642 +++++++++ .../RoleEligibilitySchedule.json | 404 ++++++ .../RoleEligibilityScheduleInstance.json | 403 ++++++ .../RoleEligibilityScheduleRequest.json | 638 +++++++++ .../RoleManagementPolicy.json | 384 ++++++ .../RoleManagementPolicyAssignment.json | 393 ++++++ .../2024-09-01-preview/common-types.json | 500 +++++++ ...elRoleAssignmentScheduleRequestByName.json | 10 + ...lRoleEligibilityScheduleRequestByName.json | 10 + .../examples/DeleteRoleManagementPolicy.json | 11 + .../DeleteRoleManagementPolicyAssignment.json | 11 + .../GetEligibleChildResourcesByScope.json | 25 + .../GetRoleAssignmentScheduleByName.json | 51 + ...tRoleAssignmentScheduleInstanceByName.json | 52 + ...oleAssignmentScheduleInstancesByScope.json | 56 + ...etRoleAssignmentScheduleRequestByName.json | 62 + ...tRoleAssignmentScheduleRequestByScope.json | 66 + .../GetRoleAssignmentSchedulesByScope.json | 55 + .../GetRoleEligibilityScheduleByName.json | 49 + ...RoleEligibilityScheduleInstanceByName.json | 48 + ...leEligibilityScheduleInstancesByScope.json | 52 + ...tRoleEligibilityScheduleRequestByName.json | 62 + ...RoleEligibilityScheduleRequestByScope.json | 66 + .../GetRoleEligibilitySchedulesByScope.json | 53 + ...tRoleManagementPolicyAssignmentByName.json | 394 ++++++ ...RoleManagementPolicyAssignmentByScope.json | 397 ++++++ .../GetRoleManagementPolicyByName.json | 738 +++++++++++ .../GetRoleManagementPolicyByScope.json | 741 +++++++++++ .../PatchPartialRoleManagementPolicy.json | 782 +++++++++++ .../examples/PatchRoleManagementPolicy.json | 1172 +++++++++++++++++ ...leManagementPolicyToEnablePIMOnlyMode.json | 861 ++++++++++++ .../PutRoleAssignmentScheduleRequest.json | 80 ++ .../PutRoleEligibilityScheduleRequest.json | 79 ++ .../PutRoleManagementPolicyAssignment.json | 396 ++++++ ...teRoleAssignmentScheduleRequestByName.json | 80 ++ ...eRoleEligibilityScheduleRequestByName.json | 79 ++ .../authorization/resource-manager/readme.md | 27 +- 40 files changed, 10929 insertions(+), 1 deletion(-) create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json new file mode 100644 index 000000000000..9cc0b83c5b91 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json @@ -0,0 +1,154 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/eligibleChildResources": { + "get": { + "tags": [ + "eligibleChildResources" + ], + "operationId": "EligibleChildResources_Get", + "description": "Get the child resources of a resource on which user has eligible access", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=resourceType+eq+'Subscription' to filter on only resource of type = 'Subscription'. Use $filter=resourceType+eq+'subscription'+or+resourceType+eq+'resourcegroup' to filter on resource of type = 'Subscription' or 'ResourceGroup'" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/EligibleChildResourcesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetEligibleChildResourcesByScope": { + "$ref": "./examples/GetEligibleChildResourcesByScope.json" + } + } + } + } + }, + "definitions": { + "EligibleChildResourcesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EligibleChildResource" + }, + "description": "Eligible child resource list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Eligible child resources list operation result." + }, + "EligibleChildResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource scope Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The resource type." + } + }, + "type": "object", + "description": "Eligible child resource" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json new file mode 100644 index 000000000000..0f781d1c69a7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json @@ -0,0 +1,420 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}": { + "get": { + "tags": [ + "roleAssignmentSchedules" + ], + "operationId": "RoleAssignmentSchedules_Get", + "description": "Get the specified role assignment schedule for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role assignment schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule.", + "schema": { + "$ref": "#/definitions/RoleAssignmentSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleByName": { + "$ref": "./examples/GetRoleAssignmentScheduleByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules": { + "get": { + "tags": [ + "roleAssignmentSchedules" + ], + "operationId": "RoleAssignmentSchedules_ListForScope", + "description": "Gets role assignment schedules for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedules for the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments schedules.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleFilter", + "x-ms-examples": { + "GetRoleAssignmentSchedulesByScope": { + "$ref": "./examples/GetRoleAssignmentSchedulesByScope.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment schedule of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment schedule of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific status." + } + }, + "type": "object", + "description": "Role assignment schedule filter" + }, + "RoleAssignmentScheduleProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleAssignmentScheduleRequestId": { + "type": "string", + "description": "The id of roleAssignmentScheduleRequest used to create this roleAssignmentSchedule" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "The id of roleEligibilitySchedule used to activated this roleAssignmentSchedule" + }, + "assignmentType": { + "type": "string", + "description": "Assignment type of the role assignment schedule", + "enum": [ + "Activated", + "Assigned" + ], + "x-ms-enum": { + "name": "AssignmentType", + "modelAsString": true + } + }, + "memberType": { + "type": "string", + "description": "Membership type of the role assignment schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "description": "The status of the role assignment schedule.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime when role assignment schedule" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime when role assignment schedule" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was created" + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was modified" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role assignment schedule properties with scope." + }, + "RoleAssignmentSchedule": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleProperties", + "description": "Role assignment schedule properties." + } + }, + "type": "object", + "description": "Role Assignment schedule" + }, + "RoleAssignmentScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentSchedule" + }, + "description": "Role assignment schedule list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json new file mode 100644 index 000000000000..9d8b2d6cd802 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json @@ -0,0 +1,427 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances": { + "get": { + "tags": [ + "roleAssignmentScheduleInstances" + ], + "operationId": "RoleAssignmentScheduleInstances_ListForScope", + "description": "Gets role assignment schedule instances of a role assignment schedule.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns array of role assignment schedule instances.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleInstanceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleInstanceFilter", + "x-ms-examples": { + "GetRoleAssignmentScheduleInstancesByScope": { + "$ref": "./examples/GetRoleAssignmentScheduleInstancesByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}": { + "get": { + "tags": [ + "roleAssignmentScheduleInstances" + ], + "operationId": "RoleAssignmentScheduleInstances_Get", + "description": "Gets the specified role assignment schedule instance.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (hash of schedule name + time) of the role assignment schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule instance.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleInstanceByName": { + "$ref": "./examples/GetRoleAssignmentScheduleInstanceByName.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleInstanceFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role assignment schedule instances of the specific status." + }, + "roleAssignmentScheduleId": { + "type": "string", + "description": "Returns role assignment schedule instances belonging to a specific role assignment schedule." + } + }, + "type": "object", + "description": "Role assignment schedule instance filter" + }, + "RoleAssignmentScheduleInstanceProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleAssignmentScheduleId": { + "type": "string", + "description": "Id of the master role assignment schedule" + }, + "originRoleAssignmentId": { + "type": "string", + "description": "Role Assignment Id in external system" + }, + "status": { + "type": "string", + "description": "The status of the role assignment schedule instance.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The startDateTime of the role assignment schedule instance" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The endDateTime of the role assignment schedule instance" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "roleEligibilityScheduleId used to activate" + }, + "linkedRoleEligibilityScheduleInstanceId": { + "type": "string", + "description": "roleEligibilityScheduleInstanceId linked to this roleAssignmentScheduleInstance" + }, + "assignmentType": { + "type": "string", + "description": "Assignment type of the role assignment schedule", + "enum": [ + "Activated", + "Assigned" + ], + "x-ms-enum": { + "name": "AssignmentType", + "modelAsString": true + } + }, + "memberType": { + "type": "string", + "description": "Membership type of the role assignment schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role assignment schedule was created" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role assignment schedule properties with scope." + }, + "RoleAssignmentScheduleInstance": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule instance type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleInstanceProperties", + "description": "Role assignment schedule instance properties." + } + }, + "type": "object", + "description": "Information about current or upcoming role assignment schedule instance" + }, + "RoleAssignmentScheduleInstanceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentScheduleInstance" + }, + "description": "Role assignment schedule instance list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule instance list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json new file mode 100644 index 000000000000..c76b2c516b86 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json @@ -0,0 +1,642 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}": { + "put": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Create", + "description": "Creates a role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule request to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "A GUID for the role assignment to create. The name must be unique and different for each role assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Parameters for the role assignment schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleAssignmentScheduleRequest": { + "$ref": "./examples/PutRoleAssignmentScheduleRequest.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Get", + "description": "Get the specified role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment schedule request.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role assignment schedule request to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment schedule request.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/GetRoleAssignmentScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests": { + "get": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_ListForScope", + "description": "Gets role assignment schedule requests for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments schedule requests.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedule requests requested by the current user. Use $filter=asTarget() to return all role assignment schedule requests created for the current user. Use $filter=asApprover() to return all role assignment schedule requests where the current user is an approver." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments schedule requests.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentScheduleRequestFilter", + "x-ms-examples": { + "GetRoleAssignmentScheduleRequestByScope": { + "$ref": "./examples/GetRoleAssignmentScheduleRequestByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}/cancel": { + "post": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Cancel", + "description": "Cancels a pending role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment request to cancel.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment request to cancel." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CancelRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/CancelRoleAssignmentScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}/validate": { + "post": { + "tags": [ + "RoleAssignmentScheduleRequests" + ], + "operationId": "RoleAssignmentScheduleRequests_Validate", + "description": "Validates a new role assignment schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment request to validate.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment request to validate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Parameters for the role assignment schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment request.", + "schema": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ValidateRoleAssignmentScheduleRequestByName": { + "$ref": "./examples/ValidateRoleAssignmentScheduleRequestByName.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentScheduleRequestFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment requests of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role assignment requests of the specific role definition." + }, + "requestorId": { + "type": "string", + "description": "Returns role assignment requests created by specific principal." + }, + "status": { + "type": "string", + "description": "Returns role assignment requests of specific status." + } + }, + "type": "object", + "description": "Role assignment schedule request filter" + }, + "RoleAssignmentScheduleRequestProperties": { + "properties": { + "scope": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "requestType": { + "type": "string", + "description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc", + "enum": [ + "AdminAssign", + "AdminRemove", + "AdminUpdate", + "AdminExtend", + "AdminRenew", + "SelfActivate", + "SelfDeactivate", + "SelfExtend", + "SelfRenew" + ], + "x-ms-enum": { + "name": "RequestType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The status of the role assignment schedule request.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "approvalId": { + "type": "string", + "readOnly": true, + "description": "The approvalId of the role assignment schedule request." + }, + "targetRoleAssignmentScheduleId": { + "type": "string", + "description": "The resultant role assignment schedule id or the role assignment schedule id being updated" + }, + "targetRoleAssignmentScheduleInstanceId": { + "type": "string", + "description": "The role assignment schedule instance id being updated" + }, + "scheduleInfo": { + "properties": { + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime of the role assignment schedule." + }, + "expiration": { + "properties": { + "type": { + "type": "string", + "description": "Type of the role assignment schedule expiration", + "enum": [ + "AfterDuration", + "AfterDateTime", + "NoExpiration" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime of the role assignment schedule." + }, + "duration": { + "type": "string", + "description": "Duration of the role assignment schedule in TimeSpan." + } + }, + "type": "object", + "description": "Expiration of the role assignment schedule" + } + }, + "type": "object", + "description": "Schedule info of the role assignment schedule" + }, + "linkedRoleEligibilityScheduleId": { + "type": "string", + "description": "The linked role eligibility schedule id - to activate an eligibility." + }, + "justification": { + "type": "string", + "description": "Justification for the role assignment" + }, + "ticketInfo": { + "properties": { + "ticketNumber": { + "type": "string", + "description": "Ticket number for the role assignment" + }, + "ticketSystem": { + "type": "string", + "description": "Ticket system name for the role assignment" + } + }, + "type": "object", + "description": "Ticket Info of the role assignment" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "DateTime when role assignment schedule request was created" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "description": "Id of the user who created this request" + }, + "expandedProperties": { + "type": "object", + "readOnly": true, + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "required": [ + "roleDefinitionId", + "principalId", + "requestType" + ], + "type": "object", + "description": "Role assignment schedule request properties with scope." + }, + "RoleAssignmentScheduleRequest": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment schedule request type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentScheduleRequestProperties", + "description": "Role assignment schedule request properties." + } + }, + "type": "object", + "description": "Role Assignment schedule request" + }, + "RoleAssignmentScheduleRequestListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignmentScheduleRequest" + }, + "description": "Role assignment schedule request list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role assignment schedule request list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object", + "description": "Provides role assignment request scope, role definition and principal properties for expansion. " + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json new file mode 100644 index 000000000000..ab3c8230520a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json @@ -0,0 +1,404 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}": { + "get": { + "tags": [ + "roleEligibilitySchedules" + ], + "operationId": "RoleEligibilitySchedules_Get", + "description": "Get the specified role eligibility schedule for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role eligibility schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule.", + "schema": { + "$ref": "#/definitions/RoleEligibilitySchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleByName": { + "$ref": "./examples/GetRoleEligibilityScheduleByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules": { + "get": { + "tags": [ + "roleEligibilitySchedules" + ], + "operationId": "RoleEligibilitySchedules_ListForScope", + "description": "Gets role eligibility schedules for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role eligibility schedules.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleFilter", + "x-ms-examples": { + "GetRoleEligibilitySchedulesByScope": { + "$ref": "./examples/GetRoleEligibilitySchedulesByScope.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility schedule of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility schedule of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role eligibility schedule of the specific status." + } + }, + "type": "object", + "description": "Role eligibility schedule filter" + }, + "RoleEligibilityScheduleProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role eligibility schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleEligibilityScheduleRequestId": { + "type": "string", + "description": "The id of roleEligibilityScheduleRequest used to create this roleAssignmentSchedule" + }, + "memberType": { + "type": "string", + "description": "Membership type of the role eligibility schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "description": "The status of the role eligibility schedule.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime when role eligibility schedule" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime when role eligibility schedule" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was created" + }, + "updatedOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was modified" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role eligibility schedule properties with scope." + }, + "RoleEligibilitySchedule": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleProperties", + "description": "role eligibility schedule properties." + } + }, + "type": "object", + "description": "Role eligibility schedule" + }, + "RoleEligibilityScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilitySchedule" + }, + "description": "role eligibility schedule list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "role eligibility schedule list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json new file mode 100644 index 000000000000..9a170eb605fd --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json @@ -0,0 +1,403 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role eligibility grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances": { + "get": { + "tags": [ + "roleEligibilityScheduleInstances" + ], + "operationId": "RoleEligibilityScheduleInstances_ListForScope", + "description": "Gets role eligibility schedule instances of a role eligibility schedule.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns array of role eligibility schedule instances.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleInstanceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleInstanceFilter", + "x-ms-examples": { + "GetRoleEligibilityScheduleInstancesByScope": { + "$ref": "./examples/GetRoleEligibilityScheduleInstancesByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}": { + "get": { + "tags": [ + "roleEligibilityScheduleInstances" + ], + "operationId": "RoleEligibilityScheduleInstances_Get", + "description": "Gets the specified role eligibility schedule instance.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedules.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (hash of schedule name + time) of the role eligibility schedule to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule instance.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleInstanceByName": { + "$ref": "./examples/GetRoleEligibilityScheduleInstanceByName.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleInstanceFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific role definition." + }, + "status": { + "type": "string", + "description": "Returns role eligibility schedule instances of the specific status." + }, + "roleEligibilityScheduleId": { + "type": "string", + "description": "Returns role eligibility schedule instances belonging to a specific role eligibility schedule." + } + }, + "type": "object", + "description": "Role eligibility schedule instance filter" + }, + "RoleEligibilityScheduleInstanceProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role eligibility schedule scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "roleEligibilityScheduleId": { + "type": "string", + "description": "Id of the master role eligibility schedule" + }, + "status": { + "type": "string", + "description": "The status of the role eligibility schedule instance", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The startDateTime of the role eligibility schedule instance" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The endDateTime of the role eligibility schedule instance" + }, + "memberType": { + "type": "string", + "description": "Membership type of the role eligibility schedule", + "enum": [ + "Inherited", + "Direct", + "Group" + ], + "x-ms-enum": { + "name": "MemberType", + "modelAsString": true + } + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "DateTime when role eligibility schedule was created" + }, + "expandedProperties": { + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "type": "object", + "description": "Role eligibility schedule properties with scope." + }, + "RoleEligibilityScheduleInstance": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule instance type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleInstanceProperties", + "description": "Role eligibility schedule instance properties." + } + }, + "type": "object", + "description": "Information about current or upcoming role eligibility schedule instance" + }, + "RoleEligibilityScheduleInstanceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilityScheduleInstance" + }, + "description": "Role eligibility schedule instance list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role eligibility schedule instance list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json new file mode 100644 index 000000000000..a024670456d7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json @@ -0,0 +1,638 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role eligibility grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}": { + "put": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Create", + "description": "Creates a role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Parameters for the role eligibility schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleEligibilityScheduleRequest": { + "$ref": "./examples/PutRoleEligibilityScheduleRequest.json" + } + } + }, + "get": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Get", + "description": "Get the specified role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule request.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role eligibility schedule request to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/GetRoleEligibilityScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests": { + "get": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_ListForScope", + "description": "Gets role eligibility schedule requests for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility schedule requests.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role eligibility schedule requests.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequestListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleEligibilityScheduleRequestFilter", + "x-ms-examples": { + "GetRoleEligibilityScheduleRequestByScope": { + "$ref": "./examples/GetRoleEligibilityScheduleRequestByScope.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/cancel": { + "post": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Cancel", + "description": "Cancels a pending role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility request to cancel.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility request to cancel." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CancelRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/CancelRoleEligibilityScheduleRequestByName.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}/validate": { + "post": { + "tags": [ + "RoleEligibilityScheduleRequests" + ], + "operationId": "RoleEligibilityScheduleRequests_Validate", + "description": "Validates a new role eligibility schedule request.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role eligibility request to validate.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleEligibilityScheduleRequestName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role eligibility request to validate." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Parameters for the role eligibility schedule request." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role eligibility schedule request.", + "schema": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ValidateRoleEligibilityScheduleRequestByName": { + "$ref": "./examples/ValidateRoleEligibilityScheduleRequestByName.json" + } + } + } + } + }, + "definitions": { + "RoleEligibilityScheduleRequestFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role eligibility requests of the specific principal." + }, + "roleDefinitionId": { + "type": "string", + "description": "Returns role eligibility requests of the specific role definition." + }, + "requestorId": { + "type": "string", + "description": "Returns role eligibility requests created by specific principal." + }, + "status": { + "type": "string", + "description": "Returns role eligibility requests of specific status." + } + }, + "type": "object", + "description": "Role eligibility schedule request filter" + }, + "RoleEligibilityScheduleRequestProperties": { + "properties": { + "scope": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "readOnly": true, + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "ForeignGroup", + "Device" + ], + "x-ms-enum": { + "name": "principalType", + "modelAsString": true + } + }, + "requestType": { + "type": "string", + "description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc", + "enum": [ + "AdminAssign", + "AdminRemove", + "AdminUpdate", + "AdminExtend", + "AdminRenew", + "SelfActivate", + "SelfDeactivate", + "SelfExtend", + "SelfRenew" + ], + "x-ms-enum": { + "name": "RequestType", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": true, + "description": "The status of the role eligibility schedule request.", + "enum": [ + "Accepted", + "PendingEvaluation", + "Granted", + "Denied", + "PendingProvisioning", + "Provisioned", + "PendingRevocation", + "Revoked", + "Canceled", + "Failed", + "PendingApprovalProvisioning", + "PendingApproval", + "FailedAsResourceIsLocked", + "PendingAdminDecision", + "AdminApproved", + "AdminDenied", + "TimedOut", + "ProvisioningStarted", + "Invalid", + "PendingScheduleCreation", + "ScheduleCreated", + "PendingExternalProvisioning" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + } + }, + "approvalId": { + "type": "string", + "readOnly": true, + "description": "The approvalId of the role eligibility schedule request." + }, + "scheduleInfo": { + "properties": { + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start DateTime of the role eligibility schedule." + }, + "expiration": { + "properties": { + "type": { + "type": "string", + "description": "Type of the role eligibility schedule expiration", + "enum": [ + "AfterDuration", + "AfterDateTime", + "NoExpiration" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "End DateTime of the role eligibility schedule." + }, + "duration": { + "type": "string", + "description": "Duration of the role eligibility schedule in TimeSpan." + } + }, + "type": "object", + "description": "Expiration of the role eligibility schedule" + } + }, + "type": "object", + "description": "Schedule info of the role eligibility schedule" + }, + "targetRoleEligibilityScheduleId": { + "type": "string", + "description": "The resultant role eligibility schedule id or the role eligibility schedule id being updated" + }, + "targetRoleEligibilityScheduleInstanceId": { + "type": "string", + "description": "The role eligibility schedule instance id being updated" + }, + "justification": { + "type": "string", + "description": "Justification for the role eligibility" + }, + "ticketInfo": { + "properties": { + "ticketNumber": { + "type": "string", + "description": "Ticket number for the role eligibility" + }, + "ticketSystem": { + "type": "string", + "description": "Ticket system name for the role eligibility" + } + }, + "type": "object", + "description": "Ticket Info of the role eligibility" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted value is '2.0'" + }, + "createdOn": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "DateTime when role eligibility schedule request was created" + }, + "requestorId": { + "type": "string", + "readOnly": true, + "description": "Id of the user who created this request" + }, + "expandedProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of principal, scope and role definition", + "$ref": "#/definitions/ExpandedProperties" + } + }, + "required": [ + "roleDefinitionId", + "principalId", + "requestType" + ], + "type": "object", + "description": "Role eligibility schedule request properties with scope." + }, + "RoleEligibilityScheduleRequest": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role eligibility schedule request type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleEligibilityScheduleRequestProperties", + "description": "Role eligibility schedule request properties." + } + }, + "type": "object", + "description": "Role Eligibility schedule request" + }, + "RoleEligibilityScheduleRequestListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleEligibilityScheduleRequest" + }, + "description": "Role eligibility schedule request list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role eligibility schedule request list operation result." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + }, + "ExpandedProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "principal": { + "type": "object", + "description": "Details of the principal", + "properties": { + "id": { + "type": "string", + "description": "Id of the principal" + }, + "displayName": { + "type": "string", + "description": "Display name of the principal" + }, + "email": { + "type": "string", + "description": "Email id of the principal" + }, + "type": { + "type": "string", + "description": "Type of the principal" + } + } + } + }, + "type": "object", + "description": "Expanded info of resource, role and principal" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json new file mode 100644 index 000000000000..523315260e37 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json @@ -0,0 +1,384 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}": { + "get": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Get", + "description": "Get the specified role management policy for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetRoleManagementPolicyByName": { + "$ref": "./examples/GetRoleManagementPolicyByName.json" + } + } + }, + "patch": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Update", + "description": "Update a role management policy", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to upsert." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + }, + "description": "Parameters for the role management policy." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - Returns the updated policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PatchRoleManagementPolicy": { + "$ref": "./examples/PatchRoleManagementPolicy.json" + }, + "PatchPartialRoleManagementPolicy": { + "$ref": "./examples/PatchPartialRoleManagementPolicy.json" + }, + "PatchRoleManagementPolicyToEnablePIMOnlyMode": { + "$ref": "./examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json" + } + } + }, + "delete": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_Delete", + "description": "Delete a role management policy", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name (guid) of the role management policy to upsert." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Successfully deleted the policy." + }, + "204": { + "description": "NoContent - policy does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteRoleManagementPolicy": { + "$ref": "./examples/DeleteRoleManagementPolicy.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicies": { + "get": { + "tags": [ + "roleManagementPolicies" + ], + "operationId": "RoleManagementPolicies_ListForScope", + "description": "Gets role management policies for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role management policies.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetRoleManagementPolicyByRoleDefinitionFilter": { + "$ref": "./examples/GetRoleManagementPolicyByScope.json" + } + } + } + } + }, + "definitions": { + "RoleManagementPolicyProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role management policy scope." + }, + "displayName": { + "type": "string", + "description": "The role management policy display name." + }, + "description": { + "type": "string", + "description": "The role management policy description." + }, + "isOrganizationDefault": { + "type": "boolean", + "description": "The role management policy is default policy." + }, + "lastModifiedBy": { + "$ref": "./common-types.json#/definitions/Principal" + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The last modified date time." + }, + "rules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "description": "The rule applied to the policy." + }, + "effectiveRules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "readOnly": true, + "description": "The readonly computed rule applied to the policy." + }, + "policyProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of scope", + "$ref": "#/definitions/PolicyProperties" + } + }, + "type": "object", + "description": "Role management policy properties with scope." + }, + "RoleManagementPolicy": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role management policy Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role management policy name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role management policy type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleManagementPolicyProperties", + "description": "Role management policy properties." + } + }, + "type": "object", + "description": "Role management policy" + }, + "RoleManagementPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleManagementPolicy" + }, + "description": "Role management policy list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role management policy list operation result." + }, + "PolicyProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + } + }, + "type": "object", + "description": "Expanded info of resource scope" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..1479e16feae0 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json @@ -0,0 +1,393 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2024-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}": { + "get": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Get", + "description": "Get the specified role management policy assignment for a resource scope", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to get." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role management policy.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleManagementPolicyAssignmentByName.json" + } + } + }, + "put": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Create", + "description": "Create a role management policy assignment", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy assignment to upsert.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to upsert." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + }, + "description": "Parameters for the role management policy assignment." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns the created or updated policy assignment.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PutRoleManagementPolicyAssignment": { + "$ref": "./examples/PutRoleManagementPolicyAssignment.json" + } + } + }, + "delete": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_Delete", + "description": "Delete a role management policy assignment", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleManagementPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of format {guid_guid} the role management policy assignment to delete." + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Successfully deleted the policy assignment." + }, + "204": { + "description": "NoContent - policy assignment does not exists." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteRoleManagementPolicyAssignment": { + "$ref": "./examples/DeleteRoleManagementPolicyAssignment.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments": { + "get": { + "tags": [ + "roleManagementPolicyAssignments" + ], + "operationId": "RoleManagementPolicyAssignments_ListForScope", + "description": "Gets role management assignment policies for a resource scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role management policy.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role management policies.", + "schema": { + "$ref": "#/definitions/RoleManagementPolicyAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetRoleManagementPolicyAssignmentByScope": { + "$ref": "./examples/GetRoleManagementPolicyAssignmentByScope.json" + } + } + } + } + }, + "definitions": { + "RoleManagementPolicyAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role management policy Id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role management policy name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role management policy type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleManagementPolicyAssignmentProperties", + "description": "Role management policy properties." + } + }, + "type": "object", + "description": "Role management policy" + }, + "RoleManagementPolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "string", + "description": "The role management policy scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition of management policy assignment." + }, + "policyId": { + "type": "string", + "description": "The policy id role management policy assignment." + }, + "effectiveRules": { + "type": "array", + "items": { + "$ref": "./common-types.json#/definitions/RoleManagementPolicyRule" + }, + "readOnly": true, + "description": "The readonly computed rule applied to the policy." + }, + "policyAssignmentProperties": { + "readOnly": true, + "type": "object", + "description": "Additional properties of scope, role definition and policy", + "$ref": "#/definitions/PolicyAssignmentProperties" + } + }, + "type": "object", + "description": "Role management policy assignment properties with scope." + }, + "RoleManagementPolicyAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleManagementPolicyAssignment" + }, + "description": "Role management policy assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "type": "object", + "description": "Role management policy assignment list operation result." + }, + "PolicyAssignmentProperties": { + "properties": { + "scope": { + "type": "object", + "description": "Details of the resource scope", + "properties": { + "id": { + "type": "string", + "description": "Scope id of the resource" + }, + "displayName": { + "type": "string", + "description": "Display name of the resource" + }, + "type": { + "type": "string", + "description": "Type of the resource" + } + } + }, + "roleDefinition": { + "type": "object", + "description": "Details of role definition", + "properties": { + "id": { + "type": "string", + "description": "Id of the role definition" + }, + "displayName": { + "type": "string", + "description": "Display name of the role definition" + }, + "type": { + "type": "string", + "description": "Type of the role definition" + } + } + }, + "policy": { + "type": "object", + "description": "Details of the policy", + "properties": { + "id": { + "type": "string", + "description": "Id of the policy" + }, + "lastModifiedBy": { + "$ref": "./common-types.json#/definitions/Principal" + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last modified date time." + } + } + } + }, + "type": "object", + "description": "Expanded info of resource scope, role definition and policy" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object", + "description": "An error response from the service." + }, + "CloudErrorBody": { + "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." + } + }, + "type": "object", + "description": "An error response from the service." + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json new file mode 100644 index 000000000000..3ed792b62118 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/common-types.json @@ -0,0 +1,500 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AuthorizationManagementClient" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Principal": { + "readOnly": true, + "type": "object", + "description": "The name of the entity last modified it", + "properties": { + "id": { + "type": "string", + "description": "The id of the principal made changes" + }, + "displayName": { + "type": "string", + "description": "The name of the principal made changes" + }, + "type": { + "type": "string", + "description": "Type of principal such as user , group etc" + }, + "email": { + "type": "string", + "description": "Email of principal" + } + } + }, + "RoleManagementPolicyRule": { + "description": "The role management policy rule.", + "type": "object", + "required": [ + "ruleType" + ], + "discriminator": "ruleType", + "properties": { + "id": { + "type": "string", + "description": "The id of the rule." + }, + "ruleType": { + "description": "The type of rule", + "$ref": "#/definitions/RoleManagementPolicyRuleType" + }, + "target": { + "$ref": "#/definitions/RoleManagementPolicyRuleTarget", + "description": "The target of the current rule." + } + } + }, + "RoleManagementPolicyApprovalRule": { + "description": "The role management policy approval rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "setting": { + "$ref": "#/definitions/ApprovalSettings", + "description": "The approval setting" + } + } + }, + "ApprovalSettings": { + "description": "The approval settings.", + "type": "object", + "properties": { + "isApprovalRequired": { + "type": "boolean", + "description": "Determines whether approval is required or not." + }, + "isApprovalRequiredForExtension": { + "type": "boolean", + "description": "Determines whether approval is required for assignment extension." + }, + "isRequestorJustificationRequired": { + "type": "boolean", + "description": "Determine whether requestor justification is required." + }, + "approvalMode": { + "type": "string", + "description": "The type of rule", + "enum": [ + "SingleStage", + "Serial", + "Parallel", + "NoApproval" + ], + "x-ms-enum": { + "name": "ApprovalMode", + "modelAsString": true + } + }, + "approvalStages": { + "type": "array", + "items": { + "$ref": "#/definitions/ApprovalStage" + }, + "x-ms-identifiers": [], + "description": "The approval stages of the request." + } + } + }, + "ApprovalStage": { + "description": "The approval stage.", + "type": "object", + "properties": { + "approvalStageTimeOutInDays": { + "type": "integer", + "format": "int32", + "description": "The time in days when approval request would be timed out" + }, + "isApproverJustificationRequired": { + "type": "boolean", + "description": "Determines whether approver need to provide justification for his decision." + }, + "escalationTimeInMinutes": { + "type": "integer", + "format": "int32", + "description": "The time in minutes when the approval request would be escalated if the primary approver does not approve" + }, + "primaryApprovers": { + "type": "array", + "description": "The primary approver of the request.", + "items": { + "$ref": "#/definitions/UserSet" + } + }, + "isEscalationEnabled": { + "type": "boolean", + "description": "The value determine whether escalation feature is enabled." + }, + "escalationApprovers": { + "type": "array", + "description": "The escalation approver of the request.", + "items": { + "$ref": "#/definitions/UserSet" + } + } + } + }, + "UserSet": { + "description": "The detail of a user.", + "type": "object", + "properties": { + "userType": { + "type": "string", + "description": "The type of user.", + "enum": [ + "User", + "Group" + ], + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + }, + "isBackup": { + "type": "boolean", + "description": "The value indicating whether the user is a backup fallback approver" + }, + "id": { + "type": "string", + "description": "The object id of the user." + }, + "description": { + "type": "string", + "description": "The description of the user." + } + } + }, + "UsersOrServicePrincipalSet": { + "description": "The detail of a subject.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of user.", + "enum": [ + "User", + "Group", + "ServicePrincipal" + ], + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + }, + "id": { + "type": "string", + "description": "The object id of the entity." + }, + "displayName": { + "type": "string", + "description": "The display Name of the entity." + } + } + }, + "RoleManagementPolicyAuthenticationContextRule": { + "description": "The role management policy authentication context rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "isEnabled": { + "type": "boolean", + "description": "The value indicating if rule is enabled." + }, + "claimValue": { + "type": "string", + "description": "The claim value." + } + } + }, + "RoleManagementPolicyEnablementRule": { + "description": "The role management policy enablement rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "enabledRules": { + "type": "array", + "items": { + "type": "string", + "description": "The type of enablement rule", + "enum": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "x-ms-enum": { + "name": "EnablementRules", + "modelAsString": true + } + }, + "description": "The list of enabled rules." + } + } + }, + "RoleManagementPolicyExpirationRule": { + "description": "The role management policy expiration rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "isExpirationRequired": { + "type": "boolean", + "description": "The value indicating whether expiration is required." + }, + "maximumDuration": { + "type": "string", + "description": "The maximum duration of expiration in timespan." + }, + "exceptionMembers": { + "type": "array", + "description": "The members not restricted by expiration rule.", + "items": { + "$ref": "#/definitions/UserSet" + } + } + } + }, + "RoleManagementPolicyNotificationRule": { + "description": "The role management policy notification rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string", + "description": "The type of notification.", + "enum": [ + "Email" + ], + "x-ms-enum": { + "name": "NotificationDeliveryMechanism", + "modelAsString": true + } + }, + "notificationLevel": { + "type": "string", + "description": "The notification level.", + "enum": [ + "None", + "Critical", + "All" + ], + "x-ms-enum": { + "name": "NotificationLevel", + "modelAsString": true + } + }, + "recipientType": { + "type": "string", + "description": "The recipient type.", + "enum": [ + "Requestor", + "Approver", + "Admin" + ], + "x-ms-enum": { + "name": "RecipientType", + "modelAsString": true + } + }, + "notificationRecipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of notification recipients." + }, + "isDefaultRecipientsEnabled": { + "type": "boolean", + "description": "Determines if the notification will be sent to the recipient type specified in the policy rule." + } + } + }, + "RoleManagementPolicyRuleTarget": { + "description": "The role management policy rule target.", + "type": "object", + "properties": { + "caller": { + "type": "string", + "description": "The caller of the setting." + }, + "operations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The type of operation." + }, + "level": { + "type": "string", + "description": "The assignment level to which rule is applied." + }, + "targetObjects": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of target objects." + }, + "inheritableSettings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of inheritable settings." + }, + "enforcedSettings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of enforced settings." + } + } + }, + "RoleManagementPolicyRuleType": { + "type": "string", + "description": "The type of rule", + "enum": [ + "RoleManagementPolicyApprovalRule", + "RoleManagementPolicyAuthenticationContextRule", + "RoleManagementPolicyEnablementRule", + "RoleManagementPolicyExpirationRule", + "RoleManagementPolicyNotificationRule", + "RoleManagementPolicyPimOnlyModeRule" + ], + "x-ms-enum": { + "name": "RoleManagementPolicyRuleType", + "modelAsString": true + } + }, + "RoleManagementPolicyPimOnlyModeRule": { + "description": "The role management policy PIM only mode rule.", + "allOf": [ + { + "$ref": "#/definitions/RoleManagementPolicyRule" + } + ], + "type": "object", + "properties": { + "pimOnlyModeSettings": { + "$ref": "#/definitions/PIMOnlyModeSettings", + "description": "The PIM Only Mode settings" + } + } + }, + "PIMOnlyModeSettings": { + "description": "The PIM Only Mode settings.", + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Determines whether the setting is enabled, disabled or report only.", + "enum": [ + "Disabled", + "Enabled", + "ReportOnly" + ], + "x-ms-enum": { + "name": "PIMOnlyMode", + "modelAsString": true + } + }, + "excludes": { + "type": "array", + "description": "The list of excluded entities that the rule does not apply to.", + "items": { + "$ref": "#/definitions/UsersOrServicePrincipalSet" + } + }, + "excludedAssignmentTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "ServicePrincipalsAsTarget", + "ServicePrincipalsAsRequestor" + ], + "x-ms-enum": { + "name": "ExcludedPrincipalTypes", + "modelAsString": true + } + }, + "description": "The list of excluded assignment types allowed." + } + } + } + }, + "parameters": { + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ResourceTypeParameter": { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource name.", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + }, + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}'", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..55ca173bc777 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..08a2d9d323d2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/CancelRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json new file mode 100644 index 000000000000..386864163fb7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicy.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..775fc20b75bf --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/DeleteRoleManagementPolicyAssignment.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json new file mode 100644 index 000000000000..e6822e1599c5 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetEligibleChildResourcesByScope.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "api-version": "2024-09-01-preview", + "$filter": "resourceType+eq+'resourcegroup'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "RG-1", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-1", + "type": "resourcegroup" + }, + { + "name": "RG-2", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/resourceGroups/RG-2", + "type": "resourcegroup" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json new file mode 100644 index 000000000000..9bf6aaa1736b --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleByName.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleName": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleAssignmentScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "updatedOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "type": "Microsoft.Authorization/RoleAssignmentSchedules" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json new file mode 100644 index 000000000000..62f0b7e7d324 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstanceByName.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleInstanceName": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "originRoleAssignmentId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "linkedRoleEligibilityScheduleInstanceId": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Accepted", + "roleAssignmentScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "type": "Microsoft.Authorization/RoleAssignmentScheduleInstances" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json new file mode 100644 index 000000000000..9e48f568a642 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleInstancesByScope.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "originRoleAssignmentId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleAssignments/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "linkedRoleEligibilityScheduleInstanceId": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Accepted", + "roleAssignmentScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleInstances/ed9b8180-cef7-4c77-a63c-b8566ecfc412", + "type": "Microsoft.Authorization/RoleAssignmentScheduleInstances" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..e2cca775e6f2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json new file mode 100644 index 000000000000..5045222d3db4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentScheduleRequestByScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetRoleAssignmentScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json new file mode 100644 index 000000000000..250663179382 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleAssignmentSchedulesByScope.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "assignmentType": "Assigned", + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleAssignmentScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "startDateTime": "2020-09-09T21:35:27.91Z", + "endDateTime": "2020-09-10T05:35:17.91Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:35:27.91Z", + "updatedOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentSchedules/c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "type": "Microsoft.Authorization/RoleAssignmentSchedules" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json new file mode 100644 index 000000000000..17a4b8367993 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleByName.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleName": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "startDateTime": "2020-09-09T21:33:14.557Z", + "endDateTime": "2021-09-09T21:32:28.49Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:33:06.3Z", + "updatedOn": "2020-09-09T22:27:00.513Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "type": "Microsoft.Authorization/RoleEligibilitySchedules" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json new file mode 100644 index 000000000000..ec45f8a5cbb2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstanceByName.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleInstanceName": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "startDateTime": "2020-09-10T00:32:36.86Z", + "endDateTime": "2021-09-10T00:31:41.477Z", + "memberType": "Direct", + "createdOn": "2020-09-10T00:32:36.86Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json new file mode 100644 index 000000000000..715c97443579 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleInstancesByScope.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "startDateTime": "2020-09-10T00:32:36.86Z", + "endDateTime": "2021-09-10T00:31:41.477Z", + "memberType": "Direct", + "createdOn": "2020-09-10T00:32:36.86Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleInstances/21e4b59a-0499-4fe0-a3c3-43a3055b773a", + "type": "Microsoft.Authorization/RoleEligibilityScheduleInstances" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..c17e47738891 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json new file mode 100644 index 000000000000..e58d52f7edbd --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilityScheduleRequestByScope.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('A3BB8764-CB92-4276-9D2A-CA1E895E55EA')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityRequests" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json new file mode 100644 index 000000000000..efff14bdf221 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleEligibilitySchedulesByScope.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "$filter": "assignedTo('a3bb8764-cb92-4276-9d2a-ca1e895e55ea')", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/b24988ac-6180-42a0-ab88-20f7382dd24c", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "status": "Provisioned", + "roleEligibilityScheduleRequestId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "startDateTime": "2020-09-09T21:33:14.557Z", + "endDateTime": "2021-09-09T21:32:28.49Z", + "memberType": "Direct", + "createdOn": "2020-09-09T21:33:06.3Z", + "updatedOn": "2020-09-09T22:27:00.513Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilitySchedules/b1477448-2cc6-4ceb-93b4-54a202a89413", + "type": "Microsoft.Authorization/RoleEligibilitySchedules" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json new file mode 100644 index 000000000000..dc63c66cf059 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByName.json @@ -0,0 +1,394 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json new file mode 100644 index 000000000000..46e48704de5a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyAssignmentByScope.json @@ -0,0 +1,397 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json new file mode 100644 index 000000000000..dd7377445abc --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByName.json @@ -0,0 +1,738 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T02:54:27.167+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json new file mode 100644 index 000000000000..956daa8ec93a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/GetRoleManagementPolicyByScope.json @@ -0,0 +1,741 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T02:54:27.167+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json new file mode 100644 index 000000000000..d608391c4c10 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchPartialRoleManagementPolicy.json @@ -0,0 +1,782 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json new file mode 100644 index 000000000000..aa1ad8c3fd53 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicy.json @@ -0,0 +1,1172 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User", + "displayName": "AdminUser1" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group", + "displayName": "Admin Group1" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal", + "displayName": "JIT Application" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json new file mode 100644 index 000000000000..302e6822f305 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PatchRoleManagementPolicyToEnablePIMOnlyMode.json @@ -0,0 +1,861 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyName": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "rules": [ + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": null, + "description": null, + "isOrganizationDefault": false, + "lastModifiedDateTime": "2021-03-17T16:35:27.91+00:00", + "lastModifiedBy": { + "id": null, + "displayName": "Admin", + "type": null, + "email": null + }, + "rules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "effectiveRules": [ + { + "isExpirationRequired": false, + "maximumDuration": "P180D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "Justification", + "MultiFactorAuthentication", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User", + "displayName": "AdminUser1" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group", + "displayName": "Admin Group1" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal", + "displayName": "JIT Application" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + }, + { + "id": "PIMOnlyMode_Admin_Assignment", + "ruleType": "RoleManagementPolicyPimOnlyModeRule", + "pimOnlyModeSettings": { + "excludedAssignmentTypes": [ + "ServicePrincipalsAsTarget" + ], + "mode": "Enabled", + "excludes": [ + { + "id": "ec42a424-a0c0-4418-8788-d19bdeb03704", + "type": "User" + }, + { + "id": "00029dfb-0218-4e7a-9a85-c15dc0c880bc", + "type": "Group" + }, + { + "id": "0000103d-1fc2-4ac8-81de-71517765655c", + "type": "ServicePrincipal" + } + ] + }, + "target": { + "caller": "Admin", + "level": "Assignment", + "operations": [ + "all" + ], + "enforcedSettings": [ + "all" + ], + "inheritableSettings": [ + "all" + ], + "targetObjects": [] + } + } + ], + "policyProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + } + } + }, + "name": "570c3619-7688-4b34-b290-2b8bb3ccab2a", + "id": "/providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/570c3619-7688-4b34-b290-2b8bb3ccab2a", + "type": "Microsoft.Authorization/RoleManagementPolicies" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json new file mode 100644 index 000000000000..b75cb221c0a7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleAssignmentScheduleRequest.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "SelfActivate", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json new file mode 100644 index 000000000000..0ad80a7d4ab4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleEligibilityScheduleRequest.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "AdminAssign", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json new file mode 100644 index 000000000000..b01e12e31fa7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/PutRoleManagementPolicyAssignment.json @@ -0,0 +1,396 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Subscription/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleManagementPolicyAssignmentName": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "api-version": "2024-09-01-preview", + "parameters": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "scope": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "roleDefinitionId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "policyId": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "effectiveRules": [ + { + "enabledRules": [], + "id": "Enablement_Admin_Eligibility", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Eligibility", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_eligible@test.com" + ], + "id": "Notification_Admin_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_eligible@test.com" + ], + "id": "Notification_Requestor_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_eligible@test.com" + ], + "id": "Notification_Approver_Admin_Eligibility", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Eligibility", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification" + ], + "id": "Enablement_Admin_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": false, + "maximumDuration": "P90D", + "exceptionMembers": null, + "id": "Expiration_Admin_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_admin_member@test.com" + ], + "id": "Notification_Admin_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_admin_member@test.com" + ], + "id": "Notification_Requestor_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "approver_admin_member@test.com" + ], + "id": "Notification_Approver_Admin_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "Admin", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "setting": { + "isApprovalRequired": true, + "isApprovalRequiredForExtension": false, + "isRequestorJustificationRequired": true, + "approvalMode": "SingleStage", + "approvalStages": [ + { + "approvalStageTimeOutInDays": 1, + "isApproverJustificationRequired": true, + "escalationTimeInMinutes": 0, + "primaryApprovers": [ + { + "id": "2385b0f3-5fa9-43cf-8ca4-b01dc97298cd", + "description": "amansw_new_group", + "isBackup": false, + "userType": "Group" + }, + { + "id": "2f4913c9-d15b-406a-9946-1d66a28f2690", + "description": "amansw_group", + "isBackup": false, + "userType": "Group" + } + ], + "isEscalationEnabled": false, + "escalationApprovers": null + } + ] + }, + "id": "Approval_EndUser_Assignment", + "ruleType": "RoleManagementPolicyApprovalRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isEnabled": false, + "claimValue": "", + "id": "AuthenticationContext_EndUser_Assignment", + "ruleType": "RoleManagementPolicyAuthenticationContextRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "enabledRules": [ + "MultiFactorAuthentication", + "Justification", + "Ticketing" + ], + "id": "Enablement_EndUser_Assignment", + "ruleType": "RoleManagementPolicyEnablementRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "isExpirationRequired": true, + "maximumDuration": "PT7H", + "exceptionMembers": null, + "id": "Expiration_EndUser_Assignment", + "ruleType": "RoleManagementPolicyExpirationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Admin", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "admin_enduser_member@test.com" + ], + "id": "Notification_Admin_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Requestor", + "isDefaultRecipientsEnabled": false, + "notificationLevel": "Critical", + "notificationRecipients": [ + "requestor_enduser_member@test.com" + ], + "id": "Notification_Requestor_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + }, + { + "notificationType": "Email", + "recipientType": "Approver", + "isDefaultRecipientsEnabled": true, + "notificationLevel": "Critical", + "notificationRecipients": null, + "id": "Notification_Approver_EndUser_Assignment", + "ruleType": "RoleManagementPolicyNotificationRule", + "target": { + "caller": "EndUser", + "operations": [ + "All" + ], + "level": "Assignment", + "targetObjects": null, + "inheritableSettings": null, + "enforcedSettings": null + } + } + ], + "policyAssignmentProperties": { + "scope": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleDefinitions/a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "displayName": "FHIR Data Converter", + "type": "BuiltInRole" + }, + "policy": { + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicies/b959d571-f0b5-4042-88a7-01be6cb22db9", + "lastModifiedBy": null, + "lastModifiedDateTime": null + } + } + }, + "name": "b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "id": "/subscriptions/129ff972-28f8-46b8-a726-e497be039368/providers/Microsoft.Authorization/roleManagementPolicyAssignment/b959d571-f0b5-4042-88a7-01be6cb22db9_a1705bd2-3a8f-45a5-8683-466fcfd5cc24", + "type": "Microsoft.Authorization/RoleManagementPolicyAssignment" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json new file mode 100644 index 000000000000..96eac3c70592 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleAssignmentScheduleRequestByName.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleAssignmentScheduleRequestName": "fea7a502-9a96-4806-a26f-eee560e52045", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "SelfActivate", + "linkedRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleAssignmentScheduleId": "c9e264ff-3133-4776-a81a-ebc7c33c8ec6", + "targetRoleAssignmentScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "SelfActivate", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:35:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "PT8H" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:35:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "fea7a502-9a96-4806-a26f-eee560e52045", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleAssignmentScheduleRequests/fea7a502-9a96-4806-a26f-eee560e52045", + "type": "Microsoft.Authorization/RoleAssignmentScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json new file mode 100644 index 000000000000..5ba43835dfb4 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2024-09-01-preview/examples/ValidateRoleEligibilityScheduleRequestByName.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleEligibilityScheduleRequestName": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "parameters": { + "properties": { + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "requestType": "AdminAssign", + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0" + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "targetRoleEligibilityScheduleId": "b1477448-2cc6-4ceb-93b4-54a202a89413", + "targetRoleEligibilityScheduleInstanceId": null, + "scope": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "principalId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "principalType": "User", + "requestType": "AdminAssign", + "status": "Provisioned", + "approvalId": null, + "scheduleInfo": { + "startDateTime": "2020-09-09T21:31:27.91Z", + "expiration": { + "type": "AfterDuration", + "endDateTime": null, + "duration": "P365D" + } + }, + "ticketInfo": { + "ticketNumber": null, + "ticketSystem": null + }, + "justification": null, + "requestorId": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "createdOn": "2020-09-09T21:32:27.91Z", + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "expandedProperties": { + "scope": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f", + "displayName": "Pay-As-You-Go", + "type": "subscription" + }, + "roleDefinition": { + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/c8d4ff99-41c3-41a8-9f60-21dfdad59608", + "displayName": "Contributor", + "type": "BuiltInRole" + }, + "principal": { + "id": "a3bb8764-cb92-4276-9d2a-ca1e895e55ea", + "displayName": "User Account", + "email": "user@my-tenant.com", + "type": "User" + } + } + }, + "name": "64caffb6-55c0-4deb-a585-68e948ea1ad6", + "id": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/RoleEligibilityScheduleRequests/64caffb6-55c0-4deb-a585-68e948ea1ad6", + "type": "Microsoft.Authorization/RoleEligibilityScheduleRequests" + } + } + } +} diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index b7c24d4a3136..58d6c1637ddf 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Authorization API. ``` yaml openapi-type: arm -tag: package-2024-02-01-preview +tag: package-2024-09-01-preview ``` ### Suppression @@ -93,6 +93,31 @@ directive: reason: common-types doesn't need to reference api version. ``` +### Tag: package-2024-09-01-preview + +These settings apply only when `--tag=package-2024-09-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-01-preview' +input-file: + - Microsoft.Authorization/stable/2015-07-01/authorization-ClassicAdminCalls.json + - Microsoft.Authorization/stable/2015-07-01/authorization-ElevateAccessCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-DenyAssignmentCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-ProviderOperationsCalls.json + - Microsoft.Authorization/stable/2022-04-01/authorization-RoleAssignmentsCalls.json + - Microsoft.Authorization/preview/2022-05-01-preview/authorization-RoleDefinitionsCalls.json + - Microsoft.Authorization/preview/2024-09-01-preview/common-types.json + - Microsoft.Authorization/preview/2021-12-01-preview/authorization-AccessReviewCalls.json + - Microsoft.Authorization/preview/2024-09-01-preview/EligibleChildResources.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentSchedule.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleInstance.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleAssignmentScheduleRequest.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilitySchedule.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleInstance.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleEligibilityScheduleRequest.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicy.json + - Microsoft.Authorization/preview/2024-09-01-preview/RoleManagementPolicyAssignment.json + - Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json +``` ### Tag: package-2024-02-01-preview From 75fdb87b5367a3ab306e85fb6daa7501d54f0553 Mon Sep 17 00:00:00 2001 From: Almas Khan <162407742+almasak@users.noreply.github.com> Date: Fri, 4 Oct 2024 12:19:24 +0530 Subject: [PATCH 041/101] Onboard Liftr Neon Postgres service (#30806) * Onboard Liftr Neon Postgres service * [Fix] tsp compile error --- .../LiftrBase.Data/main.tsp | 40 + .../LiftrBase/main.tsp | 157 ++++ .../Neon.Postgres.Management/README.md | 28 + .../Operations_List_MaximumSet_Gen.json | 28 + ...zations_CreateOrUpdate_MaximumSet_Gen.json | 184 ++++ .../Organizations_Delete_MaximumSet_Gen.json | 18 + .../Organizations_Get_MaximumSet_Gen.json | 73 ++ ...ns_ListByResourceGroup_MaximumSet_Gen.json | 77 ++ ...ons_ListBySubscription_MaximumSet_Gen.json | 76 ++ .../Organizations_Update_MaximumSet_Gen.json | 112 +++ .../Neon.Postgres.Management/main.tsp | 53 ++ .../Neon.Postgres.Management/tspconfig.yaml | 12 + .../Operations_List_MaximumSet_Gen.json | 28 + ...zations_CreateOrUpdate_MaximumSet_Gen.json | 184 ++++ .../Organizations_Delete_MaximumSet_Gen.json | 18 + .../Organizations_Get_MaximumSet_Gen.json | 73 ++ ...ns_ListByResourceGroup_MaximumSet_Gen.json | 77 ++ ...ons_ListBySubscription_MaximumSet_Gen.json | 76 ++ .../Organizations_Update_MaximumSet_Gen.json | 112 +++ .../preview/2024-08-01-preview/neon.json | 844 ++++++++++++++++++ .../liftrneon/resource-manager/readme.md | 40 + 21 files changed, 2310 insertions(+) create mode 100644 specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/README.md create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json create mode 100644 specification/liftrneon/Neon.Postgres.Management/main.tsp create mode 100644 specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json create mode 100644 specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json create mode 100644 specification/liftrneon/resource-manager/readme.md diff --git a/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp b/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp new file mode 100644 index 000000000000..940b56869be5 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/LiftrBase.Data/main.tsp @@ -0,0 +1,40 @@ +import "../LiftrBase/main.tsp"; + +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-resource-manager"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; +using LiftrBase; + +@versioned(LiftrBase.Data.Versions) +namespace LiftrBase.Data; + +@doc("Supported versions for LiftrBase.Data resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1 and LiftrBase.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v1_preview) + v1_preview: "2024-08-01-preview", +} + +@doc("Properties specific to Data Organization resource") +model OrganizationProperties is BaseResourceProperties { + @doc("Organization properties") + partnerOrganizationProperties?: PartnerOrganizationProperties; +} + +@doc("Properties specific to Partner's organization") +model PartnerOrganizationProperties { + @doc("Organization Id in partner's system") + organizationId?: string; + + @doc("Organization name in partner's system") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$") + @minLength(1) + @maxLength(50) + organizationName: string; + + @doc("Single Sign On properties for the organization") + singleSignOnProperties?: SingleSignOnProperties; +} diff --git a/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp b/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp new file mode 100644 index 000000000000..afbeebb94191 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/LiftrBase/main.tsp @@ -0,0 +1,157 @@ +import "@azure-tools/typespec-azure-resource-manager"; +import "@typespec/versioning"; + +using Azure.ResourceManager; +using TypeSpec.Versioning; + +@versioned(LiftrBase.Versions) +namespace LiftrBase; + +@doc("Supported versions for LiftrBase resource model") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + v1_preview: "2024-08-01-preview", +} + +@doc("Marketplace subscription status of a resource.") +union MarketplaceSubscriptionStatus { + string, + + @doc("Purchased but not yet activated") + PendingFulfillmentStart: "PendingFulfillmentStart", + + @doc("Marketplace subscription is activated") + Subscribed: "Subscribed", + + @doc("This state indicates that a customer's payment for the Marketplace service was not received") + Suspended: "Suspended", + + @doc("Customer has cancelled the subscription") + Unsubscribed: "Unsubscribed", +} + +@doc("A string that represents a URI.") +scalar Uri extends string; + +@doc("Marketplace details for an organization") +model MarketplaceDetails { + @doc("SaaS subscription id for the the marketplace offer") + subscriptionId?: string; + + @doc("Marketplace subscription status") + subscriptionStatus?: MarketplaceSubscriptionStatus; + + @doc("Offer details for the marketplace that is selected by the user") + offerDetails: OfferDetails; +} + +@doc("Offer details for the marketplace that is selected by the user") +model OfferDetails { + @doc("Publisher Id for the marketplace offer") + publisherId: string; + + @doc("Offer Id for the marketplace offer") + offerId: string; + + @doc("Plan Id for the marketplace offer") + planId: string; + + @doc("Plan Name for the marketplace offer") + planName?: string; + + @doc("Term Name for the marketplace offer") + termUnit?: string; + + @doc("Term Id for the marketplace offer") + termId?: string; +} + +@doc("Reusable representation of an email address.") +@pattern("^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$") +scalar email extends string; + +@doc("User details for an organization") +model UserDetails { + @doc("First name of the user") + firstName?: string; + + @doc("Last name of the user") + lastName?: string; + + @doc("Email address of the user") + emailAddress?: email; + + @doc("User's principal name") + upn?: string; + + @doc("User's phone number") + phoneNumber?: string; +} + +@doc("Company details for an organization") +model CompanyDetails { + @doc("Company name") + companyName?: string; + + @doc("Country name of the company") + country?: string; + + @doc("Office address of the company") + officeAddress?: string; + + @doc("Business phone number of the company") + businessPhone?: string; + + @doc("Domain of the user") + domain?: string; + + @doc("Number of employees in the company") + numberOfEmployees?: int64; +} + +@doc("Base resource properties that can be extended for arm resources.") +model BaseResourceProperties { + @doc("Marketplace details of the resource.") + @visibility("create", "read") + marketplaceDetails: MarketplaceDetails; + + @doc("Details of the user.") + userDetails: UserDetails; + + @doc("Details of the company.") + companyDetails: CompanyDetails; + + @doc("Provisioning state of the resource.") + @visibility("read") + provisioningState?: ResourceProvisioningState; +} + +@doc("Properties specific to Single Sign On Resource") +model SingleSignOnProperties { + @doc("State of the Single Sign On for the organization") + singleSignOnState?: SingleSignOnStates; + + @doc("AAD enterprise application Id used to setup SSO") + enterpriseAppId?: string; + + @doc("URL for SSO to be used by the partner to redirect the user to their system") + singleSignOnUrl?: Uri; + + @doc("List of AAD domains fetched from Microsoft Graph for user.") + aadDomains?: string[]; +} + +@doc("Various states of the SSO resource") +union SingleSignOnStates { + string, + + @doc("Initial state of the SSO resource") + Initial: "Initial", + + @doc("SSO is enabled for the organization") + Enable: "Enable", + + @doc("SSO is disabled for the organization") + Disable: "Disable", +} diff --git a/specification/liftrneon/Neon.Postgres.Management/README.md b/specification/liftrneon/Neon.Postgres.Management/README.md new file mode 100644 index 000000000000..1888f2f6db26 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/README.md @@ -0,0 +1,28 @@ +# Neon Postgres service typespec project + +## Getting started + +- environment setup: https://microsoft.github.io/typespec/introduction/installation + +## Generate Neon swagger + +## NPM registry authentication + +We have to use the Liftr Feed Service for NPM to fetch the typespec dependencies. +The `.npmrc` file configures the folder accordingly. + +in development, you can tell npm to use the standard public registry by specifying it: + +`npm install --registry https://registry.npmjs.org` + +then: + +`tsp compile .` + +## Development + +Always edit `tsp` files, and generate swagger, never edit the swagger directly. + +For generating examples use the following command: + +`oav generate-examples neon.json` diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ed2a97f35d4 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ekvuojrpbuyogrikfuzyghio", + "isDataAction": true, + "display": { + "provider": "lvppuskqcdcoejwuvsqrloczvnouy", + "resource": "rvvd", + "operation": "odjjqnodcgszczpsdrhrpwmqssrybr", + "description": "bwmstukaiaoisiu" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://contoso.com/nextlink" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..b73e24223705 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "Organizations_CreateOrUpdate", + "operationId": "Organizations_CreateOrUpdate", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "XB-.:", + "resource": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3574b959b03 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Organizations_Delete", + "operationId": "Organizations_Delete", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "2_3" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c4eba3507ee --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "Organizations_Get", + "operationId": "Organizations_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "5" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dfabedecd89 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "Organizations_ListByResourceGroup", + "operationId": "Organizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..c1d5f8609be1 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Organizations_ListBySubscription", + "operationId": "Organizations_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa6b1e166e41 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/examples/2024-08-01-preview/Organizations_Update_MaximumSet_Gen.json @@ -0,0 +1,112 @@ +{ + "title": "Organizations_Update", + "operationId": "Organizations_Update", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "eRY-J_:", + "properties": { + "properties": { + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key8990": "wuvaontoqyttxtikvvahdegcfdfkz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/eRY-J_:", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/liftrneon/Neon.Postgres.Management/main.tsp b/specification/liftrneon/Neon.Postgres.Management/main.tsp new file mode 100644 index 000000000000..f61718301480 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/main.tsp @@ -0,0 +1,53 @@ +import "./LiftrBase.Data/main.tsp"; + +import "@azure-tools/typespec-autorest"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using Azure.ResourceManager; +using TypeSpec.Versioning; +using LiftrBase.Data; + +@armProviderNamespace +@service({ + title: "Neon.Postgres", + description: "Azure Native Services Integration for Neon Postgres", +}) +@versioned(Neon.Postgres.Versions) +@armCommonTypesVersion("v5") +namespace Neon.Postgres; + +@doc("Supported API versions for the Neon.Postgres resource provider.") +enum Versions { + @doc("Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1, LiftrBase.Versions.v1_preview, LiftrBase.Data.Versions.v1_preview") + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(LiftrBase.Versions.v1_preview) + @useDependency(LiftrBase.Data.Versions.v1_preview) + v1_preview: "2024-08-01-preview", +} + +interface Operations extends Azure.ResourceManager.Operations {} + +@doc("Organization Resource by Neon") +model OrganizationResource is TrackedResource<OrganizationProperties> { + @key("organizationName") + @pattern("^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$") + @segment("organizations") + @minLength(1) + @maxLength(50) + @doc("Name of the Neon Organizations resource") + @path + name: string; +} + +@armResourceOperations +interface Organizations { + get is ArmResourceRead<OrganizationResource>; + createOrUpdate is ArmResourceCreateOrUpdateAsync<OrganizationResource>; + update is ArmResourcePatchAsync<OrganizationResource, OrganizationProperties>; + delete is ArmResourceDeleteWithoutOkAsync<OrganizationResource>; + listByResourceGroup is ArmResourceListByParent<OrganizationResource>; + listBySubscription is ArmListBySubscription<OrganizationResource>; +} diff --git a/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml b/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml new file mode 100644 index 000000000000..a2065d563052 --- /dev/null +++ b/specification/liftrneon/Neon.Postgres.Management/tspconfig.yaml @@ -0,0 +1,12 @@ +emit: + - "@azure-tools/typespec-autorest" +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" +options: + "@azure-tools/typespec-autorest": + use-read-only-status-schema: true + emitter-output-dir: "{project-root}/.." + azure-resource-provider-folder: "resource-manager" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/neon.json" + examples-dir: "{project-root}/examples" diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..0ed2a97f35d4 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ekvuojrpbuyogrikfuzyghio", + "isDataAction": true, + "display": { + "provider": "lvppuskqcdcoejwuvsqrloczvnouy", + "resource": "rvvd", + "operation": "odjjqnodcgszczpsdrhrpwmqssrybr", + "description": "bwmstukaiaoisiu" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://contoso.com/nextlink" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json new file mode 100644 index 000000000000..b73e24223705 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json @@ -0,0 +1,184 @@ +{ + "title": "Organizations_CreateOrUpdate", + "operationId": "Organizations_CreateOrUpdate", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "XB-.:", + "resource": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d3574b959b03 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "Organizations_Delete", + "operationId": "Organizations_Delete", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "2_3" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..4c4eba3507ee --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Get_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "Organizations_Get", + "operationId": "Organizations_Get", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "5" + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3dfabedecd89 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,77 @@ +{ + "title": "Organizations_ListByResourceGroup", + "operationId": "Organizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..c1d5f8609be1 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,76 @@ +{ + "title": "Organizations_ListBySubscription", + "operationId": "Organizations_ListBySubscription", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "nrhvoqzulowcunhmvwfgjcaibvwcl", + "organizationName": "2__.-", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/2__.-", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..aa6b1e166e41 --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/examples/Organizations_Update_MaximumSet_Gen.json @@ -0,0 +1,112 @@ +{ + "title": "Organizations_Update", + "operationId": "Organizations_Update", + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "1178323D-8270-4757-B639-D528B6266487", + "resourceGroupName": "rgneon", + "organizationName": "eRY-J_:", + "properties": { + "properties": { + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key8990": "wuvaontoqyttxtikvvahdegcfdfkz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "marketplaceDetails": { + "subscriptionId": "yxmkfivp", + "subscriptionStatus": "PendingFulfillmentStart", + "offerDetails": { + "publisherId": "hporaxnopmolttlnkbarw", + "offerId": "bunyeeupoedueofwrzej", + "planId": "nlbfiwtslenfwek", + "planName": "ljbmgpkfqklaufacbpml", + "termUnit": "qbcq", + "termId": "aedlchikwqckuploswthvshe" + } + }, + "userDetails": { + "firstName": "buwwe", + "lastName": "escynjpynkoox", + "emailAddress": "3i_%@w8-y.H-p.tvj.dG", + "upn": "fwedjamgwwrotcjaucuzdwycfjdqn", + "phoneNumber": "dlrqoowumy" + }, + "companyDetails": { + "companyName": "uxn", + "country": "lpajqzptqchuko", + "officeAddress": "chpkrlpmfslmawgunjxdllzcrctykq", + "businessPhone": "hbeb", + "domain": "krjldeakhwiepvs", + "numberOfEmployees": 23 + }, + "provisioningState": "Succeeded", + "partnerOrganizationProperties": { + "organizationId": "njyoqflcmfwzfsqe", + "organizationName": "J:.._3P", + "singleSignOnProperties": { + "singleSignOnState": "Initial", + "enterpriseAppId": "fpibacregjfncfdsojs", + "singleSignOnUrl": "tmojh", + "aadDomains": [ + "kndszgrwzbvvlssvkej" + ] + } + } + }, + "tags": { + "key2099": "omjjymaqtrqzksxszhzgyl" + }, + "location": "upxxgikyqrbnv", + "id": "/subscriptions/1178323D-8270-4757-B639-D528B6266487/resourceGroups/rgneon/providers/Microsoft.Neon/organizations/eRY-J_:", + "name": "grhdqtqnkqmu", + "type": "gapeymltyvlqlvpgdgfxidkkd", + "systemData": { + "createdBy": "qfhekdgpvdtqcohjhvlyhzd", + "createdByType": "User", + "createdAt": "2024-07-30T15:12:24.902Z", + "lastModifiedBy": "dqsjroejrtucfjyqcoonpdopfaa", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-30T15:12:24.902Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json new file mode 100644 index 000000000000..7369ccfb67ee --- /dev/null +++ b/specification/liftrneon/resource-manager/Neon.Postgres/preview/2024-08-01-preview/neon.json @@ -0,0 +1,844 @@ +{ + "swagger": "2.0", + "info": { + "title": "Neon.Postgres", + "version": "2024-08-01-preview", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Organizations" + } + ], + "paths": { + "/providers/Neon.Postgres/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Neon.Postgres/organizations": { + "get": { + "operationId": "Organizations_ListBySubscription", + "tags": [ + "Organizations" + ], + "description": "List OrganizationResource resources 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/OrganizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_ListBySubscription": { + "$ref": "./examples/Organizations_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations": { + "get": { + "operationId": "Organizations_ListByResourceGroup", + "tags": [ + "Organizations" + ], + "description": "List OrganizationResource resources 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/OrganizationResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_ListByResourceGroup": { + "$ref": "./examples/Organizations_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}": { + "get": { + "operationId": "Organizations_Get", + "tags": [ + "Organizations" + ], + "description": "Get a OrganizationResource", + "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": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Get": { + "$ref": "./examples/Organizations_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "Organizations_CreateOrUpdate", + "tags": [ + "Organizations" + ], + "description": "Create a OrganizationResource", + "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": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OrganizationResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "201": { + "description": "Resource 'OrganizationResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Organizations_CreateOrUpdate": { + "$ref": "./examples/Organizations_CreateOrUpdate_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Organizations_Update", + "tags": [ + "Organizations" + ], + "description": "Update a OrganizationResource", + "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": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_Update": { + "$ref": "./examples/Organizations_Update_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Organizations_Delete", + "tags": [ + "Organizations" + ], + "description": "Delete a OrganizationResource", + "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": "organizationName", + "in": "path", + "description": "Name of the Neon Organizations resource", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "pattern": "^[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": { + "Organizations_Delete": { + "$ref": "./examples/Organizations_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Azure.ResourceManager.CommonTypes.TrackedResourceUpdate": { + "type": "object", + "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ] + }, + "Azure.ResourceManager.ResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource type.", + "enum": [ + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ResourceProvisioningState", + "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." + } + ] + }, + "readOnly": true + }, + "LiftrBase.CompanyDetails": { + "type": "object", + "description": "Company details for an organization", + "properties": { + "companyName": { + "type": "string", + "description": "Company name" + }, + "country": { + "type": "string", + "description": "Country name of the company" + }, + "officeAddress": { + "type": "string", + "description": "Office address of the company" + }, + "businessPhone": { + "type": "string", + "description": "Business phone number of the company" + }, + "domain": { + "type": "string", + "description": "Domain of the user" + }, + "numberOfEmployees": { + "type": "integer", + "format": "int64", + "description": "Number of employees in the company" + } + } + }, + "LiftrBase.Data.OrganizationProperties": { + "type": "object", + "description": "Properties specific to Data Organization resource", + "properties": { + "marketplaceDetails": { + "$ref": "#/definitions/LiftrBase.MarketplaceDetails", + "description": "Marketplace details of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "Details of the user." + }, + "companyDetails": { + "$ref": "#/definitions/LiftrBase.CompanyDetails", + "description": "Details of the company." + }, + "provisioningState": { + "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "partnerOrganizationProperties": { + "$ref": "#/definitions/LiftrBase.Data.PartnerOrganizationProperties", + "description": "Organization properties" + } + }, + "required": [ + "marketplaceDetails", + "userDetails", + "companyDetails" + ] + }, + "LiftrBase.Data.OrganizationPropertiesUpdate": { + "type": "object", + "description": "Properties specific to Data Organization resource", + "properties": { + "userDetails": { + "$ref": "#/definitions/LiftrBase.UserDetails", + "description": "Details of the user." + }, + "companyDetails": { + "$ref": "#/definitions/LiftrBase.CompanyDetails", + "description": "Details of the company." + }, + "partnerOrganizationProperties": { + "$ref": "#/definitions/LiftrBase.Data.PartnerOrganizationPropertiesUpdate", + "description": "Organization properties" + } + } + }, + "LiftrBase.Data.PartnerOrganizationProperties": { + "type": "object", + "description": "Properties specific to Partner's organization", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization Id in partner's system" + }, + "organizationName": { + "type": "string", + "description": "Organization name in partner's system", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/LiftrBase.SingleSignOnProperties", + "description": "Single Sign On properties for the organization" + } + }, + "required": [ + "organizationName" + ] + }, + "LiftrBase.Data.PartnerOrganizationPropertiesUpdate": { + "type": "object", + "description": "Properties specific to Partner's organization", + "properties": { + "organizationId": { + "type": "string", + "description": "Organization Id in partner's system" + }, + "organizationName": { + "type": "string", + "description": "Organization name in partner's system", + "minLength": 1, + "maxLength": 50, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_\\-.: ]*$" + }, + "singleSignOnProperties": { + "$ref": "#/definitions/LiftrBase.SingleSignOnProperties", + "description": "Single Sign On properties for the organization" + } + } + }, + "LiftrBase.MarketplaceDetails": { + "type": "object", + "description": "Marketplace details for an organization", + "properties": { + "subscriptionId": { + "type": "string", + "description": "SaaS subscription id for the the marketplace offer" + }, + "subscriptionStatus": { + "$ref": "#/definitions/LiftrBase.MarketplaceSubscriptionStatus", + "description": "Marketplace subscription status" + }, + "offerDetails": { + "$ref": "#/definitions/LiftrBase.OfferDetails", + "description": "Offer details for the marketplace that is selected by the user" + } + }, + "required": [ + "offerDetails" + ] + }, + "LiftrBase.MarketplaceSubscriptionStatus": { + "type": "string", + "description": "Marketplace subscription status of a resource.", + "enum": [ + "PendingFulfillmentStart", + "Subscribed", + "Suspended", + "Unsubscribed" + ], + "x-ms-enum": { + "name": "MarketplaceSubscriptionStatus", + "modelAsString": true, + "values": [ + { + "name": "PendingFulfillmentStart", + "value": "PendingFulfillmentStart", + "description": "Purchased but not yet activated" + }, + { + "name": "Subscribed", + "value": "Subscribed", + "description": "Marketplace subscription is activated" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "This state indicates that a customer's payment for the Marketplace service was not received" + }, + { + "name": "Unsubscribed", + "value": "Unsubscribed", + "description": "Customer has cancelled the subscription" + } + ] + } + }, + "LiftrBase.OfferDetails": { + "type": "object", + "description": "Offer details for the marketplace that is selected by the user", + "properties": { + "publisherId": { + "type": "string", + "description": "Publisher Id for the marketplace offer" + }, + "offerId": { + "type": "string", + "description": "Offer Id for the marketplace offer" + }, + "planId": { + "type": "string", + "description": "Plan Id for the marketplace offer" + }, + "planName": { + "type": "string", + "description": "Plan Name for the marketplace offer" + }, + "termUnit": { + "type": "string", + "description": "Term Name for the marketplace offer" + }, + "termId": { + "type": "string", + "description": "Term Id for the marketplace offer" + } + }, + "required": [ + "publisherId", + "offerId", + "planId" + ] + }, + "LiftrBase.SingleSignOnProperties": { + "type": "object", + "description": "Properties specific to Single Sign On Resource", + "properties": { + "singleSignOnState": { + "$ref": "#/definitions/LiftrBase.SingleSignOnStates", + "description": "State of the Single Sign On for the organization" + }, + "enterpriseAppId": { + "type": "string", + "description": "AAD enterprise application Id used to setup SSO" + }, + "singleSignOnUrl": { + "$ref": "#/definitions/LiftrBase.Uri", + "description": "URL for SSO to be used by the partner to redirect the user to their system" + }, + "aadDomains": { + "type": "array", + "description": "List of AAD domains fetched from Microsoft Graph for user.", + "items": { + "type": "string" + } + } + } + }, + "LiftrBase.SingleSignOnStates": { + "type": "string", + "description": "Various states of the SSO resource", + "enum": [ + "Initial", + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SingleSignOnStates", + "modelAsString": true, + "values": [ + { + "name": "Initial", + "value": "Initial", + "description": "Initial state of the SSO resource" + }, + { + "name": "Enable", + "value": "Enable", + "description": "SSO is enabled for the organization" + }, + { + "name": "Disable", + "value": "Disable", + "description": "SSO is disabled for the organization" + } + ] + } + }, + "LiftrBase.Uri": { + "type": "string", + "description": "A string that represents a URI." + }, + "LiftrBase.UserDetails": { + "type": "object", + "description": "User details for an organization", + "properties": { + "firstName": { + "type": "string", + "description": "First name of the user" + }, + "lastName": { + "type": "string", + "description": "Last name of the user" + }, + "emailAddress": { + "$ref": "#/definitions/LiftrBase.email", + "description": "Email address of the user" + }, + "upn": { + "type": "string", + "description": "User's principal name" + }, + "phoneNumber": { + "type": "string", + "description": "User's phone number" + } + } + }, + "LiftrBase.email": { + "type": "string", + "description": "Reusable representation of an email address.", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + }, + "OrganizationResource": { + "type": "object", + "description": "Organization Resource by Neon", + "properties": { + "properties": { + "$ref": "#/definitions/LiftrBase.Data.OrganizationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OrganizationResourceListResult": { + "type": "object", + "description": "The response of a OrganizationResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OrganizationResource items on this page", + "items": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OrganizationResourceUpdate": { + "type": "object", + "description": "Organization Resource by Neon", + "properties": { + "properties": { + "$ref": "#/definitions/LiftrBase.Data.OrganizationPropertiesUpdate", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.TrackedResourceUpdate" + } + ] + } + }, + "parameters": {} +} diff --git a/specification/liftrneon/resource-manager/readme.md b/specification/liftrneon/resource-manager/readme.md new file mode 100644 index 000000000000..0070928868c7 --- /dev/null +++ b/specification/liftrneon/resource-manager/readme.md @@ -0,0 +1,40 @@ +# Neon.Postgres RP + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for neon service. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the neon service. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-08-01-preview +``` + +### Tag: package-2024-08-01-preview + +These settings apply only when `--tag=package-2024-08-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-08-01-preview' +input-file: + - Neon.Postgres/preview/2024-08-01-preview/neon.json +``` From c1b5abdd0fd8b25278e4bc9670c2f6c0bded9828 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Fri, 4 Oct 2024 09:17:33 -0700 Subject: [PATCH 042/101] Changed 24 days to 24 hours. (#30856) --- .../maps/data-plane/Route/preview/1.0/route.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/maps/data-plane/Route/preview/1.0/route.json b/specification/maps/data-plane/Route/preview/1.0/route.json index 92ae9d2a3e68..848fab43bc18 100644 --- a/specification/maps/data-plane/Route/preview/1.0/route.json +++ b/specification/maps/data-plane/Route/preview/1.0/route.json @@ -887,7 +887,7 @@ "/route/matrix/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using an asynchronous request.", - "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using an asynchronous (async) request. To make a synchronous (sync) request, see [Post Route Matrix Sync](/rest/api/maps/route/post-route-matrix-sync). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrix", "x-ms-client-name": "RequestRouteMatrix", "x-ms-long-running-operation": true, @@ -993,7 +993,7 @@ }, "get": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations.", - "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Get Route Matrix` API is an HTTP `GET` request that computes the travel time and distance for all possible pairs in a list of origins and destinations. Unlike the [Get Route Directions](/rest/api/maps/route/get-route-directions) API, which provide detailed route instructions, this API focuses on efficiency by giving you the cost (travel time and distance) of routing from each origin to every destination. For more information, see [Best practices for Azure Maps Route service](/azure/azure-maps/how-to-use-best-practices-for-routing).\n\nFor every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nGET https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nGET https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix GET request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a GET request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_GetRouteMatrix", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -1034,7 +1034,7 @@ "/route/matrix/sync/{format}": { "post": { "summary": "Use to get a route matrix showing the travel time and distance for all possible pairs in a list of origins and destinations, using a synchronous request.", - "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", + "description": "\n\nThe `Post Route Matrix Sync` API is an HTTP `POST` request that allows calculation of a matrix of route summaries for a set of routes defined by origin and destination locations by using a single synchronous (sync) request. To make an asynchronous (async) request, see [Post Route Matrix](/rest/api/maps/route/post-route-matrix). For every given origin, the service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table and each cell in the table contains the costs of routing from the origin to the destination for that cell. As an example, let's say a food delivery company has 20 drivers and they need to find the closest driver to pick up the delivery from the restaurant. To solve this use case, they can call Matrix Route API.\n\n\nFor each route, the travel times and distances are returned. You can use the computed costs to determine which detailed routes to calculate using the Route Directions API.\n\n\nThe maximum size of a matrix for async request is **700** and for sync request it's **100** (the number of origins multiplied by the number of destinations).\n\n\n\n### Submit Synchronous Route Matrix Request\nIf your scenario requires synchronous requests and the maximum size of the matrix is less than or equal to 100, you might want to make synchronous request. The maximum size of a matrix for this API is **100** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 10x10, 6x8, 9x8 (it does not need to be square).\n\n```\nPOST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}\n```\n\n### Submit Asynchronous Route Matrix Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex routing requests. When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. If `waitForResults` parameter in the request is set to true, user will get a 200 response if the request is finished under 120 seconds.\n\n\nThe maximum size of a matrix for this API is **700** (the number of origins multiplied by the number of destinations). With that constraint in mind, examples of possible matrix dimensions are: 50x10, 10x10, 28x25. 10x70 (it does not need to be square).\n\n\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\n\n\n\n```\nPOST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}\n```\n\nHere's a typical sequence of asynchronous operations:\n1. Client sends a Route Matrix POST request to Azure Maps\n\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Route Matrix request has been accepted.\n\n > HTTP `Error` - There was an error processing your Route Matrix request. This could either be a 400 Bad Request or any other Error status code.\n\n\n3. If the Matrix Route request was accepted successfully, the Location header in the response contains the URL to download the results of the request. This status URI looks like the following:\n\n ```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n ```\n\n\n4. Client issues a GET request on the download URL obtained in Step 3 to download the results\n\n### Download Sync Results\nWhen you make a POST request for Route Matrix Sync API, the service returns 200 response code for successful request and a response array. The response body will contain the data and there will be no possibility to retrieve the results later.\n\n### Download Async Results\nWhen a request issues a `202 Accepted` response, the request is being processed using our async pipeline. You will be given a URL to check the progress of your async request in the location header of the response. This status URI looks like the following:\n```\n GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}\n```\n\nThe URL provided by the location header will return the following responses when a `GET` request is issued.\n\n > HTTP `202 Accepted` - Matrix request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Matrix request successfully processed. The response body contains all of the results.", "operationId": "Route_PostRouteMatrixSync", "x-ms-client-name": "RequestRouteMatrixSync", "x-ms-examples": { @@ -1659,7 +1659,7 @@ "/route/directions/batch/{format}": { "post": { "summary": "Use to send a batch of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API in a single asynchronous request.", - "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** days. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", + "description": "\n\nThe `Post Route Directions Batch` API is an HTTP `POST` request that sends batches of queries to the [Get Route Directions](/rest/api/maps/route/get-route-directions) API using a single asynchronous request. You can call `Route Directions Batch` API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to **700** queries and sync API up to **100** queries. To call the `Post Route Directions Batch` API in a synchronous request, see [Post Route Directions Batch Sync](/rest/api/maps/route/post-route-directions-batch-sync).\n\n### Submit Asynchronous Batch Request\nThe Asynchronous API is appropriate for processing big volumes of relatively complex route requests\n- It allows the retrieval of results in a separate call (multiple downloads are possible).\n- The asynchronous API is optimized for reliability and is not expected to run into a timeout.\n- The number of batch items is limited to **700** for this API.\n\nWhen you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available.\nThe asynchronous responses are stored for **24** hours. The redirect URL returns a 404 response if used after the expiration period.\n\nPlease note that asynchronous batch request is a long-running operation. Here's a typical sequence of operations:\n1. Client sends a Route Directions Batch `POST` request to Azure Maps.\n```\nPOST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}\n```\n2. The server will respond with one of the following:\n\n > HTTP `202 Accepted` - Batch request has been accepted.\n\n > HTTP `Error` - There was an error processing your Batch request. This could either be a `400 Bad Request` or any other `Error` status code.\n\n3. If the batch request was accepted successfully, the `Location` header in the response contains the URL to download the results of the batch request.\n This status URI looks like following:\n```\nGET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key} \n```\n4. Client issues a `GET` request on the _download URL_ obtained in Step 3 to download the batch results.\n\n### POST Body for Batch Request\nTo send the _route directions_ queries you will use a `POST` request where the request body will contain the `batchItems` array in `json` format and the `Content-Type` header will be set to `application/json`. Here's a sample request body containing 3 _route directions_ queries:\n\n\n```json\n{\n \"batchItems\": [\n { \"query\": \"?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false\" },\n { \"query\": \"?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest\" },\n { \"query\": \"?query=48.923159,-122.557362:32.621279,-116.840362\" }\n ]\n}\n```\n\nA _route directions_ query in a batch is just a partial URL _without_ the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported _route directions_ [URI parameters](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#uri-parameters). The string values in the _route directions_ query must be properly escaped (e.g. \" character should be escaped with \\\\ ) and it should also be properly URL-encoded.\n\n\nThe async API allows caller to batch up to **700** queries and sync API up to **100** queries, and the batch should contain at least **1** query.\n\n\n### Download Asynchronous Batch Results\nTo download the async batch results you will issue a `GET` request to the batch download endpoint. This _download URL_ can be obtained from the `Location` header of a successful `POST` batch request and looks like the following:\n\n```\nhttps://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}\n```\nHere's the typical sequence of operations for downloading the batch results:\n1. Client sends a `GET` request using the _download URL_.\n2. The server will respond with one of the following:\n \n > HTTP `202 Accepted` - Batch request was accepted but is still being processed. Please try again in some time.\n\n > HTTP `200 OK` - Batch request successfully processed. The response body contains all the batch results.\n\n\n\n### Batch Response Model\nThe returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a `summary` component that indicates the `totalRequests` that were part of the original batch request and `successfulRequests`i.e. queries which were executed successfully. The batch response also includes a `batchItems` array which contains a response for each and every query in the batch request. The `batchItems` will contain the results in the exact same order the original queries were sent in the batch request. Each item in `batchItems` contains `statusCode` and `response` fields. Each `response` in `batchItems` is of one of the following types:\n\n - [`RouteDirections`](https://docs.microsoft.com/rest/api/maps/route/getroutedirections#routedirections) - If the query completed successfully.\n\n - `Error` - If the query failed. The response will contain a `code` and a `message` in this case.\n\n\nHere's a sample Batch Response with 1 _successful_ and 1 _failed_ result:\n\n\n```json\n{\n \"summary\": {\n \"successfulRequests\": 1,\n \"totalRequests\": 2\n },\n \"batchItems\": [\n {\n \"statusCode\": 200,\n \"response\": {\n \"routes\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"legs\": [\n {\n \"summary\": {\n \"lengthInMeters\": 1758,\n \"travelTimeInSeconds\": 387,\n \"trafficDelayInSeconds\": 0,\n \"departureTime\": \"2018-07-17T00:49:56+00:00\",\n \"arrivalTime\": \"2018-07-17T00:56:22+00:00\"\n },\n \"points\": [\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.34892\n },\n {\n \"latitude\": 47.62094,\n \"longitude\": -122.3485\n },\n {\n \"latitude\": 47.62095,\n \"longitude\": -122.3476\n }\n ]\n }\n ],\n \"sections\": [\n {\n \"startPointIndex\": 0,\n \"endPointIndex\": 40,\n \"sectionType\": \"TRAVEL_MODE\",\n \"travelMode\": \"bicycle\"\n }\n ]\n }\n ]\n }\n },\n {\n \"statusCode\": 400,\n \"response\":\n {\n \"error\":\n {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request: one or more parameters were incorrectly specified or are mutually exclusive.\"\n }\n }\n }\n ]\n}\n```", "operationId": "Route_PostRouteDirectionsBatch", "x-ms-client-name": "RequestRouteDirectionsBatch", "x-ms-long-running-operation": true, From b26a190235f162b15d77dad889d104d06871fb4f Mon Sep 17 00:00:00 2001 From: Yuan Zhuang <40252949+yuanzhuangyuanzhuang@users.noreply.github.com> Date: Fri, 4 Oct 2024 10:25:58 -0700 Subject: [PATCH 043/101] fix wrong para position for the newly added params for AOAI (#30849) * fix wrong para position for the newly added params * Add parallel_tool_calls to assistant api * bug fix --------- Co-authored-by: Yuan Zhuang <yuzhua@microsoft.com> Co-authored-by: Shruti Gupta <shrgupta@microsoft.com> --- .../preview/2024-09-01-preview/inference.json | 18 ++++++++++++++---- .../preview/2024-09-01-preview/inference.yaml | 6 ++++++ 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json index 3be6ffd7734d..c339e42d06a6 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json @@ -3739,6 +3739,10 @@ "nullable": true, "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n" }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls", + "nullable": true + }, "response_format": { "description": "An object specifying the format that the model must output. Compatible with [GPT-4o](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4o mini](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models), [GPT-4 Turbo](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-4-and-gpt-4-turbo-models) and all [GPT-3.5](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#gpt-35) Turbo models newer than `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which guarantees the model will match your supplied JSON schema.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n", "oneOf": [ @@ -3785,6 +3789,10 @@ "nullable": true, "default": false }, + "stream_options": { + "$ref": "#/components/schemas/chatCompletionStreamOptions", + "nullable": true + }, "temperature": { "type": "number", "minimum": 0, @@ -8202,10 +8210,6 @@ "nullable": true, "description": "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n" }, - "stream_options": { - "$ref": "#/components/schemas/chatCompletionStreamOptions", - "nullable": true - }, "max_prompt_tokens": { "type": "integer", "nullable": true, @@ -8226,6 +8230,9 @@ "$ref": "#/components/schemas/assistantsApiToolChoiceOption", "nullable": true }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, "response_format": { "$ref": "#/components/schemas/assistantsApiResponseFormatOption", "nullable": true @@ -8486,6 +8493,9 @@ "$ref": "#/components/schemas/assistantsApiToolChoiceOption", "nullable": true }, + "parallel_tool_calls": { + "$ref": "#/components/schemas/ParallelToolCalls" + }, "response_format": { "$ref": "#/components/schemas/assistantsApiResponseFormatOption", "nullable": true diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml index aa5051f82553..73e77e64decb 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml @@ -2488,6 +2488,8 @@ components: example: 1 nullable: true description: How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs. + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" presence_penalty: type: number default: 0 @@ -5723,6 +5725,8 @@ components: tool_choice: $ref: "#/components/schemas/assistantsApiToolChoiceOption" nullable: true + parallel_tool_calls: + $ref: "#/components/schemas/ParallelToolCalls" response_format: $ref: "#/components/schemas/assistantsApiResponseFormatOption" nullable: true @@ -5922,6 +5926,8 @@ components: tool_choice: $ref: "#/components/schemas/assistantsApiToolChoiceOption" nullable: true + parallel_tool_calls": + $ref: "#/components/schemas/ParallelToolCalls" response_format: $ref: "#/components/schemas/assistantsApiResponseFormatOption" nullable: true From 67713ccbb1ec783278523d55d030fa558ba34b19 Mon Sep 17 00:00:00 2001 From: jonathanserbent <34686049+jonathanserbent@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:52:53 -0500 Subject: [PATCH 044/101] Release search azure.search preview: 2024-11-01-preview (#30485) * Copy over old spec into new folder * Update version to 11-01 * Initial feature spec changes * Additional Feature Changes and Examples * Swagger Prettier Check * Swagger Lint * Fix order of semanticQuery Parameter * Apply feedback * Add back defaultoversampling and rerankWithOriginalVectors * Semantic query order * Spellcheck CI * swagger prettier CI * Make the QueryRewrites List of List of strings into a List of objects which contain a list of string --------- Co-authored-by: Jonathan Serbent <jserbent@microsoft.com> --- cSpell.json | 7 +- .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 38 + .../examples/SearchIndexCountDocuments.json | 15 + .../examples/SearchIndexGetDocument.json | 29 + .../examples/SearchIndexIndexDocuments.json | 3808 +++++ .../SearchIndexSearchDocumentsGet.json | 86 + .../SearchIndexSearchDocumentsPost.json | 220 + ...SearchIndexSearchDocumentsSemanticGet.json | 52 + ...earchIndexSearchDocumentsSemanticPost.json | 69 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 59 + .../examples/SearchServiceCreateAlias.json | 25 + .../SearchServiceCreateDataSource.json | 73 + .../examples/SearchServiceCreateIndex.json | 582 + .../examples/SearchServiceCreateIndexer.json | 74 + .../SearchServiceCreateOrUpdateAlias.json | 37 + ...SearchServiceCreateOrUpdateDataSource.json | 112 + .../SearchServiceCreateOrUpdateIndex.json | 904 ++ .../SearchServiceCreateOrUpdateIndexer.json | 115 + .../SearchServiceCreateOrUpdateSkillset.json | 440 + ...SearchServiceCreateOrUpdateSynonymMap.json | 63 + .../examples/SearchServiceCreateSkillset.json | 288 + .../SearchServiceCreateSynonymMap.json | 42 + .../examples/SearchServiceDeleteAlias.json | 16 + .../SearchServiceDeleteDataSource.json | 16 + .../examples/SearchServiceDeleteIndex.json | 16 + .../examples/SearchServiceDeleteIndexer.json | 16 + .../examples/SearchServiceDeleteSkillset.json | 16 + .../SearchServiceDeleteSynonymMap.json | 16 + .../examples/SearchServiceGetAlias.json | 20 + .../examples/SearchServiceGetDataSource.json | 45 + .../examples/SearchServiceGetIndex.json | 331 + .../SearchServiceGetIndexStatistics.json | 19 + .../examples/SearchServiceGetIndexer.json | 43 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 58 + .../examples/SearchServiceGetSkillset.json | 161 + .../examples/SearchServiceGetSynonymMap.json | 29 + .../examples/SearchServiceIndexAnalyze.json | 40 + .../examples/SearchServiceListAliases.json | 23 + .../SearchServiceListDataSources.json | 49 + .../examples/SearchServiceListIndexers.json | 46 + .../examples/SearchServiceListIndexes.json | 335 + .../examples/SearchServiceListSkillsets.json | 165 + .../SearchServiceListSynonymMaps.json | 33 + .../examples/SearchServiceResetDocs.json | 21 + .../examples/SearchServiceResetIndexer.json | 13 + .../examples/SearchServiceResetSkills.json | 20 + .../examples/SearchServiceRunIndexer.json | 13 + .../2024-11-01-preview/searchindex.json | 3277 ++++ .../2024-11-01-preview/searchservice.json | 12918 ++++++++++++++++ .../search/data-plane/Azure.Search/readme.md | 30 +- 53 files changed, 25095 insertions(+), 2 deletions(-) create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json diff --git a/cSpell.json b/cSpell.json index 12154bc72508..327f6817c544 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1239,7 +1239,12 @@ "vectorizing", "onelake", "tiktoken", - "Matryoshka" + "Matryoshka", + "rescore", + "rescoring", + "rescored", + "maxcharlength", + "submode" ] }, { diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..d7e422559283 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..1e8238c7ac9d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,38 @@ +{ + "operationId": "Documents_AutocompletePost", + "title": "SearchIndexAutocompleteDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "autocompleteRequest": { + "search": "p", + "autocompleteMode": "oneTerm", + "filter": "ownerId ne '1'", + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "searchFields": "category, ownerId", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@search.coverage": 100.0, + "value": [ + { + "text": "purple", + "queryPlusText": "<em>purple</em>" + }, + { + "text": "pink", + "queryPlusText": "<em>pink</em>" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..08553318c0e5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,15 @@ +{ + "operationId": "Documents_Count", + "title": "SearchIndexCountDocuments", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": 50 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..d528286f1839 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,29 @@ +{ + "operationId": "Documents_Get", + "title": "SearchIndexGetDocument", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "key": "1", + "$select": [ + "id", + "description", + "name", + "category", + "ownerId" + ], + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "1", + "name": "test", + "description": "test1 hello", + "category": "purple", + "ownerId": "sam" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..1376aa34cfae --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,3808 @@ +{ + "operationId": "Documents_Index", + "title": "SearchIndexIndexDocuments", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "batch": { + "value": [ + { + "@search.action": "mergeOrUpload", + "id": "0", + "name": "test", + "description": "test0 hello", + "vector1": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ], + "vector1b": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ], + "vector2": [ + 0, + 1, + 2, + 3, + 4 + ], + "vector3": [ + 0, + 1, + 2, + 3, + 4 + ], + "vector22": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "1", + "name": "test", + "description": "test1 hello", + "vector1": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ], + "vector1b": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ], + "vector2": [ + 1, + 2, + 3, + 4, + 5 + ], + "vector3": [ + 1, + 2, + 3, + 4, + 5 + ], + "vector22": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "2", + "name": "test", + "description": "test2 hello", + "vector1": [ + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ], + "vector1b": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ], + "vector2": [ + 2, + 3, + 4, + 5, + 6 + ], + "vector3": [ + 2, + 3, + 4, + 5, + 6 + ], + "vector22": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "3", + "name": "test", + "description": "test3 hello", + "vector1": [ + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ], + "vector1b": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ], + "vector2": [ + 3, + 4, + 5, + 6, + 7 + ], + "vector3": [ + 3, + 4, + 5, + 6, + 7 + ], + "vector22": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "4", + "name": "test", + "description": "test4 hello", + "vector1": [ + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ], + "vector1b": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ], + "vector2": [ + 4, + 5, + 6, + 7, + 8 + ], + "vector3": [ + 4, + 5, + 6, + 7, + 8 + ], + "vector22": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "5", + "name": "test", + "description": "test5 hello", + "vector1": [ + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ], + "vector1b": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ], + "vector2": [ + 5, + 6, + 7, + 8, + 9 + ], + "vector3": [ + 5, + 6, + 7, + 8, + 9 + ], + "vector22": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "6", + "name": "test", + "description": "test6 hello", + "vector1": [ + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ], + "vector1b": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ], + "vector2": [ + 6, + 7, + 8, + 9, + 10 + ], + "vector3": [ + 6, + 7, + 8, + 9, + 10 + ], + "vector22": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "7", + "name": "test", + "description": "test7 hello", + "vector1": [ + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ], + "vector1b": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ], + "vector2": [ + 7, + 8, + 9, + 10, + 11 + ], + "vector3": [ + 7, + 8, + 9, + 10, + 11 + ], + "vector22": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "8", + "name": "test", + "description": "test8 hello", + "vector1": [ + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ], + "vector1b": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ], + "vector2": [ + 8, + 9, + 10, + 11, + 12 + ], + "vector3": [ + 8, + 9, + 10, + 11, + 12 + ], + "vector22": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "9", + "name": "test", + "description": "test9 hello", + "vector1": [ + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ], + "vector1b": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ], + "vector2": [ + 9, + 10, + 11, + 12, + 13 + ], + "vector3": [ + 9, + 10, + 11, + 12, + 13 + ], + "vector22": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "10", + "name": "test", + "description": "test10 hello", + "vector1": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "vector1b": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ], + "vector2": [ + 10, + 11, + 12, + 13, + 14 + ], + "vector3": [ + 10, + 11, + 12, + 13, + 14 + ], + "vector22": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "11", + "name": "test", + "description": "test11 hello", + "vector1": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "vector1b": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ], + "vector2": [ + 11, + 12, + 13, + 14, + 15 + ], + "vector3": [ + 11, + 12, + 13, + 14, + 15 + ], + "vector22": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "12", + "name": "test", + "description": "test12 hello", + "vector1": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "vector1b": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ], + "vector2": [ + 12, + 13, + 14, + 15, + 16 + ], + "vector3": [ + 12, + 13, + 14, + 15, + 16 + ], + "vector22": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "13", + "name": "test", + "description": "test13 hello", + "vector1": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "vector1b": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ], + "vector2": [ + 13, + 14, + 15, + 16, + 17 + ], + "vector3": [ + 13, + 14, + 15, + 16, + 17 + ], + "vector22": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "14", + "name": "test", + "description": "test14 hello", + "vector1": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "vector1b": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ], + "vector2": [ + 14, + 15, + 16, + 17, + 18 + ], + "vector3": [ + 14, + 15, + 16, + 17, + 18 + ], + "vector22": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "15", + "name": "test", + "description": "test15 hello", + "vector1": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "vector1b": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ], + "vector2": [ + 15, + 16, + 17, + 18, + 19 + ], + "vector3": [ + 15, + 16, + 17, + 18, + 19 + ], + "vector22": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "16", + "name": "test", + "description": "test16 hello", + "vector1": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "vector1b": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ], + "vector2": [ + 16, + 17, + 18, + 19, + 20 + ], + "vector3": [ + 16, + 17, + 18, + 19, + 20 + ], + "vector22": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "17", + "name": "test", + "description": "test17 hello", + "vector1": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "vector1b": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ], + "vector2": [ + 17, + 18, + 19, + 20, + 21 + ], + "vector3": [ + 17, + 18, + 19, + 20, + 21 + ], + "vector22": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "18", + "name": "test", + "description": "test18 hello", + "vector1": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "vector1b": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ], + "vector2": [ + 18, + 19, + 20, + 21, + 22 + ], + "vector3": [ + 18, + 19, + 20, + 21, + 22 + ], + "vector22": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "19", + "name": "test", + "description": "test19 hello", + "vector1": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "vector1b": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ], + "vector2": [ + 19, + 20, + 21, + 22, + 23 + ], + "vector3": [ + 19, + 20, + 21, + 22, + 23 + ], + "vector22": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "20", + "name": "test", + "description": "test20 hello", + "vector1": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "vector1b": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ], + "vector2": [ + 20, + 21, + 22, + 23, + 24 + ], + "vector3": [ + 20, + 21, + 22, + 23, + 24 + ], + "vector22": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "ownerId": "benny", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "21", + "name": "test", + "description": "test21 hello", + "vector1": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "vector1b": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ], + "vector2": [ + 21, + 22, + 23, + 24, + 25 + ], + "vector3": [ + 21, + 22, + 23, + 24, + 25 + ], + "vector22": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "22", + "name": "test", + "description": "test22 hello", + "vector1": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "vector1b": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ], + "vector2": [ + 22, + 23, + 24, + 25, + 26 + ], + "vector3": [ + 22, + 23, + 24, + 25, + 26 + ], + "vector22": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "23", + "name": "test", + "description": "test23 hello", + "vector1": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "vector1b": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ], + "vector2": [ + 23, + 24, + 25, + 26, + 27 + ], + "vector3": [ + 23, + 24, + 25, + 26, + 27 + ], + "vector22": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "24", + "name": "test", + "description": "test24 hello", + "vector1": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "vector1b": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ], + "vector2": [ + 24, + 25, + 26, + 27, + 28 + ], + "vector3": [ + 24, + 25, + 26, + 27, + 28 + ], + "vector22": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "ownerId": "ryan", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "25", + "name": "test", + "description": "test25 hello", + "vector1": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "vector1b": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ], + "vector2": [ + 25, + 26, + 27, + 28, + 29 + ], + "vector3": [ + 25, + 26, + 27, + 28, + 29 + ], + "vector22": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "26", + "name": "test", + "description": "test26 hello", + "vector1": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "vector1b": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ], + "vector2": [ + 26, + 27, + 28, + 29, + 30 + ], + "vector3": [ + 26, + 27, + 28, + 29, + 30 + ], + "vector22": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "27", + "name": "test", + "description": "test27 hello", + "vector1": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "vector1b": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ], + "vector2": [ + 27, + 28, + 29, + 30, + 31 + ], + "vector3": [ + 27, + 28, + 29, + 30, + 31 + ], + "vector22": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "28", + "name": "test", + "description": "test28 hello", + "vector1": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "vector1b": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ], + "vector2": [ + 28, + 29, + 30, + 31, + 32 + ], + "vector3": [ + 28, + 29, + 30, + 31, + 32 + ], + "vector22": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "29", + "name": "test", + "description": "test29 hello", + "vector1": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "vector1b": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ], + "vector2": [ + 29, + 30, + 31, + 32, + 33 + ], + "vector3": [ + 29, + 30, + 31, + 32, + 33 + ], + "vector22": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "30", + "name": "test", + "description": "test30 hello", + "vector1": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "vector1b": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ], + "vector2": [ + 30, + 31, + 32, + 33, + 34 + ], + "vector3": [ + 30, + 31, + 32, + 33, + 34 + ], + "vector22": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "ownerId": "benny", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "31", + "name": "test", + "description": "test31 hello", + "vector1": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "vector1b": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ], + "vector2": [ + 31, + 32, + 33, + 34, + 35 + ], + "vector3": [ + 31, + 32, + 33, + 34, + 35 + ], + "vector22": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "32", + "name": "test", + "description": "test32 hello", + "vector1": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "vector1b": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ], + "vector2": [ + 32, + 33, + 34, + 35, + 36 + ], + "vector3": [ + 32, + 33, + 34, + 35, + 36 + ], + "vector22": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "33", + "name": "test", + "description": "test33 hello", + "vector1": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "vector1b": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ], + "vector2": [ + 33, + 34, + 35, + 36, + 37 + ], + "vector3": [ + 33, + 34, + 35, + 36, + 37 + ], + "vector22": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "34", + "name": "test", + "description": "test34 hello", + "vector1": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "vector1b": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ], + "vector2": [ + 34, + 35, + 36, + 37, + 38 + ], + "vector3": [ + 34, + 35, + 36, + 37, + 38 + ], + "vector22": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "35", + "name": "test", + "description": "test35 hello", + "vector1": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "vector1b": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ], + "vector2": [ + 35, + 36, + 37, + 38, + 39 + ], + "vector3": [ + 35, + 36, + 37, + 38, + 39 + ], + "vector22": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "36", + "name": "test", + "description": "test36 hello", + "vector1": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "vector1b": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ], + "vector2": [ + 36, + 37, + 38, + 39, + 40 + ], + "vector3": [ + 36, + 37, + 38, + 39, + 40 + ], + "vector22": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "37", + "name": "test", + "description": "test37 hello", + "vector1": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "vector1b": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ], + "vector2": [ + 37, + 38, + 39, + 40, + 41 + ], + "vector3": [ + 37, + 38, + 39, + 40, + 41 + ], + "vector22": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "38", + "name": "test", + "description": "test38 hello", + "vector1": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "vector1b": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ], + "vector2": [ + 38, + 39, + 40, + 41, + 42 + ], + "vector3": [ + 38, + 39, + 40, + 41, + 42 + ], + "vector22": [ + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67 + ], + "ownerId": "sam", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "39", + "name": "test", + "description": "test39 hello", + "vector1": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "vector1b": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ], + "vector2": [ + 39, + 40, + 41, + 42, + 43 + ], + "vector3": [ + 39, + 40, + 41, + 42, + 43 + ], + "vector22": [ + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68 + ], + "ownerId": "ryan", + "category": "pink" + }, + { + "@search.action": "mergeOrUpload", + "id": "40", + "name": "test", + "description": "test40 hello", + "vector1": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "vector1b": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ], + "vector2": [ + 40, + 41, + 42, + 43, + 44 + ], + "vector3": [ + 40, + 41, + 42, + 43, + 44 + ], + "vector22": [ + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69 + ], + "ownerId": "benny", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "41", + "name": "test", + "description": "test41 hello", + "vector1": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "vector1b": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ], + "vector2": [ + 41, + 42, + 43, + 44, + 45 + ], + "vector3": [ + 41, + 42, + 43, + 44, + 45 + ], + "vector22": [ + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "42", + "name": "test", + "description": "test42 hello", + "vector1": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "vector1b": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ], + "vector2": [ + 42, + 43, + 44, + 45, + 46 + ], + "vector3": [ + 42, + 43, + 44, + 45, + 46 + ], + "vector22": [ + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71 + ], + "ownerId": "ryan", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "43", + "name": "test", + "description": "test43 hello", + "vector1": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "vector1b": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ], + "vector2": [ + 43, + 44, + 45, + 46, + 47 + ], + "vector3": [ + 43, + 44, + 45, + 46, + 47 + ], + "vector22": [ + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "44", + "name": "test", + "description": "test44 hello", + "vector1": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "vector1b": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ], + "vector2": [ + 44, + 45, + 46, + 47, + 48 + ], + "vector3": [ + 44, + 45, + 46, + 47, + 48 + ], + "vector22": [ + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73 + ], + "ownerId": "sam", + "category": "green" + }, + { + "@search.action": "mergeOrUpload", + "id": "45", + "name": "test", + "description": "test45 hello", + "vector1": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "vector1b": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ], + "vector2": [ + 45, + 46, + 47, + 48, + 49 + ], + "vector3": [ + 45, + 46, + 47, + 48, + 49 + ], + "vector22": [ + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74 + ], + "ownerId": "ryan", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "46", + "name": "test", + "description": "test46 hello", + "vector1": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "vector1b": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ], + "vector2": [ + 46, + 47, + 48, + 49, + 50 + ], + "vector3": [ + 46, + 47, + 48, + 49, + 50 + ], + "vector22": [ + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75 + ], + "ownerId": "sam", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "47", + "name": "test", + "description": "test47 hello", + "vector1": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "vector1b": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ], + "vector2": [ + 47, + 48, + 49, + 50, + 51 + ], + "vector3": [ + 47, + 48, + 49, + 50, + 51 + ], + "vector22": [ + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75, + 76 + ], + "ownerId": "sam", + "category": "orange" + }, + { + "@search.action": "mergeOrUpload", + "id": "no-vectors", + "name": "test", + "description": "no vector", + "ownerId": "sam", + "category": "purple" + }, + { + "@search.action": "mergeOrUpload", + "id": "empty-vectors", + "name": "test", + "description": "no vector", + "ownerId": "sam", + "category": "purple" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "0", + "status": true, + "statusCode": 201 + }, + { + "key": "1", + "status": true, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "statusCode": 201 + }, + { + "key": "3", + "status": true, + "statusCode": 201 + }, + { + "key": "4", + "status": true, + "statusCode": 201 + }, + { + "key": "5", + "status": true, + "statusCode": 201 + }, + { + "key": "6", + "status": true, + "statusCode": 201 + }, + { + "key": "7", + "status": true, + "statusCode": 201 + }, + { + "key": "8", + "status": true, + "statusCode": 201 + }, + { + "key": "9", + "status": true, + "statusCode": 201 + }, + { + "key": "10", + "status": true, + "statusCode": 201 + }, + { + "key": "11", + "status": true, + "statusCode": 201 + }, + { + "key": "12", + "status": true, + "statusCode": 201 + }, + { + "key": "13", + "status": true, + "statusCode": 201 + }, + { + "key": "14", + "status": true, + "statusCode": 201 + }, + { + "key": "15", + "status": true, + "statusCode": 201 + }, + { + "key": "16", + "status": true, + "statusCode": 201 + }, + { + "key": "17", + "status": true, + "statusCode": 201 + }, + { + "key": "18", + "status": true, + "statusCode": 201 + }, + { + "key": "19", + "status": true, + "statusCode": 201 + }, + { + "key": "20", + "status": true, + "statusCode": 201 + }, + { + "key": "21", + "status": true, + "statusCode": 201 + }, + { + "key": "22", + "status": true, + "statusCode": 201 + }, + { + "key": "23", + "status": true, + "statusCode": 201 + }, + { + "key": "24", + "status": true, + "statusCode": 201 + }, + { + "key": "25", + "status": true, + "statusCode": 201 + }, + { + "key": "26", + "status": true, + "statusCode": 201 + }, + { + "key": "27", + "status": true, + "statusCode": 201 + }, + { + "key": "28", + "status": true, + "statusCode": 201 + }, + { + "key": "29", + "status": true, + "statusCode": 201 + }, + { + "key": "30", + "status": true, + "statusCode": 201 + }, + { + "key": "31", + "status": true, + "statusCode": 201 + }, + { + "key": "32", + "status": true, + "statusCode": 201 + }, + { + "key": "33", + "status": true, + "statusCode": 201 + }, + { + "key": "34", + "status": true, + "statusCode": 201 + }, + { + "key": "35", + "status": true, + "statusCode": 201 + }, + { + "key": "36", + "status": true, + "statusCode": 201 + }, + { + "key": "37", + "status": true, + "statusCode": 201 + }, + { + "key": "38", + "status": true, + "statusCode": 201 + }, + { + "key": "39", + "status": true, + "statusCode": 201 + }, + { + "key": "40", + "status": true, + "statusCode": 201 + }, + { + "key": "41", + "status": true, + "statusCode": 201 + }, + { + "key": "42", + "status": true, + "statusCode": 201 + }, + { + "key": "43", + "status": true, + "statusCode": 201 + }, + { + "key": "44", + "status": true, + "statusCode": 201 + }, + { + "key": "45", + "status": true, + "statusCode": 201 + }, + { + "key": "46", + "status": true, + "statusCode": 201 + }, + { + "key": "47", + "status": true, + "statusCode": 201 + }, + { + "key": "no-vectors", + "status": true, + "statusCode": 201 + }, + { + "key": "empty-vectors", + "status": true, + "statusCode": 201 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "0", + "status": true, + "statusCode": 201 + }, + { + "key": "1", + "status": true, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "statusCode": 201 + }, + { + "key": "3", + "status": true, + "statusCode": 201 + }, + { + "key": "4", + "status": true, + "statusCode": 201 + }, + { + "key": "5", + "status": true, + "statusCode": 201 + }, + { + "key": "6", + "status": true, + "statusCode": 201 + }, + { + "key": "7", + "status": true, + "statusCode": 201 + }, + { + "key": "8", + "status": true, + "statusCode": 201 + }, + { + "key": "9", + "status": true, + "statusCode": 201 + }, + { + "key": "10", + "status": true, + "statusCode": 201 + }, + { + "key": "11", + "status": true, + "statusCode": 201 + }, + { + "key": "12", + "status": true, + "statusCode": 201 + }, + { + "key": "13", + "status": true, + "statusCode": 201 + }, + { + "key": "14", + "status": true, + "statusCode": 201 + }, + { + "key": "15", + "status": true, + "statusCode": 201 + }, + { + "key": "16", + "status": true, + "statusCode": 201 + }, + { + "key": "17", + "status": true, + "statusCode": 201 + }, + { + "key": "18", + "status": true, + "statusCode": 201 + }, + { + "key": "19", + "status": true, + "statusCode": 201 + }, + { + "key": "20", + "status": true, + "statusCode": 201 + }, + { + "key": "21", + "status": true, + "statusCode": 201 + }, + { + "key": "22", + "status": true, + "statusCode": 201 + }, + { + "key": "23", + "status": true, + "statusCode": 201 + }, + { + "key": "24", + "status": true, + "statusCode": 201 + }, + { + "key": "25", + "status": true, + "statusCode": 201 + }, + { + "key": "26", + "status": true, + "statusCode": 201 + }, + { + "key": "27", + "status": true, + "statusCode": 201 + }, + { + "key": "28", + "status": true, + "statusCode": 201 + }, + { + "key": "29", + "status": true, + "statusCode": 201 + }, + { + "key": "30", + "status": true, + "statusCode": 201 + }, + { + "key": "31", + "status": true, + "statusCode": 201 + }, + { + "key": "32", + "status": true, + "statusCode": 201 + }, + { + "key": "33", + "status": true, + "statusCode": 201 + }, + { + "key": "34", + "status": true, + "statusCode": 201 + }, + { + "key": "35", + "status": true, + "statusCode": 201 + }, + { + "key": "36", + "status": true, + "statusCode": 201 + }, + { + "key": "37", + "status": true, + "statusCode": 201 + }, + { + "key": "38", + "status": true, + "statusCode": 201 + }, + { + "key": "39", + "status": true, + "statusCode": 201 + }, + { + "key": "40", + "status": true, + "statusCode": 201 + }, + { + "key": "41", + "status": true, + "statusCode": 201 + }, + { + "key": "42", + "status": true, + "statusCode": 201 + }, + { + "key": "43", + "status": true, + "statusCode": 201 + }, + { + "key": "44", + "status": true, + "statusCode": 201 + }, + { + "key": "45", + "status": true, + "statusCode": 201 + }, + { + "key": "46", + "status": true, + "statusCode": 201 + }, + { + "key": "47", + "status": true, + "statusCode": 201 + }, + { + "key": "no-vectors", + "status": true, + "statusCode": 201 + }, + { + "key": "empty-vectors", + "status": true, + "statusCode": 201 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..1267b386a073 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "<em>Nice</em> <em>Hotel</em>" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy <em>Hotel</em>" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..eb57be4b7bc3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,220 @@ +{ + "operationId": "Documents_SearchPost", + "title": "SearchIndexSearchDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "searchRequest": { + "count": true, + "facets": [ + "ownerId" + ], + "filter": "category eq 'purple' or category eq 'pink'", + "highlight": "category", + "highlightPostTag": "</em>", + "highlightPreTag": "</em>", + "orderby": "id desc", + "queryType": "simple", + "scoringStatistics": "global", + "sessionId": "mysessionid", + "scoringParameters": [ + "categoryTag:desiredCategoryValue" + ], + "scoringProfile": "stringFieldBoost", + "search": "purple", + "searchFields": "id,name,description,category,ownerId", + "searchMode": "any", + "select": "id,name,description,category,ownerId", + "skip": 0, + "top": 10, + "vectorQueries": [ + { + "vector": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9 + ], + "kind": "vector", + "k": 50, + "fields": "vector22, vector1b", + "oversampling": 20, + "weight": 1, + "threshold": { + "value": 0.984, + "kind": "vectorSimilarity" + }, + "filterOverride": "ownerId eq 'sam'" + } + ], + "vectorFilterMode": "preFilter", + "hybridSearch": { + "maxTextRecallSize": 100, + "countAndFacetMode": "countAllResults" + } + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 27, + "@search.facets": { + "ownerId": [ + { + "count": 16, + "value": "sam" + }, + { + "count": 8, + "value": "ryan" + }, + { + "count": 3, + "value": "benny" + } + ] + }, + "value": [ + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "no-vectors", + "name": "test", + "description": "no vector", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "empty-vectors", + "name": "test", + "description": "no vector", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "9", + "name": "test", + "description": "test9 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "8", + "name": "test", + "description": "test8 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "7", + "name": "test", + "description": "test7 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "6", + "name": "test", + "description": "test6 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "5", + "name": "test", + "description": "test5 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "4", + "name": "test", + "description": "test4 hello", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "3", + "name": "test", + "description": "test3 hello", + "category": "purple", + "ownerId": "ryan" + }, + { + "@search.score": 1.0, + "@search.highlights": { + "category": [ + "</em>purple</em>" + ] + }, + "id": "24", + "name": "test", + "description": "test24 hello", + "category": "purple", + "ownerId": "ryan" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json new file mode 100644 index 000000000000..656b6db2b4a6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticGet.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.answers": [ + { + "key": "4123", + "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).", + "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).", + "score": 0.94639826 + } + ], + "value": [ + { + "@search.score": 0.5479723, + "@search.rerankerScore": 1.0321671911515296, + "@search.captions": [ + { + "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.", + "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America." + } + ], + "id": "4123", + "title": "Earth Atmosphere", + "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n", + "locations": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json new file mode 100644 index 000000000000..1b03fad7f52b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSearchDocumentsSemanticPost.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "searchRequest": { + "count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.answers": [ + { + "key": "4123", + "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).", + "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).", + "score": 0.94639826 + } + ], + "@search.nextPageParameters": { + "count": true, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "queryType": "semantic", + "search": "how do clouds form", + "semanticConfiguration": "my-semantic-config", + "answers": "extractive|count-3", + "captions": "extractive|highlight-true", + "semanticErrorHandling": "partial", + "semanticMaxWaitInMilliseconds": 780, + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 0.5479723, + "@search.rerankerScore": 1.0321671911515296, + "@search.captions": [ + { + "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.", + "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America." + } + ], + "id": "4123", + "title": "Earth Atmosphere", + "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n", + "locations": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-01-preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..c7b3a006ad5b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2024-11-01-preview", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice <em>Hotel</em>", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy <em>Hotel</em>", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..1d1c05aba34d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,59 @@ +{ + "operationId": "Documents_SuggestPost", + "title": "SearchIndexSuggestDocumentsPost", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "suggestRequest": { + "filter": "ownerId eq 'sam' and id lt '15'", + "highlightPostTag": "</em>", + "highlightPreTag": "<em>", + "minimumCoverage": 80, + "orderby": "id desc", + "search": "p", + "searchFields": "category", + "select": "id,name,category,ownerId", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@search.coverage": 100.0, + "value": [ + { + "@search.text": "<em>p</em>urple", + "id": "14", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "13", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "11", + "name": "test", + "category": "purple", + "ownerId": "sam" + }, + { + "@search.text": "<em>p</em>urple", + "id": "1", + "name": "test", + "category": "purple", + "ownerId": "sam" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json new file mode 100644 index 000000000000..bc0e3d0410d0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateAlias.json @@ -0,0 +1,25 @@ +{ + "operationId": "Aliases_Create", + "title": "SearchServiceCreateAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "alias": { + "name": "tempalias", + "indexes": [ + "preview-test" + ] + } + }, + "responses": { + "201": { + "body": { + "name": "tempalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..dfeca99c161c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,73 @@ +{ + "operationId": "DataSources_Create", + "title": "SearchServiceCreateDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "dataSource": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "highWaterMarkColumnName": "metadata_storage_last_modified", + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + "dataDeletionDetectionPolicy": { + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true", + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..7112b1f89d15 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,582 @@ +{ + "operationId": "Indexes_Create", + "title": "SearchServiceCreateIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "index": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "key": true, + "sortable": true + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 20, + "vectorSearchProfile": "config1" + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "name", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "description", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "standard.lucene" + }, + { + "name": "category", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "ownerId", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "text": { + "weights": { + "name": 3, + "description": 1, + "category": 2, + "ownerId": 1 + } + }, + "functions": [ + { + "tag": { + "tagsParameter": "categoryTag" + }, + "type": "tag", + "fieldName": "category", + "boost": 2 + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ], + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "normalizers": [], + "semantic": {}, + "vectorSearch": { + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "algorithms": [ + { + "hnswParameters": { + "metric": "cosine" + }, + "name": "cosine", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "euclidean" + }, + "name": "euclidean", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "dotProduct" + }, + "name": "dotProduct", + "kind": "hnsw" + } + ], + "vectorizers": [ + { + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com/", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + }, + "name": "openai", + "kind": "azureOpenAI" + }, + { + "customWebApiParameters": { + "uri": "https://my-custom-endpoint.org/", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "httpMethod": "POST", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + }, + "name": "custom-web-api", + "kind": "customWebApi" + }, + { + "amlParameters": { + "uri": "https://my-custom-endpoint.org/", + "resourceId": "aml resource id", + "timeout": "PT1M", + "region": "aml region", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + }, + "name": "aml", + "kind": "aml" + } + ], + "compressions": [ + { + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "name": "mySQ8", + "kind": "scalarQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..9731be059de3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,74 @@ +{ + "operationId": "Indexers_Create", + "title": "SearchServiceCreateIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "indexer": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "schedule": { + "interval": "P1D" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToMany" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToMany" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json new file mode 100644 index 000000000000..67ec8b97cf71 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateAlias.json @@ -0,0 +1,37 @@ +{ + "operationId": "Aliases_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "myalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "alias": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + }, + "201": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..833560453684 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,112 @@ +{ + "operationId": "DataSources_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "tempdatasource", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "dataSource": { + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "highWaterMarkColumnName": "metadata_storage_last_modified", + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + "dataDeletionDetectionPolicy": { + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true", + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..13234c786119 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,904 @@ +{ + "operationId": "Indexes_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "temp-preview-test", + "allowIndexDowntime": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "index": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "key": true, + "sortable": true + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 20, + "vectorSearchProfile": "config1" + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 5, + "vectorSearchProfile": "config3" + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "retrievable": true, + "searchable": true, + "dimensions": 10, + "vectorSearchProfile": "config2" + }, + { + "name": "name", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "description", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "standard.lucene" + }, + { + "name": "category", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + }, + { + "name": "ownerId", + "type": "Edm.String", + "retrievable": true, + "searchable": true, + "filterable": true, + "sortable": true, + "facetable": true, + "analyzer": "en.lucene" + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "text": { + "weights": { + "name": 3, + "description": 1, + "category": 2, + "ownerId": 1 + } + }, + "functions": [ + { + "tag": { + "tagsParameter": "categoryTag" + }, + "type": "tag", + "fieldName": "category", + "boost": 2 + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ], + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "normalizers": [], + "semantic": {}, + "vectorSearch": { + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "algorithms": [ + { + "hnswParameters": { + "metric": "cosine" + }, + "name": "cosine", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "euclidean" + }, + "name": "euclidean", + "kind": "hnsw" + }, + { + "hnswParameters": { + "metric": "dotProduct" + }, + "name": "dotProduct", + "kind": "hnsw" + } + ], + "vectorizers": [ + { + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com/", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + }, + "name": "openai", + "kind": "azureOpenAI" + }, + { + "customWebApiParameters": { + "uri": "https://my-custom-endpoint.org/", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "httpMethod": "POST", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + }, + "name": "custom-web-api", + "kind": "customWebApi" + }, + { + "amlParameters": { + "uri": "https://my-custom-endpoint.org/", + "resourceId": "aml resource id", + "timeout": "PT1M", + "region": "aml region", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + }, + "name": "aml", + "kind": "aml" + } + ], + "compressions": [ + { + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "name": "mySQ8", + "kind": "scalarQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10, + "rescoreStorageMethod": "preserveOriginals" + }, + "truncationDimension": 2 + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "temp-preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "api-key", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..5eaefa934ef2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,115 @@ +{ + "operationId": "Indexers_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "disableCacheReprocessingChangeDetection": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "schedule": { + "interval": "P1D" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": { + "parsingMode": "markdown", + "markdownParsingSubmode": "oneToOne" + } + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..0385859a626e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,440 @@ +{ + "operationId": "Skillsets_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "tempskillset", + "api-version": "2024-11-01-preview", + "ignoreResetRequirements": null, + "disableCacheReprocessingChangeDetection": null, + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "skillset": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "countryHint", + "source": "/document/countryHint" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + }, + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "inputs": [ + { + "name": "file_data", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com", + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..7e14a451af29 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,63 @@ +{ + "operationId": "SynonymMaps_CreateOrUpdate", + "title": "SearchServiceCreateOrUpdateSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null, + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..4204b09bc7a2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,288 @@ +{ + "operationId": "Skillsets_Create", + "title": "SearchServiceCreateSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "skillset": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "countryHint", + "source": "/document/countryHint" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + }, + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "inputs": [ + { + "name": "file_data", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com", + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "tempskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "cognitiveServices": { + "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey", + "key": "myKey", + "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..9ee48aae761b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,42 @@ +{ + "operationId": "SynonymMaps_Create", + "title": "SearchServiceCreateSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "synonymMap": { + "name": "tempsynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + }, + "responses": { + "201": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "tempsynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json new file mode 100644 index 000000000000..889089824926 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteAlias.json @@ -0,0 +1,16 @@ +{ + "operationId": "Aliases_Delete", + "title": "SearchServiceDeleteAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "tempalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..4d2d7eca9289 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,16 @@ +{ + "operationId": "DataSources_Delete", + "title": "SearchServiceDeleteDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "tempdatasource", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..cd5240a09a9e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,16 @@ +{ + "operationId": "Indexes_Delete", + "title": "SearchServiceDeleteIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "temp-preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..ecc4f149f674 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,16 @@ +{ + "operationId": "Indexers_Delete", + "title": "SearchServiceDeleteIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "tempindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "404": {}, + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..9b43b2af7df4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,16 @@ +{ + "operationId": "Skillsets_Delete", + "title": "SearchServiceDeleteSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "tempskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..53b4c7485013 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,16 @@ +{ + "operationId": "SynonymMaps_Delete", + "title": "SearchServiceDeleteSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "tempsynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "If-Match": null, + "If-None-Match": null + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json new file mode 100644 index 000000000000..8bdef8764719 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetAlias.json @@ -0,0 +1,20 @@ +{ + "operationId": "Aliases_Get", + "title": "SearchServiceGetAlias", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "aliasName": "myalias", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..903cb9f52307 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,45 @@ +{ + "operationId": "DataSources_Get", + "title": "SearchServiceGetDataSource", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "dataSourceName": "mydocdbdatasource", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mydocdbdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..adb39be8a2f1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,331 @@ +{ + "operationId": "Indexes_Get", + "title": "SearchServiceGetIndex", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "<redacted>", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..edca0dc5aa5b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,19 @@ +{ + "operationId": "Indexes_GetStatistics", + "title": "SearchServiceGetIndexStatistics", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "documentCount": 12, + "storageSize": 123456, + "vectorIndexSize": 123456 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..b7f67eff7c54 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,43 @@ +{ + "operationId": "Indexers_Get", + "title": "SearchServiceGetIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": {} + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..801414653941 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "PT22H", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..4122c86506f5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,58 @@ +{ + "operationId": "GetServiceStatistics", + "title": "SearchServiceGetServiceStatistics", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 12 + }, + "indexesCount": { + "usage": 2, + "quota": 2 + }, + "indexersCount": { + "usage": 2, + "quota": 2 + }, + "dataSourcesCount": { + "usage": 2, + "quota": 2 + }, + "storageSize": { + "usage": 123456, + "quota": 10485760 + }, + "synonymMaps": { + "usage": 3, + "quota": 3 + }, + "skillsetCount": { + "usage": 2, + "quota": 2 + }, + "aliasesCount": { + "usage": 4, + "quota": 4 + }, + "vectorIndexSize": { + "usage": 123456 + } + }, + "limits": { + "maxStoragePerIndex": 10485760, + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 40, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..f5460462a599 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,161 @@ +{ + "operationId": "Skillsets_Get", + "title": "SearchServiceGetSkillset", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "myskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "context": "/document", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "context": "/document", + "defaultLanguageCode": "en", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "pageOverlapLength": 0, + "maximumPagesToTake": 0, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "defaultLanguageCode": "en", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "context": "/document", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "batchSize": 1000, + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..dafbceb70d0d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,29 @@ +{ + "operationId": "SynonymMaps_Get", + "title": "SearchServiceGetSynonymMap", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..f990fed87fd6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,40 @@ +{ + "operationId": "Indexes_Analyze", + "title": "SearchServiceIndexAnalyze", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexName": "preview-test", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "request": { + "text": "Text to analyze", + "analyzer": "ar.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json new file mode 100644 index 000000000000..69c9ecb9b00c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListAliases.json @@ -0,0 +1,23 @@ +{ + "operationId": "Aliases_List", + "title": "SearchServiceListAliases", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myalias", + "indexes": [ + "preview-test" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..845e2dd9704e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,49 @@ +{ + "operationId": "DataSources_List", + "title": "SearchServiceListDataSources", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mydocdbdatasource", + "description": "My Azure Blob data source.", + "type": "azureblob", + "credentials": { + "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "container": { + "name": "doc-extraction-skillset", + "query": "E2E_Dsat" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "metadata_storage_last_modified" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..ee4a73b3eed5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,46 @@ +{ + "operationId": "Indexers_List", + "title": "SearchServiceListIndexers", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": "*", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "Description of the indexer", + "dataSourceName": "mydocdbdatasource", + "skillsetName": "myskillset", + "targetIndexName": "preview-test", + "disabled": false, + "schedule": { + "interval": "P1D", + "startTime": "2024-06-06T00:01:50.265Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "configuration": {} + }, + "fieldMappings": [], + "outputFieldMappings": [], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..b633eb879d39 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,335 @@ +{ + "operationId": "Indexes_List", + "title": "SearchServiceListIndexes", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "preview-test", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": true, + "synonymMaps": [] + }, + { + "name": "vector1", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 20, + "vectorSearchProfile": "config1", + "synonymMaps": [] + }, + { + "name": "vector1b", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "vector2", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector3", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 5, + "vectorSearchProfile": "config3", + "synonymMaps": [] + }, + { + "name": "vector22", + "type": "Collection(Edm.Single)", + "searchable": true, + "filterable": false, + "retrievable": true, + "stored": true, + "sortable": false, + "facetable": false, + "key": false, + "dimensions": 10, + "vectorSearchProfile": "config2", + "synonymMaps": [] + }, + { + "name": "name", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "standard.lucene", + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + }, + { + "name": "ownerId", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "stored": true, + "sortable": true, + "facetable": true, + "key": false, + "analyzer": "en.lucene", + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "stringFieldBoost", + "functionAggregation": "sum", + "text": { + "weights": { + "name": 3.0, + "description": 1.0, + "category": 2.0, + "ownerId": 1.0 + } + }, + "functions": [ + { + "fieldName": "category", + "interpolation": "linear", + "type": "tag", + "boost": 2.0, + "tag": { + "tagsParameter": "categoryTag" + } + } + ] + } + ], + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "category", + "ownerId" + ] + } + ], + "analyzers": [ + { + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "name": "tagsAnalyzer", + "tokenizer": "standard_v2", + "tokenFilters": [ + "common_grams" + ], + "charFilters": [ + "html_strip" + ] + } + ], + "normalizers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity" + }, + "semantic": { + "configurations": [] + }, + "vectorSearch": { + "algorithms": [ + { + "name": "cosine", + "kind": "hnsw", + "hnswParameters": { + "metric": "cosine", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "euclidean", + "kind": "hnsw", + "hnswParameters": { + "metric": "euclidean", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + }, + { + "name": "dotProduct", + "kind": "hnsw", + "hnswParameters": { + "metric": "dotProduct", + "m": 4, + "efConstruction": 400, + "efSearch": 500 + } + } + ], + "profiles": [ + { + "name": "config1", + "algorithm": "cosine", + "vectorizer": "openai", + "compression": "mySQ8" + }, + { + "name": "config2", + "algorithm": "euclidean", + "vectorizer": "custom-web-api", + "compression": "mySQ8" + }, + { + "name": "config3", + "algorithm": "dotProduct", + "vectorizer": "custom-web-api", + "compression": "myBQC" + } + ], + "vectorizers": [ + { + "name": "openai", + "kind": "azureOpenAI", + "azureOpenAIParameters": { + "resourceUri": "https://test-sample.openai.azure.com", + "deploymentId": "model", + "apiKey": "<redacted>", + "modelName": "text-embedding-3-large" + } + }, + { + "name": "custom-web-api", + "kind": "customWebApi", + "customWebApiParameters": { + "httpMethod": "POST", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "authResourceId": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + "httpHeaders": { + "header1": "value1", + "header2": "value2" + }, + "authIdentity": { + "@odata.type": "#Microsoft.Azure.Search.DataNoneIdentity" + } + } + }, + { + "name": "aml", + "kind": "aml", + "amlParameters": { + "resourceId": "aml resource id", + "region": "aml region", + "uri": "https://my-custom-endpoint.org/", + "timeout": "PT1M", + "modelName": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + ], + "compressions": [ + { + "name": "mySQ8", + "kind": "scalarQuantization", + "truncationDimension": 2, + "scalarQuantizationParameters": { + "quantizedDataType": "int8" + }, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + }, + { + "name": "myBQC", + "kind": "binaryQuantization", + "truncationDimension": 2, + "rescoringOptions": { + "enableRescoring": true, + "defaultOversampling": 10.0, + "rescoreStorageMethod": "preserveOriginals" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..f3a1fcbe4306 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,165 @@ +{ + "operationId": "Skillsets_List", + "title": "SearchServiceListSkillsets", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "myskillset", + "description": "Skillset for extracting entities and more", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "skill2", + "context": "/document", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "countryHint", + "source": "/document/countryHint", + "inputs": [] + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "skill3", + "context": "/document", + "defaultLanguageCode": "en", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "pageOverlapLength": 0, + "maximumPagesToTake": 0, + "unit": "azureOpenAITokens", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "azureOpenAITokenizerParameters": { + "encoderModelName": "cl100k_base", + "allowedSpecialTokens": [ + "[START]", + "[END]" + ] + } + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "skill4", + "context": "/document/pages/*", + "defaultLanguageCode": "en", + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "skill5", + "context": "/document", + "uri": "https://contoso.example.org/", + "httpMethod": "POST", + "timeout": "PT5S", + "batchSize": 1000, + "inputs": [ + { + "name": "text", + "source": "/document/content", + "inputs": [] + }, + { + "name": "languageCode", + "source": "/document/languageCode", + "inputs": [] + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + }, + { + "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "name": "docIntelligenceLayoutSkill", + "context": "/document", + "outputMode": "oneToMany", + "markdownHeaderDepth": "h3", + "inputs": [ + { + "name": "file_data", + "source": "/document/content", + "inputs": [] + } + ], + "outputs": [ + { + "name": "markdown_document", + "targetName": "markdown_document" + } + ] + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..5c7b199b818c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,33 @@ +{ + "operationId": "SynonymMaps_List", + "title": "SearchServiceListSynonymMaps", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "$select": null, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@odata.etag": "0x1234568AE7E58A1", + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "<applicationSecret>" + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json new file mode 100644 index 000000000000..20a91dd39c69 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetDocs.json @@ -0,0 +1,21 @@ +{ + "operationId": "Indexers_ResetDocs", + "title": "SearchServiceResetDocs", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "overwrite": true, + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "keysOrIds": { + "documentKeys": [ + "1", + "2", + "3" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..9bbe95f61d97 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,13 @@ +{ + "operationId": "Indexers_Reset", + "title": "SearchServiceResetIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json new file mode 100644 index 000000000000..eb179862b112 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceResetSkills.json @@ -0,0 +1,20 @@ +{ + "operationId": "Skillsets_ResetSkills", + "title": "SearchServiceResetSkills", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "skillsetName": "myskillset", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000", + "skillNames": { + "skillNames": [ + "skill2", + "skill3", + "skill4" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..af555c5787cc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,13 @@ +{ + "operationId": "Indexers_Run", + "title": "SearchServiceRunIndexer", + "parameters": { + "endpoint": "https://previewexampleservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2024-11-01-preview", + "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json new file mode 100644 index 000000000000..181d92e26be4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchindex.json @@ -0,0 +1,3277 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2024-11-01-preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + }, + "SearchIndexSearchDocumentsSemanticGet": { + "$ref": "./examples/SearchIndexSearchDocumentsSemanticGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringStatistics", + "in": "query", + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "sessionId", + "in": "query", + "type": "string", + "description": "A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "name": "semanticConfiguration", + "in": "query", + "type": "string", + "description": "The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticErrorHandling", + "in": "query", + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results (default).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticMaxWaitInMilliseconds", + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "answers", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "captions", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticQuery", + "in": "query", + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryRewrites", + "in": "query", + "type": "string", + "enum": [ + "none", + "generative" + ], + "x-ms-enum": { + "name": "QueryRewritesType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not generate additional query rewrites for this query." + }, + { + "value": "generative", + "name": "Generative", + "description": "Generate alternative query terms to increase the recall of a search request." + } + ] + }, + "description": "When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`. This parameter is only valid if the query type is `semantic`.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "debug", + "in": "query", + "type": "string", + "enum": [ + "disabled", + "semantic", + "vector", + "queryRewrites", + "all" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their reranked results." + }, + { + "value": "vector", + "name": "Vector", + "description": "Allows the user to further explore their hybrid and vector query results." + }, + { + "value": "queryRewrites", + "name": "QueryRewrites", + "description": "Allows the user to explore the list of query rewrites generated for their search request." + }, + { + "value": "all", + "name": "All", + "description": "Turn on all debug options." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryLanguage", + "in": "query", + "type": "string", + "enum": [ + "none", + "en-us" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "English (US)" + } + ] + }, + "description": "The language of the query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "speller", + "in": "query", + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "QuerySpellerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names used for semantic ranking.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + }, + "SearchIndexSearchDocumentsSemanticPost": { + "$ref": "./examples/SearchIndexSearchDocumentsSemanticPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "$ref": "#/definitions/LookupDocument" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "SearchFacetsResult": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetsResult", + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The nested facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not contain any nested facets." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if the query can't return all the requested documents in a single response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "$ref": "#/definitions/SearchFacetsResult", + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.answers": { + "type": "array", + "items": { + "$ref": "#/definitions/AnswerResult" + }, + "readOnly": true, + "x-ms-client-name": "Answers", + "x-nullable": true, + "description": "The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'." + }, + "@search.debugInfo": { + "$ref": "#/definitions/DebugInfo", + "readOnly": true, + "x-ms-client-name": "DebugInfo", + "x-nullable": true, + "description": "Debug information that applies to the search results as a whole." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + }, + "@search.semanticPartialResponseReason": { + "$ref": "#/definitions/SemanticPartialResponseReason", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseReason", + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "@search.semanticPartialResponseType": { + "$ref": "#/definitions/SemanticPartialResponseType", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseType", + "description": "Type of partial response that was returned for a semantic ranking request." + }, + "@search.semanticQueryRewritesResultType": { + "$ref": "#/definitions/SemanticQueryRewritesResultType", + "readOnly": true, + "x-ms-client-name": "SemanticQueryRewritesResultType", + "description": "Type of query rewrite that was used to retrieve documents." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.rerankerScore": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "RerankerScore", + "x-nullable": true, + "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + }, + "@search.captions": { + "type": "array", + "items": { + "$ref": "#/definitions/CaptionResult" + }, + "readOnly": true, + "x-ms-client-name": "Captions", + "x-nullable": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." + }, + "@search.documentDebugInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentDebugInfo" + }, + "readOnly": true, + "x-ms-client-name": "DocumentDebugInfo", + "x-nullable": true, + "description": "Contains debugging information that can be used to further explore your search results." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "LookupDocument": { + "type": "object", + "additionalProperties": true, + "description": "A document retrieved via a document lookup operation." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "QueryDebugMode": { + "type": "string", + "enum": [ + "disabled", + "semantic", + "vector", + "queryRewrites", + "all" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their reranked results." + }, + { + "value": "vector", + "name": "Vector", + "description": "Allows the user to further explore their hybrid and vector query results." + }, + { + "value": "queryRewrites", + "name": "QueryRewrites", + "description": "Allows the user to explore the list of query rewrites generated for their search request." + }, + { + "value": "all", + "name": "All", + "description": "Turn on all debug options." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results. You can enable multiple debug modes simultaneously by separating them with a | character, for example: semantic|queryRewrites." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed." + }, + "Speller": { + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "QuerySpellerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms." + }, + "VectorQuery": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/VectorQueryKind", + "description": "The kind of vector query being performed.", + "x-nullable": false + }, + "k": { + "type": "integer", + "format": "int32", + "description": "Number of nearest neighbors to return as top hits." + }, + "fields": { + "type": "string", + "description": "Vector Fields of type Collection(Edm.Single) to be included in the vector searched." + }, + "exhaustive": { + "type": "boolean", + "description": "When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values." + }, + "oversampling": { + "type": "number", + "format": "double", + "description": "Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field." + }, + "weight": { + "type": "number", + "format": "float", + "description": "Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. " + }, + "threshold": { + "$ref": "#/definitions/VectorThreshold", + "description": "The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric." + }, + "filterOverride": { + "type": "string", + "description": "The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead." + } + }, + "required": [ + "kind" + ], + "description": "The query parameters for vector and hybrid search queries." + }, + "RawVectorQuery": { + "type": "object", + "x-ms-client-name": "VectorizedQuery", + "x-ms-discriminator-value": "vector", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "vector": { + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "description": "The vector representation of a search query." + } + }, + "required": [ + "vector" + ], + "description": "The query parameters to use for vector search when a raw vector value is provided." + }, + "VectorizableTextQuery": { + "type": "object", + "x-ms-discriminator-value": "text", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "text": { + "type": "string", + "description": "The text to be vectorized to perform a vector search query." + }, + "queryRewrites": { + "$ref": "#/definitions/QueryRewrites", + "description": "Can be configured to let a generative model rewrite the query before sending it to be vectorized." + } + }, + "required": [ + "text" + ], + "description": "The query parameters to use for vector search when a text value that needs to be vectorized is provided." + }, + "VectorizableImageUrlQuery": { + "type": "object", + "x-ms-discriminator-value": "imageUrl", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "url": { + "type": "string", + "description": "The URL of an image to be vectorized to perform a vector search query." + } + }, + "description": "The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided." + }, + "VectorizableImageBinaryQuery": { + "type": "object", + "x-ms-discriminator-value": "imageBinary", + "allOf": [ + { + "$ref": "#/definitions/VectorQuery" + } + ], + "properties": { + "base64Image": { + "type": "string", + "description": "The base 64 encoded binary of an image to be vectorized to perform a vector search query." + } + }, + "description": "The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided." + }, + "VectorQueryKind": { + "type": "string", + "enum": [ + "vector", + "text", + "imageUrl", + "imageBinary" + ], + "x-ms-enum": { + "name": "VectorQueryKind", + "modelAsString": true, + "values": [ + { + "value": "vector", + "name": "Vector", + "description": "Vector query where a raw vector value is provided." + }, + { + "value": "text", + "name": "Text", + "description": "Vector query where a text value that needs to be vectorized is provided." + }, + { + "value": "imageUrl", + "name": "ImageUrl", + "description": "Vector query where an url that represents an image value that needs to be vectorized is provided." + }, + { + "value": "imageBinary", + "name": "ImageBinary", + "description": "Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorThreshold": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/VectorThresholdKind", + "description": "The kind of threshold used to filter vector queries", + "x-nullable": false + } + }, + "required": [ + "kind" + ], + "description": "The threshold used for vector queries." + }, + "VectorSimilarityThreshold": { + "type": "object", + "x-ms-discriminator-value": "vectorSimilarity", + "allOf": [ + { + "$ref": "#/definitions/VectorThreshold" + } + ], + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The threshold will filter based on the similarity metric value. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + } + }, + "required": [ + "value" + ], + "description": "The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + }, + "SearchScoreThreshold": { + "type": "object", + "x-ms-discriminator-value": "searchScore", + "allOf": [ + { + "$ref": "#/definitions/VectorThreshold" + } + ], + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The threshold will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + } + }, + "required": [ + "value" + ], + "description": "The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + }, + "VectorThresholdKind": { + "type": "string", + "enum": [ + "vectorSimilarity", + "searchScore" + ], + "x-ms-enum": { + "name": "VectorThresholdKind", + "modelAsString": true, + "values": [ + { + "value": "vectorSimilarity", + "name": "VectorSimilarity", + "description": "The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field." + }, + { + "value": "searchScore", + "name": "SearchScore", + "description": "The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score." + } + ] + }, + "description": "The kind of vector query being performed." + }, + "VectorFilterMode": { + "type": "string", + "enum": [ + "postFilter", + "preFilter" + ], + "x-ms-enum": { + "name": "VectorFilterMode", + "modelAsString": true, + "values": [ + { + "value": "postFilter", + "name": "PostFilter", + "description": "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'." + }, + { + "value": "preFilter", + "name": "PreFilter", + "description": "The filter will be applied before the search query." + } + ] + }, + "description": "Determines whether or not filters are applied before or after the vector search is performed." + }, + "HybridSearch": { + "type": "object", + "properties": { + "maxTextRecallSize": { + "type": "integer", + "format": "int32", + "description": "Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000." + }, + "countAndFacetMode": { + "$ref": "#/definitions/HybridCountAndFacetMode", + "description": "Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window." + } + }, + "description": "TThe query parameters to configure hybrid search behaviors." + }, + "HybridCountAndFacetMode": { + "type": "string", + "enum": [ + "countRetrievableResults", + "countAllResults" + ], + "x-ms-enum": { + "name": "HybridCountAndFacetMode", + "modelAsString": true, + "values": [ + { + "value": "countRetrievableResults", + "name": "CountRetrievableResults", + "description": "Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'." + }, + { + "value": "countAllResults", + "name": "CountAllResults", + "description": "Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window." + } + ] + }, + "description": "Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. The default value is 'countAllResults'." + }, + "QueryLanguage": { + "type": "string", + "enum": [ + "none", + "en-us", + "en-gb", + "en-in", + "en-ca", + "en-au", + "fr-fr", + "fr-ca", + "de-de", + "es-es", + "es-mx", + "zh-cn", + "zh-tw", + "pt-br", + "pt-pt", + "it-it", + "ja-jp", + "ko-kr", + "ru-ru", + "cs-cz", + "nl-be", + "nl-nl", + "hu-hu", + "pl-pl", + "sv-se", + "tr-tr", + "hi-in", + "ar-sa", + "ar-eg", + "ar-ma", + "ar-kw", + "ar-jo", + "da-dk", + "no-no", + "bg-bg", + "hr-hr", + "hr-ba", + "ms-my", + "ms-bn", + "sl-sl", + "ta-in", + "vi-vn", + "el-gr", + "ro-ro", + "is-is", + "id-id", + "th-th", + "lt-lt", + "uk-ua", + "lv-lv", + "et-ee", + "ca-es", + "fi-fi", + "sr-ba", + "sr-me", + "sr-rs", + "sk-sk", + "nb-no", + "hy-am", + "bn-in", + "eu-es", + "gl-es", + "gu-in", + "he-il", + "ga-ie", + "kn-in", + "ml-in", + "mr-in", + "fa-ae", + "pa-in", + "te-in", + "ur-pk" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "Query language value for English (United States)." + }, + { + "value": "en-gb", + "name": "EnGb", + "description": "Query language value for English (Great Britain)." + }, + { + "value": "en-in", + "name": "EnIn", + "description": "Query language value for English (India)." + }, + { + "value": "en-ca", + "name": "EnCa", + "description": "Query language value for English (Canada)." + }, + { + "value": "en-au", + "name": "EnAu", + "description": "Query language value for English (Australia)." + }, + { + "value": "fr-fr", + "name": "FrFr", + "description": "Query language value for French (France)." + }, + { + "value": "fr-ca", + "name": "FrCa", + "description": "Query language value for French (Canada)." + }, + { + "value": "de-de", + "name": "DeDe", + "description": "Query language value for German (Germany)." + }, + { + "value": "es-es", + "name": "EsEs", + "description": "Query language value for Spanish (Spain)." + }, + { + "value": "es-mx", + "name": "EsMx", + "description": "Query language value for Spanish (Mexico)." + }, + { + "value": "zh-cn", + "name": "ZhCn", + "description": "Query language value for Chinese (China)." + }, + { + "value": "zh-tw", + "name": "ZhTw", + "description": "Query language value for Chinese (Taiwan)." + }, + { + "value": "pt-br", + "name": "PtBr", + "description": "Query language value for Portuguese (Brazil)." + }, + { + "value": "pt-pt", + "name": "PtPt", + "description": "Query language value for Portuguese (Portugal)." + }, + { + "value": "it-it", + "name": "ItIt", + "description": "Query language value for Italian (Italy)." + }, + { + "value": "ja-jp", + "name": "JaJp", + "description": "Query language value for Japanese (Japan)." + }, + { + "value": "ko-kr", + "name": "KoKr", + "description": "Query language value for Korean (Korea)." + }, + { + "value": "ru-ru", + "name": "RuRu", + "description": "Query language value for Russian (Russia)." + }, + { + "value": "cs-cz", + "name": "CsCz", + "description": "Query language value for Czech (Czech Republic)." + }, + { + "value": "nl-be", + "name": "NlBe", + "description": "Query language value for Dutch (Belgium)." + }, + { + "value": "nl-nl", + "name": "NlNl", + "description": "Query language value for Dutch (Netherlands)." + }, + { + "value": "hu-hu", + "name": "HuHu", + "description": "Query language value for Hungarian (Hungary)." + }, + { + "value": "pl-pl", + "name": "PlPl", + "description": "Query language value for Polish (Poland)." + }, + { + "value": "sv-se", + "name": "SvSe", + "description": "Query language value for Swedish (Sweden)." + }, + { + "value": "tr-tr", + "name": "TrTr", + "description": "Query language value for Turkish (Turkey)." + }, + { + "value": "hi-in", + "name": "HiIn", + "description": "Query language value for Hindi (India)." + }, + { + "value": "ar-sa", + "name": "ArSa", + "description": "Query language value for Arabic (Saudi Arabia)." + }, + { + "value": "ar-eg", + "name": "ArEg", + "description": "Query language value for Arabic (Egypt)." + }, + { + "value": "ar-ma", + "name": "ArMa", + "description": "Query language value for Arabic (Morocco)." + }, + { + "value": "ar-kw", + "name": "ArKw", + "description": "Query language value for Arabic (Kuwait)." + }, + { + "value": "ar-jo", + "name": "ArJo", + "description": "Query language value for Arabic (Jordan)." + }, + { + "value": "da-dk", + "name": "DaDk", + "description": "Query language value for Danish (Denmark)." + }, + { + "value": "no-no", + "name": "NoNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "bg-bg", + "name": "BgBg", + "description": "Query language value for Bulgarian (Bulgaria)." + }, + { + "value": "hr-hr", + "name": "HrHr", + "description": "Query language value for Croatian (Croatia)." + }, + { + "value": "hr-ba", + "name": "HrBa", + "description": "Query language value for Croatian (Bosnia and Herzegovina)." + }, + { + "value": "ms-my", + "name": "MsMy", + "description": "Query language value for Malay (Malaysia)." + }, + { + "value": "ms-bn", + "name": "MsBn", + "description": "Query language value for Malay (Brunei Darussalam)." + }, + { + "value": "sl-sl", + "name": "SlSl", + "description": "Query language value for Slovenian (Slovenia)." + }, + { + "value": "ta-in", + "name": "TaIn", + "description": "Query language value for Tamil (India)." + }, + { + "value": "vi-vn", + "name": "ViVn", + "description": "Query language value for Vietnamese (Viet Nam)." + }, + { + "value": "el-gr", + "name": "ElGr", + "description": "Query language value for Greek (Greece)." + }, + { + "value": "ro-ro", + "name": "RoRo", + "description": "Query language value for Romanian (Romania)." + }, + { + "value": "is-is", + "name": "IsIs", + "description": "Query language value for Icelandic (Iceland)." + }, + { + "value": "id-id", + "name": "IdId", + "description": "Query language value for Indonesian (Indonesia)." + }, + { + "value": "th-th", + "name": "ThTh", + "description": "Query language value for Thai (Thailand)." + }, + { + "value": "lt-lt", + "name": "LtLt", + "description": "Query language value for Lithuanian (Lithuania)." + }, + { + "value": "uk-ua", + "name": "UkUa", + "description": "Query language value for Ukrainian (Ukraine)." + }, + { + "value": "lv-lv", + "name": "LvLv", + "description": "Query language value for Latvian (Latvia)." + }, + { + "value": "et-ee", + "name": "EtEe", + "description": "Query language value for Estonian (Estonia)." + }, + { + "value": "ca-es", + "name": "CaEs", + "description": "Query language value for Catalan." + }, + { + "value": "fi-fi", + "name": "FiFi", + "description": "Query language value for Finnish (Finland)." + }, + { + "value": "sr-ba", + "name": "SrBa", + "description": "Query language value for Serbian (Bosnia and Herzegovina)." + }, + { + "value": "sr-me", + "name": "SrMe", + "description": "Query language value for Serbian (Montenegro)." + }, + { + "value": "sr-rs", + "name": "SrRs", + "description": "Query language value for Serbian (Serbia)." + }, + { + "value": "sk-sk", + "name": "SkSk", + "description": "Query language value for Slovak (Slovakia)." + }, + { + "value": "nb-no", + "name": "NbNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "hy-am", + "name": "HyAm", + "description": "Query language value for Armenian (Armenia)." + }, + { + "value": "bn-in", + "name": "BnIn", + "description": "Query language value for Bengali (India)." + }, + { + "value": "eu-es", + "name": "EuEs", + "description": "Query language value for Basque." + }, + { + "value": "gl-es", + "name": "GlEs", + "description": "Query language value for Galician." + }, + { + "value": "gu-in", + "name": "GuIn", + "description": "Query language value for Gujarati (India)." + }, + { + "value": "he-il", + "name": "HeIl", + "description": "Query language value for Hebrew (Israel)." + }, + { + "value": "ga-ie", + "name": "GaIe", + "description": "Query language value for Irish (Ireland)." + }, + { + "value": "kn-in", + "name": "KnIn", + "description": "Query language value for Kannada (India)." + }, + { + "value": "ml-in", + "name": "MlIn", + "description": "Query language value for Malayalam (India)." + }, + { + "value": "mr-in", + "name": "MrIn", + "description": "Query language value for Marathi (India)." + }, + { + "value": "fa-ae", + "name": "FaAe", + "description": "Query language value for Persian (U.A.E.)." + }, + { + "value": "pa-in", + "name": "PaIn", + "description": "Query language value for Punjabi (India)." + }, + { + "value": "te-in", + "name": "TeIn", + "description": "Query language value for Telugu (India)." + }, + { + "value": "ur-pk", + "name": "UrPk", + "description": "Query language value for Urdu (Pakistan)." + } + ] + }, + "description": "The language of the query." + }, + "ScoringStatistics": { + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringStatistics": { + "$ref": "#/definitions/ScoringStatistics", + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "sessionId": { + "type": "string", + "description": "A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "debug": { + "$ref": "#/definitions/QueryDebugMode", + "description": "Enables a debugging tool that can be used to further explore your reranked results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "queryLanguage": { + "$ref": "#/definitions/QueryLanguage", + "description": "A value that specifies the language of the search query." + }, + "speller": { + "$ref": "#/definitions/Speller", + "description": "A value that specified the type of the speller to use to spell-correct individual search query terms." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + }, + "semanticConfiguration": { + "type": "string", + "description": "The name of a semantic configuration that will be used when processing documents for queries of type semantic." + }, + "semanticErrorHandling": { + "$ref": "#/definitions/SemanticErrorHandling", + "description": "Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results." + }, + "semanticMaxWaitInMilliseconds": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails." + }, + "semanticQuery": { + "type": "string", + "description": "Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase." + }, + "answers": { + "$ref": "#/definitions/Answers", + "description": "A value that specifies whether answers should be returned as part of the search response." + }, + "captions": { + "$ref": "#/definitions/Captions", + "description": "A value that specifies whether captions should be returned as part of the search response." + }, + "queryRewrites": { + "$ref": "#/definitions/QueryRewrites", + "description": "A value that specifies whether query rewrites should be generated to augment the search query." + }, + "semanticFields": { + "type": "string", + "description": "The comma-separated list of field names used for semantic ranking." + }, + "vectorQueries": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorQuery" + }, + "description": "The query parameters for vector and hybrid search queries." + }, + "vectorFilterMode": { + "$ref": "#/definitions/VectorFilterMode", + "description": "Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes." + }, + "hybridSearch": { + "$ref": "#/definitions/HybridSearch", + "description": "The query parameters to configure hybrid search behaviors." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "AnswerResult": { + "x-ms-client-name": "QueryAnswerResult", + "properties": { + "score": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The score value represents how relevant the answer is to the query relative to other answers returned for the query." + }, + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the document the answer was extracted from." + }, + "text": { + "type": "string", + "readOnly": true, + "description": "The text passage extracted from the document contents as the answer." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." + }, + "CaptionResult": { + "x-ms-client-name": "QueryCaptionResult", + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "A representative text passage extracted from the document most relevant to the search query." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type `semantic`." + }, + "SemanticPartialResponseReason": { + "type": "string", + "enum": [ + "maxWaitExceeded", + "capacityOverloaded", + "transient" + ], + "x-ms-enum": { + "name": "SemanticErrorReason", + "modelAsString": true, + "values": [ + { + "value": "maxWaitExceeded", + "name": "MaxWaitExceeded", + "description": "If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration exceeded that value. Only the base results were returned." + }, + { + "value": "capacityOverloaded", + "name": "CapacityOverloaded", + "description": "The request was throttled. Only the base results were returned." + }, + { + "value": "transient", + "name": "Transient", + "description": "At least one step of the semantic process failed." + } + ] + }, + "description": "Reason that a partial response was returned for a semantic ranking request." + }, + "SemanticPartialResponseType": { + "type": "string", + "enum": [ + "baseResults", + "rerankedResults" + ], + "x-ms-enum": { + "name": "SemanticSearchResultsType", + "modelAsString": true, + "values": [ + { + "value": "baseResults", + "name": "BaseResults", + "description": "Results without any semantic enrichment or reranking." + }, + { + "value": "rerankedResults", + "name": "RerankedResults", + "description": "Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights." + } + ] + }, + "description": "Type of partial response that was returned for a semantic ranking request." + }, + "SemanticQueryRewritesResultType": { + "type": "string", + "enum": [ + "originalQueryOnly" + ], + "x-ms-enum": { + "name": "SemanticQueryRewritesResultType", + "modelAsString": true, + "values": [ + { + "value": "originalQueryOnly", + "name": "OriginalQueryOnly", + "description": "Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results." + } + ] + }, + "description": "Type of query rewrite that was used for this request." + }, + "SemanticErrorHandling": { + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorMode", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results." + }, + "Answers": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'." + }, + "Captions": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-<number of maximum character length>', such as 'extractive|maxcharlength-600'." + }, + "QueryRewrites": { + "type": "string", + "enum": [ + "none", + "generative" + ], + "x-ms-enum": { + "name": "QueryRewritesType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not generate additional query rewrites for this query." + }, + { + "value": "generative", + "name": "Generative", + "description": "Generate alternative query terms to increase the recall of a search request." + } + ] + }, + "description": "This parameter is only valid if the query type is `semantic`. When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-<number of rewrites>` option, such as `generative|count-3`. Defaults to `None`." + }, + "DebugInfo": { + "type": "object", + "properties": { + "queryRewrites": { + "$ref": "#/definitions/QueryRewritesDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + } + }, + "description": "Contains debugging information that can be used to further explore your search results." + }, + "DocumentDebugInfo": { + "type": "object", + "properties": { + "semantic": { + "$ref": "#/definitions/SemanticDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to semantic ranking requests." + }, + "vectors": { + "$ref": "#/definitions/VectorsDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to vector and hybrid search." + } + }, + "description": "Contains debugging information that can be used to further explore your search results." + }, + "SemanticDebugInfo": { + "type": "object", + "properties": { + "titleField": { + "$ref": "#/definitions/QueryResultDocumentSemanticField", + "readOnly": true, + "description": "The title field that was sent to the semantic enrichment process, as well as how it was used" + }, + "contentFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The content fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "keywordFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The keyword fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "rerankerInput": { + "$ref": "#/definitions/QueryResultDocumentRerankerInput", + "readOnly": true, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + } + } + }, + "QueryResultDocumentSemanticField": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that was sent to the semantic enrichment process" + }, + "state": { + "$ref": "#/definitions/QueryResultDocumentSemanticFieldState", + "readOnly": true, + "description": "The way the field was used for the semantic enrichment process (fully used, partially used, or unused)" + } + }, + "description": "Description of fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "QueryResultDocumentSemanticFieldState": { + "type": "string", + "enum": [ + "used", + "unused", + "partial" + ], + "x-ms-enum": { + "name": "SemanticFieldState", + "modelAsString": true, + "values": [ + { + "value": "used", + "name": "Used", + "description": "The field was fully used for semantic enrichment." + }, + { + "value": "unused", + "name": "Unused", + "description": "The field was not used for semantic enrichment." + }, + { + "value": "partial", + "name": "Partial", + "description": "The field was partially used for semantic enrichment." + } + ] + }, + "description": "The way the field was used for the semantic enrichment process." + }, + "QueryResultDocumentRerankerInput": { + "type": "object", + "properties": { + "title": { + "type": "string", + "readOnly": true, + "description": "The raw string for the title field that was used for semantic enrichment." + }, + "content": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the content fields that were used for semantic enrichment." + }, + "keywords": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the keyword fields that were used for semantic enrichment." + } + }, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + }, + "VectorsDebugInfo": { + "type": "object", + "properties": { + "subscores": { + "$ref": "#/definitions/QueryResultDocumentSubscores", + "readOnly": true, + "description": "The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF." + } + } + }, + "QueryResultDocumentSubscores": { + "type": "object", + "properties": { + "text": { + "$ref": "#/definitions/TextResult", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + }, + "vectors": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentVectorSubscores" + }, + "readOnly": true, + "description": "The vector similarity and @search.score values for each vector query." + }, + "documentBoost": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + } + }, + "description": "The breakdown of subscores between the text and vector query components of the search query for this document. Each vector query is shown as a separate object in the same order they were received." + }, + "TextResult": { + "type": "object", + "properties": { + "searchScore": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + } + }, + "readOnly": true, + "description": "The BM25 or Classic score for the text portion of the query." + }, + "QueryResultDocumentVectorSubscores": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SingleVectorFieldResult", + "readOnly": true + }, + "readOnly": true, + "description": "The vector similarity and @search.score values for each vector query. Each cross-field vector query will have separate subscores for each referenced field." + }, + "SingleVectorFieldResult": { + "type": "object", + "properties": { + "searchScore": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The @search.score value that is calculated from the vector similarity score. This is the score that's visible in a pure single-field single-vector query." + }, + "vectorSimilarity": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The vector similarity score for this document. Note this is the canonical definition of similarity metric, not the 'distance' version. For example, cosine similarity instead of cosine distance." + } + }, + "readOnly": true, + "description": "A single vector field result. Both @search.score and vector similarity values are returned. Vector similarity is related to @search.score by an equation." + }, + "QueryRewritesDebugInfo": { + "type": "object", + "properties": { + "text": { + "$ref": "#/definitions/QueryRewritesValuesDebugInfo", + "readOnly": true, + "description": "List of query rewrites generated for the text query." + }, + "vectors": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryRewritesValuesDebugInfo" + }, + "readOnly": true, + "description": "List of query rewrites generated for the vectorizable text queries." + } + }, + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + }, + "QueryRewritesValuesDebugInfo": { + "type": "object", + "properties": { + "rewrites": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "List of query rewrites." + } + }, + "readOnly": true, + "description": "Contains debugging information specific to query rewrites." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json new file mode 100644 index 000000000000..2445398325e1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2024-11-01-preview/searchservice.json @@ -0,0 +1,12918 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2024-11-01-preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.resetdocs": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_ResetDocs", + "x-ms-examples": { + "SearchServiceResetDocs": { + "$ref": "./examples/SearchServiceResetDocs.json" + } + }, + "description": "Resets specific documents in the datasource to be selectively re-ingested by the indexer.", + "externalDocs": { + "url": "https://aka.ms/reset-documents" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset documents for." + }, + { + "name": "keysOrIds", + "in": "body", + "required": false, + "schema": { + "type": "object", + "x-ms-client-name": "DocumentKeysOrIds", + "properties": { + "documentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "document keys to be reset" + }, + "datasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "datasource document identifiers to be reset" + } + } + } + }, + { + "name": "overwrite", + "in": "query", + "required": false, + "default": false, + "type": "boolean", + "description": "If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/skillsets('{skillsetName}')/search.resetskills": { + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_ResetSkills", + "x-ms-examples": { + "SearchServiceResetSkills": { + "$ref": "./examples/SearchServiceResetSkills.json" + } + }, + "description": "Reset an existing skillset in a search service.", + "externalDocs": { + "url": "https://aka.ms/reset-skills" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to reset." + }, + { + "name": "skillNames", + "in": "body", + "required": true, + "schema": { + "type": "object", + "x-ms-client-name": "SkillNames", + "properties": { + "skillNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the names of skills to be reset." + } + } + }, + "description": "The names of skills to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skills in the skillset are successfully reset." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/aliases": { + "post": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Create", + "x-ms-examples": { + "SearchServiceCreateAlias": { + "$ref": "./examples/SearchServiceCreateAlias.json" + } + }, + "description": "Creates a new search alias.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Alias" + }, + "parameters": [ + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_List", + "x-ms-examples": { + "SearchServiceListAliases": { + "$ref": "./examples/SearchServiceListAliases.json" + } + }, + "description": "Lists all aliases available for a search service.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/List-Aliases" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListAliasesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/aliases('{aliasName}')": { + "put": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateAlias": { + "$ref": "./examples/SearchServiceCreateOrUpdateAlias.json" + } + }, + "description": "Creates a new search alias or updates an alias if it already exists.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Update-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the alias to create or update." + }, + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Delete", + "x-ms-examples": { + "SearchServiceDeleteAlias": { + "$ref": "./examples/SearchServiceDeleteAlias.json" + } + }, + "description": "Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Delete-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Get", + "x-ms-examples": { + "SearchServiceGetAlias": { + "$ref": "./examples/SearchServiceGetAlias.json" + } + }, + "description": "Retrieves an alias definition.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Get-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/data-plane/v1/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "normalizer": { + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use to normalize the given text." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "LexicalNormalizerName": { + "type": "string", + "enum": [ + "asciifolding", + "elision", + "lowercase", + "standard", + "uppercase" + ], + "x-ms-enum": { + "name": "LexicalNormalizerName", + "modelAsString": true, + "values": [ + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "standard", + "name": "Standard", + "description": "Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + } + ] + }, + "description": "Defines the names of all text normalizers supported by the search engine.", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by the search engine.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "VectorEncodingFormat": { + "type": "string", + "enum": [ + "packedBit" + ], + "x-ms-enum": { + "name": "VectorEncodingFormat", + "modelAsString": true, + "values": [ + { + "value": "packedBit", + "name": "PackedBit", + "description": "Encoding format representing bits packed into a wider data type." + } + ] + }, + "description": "The encoding format for interpreting vector field contents." + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType", + "Edm.Single", + "Edm.Half", + "Edm.Int16", + "Edm.SByte", + "Edm.Byte" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + }, + { + "value": "Edm.Single", + "name": "Single", + "description": "Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single)." + }, + { + "value": "Edm.Half", + "name": "Half", + "description": "Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half)." + }, + { + "value": "Edm.Int16", + "name": "Int16", + "description": "Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16)." + }, + { + "value": "Edm.SByte", + "name": "SByte", + "description": "Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte)." + }, + { + "value": "Edm.Byte", + "name": "Byte", + "description": "Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte)." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalNormalizer": { + "type": "object", + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of normalizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "description": "The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for normalizers." + }, + "CustomNormalizer": { + "type": "object", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomNormalizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalNormalizer" + } + ], + "properties": { + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "description": "Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "VectorSearch": { + "type": "object", + "properties": { + "profiles": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchProfile" + }, + "description": "Defines combinations of configurations to use with vector search." + }, + "algorithms": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + }, + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "vectorizers": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchVectorizer" + }, + "description": "Contains configuration options on how to vectorize text vector queries." + }, + "compressions": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + }, + "description": "Contains configuration options specific to the compression method used during indexing or querying." + } + }, + "description": "Contains configuration options related to vector search." + }, + "VectorSearchProfile": { + "type": "object", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular vector search profile.", + "x-nullable": false + }, + "algorithm": { + "x-ms-client-name": "algorithmConfigurationName", + "type": "string", + "description": "The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.", + "x-nullable": false + }, + "vectorizer": { + "x-ms-client-name": "vectorizerName", + "type": "string", + "description": "The name of the vectorization being configured for use with vector search.", + "x-nullable": false + }, + "compression": { + "x-ms-client-name": "compressionConfigurationName", + "type": "string", + "description": "The name of the compression method configuration that specifies the compression method and optional parameters.", + "x-nullable": false + } + }, + "required": [ + "name", + "algorithm" + ], + "description": "Defines a combination of configurations to use with vector search." + }, + "VectorSearchAlgorithmConfiguration": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchAlgorithmKind", + "description": "The name of the kind of algorithm being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the algorithm used during indexing or querying." + }, + "HnswVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "HnswAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "hnsw", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "hnswParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/HnswParameters", + "description": "Contains the parameters specific to HNSW algorithm." + } + }, + "description": "Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy." + }, + "HnswParameters": { + "type": "object", + "properties": { + "m": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 4, + "maximum": 10, + "default": 4, + "description": "The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time." + }, + "efConstruction": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 400, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns." + }, + "efSearch": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 500, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns." + }, + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to the HNSW algorithm." + }, + "ExhaustiveKnnVectorSearchAlgorithmConfiguration": { + "x-ms-client-name": "ExhaustiveKnnAlgorithmConfiguration", + "type": "object", + "x-ms-discriminator-value": "exhaustiveKnn", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + } + ], + "properties": { + "exhaustiveKnnParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ExhaustiveKnnParameters", + "description": "Contains the parameters specific to exhaustive KNN algorithm." + } + }, + "description": "Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index." + }, + "ExhaustiveKnnParameters": { + "type": "object", + "properties": { + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to exhaustive KNN algorithm." + }, + "VectorSearchAlgorithmMetric": { + "type": "string", + "enum": [ + "cosine", + "euclidean", + "dotProduct", + "hamming" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmMetric", + "modelAsString": true, + "values": [ + { + "value": "cosine", + "name": "Cosine", + "description": "Measures the angle between vectors to quantify their similarity, disregarding magnitude. The smaller the angle, the closer the similarity." + }, + { + "value": "euclidean", + "name": "Euclidean", + "description": "Computes the straight-line distance between vectors in a multi-dimensional space. The smaller the distance, the closer the similarity." + }, + { + "value": "dotProduct", + "name": "DotProduct", + "description": "Calculates the sum of element-wise products to gauge alignment and magnitude similarity. The larger and more positive, the closer the similarity." + }, + { + "value": "hamming", + "name": "Hamming", + "description": "Only applicable to bit-packed binary data types. Determines dissimilarity by counting differing positions in binary vectors. The fewer differences, the closer the similarity." + } + ] + }, + "description": "The similarity metric to use for vector comparisons. It is recommended to choose the same similarity metric as the embedding model was trained on." + }, + "VectorSearchAlgorithmKind": { + "type": "string", + "enum": [ + "hnsw", + "exhaustiveKnn" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmKind", + "modelAsString": true, + "values": [ + { + "value": "hnsw", + "name": "Hnsw", + "description": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm." + }, + { + "value": "exhaustiveKnn", + "name": "ExhaustiveKnn", + "description": "Exhaustive KNN algorithm which will perform brute-force search." + } + ] + }, + "description": "The algorithm used for indexing and querying." + }, + "VectorSearchCompressionConfiguration": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchCompressionKind", + "description": "The name of the kind of compression method being configured for use with vector search.", + "x-nullable": false + }, + "rerankWithOriginalVectors": { + "type": "boolean", + "default": true, + "description": "If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency." + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + }, + "rescoringOptions": { + "type": "object", + "$ref": "#/definitions/RescoringOptions", + "description": "Contains the options for rescoring.", + "x-nullable": true + }, + "truncationDimension": { + "type": "integer", + "format": "int32", + "description": "The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation.", + "x-nullable": true + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the compression method used during indexing or querying." + }, + "RescoringOptions": { + "x-ms-client-name": "RescoringOptions", + "type": "object", + "properties": { + "enableRescoring": { + "type": "boolean", + "default": true, + "description": "If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency.", + "x-nullable": true + }, + "defaultOversampling": { + "type": "number", + "format": "double", + "description": "Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency.", + "x-nullable": true + }, + "rescoreStorageMethod": { + "$ref": "#/definitions/VectorSearchCompressionRescoreStorageMethod", + "default": "preserveOriginals", + "description": "Controls the storage method for original vectors. This setting is immutable.", + "x-nullable": true + } + }, + "description": "Contains the options for rescoring." + }, + "ScalarQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "ScalarQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "scalarQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "properties": { + "scalarQuantizationParameters": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/ScalarQuantizationParameters", + "description": "Contains the parameters specific to Scalar Quantization." + } + }, + "description": "Contains configuration options specific to the scalar quantization compression method used during indexing and querying." + }, + "ScalarQuantizationParameters": { + "type": "object", + "properties": { + "quantizedDataType": { + "$ref": "#/definitions/VectorSearchCompressionTargetDataType", + "x-nullable": true, + "description": "The quantized data type of compressed vector values." + } + }, + "description": "Contains the parameters specific to Scalar Quantization." + }, + "BinaryQuantizationVectorSearchCompressionConfiguration": { + "x-ms-client-name": "BinaryQuantizationCompressionConfiguration", + "type": "object", + "x-ms-discriminator-value": "binaryQuantization", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchCompressionConfiguration" + } + ], + "description": "Contains configuration options specific to the binary quantization compression method used during indexing and querying." + }, + "VectorSearchCompressionTargetDataType": { + "type": "string", + "enum": [ + "int8" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionTargetDataType", + "modelAsString": true, + "values": [ + { + "value": "int8", + "name": "Int8" + } + ] + }, + "description": "The quantized data type of compressed vector values." + }, + "VectorSearchCompressionKind": { + "type": "string", + "enum": [ + "scalarQuantization", + "binaryQuantization" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionKind", + "modelAsString": true, + "values": [ + { + "value": "scalarQuantization", + "name": "ScalarQuantization", + "description": "Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size." + }, + { + "value": "binaryQuantization", + "name": "BinaryQuantization", + "description": "Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size." + } + ] + }, + "description": "The compression method used for indexing and querying." + }, + "VectorSearchCompressionRescoreStorageMethod": { + "type": "string", + "enum": [ + "preserveOriginals", + "discardOriginals" + ], + "x-ms-enum": { + "name": "VectorSearchCompressionRescoreStorageMethod", + "modelAsString": true, + "values": [ + { + "value": "preserveOriginals", + "name": "PreserveOriginals", + "description": "This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling." + }, + { + "value": "discardOriginals", + "name": "DiscardOriginals", + "description": "This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality." + } + ] + }, + "description": "The storage method for the original full-precision vectors used for rescoring and internal index operations." + }, + "VectorSearchVectorizer": { + "type": "object", + "discriminator": "kind", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular vectorization method.", + "x-nullable": false + }, + "kind": { + "$ref": "#/definitions/VectorSearchVectorizerKind", + "description": "The name of the kind of vectorization method being configured for use with vector search.", + "x-nullable": false + } + }, + "required": [ + "name", + "kind" + ], + "description": "Specifies the vectorization method to be used during query time." + }, + "AzureOpenAIVectorizer": { + "type": "object", + "x-ms-discriminator-value": "azureOpenAI", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "azureOpenAIParameters": { + "x-ms-client-name": "AzureOpenAIParameters", + "$ref": "#/definitions/AzureOpenAIParameters", + "description": "Contains the parameters specific to Azure OpenAI embedding vectorization." + } + }, + "description": "Specifies the Azure OpenAI resource used to vectorize a query string." + }, + "AzureOpenAIParameters": { + "type": "object", + "properties": { + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI of the Azure OpenAI resource." + }, + "deploymentId": { + "x-ms-client-name": "deploymentName", + "type": "string", + "description": "ID of the Azure OpenAI model deployment on the designated resource." + }, + "apiKey": { + "type": "string", + "description": "API key of the designated Azure OpenAI resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections." + }, + "modelName": { + "$ref": "#/definitions/AzureOpenAIModelName", + "description": "The name of the embedding model that is deployed at the provided deploymentId path." + } + }, + "description": "Specifies the parameters for connecting to the Azure OpenAI resource." + }, + "AzureOpenAIModelName": { + "type": "string", + "enum": [ + "text-embedding-ada-002", + "text-embedding-3-large", + "text-embedding-3-small" + ], + "x-ms-enum": { + "name": "AzureOpenAIModelName", + "modelAsString": true, + "values": [ + { + "value": "text-embedding-ada-002", + "name": "TextEmbeddingAda002" + }, + { + "value": "text-embedding-3-large", + "name": "TextEmbedding3Large" + }, + { + "value": "text-embedding-3-small", + "name": "TextEmbedding3Small" + } + ] + }, + "description": "The Azure Open AI model name that will be called." + }, + "WebApiVectorizer": { + "type": "object", + "x-ms-discriminator-value": "customWebApi", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "customWebApiParameters": { + "x-ms-client-name": "WebApiParameters", + "$ref": "#/definitions/WebApiParameters", + "description": "Specifies the properties of the user-defined vectorizer." + } + }, + "description": "Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset." + }, + "WebApiParameters": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "The URI of the Web API providing the vectorizer." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the HTTP request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the HTTP request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "x-ms-format": "arm-id", + "description": "Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "description": "Specifies the properties for connecting to a user-defined vectorizer." + }, + "AIServicesVisionVectorizer": { + "type": "object", + "x-ms-discriminator-value": "aiServicesVision", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "aiServicesVisionParameters": { + "x-ms-client-name": "AIServicesVisionParameters", + "$ref": "#/definitions/AIServicesVisionParameters", + "description": "Contains the parameters specific to AI Services Vision embedding vectorization." + } + }, + "description": "Specifies the AI Services Vision parameters for vectorizing a query image or text." + }, + "AIServicesVisionParameters": { + "type": "object", + "properties": { + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified." + }, + "resourceUri": { + "type": "string", + "format": "uri", + "description": "The resource URI of the AI Services resource." + }, + "apiKey": { + "type": "string", + "description": "API key of the designated AI Services resource." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the index, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "description": "Specifies the AI Services Vision parameters for vectorizing a query image or text.", + "required": [ + "resourceUri", + "modelVersion" + ] + }, + "AMLVectorizer": { + "type": "object", + "x-ms-discriminator-value": "aml", + "allOf": [ + { + "$ref": "#/definitions/VectorSearchVectorizer" + } + ], + "properties": { + "amlParameters": { + "x-ms-client-name": "AMLParameters", + "$ref": "#/definitions/AMLParameters", + "description": "Specifies the properties of the AML vectorizer." + } + }, + "description": "Specifies an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog for generating the vector embedding of a query string." + }, + "AMLParameters": { + "type": "object", + "properties": { + "uri": { + "x-ms-client-name": "ScoringUri", + "type": "string", + "format": "uri", + "x-nullable": true, + "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." + }, + "key": { + "x-ms-client-name": "AuthenticationKey", + "type": "string", + "x-nullable": true, + "description": "(Required for key authentication) The key for the AML service." + }, + "resourceId": { + "type": "string", + "x-nullable": true, + "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." + }, + "timeout": { + "type": "string", + "format": "duration", + "x-nullable": true, + "description": "(Optional) When specified, indicates the timeout for the http client making the API call." + }, + "region": { + "type": "string", + "x-nullable": true, + "description": "(Optional for token authentication). The region the AML service is deployed in." + }, + "modelName": { + "$ref": "#/definitions/AIStudioModelCatalogName", + "description": "The name of the embedding model from the Azure AI Studio Catalog that is deployed at the provided endpoint." + } + }, + "required": [ + "uri" + ], + "description": "Specifies the properties for connecting to an AML vectorizer." + }, + "AIStudioModelCatalogName": { + "type": "string", + "enum": [ + "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "Cohere-embed-v3-english", + "Cohere-embed-v3-multilingual" + ], + "x-ms-enum": { + "name": "AIStudioModelCatalogName", + "modelAsString": true, + "values": [ + { + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "name": "OpenAI_CLIP_Image_Text_Embeddings_vit_base_patch32" + }, + { + "value": "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "name": "OpenAI_CLIP_Image_Text_Embeddings_ViT_Large_Patch14_336" + }, + { + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "name": "Facebook_DinoV2_Image_Embeddings_ViT_Base" + }, + { + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "name": "Facebook_DinoV2_Image_Embeddings_ViT_Giant" + }, + { + "value": "Cohere-embed-v3-english", + "name": "Cohere_embed_v3_english" + }, + { + "value": "Cohere-embed-v3-multilingual", + "name": "Cohere_embed_v3_multilingual" + } + ] + }, + "description": "The name of the embedding model from the Azure AI Studio Catalog that will be called." + }, + "VectorSearchVectorizerKind": { + "type": "string", + "enum": [ + "azureOpenAI", + "customWebApi", + "aiServicesVision", + "aml" + ], + "x-ms-enum": { + "name": "VectorSearchVectorizerKind", + "modelAsString": true, + "values": [ + { + "value": "azureOpenAI", + "name": "AzureOpenAI", + "description": "Generate embeddings using an Azure OpenAI resource at query time." + }, + { + "value": "customWebApi", + "name": "CustomWebApi", + "description": "Generate embeddings using a custom web endpoint at query time." + }, + { + "value": "aiServicesVision", + "name": "AIServicesVision", + "description": "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API." + }, + { + "value": "aml", + "name": "AML", + "description": "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time." + } + ] + }, + "description": "The vectorization method to be used during query time." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "SearchIndexerDataIdentity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of identity." + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base type for data identities." + }, + "SearchIndexerDataNoneIdentity": { + "description": "Clears the identity property of a datasource.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataNoneIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ] + }, + "SearchIndexerDataUserAssignedIdentity": { + "description": "Specifies the identity for a datasource to use.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataUserAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ], + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The fully qualified Azure resource Id of a user assigned managed identity typically in the form \"/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId\" that should have been assigned to the search service." + } + }, + "required": [ + "userAssignedIdentity" + ] + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql", + "adlsgen2", + "onelake" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates an Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates an Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + }, + { + "value": "adlsgen2", + "name": "AdlsGen2", + "description": "Indicates an ADLS Gen2 datasource." + }, + { + "value": "onelake", + "name": "OneLake", + "description": "Indicates a Microsoft Fabric OneLake datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If \"none\" is specified, the value of this property is cleared." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "x-nullable": true, + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "x-nullable": true, + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "markdownParsingSubmode": { + "$ref": "#/definitions/MarkdownParsingSubmode", + "x-nullable": true + }, + "markdownHeaderDepth": { + "$ref": "#/definitions/MarkdownHeaderDepth", + "x-nullable": true + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." + } + }, + "additionalProperties": true, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines", + "markdown" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents." + }, + { + "value": "markdown", + "name": "Markdown", + "description": "Set to markdown to extract content from markdown files." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "MarkdownParsingSubmode": { + "type": "string", + "enum": [ + "oneToMany", + "oneToOne" + ], + "x-ms-enum": { + "name": "MarkdownParsingSubmode", + "modelAsString": true, + "values": [ + { + "value": "oneToMany", + "name": "OneToMany", + "description": "Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode." + }, + { + "value": "oneToOne", + "name": "OneToOne", + "description": "Indicates that each markdown file will be parsed into a single search document." + } + ] + }, + "default": "oneToMany", + "description": "Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`." + }, + "MarkdownHeaderDepth": { + "type": "string", + "enum": [ + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ], + "x-ms-enum": { + "name": "MarkdownHeaderDepth", + "modelAsString": true, + "values": [ + { + "value": "h1", + "name": "h1", + "description": "Indicates that headers up to a level of h1 will be considered while grouping markdown content." + }, + { + "value": "h2", + "name": "h2", + "description": "Indicates that headers up to a level of h2 will be considered while grouping markdown content." + }, + { + "value": "h3", + "name": "h3", + "description": "Indicates that headers up to a level of h3 will be considered while grouping markdown content." + }, + { + "value": "h4", + "name": "h4", + "description": "Indicates that headers up to a level of h4 will be considered while grouping markdown content." + }, + { + "value": "h5", + "name": "h5", + "description": "Indicates that headers up to a level of h5 will be considered while grouping markdown content." + }, + { + "value": "h6", + "name": "h6", + "description": "Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default." + } + ] + }, + "default": "h6", + "description": "Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "x-nullable": true, + "additionalProperties": true, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "x-nullable": true, + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "x-nullable": true, + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "x-nullable": true, + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "x-nullable": true, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "cache": { + "$ref": "#/definitions/SearchIndexerCache", + "x-nullable": true, + "description": "Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/search-howto-incremental-index" + } + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "statusDetail": { + "$ref": "#/definitions/IndexerExecutionStatusDetail", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "currentState": { + "$ref": "#/definitions/IndexerCurrentState", + "readOnly": true, + "description": "All of the state that defines and dictates the indexer's current execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "IndexerExecutionStatusDetail": { + "type": "string", + "enum": [ + "resetDocs" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatusDetail", + "modelAsString": true, + "values": [ + { + "value": "resetDocs", + "name": "ResetDocs", + "description": "Indicates that the reset that occurred was for a call to ResetDocs." + } + ] + }, + "description": "Details the status of an individual indexer execution." + }, + "IndexerCurrentState": { + "type": "object", + "properties": { + "mode": { + "$ref": "#/definitions/IndexingMode", + "readOnly": true, + "description": "The mode the indexer is running in." + }, + "allDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on all documents in the datasource." + }, + "allDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on all documents in the datasource." + }, + "resetDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on select, reset documents in the datasource." + }, + "resetDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on select, reset documents in the datasource." + }, + "resetDocumentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys." + }, + "resetDatasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids." + } + }, + "description": "Represents all of the state that defines and dictates the indexer's current execution." + }, + "IndexingMode": { + "type": "string", + "enum": [ + "indexingAllDocs", + "indexingResetDocs" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true, + "values": [ + { + "value": "indexingAllDocs", + "name": "IndexingAllDocs", + "description": "The indexer is indexing all documents in the datasource." + }, + { + "value": "indexingResetDocs", + "name": "indexingResetDocs", + "description": "The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status." + } + ] + }, + "x-nullable": false, + "description": "Represents the mode the indexer is executing in." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields." + }, + "stored": { + "type": "boolean", + "description": "An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "normalizer": { + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "dimensions": { + "x-ms-client-name": "vectorSearchDimensions", + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 2, + "maximum": 2048, + "description": "The dimensionality of the vector field." + }, + "vectorSearchProfile": { + "x-ms-client-name": "vectorSearchProfileName", + "type": "string", + "x-nullable": true, + "description": "The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field." + }, + "vectorEncoding": { + "x-ms-client-name": "VectorEncodingFormat", + "$ref": "#/definitions/VectorEncodingFormat", + "description": "The encoding format to interpret the field contents.", + "x-nullable": true + }, + "synonymMaps": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.", + "x-nullable": true + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "normalizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalNormalizer" + }, + "description": "The normalizers for the index.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "semantic": { + "$ref": "#/definitions/SemanticSettings", + "description": "Defines parameters for a search index that influence semantic capabilities.", + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "x-ms-client-name": "SemanticSearch", + "x-nullable": true + }, + "vectorSearch": { + "$ref": "#/definitions/VectorSearch", + "description": "Contains configuration options related to vector search.", + "x-ms-client-name": "VectorSearch", + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "SearchAlias": { + "type": "object", + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the alias." + }, + "indexes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The name of the index this alias maps to. Only one index name may be specified." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the alias." + } + }, + "required": [ + "name", + "indexes" + ], + "description": "Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + }, + "vectorIndexSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The amount of memory in bytes consumed by vectors in the index." + } + }, + "required": [ + "documentCount", + "storageSize", + "vectorIndexSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "ListAliasesResult": { + "type": "object", + "properties": { + "value": { + "x-ms-client-name": "Aliases", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The aliases in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about the Azure AI service to be used when running skills." + }, + "knowledgeStore": { + "$ref": "#/definitions/SearchIndexerKnowledgeStore", + "description": "Definition of additional projections to Azure blob, table, or files, of enriched data." + }, + "indexProjections": { + "$ref": "#/definitions/SearchIndexerIndexProjections", + "description": "Definition of additional projections to secondary search index(es)." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of Azure AI service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the Azure AI service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any Azure AI service resource attached to a skillset." + }, + "SearchIndexerKnowledgeStore": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account projections will be stored in." + }, + "projections": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjection", + "x-nullable": false + }, + "description": "A list of additional projections to perform during indexing." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreParameters" + } + }, + "required": [ + "storageConnectionString", + "projections" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/knowledge-store-projection-overview" + }, + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "SearchIndexerKnowledgeStoreProjection": { + "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreTableProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Table storage." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreObjectProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Blob storage." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreFileProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure File storage." + } + }, + "description": "Container object for various projection selectors." + }, + "SearchIndexerKnowledgeStoreProjectionSelector": { + "properties": { + "referenceKeyName": { + "type": "string", + "description": "Name of reference key to different projection." + }, + "generatedKeyName": { + "type": "string", + "description": "Name of generated key to store projection under." + }, + "source": { + "type": "string", + "description": "Source data to project." + }, + "sourceContext": { + "type": "string", + "description": "Source context for complex projections." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Nested inputs for complex projections." + } + }, + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreBlobProjectionSelector": { + "properties": { + "storageContainer": { + "type": "string", + "description": "Blob container to store projections in." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "required": [ + "storageContainer" + ], + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreTableProjectionSelector": { + "properties": { + "tableName": { + "type": "string", + "description": "Name of the Azure table to store projected data in." + } + }, + "required": [ + "generatedKeyName", + "tableName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "description": "Description for what data to store in Azure Tables." + }, + "SearchIndexerKnowledgeStoreObjectProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Blob." + }, + "SearchIndexerKnowledgeStoreFileProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Files." + }, + "SearchIndexerKnowledgeStoreParameters": { + "type": "object", + "properties": { + "synthesizeGeneratedKeyName": { + "type": "boolean", + "default": false, + "description": "Whether or not projections should synthesize a generated key name if one isn't already present." + } + }, + "additionalProperties": true, + "description": "A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "SearchIndexerIndexProjections": { + "type": "object", + "properties": { + "selectors": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerIndexProjectionSelector" + }, + "description": "A list of projections to be performed to secondary search indexes." + }, + "parameters": { + "$ref": "#/definitions/SearchIndexerIndexProjectionsParameters" + } + }, + "required": [ + "selectors" + ], + "description": "Definition of additional projections to secondary search indexes." + }, + "SearchIndexerIndexProjectionSelector": { + "type": "object", + "properties": { + "targetIndexName": { + "type": "string", + "description": "Name of the search index to project to. Must have a key field with the 'keyword' analyzer set." + }, + "parentKeyFieldName": { + "type": "string", + "description": "Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field." + }, + "sourceContext": { + "type": "string", + "description": "Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents." + }, + "mappings": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Mappings for the projection, or which source should be mapped to which field in the target index." + } + }, + "required": [ + "targetIndexName", + "parentKeyFieldName", + "sourceContext", + "mappings" + ], + "description": "Description for what data to store in the designated search index." + }, + "SearchIndexerIndexProjectionsParameters": { + "type": "object", + "properties": { + "projectionMode": { + "$ref": "#/definitions/IndexProjectionMode", + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + } + }, + "additionalProperties": true, + "description": "A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + }, + "IndexProjectionMode": { + "type": "string", + "enum": [ + "skipIndexingParentDocuments", + "includeIndexingParentDocuments" + ], + "x-ms-enum": { + "name": "IndexProjectionMode", + "modelAsString": true, + "values": [ + { + "value": "skipIndexingParentDocuments", + "name": "SkipIndexingParentDocuments", + "description": "The source document will be skipped from writing into the indexer's target index." + }, + { + "value": "includeIndexingParentDocuments", + "name": "IncludeIndexingParentDocuments", + "description": "The source document will be written into the indexer's target index. This is the default pattern." + } + ] + }, + "description": "Defines behavior of the index projections in relation to the rest of the indexer." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default Azure AI service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "The multi-region account key of an Azure AI service resource that's attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the Azure AI service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "AIServicesAccountKey": { + "type": "object", + "description": "The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AIServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the Azure AI service resource attached to a skillset." + }, + "subdomainUrl": { + "type": "string", + "description": "The subdomain url for the corresponding AI Service." + } + }, + "required": [ + "key", + "subdomainUrl" + ] + }, + "AIServicesAccountIdentity": { + "type": "object", + "description": "The multi-region account of an Azure AI service resource that's attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AIServicesByIdentity", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to AI Service. If not specified, the system-assigned managed identity is used. On updates to the skillset, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + }, + "subdomainUrl": { + "type": "string", + "description": "The subdomain url for the corresponding AI Service." + } + }, + "required": [ + "identity", + "subdomainUrl" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "A URI fragment specifying the type of skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "x-nullable": true, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sensitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sensitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + }, + "lineEnding": { + "$ref": "#/definitions/OcrSkillLineEnding", + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultCountryHint": { + "type": "string", + "x-nullable": true, + "description": "A country code to use as a hint to the language detection model if it cannot disambiguate the language." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "This skill is deprecated. Use the V3.EntityRecognitionSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "This skill is deprecated. Use the V3.SentimentSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "includeOpinionMining": { + "type": "boolean", + "default": false, + "description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + }, + "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." + }, + "EntityLinkingSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + }, + "description": "Using the Text Analytics API, extracts linked entities from text." + }, + "EntityRecognitionSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + }, + "description": "Using the Text Analytics API, extracts entities of different types from text." + }, + "PIIDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "minimum": 0.0, + "maximum": 1.0, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "maskingMode": { + "$ref": "#/definitions/PIIDetectionSkillMaskingMode", + "description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'." + }, + "maskingCharacter": { + "x-ms-client-name": "mask", + "type": "string", + "x-nullable": true, + "maxLength": 1, + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + }, + "piiCategories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of PII entity categories that should be extracted and masked." + }, + "domain": { + "type": "string", + "x-nullable": true, + "description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + }, + "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is `en`." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + }, + "pageOverlapLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk." + }, + "maximumPagesToTake": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Only applicable when textSplitMode is set to 'pages'. If specified, the SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' pages, in order to improve performance when only a few initial pages are needed from each document." + }, + "unit": { + "$ref": "#/definitions/SplitSkillUnit", + "x-nullable": true, + "description": "Only applies if textSplitMode is set to pages. There are two possible values. The choice of the values will decide the length (maximumPageLength and pageOverlapLength) measurement. The default is 'characters', which means the length will be measured by character." + }, + "azureOpenAITokenizerParameters": { + "$ref": "#/definitions/AzureOpenAITokenizerParameters", + "x-nullable": true, + "description": "Only applies if the unit is set to azureOpenAITokens. If specified, the splitSkill will use these parameters when performing the tokenization. The parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is `en`." + }, + "entitiesDefinitionUri": { + "type": "string", + "x-nullable": true, + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "x-nullable": true, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "x-nullable": true, + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is `en`." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "DocumentExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "parsingMode": { + "type": "string", + "x-nullable": true, + "description": "The parsingMode for the skill. Will be set to 'default' if not defined." + }, + "dataToExtract": { + "type": "string", + "x-nullable": true, + "description": "The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined." + }, + "configuration": { + "type": "object", + "additionalProperties": true, + "x-nullable": true, + "description": "A dictionary of configurations for the skill." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content from a file within the enrichment pipeline." + }, + "DocumentIntelligenceLayoutSkill": { + "type": "object", + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "outputMode": { + "$ref": "#/definitions/DocumentIntelligenceLayoutSkillOutputMode", + "x-nullable": true, + "description": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'." + }, + "markdownHeaderDepth": { + "$ref": "#/definitions/DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "x-nullable": true, + "description": "The depth of headers in the markdown output. Default is h6." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline." + }, + "DocumentIntelligenceLayoutSkillOutputMode": { + "type": "string", + "enum": [ + "oneToMany" + ], + "x-ms-enum": { + "name": "DocumentIntelligenceLayoutSkillOutputMode", + "modelAsString": true, + "values": [ + { + "value": "oneToMany", + "name": "OneToMany", + "description": "Specify the deepest markdown header section to parse." + } + ] + }, + "default": "oneToMany", + "description": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'" + }, + "DocumentIntelligenceLayoutSkillMarkdownHeaderDepth": { + "type": "string", + "enum": [ + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ], + "x-ms-enum": { + "name": "DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "modelAsString": true, + "values": [ + { + "value": "h1", + "name": "H1", + "description": "Header level 1." + }, + { + "value": "h2", + "name": "H2", + "description": "Header level 2." + }, + { + "value": "h3", + "name": "H3", + "description": "Header level 3." + }, + { + "value": "h4", + "name": "H4", + "description": "Header level 4." + }, + { + "value": "h5", + "name": "H5", + "description": "Header level 5." + }, + { + "value": "h6", + "name": "H6", + "description": "Header level 6." + } + ] + }, + "default": "h6", + "description": "The depth of headers in the markdown output. Default is h6." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "x-ms-format": "arm-id", + "description": "Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "AmlSkill": { + "type": "object", + "x-ms-client-name": "AzureMachineLearningSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.AmlSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "x-ms-client-name": "ScoringUri", + "type": "string", + "format": "uri", + "x-nullable": true, + "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." + }, + "key": { + "x-ms-client-name": "AuthenticationKey", + "type": "string", + "x-nullable": true, + "description": "(Required for key authentication) The key for the AML service." + }, + "resourceId": { + "type": "string", + "x-nullable": true, + "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." + }, + "timeout": { + "type": "string", + "format": "duration", + "x-nullable": true, + "description": "(Optional) When specified, indicates the timeout for the http client making the API call." + }, + "region": { + "type": "string", + "x-nullable": true, + "description": "(Optional for token authentication). The region the AML service is deployed in." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/en-us/azure/search/cognitive-search-aml-skill" + }, + "description": "The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment." + }, + "AzureOpenAIEmbeddingSkill": { + "x-ms-client-name": "AzureOpenAIEmbeddingSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + }, + { + "$ref": "#/definitions/AzureOpenAIParameters" + } + ], + "properties": { + "dimensions": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models." + } + }, + "type": "object", + "description": "Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource." + }, + "VisionVectorizeSkill": { + "x-ms-client-name": "VisionVectorizeSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.VectorizeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "type": "object", + "properties": { + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the AI Services Vision service. It will default to the latest available when not specified." + } + }, + "required": [ + "modelVersion" + ], + "description": "Allows you to generate a vector embedding for a given image or text input using the Azure AI Services Vision Vectorize API." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "SplitSkillUnit": { + "type": "string", + "enum": [ + "characters", + "azureOpenAITokens" + ], + "x-ms-enum": { + "name": "SplitSkillUnit", + "modelAsString": true, + "values": [ + { + "value": "characters", + "name": "Characters", + "description": "The length will be measured by character." + }, + { + "value": "azureOpenAITokens", + "name": "AzureOpenAITokens", + "description": "The length will be measured by an AzureOpenAI tokenizer from the tiktoken library." + } + ] + }, + "description": "A value indicating which unit to use." + }, + "AzureOpenAITokenizerParameters": { + "type": "object", + "properties": { + "encoderModelName": { + "$ref": "#/definitions/EncoderModelName", + "x-nullable": true, + "description": "Only applies if the unit is set to azureOpenAITokens. Options include 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'." + }, + "allowedSpecialTokens": { + "type": "array", + "items": { + "type": "string" + }, + "description": "(Optional) Only applies if the unit is set to azureOpenAITokens. This parameter defines a collection of special tokens that are permitted within the tokenization process." + } + } + }, + "EncoderModelName": { + "type": "string", + "enum": [ + "r50k_base", + "p50k_base", + "p50k_edit", + "cl100k_base" + ], + "x-ms-enum": { + "name": "SplitSkillEncoderModelName", + "modelAsString": true, + "values": [ + { + "value": "r50k_base", + "name": "R50kBase", + "description": "Refers to a base model trained with a 50,000 token vocabulary, often used in general natural language processing tasks." + }, + { + "value": "p50k_base", + "name": "P50kBase", + "description": "A base model with a 50,000 token vocabulary, optimized for prompt-based tasks." + }, + { + "value": "p50k_edit", + "name": "P50kEdit", + "description": "Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a 50,000 token vocabulary." + }, + { + "value": "cl100k_base", + "name": "CL100kBase", + "description": "A base model with a 100,000 token vocabulary." + } + ] + }, + "description": "A value indicating which tokenizer to use." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "PIIDetectionSkillMaskingMode": { + "type": "string", + "enum": [ + "none", + "replace" + ], + "x-ms-enum": { + "name": "PIIDetectionSkillMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "No masking occurs and the maskedText output will not be returned." + }, + { + "value": "replace", + "name": "Replace", + "description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText." + } + ] + }, + "description": "A string indicating what maskingMode to use to mask the personal information detected in the input text." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by SentimentSkill.", + "x-az-search-deprecated": true + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "af", + "sq", + "anp", + "ar", + "ast", + "awa", + "az", + "bfy", + "eu", + "be", + "be-cyrl", + "be-latn", + "bho", + "bi", + "brx", + "bs", + "bra", + "br", + "bg", + "bns", + "bua", + "ca", + "ceb", + "rab", + "ch", + "hne", + "zh-Hans", + "zh-Hant", + "kw", + "co", + "crh", + "hr", + "cs", + "da", + "prs", + "dhi", + "doi", + "nl", + "en", + "myv", + "et", + "fo", + "fj", + "fil", + "fi", + "fr", + "fur", + "gag", + "gl", + "de", + "gil", + "gon", + "el", + "kl", + "gvr", + "ht", + "hlb", + "hni", + "bgc", + "haw", + "hi", + "mww", + "hoc", + "hu", + "is", + "smn", + "id", + "ia", + "iu", + "ga", + "it", + "ja", + "Jns", + "jv", + "kea", + "kac", + "xnr", + "krc", + "kaa-cyrl", + "kaa", + "csb", + "kk-cyrl", + "kk-latn", + "klr", + "kha", + "quc", + "ko", + "kfq", + "kpy", + "kos", + "kum", + "ku-arab", + "ku-latn", + "kru", + "ky", + "lkt", + "la", + "lt", + "dsb", + "smj", + "lb", + "bfz", + "ms", + "mt", + "kmj", + "gv", + "mi", + "mr", + "mn", + "cnr-cyrl", + "cnr-latn", + "nap", + "ne", + "niu", + "nog", + "sme", + "nb", + "no", + "oc", + "os", + "ps", + "fa", + "pl", + "pt", + "pa", + "ksh", + "ro", + "rm", + "ru", + "sck", + "sm", + "sa", + "sat", + "sco", + "gd", + "sr", + "sr-Cyrl", + "sr-Latn", + "xsr", + "srx", + "sms", + "sk", + "sl", + "so", + "sma", + "es", + "sw", + "sv", + "tg", + "tt", + "tet", + "thf", + "to", + "tr", + "tk", + "tyv", + "hsb", + "ur", + "ug", + "uz-arab", + "uz-cyrl", + "uz", + "vo", + "wae", + "cy", + "fy", + "yua", + "za", + "zu", + "unk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "sq", + "description": "Albanian" + }, + { + "value": "anp", + "description": "Angika (Devanagiri)" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ast", + "description": "Asturian" + }, + { + "value": "awa", + "description": "Awadhi-Hindi (Devanagiri)" + }, + { + "value": "az", + "description": "Azerbaijani (Latin)" + }, + { + "value": "bfy", + "description": "Bagheli" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "be", + "description": "Belarusian (Cyrillic and Latin)" + }, + { + "value": "be-cyrl", + "description": "Belarusian (Cyrillic)" + }, + { + "value": "be-latn", + "description": "Belarusian (Latin)" + }, + { + "value": "bho", + "description": "Bhojpuri-Hindi (Devanagiri)" + }, + { + "value": "bi", + "description": "Bislama" + }, + { + "value": "brx", + "description": "Bodo (Devanagiri)" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "bra", + "description": "Brajbha" + }, + { + "value": "br", + "description": "Breton" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bns", + "description": "Bundeli" + }, + { + "value": "bua", + "description": "Buryat (Cyrillic)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "ceb", + "description": "Cebuano" + }, + { + "value": "rab", + "description": "Chamling" + }, + { + "value": "ch", + "description": "Chamorro" + }, + { + "value": "hne", + "description": "Chhattisgarhi (Devanagiri)" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "kw", + "description": "Cornish" + }, + { + "value": "co", + "description": "Corsican" + }, + { + "value": "crh", + "description": "Crimean Tatar (Latin)" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "dhi", + "description": "Dhimal (Devanagiri)" + }, + { + "value": "doi", + "description": "Dogri (Devanagiri)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "myv", + "description": "Erzya (Cyrillic)" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fo", + "description": "Faroese" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "fur", + "description": "Frulian" + }, + { + "value": "gag", + "description": "Gagauz (Latin)" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "gil", + "description": "Gilbertese" + }, + { + "value": "gon", + "description": "Gondi (Devanagiri)" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "kl", + "description": "Greenlandic" + }, + { + "value": "gvr", + "description": "Gurung (Devanagiri)" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "hlb", + "description": "Halbi (Devanagiri)" + }, + { + "value": "hni", + "description": "Hani" + }, + { + "value": "bgc", + "description": "Haryanvi" + }, + { + "value": "haw", + "description": "Hawaiian" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw (Latin)" + }, + { + "value": "hoc", + "description": "Ho (Devanagiri)" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "smn", + "description": "Inari Sami" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "ia", + "description": "Interlingua" + }, + { + "value": "iu", + "description": "Inuktitut (Latin)" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "Jns", + "description": "Jaunsari (Devanagiri)" + }, + { + "value": "jv", + "description": "Javanese" + }, + { + "value": "kea", + "description": "Kabuverdianu" + }, + { + "value": "kac", + "description": "Kachin (Latin)" + }, + { + "value": "xnr", + "description": "Kangri (Devanagiri)" + }, + { + "value": "krc", + "description": "Karachay-Balkar" + }, + { + "value": "kaa-cyrl", + "description": "Kara-Kalpak (Cyrillic)" + }, + { + "value": "kaa", + "description": "Kara-Kalpak (Latin)" + }, + { + "value": "csb", + "description": "Kashubian" + }, + { + "value": "kk-cyrl", + "description": "Kazakh (Cyrillic)" + }, + { + "value": "kk-latn", + "description": "Kazakh (Latin)" + }, + { + "value": "klr", + "description": "Khaling" + }, + { + "value": "kha", + "description": "Khasi" + }, + { + "value": "quc", + "description": "K'iche'" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "kfq", + "description": "Korku" + }, + { + "value": "kpy", + "description": "Koryak" + }, + { + "value": "kos", + "description": "Kosraean" + }, + { + "value": "kum", + "description": "Kumyk (Cyrillic)" + }, + { + "value": "ku-arab", + "description": "Kurdish (Arabic)" + }, + { + "value": "ku-latn", + "description": "Kurdish (Latin)" + }, + { + "value": "kru", + "description": "Kurukh (Devanagiri)" + }, + { + "value": "ky", + "description": "Kyrgyz (Cyrillic)" + }, + { + "value": "lkt", + "description": "Lakota" + }, + { + "value": "la", + "description": "Latin" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "dsb", + "description": "Lower Sorbian" + }, + { + "value": "smj", + "description": "Lule Sami" + }, + { + "value": "lb", + "description": "Luxembourgish" + }, + { + "value": "bfz", + "description": "Mahasu Pahari (Devanagiri)" + }, + { + "value": "ms", + "description": "Malay (Latin)" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "kmj", + "description": "Malto (Devanagiri)" + }, + { + "value": "gv", + "description": "Manx" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "mr", + "description": "Marathi" + }, + { + "value": "mn", + "description": "Mongolian (Cyrillic)" + }, + { + "value": "cnr-cyrl", + "description": "Montenegrin (Cyrillic)" + }, + { + "value": "cnr-latn", + "description": "Montenegrin (Latin)" + }, + { + "value": "nap", + "description": "Neapolitan" + }, + { + "value": "ne", + "description": "Nepali" + }, + { + "value": "niu", + "description": "Niuean" + }, + { + "value": "nog", + "description": "Nogay" + }, + { + "value": "sme", + "description": "Northern Sami (Latin)" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "no", + "description": "Norwegian" + }, + { + "value": "oc", + "description": "Occitan" + }, + { + "value": "os", + "description": "Ossetic" + }, + { + "value": "ps", + "description": "Pashto" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pa", + "description": "Punjabi (Arabic)" + }, + { + "value": "ksh", + "description": "Ripuarian" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "rm", + "description": "Romansh" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sck", + "description": "Sadri (Devanagiri)" + }, + { + "value": "sm", + "description": "Samoan (Latin)" + }, + { + "value": "sa", + "description": "Sanskrit (Devanagiri)" + }, + { + "value": "sat", + "description": "Santali (Devanagiri)" + }, + { + "value": "sco", + "description": "Scots" + }, + { + "value": "gd", + "description": "Scottish Gaelic" + }, + { + "value": "sr", + "description": "Serbian (Latin)" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "xsr", + "description": "Sherpa (Devanagiri)" + }, + { + "value": "srx", + "description": "Sirmauri (Devanagiri)" + }, + { + "value": "sms", + "description": "Skolt Sami" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "so", + "description": "Somali (Arabic)" + }, + { + "value": "sma", + "description": "Southern Sami" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sw", + "description": "Swahili (Latin)" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tg", + "description": "Tajik (Cyrillic)" + }, + { + "value": "tt", + "description": "Tatar (Latin)" + }, + { + "value": "tet", + "description": "Tetum" + }, + { + "value": "thf", + "description": "Thangmi" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "tk", + "description": "Turkmen (Latin)" + }, + { + "value": "tyv", + "description": "Tuvan" + }, + { + "value": "hsb", + "description": "Upper Sorbian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "ug", + "description": "Uyghur (Arabic)" + }, + { + "value": "uz-arab", + "description": "Uzbek (Arabic)" + }, + { + "value": "uz-cyrl", + "description": "Uzbek (Cyrillic)" + }, + { + "value": "uz", + "description": "Uzbek (Latin)" + }, + { + "value": "vo", + "description": "Volapük" + }, + { + "value": "wae", + "description": "Walser" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "fy", + "description": "Western Frisian" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "za", + "description": "Zhuang" + }, + { + "value": "zu", + "description": "Zulu" + }, + { + "value": "unk", + "description": "Unknown (All)" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "OcrSkillLineEnding": { + "type": "string", + "enum": [ + "space", + "carriageReturn", + "lineFeed", + "carriageReturnLineFeed" + ], + "x-ms-enum": { + "name": "LineEnding", + "modelAsString": true, + "values": [ + { + "value": "space", + "name": "Space", + "description": "Lines are separated by a single space character." + }, + { + "value": "carriageReturn", + "name": "CarriageReturn", + "description": "Lines are separated by a carriage return ('\\r') character." + }, + { + "value": "lineFeed", + "name": "LineFeed", + "description": "Lines are separated by a single line feed ('\\n') character." + }, + { + "value": "carriageReturnLineFeed", + "name": "CarriageReturnLineFeed", + "description": "Lines are separated by a carriage return and a line feed ('\\r\\n') character." + } + ] + }, + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "am", + "bs", + "cs", + "da", + "de", + "en", + "es", + "et", + "fi", + "fr", + "he", + "hi", + "hr", + "hu", + "id", + "is", + "it", + "ja", + "ko", + "lv", + "nb", + "nl", + "pl", + "pt", + "pt-br", + "ru", + "sk", + "sl", + "sr", + "sv", + "tr", + "ur", + "zh" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "am", + "description": "Amharic" + }, + { + "value": "bs", + "description": "Bosnian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr", + "description": "Serbian" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "zh", + "description": "Chinese (Simplified)" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by EntityRecognitionSkill.", + "x-az-search-deprecated": true + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "tlh-Latn", + "tlh-Piqd", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "pt-br", + "pt-PT", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua", + "ga", + "kn", + "mi", + "ml", + "pa" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "tlh-Latn", + "description": "Klingon (Latin script)" + }, + { + "value": "tlh-Piqd", + "description": "Klingon (Klingon script)" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "kn", + "description": "Kannada" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "ml", + "description": "Malayalam" + }, + { + "value": "pa", + "description": "Punjabi" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "az", + "bg", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "el", + "en", + "es", + "et", + "eu", + "fi", + "fr", + "ga", + "gl", + "he", + "hi", + "hr", + "hu", + "id", + "it", + "ja", + "kk", + "ko", + "lt", + "lv", + "mk", + "ms", + "nb", + "nl", + "pl", + "prs", + "pt-BR", + "pt", + "pt-PT", + "ro", + "ru", + "sk", + "sl", + "sr-Cyrl", + "sr-Latn", + "sv", + "th", + "tr", + "uk", + "vi", + "zh", + "zh-Hans", + "zh-Hant" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "az", + "description": "Azerbaijani" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "kk", + "description": "Kazakh" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "mk", + "description": "Macedonian" + }, + { + "value": "ms", + "description": "Malay Malaysia" + }, + { + "value": "nb", + "description": "Norwegian (Bokmal)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "pt-BR", + "description": "Portuguese-Brazil" + }, + { + "value": "pt", + "description": "Portuguese-Portugal" + }, + { + "value": "pt-PT", + "description": "Portuguese-Portugal" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian - Cyrillic RS" + }, + { + "value": "sr-Latn", + "description": "Serbian - Latin RS" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "zh", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If \"none\" is specified, the value of this property is cleared." + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps." + }, + "SearchIndexerCache": { + "type": "object", + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account where the cache data will be persisted." + }, + "enableReprocessing": { + "type": "boolean", + "x-nullable": true, + "description": "Specifies whether incremental reprocessing is enabled." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + } + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "aliasesCount": { + "x-ms-client-name": "aliasCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of aliases." + }, + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + }, + "vectorIndexSize": { + "x-ms-client-name": "vectorIndexSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total memory consumption of all vector indexes within the service, in bytes." + } + }, + "required": [ + "aliasesCount", + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps", + "skillsetCount", + "vectorIndexSize" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + }, + "maxStoragePerIndex": { + "x-ms-client-name": "maxStoragePerIndexInBytes", + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The maximum amount of storage in bytes allowed per index." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SemanticSettings": { + "x-ms-client-name": "SemanticSearch", + "properties": { + "defaultConfiguration": { + "x-ms-client-name": "defaultConfigurationName", + "type": "string", + "description": "Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time." + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticConfiguration" + }, + "description": "The semantic configurations for the index." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines parameters for a search index that influence semantic capabilities." + }, + "SemanticConfiguration": { + "properties": { + "name": { + "externalDocs": { + "url": "https://learn.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the semantic configuration.", + "x-nullable": false + }, + "prioritizedFields": { + "$ref": "#/definitions/PrioritizedFields", + "x-nullable": false, + "description": "Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set." + } + }, + "required": [ + "name", + "prioritizedFields" + ], + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines a specific configuration to be used in the context of semantic capabilities." + }, + "PrioritizedFields": { + "x-ms-client-name": "SemanticPrioritizedFields", + "properties": { + "titleField": { + "$ref": "#/definitions/SemanticField", + "description": "Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank." + }, + "prioritizedContentFields": { + "x-ms-client-name": "contentFields", + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + }, + "prioritizedKeywordsFields": { + "x-ms-client-name": "keywordsFields", + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + } + }, + "externalDocs": { + "url": "https://learn.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers." + }, + "SemanticField": { + "properties": { + "fieldName": { + "type": "string", + "description": "", + "x-nullable": false + } + }, + "required": [ + "fieldName" + ], + "description": "A field that is used as part of the semantic configuration." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "DisableCacheReprocessingChangeDetectionParameter": { + "name": "disableCacheReprocessingChangeDetection", + "in": "query", + "required": false, + "type": "boolean", + "description": "Disables cache reprocessing change detection.", + "x-ms-parameter-location": "method" + }, + "IgnoreResetRequirementsParameter": { + "name": "ignoreResetRequirements", + "x-ms-client-name": "skipIndexerResetRequirementForCache", + "in": "query", + "required": false, + "type": "boolean", + "description": "Ignores cache reset requirements.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 1ff80a2c48e2..b1cc42b884bd 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -26,7 +26,7 @@ These are the global settings for SearchServiceClient and SearchIndexClient. title: SearchClient opt-in-extensible-enums: true openapi-type: data-plane -tag: package-2024-09-01-preview +tag: package-2024-11-01-preview directive: - where: @@ -169,6 +169,34 @@ directive: ### Tag: package-2024-09-01-preview +These settings apply only when `--tag=package-2024-11-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-01-preview' +input-file: +- preview/2024-11-01-preview/searchservice.json +- preview/2024-11-01-preview/searchindex.json +``` + +### Tag: package-2024-11-searchservice-preview + +These settings apply only when `--tag=package-2024-11-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-searchservice-preview' +input-file: +- preview/2024-11-01-preview/searchservice.json +``` + +### Tag: package-2024-11-searchindex-preview + +These settings apply only when `--tag=package-2024-11-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2024-11-searchindex-preview' +input-file: +- preview/2024-11-01-preview/searchindex.json +``` + +### Tag: package-2024-09-01-preview + These settings apply only when `--tag=package-2024-09-01-preview` is specified on the command line. ``` yaml $(tag) == 'package-2024-09-01-preview' From 3bf9bcd1d7f4fc95024db2a944ab3800341edf2f Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:28:28 -0700 Subject: [PATCH 045/101] Fleet GA API version "2024-11-01" (#30568) * Updating the version to "2024-10-01" * Fix Stable version path in readme.Md * Updating path for stable version. * Updating Readme.md files for other languages SDK. * Updating SDK readme.md files. * Add Java SDK readme reference to main readme.md file. * Updating Main.tsp to add GA version. * Remove version references from individual sdk readme.md files, as it gets it from main.tsp. * fixing dependencies for2024-10-01 in main.tsp. * updated generated file from sp. * Adding example refs back, removed by tool * Adding examples * Update main.tsp. local build - npx tsv specification/azurefleet/AzureFleet.Management * Update Path for 24_10_01 in main.tsp * Restore Python package-version: 1.0.0b1 * Adding Retry-after header in 20` response examples. * Changing API version to 2024-11-01 * Updating "provisioningState" in example and swagger - adding "Azure-AsyncOperation" - header. * update to example. * Updating the examples based on tsp generated to pass the build. The Tsp files needs to be update for correctness. * Update examples to have succeeded state * Update sdk-suppressions.yaml * Updating examples to add Retry-After header. Update "provisioningState": "Creating" for 201 responses. * Changes for Attribute schema. * Attribute changes. * Updates. * Adding Atrributes. * Supressing - typespec-azure-core/casing-style: The names of Model types must use PascalCase * Adding VM Attributes properties. * Adding refrence to VmAttributes and locationProfiles (Needs to be completed for model.) * Adding AdditionalCapabilities, LocationProfile. * Run Prettier. * Spell Check fixes. * Make paramters optional - vmAttributes, additionalLocationsProfile * Fixing Descriptions. * Supress error for ultraSSDEnabled name. * Updates after npx ci * Revert "Updates after npx ci" This reverts commit bf1aed71f182bc43cfe5efd23a929a6c49912f29. * Updates after npx ci * Supression update * Updating description of ultraSSD to match Compute description. * Supress Camel Case error for SSD * Suppress ultraSSDEnabled for DefinitionsPropertiesNamesCamelCase --------- Co-authored-by: Sahil Arora <arorasahil@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Rahul Singh <rahuls@microsft.com> --- .../Fleets_CreateOrUpdate_MaximumSet.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../Fleets_Update_MaximumSet.json | 3 +- .../Fleets_Update_MinimumSet.json | 3 +- .../Fleets_CreateOrUpdate.json | 2 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 2 +- .../2024-05-01-preview/Fleets_Update.json | 3 +- .../2024-11-01/Fleets_CreateOrUpdate.json | 1174 ++++++ .../Fleets_CreateOrUpdate_MinimumSet.json | 300 ++ .../examples/2024-11-01/Fleets_Delete.json | 18 + .../examples/2024-11-01/Fleets_Get.json | 405 ++ .../Fleets_ListByResourceGroup.json | 409 ++ .../2024-11-01/Fleets_ListBySubscription.json | 408 ++ .../Fleets_ListVirtualMachineScaleSets.json | 40 + .../examples/2024-11-01/Fleets_Update.json | 767 ++++ .../examples/2024-11-01/Operations_List.json | 71 + .../AzureFleet.Management/fleet.tsp | 285 ++ .../azurefleet/AzureFleet.Management/main.tsp | 6 + .../Fleets_CreateOrUpdate_MaximumSet.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../examples/Fleets_Update_MaximumSet.json | 3 +- .../examples/Fleets_Update_MinimumSet.json | 3 +- .../examples/Fleets_CreateOrUpdate.json | 2 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 2 +- .../examples/Fleets_Update.json | 3 +- .../stable/2024-11-01/azurefleet.json | 3581 +++++++++++++++++ .../examples/Fleets_CreateOrUpdate.json | 1174 ++++++ .../Fleets_CreateOrUpdate_MinimumSet.json | 300 ++ .../2024-11-01/examples/Fleets_Delete.json | 18 + .../2024-11-01/examples/Fleets_Get.json | 405 ++ .../examples/Fleets_ListByResourceGroup.json | 409 ++ .../examples/Fleets_ListBySubscription.json | 408 ++ .../Fleets_ListVirtualMachineScaleSets.json | 40 + .../2024-11-01/examples/Fleets_Update.json | 767 ++++ .../2024-11-01/examples/Operations_List.json | 71 + .../azurefleet/resource-manager/readme.az.md | 2 - .../azurefleet/resource-manager/readme.cli.md | 12 +- .../azurefleet/resource-manager/readme.go.md | 2 +- .../resource-manager/readme.java.md | 13 + .../azurefleet/resource-manager/readme.md | 18 +- .../resource-manager/readme.python.md | 2 +- .../resource-manager/sdk-suppressions.yaml | 48 +- 42 files changed, 11169 insertions(+), 22 deletions(-) create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json create mode 100644 specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json create mode 100644 specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json create mode 100644 specification/azurefleet/resource-manager/readme.java.md diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json index afa94a22086e..765892be1275 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MaximumSet.json @@ -765,7 +765,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "properties": { diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json index 1adda99d41ae..0c7cbc16f8e8 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_CreateOrUpdate_MinimumSet.json @@ -19,7 +19,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "location": "westus", diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json index 1ec2663494ac..7abc1f77347b 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MaximumSet.json @@ -752,7 +752,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json index ae9018cbee4f..b8629a85cf15 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2023-11-01-preview/Fleets_Update_MinimumSet.json @@ -16,7 +16,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json index f8a4fab670f2..45338e3137a5 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate.json @@ -383,7 +383,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 10, "minCapacity": 20, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json index 8d9bd1338335..74ee56feafa8 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_CreateOrUpdate_MinimumSet.json @@ -101,7 +101,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 2, "minCapacity": 1, diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json index 41186c2130fa..0abdb2cf6780 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-05-01-preview/Fleets_Update.json @@ -759,7 +759,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json new file mode 100644 index 000000000000..a76ad9c827a9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json @@ -0,0 +1,1174 @@ +{ + "title": "Fleets_CreateOrUpdate", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myvaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": {} + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 10, + "minCapacity": 20, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 10, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 0, + "minCapacity": 0, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..e94c80506873 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,300 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json new file mode 100644 index 000000000000..18f72eff408a --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Fleets_Delete", + "operationId": "Fleets_Delete", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json new file mode 100644 index 000000000000..5d9c7b54d0a9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Get.json @@ -0,0 +1,405 @@ +{ + "title": "Fleets_Get", + "operationId": "Fleets_Get", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json new file mode 100644 index 000000000000..3a834d56d590 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListByResourceGroup.json @@ -0,0 +1,409 @@ +{ + "title": "Fleets_ListByResourceGroup", + "operationId": "Fleets_ListByResourceGroup", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json new file mode 100644 index 000000000000..e93f74bee6b9 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListBySubscription.json @@ -0,0 +1,408 @@ +{ + "title": "Fleets_ListBySubscription", + "operationId": "Fleets_ListBySubscription", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json new file mode 100644 index 000000000000..96c7add60f74 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_ListVirtualMachineScaleSets.json @@ -0,0 +1,40 @@ +{ + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "name": "myFleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", + "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", + "operationStatus": "Creating", + "error": { + "details": [ + { + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", + "message": "Allocation Failed" + } + ], + "innererror": { + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" + }, + "code": "OverconstrainedAllocationRequest", + "target": "nhaj", + "message": "Allocation Failed" + } + } + ] + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json new file mode 100644 index 000000000000..73a8f4820114 --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json @@ -0,0 +1,767 @@ +{ + "title": "Fleets_Update", + "operationId": "Fleets_Update", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "properties": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", + "exactVersion": "zjbntmiskjexlr" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "settings": {}, + "provisioningState": "Succeeded" + }, + "type": "cmeam", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {}, + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c" + }, + "tags": {}, + "location": "westus", + "plan": { + "name": "uapfngmdekvpgjhomthtpxjfdmmll", + "publisher": "aqhles", + "product": "bfzbkdnbexmedxdc", + "promotionCode": "gspehogwfjxirz", + "version": "yza" + }, + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json new file mode 100644 index 000000000000..8acf291032fe --- /dev/null +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Operations_List.json @@ -0,0 +1,71 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Get Azure Fleet", + "description": "Get properties of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Create or Update Azure Fleet", + "description": "Creates a new Azure Fleet resource or updates an existing one" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Delete Virtual Machine and Virtual Machine scale sets in a Azure Fleet resource", + "description": "Deletes all compute resources of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Register subscription for Microsoft.AzureFleet", + "description": "Registers Subscription with Microsoft.AzureFleet resource provider" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Unregister Subscription for Microsoft.AzureFleet", + "description": "Unregisters Subscription with Microsoft.AzureFleet resource provider" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index 2ea667384c57..c4c78b4e7f5f 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -84,6 +84,14 @@ model FleetProperties { @doc("List of VM sizes supported for Compute Fleet") vmSizesProfile: Array<VmSizeProfile>; + @added(Versions.v2024_11_01) + @doc("Attribute based Fleet.") + vmAttributes?: VMAttributes; + + @added(Versions.v2024_11_01) + @doc("Represents the configuration for additional locations where Fleet resources may be deployed.") + additionalLocationsProfile?: AdditionalLocationsProfile; + @doc("Compute Profile to use for running user's workloads.") computeProfile: ComputeProfile; @@ -118,6 +126,15 @@ model ComputeProfile { This property cannot be updated. """) platformFaultDomainCount?: int32; + + @added(Versions.v2024_11_01) + @doc(""" + Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. + ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. + hibernationEnabled: Enables the hibernation capability on the VMSS VMs. + Default value is null if not specified. This property cannot be updated once set. + """) + additionalVirtualMachineCapabilities?: AdditionalCapabilities; } @doc("Specifications about a VM Size. This will also contain the corresponding rank and weight in future.") @@ -211,6 +228,274 @@ union EvictionPolicy { Deallocate: "Deallocate", } +@added(Versions.v2024_11_01) +@doc("AdditionalCapabilities for VM.") +model AdditionalCapabilities { + #suppress "@azure-tools/typespec-azure-core/casing-style" "ultraSSDEnabled which does not follow camel casing" + @doc(""" + The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. + Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. + """) + ultraSSDEnabled?: boolean; + + @doc("The flag that enables or disables hibernation capability on the VM.") + hibernationEnabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributeMinMaxInteger which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes.") +model VMAttributeMinMaxInteger { + @minValue(0) + @doc("Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified.") + min?: int32; + + @minValue(0) + @doc("Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified.") + max?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributeMinMaxDouble which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("VMAttributes using double values.") +model VMAttributeMinMaxDouble { + @minValue(0.0) + @doc("Minimum value. default 0. Double.MinValue()") + min?: float64; + + @minValue(0.0) + @doc("Maximum value. Double.MaxValue(1.7976931348623157E+308)") + max?: float64; +} + +@added(Versions.v2024_11_01) +@doc("VMSizes supported by Azure VMs. Included is a union of Excluded and Required.") +union VMAttributeSupport { + string, + + @doc("All VMSizes having the feature support will be excluded.") + Excluded: "Excluded", + + @doc(" VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required.") + Included: "Included", + + @doc("Only the VMSizes having the feature support will be used.") + Required: "Required", +} + +@added(Versions.v2024_11_01) +@doc(""" + VMCategories defined for Azure VMs. + See: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose + """) +union VMCategory { + string, + + @doc(""" + General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers. + """) + GeneralPurpose: "GeneralPurpose", + + @doc(""" + Compute optimized VM sizes have a high CPU-to-memory ratio. These sizes are good for medium traffic web servers, network appliances, batch processes, and application servers. + """) + ComputeOptimized: "ComputeOptimized", + + @doc(""" + Memory optimized VM sizes offer a high memory-to-CPU ratio that is great for relational database servers, medium to large caches, and in-memory analytics. + """) + MemoryOptimized: "MemoryOptimized", + + @doc(""" + Storage optimized virtual machine (VM) sizes offer high disk throughput and IO, and are ideal for Big Data, SQL, NoSQL databases, data warehousing, and large transactional databases. + Examples include Cassandra, MongoDB, Cloudera, and Redis. + """) + StorageOptimized: "StorageOptimized", + + @doc(""" + GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs. + These sizes are designed for compute-intensive, graphics-intensive, and visualization workloads. + """) + GpuAccelerated: "GpuAccelerated", + + @doc(""" + FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA. + These sizes are designed for compute-intensive workloads. This article provides information about the number and type of FPGA, vCPUs, data disks, and NICs. + Storage throughput and network bandwidth are also included for each size in this grouping. + """) + FpgaAccelerated: "FpgaAccelerated", + + @doc(""" + Azure High Performance Compute VMs are optimized for various HPC workloads such as computational fluid dynamics, finite element analysis, frontend and backend EDA, + rendering, molecular dynamics, computational geo science, weather simulation, and financial risk analysis. + """) + HighPerformanceCompute: "HighPerformanceCompute", +} + +@added(Versions.v2024_11_01) +@doc("Cpu Manufacturers supported by Azure VMs.") +union CpuManufacturer { + string, + + @doc("Intel CPU.") + Intel: "Intel", + + @doc("AMD CPU.") + AMD: "AMD", + + @doc("Microsoft CPU.") + Microsoft: "Microsoft", + + @doc("Ampere CPU.") + Ampere: "Ampere", +} + +@added(Versions.v2024_11_01) +@doc("Different kind of Local storage disk types supported by Azure VMs.") +union LocalStorageDiskType { + string, + + @doc("HDD DiskType.") + HDD: "HDD", + + @doc("SDD DiskType.") + SSD: "SSD", +} + +@added(Versions.v2024_11_01) +@doc("Architecture types supported by Azure VMs.") +union ArchitectureType { + string, + + @doc("ARM64 Architecture") + ARM64: "ARM64", + + @doc("X86 Architecture") + X86: "X86", +} + +@added(Versions.v2024_11_01) +@doc("Accelerator manufacturers supported by Azure VMs.") +union AcceleratorManufacturer { + string, + + @doc("AMD GpuType") + AMD: "AMD", + + @doc("Nvidia GpuType") + Nvidia: "Nvidia", + + @doc("Xilinx GpuType") + Xilinx: "Xilinx", +} + +@added(Versions.v2024_11_01) +@doc("Accelerator types supported by Azure VMs.") +union AcceleratorType { + string, + + @doc("GPU Accelerator") + GPU: "GPU", + + @doc("FPGA Accelerator") + FPGA: "FPGA", +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VMAttributes which does not follow camel casing" +@added(Versions.v2024_11_01) +@doc("VMAttributes that will be used to filter VMSizes which will be used to build Fleet.") +model VMAttributes { + @doc("The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified.") + vCpuCount: VMAttributeMinMaxInteger; + + @doc("The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified.") + memoryInGiB: VMAttributeMinMaxDouble; + + @doc("Specifies whether the VMSize supporting local storage should be used to build Fleet or not.") + localStorageSupport?: VMAttributeSupport; + + @doc("The range of local storage in GB specified from Min to Max.") + localStorageInGiB?: VMAttributeMinMaxDouble; + + @extension("x-ms-identifiers", []) + @doc(""" + The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. + If localStorageSupport is "Excluded", this VMAttribute can not be used. + """) + localStorageDiskTypes?: Array<LocalStorageDiskType>; + + @doc("The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + dataDiskCount?: VMAttributeMinMaxInteger; + + @doc("The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + networkInterfaceCount?: VMAttributeMinMaxInteger; + + @doc("The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + networkBandwidthInMbps?: VMAttributeMinMaxDouble; + + @doc("Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not.") + rdmaSupport?: VMAttributeSupport; + + @doc("The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + rdmaNetworkInterfaceCount?: VMAttributeMinMaxInteger; + + @doc("Specifies whether the VMSize supporting accelerator should be used to build Fleet or not.") + acceleratorSupport?: VMAttributeSupport; + + @extension("x-ms-identifiers", []) + @doc("The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + acceleratorManufacturers?: Array<AcceleratorManufacturer>; + + @extension("x-ms-identifiers", []) + @doc("The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + acceleratorTypes?: Array<AcceleratorType>; + + @doc("The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified.") + acceleratorCount?: VMAttributeMinMaxInteger; + + @extension("x-ms-identifiers", []) + @doc("The VM category specified as a list. Optional parameter.") + vmCategories?: Array<VMCategory>; + + @extension("x-ms-identifiers", []) + @doc("The VM architecture types specified as a list. Optional parameter.") + architectureTypes?: Array<ArchitectureType>; + + @extension("x-ms-identifiers", []) + @doc("The VM CPU manufacturers specified as a list. Optional parameter.") + cpuManufacturers?: Array<CpuManufacturer>; + + @doc("Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not.") + burstableSupport?: VMAttributeSupport; + + @extension("x-ms-identifiers", []) + @doc("Specifies which VMSizes should be excluded while building Fleet. Optional parameter.") + excludedVMSizes?: Array<string>; +} + +@added(Versions.v2024_11_01) +@doc("Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).") +model LocationProfile { + @doc(""" + The ARM location name of the additional region. + """) + location?: string; + + @doc(""" + An override for computeProfile.baseVirtualMachineProfile specific to this region. + This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. + """) + virtualMachineProfileOverride?: BaseVirtualMachineProfile; +} + +@added(Versions.v2024_11_01) +@doc("Represents the configuration for additional locations where Fleet resources may be deployed.") +model AdditionalLocationsProfile { + @extension("x-ms-identifiers", []) + @doc("The list of location profiles.") + locationProfiles: Array<LocationProfile>; +} + @armResourceOperations interface Fleets { get is ArmResourceRead<Fleet>; diff --git a/specification/azurefleet/AzureFleet.Management/main.tsp b/specification/azurefleet/AzureFleet.Management/main.tsp index a29951f7985a..a27c615626af 100644 --- a/specification/azurefleet/AzureFleet.Management/main.tsp +++ b/specification/azurefleet/AzureFleet.Management/main.tsp @@ -33,6 +33,12 @@ enum Versions { @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("Public Preview Api version") v2024_05_01_preview: "2024-05-01-preview", + + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + @doc("Public Api version") + v2024_11_01: "2024-11-01", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json index afa94a22086e..765892be1275 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MaximumSet.json @@ -765,7 +765,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "properties": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json index 1adda99d41ae..0c7cbc16f8e8 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -19,7 +19,8 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus" + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 }, "body": { "location": "westus", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json index 1ec2663494ac..7abc1f77347b 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MaximumSet.json @@ -752,7 +752,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json index ae9018cbee4f..b8629a85cf15 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2023-11-01-preview/examples/Fleets_Update_MinimumSet.json @@ -16,7 +16,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json index f8a4fab670f2..45338e3137a5 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate.json @@ -383,7 +383,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 10, "minCapacity": 20, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json index 8d9bd1338335..74ee56feafa8 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -101,7 +101,7 @@ "200": { "body": { "properties": { - "provisioningState": "Creating", + "provisioningState": "Succeeded", "spotPriorityProfile": { "capacity": 2, "minCapacity": 1, diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json index 41186c2130fa..0abdb2cf6780 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/preview/2024-05-01-preview/examples/Fleets_Update.json @@ -759,7 +759,8 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus" + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 } } } diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json new file mode 100644 index 000000000000..3042422c58d8 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json @@ -0,0 +1,3581 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureFleet", + "version": "2024-11-01", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Fleets" + } + ], + "paths": { + "/providers/Microsoft.AzureFleet/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListBySubscription", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources 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/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListBySubscription": { + "$ref": "./examples/Fleets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets": { + "get": { + "operationId": "Fleets_ListByResourceGroup", + "tags": [ + "Fleets" + ], + "description": "List Fleet resources 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/FleetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListByResourceGroup": { + "$ref": "./examples/Fleets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{fleetName}": { + "get": { + "operationId": "Fleets_Get", + "tags": [ + "Fleets" + ], + "description": "Get a Fleet", + "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": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_Get": { + "$ref": "./examples/Fleets_Get.json" + } + } + }, + "put": { + "operationId": "Fleets_CreateOrUpdate", + "tags": [ + "Fleets" + ], + "description": "Create a Fleet", + "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": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Fleet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Fleet' update operation succeeded", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "201": { + "description": "Resource 'Fleet' create operation succeeded", + "schema": { + "$ref": "#/definitions/Fleet" + }, + "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": { + "Fleets_CreateOrUpdate": { + "$ref": "./examples/Fleets_CreateOrUpdate.json" + }, + "Fleets_CreateOrUpdate_MinimumSet": { + "$ref": "./examples/Fleets_CreateOrUpdate_MinimumSet.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Fleets_Update", + "tags": [ + "Fleets" + ], + "description": "Update a Fleet", + "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": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/FleetUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Fleet" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_Update": { + "$ref": "./examples/Fleets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Fleets_Delete", + "tags": [ + "Fleets" + ], + "description": "Delete a Fleet", + "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": "fleetName", + "in": "path", + "description": "The name of the Compute Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "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": { + "Fleets_Delete": { + "$ref": "./examples/Fleets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureFleet/fleets/{name}/virtualMachineScaleSets": { + "get": { + "operationId": "Fleets_ListVirtualMachineScaleSets", + "tags": [ + "Fleets" + ], + "description": "List VirtualMachineScaleSet resources by Fleet", + "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": "name", + "in": "path", + "description": "The name of the Fleet", + "required": true, + "type": "string", + "pattern": "^[^_\\W][\\w\\-._]{0,79}(?<![-.])$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Fleets_ListVirtualMachineScaleSets": { + "$ref": "./examples/Fleets_ListVirtualMachineScaleSets.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AcceleratorManufacturer": { + "type": "string", + "description": "Accelerator manufacturers supported by Azure VMs.", + "enum": [ + "AMD", + "Nvidia", + "Xilinx" + ], + "x-ms-enum": { + "name": "AcceleratorManufacturer", + "modelAsString": true, + "values": [ + { + "name": "AMD", + "value": "AMD", + "description": "AMD GpuType" + }, + { + "name": "Nvidia", + "value": "Nvidia", + "description": "Nvidia GpuType" + }, + { + "name": "Xilinx", + "value": "Xilinx", + "description": "Xilinx GpuType" + } + ] + } + }, + "AcceleratorType": { + "type": "string", + "description": "Accelerator types supported by Azure VMs.", + "enum": [ + "GPU", + "FPGA" + ], + "x-ms-enum": { + "name": "AcceleratorType", + "modelAsString": true, + "values": [ + { + "name": "GPU", + "value": "GPU", + "description": "GPU Accelerator" + }, + { + "name": "FPGA", + "value": "FPGA", + "description": "FPGA Accelerator" + } + ] + } + }, + "AdditionalCapabilities": { + "type": "object", + "description": "AdditionalCapabilities for VM.", + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS.\nManaged disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + }, + "hibernationEnabled": { + "type": "boolean", + "description": "The flag that enables or disables hibernation capability on the VM." + } + } + }, + "AdditionalLocationsProfile": { + "type": "object", + "description": "Represents the configuration for additional locations where Fleet resources may be deployed.", + "properties": { + "locationProfiles": { + "type": "array", + "description": "The list of location profiles.", + "items": { + "$ref": "#/definitions/LocationProfile" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "locationProfiles" + ] + }, + "AdditionalUnattendContent": { + "type": "object", + "description": "Specifies additional XML formatted information that can be included in the\nUnattend.xml file, which is used by Windows Setup. Contents are defined by\nsetting name, component name, and the pass in which the content is applied.", + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is\nMicrosoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "modelAsString": false + } + }, + "settingName": { + "$ref": "#/definitions/SettingNames", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon." + }, + "content": { + "type": "string", + "format": "password", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for\nthe specified path and component. The XML must be less than 4KB and must\ninclude the root element for the setting or feature that is being inserted.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "ApiEntityReference": { + "type": "object", + "description": "The API entity reference.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM resource id in the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + } + }, + "ApiError": { + "type": "object", + "description": "ApiError for Fleet", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "details": { + "type": "array", + "description": "The API error details", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "x-ms-identifiers": [ + "message", + "target" + ] + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The API inner error" + } + } + }, + "ApiErrorBase": { + "type": "object", + "description": "API error base.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ApplicationProfile": { + "type": "object", + "description": "Contains the list of gallery applications that should be made available to the\nVM/VMSS", + "properties": { + "galleryApplications": { + "type": "array", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS", + "items": { + "$ref": "#/definitions/VMGalleryApplication" + }, + "x-ms-identifiers": [ + "packageReferenceId" + ] + } + } + }, + "ArchitectureType": { + "type": "string", + "description": "Architecture types supported by Azure VMs.", + "enum": [ + "ARM64", + "X86" + ], + "x-ms-enum": { + "name": "ArchitectureType", + "modelAsString": true, + "values": [ + { + "name": "ARM64", + "value": "ARM64", + "description": "ARM64 Architecture" + }, + { + "name": "X86", + "value": "X86", + "description": "X86 Architecture" + } + ] + } + }, + "BasePriorityProfile": { + "type": "object", + "description": "Contains common properties that are applicable to both Spot and Regular.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + } + } + }, + "BaseVirtualMachineProfile": { + "type": "object", + "description": "Describes the base virtual machine profile for fleet", + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale\nset." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the\nscale set." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the\nscale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines\nin the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises.\n<br><br> Possible values for Windows Server operating system are: <br><br>\nWindows_Client <br><br> Windows_Server <br><br> Possible values for Linux\nServer operating system are: <br><br> RHEL_BYOS (for RHEL) <br><br> SLES_BYOS\n(for SUSE) <br><br> For more information, see [Azure Hybrid Use Benefit for\nWindows\nServer](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)\n<br><br> [Azure Hybrid Use Benefit for Linux\nServer](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)\n<br><br> Minimum api-version: 2015-06-15" + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + }, + "userData": { + "type": "string", + "description": "UserData for the virtual machines in the scale set, which must be base-64\nencoded. Customer should not pass any secrets in here. Minimum api-version:\n2021-03-01." + }, + "capacityReservation": { + "$ref": "#/definitions/CapacityReservationProfile", + "description": "Specifies the capacity reservation related details of a scale set. Minimum\napi-version: 2021-04-01." + }, + "applicationProfile": { + "$ref": "#/definitions/ApplicationProfile", + "description": "Specifies the gallery applications that should be made available to the VM/VMSS" + }, + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetHardwareProfile", + "description": "Specifies the hardware profile related details of a scale set. Minimum\napi-version: 2021-11-01." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01" + }, + "securityPostureReference": { + "$ref": "#/definitions/SecurityPostureReference", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01" + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time in which this VM profile for the Virtual Machine Scale Set\nwas created. Minimum API version for this property is 2023-09-01. This value\nwill be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile\nwith minimum api-version 2023-09-01. Examples: \"2024-07-01T00:00:01.1234567+00:00\"", + "readOnly": true + } + } + }, + "BootDiagnostics": { + "type": "object", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. You can easily view the output of your\nconsole log. Azure also enables you to see a screenshot of the VM from the\nhypervisor.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "format": "uri", + "description": "Uri of the storage account to use for placing the console output and\nscreenshot. If storageUri is not specified while enabling boot diagnostics,\nmanaged storage will be used." + } + } + }, + "CachingTypes": { + "type": "string", + "description": "Specifies the caching requirements.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "'None' is default for Standard Storage" + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "'ReadOnly' is default for Premium Storage" + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "'ReadWrite' is default for OS Disk" + } + ] + } + }, + "CapacityReservationProfile": { + "type": "object", + "description": "The parameters of a capacity reservation Profile.", + "properties": { + "capacityReservationGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies the capacity reservation group resource id that should be used for\nallocating the virtual machine or scaleset vm instances provided enough\ncapacity has been reserved. Please refer to https://aka.ms/CapacityReservation\nfor more details." + } + } + }, + "ComputeProfile": { + "type": "object", + "description": "Compute Profile to use for running user's workloads.", + "properties": { + "baseVirtualMachineProfile": { + "$ref": "#/definitions/BaseVirtualMachineProfile", + "description": "Base Virtual Machine Profile Properties to be specified according to \"specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile\"" + }, + "computeApiVersion": { + "type": "string", + "description": "Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines.\nThe default value will be the latest supported computeApiVersion by Compute Fleet." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of fault domains to use when creating the underlying VMSS.\nA fault domain is a logical group of hardware within an Azure datacenter.\nVMs in the same fault domain share a common power source and network switch.\nIf not specified, defaults to 1, which represents \"Max Spreading\" (using as many fault domains as possible).\nThis property cannot be updated." + }, + "additionalVirtualMachineCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled.\nultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs.\nhibernationEnabled: Enables the hibernation capability on the VMSS VMs.\nDefault value is null if not specified. This property cannot be updated once set." + } + }, + "required": [ + "baseVirtualMachineProfile" + ] + }, + "CpuManufacturer": { + "type": "string", + "description": "Cpu Manufacturers supported by Azure VMs.", + "enum": [ + "Intel", + "AMD", + "Microsoft", + "Ampere" + ], + "x-ms-enum": { + "name": "CpuManufacturer", + "modelAsString": true, + "values": [ + { + "name": "Intel", + "value": "Intel", + "description": "Intel CPU." + }, + { + "name": "AMD", + "value": "AMD", + "description": "AMD CPU." + }, + { + "name": "Microsoft", + "value": "Microsoft", + "description": "Microsoft CPU." + }, + { + "name": "Ampere", + "value": "Ampere", + "description": "Ampere CPU." + } + ] + } + }, + "DeleteOptions": { + "type": "string", + "description": "Specify what happens to the network interface when the VM is deleted", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DeleteOptions", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "Delete Option" + }, + { + "name": "Detach", + "value": "Detach", + "description": "Detach Option" + } + ] + } + }, + "DiagnosticsProfile": { + "type": "object", + "description": "Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15.", + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output\nand Screenshot to diagnose VM status. **NOTE**: If storageUri is being\nspecified then ensure that the storage account is in the same region and\nsubscription as the VM. You can easily view the output of your console log.\nAzure also enables you to see a screenshot of the VM from the hypervisor." + } + } + }, + "DiffDiskOptions": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true, + "values": [ + { + "name": "Local", + "value": "Local", + "description": "Local Option." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property\ncan be used by user in the request to choose the location i.e, cache disk or\nresource disk space for Ephemeral OS disk provisioning. For more information on\nEphemeral OS disk size requirements, please refer Ephemeral OS disk size\nrequirements for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements\nand Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements\nMinimum api-version for NvmeDisk: 2024-03-01.", + "enum": [ + "CacheDisk", + "ResourceDisk", + "NvmeDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "CacheDisk", + "description": "CacheDisk option." + }, + { + "name": "ResourceDisk", + "value": "ResourceDisk", + "description": "Resource Disk option." + }, + { + "name": "NvmeDisk", + "value": "NvmeDisk", + "description": "NvmeDisk option." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "Describes the parameters of ephemeral disk settings that can be specified for\noperating system disk. **Note:** The ephemeral disk settings can only be\nspecified for managed disk.", + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOptions", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk. Possible\nvalues are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is:\n**CacheDisk** if one is configured for the VM size otherwise **ResourceDisk**\nis used. Refer to the VM size documentation for Windows VM at\nhttps://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at\nhttps://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM\nsizes exposes a cache disk." + } + } + }, + "DiskControllerTypes": { + "type": "string", + "description": "Specifies the disk controller type configured for the VM and\nVirtualMachineScaleSet. This property is only supported for virtual machines\nwhose operating system disk and VM sku supports Generation 2\n(https://docs.microsoft.com/en-us/azure/virtual-machines/generation-2), please\ncheck the HyperVGenerations capability returned as part of VM sku capabilities\nin the response of Microsoft.Compute SKUs api for the region contains V2\n(https://docs.microsoft.com/rest/api/compute/resourceskus/list). For more\ninformation about Disk Controller Types supported please refer to\nhttps://aka.ms/azure-diskcontrollertypes.", + "enum": [ + "SCSI", + "NVMe" + ], + "x-ms-enum": { + "name": "DiskControllerTypes", + "modelAsString": true, + "values": [ + { + "name": "SCSI", + "value": "SCSI", + "description": "SCSI disk type" + }, + { + "name": "NVMe", + "value": "NVMe", + "description": "NVMe disk type" + } + ] + } + }, + "DiskCreateOptionTypes": { + "type": "string", + "description": "Specifies how the virtual machine should be created.", + "enum": [ + "FromImage", + "Empty", + "Attach", + "Copy", + "Restore" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "FromImage", + "value": "FromImage", + "description": "This value is used when you are using an image to create the virtual machine.\nIf you are using a platform image, you also use the imageReference element\ndescribed above. If you are using a marketplace image, you also use the\nplan element previously described." + }, + { + "name": "Empty", + "value": "Empty", + "description": "This value is used when creating an empty data disk." + }, + { + "name": "Attach", + "value": "Attach", + "description": "This value is used when you are using a specialized disk to create the virtual machine." + }, + { + "name": "Copy", + "value": "Copy", + "description": "This value is used to create a data disk from a snapshot or another disk." + }, + { + "name": "Restore", + "value": "Restore", + "description": "This value is used to create a data disk from a disk restore point." + } + ] + } + }, + "DiskDeleteOptionTypes": { + "type": "string", + "description": "Specifies the behavior of the managed disk when the VM gets deleted, for\nexample whether the managed disk is deleted or detached. Supported values are:\n**Delete.** If this value is used, the managed disk is deleted when VM gets\ndeleted. **Detach.** If this value is used, the managed disk is retained after\nVM gets deleted. Minimum api-version: 2021-03-01.", + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "DiskDeleteOptionTypes", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "If this value is used, the managed disk is deleted when VM gets deleted." + }, + { + "name": "Detach", + "value": "Detach", + "description": "If this value is used, the managed disk is retained after VM gets deleted." + } + ] + } + }, + "DiskEncryptionSetParameters": { + "type": "object", + "description": "Describes the parameter of customer managed disk encryption set resource id\nthat can be specified for disk. **Note:** The disk encryption set resource id\ncan only be specified for managed disk. Please refer\nhttps://aka.ms/mdssewithcmkoverview for more details.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "DomainNameLabelScopeTypes": { + "type": "string", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created", + "enum": [ + "TenantReuse", + "SubscriptionReuse", + "ResourceGroupReuse", + "NoReuse" + ], + "x-ms-enum": { + "name": "DomainNameLabelScopeTypes", + "modelAsString": true, + "values": [ + { + "name": "TenantReuse", + "value": "TenantReuse", + "description": "TenantReuse type" + }, + { + "name": "SubscriptionReuse", + "value": "SubscriptionReuse", + "description": "SubscriptionReuse type" + }, + { + "name": "ResourceGroupReuse", + "value": "ResourceGroupReuse", + "description": "ResourceGroupReuse type" + }, + { + "name": "NoReuse", + "value": "NoReuse", + "description": "NoReuse type" + } + ] + } + }, + "EncryptionIdentity": { + "type": "object", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations.", + "properties": { + "userAssignedIdentityResourceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies ARM Resource ID of one of the user identities associated with the VM." + } + } + }, + "EvictionPolicy": { + "type": "string", + "description": "Different kind of eviction policies", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "EvictionPolicy", + "modelAsString": true, + "values": [ + { + "name": "Delete", + "value": "Delete", + "description": "When evicted, the Spot VM will be deleted and the corresponding capacity will be updated to reflect this." + }, + { + "name": "Deallocate", + "value": "Deallocate", + "description": "When evicted, the Spot VM will be deallocated/stopped" + } + ] + } + }, + "Fleet": { + "type": "object", + "description": "An Compute Fleet resource", + "properties": { + "properties": { + "$ref": "#/definitions/FleetProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "zones": { + "type": "array", + "description": "Zones in which the Compute Fleet is available", + "items": { + "type": "string" + } + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan", + "description": "Details of the resource plan." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "FleetListResult": { + "type": "object", + "description": "The response of a Fleet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Fleet items on this page", + "items": { + "$ref": "#/definitions/Fleet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "FleetProperties": { + "type": "object", + "description": "Details of the Compute Fleet.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "spotPriorityProfile": { + "$ref": "#/definitions/SpotPriorityProfile", + "description": "Configuration Options for Spot instances in Compute Fleet." + }, + "regularPriorityProfile": { + "$ref": "#/definitions/RegularPriorityProfile", + "description": "Configuration Options for Regular instances in Compute Fleet." + }, + "vmSizesProfile": { + "type": "array", + "description": "List of VM sizes supported for Compute Fleet", + "items": { + "$ref": "#/definitions/VmSizeProfile" + }, + "x-ms-identifiers": [] + }, + "vmAttributes": { + "$ref": "#/definitions/VMAttributes", + "description": "Attribute based Fleet." + }, + "additionalLocationsProfile": { + "$ref": "#/definitions/AdditionalLocationsProfile", + "description": "Represents the configuration for additional locations where Fleet resources may be deployed." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "Compute Profile to use for running user's workloads." + }, + "timeCreated": { + "type": "string", + "format": "date-time", + "description": "Specifies the time at which the Compute Fleet is created.", + "readOnly": true + }, + "uniqueId": { + "type": "string", + "description": "Specifies the ID which uniquely identifies a Compute Fleet.", + "readOnly": true + } + }, + "required": [ + "vmSizesProfile", + "computeProfile" + ] + }, + "FleetUpdate": { + "type": "object", + "description": "Fleet Update Model", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentityUpdate", + "description": "Updatable managed service identity" + }, + "plan": { + "$ref": "#/definitions/ResourcePlanUpdate", + "description": "Updatable resource plan" + }, + "properties": { + "$ref": "#/definitions/FleetProperties", + "description": "RP-specific updatable properties" + } + } + }, + "IPVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true, + "values": [ + { + "name": "IPv4", + "value": "IPv4", + "description": "IPv4 version" + }, + { + "name": "IPv6", + "value": "IPv6", + "description": "IPv6 version" + } + ] + } + }, + "ImageReference": { + "type": "object", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations. NOTE: Image\nreference publisher and offer can only be set when you create the scale set.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + }, + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create\nthe virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create\nthe virtual machine. The allowed formats are Major.Minor.Build or 'latest'.\nMajor, Minor, and Build are decimal numbers. Specify 'latest' to use the latest\nversion of an image available at deploy time. Even if you use 'latest', the VM\nimage will not automatically update after deploy time even if a new version\nbecomes available. Please do not use field 'version' for gallery image\ndeployment, gallery image should always use 'id' field for deployment, to use 'latest'\nversion of gallery image, just set\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}'\nin the 'id' field without version input." + }, + "exactVersion": { + "type": "string", + "description": "Specifies in decimal numbers, the version of platform image or marketplace\nimage used to create the virtual machine. This readonly field differs from 'version',\nonly if the value specified in 'version' field is 'latest'.", + "readOnly": true + }, + "sharedGalleryImageId": { + "type": "string", + "description": "Specified the shared gallery image unique id for vm deployment. This can be\nfetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "Specified the community gallery image unique id for vm deployment. This can be\nfetched from community gallery image GET call." + } + } + }, + "InnerError": { + "type": "object", + "description": "Inner error details.", + "properties": { + "exceptionType": { + "type": "string", + "description": "The exception type." + }, + "errorDetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + } + }, + "KeyVaultSecretReference": { + "type": "object", + "description": "Describes a reference to Key Vault Secret", + "properties": { + "secretUrl": { + "type": "string", + "format": "uri", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ] + }, + "LinuxConfiguration": { + "type": "object", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros).", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, default\nbehavior is to set it to true. This will ensure that VM Agent is installed on\nthe VM so that extensions can be added to the VM later." + }, + "patchSettings": { + "$ref": "#/definitions/LinuxPatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Linux." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Linux virtual\nmachine. Default value is false." + } + } + }, + "LinuxPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine. <br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments.The property provisionVMAgent must be true." + } + ] + } + }, + "LinuxPatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Linux.", + "properties": { + "patchMode": { + "$ref": "#/definitions/LinuxVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - The\nvirtual machine's default patching configuration is used. <br /><br />\n**AutomaticByPlatform** - The virtual machine will be automatically updated by\nthe platform. The property provisionVMAgent must be true" + }, + "assessmentMode": { + "$ref": "#/definitions/LinuxPatchAssessmentMode", + "description": "Specifies the mode of VM Guest Patch Assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine. <br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Linux." + } + } + }, + "LinuxVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "LinuxVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Linux patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/LinuxVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "LinuxVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "LinuxVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "The virtual machine's default patching configuration is used." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true." + } + ] + } + }, + "LocalStorageDiskType": { + "type": "string", + "description": "Different kind of Local storage disk types supported by Azure VMs.", + "enum": [ + "HDD", + "SSD" + ], + "x-ms-enum": { + "name": "LocalStorageDiskType", + "modelAsString": true, + "values": [ + { + "name": "HDD", + "value": "HDD", + "description": "HDD DiskType." + }, + { + "name": "SSD", + "value": "SSD", + "description": "SDD DiskType." + } + ] + } + }, + "LocationProfile": { + "type": "object", + "description": "Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).", + "properties": { + "location": { + "type": "string", + "description": "The ARM location name of the additional region." + }, + "virtualMachineProfileOverride": { + "$ref": "#/definitions/BaseVirtualMachineProfile", + "description": "An override for computeProfile.baseVirtualMachineProfile specific to this region. \nThis override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location." + } + } + }, + "ManagedServiceIdentityUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "Mode": { + "type": "string", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode.", + "enum": [ + "Audit", + "Enforce" + ], + "x-ms-enum": { + "name": "Mode", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Audit Mode" + }, + { + "name": "Enforce", + "value": "Enforce", + "description": "Enforce Mode" + } + ] + } + }, + "NetworkApiVersion": { + "type": "string", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'", + "enum": [ + "2020-11-01" + ], + "x-ms-enum": { + "name": "NetworkApiVersion", + "modelAsString": true, + "values": [ + { + "name": "v2020_11_01", + "value": "2020-11-01", + "description": "Initial version supported. Later versions are supported as well." + } + ] + } + }, + "NetworkInterfaceAuxiliaryMode": { + "type": "string", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "AcceleratedConnections", + "Floating" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliaryMode", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "None Mode" + }, + { + "name": "AcceleratedConnections", + "value": "AcceleratedConnections", + "description": "AcceleratedConnections Mode" + }, + { + "name": "Floating", + "value": "Floating", + "description": "Floating Mode" + } + ] + } + }, + "NetworkInterfaceAuxiliarySku": { + "type": "string", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource.", + "enum": [ + "None", + "A1", + "A2", + "A4", + "A8" + ], + "x-ms-enum": { + "name": "NetworkInterfaceAuxiliarySku", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "no sku" + }, + { + "name": "A1", + "value": "A1", + "description": "A1 sku" + }, + { + "name": "A2", + "value": "A2", + "description": "A2 sku" + }, + { + "name": "A4", + "value": "A4", + "description": "A4 sku" + }, + { + "name": "A8", + "value": "A8", + "description": "A8 sku" + } + ] + } + }, + "OSImageNotificationProfile": { + "type": "object", + "description": "Specifies OS Image Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Length of time a Virtual Machine being reimaged or having its OS upgraded will\nhave to potentially approve the OS Image Scheduled Event before the event is\nauto approved (timed out). The configuration is specified in ISO 8601 format,\nand the value must not exceed 15 minutes (PT15M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the OS Image Scheduled event is enabled or disabled." + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows OS type" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux OS type" + } + ] + } + }, + "PatchSettings": { + "type": "object", + "description": "Specifies settings related to VM Guest Patching on Windows.", + "properties": { + "patchMode": { + "$ref": "#/definitions/WindowsVMGuestPatchMode", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.<br /><br /> Possible values are:<br /><br /> **Manual** - You\ncontrol the application of patches to a virtual machine. You do this by\napplying patches manually inside the VM. In this mode, automatic updates are\ndisabled; the property WindowsConfiguration.enableAutomaticUpdates must be\nfalse<br /><br /> **AutomaticByOS** - The virtual machine will automatically be\nupdated by the OS. The property WindowsConfiguration.enableAutomaticUpdates\nmust be true. <br /><br /> **AutomaticByPlatform** - the virtual machine will\nautomatically updated by the platform. The properties provisionVMAgent and\nWindowsConfiguration.enableAutomaticUpdates must be true" + }, + "enableHotpatching": { + "type": "boolean", + "description": "Enables customers to patch their Azure VMs without requiring a reboot. For\nenableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode'\nmust be set to 'AutomaticByPlatform'." + }, + "assessmentMode": { + "$ref": "#/definitions/WindowsPatchAssessmentMode", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual\nmachine.<br /><br /> Possible values are:<br /><br /> **ImageDefault** - You\ncontrol the timing of patch assessments on a virtual machine.<br /><br />\n**AutomaticByPlatform** - The platform will trigger periodic patch assessments.\nThe property provisionVMAgent must be true." + }, + "automaticByPlatformSettings": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformSettings", + "description": "Specifies additional settings for patch mode AutomaticByPlatform in VM Guest\nPatching on Windows." + } + } + }, + "ProtocolTypes": { + "type": "string", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": true, + "values": [ + { + "name": "Http", + "value": "Http", + "description": "Http protocol" + }, + { + "name": "Https", + "value": "Https", + "description": "Https protocol" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting", + "Migrating" + ], + "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": "Creating", + "value": "Creating", + "description": "Initial creation in progress." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Update in progress." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion in progress." + }, + { + "name": "Migrating", + "value": "Migrating", + "description": "Resource is being migrated from one subscription or resource group to another." + } + ] + }, + "readOnly": true + }, + "ProxyAgentSettings": { + "type": "object", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01.", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether ProxyAgent feature should be enabled on the virtual machine\nor virtual machine scale set." + }, + "mode": { + "$ref": "#/definitions/Mode", + "description": "Specifies the mode that ProxyAgent will execute on if the feature is enabled.\nProxyAgent will start to audit or monitor but not enforce access control over\nrequests to host endpoints in Audit mode, while in Enforce mode it will enforce\naccess control. The default value is Enforce mode." + }, + "keyIncarnationId": { + "type": "integer", + "format": "int32", + "description": "Increase the value of this property allows user to reset the key used for\nsecuring communication channel between guest and host." + } + } + }, + "PublicIPAddressSku": { + "type": "object", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible.", + "properties": { + "name": { + "$ref": "#/definitions/PublicIPAddressSkuName", + "description": "Specify public IP sku name" + }, + "tier": { + "$ref": "#/definitions/PublicIPAddressSkuTier", + "description": "Specify public IP sku tier" + } + } + }, + "PublicIPAddressSkuName": { + "type": "string", + "description": "Specify public IP sku name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true, + "values": [ + { + "name": "Basic", + "value": "Basic", + "description": "Basic sku name" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Standard sku name" + } + ] + } + }, + "PublicIPAddressSkuTier": { + "type": "string", + "description": "Specify public IP sku tier", + "enum": [ + "Regional", + "Global" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuTier", + "modelAsString": true, + "values": [ + { + "name": "Regional", + "value": "Regional", + "description": "Regional sku tier" + }, + { + "name": "Global", + "value": "Global", + "description": "Global sku tier" + } + ] + } + }, + "RegularPriorityAllocationStrategy": { + "type": "string", + "description": "Regular VM Allocation strategy types for Compute Fleet", + "enum": [ + "LowestPrice", + "Prioritized" + ], + "x-ms-enum": { + "name": "RegularPriorityAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "Default. VM sizes distribution will be determined to optimize for price." + }, + { + "name": "Prioritized", + "value": "Prioritized", + "description": "VM sizes distribution will be determined to optimize for the 'priority' as specified for each vm size." + } + ] + } + }, + "RegularPriorityProfile": { + "type": "object", + "description": "Configuration Options for Regular instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "allocationStrategy": { + "$ref": "#/definitions/RegularPriorityAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Regular VMs." + } + } + }, + "ResourcePlanUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "name": { + "type": "string", + "description": "A user defined name of the 3rd Party Artifact that is being procured." + }, + "publisher": { + "type": "string", + "description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic" + }, + "product": { + "type": "string", + "description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding." + }, + "promotionCode": { + "type": "string", + "description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact." + }, + "version": { + "type": "string", + "description": "The version of the desired product/artifact." + } + } + }, + "ScheduledEventsProfile": { + "type": "object", + "description": "Specifies Scheduled Event related configurations.", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + }, + "osImageNotificationProfile": { + "$ref": "#/definitions/OSImageNotificationProfile", + "description": "Specifies OS Image Scheduled Event related configurations." + } + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "Specifies the EncryptionType of the managed disk.\n**Note:** It can be set for only Confidential VMs.", + "enum": [ + "VMGuestStateOnly", + "DiskWithVMGuestState", + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "EncryptionType of the managed disk is set to VMGuestStateOnly for encryption\nof just the VMGuestState blob." + }, + { + "name": "DiskWithVMGuestState", + "value": "DiskWithVMGuestState", + "description": "EncryptionType of the managed disk is set to DiskWithVMGuestState for encryption\nof the managed disk along with VMGuestState blob." + }, + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "EncryptionType of the managed disk is set to NonPersistedTPM for not persisting\nfirmware state in the VMGuestState blob." + } + ] + } + }, + "SecurityPostureReference": { + "type": "object", + "description": "Specifies the security posture to be used for all virtual machines in the scale\nset. Minimum api-version: 2023-03-01", + "properties": { + "id": { + "type": "string", + "description": "The security posture reference id in the form of\n/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest" + }, + "excludeExtensions": { + "type": "array", + "description": "List of virtual machine extension names to exclude when applying the security\nposture.", + "items": { + "type": "string" + } + }, + "isOverridable": { + "type": "boolean", + "description": "Whether the security posture can be overridden by the user." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the Security profile settings for the virtual machine or virtual\nmachine scale set.", + "properties": { + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01." + }, + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host\nEncryption for the virtual machine or virtual machine scale set. This will\nenable the encryption for all the disks including Resource/Temp disk at host\nitself. The default behavior is: The Encryption at host will be disabled unless\nthis property is set to true for the resource." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set." + }, + "encryptionIdentity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Specifies the Managed Identity used by ADE to get access token for keyvault\noperations." + }, + "proxyAgentSettings": { + "$ref": "#/definitions/ProxyAgentSettings", + "description": "Specifies ProxyAgent settings while creating the virtual machine. Minimum\napi-version: 2023-09-01." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any\nspecified value to enable UefiSettings. The default behavior is: UefiSettings\nwill not be enabled unless this property is set.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "TrustedLaunch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "ConfidentialVM security type" + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version for\nall virtual machines in the scale set when using 'latest' image version.\nMinimum api-version: 2022-11-01", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The service artifact reference id in the form of\n/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "SettingNames": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values\nare: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": true, + "values": [ + { + "name": "AutoLogon", + "value": "AutoLogon", + "description": "AutoLogon setting" + }, + { + "name": "FirstLogonCommands", + "value": "FirstLogonCommands", + "description": "FirstLogonCommands setting" + } + ] + } + }, + "SpotAllocationStrategy": { + "type": "string", + "description": "Spot allocation strategy types for Compute Fleet", + "enum": [ + "PriceCapacityOptimized", + "LowestPrice", + "CapacityOptimized" + ], + "x-ms-enum": { + "name": "SpotAllocationStrategy", + "modelAsString": true, + "values": [ + { + "name": "PriceCapacityOptimized", + "value": "PriceCapacityOptimized", + "description": "Default. VM sizes distribution will be determined to optimize for both price and capacity." + }, + { + "name": "LowestPrice", + "value": "LowestPrice", + "description": "VM sizes distribution will be determined to optimize for price. Note: Capacity will still be considered here but will be given much less weight." + }, + { + "name": "CapacityOptimized", + "value": "CapacityOptimized", + "description": "VM sizes distribution will be determined to optimize for capacity." + } + ] + } + }, + "SpotPriorityProfile": { + "type": "object", + "description": "Configuration Options for Spot instances in Compute Fleet.", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Total capacity to achieve. It is currently in terms of number of VMs.", + "minimum": 0 + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "Minimum capacity to achieve which cannot be updated. If we will not be able to \"guarantee\" minimum capacity, we will reject the request in the sync path itself.", + "minimum": 0 + }, + "maxPricePerVM": { + "type": "number", + "format": "float", + "description": "Price per hour of each Spot VM will never exceed this." + }, + "evictionPolicy": { + "$ref": "#/definitions/EvictionPolicy", + "description": "Eviction Policy to follow when evicting Spot VMs." + }, + "allocationStrategy": { + "$ref": "#/definitions/SpotAllocationStrategy", + "description": "Allocation strategy to follow when determining the VM sizes distribution for Spot VMs." + }, + "maintain": { + "type": "boolean", + "description": "Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs.\nIf maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted)\nor update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity.\nMaintain is enabled by default." + } + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux\nVM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If\nthe file already exists, the specified key is appended to the file. Example:\n/home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The\nkey needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys,\nsee [Create SSH keys on Linux and Mac for Linux VMs in\nAzure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Info level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error Level" + } + ] + } + }, + "StorageAccountTypes": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk\nstorage account type can only be set when you create the scale set. NOTE:\nUltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk.\nStandard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS\nuses Premium SSD. UltraSSD_LRS uses Ultra disk. Premium_ZRS uses Premium SSD\nzone redundant storage. StandardSSD_ZRS uses Standard SSD zone redundant\nstorage. For more information regarding disks supported for Windows Virtual\nMachines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/windows/disks-types and, for\nLinux Virtual Machines, refer to\nhttps://docs.microsoft.com/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS", + "PremiumV2_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true, + "values": [ + { + "name": "Standard_LRS", + "value": "Standard_LRS", + "description": "Standard_LRS option." + }, + { + "name": "Premium_LRS", + "value": "Premium_LRS", + "description": "Premium_LRS option." + }, + { + "name": "StandardSSD_LRS", + "value": "StandardSSD_LRS", + "description": "StandardSSD_LRS option." + }, + { + "name": "UltraSSD_LRS", + "value": "UltraSSD_LRS", + "description": "UltraSSD_LRS option." + }, + { + "name": "Premium_ZRS", + "value": "Premium_ZRS", + "description": "Premium_ZRS option." + }, + { + "name": "StandardSSD_ZRS", + "value": "StandardSSD_ZRS", + "description": "StandardSSD_ZRS option." + }, + { + "name": "PremiumV2_LRS", + "value": "PremiumV2_LRS", + "description": "PremiumV2_LRS option." + } + ] + } + }, + "SubResource": { + "type": "object", + "description": "Describes SubResource", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id" + } + } + }, + "SubResourceReadOnly": { + "type": "object", + "description": "Describes a Readonly subresource.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "description": "Specifies Terminate Scheduled Event related configurations.", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to\npotentially approve the Terminate Scheduled Event before the event is auto\napproved (timed out). The configuration must be specified in ISO 8601 format,\nthe default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "UefiSettings": { + "type": "object", + "description": "Specifies the security settings like secure boot and vTPM used while creating\nthe virtual machine. Minimum api-version: 2020-12-01.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine. Minimum\napi-version: 2020-12-01." + } + } + }, + "VMAttributeMinMaxDouble": { + "type": "object", + "description": "VMAttributes using double values.", + "properties": { + "min": { + "type": "number", + "format": "double", + "description": "Minimum value. default 0. Double.MinValue()", + "minimum": 0 + }, + "max": { + "type": "number", + "format": "double", + "description": "Maximum value. Double.MaxValue(1.7976931348623157E+308)", + "minimum": 0 + } + } + }, + "VMAttributeMinMaxInteger": { + "type": "object", + "description": "While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes.", + "properties": { + "min": { + "type": "integer", + "format": "int32", + "description": "Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified.", + "minimum": 0 + }, + "max": { + "type": "integer", + "format": "int32", + "description": "Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified.", + "minimum": 0 + } + } + }, + "VMAttributeSupport": { + "type": "string", + "description": "VMSizes supported by Azure VMs. Included is a union of Excluded and Required.", + "enum": [ + "Excluded", + "Included", + "Required" + ], + "x-ms-enum": { + "name": "VMAttributeSupport", + "modelAsString": true, + "values": [ + { + "name": "Excluded", + "value": "Excluded", + "description": "All VMSizes having the feature support will be excluded." + }, + { + "name": "Included", + "value": "Included", + "description": " VMSizes that have the feature support and that do not have the feature support will be used. Included is a union of Excluded and Required." + }, + { + "name": "Required", + "value": "Required", + "description": "Only the VMSizes having the feature support will be used." + } + ] + } + }, + "VMAttributes": { + "type": "object", + "description": "VMAttributes that will be used to filter VMSizes which will be used to build Fleet.", + "properties": { + "vCpuCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified." + }, + "memoryInGiB": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified." + }, + "localStorageSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting local storage should be used to build Fleet or not." + }, + "localStorageInGiB": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of local storage in GB specified from Min to Max." + }, + "localStorageDiskTypes": { + "type": "array", + "description": "The local storage disk types specified as a list. LocalStorageSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf localStorageSupport is \"Excluded\", this VMAttribute can not be used.", + "items": { + "$ref": "#/definitions/LocalStorageDiskType" + }, + "x-ms-identifiers": [] + }, + "dataDiskCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "networkInterfaceCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "networkBandwidthInMbps": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "rdmaSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not." + }, + "rdmaNetworkInterfaceCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + }, + "acceleratorSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting accelerator should be used to build Fleet or not." + }, + "acceleratorManufacturers": { + "type": "array", + "description": "The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "items": { + "$ref": "#/definitions/AcceleratorManufacturer" + }, + "x-ms-identifiers": [] + }, + "acceleratorTypes": { + "type": "array", + "description": "The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "items": { + "$ref": "#/definitions/AcceleratorType" + }, + "x-ms-identifiers": [] + }, + "acceleratorCount": { + "$ref": "#/definitions/VMAttributeMinMaxInteger", + "description": "The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified." + }, + "vmCategories": { + "type": "array", + "description": "The VM category specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/VMCategory" + }, + "x-ms-identifiers": [] + }, + "architectureTypes": { + "type": "array", + "description": "The VM architecture types specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/ArchitectureType" + }, + "x-ms-identifiers": [] + }, + "cpuManufacturers": { + "type": "array", + "description": "The VM CPU manufacturers specified as a list. Optional parameter.", + "items": { + "$ref": "#/definitions/CpuManufacturer" + }, + "x-ms-identifiers": [] + }, + "burstableSupport": { + "$ref": "#/definitions/VMAttributeSupport", + "description": "Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not." + }, + "excludedVMSizes": { + "type": "array", + "description": "Specifies which VMSizes should be excluded while building Fleet. Optional parameter.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "vCpuCount", + "memoryInGiB" + ] + }, + "VMCategory": { + "type": "string", + "description": "VMCategories defined for Azure VMs.\nSee: https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose", + "enum": [ + "GeneralPurpose", + "ComputeOptimized", + "MemoryOptimized", + "StorageOptimized", + "GpuAccelerated", + "FpgaAccelerated", + "HighPerformanceCompute" + ], + "x-ms-enum": { + "name": "VMCategory", + "modelAsString": true, + "values": [ + { + "name": "GeneralPurpose", + "value": "GeneralPurpose", + "description": "General purpose VM sizes provide balanced CPU-to-memory ratio. Ideal for testing and development, small to medium databases, and low to medium traffic web servers." + }, + { + "name": "ComputeOptimized", + "value": "ComputeOptimized", + "description": "Compute optimized VM sizes have a high CPU-to-memory ratio. These sizes are good for medium traffic web servers, network appliances, batch processes, and application servers." + }, + { + "name": "MemoryOptimized", + "value": "MemoryOptimized", + "description": "Memory optimized VM sizes offer a high memory-to-CPU ratio that is great for relational database servers, medium to large caches, and in-memory analytics." + }, + { + "name": "StorageOptimized", + "value": "StorageOptimized", + "description": "Storage optimized virtual machine (VM) sizes offer high disk throughput and IO, and are ideal for Big Data, SQL, NoSQL databases, data warehousing, and large transactional databases. \nExamples include Cassandra, MongoDB, Cloudera, and Redis." + }, + { + "name": "GpuAccelerated", + "value": "GpuAccelerated", + "description": "GPU optimized VM sizes are specialized virtual machines available with single, multiple, or fractional GPUs. \nThese sizes are designed for compute-intensive, graphics-intensive, and visualization workloads." + }, + { + "name": "FpgaAccelerated", + "value": "FpgaAccelerated", + "description": "FPGA optimized VM sizes are specialized virtual machines available with single or multiple FPGA. \nThese sizes are designed for compute-intensive workloads. This article provides information about the number and type of FPGA, vCPUs, data disks, and NICs. \nStorage throughput and network bandwidth are also included for each size in this grouping." + }, + { + "name": "HighPerformanceCompute", + "value": "HighPerformanceCompute", + "description": "Azure High Performance Compute VMs are optimized for various HPC workloads such as computational fluid dynamics, finite element analysis, frontend and backend EDA, \nrendering, molecular dynamics, computational geo science, weather simulation, and financial risk analysis." + } + ] + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. **Note:** It can\nonly be set for Confidential VMs.", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "description": "Specifies the EncryptionType of the managed disk. It is set to\nDiskWithVMGuestState for encryption of the managed disk along with VMGuestState\nblob, VMGuestStateOnly for encryption of just the VMGuestState blob, and\nNonPersistedTPM for not persisting firmware state in the VMGuestState blob..\n**Note:** It can be set for only Confidential VMs." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and\nVMGuest blob." + } + } + }, + "VMGalleryApplication": { + "type": "object", + "description": "Specifies the required information to reference a compute gallery application\nversion", + "properties": { + "tags": { + "type": "string", + "description": "Optional, Specifies a passthrough value for more generic context." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "Optional, Specifies the order in which the packages have to be installed" + }, + "packageReferenceId": { + "type": "string", + "format": "arm-id", + "description": "Specifies the GalleryApplicationVersion resource id on the form of\n/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version}" + }, + "configurationReference": { + "type": "string", + "description": "Optional, Specifies the uri to an azure blob that will replace the default\nconfiguration for the package if provided" + }, + "treatFailureAsDeploymentFailure": { + "type": "boolean", + "description": "Optional, If true, any failure for any operation in the VmApplication will fail\nthe deployment" + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "If set to true, when a new Gallery Application version is available in PIR/SIG,\nit will be automatically updated for the VM/VMSS" + } + }, + "required": [ + "packageReferenceId" + ] + }, + "VMSizeProperties": { + "type": "object", + "description": "Specifies VM Size Property settings on the virtual machine.", + "properties": { + "vCPUsAvailable": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of vCPUs available for the VM. When this property is not\nspecified in the request body the default behavior is to set it to the value of\nvCPUs available for that VM size exposed in api response of [List all available\nvirtual machine sizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list)." + }, + "vCPUsPerCore": { + "type": "integer", + "format": "int32", + "description": "Specifies the vCPU to physical core ratio. When this property is not specified\nin the request body the default behavior is set to the value of vCPUsPerCore\nfor the VM Size exposed in api response of [List all available virtual machine\nsizes in a\nregion](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list).\n**Setting this property to 1 also means that hyper-threading is disabled.**" + } + } + }, + "VaultCertificate": { + "type": "object", + "description": "Describes a single certificate reference in a Key Vault, and where the\ncertificate should reside on the VM.", + "properties": { + "certificateUrl": { + "type": "string", + "format": "uri", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be It is the Base64 encoding of the\nfollowing JSON Object which is encoded in UTF-8: <br><br> {<br>\n\"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br>\n\"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to\nwhich the certificate should be added. The specified certificate store is\nimplicitly in the LocalMachine account. For Linux VMs, the certificate file is\nplaced under the /var/lib/waagent directory, with the file name\n<UppercaseThumbprint>.crt for the X509 certificate file and\n<UppercaseThumbprint>.prv for private key. Both of these files are .pem\nformatted." + } + } + }, + "VaultSecretGroup": { + "type": "object", + "description": "Describes a set of certificates which are all in the same Key Vault.", + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in\nVaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "description": "The list of key vault references in SourceVault which contain certificates.", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [ + "certificateUrl" + ] + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "Describes the uri of a disk.", + "properties": { + "uri": { + "type": "string", + "format": "uri", + "description": "Specifies the virtual hard disk's uri." + } + } + }, + "VirtualMachineScaleSet": { + "type": "object", + "description": "An AzureFleet's virtualMachineScaleSet", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtualMachineScaleSet", + "readOnly": true + }, + "id": { + "type": "string", + "description": "The compute RP resource id of the virtualMachineScaleSet \n\"subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}\"", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the virtualMachineScaleSet", + "readOnly": true + }, + "operationStatus": { + "$ref": "#/definitions/ProvisioningState", + "description": "This represents the operationStatus of the VMSS in response to the last operation that was performed on it by Azure Fleet resource.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ApiError", + "description": "Error Information when `operationStatus` is `Failed`", + "readOnly": true + } + }, + "required": [ + "name", + "id", + "operationStatus" + ] + }, + "VirtualMachineScaleSetDataDisk": { + "type": "object", + "description": "Describes a virtual machine scale set data disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to\nidentify data disks within the VM and therefore must be unique for each data\ndisk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property\ndiskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be\nlarger than 1023." + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when\nStorageAccountType is UltraSSD_LRS. If not specified, a default value would be\nassigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used\nonly when StorageAccountType is UltraSSD_LRS. If not specified, a default value\nwould be assigned based on diskSizeGB." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether data disk should be deleted or detached upon VMSS Flex\ndeletion (This feature is available for VMSS with Flexible OrchestrationMode\nonly).<br><br> Possible values: <br><br> **Delete** If this value is used, the\ndata disk is deleted when the VMSS Flex VM is deleted.<br><br> **Detach** If\nthis value is used, the data disk is retained after VMSS Flex VM is\ndeleted.<br><br> The default value is set to **Delete**." + } + }, + "required": [ + "lun", + "createOption" + ] + }, + "VirtualMachineScaleSetExtension": { + "type": "object", + "description": "Describes a Virtual Machine Scale Set Extension.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "Resource Id", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "type": "string", + "description": "Resource type", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + } + }, + "VirtualMachineScaleSetExtensionProfile": { + "type": "object", + "description": "Describes a virtual machine scale set extension profile.", + "properties": { + "extensions": { + "type": "array", + "description": "The virtual machine scale set child extension resources.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration\nshould be between 15 minutes and 120 minutes (inclusive) and should be\nspecified in ISO 8601 format. The default value is 90 minutes (PT1H30M).\nMinimum api-version: 2020-06-01." + } + } + }, + "VirtualMachineScaleSetExtensionProperties": { + "type": "object", + "description": "Describes the properties of a Virtual Machine Scale Set Extension.", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension\nhandler will be forced to update even if the extension configuration has not\nchanged." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is\navailable at deployment time. Once deployed, however, the extension will not\nupgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the\nplatform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension.", + "additionalProperties": {} + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or\nprotectedSettingsFromKeyVault or no protected settings at all.", + "additionalProperties": {}, + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "readOnly": true + }, + "provisionAfterExtensions": { + "type": "array", + "description": "Collection of extension names after which this extension needs to be\nprovisioned.", + "items": { + "type": "string" + } + }, + "suppressFailures": { + "type": "boolean", + "description": "Indicates whether failures stemming from the extension will be suppressed\n(Operational failures such as not connecting to the VM will not be suppressed\nregardless of this value). The default is false." + }, + "protectedSettingsFromKeyVault": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "The extensions protected settings that are passed by reference, and consumed\nfrom key vault" + } + } + }, + "VirtualMachineScaleSetHardwareProfile": { + "type": "object", + "description": "Specifies the hardware settings for the virtual machine scale set.", + "properties": { + "vmSizeProperties": { + "$ref": "#/definitions/VMSizeProperties", + "description": "Specifies the properties for customizing the size of the virtual machine.\nMinimum api-version: 2021-11-01. Please follow the instructions in [VM\nCustomization](https://aka.ms/vmcustomization) for more details." + } + } + }, + "VirtualMachineScaleSetIPConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration\nproperties.", + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of application\ngateways. A scale set can reference backend address pools of multiple\napplication gateways. Multiple scale sets cannot use the same application\ngateway.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "applicationSecurityGroups": { + "type": "array", + "description": "Specifies an array of references to application security group.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "description": "Specifies an array of references to backend address pools of load balancers. A\nscale set can reference backend address pools of one public and one internal\nload balancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + }, + "loadBalancerInboundNatPools": { + "type": "array", + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A\nscale set can reference inbound nat pools of one public and one internal load\nbalancer. Multiple scale sets cannot use the same basic sku load balancer.", + "items": { + "$ref": "#/definitions/SubResource" + } + } + } + }, + "VirtualMachineScaleSetIpTag": { + "type": "object", + "description": "Contains the IP tag associated with the public IP address.", + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + } + }, + "VirtualMachineScaleSetListResult": { + "type": "object", + "description": "The response of a VirtualMachineScaleSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineScaleSet items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "type": "object", + "description": "Describes the parameters of a ScaleSet managed disk.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountTypes", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can\nonly be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed\ndisk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + } + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's network configurations.", + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties", + "description": "Describes a virtual machine scale set network profile's IP configuration." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS servers IP addresses", + "items": { + "type": "string" + } + } + } + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machine scale set network profile's IP configuration.", + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more\nthan 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "disableTcpStateTracking": { + "type": "boolean", + "description": "Specifies whether the network interface is disabled for tcp state tracking." + }, + "enableFpga": { + "type": "boolean", + "description": "Specifies whether the network interface is FPGA networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "description": "Specifies the IP configurations of the network interface.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the network interface when the VM is deleted" + }, + "auxiliaryMode": { + "$ref": "#/definitions/NetworkInterfaceAuxiliaryMode", + "description": "Specifies whether the Auxiliary mode is enabled for the Network Interface\nresource." + }, + "auxiliarySku": { + "$ref": "#/definitions/NetworkInterfaceAuxiliarySku", + "description": "Specifies whether the Auxiliary sku is enabled for the Network Interface\nresource." + } + }, + "required": [ + "ipConfigurations" + ] + }, + "VirtualMachineScaleSetNetworkProfile": { + "type": "object", + "description": "Describes a virtual machine scale set network profile.", + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an\ninstance in the virtual machine scale set. The reference will be in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "description": "The list of network configurations.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "x-ms-identifiers": [] + }, + "networkApiVersion": { + "$ref": "#/definitions/NetworkApiVersion", + "description": "specifies the Microsoft.Network API version used when creating networking\nresources in the Network Interface Configurations for Virtual Machine Scale Set\nwith orchestration mode 'Flexible'" + } + } + }, + "VirtualMachineScaleSetOSDisk": { + "type": "object", + "description": "Describes a virtual machine scale set operating system disk.", + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/CachingTypes", + "description": "Specifies the caching requirements. Possible values are: **None,**\n**ReadOnly,** **ReadWrite.** The default values are: **None for Standard\nstorage. ReadOnly for Premium storage.**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/DiskCreateOptionTypes", + "description": "Specifies how the virtual machines in the scale set should be created. The only\nallowed value is: **FromImage.** This value is used when you are using an image\nto create the virtual machine. If you are using a platform image, you also use\nthe imageReference element described above. If you are using a marketplace\nimage, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the\nvirtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used\nto overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB'\nis the number of bytes x 1024^3 for the disk and the value cannot\nbe larger than 1023." + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the\ndisk if creating a VM from user-image or a specialized VHD. Possible values\nare: **Windows,** **Linux.**" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "description": "Specifies the container urls that are used to store operating system disks for\nthe scale set.", + "items": { + "type": "string" + } + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters", + "description": "The managed disk parameters." + }, + "deleteOption": { + "$ref": "#/definitions/DiskDeleteOptionTypes", + "description": "Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion\n(This feature is available for VMSS with Flexible OrchestrationMode only).\n<br><br> Possible values: <br><br> **Delete** If this value is used, the OS\ndisk is deleted when VMSS Flex VM is deleted.<br><br> **Detach** If this value\nis used, the OS disk is retained after VMSS Flex VM is deleted. <br><br> The\ndefault value is set to **Delete**. For an Ephemeral OS Disk, the default value\nis set to **Delete**. User cannot change the delete option for Ephemeral OS\nDisk." + } + }, + "required": [ + "createOption" + ] + }, + "VirtualMachineScaleSetOSProfile": { + "type": "object", + "description": "Describes a virtual machine scale set OS profile.", + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale\nset. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account. <br><br> **Windows-only\nrestriction:** Cannot end in \".\" <br><br> **Disallowed values:**\n\"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\",\n\"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\",\n\"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\",\n\"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".\n<br><br> **Minimum-length (Linux):** 1 character <br><br> **Max-length\n(Linux):** 64 characters <br><br> **Max-length (Windows):** 20 characters" + }, + "adminPassword": { + "type": "string", + "format": "password", + "description": "Specifies the password of the administrator account. <br><br> **Minimum-length\n(Windows):** 8 characters <br><br> **Minimum-length (Linux):** 6 characters\n<br><br> **Max-length (Windows):** 123 characters <br><br> **Max-length\n(Linux):** 72 characters <br><br> **Complexity requirements:** 3 out of 4\nconditions below need to be fulfilled <br> Has lower characters <br>Has upper\ncharacters <br> Has a digit <br> Has a special character (Regex match [\\W_])\n<br><br> **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\",\n\"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\",\n\"Password22\", \"iloveyou!\" <br><br> For resetting the password, see [How to\nreset the Remote Desktop service or its login password in a Windows\nVM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)\n<br><br> For resetting root password, see [Manage users, SSH, and check or\nrepair disks on Azure Linux VMs using the VMAccess\nExtension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "customData": { + "type": "string", + "format": "password", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string\nis decoded to a binary array that is saved as a file on the Virtual Machine.\nThe maximum length of the binary array is 65535 bytes. For using cloud-init for\nyour VM, see [Using cloud-init to customize a Linux VM during\ncreation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init)", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine. For a\nlist of supported Linux distributions, see [Linux on Azure-Endorsed\nDistributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros)." + }, + "secrets": { + "type": "array", + "description": "Specifies set of certificates that should be installed onto the virtual\nmachines in the scale set. To install certificates on a virtual machine it is\nrecommended to use the [Azure Key Vault virtual machine extension for\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows).", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault/id" + ] + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine\nscale set. This may only be set to False when no extensions are present on the\nvirtual machine scale set." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Optional property which must either be set to True or omitted." + } + } + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration" + }, + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "Describes the public IP Sku. It can only be set with OrchestrationMode as\nFlexible." + } + }, + "required": [ + "name" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "type": "object", + "description": "Describes a virtual machines scale sets network configuration's DNS settings.", + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index\nwill be the domain name labels of the PublicIPAddress resources that will be\ncreated" + }, + "domainNameLabelScope": { + "$ref": "#/definitions/DomainNameLabelScopeTypes", + "description": "The Domain name label scope.The concatenation of the hashed domain name label\nthat generated according to the policy from domain name label scope and vm\nindex will be the domain name labels of the PublicIPAddress resources that will\nbe created" + } + }, + "required": [ + "domainNameLabel" + ] + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "type": "object", + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress\nconfiguration", + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "description": "The list of IP tags associated with the public IP address.", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "x-ms-identifiers": [] + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "$ref": "#/definitions/IPVersion", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the\nspecific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible\nvalues are: 'IPv4' and 'IPv6'." + }, + "deleteOption": { + "$ref": "#/definitions/DeleteOptions", + "description": "Specify what happens to the public IP when the VM is deleted" + } + } + }, + "VirtualMachineScaleSetStorageProfile": { + "type": "object", + "description": "Describes a virtual machine scale set storage profile.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about\nplatform images, marketplace images, or virtual machine images. This element is\nrequired when you want to use a platform image, marketplace image, or virtual\nmachine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview)." + }, + "dataDisks": { + "type": "array", + "description": "Specifies the parameters that are used to add data disks to the virtual\nmachines in the scale set. For more information about disks, see [About disks\nand VHDs for Azure virtual\nmachines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview).", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "x-ms-identifiers": [ + "name", + "lun" + ] + }, + "diskControllerType": { + "$ref": "#/definitions/DiskControllerTypes", + "description": "Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01" + } + } + }, + "VmSizeProfile": { + "type": "object", + "description": "Specifications about a VM Size. This will also contain the corresponding rank and weight in future.", + "properties": { + "name": { + "type": "string", + "description": "The Sku name (e.g. 'Standard_DS1_v2')" + }, + "rank": { + "type": "integer", + "format": "int32", + "description": "The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized'\nThe lower the number, the higher the priority. Starting with 0.", + "minimum": 0, + "maximum": 65535 + } + }, + "required": [ + "name" + ] + }, + "WinRMConfiguration": { + "type": "object", + "description": "Describes Windows Remote Management configuration of the VM", + "properties": { + "listeners": { + "type": "array", + "description": "The list of Windows Remote Management listeners", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "x-ms-identifiers": [] + } + } + }, + "WinRMListener": { + "type": "object", + "description": "Describes Protocol and thumbprint of Windows Remote Management listener", + "properties": { + "protocol": { + "$ref": "#/definitions/ProtocolTypes", + "description": "Specifies the protocol of WinRM listener. Possible values are: **http,**\n**https.**" + }, + "certificateUrl": { + "type": "string", + "format": "uri", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a\nsecret. For adding a secret to the Key Vault, see [Add a key or secret to the\nkey\nvault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).\nIn this case, your certificate needs to be the Base64 encoding of the following\nJSON Object which is encoded in UTF-8: <br><br> {<br>\n\"data\":\"<Base64-encoded-certificate>\",<br> \"dataType\":\"pfx\",<br>\n\"password\":\"<pfx-file-password>\"<br>} <br> To install certificates on a virtual\nmachine it is recommended to use the [Azure Key Vault virtual machine extension\nfor\nLinux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux)\nor the [Azure Key Vault virtual machine extension for\nWindows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows)." + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Specifies Windows operating system settings on the virtual machine.", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual\nmachine. When this property is not specified in the request body, it is set to\ntrue by default. This will ensure that VM Agent is installed on the VM so that\nextensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine.\nDefault value is true. For virtual machine scale sets, this property can be\nupdated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".\nPossible values can be\n[TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id)\nvalue from time zones returned by\n[TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "description": "Specifies additional base-64 encoded XML formatted information that can be\nincluded in the Unattend.xml file, which is used by Windows Setup.", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "x-ms-identifiers": [] + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "[Preview Feature] Specifies settings related to VM Guest Patching on Windows." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows\nPowerShell." + }, + "enableVMAgentPlatformUpdates": { + "type": "boolean", + "description": "Indicates whether VMAgent Platform Updates is enabled for the Windows virtual\nmachine. Default value is false." + } + } + }, + "WindowsPatchAssessmentMode": { + "type": "string", + "description": "Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.", + "enum": [ + "ImageDefault", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsPatchAssessmentMode", + "modelAsString": true, + "values": [ + { + "name": "ImageDefault", + "value": "ImageDefault", + "description": "You control the timing of patch assessments on a virtual machine." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The platform will trigger periodic patch assessments. The property provisionVMAgent must be true." + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformRebootSetting": { + "type": "string", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation operations.", + "enum": [ + "Unknown", + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "modelAsString": true, + "values": [ + { + "name": "Unknown", + "value": "Unknown", + "description": "Unknown Reboot setting" + }, + { + "name": "IfRequired", + "value": "IfRequired", + "description": "IfRequired Reboot setting" + }, + { + "name": "Never", + "value": "Never", + "description": "Never Reboot setting" + }, + { + "name": "Always", + "value": "Always", + "description": "Always Reboot setting" + } + ] + } + }, + "WindowsVMGuestPatchAutomaticByPlatformSettings": { + "type": "object", + "description": "Specifies additional settings to be applied when patch mode AutomaticByPlatform\nis selected in Windows patch settings.", + "properties": { + "rebootSetting": { + "$ref": "#/definitions/WindowsVMGuestPatchAutomaticByPlatformRebootSetting", + "description": "Specifies the reboot setting for all AutomaticByPlatform patch installation\noperations." + }, + "bypassPlatformSafetyChecksOnUserSchedule": { + "type": "boolean", + "description": "Enables customer to schedule patching without accidental upgrades" + } + } + }, + "WindowsVMGuestPatchMode": { + "type": "string", + "description": "Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual\nmachines associated to virtual machine scale set with OrchestrationMode as\nFlexible.", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "WindowsVMGuestPatchMode", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "You control the application of patches to a virtual machine.\nYou do this by applying patches manually inside the VM. In this mode,\nautomatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates\nmust be false" + }, + { + "name": "AutomaticByOS", + "value": "AutomaticByOS", + "description": "The virtual machine will automatically be updated by the OS.\nThe property WindowsConfiguration.enableAutomaticUpdates must be true." + }, + { + "name": "AutomaticByPlatform", + "value": "AutomaticByPlatform", + "description": "The virtual machine will automatically updated by the platform. The properties\nprovisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json new file mode 100644 index 000000000000..a76ad9c827a9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json @@ -0,0 +1,1174 @@ +{ + "title": "Fleets_CreateOrUpdate", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myvaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": {} + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 10, + "minCapacity": 20, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 10, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 0, + "minCapacity": 0, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Https", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json new file mode 100644 index 000000000000..e94c80506873 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -0,0 +1,300 @@ +{ + "title": "Fleets_CreateOrUpdate_MinimumSet", + "operationId": "Fleets_CreateOrUpdate", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "resource": { + "properties": { + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "adminPassword": "TestPassword$0", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + } + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus", + "Retry-After": 30 + }, + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 2, + "minCapacity": 1, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_D2s_v3" + }, + { + "name": "Standard_D4s_v3" + }, + { + "name": "Standard_E2s_v3" + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "storageProfile": { + "imageReference": { + "publisher": "canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts-gen2", + "version": "latest" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + } + }, + "osProfile": { + "computerNamePrefix": "prefix", + "adminUsername": "azureuser", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "primary": true, + "enableAcceleratedNetworking": false, + "ipConfigurations": [ + { + "name": "vmNameTest", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true + } + } + ], + "networkApiVersion": "2022-07-01" + } + }, + "computeApiVersion": "2023-09-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "tags": { + "key": "fleets-test" + }, + "location": "eastus2euap", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json new file mode 100644 index 000000000000..18f72eff408a --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Fleets_Delete", + "operationId": "Fleets_Delete", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json new file mode 100644 index 000000000000..5d9c7b54d0a9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Get.json @@ -0,0 +1,405 @@ +{ + "title": "Fleets_Get", + "operationId": "Fleets_Get", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json new file mode 100644 index 000000000000..3a834d56d590 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListByResourceGroup.json @@ -0,0 +1,409 @@ +{ + "title": "Fleets_ListByResourceGroup", + "operationId": "Fleets_ListByResourceGroup", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json new file mode 100644 index 000000000000..e93f74bee6b9 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListBySubscription.json @@ -0,0 +1,408 @@ +{ + "title": "Fleets_ListBySubscription", + "operationId": "Fleets_ListBySubscription", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Creating", + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "exactVersion": "zjbntmiskjexlr", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "type": "cmeam", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "provisioningState": "Succeeded", + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "mubredelfbshboaxrsxiajihahaa", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "type": "UserAssigned", + "userAssignedIdentities": { + "key9851": { + "principalId": "6d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "clientId": "7d508e5b-374b-4382-9a1c-01fb8b6cb37c" + } + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + }, + "tags": { + "key3518": "luvrnuvsgdpbuofdskkcoqhfh" + }, + "location": "westus", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json new file mode 100644 index 000000000000..96c7add60f74 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_ListVirtualMachineScaleSets.json @@ -0,0 +1,40 @@ +{ + "title": "Fleets_ListVirtualMachineScaleSets", + "operationId": "Fleets_ListVirtualMachineScaleSets", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "name": "myFleet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myVmss", + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/myFleet/virtualMachineScaleSets/myVmss", + "type": "Microsoft.AzureFleet/fleets/virtualMachineScaleSets", + "operationStatus": "Creating", + "error": { + "details": [ + { + "code": "gzhtOverconstrainedAllocationRequestyosk", + "target": "qfthabhrmndhfizfnrwpgxvnokpy", + "message": "Allocation Failed" + } + ], + "innererror": { + "exceptionType": "sfaomfpoaptnbxchrfskm", + "errorDetail": "ihjwbwykq" + }, + "code": "OverconstrainedAllocationRequest", + "target": "nhaj", + "message": "Allocation Failed" + } + } + ] + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json new file mode 100644 index 000000000000..73a8f4820114 --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json @@ -0,0 +1,767 @@ +{ + "title": "Fleets_Update", + "operationId": "Fleets_Update", + "parameters": { + "api-version": "2024-11-01", + "subscriptionId": "1DC2F28C-A625-4B0E-9748-9885A3C9E9EB", + "resourceGroupName": "rgazurefleet", + "fleetName": "testFleet", + "properties": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "adminPassword": "adfbrdxpv", + "customData": "xjjib", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon", + "content": "bubmqbxjkj" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": {}, + "protectedSettings": {}, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + } + } + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "configurationReference": "ulztmiavpojpbpbddgnuuiimxcpau", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + } + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + } + }, + "plan": { + "name": "jwgrcrnrtfoxn", + "publisher": "iozjbiqqckqm", + "product": "cgopbyvdyqikahwyxfpzwaqk", + "promotionCode": "naglezezplcaruqogtxnuizslqnnbr", + "version": "wa" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "spotPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "maxPricePerVM": 0.00865, + "evictionPolicy": "Delete", + "allocationStrategy": "PriceCapacityOptimized", + "maintain": true + }, + "regularPriorityProfile": { + "capacity": 20, + "minCapacity": 10, + "allocationStrategy": "LowestPrice" + }, + "vmSizesProfile": [ + { + "name": "Standard_d1_v2", + "rank": 19225 + } + ], + "computeProfile": { + "baseVirtualMachineProfile": { + "osProfile": { + "computerNamePrefix": "o", + "adminUsername": "nrgzqciiaaxjrqldbmjbqkyhntp", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "timeZone": "hlyjiqcfksgrpjrct", + "additionalUnattendContent": [ + { + "passName": "OobeSystem", + "componentName": "Microsoft-Windows-Shell-Setup", + "settingName": "AutoLogon" + } + ], + "patchSettings": { + "patchMode": "Manual", + "enableHotpatching": true, + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "winRM": { + "listeners": [ + { + "protocol": "Http", + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName" + } + ] + }, + "enableVMAgentPlatformUpdates": true + }, + "linuxConfiguration": { + "disablePasswordAuthentication": true, + "ssh": { + "publicKeys": [ + { + "path": "kmqz", + "keyData": "kivgsubusvpprwqaqpjcmhsv" + } + ] + }, + "provisionVMAgent": true, + "patchSettings": { + "patchMode": "ImageDefault", + "assessmentMode": "ImageDefault", + "automaticByPlatformSettings": { + "rebootSetting": "Unknown", + "bypassPlatformSafetyChecksOnUserSchedule": true + } + }, + "enableVMAgentPlatformUpdates": true + }, + "secrets": [ + { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "vaultCertificates": [ + { + "certificateUrl": "https://myVaultName.vault.azure.net/secrets/myCertName", + "certificateStore": "nlxrwavpzhueffxsshlun" + } + ] + } + ], + "allowExtensionOperations": true, + "requireGuestProvisionSignal": true + }, + "storageProfile": { + "imageReference": { + "publisher": "mqxgwbiyjzmxavhbkd", + "offer": "isxgumkarlkomp", + "sku": "eojmppqcrnpmxirtp", + "version": "wvpcqefgtmqdgltiuz", + "sharedGalleryImageId": "kmkgihoxwlawuuhcinfirktdwkmx", + "communityGalleryImageId": "vlqe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/{versionName}", + "exactVersion": "zjbntmiskjexlr" + }, + "osDisk": { + "name": "wfttw", + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "diskSizeGB": 14, + "osType": "Windows", + "image": { + "uri": "https://myStorageAccountName.blob.core.windows.net/myContainerName/myVhdName.vhd" + }, + "vhdContainers": [ + "tkzcwddtinkfpnfklatw" + ], + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "deleteOption": "Delete" + }, + "dataDisks": [ + { + "name": "eogiykmdmeikswxmigjws", + "lun": 14, + "caching": "None", + "writeAcceleratorEnabled": true, + "createOption": "FromImage", + "diskSizeGB": 6, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + }, + "securityProfile": { + "securityEncryptionType": "VMGuestStateOnly", + "diskEncryptionSet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}" + } + } + }, + "diskIOPSReadWrite": 27, + "diskMBpsReadWrite": 2, + "deleteOption": "Delete" + } + ], + "diskControllerType": "uzb" + }, + "networkProfile": { + "healthProbe": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}" + }, + "networkInterfaceConfigurations": [ + { + "name": "i", + "properties": { + "primary": true, + "enableAcceleratedNetworking": true, + "disableTcpStateTracking": true, + "enableFpga": true, + "networkSecurityGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}" + }, + "dnsSettings": { + "dnsServers": [ + "nxmmfolhclsesu" + ] + }, + "ipConfigurations": [ + { + "name": "oezqhkidfhyywlfzwuotilrpbqnjg", + "properties": { + "subnet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}" + }, + "primary": true, + "publicIPAddressConfiguration": { + "name": "fvpqf", + "properties": { + "idleTimeoutInMinutes": 9, + "dnsSettings": { + "domainNameLabel": "ukrddzvmorpmfsczjwtbvp", + "domainNameLabelScope": "TenantReuse" + }, + "ipTags": [ + { + "ipTagType": "sddgsoemnzgqizale", + "tag": "wufmhrjsakbiaetyara" + } + ], + "publicIPPrefix": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName}" + }, + "publicIPAddressVersion": "IPv4", + "deleteOption": "Delete" + }, + "sku": { + "name": "Basic", + "tier": "Regional" + } + }, + "privateIPAddressVersion": "IPv4", + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "applicationSecurityGroups": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}" + } + ], + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatPools/{inboundNatPoolName}" + } + ] + } + } + ], + "enableIPForwarding": true, + "deleteOption": "Delete", + "auxiliaryMode": "None", + "auxiliarySku": "None" + } + } + ], + "networkApiVersion": "2020-11-01" + }, + "securityProfile": { + "uefiSettings": { + "secureBootEnabled": true, + "vTpmEnabled": true + }, + "encryptionAtHost": true, + "securityType": "TrustedLaunch", + "encryptionIdentity": { + "userAssignedIdentityResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{userAssignedIdentityName}" + }, + "proxyAgentSettings": { + "enabled": true, + "mode": "Audit", + "keyIncarnationId": 20 + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://myStorageAccountName.blob.core.windows.net" + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "bndxuxx", + "properties": { + "forceUpdateTag": "yhgxw", + "publisher": "kpxtirxjfprhs", + "type": "pgjilctjjwaa", + "typeHandlerVersion": "zevivcoilxmbwlrihhhibq", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "provisionAfterExtensions": [ + "nftzosroolbcwmpupujzqwqe" + ], + "suppressFailures": true, + "protectedSettingsFromKeyVault": { + "secretUrl": "https://myVaultName.vault.azure.net/secrets/secret/mySecretName", + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + } + }, + "settings": {}, + "provisioningState": "Succeeded" + }, + "type": "cmeam", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{extensionName}" + } + ], + "extensionsTimeBudget": "mbhjahtdygwgyszdwjtvlvtgchdwil" + }, + "licenseType": "v", + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "notBeforeTimeout": "iljppmmw", + "enable": true + }, + "osImageNotificationProfile": { + "notBeforeTimeout": "olbpadmevekyczfokodtfprxti", + "enable": true + } + }, + "userData": "s", + "capacityReservation": { + "capacityReservationGroup": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}" + } + }, + "applicationProfile": { + "galleryApplications": [ + { + "tags": "eyrqjbib", + "order": 5, + "packageReferenceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{applicationName}/versions/{versionName}", + "treatFailureAsDeploymentFailure": true, + "enableAutomaticUpgrade": true + } + ] + }, + "hardwareProfile": { + "vmSizeProperties": { + "vCPUsAvailable": 16, + "vCPUsPerCore": 23 + } + }, + "serviceArtifactReference": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactsName}/vmArtifactsProfiles/{vmArtifactsProfileName}" + }, + "securityPostureReference": { + "id": "/CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest", + "excludeExtensions": [ + "{securityPostureVMExtensionName}" + ], + "isOverridable": true + }, + "timeCreated": "2024-04-29T21:51:44.043Z" + }, + "computeApiVersion": "2023-07-01", + "platformFaultDomainCount": 1 + }, + "provisioningState": "Creating", + "timeCreated": "2024-07-10T00:16:34.8590555+00:00", + "uniqueId": "a2f7fabd-bbc2-4a20-afe1-49fdb3885a28" + }, + "zones": [ + "zone1", + "zone2" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": {}, + "principalId": "4d508e5b-374b-4382-9a1c-01fb8b6cb37c", + "tenantId": "5d508e5b-374b-4382-9a1c-01fb8b6cb37c" + }, + "tags": {}, + "location": "westus", + "plan": { + "name": "uapfngmdekvpgjhomthtpxjfdmmll", + "publisher": "aqhles", + "product": "bfzbkdnbexmedxdc", + "promotionCode": "gspehogwfjxirz", + "version": "yza" + }, + "id": "/subscriptions/7B0CD4DB-3381-4013-9B31-FB6E6FD0FF1C/resourceGroups/rgazurefleet/providers/Microsoft.AzureFleet/fleets/testFleet", + "name": "testFleet", + "type": "Microsoft.AzureFleet/fleets", + "systemData": { + "createdBy": "rowegentrpoajsv", + "createdByType": "User", + "createdAt": "2024-04-29T21:51:44.043Z", + "lastModifiedBy": "edwuayhhaoepxzisfaqjhmrxjq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-29T21:51:44.043Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus", + "Retry-After": 30 + } + } + } +} diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json new file mode 100644 index 000000000000..8acf291032fe --- /dev/null +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Operations_List.json @@ -0,0 +1,71 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-11-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/read", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Get Azure Fleet", + "description": "Get properties of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/write", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Create or Update Azure Fleet", + "description": "Creates a new Azure Fleet resource or updates an existing one" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/fleets/delete", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Fleets", + "operation": "Delete Virtual Machine and Virtual Machine scale sets in a Azure Fleet resource", + "description": "Deletes all compute resources of Azure Fleet resource" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/register/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Register subscription for Microsoft.AzureFleet", + "description": "Registers Subscription with Microsoft.AzureFleet resource provider" + } + }, + { + "origin": "user,system", + "name": "Microsoft.AzureFleet/unregister/action", + "isDataAction": false, + "display": { + "provider": "Microsoft Azure Fleet", + "resource": "Subscription", + "operation": "Unregister Subscription for Microsoft.AzureFleet", + "description": "Unregisters Subscription with Microsoft.AzureFleet resource provider" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/azurefleet/resource-manager/readme.az.md b/specification/azurefleet/resource-manager/readme.az.md index 0e615e46472b..8b9544c437ef 100644 --- a/specification/azurefleet/resource-manager/readme.az.md +++ b/specification/azurefleet/resource-manager/readme.az.md @@ -15,8 +15,6 @@ python-sdk-output-folder: "$(az-output-folder)/azext_computefleet/vendored_sdks/ # refer to the faq.md for more details ``` - - This is for command modules that already in azure cli main repo. ``` yaml $(az) && $(target-mode) == 'core' az: diff --git a/specification/azurefleet/resource-manager/readme.cli.md b/specification/azurefleet/resource-manager/readme.cli.md index c6cf6ad37ea4..7d1cfb151245 100644 --- a/specification/azurefleet/resource-manager/readme.cli.md +++ b/specification/azurefleet/resource-manager/readme.cli.md @@ -1 +1,11 @@ -## CLI Common Settings for all the command line tools \ No newline at end of file +## CLI Common Settings for all the command line tools + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + cli-name: computefleet + package-name: azure-mgmt-computefleet + namespace: azure.mgmt.computefleet + +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.go.md b/specification/azurefleet/resource-manager/readme.go.md index 309eb944f416..6f1409cb3b18 100644 --- a/specification/azurefleet/resource-manager/readme.go.md +++ b/specification/azurefleet/resource-manager/readme.go.md @@ -8,4 +8,4 @@ license-header: MICROSOFT_MIT_NO_VERSION module-name: sdk/resourcemanager/computefleet/armcomputefleet module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -``` +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.java.md b/specification/azurefleet/resource-manager/readme.java.md new file mode 100644 index 000000000000..6e605c3e6742 --- /dev/null +++ b/specification/azurefleet/resource-manager/readme.java.md @@ -0,0 +1,13 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.azurefleet +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/armcomputefleet +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/readme.md b/specification/azurefleet/resource-manager/readme.md index d6726ce99f11..660c328dcf26 100644 --- a/specification/azurefleet/resource-manager/readme.md +++ b/specification/azurefleet/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the computefleet. ```yaml openapi-type: arm -tag: package-preview-2024-05 +tag: package-2024-11-01 suppressions: - code: PatchBodyParametersSchema from: azurefleet.json @@ -44,8 +44,9 @@ suppressions: from: azurefleet.json where: - $.definitions.VirtualMachineScaleSetDataDisk.properties.diskIOPSReadWrite + - $.definitions.AdditionalCapabilities.properties.ultraSSDEnabled reason: Property "diskIOPSReadWrite" does not follow Camel Case and can't be changed as it is being - defined previously in Microsoft.Compute like this. + defined previously in Microsoft.Compute like this. ultraSSDEnabled - SSD doesn't follow camel case. ``` ### Tag: package-preview-2023-11 @@ -66,6 +67,15 @@ input-file: - Microsoft.AzureFleet/preview/2024-05-01-preview/azurefleet.json ``` +### Tag: package-2024-11-01 + +These settings apply only when `--tag=package-2024-11-01` is specified on the command line. + +```yaml $(tag) == 'package-2024-11-01' +input-file: + - Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json +``` + --- # Code Generation @@ -106,3 +116,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) diff --git a/specification/azurefleet/resource-manager/readme.python.md b/specification/azurefleet/resource-manager/readme.python.md index 6f2a97db3a13..38e083bbc4fa 100644 --- a/specification/azurefleet/resource-manager/readme.python.md +++ b/specification/azurefleet/resource-manager/readme.python.md @@ -15,4 +15,4 @@ clear-output-folder: true ``` yaml $(python) no-namespace-folders: true output-folder: $(python-sdks-folder)/computefleet/azure-mgmt-computefleet/azure/mgmt/computefleet -``` +``` \ No newline at end of file diff --git a/specification/azurefleet/resource-manager/sdk-suppressions.yaml b/specification/azurefleet/resource-manager/sdk-suppressions.yaml index 20c674093519..fe3e9fb6ccb1 100644 --- a/specification/azurefleet/resource-manager/sdk-suppressions.yaml +++ b/specification/azurefleet/resource-manager/sdk-suppressions.yaml @@ -3,7 +3,53 @@ suppressions: - package: azure-mgmt-computefleet breaking-changes: - The 'NetworkApiVersion' enum had its value 'ENUM_2020_11_01' deleted or renamed in the current version + - Deleted or renamed enum value `DiskControllerTypes.N_V_ME` + - Deleted or renamed enum value `NetworkApiVersion.ENUM_2020_11_01` + - Deleted or renamed enum value `SecurityEncryptionTypes.DISK_WITH_V_M_GUEST_STATE` + - Deleted or renamed enum value `SecurityEncryptionTypes.NON_PERSISTED_T_P_M` + - Deleted or renamed enum value `SecurityEncryptionTypes.V_M_GUEST_STATE_ONLY` + - Deleted or renamed enum value `SecurityTypes.CONFIDENTIAL_V_M` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_V2_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.PREMIUM_Z_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_S_S_D_L_R_S` + - Deleted or renamed enum value `StorageAccountTypes.STANDARD_S_S_D_Z_R_S` + - Deleted or renamed enum value `StorageAccountTypes.ULTRA_S_S_D_L_R_S` + - Deleted or renamed enum value `WindowsVMGuestPatchMode.AUTOMATIC_BY_O_S` + - Deleted or renamed method `LinuxConfiguration.enable_v_m_agent_platform_updates` + - Deleted or renamed method `LinuxConfiguration.provision_v_m_agent` + - Deleted or renamed method `SpotPriorityProfile.max_price_per_v_m` + - Deleted or renamed method `VMSizeProperties.v_c_p_us_available` + - Deleted or renamed method `VMSizeProperties.v_c_p_us_per_core` + - Deleted or renamed method `VirtualMachineScaleSetDataDisk.disk_i_o_p_s_read_write` + - Deleted or renamed method `VirtualMachineScaleSetDataDisk.disk_size_g_b` + - Deleted or renamed method `VirtualMachineScaleSetIPConfigurationProperties.private_i_p_address_version` + - Deleted or renamed method `VirtualMachineScaleSetIPConfigurationProperties.public_i_p_address_configuration` + - Deleted or renamed method `VirtualMachineScaleSetNetworkConfigurationProperties.enable_i_p_forwarding` + - Deleted or renamed method `VirtualMachineScaleSetOSDisk.disk_size_g_b` + - Deleted or renamed method `VirtualMachineScaleSetPublicIPAddressConfigurationProperties.public_i_p_address_version` + - Deleted or renamed method `VirtualMachineScaleSetPublicIPAddressConfigurationProperties.public_i_p_prefix` + - Deleted or renamed method `WindowsConfiguration.enable_v_m_agent_platform_updates` + - Deleted or renamed method `WindowsConfiguration.provision_v_m_agent` + - Deleted or renamed method `WindowsConfiguration.win_r_m` + - Model `LinuxConfiguration` deleted or renamed its instance variable `enable_v_m_agent_platform_updates` + - Model `LinuxConfiguration` deleted or renamed its instance variable `provision_v_m_agent` + - Model `SpotPriorityProfile` deleted or renamed its instance variable `max_price_per_v_m` + - Model `VMSizeProperties` deleted or renamed its instance variable `v_c_p_us_available` + - Model `VMSizeProperties` deleted or renamed its instance variable `v_c_p_us_per_core` + - Model `VirtualMachineScaleSetDataDisk` deleted or renamed its instance variable `disk_i_o_p_s_read_write` + - Model `VirtualMachineScaleSetDataDisk` deleted or renamed its instance variable `disk_size_g_b` + - Model `VirtualMachineScaleSetIPConfigurationProperties` deleted or renamed its instance variable `private_i_p_address_version` + - Model `VirtualMachineScaleSetIPConfigurationProperties` deleted or renamed its instance variable `public_i_p_address_configuration` + - Model `VirtualMachineScaleSetNetworkConfigurationProperties` deleted or renamed its instance variable `enable_i_p_forwarding` + - Model `VirtualMachineScaleSetOSDisk` deleted or renamed its instance variable `disk_size_g_b` + - Model `VirtualMachineScaleSetPublicIPAddressConfigurationProperties` deleted or renamed its instance variable `public_i_p_address_version` + - Model `VirtualMachineScaleSetPublicIPAddressConfigurationProperties` deleted or renamed its instance variable `public_i_p_prefix` + - Model `WindowsConfiguration` deleted or renamed its instance variable `enable_v_m_agent_platform_updates` + - Model `WindowsConfiguration` deleted or renamed its instance variable `provision_v_m_agent` + - Model `WindowsConfiguration` deleted or renamed its instance variable `win_r_m` azure-sdk-for-go: - package: 'sdk/resourcemanager/computefleet/armcomputefleet' breaking-changes: - - "`NetworkAPIVersion20201101` from enum `NetworkAPIVersion` has been removed" \ No newline at end of file + - "`NetworkAPIVersion20201101` from enum `NetworkAPIVersion` has been removed" From 4995036206058b8a75070667995b8feb038549be Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Fri, 4 Oct 2024 16:23:46 -0700 Subject: [PATCH 046/101] Added: Note that sunrise and sunset times not returned when solar day is observed in the requested region (#30860) * Added: Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. * Added TypeSpecRequirement suppression for timezone v1. --- .../maps/data-plane/Timezone/preview/1.0/timezone.json | 6 +++--- specification/maps/suppressions.yaml | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json index a7d0d38b186d..642e4d7264ee 100644 --- a/specification/maps/data-plane/Timezone/preview/1.0/timezone.json +++ b/specification/maps/data-plane/Timezone/preview/1.0/timezone.json @@ -189,7 +189,7 @@ "/timezone/byCoordinates/{format}": { "get": { "summary": "Use to get the current, historical, and future time zone information for the specified latitude-longitude pair.", - "description": "\n\nThe `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.", + "description": "\n\nThe `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location, with the exception of regions that observe solar days.", "operationId": "Timezone_GetTimezoneByCoordinates", "x-ms-examples": { "Successfully retrieve timezone by coordinates": { @@ -670,13 +670,13 @@ "readOnly": true }, "Sunrise": { - "description": "Sunrise at the given time zone as shown in the `Tag` property. The sunrise is described in the ISO8601 format. (Only be populated if the call is byCoordinates)", + "description": "Sunrise at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunrise is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region.", "type": "string", "format": "date-time", "readOnly": true }, "Sunset": { - "description": "Sunset at the given time zone as shown in the `Tag` property. The sunset is described in the ISO8601 format.(Only be populated if the call is byCoordinates)", + "description": "Sunset at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunset is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region.", "type": "string", "format": "date-time", "readOnly": true diff --git a/specification/maps/suppressions.yaml b/specification/maps/suppressions.yaml index 499e360ba175..cdffaf7392fd 100644 --- a/specification/maps/suppressions.yaml +++ b/specification/maps/suppressions.yaml @@ -1,3 +1,6 @@ - tool: TypeSpecRequirement path: ./data-plane/Route/preview/1.0/route.json reason: Brownfield service not ready to migrate +- tool: TypeSpecRequirement + path: ./data-plane/Timezone/preview/1.0/timezone.json + reason: Brownfield service not ready to migrate From 655f4c80528b2aa2d5e52767e9a1bf7dd2a0655a Mon Sep 17 00:00:00 2001 From: Drishti Peshwani <148189108+drishtipeshwani09@users.noreply.github.com> Date: Mon, 7 Oct 2024 09:26:53 +0530 Subject: [PATCH 047/101] Updated the default tag in readme.md (#30854) --- specification/containerinstance/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index e875793a7d4f..4021d6ca8017 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-preview-2024-10 +tag: package-preview-2024-05 ``` ### Tag: package-preview-2024-10 From 6fbbe1db056a37600cc4d60007a76113a1ad0074 Mon Sep 17 00:00:00 2001 From: bamus1166 <137086041+bamus1166@users.noreply.github.com> Date: Mon, 7 Oct 2024 12:45:11 +0300 Subject: [PATCH 048/101] Updated pricing extensions documentation (#30815) * Updated pricing extensions documentation * ... * ..... * Fixed comment * ran prettier --- .../Microsoft.Security/stable/2023-01-01/pricings.json | 2 +- .../Microsoft.Security/stable/2024-01-01/pricings.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json b/specification/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json index fe87c50246d4..360ebcab8d44 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2023-01-01/pricings.json @@ -271,7 +271,7 @@ "properties": { "name": { "type": "string", - "description": "The extension name. Supported values are: <br><br>**AgentlessDiscoveryForKubernetes** - API-based discovery of information about Kubernetes cluster architecture, workload objects, and setup. Required for Kubernetes inventory, identity and network exposure detection, attack path analysis and risk hunting as part of the cloud security explorer.\r\nAvailable for CloudPosture plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month.\r\nAvailable for StorageAccounts plan.<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events.\r\nAvailable for StorageAccounts and CloudPosture plans.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images stored in your container registries.\r\nAvailable for CloudPosture and Containers plans." + "description": "The extension name. Supported values are: <br><br>**AgentlessDiscoveryForKubernetes** - Provides zero footprint, API-based discovery of Kubernetes clusters, their configurations and deployments. The collected data is used to create a contextualized security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize risks and threats to Kubernetes environments and workloads.<br>Available for CloudPosture plan and Containers plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plans).<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture plan.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images stored in your container registries.<br>Available for CloudPosture plan and Containers plan.<br><br>**MdeDesignatedSubscription** - Direct onboarding is a seamless integration between Defender for Endpoint and Defender for Cloud that doesn’t require extra software deployment on your servers. The onboarded resources will be presented under a designated Azure Subscription you configure<br>Available for VirtualMachines plan (P1 and P2 sub plans).<br><br>**AgentlessVmScanning** - Scans your machines for installed software, vulnerabilities, malware and secret scanning without relying on agents or impacting machine performance. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.<br>Available for CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers plan.<br><br>**EntraPermissionsManagement** - Permissions Management provides Cloud Infrastructure Entitlement Management (CIEM) capabilities that helps organizations to manage and control user access and entitlements in their cloud infrastructure - important attack vector for cloud environments.<br>Permissions Management analyzes all permissions and active usage, and suggests recommendations to reduce permissions to enforce the principle of least privilege. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.<br>Available for CloudPosture plan. <br><br>**FileIntegrityMonitoring** - File integrity monitoring (FIM), examines operating system files.<br>Windows registries, Linux system files, in real time, for changes that might indicate an attack.<br>Available for VirtualMachines plan (P2 sub plan). <br><br>**ContainerSensor** - The sensor is based on IG and provides a rich threat detection suite for Kubernetes clusters, nodes, and workloads, powered by Microsoft leading threat intelligence, provides mapping to MITRE ATT&CK framework.<br>Available for Containers plan. <br><br>**AIPromptEvidence** - Exposes the prompts passed between the user and the AI model as alert evidence. This helps classify and triage the alerts with relevant user context. The prompt snippets will include only segments of the user prompt or model response that were deemed suspicious and relevant for security classifications. The prompt evidence will be available through Defender portal as part of each alert.<br>Available for AI plan. <br><br>" }, "isEnabled": { "type": "string", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json index a21cc97ab7be..3b9328ffbd2d 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2024-01-01/pricings.json @@ -411,7 +411,7 @@ "properties": { "name": { "type": "string", - "description": "The extension name. Supported values are: <br><br>**AgentlessDiscoveryForKubernetes** - API-based discovery of information about Kubernetes cluster architecture, workload objects, and setup. Required for Kubernetes inventory, identity and network exposure detection, attack path analysis and risk hunting as part of the cloud security explorer.\r\nAvailable for CloudPosture plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month.\r\nAvailable for StorageAccounts plan.<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events.\r\nAvailable for StorageAccounts and CloudPosture plans.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images stored in your container registries.\r\nAvailable for CloudPosture and Containers plans." + "description": "The extension name. Supported values are: <br><br>**AgentlessDiscoveryForKubernetes** - Provides zero footprint, API-based discovery of Kubernetes clusters, their configurations and deployments. The collected data is used to create a contextualized security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize risks and threats to Kubernetes environments and workloads.<br>Available for CloudPosture plan and Containers plan.<br><br>**OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plans).<br><br>**SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events.<br>Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture plan.<br><br>**ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images stored in your container registries.<br>Available for CloudPosture plan and Containers plan.<br><br>**MdeDesignatedSubscription** - Direct onboarding is a seamless integration between Defender for Endpoint and Defender for Cloud that doesn’t require extra software deployment on your servers. The onboarded resources will be presented under a designated Azure Subscription you configure<br>Available for VirtualMachines plan (P1 and P2 sub plans).<br><br>**AgentlessVmScanning** - Scans your machines for installed software, vulnerabilities, malware and secret scanning without relying on agents or impacting machine performance. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.<br>Available for CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers plan.<br><br>**EntraPermissionsManagement** - Permissions Management provides Cloud Infrastructure Entitlement Management (CIEM) capabilities that helps organizations to manage and control user access and entitlements in their cloud infrastructure - important attack vector for cloud environments.<br>Permissions Management analyzes all permissions and active usage, and suggests recommendations to reduce permissions to enforce the principle of least privilege. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.<br>Available for CloudPosture plan. <br><br>**FileIntegrityMonitoring** - File integrity monitoring (FIM), examines operating system files.<br>Windows registries, Linux system files, in real time, for changes that might indicate an attack.<br>Available for VirtualMachines plan (P2 sub plan). <br><br>**ContainerSensor** - The sensor is based on IG and provides a rich threat detection suite for Kubernetes clusters, nodes, and workloads, powered by Microsoft leading threat intelligence, provides mapping to MITRE ATT&CK framework.<br>Available for Containers plan. <br><br>**AIPromptEvidence** - Exposes the prompts passed between the user and the AI model as alert evidence. This helps classify and triage the alerts with relevant user context. The prompt snippets will include only segments of the user prompt or model response that were deemed suspicious and relevant for security classifications. The prompt evidence will be available through Defender portal as part of each alert.<br>Available for AI plan. <br><br>" }, "isEnabled": { "type": "string", From f10366bad0ccb3c08814a1c7a1db79b7dc2f0089 Mon Sep 17 00:00:00 2001 From: Nick Depinet <depinetnick@gmail.com> Date: Mon, 7 Oct 2024 10:22:50 -0700 Subject: [PATCH 049/101] [devcenter] - Microsoft.DevCenter 2024-10-01-preview (#30751) * Copy files from preview/2024-08-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Added tag for 2024-10-01-preview in readme file * fix readme.md from api-version create script * add changes for 10-01-preview api version * fix spelling, remove unused examples * fix example * suppress additionalproperties error on pre-existing model * fix suppresion * remove unneeded suppression, fix incorrect example --------- Co-authored-by: Nick Depinet <ndepinet@microsoft.com> --- .../2024-10-01-preview/commonDefinitions.json | 170 + .../preview/2024-10-01-preview/devcenter.json | 8660 +++++++++++++++++ .../examples/AttachedNetworks_Create.json | 54 + .../examples/AttachedNetworks_Delete.json | 18 + .../AttachedNetworks_GetByDevCenter.json | 32 + .../AttachedNetworks_GetByProject.json | 32 + .../AttachedNetworks_ListByDevCenter.json | 54 + .../AttachedNetworks_ListByProject.json | 54 + .../examples/Catalogs_Connect.json | 17 + .../examples/Catalogs_CreateAdo.json | 92 + .../examples/Catalogs_CreateGitHub.json | 92 + .../examples/Catalogs_Delete.json | 18 + .../examples/Catalogs_Get.json | 48 + .../Catalogs_GetSyncErrorDetails.json | 36 + .../examples/Catalogs_List.json | 50 + .../examples/Catalogs_Patch.json | 62 + .../examples/Catalogs_Sync.json | 17 + .../examples/CheckNameAvailability.json | 17 + ...opedNameAvailability_DevCenterCatalog.json | 18 + ...ScopedNameAvailability_ProjectCatalog.json | 18 + .../examples/CurationProfiles_Delete.json | 18 + .../examples/CurationProfiles_Get.json | 37 + .../CurationProfiles_ListByDevCenter.json | 40 + .../examples/CurationProfiles_Patch.json | 52 + .../examples/CurationProfiles_Put.json | 75 + .../examples/CustomizationTasks_Get.json | 40 + .../CustomizationTasks_GetErrorDetails.json | 22 + .../CustomizationTasks_ListByCatalog.json | 42 + .../examples/DevBoxDefinitions_Create.json | 75 + .../examples/DevBoxDefinitions_Delete.json | 18 + .../examples/DevBoxDefinitions_Get.json | 37 + .../DevBoxDefinitions_GetByProject.json | 37 + .../DevBoxDefinitions_ListByDevCenter.json | 41 + .../DevBoxDefinitions_ListByProject.json | 41 + .../examples/DevBoxDefinitions_Patch.json | 50 + .../DevCenterEncryptionSets_Create.json | 84 + .../DevCenterEncryptionSets_Delete.json | 18 + .../examples/DevCenterEncryptionSets_Get.json | 41 + .../DevCenterEncryptionSets_List.json | 44 + .../DevCenterEncryptionSets_Patch.json | 52 + .../examples/DevCenters_Create.json | 93 + ...ers_CreateWithDisabledManagedNetworks.json | 100 + .../DevCenters_CreateWithEncryption.json | 124 + .../examples/DevCenters_CreateWithPlanId.json | 75 + ...ers_CreateWithRestrictedResourceUsage.json | 102 + .../DevCenters_CreateWithUserIdentity.json | 97 + .../examples/DevCenters_Delete.json | 17 + .../examples/DevCenters_Get.json | 41 + .../DevCenters_ListByResourceGroup.json | 37 + .../DevCenters_ListBySubscription.json | 36 + .../examples/DevCenters_Patch.json | 45 + .../examples/EnvironmentDefinitions_Get.json | 53 + ...onmentDefinitions_GetByProjectCatalog.json | 53 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../EnvironmentDefinitions_ListByCatalog.json | 56 + ...nmentDefinitions_ListByProjectCatalog.json | 56 + .../examples/EnvironmentTypes_Delete.json | 13 + .../examples/EnvironmentTypes_Get.json | 33 + .../examples/EnvironmentTypes_List.json | 32 + .../examples/EnvironmentTypes_Patch.json | 41 + .../examples/EnvironmentTypes_Put.json | 63 + .../examples/Galleries_Create.json | 54 + .../examples/Galleries_Delete.json | 18 + .../examples/Galleries_Get.json | 30 + .../examples/Galleries_List.json | 50 + .../examples/ImageDefinitions_BuildImage.json | 18 + .../ImageDefinitions_CancelImageBuild.json | 19 + .../ImageDefinitions_GetByProjectCatalog.json | 38 + .../ImageDefinitions_GetImageBuild.json | 34 + ...ImageDefinitions_GetImageBuildDetails.json | 73 + ...ImageDefinitions_ListByProjectCatalog.json | 50 + ...ions_ListImageBuildsByImageDefinition.json | 38 + .../examples/ImageVersions_Get.json | 34 + .../examples/ImageVersions_GetByProject.json | 33 + .../examples/ImageVersions_List.json | 37 + .../examples/ImageVersions_ListByProject.json | 36 + .../examples/Images_Get.json | 44 + .../examples/Images_GetByProject.json | 43 + .../examples/Images_ListByDevCenter.json | 75 + .../examples/Images_ListByGallery.json | 76 + .../examples/Images_ListByProject.json | 105 + .../examples/NetworkConnections_Delete.json | 17 + .../examples/NetworkConnections_Get.json | 35 + .../NetworkConnections_GetHealthDetails.json | 37 + ...etworkConnections_ListByResourceGroup.json | 37 + ...NetworkConnections_ListBySubscription.json | 36 + .../NetworkConnections_ListHealthDetails.json | 41 + ...tOutboundNetworkDependenciesEndpoints.json | 55 + .../examples/NetworkConnections_Patch.json | 45 + .../examples/NetworkConnections_Put.json | 69 + .../NetworkConnections_RunHealthChecks.json | 16 + .../examples/OperationStatus_Get.json | 42 + .../examples/Operations_Get.json | 21 + .../examples/PlanMembers_Create.json | 69 + .../examples/PlanMembers_Delete.json | 18 + .../examples/PlanMembers_Get.json | 35 + .../examples/PlanMembers_List.json | 38 + .../examples/PlanMembers_Patch.json | 46 + .../examples/Plans_Create.json | 71 + .../examples/Plans_Delete.json | 17 + .../examples/Plans_Get.json | 35 + .../examples/Plans_ListByResourceGroup.json | 38 + .../examples/Plans_ListBySubscription.json | 37 + .../examples/Plans_Patch.json | 49 + .../examples/Pools_Delete.json | 18 + .../examples/Pools_Get.json | 50 + .../examples/Pools_GetUnhealthyStatus.json | 64 + .../examples/Pools_List.json | 53 + .../examples/Pools_Patch.json | 61 + .../examples/Pools_Put.json | 104 + .../examples/Pools_PutWithManagedNetwork.json | 111 + .../Pools_PutWithValueDevBoxDefinition.json | 131 + .../examples/Pools_RunHealthChecks.json | 17 + .../ProjectAllowedEnvironmentTypes_Get.json | 26 + .../ProjectAllowedEnvironmentTypes_List.json | 29 + ...nvironmentDefinitions_GetErrorDetails.json | 22 + .../examples/ProjectCatalogs_Connect.json | 17 + .../examples/ProjectCatalogs_CreateAdo.json | 95 + .../ProjectCatalogs_CreateGitHub.json | 95 + .../examples/ProjectCatalogs_Delete.json | 18 + .../examples/ProjectCatalogs_Get.json | 50 + .../ProjectCatalogs_GetSyncErrorDetails.json | 36 + .../examples/ProjectCatalogs_List.json | 50 + .../examples/ProjectCatalogs_Patch.json | 60 + .../examples/ProjectCatalogs_Sync.json | 17 + .../ProjectEnvironmentTypes_Delete.json | 13 + .../examples/ProjectEnvironmentTypes_Get.json | 63 + .../ProjectEnvironmentTypes_List.json | 66 + .../ProjectEnvironmentTypes_Patch.json | 85 + .../examples/ProjectEnvironmentTypes_Put.json | 146 + .../examples/ProjectPolicies_Delete.json | 18 + .../examples/ProjectPolicies_Get.json | 37 + .../ProjectPolicies_ListByDevCenter.json | 40 + .../examples/ProjectPolicies_Patch.json | 52 + .../examples/ProjectPolicies_Put.json | 75 + .../examples/Projects_Delete.json | 17 + .../examples/Projects_Get.json | 41 + .../Projects_GetInheritedSettings.json | 20 + .../Projects_ListByResourceGroup.json | 38 + .../examples/Projects_ListBySubscription.json | 37 + .../examples/Projects_Patch.json | 62 + .../examples/Projects_Put.json | 72 + .../Projects_PutWithMaxDevBoxPerUser.json | 72 + ...dules_CreateDailyShutdownPoolSchedule.json | 67 + .../examples/Schedules_Delete.json | 19 + .../examples/Schedules_Get.json | 35 + .../examples/Schedules_ListByPool.json | 38 + .../examples/Schedules_Patch.json | 46 + .../examples/Skus_ListByProject.json | 32 + .../examples/Skus_ListBySubscription.json | 30 + .../examples/Usages_ListByLocation.json | 34 + .../preview/2024-10-01-preview/vdi.json | 1989 ++++ .../devcenter/resource-manager/readme.md | 17 +- 153 files changed, 17805 insertions(+), 1 deletion(-) create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/commonDefinitions.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithEncryption.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithPlanId.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithRestrictedResourceUsage.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithUserIdentity.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_BuildImage.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_CancelImageBuild.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuild.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByGallery.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_GetHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatus_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Operations_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_GetUnhealthyStatus.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithManagedNetwork.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Connect.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_GetInheritedSettings.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_ListByPool.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Usages_ListByLocation.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/vdi.json diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/commonDefinitions.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/commonDefinitions.json new file mode 100644 index 000000000000..3bb2ac21b14e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/commonDefinitions.json @@ -0,0 +1,170 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "Capability": { + "description": "A name/value pair to describe a capability.", + "type": "object", + "properties": { + "name": { + "description": "Name of the capability.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the capability.", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResourceUpdate": { + "description": "Base tracked resource type for PATCH updates", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags", + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "DevCenterSku": { + "description": "The resource model definition representing SKU for DevCenter resources", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + ], + "properties": { + "resourceType": { + "type": "string", + "description": "The name of the resource type", + "readOnly": true + }, + "locations": { + "description": "SKU supported locations.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Collection of name/value pairs to describe the SKU capabilities.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Capability" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Updating", + "Updated", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Canceled", + "MovingResources", + "TransientFailure", + "RolloutInProgress", + "StorageProvisioningFailed" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'.", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json new file mode 100644 index 000000000000..5ff16adde8cf --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -0,0 +1,8660 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListBySubscription": { + "$ref": "./examples/Plans_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all devcenter plans in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Plans_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/Plans_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter plan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/Plans_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + } + ], + "operationId": "Plans_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/Plans_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter plan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanUpdate" + } + } + ], + "operationId": "Plans_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/Plans_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter plan", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + } + ], + "operationId": "Plans_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/Plans_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members": { + "get": { + "tags": [ + "Plans" + ], + "description": "Lists all of the members assigned to a devcenter plan.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "PlanMembers_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PlanMembersListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_ListByResourceGroup": { + "$ref": "./examples/PlanMembers_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/plans/{planName}/members/{memberName}": { + "get": { + "tags": [ + "Plans" + ], + "description": "Gets a devcenter plan member.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Get": { + "$ref": "./examples/PlanMembers_Get.json" + } + } + }, + "put": { + "tags": [ + "Plans" + ], + "description": "Creates or updates a devcenter plan member resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter plan.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + } + ], + "operationId": "PlanMembers_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Create": { + "$ref": "./examples/PlanMembers_Create.json" + } + } + }, + "patch": { + "tags": [ + "Plans" + ], + "description": "Partially updates a devcenter plan member.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter plan properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PlanMemberUpdate" + } + } + ], + "operationId": "PlanMembers_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Update": { + "$ref": "./examples/PlanMembers_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Plans" + ], + "description": "Deletes a devcenter plan member", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PlanNameParameter" + }, + { + "$ref": "#/parameters/PlanMemberNameParameter" + } + ], + "operationId": "PlanMembers_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Plans_Delete": { + "$ref": "./examples/PlanMembers_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListBySubscription": { + "$ref": "./examples/DevCenters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_ListByResourceGroup": { + "$ref": "./examples/DevCenters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Gets a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Get": { + "$ref": "./examples/DevCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "DevCenters" + ], + "description": "Creates or updates a devcenter resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenter" + } + } + ], + "operationId": "DevCenters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Create": { + "$ref": "./examples/DevCenters_Create.json" + }, + "DevCenters_CreateWithPlanId": { + "$ref": "./examples/DevCenters_CreateWithPlanId.json" + }, + "DevCenters_CreateWithUserIdentity": { + "$ref": "./examples/DevCenters_CreateWithUserIdentity.json" + }, + "DevCenters_CreateWithEncryption": { + "$ref": "./examples/DevCenters_CreateWithEncryption.json" + }, + "DevCenters_CreateWithDisabledManagedNetworks": { + "$ref": "./examples/DevCenters_CreateWithDisabledManagedNetworks.json" + }, + "DevCenters_CreateWithRestrictedResourceUsage": { + "$ref": "./examples/DevCenters_CreateWithRestrictedResourceUsage.json" + } + } + }, + "patch": { + "tags": [ + "DevCenters" + ], + "description": "Partially updates a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterUpdate" + } + } + ], + "operationId": "DevCenters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Update": { + "$ref": "./examples/DevCenters_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DevCenters" + ], + "description": "Deletes a devcenter", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevCenters_Delete": { + "$ref": "./examples/DevCenters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Lists all encryption sets in the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EncryptionSets_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EncryptionSetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_List": { + "$ref": "./examples/DevCenterEncryptionSets_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/encryptionSets/{encryptionSetName}": { + "get": { + "tags": [ + "EncryptionSets" + ], + "description": "Gets a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Get": { + "$ref": "./examples/DevCenterEncryptionSets_Get.json" + } + } + }, + "put": { + "tags": [ + "EncryptionSets" + ], + "description": "Creates or updates a devcenter encryption set resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter encryption set.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + } + ], + "operationId": "EncryptionSets_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Create": { + "$ref": "./examples/DevCenterEncryptionSets_Create.json" + } + } + }, + "patch": { + "tags": [ + "EncryptionSets" + ], + "description": "Partially updates a devcenter encryption set.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter encryption set properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EncryptionSetUpdate" + } + } + ], + "operationId": "EncryptionSets_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Update": { + "$ref": "./examples/DevCenterEncryptionSets_Patch.json" + } + } + }, + "delete": { + "tags": [ + "EncryptionSets" + ], + "description": "Deletes a devcenter encryption set", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevCenterEncryptionSetNameParameter" + } + ], + "operationId": "EncryptionSets_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EncryptionSets_Delete": { + "$ref": "./examples/DevCenterEncryptionSets_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/curationProfiles": { + "get": { + "tags": [ + "Curation Profiles" + ], + "description": "Lists all curation profiles in the dev center", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "CurationProfiles_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CurationProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CurationProfiles_ListByDevCenter": { + "$ref": "./examples/CurationProfiles_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/curationProfiles/{curationProfileName}": { + "get": { + "tags": [ + "Curation Profiles" + ], + "description": "Gets a specific curation profile.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CurationProfileNameParameter" + } + ], + "operationId": "CurationProfiles_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CurationProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CurationProfiles_Get": { + "$ref": "./examples/CurationProfiles_Get.json" + } + } + }, + "put": { + "tags": [ + "Curation Profiles" + ], + "description": "Creates or updates an curation profile.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CurationProfileNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an curation profile.", + "required": true, + "schema": { + "$ref": "#/definitions/CurationProfile" + } + } + ], + "operationId": "CurationProfiles_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/CurationProfile" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/CurationProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CurationProfiles_CreateOrUpdate": { + "$ref": "./examples/CurationProfiles_Put.json" + } + } + }, + "patch": { + "tags": [ + "Curation Profiles" + ], + "description": "Partially updates an curation profile.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CurationProfileNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable curation profile properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CurationProfileUpdate" + } + } + ], + "operationId": "CurationProfiles_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/CurationProfile" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CurationProfiles_Update": { + "$ref": "./examples/CurationProfiles_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Curation Profiles" + ], + "description": "Deletes an curation profile.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CurationProfileNameParameter" + } + ], + "operationId": "CurationProfiles_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CurationProfiles_Delete": { + "$ref": "./examples/CurationProfiles_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies": { + "get": { + "tags": [ + "Project Policies" + ], + "description": "Lists all project policies in the dev center", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectPolicies_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectPolicies_ListByDevCenter": { + "$ref": "./examples/ProjectPolicies_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/projectPolicies/{projectPolicyName}": { + "get": { + "tags": [ + "Project Policies" + ], + "description": "Gets a specific project policy.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/ProjectPolicyNameParameter" + } + ], + "operationId": "ProjectPolicies_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectPolicies_Get": { + "$ref": "./examples/ProjectPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Project Policies" + ], + "description": "Creates or updates an project policy.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/ProjectPolicyNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an project policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectPolicy" + } + } + ], + "operationId": "ProjectPolicies_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectPolicy" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ProjectPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectPolicies_CreateOrUpdate": { + "$ref": "./examples/ProjectPolicies_Put.json" + } + } + }, + "patch": { + "tags": [ + "Project Policies" + ], + "description": "Partially updates an project policy.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/ProjectPolicyNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project policy properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectPolicyUpdate" + } + } + ], + "operationId": "ProjectPolicies_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectPolicy" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectPolicies_Update": { + "$ref": "./examples/ProjectPolicies_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Project Policies" + ], + "description": "Deletes an project policy.", + "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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/ProjectPolicyNameParameter" + } + ], + "operationId": "ProjectPolicies_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectPolicies_Delete": { + "$ref": "./examples/ProjectPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListBySubscription": { + "$ref": "./examples/Projects_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_ListByResourceGroup": { + "$ref": "./examples/Projects_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a specific project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "description": "Creates or updates a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "operationId": "Projects_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_Put.json" + }, + "Projects_CreateOrUpdateWithLimitsPerDev": { + "$ref": "./examples/Projects_PutWithMaxDevBoxPerUser.json" + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "description": "Partially updates a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "operationId": "Projects_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "description": "Deletes a project resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/getInheritedSettings": { + "post": { + "tags": [ + "Projects" + ], + "description": "Gets applicable inherited settings for this project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_GetInheritedSettings", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InheritedSettingsForProject" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Projects_GetInheritedSettings": { + "$ref": "./examples/Projects_GetInheritedSettings.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a Project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByProject": { + "$ref": "./examples/AttachedNetworks_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByProject": { + "$ref": "./examples/AttachedNetworks_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Lists the catalogs associated with a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectCatalogs_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_List": { + "$ref": "./examples/ProjectCatalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets an associated project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Get": { + "$ref": "./examples/ProjectCatalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Project Catalogs" + ], + "description": "Creates or updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "ProjectCatalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/ProjectCatalogs_CreateGitHub.json" + }, + "ProjectCatalogs_CreateOrUpdateAdo": { + "$ref": "./examples/ProjectCatalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Project Catalogs" + ], + "description": "Partially updates a project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "ProjectCatalogs_Patch", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Patch": { + "$ref": "./examples/ProjectCatalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Project Catalogs" + ], + "description": "Deletes a project catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_Delete": { + "$ref": "./examples/ProjectCatalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Lists the environment definitions in this project catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByProjectCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_GetByProjectCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetByProjectCatalog": { + "$ref": "./examples/EnvironmentDefinitions_GetByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "ProjectCatalogEnvironmentDefinitions_GetErrorDetails", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogEnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/getSyncErrorDetails": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Gets project catalog synchronization error details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_GetSyncErrorDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogs_GetSyncErrorDetails": { + "$ref": "./examples/ProjectCatalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Sync": { + "$ref": "./examples/ProjectCatalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Project Catalogs" + ], + "description": "Connects a project catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "ProjectCatalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogs_Connect": { + "$ref": "./examples/ProjectCatalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Lists galleries for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Galleries_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GalleryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_ListByDevCenter": { + "$ref": "./examples/Galleries_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Gets a gallery", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Get": { + "$ref": "./examples/Galleries_Get.json" + } + } + }, + "put": { + "tags": [ + "Galleries" + ], + "description": "Creates or updates a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a gallery.", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + } + } + ], + "operationId": "Galleries_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Galleries_CreateOrUpdate": { + "$ref": "./examples/Galleries_Create.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "description": "Deletes a gallery resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Galleries_Delete": { + "$ref": "./examples/Galleries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByDevCenter": { + "$ref": "./examples/Images_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a gallery.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByGallery", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByGallery": { + "$ref": "./examples/Images_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets a gallery image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "Images_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/Images_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByImage", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Versions_Get": { + "$ref": "./examples/ImageVersions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + } + ], + "operationId": "Images_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByProject": { + "$ref": "./examples/Images_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "Images_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_GetByProject": { + "$ref": "./examples/Images_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByProject": { + "$ref": "./examples/ImageVersions_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/ProjectImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_GetByProject": { + "$ref": "./examples/ImageVersions_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/listSkus": { + "post": { + "tags": [ + "Project SKUs" + ], + "description": "Lists SKUs available to the project", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Skus_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Skus_ListByProject": { + "$ref": "./examples/Skus_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a DevCenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByDevCenter": { + "$ref": "./examples/AttachedNetworks_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByDevCenter": { + "$ref": "./examples/AttachedNetworks_GetByDevCenter.json" + } + } + }, + "put": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Creates or updates an attached NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an attached NetworkConnection.", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + } + ], + "operationId": "AttachedNetworks_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AttachedNetworks_Create": { + "$ref": "./examples/AttachedNetworks_Create.json" + } + } + }, + "delete": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Un-attach a NetworkConnection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_Delete": { + "$ref": "./examples/AttachedNetworks_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists catalogs for a devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Catalogs_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByDevCenter": { + "$ref": "./examples/Catalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets a catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/Catalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Catalogs" + ], + "description": "Creates or updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "Catalogs_CreateOrUpdate", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/Catalogs_CreateGitHub.json" + }, + "Catalogs_CreateOrUpdateAdo": { + "$ref": "./examples/Catalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Catalogs" + ], + "description": "Partially updates a catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "Catalogs_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/Catalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Catalogs" + ], + "description": "Deletes a catalog resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/Catalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/getSyncErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "post": { + "tags": [ + "Catalogs" + ], + "description": "Gets catalog synchronization error details", + "operationId": "Catalogs_GetSyncErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SyncErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_GetSyncErrorDetails": { + "$ref": "./examples/Catalogs_GetSyncErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Syncs templates for a template source.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Sync": { + "$ref": "./examples/Catalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/connect": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Connects a catalog to enable syncing.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Connect", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Connect": { + "$ref": "./examples/Catalogs_Connect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for the devcenter.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentTypes_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_ListByDevCenter": { + "$ref": "./examples/EnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Get": { + "$ref": "./examples/EnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + } + ], + "operationId": "EnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/EnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentTypeUpdate" + } + } + ], + "operationId": "EnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Update": { + "$ref": "./examples/EnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes an environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Delete": { + "$ref": "./examples/EnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists allowed environment types for a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_List": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an allowed environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_Get": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for a project.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_List": { + "$ref": "./examples/ProjectEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Get": { + "$ref": "./examples/ProjectEnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a Project Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + } + ], + "operationId": "ProjectEnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/ProjectEnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdate" + } + } + ], + "operationId": "ProjectEnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Update": { + "$ref": "./examples/ProjectEnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes a project environment type.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Delete", + "responses": { + "200": { + "description": "Resource was deleted." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Delete": { + "$ref": "./examples/ProjectEnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions for a devcenter.", + "operationId": "DevBoxDefinitions_ListByDevCenter", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByDevCenter": { + "$ref": "./examples/DevBoxDefinitions_ListByDevCenter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition", + "operationId": "DevBoxDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Get": { + "$ref": "./examples/DevBoxDefinitions_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Creates or updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "201": { + "description": "Created. The operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Create": { + "$ref": "./examples/DevBoxDefinitions_Create.json" + } + } + }, + "patch": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Partially updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinitionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "202": { + "description": "Accepted. The operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Patch": { + "$ref": "./examples/DevBoxDefinitions_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Deletes a Dev Box definition", + "operationId": "DevBoxDefinitions_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Delete": { + "$ref": "./examples/DevBoxDefinitions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions configured for a project.", + "operationId": "DevBoxDefinitions_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByProject": { + "$ref": "./examples/DevBoxDefinitions_ListByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions/{devBoxDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition configured for a project", + "operationId": "DevBoxDefinitions_GetByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_GetByProject": { + "$ref": "./examples/DevBoxDefinitions_GetByProject.json" + } + } + } + }, + "/providers/Microsoft.DevCenter/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_Get": { + "$ref": "./examples/Operations_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/operationStatuses/{operationId}": { + "get": { + "description": "Gets the current status of an async operation.", + "operationId": "OperationStatuses_Get", + "summary": "Get Operation Status", + "tags": [ + "OperationStatus" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "The requested operation status", + "headers": { + "Location": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/OperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/usages": { + "get": { + "operationId": "Usages_ListByLocation", + "description": "Lists the current usages and limits in this location for the provided subscription.", + "tags": [ + "Usages" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; a list of usages is returned", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "The default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "listUsages": { + "$ref": "./examples/Usages_ListByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkScopedNameAvailability": { + "post": { + "tags": [ + "CheckScopedNameAvailability" + ], + "operationId": "CheckScopedNameAvailability_Execute", + "x-ms-examples": { + "DevcenterCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_DevCenterCatalog.json" + }, + "ProjectCatalogNameAvailability": { + "$ref": "./examples/CheckScopedNameAvailability_ProjectCatalog.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckScopedNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "List Tasks in the catalog.", + "operationId": "CustomizationTasks_ListByCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTaskListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "CustomizationTasks_ListByCatalog": { + "$ref": "./examples/CustomizationTasks_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "get": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets a Task from the catalog", + "operationId": "CustomizationTasks_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomizationTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_Get": { + "$ref": "./examples/CustomizationTasks_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/tasks/{taskName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/CustomizationTaskNameParameter" + } + ], + "post": { + "tags": [ + "Customization Tasks" + ], + "description": "Gets Customization Task error details", + "operationId": "CustomizationTasks_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CustomizationTasks_GetErrorDetails": { + "$ref": "./examples/CustomizationTasks_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions": { + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "List environment definitions in the catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentDefinitions_ListByCatalog", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EnvironmentDefinitions_ListByCatalog": { + "$ref": "./examples/EnvironmentDefinitions_ListByCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets an environment definition from the catalog.", + "operationId": "EnvironmentDefinitions_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_Get": { + "$ref": "./examples/EnvironmentDefinitions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/environmentDefinitions/{environmentDefinitionName}/getErrorDetails": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentDefinitionNameParameter" + } + ], + "post": { + "tags": [ + "Environment Definitions" + ], + "description": "Gets Environment Definition error details", + "operationId": "EnvironmentDefinitions_GetErrorDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "vdi.json#/definitions/CatalogResourceValidationErrorDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EnvironmentDefinitions_GetErrorDetails": { + "$ref": "./examples/EnvironmentDefinitions_GetErrorDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "List Image Definitions in the catalog.", + "operationId": "ProjectCatalogImageDefinitions_ListByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ImageDefinitions_ListByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_ListByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Gets an Image Definition from the catalog", + "operationId": "ProjectCatalogImageDefinitions_GetByProjectCatalog", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitions_GetByProjectCatalog": { + "$ref": "./examples/ImageDefinitions_GetByProjectCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/buildImage": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Builds an image for the specified Image Definition.", + "operationId": "ProjectCatalogImageDefinitions_BuildImage", + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ProjectCatalogImageDefinitions_BuildImage": { + "$ref": "./examples/ImageDefinitions_BuildImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Lists builds for a specified image definition.", + "operationId": "ProjectCatalogImageDefinitionBuilds_ListByImageDefinition", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuildListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionBuilds_ListByImageDefinition": { + "$ref": "./examples/ImageDefinitions_ListImageBuildsByImageDefinition.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "get": { + "tags": [ + "Image Definitions" + ], + "description": "Gets a build for a specified image definition.", + "operationId": "ProjectCatalogImageDefinitionBuild_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuild" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageDefinitionBuilds_GetByImageDefinition": { + "$ref": "./examples/ImageDefinitions_GetImageBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/cancel": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Cancels the specified build for an image definition.", + "operationId": "ProjectCatalogImageDefinitionBuild_Cancel", + "parameters": [], + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ImageDefinitionBuilds_CancelByImageDefinition": { + "$ref": "./examples/ImageDefinitions_CancelImageBuild.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/catalogs/{catalogName}/imageDefinitions/{imageDefinitionName}/builds/{buildName}/getBuildDetails": { + "post": { + "tags": [ + "Image Definitions" + ], + "description": "Gets Build details", + "operationId": "ProjectCatalogImageDefinitionBuild_GetBuildDetails", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionNameParameter" + }, + { + "$ref": "#/parameters/ImageDefinitionBuildNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageDefinitionBuildDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ProjectCatalogImageDefinitionBuild_GetErrorDetails": { + "$ref": "./examples/ImageDefinitions_GetImageBuildDetails.json" + } + } + } + } + }, + "definitions": { + "DevCenterPlan": { + "type": "object", + "description": "Represents a devcenter plan resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Plan properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanProperties" + }, + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "PlanProperties": { + "description": "Properties of the devcenter plan.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterPlanMember": { + "type": "object", + "description": "Represents a devcenter plan member resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Plan member properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanMemberProperties" + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "PlanMemberProperties": { + "description": "Properties of the devcenter plan member.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PlanMemberUpdateProperties" + } + ], + "properties": { + "memberId": { + "description": "The unique id of the member.", + "type": "string" + }, + "memberType": { + "description": "The type of the member (user, group)", + "enum": [ + "User", + "Group" + ], + "type": "string", + "x-ms-enum": { + "name": "PlanMemberType", + "modelAsString": true + } + }, + "syncStatus": { + "description": "The sync status of the member.", + "$ref": "#/definitions/PlanMemberSyncStatus", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "PlanMemberUpdateProperties": { + "description": "Properties of the devcenter plan member.", + "type": "object", + "properties": { + "tier": { + "description": "The tier of the member.", + "type": "string" + } + } + }, + "PlanMemberSyncStatus": { + "description": "The sync status of the plan member.", + "type": "object", + "properties": { + "syncState": { + "enum": [ + "Succeeded", + "InProgress", + "NotStarted", + "Failed", + "Canceled" + ], + "description": "The synchronization state of the plan member.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "PlanMemberSyncState", + "modelAsString": true + } + }, + "lastSyncError": { + "description": "Error response describing why the sync failed.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "lastSyncTime": { + "description": "When the plan member was last synced.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "PlanMemberUpdate": { + "description": "The devcenter plan member resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "description": "Plan member update properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PlanMemberUpdateProperties" + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "DevCenter": { + "type": "object", + "description": "Represents a devcenter resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "DevCenter properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterProperties" + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterProperties": { + "description": "Properties of the devcenter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "DevCenterUpdateProperties": { + "description": "Properties of the devcenter. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "planId": { + "type": "string", + "description": "Resource Id of an associated Plan" + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption settings to be used for server-side encryption for proprietary content (such as catalogs, logs, customizations)." + }, + "displayName": { + "type": "string", + "description": "The display name of the devcenter." + }, + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog." + }, + "networkSettings": { + "$ref": "#/definitions/DevCenterNetworkSettings", + "description": "Network settings that will be enforced on network resources associated with the Dev Center." + }, + "devBoxProvisioningSettings": { + "$ref": "#/definitions/DevBoxProvisioningSettings", + "description": "Settings to be used in the provisioning of all Dev Boxes that belong to this dev center." + }, + "restrictedResourceTypes": { + "description": "Indicates the resource types that are restricted from being accessed by a project unless allowed by a project policy.", + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterResourceType" + } + } + } + }, + "DevCenterEncryptionSet": { + "description": "Represents a devcenter encryption set resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetProperties", + "description": "Properties of a devcenter encryption set." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterEncryptionSetProperties": { + "description": "Properties of the devcenter encryption set.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "DevCenterEncryptionSetUpdateProperties": { + "description": "Properties of the devcenter encryption set. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not.", + "$ref": "#/definitions/DevboxDisksEncryptionEnableStatus" + }, + "keyEncryptionKeyUrl": { + "type": "string", + "description": "Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek." + } + } + }, + "DevboxDisksEncryptionEnableStatus": { + "description": "Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DevboxDisksEncryptionEnableStatus", + "modelAsString": true + } + }, + "DevCenterProjectCatalogSettings": { + "type": "object", + "description": "Project catalog settings for project catalogs under a project associated to this dev center.", + "properties": { + "catalogItemSyncEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/CatalogItemSyncEnableStatus" + } + } + }, + "DevCenterResourceType": { + "description": "Indicates dev center resource types.", + "enum": [ + "Images", + "AttachedNetworks", + "Skus" + ], + "type": "string", + "x-ms-enum": { + "name": "DevCenterResourceType", + "modelAsString": true + } + }, + "DevBoxProvisioningSettings": { + "type": "object", + "description": "Provisioning settings that apply to all Dev Boxes created in this dev center", + "properties": { + "installAzureMonitorAgentEnableStatus": { + "description": "Whether project catalogs associated with projects in this dev center can be configured to sync catalog items.", + "$ref": "#/definitions/InstallAzureMonitorAgentEnableStatus" + } + } + }, + "CatalogItemSyncEnableStatus": { + "description": "Catalog item sync types enable or disable status. Indicates whether project catalogs are allowed to sync catalog items under projects associated to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemSyncEnableStatus", + "modelAsString": true + } + }, + "DevCenterNetworkSettings": { + "type": "object", + "description": "Network settings for the Dev Center.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus" + } + } + }, + "ProjectNetworkSettings": { + "type": "object", + "description": "Network settings for the project.", + "properties": { + "microsoftHostedNetworkEnableStatus": { + "$ref": "#/definitions/MicrosoftHostedNetworkEnableStatus", + "readOnly": true + } + } + }, + "MicrosoftHostedNetworkEnableStatus": { + "description": "Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MicrosoftHostedNetworkEnableStatus", + "modelAsString": true + } + }, + "Encryption": { + "type": "object", + "properties": { + "customerManagedKeyEncryption": { + "$ref": "../../../../../common-types/resource-management/v4/customermanagedkeys.json#/definitions/customerManagedKeyEncryption" + } + } + }, + "InstallAzureMonitorAgentEnableStatus": { + "description": "Setting to be used when determining whether to install the Azure Monitor Agent service on Dev Boxes that belong to this dev center.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "InstallAzureMonitorAgentEnableStatus", + "modelAsString": true + } + }, + "PlanUpdate": { + "description": "The devcenter plan resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "sku": { + "description": "The SKU for DevCenters created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + } + } + }, + "DevCenterUpdate": { + "description": "The devcenter resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterUpdateProperties", + "description": "Properties of a Dev Center to be updated." + } + } + }, + "EncryptionSetUpdate": { + "description": "The devcenter encryption set resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterEncryptionSetUpdateProperties", + "description": "Properties of a Dev Center encryption set to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "PlanListResult": { + "description": "Result of the list devcenter plans operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlan" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PlanMembersListResult": { + "description": "Result of the list devcenter plan members operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterPlanMember" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterListResult": { + "description": "Result of the list devcenters operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenter" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EncryptionSetListResult": { + "description": "Result of the list devcenter encryption set operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenterEncryptionSet" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterUri": { + "description": "The URI of the resource.", + "readOnly": true, + "type": "string" + }, + "Project": { + "description": "Represents a project resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of a project." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectUpdateProperties": { + "description": "Properties of a project. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devCenterId": { + "type": "string", + "description": "Resource Id of an associated DevCenter" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced." + }, + "displayName": { + "type": "string", + "description": "The display name of the project." + }, + "catalogSettings": { + "$ref": "#/definitions/ProjectCatalogSettings", + "description": "Settings to be used when associating a project with a catalog." + } + } + }, + "ProjectCatalogSettings": { + "description": "Settings to be used when associating a project with a catalog.", + "type": "object", + "properties": { + "catalogItemSyncTypes": { + "description": "Indicates catalog item types that can be synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "ProjectProperties": { + "description": "Properties of a project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center resource this project is associated with.", + "$ref": "#/definitions/DevCenterUri", + "readOnly": true + } + } + }, + "ProjectUpdate": { + "description": "The project properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties", + "description": "Properties of a project to be updated." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "InheritedSettingsForProject": { + "description": "Applicable inherited settings for a project.", + "type": "object", + "properties": { + "projectCatalogSettings": { + "$ref": "#/definitions/DevCenterProjectCatalogSettings", + "description": "Dev Center settings to be used when associating a project with a catalog.", + "readOnly": true + }, + "networkSettings": { + "$ref": "#/definitions/ProjectNetworkSettings", + "description": "Network settings that will be enforced on this project.", + "readOnly": true + } + } + }, + "CurationProfileListResult": { + "description": "Results of the curation profile list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CurationProfile" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CurationProfile": { + "description": "Represents an curation profile resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CurationProfileProperties", + "description": "Properties of an curation profile." + } + } + }, + "CurationProfileProperties": { + "description": "Properties of an curation profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CurationProfileUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "CurationProfileUpdateProperties": { + "description": "Properties of an curation profile. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "resourcePolicies": { + "description": "Resource policies that are a part of this curation profile.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourcePolicy" + } + }, + "scopes": { + "description": "Resources that have access to the shared resources that are a part of this curation profile.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResourcePolicy": { + "description": "A resource policy.", + "type": "object", + "properties": { + "resources": { + "description": "Resources that are included and shared as a part of a project policy.", + "type": "string" + }, + "filter": { + "description": "Optional. When specified, this expression is used to filter the resources.", + "type": "string" + } + } + }, + "CurationProfileUpdate": { + "description": "The curation profile properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CurationProfileUpdateProperties", + "description": "Properties of an curation profile to be updated." + } + } + }, + "ProjectPolicyListResult": { + "description": "Results of the project policy list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProjectPolicy" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectPolicy": { + "description": "Represents an project policy resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectPolicyProperties", + "description": "Properties of an project policy." + } + } + }, + "ProjectPolicyProperties": { + "description": "Properties of an project policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectPolicyUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ProjectPolicyUpdateProperties": { + "description": "Properties of an project policy. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "resourcePolicies": { + "description": "Resource policies that are a part of this project policy.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourcePolicy" + } + }, + "scopes": { + "description": "Resources that have access to the shared resources that are a part of this project policy.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ProjectPolicyUpdate": { + "description": "The project policy properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectPolicyUpdateProperties", + "description": "Properties of an project policy to be updated." + } + } + }, + "Catalog": { + "description": "Represents a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogProperties", + "description": "Catalog properties." + } + } + }, + "CatalogUpdateProperties": { + "description": "Properties of a catalog. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "gitHub": { + "description": "Properties for a GitHub catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "adoGit": { + "description": "Properties for an Azure DevOps catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "syncType": { + "enum": [ + "Manual", + "Scheduled" + ], + "description": "Indicates the type of sync that is configured for the catalog.", + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncType", + "modelAsString": true + } + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "CatalogProperties": { + "description": "Properties of a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CatalogUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "syncState": { + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Canceled" + ], + "description": "The synchronization state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncState", + "modelAsString": true + } + }, + "lastSyncStats": { + "description": "Stats of the latest synchronization.", + "$ref": "#/definitions/SyncStats", + "readOnly": true + }, + "connectionState": { + "enum": [ + "Connected", + "Disconnected" + ], + "description": "The connection state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogConnectionState", + "modelAsString": true + } + }, + "lastConnectionTime": { + "description": "When the catalog was last connected.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "lastSyncTime": { + "description": "When the catalog was last synced.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "SyncStats": { + "description": "Stats of the synchronization.", + "type": "object", + "properties": { + "added": { + "description": "Count of catalog items added during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "updated": { + "description": "Count of catalog items updated during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "unchanged": { + "description": "Count of catalog items that were unchanged during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "removed": { + "description": "Count of catalog items removed during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "validationErrors": { + "description": "Count of catalog items that had validation errors during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "synchronizationErrors": { + "description": "Count of synchronization errors that occured during synchronization.", + "type": "integer", + "format": "int32", + "readOnly": true, + "minimum": 0 + }, + "syncedCatalogItemTypes": { + "description": "Indicates catalog item types that were synced.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogItemType" + } + } + } + }, + "GitCatalog": { + "description": "Properties for a Git repository catalog.", + "type": "object", + "properties": { + "uri": { + "description": "Git URI.", + "type": "string" + }, + "branch": { + "description": "Git branch.", + "type": "string" + }, + "secretIdentifier": { + "description": "A reference to the Key Vault secret containing a security token to authenticate to a Git repository.", + "type": "string" + }, + "path": { + "description": "The folder where the catalog items can be found inside the repository.", + "type": "string" + } + } + }, + "CatalogUpdate": { + "description": "The catalog's properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogUpdateProperties", + "description": "Catalog properties for update." + } + } + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "SyncErrorDetails": { + "description": "Synchronization error details.", + "type": "object", + "properties": { + "operationError": { + "description": "Error information for the overall synchronization operation.", + "readOnly": true, + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "conflicts": { + "description": "Catalog items that have conflicting names.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogConflictError" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "errors": { + "description": "Errors that occured during synchronization.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogSyncError" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogSyncError": { + "description": "An individual synchronization error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file the error is associated with.", + "type": "string", + "readOnly": true + }, + "errorDetails": { + "description": "Errors associated with the file.", + "type": "array", + "items": { + "$ref": "vdi.json#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogConflictError": { + "description": "An individual conflict error.", + "type": "object", + "properties": { + "path": { + "description": "The path of the file that has a conflicting name.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the conflicting catalog item.", + "type": "string", + "readOnly": true + } + } + }, + "Gallery": { + "description": "Represents a gallery.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties", + "description": "Gallery properties." + } + } + }, + "GalleryProperties": { + "description": "Properties of a gallery.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "galleryResourceId": { + "description": "The resource ID of the backing Azure Compute Gallery.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "galleryResourceId" + ] + }, + "Image": { + "description": "Represents an image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties", + "description": "Image properties." + } + } + }, + "ImageProperties": { + "description": "Properties of an image.", + "type": "object", + "properties": { + "description": { + "description": "The description of the image.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the image.", + "type": "string", + "readOnly": true + }, + "offer": { + "description": "The name of the image offer.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The SKU name for the image.", + "type": "string", + "readOnly": true + }, + "recommendedMachineConfiguration": { + "description": "The recommended machine configuration to use with the image.", + "$ref": "#/definitions/RecommendedMachineConfiguration", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "hibernateSupport": { + "description": "Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "readOnly": true, + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "RecommendedMachineConfiguration": { + "description": "Properties for a recommended machine configuration.", + "type": "object", + "properties": { + "memory": { + "description": "Recommended memory range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + }, + "vCPUs": { + "description": "Recommended vCPU range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + } + } + }, + "ResourceRange": { + "description": "Properties for a range of values.", + "type": "object", + "properties": { + "min": { + "description": "Minimum value.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "max": { + "description": "Maximum value.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageVersion": { + "description": "Represents an image version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageVersionProperties", + "description": "Image version properties." + } + } + }, + "ImageVersionProperties": { + "description": "Properties of an image version.", + "type": "object", + "properties": { + "name": { + "description": "The semantic version string.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "excludeFromLatest": { + "description": "If the version should be excluded from being treated as the latest version.", + "type": "boolean", + "readOnly": true + }, + "osDiskImageSizeInGb": { + "description": "The size of the OS disk image, in GB.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "GalleryListResult": { + "description": "Results of the gallery list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageListResult": { + "description": "Results of the image list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageVersionListResult": { + "description": "Results of the image version list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentType": { + "description": "Represents an allowed environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AllowedEnvironmentTypeProperties", + "description": "Properties of an allowed environment type." + } + } + }, + "AllowedEnvironmentTypeProperties": { + "description": "Properties of an allowed environment type.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "displayName": { + "description": "The display name of the allowed environment type.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentTypeListResult": { + "description": "Result of the allowed environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeProperties": { + "description": "Properties of an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "EnvironmentTypeUpdate": { + "description": "The environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeUpdateProperties", + "description": "Properties of an environment type to be updated." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeUpdateProperties": { + "description": "Properties of an environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the environment type." + } + } + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectEnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "type": "string", + "description": "The geo-location for the environment type" + } + } + }, + "ProjectEnvironmentTypeUpdateProperties": { + "description": "Properties of a project environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "deploymentTargetId": { + "description": "Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.", + "type": "string" + }, + "displayName": { + "description": "The display name of the project environment type.", + "type": "string" + }, + "status": { + "description": "Defines whether this Environment Type can be used in this Project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + }, + "creatorRoleAssignment": { + "description": "The role definition assigned to the environment creator on backing resources.", + "type": "object", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the environment creator.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "userRoleAssignments": { + "description": "Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserRoleAssignment" + } + } + } + }, + "ProjectEnvironmentTypeProperties": { + "description": "Properties of a project environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "environmentCount": { + "description": "The number of environments of this type.", + "type": "integer", + "format": "int32", + "minimum": 0, + "readOnly": true + } + } + }, + "ProjectEnvironmentTypeUpdate": { + "description": "The project environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties", + "description": "Properties to configure an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectEnvironmentTypeListResult": { + "description": "Result of the project environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionListResult": { + "description": "Results of the Dev Box definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionUpdate": { + "description": "Partial update of a Dev Box definition resource.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties", + "description": "Properties of a Dev Box definition to be updated." + } + } + }, + "DevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Dev Box definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionProperties" + } + } + }, + "DevBoxDefinitionUpdateProperties": { + "description": "Properties of a Dev Box definition. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created using this definition.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "osStorageType": { + "description": "The storage type used for the Operating System disk of Dev Boxes created using this definition.", + "type": "string" + }, + "hibernateSupport": { + "description": "Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "DevBoxDefinitionProperties": { + "description": "Properties of a Dev Box definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "imageValidationStatus": { + "description": "Validation status of the configured image.", + "$ref": "vdi.json#/definitions/ImageValidationStatus", + "readOnly": true + }, + "imageValidationErrorDetails": { + "description": "Details for image validator error. Populated when the image validation is not successful.", + "$ref": "vdi.json#/definitions/ImageValidationErrorDetails", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Dev Box Definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + }, + "activeImageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + }, + "required": [ + "imageReference", + "sku" + ] + }, + "AttachedNetworkConnection": { + "description": "Represents an attached NetworkConnection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttachedNetworkConnectionProperties", + "description": "Attached NetworkConnection properties." + } + } + }, + "AttachedNetworkConnectionProperties": { + "description": "Properties of an attached NetworkConnection.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "networkConnectionId": { + "description": "The resource ID of the NetworkConnection you want to attach.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkConnectionLocation": { + "description": "The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.", + "type": "string", + "readOnly": true + }, + "healthCheckStatus": { + "$ref": "vdi.json#/definitions/HealthCheckStatus", + "readOnly": true + }, + "domainJoinType": { + "description": "AAD Join type of the network. This is populated based on the referenced Network Connection.", + "$ref": "vdi.json#/definitions/DomainJoinType", + "readOnly": true + } + }, + "required": [ + "networkConnectionId" + ] + }, + "AttachedNetworkListResult": { + "description": "Results of the Attached Networks list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AttachedNetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentRole": { + "type": "object", + "description": "A role that can be assigned to a user.", + "properties": { + "roleName": { + "description": "The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "This is a description of the Role Assignment.", + "type": "string", + "readOnly": true + } + } + }, + "UserRoleAssignment": { + "type": "object", + "description": "Mapping of user object ID to role assignments.", + "x-ms-client-name": "userRoleAssignmentValue", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the parent user.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + ], + "properties": { + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object", + "readOnly": true + } + } + }, + "CatalogItemType": { + "description": "Indicates catalog item types.", + "enum": [ + "EnvironmentDefinition", + "ImageDefinition" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogItemType", + "modelAsString": true + } + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether the environment type is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true + } + }, + "ListUsagesResult": { + "description": "List of Core Usages.", + "type": "object", + "properties": { + "value": { + "description": "The array page of Usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "The link to get the next page of Usage result.", + "type": "string", + "readOnly": true + } + } + }, + "Usage": { + "description": "The core usage details.", + "type": "object", + "properties": { + "currentValue": { + "description": "The current usage.", + "type": "integer", + "format": "int64" + }, + "limit": { + "description": "The limit integer.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "The unit details.", + "type": "string", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "name": { + "description": "The name.", + "$ref": "#/definitions/UsageName" + }, + "id": { + "description": "The fully qualified arm resource id.", + "type": "string" + } + } + }, + "UsageName": { + "description": "The Usage Names.", + "type": "object", + "properties": { + "localizedValue": { + "description": "The localized name of the resource.", + "type": "string" + }, + "value": { + "description": "The name of the resource.", + "type": "string" + } + } + }, + "CustomizationTaskListResult": { + "description": "Results of the Task list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomizationTask" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CustomizationTask": { + "description": "Represents a Task to be used in customizing a Dev Box.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Task properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomizationTaskProperties" + } + } + }, + "CustomizationTaskProperties": { + "description": "Properties of a Task.", + "type": "object", + "properties": { + "inputs": { + "description": "Inputs to the task.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomizationTaskInput" + }, + "readOnly": true + }, + "timeout": { + "description": "The default timeout for the task.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Task.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "CustomizationTaskInput": { + "description": "Input for a Task.", + "type": "object", + "properties": { + "description": { + "description": "Description of the input.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the input.", + "type": "string", + "enum": [ + "string", + "number", + "boolean" + ], + "x-ms-enum": { + "name": "CustomizationTaskInputType", + "modelAsString": true + }, + "readOnly": true + }, + "required": { + "description": "Whether or not the input is required.", + "type": "boolean", + "readOnly": true + } + } + }, + "EnvironmentDefinitionListResult": { + "description": "Results of the environment definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentDefinition": { + "description": "Represents an environment definition catalog item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Environment definition properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentDefinitionProperties" + } + } + }, + "EnvironmentDefinitionProperties": { + "description": "Properties of an environment definition.", + "type": "object", + "properties": { + "description": { + "description": "A short description of the environment definition.", + "type": "string", + "readOnly": true + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentDefinitionParameter" + }, + "description": "Input parameters passed to an environment.", + "readOnly": true + }, + "templatePath": { + "description": "Path to the Environment Definition entrypoint file.", + "type": "string", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the environment definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + } + } + }, + "EnvironmentDefinitionParameter": { + "type": "object", + "description": "Properties of an Environment Definition parameter", + "properties": { + "id": { + "type": "string", + "description": "Unique ID of the parameter", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Display name of the parameter", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the parameter", + "readOnly": true + }, + "type": { + "description": "A string of one of the basic JSON types (number, integer, array, object, boolean, string)", + "$ref": "#/definitions/ParameterType", + "readOnly": true + }, + "readOnly": { + "type": "boolean", + "description": "Whether or not this parameter is read-only. If true, default should have a value.", + "readOnly": true + }, + "required": { + "type": "boolean", + "description": "Whether or not this parameter is required", + "readOnly": true + } + } + }, + "ParameterType": { + "type": "string", + "enum": [ + "array", + "boolean", + "integer", + "number", + "object", + "string" + ], + "description": "The type of data a parameter accepts.", + "readOnly": true, + "x-ms-enum": { + "name": "ParameterType", + "modelAsString": true, + "values": [ + { + "value": "array", + "description": "The parameter accepts an array of values." + }, + { + "value": "boolean", + "description": "The parameter accepts a boolean value." + }, + { + "value": "integer", + "description": "The parameter accepts an integer value." + }, + { + "value": "number", + "description": "The parameter accepts a number value." + }, + { + "value": "object", + "description": "The parameter accepts an object value." + }, + { + "value": "string", + "description": "The parameter accepts a string value." + } + ] + } + }, + "CheckScopedNameAvailabilityRequest": { + "description": "The scoped name check availability request body.", + "type": "object", + "properties": { + "name": { + "description": "The name of the resource for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + }, + "scope": { + "description": "The resource id to scope the name check.", + "type": "string" + } + } + }, + "ImageDefinitionListResult": { + "description": "Results of the Image Definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageDefinition": { + "description": "Represents a definition for an Image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Image Definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDefinitionProperties" + } + } + }, + "ImageDefinitionProperties": { + "description": "Properties of an Image Definition.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "fileUrl": { + "description": "The URL to the repository file containing the image definition.", + "type": "string", + "readOnly": true + }, + "latestBuild": { + "$ref": "#/definitions/LatestImageBuild", + "description": "Details about the latest build." + }, + "imageValidationStatus": { + "description": "Validation status of the configured image.", + "$ref": "vdi.json#/definitions/ImageValidationStatus", + "readOnly": true + }, + "imageValidationErrorDetails": { + "description": "Details for image validator error. Populated when the image validation is not successful.", + "$ref": "vdi.json#/definitions/ImageValidationErrorDetails", + "readOnly": true + }, + "validationStatus": { + "description": "Validation status for the Image Definition.", + "$ref": "vdi.json#/definitions/CatalogResourceValidationStatus", + "readOnly": true + }, + "activeImageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + } + }, + "LatestImageBuild": { + "type": "object", + "description": "Details about the latest build.", + "properties": { + "name": { + "description": "Identifier of a build.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The state of an Image Definition Build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + } + } + }, + "ImageDefinitionBuildStatus": { + "type": "string", + "enum": [ + "Succeeded", + "Running", + "ValidationFailed", + "Failed", + "Cancelled", + "TimedOut" + ], + "description": "The state of an Image Definition Build.", + "readOnly": true, + "x-ms-enum": { + "name": "ImageDefinitionBuildStatus", + "modelAsString": true, + "values": [ + { + "value": "Succeeded", + "description": "The image build has succeeded." + }, + { + "value": "Running", + "description": "The image build is running." + }, + { + "value": "ValidationFailed", + "description": "The built image has failed validation." + }, + { + "value": "Failed", + "description": "The image build has failed." + }, + { + "value": "Cancelled", + "description": "The image build has been cancelled." + }, + { + "value": "TimedOut", + "description": "The image build has timed out." + } + ] + } + }, + "ImageDefinitionBuildListResult": { + "description": "Results of the Image Definition Build list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuild" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageDefinitionBuild": { + "description": "Represents a specific build of an Image Definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Image Definition Build properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageDefinitionBuildProperties" + } + } + }, + "ImageDefinitionBuildProperties": { + "description": "Properties of an Image Definition Build.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "The specific image version used by the build.", + "readOnly": true + }, + "status": { + "description": "The status of the build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "errorDetails": { + "description": "Details for image creation error. Populated when the image creation is not successful.", + "$ref": "#/definitions/ImageCreationErrorDetails", + "readOnly": true + } + } + }, + "ImageDefinitionBuildDetails": { + "description": "Represents a specific build of an Image Definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "The specific image version used by the build.", + "readOnly": true + }, + "status": { + "description": "The status of the build.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "errorDetails": { + "description": "Details for image creation error. Populated when the image creation is not successful.", + "$ref": "#/definitions/ImageCreationErrorDetails", + "readOnly": true + }, + "taskGroups": { + "description": "The list of task groups executed during the image definition build.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuildTaskGroup" + }, + "readOnly": true + } + } + }, + "ImageCreationErrorDetails": { + "type": "object", + "description": "Image creation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "ImageDefinitionBuildTaskGroup": { + "description": "A task group executed during the image definition build.", + "type": "object", + "properties": { + "name": { + "description": "The name of the task group.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the task group.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task group.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "tasks": { + "description": "The list of tasks executed during the task group.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageDefinitionBuildTask" + }, + "readOnly": true + } + } + }, + "ImageDefinitionBuildTask": { + "description": "A task executed during the image definition build.", + "type": "object", + "properties": { + "name": { + "description": "The name of the task.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the task.", + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "key", + "value" + ] + } + }, + "displayName": { + "description": "Display name to help differentiate multiple instances of the same task.", + "type": "string" + }, + "id": { + "description": "ID of the task instance.", + "type": "string", + "readOnly": true + }, + "startTime": { + "description": "Start time of the task.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "endTime": { + "description": "End time of the task.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The status of the task.", + "$ref": "#/definitions/ImageDefinitionBuildStatus", + "readOnly": true + }, + "logUri": { + "description": "The URI for retrieving logs for the task execution.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "PlanNameParameter": { + "name": "planName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter plan.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "PlanMemberNameParameter": { + "name": "memberName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a devcenter plan member.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevCenterNameParameter": { + "name": "devCenterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 26 + }, + "DevCenterEncryptionSetNameParameter": { + "name": "encryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter encryption set.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$", + "minLength": 3, + "maxLength": 63 + }, + "CurationProfileNameParameter": { + "name": "curationProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the curation profile.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ProjectPolicyNameParameter": { + "name": "projectPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project policy.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Catalog.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "GalleryNameParameter": { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]{0,78}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 80 + }, + "ProjectImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9~][a-zA-Z0-9-.~]{0,151}[a-zA-Z0-9]$", + "minLength": 3, + "maxLength": 153 + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the image.", + "x-ms-parameter-location": "method", + "pattern": "^[0-9]{1,10}[.][0-9]{1,10}[.][0-9]{1,10}$", + "minLength": 5, + "maxLength": 32 + }, + "EnvironmentTypeNameParameter": { + "name": "environmentTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the environment type.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "AttachedNetworkConnectionNameParameter": { + "name": "attachedNetworkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the attached NetworkConnection.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "DevBoxDefinitionName": { + "name": "devBoxDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Dev Box definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The Azure region", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomizationTaskNameParameter": { + "name": "taskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Task.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "EnvironmentDefinitionNameParameter": { + "name": "environmentDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Environment Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageDefinitionNameParameter": { + "name": "imageDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Image Definition.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ImageDefinitionBuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the Image Definition Build.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Create.json new file mode 100644 index 000000000000..dc1c1e37045f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3", + "body": { + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Delete.json new file mode 100644 index 000000000000..23315db4969a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByDevCenter.json new file mode 100644 index 000000000000..1267f4e5f9a6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByDevCenter.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByProject.json new file mode 100644 index 000000000000..a4c3620a33da --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_GetByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/projects/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByDevCenter.json new file mode 100644 index 000000000000..dd93927865ba --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByDevCenter.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByProject.json new file mode 100644 index 000000000000..6832e55bd693 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/AttachedNetworks_ListByProject.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Connect.json new file mode 100644 index 000000000000..b29e1176c156 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateAdo.json new file mode 100644 index 000000000000..32025e8126b6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateAdo.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateGitHub.json new file mode 100644 index 000000000000..1121354915d0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_CreateGitHub.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "syncType": "Manual" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0 + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Manual" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Delete.json new file mode 100644 index 000000000000..9929a39d4e63 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Get.json new file mode 100644 index 000000000000..c7b1021a535c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..0b78ee795aa7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_List.json new file mode 100644 index 000000000000..ebbeb1fb53f1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Patch.json new file mode 100644 index 000000000000..fa65437ab082 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + }, + "syncType": "Scheduled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded", + "syncType": "Scheduled" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Sync.json new file mode 100644 index 000000000000..b29e1176c156 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Catalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckNameAvailability.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..14f7d3469712 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json new file mode 100644 index 000000000000..6c2470fd449b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_DevCenterCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json new file mode 100644 index 000000000000..2cecf9940c44 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CheckScopedNameAvailability_ProjectCatalog.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/projects/catalogs", + "scope": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Delete.json new file mode 100644 index 000000000000..4179d2d2351e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "curationProfileName": "DevOnlyResources" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Get.json new file mode 100644 index 000000000000..76d5a4b93911 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "curationProfileName": "DevOnlyResources" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/curationProfiles/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/curationprofiles", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_ListByDevCenter.json new file mode 100644 index 000000000000..191a28ab3223 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_ListByDevCenter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/curationProfiles/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/curationprofiles", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Patch.json new file mode 100644 index 000000000000..652a60dc8ef7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Patch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "curationProfileName": "DevOnlyResources", + "body": { + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/curationProfiles/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/curationprofiles", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Put.json new file mode 100644 index 000000000000..dd18ce60a582 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CurationProfiles_Put.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "curationProfileName": "DevOnlyResources", + "body": { + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/curationProfiles/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/curationprofiles", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/curationProfiles/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/curationprofiles", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_Get.json new file mode 100644 index 000000000000..b541d099ed05 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30, + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_GetErrorDetails.json new file mode 100644 index 000000000000..dcabfb4e8580 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "taskName": "SampleTask" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_ListByCatalog.json new file mode 100644 index 000000000000..2a1f845cc78c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/CustomizationTasks_ListByCatalog.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog/tasks/SampleTask", + "name": "SampleTask", + "type": "Microsoft.DevCenter/devcenters/catalogs/tasks", + "properties": { + "inputs": { + "package": { + "type": "string", + "required": true + }, + "feed": { + "type": "string" + } + }, + "timeout": 30 + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Create.json new file mode 100644 index 000000000000..a248273a077c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Create.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Created" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Delete.json new file mode 100644 index 000000000000..be1224b5c0e2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Get.json new file mode 100644 index 000000000000..562babd3e8f4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_GetByProject.json new file mode 100644 index 000000000000..90160e8a46c9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_GetByProject.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json new file mode 100644 index 000000000000..be5b0405955e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByDevCenter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByProject.json new file mode 100644 index 000000000000..4541dbbf69c9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_ListByProject.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Patch.json new file mode 100644 index 000000000000..7c49e2ee11f9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxDefinitions_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Create.json new file mode 100644 index 000000000000..548f54ab6c6b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Create.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "location": "westus", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Delete.json new file mode 100644 index 000000000000..314f1c07f4b8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Get.json new file mode 100644 index 000000000000..215960869e41 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_List.json new file mode 100644 index 000000000000..f4e0b3cb7d26 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovaultwestus.vault.azure.net/keys/contosokek", + "provisioningState": "Succeeded" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Patch.json new file mode 100644 index 000000000000..e287c775953b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenterEncryptionSets_Patch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "encryptionSetName": "EncryptionWestUs", + "body": { + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/encryptionSets/EncryptionWestUs", + "name": "EncryptionWestUs", + "type": "Microsoft.DevCenter/devcenters/encryptionSets", + "properties": { + "devboxDisksEncryptionEnableStatus": "Enabled", + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokekwestus", + "provisioningState": "Accepted" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Create.json new file mode 100644 index 000000000000..26ce5856d165 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Create.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json new file mode 100644 index 000000000000..9a2a2d9848de --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithDisabledManagedNetworks.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Disabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithEncryption.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithEncryption.json new file mode 100644 index 000000000000..0368b838f71b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithEncryption.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "encryption": { + "customerManagedKeyEncryption": { + "keyEncryptionKeyIdentity": { + "identityType": "userAssignedIdentity", + "userAssignedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1" + }, + "keyEncryptionKeyUrl": "https://contosovault.vault.azure.net/keys/contosokek" + } + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithPlanId.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithPlanId.json new file mode 100644 index 000000000000..f4fbb75bed63 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithPlanId.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "planId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithRestrictedResourceUsage.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithRestrictedResourceUsage.json new file mode 100644 index 000000000000..cb69dbdae84e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithRestrictedResourceUsage.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter", + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "restrictedResourceTypes": [ + "Images", + "AttachedNetworks" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Disabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + }, + "restrictedResourceTypes": [ + "Images", + "AttachedNetworks" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Disabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + }, + "restrictedResourceTypes": [ + "Images", + "AttachedNetworks" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithUserIdentity.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithUserIdentity.json new file mode 100644 index 000000000000..8cd135873227 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_CreateWithUserIdentity.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "displayName": "ContosoDevCenter" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Delete.json new file mode 100644 index 000000000000..5b25f028fc78 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Get.json new file mode 100644 index 000000000000..4b73c7b247da --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "hidden-title": "ContosoDevCenter", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter", + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "devBoxProvisioningSettings": { + "installAzureMonitorAgentEnableStatus": "Enabled" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListByResourceGroup.json new file mode 100644 index 000000000000..142d003d60f3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListBySubscription.json new file mode 100644 index 000000000000..d1952eca7a26 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Patch.json new file mode 100644 index 000000000000..ae85cc0c0870 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevCenters_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "displayName": "ContosoDevCenter" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_Get.json new file mode 100644 index 000000000000..dcfa28d3ba35 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_Get.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..0a7816326699 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetByProjectCatalog.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..5f9ac3f8eee2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json new file mode 100644 index 000000000000..d0db7f6b7f3e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/devcenters/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..21842ffd1508 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentDefinitions_ListByProjectCatalog.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/myCatalog/environmentDefinitions/myEnvironmentDefinition", + "name": "myEnvironmentDefinition", + "type": "Microsoft.DevCenter/projects/catalogs/environmentDefinitions", + "properties": { + "description": "My sample environment definition.", + "parameters": [ + { + "id": "functionAppRuntime", + "name": "Function App Runtime", + "type": "string", + "required": true + }, + { + "id": "storageAccountType", + "name": "Storage Account Type", + "type": "string", + "required": true + }, + { + "id": "httpsOnly", + "name": "HTTPS only", + "type": "boolean", + "readOnly": true, + "required": true + } + ], + "templatePath": "azuredeploy.json", + "validationStatus": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Delete.json new file mode 100644 index 000000000000..4b0a9fa87b11 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Get.json new file mode 100644 index 000000000000..4d0b42977fe9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_List.json new file mode 100644 index 000000000000..ed16ab0c29ed --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Patch.json new file mode 100644 index 000000000000..acccbf9c0772 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Patch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "displayName": "Dev" + }, + "tags": { + "Owner": "superuser" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Put.json new file mode 100644 index 000000000000..9ede0f5b29ea --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/EnvironmentTypes_Put.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "tags": { + "Owner": "superuser" + }, + "properties": { + "displayName": "Dev" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "properties": { + "displayName": "Dev" + }, + "tags": { + "hidden-title": "Dev", + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Create.json new file mode 100644 index 000000000000..6d118ad8f6e6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery", + "body": { + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Delete.json new file mode 100644 index 000000000000..76bd1a878052 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Get.json new file mode 100644 index 000000000000..e1643e72ef72 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_List.json new file mode 100644 index 000000000000..34bd516074f9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Galleries_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/default", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "provisioningState": "Succeeded", + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/CentralGallery" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/ImageGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/SharedGallery", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_BuildImage.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_BuildImage.json new file mode 100644 index 000000000000..77766a49b069 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_BuildImage.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_CancelImageBuild.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_CancelImageBuild.json new file mode 100644 index 000000000000..a25fa1a4598a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_CancelImageBuild.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json new file mode 100644 index 000000000000..4f3f0cbe5ec6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetByProjectCatalog.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog", + "imageDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "latestBuild": { + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "status": "Running", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuild.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuild.json new file mode 100644 index 000000000000..33e2fadee135 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuild.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "type": "Microsoft.DevCenter/projects/catalogs/imageDefinitions/builds", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "status": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json new file mode 100644 index 000000000000..fd6d5ed2e02e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_GetImageBuildDetails.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "status": "Succeeded", + "taskGroups": [ + { + "name": "Provisioning", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "Provisioning", + "status": "Succeeded", + "displayName": "Provisioning", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "id": "e72eb35f-f406-42ec-8b93-7d18a9f7b059", + "logUri": "" + } + ] + }, + { + "name": "Customizations", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "vs2022", + "status": "Succeeded", + "displayName": "Install Visual Studio 2022", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "id": "e72eb35f-f406-42ec-8b93-7d18a9f7b059", + "logUri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7/logs/e72eb35f-f406-42ec-8b93-7d18a9f7b059" + } + ] + }, + { + "name": "Generalization", + "status": "Succeeded", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "tasks": [ + { + "name": "Generalization", + "status": "Succeeded", + "displayName": "Generalization", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z", + "logUri": "" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json new file mode 100644 index 000000000000..784043af3e2f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListByProjectCatalog.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "catalogName": "TeamCatalog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/catalogs/TeamCatalog/imagedefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/catalogs/imagedefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "latestBuild": { + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "status": "Running", + "startTime": "2020-11-18T18:25:02.224Z", + "endTime": "2020-11-18T18:25:12.952Z" + }, + "activeImageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "imageValidationStatus": "Failed", + "validationStatus": "Succeeded", + "imageValidationErrorDetails": { + "code": "400", + "message": "Validation failed" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json new file mode 100644 index 000000000000..28bb979b8058 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageDefinitions_ListImageBuildsByImageDefinition.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "imageDefinitionName": "DefaultDevImage", + "buildName": "0a28fc61-6f87-4611-8fe2-32df44ab93b7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog/imageDefinitions/DefaultDevImage/builds/0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "name": "0a28fc61-6f87-4611-8fe2-32df44ab93b7", + "type": "Microsoft.DevCenter/projects/catalogs/imageDefinitions/builds", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/versions/1.0.0" + }, + "status": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_Get.json new file mode 100644 index 000000000000..eda4183721a8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_GetByProject.json new file mode 100644 index 000000000000..7921939d3e39 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_GetByProject.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_List.json new file mode 100644 index 000000000000..84f40aca4f2c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_ListByProject.json new file mode 100644 index 000000000000..955558cde725 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ImageVersions_ListByProject.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoImageDefinition" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition/versions/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/project/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_Get.json new file mode 100644 index 000000000000..b1a458a0bc7f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_GetByProject.json new file mode 100644 index 000000000000..c618d9c9a82b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_GetByProject.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject", + "imageName": "~gallery~DefaultDevGallery~ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/project/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByDevCenter.json new file mode 100644 index 000000000000..902b43d106b9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByDevCenter.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByGallery.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByGallery.json new file mode 100644 index 000000000000..979d41510e0d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByGallery.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DevGallery" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByProject.json new file mode 100644 index 000000000000..aee9ea59d3a8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Images_ListByProject.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoBaseImage", + "name": "~gallery~DefaultDevGallery~ContosoBaseImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~catalog~DefaultCatalog~DefaultImage", + "name": "~catalog~DefaultCatalog~DefaultImage", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myProject/images/~gallery~DefaultDevGallery~ContosoImageDefinition", + "name": "~gallery~DefaultDevGallery~ContosoImageDefinition", + "type": "Microsoft.DevCenter/project/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Delete.json new file mode 100644 index 000000000000..68b509165506 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Get.json new file mode 100644 index 000000000000..7669fdc577d9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded", + "healthCheckStatus": "Passed" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_GetHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_GetHealthDetails.json new file mode 100644 index 000000000000..c58b9da05cdd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_GetHealthDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/eastusnetwork/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..048256ca60b5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListBySubscription.json new file mode 100644 index 000000000000..8c51d0d3b56d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnection", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListHealthDetails.json new file mode 100644 index 000000000000..5a04885d7cfd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListHealthDetails.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..2b634afaaf5a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Dev Box Service", + "endpoints": [ + { + "domainName": "devbox.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Intune", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Cloud PC", + "endpoints": [ + { + "domainName": "rdweb.wvd.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Patch.json new file mode 100644 index 000000000000..58dd00d8c61a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainPassword": "New Password value for user" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Put.json new file mode 100644 index 000000000000..e4817242c917 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_Put.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "domainPassword": "Password value for user", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_RunHealthChecks.json new file mode 100644 index 000000000000..3d536b53dd51 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/NetworkConnections_RunHealthChecks.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatus_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..214554208a73 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/OperationStatus_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus3", + "operationId": "3fa1a29d-e807-488d-81d1-f1c5456a08cd" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 100 + } + }, + "202": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 99 + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "default": { + "body": { + "error": { + "code": "OperationNotFound", + "message": "The requested async operation was not found" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Operations_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Operations_Get.json new file mode 100644 index 000000000000..77568f6276a8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Operations_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevCenter/devcenters/write", + "display": { + "provider": "Microsoft DevTest Center", + "resource": "Microsoft DevTest Center devcenter resource", + "operation": "write" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Create.json new file mode 100644 index 000000000000..3b68f53c66f9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Create.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "tier": "Standard" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "tier": "Standard", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "tier": "Standard", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Delete.json new file mode 100644 index 000000000000..72d2e684fdb5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Get.json new file mode 100644 index 000000000000..80647b43069e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "tier": "Standard", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_List.json new file mode 100644 index 000000000000..0fa91ad24265 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberType": "User", + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "tier": "Standard", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Patch.json new file mode 100644 index 000000000000..099fd6ca0e81 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/PlanMembers_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "memberName": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "name": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan/members/d702f662-b3f2-4796-9e8c-13c22378ced3", + "type": "Microsoft.DevCenter/plans/members", + "tags": { + "CostCode": "12345" + }, + "properties": { + "memberId": "d702f662-b3f2-4796-9e8c-13c22378ced3", + "memberType": "User", + "tier": "Standard", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Create.json new file mode 100644 index 000000000000..dbd5fed59f1d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Create.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": {}, + "sku": { + "name": "Preview" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "hidden-title": "ContosoPlan", + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Delete.json new file mode 100644 index 000000000000..ee2b2da12a6c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Get.json new file mode 100644 index 000000000000..3bd9546f82e9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListByResourceGroup.json new file mode 100644 index 000000000000..f296f17a660c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/plans/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListBySubscription.json new file mode 100644 index 000000000000..0cc19573b540 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Patch.json new file mode 100644 index 000000000000..107412bb40e4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Plans_Patch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "planName": "ContosoPlan", + "body": { + "sku": { + "name": "Preview" + }, + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/ContosoPlan", + "name": "ContosoPlan", + "type": "Microsoft.DevCenter/plans", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Preview" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..41a9b03f6afd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "poolName" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..3e76c21a6098 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_GetUnhealthyStatus.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_GetUnhealthyStatus.json new file mode 100644 index 000000000000..a91ac892944a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_GetUnhealthyStatus.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Unhealthy", + "healthStatusDetails": [ + { + "code": "NetworkConnectionUnhealthy", + "message": "The Pool's Network Connection is in an unhealthy state. Check the Network Connection's health status for more details." + }, + { + "code": "ImageValidationFailed", + "message": "Image validation has failed. Check the Dev Box Definition's image validation status for more details." + }, + { + "code": "IntuneValidationFailed", + "message": "Intune license validation has failed. The tenant does not have a valid Intune license." + } + ], + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..104fb5e11902 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_List.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Patch.json new file mode 100644 index 000000000000..c968b6b81b0b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Patch.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "devBoxDefinitionName": "WebDevBox2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox2", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Put.json new file mode 100644 index 000000000000..b6d8b329ab69 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_Put.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithManagedNetwork.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithManagedNetwork.json new file mode 100644 index 000000000000..efca4f1f3e9a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithManagedNetwork.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "managedNetwork", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Managed", + "managedVirtualNetworkRegions": [ + "centralus" + ] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json new file mode 100644 index 000000000000..4163046f55c2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_PutWithValueDevBoxDefinition.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Healthy", + "devBoxCount": 1, + "provisioningState": "Succeeded", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "displayName": "Developer Pool", + "devBoxDefinitionType": "Value", + "devBoxDefinitionName": "", + "devBoxDefinition": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/projects/DevProject/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + } + }, + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "stopOnNoConnect": { + "status": "Enabled", + "gracePeriodMinutes": 120 + }, + "healthStatus": "Pending", + "provisioningState": "Created", + "singleSignOnStatus": "Disabled", + "virtualNetworkType": "Unmanaged", + "managedVirtualNetworkRegions": [] + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_RunHealthChecks.json new file mode 100644 index 000000000000..f158ae0e35a6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Pools_RunHealthChecks.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json new file mode 100644 index 000000000000..57bbecbf6dda --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json new file mode 100644 index 000000000000..3474f3e9ec74 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectAllowedEnvironmentTypes_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json new file mode 100644 index 000000000000..04b24c7b4fe6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogEnvironmentDefinitions_GetErrorDetails.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "myCatalog", + "environmentDefinitionName": "myEnvironmentDefinition" + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "code": "ParameterValueInvalid", + "message": "Expected parameter value for 'InstanceCount' to be integer but found the string 'test'." + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Connect.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Connect.json new file mode 100644 index 000000000000..e39f67d52d5f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Connect.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateAdo.json new file mode 100644 index 000000000000..e8efe15c3c7f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateAdo.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateGitHub.json new file mode 100644 index 000000000000..30bbda99457d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_CreateGitHub.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 0, + "updated": 0, + "unchanged": 0, + "removed": 0, + "validationErrors": 0, + "synchronizationErrors": 0, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Accepted", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Delete.json new file mode 100644 index 000000000000..73f40ec849ee --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Get.json new file mode 100644 index 000000000000..a5edcbfcd77c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Get.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1, + "syncedCatalogItemTypes": [ + "EnvironmentDefinition" + ] + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json new file mode 100644 index 000000000000..25c467b4f5b9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_GetSyncErrorDetails.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "operationError": { + "code": "Conflict", + "message": "The source control credentials could not be validated successfully." + }, + "conflicts": [ + { + "path": "/Environments/Duplicate/manifest.yaml", + "name": "DuplicateEnvironmentName" + } + ], + "errors": [ + { + "path": "/Environments/Invalid/manifest.yaml", + "errorDetails": [ + { + "code": "ParseError", + "message": "Schema Error Within Catalog Item: Missing Name" + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_List.json new file mode 100644 index 000000000000..4795acb14650 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/Contoso/catalogs", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Patch.json new file mode 100644 index 000000000000..8a344912e8a0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Patch.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/projects/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncStats": { + "added": 1, + "updated": 1, + "unchanged": 1, + "removed": 1, + "validationErrors": 1, + "synchronizationErrors": 1 + }, + "lastConnectionTime": "2020-11-18T18:28:00.314Z", + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "connectionState": "Connected", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Sync.json new file mode 100644 index 000000000000..e39f67d52d5f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectCatalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Delete.json new file mode 100644 index 000000000000..f143abafc4be --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Get.json new file mode 100644 index 000000000000..3c455ab1f0e2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_List.json new file mode 100644 index 000000000000..0a41c95437c0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Patch.json new file mode 100644 index 000000000000..2c30d447a304 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Patch.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 1, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Put.json new file mode 100644 index 000000000000..7338bc155d91 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectEnvironmentTypes_Put.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "displayName": "DevTest", + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "environmentCount": 0, + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "hidden-title": "Dev", + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Delete.json new file mode 100644 index 000000000000..7e24246b38c5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "projectPolicyName": "DevOnlyResources" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Get.json new file mode 100644 index 000000000000..9ef348338dc3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "projectPolicyName": "DevOnlyResources" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/projectPolicies/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/projectpolicies", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_ListByDevCenter.json new file mode 100644 index 000000000000..3a65ae847c6b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_ListByDevCenter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/projectPolicies/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/projectpolicies", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Patch.json new file mode 100644 index 000000000000..6ae6c5503eb2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Patch.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "projectPolicyName": "DevOnlyResources", + "body": { + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/projectPolicies/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/projectpolicies", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-02-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Put.json new file mode 100644 index 000000000000..157b79eb2905 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/ProjectPolicies_Put.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff1", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "projectPolicyName": "DevOnlyResources", + "body": { + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/projectPolicies/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/projectpolicies", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/projectPolicies/DevOnlyResources", + "name": "DevOnlyResources", + "type": "Microsoft.DevCenter/devcenters/projectpolicies", + "properties": { + "resourcePolicies": [ + { + "resources": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-westus3" + } + ], + "scopes": [ + "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff1/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject" + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Delete.json new file mode 100644 index 000000000000..95034c6a00fa --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Get.json new file mode 100644 index 000000000000..60ae7867807b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Get.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_GetInheritedSettings.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_GetInheritedSettings.json new file mode 100644 index 000000000000..b34097ebd813 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_GetInheritedSettings.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "projectCatalogSettings": { + "catalogItemSyncEnableStatus": "Enabled" + }, + "networkSettings": { + "microsoftHostedNetworkEnableStatus": "Enabled" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListByResourceGroup.json new file mode 100644 index 000000000000..c03b2952d974 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListBySubscription.json new file mode 100644 index 000000000000..4e819880fbd1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Patch.json new file mode 100644 index 000000000000..0cf7adaf15b9 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Patch.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "description": "This is my first project.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + } + }, + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project. Very exciting.", + "displayName": "Dev", + "catalogSettings": { + "catalogItemSyncTypes": [ + "EnvironmentDefinition" + ] + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "displayName": "Dev", + "CostCenter": "R&D" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Put.json new file mode 100644 index 000000000000..53517b8be848 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_Put.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "displayName": "Dev" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "hidden-title": "Dev", + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json new file mode 100644 index 000000000000..b74d97ac325e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Projects_PutWithMaxDevBoxPerUser.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3 + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json new file mode 100644 index 000000000000..9f9e192fd70b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_CreateDailyShutdownPoolSchedule.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Delete.json new file mode 100644 index 000000000000..046ffe3438ef --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Get.json new file mode 100644 index 000000000000..33413bc15789 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_ListByPool.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_ListByPool.json new file mode 100644 index 000000000000..22160fae339c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_ListByPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Patch.json new file mode 100644 index 000000000000..df1566037353 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Schedules_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "time": "18:00" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListByProject.json new file mode 100644 index 000000000000..4784fac46161 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "myProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListBySubscription.json new file mode 100644 index 000000000000..fbfcfa850f1e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Skus_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Usages_ListByLocation.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Usages_ListByLocation.json new file mode 100644 index 000000000000..4f1d8ec1597b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/examples/Usages_ListByLocation.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "currentValue": 2, + "limit": 8, + "unit": "Count", + "name": { + "value": "devcenters" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/devcenters" + }, + { + "currentValue": 5, + "limit": 30, + "unit": "Count", + "name": { + "value": "projects" + }, + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/Microsoft.DevCenter/locations/westus/quotas/projects" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/vdi.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/vdi.json new file mode 100644 index 000000000000..cc5442ff80d4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/preview/2024-10-01-preview/vdi.json @@ -0,0 +1,1989 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-10-01-preview", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/skus": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "SKUs" + ], + "description": "Lists the Microsoft.DevCenter SKUs available in a subscription", + "operationId": "Skus_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_ListBySubscription": { + "$ref": "./examples/Skus_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Lists pools for a project", + "operationId": "Pools_ListByProject", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Pools_ListByProject": { + "$ref": "./examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Gets a machine pool", + "operationId": "Pools_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/Pools_Get.json" + }, + "Pools_GetUnhealthyStatus": { + "$ref": "./examples/Pools_GetUnhealthyStatus.json" + } + } + }, + "put": { + "tags": [ + "Pools" + ], + "description": "Creates or updates a machine pool", + "operationId": "Pools_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/Pools_Put.json" + }, + "Pools_CreateOrUpdateWithManagedNetwork": { + "$ref": "./examples/Pools_PutWithManagedNetwork.json" + }, + "Pools_CreateOrUpdateWithValueDevBoxDefinition": { + "$ref": "./examples/Pools_PutWithValueDevBoxDefinition.json" + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "description": "Partially updates a machine pool", + "operationId": "Pools_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/Pools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Pools" + ], + "description": "Deletes a machine pool", + "operationId": "Pools_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "./examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks": { + "post": { + "tags": [ + "Pools" + ], + "description": "Triggers a refresh of the pool status.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "operationId": "Pools_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating pool status refresh.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_RefreshStatus": { + "$ref": "./examples/Pools_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Lists schedules for a pool", + "operationId": "Schedules_ListByPool", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Schedules_ListByPool": { + "$ref": "./examples/Schedules_ListByPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Gets a schedule resource.", + "operationId": "Schedules_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_GetByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + }, + "put": { + "tags": [ + "Schedules" + ], + "description": "Creates or updates a Schedule.", + "operationId": "Schedules_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task", + "required": true, + "schema": { + "$ref": "#/definitions/Schedule" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_CreateDailyShutdownPoolSchedule": { + "$ref": "./examples/Schedules_CreateDailyShutdownPoolSchedule.json" + } + } + }, + "patch": { + "tags": [ + "Schedules" + ], + "description": "Partially updates a Scheduled.", + "operationId": "Schedules_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Update": { + "$ref": "./examples/Schedules_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Schedules" + ], + "description": "Deletes a Scheduled.", + "operationId": "Schedules_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Schedules_Delete": { + "$ref": "./examples/Schedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a subscription", + "operationId": "NetworkConnections_ListBySubscription", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListBySubscription": { + "$ref": "./examples/NetworkConnections_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a resource group", + "operationId": "NetworkConnections_ListByResourceGroup", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListByResourceGroup": { + "$ref": "./examples/NetworkConnections_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets a network connection resource", + "operationId": "NetworkConnections_Get", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Get": { + "$ref": "./examples/NetworkConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "Network Connections" + ], + "description": "Creates or updates a Network Connections resource", + "operationId": "NetworkConnections_CreateOrUpdate", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_CreateOrUpdate": { + "$ref": "./examples/NetworkConnections_Put.json" + } + } + }, + "patch": { + "tags": [ + "Network Connections" + ], + "description": "Partially updates a Network Connection", + "operationId": "NetworkConnections_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnectionUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Update": { + "$ref": "./examples/NetworkConnections_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Network Connections" + ], + "description": "Deletes a Network Connections resource", + "operationId": "NetworkConnections_Delete", + "parameters": [], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Delete": { + "$ref": "./examples/NetworkConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists health check status details", + "operationId": "NetworkConnections_ListHealthDetails", + "parameters": [], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListHealthDetails": { + "$ref": "./examples/NetworkConnections_ListHealthDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks/latest": { + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets health check status details.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_GetHealthDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_GetHealthDetails": { + "$ref": "./examples/NetworkConnections_GetHealthDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks": { + "post": { + "tags": [ + "Network Connection" + ], + "description": "Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "202": { + "description": "Accepted. Initiating health checks.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkConnections_RunHealthChecks": { + "$ref": "./examples/NetworkConnections_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/outboundNetworkDependenciesEndpoints": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connection" + ], + "operationId": "NetworkConnections_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.", + "parameters": [], + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of outbound network dependencies.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuListResult": { + "description": "Results of the Microsoft.DevCenter SKU list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "commonDefinitions.json#/definitions/DevCenterSku" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Pool": { + "description": "A pool of Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Pool properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties" + } + } + }, + "PoolUpdateProperties": { + "description": "Properties of a Pool. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "$ref": "#/definitions/PoolDevBoxDefinitionType" + }, + "devBoxDefinitionName": { + "description": "Name of a Dev Box definition in parent Project of this Pool. Will be ignored if devBoxDefinitionType is Value.", + "type": "string" + }, + "devBoxDefinition": { + "description": "A definition of the machines that are created from this Pool. Will be ignored if devBoxDefinitionType is Reference or not provided.", + "$ref": "#/definitions/PoolDevBoxDefinition" + }, + "networkConnectionName": { + "description": "Name of a Network Connection in parent Project of this Pool", + "type": "string" + }, + "licenseType": { + "description": "Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.", + "$ref": "#/definitions/LicenseType" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + }, + "stopOnNoConnect": { + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnNoConnectConfiguration" + }, + "singleSignOnStatus": { + "description": "Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.", + "$ref": "#/definitions/SingleSignOnStatus" + }, + "displayName": { + "type": "string", + "description": "The display name of the pool." + }, + "virtualNetworkType": { + "description": "Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.", + "$ref": "#/definitions/VirtualNetworkType" + }, + "managedVirtualNetworkRegions": { + "type": "array", + "description": "The regions of the managed virtual network (required when managedNetworkType is Managed).", + "items": { + "type": "string" + } + } + } + }, + "PoolProperties": { + "type": "object", + "description": "Properties of a Pool", + "allOf": [ + { + "$ref": "#/definitions/PoolUpdateProperties" + } + ], + "properties": { + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/HealthStatus", + "readOnly": true + }, + "healthStatusDetails": { + "description": "Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state", + "type": "array", + "items": { + "$ref": "#/definitions/HealthStatusDetail" + }, + "x-ms-identifiers": [ + "code" + ], + "readOnly": true + }, + "devBoxCount": { + "description": "Indicates the number of provisioned Dev Boxes in this pool.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "devBoxDefinitionName", + "networkConnectionName", + "licenseType", + "localAdministrator" + ] + }, + "PoolDevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created from the Pool.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Sku" + }, + "activeImageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + } + }, + "HealthStatus": { + "description": "Health status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "HealthStatusDetail": { + "type": "object", + "description": "Pool health status detail.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the issue.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A message describing the issue, intended to be suitable for display in a user interface", + "readOnly": true + } + } + }, + "LicenseType": { + "description": "License Types", + "enum": [ + "Windows_Client" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "LocalAdminStatus": { + "description": "Local Administrator enable or disable status. Indicates whether owners of Dev Boxes are added as local administrators on the Dev Box.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true + } + }, + "SingleSignOnStatus": { + "description": "SingleSignOn (SSO) enable or disable status. Indicates whether Dev Boxes in the Pool will have SSO enabled or disabled.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "SingleSignOnStatus", + "modelAsString": true + } + }, + "VirtualNetworkType": { + "description": "Indicates a pool uses a Virtual Network managed by Microsoft (Managed), or a customer provided Network (Unmanaged).", + "type": "string", + "enum": [ + "Managed", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": true + } + }, + "PoolDevBoxDefinitionType": { + "description": "Indicates if the pool is created from an existing Dev Box Definition or if one is provided directly.", + "type": "string", + "enum": [ + "Reference", + "Value" + ], + "x-ms-enum": { + "name": "PoolDevBoxDefinitionType", + "modelAsString": true + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.", + "$ref": "#/definitions/StopOnDisconnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.", + "type": "integer", + "format": "int32" + } + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true + } + }, + "StopOnNoConnectConfiguration": { + "type": "object", + "description": "Stop on no connect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Enables the feature to stop a started Dev Box when it has not been connected to, once the grace period has lapsed.", + "$ref": "#/definitions/StopOnNoConnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box if no connection is made.", + "type": "integer", + "format": "int32" + } + } + }, + "StopOnNoConnectEnableStatus": { + "description": "Stop on no connect enable or disable status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnNoConnectEnableStatus", + "modelAsString": true + } + }, + "PoolListResult": { + "description": "Results of the machine pool list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PoolUpdate": { + "description": "The pool properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolUpdateProperties", + "description": "Properties of a pool to be updated." + } + } + }, + "ImageReference": { + "type": "object", + "description": "Image reference information", + "properties": { + "id": { + "description": "Image ID, or Image version ID. When Image ID is provided, its latest version will be used.", + "type": "string" + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use." + } + } + }, + "ImageValidationStatus": { + "description": "Image validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed", + "TimedOut" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageValidationStatus", + "modelAsString": true + } + }, + "ImageValidationErrorDetails": { + "type": "object", + "description": "Image validation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "CatalogResourceValidationStatus": { + "description": "Catalog resource validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogResourceValidationStatus", + "modelAsString": true + } + }, + "CatalogResourceValidationErrorDetails": { + "type": "object", + "description": "List of validator error details. Populated when changes are made to the resource or its dependent resources that impact the validity of the Catalog resource.", + "properties": { + "errors": { + "description": "Errors associated with resources synchronized from the catalog.", + "type": "array", + "items": { + "$ref": "#/definitions/CatalogErrorDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "CatalogErrorDetails": { + "type": "object", + "description": "Catalog error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "NetworkConnection": { + "type": "object", + "description": "Network related settings", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Network Connection", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProperties" + } + } + }, + "NetworkConnectionUpdate": { + "description": "The network connection properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkConnectionUpdateProperties", + "description": "Properties of a network connection resource to be updated." + } + } + }, + "NetworkConnectionUpdateProperties": { + "description": "Properties of network connection. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "subnetId": { + "description": "The subnet to attach Virtual Machines to", + "type": "string" + }, + "domainName": { + "description": "Active Directory domain name", + "type": "string" + }, + "organizationUnit": { + "description": "Active Directory domain Organization Unit (OU)", + "type": "string" + }, + "domainUsername": { + "description": "The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.", + "type": "string" + }, + "domainPassword": { + "description": "The password for the account used to join domain", + "type": "string", + "x-ms-secret": true + } + } + }, + "NetworkProperties": { + "description": "Network properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkConnectionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "healthCheckStatus": { + "description": "Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "networkingResourceGroupName": { + "description": "The name for resource group where NICs will be placed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domainJoinType": { + "description": "AAD Join type.", + "$ref": "#/definitions/DomainJoinType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "subnetId", + "domainJoinType" + ] + }, + "NetworkConnectionListResult": { + "description": "Result of the network connection list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DomainJoinType": { + "description": "Active Directory join type", + "enum": [ + "HybridAzureADJoin", + "AzureADJoin", + "None" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true + } + }, + "HealthCheckStatus": { + "description": "Health check status values", + "enum": [ + "Unknown", + "Pending", + "Running", + "Passed", + "Warning", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthCheckStatus", + "modelAsString": true + } + }, + "HealthCheckStatusDetails": { + "description": "Health Check details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Health check status details properties.", + "$ref": "#/definitions/HealthCheckStatusDetailsProperties" + } + } + }, + "HealthCheckStatusDetailsProperties": { + "description": "Health Check properties.", + "type": "object", + "properties": { + "startDateTime": { + "type": "string", + "description": "Start time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "End time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "healthChecks": { + "description": "Details for each health check item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheck" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "HealthCheck": { + "description": "An individual health check item", + "type": "object", + "properties": { + "status": { + "description": "The status of the health check item.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "displayName": { + "description": "The display name of this health check item.", + "type": "string", + "readOnly": true + }, + "startDateTime": { + "description": "Start time of health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "description": "End time of the health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "errorType": { + "description": "The type of error that occurred during this health check.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action to fix the corresponding error.", + "type": "string", + "readOnly": true + }, + "additionalDetails": { + "description": "Additional details about the health check or the recommended action.", + "type": "string", + "readOnly": true + } + } + }, + "HealthCheckStatusDetailsListResult": { + "description": "Result of the network health check list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheckStatusDetails" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [ + "category" + ], + "description": "The collection of outbound network dependency endpoints returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "properties": { + "category": { + "type": "string", + "readOnly": true, + "description": "The type of service that the agent connects to." + }, + "endpoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ], + "description": "The endpoints for this service for which the agent requires outbound access." + } + }, + "description": "A collection of related endpoints from the same service for which the agent requires outbound access." + }, + "EndpointDependency": { + "type": "object", + "properties": { + "domainName": { + "type": "string", + "readOnly": true, + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Human-readable supplemental information about the dependency and when it is applicable." + }, + "endpointDetails": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "x-ms-identifiers": [], + "description": "The list of connection details for this endpoint." + } + }, + "description": "A domain name and connection details used to access a dependency." + }, + "EndpointDetail": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The port an endpoint is connected to." + } + }, + "description": "Details about the connection between the Batch service and the endpoint." + }, + "Schedule": { + "type": "object", + "description": "Represents a Schedule to execute a task.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Schedule resource", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleProperties" + } + } + }, + "ScheduleUpdate": { + "description": "The schedule properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleUpdateProperties", + "description": "Properties of a schedule resource to be updated." + } + } + }, + "ScheduleUpdateProperties": { + "description": "Updatable properties of a Schedule.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType" + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency" + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string" + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string" + }, + "state": { + "description": "Indicates whether or not this scheduled task is enabled.", + "$ref": "#/definitions/ScheduleEnableStatus" + } + } + }, + "ScheduleProperties": { + "description": "The Schedule properties defining when and what to execute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "type", + "frequency", + "timeZone", + "time" + ] + }, + "ScheduleListResult": { + "description": "Result of the schedule list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true + } + }, + "ScheduleEnableStatus": { + "description": "Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleEnableStatus", + "modelAsString": true + } + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "NetworkConnectionName": { + "name": "networkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Network Connection that can be applied to a Pool.", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$", + "minLength": 3, + "maxLength": 63 + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schedule that uniquely identifies it.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[-\\w]+$", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/readme.md b/specification/devcenter/resource-manager/readme.md index 552e6d6dca54..39aa62c0f72f 100644 --- a/specification/devcenter/resource-manager/readme.md +++ b/specification/devcenter/resource-manager/readme.md @@ -27,10 +27,25 @@ These are the global settings for devcenter. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2024-08 +tag: package-preview-2024-10 ``` +### Tag: package-preview-2024-10 + +These settings apply only when `--tag=package-preview-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-10' +input-file: + - Microsoft.DevCenter/preview/2024-10-01-preview/commonDefinitions.json + - Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json + - Microsoft.DevCenter/preview/2024-10-01-preview/vdi.json +suppressions: + - code: PatchBodyParametersSchema + from: vdi.json + reason: Patch Body comes from common-types v5 Sku object. Keeping here for consistency with existing parts of API to avoid breaking customers. +``` + ### Tag: package-preview-2024-08 These settings apply only when `--tag=package-preview-2024-08` is specified on the command line. From 75efbd8fa0860a713074a2c9e8147397e84de026 Mon Sep 17 00:00:00 2001 From: Minh-Anh Phan <111523473+minhanh-phan@users.noreply.github.com> Date: Mon, 7 Oct 2024 11:12:24 -0700 Subject: [PATCH 050/101] Update Swagger and TypeSpec for details property (#30632) --- .../models/completions/azure_content_filtering.tsp | 2 +- .../inference/preview/2024-04-01-preview/inference.json | 3 +-- .../inference/preview/2024-04-01-preview/inference.yaml | 1 - .../inference/preview/2024-05-01-preview/inference.json | 3 +-- .../inference/preview/2024-05-01-preview/inference.yaml | 1 - .../inference/preview/2024-07-01-preview/inference.json | 3 +-- .../inference/preview/2024-07-01-preview/inference.yaml | 1 - .../inference/preview/2024-08-01-preview/inference.json | 3 +-- 8 files changed, 5 insertions(+), 12 deletions(-) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp index 233b79d5310a..3fe4eca0af11 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions/azure_content_filtering.tsp @@ -191,5 +191,5 @@ model ContentFilterDetailedResults { ...FilteredResultBase; @doc("The collection of detailed blocklist result information.") - details: ContentFilterBlocklistIdResult[]; + details?: ContentFilterBlocklistIdResult[]; } diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json index f36ce2a3a63d..fb04fff1e0e0 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.json @@ -3005,8 +3005,7 @@ } ], "required": [ - "filtered", - "details" + "filtered" ] }, "promptFilterResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.yaml index 6a53dd64d833..a82e43d648ae 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/inference.yaml @@ -1973,7 +1973,6 @@ components: type: array required: - filtered - - details promptFilterResult: type: object description: Content filtering results for a single prompt in the request. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json index 85224e273865..77580ea9ac6c 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.json @@ -3465,8 +3465,7 @@ } ], "required": [ - "filtered", - "details" + "filtered" ] }, "promptFilterResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.yaml index 175e7cf979c9..99bc64dfb4d5 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.yaml @@ -2238,7 +2238,6 @@ components: type: array required: - filtered - - details promptFilterResult: type: object description: Content filtering results for a single prompt in the request. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.json index 26517d96b112..c634feab47f7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.json @@ -3465,8 +3465,7 @@ } ], "required": [ - "filtered", - "details" + "filtered" ] }, "promptFilterResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.yaml index 0d0a1c8245a2..14ad3e74e4ad 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.yaml @@ -2238,7 +2238,6 @@ components: type: array required: - filtered - - details promptFilterResult: type: object description: Content filtering results for a single prompt in the request. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.json index fbe7bcc90477..36e4d192fef6 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.json @@ -3251,8 +3251,7 @@ } ], "required": [ - "filtered", - "details" + "filtered" ] }, "promptFilterResult": { From 191c76349cdbc840567a9f1b2cbae50fd57bc1b9 Mon Sep 17 00:00:00 2001 From: wiboris <54044985+wiboris@users.noreply.github.com> Date: Mon, 7 Oct 2024 13:42:43 -0700 Subject: [PATCH 051/101] updating typespec to 2024-07-01.20.0 api (#30839) --- specification/batch/Azure.Batch/client.tsp | 17 +- .../Applications_GetApplication.json | 2 +- .../Applications_ListApplications.json | 2 +- .../JobSchedules_CreateJobSchedule_Basic.json | 2 +- ...obSchedules_CreateJobSchedule_Complex.json | 12 +- .../JobSchedules_DeleteJobSchedule.json | 2 +- .../JobSchedules_DisableJobSchedule.json | 2 +- .../JobSchedules_EnableJobSchedule.json | 2 +- .../JobSchedules_GetJobSchedule.json | 2 +- .../JobSchedules_JobScheduleExists.json | 2 +- .../JobSchedules_ListJobSchedules.json | 2 +- .../JobSchedules_ReplaceJobSchedule.json | 2 +- .../JobSchedules_TerminateJobSchedule.json | 2 +- .../JobSchedules_UpdateJobSchedule.json | 2 +- .../Jobs_CreateJob_Basic.json | 2 +- .../Jobs_CreateJob_Complex.json | 12 +- .../Jobs_DeleteJob.json | 2 +- .../Jobs_DisableJob.json | 2 +- .../Jobs_EnableJob.json | 2 +- .../Jobs_GetJob.json | 2 +- .../Jobs_GetJobTaskCounts.json | 2 +- ...istJobPreparationAndReleaseTaskStatus.json | 4 +- .../Jobs_ListJobs.json | 2 +- .../Jobs_ListJobsFromSchedule.json | 2 +- .../Jobs_ReplaceJob.json | 2 +- .../Jobs_TerminateJob.json | 2 +- .../Jobs_UpdateJob.json | 2 +- .../2024-07-01.20.0/Node_DeallocateNode.json | 18 + .../2024-07-01.20.0/Node_StartNode.json | 15 + .../Nodes_CreateNodeUser.json | 2 +- .../Nodes_DeleteNodeFile.json | 2 +- .../Nodes_DeleteNodeUser.json | 2 +- .../Nodes_DisableNodeScheduling.json | 2 +- .../Nodes_EnableNodeScheduling.json | 2 +- .../Nodes_GetNode.json | 2 +- .../Nodes_GetNodeExtension.json | 2 +- .../Nodes_GetNodeFile.json | 2 +- .../Nodes_GetNodeFileProperties.json | 2 +- .../Nodes_GetNodeRemoteLoginSettings.json | 2 +- .../Nodes_ListNodeExtensions.json | 2 +- .../Nodes_ListNodeFiles.json | 2 +- .../Nodes_ListNodes.json | 2 +- .../2024-07-01.20.0/Nodes_NodeReimage.json | 18 + .../Nodes_RebootNode.json | 2 +- .../Nodes_ReplaceNodeUser.json | 2 +- .../Nodes_UploadNodeLogs.json | 2 +- ...ools_CreatePool_AcceleratedNetworking.json | 2 +- .../Pools_CreatePool_MountConfiguration.json | 2 +- .../Pools_CreatePool_OSDisk.json | 2 +- .../Pools_CreatePool_ResourceTags.json | 2 +- .../Pools_CreatePool_SecurityProfile.json | 2 +- ...reatePool_VirtualMachineConfiguration.json | 2 +- ...ualMachineConfigurationWithContainers.json | 2 +- ...ualMachineConfigurationWithExtensions.json | 2 +- ...igurationWithServiceArtifactReference.json | 2 +- .../Pools_DeletePool.json | 2 +- .../Pools_DisablePoolAutoScale.json | 2 +- .../Pools_EnablePoolAutoscale.json | 2 +- .../Pools_EvaluatePoolAutoscale.json | 2 +- .../Pools_GetPool_AcceleratedNetworking.json | 2 +- .../Pools_GetPool_Basic.json | 2 +- .../Pools_GetPool_SecurityProfile.json | 2 +- ...ualMachineConfigurationWithExtensions.json | 2 +- ...VirtualMachineConfigurationWithOSDisk.json | 2 +- ...igurationWithServiceArtifactReference.json | 2 +- .../Pools_ListPoolNodeCounts.json | 14 +- .../Pools_ListPoolUsageMetrics.json | 2 +- .../Pools_ListPools_Basic.json | 4 +- .../Pools_ListSupportedImages.json | 2 +- .../Pools_PoolExists.json | 2 +- .../Pools_RemoveNodes.json | 2 +- .../Pools_ReplacePoolProperties.json | 2 +- .../Pools_ResizePool.json | 2 +- .../Pools_StopPoolResize.json | 2 +- .../Pools_UpdatePool.json | 2 +- .../Tasks_CreateTaskCollection_Basic.json | 2 +- .../Tasks_CreateTaskCollection_Complex.json | 2 +- .../Tasks_CreateTask_Basic.json | 2 +- .../Tasks_CreateTask_ContainerSettings.json | 2 +- ...sk_ContainerSettingsWithDataIsolation.json | 33 + ...ngsWithDataIsolation_DuplicateSources.json | 37 + .../Tasks_CreateTask_ExitConditions.json | 2 +- .../Tasks_CreateTask_RequiredSlots.json | 2 +- .../Tasks_DeleteTask.json | 2 +- .../Tasks_DeleteTaskFile.json | 2 +- .../Tasks_GetTask.json | 2 +- .../Tasks_GetTaskFile.json | 2 +- .../Tasks_GetTaskFileProperties.json | 2 +- .../Tasks_ListSubTasks.json | 2 +- .../Tasks_ListTaskFiles.json | 2 +- .../Tasks_ListTasks.json | 2 +- .../Tasks_ReactivateTask.json | 2 +- .../Tasks_ReplaceTask.json | 2 +- .../Tasks_TerminateTask.json | 2 +- specification/batch/Azure.Batch/main.tsp | 4 +- specification/batch/Azure.Batch/models.tsp | 194 +- specification/batch/Azure.Batch/routes.tsp | 114 +- .../batch/Azure.Batch/tspconfig.yaml | 2 +- .../preview/2024-07-01.20.0/BatchService.json | 16615 ++++++++++++++++ .../examples/Applications_GetApplication.json | 22 + .../Applications_ListApplications.json | 25 + .../JobSchedules_CreateJobSchedule_Basic.json | 24 + ...obSchedules_CreateJobSchedule_Complex.json | 132 + .../JobSchedules_DeleteJobSchedule.json | 14 + .../JobSchedules_DisableJobSchedule.json | 14 + .../JobSchedules_EnableJobSchedule.json | 14 + .../examples/JobSchedules_GetJobSchedule.json | 48 + .../JobSchedules_JobScheduleExists.json | 15 + .../JobSchedules_ListJobSchedules.json | 79 + .../JobSchedules_ReplaceJobSchedule.json | 30 + .../JobSchedules_TerminateJobSchedule.json | 14 + .../JobSchedules_UpdateJobSchedule.json | 30 + .../examples/Jobs_CreateJob_Basic.json | 20 + .../examples/Jobs_CreateJob_Complex.json | 124 + .../examples/Jobs_DeleteJob.json | 14 + .../examples/Jobs_DisableJob.json | 17 + .../examples/Jobs_EnableJob.json | 14 + .../2024-07-01.20.0/examples/Jobs_GetJob.json | 45 + .../examples/Jobs_GetJobTaskCounts.json | 31 + ...istJobPreparationAndReleaseTaskStatus.json | 42 + .../examples/Jobs_ListJobs.json | 46 + .../examples/Jobs_ListJobsFromSchedule.json | 47 + .../examples/Jobs_ReplaceJob.json | 24 + .../examples/Jobs_TerminateJob.json | 17 + .../examples/Jobs_UpdateJob.json | 24 + .../examples/Node_DeallocateNode.json | 18 + .../examples/Node_StartNode.json | 15 + .../examples/Nodes_CreateNodeUser.json | 21 + .../examples/Nodes_DeleteNodeFile.json | 17 + .../examples/Nodes_DeleteNodeUser.json | 16 + .../examples/Nodes_DisableNodeScheduling.json | 18 + .../examples/Nodes_EnableNodeScheduling.json | 15 + .../examples/Nodes_GetNode.json | 54 + .../examples/Nodes_GetNodeExtension.json | 37 + .../examples/Nodes_GetNodeFile.json | 23 + .../examples/Nodes_GetNodeFileProperties.json | 22 + .../Nodes_GetNodeRemoteLoginSettings.json | 20 + .../examples/Nodes_ListNodeExtensions.json | 61 + .../examples/Nodes_ListNodeFiles.json | 48 + .../examples/Nodes_ListNodes.json | 136 + .../examples/Nodes_NodeReimage.json | 18 + .../examples/Nodes_RebootNode.json | 18 + .../examples/Nodes_ReplaceNodeUser.json | 20 + .../examples/Nodes_UploadNodeLogs.json | 24 + ...ools_CreatePool_AcceleratedNetworking.json | 30 + .../Pools_CreatePool_MountConfiguration.json | 72 + .../examples/Pools_CreatePool_OSDisk.json | 40 + .../Pools_CreatePool_ResourceTags.json | 31 + .../Pools_CreatePool_SecurityProfile.json | 35 + ...reatePool_VirtualMachineConfiguration.json | 44 + ...ualMachineConfigurationWithContainers.json | 43 + ...ualMachineConfigurationWithExtensions.json | 59 + ...igurationWithServiceArtifactReference.json | 33 + .../examples/Pools_DeletePool.json | 14 + .../examples/Pools_DisablePoolAutoScale.json | 14 + .../examples/Pools_EnablePoolAutoscale.json | 18 + .../examples/Pools_EvaluatePoolAutoscale.json | 22 + .../Pools_GetPool_AcceleratedNetworking.json | 52 + .../examples/Pools_GetPool_Basic.json | 58 + .../Pools_GetPool_SecurityProfile.json | 55 + ...ualMachineConfigurationWithExtensions.json | 74 + ...VirtualMachineConfigurationWithOSDisk.json | 58 + ...igurationWithServiceArtifactReference.json | 54 + .../examples/Pools_ListPoolNodeCounts.json | 141 + .../examples/Pools_ListPoolUsageMetrics.json | 32 + .../examples/Pools_ListPools_Basic.json | 61 + .../examples/Pools_ListSupportedImages.json | 78 + .../examples/Pools_PoolExists.json | 15 + .../examples/Pools_RemoveNodes.json | 20 + .../examples/Pools_ReplacePoolProperties.json | 21 + .../examples/Pools_ResizePool.json | 18 + .../examples/Pools_StopPoolResize.json | 14 + .../examples/Pools_UpdatePool.json | 19 + .../Tasks_CreateTaskCollection_Basic.json | 45 + .../Tasks_CreateTaskCollection_Complex.json | 80 + .../examples/Tasks_CreateTask_Basic.json | 18 + .../Tasks_CreateTask_ContainerSettings.json | 28 + ...sk_ContainerSettingsWithDataIsolation.json | 33 + ...ngsWithDataIsolation_DuplicateSources.json | 37 + .../Tasks_CreateTask_ExitConditions.json | 35 + .../Tasks_CreateTask_RequiredSlots.json | 19 + .../examples/Tasks_DeleteTask.json | 15 + .../examples/Tasks_DeleteTaskFile.json | 17 + .../examples/Tasks_GetTask.json | 46 + .../examples/Tasks_GetTaskFile.json | 23 + .../examples/Tasks_GetTaskFileProperties.json | 22 + .../examples/Tasks_ListSubTasks.json | 52 + .../examples/Tasks_ListTaskFiles.json | 43 + .../examples/Tasks_ListTasks.json | 71 + .../examples/Tasks_ReactivateTask.json | 15 + .../examples/Tasks_ReplaceTask.json | 22 + .../examples/Tasks_TerminateTask.json | 15 + specification/batch/data-plane/readme.md | 9 + 193 files changed, 20532 insertions(+), 144 deletions(-) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Applications_GetApplication.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Applications_ListApplications.json (93%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_CreateJobSchedule_Basic.json (93%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_CreateJobSchedule_Complex.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_DeleteJobSchedule.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_DisableJobSchedule.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_EnableJobSchedule.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_GetJobSchedule.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_JobScheduleExists.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_ListJobSchedules.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_ReplaceJobSchedule.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_TerminateJobSchedule.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/JobSchedules_UpdateJobSchedule.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_CreateJob_Basic.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_CreateJob_Complex.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_DeleteJob.json (88%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_DisableJob.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_EnableJob.json (88%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_GetJob.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_GetJobTaskCounts.json (94%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_ListJobPreparationAndReleaseTaskStatus.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_ListJobs.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_ListJobsFromSchedule.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_ReplaceJob.json (93%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_TerminateJob.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Jobs_UpdateJob.json (93%) create mode 100644 specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_DeallocateNode.json create mode 100644 specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_StartNode.json rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_CreateNodeUser.json (93%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_DeleteNodeFile.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_DeleteNodeUser.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_DisableNodeScheduling.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_EnableNodeScheduling.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_GetNode.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_GetNodeExtension.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_GetNodeFile.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_GetNodeFileProperties.json (94%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_GetNodeRemoteLoginSettings.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_ListNodeExtensions.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_ListNodeFiles.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_ListNodes.json (99%) create mode 100644 specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_NodeReimage.json rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_RebootNode.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_ReplaceNodeUser.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Nodes_UploadNodeLogs.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_AcceleratedNetworking.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_MountConfiguration.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_OSDisk.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_ResourceTags.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_SecurityProfile.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_VirtualMachineConfiguration.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_DeletePool.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_DisablePoolAutoScale.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_EnablePoolAutoscale.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_EvaluatePoolAutoscale.json (93%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_AcceleratedNetworking.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_Basic.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_SecurityProfile.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ListPoolNodeCounts.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ListPoolUsageMetrics.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ListPools_Basic.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ListSupportedImages.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_PoolExists.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_RemoveNodes.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ReplacePoolProperties.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_ResizePool.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_StopPoolResize.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Pools_UpdatePool.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTaskCollection_Basic.json (96%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTaskCollection_Complex.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTask_Basic.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTask_ContainerSettings.json (94%) create mode 100644 specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json create mode 100644 specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTask_ExitConditions.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_CreateTask_RequiredSlots.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_DeleteTask.json (89%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_DeleteTaskFile.json (91%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_GetTask.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_GetTaskFile.json (95%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_GetTaskFileProperties.json (94%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_ListSubTasks.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_ListTaskFiles.json (97%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_ListTasks.json (98%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_ReactivateTask.json (90%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_ReplaceTask.json (92%) rename specification/batch/Azure.Batch/examples/{2024-02-01.19.0 => 2024-07-01.20.0}/Tasks_TerminateTask.json (89%) create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_GetApplication.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_ListApplications.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Complex.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DeleteJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DisableJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_EnableJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_GetJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_JobScheduleExists.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ListJobSchedules.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ReplaceJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_TerminateJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_UpdateJobSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Complex.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DeleteJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DisableJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_EnableJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJobTaskCounts.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobs.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobsFromSchedule.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ReplaceJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_TerminateJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_UpdateJob.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_DeallocateNode.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_StartNode.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_CreateNodeUser.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeFile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeUser.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DisableNodeScheduling.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_EnableNodeScheduling.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNode.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeExtension.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFileProperties.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeRemoteLoginSettings.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeExtensions.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeFiles.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodes.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_NodeReimage.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_RebootNode.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ReplaceNodeUser.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_UploadNodeLogs.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_AcceleratedNetworking.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_MountConfiguration.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_OSDisk.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_ResourceTags.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_SecurityProfile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DeletePool.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DisablePoolAutoScale.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EnablePoolAutoscale.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EvaluatePoolAutoscale.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_AcceleratedNetworking.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_SecurityProfile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolNodeCounts.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolUsageMetrics.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPools_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListSupportedImages.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_PoolExists.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_RemoveNodes.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ReplacePoolProperties.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ResizePool.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_StopPoolResize.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_UpdatePool.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Complex.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_Basic.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettings.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ExitConditions.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_RequiredSlots.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTask.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTaskFile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTask.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFile.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFileProperties.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListSubTasks.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTaskFiles.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTasks.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReactivateTask.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReplaceTask.json create mode 100644 specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_TerminateTask.json diff --git a/specification/batch/Azure.Batch/client.tsp b/specification/batch/Azure.Batch/client.tsp index d8a623867040..7e45b39dc549 100644 --- a/specification/batch/Azure.Batch/client.tsp +++ b/specification/batch/Azure.Batch/client.tsp @@ -4,7 +4,7 @@ import "./main.tsp"; using Azure.ClientGenerator.Core; @TypeSpec.Versioning.useDependency(Azure.Core.Versions.v1_0_Preview_2) -@TypeSpec.Versioning.useDependency(Azure.Batch.Versions.v2024_02_01) +@TypeSpec.Versioning.useDependency(Azure.Batch.Versions.v2024_07_01) namespace Client; #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "" #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "" @@ -76,6 +76,9 @@ interface BatchClient { replaceNodeUser is Azure.Batch.Nodes.replaceNodeUser; getNode is Azure.Batch.Nodes.getNode; rebootNode is Azure.Batch.Nodes.rebootNode; + startNode is Azure.Batch.Nodes.startNode; + reimageNode is Azure.Batch.Nodes.reimageNode; + deallocateNode is Azure.Batch.Nodes.deallocateNode; disableNodeScheduling is Azure.Batch.Nodes.disableNodeScheduling; enableNodeScheduling is Azure.Batch.Nodes.enableNodeScheduling; getNodeRemoteLoginSettings is Azure.Batch.Nodes.getNodeRemoteLoginSettings; @@ -94,7 +97,15 @@ interface BatchClient { @@access(Azure.Batch.Pools.poolExists, Access.internal, "csharp"); @@access(Azure.Batch.JobSchedules.jobScheduleExists, Access.internal, "csharp"); @@access(Azure.Batch.Tasks.getTaskFileProperties, Access.internal, "csharp"); +@@clientName(BatchClient.getTaskFileProperties, + "getTaskFilePropertiesInternal", + "csharp" +); @@access(Azure.Batch.Nodes.getNodeFileProperties, Access.internal, "csharp"); +@@clientName(BatchClient.getNodeFileProperties, + "getNodeFilePropertiesInternal", + "csharp" +); /* JAVA OVERRIDES */ // client name overrides @@ -218,6 +229,9 @@ interface BatchClient { @@clientName(BatchClient.replaceNodeUser, "replaceNodeUserInternal", "java"); @@clientName(BatchClient.getNode, "getNodeInternal", "java"); @@clientName(BatchClient.rebootNode, "rebootNodeInternal", "java"); +@@clientName(BatchClient.startNode, "startNodeInternal", "java"); +@@clientName(BatchClient.reimageNode, "reimageNodeInternal", "java"); +@@clientName(BatchClient.deallocateNode, "deallocateNodeInternal", "java"); @@clientName(BatchClient.disableNodeScheduling, "disableNodeSchedulingInternal", "java" @@ -306,6 +320,7 @@ interface BatchClient { @@access(Azure.Batch.BatchNodeUserUpdateContent, Access.public, "java"); @@access(Azure.Batch.BatchNode, Access.public, "java"); @@access(Azure.Batch.BatchNodeRebootContent, Access.public, "java"); +@@access(Azure.Batch.BatchNodeDeallocateContent, Access.public, "java"); @@access(Azure.Batch.BatchNodeReimageContent, Access.public, "java"); @@access(Azure.Batch.BatchNodeDisableSchedulingContent, Access.public, "java"); @@access(Azure.Batch.BatchNodeRemoteLoginSettings, Access.public, "java"); diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_GetApplication.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_GetApplication.json index e18b17fbaab0..24120780e2d2 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_GetApplication.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_GetApplication.json @@ -3,7 +3,7 @@ "title": "Get applications", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "applicationId": "my_application_id" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_ListApplications.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_ListApplications.json index d4c8edbf5e5a..3d9488449d95 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Applications_ListApplications.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Applications_ListApplications.json @@ -3,7 +3,7 @@ "title": "List applications", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Basic.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Basic.json index 73996de79a79..84d8577c3564 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Basic.json @@ -3,7 +3,7 @@ "title": "Creates a basic JobSchedule", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "jobSchedule": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Complex.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Complex.json index 6d4387e11cfe..597bbe4dbd88 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_CreateJobSchedule_Complex.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_CreateJobSchedule_Complex.json @@ -3,7 +3,7 @@ "title": "Creates a complex JobScheduleAdd", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "jobSchedule": { @@ -59,7 +59,7 @@ "autoPoolIdPrefix": "mypool", "poolLifetimeOption": "jobschedule", "pool": { - "vmSize": "Standard_D1_v2", + "vmSize": "STANDARD_D2S_V3", "virtualMachineConfiguration": { "imageReference": { "publisher": "MicrosoftWindowsServer", @@ -67,7 +67,13 @@ "sku": "2016-datacenter-smalldisk", "version": "latest" }, - "nodeAgentSKUId": "batch.node.windows amd64" + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "nodePlacementConfiguration": { + "policy": "zonal" + } }, "resizeTimeout": "PT15M", "targetDedicatedNodes": 3, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DeleteJobSchedule.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DeleteJobSchedule.json index 4eb1b3ba028d..cfb3b3126163 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DeleteJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DeleteJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule delete", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DisableJobSchedule.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DisableJobSchedule.json index 641df039a089..ec35089fd54c 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_DisableJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_DisableJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule disable", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_EnableJobSchedule.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_EnableJobSchedule.json index f34cbbb0fc1b..299fe57388f9 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_EnableJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_EnableJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule enable", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_GetJobSchedule.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_GetJobSchedule.json index 223be7fe95b6..cc71f9cd756b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_GetJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_GetJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule get", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_JobScheduleExists.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_JobScheduleExists.json index 00d523f0fe70..d67abcf3e706 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_JobScheduleExists.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_JobScheduleExists.json @@ -3,7 +3,7 @@ "title": "Check Job Schedule Exists", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ListJobSchedules.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ListJobSchedules.json index 5f873b246975..04e4d32afcee 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ListJobSchedules.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ListJobSchedules.json @@ -3,7 +3,7 @@ "title": "JobSchedule list", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ReplaceJobSchedule.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ReplaceJobSchedule.json index 3625de2dd434..d48982782b9c 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_ReplaceJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_ReplaceJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule patch", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_TerminateJobSchedule.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_TerminateJobSchedule.json index ffd2a483d448..b18cf1916b2b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_TerminateJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_TerminateJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule terminate", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_UpdateJobSchedule.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_UpdateJobSchedule.json index 069a43caf6be..7e9311ab4f57 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/JobSchedules_UpdateJobSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/JobSchedules_UpdateJobSchedule.json @@ -3,7 +3,7 @@ "title": "JobSchedule update", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Basic.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Basic.json index baab498938f8..ba9c69bb1c08 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Basic.json @@ -3,7 +3,7 @@ "title": "Creates a basic job", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "job": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Complex.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Complex.json index e84804756085..4d0b8560f32f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_CreateJob_Complex.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_CreateJob_Complex.json @@ -3,7 +3,7 @@ "title": "Creates a complex job", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "job": { @@ -52,7 +52,7 @@ "autoPoolIdPrefix": "mypool", "poolLifetimeOption": "job", "pool": { - "vmSize": "Standard_D1_v2", + "vmSize": "STANDARD_D2S_V3", "virtualMachineConfiguration": { "imageReference": { "publisher": "MicrosoftWindowsServer", @@ -60,7 +60,13 @@ "sku": "2016-datacenter-smalldisk", "version": "latest" }, - "nodeAgentSKUId": "batch.node.windows amd64" + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "nodePlacementConfiguration": { + "policy": "zonal" + } }, "resizeTimeout": "PT15M", "targetDedicatedNodes": 3, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DeleteJob.json similarity index 88% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DeleteJob.json index dc0f8e197ecf..83175db2e27a 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DeleteJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DeleteJob.json @@ -3,7 +3,7 @@ "title": "Delete Job", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DisableJob.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DisableJob.json index 976ee3ca6169..28510af741a6 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_DisableJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_DisableJob.json @@ -3,7 +3,7 @@ "title": "Job disable", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_EnableJob.json similarity index 88% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_EnableJob.json index ec972d834143..8251b14494c0 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_EnableJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_EnableJob.json @@ -3,7 +3,7 @@ "title": "Job enable", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJob.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJob.json index fa59fbe1be5d..bd508f90a31f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJob.json @@ -3,7 +3,7 @@ "title": "Job get", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJobTaskCounts.json similarity index 94% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJobTaskCounts.json index 70f734727ce2..39ca25067b14 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_GetJobTaskCounts.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_GetJobTaskCounts.json @@ -3,7 +3,7 @@ "title": "Job get task counts", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json index 03e36673a779..a174e7067877 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobPreparationAndReleaseTaskStatus.json @@ -3,7 +3,7 @@ "title": "Job list preparation and release task status", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" @@ -35,7 +35,7 @@ } } ], - "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-02-01.19.0" + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-07-01.20.0" } } } diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobs.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobs.json index 487658237517..dab7b8e30caa 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobs.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobs.json @@ -3,7 +3,7 @@ "title": "Job list", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobsFromSchedule.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobsFromSchedule.json index 2ba6158c6d78..a763b9bad5b0 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ListJobsFromSchedule.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ListJobsFromSchedule.json @@ -3,7 +3,7 @@ "title": "List Job Under Job Schedule", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobScheduleId": "jobScheduleId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ReplaceJob.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ReplaceJob.json index e7b75ae8aefd..eedb3083e1e0 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_ReplaceJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_ReplaceJob.json @@ -3,7 +3,7 @@ "title": "Job patch", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_TerminateJob.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_TerminateJob.json index 2ec4cbd216a1..92f2f3c56481 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_TerminateJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_TerminateJob.json @@ -3,7 +3,7 @@ "title": "Job terminate", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_UpdateJob.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_UpdateJob.json index b1ddadf806fd..1280cb696495 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Jobs_UpdateJob.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Jobs_UpdateJob.json @@ -3,7 +3,7 @@ "title": "Job update", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_DeallocateNode.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_DeallocateNode.json new file mode 100644 index 000000000000..beba564d2c46 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_DeallocateNode.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_DeallocateNode", + "title": "Node Deallocate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDeallocateParameter": { + "nodeDeallocateOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_StartNode.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_StartNode.json new file mode 100644 index 000000000000..dba002f5df03 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Node_StartNode.json @@ -0,0 +1,15 @@ +{ + "operationId": "Nodes_StartNode", + "title": "Node start", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_CreateNodeUser.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_CreateNodeUser.json index 1f3232520cd9..d38cd713bb4b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_CreateNodeUser.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_CreateNodeUser.json @@ -3,7 +3,7 @@ "title": "Node create user", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161121t182739z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeFile.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeFile.json index ed146c43d47b..862b172936a1 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeFile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeFile.json @@ -3,7 +3,7 @@ "title": "File delete from node", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161122t193202z", "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeUser.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeUser.json index 999f12cc26e8..415f79422e46 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DeleteNodeUser.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DeleteNodeUser.json @@ -3,7 +3,7 @@ "title": "Node delete user", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161121t182739z", "userName": "userName", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DisableNodeScheduling.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DisableNodeScheduling.json index c62df5ec29e8..78838915dfcf 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_DisableNodeScheduling.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_DisableNodeScheduling.json @@ -3,7 +3,7 @@ "title": "Node disable scheduling", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_EnableNodeScheduling.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_EnableNodeScheduling.json index f64ddacbb438..868be69627aa 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_EnableNodeScheduling.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_EnableNodeScheduling.json @@ -3,7 +3,7 @@ "title": "Node enable scheduling", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNode.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNode.json index e4f594070200..04656b7cb676 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNode.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNode.json @@ -5,7 +5,7 @@ "batchUrl": "account.region.batch.azure.com", "poolId": "poolId", "nodeId": "tvm-1695681911_2-20161122t193202z", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeExtension.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeExtension.json index 6504539dc06b..f1b15b4a6a3b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeExtension.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeExtension.json @@ -6,7 +6,7 @@ "poolId": "poolId", "nodeId": "tvm-1695681911_2-20161122t193202z", "extensionName": "batchNodeExtension", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFile.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFile.json index c7198ff8d4ed..92a376d1d4a6 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFile.json @@ -3,7 +3,7 @@ "title": "Get File From Compute Node", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "nodeId", "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFileProperties.json similarity index 94% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFileProperties.json index 90073c586af3..4e76206dd77c 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeFileProperties.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeFileProperties.json @@ -3,7 +3,7 @@ "title": "File get properties from node", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "nodeId", "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeRemoteLoginSettings.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeRemoteLoginSettings.json index b26c660050ab..53b5291a569c 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_GetNodeRemoteLoginSettings.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_GetNodeRemoteLoginSettings.json @@ -3,7 +3,7 @@ "title": "Node get remote login settings", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161121t182739z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeExtensions.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeExtensions.json index aa7faefe4938..5e4f7fb1eebe 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeExtensions.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeExtensions.json @@ -3,7 +3,7 @@ "title": "List compute node extensions", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_2-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeFiles.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeFiles.json index 164111ec8a3d..b7dd7ef9b6db 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodeFiles.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodeFiles.json @@ -3,7 +3,7 @@ "title": "File list from node", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodes.json similarity index 99% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodes.json index 6c3fd0244810..ebec819a1bde 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ListNodes.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ListNodes.json @@ -3,7 +3,7 @@ "title": "Node list", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_NodeReimage.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_NodeReimage.json new file mode 100644 index 000000000000..b53e9c67d153 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_NodeReimage.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_ReimageNode", + "title": "Node reimage", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeReimageParameter": { + "nodeReimageOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_RebootNode.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_RebootNode.json index d828bf48908d..150acaadcd07 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_RebootNode.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_RebootNode.json @@ -3,7 +3,7 @@ "title": "Node reboot", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ReplaceNodeUser.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ReplaceNodeUser.json index 7408e05d475b..d93a7ffd93eb 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_ReplaceNodeUser.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_ReplaceNodeUser.json @@ -3,7 +3,7 @@ "title": "Node update user", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161121t182739z", "userName": "userName", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_UploadNodeLogs.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_UploadNodeLogs.json index ac111761c050..c4ce833ad67a 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Nodes_UploadNodeLogs.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Nodes_UploadNodeLogs.json @@ -3,7 +3,7 @@ "title": "Upload BatchService Logs", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "nodeId": "tvm-1695681911_1-20161121t182739z", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_AcceleratedNetworking.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_AcceleratedNetworking.json index 51ce88f34fd3..92dc19a13166 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_AcceleratedNetworking.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_AcceleratedNetworking.json @@ -3,7 +3,7 @@ "title": "Creates a pool with accelerated networking", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_MountConfiguration.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_MountConfiguration.json index 86c734c6f9ca..226ddbba2925 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_MountConfiguration.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_MountConfiguration.json @@ -3,7 +3,7 @@ "title": "Creates a pool with mount drive specified", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_OSDisk.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_OSDisk.json index f144330b8d1b..b6b570be4153 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_OSDisk.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_OSDisk.json @@ -3,7 +3,7 @@ "title": "Creates a VirtualMachineConfiguration pool with OS disk", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_ResourceTags.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_ResourceTags.json index 0457709ba9c5..87ef2da9bbc2 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_ResourceTags.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_ResourceTags.json @@ -3,7 +3,7 @@ "title": "Creates a simple pool with resourceTags", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_SecurityProfile.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_SecurityProfile.json index 769bd5b7ceab..0bb88a3b5fc3 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_SecurityProfile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_SecurityProfile.json @@ -3,7 +3,7 @@ "title": "Creates a pool with SecurityProfile", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfiguration.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfiguration.json index fdda1fc4bd29..80f90a22dda3 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfiguration.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfiguration.json @@ -3,7 +3,7 @@ "title": "Creates a VirtualMachineConfiguration pool", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json index 6c93e93aebf9..08306081f2a7 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json @@ -3,7 +3,7 @@ "title": "Creates a VirtualMachineConfiguration pool with containers", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json index ec470c8b9617..1dfd0411496c 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json @@ -3,7 +3,7 @@ "title": "Creates a VirtualMachineConfiguration pool with extensions", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json index 28aa0e11bd67..488744a59ee6 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -3,7 +3,7 @@ "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", "pool": { diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DeletePool.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DeletePool.json index 88c53b1b46e2..3125fb5f45ce 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DeletePool.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DeletePool.json @@ -3,7 +3,7 @@ "title": "Pool delete", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DisablePoolAutoScale.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DisablePoolAutoScale.json index ac34fc088182..973f97a7dbcb 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_DisablePoolAutoScale.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_DisablePoolAutoScale.json @@ -3,7 +3,7 @@ "title": "Disable pool autoscale", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EnablePoolAutoscale.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EnablePoolAutoscale.json index e6a2627b9274..c4ce7c23579d 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EnablePoolAutoscale.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EnablePoolAutoscale.json @@ -3,7 +3,7 @@ "title": "Pool enable autoscale", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EvaluatePoolAutoscale.json similarity index 93% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EvaluatePoolAutoscale.json index 1c05283aab88..25ee2bbcf2f6 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_EvaluatePoolAutoscale.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_EvaluatePoolAutoscale.json @@ -3,7 +3,7 @@ "title": "Pool evaluate autoscale", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_AcceleratedNetworking.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_AcceleratedNetworking.json index fcb46bf1c1a2..8b7526f52f1e 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_AcceleratedNetworking.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_AcceleratedNetworking.json @@ -3,7 +3,7 @@ "title": "Get a pool with AcceleratedNetworking", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "pool", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_Basic.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_Basic.json index 9bae3ce6828b..6262ef80a3f7 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_Basic.json @@ -3,7 +3,7 @@ "title": "Pool get", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "pool", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_SecurityProfile.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_SecurityProfile.json index f020e3b32e0b..58ee2ddcbd99 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_SecurityProfile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_SecurityProfile.json @@ -3,7 +3,7 @@ "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "mypool001", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json index 82a7e7b9162e..d6e1c7d07a0b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json @@ -3,7 +3,7 @@ "title": "Get a VirtualMachineConfiguration pool with extensions", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "pool", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json index 6574e2cbb14a..c8c72b256329 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json @@ -3,7 +3,7 @@ "title": "Add a VirtualMachineConfiguration pool with OS disk", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "mypool001", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json index 7462de39af56..065c6d30d888 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -3,7 +3,7 @@ "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "pool", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolNodeCounts.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolNodeCounts.json index d3cbbb642b61..d25481d5bbe0 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolNodeCounts.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolNodeCounts.json @@ -3,7 +3,7 @@ "title": "NodeCountsPayload", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, @@ -15,6 +15,8 @@ "poolId": "pool1", "dedicated": { "creating": 0, + "deallocated": 0, + "deallocating": 0, "idle": 0, "leavingPool": 0, "offline": 0, @@ -32,6 +34,8 @@ }, "lowPriority": { "creating": 0, + "deallocated": 0, + "deallocating": 0, "idle": 0, "leavingPool": 0, "offline": 0, @@ -52,6 +56,8 @@ "poolId": "pool2", "dedicated": { "creating": 0, + "deallocated": 0, + "deallocating": 0, "idle": 1, "leavingPool": 0, "offline": 3, @@ -69,6 +75,8 @@ }, "lowPriority": { "creating": 0, + "deallocated": 0, + "deallocating": 0, "idle": 0, "leavingPool": 0, "offline": 0, @@ -89,6 +97,8 @@ "poolId": "pool3", "dedicated": { "creating": 0, + "deallocated": 0, + "deallocating": 0, "idle": 5, "leavingPool": 0, "offline": 0, @@ -106,6 +116,8 @@ }, "lowPriority": { "creating": 7, + "deallocated": 0, + "deallocating": 0, "idle": 0, "leavingPool": 0, "offline": 0, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolUsageMetrics.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolUsageMetrics.json index 82cbeab87d2b..b9fc8590ee01 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPoolUsageMetrics.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPoolUsageMetrics.json @@ -3,7 +3,7 @@ "title": "Pool list usage metrics", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPools_Basic.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPools_Basic.json index 0883574a2b13..f7a2eba406d2 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListPools_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListPools_Basic.json @@ -3,7 +3,7 @@ "title": "Pool list", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, @@ -21,7 +21,7 @@ "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", "allocationState": "steady", "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", - "vmSize": "Standard_D1_v2", + "vmSize": "small", "resizeTimeout": "PT15M", "currentDedicatedNodes": 3, "currentLowPriorityNodes": 0, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListSupportedImages.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListSupportedImages.json index 41c98e95f421..a680b3a7f718 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ListSupportedImages.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ListSupportedImages.json @@ -3,7 +3,7 @@ "title": "Account list node agent skus", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" }, diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_PoolExists.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_PoolExists.json index 3b7076be3a60..3d4df6ca98df 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_PoolExists.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_PoolExists.json @@ -3,7 +3,7 @@ "title": "Check Pool Exists", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_RemoveNodes.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_RemoveNodes.json index 94f6e1387660..2e68b4a5da9f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_RemoveNodes.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_RemoveNodes.json @@ -3,7 +3,7 @@ "title": "Pool remove nodes", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ReplacePoolProperties.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ReplacePoolProperties.json index 93cb8d88b580..c2208c4d2c0e 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ReplacePoolProperties.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ReplacePoolProperties.json @@ -3,7 +3,7 @@ "title": "Pool update", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ResizePool.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ResizePool.json index fcfd1e063b38..29ffedcbcfab 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_ResizePool.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_ResizePool.json @@ -3,7 +3,7 @@ "title": "Pool resize", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "resizePool", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_StopPoolResize.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_StopPoolResize.json index db1f0716dfed..c63dce3238c5 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_StopPoolResize.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_StopPoolResize.json @@ -3,7 +3,7 @@ "title": "Pool stop resize", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_UpdatePool.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_UpdatePool.json index 1138f17ad957..28d784abfed8 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Pools_UpdatePool.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Pools_UpdatePool.json @@ -3,7 +3,7 @@ "title": "Patch the Pool", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "poolId": "poolId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Basic.json similarity index 96% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Basic.json index ef37e3605956..d2e7cc3f97f0 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Basic.json @@ -3,7 +3,7 @@ "title": "Creates a basic collection of tasks", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Complex.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Complex.json index 5d3ea8180cf6..3124669e48a4 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTaskCollection_Complex.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTaskCollection_Complex.json @@ -3,7 +3,7 @@ "title": "Creates a complex collection of tasks", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_Basic.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_Basic.json index 9ac29f42ba78..19009ec05e46 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_Basic.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_Basic.json @@ -3,7 +3,7 @@ "title": "Creates a basic task", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettings.json similarity index 94% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettings.json index 55bd01e12b65..435647de8e6f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ContainerSettings.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettings.json @@ -3,7 +3,7 @@ "title": "Creates a task with container settings", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json new file mode 100644 index 000000000000..bf4b3e6125c1 --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json @@ -0,0 +1,33 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings with data isolation", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Tue, 26 Mar 2024 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerHostBatchBindMounts": [ + { + "source": "Task", + "isReadOnly": true + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json new file mode 100644 index 000000000000..219df4f7ed6b --- /dev/null +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json @@ -0,0 +1,37 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings with duplicate source", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Tue, 26 Mar 2024 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerHostBatchBindMounts": [ + { + "source": "Task", + "isReadOnly": true + }, + { + "source": "Task", + "isReadOnly": true + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ExitConditions.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ExitConditions.json index 4031c4a776cf..7e906114290b 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_ExitConditions.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_ExitConditions.json @@ -3,7 +3,7 @@ "title": "Creates a task with exit conditions", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_RequiredSlots.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_RequiredSlots.json index 6b14c38c96ea..d5edf7f9b2f3 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_CreateTask_RequiredSlots.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_CreateTask_RequiredSlots.json @@ -3,7 +3,7 @@ "title": "Creates a task with extra slot requirement", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTask.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTask.json index 0f7d404c37a5..137f15899eea 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTask.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTask.json @@ -3,7 +3,7 @@ "title": "Task delete", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTaskFile.json similarity index 91% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTaskFile.json index 0908b20f659a..aaafede1c026 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_DeleteTaskFile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_DeleteTaskFile.json @@ -3,7 +3,7 @@ "title": "File delete from task", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "task1", "filePath": "wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTask.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTask.json index 3e8e2daaf788..312752b206e9 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTask.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTask.json @@ -3,7 +3,7 @@ "title": "Task get", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFile.json similarity index 95% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFile.json index 14df3ed4f5ef..4dbf72e96c7f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFile.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFile.json @@ -3,7 +3,7 @@ "title": "Get File From Task", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "task1", "filePath": "wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFileProperties.json similarity index 94% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFileProperties.json index a4b6bb55369e..99e3c7b9177f 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_GetTaskFileProperties.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_GetTaskFileProperties.json @@ -3,7 +3,7 @@ "title": "File get properties from task", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "filePath": "wd\\testFile.txt", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListSubTasks.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListSubTasks.json index cf4efa6d84c0..f98c195dff2a 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListSubTasks.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListSubTasks.json @@ -3,7 +3,7 @@ "title": "Task list subtasks", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTaskFiles.json similarity index 97% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTaskFiles.json index 9d3e580e4afb..494f14e3252d 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTaskFiles.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTaskFiles.json @@ -3,7 +3,7 @@ "title": "File list from task", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTasks.json similarity index 98% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTasks.json index e0fe12da8340..4eac964e9582 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ListTasks.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ListTasks.json @@ -3,7 +3,7 @@ "title": "Task list", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReactivateTask.json similarity index 90% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReactivateTask.json index 12a5ad7b37a7..e997458d2906 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReactivateTask.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReactivateTask.json @@ -3,7 +3,7 @@ "title": "Task reactivate", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReplaceTask.json similarity index 92% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReplaceTask.json index eb8822a9b419..603f15d36c41 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_ReplaceTask.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_ReplaceTask.json @@ -3,7 +3,7 @@ "title": "Task update", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_TerminateTask.json similarity index 89% rename from specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json rename to specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_TerminateTask.json index 823bfe3c92dc..dd199028aef5 100644 --- a/specification/batch/Azure.Batch/examples/2024-02-01.19.0/Tasks_TerminateTask.json +++ b/specification/batch/Azure.Batch/examples/2024-07-01.20.0/Tasks_TerminateTask.json @@ -3,7 +3,7 @@ "title": "Task terminate", "parameters": { "batchUrl": "account.region.batch.azure.com", - "api-version": "2024-02-01.19.0", + "api-version": "2024-07-01.20.0", "jobId": "jobId", "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", diff --git a/specification/batch/Azure.Batch/main.tsp b/specification/batch/Azure.Batch/main.tsp index e61b87a7f3aa..6643904bee92 100644 --- a/specification/batch/Azure.Batch/main.tsp +++ b/specification/batch/Azure.Batch/main.tsp @@ -31,7 +31,7 @@ namespace Azure.Batch; @doc("The Azure Batch service version.") enum Versions { - @doc("API Version 2024-02-01.19.0") + @doc("API Version 2024-07-01.20.0") @useDependency(Azure.Core.Versions.v1_0_Preview_2) - v2024_02_01: "2024-02-01.19.0", + v2024_07_01: "2024-07-01.20.0", } diff --git a/specification/batch/Azure.Batch/models.tsp b/specification/batch/Azure.Batch/models.tsp index f39c195e83ea..9b92b504d225 100644 --- a/specification/batch/Azure.Batch/models.tsp +++ b/specification/batch/Azure.Batch/models.tsp @@ -176,6 +176,29 @@ union DiskEncryptionTarget { union BatchNodePlacementPolicyType { string, + @doc("The path for multi-instances task to shared their files.") + Shared: "Shared", + + @doc("The path for start task.") + Startup: "Startup", + + @doc("The path contains all virtual file systems are mounted on this node.") + VfsMounts: "VfsMounts", + + @doc("The task path.") + Task: "Task", + + @doc("The job-prep task path.") + JobPrep: "JobPrep", + + @doc("The applications path.") + Applications: "Applications", +} + +@doc("The paths which will be mounted to container task's container.") +union ContainerHostDataPath { + string, + @doc("All nodes in the pool will be allocated in the same region.") Regional: "regional", @@ -241,7 +264,7 @@ union IpAddressProvisioningType { NoPublicIpAddresses: "nopublicipaddresses", } -@doc("AccessDiffDiskPlacementScope enums") +@doc("Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements") union DiffDiskPlacement { string, @@ -430,6 +453,23 @@ union BatchNodeDeallocationOption { RetainedData: "retaineddata", } +@doc("BatchNodeDeallocateOption enums") +union BatchNodeDeallocateOption { + string, + + @doc("Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Deallocate the Compute Node as soon as Tasks have been terminated.") + Requeue: "requeue", + + @doc("Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Deallocate the Compute Node as soon as Tasks have been terminated.") + Terminate: "terminate", + + @doc("Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Tasks have completed.") + TaskCompletion: "taskcompletion", + + @doc("Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Task retention periods have expired.") + RetainedData: "retaineddata", +} + @doc("BatchJobAction enums") union BatchJobAction { string, @@ -545,6 +585,12 @@ union BatchNodeState { @doc("The Compute Node is undergoing an OS upgrade operation.") UpgradingOS: "upgradingos", + + @doc("The Compute Node is deallocated.") + Deallocated: "deallocated", + + @doc("The Compute Node is deallocating.") + Deallocating: "deallocating", } @doc("UpgradeMode enums") @@ -631,6 +677,17 @@ union BatchNodeDisableSchedulingOption { TaskCompletion: "taskcompletion", } +@doc("SecurityEncryptionTypes enums") +union SecurityEncryptionTypes { + string, + + @doc("NonPersistedTPM") + NonPersistedTPM: "NonPersistedTPM", + + @doc("VMGuestStateOnly") + VMGuestStateOnly: "VMGuestStateOnly", +} + @doc("Level code.") union StatusLevelTypes { string, @@ -651,6 +708,9 @@ union SecurityTypes { @doc("Trusted launch protects against advanced and persistent attack techniques.") "trustedLaunch", + + @doc("Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified.") + "confidentialVM", } @doc("The result of listing the applications available in an Account.") @@ -803,6 +863,12 @@ model ImageReference { @doc("The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'.") @visibility("read") exactVersion?: string; + + @doc("The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call.") + sharedGalleryImageId?: string; + + @doc("The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call.") + communityGalleryImageId?: string; } @doc("The result of listing the Compute Node counts in the Account.") @@ -871,6 +937,12 @@ model BatchNodeCounts { @doc("The number of Compute Nodes in the waitingForStartTask state.") waitingForStartTask: int32; + @doc("The number of Compute Nodes in the deallocated state.") + deallocated: int32; + + @doc("The number of Compute Nodes in the deallocating state.") + deallocating: int32; + @doc("The total number of Compute Nodes.") total: int32; @@ -1177,7 +1249,7 @@ model BatchJobScheduleConfiguration { @doc("Specifies the security profile settings for the virtual machine or virtual machine scale set.") model SecurityProfile { - @doc("This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.") + @doc("This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.") encryptionAtHost: boolean; @doc("Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.") @@ -1246,8 +1318,12 @@ model BatchJobSpecification { @doc("The network configuration for the Job.") model BatchJobNetworkConfiguration { - @doc("The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. This will only work with a VirtualMachineConfiguration Pool. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.") + @doc("The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.") subnetId: string; + + #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" + @doc("Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false.") + skipWithdrawFromVNet: boolean; } @doc("The execution constraints for a Job.") @@ -1291,7 +1367,7 @@ model BatchJobManagerTask { @doc("The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024.") displayName?: string; - @doc("The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") + @doc("The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).") commandLine: string; @doc("The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.") @@ -1353,6 +1429,18 @@ model BatchTaskContainerSettings { @doc("The location of the container Task working directory. The default is 'taskWorkingDirectory'.") workingDirectory?: ContainerWorkingDirectory; + + @doc("The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.") + containerHostBatchBindMounts?: ContainerHostBatchBindMountEntry[]; +} + +@doc("The entry of path and mount mode you want to mount into task container.") +model ContainerHostBatchBindMountEntry { + @doc("The path which be mounted to container customer can select.") + source?: ContainerHostDataPath; + + @doc("Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path.") + isReadOnly?: boolean; } @doc("A private container registry.") @@ -1435,7 +1523,7 @@ model OutputFileBlobContainerDestination { @doc("The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.") identityReference?: BatchNodeIdentityReference; - @doc("A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types.") + @doc("A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.") uploadHeaders?: HttpHeader[]; } @@ -1557,7 +1645,7 @@ model BatchJobPreparationTask { @doc("A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).") id?: string; - @doc("The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") + @doc("The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).") commandLine: string; @doc("The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.") @@ -1604,7 +1692,7 @@ model BatchJobReleaseTask { @doc("A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).") id?: string; - @doc("The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") + @doc("The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).") commandLine: string; @doc("The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.") @@ -1661,7 +1749,7 @@ model BatchPoolSpecification { @doc("The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).") vmSize: string; - @doc("The virtual machine configuration for the Pool. This property must be specified if the Pool needs to be created with Azure IaaS VMs. If it is not specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).") + @doc("The virtual machine configuration for the Pool. This property must be specified.") virtualMachineConfiguration?: VirtualMachineConfiguration; @doc("The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.") @@ -1735,7 +1823,7 @@ model VirtualMachineConfiguration { @doc("Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image.") windowsConfiguration?: WindowsConfiguration; - @doc("The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.") + @doc("The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.") dataDisks?: DataDisk[]; @doc(""" @@ -1819,7 +1907,7 @@ model ContainerConfiguration { Azure Compute Gallery Image. """) model DiskEncryptionConfiguration { - @doc("The list of disk targets Batch Service will encrypt on the compute node. If omitted, no disks on the compute nodes in the pool will be encrypted. On Linux pool, only \"TemporaryDisk\" is supported; on Windows pool, \"OsDisk\" and \"TemporaryDisk\" must be specified.") + @doc("The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node.") targets?: DiskEncryptionTarget[]; } @@ -1888,7 +1976,7 @@ model OSDisk { compute node (VM). """) model DiffDiskSettings { - @doc("Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.") + @doc("Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.") placement?: DiffDiskPlacement; } @@ -1901,16 +1989,16 @@ model BatchTaskSchedulingPolicy { #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" @doc("The network configuration for a Pool.") model NetworkConfiguration { - @doc("The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. For Pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For Pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.") + @doc("The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. Enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.") subnetId?: string; @doc("The scope of dynamic vnet assignment.") dynamicVNetAssignmentScope?: DynamicVNetAssignmentScope; - @doc("The configuration for endpoints on Compute Nodes in the Batch Pool. Pool endpoint configuration is only supported on Pools with the virtualMachineConfiguration property.") + @doc("The configuration for endpoints on Compute Nodes in the Batch Pool.") endpointConfiguration?: BatchPoolEndpointConfiguration; - @doc("The Public IPAddress configuration for Compute Nodes in the Batch Pool. Public IP configuration property is only supported on Pools with the virtualMachineConfiguration property.") + @doc("The Public IPAddress configuration for Compute Nodes in the Batch Pool.") @clientName("publicIpAddressConfiguration") publicIPAddressConfiguration?: PublicIpAddressConfiguration; @@ -1993,7 +2081,7 @@ model PublicIpAddressConfiguration { block Batch from being able to re-run the StartTask. """) model BatchStartTask { - @doc("The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") + @doc("The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).") commandLine: string; @doc("The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.") @@ -2052,14 +2140,17 @@ model LinuxUserConfiguration { @doc("Properties used to create a user Account on a Windows Compute Node.") model WindowsUserConfiguration { - @doc("The login mode for the user. The default value for VirtualMachineConfiguration Pools is 'batch'.") + @doc("The login mode for the user. The default is 'batch'.") loginMode?: LoginMode; } @doc("The managed disk parameters.") model ManagedDisk { @doc("The storage account type for managed disk.") - storageAccountType: StorageAccountType; + storageAccountType?: StorageAccountType; + + @doc("Specifies the security profile settings for the managed disk.") + securityProfile?: VMDiskSecurityProfile; } @doc(""" @@ -2346,7 +2437,7 @@ model BatchJob { @visibility("read") executionInfo?: BatchJobExecutionInfo; - @doc("Resource usage statistics for the entire lifetime of the Job. This property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.") + @doc("Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.") @visibility("read") stats?: BatchJobStatistics; } @@ -2424,6 +2515,9 @@ model BatchJobUpdateContent { @doc("A list of name-value pairs associated with the Job as metadata. If omitted, the existing Job metadata is left unchanged.") metadata?: MetadataItem[]; + + @doc("The network configuration for the Job.") + networkConfiguration?: BatchJobNetworkConfiguration; } @doc("Contains information about the execution of a Job in the Azure Batch service.") @@ -2706,7 +2800,7 @@ model BatchPool { @visibility("read") allocationStateTransitionTime?: utcDateTime; - @doc("The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).") + @doc("The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).") @visibility("read") vmSize?: string; @@ -2789,7 +2883,7 @@ model BatchPool { @visibility("read") metadata?: MetadataItem[]; - @doc("Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the CloudPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.") + @doc("Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.") @visibility("read") stats?: BatchPoolStatistics; @@ -2898,6 +2992,15 @@ model BatchPoolReplaceContent { @doc("Parameters for updating an Azure Batch Pool.") model BatchPoolUpdateContent { + @doc("The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. This field can be updated only when the pool is empty.") + displayName?: string; + + @doc("The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br />This field can be updated only when the pool is empty.") + vmSize?: string; + + @doc("Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.<br /><br />This field can be updated only when the pool is empty.") + enableInterNodeCommunication?: boolean; + @doc("A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged.") startTask?: BatchStartTask; @@ -2907,8 +3010,32 @@ model BatchPoolUpdateContent { @doc("A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.") metadata?: MetadataItem[]; + @doc("The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty.") + virtualMachineConfiguration?: VirtualMachineConfiguration; + @doc("The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged.") targetNodeCommunicationMode?: BatchNodeCommunicationMode; + + @doc("The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.<br /><br />This field can be updated only when the pool is empty.") + taskSlotsPerNode?: int32; + + @doc("How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty.") + taskSchedulingPolicy?: BatchTaskSchedulingPolicy; + + @doc("The network configuration for the Pool. This field can be updated only when the pool is empty.") + networkConfiguration?: NetworkConfiguration; + + @doc("The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.<br /><br />This field can be updated only when the pool is empty.") + resourceTags?: Record<string>; + + @doc("The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.") + userAccounts?: UserAccount[]; + + @doc("Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.<br /><br />This field can be updated only when the pool is empty.") + mountConfiguration?: MountConfiguration[]; + + @doc("The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can be updated only when the pool is empty.") + upgradePolicy?: UpgradePolicy; } @doc("An error that occurred when resizing a Pool.") @@ -2985,7 +3112,7 @@ model BatchPoolListResult { @doc("Parameters for enabling automatic scaling on an Azure Batch Pool.") model BatchPoolEnableAutoScaleContent { - @doc("The formula for the desired number of Compute Nodes in the Pool. The formula is checked for validity before it is applied to the Pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).") + @doc("The formula for the desired number of Compute Nodes in the Pool. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.") autoScaleFormula?: string; @doc("The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.") @@ -2994,7 +3121,7 @@ model BatchPoolEnableAutoScaleContent { @doc("Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.") model BatchPoolEvaluateAutoScaleContent { - @doc("The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).") + @doc("The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling).") autoScaleFormula: string; } @@ -3025,6 +3152,12 @@ model BatchNodeRemoveContent { nodeDeallocationOption?: BatchNodeDeallocationOption; } +@doc("Options for deallocating a Compute Node.") +model BatchNodeDeallocateContent { + @doc("When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue.") + nodeDeallocateOption?: BatchNodeDeallocateOption; +} + @doc(""" Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an @@ -3081,7 +3214,7 @@ model BatchTask { @visibility("read") previousStateTransitionTime?: utcDateTime; - @doc("The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).") + @doc("The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).") @visibility("read") commandLine?: string; @@ -3237,6 +3370,13 @@ model ExitOptions { dependencyAction?: DependencyAction; } +#suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" +@doc("Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs.") +model VMDiskSecurityProfile { + @doc("Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs.") + securityEncryptionType?: SecurityEncryptionTypes; +} + @doc(""" A range of exit codes and how the Batch service should respond to exit codes within that range. @@ -3504,7 +3644,7 @@ model UpgradePolicy { @clientName("automaticOsUpgradePolicy") automaticOSUpgradePolicy?: AutomaticOsUpgradePolicy; - @doc("The configuration parameters used while performing a rolling upgrade. This property is only supported on Pools with the virtualMachineConfiguration property.") + @doc("The configuration parameters used while performing a rolling upgrade.") rollingUpgradePolicy?: RollingUpgradePolicy; } @@ -3514,7 +3654,7 @@ model AutomaticOsUpgradePolicy { disableAutomaticRollback?: boolean; #suppress "@azure-tools/typespec-azure-core/casing-style" "The names of Property types must use camelCase" - @doc("Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/en-us/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true.") + @doc("Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true.") @clientName("enableAutomaticOsUpgrade") enableAutomaticOSUpgrade?: boolean; @@ -3561,7 +3701,7 @@ model BatchNodeUserCreateContent { expiryTime?: utcDateTime; @secret - @doc("The password of the Account. The password is required for Windows Compute Nodes (those created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.") + @doc("The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.") password?: string; @doc("The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).") @@ -3571,7 +3711,7 @@ model BatchNodeUserCreateContent { @doc("Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.") model BatchNodeUserUpdateContent { @secret - @doc("The password of the Account. The password is required for Windows Compute Nodes (those created with 'virtualMachineConfiguration' using a Windows Image reference). For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.") + @doc("The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.") password?: string; @doc("The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day.") diff --git a/specification/batch/Azure.Batch/routes.tsp b/specification/batch/Azure.Batch/routes.tsp index 181b81fd6a8b..6bb346a8bded 100644 --- a/specification/batch/Azure.Batch/routes.tsp +++ b/specification/batch/Azure.Batch/routes.tsp @@ -93,7 +93,7 @@ interface Pools { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics. """) @query @clientName("filter", "!autorest") @@ -119,15 +119,15 @@ interface Pools { {} >; - @summary("Lists all of the Pools in the specified Account.") - @doc("Lists all of the Pools in the specified Account.") + @summary("Lists all of the Pools which be mounted.") + @doc("Lists all of the Pools which be mounted.") @route("/pools") @clientName("listPoolsInternal", "java") listPools is ListOperation< { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools. """) @query @clientName("filter", "!autorest") @@ -350,7 +350,7 @@ interface Pools { { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images. """) @query @clientName("filter", "!autorest") @@ -370,7 +370,7 @@ interface Pools { { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-support-images. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images. """) @query @clientName("filter", "!autorest") @@ -402,6 +402,10 @@ interface Jobs { @doc("The ID of the Job to delete.") @path jobId: string; + + @doc("If true, the server will delete the Job even if the corresponding nodes have not fully processed the deletion. The default value is false.") + @query + force?: boolean; }, DeleteResponseHeaders >; @@ -539,6 +543,10 @@ interface Jobs { @doc("The options to use for terminating the Job.") @bodyRoot parameters?: BatchJobTerminateContent; + + @doc("If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is false.") + @query + force?: boolean; }, AcceptedProcessingResponseHeaders >; @@ -574,7 +582,7 @@ interface Jobs { { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs. """) @query @clientName("filter", "!autorest") @@ -605,7 +613,7 @@ interface Jobs { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. """) @query @clientName("filter", "!autorest") @@ -646,7 +654,7 @@ interface Jobs { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. """) @query @clientName("filter", "!autorest") @@ -715,6 +723,10 @@ interface JobSchedules { @doc("The ID of the Job Schedule to delete.") @path jobScheduleId: string; + + @doc("If true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false.") + @query + force?: boolean; }, DeleteResponseHeaders >; @@ -822,6 +834,10 @@ interface JobSchedules { @doc("The ID of the Job Schedule to terminates.") @path jobScheduleId: string; + + @doc("If true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default value is false.") + @query + force?: boolean; }, AcceptedProcessingResponseHeaders >; @@ -847,7 +863,7 @@ interface JobSchedules { { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. """) @query @clientName("filter", "!autorest") @@ -909,7 +925,7 @@ interface Tasks { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks. """) @query @clientName("filter", "!autorest") @@ -1162,7 +1178,6 @@ interface Tasks { @doc("Gets the properties of the specified Task file.") @route("/jobs/{jobId}/tasks/{taskId}/files/{filePath}") @clientName("getTaskFilePropertiesInternal", "java") - @clientName("getTaskFilePropertiesInternal", "csharp") getTaskFileProperties is HeadFileOperation< BatchTaskFileClientPathContent & BatchModifiedSinceHeaders, {} @@ -1184,7 +1199,7 @@ interface Tasks { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files. """) @query @clientName("filter", "!autorest") @@ -1333,6 +1348,69 @@ interface Nodes { AcceptedProcessingResponseHeaders >; + @summary("Starts the specified Compute Node.") + @doc("You can start a Compute Node only if it has been deallocated.") + @route("/pools/{poolId}/nodes/{nodeId}/start") + @clientName("startNodeInternal", "java") + startNode is PostOperation< + { + @doc("The ID of the Pool that contains the Compute Node.") + @path + poolId: string; + + @doc("The ID of the Compute Node that you want to restart.") + @path + nodeId: string; + }, + AcceptedProcessingResponseHeaders + >; + + @summary("Deallocates the specified Compute Node.") + @doc("You can deallocate a Compute Node only if it is in an idle or running state.") + @route("/pools/{poolId}/nodes/{nodeId}/deallocate") + @clientName("deallocateNodeInternal", "java") + deallocateNode is PostOperation< + MinimalMetadata & { + @doc("The ID of the Pool that contains the Compute Node.") + @path + poolId: string; + + @doc("The ID of the Compute Node that you want to restart.") + @path + nodeId: string; + + @doc("The options to use for deallocating the Compute Node.") + @bodyRoot + parameters?: BatchNodeDeallocateContent; + }, + AcceptedProcessingResponseHeaders + >; + + @summary("Reinstalls the operating system on the specified Compute Node.") + @doc(""" + You can reinstall the operating system on a Compute Node only if it is in an + idle or running state. This API can be invoked only on Pools created with the + cloud service configuration property. + """) + @route("/pools/{poolId}/nodes/{nodeId}/reimage") + @clientName("reimageNodeInternal", "java") + reimageNode is PostOperation< + MinimalMetadata & { + @doc("The ID of the Pool that contains the Compute Node.") + @path + poolId: string; + + @doc("The ID of the Compute Node that you want to restart.") + @path + nodeId: string; + + @doc("The options to use for reimaging the Compute Node.") + @body + parameters?: BatchNodeReimageContent; + }, + AcceptedProcessingResponseHeaders + >; + @summary("Disables Task scheduling on the specified Compute Node.") @doc(""" You can disable Task scheduling on a Compute Node only if its current @@ -1379,9 +1457,8 @@ interface Nodes { @summary("Gets the settings required for remote login to a Compute Node.") @doc(""" - Before you can remotely login to a Compute Node using the remote login - settings, you must create a user Account on the Compute Node. This API can be - invoked only on Pools created with the virtual machine configuration property. + Before you can remotely login to a Compute Node using the remote login settings, + you must create a user Account on the Compute Node. """) @route("/pools/{poolId}/nodes/{nodeId}/remoteloginsettings") @clientName("getNodeRemoteLoginSettingsInternal", "java") @@ -1442,7 +1519,7 @@ interface Nodes { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. """) @query @clientName("filter", "!autorest") @@ -1555,7 +1632,6 @@ interface Nodes { @doc("Gets the properties of the specified Compute Node file.") @route("/pools/{poolId}/nodes/{nodeId}/files/{filePath}") @clientName("getNodeFilePropertiesInternal", "java") - @clientName("getNodeFilePropertiesInternal", "csharp") getNodeFileProperties is HeadFileOperation< BatchNodeFileClientPathContent & BatchModifiedSinceHeaders, {} @@ -1577,7 +1653,7 @@ interface Nodes { @doc(""" An OData $filter clause. For more information on constructing this filter, see - https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. + https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. """) @query @clientName("filter", "!autorest") diff --git a/specification/batch/Azure.Batch/tspconfig.yaml b/specification/batch/Azure.Batch/tspconfig.yaml index 1c66dcb9fc9e..cd8eb212b04d 100644 --- a/specification/batch/Azure.Batch/tspconfig.yaml +++ b/specification/batch/Azure.Batch/tspconfig.yaml @@ -12,7 +12,7 @@ options: emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/Azure.Batch/preview/{version}/BatchService.json" "@azure-tools/typespec-csharp": - package-dir: "Azure.Batch" + package-dir: "Azure.Compute.Batch" clear-output-folder: true model-namespace: false head-as-boolean: false diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json new file mode 100644 index 000000000000..ec041a5d4142 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json @@ -0,0 +1,16615 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Batch", + "version": "2024-07-01.20.0", + "description": "Azure Batch provides Cloud-scale job scheduling and compute management.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "description": "Batch account endpoint (for example: https://batchaccount.eastus2.batch.azure.com).", + "required": true, + "type": "string", + "format": "uri", + "x-ms-skip-url-encoding": true + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "OAuth2Auth": [ + "https://batch.core.windows.net//.default" + ] + } + ], + "securityDefinitions": { + "OAuth2Auth": { + "type": "oauth2", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://batch.core.windows.net//.default": "" + } + } + }, + "tags": [ + { + "name": "Applications" + }, + { + "name": "Pools" + }, + { + "name": "Jobs" + }, + { + "name": "Job Schedules" + }, + { + "name": "Tasks" + }, + { + "name": "Nodes" + } + ], + "paths": { + "/applications": { + "get": { + "operationId": "Applications_ListApplications", + "tags": [ + "Applications" + ], + "summary": "Lists all of the applications available in the specified Account.", + "description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchApplicationListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "List applications": { + "$ref": "./examples/Applications_ListApplications.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/applications/{applicationId}": { + "get": { + "operationId": "Applications_GetApplication", + "tags": [ + "Applications" + ], + "summary": "Gets information about the specified Application.", + "description": "This operation returns only Applications and versions that are available for\nuse on Compute Nodes; that is, that can be used in an Package reference. For\nadministrator information about Applications and versions that are not yet\navailable to Compute Nodes, use the Azure portal or the Azure Resource Manager\nAPI.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "applicationId", + "in": "path", + "description": "The ID of the Application", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchApplication" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Get applications": { + "$ref": "./examples/Applications_GetApplication.json" + } + } + } + }, + "/jobs": { + "get": { + "operationId": "Jobs_ListJobs", + "tags": [ + "Jobs" + ], + "summary": "Lists all of the Jobs in the specified Account.", + "description": "Lists all of the Jobs in the specified Account.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJobListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job list": { + "$ref": "./examples/Jobs_ListJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + }, + "post": { + "operationId": "Jobs_CreateJob", + "tags": [ + "Jobs" + ], + "summary": "Creates a Job to the specified Account.", + "description": "The Batch service supports two ways to control the work done as part of a Job.\nIn the first approach, the user specifies a Job Manager Task. The Batch service\nlaunches this Task when it is ready to start the Job. The Job Manager Task\ncontrols all other Tasks that run under this Job, by using the Task APIs. In\nthe second approach, the user directly controls the execution of Tasks under an\nactive Job, by using the Task APIs. Also note: when naming Jobs, avoid\nincluding sensitive information such as user names or secret project names.\nThis information may appear in telemetry logs accessible to Microsoft Support\nengineers.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "job", + "in": "body", + "description": "The Job to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobCreateContent" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Creates a basic job": { + "$ref": "./examples/Jobs_CreateJob_Basic.json" + }, + "Creates a complex job": { + "$ref": "./examples/Jobs_CreateJob_Complex.json" + } + } + } + }, + "/jobs/{jobId}": { + "get": { + "operationId": "Jobs_GetJob", + "tags": [ + "Jobs" + ], + "summary": "Gets information about the specified Job.", + "description": "Gets information about the specified Job.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJob" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job get": { + "$ref": "./examples/Jobs_GetJob.json" + } + } + }, + "put": { + "operationId": "Jobs_ReplaceJob", + "tags": [ + "Jobs" + ], + "summary": "Updates the properties of the specified Job.", + "description": "This fully replaces all the updatable properties of the Job. For example, if\nthe Job has constraints associated with it and if constraints is not specified\nwith this request, then the Batch service will remove the existing constraints.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job whose properties you want to update.", + "required": true, + "type": "string" + }, + { + "name": "job", + "in": "body", + "description": "A job with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJob" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job patch": { + "$ref": "./examples/Jobs_ReplaceJob.json" + } + } + }, + "patch": { + "operationId": "Jobs_UpdateJob", + "tags": [ + "Jobs" + ], + "summary": "Updates the properties of the specified Job.", + "description": "This replaces only the Job properties specified in the request. For example, if\nthe Job has constraints, and a request does not specify the constraints\nelement, then the Job keeps the existing constraints.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job whose properties you want to update.", + "required": true, + "type": "string" + }, + { + "name": "job", + "in": "body", + "description": "The options to use for updating the Job.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job update": { + "$ref": "./examples/Jobs_UpdateJob.json" + } + } + }, + "delete": { + "operationId": "Jobs_DeleteJob", + "tags": [ + "Jobs" + ], + "summary": "Deletes a Job.", + "description": "Deleting a Job also deletes all Tasks that are part of that Job, and all Job\nstatistics. This also overrides the retention period for Task data; that is, if\nthe Job contains Tasks which are still retained on Compute Nodes, the Batch\nservices deletes those Tasks' working directories and all their contents. When\na Delete Job request is received, the Batch service sets the Job to the\ndeleting state. All update operations on a Job that is in deleting state will\nfail with status code 409 (Conflict), with additional information indicating\nthat the Job is being deleted.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to delete.", + "required": true, + "type": "string" + }, + { + "name": "force", + "in": "query", + "description": "If true, the server will delete the Job even if the corresponding nodes have not fully processed the deletion. The default value is false.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Delete Job": { + "$ref": "./examples/Jobs_DeleteJob.json" + } + } + } + }, + "/jobs/{jobId}/addtaskcollection": { + "post": { + "operationId": "Tasks_CreateTaskCollection", + "tags": [ + "Tasks" + ], + "summary": "Adds a collection of Tasks to the specified Job.", + "description": "Note that each Task must have a unique ID. The Batch service may not return the\nresults for each Task in the same order the Tasks were submitted in this\nrequest. If the server times out or the connection is closed during the\nrequest, the request may have been partially or fully processed, or not at all.\nIn such cases, the user should re-issue the request. Note that it is up to the\nuser to correctly handle failures when re-issuing a request. For example, you\nshould use the same Task IDs during a retry so that if the prior operation\nsucceeded, the retry will not create extra Tasks unexpectedly. If the response\ncontains any Tasks which failed to add, a client can retry the request. In a\nretry, it is most efficient to resubmit only Tasks that failed to add, and to\nomit Tasks that were successfully added on the first attempt. The maximum\nlifetime of a Task from addition to completion is 180 days. If a Task has not\ncompleted within 180 days of being added it will be terminated by the Batch\nservice and left in whatever state it was in at that time.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to which the Task collection is to be added.", + "required": true, + "type": "string" + }, + { + "name": "taskCollection", + "in": "body", + "description": "The Tasks to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchTaskGroup" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchTaskAddCollectionResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Creates a basic collection of tasks": { + "$ref": "./examples/Tasks_CreateTaskCollection_Basic.json" + }, + "Creates a complex collection of tasks": { + "$ref": "./examples/Tasks_CreateTaskCollection_Complex.json" + } + } + } + }, + "/jobs/{jobId}/disable": { + "post": { + "operationId": "Jobs_DisableJob", + "tags": [ + "Jobs" + ], + "summary": "Disables the specified Job, preventing new Tasks from running.", + "description": "The Batch Service immediately moves the Job to the disabling state. Batch then\nuses the disableTasks parameter to determine what to do with the currently\nrunning Tasks of the Job. The Job remains in the disabling state until the\ndisable operation is completed and all Tasks have been dealt with according to\nthe disableTasks option; the Job then moves to the disabled state. No new Tasks\nare started under the Job until it moves back to active state. If you try to\ndisable a Job that is in any state other than active, disabling, or disabled,\nthe request fails with status code 409.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to disable.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for disabling the Job.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobDisableContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job disable": { + "$ref": "./examples/Jobs_DisableJob.json" + } + } + } + }, + "/jobs/{jobId}/enable": { + "post": { + "operationId": "Jobs_EnableJob", + "tags": [ + "Jobs" + ], + "summary": "Enables the specified Job, allowing new Tasks to run.", + "description": "When you call this API, the Batch service sets a disabled Job to the enabling\nstate. After the this operation is completed, the Job moves to the active\nstate, and scheduling of new Tasks under the Job resumes. The Batch service\ndoes not allow a Task to remain in the active state for more than 180 days.\nTherefore, if you enable a Job containing active Tasks which were added more\nthan 180 days ago, those Tasks will not run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to enable.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job enable": { + "$ref": "./examples/Jobs_EnableJob.json" + } + } + } + }, + "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { + "get": { + "operationId": "Jobs_ListJobPreparationAndReleaseTaskStatus", + "tags": [ + "Jobs" + ], + "summary": "Lists the execution status of the Job Preparation and Job Release Task for the\nspecified Job across the Compute Nodes where the Job has run.", + "description": "This API returns the Job Preparation and Job Release Task status on all Compute\nNodes that have run the Job Preparation or Job Release Task. This includes\nCompute Nodes which have since been removed from the Pool. If this API is\ninvoked on a Job which has no Job Preparation or Job Release Task, the Batch\nservice returns HTTP status code 409 (Conflict) with an error code of\nJobPreparationTaskNotSpecified.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJobPreparationAndReleaseTaskStatusListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job list preparation and release task status": { + "$ref": "./examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/jobs/{jobId}/taskcounts": { + "get": { + "operationId": "Jobs_GetJobTaskCounts", + "tags": [ + "Jobs" + ], + "summary": "Gets the Task counts for the specified Job.", + "description": "Task counts provide a count of the Tasks by active, running or completed Task\nstate, and a count of Tasks which succeeded or failed. Tasks in the preparing\nstate are counted as running. Note that the numbers returned may not always be\nup to date. If you need exact task counts, use a list query.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchTaskCountsResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job get task counts": { + "$ref": "./examples/Jobs_GetJobTaskCounts.json" + } + } + } + }, + "/jobs/{jobId}/tasks": { + "get": { + "operationId": "Tasks_ListTasks", + "tags": [ + "Tasks" + ], + "summary": "Lists all of the Tasks that are associated with the specified Job.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and\nnodeInfo refer to the primary Task. Use the list subtasks API to retrieve\ninformation about subtasks.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchTaskListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task list": { + "$ref": "./examples/Tasks_ListTasks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + }, + "post": { + "operationId": "Tasks_CreateTask", + "tags": [ + "Tasks" + ], + "summary": "Creates a Task to the specified Job.", + "description": "The maximum lifetime of a Task from addition to completion is 180 days. If a\nTask has not completed within 180 days of being added it will be terminated by\nthe Batch service and left in whatever state it was in at that time.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to which the Task is to be created.", + "required": true, + "type": "string" + }, + { + "name": "task", + "in": "body", + "description": "The Task to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchTaskCreateContent" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Creates a basic task": { + "$ref": "./examples/Tasks_CreateTask_Basic.json" + }, + "Creates a task with container settings": { + "$ref": "./examples/Tasks_CreateTask_ContainerSettings.json" + }, + "Creates a task with container settings with data isolation": { + "$ref": "./examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json" + }, + "Creates a task with container settings with duplicate source": { + "$ref": "./examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json" + }, + "Creates a task with exit conditions": { + "$ref": "./examples/Tasks_CreateTask_ExitConditions.json" + }, + "Creates a task with extra slot requirement": { + "$ref": "./examples/Tasks_CreateTask_RequiredSlots.json" + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}": { + "get": { + "operationId": "Tasks_GetTask", + "tags": [ + "Tasks" + ], + "summary": "Gets information about the specified Task.", + "description": "For multi-instance Tasks, information such as affinityId, executionInfo and\nnodeInfo refer to the primary Task. Use the list subtasks API to retrieve\ninformation about subtasks.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job that contains the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task to get information about.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchTask" + }, + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task get": { + "$ref": "./examples/Tasks_GetTask.json" + } + } + }, + "put": { + "operationId": "Tasks_ReplaceTask", + "tags": [ + "Tasks" + ], + "description": "Updates the properties of the specified Task.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job containing the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task to update.", + "required": true, + "type": "string" + }, + { + "name": "task", + "in": "body", + "description": "The Task to update.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchTask" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task update": { + "$ref": "./examples/Tasks_ReplaceTask.json" + } + } + }, + "delete": { + "operationId": "Tasks_DeleteTask", + "tags": [ + "Tasks" + ], + "summary": "Deletes a Task from the specified Job.", + "description": "When a Task is deleted, all of the files in its directory on the Compute Node\nwhere it ran are also deleted (regardless of the retention time). For\nmulti-instance Tasks, the delete Task operation applies synchronously to the\nprimary task; subtasks and their files are then deleted asynchronously in the\nbackground.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job from which to delete the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task delete": { + "$ref": "./examples/Tasks_DeleteTask.json" + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files": { + "get": { + "operationId": "Tasks_ListTaskFiles", + "tags": [ + "Tasks" + ], + "summary": "Lists the files in a Task's directory on its Compute Node.", + "description": "Lists the files in a Task's directory on its Compute Node.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job that contains the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task whose files you want to list.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files.", + "required": false, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "Whether to list children of the Task directory. This parameter can be used in\ncombination with the filter parameter to list specific type of files.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeFileListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File list from task": { + "$ref": "./examples/Tasks_ListTaskFiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files/{filePath}": { + "get": { + "operationId": "Tasks_GetTaskFile", + "tags": [ + "Tasks" + ], + "description": "Returns the content of the specified Task file.", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job that contains the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task whose file you want to retrieve.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the Task file that you want to get the content of.", + "required": true, + "type": "string" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "ocp-range", + "in": "header", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The\nformat is bytes=startRange-endRange.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + }, + "headers": { + "Content-Length": { + "type": "string", + "description": "The length of the file." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "ocp-batch-file-isdirectory": { + "type": "boolean", + "description": "Whether the object represents a directory." + }, + "ocp-batch-file-mode": { + "type": "string", + "description": "The file mode attribute in octal format." + }, + "ocp-batch-file-url": { + "type": "string", + "description": "The URL of the file." + }, + "ocp-creation-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The file creation time." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Get File From Task": { + "$ref": "./examples/Tasks_GetTaskFile.json" + } + } + }, + "delete": { + "operationId": "Tasks_DeleteTaskFile", + "tags": [ + "Tasks" + ], + "summary": "Deletes the specified Task file from the Compute Node where the Task ran.", + "description": "Deletes the specified Task file from the Compute Node where the Task ran.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job that contains the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task whose file you want to retrieve.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the Task file that you want to get the content of.", + "required": true, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "Whether to delete children of a directory. If the filePath parameter represents\na directory instead of a file, you can set recursive to true to delete the\ndirectory and all of the files and subdirectories in it. If recursive is false\nthen the directory must be empty or deletion will fail.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File delete from task": { + "$ref": "./examples/Tasks_DeleteTaskFile.json" + } + } + }, + "head": { + "operationId": "Tasks_GetTaskFileProperties", + "tags": [ + "Tasks" + ], + "description": "Gets the properties of the specified Task file.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job that contains the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task whose file you want to retrieve.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the Task file that you want to get the content of.", + "required": true, + "type": "string" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Content-Length": { + "type": "string", + "description": "The length of the file." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "ocp-batch-file-isdirectory": { + "type": "boolean", + "description": "Whether the object represents a directory." + }, + "ocp-batch-file-mode": { + "type": "string", + "description": "The file mode attribute in octal format." + }, + "ocp-batch-file-url": { + "type": "string", + "description": "The URL of the file." + }, + "ocp-creation-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The file creation time." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File get properties from task": { + "$ref": "./examples/Tasks_GetTaskFileProperties.json" + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/reactivate": { + "post": { + "operationId": "Tasks_ReactivateTask", + "tags": [ + "Tasks" + ], + "summary": "Reactivates a Task, allowing it to run again even if its retry count has been\nexhausted.", + "description": "Reactivation makes a Task eligible to be retried again up to its maximum retry\ncount. The Task's state is changed to active. As the Task is no longer in the\ncompleted state, any previous exit code or failure information is no longer\navailable after reactivation. Each time a Task is reactivated, its retry count\nis reset to 0. Reactivation will fail for Tasks that are not completed or that\npreviously completed successfully (with an exit code of 0). Additionally, it\nwill fail if the Job has completed (or is terminating or deleting).", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job containing the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task to reactivate.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task reactivate": { + "$ref": "./examples/Tasks_ReactivateTask.json" + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { + "get": { + "operationId": "Tasks_ListSubTasks", + "tags": [ + "Tasks" + ], + "summary": "Lists all of the subtasks that are associated with the specified multi-instance\nTask.", + "description": "If the Task is not a multi-instance Task then this returns an empty collection.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchTaskListSubtasksResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task list subtasks": { + "$ref": "./examples/Tasks_ListSubTasks.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/terminate": { + "post": { + "operationId": "Tasks_TerminateTask", + "tags": [ + "Tasks" + ], + "summary": "Terminates the specified Task.", + "description": "When the Task has been terminated, it moves to the completed state. For\nmulti-instance Tasks, the terminate Task operation applies synchronously to the\nprimary task; subtasks are then terminated asynchronously in the background.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job containing the Task.", + "required": true, + "type": "string" + }, + { + "name": "taskId", + "in": "path", + "description": "The ID of the Task to terminate.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Task terminate": { + "$ref": "./examples/Tasks_TerminateTask.json" + } + } + } + }, + "/jobs/{jobId}/terminate": { + "post": { + "operationId": "Jobs_TerminateJob", + "tags": [ + "Jobs" + ], + "summary": "Terminates the specified Job, marking it as completed.", + "description": "When a Terminate Job request is received, the Batch service sets the Job to the\nterminating state. The Batch service then terminates any running Tasks\nassociated with the Job and runs any required Job release Tasks. Then the Job\nmoves into the completed state. If there are any Tasks in the Job in the active\nstate, they will remain in the active state. Once a Job is terminated, new\nTasks cannot be added and any remaining active Tasks will not be scheduled.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobId", + "in": "path", + "description": "The ID of the Job to terminate.", + "required": true, + "type": "string" + }, + { + "name": "force", + "in": "query", + "description": "If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is false.", + "required": false, + "type": "boolean" + }, + { + "name": "parameters", + "in": "body", + "description": "The options to use for terminating the Job.", + "required": false, + "schema": { + "$ref": "#/definitions/BatchJobTerminateContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Job terminate": { + "$ref": "./examples/Jobs_TerminateJob.json" + } + } + } + }, + "/jobschedules": { + "get": { + "operationId": "JobSchedules_ListJobSchedules", + "tags": [ + "Job Schedules" + ], + "summary": "Lists all of the Job Schedules in the specified Account.", + "description": "Lists all of the Job Schedules in the specified Account.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJobScheduleListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule list": { + "$ref": "./examples/JobSchedules_ListJobSchedules.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + }, + "post": { + "operationId": "JobSchedules_CreateJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Creates a Job Schedule to the specified Account.", + "description": "Creates a Job Schedule to the specified Account.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "jobSchedule", + "in": "body", + "description": "The Job Schedule to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobScheduleCreateContent" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Creates a basic JobSchedule": { + "$ref": "./examples/JobSchedules_CreateJobSchedule_Basic.json" + }, + "Creates a complex JobScheduleAdd": { + "$ref": "./examples/JobSchedules_CreateJobSchedule_Complex.json" + } + } + } + }, + "/jobschedules/{jobScheduleId}": { + "get": { + "operationId": "JobSchedules_GetJobSchedule", + "tags": [ + "Job Schedules" + ], + "description": "Gets information about the specified Job Schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to get.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJobSchedule" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule get": { + "$ref": "./examples/JobSchedules_GetJobSchedule.json" + } + } + }, + "put": { + "operationId": "JobSchedules_ReplaceJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This fully replaces all the updatable properties of the Job Schedule. For\nexample, if the schedule property is not specified with this request, then the\nBatch service will remove the existing schedule. Changes to a Job Schedule only\nimpact Jobs created by the schedule after the update has taken place; currently\nrunning Jobs are unaffected.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to update.", + "required": true, + "type": "string" + }, + { + "name": "jobSchedule", + "in": "body", + "description": "A Job Schedule with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobSchedule" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule patch": { + "$ref": "./examples/JobSchedules_ReplaceJobSchedule.json" + } + } + }, + "patch": { + "operationId": "JobSchedules_UpdateJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Updates the properties of the specified Job Schedule.", + "description": "This replaces only the Job Schedule properties specified in the request. For\nexample, if the schedule property is not specified with this request, then the\nBatch service will keep the existing schedule. Changes to a Job Schedule only\nimpact Jobs created by the schedule after the update has taken place; currently\nrunning Jobs are unaffected.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to update.", + "required": true, + "type": "string" + }, + { + "name": "jobSchedule", + "in": "body", + "description": "The options to use for updating the Job Schedule.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchJobScheduleUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule update": { + "$ref": "./examples/JobSchedules_UpdateJobSchedule.json" + } + } + }, + "delete": { + "operationId": "JobSchedules_DeleteJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Deletes a Job Schedule from the specified Account.", + "description": "When you delete a Job Schedule, this also deletes all Jobs and Tasks under that\nschedule. When Tasks are deleted, all the files in their working directories on\nthe Compute Nodes are also deleted (the retention period is ignored). The Job\nSchedule statistics are no longer accessible once the Job Schedule is deleted,\nthough they are still counted towards Account lifetime statistics.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to delete.", + "required": true, + "type": "string" + }, + { + "name": "force", + "in": "query", + "description": "If true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. The default value is false.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule delete": { + "$ref": "./examples/JobSchedules_DeleteJobSchedule.json" + } + } + }, + "head": { + "operationId": "JobSchedules_JobScheduleExists", + "tags": [ + "Job Schedules" + ], + "summary": "Checks the specified Job Schedule exists.", + "description": "Checks the specified Job Schedule exists.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule which you want to check.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Check Job Schedule Exists": { + "$ref": "./examples/JobSchedules_JobScheduleExists.json" + } + } + } + }, + "/jobschedules/{jobScheduleId}/disable": { + "post": { + "operationId": "JobSchedules_DisableJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Disables a Job Schedule.", + "description": "No new Jobs will be created until the Job Schedule is enabled again.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to disable.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule disable": { + "$ref": "./examples/JobSchedules_DisableJobSchedule.json" + } + } + } + }, + "/jobschedules/{jobScheduleId}/enable": { + "post": { + "operationId": "JobSchedules_EnableJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Enables a Job Schedule.", + "description": "Enables a Job Schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to enable.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule enable": { + "$ref": "./examples/JobSchedules_EnableJobSchedule.json" + } + } + } + }, + "/jobschedules/{jobScheduleId}/jobs": { + "get": { + "operationId": "Jobs_ListJobsFromSchedule", + "tags": [ + "Jobs" + ], + "summary": "Lists the Jobs that have been created under the specified Job Schedule.", + "description": "Lists the Jobs that have been created under the specified Job Schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule from which you want to get a list of Jobs.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchJobListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "List Job Under Job Schedule": { + "$ref": "./examples/Jobs_ListJobsFromSchedule.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/jobschedules/{jobScheduleId}/terminate": { + "post": { + "operationId": "JobSchedules_TerminateJobSchedule", + "tags": [ + "Job Schedules" + ], + "summary": "Terminates a Job Schedule.", + "description": "Terminates a Job Schedule.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "jobScheduleId", + "in": "path", + "description": "The ID of the Job Schedule to terminates.", + "required": true, + "type": "string" + }, + { + "name": "force", + "in": "query", + "description": "If true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. The default value is false.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "JobSchedule terminate": { + "$ref": "./examples/JobSchedules_TerminateJobSchedule.json" + } + } + } + }, + "/nodecounts": { + "get": { + "operationId": "Pools_ListPoolNodeCounts", + "tags": [ + "Pools" + ], + "description": "Gets the number of Compute Nodes in each state, grouped by Pool. Note that the\nnumbers returned may not always be up to date. If you need exact node counts,\nuse a list query.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchPoolNodeCountsListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "NodeCountsPayload": { + "$ref": "./examples/Pools_ListPoolNodeCounts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/pools": { + "get": { + "operationId": "Pools_ListPools", + "tags": [ + "Pools" + ], + "summary": "Lists all of the Pools which be mounted.", + "description": "Lists all of the Pools which be mounted.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchPoolListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool list": { + "$ref": "./examples/Pools_ListPools_Basic.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + }, + "post": { + "operationId": "Pools_CreatePool", + "tags": [ + "Pools" + ], + "summary": "Creates a Pool to the specified Account.", + "description": "When naming Pools, avoid including sensitive information such as user names or\nsecret project names. This information may appear in telemetry logs accessible\nto Microsoft Support engineers.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "pool", + "in": "body", + "description": "The Pool to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolCreateContent" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Creates a VirtualMachineConfiguration pool": { + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfiguration.json" + }, + "Creates a VirtualMachineConfiguration pool with OS disk": { + "$ref": "./examples/Pools_CreatePool_OSDisk.json" + }, + "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference": { + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json" + }, + "Creates a VirtualMachineConfiguration pool with containers": { + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json" + }, + "Creates a VirtualMachineConfiguration pool with extensions": { + "$ref": "./examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json" + }, + "Creates a pool with SecurityProfile": { + "$ref": "./examples/Pools_CreatePool_SecurityProfile.json" + }, + "Creates a pool with accelerated networking": { + "$ref": "./examples/Pools_CreatePool_AcceleratedNetworking.json" + }, + "Creates a pool with mount drive specified": { + "$ref": "./examples/Pools_CreatePool_MountConfiguration.json" + }, + "Creates a simple pool with resourceTags": { + "$ref": "./examples/Pools_CreatePool_ResourceTags.json" + } + } + } + }, + "/pools/{poolId}": { + "get": { + "operationId": "Pools_GetPool", + "tags": [ + "Pools" + ], + "description": "Gets information about the specified Pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + }, + { + "name": "$expand", + "in": "query", + "description": "An OData $expand clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchPool" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Add a VirtualMachineConfiguration pool with OS disk": { + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json" + }, + "Get a VirtualMachineConfiguration pool with SecurityProfile": { + "$ref": "./examples/Pools_GetPool_SecurityProfile.json" + }, + "Get a VirtualMachineConfiguration pool with ServiceArtifactReference": { + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json" + }, + "Get a VirtualMachineConfiguration pool with extensions": { + "$ref": "./examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json" + }, + "Get a pool with AcceleratedNetworking": { + "$ref": "./examples/Pools_GetPool_AcceleratedNetworking.json" + }, + "Pool get": { + "$ref": "./examples/Pools_GetPool_Basic.json" + } + } + }, + "patch": { + "operationId": "Pools_UpdatePool", + "tags": [ + "Pools" + ], + "summary": "Updates the properties of the specified Pool.", + "description": "This only replaces the Pool properties specified in the request. For example,\nif the Pool has a StartTask associated with it, and a request does not specify\na StartTask element, then the Pool keeps the existing StartTask.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + }, + { + "name": "pool", + "in": "body", + "description": "The pool properties to update.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Patch the Pool": { + "$ref": "./examples/Pools_UpdatePool.json" + } + } + }, + "delete": { + "operationId": "Pools_DeletePool", + "tags": [ + "Pools" + ], + "summary": "Deletes a Pool from the specified Account.", + "description": "When you request that a Pool be deleted, the following actions occur: the Pool\nstate is set to deleting; any ongoing resize operation on the Pool are stopped;\nthe Batch service starts resizing the Pool to zero Compute Nodes; any Tasks\nrunning on existing Compute Nodes are terminated and requeued (as if a resize\nPool operation had been requested with the default requeue option); finally,\nthe Pool is removed from the system. Because running Tasks are requeued, the\nuser can rerun these Tasks by updating their Job to target a different Pool.\nThe Tasks can then run on the new Pool. If you want to override the requeue\nbehavior, then you should call resize Pool explicitly to shrink the Pool to\nzero size before deleting the Pool. If you call an Update, Patch or Delete API\non a Pool in the deleting state, it will fail with HTTP status code 409 with\nerror code PoolBeingDeleted.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool delete": { + "$ref": "./examples/Pools_DeletePool.json" + } + } + }, + "head": { + "operationId": "Pools_PoolExists", + "tags": [ + "Pools" + ], + "description": "Gets basic properties of a Pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "404": { + "description": "The server cannot find the requested resource." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Check Pool Exists": { + "$ref": "./examples/Pools_PoolExists.json" + } + } + } + }, + "/pools/{poolId}/disableautoscale": { + "post": { + "operationId": "Pools_DisablePoolAutoScale", + "tags": [ + "Pools" + ], + "summary": "Disables automatic scaling for a Pool.", + "description": "Disables automatic scaling for a Pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool on which to disable automatic scaling.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Disable pool autoscale": { + "$ref": "./examples/Pools_DisablePoolAutoScale.json" + } + } + } + }, + "/pools/{poolId}/enableautoscale": { + "post": { + "operationId": "Pools_EnablePoolAutoScale", + "tags": [ + "Pools" + ], + "summary": "Enables automatic scaling for a Pool.", + "description": "You cannot enable automatic scaling on a Pool if a resize operation is in\nprogress on the Pool. If automatic scaling of the Pool is currently disabled,\nyou must specify a valid autoscale formula as part of the request. If automatic\nscaling of the Pool is already enabled, you may specify a new autoscale formula\nand/or a new evaluation interval. You cannot call this API for the same Pool\nmore than once every 30 seconds.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for enabling automatic scaling.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolEnableAutoScaleContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool enable autoscale": { + "$ref": "./examples/Pools_EnablePoolAutoscale.json" + } + } + } + }, + "/pools/{poolId}/evaluateautoscale": { + "post": { + "operationId": "Pools_EvaluatePoolAutoScale", + "tags": [ + "Pools" + ], + "summary": "Gets the result of evaluating an automatic scaling formula on the Pool.", + "description": "This API is primarily for validating an autoscale formula, as it simply returns\nthe result without applying the formula to the Pool. The Pool must have auto\nscaling enabled in order to evaluate a formula.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool on which to evaluate the automatic scaling formula.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for evaluating the automatic scaling formula.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolEvaluateAutoScaleContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AutoScaleRun" + }, + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool evaluate autoscale": { + "$ref": "./examples/Pools_EvaluatePoolAutoscale.json" + } + } + } + }, + "/pools/{poolId}/nodes": { + "get": { + "operationId": "Nodes_ListNodes", + "tags": [ + "Nodes" + ], + "summary": "Lists the Compute Nodes in the specified Pool.", + "description": "Lists the Compute Nodes in the specified Pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool from which you want to list Compute Nodes.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.", + "required": false, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node list": { + "$ref": "./examples/Nodes_ListNodes.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/pools/{poolId}/nodes/{nodeId}": { + "get": { + "operationId": "Nodes_GetNode", + "tags": [ + "Nodes" + ], + "summary": "Gets information about the specified Compute Node.", + "description": "Gets information about the specified Compute Node.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to get information about.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNode" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node get": { + "$ref": "./examples/Nodes_GetNode.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/deallocate": { + "post": { + "operationId": "Nodes_DeallocateNode", + "tags": [ + "Nodes" + ], + "summary": "Deallocates the specified Compute Node.", + "description": "You can deallocate a Compute Node only if it is in an idle or running state.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to restart.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The options to use for deallocating the Compute Node.", + "required": false, + "schema": { + "$ref": "#/definitions/BatchNodeDeallocateContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node Deallocate": { + "$ref": "./examples/Node_DeallocateNode.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { + "post": { + "operationId": "Nodes_DisableNodeScheduling", + "tags": [ + "Nodes" + ], + "summary": "Disables Task scheduling on the specified Compute Node.", + "description": "You can disable Task scheduling on a Compute Node only if its current\nscheduling state is enabled.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node on which you want to disable Task scheduling.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The options to use for disabling scheduling on the Compute Node.", + "required": false, + "schema": { + "$ref": "#/definitions/BatchNodeDisableSchedulingContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node disable scheduling": { + "$ref": "./examples/Nodes_DisableNodeScheduling.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { + "post": { + "operationId": "Nodes_EnableNodeScheduling", + "tags": [ + "Nodes" + ], + "summary": "Enables Task scheduling on the specified Compute Node.", + "description": "You can enable Task scheduling on a Compute Node only if its current scheduling\nstate is disabled", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node on which you want to enable Task scheduling.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node enable scheduling": { + "$ref": "./examples/Nodes_EnableNodeScheduling.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/extensions": { + "get": { + "operationId": "Nodes_ListNodeExtensions", + "tags": [ + "Nodes" + ], + "summary": "Lists the Compute Nodes Extensions in the specified Pool.", + "description": "Lists the Compute Nodes Extensions in the specified Pool.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to list extensions.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeVMExtensionListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "List compute node extensions": { + "$ref": "./examples/Nodes_ListNodeExtensions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/extensions/{extensionName}": { + "get": { + "operationId": "Nodes_GetNodeExtension", + "tags": [ + "Nodes" + ], + "summary": "Gets information about the specified Compute Node Extension.", + "description": "Gets information about the specified Compute Node Extension.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that contains the extensions.", + "required": true, + "type": "string" + }, + { + "name": "extensionName", + "in": "path", + "description": "The name of the Compute Node Extension that you want to get information about.", + "required": true, + "type": "string" + }, + { + "name": "$select", + "in": "query", + "description": "An OData $select clause.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeVMExtension" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Get batch node extension": { + "$ref": "./examples/Nodes_GetNodeExtension.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files": { + "get": { + "operationId": "Nodes_ListNodeFiles", + "tags": [ + "Nodes" + ], + "summary": "Lists all of the files in Task directories on the specified Compute Node.", + "description": "Lists all of the files in Task directories on the specified Compute Node.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node whose files you want to list.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.", + "required": false, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "Whether to list children of a directory.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeFileListResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File list from node": { + "$ref": "./examples/Nodes_ListNodeFiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files/{filePath}": { + "get": { + "operationId": "Nodes_GetNodeFile", + "tags": [ + "Nodes" + ], + "description": "Returns the content of the specified Compute Node file.", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the file or directory.", + "required": true, + "type": "string" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "ocp-range", + "in": "header", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The\nformat is bytes=startRange-endRange.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "file" + }, + "headers": { + "Content-Length": { + "type": "string", + "description": "The length of the file." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "ocp-batch-file-isdirectory": { + "type": "boolean", + "description": "Whether the object represents a directory." + }, + "ocp-batch-file-mode": { + "type": "string", + "description": "The file mode attribute in octal format." + }, + "ocp-batch-file-url": { + "type": "string", + "description": "The URL of the file." + }, + "ocp-creation-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The file creation time." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Get File From Compute Node": { + "$ref": "./examples/Nodes_GetNodeFile.json" + } + } + }, + "delete": { + "operationId": "Nodes_DeleteNodeFile", + "tags": [ + "Nodes" + ], + "summary": "Deletes the specified file from the Compute Node.", + "description": "Deletes the specified file from the Compute Node.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the file or directory.", + "required": true, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "Whether to delete children of a directory. If the filePath parameter represents\na directory instead of a file, you can set recursive to true to delete the\ndirectory and all of the files and subdirectories in it. If recursive is false\nthen the directory must be empty or deletion will fail.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File delete from node": { + "$ref": "./examples/Nodes_DeleteNodeFile.json" + } + } + }, + "head": { + "operationId": "Nodes_GetNodeFileProperties", + "tags": [ + "Nodes" + ], + "description": "Gets the properties of the specified Compute Node file.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "filePath", + "in": "path", + "description": "The path to the file or directory.", + "required": true, + "type": "string" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "Content-Length": { + "type": "string", + "description": "The length of the file." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "ocp-batch-file-isdirectory": { + "type": "boolean", + "description": "Whether the object represents a directory." + }, + "ocp-batch-file-mode": { + "type": "string", + "description": "The file mode attribute in octal format." + }, + "ocp-batch-file-url": { + "type": "string", + "description": "The URL of the file." + }, + "ocp-creation-time": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The file creation time." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "File get properties from node": { + "$ref": "./examples/Nodes_GetNodeFileProperties.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reboot": { + "post": { + "operationId": "Nodes_RebootNode", + "tags": [ + "Nodes" + ], + "summary": "Restarts the specified Compute Node.", + "description": "You can restart a Compute Node only if it is in an idle or running state.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to restart.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The options to use for rebooting the Compute Node.", + "required": false, + "schema": { + "$ref": "#/definitions/BatchNodeRebootContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node reboot": { + "$ref": "./examples/Nodes_RebootNode.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reimage": { + "post": { + "operationId": "Nodes_ReimageNode", + "tags": [ + "Nodes" + ], + "summary": "Reinstalls the operating system on the specified Compute Node.", + "description": "You can reinstall the operating system on a Compute Node only if it is in an\nidle or running state. This API can be invoked only on Pools created with the\ncloud service configuration property.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to restart.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The options to use for reimaging the Compute Node.", + "required": false, + "schema": { + "$ref": "#/definitions/BatchNodeReimageContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node reimage": { + "$ref": "./examples/Nodes_NodeReimage.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/remoteloginsettings": { + "get": { + "operationId": "Nodes_GetNodeRemoteLoginSettings", + "tags": [ + "Nodes" + ], + "summary": "Gets the settings required for remote login to a Compute Node.", + "description": "Before you can remotely login to a Compute Node using the remote login settings, \nyou must create a user Account on the Compute Node.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node for which to obtain the remote login settings.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchNodeRemoteLoginSettings" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node get remote login settings": { + "$ref": "./examples/Nodes_GetNodeRemoteLoginSettings.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/start": { + "post": { + "operationId": "Nodes_StartNode", + "tags": [ + "Nodes" + ], + "summary": "Starts the specified Compute Node.", + "description": "You can start a Compute Node only if it has been deallocated.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node that you want to restart.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node start": { + "$ref": "./examples/Node_StartNode.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs": { + "post": { + "operationId": "Nodes_UploadNodeLogs", + "tags": [ + "Nodes" + ], + "summary": "Upload Azure Batch service log files from the specified Compute Node to Azure\nBlob Storage.", + "description": "This is for gathering Azure Batch service log files in an automated fashion\nfrom Compute Nodes if you are experiencing an error and wish to escalate to\nAzure support. The Azure Batch service log files should be shared with Azure\nsupport to aid in debugging issues with the Batch service.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the Compute Node for which you want to get the Remote Desktop\nProtocol file.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The Azure Batch service log files upload options.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Upload BatchService Logs": { + "$ref": "./examples/Nodes_UploadNodeLogs.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users": { + "post": { + "operationId": "Nodes_CreateNodeUser", + "tags": [ + "Nodes" + ], + "summary": "Adds a user Account to the specified Compute Node.", + "description": "You can add a user Account to a Compute Node only when it is in the idle or\nrunning state.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the machine on which you want to create a user Account.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The options to use for creating the user.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchNodeUserCreateContent" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node create user": { + "$ref": "./examples/Nodes_CreateNodeUser.json" + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { + "put": { + "operationId": "Nodes_ReplaceNodeUser", + "tags": [ + "Nodes" + ], + "summary": "Updates the password and expiration time of a user Account on the specified Compute Node.", + "description": "This operation replaces of all the updatable properties of the Account. For\nexample, if the expiryTime element is not specified, the current value is\nreplaced with the default value, not left unmodified. You can update a user\nAccount on a Compute Node only when it is in the idle or running state.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the machine on which you want to update a user Account.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user Account to update.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for updating the user.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchNodeUserUpdateContent" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node update user": { + "$ref": "./examples/Nodes_ReplaceNodeUser.json" + } + } + }, + "delete": { + "operationId": "Nodes_DeleteNodeUser", + "tags": [ + "Nodes" + ], + "summary": "Deletes a user Account from the specified Compute Node.", + "description": "You can delete a user Account to a Compute Node only when it is in the idle or\nrunning state.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool that contains the Compute Node.", + "required": true, + "type": "string" + }, + { + "name": "nodeId", + "in": "path", + "description": "The ID of the machine on which you want to delete a user Account.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user Account to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "headers": { + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Node delete user": { + "$ref": "./examples/Nodes_DeleteNodeUser.json" + } + } + } + }, + "/pools/{poolId}/removenodes": { + "post": { + "operationId": "Pools_RemoveNodes", + "tags": [ + "Pools" + ], + "summary": "Removes Compute Nodes from the specified Pool.", + "description": "This operation can only run when the allocation state of the Pool is steady.\nWhen this operation runs, the allocation state changes from steady to resizing.\nEach request may remove up to 100 nodes.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for removing the node.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchNodeRemoveContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool remove nodes": { + "$ref": "./examples/Pools_RemoveNodes.json" + } + } + } + }, + "/pools/{poolId}/resize": { + "post": { + "operationId": "Pools_ResizePool", + "tags": [ + "Pools" + ], + "summary": "Changes the number of Compute Nodes that are assigned to a Pool.", + "description": "You can only resize a Pool when its allocation state is steady. If the Pool is\nalready resizing, the request fails with status code 409. When you resize a\nPool, the Pool's allocation state changes from steady to resizing. You cannot\nresize Pools which are configured for automatic scaling. If you try to do this,\nthe Batch service returns an error 409. If you resize a Pool downwards, the\nBatch service chooses which Compute Nodes to remove. To remove specific Compute\nNodes, use the Pool remove Compute Nodes API instead.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + }, + { + "name": "content", + "in": "body", + "description": "The options to use for resizing the pool.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolResizeContent" + } + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool resize": { + "$ref": "./examples/Pools_ResizePool.json" + } + } + } + }, + "/pools/{poolId}/stopresize": { + "post": { + "operationId": "Pools_StopPoolResize", + "tags": [ + "Pools" + ], + "summary": "Stops an ongoing resize operation on the Pool.", + "description": "This does not restore the Pool to its previous state before the resize\noperation: it only stops any further changes being made, and the Pool maintains\nits current state. After stopping, the Pool stabilizes at the number of Compute\nNodes it was at when the stop operation was done. During the stop operation,\nthe Pool allocation state changes first to stopping and then to steady. A\nresize operation need not be an explicit resize Pool request; this API can also\nbe used to halt the initial sizing of the Pool when it is created.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "If-Modified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nbeen modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifModifiedSince" + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "description": "A timestamp indicating the last modified time of the resource known to the\nclient. The operation will be performed only if the resource on the service has\nnot been modified since the specified time.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ifUnmodifiedSince" + }, + { + "name": "If-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice exactly matches the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifMatch" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "An ETag value associated with the version of the resource known to the client.\nThe operation will be performed only if the resource's current ETag on the\nservice does not match the value specified by the client.", + "required": false, + "type": "string", + "x-ms-client-name": "ifNoneMatch" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to get.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but processing has not yet completed.", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool stop resize": { + "$ref": "./examples/Pools_StopPoolResize.json" + } + } + } + }, + "/pools/{poolId}/updateproperties": { + "post": { + "operationId": "Pools_ReplacePoolProperties", + "tags": [ + "Pools" + ], + "summary": "Updates the properties of the specified Pool.", + "description": "This fully replaces all the updatable properties of the Pool. For example, if\nthe Pool has a StartTask associated with it and if StartTask is not specified\nwith this request, then the Batch service will remove the existing StartTask.", + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "poolId", + "in": "path", + "description": "The ID of the Pool to update.", + "required": true, + "type": "string" + }, + { + "name": "pool", + "in": "body", + "description": "The options to use for replacing properties on the pool.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPoolReplaceContent" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. ", + "headers": { + "DataServiceId": { + "type": "string", + "description": "The OData ID of the resource to which the request applied." + }, + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool update": { + "$ref": "./examples/Pools_ReplacePoolProperties.json" + } + } + } + }, + "/poolusagemetrics": { + "get": { + "operationId": "Pools_ListPoolUsageMetrics", + "tags": [ + "Pools" + ], + "summary": "Lists the usage metrics, aggregated by Pool across individual time intervals,\nfor the specified Account.", + "description": "If you do not specify a $filter clause including a poolId, the response\nincludes all Pools that existed in the Account in the time range of the\nreturned aggregation intervals. If you do not specify a $filter clause\nincluding a startTime or endTime these filters default to the start and end\ntimes of the last aggregation interval currently available; that is, only the\nlast aggregation interval is returned.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "startTime", + "in": "query", + "description": "The earliest time from which to include metrics. This must be at least two and\na half hours before the current time. If not specified this defaults to the\nstart time of the last aggregation interval currently available.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "endtime", + "in": "query", + "description": "The latest time from which to include metrics. This must be at least two hours\nbefore the current time. If not specified this defaults to the end time of the\nlast aggregation interval currently available.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchPoolListUsageMetricsResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Pool list usage metrics": { + "$ref": "./examples/Pools_ListPoolUsageMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + }, + "/supportedimages": { + "get": { + "operationId": "Pools_ListSupportedImages", + "tags": [ + "Pools" + ], + "summary": "Lists all Virtual Machine Images supported by the Azure Batch service.", + "description": "Lists all Virtual Machine Images supported by the Azure Batch service.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "timeOut", + "in": "query", + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\".", + "required": false, + "type": "integer", + "format": "int32", + "default": 30 + }, + { + "name": "client-request-id", + "in": "header", + "description": "The caller-generated request identity, in the form of a GUID with no decoration\nsuch as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "required": false, + "type": "string", + "x-ms-client-name": "clientRequestId" + }, + { + "name": "return-client-request-id", + "in": "header", + "description": "Whether the server should return the client-request-id in the response.", + "required": false, + "type": "boolean", + "default": false, + "x-ms-client-name": "returnClientRequestId" + }, + { + "name": "ocp-date", + "in": "header", + "description": "The time the request was issued. Client libraries typically set this to the\ncurrent system clock time; set it explicitly if you are calling the REST API\ndirectly.", + "required": false, + "type": "string", + "format": "date-time-rfc7231", + "x-ms-client-name": "ocpdate" + }, + { + "name": "maxresults", + "in": "query", + "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1000, + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$filter", + "in": "query", + "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/BatchAccountListSupportedImagesResult" + }, + "headers": { + "ETag": { + "type": "string", + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc7231", + "description": "The time at which the resource was last modified." + }, + "client-request-id": { + "type": "string", + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true." + }, + "request-id": { + "type": "string", + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch Account against which the request was made, and the region that Account resides in." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + }, + "x-ms-examples": { + "Account list node agent skus": { + "$ref": "./examples/Pools_ListSupportedImages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + } + } + } + }, + "definitions": { + "AccessScope": { + "type": "string", + "description": "AccessScope enums", + "enum": [ + "job" + ], + "x-ms-enum": { + "name": "AccessScope", + "modelAsString": true, + "values": [ + { + "name": "Job", + "value": "job", + "description": "Grants access to perform all operations on the Job containing the Task." + } + ] + } + }, + "AffinityInfo": { + "type": "object", + "description": "A locality hint that can be used by the Batch service to select a Compute Node\non which to start a Task.", + "properties": { + "affinityId": { + "type": "string", + "description": "An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + } + }, + "required": [ + "affinityId" + ] + }, + "AllocationState": { + "type": "string", + "description": "AllocationState enums", + "enum": [ + "steady", + "resizing", + "stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true, + "values": [ + { + "name": "Steady", + "value": "steady", + "description": "The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in progress. A Pool enters this state when it is created and when no operations are being performed on the Pool to change the number of Compute Nodes." + }, + { + "name": "Resizing", + "value": "resizing", + "description": "The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool." + }, + { + "name": "Stopping", + "value": "stopping", + "description": "The Pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + } + }, + "AuthenticationTokenSettings": { + "type": "object", + "description": "The settings for an authentication token that the Task can use to perform Batch\nservice operations.", + "properties": { + "access": { + "type": "array", + "description": "The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the Job which contains the Task.", + "items": { + "$ref": "#/definitions/AccessScope" + } + } + } + }, + "AutoScaleRun": { + "type": "object", + "description": "The results and errors from an execution of a Pool autoscale formula.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "description": "The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "description": "Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful." + } + }, + "required": [ + "timestamp" + ] + }, + "AutoScaleRunError": { + "type": "object", + "description": "An error that occurred when executing or evaluating a Pool autoscale formula.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the autoscale error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "description": "A list of additional error details related to the autoscale error.", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [] + } + } + }, + "AutoUserScope": { + "type": "string", + "description": "AutoUserScope enums", + "enum": [ + "task", + "pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": true, + "values": [ + { + "name": "Task", + "value": "task", + "description": "Specifies that the service should create a new user for the Task." + }, + { + "name": "Pool", + "value": "pool", + "description": "Specifies that the Task runs as the common auto user Account which is created on every Compute Node in a Pool." + } + ] + } + }, + "AutoUserSpecification": { + "type": "object", + "description": "Specifies the options for the auto user that runs an Azure Batch Task.", + "properties": { + "scope": { + "$ref": "#/definitions/AutoUserScope", + "description": "The scope for the auto user. The default value is pool. If the pool is running Windows, a value of Task should be specified if stricter isolation between tasks is required, such as if the task mutates the registry in a way which could impact other tasks." + }, + "elevationLevel": { + "$ref": "#/definitions/ElevationLevel", + "description": "The elevation level of the auto user. The default value is nonAdmin." + } + } + }, + "AutomaticOsUpgradePolicy": { + "type": "object", + "description": "The configuration parameters used for performing automatic OS upgrade.", + "properties": { + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled." + }, + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) cannot be set to true.", + "x-ms-client-name": "enableAutomaticOsUpgrade" + }, + "useRollingUpgradePolicy": { + "type": "boolean", + "description": "Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS." + }, + "osRollingUpgradeDeferral": { + "type": "boolean", + "description": "Defer OS upgrades on the TVMs if they are running tasks." + } + } + }, + "AzureBlobFileSystemConfiguration": { + "type": "object", + "description": "Information used to connect to an Azure Storage Container using Blobfuse.", + "properties": { + "accountName": { + "type": "string", + "description": "The Azure Storage Account name." + }, + "containerName": { + "type": "string", + "description": "The Azure Blob Storage Container name." + }, + "accountKey": { + "type": "string", + "format": "password", + "description": "The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "sasKey": { + "type": "string", + "format": "password", + "description": "The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be specified.", + "x-ms-secret": true + }, + "blobfuseOptions": { + "type": "string", + "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux." + }, + "relativeMountPath": { + "type": "string", + "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "identityReference": { + "$ref": "#/definitions/BatchNodeIdentityReference", + "description": "The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified." + } + }, + "required": [ + "accountName", + "containerName", + "relativeMountPath" + ] + }, + "AzureFileShareConfiguration": { + "type": "object", + "description": "Information used to connect to an Azure Fileshare.", + "properties": { + "accountName": { + "type": "string", + "description": "The Azure Storage account name." + }, + "azureFileUrl": { + "type": "string", + "description": "The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'." + }, + "accountKey": { + "type": "string", + "format": "password", + "description": "The Azure Storage account key.", + "x-ms-secret": true + }, + "relativeMountPath": { + "type": "string", + "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "accountName", + "azureFileUrl", + "accountKey", + "relativeMountPath" + ] + }, + "BatchAccountListSupportedImagesResult": { + "type": "object", + "description": "The result of listing the supported Virtual Machine Images.", + "properties": { + "value": { + "type": "array", + "description": "The list of supported Virtual Machine Images.", + "items": { + "$ref": "#/definitions/BatchSupportedImage" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchApplication": { + "type": "object", + "description": "Contains information about an application in an Azure Batch Account.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the application within the Account." + }, + "displayName": { + "type": "string", + "description": "The display name for the application." + }, + "versions": { + "type": "array", + "description": "The list of available versions of the application.", + "items": { + "type": "string" + } + } + }, + "required": [ + "id", + "displayName", + "versions" + ] + }, + "BatchApplicationListResult": { + "type": "object", + "description": "The result of listing the applications available in an Account.", + "properties": { + "value": { + "type": "array", + "description": "The list of applications available in the Account.", + "items": { + "$ref": "#/definitions/BatchApplication" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchApplicationPackageReference": { + "type": "object", + "description": "A reference to an Package to be deployed to Compute Nodes.", + "properties": { + "applicationId": { + "type": "string", + "description": "The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName})." + }, + "version": { + "type": "string", + "description": "The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task fails with a pre-processing error." + } + }, + "required": [ + "applicationId" + ] + }, + "BatchAutoPoolSpecification": { + "type": "object", + "description": "Specifies characteristics for a temporary 'auto pool'. The Batch service will\ncreate this auto Pool when the Job is submitted.", + "properties": { + "autoPoolIdPrefix": { + "type": "string", + "description": "A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long." + }, + "poolLifetimeOption": { + "$ref": "#/definitions/BatchPoolLifetimeOption", + "description": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools." + }, + "keepAlive": { + "type": "boolean", + "description": "Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option." + }, + "pool": { + "$ref": "#/definitions/BatchPoolSpecification", + "description": "The Pool specification for the auto Pool." + } + }, + "required": [ + "poolLifetimeOption" + ] + }, + "BatchAutoPoolSpecificationUpdate": { + "type": "object", + "description": "Specifies characteristics for a temporary 'auto pool'. The Batch service will\ncreate this auto Pool when the Job is submitted.", + "properties": { + "autoPoolIdPrefix": { + "type": "string", + "description": "A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long." + }, + "poolLifetimeOption": { + "$ref": "#/definitions/BatchPoolLifetimeOption", + "description": "The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools." + }, + "keepAlive": { + "type": "boolean", + "description": "Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option." + }, + "pool": { + "$ref": "#/definitions/BatchPoolSpecificationUpdate", + "description": "The Pool specification for the auto Pool." + } + } + }, + "BatchError": { + "type": "object", + "description": "An error response received from the Azure Batch service.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "$ref": "#/definitions/BatchErrorMessage", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "description": "A collection of key-value pairs containing additional details about the error.", + "items": { + "$ref": "#/definitions/BatchErrorDetail" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "code" + ] + }, + "BatchErrorDetail": { + "type": "object", + "description": "An item of additional information included in an Azure Batch error response.", + "properties": { + "key": { + "type": "string", + "description": "An identifier specifying the meaning of the Value property." + }, + "value": { + "type": "string", + "description": "The additional information included with the error response." + } + } + }, + "BatchErrorMessage": { + "type": "object", + "description": "An error message received in an Azure Batch error response.", + "properties": { + "lang": { + "type": "string", + "description": "The language code of the error message." + }, + "value": { + "type": "string", + "description": "The text of the message." + } + } + }, + "BatchJob": { + "type": "object", + "description": "An Azure Batch Job.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name for the Job.", + "readOnly": true + }, + "usesTaskDependencies": { + "type": "boolean", + "description": "Whether Tasks in the Job can define dependencies on each other. The default is false.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The URL of the Job.", + "readOnly": true + }, + "eTag": { + "type": "string", + "description": "The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.", + "readOnly": true + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified time of the Job. This is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Job.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/BatchJobState", + "description": "The current state of the Job.", + "readOnly": true + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job entered its current state.", + "readOnly": true + }, + "previousState": { + "$ref": "#/definitions/BatchJobState", + "description": "The previous state of the Job. This property is not set if the Job is in its initial Active state.", + "readOnly": true + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job entered its previous state. This property is not set if the Job is in its initial Active state.", + "readOnly": true + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "allowTaskPreemption": { + "type": "boolean", + "description": "Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.", + "default": -1 + }, + "constraints": { + "$ref": "#/definitions/BatchJobConstraints", + "description": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/BatchJobManagerTask", + "description": "Details of a Job Manager Task to be launched when the Job is started.", + "readOnly": true + }, + "jobPreparationTask": { + "$ref": "#/definitions/BatchJobPreparationTask", + "description": "The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.", + "readOnly": true + }, + "jobReleaseTask": { + "$ref": "#/definitions/BatchJobReleaseTask", + "description": "The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.", + "readOnly": true + }, + "commonEnvironmentSettings": { + "type": "array", + "description": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "poolInfo": { + "$ref": "#/definitions/BatchPoolInfo", + "description": "The Pool settings associated with the Job." + }, + "onAllTasksComplete": { + "$ref": "#/definitions/OnAllBatchTasksComplete", + "description": "The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction." + }, + "onTaskFailure": { + "$ref": "#/definitions/OnBatchTaskFailure", + "description": "The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction.", + "readOnly": true + }, + "networkConfiguration": { + "$ref": "#/definitions/BatchJobNetworkConfiguration", + "description": "The network configuration for the Job.", + "readOnly": true + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "executionInfo": { + "$ref": "#/definitions/BatchJobExecutionInfo", + "description": "The execution information for the Job.", + "readOnly": true + }, + "stats": { + "$ref": "#/definitions/BatchJobStatistics", + "description": "Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "readOnly": true + } + }, + "required": [ + "poolInfo" + ] + }, + "BatchJobAction": { + "type": "string", + "description": "BatchJobAction enums", + "enum": [ + "none", + "disable", + "terminate" + ], + "x-ms-enum": { + "name": "BatchJobAction", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "none", + "description": "Take no action." + }, + { + "name": "Disable", + "value": "disable", + "description": "Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate the Job. The terminationReason in the Job's executionInfo is set to \"TaskFailed\"." + } + ] + } + }, + "BatchJobConstraints": { + "type": "object", + "description": "The execution constraints for a Job.", + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "description": "The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may run." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the Batch service retries Tasks without limit. The default value is 0 (no retries)." + } + } + }, + "BatchJobCreateContent": { + "type": "object", + "description": "Parameters for creating an Azure Batch Job.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "description": "The display name for the Job. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "description": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "allowTaskPreemption": { + "type": "boolean", + "description": "Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.", + "default": -1 + }, + "constraints": { + "$ref": "#/definitions/BatchJobConstraints", + "description": "The execution constraints for the Job." + }, + "jobManagerTask": { + "$ref": "#/definitions/BatchJobManagerTask", + "description": "Details of a Job Manager Task to be launched when the Job is started. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based on those contents." + }, + "jobPreparationTask": { + "$ref": "#/definitions/BatchJobPreparationTask", + "description": "The Job Preparation Task. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/BatchJobReleaseTask", + "description": "The Job Release Task. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Nodes that have run the Job Preparation Task. The primary purpose of the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation." + }, + "commonEnvironmentSettings": { + "type": "array", + "description": "The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "poolInfo": { + "$ref": "#/definitions/BatchPoolInfo", + "description": "The Pool on which the Batch service runs the Job's Tasks." + }, + "onAllTasksComplete": { + "$ref": "#/definitions/OnAllBatchTasksComplete", + "description": "The action the Batch service should take when all Tasks in the Job are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction." + }, + "onTaskFailure": { + "$ref": "#/definitions/OnBatchTaskFailure", + "description": "The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction." + }, + "networkConfiguration": { + "$ref": "#/definitions/BatchJobNetworkConfiguration", + "description": "The network configuration for the Job." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "poolInfo" + ] + }, + "BatchJobDisableContent": { + "type": "object", + "description": "Parameters for disabling an Azure Batch Job.", + "properties": { + "disableTasks": { + "$ref": "#/definitions/DisableBatchJobOption", + "description": "What to do with active Tasks associated with the Job." + } + }, + "required": [ + "disableTasks" + ] + }, + "BatchJobExecutionInfo": { + "type": "object", + "description": "Contains information about the execution of a Job in the Azure Batch service.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the Job. This is the time at which the Job was created." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The completion time of the Job. This property is set only if the Job is in the completed state." + }, + "poolId": { + "type": "string", + "description": "The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool." + }, + "schedulingError": { + "$ref": "#/definitions/BatchJobSchedulingError", + "description": "Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting the Job." + }, + "terminateReason": { + "type": "string", + "description": "A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a Job' operation.", + "x-ms-client-name": "terminationReason" + } + }, + "required": [ + "startTime" + ] + }, + "BatchJobListResult": { + "type": "object", + "description": "The result of listing the Jobs in an Account.", + "properties": { + "value": { + "type": "array", + "description": "The list of Jobs.", + "items": { + "$ref": "#/definitions/BatchJob" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchJobManagerTask": { + "type": "object", + "description": "Specifies details of a Job Manager Task.\nThe Job Manager Task is automatically started when the Job is created. The\nBatch service tries to schedule the Job Manager Task before any other Tasks in\nthe Job. When shrinking a Pool, the Batch service tries to preserve Nodes where\nJob Manager Tasks are running for as long as possible (that is, Compute Nodes\nrunning 'normal' Tasks are removed before Compute Nodes running Job Manager\nTasks). When a Job Manager Task fails and needs to be restarted, the system\ntries to schedule it at the highest priority. If there are no idle Compute\nNodes available, the system may terminate one of the running Tasks in the Pool\nand return it to the queue in order to make room for the Job Manager Task to\nrestart. Note that a Job Manager Task in one Job does not have priority over\nTasks in other Jobs. Across Jobs, only Job level priorities are observed. For\nexample, if a Job Manager in a priority 0 Job needs to be restarted, it will\nnot displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery\noperation is triggered on a Node. Examples of recovery operations include (but\nare not limited to) when an unhealthy Node is rebooted or a Compute Node\ndisappeared due to host failure. Retries due to recovery operations are\nindependent of and are not counted against the maxTaskRetryCount. Even if the\nmaxTaskRetryCount is 0, an internal retry due to a recovery operation may\noccur. Because of this, all Tasks should be idempotent. This means Tasks need\nto tolerate being interrupted and restarted without causing any corruption or\nduplicate data. The best practice for long running Tasks is to use some form of\ncheckpointing.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "description": "The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "outputFiles": { + "type": "array", + "description": "A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Manager Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "Constraints that apply to the Job Manager Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "description": "The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported and must not be specified." + }, + "killJobOnCompletion": { + "type": "boolean", + "description": "Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "runExclusive": { + "type": "boolean", + "description": "Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true." + }, + "applicationPackageReferences": { + "type": "array", + "description": "A list of Application Packages that the Batch service will deploy to the\nCompute Node before running the command line.Application Packages are\ndownloaded and deployed to a shared directory, not the Task working\ndirectory. Therefore, if a referenced Application Package is already\non the Compute Node, and is up to date, then it is not re-downloaded;\nthe existing copy on the Compute Node is used. If a referenced Application\nPackage cannot be installed, for example because the package has been deleted\nor because download failed, the Task fails.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "authenticationTokenSettings": { + "$ref": "#/definitions/AuthenticationTokenSettings", + "description": "The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job." + }, + "allowLowPriorityNode": { + "type": "boolean", + "description": "Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true." + } + }, + "required": [ + "id", + "commandLine" + ] + }, + "BatchJobManagerTaskUpdate": { + "type": "object", + "description": "Specifies details of a Job Manager Task.\nThe Job Manager Task is automatically started when the Job is created. The\nBatch service tries to schedule the Job Manager Task before any other Tasks in\nthe Job. When shrinking a Pool, the Batch service tries to preserve Nodes where\nJob Manager Tasks are running for as long as possible (that is, Compute Nodes\nrunning 'normal' Tasks are removed before Compute Nodes running Job Manager\nTasks). When a Job Manager Task fails and needs to be restarted, the system\ntries to schedule it at the highest priority. If there are no idle Compute\nNodes available, the system may terminate one of the running Tasks in the Pool\nand return it to the queue in order to make room for the Job Manager Task to\nrestart. Note that a Job Manager Task in one Job does not have priority over\nTasks in other Jobs. Across Jobs, only Job level priorities are observed. For\nexample, if a Job Manager in a priority 0 Job needs to be restarted, it will\nnot displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery\noperation is triggered on a Node. Examples of recovery operations include (but\nare not limited to) when an unhealthy Node is rebooted or a Compute Node\ndisappeared due to host failure. Retries due to recovery operations are\nindependent of and are not counted against the maxTaskRetryCount. Even if the\nmaxTaskRetryCount is 0, an internal retry due to a recovery operation may\noccur. Because of this, all Tasks should be idempotent. This means Tasks need\nto tolerate being interrupted and restarted without causing any corruption or\nduplicate data. The best practice for long running Tasks is to use some form of\ncheckpointing.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "description": "The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettingsUpdate", + "description": "The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "outputFiles": { + "type": "array", + "description": "A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Manager Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "Constraints that apply to the Job Manager Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "description": "The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported and must not be specified." + }, + "killJobOnCompletion": { + "type": "boolean", + "description": "Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set killJobOnCompletion to false." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "runExclusive": { + "type": "boolean", + "description": "Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only relevant if the Compute Node allows multiple concurrent Tasks. The default value is true." + }, + "applicationPackageReferences": { + "type": "array", + "description": "A list of Application Packages that the Batch service will deploy to the\nCompute Node before running the command line.Application Packages are\ndownloaded and deployed to a shared directory, not the Task working\ndirectory. Therefore, if a referenced Application Package is already\non the Compute Node, and is up to date, then it is not re-downloaded;\nthe existing copy on the Compute Node is used. If a referenced Application\nPackage cannot be installed, for example because the package has been deleted\nor because download failed, the Task fails.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "authenticationTokenSettings": { + "$ref": "#/definitions/AuthenticationTokenSettings", + "description": "The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job." + }, + "allowLowPriorityNode": { + "type": "boolean", + "description": "Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true." + } + } + }, + "BatchJobNetworkConfiguration": { + "type": "object", + "description": "The network configuration for the Job.", + "properties": { + "subnetId": { + "type": "string", + "description": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "skipWithdrawFromVNet": { + "type": "boolean", + "description": "Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false." + } + }, + "required": [ + "subnetId", + "skipWithdrawFromVNet" + ] + }, + "BatchJobNetworkConfigurationUpdate": { + "type": "object", + "description": "The network configuration for the Job.", + "properties": { + "subnetId": { + "type": "string", + "description": "The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for outbound connections for communications to Azure Storage. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "skipWithdrawFromVNet": { + "type": "boolean", + "description": "Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. Defaults to false." + } + } + }, + "BatchJobPreparationAndReleaseTaskStatus": { + "type": "object", + "description": "The status of the Job Preparation and Job Release Tasks on a Compute Node.", + "properties": { + "poolId": { + "type": "string", + "description": "The ID of the Pool containing the Compute Node to which this entry refers." + }, + "nodeId": { + "type": "string", + "description": "The ID of the Compute Node to which this entry refers." + }, + "nodeUrl": { + "type": "string", + "description": "The URL of the Compute Node to which this entry refers." + }, + "jobPreparationTaskExecutionInfo": { + "$ref": "#/definitions/BatchJobPreparationTaskExecutionInfo", + "description": "Information about the execution status of the Job Preparation Task on this Compute Node." + }, + "jobReleaseTaskExecutionInfo": { + "$ref": "#/definitions/BatchJobReleaseTaskExecutionInfo", + "description": "Information about the execution status of the Job Release Task on this Compute Node. This property is set only if the Job Release Task has run on the Compute Node." + } + } + }, + "BatchJobPreparationAndReleaseTaskStatusListResult": { + "type": "object", + "description": "The result of listing the status of the Job Preparation and Job Release Tasks\nfor a Job.", + "properties": { + "value": { + "type": "array", + "description": "A list of Job Preparation and Job Release Task execution information.", + "items": { + "$ref": "#/definitions/BatchJobPreparationAndReleaseTaskStatus" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchJobPreparationTask": { + "type": "object", + "description": "A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.\nYou can use Job Preparation to prepare a Node to run Tasks for the Job.\nActivities commonly performed in Job Preparation include: Downloading common\nresource files used by all the Tasks in the Job. The Job Preparation Task can\ndownload these common resource files to the shared location on the Node.\n(AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so\nthat all Tasks of that Job can communicate with it. If the Job Preparation Task\nfails (that is, exhausts its retry count before exiting with exit code 0),\nBatch will not run Tasks of this Job on the Node. The Compute Node remains\nineligible to run Tasks of this Job until it is reimaged. The Compute Node\nremains active and can be used for other Jobs. The Job Preparation Task can run\nmultiple times on the same Node. Therefore, you should write the Job\nPreparation Task to handle re-execution. If the Node is rebooted, the Job\nPreparation Task is run again on the Compute Node before scheduling any other\nTask of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job\nPreparation Task did not previously complete. If the Node is reimaged, the Job\nPreparation Task is run again before scheduling any Task of the Job. Batch will\nretry Tasks when a recovery operation is triggered on a Node. Examples of\nrecovery operations include (but are not limited to) when an unhealthy Node is\nrebooted or a Compute Node disappeared due to host failure. Retries due to\nrecovery operations are independent of and are not counted against the\nmaxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to\na recovery operation may occur. Because of this, all Tasks should be\nidempotent. This means Tasks need to tolerate being interrupted and restarted\nwithout causing any corruption or duplicate data. The best practice for long\nrunning Tasks is to use some form of checkpointing.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Preparation Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "Constraints that apply to the Job Preparation Task." + }, + "waitForSuccess": { + "type": "boolean", + "description": "Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes." + }, + "rerunOnNodeRebootAfterSuccess": { + "type": "boolean", + "description": "Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true." + } + }, + "required": [ + "commandLine" + ] + }, + "BatchJobPreparationTaskExecutionInfo": { + "type": "object", + "description": "Contains information about the execution of a Job Preparation Task on a Compute\nNode.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state." + }, + "state": { + "$ref": "#/definitions/BatchJobPreparationTaskState", + "description": "The current state of the Job Preparation Task on the Compute Node." + }, + "taskRootDirectory": { + "type": "string", + "description": "The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "description": "The URL to the root directory of the Job Preparation Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/BatchTaskContainerExecutionInfo", + "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/BatchTaskFailureInfo", + "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "description": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "description": "The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/BatchTaskExecutionResult", + "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "state", + "retryCount" + ] + }, + "BatchJobPreparationTaskState": { + "type": "string", + "description": "BatchJobPreparationTaskState enums", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "BatchJobPreparationTaskState", + "modelAsString": true, + "values": [ + { + "name": "Running", + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "name": "Completed", + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "BatchJobPreparationTaskUpdate": { + "type": "object", + "description": "A Job Preparation Task to run before any Tasks of the Job on any given Compute Node.\nYou can use Job Preparation to prepare a Node to run Tasks for the Job.\nActivities commonly performed in Job Preparation include: Downloading common\nresource files used by all the Tasks in the Job. The Job Preparation Task can\ndownload these common resource files to the shared location on the Node.\n(AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the Node so\nthat all Tasks of that Job can communicate with it. If the Job Preparation Task\nfails (that is, exhausts its retry count before exiting with exit code 0),\nBatch will not run Tasks of this Job on the Node. The Compute Node remains\nineligible to run Tasks of this Job until it is reimaged. The Compute Node\nremains active and can be used for other Jobs. The Job Preparation Task can run\nmultiple times on the same Node. Therefore, you should write the Job\nPreparation Task to handle re-execution. If the Node is rebooted, the Job\nPreparation Task is run again on the Compute Node before scheduling any other\nTask of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job\nPreparation Task did not previously complete. If the Node is reimaged, the Job\nPreparation Task is run again before scheduling any Task of the Job. Batch will\nretry Tasks when a recovery operation is triggered on a Node. Examples of\nrecovery operations include (but are not limited to) when an unhealthy Node is\nrebooted or a Compute Node disappeared due to host failure. Retries due to\nrecovery operations are independent of and are not counted against the\nmaxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to\na recovery operation may occur. Because of this, all Tasks should be\nidempotent. This means Tasks need to tolerate being interrupted and restarted\nwithout causing any corruption or duplicate data. The best practice for long\nrunning Tasks is to use some form of checkpointing.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettingsUpdate", + "description": "The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. Files listed under this element are located in the Task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Preparation Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "Constraints that apply to the Job Preparation Task." + }, + "waitForSuccess": { + "type": "boolean", + "description": "Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes." + }, + "rerunOnNodeRebootAfterSuccess": { + "type": "boolean", + "description": "Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to behave correctly if run multiple times. The default value is true." + } + } + }, + "BatchJobReleaseTask": { + "type": "object", + "description": "A Job Release Task to run on Job completion on any Compute Node where the Job has run.\nThe Job Release Task runs when the Job ends, because of one of the following:\nThe user calls the Terminate Job API, or the Delete Job API while the Job is\nstill active, the Job's maximum wall clock time constraint is reached, and the\nJob is still active, or the Job's Job Manager Task completed, and the Job is\nconfigured to terminate when the Job Manager completes. The Job Release Task\nruns on each Node where Tasks of the Job have run and the Job Preparation Task\nran and completed. If you reimage a Node after it has run the Job Preparation\nTask, and the Job ends without any further Tasks of the Job running on that\nNode (and hence the Job Preparation Task does not re-run), then the Job Release\nTask does not run on that Compute Node. If a Node reboots while the Job Release\nTask is still running, the Job Release Task runs again when the Compute Node\nstarts up. The Job is not marked as complete until all Job Release Tasks have\ncompleted. The Job Release Task runs in the background. It does not occupy a\nscheduling slot; that is, it does not count towards the taskSlotsPerNode limit\nspecified on the Pool.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Release Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "maxWallClockTime": { + "type": "string", + "format": "duration", + "description": "The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "description": "The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task." + } + }, + "required": [ + "commandLine" + ] + }, + "BatchJobReleaseTaskExecutionInfo": { + "type": "object", + "description": "Contains information about the execution of a Job Release Task on a Compute\nNode.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task started running. If the Task has been restarted or retried, this is the most recent time at which the Task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state." + }, + "state": { + "$ref": "#/definitions/BatchJobReleaseTaskState", + "description": "The current state of the Job Release Task on the Compute Node." + }, + "taskRootDirectory": { + "type": "string", + "description": "The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the Task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "description": "The URL to the root directory of the Job Release Task on the Compute Node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/BatchTaskContainerExecutionInfo", + "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/BatchTaskFailureInfo", + "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure." + }, + "result": { + "$ref": "#/definitions/BatchTaskExecutionResult", + "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "startTime", + "state" + ] + }, + "BatchJobReleaseTaskState": { + "type": "string", + "description": "BatchJobReleaseTaskState enums", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "BatchJobReleaseTaskState", + "modelAsString": true, + "values": [ + { + "name": "Running", + "value": "running", + "description": "The Task is currently running (including retrying)." + }, + { + "name": "Completed", + "value": "completed", + "description": "The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "BatchJobReleaseTaskUpdate": { + "type": "object", + "description": "A Job Release Task to run on Job completion on any Compute Node where the Job has run.\nThe Job Release Task runs when the Job ends, because of one of the following:\nThe user calls the Terminate Job API, or the Delete Job API while the Job is\nstill active, the Job's maximum wall clock time constraint is reached, and the\nJob is still active, or the Job's Job Manager Task completed, and the Job is\nconfigured to terminate when the Job Manager completes. The Job Release Task\nruns on each Node where Tasks of the Job have run and the Job Preparation Task\nran and completed. If you reimage a Node after it has run the Job Preparation\nTask, and the Job ends without any further Tasks of the Job running on that\nNode (and hence the Job Preparation Task does not re-run), then the Job Release\nTask does not run on that Compute Node. If a Node reboots while the Job Release\nTask is still running, the Job Release Task runs again when the Compute Node\nstarts up. The Job is not marked as complete until all Job Release Tasks have\ncompleted. The Job Release Task runs in the background. It does not occupy a\nscheduling slot; that is, it does not count towards the taskSlotsPerNode limit\nspecified on the Pool.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettingsUpdate", + "description": "The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Job Release Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "maxWallClockTime": { + "type": "string", + "format": "duration", + "description": "The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "description": "The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique to the Task." + } + } + }, + "BatchJobSchedule": { + "type": "object", + "description": "A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a\nspecification used to create each Job.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the schedule within the Account.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name for the schedule.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The URL of the Job Schedule.", + "readOnly": true + }, + "eTag": { + "type": "string", + "description": "The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.", + "readOnly": true + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Job Schedule.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/BatchJobScheduleState", + "description": "The current state of the Job Schedule.", + "readOnly": true + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job Schedule entered the current state.", + "readOnly": true + }, + "previousState": { + "$ref": "#/definitions/BatchJobScheduleState", + "description": "The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state.", + "readOnly": true + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state.", + "readOnly": true + }, + "schedule": { + "$ref": "#/definitions/BatchJobScheduleConfiguration", + "description": "The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time." + }, + "jobSpecification": { + "$ref": "#/definitions/BatchJobSpecification", + "description": "The details of the Jobs to be created on this schedule." + }, + "executionInfo": { + "$ref": "#/definitions/BatchJobScheduleExecutionInfo", + "description": "Information about Jobs that have been and will be run under this schedule.", + "readOnly": true + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "stats": { + "$ref": "#/definitions/BatchJobScheduleStatistics", + "description": "The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "readOnly": true + } + }, + "required": [ + "jobSpecification" + ] + }, + "BatchJobScheduleConfiguration": { + "type": "object", + "description": "The schedule according to which Jobs will be created. All times are fixed\nrespective to UTC and are not impacted by daylight saving time.", + "properties": { + "doNotRunUntil": { + "type": "string", + "format": "date-time", + "description": "The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create Jobs immediately." + }, + "doNotRunAfter": { + "type": "string", + "format": "date-time", + "description": "A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it." + }, + "startWindow": { + "type": "string", + "format": "duration", + "description": "The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "recurrenceInterval": { + "type": "string", + "format": "duration", + "description": "The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + } + }, + "BatchJobScheduleCreateContent": { + "type": "object", + "description": "Parameters for creating an Azure Batch Job Schedule", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "description": "The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "schedule": { + "$ref": "#/definitions/BatchJobScheduleConfiguration", + "description": "The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time." + }, + "jobSpecification": { + "$ref": "#/definitions/BatchJobSpecification", + "description": "The details of the Jobs to be created on this schedule." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "id", + "schedule", + "jobSpecification" + ] + }, + "BatchJobScheduleExecutionInfo": { + "type": "object", + "description": "Contains information about Jobs that have been and will be run under a Job\nSchedule.", + "properties": { + "nextRunTime": { + "type": "string", + "format": "date-time", + "description": "The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime unless the Job is enabled before then." + }, + "recentJob": { + "$ref": "#/definitions/RecentBatchJob", + "description": "Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has run under the schedule." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state." + } + } + }, + "BatchJobScheduleListResult": { + "type": "object", + "description": "The result of listing the Job Schedules in an Account.", + "properties": { + "value": { + "type": "array", + "description": "The list of Job Schedules.", + "items": { + "$ref": "#/definitions/BatchJobSchedule" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchJobScheduleState": { + "type": "string", + "description": "BatchJobScheduleState enums", + "enum": [ + "active", + "completed", + "disabled", + "terminating", + "deleting" + ], + "x-ms-enum": { + "name": "BatchJobScheduleState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The Job Schedule is active and will create Jobs as per its schedule." + }, + { + "name": "Completed", + "value": "completed", + "description": "The Job Schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "name": "Disabled", + "value": "disabled", + "description": "The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on this schedule, but any existing active Job will continue to run." + }, + { + "name": "Terminating", + "value": "terminating", + "description": "The Job Schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor is any existing Job active." + }, + { + "name": "Deleting", + "value": "deleting", + "description": "The user has requested that the Job Schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job Schedule have been deleted." + } + ] + } + }, + "BatchJobScheduleStatistics": { + "type": "object", + "description": "Resource usage statistics for a Job Schedule.", + "properties": { + "url": { + "type": "string", + "description": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "description": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule.", + "x-ms-client-name": "userCpuTime" + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "description": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs created under the schedule.", + "x-ms-client-name": "kernelCpuTime" + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "description": "The total wall clock time of all the Tasks in all the Jobs created under the schedule. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk read operations made by all Tasks in all Jobs created under the schedule." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk write operations made by all Tasks in all Jobs created under the schedule." + }, + "readIOGiB": { + "type": "number", + "format": "float", + "description": "The total gibibytes read from disk by all Tasks in all Jobs created under the schedule." + }, + "writeIOGiB": { + "type": "number", + "format": "float", + "description": "The total gibibytes written to disk by all Tasks in all Jobs created under the schedule." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "description": "The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "description": "The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "description": "The total number of retries during the given time range on all Tasks in all Jobs created under the schedule." + }, + "waitTime": { + "type": "string", + "format": "duration", + "description": "The total wait time of all Tasks in all Jobs created under the schedule. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.). This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ] + }, + "BatchJobScheduleUpdateContent": { + "type": "object", + "description": "Parameters for updating an Azure Batch Job Schedule.", + "properties": { + "schedule": { + "$ref": "#/definitions/BatchJobScheduleConfiguration", + "description": "The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time. If you do not specify this element, the existing schedule is left unchanged." + }, + "jobSpecification": { + "$ref": "#/definitions/BatchJobSpecificationUpdate", + "description": "The details of the Jobs to be created on this schedule. Updates affect only Jobs that are started after the update has taken place. Any currently active Job continues with the older specification." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Job Schedule as metadata. If you do not specify this element, existing metadata is left unchanged.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchJobSchedulingError": { + "type": "object", + "description": "An error encountered by the Batch service when scheduling a Job.", + "properties": { + "category": { + "$ref": "#/definitions/ErrorCategory", + "description": "The category of the Job scheduling error." + }, + "code": { + "type": "string", + "description": "An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the Job scheduling error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "description": "A list of additional error details related to the scheduling error.", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "category" + ] + }, + "BatchJobSpecification": { + "type": "object", + "description": "Specifies details of the Jobs to be created on a schedule.", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API." + }, + "allowTaskPreemption": { + "type": "boolean", + "description": "Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "displayName": { + "type": "string", + "description": "The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "description": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "onAllTasksComplete": { + "$ref": "#/definitions/OnAllBatchTasksComplete", + "description": "The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction." + }, + "onTaskFailure": { + "$ref": "#/definitions/OnBatchTaskFailure", + "description": "The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction." + }, + "networkConfiguration": { + "$ref": "#/definitions/BatchJobNetworkConfiguration", + "description": "The network configuration for the Job." + }, + "constraints": { + "$ref": "#/definitions/BatchJobConstraints", + "description": "The execution constraints for Jobs created under this schedule." + }, + "jobManagerTask": { + "$ref": "#/definitions/BatchJobManagerTask", + "description": "The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job." + }, + "jobPreparationTask": { + "$ref": "#/definitions/BatchJobPreparationTask", + "description": "The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/BatchJobReleaseTask", + "description": "The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task." + }, + "commonEnvironmentSettings": { + "type": "array", + "description": "A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "poolInfo": { + "$ref": "#/definitions/BatchPoolInfo", + "description": "The Pool on which the Batch service runs the Tasks of Jobs created under this schedule." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "poolInfo" + ] + }, + "BatchJobSpecificationUpdate": { + "type": "object", + "description": "Specifies details of the Jobs to be created on a schedule.", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API." + }, + "allowTaskPreemption": { + "type": "boolean", + "description": "Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "displayName": { + "type": "string", + "description": "The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "description": "Whether Tasks in the Job can define dependencies on each other. The default is false." + }, + "onAllTasksComplete": { + "$ref": "#/definitions/OnAllBatchTasksComplete", + "description": "The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default is noaction." + }, + "onTaskFailure": { + "$ref": "#/definitions/OnBatchTaskFailure", + "description": "The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download error. The default is noaction." + }, + "networkConfiguration": { + "$ref": "#/definitions/BatchJobNetworkConfigurationUpdate", + "description": "The network configuration for the Job." + }, + "constraints": { + "$ref": "#/definitions/BatchJobConstraints", + "description": "The execution constraints for Jobs created under this schedule." + }, + "jobManagerTask": { + "$ref": "#/definitions/BatchJobManagerTaskUpdate", + "description": "The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the Job." + }, + "jobPreparationTask": { + "$ref": "#/definitions/BatchJobPreparationTaskUpdate", + "description": "The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/BatchJobReleaseTaskUpdate", + "description": "The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task." + }, + "commonEnvironmentSettings": { + "type": "array", + "description": "A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified here by specifying the same setting name with a different value.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "poolInfo": { + "$ref": "#/definitions/BatchPoolInfoUpdate", + "description": "The Pool on which the Batch service runs the Tasks of Jobs created under this schedule." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchJobState": { + "type": "string", + "description": "BatchJobState enums", + "enum": [ + "active", + "disabling", + "disabled", + "enabling", + "terminating", + "completed", + "deleting" + ], + "x-ms-enum": { + "name": "BatchJobState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The Job is available to have Tasks scheduled." + }, + { + "name": "Disabling", + "value": "disabling", + "description": "A user has requested that the Job be disabled, but the disable operation is still in progress (for example, waiting for Tasks to terminate)." + }, + { + "name": "Disabled", + "value": "disabled", + "description": "A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled." + }, + { + "name": "Enabling", + "value": "enabling", + "description": "A user has requested that the Job be enabled, but the enable operation is still in progress." + }, + { + "name": "Terminating", + "value": "terminating", + "description": "The Job is about to complete, either because a Job Manager Task has completed or because the user has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running)." + }, + { + "name": "Completed", + "value": "completed", + "description": "All Tasks have terminated, and the system will not accept any more Tasks or any further changes to the Job." + }, + { + "name": "Deleting", + "value": "deleting", + "description": "A user has requested that the Job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running Tasks)." + } + ] + } + }, + "BatchJobStatistics": { + "type": "object", + "description": "Resource usage statistics for a Job.", + "properties": { + "url": { + "type": "string", + "description": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "description": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.", + "x-ms-client-name": "userCpuTime" + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "description": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job.", + "x-ms-client-name": "kernelCpuTime" + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "description": "The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk read operations made by all Tasks in the Job." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk write operations made by all Tasks in the Job." + }, + "readIOGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB read from disk by all Tasks in the Job." + }, + "writeIOGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB written to disk by all Tasks in the Job." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "description": "The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "description": "The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "description": "The total number of retries on all the Tasks in the Job during the given time range." + }, + "waitTime": { + "type": "string", + "format": "duration", + "description": "The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included in the Job statistics." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "numSucceededTasks", + "numFailedTasks", + "numTaskRetries", + "waitTime" + ] + }, + "BatchJobTerminateContent": { + "type": "object", + "description": "Parameters for terminating an Azure Batch Job.", + "properties": { + "terminateReason": { + "type": "string", + "description": "The text you want to appear as the Job's TerminationReason. The default is 'UserTerminate'.", + "x-ms-client-name": "terminationReason" + } + } + }, + "BatchJobUpdateContent": { + "type": "object", + "description": "Parameters for updating an Azure Batch Job.", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the Job is left unchanged." + }, + "allowTaskPreemption": { + "type": "boolean", + "description": "Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API." + }, + "maxParallelTasks": { + "type": "integer", + "format": "int32", + "description": "The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API." + }, + "constraints": { + "$ref": "#/definitions/BatchJobConstraints", + "description": "The execution constraints for the Job. If omitted, the existing execution constraints are left unchanged." + }, + "poolInfo": { + "$ref": "#/definitions/BatchPoolInfoUpdate", + "description": "The Pool on which the Batch service runs the Job's Tasks. You may change the Pool for a Job only when the Job is disabled. The Patch Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool." + }, + "onAllTasksComplete": { + "$ref": "#/definitions/OnAllBatchTasksComplete", + "description": "The action the Batch service should take when all Tasks in the Job are in the completed state. If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic Job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Job as metadata. If omitted, the existing Job metadata is left unchanged.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "networkConfiguration": { + "$ref": "#/definitions/BatchJobNetworkConfigurationUpdate", + "description": "The network configuration for the Job." + } + } + }, + "BatchNode": { + "type": "object", + "description": "A Compute Node in the Batch service.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the Compute Node. Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute Nodes." + }, + "url": { + "type": "string", + "description": "The URL of the Compute Node." + }, + "state": { + "$ref": "#/definitions/BatchNodeState", + "description": "The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available." + }, + "schedulingState": { + "$ref": "#/definitions/SchedulingState", + "description": "Whether the Compute Node is available for Task scheduling." + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Compute Node entered its current state." + }, + "lastBootTime": { + "type": "string", + "format": "date-time", + "description": "The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable." + }, + "allocationTime": { + "type": "string", + "format": "date-time", + "description": "The time at which this Compute Node was allocated to the Pool. This is the time when the Compute Node was initially allocated and doesn't change once set. It is not updated when the Compute Node is service healed or preempted." + }, + "ipAddress": { + "type": "string", + "description": "The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new Compute Nodes." + }, + "affinityId": { + "type": "string", + "description": "An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. Note that this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere." + }, + "vmSize": { + "type": "string", + "description": "The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalTasksRun": { + "type": "integer", + "format": "int32", + "description": "The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTasksCount": { + "type": "integer", + "format": "int32", + "description": "The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "runningTaskSlotsCount": { + "type": "integer", + "format": "int32", + "description": "The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "totalTasksSucceeded": { + "type": "integer", + "format": "int32", + "description": "The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks." + }, + "recentTasks": { + "type": "array", + "description": "A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute Node since it was assigned to the Pool.", + "items": { + "$ref": "#/definitions/BatchTaskInfo" + }, + "x-ms-identifiers": [] + }, + "startTask": { + "$ref": "#/definitions/BatchStartTask", + "description": "The Task specified to run on the Compute Node as it joins the Pool." + }, + "startTaskInfo": { + "$ref": "#/definitions/BatchStartTaskInfo", + "description": "Runtime information about the execution of the StartTask on the Compute Node." + }, + "errors": { + "type": "array", + "description": "The list of errors that are currently being encountered by the Compute Node.", + "items": { + "$ref": "#/definitions/BatchNodeError" + }, + "x-ms-identifiers": [] + }, + "isDedicated": { + "type": "boolean", + "description": "Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node." + }, + "endpointConfiguration": { + "$ref": "#/definitions/BatchNodeEndpointConfiguration", + "description": "The endpoint configuration for the Compute Node." + }, + "nodeAgentInfo": { + "$ref": "#/definitions/BatchNodeAgentInfo", + "description": "Information about the Compute Node agent version and the time the Compute Node upgraded to a new version." + }, + "virtualMachineInfo": { + "$ref": "#/definitions/VirtualMachineInfo", + "description": "Info about the current state of the virtual machine." + } + } + }, + "BatchNodeAgentInfo": { + "type": "object", + "description": "The Batch Compute Node agent is a program that runs on each Compute Node in the\nPool and provides Batch capability on the Compute Node.", + "properties": { + "version": { + "type": "string", + "description": "The version of the Batch Compute Node agent running on the Compute Node. This version number can be checked against the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time when the Compute Node agent was updated on the Compute Node. This is the most recent time that the Compute Node agent was updated to a new version." + } + }, + "required": [ + "version", + "lastUpdateTime" + ] + }, + "BatchNodeCommunicationMode": { + "type": "string", + "description": "BatchNodeCommunicationMode enums", + "enum": [ + "default", + "classic", + "simplified" + ], + "x-ms-enum": { + "name": "BatchNodeCommunicationMode", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "default", + "description": "The node communication mode is automatically set by the Batch service." + }, + { + "name": "Classic", + "value": "classic", + "description": "Nodes using the classic communication mode require inbound TCP communication on ports 29876 and 29877 from the \"BatchNodeManagement.{region}\" service tag and outbound TCP communication on port 443 to the \"Storage.region\" and \"BatchNodeManagement.{region}\" service tags." + }, + { + "name": "Simplified", + "value": "simplified", + "description": "Nodes using the simplified communication mode require outbound TCP communication on port 443 to the \"BatchNodeManagement.{region}\" service tag. No open inbound ports are required." + } + ] + } + }, + "BatchNodeCounts": { + "type": "object", + "description": "The number of Compute Nodes in each Compute Node state.", + "properties": { + "creating": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the creating state." + }, + "idle": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the idle state." + }, + "offline": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the offline state." + }, + "preempted": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the preempted state." + }, + "rebooting": { + "type": "integer", + "format": "int32", + "description": "The count of Compute Nodes in the rebooting state." + }, + "reimaging": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the reimaging state." + }, + "running": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the running state." + }, + "starting": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the starting state." + }, + "startTaskFailed": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the startTaskFailed state." + }, + "leavingPool": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the leavingPool state." + }, + "unknown": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the unknown state." + }, + "unusable": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the unusable state." + }, + "waitingForStartTask": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the waitingForStartTask state." + }, + "deallocated": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the deallocated state." + }, + "deallocating": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the deallocating state." + }, + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of Compute Nodes." + }, + "upgradingOS": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes in the upgradingOS state.", + "x-ms-client-name": "upgradingOs" + } + }, + "required": [ + "creating", + "idle", + "offline", + "preempted", + "rebooting", + "reimaging", + "running", + "starting", + "startTaskFailed", + "leavingPool", + "unknown", + "unusable", + "waitingForStartTask", + "deallocated", + "deallocating", + "total", + "upgradingOS" + ] + }, + "BatchNodeDeallocateContent": { + "type": "object", + "description": "Options for deallocating a Compute Node.", + "properties": { + "nodeDeallocateOption": { + "$ref": "#/definitions/BatchNodeDeallocateOption", + "description": "When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue." + } + } + }, + "BatchNodeDeallocateOption": { + "type": "string", + "description": "BatchNodeDeallocateOption enums", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "BatchNodeDeallocateOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Deallocate the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Deallocate the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Tasks have completed." + }, + { + "name": "RetainedData", + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Task retention periods have expired." + } + ] + } + }, + "BatchNodeDeallocationOption": { + "type": "string", + "description": "BatchNodeDeallocationOption enums", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "BatchNodeDeallocationOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Remove Compute Nodes as soon as Tasks have been terminated." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed." + }, + { + "name": "RetainedData", + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have expired." + } + ] + } + }, + "BatchNodeDisableSchedulingContent": { + "type": "object", + "description": "Parameters for disabling scheduling on an Azure Batch Compute Node.", + "properties": { + "nodeDisableSchedulingOption": { + "$ref": "#/definitions/BatchNodeDisableSchedulingOption", + "description": "What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue." + } + } + }, + "BatchNodeDisableSchedulingOption": { + "type": "string", + "description": "BatchNodeDisableSchedulingOption enums", + "enum": [ + "requeue", + "terminate", + "taskcompletion" + ], + "x-ms-enum": { + "name": "BatchNodeDisableSchedulingOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks may run again on other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have been terminated." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Enter offline state when all Tasks have completed." + } + ] + } + }, + "BatchNodeEndpointConfiguration": { + "type": "object", + "description": "The endpoint configuration for the Compute Node.", + "properties": { + "inboundEndpoints": { + "type": "array", + "description": "The list of inbound endpoints that are accessible on the Compute Node.", + "items": { + "$ref": "#/definitions/InboundEndpoint" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "inboundEndpoints" + ] + }, + "BatchNodeError": { + "type": "object", + "description": "An error encountered by a Compute Node.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the Compute Node error, intended to be suitable for display in a user interface." + }, + "errorDetails": { + "type": "array", + "description": "The list of additional error details related to the Compute Node error.", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchNodeFile": { + "type": "object", + "description": "Information about a file or directory on a Compute Node.", + "properties": { + "name": { + "type": "string", + "description": "The file path." + }, + "url": { + "type": "string", + "description": "The URL of the file." + }, + "isDirectory": { + "type": "boolean", + "description": "Whether the object represents a directory." + }, + "properties": { + "$ref": "#/definitions/FileProperties", + "description": "The file properties." + } + } + }, + "BatchNodeFileListResult": { + "type": "object", + "description": "The result of listing the files on a Compute Node, or the files associated with\na Task on a Compute Node.", + "properties": { + "value": { + "type": "array", + "description": "The list of files.", + "items": { + "$ref": "#/definitions/BatchNodeFile" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchNodeFillType": { + "type": "string", + "description": "BatchNodeFillType enums", + "enum": [ + "spread", + "pack" + ], + "x-ms-enum": { + "name": "BatchNodeFillType", + "modelAsString": true, + "values": [ + { + "name": "Spread", + "value": "spread", + "description": "Tasks should be assigned evenly across all Compute Nodes in the Pool." + }, + { + "name": "Pack", + "value": "pack", + "description": "As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before any Tasks are assigned to the next Compute Node in the Pool." + } + ] + } + }, + "BatchNodeIdentityReference": { + "type": "object", + "description": "The reference to a user assigned identity associated with the Batch pool which\na compute node will use.", + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM resource id of the user assigned identity." + } + } + }, + "BatchNodeInfo": { + "type": "object", + "description": "Information about the Compute Node on which a Task ran.", + "properties": { + "affinityId": { + "type": "string", + "description": "An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled on this Compute Node." + }, + "nodeUrl": { + "type": "string", + "description": "The URL of the Compute Node on which the Task ran." + }, + "poolId": { + "type": "string", + "description": "The ID of the Pool on which the Task ran." + }, + "nodeId": { + "type": "string", + "description": "The ID of the Compute Node on which the Task ran." + }, + "taskRootDirectory": { + "type": "string", + "description": "The root directory of the Task on the Compute Node." + }, + "taskRootDirectoryUrl": { + "type": "string", + "description": "The URL to the root directory of the Task on the Compute Node." + } + } + }, + "BatchNodeListResult": { + "type": "object", + "description": "The result of listing the Compute Nodes in a Pool.", + "properties": { + "value": { + "type": "array", + "description": "The list of Compute Nodes.", + "items": { + "$ref": "#/definitions/BatchNode" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchNodePlacementConfiguration": { + "type": "object", + "description": "For regional placement, nodes in the pool will be allocated in the same region.\nFor zonal placement, nodes in the pool will be spread across different zones\nwith best effort balancing.", + "properties": { + "policy": { + "$ref": "#/definitions/BatchNodePlacementPolicyType", + "description": "Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy." + } + } + }, + "BatchNodePlacementPolicyType": { + "type": "string", + "description": "BatchNodePlacementPolicyType enums", + "enum": [ + "Shared", + "Startup", + "VfsMounts", + "Task", + "JobPrep", + "Applications" + ], + "x-ms-enum": { + "name": "BatchNodePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "name": "Shared", + "value": "Shared", + "description": "The path for multi-instances task to shared their files." + }, + { + "name": "Startup", + "value": "Startup", + "description": "The path for start task." + }, + { + "name": "VfsMounts", + "value": "VfsMounts", + "description": "The path contains all virtual file systems are mounted on this node." + }, + { + "name": "Task", + "value": "Task", + "description": "The task path." + }, + { + "name": "JobPrep", + "value": "JobPrep", + "description": "The job-prep task path." + }, + { + "name": "Applications", + "value": "Applications", + "description": "The applications path." + } + ] + } + }, + "BatchNodeRebootContent": { + "type": "object", + "description": "Parameters for rebooting an Azure Batch Compute Node.", + "properties": { + "nodeRebootOption": { + "$ref": "#/definitions/BatchNodeRebootOption", + "description": "When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue." + } + } + }, + "BatchNodeRebootOption": { + "type": "string", + "description": "BatchNodeRebootOption enums", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "BatchNodeRebootOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Restart the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart the Compute Node when all Tasks have completed." + }, + { + "name": "RetainedData", + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all Task retention periods have expired." + } + ] + } + }, + "BatchNodeReimageContent": { + "type": "object", + "description": "Parameters for reimaging an Azure Batch Compute Node.", + "properties": { + "nodeReimageOption": { + "$ref": "#/definitions/BatchNodeReimageOption", + "description": "When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue." + } + } + }, + "BatchNodeReimageOption": { + "type": "string", + "description": "BatchNodeReimageOption enums", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "BatchNodeReimageOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Reimage the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage the Compute Node when all Tasks have completed." + }, + { + "name": "RetainedData", + "value": "retaineddata", + "description": "Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired." + } + ] + } + }, + "BatchNodeRemoteLoginSettings": { + "type": "object", + "description": "The remote login settings for a Compute Node.", + "properties": { + "remoteLoginIPAddress": { + "type": "string", + "description": "The IP address used for remote login to the Compute Node.", + "x-ms-client-name": "remoteLoginIpAddress" + }, + "remoteLoginPort": { + "type": "integer", + "format": "int32", + "description": "The port used for remote login to the Compute Node." + } + }, + "required": [ + "remoteLoginIPAddress", + "remoteLoginPort" + ] + }, + "BatchNodeRemoveContent": { + "type": "object", + "description": "Parameters for removing nodes from an Azure Batch Pool.", + "properties": { + "nodeList": { + "type": "array", + "description": "A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes may be removed per request.", + "items": { + "type": "string" + } + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for removal of Compute Nodes to the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "$ref": "#/definitions/BatchNodeDeallocationOption", + "description": "Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default value is requeue." + } + }, + "required": [ + "nodeList" + ] + }, + "BatchNodeState": { + "type": "string", + "description": "BatchNodeState enums", + "enum": [ + "idle", + "rebooting", + "reimaging", + "running", + "unusable", + "creating", + "starting", + "waitingforstarttask", + "starttaskfailed", + "unknown", + "leavingpool", + "offline", + "preempted", + "upgradingos", + "deallocated", + "deallocating" + ], + "x-ms-enum": { + "name": "BatchNodeState", + "modelAsString": true, + "values": [ + { + "name": "Idle", + "value": "idle", + "description": "The Compute Node is not currently running a Task." + }, + { + "name": "Rebooting", + "value": "rebooting", + "description": "The Compute Node is rebooting." + }, + { + "name": "Reimaging", + "value": "reimaging", + "description": "The Compute Node is reimaging." + }, + { + "name": "Running", + "value": "running", + "description": "The Compute Node is running one or more Tasks (other than a StartTask)." + }, + { + "name": "Unusable", + "value": "unusable", + "description": "The Compute Node cannot be used for Task execution due to errors." + }, + { + "name": "Creating", + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool." + }, + { + "name": "Starting", + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "name": "WaitingForStartTask", + "value": "waitingforstarttask", + "description": "The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed." + }, + { + "name": "StartTaskFailed", + "value": "starttaskfailed", + "description": "The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks." + }, + { + "name": "Unknown", + "value": "unknown", + "description": "The Batch service has lost contact with the Compute Node, and does not know its true state." + }, + { + "name": "LeavingPool", + "value": "leavingpool", + "description": "The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down." + }, + { + "name": "Offline", + "value": "offline", + "description": "The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled." + }, + { + "name": "Preempted", + "value": "preempted", + "description": "The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available." + }, + { + "name": "UpgradingOS", + "value": "upgradingos", + "description": "The Compute Node is undergoing an OS upgrade operation." + }, + { + "name": "Deallocated", + "value": "deallocated", + "description": "The Compute Node is deallocated." + }, + { + "name": "Deallocating", + "value": "deallocating", + "description": "The Compute Node is deallocating." + } + ] + } + }, + "BatchNodeUserCreateContent": { + "type": "object", + "description": "Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.", + "properties": { + "name": { + "type": "string", + "description": "The user name of the Account." + }, + "isAdmin": { + "type": "boolean", + "description": "Whether the Account should be an administrator on the Compute Node. The default value is false." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property.", + "x-ms-secret": true + }, + "sshPublicKey": { + "type": "string", + "description": "The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "required": [ + "name" + ] + }, + "BatchNodeUserUpdateContent": { + "type": "object", + "description": "Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.", + "properties": { + "password": { + "type": "string", + "format": "password", + "description": "The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.", + "x-ms-secret": true + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute Nodes, the expiryTime has a precision up to a day." + }, + "sshPublicKey": { + "type": "string", + "description": "The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed." + } + } + }, + "BatchNodeVMExtension": { + "type": "object", + "description": "The configuration for virtual machine extension instance view.", + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the virtual machine extension." + }, + "vmExtension": { + "$ref": "#/definitions/VMExtension", + "description": "The virtual machine extension." + }, + "instanceView": { + "$ref": "#/definitions/VMExtensionInstanceView", + "description": "The vm extension instance view." + } + } + }, + "BatchNodeVMExtensionListResult": { + "type": "object", + "description": "The result of listing the Compute Node extensions in a Node.", + "properties": { + "value": { + "type": "array", + "description": "The list of Compute Node extensions.", + "items": { + "$ref": "#/definitions/BatchNodeVMExtension" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchPool": { + "type": "object", + "description": "A Pool in the Azure Batch service.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case).", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The URL of the Pool.", + "readOnly": true + }, + "eTag": { + "type": "string", + "description": "The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect only if nobody else has modified the Pool in the meantime.", + "readOnly": true + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Pool.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/BatchPoolState", + "description": "The current state of the Pool.", + "readOnly": true + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Pool entered its current state.", + "readOnly": true + }, + "allocationState": { + "$ref": "#/definitions/AllocationState", + "description": "Whether the Pool is resizing.", + "readOnly": true + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Pool entered its current allocation state.", + "readOnly": true + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes, see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).", + "readOnly": true + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "The virtual machine configuration for the Pool. This property must be specified.", + "readOnly": true + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes.", + "readOnly": true + }, + "resizeErrors": { + "type": "array", + "description": "A list of errors encountered while performing the last resize on the Pool. This property is set only if one or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady.", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "resourceTags": { + "type": "object", + "description": "The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The number of dedicated Compute Nodes currently in the Pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have been preempted are included in this count.", + "readOnly": true + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of dedicated Compute Nodes in the Pool.", + "readOnly": true + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of Spot/Low-priority Compute Nodes in the Pool.", + "readOnly": true + }, + "enableAutoScale": { + "type": "boolean", + "description": "Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false.", + "readOnly": true + }, + "autoScaleFormula": { + "type": "string", + "description": "A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.", + "readOnly": true + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "description": "The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.", + "readOnly": true + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "description": "The results and errors from the last execution of the autoscale formula. This property is set only if the Pool automatically scales, i.e. enableAutoScale is true.", + "readOnly": true + }, + "enableInterNodeCommunication": { + "type": "boolean", + "description": "Whether the Pool permits direct communication between Compute Nodes. This imposes restrictions on which Compute Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes to be allocated in the Pool.", + "readOnly": true + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the Pool.", + "readOnly": true + }, + "startTask": { + "$ref": "#/definitions/BatchStartTask", + "description": "A Task specified to run on each Compute Node as it joins the Pool." + }, + "applicationPackageReferences": { + "type": "array", + "description": "The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.", + "readOnly": true + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/BatchTaskSchedulingPolicy", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.", + "readOnly": true + }, + "userAccounts": { + "type": "array", + "description": "The list of user Accounts to be created on each Compute Node in the Pool.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "stats": { + "$ref": "#/definitions/BatchPoolStatistics", + "description": "Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "readOnly": true + }, + "mountConfiguration": { + "type": "array", + "description": "A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "identity": { + "$ref": "#/definitions/BatchPoolIdentity", + "description": "The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "readOnly": true + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. If omitted, the default value is Default." + }, + "currentNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The current state of the pool communication mode.", + "readOnly": true + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling." + } + } + }, + "BatchPoolCreateContent": { + "type": "object", + "description": "Parameters for creating an Azure Batch Pool.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case)." + }, + "displayName": { + "type": "string", + "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration), see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "The virtual machine configuration for the Pool. This property must be specified." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "resourceTags": { + "type": "object", + "description": "The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.", + "additionalProperties": { + "type": "string" + } + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "description": "Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "description": "A formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "description": "The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "description": "Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/BatchStartTask", + "description": "A Task specified to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "applicationPackageReferences": { + "type": "array", + "description": "The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/BatchTaskSchedulingPolicy", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread." + }, + "userAccounts": { + "type": "array", + "description": "The list of user Accounts to be created on each Compute Node in the Pool.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "mountConfiguration": { + "type": "array", + "description": "Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [] + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. If omitted, the default value is Default." + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling." + } + }, + "required": [ + "id", + "vmSize" + ] + }, + "BatchPoolEnableAutoScaleContent": { + "type": "object", + "description": "Parameters for enabling automatic scaling on an Azure Batch Pool.", + "properties": { + "autoScaleFormula": { + "type": "string", + "description": "The formula for the desired number of Compute Nodes in the Pool. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "description": "The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued." + } + } + }, + "BatchPoolEndpointConfiguration": { + "type": "object", + "description": "The endpoint configuration for a Pool.", + "properties": { + "inboundNATPools": { + "type": "array", + "description": "A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "x-ms-client-name": "inboundNatPools", + "x-ms-identifiers": [] + } + }, + "required": [ + "inboundNATPools" + ] + }, + "BatchPoolEndpointConfigurationUpdate": { + "type": "object", + "description": "The endpoint configuration for a Pool.", + "properties": { + "inboundNATPools": { + "type": "array", + "description": "A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses.", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "x-ms-client-name": "inboundNatPools", + "x-ms-identifiers": [] + } + } + }, + "BatchPoolEvaluateAutoScaleContent": { + "type": "object", + "description": "Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.", + "properties": { + "autoScaleFormula": { + "type": "string", + "description": "The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling)." + } + }, + "required": [ + "autoScaleFormula" + ] + }, + "BatchPoolIdentity": { + "type": "object", + "description": "The identity of the Batch pool, if configured.", + "properties": { + "type": { + "$ref": "#/definitions/BatchPoolIdentityType", + "description": "The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + }, + "userAssignedIdentities": { + "type": "array", + "description": "The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "type" + ] + }, + "BatchPoolIdentityType": { + "type": "string", + "description": "BatchPoolIdentityType enums", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "BatchPoolIdentityType", + "modelAsString": true, + "values": [ + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "Batch pool has user assigned identities with it." + }, + { + "name": "None", + "value": "None", + "description": "Batch pool has no identity associated with it. Setting `None` in update pool will remove existing identities." + } + ] + } + }, + "BatchPoolInfo": { + "type": "object", + "description": "Specifies how a Job should be assigned to a Pool.", + "properties": { + "poolId": { + "type": "string", + "description": "The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both." + }, + "autoPoolSpecification": { + "$ref": "#/definitions/BatchAutoPoolSpecification", + "description": "Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both." + } + } + }, + "BatchPoolInfoUpdate": { + "type": "object", + "description": "Specifies how a Job should be assigned to a Pool.", + "properties": { + "poolId": { + "type": "string", + "description": "The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both." + }, + "autoPoolSpecification": { + "$ref": "#/definitions/BatchAutoPoolSpecificationUpdate", + "description": "Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both." + } + } + }, + "BatchPoolLifetimeOption": { + "type": "string", + "description": "BatchPoolLifetimeOption enums", + "enum": [ + "jobschedule", + "job" + ], + "x-ms-enum": { + "name": "BatchPoolLifetimeOption", + "modelAsString": true, + "values": [ + { + "name": "JobSchedule", + "value": "jobschedule", + "description": "The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs." + }, + { + "name": "Job", + "value": "job", + "description": "The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto Pool for every Job created on the schedule." + } + ] + } + }, + "BatchPoolListResult": { + "type": "object", + "description": "The result of listing the Pools in an Account.", + "properties": { + "value": { + "type": "array", + "description": "The list of Pools.", + "items": { + "$ref": "#/definitions/BatchPool" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchPoolListUsageMetricsResult": { + "type": "object", + "description": "The result of a listing the usage metrics for an Account.", + "properties": { + "value": { + "type": "array", + "description": "The Pool usage metrics data.", + "items": { + "$ref": "#/definitions/BatchPoolUsageMetrics" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchPoolNodeCounts": { + "type": "object", + "description": "The number of Compute Nodes in each state for a Pool.", + "properties": { + "poolId": { + "type": "string", + "description": "The ID of the Pool." + }, + "dedicated": { + "$ref": "#/definitions/BatchNodeCounts", + "description": "The number of dedicated Compute Nodes in each state." + }, + "lowPriority": { + "$ref": "#/definitions/BatchNodeCounts", + "description": "The number of Spot/Low-priority Compute Nodes in each state." + } + }, + "required": [ + "poolId" + ] + }, + "BatchPoolNodeCountsListResult": { + "type": "object", + "description": "The result of listing the Compute Node counts in the Account.", + "properties": { + "value": { + "type": "array", + "description": "A list of Compute Node counts by Pool.", + "items": { + "$ref": "#/definitions/BatchPoolNodeCounts" + }, + "x-ms-identifiers": [] + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchPoolReplaceContent": { + "type": "object", + "description": "Parameters for replacing properties on an Azure Batch Pool.", + "properties": { + "startTask": { + "$ref": "#/definitions/BatchStartTask", + "description": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is removed from the Pool." + }, + "applicationPackageReferences": { + "type": "array", + "description": "The list of Application Packages to be installed on each Compute Node in the Pool. The list replaces any existing Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given Pool.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata. This list replaces any existing metadata configured on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. This setting replaces any existing targetNodeCommunication setting on the Pool. If omitted, the existing setting is default." + } + }, + "required": [ + "applicationPackageReferences", + "metadata" + ] + }, + "BatchPoolResizeContent": { + "type": "object", + "description": "Parameters for changing the size of an Azure Batch Pool.", + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of dedicated Compute Nodes in the Pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of Spot/Low-priority Compute Nodes in the Pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "$ref": "#/definitions/BatchNodeDeallocationOption", + "description": "Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing. The default value is requeue." + } + } + }, + "BatchPoolResourceStatistics": { + "type": "object", + "description": "Statistics related to resource consumption by Compute Nodes in a Pool.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "avgCPUPercentage": { + "type": "number", + "format": "float", + "description": "The average CPU usage across all Compute Nodes in the Pool (percentage per node).", + "x-ms-client-name": "avgCpuPercentage" + }, + "avgMemoryGiB": { + "type": "number", + "format": "float", + "description": "The average memory usage in GiB across all Compute Nodes in the Pool." + }, + "peakMemoryGiB": { + "type": "number", + "format": "float", + "description": "The peak memory usage in GiB across all Compute Nodes in the Pool." + }, + "avgDiskGiB": { + "type": "number", + "format": "float", + "description": "The average used disk space in GiB across all Compute Nodes in the Pool." + }, + "peakDiskGiB": { + "type": "number", + "format": "float", + "description": "The peak used disk space in GiB across all Compute Nodes in the Pool." + }, + "diskReadIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk read operations across all Compute Nodes in the Pool." + }, + "diskWriteIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk write operations across all Compute Nodes in the Pool." + }, + "diskReadGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB of disk reads across all Compute Nodes in the Pool." + }, + "diskWriteGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB of disk writes across all Compute Nodes in the Pool." + }, + "networkReadGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB of network reads across all Compute Nodes in the Pool." + }, + "networkWriteGiB": { + "type": "number", + "format": "float", + "description": "The total amount of data in GiB of network writes across all Compute Nodes in the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "avgCPUPercentage", + "avgMemoryGiB", + "peakMemoryGiB", + "avgDiskGiB", + "peakDiskGiB", + "diskReadIOps", + "diskWriteIOps", + "diskReadGiB", + "diskWriteGiB", + "networkReadGiB", + "networkWriteGiB" + ] + }, + "BatchPoolSpecification": { + "type": "object", + "description": "Specification for creating a new Pool.", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "description": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "description": "The virtual machine configuration for the Pool. This property must be specified." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/BatchTaskSchedulingPolicy", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "resourceTags": { + "type": "string", + "description": "The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "description": "Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "description": "The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "description": "The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "description": "Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/BatchStartTask", + "description": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "applicationPackageReferences": { + "type": "array", + "description": "The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "userAccounts": { + "type": "array", + "description": "The list of user Accounts to be created on each Compute Node in the Pool.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "mountConfiguration": { + "type": "array", + "description": "A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [] + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. If omitted, the default value is Default." + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling." + } + }, + "required": [ + "vmSize" + ] + }, + "BatchPoolSpecificationUpdate": { + "type": "object", + "description": "Specification for creating a new Pool.", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "description": "The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfigurationUpdate", + "description": "The virtual machine configuration for the Pool. This property must be specified." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/BatchTaskSchedulingPolicyUpdate", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "description": "The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "resourceTags": { + "type": "string", + "description": "The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "description": "The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "description": "Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "description": "The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "description": "The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "description": "Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfigurationUpdate", + "description": "The network configuration for the Pool." + }, + "startTask": { + "$ref": "#/definitions/BatchStartTaskUpdate", + "description": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted." + }, + "applicationPackageReferences": { + "type": "array", + "description": "The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "userAccounts": { + "type": "array", + "description": "The list of user Accounts to be created on each Compute Node in the Pool.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "mountConfiguration": { + "type": "array", + "description": "A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [] + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. If omitted, the default value is Default." + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicyUpdate", + "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling." + } + } + }, + "BatchPoolState": { + "type": "string", + "description": "BatchPoolState enums", + "enum": [ + "active", + "deleting" + ], + "x-ms-enum": { + "name": "BatchPoolState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The Pool is available to run Tasks subject to the availability of Compute Nodes." + }, + { + "name": "Deleting", + "value": "deleting", + "description": "The user has requested that the Pool be deleted, but the delete operation has not yet completed." + } + ] + } + }, + "BatchPoolStatistics": { + "type": "object", + "description": "Contains utilization and resource usage statistics for the lifetime of a Pool.", + "properties": { + "url": { + "type": "string", + "description": "The URL for the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "usageStats": { + "$ref": "#/definitions/BatchPoolUsageStatistics", + "description": "Statistics related to Pool usage, such as the amount of core-time used." + }, + "resourceStats": { + "$ref": "#/definitions/BatchPoolResourceStatistics", + "description": "Statistics related to resource consumption by Compute Nodes in the Pool." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime" + ] + }, + "BatchPoolUpdateContent": { + "type": "object", + "description": "Parameters for updating an Azure Batch Pool.", + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. This field can be updated only when the pool is empty." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br />This field can be updated only when the pool is empty." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "description": "Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching its desired size. The default value is false.<br /><br />This field can be updated only when the pool is empty." + }, + "startTask": { + "$ref": "#/definitions/BatchStartTaskUpdate", + "description": "A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing StartTask is left unchanged." + }, + "applicationPackageReferences": { + "type": "array", + "description": "A list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package references are removed from the Pool. If omitted, any existing Package references are left unchanged.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "metadata": { + "type": "array", + "description": "A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing metadata is left unchanged.", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "x-ms-identifiers": [] + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfigurationUpdate", + "description": "The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only when the pool is empty." + }, + "targetNodeCommunicationMode": { + "$ref": "#/definitions/BatchNodeCommunicationMode", + "description": "The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode configured on the Pool. If omitted, any existing metadata is left unchanged." + }, + "taskSlotsPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.<br /><br />This field can be updated only when the pool is empty." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/BatchTaskSchedulingPolicyUpdate", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field can be updated only when the pool is empty." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfigurationUpdate", + "description": "The network configuration for the Pool. This field can be updated only when the pool is empty." + }, + "resourceTags": { + "type": "object", + "description": "The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.<br /><br />This field can be updated only when the pool is empty.", + "additionalProperties": { + "type": "string" + } + }, + "userAccounts": { + "type": "array", + "description": "The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool is empty.", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "x-ms-identifiers": [] + }, + "mountConfiguration": { + "type": "array", + "description": "Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, NFS, CIFS or Blobfuse based file system.<br /><br />This field can be updated only when the pool is empty.", + "items": { + "$ref": "#/definitions/MountConfiguration" + }, + "x-ms-identifiers": [] + }, + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicyUpdate", + "description": "The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can be updated only when the pool is empty." + } + } + }, + "BatchPoolUsageMetrics": { + "type": "object", + "description": "Usage metrics for a Pool across an aggregation interval.", + "properties": { + "poolId": { + "type": "string", + "description": "The ID of the Pool whose metrics are aggregated in this entry." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the aggregation interval covered by this entry." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the aggregation interval covered by this entry." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the Pool. All VMs in a Pool are the same size. For information about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalCoreHours": { + "type": "number", + "format": "float", + "description": "The total core hours used in the Pool during this aggregation interval." + } + }, + "required": [ + "poolId", + "startTime", + "endTime", + "vmSize", + "totalCoreHours" + ] + }, + "BatchPoolUsageStatistics": { + "type": "object", + "description": "Statistics related to Pool usage information.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "dedicatedCoreTime": { + "type": "string", + "format": "duration", + "description": "The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool." + } + }, + "required": [ + "startTime", + "lastUpdateTime", + "dedicatedCoreTime" + ] + }, + "BatchStartTask": { + "type": "object", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node.\nExamples of recovery operations include (but are not limited to) when an\nunhealthy Node is rebooted or a Compute Node disappeared due to host failure.\nRetries due to recovery operations are independent of and are not counted\nagainst the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal\nretry due to a recovery operation may occur. Because of this, all Tasks should\nbe idempotent. This means Tasks need to tolerate being interrupted and\nrestarted without causing any corruption or duplicate data. The best practice\nfor long running Tasks is to use some form of checkpointing. In some cases the\nStartTask may be re-run even though the Compute Node was not rebooted. Special\ncare should be taken to avoid StartTasks which create breakaway process or\ninstall/launch services from the StartTask working directory, as this will\nblock Batch from being able to re-run the StartTask.", + "properties": { + "commandLine": { + "type": "string", + "description": "The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the StartTask.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries)." + }, + "waitForSuccess": { + "type": "boolean", + "description": "Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true." + } + }, + "required": [ + "commandLine" + ] + }, + "BatchStartTaskInfo": { + "type": "object", + "description": "Information about a StartTask running on a Compute Node.", + "properties": { + "state": { + "$ref": "#/definitions/BatchStartTaskState", + "description": "The state of the StartTask on the Compute Node." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the StartTask started running. This value is reset every time the Task is restarted or retried (that is, this is the most recent time at which the StartTask started running)." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the StartTask stopped running. This is the end time of the most recent run of the StartTask, if that run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently running." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "The exit code of the program specified on the StartTask command line. This property is set only if the StartTask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/BatchTaskContainerExecutionInfo", + "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/BatchTaskFailureInfo", + "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "description": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "description": "The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/BatchTaskExecutionResult", + "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "state", + "startTime", + "retryCount" + ] + }, + "BatchStartTaskState": { + "type": "string", + "description": "BatchStartTaskState enums", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "BatchStartTaskState", + "modelAsString": true, + "values": [ + { + "name": "Running", + "value": "running", + "description": "The StartTask is currently running." + }, + { + "name": "Completed", + "value": "completed", + "description": "The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures)." + } + ] + } + }, + "BatchStartTaskUpdate": { + "type": "object", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node.\nExamples of recovery operations include (but are not limited to) when an\nunhealthy Node is rebooted or a Compute Node disappeared due to host failure.\nRetries due to recovery operations are independent of and are not counted\nagainst the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal\nretry due to a recovery operation may occur. Because of this, all Tasks should\nbe idempotent. This means Tasks need to tolerate being interrupted and\nrestarted without causing any corruption or duplicate data. The best practice\nfor long running Tasks is to use some form of checkpointing. In some cases the\nStartTask may be re-run even though the Compute Node was not rebooted. Special\ncare should be taken to avoid StartTasks which create breakaway process or\ninstall/launch services from the StartTask working directory, as this will\nblock Batch from being able to re-run the StartTask.", + "properties": { + "commandLine": { + "type": "string", + "description": "The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettingsUpdate", + "description": "The settings for the container under which the StartTask runs. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's working directory.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the StartTask.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries)." + }, + "waitForSuccess": { + "type": "boolean", + "description": "Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask fails, new Tasks will continue to be scheduled on the Compute Node. The default is true." + } + } + }, + "BatchSubtask": { + "type": "object", + "description": "Information about an Azure Batch subtask.", + "properties": { + "id": { + "type": "integer", + "format": "int32", + "description": "The ID of the subtask." + }, + "nodeInfo": { + "$ref": "#/definitions/BatchNodeInfo", + "description": "Information about the Compute Node on which the subtask ran." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the subtask completed. This property is set only if the subtask is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/BatchTaskContainerExecutionInfo", + "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/BatchTaskFailureInfo", + "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure." + }, + "state": { + "$ref": "#/definitions/BatchSubtaskState", + "description": "The current state of the subtask." + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the subtask entered its current state." + }, + "previousState": { + "$ref": "#/definitions/BatchSubtaskState", + "description": "The previous state of the subtask. This property is not set if the subtask is in its initial running state." + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state." + }, + "result": { + "$ref": "#/definitions/BatchTaskExecutionResult", + "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + } + }, + "BatchSubtaskState": { + "type": "string", + "description": "BatchSubtaskState enums", + "enum": [ + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "BatchSubtaskState", + "modelAsString": true, + "values": [ + { + "name": "Preparing", + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "name": "Running", + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "name": "Completed", + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "BatchSupportedImage": { + "type": "object", + "description": "A reference to the Azure Virtual Machines Marketplace Image and additional\ninformation about the Image.", + "properties": { + "nodeAgentSKUId": { + "type": "string", + "description": "The ID of the Compute Node agent SKU which the Image supports.", + "x-ms-client-name": "nodeAgentSkuId" + }, + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The reference to the Azure Virtual Machine's Marketplace Image." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "The type of operating system (e.g. Windows or Linux) of the Image." + }, + "capabilities": { + "type": "array", + "description": "The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this list are considered of special interest and are generally related to integration with other features in the Azure Batch service.", + "items": { + "type": "string" + } + }, + "batchSupportEndOfLife": { + "type": "string", + "format": "date-time", + "description": "The time when the Azure Batch service will stop accepting create Pool requests for the Image." + }, + "verificationType": { + "$ref": "#/definitions/ImageVerificationType", + "description": "Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node agent SKU." + } + }, + "required": [ + "nodeAgentSKUId", + "imageReference", + "osType", + "verificationType" + ] + }, + "BatchTask": { + "type": "object", + "description": "Batch will retry Tasks when a recovery operation is triggered on a Node.\nExamples of recovery operations include (but are not limited to) when an\nunhealthy Node is rebooted or a Compute Node disappeared due to host failure.\nRetries due to recovery operations are independent of and are not counted\nagainst the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal\nretry due to a recovery operation may occur. Because of this, all Tasks should\nbe idempotent. This means Tasks need to tolerate being interrupted and\nrestarted without causing any corruption or duplicate data. The best practice\nfor long running Tasks is to use some form of checkpointing.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.", + "readOnly": true + }, + "url": { + "type": "string", + "description": "The URL of the Task.", + "readOnly": true + }, + "eTag": { + "type": "string", + "description": "The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect only if nobody else has modified the Task in the meantime.", + "readOnly": true + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified time of the Task.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Task.", + "readOnly": true + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/BatchTaskState", + "description": "The current state of the Task.", + "readOnly": true + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task entered its current state.", + "readOnly": true + }, + "previousState": { + "$ref": "#/definitions/BatchTaskState", + "description": "The previous state of the Task. This property is not set if the Task is in its initial Active state.", + "readOnly": true + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task entered its previous state. This property is not set if the Task is in its initial Active state.", + "readOnly": true + }, + "commandLine": { + "type": "string", + "description": "The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).", + "readOnly": true + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files.", + "readOnly": true + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "outputFiles": { + "type": "array", + "description": "A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInfo", + "description": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task.", + "readOnly": true + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "The execution constraints that apply to this Task." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "description": "The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1.", + "readOnly": true + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task.", + "readOnly": true + }, + "executionInfo": { + "$ref": "#/definitions/BatchTaskExecutionInfo", + "description": "Information about the execution of the Task.", + "readOnly": true + }, + "nodeInfo": { + "$ref": "#/definitions/BatchNodeInfo", + "description": "Information about the Compute Node on which the Task ran.", + "readOnly": true + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "description": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task.", + "readOnly": true + }, + "stats": { + "$ref": "#/definitions/BatchTaskStatistics", + "description": "Resource usage statistics for the Task.", + "readOnly": true + }, + "dependsOn": { + "$ref": "#/definitions/BatchTaskDependencies", + "description": "The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled.", + "readOnly": true + }, + "applicationPackageReferences": { + "type": "array", + "description": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "authenticationTokenSettings": { + "$ref": "#/definitions/AuthenticationTokenSettings", + "description": "The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job.", + "readOnly": true + } + } + }, + "BatchTaskAddCollectionResult": { + "type": "object", + "description": "The result of adding a collection of Tasks to a Job.", + "properties": { + "value": { + "type": "array", + "description": "The results of the add Task collection operation.", + "items": { + "$ref": "#/definitions/BatchTaskAddResult" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchTaskAddResult": { + "type": "object", + "description": "Result for a single Task added as part of an add Task collection operation.", + "properties": { + "status": { + "$ref": "#/definitions/BatchTaskAddStatus", + "description": "The status of the add Task request." + }, + "taskId": { + "type": "string", + "description": "The ID of the Task for which this is the result." + }, + "eTag": { + "type": "string", + "description": "The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the Job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified time of the Task." + }, + "location": { + "type": "string", + "description": "The URL of the Task, if the Task was successfully added." + }, + "error": { + "$ref": "#/definitions/BatchError", + "description": "The error encountered while attempting to add the Task." + } + }, + "required": [ + "status", + "taskId" + ] + }, + "BatchTaskAddStatus": { + "type": "string", + "description": "BatchTaskAddStatus enums", + "enum": [ + "success", + "clienterror", + "servererror" + ], + "x-ms-enum": { + "name": "BatchTaskAddStatus", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "success", + "description": "The Task was added successfully." + }, + { + "name": "ClientError", + "value": "clienterror", + "description": "The Task failed to add due to a client error and should not be retried without modifying the request as appropriate." + }, + { + "name": "ServerError", + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification." + } + ] + } + }, + "BatchTaskConstraints": { + "type": "object", + "description": "Execution constraints to apply to a Task.", + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "description": "The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the Task may run." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "description": "The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained for 7 days unless the Compute Node is removed or the Job is deleted." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default value is 0 (no retries)." + } + } + }, + "BatchTaskContainerExecutionInfo": { + "type": "object", + "description": "Contains information about the container which a Task is executing.", + "properties": { + "containerId": { + "type": "string", + "description": "The ID of the container." + }, + "state": { + "type": "string", + "description": "The state of the container. This is the state of the container according to the Docker service. It is equivalent to the status field returned by \"docker inspect\"." + }, + "error": { + "type": "string", + "description": "Detailed error information about the container. This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by \"docker inspect\"." + } + } + }, + "BatchTaskContainerSettings": { + "type": "object", + "description": "The container settings for a Task.", + "properties": { + "containerRunOptions": { + "type": "string", + "description": "Additional options to the container create command. These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "description": "The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to \"docker pull\". If no tag is provided as part of the Image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistryReference", + "description": "The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation." + }, + "workingDirectory": { + "$ref": "#/definitions/ContainerWorkingDirectory", + "description": "The location of the container Task working directory. The default is 'taskWorkingDirectory'." + }, + "containerHostBatchBindMounts": { + "type": "array", + "description": "The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.", + "items": { + "$ref": "#/definitions/ContainerHostBatchBindMountEntry" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "imageName" + ] + }, + "BatchTaskContainerSettingsUpdate": { + "type": "object", + "description": "The container settings for a Task.", + "properties": { + "containerRunOptions": { + "type": "string", + "description": "Additional options to the container create command. These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "description": "The Image to use to create the container in which the Task will run. This is the full Image reference, as would be specified to \"docker pull\". If no tag is provided as part of the Image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistryReference", + "description": "The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation." + }, + "workingDirectory": { + "$ref": "#/definitions/ContainerWorkingDirectory", + "description": "The location of the container Task working directory. The default is 'taskWorkingDirectory'." + }, + "containerHostBatchBindMounts": { + "type": "array", + "description": "The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty.", + "items": { + "$ref": "#/definitions/ContainerHostBatchBindMountEntry" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchTaskCounts": { + "type": "object", + "description": "The Task counts for a Job.", + "properties": { + "active": { + "type": "integer", + "format": "int32", + "description": "The number of Tasks in the active state." + }, + "running": { + "type": "integer", + "format": "int32", + "description": "The number of Tasks in the running or preparing state." + }, + "completed": { + "type": "integer", + "format": "int32", + "description": "The number of Tasks in the completed state." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "description": "The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ] + }, + "BatchTaskCountsResult": { + "type": "object", + "description": "The Task and TaskSlot counts for a Job.", + "properties": { + "taskCounts": { + "$ref": "#/definitions/BatchTaskCounts", + "description": "The number of Tasks per state." + }, + "taskSlotCounts": { + "$ref": "#/definitions/BatchTaskSlotCounts", + "description": "The number of TaskSlots required by Tasks per state." + } + }, + "required": [ + "taskCounts", + "taskSlotCounts" + ] + }, + "BatchTaskCreateContent": { + "type": "object", + "description": "Parameters for creating an Azure Batch Task.", + "properties": { + "id": { + "type": "string", + "description": "A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a Job that differ only by case)." + }, + "displayName": { + "type": "string", + "description": "A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the Task completes." + }, + "commandLine": { + "type": "string", + "description": "The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after the primary Task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/BatchTaskContainerSettings", + "description": "The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will not be able to access those files." + }, + "resourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + }, + "outputFiles": { + "type": "array", + "description": "A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed.", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "x-ms-identifiers": [] + }, + "environmentSettings": { + "type": "array", + "description": "A list of environment variable settings for the Task.", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "x-ms-identifiers": [] + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInfo", + "description": "A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task." + }, + "constraints": { + "$ref": "#/definitions/BatchTaskConstraints", + "description": "The execution constraints that apply to this Task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days." + }, + "requiredSlots": { + "type": "integer", + "format": "int32", + "description": "The number of scheduling slots that the Task required to run. The default is 1. A Task can only be scheduled to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "description": "The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "description": "An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance Task." + }, + "dependsOn": { + "$ref": "#/definitions/BatchTaskDependencies", + "description": "The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob." + }, + "applicationPackageReferences": { + "type": "array", + "description": "A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download failed, the Task fails.", + "items": { + "$ref": "#/definitions/BatchApplicationPackageReference" + }, + "x-ms-identifiers": [] + }, + "authenticationTokenSettings": { + "$ref": "#/definitions/AuthenticationTokenSettings", + "description": "The settings for an authentication token that the Task can use to perform Batch service operations. If this property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job." + } + }, + "required": [ + "id", + "commandLine" + ] + }, + "BatchTaskDependencies": { + "type": "object", + "description": "Specifies any dependencies of a Task. Any Task that is explicitly specified or\nwithin a dependency range must complete before the dependant Task will be\nscheduled.", + "properties": { + "taskIds": { + "type": "array", + "description": "The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent Task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using Task ID ranges instead.", + "items": { + "type": "string" + } + }, + "taskIdRanges": { + "type": "array", + "description": "The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent Task can be scheduled.", + "items": { + "$ref": "#/definitions/BatchTaskIdRange" + }, + "x-ms-identifiers": [] + } + } + }, + "BatchTaskExecutionInfo": { + "type": "object", + "description": "Information about the execution of a Task.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present only for Tasks that are in the running or completed state." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the Task completed. This property is set only if the Task is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "description": "The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/BatchTaskContainerExecutionInfo", + "description": "Information about the container under which the Task is executing. This property is set only if the Task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/BatchTaskFailureInfo", + "description": "Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "description": "The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service will retry the Task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "description": "The most recent time at which a retry of the Task started running. This element is present only if the Task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "requeueCount": { + "type": "integer", + "format": "int32", + "description": "The number of times the Task has been requeued by the Batch service as the result of a user request. When the user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has been requeued for these reasons." + }, + "lastRequeueTime": { + "type": "string", + "format": "date-time", + "description": "The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero." + }, + "result": { + "$ref": "#/definitions/BatchTaskExecutionResult", + "description": "The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ + "retryCount", + "requeueCount" + ] + }, + "BatchTaskExecutionResult": { + "type": "string", + "description": "BatchTaskExecutionResult enums", + "enum": [ + "success", + "failure" + ], + "x-ms-enum": { + "name": "BatchTaskExecutionResult", + "modelAsString": true, + "values": [ + { + "name": "Success", + "value": "success", + "description": "The Task ran successfully." + }, + { + "name": "Failure", + "value": "failure", + "description": "There was an error during processing of the Task. The failure may have occurred before the Task process was launched, while the Task process was executing, or after the Task process exited." + } + ] + } + }, + "BatchTaskFailureInfo": { + "type": "object", + "description": "Information about a Task failure.", + "properties": { + "category": { + "$ref": "#/definitions/ErrorCategory", + "description": "The category of the Task error." + }, + "code": { + "type": "string", + "description": "An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the Task error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "description": "A list of additional details related to the error.", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "category" + ] + }, + "BatchTaskGroup": { + "type": "object", + "description": "A collection of Azure Batch Tasks to add.", + "properties": { + "value": { + "type": "array", + "description": "The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks.", + "items": { + "$ref": "#/definitions/BatchTaskCreateContent" + } + } + }, + "required": [ + "value" + ] + }, + "BatchTaskIdRange": { + "type": "object", + "description": "The start and end of the range are inclusive. For example, if a range has start\n9 and end 12, then it represents Tasks '9', '10', '11' and '12'.", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "The first Task ID in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "The last Task ID in the range." + } + }, + "required": [ + "start", + "end" + ] + }, + "BatchTaskInfo": { + "type": "object", + "description": "Information about a Task running on a Compute Node.", + "properties": { + "taskUrl": { + "type": "string", + "description": "The URL of the Task." + }, + "jobId": { + "type": "string", + "description": "The ID of the Job to which the Task belongs." + }, + "taskId": { + "type": "string", + "description": "The ID of the Task." + }, + "subtaskId": { + "type": "integer", + "format": "int32", + "description": "The ID of the subtask if the Task is a multi-instance Task." + }, + "taskState": { + "$ref": "#/definitions/BatchTaskState", + "description": "The current state of the Task." + }, + "executionInfo": { + "$ref": "#/definitions/BatchTaskExecutionInfo", + "description": "Information about the execution of the Task." + } + }, + "required": [ + "taskState" + ] + }, + "BatchTaskListResult": { + "type": "object", + "description": "The result of listing the Tasks in a Job.", + "properties": { + "value": { + "type": "array", + "description": "The list of Tasks.", + "items": { + "$ref": "#/definitions/BatchTask" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchTaskListSubtasksResult": { + "type": "object", + "description": "The result of listing the subtasks of a Task.", + "properties": { + "value": { + "type": "array", + "description": "The list of subtasks.", + "items": { + "$ref": "#/definitions/BatchSubtask" + } + }, + "odata.nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "BatchTaskSchedulingPolicy": { + "type": "object", + "description": "Specifies how Tasks should be distributed across Compute Nodes.", + "properties": { + "nodeFillType": { + "$ref": "#/definitions/BatchNodeFillType", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread." + } + }, + "required": [ + "nodeFillType" + ] + }, + "BatchTaskSchedulingPolicyUpdate": { + "type": "object", + "description": "Specifies how Tasks should be distributed across Compute Nodes.", + "properties": { + "nodeFillType": { + "$ref": "#/definitions/BatchNodeFillType", + "description": "How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread." + } + } + }, + "BatchTaskSlotCounts": { + "type": "object", + "description": "The TaskSlot counts for a Job.", + "properties": { + "active": { + "type": "integer", + "format": "int32", + "description": "The number of TaskSlots for active Tasks." + }, + "running": { + "type": "integer", + "format": "int32", + "description": "The number of TaskSlots for running Tasks." + }, + "completed": { + "type": "integer", + "format": "int32", + "description": "The number of TaskSlots for completed Tasks." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "description": "The number of TaskSlots for succeeded Tasks." + }, + "failed": { + "type": "integer", + "format": "int32", + "description": "The number of TaskSlots for failed Tasks." + } + }, + "required": [ + "active", + "running", + "completed", + "succeeded", + "failed" + ] + }, + "BatchTaskState": { + "type": "string", + "description": "BatchTaskState enums", + "enum": [ + "active", + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "BatchTaskState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "active", + "description": "The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "name": "Preparing", + "value": "preparing", + "description": "The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node." + }, + { + "name": "Running", + "value": "running", + "description": "The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing." + }, + { + "name": "Completed", + "value": "completed", + "description": "The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated." + } + ] + } + }, + "BatchTaskStatistics": { + "type": "object", + "description": "Resource usage statistics for a Task.", + "properties": { + "url": { + "type": "string", + "description": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "description": "The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task.", + "x-ms-client-name": "userCpuTime" + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "description": "The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task.", + "x-ms-client-name": "kernelCpuTime" + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "description": "The total wall clock time of the Task. The wall clock time is the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by then). If the Task was retried, this includes the wall clock time of all the Task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk read operations made by the Task." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "description": "The total number of disk write operations made by the Task." + }, + "readIOGiB": { + "type": "number", + "format": "float", + "description": "The total gibibytes read from disk by the Task." + }, + "writeIOGiB": { + "type": "number", + "format": "float", + "description": "The total gibibytes written to disk by the Task." + }, + "waitTime": { + "type": "string", + "format": "duration", + "description": "The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the most recent Task execution.)." + } + }, + "required": [ + "url", + "startTime", + "lastUpdateTime", + "userCPUTime", + "kernelCPUTime", + "wallClockTime", + "readIOps", + "writeIOps", + "readIOGiB", + "writeIOGiB", + "waitTime" + ] + }, + "CachingType": { + "type": "string", + "description": "CachingType enums", + "enum": [ + "none", + "readonly", + "readwrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "none", + "description": "The caching mode for the disk is not enabled." + }, + { + "name": "ReadOnly", + "value": "readonly", + "description": "The caching mode for the disk is read only." + }, + { + "name": "ReadWrite", + "value": "readwrite", + "description": "The caching mode for the disk is read and write." + } + ] + } + }, + "CifsMountConfiguration": { + "type": "object", + "description": "Information used to connect to a CIFS file system.", + "properties": { + "username": { + "type": "string", + "description": "The user to use for authentication against the CIFS file system." + }, + "source": { + "type": "string", + "description": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to use for authentication against the CIFS file system.", + "x-ms-secret": true + } + }, + "required": [ + "username", + "source", + "relativeMountPath", + "password" + ] + }, + "ContainerConfiguration": { + "type": "object", + "description": "The configuration for container-enabled Pools.", + "properties": { + "type": { + "$ref": "#/definitions/ContainerType", + "description": "The container technology to be used." + }, + "containerImageNames": { + "type": "array", + "description": "The collection of container Image names. This is the full Image reference, as would be specified to \"docker pull\". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "description": "Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.", + "items": { + "$ref": "#/definitions/ContainerRegistryReference" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "type" + ] + }, + "ContainerConfigurationUpdate": { + "type": "object", + "description": "The configuration for container-enabled Pools.", + "properties": { + "type": { + "$ref": "#/definitions/ContainerType", + "description": "The container technology to be used." + }, + "containerImageNames": { + "type": "array", + "description": "The collection of container Image names. This is the full Image reference, as would be specified to \"docker pull\". An Image will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry.", + "items": { + "type": "string" + } + }, + "containerRegistries": { + "type": "array", + "description": "Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry which requires credentials, then those credentials must be provided here.", + "items": { + "$ref": "#/definitions/ContainerRegistryReference" + }, + "x-ms-identifiers": [] + } + } + }, + "ContainerHostBatchBindMountEntry": { + "type": "object", + "description": "The entry of path and mount mode you want to mount into task container.", + "properties": { + "source": { + "$ref": "#/definitions/ContainerHostDataPath", + "description": "The path which be mounted to container customer can select." + }, + "isReadOnly": { + "type": "boolean", + "description": "Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path." + } + } + }, + "ContainerHostDataPath": { + "type": "string", + "description": "The paths which will be mounted to container task's container.", + "enum": [ + "regional", + "zonal" + ], + "x-ms-enum": { + "name": "ContainerHostDataPath", + "modelAsString": true, + "values": [ + { + "name": "Regional", + "value": "regional", + "description": "All nodes in the pool will be allocated in the same region." + }, + { + "name": "Zonal", + "value": "zonal", + "description": "Nodes in the pool will be spread across different availability zones with best effort balancing." + } + ] + } + }, + "ContainerRegistryReference": { + "type": "object", + "description": "A private container registry.", + "properties": { + "username": { + "type": "string", + "description": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to log into the registry server.", + "x-ms-secret": true + }, + "registryServer": { + "type": "string", + "description": "The registry URL. If omitted, the default is \"docker.io\"." + }, + "identityReference": { + "$ref": "#/definitions/BatchNodeIdentityReference", + "description": "The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password." + } + } + }, + "ContainerType": { + "type": "string", + "description": "ContainerType enums", + "enum": [ + "dockerCompatible", + "criCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true, + "values": [ + { + "name": "DockerCompatible", + "value": "dockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + }, + { + "name": "CriCompatible", + "value": "criCompatible", + "description": "A CRI based technology will be used to launch the containers." + } + ] + } + }, + "ContainerWorkingDirectory": { + "type": "string", + "description": "ContainerWorkingDirectory enums", + "enum": [ + "taskWorkingDirectory", + "containerImageDefault" + ], + "x-ms-enum": { + "name": "ContainerWorkingDirectory", + "modelAsString": true, + "values": [ + { + "name": "TaskWorkingDirectory", + "value": "taskWorkingDirectory", + "description": "Use the standard Batch service Task working directory, which will contain the Task Resource Files populated by Batch." + }, + { + "name": "ContainerImageDefault", + "value": "containerImageDefault", + "description": "Use the working directory defined in the container Image. Beware that this directory will not contain the Resource Files downloaded by Batch." + } + ] + } + }, + "DataDisk": { + "type": "object", + "description": "Settings which will be used by the data disks associated to Compute Nodes in\nthe Pool. When using attached data disks, you need to mount and format the\ndisks from within a VM to use them.", + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive.", + "x-ms-client-name": "logicalUnitNumber" + }, + "caching": { + "$ref": "#/definitions/CachingType", + "description": "The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "The initial disk size in gigabytes.", + "x-ms-client-name": "diskSizeGb" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "The storage Account type to be used for the data disk. If omitted, the default is \"standard_lrs\"." + } + }, + "required": [ + "lun", + "diskSizeGB" + ] + }, + "DependencyAction": { + "type": "string", + "description": "DependencyAction enums", + "enum": [ + "satisfy", + "block" + ], + "x-ms-enum": { + "name": "DependencyAction", + "modelAsString": true, + "values": [ + { + "name": "Satisfy", + "value": "satisfy", + "description": "Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled to run." + }, + { + "name": "Block", + "value": "block", + "description": "Blocks tasks waiting on this task, preventing them from being scheduled." + } + ] + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements", + "enum": [ + "cachedisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true, + "values": [ + { + "name": "CacheDisk", + "value": "cachedisk", + "description": "The Ephemeral OS Disk is stored on the VM cache." + } + ] + } + }, + "DiffDiskSettings": { + "type": "object", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the\ncompute node (VM).", + "properties": { + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements." + } + } + }, + "DisableBatchJobOption": { + "type": "string", + "description": "DisableBatchJobOption enums", + "enum": [ + "requeue", + "terminate", + "wait" + ], + "x-ms-enum": { + "name": "DisableBatchJobOption", + "modelAsString": true, + "values": [ + { + "name": "Requeue", + "value": "requeue", + "description": "Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled." + }, + { + "name": "Terminate", + "value": "terminate", + "description": "Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "name": "Wait", + "value": "wait", + "description": "Allow currently running Tasks to complete." + } + ] + } + }, + "DiskEncryptionConfiguration": { + "type": "object", + "description": "The disk encryption configuration applied on compute nodes in the pool.\nDisk encryption configuration is not supported on Linux pool created with\nAzure Compute Gallery Image.", + "properties": { + "targets": { + "type": "array", + "description": "The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt on the compute node.", + "items": { + "$ref": "#/definitions/DiskEncryptionTarget" + } + } + } + }, + "DiskEncryptionTarget": { + "type": "string", + "description": "DiskEncryptionTarget enums", + "enum": [ + "osdisk", + "temporarydisk" + ], + "x-ms-enum": { + "name": "DiskEncryptionTarget", + "modelAsString": true, + "values": [ + { + "name": "OsDisk", + "value": "osdisk", + "description": "The OS Disk on the compute node is encrypted." + }, + { + "name": "TemporaryDisk", + "value": "temporarydisk", + "description": "The temporary disk on the compute node is encrypted. On Linux this encryption applies to other partitions (such as those on mounted data disks) when encryption occurs at boot time." + } + ] + } + }, + "DynamicVNetAssignmentScope": { + "type": "string", + "description": "DynamicVNetAssignmentScope enums", + "enum": [ + "none", + "job" + ], + "x-ms-enum": { + "name": "DynamicVNetAssignmentScope", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "none", + "description": "No dynamic VNet assignment is enabled." + }, + { + "name": "Job", + "value": "job", + "description": "Dynamic VNet assignment is done per-job." + } + ] + } + }, + "ElevationLevel": { + "type": "string", + "description": "ElevationLevel enums", + "enum": [ + "nonadmin", + "admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": true, + "values": [ + { + "name": "NonAdmin", + "value": "nonadmin", + "description": "The user is a standard user without elevated access." + }, + { + "name": "Admin", + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "EnvironmentSetting": { + "type": "object", + "description": "An environment variable to be set on a Task process.", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + } + }, + "required": [ + "name" + ] + }, + "ErrorCategory": { + "type": "string", + "description": "ErrorCategory enums", + "enum": [ + "usererror", + "servererror" + ], + "x-ms-enum": { + "name": "ErrorCategory", + "modelAsString": true, + "values": [ + { + "name": "UserError", + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration." + }, + { + "name": "ServerError", + "value": "servererror", + "description": "The error is due to an internal server issue." + } + ] + } + }, + "ExitCodeMapping": { + "type": "object", + "description": "How the Batch service should respond if a Task exits with a particular exit\ncode.", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "A process exit code." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "description": "How the Batch service should respond if the Task exits with this exit code." + } + }, + "required": [ + "code", + "exitOptions" + ] + }, + "ExitCodeRangeMapping": { + "type": "object", + "description": "A range of exit codes and how the Batch service should respond to exit codes\nwithin that range.", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "The first exit code in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "The last exit code in the range." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "description": "How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive)." + } + }, + "required": [ + "start", + "end", + "exitOptions" + ] + }, + "ExitConditions": { + "type": "object", + "description": "Specifies how the Batch service should respond when the Task completes.", + "properties": { + "exitCodes": { + "type": "array", + "description": "A list of individual Task exit codes and how the Batch service should respond to them.", + "items": { + "$ref": "#/definitions/ExitCodeMapping" + }, + "x-ms-identifiers": [] + }, + "exitCodeRanges": { + "type": "array", + "description": "A list of Task exit code ranges and how the Batch service should respond to them.", + "items": { + "$ref": "#/definitions/ExitCodeRangeMapping" + }, + "x-ms-identifiers": [] + }, + "preProcessingError": { + "$ref": "#/definitions/ExitOptions", + "description": "How the Batch service should respond if the Task fails to start due to an error." + }, + "fileUploadError": { + "$ref": "#/definitions/ExitOptions", + "description": "How the Batch service should respond if a file upload error occurs. If the Task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence." + }, + "default": { + "$ref": "#/definitions/ExitOptions", + "description": "How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + } + } + }, + "ExitOptions": { + "type": "object", + "description": "Specifies how the Batch service responds to a particular exit condition.", + "properties": { + "jobAction": { + "$ref": "#/definitions/BatchJobAction", + "description": "An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "dependencyAction": { + "$ref": "#/definitions/DependencyAction", + "description": "An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent tasks." + } + } + }, + "FileProperties": { + "type": "object", + "description": "The properties of a file on a Compute Node.", + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The file creation time. The creation time is not returned for files on Linux Compute Nodes." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The time at which the file was last modified." + }, + "contentLength": { + "type": "string", + "description": "The length of the file." + }, + "contentType": { + "type": "string", + "description": "The content type of the file." + }, + "fileMode": { + "type": "string", + "description": "The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes." + } + }, + "required": [ + "lastModified", + "contentLength" + ] + }, + "HttpHeader": { + "type": "object", + "description": "An HTTP header name-value pair", + "properties": { + "name": { + "type": "string", + "description": "The case-insensitive name of the header to be used while uploading output files." + }, + "value": { + "type": "string", + "description": "The value of the header to be used while uploading output files." + } + }, + "required": [ + "name" + ] + }, + "ImageReference": { + "type": "object", + "description": "A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image.\nTo get the list of all Azure Marketplace Image references verified by Azure Batch, see the\n' List Supported Images ' operation.", + "properties": { + "publisher": { + "type": "string", + "description": "The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "description": "The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "description": "The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter." + }, + "version": { + "type": "string", + "description": "The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest version of an Image. If omitted, the default is 'latest'." + }, + "virtualMachineImageId": { + "type": "string", + "description": "The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "exactVersion": { + "type": "string", + "description": "The specific version of the platform image or marketplace image used to create the node. This read-only field differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'.", + "readOnly": true + }, + "sharedGalleryImageId": { + "type": "string", + "description": "The shared gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call." + }, + "communityGalleryImageId": { + "type": "string", + "description": "The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched from community gallery image GET call." + } + } + }, + "ImageVerificationType": { + "type": "string", + "description": "ImageVerificationType enums", + "enum": [ + "verified", + "unverified" + ], + "x-ms-enum": { + "name": "ImageVerificationType", + "modelAsString": true, + "values": [ + { + "name": "Verified", + "value": "verified", + "description": "The Image is guaranteed to be compatible with the associated Compute Node agent SKU and all Batch features have been confirmed to work as expected." + }, + { + "name": "Unverified", + "value": "unverified", + "description": "The associated Compute Node agent SKU should have binary compatibility with the Image, but specific functionality has not been verified." + } + ] + } + }, + "InboundEndpoint": { + "type": "object", + "description": "An inbound endpoint on a Compute Node.", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "description": "The protocol of the endpoint." + }, + "publicIPAddress": { + "type": "string", + "description": "The public IP address of the Compute Node.", + "x-ms-client-name": "publicIpAddress" + }, + "publicFQDN": { + "type": "string", + "description": "The public fully qualified domain name for the Compute Node." + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The public port number of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The backend port number of the endpoint." + } + }, + "required": [ + "name", + "protocol", + "publicIPAddress", + "publicFQDN", + "frontendPort", + "backendPort" + ] + }, + "InboundEndpointProtocol": { + "type": "string", + "description": "InboundEndpointProtocol enums", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": true, + "values": [ + { + "name": "Tcp", + "value": "tcp", + "description": "Use TCP for the endpoint." + }, + { + "name": "Udp", + "value": "udp", + "description": "Use UDP for the endpoint." + } + ] + } + }, + "InboundNatPool": { + "type": "object", + "description": "A inbound NAT Pool that can be used to address specific ports on Compute Nodes\nin a Batch Pool externally.", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "description": "The protocol of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "description": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "description": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "description": "A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "protocol", + "backendPort", + "frontendPortRangeStart", + "frontendPortRangeEnd" + ] + }, + "InstanceViewStatus": { + "type": "object", + "description": "The instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "displayStatus": { + "type": "string", + "description": "The localized label for the status." + }, + "level": { + "$ref": "#/definitions/StatusLevelTypes", + "description": "Level code." + }, + "message": { + "type": "string", + "description": "The detailed status message." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + }, + "IpAddressProvisioningType": { + "type": "string", + "description": "IPAddressProvisioningType enums", + "enum": [ + "batchmanaged", + "usermanaged", + "nopublicipaddresses" + ], + "x-ms-enum": { + "name": "IpAddressProvisioningType", + "modelAsString": true, + "values": [ + { + "name": "BatchManaged", + "value": "batchmanaged", + "description": "A public IP will be created and managed by Batch. There may be multiple public IPs depending on the size of the Pool." + }, + { + "name": "UserManaged", + "value": "usermanaged", + "description": "Public IPs are provided by the user and will be used to provision the Compute Nodes." + }, + { + "name": "NoPublicIpAddresses", + "value": "nopublicipaddresses", + "description": "No public IP Address will be created." + } + ] + } + }, + "LinuxUserConfiguration": { + "type": "object", + "description": "Properties used to create a user Account on a Linux Compute Node.", + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "description": "The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "description": "The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "format": "password", + "description": "The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of the user's .ssh directory is done).", + "x-ms-secret": true + } + } + }, + "LoginMode": { + "type": "string", + "description": "LoginMode enums", + "enum": [ + "batch", + "interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": true, + "values": [ + { + "name": "Batch", + "value": "batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "name": "Interactive", + "value": "interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session will not be elevated unless the application executed by the Task command line is configured to always require administrative privilege or to always require maximum privilege." + } + ] + } + }, + "ManagedDisk": { + "type": "object", + "description": "The managed disk parameters.", + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "The storage account type for managed disk." + }, + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile settings for the managed disk." + } + } + }, + "MetadataItem": { + "type": "object", + "description": "The Batch service does not assign any meaning to this metadata; it is solely\nfor the use of user code.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metadata item." + }, + "value": { + "type": "string", + "description": "The value of the metadata item." + } + }, + "required": [ + "name", + "value" + ] + }, + "MountConfiguration": { + "type": "object", + "description": "The file system to mount on each node.", + "properties": { + "azureBlobFileSystemConfiguration": { + "$ref": "#/definitions/AzureBlobFileSystemConfiguration", + "description": "The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties." + }, + "nfsMountConfiguration": { + "$ref": "#/definitions/NfsMountConfiguration", + "description": "The NFS file system to mount on each node. This property is mutually exclusive with all other properties." + }, + "cifsMountConfiguration": { + "$ref": "#/definitions/CifsMountConfiguration", + "description": "The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties." + }, + "azureFileShareConfiguration": { + "$ref": "#/definitions/AzureFileShareConfiguration", + "description": "The Azure File Share to mount on each node. This property is mutually exclusive with all other properties." + } + } + }, + "MultiInstanceSettings": { + "type": "object", + "description": "Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case,\nif any of the subtasks fail (for example due to exiting with a non-zero exit\ncode) the entire multi-instance Task fails. The multi-instance Task is then\nterminated and retried, up to its retry limit.", + "properties": { + "numberOfInstances": { + "type": "integer", + "format": "int32", + "description": "The number of Compute Nodes required by the Task. If omitted, the default is 1." + }, + "coordinationCommandLine": { + "type": "string", + "description": "The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main Task command. A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages." + }, + "commonResourceFiles": { + "type": "array", + "description": "A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and Task resource files is that common resource files are downloaded for all subtasks including the primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "coordinationCommandLine" + ] + }, + "NameValuePair": { + "type": "object", + "description": "Represents a name-value pair.", + "properties": { + "name": { + "type": "string", + "description": "The name in the name-value pair." + }, + "value": { + "type": "string", + "description": "The value in the name-value pair." + } + } + }, + "NetworkConfiguration": { + "type": "object", + "description": "The network configuration for a Pool.", + "properties": { + "subnetId": { + "type": "string", + "description": "The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. Enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "dynamicVNetAssignmentScope": { + "$ref": "#/definitions/DynamicVNetAssignmentScope", + "description": "The scope of dynamic vnet assignment." + }, + "endpointConfiguration": { + "$ref": "#/definitions/BatchPoolEndpointConfiguration", + "description": "The configuration for endpoints on Compute Nodes in the Batch Pool." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIpAddressConfiguration", + "description": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "x-ms-client-name": "publicIpAddressConfiguration" + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview." + } + } + }, + "NetworkConfigurationUpdate": { + "type": "object", + "description": "The network configuration for a Pool.", + "properties": { + "subnetId": { + "type": "string", + "description": "The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. Enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + }, + "dynamicVNetAssignmentScope": { + "$ref": "#/definitions/DynamicVNetAssignmentScope", + "description": "The scope of dynamic vnet assignment." + }, + "endpointConfiguration": { + "$ref": "#/definitions/BatchPoolEndpointConfigurationUpdate", + "description": "The configuration for endpoints on Compute Nodes in the Batch Pool." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/PublicIpAddressConfiguration", + "description": "The Public IPAddress configuration for Compute Nodes in the Batch Pool.", + "x-ms-client-name": "publicIpAddressConfiguration" + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview." + } + } + }, + "NetworkSecurityGroupRule": { + "type": "object", + "description": "A network security group rule to apply to an inbound endpoint.", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "$ref": "#/definitions/NetworkSecurityGroupRuleAccess", + "description": "The action that should be taken for a specified IP address, subnet range or tag." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + }, + "sourcePortRanges": { + "type": "array", + "description": "The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status code 400. The default value is '*'.", + "items": { + "type": "string" + } + } + }, + "required": [ + "priority", + "access", + "sourceAddressPrefix" + ] + }, + "NetworkSecurityGroupRuleAccess": { + "type": "string", + "description": "NetworkSecurityGroupRuleAccess enums", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "allow", + "description": "Allow access." + }, + { + "name": "Deny", + "value": "deny", + "description": "Deny access." + } + ] + } + }, + "NfsMountConfiguration": { + "type": "object", + "description": "Information used to connect to an NFS file system.", + "properties": { + "source": { + "type": "string", + "description": "The URI of the file system to mount." + }, + "relativeMountPath": { + "type": "string", + "description": "The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable." + }, + "mountOptions": { + "type": "string", + "description": "Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux." + } + }, + "required": [ + "source", + "relativeMountPath" + ] + }, + "OSDisk": { + "type": "object", + "description": "Settings for the operating system disk of the compute node (VM).", + "properties": { + "ephemeralOSDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM)." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "description": "Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard storage. ReadOnly for Premium storage." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "The initial disk size in GB when creating new OS disk." + }, + "managedDisk": { + "$ref": "#/definitions/ManagedDisk", + "description": "The managed disk parameters." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + } + } + }, + "OSType": { + "type": "string", + "description": "OSType enums", + "enum": [ + "linux", + "windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "linux", + "description": "The Linux operating system." + }, + { + "name": "Windows", + "value": "windows", + "description": "The Windows operating system." + } + ] + } + }, + "OnAllBatchTasksComplete": { + "type": "string", + "description": "The action the Batch service should take when all Tasks in the Job are in the completed state.", + "enum": [ + "noaction", + "terminatejob" + ], + "x-ms-enum": { + "name": "OnAllBatchTasksComplete", + "modelAsString": true, + "values": [ + { + "name": "NoAction", + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means." + }, + { + "name": "TerminateJob", + "value": "terminatejob", + "description": "Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'." + } + ] + } + }, + "OnBatchTaskFailure": { + "type": "string", + "description": "OnTaskFailure enums", + "enum": [ + "noaction", + "performexitoptionsjobaction" + ], + "x-ms-enum": { + "name": "OnBatchTaskFailure", + "modelAsString": true, + "values": [ + { + "name": "NoAction", + "value": "noaction", + "description": "Do nothing. The Job remains active unless terminated or disabled by some other means." + }, + { + "name": "PerformExitOptionsJobAction", + "value": "performexitoptionsjobaction", + "description": "Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'." + } + ] + } + }, + "OutputFile": { + "type": "object", + "description": "On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure.", + "properties": { + "filePattern": { + "type": "string", + "description": "A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with \".\" it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \\ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied." + }, + "destination": { + "$ref": "#/definitions/OutputFileDestination", + "description": "The destination for the output file(s)." + }, + "uploadOptions": { + "$ref": "#/definitions/OutputFileUploadConfig", + "description": "Additional options for the upload operation, including under what conditions to perform the upload." + } + }, + "required": [ + "filePattern", + "destination", + "uploadOptions" + ] + }, + "OutputFileBlobContainerDestination": { + "type": "object", + "description": "Specifies a file upload destination within an Azure blob storage container.", + "properties": { + "path": { + "type": "string", + "description": "The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name." + }, + "containerUrl": { + "type": "string", + "description": "The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, the URL must include a Shared Access Signature (SAS) granting write permissions to the container." + }, + "identityReference": { + "$ref": "#/definitions/BatchNodeIdentityReference", + "description": "The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container." + }, + "uploadHeaders": { + "type": "array", + "description": "A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading files to Azure Storage. Official document on allowed headers when uploading blobs: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types.", + "items": { + "$ref": "#/definitions/HttpHeader" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "containerUrl" + ] + }, + "OutputFileDestination": { + "type": "object", + "description": "The destination to which a file should be uploaded.", + "properties": { + "container": { + "$ref": "#/definitions/OutputFileBlobContainerDestination", + "description": "A location in Azure blob storage to which files are uploaded." + } + } + }, + "OutputFileUploadCondition": { + "type": "string", + "description": "OutputFileUploadCondition enums", + "enum": [ + "tasksuccess", + "taskfailure", + "taskcompletion" + ], + "x-ms-enum": { + "name": "OutputFileUploadCondition", + "modelAsString": true, + "values": [ + { + "name": "TaskSuccess", + "value": "tasksuccess", + "description": "Upload the file(s) only after the Task process exits with an exit code of 0." + }, + { + "name": "TaskFailure", + "value": "taskfailure", + "description": "Upload the file(s) only after the Task process exits with a nonzero exit code." + }, + { + "name": "TaskCompletion", + "value": "taskcompletion", + "description": "Upload the file(s) after the Task process exits, no matter what the exit code was." + } + ] + } + }, + "OutputFileUploadConfig": { + "type": "object", + "description": "Options for an output file upload operation, including under what conditions\nto perform the upload.", + "properties": { + "uploadCondition": { + "$ref": "#/definitions/OutputFileUploadCondition", + "description": "The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion." + } + }, + "required": [ + "uploadCondition" + ] + }, + "PublicIpAddressConfiguration": { + "type": "object", + "description": "The public IP Address configuration of the networking configuration of a Pool.", + "properties": { + "provision": { + "$ref": "#/definitions/IpAddressProvisioningType", + "description": "The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged.", + "x-ms-client-name": "IpAddressProvisioningType" + }, + "ipAddressIds": { + "type": "array", + "description": "The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.", + "items": { + "type": "string" + } + } + } + }, + "RecentBatchJob": { + "type": "object", + "description": "Information about the most recent Job to run under the Job Schedule.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the Job." + }, + "url": { + "type": "string", + "description": "The URL of the Job." + } + } + }, + "ResizeError": { + "type": "object", + "description": "An error that occurred when resizing a Pool.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the Pool resize error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "description": "A list of additional error details related to the Pool resize error.", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "x-ms-identifiers": [] + } + } + }, + "ResourceFile": { + "type": "object", + "description": "A single file or multiple files to be downloaded to a Compute Node.", + "properties": { + "autoStorageContainerName": { + "type": "string", + "description": "The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "description": "The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access." + }, + "httpUrl": { + "type": "string", + "description": "The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "description": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "description": "The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the Task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "description": "The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file." + }, + "identityReference": { + "$ref": "#/definitions/BatchNodeIdentityReference", + "description": "The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl." + } + } + }, + "RollingUpgradePolicy": { + "type": "object", + "description": "The configuration parameters used while performing a rolling upgrade.", + "properties": { + "enableCrossZoneUpgrade": { + "type": "boolean", + "description": "Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal." + }, + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "format": "duration", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format.." + }, + "prioritizeUnhealthyInstances": { + "type": "boolean", + "description": "Upgrade all unhealthy instances in a scale set before any healthy instances." + }, + "rollbackFailedInstancesOnPolicyBreach": { + "type": "boolean", + "description": "Rollback failed instances to previous model if the Rolling Upgrade policy is violated." + } + } + }, + "SchedulingState": { + "type": "string", + "description": "SchedulingState enums", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "SchedulingState", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "enabled", + "description": "Tasks can be scheduled on the Compute Node." + }, + { + "name": "Disabled", + "value": "disabled", + "description": "No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node may still run to completion. All Compute Nodes start with scheduling enabled." + } + ] + } + }, + "SecurityEncryptionTypes": { + "type": "string", + "description": "SecurityEncryptionTypes enums", + "enum": [ + "NonPersistedTPM", + "VMGuestStateOnly" + ], + "x-ms-enum": { + "name": "SecurityEncryptionTypes", + "modelAsString": true, + "values": [ + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "NonPersistedTPM" + }, + { + "name": "VMGuestStateOnly", + "value": "VMGuestStateOnly", + "description": "VMGuestStateOnly" + } + ] + } + }, + "SecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", + "properties": { + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings." + }, + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + } + }, + "required": [ + "encryptionAtHost", + "securityType", + "uefiSettings" + ] + }, + "SecurityProfileUpdate": { + "type": "object", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set.", + "properties": { + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes." + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings." + }, + "uefiSettings": { + "$ref": "#/definitions/UefiSettings", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies the security settings like secure boot and vTPM used while creating the virtual machine." + } + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.", + "enum": [ + "trustedLaunch", + "confidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "trustedLaunch", + "value": "trustedLaunch", + "description": "Trusted launch protects against advanced and persistent attack techniques." + }, + { + "name": "confidentialVM", + "value": "confidentialVM", + "description": "Azure confidential computing offers confidential VMs are for tenants with high security and confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's state from being read or modified." + } + ] + } + }, + "ServiceArtifactReference": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version\nfor all virtual machines in the scale set when using 'latest' image version.", + "properties": { + "id": { + "type": "string", + "description": "The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "id" + ] + }, + "ServiceArtifactReferenceUpdate": { + "type": "object", + "description": "Specifies the service artifact reference id used to set same image version\nfor all virtual machines in the scale set when using 'latest' image version.", + "properties": { + "id": { + "type": "string", + "description": "The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "StatusLevelTypes": { + "type": "string", + "description": "Level code.", + "enum": [ + "Error", + "Info", + "Warning" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Error", + "value": "Error", + "description": "Error" + }, + { + "name": "Info", + "value": "Info", + "description": "Info" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning" + } + ] + } + }, + "StorageAccountType": { + "type": "string", + "description": "StorageAccountType enums", + "enum": [ + "standard_lrs", + "premium_lrs", + "standardssd_lrs" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true, + "values": [ + { + "name": "StandardLRS", + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage." + }, + { + "name": "PremiumLRS", + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage." + }, + { + "name": "StandardSSDLRS", + "value": "standardssd_lrs", + "description": "The data disk / OS disk should use standard SSD locally redundant storage." + } + ] + } + }, + "UefiSettings": { + "type": "object", + "description": "Specifies the security settings like secure boot and vTPM used while creating the virtual machine.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine." + }, + "vTpmEnabled": { + "type": "boolean", + "description": "Specifies whether vTPM should be enabled on the virtual machine." + } + } + }, + "UpgradeMode": { + "type": "string", + "description": "UpgradeMode enums", + "enum": [ + "automatic", + "manual", + "rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "name": "Automatic", + "value": "automatic", + "description": "TAll virtual machines in the scale set are automatically updated at the same time." + }, + { + "name": "Manual", + "value": "manual", + "description": "You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action." + }, + { + "name": "Rolling", + "value": "rolling", + "description": "The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all instances brought up-to-date." + } + ] + } + }, + "UpgradePolicy": { + "type": "object", + "description": "Describes an upgrade policy - automatic, manual, or rolling.", + "properties": { + "mode": { + "$ref": "#/definitions/UpgradeMode", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOsUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade.", + "x-ms-client-name": "automaticOsUpgradePolicy" + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + } + }, + "required": [ + "mode" + ] + }, + "UpgradePolicyUpdate": { + "type": "object", + "description": "Describes an upgrade policy - automatic, manual, or rolling.", + "properties": { + "mode": { + "$ref": "#/definitions/UpgradeMode", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOsUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic OS upgrade.", + "x-ms-client-name": "automaticOsUpgradePolicy" + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + } + } + }, + "UploadBatchServiceLogsContent": { + "type": "object", + "description": "The Azure Batch service log files upload parameters for a Compute Node.", + "properties": { + "containerUrl": { + "type": "string", + "description": "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime." + }, + "identityReference": { + "$ref": "#/definitions/BatchNodeIdentityReference", + "description": "The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container." + } + }, + "required": [ + "containerUrl", + "startTime" + ] + }, + "UploadBatchServiceLogsResult": { + "type": "object", + "description": "The result of uploading Batch service log files from a specific Compute Node.", + "properties": { + "virtualDirectoryName": { + "type": "string", + "description": "The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier." + }, + "numberOfFilesUploaded": { + "type": "integer", + "format": "int32", + "description": "The number of log files which will be uploaded." + } + }, + "required": [ + "virtualDirectoryName", + "numberOfFilesUploaded" + ] + }, + "UserAccount": { + "type": "object", + "description": "Properties used to create a user used to execute Tasks on an Azure Batch\nCompute Node.", + "properties": { + "name": { + "type": "string", + "description": "The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password for the user Account.", + "x-ms-secret": true + }, + "elevationLevel": { + "$ref": "#/definitions/ElevationLevel", + "description": "The elevation level of the user Account. The default value is nonAdmin." + }, + "linuxUserConfiguration": { + "$ref": "#/definitions/LinuxUserConfiguration", + "description": "The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If not specified, the user is created with the default options." + }, + "windowsUserConfiguration": { + "$ref": "#/definitions/WindowsUserConfiguration", + "description": "The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows Pool. If not specified and on a Windows Pool, the user is created with the default options." + } + }, + "required": [ + "name", + "password" + ] + }, + "UserAssignedIdentity": { + "type": "object", + "description": "The user assigned Identity", + "properties": { + "resourceId": { + "type": "string", + "description": "The ARM resource id of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client id of the user assigned identity.", + "readOnly": true + }, + "principalId": { + "type": "string", + "description": "The principal id of the user assigned identity.", + "readOnly": true + } + }, + "required": [ + "resourceId" + ] + }, + "UserIdentity": { + "type": "object", + "description": "The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.", + "properties": { + "username": { + "type": "string", + "description": "The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "description": "The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs.", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionTypes", + "description": "Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and is required when using Confidential VMs." + } + } + }, + "VMExtension": { + "type": "object", + "description": "The configuration for virtual machine extensions.", + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine extension." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "The type of the extension." + }, + "typeHandlerVersion": { + "type": "string", + "description": "The version of script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + }, + "settings": { + "type": "object", + "description": "JSON formatted public settings for the extension.", + "additionalProperties": { + "type": "string" + } + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.", + "additionalProperties": { + "type": "string" + } + }, + "provisionAfterExtensions": { + "type": "array", + "description": "The collection of extension names. Collection of extension names after which this extension needs to be provisioned.", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "publisher", + "type" + ] + }, + "VMExtensionInstanceView": { + "type": "object", + "description": "The vm extension instance view.", + "properties": { + "name": { + "type": "string", + "description": "The name of the vm extension instance view." + }, + "statuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + }, + "subStatuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineConfiguration": { + "type": "object", + "description": "The configuration for Compute Nodes in a Pool based on the Azure Virtual\nMachines infrastructure.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSKUId": { + "type": "string", + "description": "The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation.", + "x-ms-client-name": "nodeAgentSkuId" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image." + }, + "dataDisks": { + "type": "array", + "description": "The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [] + }, + "licenseType": { + "type": "string", + "description": "This only applies to Images that contain the Windows operating system, and\nshould only be used when you hold valid on-premises licenses for the Compute\nNodes which will be deployed. If omitted, no on-premises licensing discount is\napplied. Values are:\n\n Windows_Server - The on-premises license is for Windows\nServer.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "description": "The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "description": "The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning." + }, + "nodePlacementConfiguration": { + "$ref": "#/definitions/BatchNodePlacementConfiguration", + "description": "The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated." + }, + "extensions": { + "type": "array", + "description": "The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node.", + "items": { + "$ref": "#/definitions/VMExtension" + }, + "x-ms-identifiers": [] + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Settings for the operating system disk of the Virtual Machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReference", + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + }, + "required": [ + "imageReference", + "nodeAgentSKUId" + ] + }, + "VirtualMachineConfigurationUpdate": { + "type": "object", + "description": "The configuration for Compute Nodes in a Pool based on the Azure Virtual\nMachines infrastructure.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSKUId": { + "type": "string", + "description": "The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute Node agent SKUs' operation.", + "x-ms-client-name": "nodeAgentSkuId" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS Image." + }, + "dataDisks": { + "type": "array", + "description": "The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [] + }, + "licenseType": { + "type": "string", + "description": "This only applies to Images that contain the Windows operating system, and\nshould only be used when you hold valid on-premises licenses for the Compute\nNodes which will be deployed. If omitted, no on-premises licensing discount is\napplied. Values are:\n\n Windows_Server - The on-premises license is for Windows\nServer.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfigurationUpdate", + "description": "The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, and all other Tasks may specify it." + }, + "diskEncryptionConfiguration": { + "$ref": "#/definitions/DiskEncryptionConfiguration", + "description": "The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node provisioning." + }, + "nodePlacementConfiguration": { + "$ref": "#/definitions/BatchNodePlacementConfiguration", + "description": "The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically allocated." + }, + "extensions": { + "type": "array", + "description": "The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed on each node.", + "items": { + "$ref": "#/definitions/VMExtension" + }, + "x-ms-identifiers": [] + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Settings for the operating system disk of the Virtual Machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfileUpdate", + "description": "Specifies the security profile settings for the virtual machine or virtual machine scale set." + }, + "serviceArtifactReference": { + "$ref": "#/definitions/ServiceArtifactReferenceUpdate", + "description": "Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}" + } + } + }, + "VirtualMachineInfo": { + "type": "object", + "description": "Info about the current state of the virtual machine.", + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The reference to the Azure Virtual Machine's Marketplace Image." + }, + "scaleSetVmResourceId": { + "type": "string", + "description": "The resource ID of the Compute Node's current Virtual Machine Scale Set VM. Only defined if the Batch Account was created with its poolAllocationMode property set to 'UserSubscription'." + } + } + }, + "WindowsConfiguration": { + "type": "object", + "description": "Windows operating system settings to apply to the virtual machine.", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true." + } + } + }, + "WindowsUserConfiguration": { + "type": "object", + "description": "Properties used to create a user Account on a Windows Compute Node.", + "properties": { + "loginMode": { + "$ref": "#/definitions/LoginMode", + "description": "The login mode for the user. The default is 'batch'." + } + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_GetApplication.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_GetApplication.json new file mode 100644 index 000000000000..24120780e2d2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_GetApplication.json @@ -0,0 +1,22 @@ +{ + "operationId": "Applications_GetApplication", + "title": "Get applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_ListApplications.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_ListApplications.json new file mode 100644 index 000000000000..3d9488449d95 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Applications_ListApplications.json @@ -0,0 +1,25 @@ +{ + "operationId": "Applications_ListApplications", + "title": "List applications", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Basic.json new file mode 100644 index 000000000000..84d8577c3564 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Basic.json @@ -0,0 +1,24 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a basic JobSchedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Complex.json new file mode 100644 index 000000000000..597bbe4dbd88 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_CreateJobSchedule_Complex.json @@ -0,0 +1,132 @@ +{ + "operationId": "JobSchedules_CreateJobSchedule", + "title": "Creates a complex JobScheduleAdd", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "STANDARD_D2S_V3", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "nodePlacementConfiguration": { + "policy": "zonal" + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DeleteJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DeleteJobSchedule.json new file mode 100644 index 000000000000..cfb3b3126163 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DeleteJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DeleteJobSchedule", + "title": "JobSchedule delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DisableJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DisableJobSchedule.json new file mode 100644 index 000000000000..ec35089fd54c --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_DisableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_DisableJobSchedule", + "title": "JobSchedule disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_EnableJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_EnableJobSchedule.json new file mode 100644 index 000000000000..299fe57388f9 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_EnableJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_EnableJobSchedule", + "title": "JobSchedule enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_GetJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_GetJobSchedule.json new file mode 100644 index 000000000000..cc71f9cd756b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_GetJobSchedule.json @@ -0,0 +1,48 @@ +{ + "operationId": "JobSchedules_GetJobSchedule", + "title": "JobSchedule get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_JobScheduleExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_JobScheduleExists.json new file mode 100644 index 000000000000..d67abcf3e706 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_JobScheduleExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "JobSchedules_JobScheduleExists", + "title": "Check Job Schedule Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ListJobSchedules.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ListJobSchedules.json new file mode 100644 index 000000000000..04e4d32afcee --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ListJobSchedules.json @@ -0,0 +1,79 @@ +{ + "operationId": "JobSchedules_ListJobSchedules", + "title": "JobSchedule list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "maxParallelTasks": -1, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ReplaceJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ReplaceJobSchedule.json new file mode 100644 index 000000000000..d48982782b9c --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_ReplaceJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_ReplaceJobSchedule", + "title": "JobSchedule patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_TerminateJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_TerminateJobSchedule.json new file mode 100644 index 000000000000..b18cf1916b2b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_TerminateJobSchedule.json @@ -0,0 +1,14 @@ +{ + "operationId": "JobSchedules_TerminateJobSchedule", + "title": "JobSchedule terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_UpdateJobSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_UpdateJobSchedule.json new file mode 100644 index 000000000000..7e9311ab4f57 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/JobSchedules_UpdateJobSchedule.json @@ -0,0 +1,30 @@ +{ + "operationId": "JobSchedules_UpdateJobSchedule", + "title": "JobSchedule update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedule": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Basic.json new file mode 100644 index 000000000000..ba9c69bb1c08 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Basic.json @@ -0,0 +1,20 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a basic job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Complex.json new file mode 100644 index 000000000000..4d0b8560f32f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_CreateJob_Complex.json @@ -0,0 +1,124 @@ +{ + "operationId": "Jobs_CreateJob", + "title": "Creates a complex job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "requiredSlots": 2, + "killJobOnCompletion": false, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "STANDARD_D2S_V3", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "nodePlacementConfiguration": { + "policy": "zonal" + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "default" + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DeleteJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DeleteJob.json new file mode 100644 index 000000000000..83175db2e27a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DeleteJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_DeleteJob", + "title": "Delete Job", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DisableJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DisableJob.json new file mode 100644 index 000000000000..28510af741a6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_DisableJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_DisableJob", + "title": "Job disable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_EnableJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_EnableJob.json new file mode 100644 index 000000000000..8251b14494c0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_EnableJob.json @@ -0,0 +1,14 @@ +{ + "operationId": "Jobs_EnableJob", + "title": "Job enable", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJob.json new file mode 100644 index 000000000000..bd508f90a31f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJob.json @@ -0,0 +1,45 @@ +{ + "operationId": "Jobs_GetJob", + "title": "Job get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJobTaskCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJobTaskCounts.json new file mode 100644 index 000000000000..39ca25067b14 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_GetJobTaskCounts.json @@ -0,0 +1,31 @@ +{ + "operationId": "Jobs_GetJobTaskCounts", + "title": "Job get task counts", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "taskCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + }, + "taskSlotCounts": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..a174e7067877 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobPreparationAndReleaseTaskStatus.json @@ -0,0 +1,42 @@ +{ + "operationId": "Jobs_ListJobPreparationAndReleaseTaskStatus", + "title": "Job list preparation and release task status", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2024-07-01.20.0" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobs.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobs.json new file mode 100644 index 000000000000..dab7b8e30caa --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobs.json @@ -0,0 +1,46 @@ +{ + "operationId": "Jobs_ListJobs", + "title": "Job list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobsFromSchedule.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobsFromSchedule.json new file mode 100644 index 000000000000..a763b9bad5b0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ListJobsFromSchedule.json @@ -0,0 +1,47 @@ +{ + "operationId": "Jobs_ListJobsFromSchedule", + "title": "List Job Under Job Schedule", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "maxParallelTasks": -1, + "allowTaskPreemption": false, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ReplaceJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ReplaceJob.json new file mode 100644 index 000000000000..eedb3083e1e0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_ReplaceJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_ReplaceJob", + "title": "Job patch", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_TerminateJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_TerminateJob.json new file mode 100644 index 000000000000..92f2f3c56481 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_TerminateJob.json @@ -0,0 +1,17 @@ +{ + "operationId": "Jobs_TerminateJob", + "title": "Job terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_UpdateJob.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_UpdateJob.json new file mode 100644 index 000000000000..1280cb696495 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Jobs_UpdateJob.json @@ -0,0 +1,24 @@ +{ + "operationId": "Jobs_UpdateJob", + "title": "Job update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_DeallocateNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_DeallocateNode.json new file mode 100644 index 000000000000..beba564d2c46 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_DeallocateNode.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_DeallocateNode", + "title": "Node Deallocate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDeallocateParameter": { + "nodeDeallocateOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_StartNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_StartNode.json new file mode 100644 index 000000000000..dba002f5df03 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Node_StartNode.json @@ -0,0 +1,15 @@ +{ + "operationId": "Nodes_StartNode", + "title": "Node start", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_CreateNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_CreateNodeUser.json new file mode 100644 index 000000000000..d38cd713bb4b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_CreateNodeUser.json @@ -0,0 +1,21 @@ +{ + "operationId": "Nodes_CreateNodeUser", + "title": "Node create user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeFile.json new file mode 100644 index 000000000000..862b172936a1 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Nodes_DeleteNodeFile", + "title": "File delete from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeUser.json new file mode 100644 index 000000000000..415f79422e46 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DeleteNodeUser.json @@ -0,0 +1,16 @@ +{ + "operationId": "Nodes_DeleteNodeUser", + "title": "Node delete user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DisableNodeScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DisableNodeScheduling.json new file mode 100644 index 000000000000..78838915dfcf --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_DisableNodeScheduling.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_DisableNodeScheduling", + "title": "Node disable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_EnableNodeScheduling.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_EnableNodeScheduling.json new file mode 100644 index 000000000000..868be69627aa --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_EnableNodeScheduling.json @@ -0,0 +1,15 @@ +{ + "operationId": "Nodes_EnableNodeScheduling", + "title": "Node enable scheduling", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNode.json new file mode 100644 index 000000000000..04656b7cb676 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNode.json @@ -0,0 +1,54 @@ +{ + "operationId": "Nodes_GetNode", + "title": "Node get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeExtension.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeExtension.json new file mode 100644 index 000000000000..f1b15b4a6a3b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeExtension.json @@ -0,0 +1,37 @@ +{ + "operationId": "Nodes_GetNodeExtension", + "title": "Get batch node extension", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "extensionName": "batchNodeExtension", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFile.json new file mode 100644 index 000000000000..92a376d1d4a6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Nodes_GetNodeFile", + "title": "Get File From Compute Node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFileProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFileProperties.json new file mode 100644 index 000000000000..4e76206dd77c --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Nodes_GetNodeFileProperties", + "title": "File get properties from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeRemoteLoginSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeRemoteLoginSettings.json new file mode 100644 index 000000000000..53b5291a569c --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_GetNodeRemoteLoginSettings.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_GetNodeRemoteLoginSettings", + "title": "Node get remote login settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeExtensions.json new file mode 100644 index 000000000000..5e4f7fb1eebe --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeExtensions.json @@ -0,0 +1,61 @@ +{ + "operationId": "Nodes_ListNodeExtensions", + "title": "List compute node extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "instanceView": { + "name": "batchNodeExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Enable succeeded: Enabling and starting agent and controller" + } + ] + }, + "vmExtension": { + "name": "batchNodeExtension", + "publisher": "Microsoft.Azure.Extensions", + "type": "CustomScript", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true + } + }, + { + "instanceView": { + "name": "customExtension", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "ExtensionOperation:enable. Status:Success" + } + ] + }, + "vmExtension": { + "name": "customExtension", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeFiles.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeFiles.json new file mode 100644 index 000000000000..b7dd7ef9b6db --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodeFiles.json @@ -0,0 +1,48 @@ +{ + "operationId": "Nodes_ListNodeFiles", + "title": "File list from node", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodes.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodes.json new file mode 100644 index 000000000000..ebec819a1bde --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ListNodes.json @@ -0,0 +1,136 @@ +{ + "operationId": "Nodes_ListNodes", + "title": "Node list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "runningTaskSlotsCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_NodeReimage.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_NodeReimage.json new file mode 100644 index 000000000000..b53e9c67d153 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_NodeReimage.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_ReimageNode", + "title": "Node reimage", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeReimageParameter": { + "nodeReimageOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_RebootNode.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_RebootNode.json new file mode 100644 index 000000000000..150acaadcd07 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_RebootNode.json @@ -0,0 +1,18 @@ +{ + "operationId": "Nodes_RebootNode", + "title": "Node reboot", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ReplaceNodeUser.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ReplaceNodeUser.json new file mode 100644 index 000000000000..d93a7ffd93eb --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_ReplaceNodeUser.json @@ -0,0 +1,20 @@ +{ + "operationId": "Nodes_ReplaceNodeUser", + "title": "Node update user", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_UploadNodeLogs.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_UploadNodeLogs.json new file mode 100644 index 000000000000..c4ce833ad67a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Nodes_UploadNodeLogs.json @@ -0,0 +1,24 @@ +{ + "operationId": "Nodes_UploadNodeLogs", + "title": "Upload BatchService Logs", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_AcceleratedNetworking.json new file mode 100644 index 000000000000..92dc19a13166 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_AcceleratedNetworking.json @@ -0,0 +1,30 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with accelerated networking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 27 Apr 2023 05:31:01 GMT", + "pool": { + "id": "mypool01", + "vmSize": "Standard_D1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2, + "networkConfiguration": { + "enableAcceleratedNetworking": true + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_MountConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_MountConfiguration.json new file mode 100644 index 000000000000..226ddbba2925 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_MountConfiguration.json @@ -0,0 +1,72 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with mount drive specified", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "mountConfiguration": [ + { + "azureBlobFileSystemConfiguration": { + "accountName": "accountName", + "containerName": "blobContainerName", + "accountKey": "accountKey", + "relativeMountPath": "bfusepath" + } + }, + { + "azureFileShareConfiguration": { + "accountName": "accountName", + "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare", + "accountKey": "accountKey", + "relativeMountPath": "filesharepath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "nfsMountConfiguration": { + "source": "somesource nfs url", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + }, + { + "cifsMountConfiguration": { + "username": "accountName", + "password": "password", + "source": "//myaccount.file.core.windows.net/file", + "relativeMountPath": "mountpath", + "mountOptions": "mount options ver=1.0" + } + } + ], + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_OSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_OSDisk.json new file mode 100644 index 000000000000..b6b570be4153 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_OSDisk.json @@ -0,0 +1,40 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:40:02 GMT", + "pool": { + "id": "mypool001", + "vmSize": "standard_d2s_v3", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "osDisk": { + "diskSizeGB": 100, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "caching": "readwrite", + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + } + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 1, + "enableAutoScale": false + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_ResourceTags.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_ResourceTags.json new file mode 100644 index 000000000000..87ef2da9bbc2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_ResourceTags.json @@ -0,0 +1,31 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a simple pool with resourceTags", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04" + }, + "targetDedicatedNodes": 1, + "resourceTags": { + "TagName1": "TagValue1", + "TagName2": "TagValue2" + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_SecurityProfile.json new file mode 100644 index 000000000000..0bb88a3b5fc3 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_SecurityProfile.json @@ -0,0 +1,35 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT", + "pool": { + "id": "mypool001", + "vmSize": "STANDARD_DC2s_V2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false, + "vTpmEnabled": null + } + } + }, + "targetDedicatedNodes": 1 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..80f90a22dda3 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfiguration.json @@ -0,0 +1,44 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..08306081f2a7 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,43 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with containers", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "120_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..1dfd0411496c --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,59 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "taskSlotsPerNode": 3, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ], + "targetNodeCommunicationMode": "simplified" + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..488744a59ee6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_CreatePool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,33 @@ +{ + "operationId": "Pools_CreatePool", + "title": "Creates a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:03:01 GMT", + "pool": { + "id": "mypool002", + "vmSize": "Standard_A1_v2", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "targetDedicatedNodes": 2 + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DeletePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DeletePool.json new file mode 100644 index 000000000000..3125fb5f45ce --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DeletePool.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DeletePool", + "title": "Pool delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DisablePoolAutoScale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DisablePoolAutoScale.json new file mode 100644 index 000000000000..973f97a7dbcb --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_DisablePoolAutoScale.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_DisablePoolAutoScale", + "title": "Disable pool autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EnablePoolAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EnablePoolAutoscale.json new file mode 100644 index 000000000000..c4ce7c23579d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EnablePoolAutoscale.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_EnablePoolAutoScale", + "title": "Pool enable autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EvaluatePoolAutoscale.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EvaluatePoolAutoscale.json new file mode 100644 index 000000000000..25ee2bbcf2f6 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_EvaluatePoolAutoscale.json @@ -0,0 +1,22 @@ +{ + "operationId": "Pools_EvaluatePoolAutoScale", + "title": "Pool evaluate autoscale", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_AcceleratedNetworking.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_AcceleratedNetworking.json new file mode 100644 index 000000000000..8b7526f52f1e --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_AcceleratedNetworking.json @@ -0,0 +1,52 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a pool with AcceleratedNetworking", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 28 Apr 2023 02:43:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB4792BE8566A2", + "lastModified": "2023-04-28T02:46:19.0268066Z", + "creationTime": "2023-04-28T02:46:19.0268066Z", + "state": "active", + "stateTransitionTime": "2023-04-28T02:46:19.0268066Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-04-28T02:47:17.9169655Z", + "vmSize": "standard_d1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + }, + "networkConfiguration": { + "dynamicVNetAssignmentScope": "none", + "enableAcceleratedNetworking": true + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_Basic.json new file mode 100644 index 000000000000..6262ef80a3f7 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_Basic.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Pool get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_SecurityProfile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_SecurityProfile.json new file mode 100644 index 000000000000..58ee2ddcbd99 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_SecurityProfile.json @@ -0,0 +1,55 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with SecurityProfile", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 14 Jun 2023 06:39:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB6CA2DFF530D1", + "lastModified": "2023-06-14T06:45:00.0946897Z", + "creationTime": "2023-06-14T06:45:00.0946897Z", + "state": "active", + "stateTransitionTime": "2023-06-14T06:45:00.0946897Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-06-14T06:45:59.4770341Z", + "vmSize": "standard_dc2s_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "18_04-lts-gen2", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 18.04", + "securityProfile": { + "securityType": "trustedLaunch", + "encryptionAtHost": true, + "uefiSettings": { + "secureBootEnabled": false + } + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json new file mode 100644 index 000000000000..d6e1c7d07a0b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithExtensions.json @@ -0,0 +1,74 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with extensions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04", + "extensions": [ + { + "name": "batchextension1", + "type": "KeyVaultForLinux", + "publisher": "Microsoft.Azure.KeyVault", + "typeHandlerVersion": "2.0", + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "settings": { + "secretsManagementSettingsKey": "secretsManagementSettingsValue", + "authenticationSettingsKey": "authenticationSettingsValue" + } + } + ] + }, + "targetNodeCommunicationMode": "classic", + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json new file mode 100644 index 000000000000..c8c72b256329 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithOSDisk.json @@ -0,0 +1,58 @@ +{ + "operationId": "Pools_GetPool", + "title": "Add a VirtualMachineConfiguration pool with OS disk", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "mypool001", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Wed, 23 Aug 2023 08:42:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "mypool001", + "url": "http://localhost:20302/testaccount1tls/pools/mypool001", + "eTag": "0x8DBA3B4E91CD7B7", + "lastModified": "2023-08-23T08:42:40.3479479Z", + "creationTime": "2023-08-23T08:42:40.3479479Z", + "state": "active", + "stateTransitionTime": "2023-08-23T08:42:40.3479479Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-08-23T08:42:53.8587829Z", + "vmSize": "standard_d2s_v3", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 1, + "targetDedicatedNodes": 1, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "0001-com-ubuntu-server-focal", + "sku": "20_04-lts", + "version": "latest" + }, + "osDisk": { + "ephemeralOSDiskSettings": { + "placement": "cachedisk" + }, + "managedDisk": { + "storageAccountType": "standardssd_lrs" + }, + "diskSizeGB": 100, + "caching": "readwrite" + }, + "nodeAgentSKUId": "batch.node.ubuntu 20.04" + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json new file mode 100644 index 000000000000..065c6d30d888 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_GetPool_VirtualMachineConfigurationWithServiceArtifactReference.json @@ -0,0 +1,54 @@ +{ + "operationId": "Pools_GetPool", + "title": "Get a VirtualMachineConfiguration pool with ServiceArtifactReference", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Thu, 11 May 2023 08:08:01 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8DB51F652DFC78F", + "lastModified": "2023-05-11T08:04:19.7259151Z", + "creationTime": "2023-05-11T08:04:19.7259151Z", + "state": "active", + "stateTransitionTime": "2023-05-11T08:04:19.7259151Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2023-05-11T08:05:22.0020052Z", + "vmSize": "standard_a1_v2", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 2, + "targetDedicatedNodes": 2, + "currentLowPriorityNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "serviceArtifactReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile" + } + }, + "currentNodeCommunicationMode": "classic" + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolNodeCounts.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolNodeCounts.json new file mode 100644 index 000000000000..d25481d5bbe0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolNodeCounts.json @@ -0,0 +1,141 @@ +{ + "operationId": "Pools_ListPoolNodeCounts", + "title": "NodeCountsPayload", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "deallocated": 0, + "deallocating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "deallocated": 0, + "deallocating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "deallocated": 0, + "deallocating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "deallocated": 0, + "deallocating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "deallocated": 0, + "deallocating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "deallocated": 0, + "deallocating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "upgradingOS": 0, + "total": 11 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolUsageMetrics.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolUsageMetrics.json new file mode 100644 index 000000000000..b9fc8590ee01 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPoolUsageMetrics.json @@ -0,0 +1,32 @@ +{ + "operationId": "Pools_ListPoolUsageMetrics", + "title": "Pool list usage metrics", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPools_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPools_Basic.json new file mode 100644 index 000000000000..f7a2eba406d2 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListPools_Basic.json @@ -0,0 +1,61 @@ +{ + "operationId": "Pools_ListPools", + "title": "Pool list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "small", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "taskSlotsPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-datacenter-smalldisk", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.windows amd64" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListSupportedImages.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListSupportedImages.json new file mode 100644 index 000000000000..a680b3a7f718 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ListSupportedImages.json @@ -0,0 +1,78 @@ +{ + "operationId": "Pools_ListSupportedImages", + "title": "Account list node agent skus", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + "verificationType": "verified", + "capabilities": [ + "DockerCompatible", + "NvidiaTeslaDriverInstalled" + ], + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.centos 7", + "imageReference": { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + }, + "verificationType": "unverified", + "osType": "linux", + "batchSupportEndOfLife": "2019-11-01T00:00:00.0Z" + }, + { + "nodeAgentSKUId": "batch.node.debian 8", + "imageReference": { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + }, + "verificationType": "verified", + "osType": "linux" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + }, + { + "nodeAgentSKUId": "batch.node.windows amd64", + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + }, + "verificationType": "verified", + "osType": "windows" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_PoolExists.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_PoolExists.json new file mode 100644 index 000000000000..3d4df6ca98df --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_PoolExists.json @@ -0,0 +1,15 @@ +{ + "operationId": "Pools_PoolExists", + "title": "Check Pool Exists", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_RemoveNodes.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_RemoveNodes.json new file mode 100644 index 000000000000..2e68b4a5da9f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_RemoveNodes.json @@ -0,0 +1,20 @@ +{ + "operationId": "Pools_RemoveNodes", + "title": "Pool remove nodes", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ReplacePoolProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ReplacePoolProperties.json new file mode 100644 index 000000000000..c2208c4d2c0e --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ReplacePoolProperties.json @@ -0,0 +1,21 @@ +{ + "operationId": "Pools_ReplacePoolProperties", + "title": "Pool update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ResizePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ResizePool.json new file mode 100644 index 000000000000..29ffedcbcfab --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_ResizePool.json @@ -0,0 +1,18 @@ +{ + "operationId": "Pools_ResizePool", + "title": "Pool resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "content": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_StopPoolResize.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_StopPoolResize.json new file mode 100644 index 000000000000..c63dce3238c5 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_StopPoolResize.json @@ -0,0 +1,14 @@ +{ + "operationId": "Pools_StopPoolResize", + "title": "Pool stop resize", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_UpdatePool.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_UpdatePool.json new file mode 100644 index 000000000000..28d784abfed8 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Pools_UpdatePool.json @@ -0,0 +1,19 @@ +{ + "operationId": "Pools_UpdatePool", + "title": "Patch the Pool", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Basic.json new file mode 100644 index 000000000000..d2e7cc3f97f0 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Basic.json @@ -0,0 +1,45 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a basic collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Complex.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Complex.json new file mode 100644 index 000000000000..3124669e48a4 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTaskCollection_Complex.json @@ -0,0 +1,80 @@ +{ + "operationId": "Tasks_CreateTaskCollection", + "title": "Creates a complex collection of tasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "requiredSlots": 2, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_Basic.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_Basic.json new file mode 100644 index 000000000000..19009ec05e46 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_Basic.json @@ -0,0 +1,18 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a basic task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettings.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettings.json new file mode 100644 index 000000000000..435647de8e6f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettings.json @@ -0,0 +1,28 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json new file mode 100644 index 000000000000..bf4b3e6125c1 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation.json @@ -0,0 +1,33 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings with data isolation", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Tue, 26 Mar 2024 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerHostBatchBindMounts": [ + { + "source": "Task", + "isReadOnly": true + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json new file mode 100644 index 000000000000..219df4f7ed6b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ContainerSettingsWithDataIsolation_DuplicateSources.json @@ -0,0 +1,37 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with container settings with duplicate source", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Tue, 26 Mar 2024 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerHostBatchBindMounts": [ + { + "source": "Task", + "isReadOnly": true + }, + { + "source": "Task", + "isReadOnly": true + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ExitConditions.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ExitConditions.json new file mode 100644 index 000000000000..7e906114290b --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_ExitConditions.json @@ -0,0 +1,35 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with exit conditions", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_RequiredSlots.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_RequiredSlots.json new file mode 100644 index 000000000000..d5edf7f9b2f3 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_CreateTask_RequiredSlots.json @@ -0,0 +1,19 @@ +{ + "operationId": "Tasks_CreateTask", + "title": "Creates a task with extra slot requirement", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "requiredSlots": 2, + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTask.json new file mode 100644 index 000000000000..137f15899eea --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_DeleteTask", + "title": "Task delete", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTaskFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTaskFile.json new file mode 100644 index 000000000000..aaafede1c026 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_DeleteTaskFile.json @@ -0,0 +1,17 @@ +{ + "operationId": "Tasks_DeleteTaskFile", + "title": "File delete from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTask.json new file mode 100644 index 000000000000..312752b206e9 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTask.json @@ -0,0 +1,46 @@ +{ + "operationId": "Tasks_GetTask", + "title": "Task get", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFile.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFile.json new file mode 100644 index 000000000000..4dbf72e96c7f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFile.json @@ -0,0 +1,23 @@ +{ + "operationId": "Tasks_GetTaskFile", + "title": "Get File From Task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFileProperties.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFileProperties.json new file mode 100644 index 000000000000..99e3c7b9177f --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_GetTaskFileProperties.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_GetTaskFileProperties", + "title": "File get properties from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream" + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListSubTasks.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListSubTasks.json new file mode 100644 index 000000000000..f98c195dff2a --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListSubTasks.json @@ -0,0 +1,52 @@ +{ + "operationId": "Tasks_ListSubTasks", + "title": "Task list subtasks", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTaskFiles.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTaskFiles.json new file mode 100644 index 000000000000..494f14e3252d --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTaskFiles.json @@ -0,0 +1,43 @@ +{ + "operationId": "Tasks_ListTaskFiles", + "title": "File list from task", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": "1813", + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": "0", + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTasks.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTasks.json new file mode 100644 index 000000000000..4eac964e9582 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ListTasks.json @@ -0,0 +1,71 @@ +{ + "operationId": "Tasks_ListTasks", + "title": "Task list", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "requiredSlots": 2, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReactivateTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReactivateTask.json new file mode 100644 index 000000000000..e997458d2906 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReactivateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_ReactivateTask", + "title": "Task reactivate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReplaceTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReplaceTask.json new file mode 100644 index 000000000000..603f15d36c41 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_ReplaceTask.json @@ -0,0 +1,22 @@ +{ + "operationId": "Tasks_ReplaceTask", + "title": "Task update", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 3, + "retentionTime": "PT1H" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_TerminateTask.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_TerminateTask.json new file mode 100644 index 000000000000..dd199028aef5 --- /dev/null +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/examples/Tasks_TerminateTask.json @@ -0,0 +1,15 @@ +{ + "operationId": "Tasks_TerminateTask", + "title": "Task terminate", + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2024-07-01.20.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": {} + } +} diff --git a/specification/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index 18197bf62a7f..9fc73c4fbb4d 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -30,6 +30,15 @@ openapi-type: data-plane tag: package-2024-07 ``` +### Tag: package-2024-07.20.0 + +These settings apply only when `--tag=package-2024-07.20.0` is specified on the command line. + +```yaml $(tag) == 'package-2024-07.20.0-preview' +input-file: + - Azure.Batch/preview/2024-07-01.20.0/BatchService.json +``` + ### Tag: package-2024-07 These settings apply only when `--tag=package-2024-07` is specified on the command line. From 060d89dff7ff8473516423adc650d5708fd2f0de Mon Sep 17 00:00:00 2001 From: Libba Lawrence <llawrence@microsoft.com> Date: Mon, 7 Oct 2024 15:24:49 -0700 Subject: [PATCH 052/101] [EG] Lint Diff (#30600) * a * odata * try update readme * update * try creating namespace specific readme * Revert "try creating namespace specific readme" This reverts commit 2ea5f4f390f04ed931b2fe2f9b822f24ab7ddf1d. * try update readme * update * remove x-ms-discriminator * remove x-nullable * typo * Revert "typo" This reverts commit 084148dfc2b303cfd917c74a6cf0672e30fc15cb. * Revert "remove x-nullable" This reverts commit 1891c46e51724ee1d23cd103d9f969d9bb7b15b7. * Revert "remove x-ms-discriminator" This reverts commit 2638842a7b0cd74a15c297eb6668db8517a948d9. * discriminator --- .../stable/2018-01-01/MediaServices.json | 16 ++-------------- specification/eventgrid/data-plane/readme.md | 8 +++----- 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json index b85e8b5f37fd..959efee38ed5 100644 --- a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json @@ -356,7 +356,8 @@ "type": "object", "required": [ "progress", - "state" + "state", + "@odata.type" ], "description": "The event data for a Job output." }, @@ -377,7 +378,6 @@ "description": "The event data for a Job output asset." }, "MediaJobOutputProgressEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputProgress", "description": "Job Output Progress Event Data. Schema of the Data property of an EventGridEvent for a Microsoft.Media.JobOutputProgress event.", "type": "object", "properties": { @@ -466,7 +466,6 @@ } }, "MediaJobScheduledEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobScheduled", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -477,7 +476,6 @@ "description": "Job scheduled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobScheduled event." }, "MediaJobProcessingEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobProcessing", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -488,7 +486,6 @@ "description": "Job processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobProcessing event." }, "MediaJobCancelingEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobCanceling", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -499,7 +496,6 @@ "description": "Job canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceling event." }, "MediaJobFinishedEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobFinished", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -518,7 +514,6 @@ "description": "Job finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobFinished event." }, "MediaJobCanceledEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobCanceled", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -537,7 +532,6 @@ "description": "Job canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobCanceled event." }, "MediaJobErroredEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobErrored", "allOf": [ { "$ref": "#/definitions/MediaJobStateChangeEventData" @@ -556,7 +550,6 @@ "description": "Job error state event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobErrored event." }, "MediaJobOutputCanceledEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputCanceled", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" @@ -567,7 +560,6 @@ "description": "Job output canceled event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceled event." }, "MediaJobOutputCancelingEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputCanceling", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" @@ -578,7 +570,6 @@ "description": "Job output canceling event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputCanceling event." }, "MediaJobOutputErroredEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputErrored", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" @@ -589,7 +580,6 @@ "description": "Job output error event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputErrored event." }, "MediaJobOutputFinishedEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputFinished", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" @@ -600,7 +590,6 @@ "description": "Job output finished event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputFinished event." }, "MediaJobOutputProcessingEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputProcessing", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" @@ -611,7 +600,6 @@ "description": "Job output processing event data. Schema of the data property of an EventGridEvent for a Microsoft.Media.JobOutputProcessing event." }, "MediaJobOutputScheduledEventData": { - "x-ms-discriminator-value": "#Microsoft.Media.JobOutputScheduled", "allOf": [ { "$ref": "#/definitions/MediaJobOutputStateChangeEventData" diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 1cf80d695d1b..43b0465c00e3 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -4,7 +4,6 @@ This is the AutoRest configuration file for EventGrid. - Multiple Azure services publish events to Azure Event Grid. This is the configuration file for generating the Publish API and the schemas for those events. Each Azure service publishing to Azure Event Grid has its own tag OpenAPI specification that describes the schemas for its events. @@ -156,7 +155,6 @@ input-file: - Microsoft.Storage/stable/2018-01-01/Storage.json - Microsoft.EventHub/stable/2018-01-01/EventHub.json - Microsoft.Resources/stable/2018-01-01/Resources.json -- Microsoft.EventGrid/stable/2018-01-01/EventGrid.json - Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json - Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json - Microsoft.DataBox/stable/2018-01-01/DataBox.json @@ -191,8 +189,8 @@ input-file: - Microsoft.Storage/stable/2018-01-01/Storage.json - Microsoft.EventHub/stable/2018-01-01/EventHub.json - Microsoft.Resources/stable/2018-01-01/Resources.json -- Microsoft.EventGrid/stable/2018-01-01/EventGrid.json - Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json +- Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json - Microsoft.DataBox/stable/2018-01-01/DataBox.json - Microsoft.Devices/stable/2018-01-01/IotHub.json - Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json @@ -218,13 +216,13 @@ input-file: These settings apply only when `--tag=package-2023-11-01` is specified on the command line. -``` yaml $(tag) == 'package-2023-06-01-preview' +``` yaml $(tag) == 'package-2023-11-01' input-file: - Microsoft.Storage/stable/2018-01-01/Storage.json - Microsoft.EventHub/stable/2018-01-01/EventHub.json - Microsoft.Resources/stable/2018-01-01/Resources.json -- Microsoft.EventGrid/stable/2018-01-01/EventGrid.json - Microsoft.EventGrid/stable/2023-11-01/EventGrid.json +- Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json - Microsoft.DataBox/stable/2018-01-01/DataBox.json - Microsoft.Devices/stable/2018-01-01/IotHub.json - Microsoft.ContainerRegistry/stable/2018-01-01/ContainerRegistry.json From b76e1187a49e588ba91c124abd8b7b6277c48a76 Mon Sep 17 00:00:00 2001 From: Christopher Radek <14189820+chrisradek@users.noreply.github.com> Date: Mon, 7 Oct 2024 15:38:26 -0700 Subject: [PATCH 053/101] Updates TypeSpec-generated OpenAPI3 models to make description optional (#30887) Co-authored-by: Christopher Radek <Christopher.Radek@microsoft.com> --- .../inference/preview/2024-04-01-preview/generated.json | 3 +-- .../inference/preview/2024-05-01-preview/generated.json | 3 +-- .../inference/preview/2024-07-01-preview/generated.json | 3 +-- .../AzureOpenAI/inference/stable/2024-06-01/generated.json | 3 +-- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json index 90332b7b9115..39a6358e425c 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-04-01-preview/generated.json @@ -3119,8 +3119,7 @@ } }, "required": [ - "filtered", - "details" + "filtered" ] }, "ContentFilterDetectionResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json index a652c7340c93..c822b0c8977b 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/generated.json @@ -3274,8 +3274,7 @@ } }, "required": [ - "filtered", - "details" + "filtered" ] }, "ContentFilterDetectionResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/generated.json index a61bda9a5c7a..3ae2f0ff666d 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/generated.json @@ -3951,8 +3951,7 @@ } }, "required": [ - "filtered", - "details" + "filtered" ] }, "ContentFilterDetectionResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json index 4d95f38b9fd5..e76d716f2043 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-06-01/generated.json @@ -3274,8 +3274,7 @@ } }, "required": [ - "filtered", - "details" + "filtered" ] }, "ContentFilterDetectionResult": { From 012021c786c360e0c34faf7af888c7fd7dbe2df5 Mon Sep 17 00:00:00 2001 From: Osahumen Uyi Aghasomwan <65305780+osaghaso@users.noreply.github.com> Date: Mon, 7 Oct 2024 16:18:51 -0700 Subject: [PATCH 054/101] adding onBehalfOfCallee to incoming call event (#30773) * adding onBehalfOfCallee to incoming call * compile the TypeSpec and add the generated SystemEvents.json * fix naming * fix naming * Fix spelling --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Co-authored-by: jolov <jolov@microsoft.com> --- cSpell.json | 6 ++++++ .../Microsoft.Communication/AzureCommunicationServices.tsp | 3 +++ .../stable/2018-01-01/AzureCommunicationServices.json | 6 +++++- .../examples/cloud-events-schema/incoming_call.json | 7 +++++++ .../examples/event-grid-schema/incoming_call.json | 7 +++++++ .../stable/2018-01-01/GeneratedSystemEvents.json | 4 ++++ .../stable/2024-01-01/GeneratedSystemEvents.json | 4 ++++ 7 files changed, 36 insertions(+), 1 deletion(-) diff --git a/cSpell.json b/cSpell.json index 327f6817c544..679a44694f6e 100644 --- a/cSpell.json +++ b/cSpell.json @@ -407,6 +407,12 @@ "Regenerte" ] }, + { + "filename": "**/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json", + "words": [ + "whatsapp" + ] + }, { "filename": "**/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/SystemEvents.json", "words": [ diff --git a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp index ba76f9403764..6571a63458ba 100644 --- a/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp +++ b/specification/eventgrid/Azure.Messaging.EventGrid.SystemEvents/Microsoft.Communication/AzureCommunicationServices.tsp @@ -23,6 +23,9 @@ model AcsIncomingCallEventData { /** Signed incoming call context. */ incomingCallContext?: string; + /** The communication identifier of the user on behalf of whom the call is made. */ + onBehalfOfCallee?: CommunicationIdentifierModel; + /** CorrelationId (CallId). */ correlationId?: string; } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 4228c52100eb..96a1e7fdcdb1 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -37,6 +37,10 @@ "description": "Signed incoming call context.", "type": "string" }, + "onBehalfOfCallee": { + "description": "The communication identifier of the user on behalf of whom the call is made.", + "$ref": "../../../../../communication/data-plane/Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel" + }, "correlationId": { "description": "CorrelationId (CallId).", "type": "string" @@ -2334,7 +2338,7 @@ "type": "string" }, "description": { - "description": "The sescription of the selected row", + "description": "The description of the selected row", "type": "string" } } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json index 1908785a12fc..9c5547cc2d36 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json @@ -27,6 +27,13 @@ }, "voipHeaders": { "customHeader": "customValue" + }, + "onBehalfOfCallee": { + "kind": "communicationUser", + "rawId": "{caller-id}", + "communicationUser": { + "id": "{caller-id}" + } } }, "incomingCallContext": "{incoming-call-contextValue}", diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json index 7531335623c5..0aef1b6fcceb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json @@ -30,6 +30,13 @@ } }, "incomingCallContext": "{incoming-call-contextValue}", + "onBehalfOfCallee": { + "kind": "communicationUser", + "rawId": "{caller-id}", + "communicationUser": { + "id": "{caller-id}" + } + }, "correlationId": "correlationId" }, "eventType": "Microsoft.Communication.IncomingCall", diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json index 48945635b761..6d2ef8958c3b 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/GeneratedSystemEvents.json @@ -852,6 +852,10 @@ "type": "string", "description": "Signed incoming call context." }, + "onBehalfOfCallee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user on behalf of whom the call is made." + }, "correlationId": { "type": "string", "description": "CorrelationId (CallId)." diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json index 36bd7e604627..2686688afd8b 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2024-01-01/GeneratedSystemEvents.json @@ -882,6 +882,10 @@ "type": "string", "description": "Signed incoming call context." }, + "onBehalfOfCallee": { + "$ref": "#/definitions/CommunicationIdentifierModel", + "description": "The communication identifier of the user on behalf of whom the call is made." + }, "correlationId": { "type": "string", "description": "CorrelationId (CallId)." From e048fbb9268458be5114ab9903808161601cd879 Mon Sep 17 00:00:00 2001 From: koen-mertens <138520871+koen-mertens@users.noreply.github.com> Date: Tue, 8 Oct 2024 04:48:03 +0200 Subject: [PATCH 055/101] Update client.tsp (#30858) --- .../HealthInsights.RadiologyInsights/client.tsp | 6 +++--- .../HealthInsights.RadiologyInsights/tspconfig.yaml | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp index efe978e0321d..c5927f3ab433 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/client.tsp @@ -90,13 +90,13 @@ interface RadiologyInsightsClient { @@clientName(AzureHealthInsights.DocumentAuthor, "ClinicalDocumentAuthor", - "csharp" + "csharp, java" ); @@clientName(AzureHealthInsights.DocumentType, "ClinicalDocumentContentType", - "csharp" + "csharp, java" ); @@clientName(AzureHealthInsights.DocumentContent, "ClinicalDocumentContent", - "csharp" + "csharp, java" ); diff --git a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml index ef2b0ce1efdd..eef454e0c36d 100644 --- a/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml +++ b/specification/ai/HealthInsights/HealthInsights.RadiologyInsights/tspconfig.yaml @@ -41,6 +41,7 @@ options: partial-update: true emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/azure-health-insights-radiologyinsights" flavor: azure + api-version: 2024-04-01 polling: inferRadiologyInsights: final-type: com.azure.health.insights.radiologyinsights.models.RadiologyInsightsInferenceResult From edc5ac9b0b6d4794058f5c2f4047389f4b5cc5d6 Mon Sep 17 00:00:00 2001 From: Yuchao Yan <yuchaoyan@microsoft.com> Date: Tue, 8 Oct 2024 11:04:03 +0800 Subject: [PATCH 056/101] [PostgreSQL flexible servers] Update readme.python.md (#30900) --- specification/postgresql/resource-manager/readme.python.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/postgresql/resource-manager/readme.python.md b/specification/postgresql/resource-manager/readme.python.md index 496975fbba74..81e72c385d06 100644 --- a/specification/postgresql/resource-manager/readme.python.md +++ b/specification/postgresql/resource-manager/readme.python.md @@ -10,12 +10,12 @@ no-namespace-folders: true clear-output-folder: true ``` -### Tag: package-flexibleserver-2023-12-01-preview and python +### Tag: package-flexibleserver-2024-08-01 and python -These settings apply only when `--tag=package-flexibleserver-2023-12-01-preview --python` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2024-08-01 --python` is specified on the command line. Please also specify `--python-sdk-folder=<path to the root directory of your azure-sdk-for-python clone>`. -``` yaml $(tag) == 'package-flexibleserver-2023-12-01-preview' && $(python) +``` yaml $(tag) == 'package-flexibleserver-2024-08-01' && $(python) title: PostgreSQLManagementClient package-name: azure-mgmt-postgresqlflexibleservers package-version: 1.0.0b1 From 15c05b93202239f0f58e7e3b84af5e8a504efc1a Mon Sep 17 00:00:00 2001 From: Zunli Hu <zuh@microsoft.com> Date: Tue, 8 Oct 2024 11:12:44 +0800 Subject: [PATCH 057/101] Release app microsoft.app 2024 08 02 preview (#30562) * Copy files from preview/2024-02-02-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-08-02-preview Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview. * Added tag for 2024-08-02-preview in readme file * Support spring cloud gateway (#29591) * support scg in 0802preview * fix lint issue --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Add scale property to java component (#29801) * add scale property for jc * swagger prettiercheck * prettier check * the prettier check has a bug * edit description * refine description --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * [Microsoft.App] add debug endpoint on replica container (#29778) * add debug endpoint on replica container * fix code style errors * add example debug endpoint * Update header and query parameter for source control (#29536) * update * fix example * fix * fix * fix * update examples * use v5 * Enable DeploymentErrors for ContainerApps (#29822) * Enable DeploymentErrors for ContainerApps * Add example * Fix format --------- Co-authored-by: layliu <layliu@microsoft.com> * Add dockerfile path argument (#30156) * Add dockerfile path argument * Fix example * Fix example * Fix linting errors * Modify example * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Make the header optional for source control (#30232) * Add includeDapr in traces and include keda in metrics for container app environment (#29987) * Add includeDapr in traces and include keda in metrics * pretty * Fix sessionpool name parameter location (#30231) * Fix sessionpool name parameter location * Prettier * Add job suspend resume (#30304) * add fields * add * Update Jobs.json fix runningState and add azure-asyncoperation * Update Jobs_Resume.json * Update Jobs_Suspend.json * add azure-asyncoperation * fix lintdiff * fix * fix * fix * add * reopen PR & add runningState states --------- Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * add runningState change (#30464) Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418) * enableFips Property for workload profile * Fix description * Add default value for property * run prettier * More prettier fixes * Add system data back for billingMeter (#30627) * Fix CI check for 2024-08-02-preview (#30641) * add suppression for patch java component (#30644) Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Fix session pool error response (#30647) Co-authored-by: Zunli Hu <zuh@microsoft.com> * Fix Swagger PrettierCheck for examples (#30674) * Copy files from preview/2024-02-02-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-08-02-preview Updated the API version from preview/2024-02-02-preview to preview/2024-08-02-preview. * Added tag for 2024-08-02-preview in readme file * Support spring cloud gateway (#29591) * support scg in 0802preview * fix lint issue --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Add scale property to java component (#29801) * add scale property for jc * swagger prettiercheck * prettier check * the prettier check has a bug * edit description * refine description --------- Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * [Microsoft.App] add debug endpoint on replica container (#29778) * add debug endpoint on replica container * fix code style errors * add example debug endpoint * Update header and query parameter for source control (#29536) * update * fix example * fix * fix * fix * update examples * use v5 * Enable DeploymentErrors for ContainerApps (#29822) * Enable DeploymentErrors for ContainerApps * Add example * Fix format --------- Co-authored-by: layliu <layliu@microsoft.com> * Add dockerfile path argument (#30156) * Add dockerfile path argument * Fix example * Fix example * Fix linting errors * Modify example * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> * Add KEDA cooldownPeriod/pollingInterval property for Container App & Jobs (#30154) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Make the header optional for source control (#30232) * Add includeDapr in traces and include keda in metrics for container app environment (#29987) * Add includeDapr in traces and include keda in metrics * pretty * Fix sessionpool name parameter location (#30231) * Fix sessionpool name parameter location * Prettier * Add job suspend resume (#30304) * add fields * add * Update Jobs.json fix runningState and add azure-asyncoperation * Update Jobs_Resume.json * Update Jobs_Suspend.json * add azure-asyncoperation * fix lintdiff * fix * fix * fix * add * reopen PR & add runningState states --------- Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * add runningState change (#30464) Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> * [Microsoft.App] Add enableFips property for dedicated workload profiles (#30418) * enableFips Property for workload profile * Fix description * Add default value for property * run prettier * More prettier fixes * Add system data back for billingMeter (#30627) * Fix CI check for 2024-08-02-preview (#30641) * add suppression for patch java component (#30644) Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> * Fix session pool error response (#30647) Co-authored-by: Zunli Hu <zuh@microsoft.com> * update --------- Co-authored-by: Xuyang Cao <Elvis_caoxy@163.com> Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> Co-authored-by: Yi Liu <yiliu6@microsoft.com> Co-authored-by: LaylaLiu-gmail <38268900+LaylaLiu-gmail@users.noreply.github.com> Co-authored-by: layliu <layliu@microsoft.com> Co-authored-by: snehapar9 <108305436+snehapar9@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Tara W <tawalke@users.noreply.github.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: yitaopan <yitaopan@microsoft.com> Co-authored-by: bgashirabake <85650284+bgashirabake@users.noreply.github.com> Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> Co-authored-by: Jitin John <jijohn@microsoft.com> * revert change (#30700) * Fix default value property error for keda properties - 08.2024 release (#30691) * Add cooldownPeriod property to Jobs.json and Job_CreateorUpdate_EventTrigger.json-TEW * PR Feedback: Run prettier on json file for PR check-TEW * PR Feedback: Update ARM for Container Apps with both cooldown and polling properties; Update jobs.json with missing cooldown Period reference-TEW * PR Feedback: Update ContainerApp examples with KEDA properties cooldownPeriod/pollingInterval-TEW" * PR Feedback: Re-ran prettier on files noted in PR Check-TEW * Removing cooldownPeriod from Jobs.json and Jobs examples-TEW * Remove default for polling and cooldown to fix error-TEW * Add Identity to session pool registry (#30748) * Add Identity to session pool registry * update examples * fix --------- Co-authored-by: Xuyang Cao <Elvis_caoxy@163.com> Co-authored-by: Xuyang Cao <Xuyang.Cao@microsoft.com> Co-authored-by: Yi Liu <yiliu6@microsoft.com> Co-authored-by: LaylaLiu-gmail <38268900+LaylaLiu-gmail@users.noreply.github.com> Co-authored-by: layliu <layliu@microsoft.com> Co-authored-by: snehapar9 <108305436+snehapar9@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Tara W <tawalke@users.noreply.github.com> Co-authored-by: Michael Dai <michaelkira@live.cn> Co-authored-by: yitaopan <yitaopan@microsoft.com> Co-authored-by: bgashirabake <85650284+bgashirabake@users.noreply.github.com> Co-authored-by: bgashirabake@gmail.com <bgashirabake@microsoft.com> Co-authored-by: Jitin John <jijohn@microsoft.com> Co-authored-by: najian <jiangnan8924@gmail.com> --- cSpell.json | 2 +- .../2024-08-02-preview/AppResiliency.json | 312 +++ .../2024-08-02-preview/AuthConfigs.json | 1034 ++++++++ .../AvailableWorkloadProfiles.json | 149 ++ .../2024-08-02-preview/BillingMeters.json | 133 + .../preview/2024-08-02-preview/Builders.json | 491 ++++ .../preview/2024-08-02-preview/Builds.json | 475 ++++ .../2024-08-02-preview/CommonDefinitions.json | 2183 +++++++++++++++++ .../ConnectedEnvironments.json | 469 ++++ .../ConnectedEnvironmentsCertificates.json | 315 +++ .../ConnectedEnvironmentsDaprComponents.json | 307 +++ .../ConnectedEnvironmentsStorages.json | 294 +++ .../2024-08-02-preview/ContainerApps.json | 1554 ++++++++++++ .../ContainerAppsBuilds.json | 348 +++ .../ContainerAppsPatches.json | 555 +++++ .../ContainerAppsRevisions.json | 682 +++++ .../2024-08-02-preview/Diagnostics.json | 866 +++++++ .../2024-08-02-preview/DotNetComponents.json | 479 ++++ .../FunctionsExtension.json | 107 + .../preview/2024-08-02-preview/Global.json | 140 ++ .../2024-08-02-preview/JavaComponents.json | 641 +++++ .../preview/2024-08-02-preview/Jobs.json | 1423 +++++++++++ .../LogicAppsExtension.json | 750 ++++++ .../ManagedEnvironments.json | 1928 +++++++++++++++ ...nmentsDaprComponentResiliencyPolicies.json | 302 +++ .../ManagedEnvironmentsDaprComponents.json | 313 +++ .../ManagedEnvironmentsDaprSubscriptions.json | 276 +++ .../ManagedEnvironmentsStorages.json | 300 +++ .../2024-08-02-preview/SessionPools.json | 708 ++++++ .../2024-08-02-preview/SourceControls.json | 488 ++++ .../2024-08-02-preview/Subscriptions.json | 80 + .../preview/2024-08-02-preview/Usages.json | 188 ++ .../AppResiliency_CreateOrUpdate.json | 176 ++ .../examples/AppResiliency_Delete.json | 13 + .../examples/AppResiliency_Get.json | 68 + .../examples/AppResiliency_List.json | 71 + .../examples/AppResiliency_Patch.json | 76 + .../examples/AuthConfigs_CreateOrUpdate.json | 61 + .../examples/AuthConfigs_Delete.json | 13 + .../examples/AuthConfigs_Get.json | 39 + .../examples/AuthConfigs_ListByContainer.json | 43 + .../AvailableWorkloadProfiles_Get.json | 159 ++ .../examples/BillingMeters_Get.json | 81 + .../examples/Builders_CreateOrUpdate.json | 128 + .../examples/Builders_Delete.json | 18 + .../examples/Builders_Get.json | 56 + .../Builders_ListByResourceGroup.json | 102 + .../examples/Builders_ListBySubscription.json | 101 + .../examples/Builders_Update.json | 66 + .../examples/Builds_CreateOrUpdate.json | 214 ++ .../Builds_CreateOrUpdate_NoConfig.json | 61 + .../examples/Builds_Delete.json | 19 + .../examples/Builds_Get.json | 85 + .../examples/Builds_ListAuthToken.json | 20 + .../Builds_ListByBuilderResource.json | 159 ++ .../examples/Certificate_CreateOrUpdate.json | 40 + ...rtificate_CreateOrUpdate_FromKeyVault.json | 46 + .../examples/Certificate_Delete.json | 13 + .../examples/Certificate_Get.json | 33 + .../Certificates_CheckNameAvailability.json | 21 + ...Certificates_ListByManagedEnvironment.json | 55 + .../examples/Certificates_Patch.json | 42 + ...nvironmentsCertificate_CreateOrUpdate.json | 38 + ...nnectedEnvironmentsCertificate_Delete.json | 13 + .../ConnectedEnvironmentsCertificate_Get.json | 32 + ...ntsCertificates_CheckNameAvailability.json | 21 + ...rtificates_ListByConnectedEnvironment.json | 53 + ...nnectedEnvironmentsCertificates_Patch.json | 41 + ...ronmentsDaprComponents_CreateOrUpdate.json | 107 + ...ctedEnvironmentsDaprComponents_Delete.json | 13 + ...nnectedEnvironmentsDaprComponents_Get.json | 61 + ...nectedEnvironmentsDaprComponents_List.json | 64 + ...nvironmentsDaprComponents_ListSecrets.json | 26 + ...edEnvironmentsStorages_CreateOrUpdate.json | 35 + .../ConnectedEnvironmentsStorages_Delete.json | 13 + .../ConnectedEnvironmentsStorages_Get.json | 25 + .../ConnectedEnvironmentsStorages_List.json | 28 + .../ConnectedEnvironments_CreateOrUpdate.json | 73 + .../ConnectedEnvironments_Delete.json | 23 + .../examples/ConnectedEnvironments_Get.json | 42 + ...ectedEnvironments_ListByResourceGroup.json | 63 + ...nectedEnvironments_ListBySubscription.json | 54 + .../examples/ConnectedEnvironments_Patch.json | 42 + .../examples/ContainerAppsBuilds_Delete.json | 19 + .../examples/ContainerAppsBuilds_Get.json | 83 + ...ontainerAppsBuilds_ListByContainerApp.json | 155 ++ .../ContainerAppsDiagnostics_Get.json | 68 + .../ContainerAppsDiagnostics_List.json | 38 + .../examples/ContainerAppsPatches_Apply.json | 53 + .../examples/ContainerAppsPatches_Delete.json | 19 + .../examples/ContainerAppsPatches_Get.json | 48 + ...ntainerAppsPatches_ListByContainerApp.json | 103 + .../ContainerAppsPatches_Skip_Configure.json | 21 + .../ContainerApps_CheckNameAvailability.json | 21 + .../ContainerApps_CreateOrUpdate.json | 660 +++++ ...s_CreateOrUpdate_ConnectedEnvironment.json | 464 ++++ .../examples/ContainerApps_Delete.json | 17 + .../examples/ContainerApps_Get.json | 214 ++ .../examples/ContainerApps_GetAuthToken.json | 24 + .../ContainerApps_Kind_CreateOrUpdate.json | 202 ++ .../ContainerApps_ListByResourceGroup.json | 200 ++ .../ContainerApps_ListBySubscription.json | 159 ++ ...tainerApps_ListCustomHostNameAnalysis.json | 42 + .../examples/ContainerApps_ListSecrets.json | 23 + ...ontainerApps_ManagedBy_CreateOrUpdate.json | 210 ++ .../examples/ContainerApps_Patch.json | 290 +++ ...rApps_SourceToCloudApp_CreateOrUpdate.json | 492 ++++ .../examples/ContainerApps_Start.json | 145 ++ .../examples/ContainerApps_Stop.json | 143 ++ .../ContainerApps_TcpApp_CreateOrUpdate.json | 207 ++ ...aprComponentResiliencyPolicies_Delete.json | 14 + .../DaprComponentResiliencyPolicies_Get.json | 54 + .../DaprComponentResiliencyPolicies_List.json | 57 + ...iencyPolicy_CreateOrUpdate_AllOptions.json | 136 + ...ncyPolicy_CreateOrUpdate_OutboundOnly.json | 85 + ...cyPolicy_CreateOrUpdate_SparseOptions.json | 88 + ...s_CreateOrUpdate_SecretStoreComponent.json | 98 + ...DaprComponents_CreateOrUpdate_Secrets.json | 107 + .../examples/DaprComponents_Delete.json | 13 + ...prComponents_Get_SecretStoreComponent.json | 57 + .../examples/DaprComponents_Get_Secrets.json | 61 + .../examples/DaprComponents_List.json | 152 ++ .../examples/DaprComponents_ListSecrets.json | 24 + ...CreateOrUpdate_BulkSubscribeAndScopes.json | 77 + ...criptions_CreateOrUpdate_DefaultRoute.json | 50 + ..._CreateOrUpdate_RouteRulesAndMetadata.json | 90 + .../examples/DaprSubscriptions_Delete.json | 13 + ...scriptions_Get_BulkSubscribeAndScopes.json | 35 + .../DaprSubscriptions_Get_DefaultRoute.json | 26 + ...bscriptions_Get_RouteRulesAndMetadata.json | 39 + .../examples/DaprSubscriptions_List.json | 73 + .../DotNetComponents_CreateOrUpdate.json | 58 + ...Components_CreateOrUpdate_ServiceBind.json | 76 + .../examples/DotNetComponents_Delete.json | 17 + .../examples/DotNetComponents_Get.json | 29 + .../DotNetComponents_Get_ServiceBind.json | 35 + .../examples/DotNetComponents_List.json | 46 + .../DotNetComponents_List_ServiceBind.json | 58 + .../examples/DotNetComponents_Patch.json | 45 + .../DotNetComponents_Patch_ServiceBind.json | 57 + .../examples/FunctionsExtension_Post.json | 15 + .../JavaComponents_CreateOrUpdate.json | 88 + ...Components_CreateOrUpdate_ServiceBind.json | 100 + .../examples/JavaComponents_Delete.json | 17 + .../examples/JavaComponents_Get.json | 40 + .../JavaComponents_Get_ServiceBind.json | 43 + .../examples/JavaComponents_List.json | 99 + .../JavaComponents_List_ServiceBind.json | 70 + .../examples/JavaComponents_Patch.json | 64 + .../JavaComponents_Patch_ServiceBind.json | 73 + .../examples/Job_CreateorUpdate.json | 325 +++ ...b_CreateorUpdate_ConnectedEnvironment.json | 219 ++ .../Job_CreateorUpdate_EventTrigger.json | 226 ++ .../examples/Job_Delete.json | 17 + .../examples/Job_Execution_Get.json | 51 + .../examples/Job_Executions_Get.json | 76 + .../2024-08-02-preview/examples/Job_Get.json | 99 + .../examples/Job_GetDetector.json | 68 + .../examples/Job_ListDetectors.json | 38 + .../examples/Job_ListSecrets.json | 23 + .../examples/Job_Patch.json | 114 + .../examples/Job_ProxyGet.json | 55 + .../examples/Job_Start.json | 51 + .../examples/Job_Stop_Execution.json | 17 + .../examples/Job_Stop_Multiple.json | 60 + .../examples/Jobs_ListByResourceGroup.json | 100 + .../examples/Jobs_ListBySubscription.json | 99 + .../examples/Jobs_Resume.json | 95 + .../examples/Jobs_Suspend.json | 95 + .../examples/LogicApps_Create.json | 30 + .../examples/LogicApps_Delete.json | 13 + ...gicApps_DeleteDeployWorkflowArtifacts.json | 18 + .../examples/LogicApps_Get.json | 19 + .../examples/LogicApps_GetWorkflow.json | 58 + .../examples/LogicApps_ListCallbackURL.json | 26 + .../examples/LogicApps_ListConnections.json | 45 + .../examples/LogicApps_ListWorkflows.json | 49 + ...LogicApps_PostDeployWorkflowArtifacts.json | 58 + .../ManagedCertificate_CreateOrUpdate.json | 50 + .../examples/ManagedCertificate_Delete.json | 13 + .../examples/ManagedCertificate_Get.json | 24 + ...Certificates_ListByManagedEnvironment.json | 47 + .../examples/ManagedCertificates_Patch.json | 30 + .../ManagedEnvironmentDiagnostics_Get.json | 68 + .../ManagedEnvironmentDiagnostics_List.json | 37 + ...ateEndpointConnections_CreateOrUpdate.json | 59 + ...mentPrivateEndpointConnections_Delete.json | 17 + ...ronmentPrivateEndpointConnections_Get.json | 31 + ...onmentPrivateEndpointConnections_List.json | 52 + ...dEnvironmentPrivateLinkResources_List.json | 30 + .../ManagedEnvironmentUsages_List.json | 25 + ...edEnvironmentsStorages_CreateOrUpdate.json | 35 + ...sStorages_CreateOrUpdate_NfsAzureFile.json | 34 + .../ManagedEnvironmentsStorages_Delete.json | 13 + .../ManagedEnvironmentsStorages_Get.json | 25 + ...EnvironmentsStorages_Get_NfsAzureFile.json | 25 + .../ManagedEnvironmentsStorages_List.json | 40 + .../ManagedEnvironments_CreateOrUpdate.json | 323 +++ ...tomInfrastructureResourceGroup_Create.json | 171 ++ .../examples/ManagedEnvironments_Delete.json | 18 + .../examples/ManagedEnvironments_Get.json | 79 + .../ManagedEnvironments_GetAuthToken.json | 23 + ...nagedEnvironments_ListByResourceGroup.json | 94 + ...anagedEnvironments_ListBySubscription.json | 99 + ...nvironments_ListWorkloadProfileStates.json | 36 + .../examples/ManagedEnvironments_Patch.json | 72 + .../examples/Operations_List.json | 24 + .../examples/Replicas_Get.json | 40 + .../examples/Replicas_List.json | 43 + .../examples/Revisions_Activate.json | 12 + .../examples/Revisions_Deactivate.json | 12 + .../examples/Revisions_Get.json | 54 + .../examples/Revisions_List.json | 57 + .../examples/Revisions_Restart.json | 12 + .../examples/SessionPools_CreateOrUpdate.json | 158 ++ .../examples/SessionPools_Delete.json | 16 + .../examples/SessionPools_Get.json | 64 + .../SessionPools_ListByResourceGroup.json | 64 + .../SessionPools_ListBySubscription.json | 63 + .../examples/SessionPools_Patch.json | 102 + .../SourceControls_CreateOrUpdate.json | 109 + .../examples/SourceControls_Delete.json | 21 + .../examples/SourceControls_Get.json | 42 + .../SourceControls_ListByContainer.json | 46 + ...iptions_GetCustomDomainVerificationId.json | 12 + .../examples/Usages_List.json | 33 + specification/app/resource-manager/readme.md | 46 +- .../resource-manager/sdk-suppressions.yaml | 10 + 228 files changed, 32489 insertions(+), 2 deletions(-) create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AppResiliency.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AuthConfigs.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AvailableWorkloadProfiles.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/BillingMeters.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builders.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builds.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/CommonDefinitions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironments.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsCertificates.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsDaprComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsStorages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerApps.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsBuilds.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsPatches.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsRevisions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Diagnostics.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/DotNetComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/FunctionsExtension.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Global.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/LogicAppsExtension.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironments.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponents.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprSubscriptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsStorages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SessionPools.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Subscriptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Usages.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_ListByContainer.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AvailableWorkloadProfiles_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/BillingMeters_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Update.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListByBuilderResource.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_ListByManagedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Apply.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Skip_Configure.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CheckNameAvailability.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_GetAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Start.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Stop.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_Secrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/FunctionsExtension_Post.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch_ServiceBind.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_EventTrigger.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Execution_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Executions_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_GetDetector.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListDetectors.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListSecrets.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ProxyGet.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Start.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Execution.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Multiple.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Resume.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Suspend.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Create.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_GetWorkflow.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListCallbackURL.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListConnections.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListWorkflows.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentUsages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_GetAuthToken.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Operations_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Activate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Deactivate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_List.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Restart.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListByResourceGroup.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListBySubscription.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Patch.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_CreateOrUpdate.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Delete.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Get.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_ListByContainer.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json create mode 100644 specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Usages_List.json diff --git a/cSpell.json b/cSpell.json index 679a44694f6e..d30e94ab13fe 100644 --- a/cSpell.json +++ b/cSpell.json @@ -278,7 +278,7 @@ ] }, { - "filename": "**/specification/app/resource-manager/Microsoft.App/preview/2024-02-02-preview/ContainerApps.json", + "filename": "**/specification/app/resource-manager/Microsoft.App/**/*.json", "words": [ "workflowapp" ] diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AppResiliency.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AppResiliency.json new file mode 100644 index 000000000000..bf654af4dc2f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AppResiliency.json @@ -0,0 +1,312 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies/{name}": { + "put": { + "tags": [ + "AppResiliency" + ], + "summary": "Create or update an application's resiliency policy.", + "description": "Create or update container app resiliency policy.", + "operationId": "AppResiliency_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resiliencyEnvelope", + "in": "body", + "description": "The resiliency policy to create or update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "201": { + "description": "App Resiliency create or update has been started.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update App Resiliency": { + "$ref": "./examples/AppResiliency_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "AppResiliency" + ], + "summary": "Update an application's resiliency policy.", + "description": "Update container app resiliency policy.", + "operationId": "AppResiliency_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resiliencyEnvelope", + "in": "body", + "description": "The resiliency policy to update.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update App Resiliency": { + "$ref": "./examples/AppResiliency_Patch.json" + } + } + }, + "delete": { + "tags": [ + "AppResiliency" + ], + "summary": "Delete an application's resiliency policy.", + "description": "Delete container app resiliency policy.", + "operationId": "AppResiliency_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Resiliency policy deleted successfully." + }, + "204": { + "description": "Resiliency policy does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete App Resiliency": { + "$ref": "./examples/AppResiliency_Delete.json" + } + } + }, + "get": { + "tags": [ + "AppResiliency" + ], + "summary": "Get an application's resiliency policy.", + "description": "Get container app resiliency policy.", + "operationId": "AppResiliency_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "description": "Name of the resiliency policy.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliency" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get App Resiliency": { + "$ref": "./examples/AppResiliency_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{appName}/resiliencyPolicies": { + "get": { + "tags": [ + "AppResiliency" + ], + "summary": "List an application's resiliency policies.", + "description": "List container app resiliency policies.", + "operationId": "AppResiliency_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "appName", + "description": "Name of the Container App.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/AppResiliencyCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App Resiliency": { + "$ref": "./examples/AppResiliency_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AuthConfigs.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AuthConfigs.json new file mode 100644 index 000000000000..5b6aefd21fb4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AuthConfigs.json @@ -0,0 +1,1034 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs": { + "get": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Get the Container App AuthConfigs in a given resource group.", + "operationId": "ContainerAppsAuthConfigs_ListByContainerApp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AuthConfigCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Auth Configs by Container Apps": { + "$ref": "./examples/AuthConfigs_ListByContainer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName}": { + "get": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Get a AuthConfig of a Container App.", + "operationId": "ContainerAppsAuthConfigs_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's AuthConfig": { + "$ref": "./examples/AuthConfigs_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Create or update the AuthConfig for a Container App.", + "description": "Create or update the AuthConfig for a Container App.", + "operationId": "ContainerAppsAuthConfigs_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "name": "authConfigEnvelope", + "in": "body", + "description": "Properties used to create a Container App AuthConfig", + "required": true, + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AuthConfig" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App AuthConfig": { + "$ref": "./examples/AuthConfigs_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsAuthConfigs" + ], + "summary": "Delete a Container App AuthConfig.", + "description": "Delete a Container App AuthConfig.", + "operationId": "ContainerAppsAuthConfigs_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "authConfigName", + "in": "path", + "description": "Name of the Container App AuthConfig.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App deleted successfully." + }, + "204": { + "description": "Container App AuthConfig does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App AuthConfig": { + "$ref": "./examples/AuthConfigs_Delete.json" + } + } + } + } + }, + "definitions": { + "AuthConfigCollection": { + "description": "AuthConfig collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AuthConfig" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AuthConfig": { + "description": "Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "AuthConfig resource specific properties", + "type": "object", + "properties": { + "platform": { + "$ref": "#/definitions/AuthPlatform", + "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization." + }, + "globalValidation": { + "$ref": "#/definitions/GlobalValidation", + "description": "The configuration settings that determines the validation flow of users using Service Authentication/Authorization." + }, + "identityProviders": { + "$ref": "#/definitions/IdentityProviders", + "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization." + }, + "login": { + "$ref": "#/definitions/Login", + "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization." + }, + "httpSettings": { + "$ref": "#/definitions/HttpSettings", + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization." + }, + "encryptionSettings": { + "$ref": "#/definitions/EncryptionSettings", + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization." + } + }, + "x-ms-client-flatten": true + } + } + }, + "AuthPlatform": { + "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.", + "type": "boolean" + }, + "runtimeVersion": { + "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.", + "type": "string" + } + } + }, + "GlobalValidation": { + "description": "The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "unauthenticatedClientAction": { + "description": "The action to take when an unauthenticated client attempts to access the app.", + "enum": [ + "RedirectToLoginPage", + "AllowAnonymous", + "Return401", + "Return403" + ], + "type": "string", + "x-ms-enum": { + "name": "UnauthenticatedClientActionV2", + "modelAsString": false + } + }, + "redirectToProvider": { + "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".", + "type": "string" + }, + "excludedPaths": { + "description": "The paths for which unauthenticated flow would not be redirected to the login page.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HttpSettings": { + "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "requireHttps": { + "description": "<code>false</code> if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, <code>true</code>.", + "type": "boolean" + }, + "routes": { + "$ref": "#/definitions/HttpSettingsRoutes", + "description": "The configuration settings of the paths HTTP requests." + }, + "forwardProxy": { + "$ref": "#/definitions/ForwardProxy", + "description": "The configuration settings of a forward proxy used to make the requests." + } + } + }, + "EncryptionSettings": { + "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "containerAppAuthEncryptionSecretName": { + "description": "The secret name which is referenced for EncryptionKey.", + "type": "string" + }, + "containerAppAuthSigningSecretName": { + "description": "The secret name which is referenced for SigningKey.", + "type": "string" + } + } + }, + "HttpSettingsRoutes": { + "description": "The configuration settings of the paths HTTP requests.", + "type": "object", + "properties": { + "apiPrefix": { + "description": "The prefix that should precede all the authentication/authorization paths.", + "type": "string" + } + } + }, + "ForwardProxy": { + "description": "The configuration settings of a forward proxy used to make the requests.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used to determine the url of the request made.", + "enum": [ + "NoProxy", + "Standard", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ForwardProxyConvention", + "modelAsString": false + } + }, + "customHostHeaderName": { + "description": "The name of the header containing the host of the request.", + "type": "string" + }, + "customProtoHeaderName": { + "description": "The name of the header containing the scheme of the request.", + "type": "string" + } + } + }, + "Login": { + "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "routes": { + "$ref": "#/definitions/LoginRoutes", + "description": "The routes that specify the endpoints used for login and logout requests." + }, + "tokenStore": { + "$ref": "#/definitions/TokenStore", + "description": "The configuration settings of the token store." + }, + "preserveUrlFragmentsForLogins": { + "description": "<code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.", + "type": "boolean" + }, + "allowedExternalRedirectUrls": { + "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.", + "type": "array", + "items": { + "type": "string" + } + }, + "cookieExpiration": { + "$ref": "#/definitions/CookieExpiration", + "description": "The configuration settings of the session cookie's expiration." + }, + "nonce": { + "$ref": "#/definitions/Nonce", + "description": "The configuration settings of the nonce used in the login flow." + } + } + }, + "LoginRoutes": { + "description": "The routes that specify the endpoints used for login and logout requests.", + "type": "object", + "properties": { + "logoutEndpoint": { + "description": "The endpoint at which a logout request should be made.", + "type": "string" + } + } + }, + "TokenStore": { + "description": "The configuration settings of the token store.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.\n The default is <code>false</code>.", + "type": "boolean" + }, + "tokenRefreshExtensionHours": { + "format": "double", + "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.", + "type": "number" + }, + "azureBlobStorage": { + "$ref": "#/definitions/BlobStorageTokenStore", + "description": "The configuration settings of the storage of the tokens if blob storage is used." + } + } + }, + "BlobStorageTokenStore": { + "description": "The configuration settings of the storage of the tokens if blob storage is used.", + "type": "object", + "required": [ + "sasUrlSettingName" + ], + "properties": { + "sasUrlSettingName": { + "description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens.", + "type": "string" + } + } + }, + "CookieExpiration": { + "description": "The configuration settings of the session cookie's expiration.", + "type": "object", + "properties": { + "convention": { + "description": "The convention used when determining the session cookie's expiration.", + "enum": [ + "FixedTime", + "IdentityProviderDerived" + ], + "type": "string", + "x-ms-enum": { + "name": "CookieExpirationConvention", + "modelAsString": false + } + }, + "timeToExpiration": { + "description": "The time after the request is made when the session cookie should expire.", + "type": "string" + } + } + }, + "Nonce": { + "description": "The configuration settings of the nonce used in the login flow.", + "type": "object", + "properties": { + "validateNonce": { + "description": "<code>false</code> if the nonce should not be validated while completing the login flow; otherwise, <code>true</code>.", + "type": "boolean" + }, + "nonceExpirationInterval": { + "description": "The time after the request is made when the nonce should expire.", + "type": "string" + } + } + }, + "IdentityProviders": { + "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.", + "type": "object", + "properties": { + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The configuration settings of the Azure Active directory provider." + }, + "facebook": { + "$ref": "#/definitions/Facebook", + "description": "The configuration settings of the Facebook provider." + }, + "gitHub": { + "$ref": "#/definitions/GitHub", + "description": "The configuration settings of the GitHub provider." + }, + "google": { + "$ref": "#/definitions/Google", + "description": "The configuration settings of the Google provider." + }, + "twitter": { + "$ref": "#/definitions/Twitter", + "description": "The configuration settings of the Twitter provider." + }, + "apple": { + "$ref": "#/definitions/Apple", + "description": "The configuration settings of the Apple provider." + }, + "azureStaticWebApps": { + "$ref": "#/definitions/AzureStaticWebApps", + "description": "The configuration settings of the Azure Static Web Apps provider." + }, + "customOpenIdConnectProviders": { + "description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/CustomOpenIdConnectProvider" + } + } + } + }, + "AzureActiveDirectory": { + "description": "The configuration settings of the Azure Active directory provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureActiveDirectoryRegistration", + "description": "The configuration settings of the Azure Active Directory app registration." + }, + "login": { + "$ref": "#/definitions/AzureActiveDirectoryLogin", + "description": "The configuration settings of the Azure Active Directory login flow." + }, + "validation": { + "$ref": "#/definitions/AzureActiveDirectoryValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + }, + "isAutoProvisioned": { + "description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryLogin": { + "description": "The configuration settings of the Azure Active Directory login flow.", + "type": "object", + "properties": { + "loginParameters": { + "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".", + "type": "array", + "items": { + "type": "string" + } + }, + "disableWWWAuthenticate": { + "description": "<code>true</code> if the www-authenticate provider should be omitted from the request; otherwise, <code>false</code>.", + "type": "boolean" + } + } + }, + "AzureActiveDirectoryRegistration": { + "description": "The configuration settings of the Azure Active Directory app registration.", + "type": "object", + "properties": { + "openIdIssuer": { + "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html", + "type": "string" + }, + "clientId": { + "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret of the relying party application.", + "type": "string" + }, + "clientSecretCertificateThumbprint": { + "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.", + "type": "string" + }, + "clientSecretCertificateSubjectAlternativeName": { + "description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + }, + "clientSecretCertificateIssuer": { + "description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional.", + "type": "string" + } + } + }, + "AzureActiveDirectoryValidation": { + "description": "The configuration settings of the Azure Active Directory token validation flow.", + "type": "object", + "properties": { + "jwtClaimChecks": { + "$ref": "#/definitions/JwtClaimChecks", + "description": "The configuration settings of the checks that should be made while validating the JWT Claims." + }, + "allowedAudiences": { + "description": "The list of audiences that can make successful authentication/authorization requests.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultAuthorizationPolicy": { + "$ref": "#/definitions/DefaultAuthorizationPolicy", + "description": "The configuration settings of the default authorization policy." + } + } + }, + "JwtClaimChecks": { + "description": "The configuration settings of the checks that should be made while validating the JWT Claims.", + "type": "object", + "properties": { + "allowedGroups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedClientApplications": { + "description": "The list of the allowed client applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DefaultAuthorizationPolicy": { + "description": "The configuration settings of the Azure Active Directory default authorization policy.", + "type": "object", + "properties": { + "allowedPrincipals": { + "$ref": "#/definitions/AllowedPrincipals", + "description": "The configuration settings of the Azure Active Directory allowed principals." + }, + "allowedApplications": { + "description": "The configuration settings of the Azure Active Directory allowed applications.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AllowedPrincipals": { + "description": "The configuration settings of the Azure Active Directory allowed principals.", + "type": "object", + "properties": { + "groups": { + "description": "The list of the allowed groups.", + "type": "array", + "items": { + "type": "string" + } + }, + "identities": { + "description": "The list of the allowed identities.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Facebook": { + "description": "The configuration settings of the Facebook provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Facebook provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppRegistration", + "description": "The configuration settings of the app registration for the Facebook provider." + }, + "graphApiVersion": { + "description": "The version of the Facebook api to be used while logging in.", + "type": "string" + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "AppRegistration": { + "description": "The configuration settings of the app registration for providers that have app ids and app secrets", + "type": "object", + "properties": { + "appId": { + "description": "The App ID of the app used for login.", + "type": "string" + }, + "appSecretSettingName": { + "description": "The app setting name that contains the app secret.", + "type": "string" + } + } + }, + "LoginScopes": { + "description": "The configuration settings of the login flow, including the scopes that should be requested.", + "type": "object", + "properties": { + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GitHub": { + "description": "The configuration settings of the GitHub provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the GitHub provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the GitHub provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "ClientRegistration": { + "description": "The configuration settings of the app registration for providers that have client ids and client secrets", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "Google": { + "description": "The configuration settings of the Google provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Google provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/ClientRegistration", + "description": "The configuration settings of the app registration for the Google provider." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + }, + "validation": { + "$ref": "#/definitions/AllowedAudiencesValidation", + "description": "The configuration settings of the Azure Active Directory token validation flow." + } + } + }, + "AllowedAudiencesValidation": { + "description": "The configuration settings of the Allowed Audiences validation flow.", + "type": "object", + "properties": { + "allowedAudiences": { + "description": "The configuration settings of the allowed list of audiences from which to validate the JWT token.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Twitter": { + "description": "The configuration settings of the Twitter provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Twitter provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/TwitterRegistration", + "description": "The configuration settings of the app registration for the Twitter provider." + } + } + }, + "TwitterRegistration": { + "description": "The configuration settings of the app registration for the Twitter provider.", + "type": "object", + "properties": { + "consumerKey": { + "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in", + "type": "string" + }, + "consumerSecretSettingName": { + "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in.", + "type": "string" + } + } + }, + "Apple": { + "description": "The configuration settings of the Apple provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Apple provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AppleRegistration", + "description": "The configuration settings of the Apple registration." + }, + "login": { + "$ref": "#/definitions/LoginScopes", + "description": "The configuration settings of the login flow." + } + } + }, + "AppleRegistration": { + "description": "The configuration settings of the registration for the Apple provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + }, + "clientSecretSettingName": { + "description": "The app setting name that contains the client secret.", + "type": "string" + } + } + }, + "AzureStaticWebApps": { + "description": "The configuration settings of the Azure Static Web Apps provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/AzureStaticWebAppsRegistration", + "description": "The configuration settings of the Azure Static Web Apps registration." + } + } + }, + "AzureStaticWebAppsRegistration": { + "description": "The configuration settings of the registration for the Azure Static Web Apps provider", + "type": "object", + "properties": { + "clientId": { + "description": "The Client ID of the app used for login.", + "type": "string" + } + } + }, + "CustomOpenIdConnectProvider": { + "description": "The configuration settings of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "enabled": { + "description": "<code>false</code> if the custom Open ID provider provider should not be enabled; otherwise, <code>true</code>.", + "type": "boolean" + }, + "registration": { + "$ref": "#/definitions/OpenIdConnectRegistration", + "description": "The configuration settings of the app registration for the custom Open ID Connect provider." + }, + "login": { + "$ref": "#/definitions/OpenIdConnectLogin", + "description": "The configuration settings of the login flow of the custom Open ID Connect provider." + } + } + }, + "OpenIdConnectRegistration": { + "description": "The configuration settings of the app registration for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "clientId": { + "description": "The client id of the custom Open ID Connect provider.", + "type": "string" + }, + "clientCredential": { + "$ref": "#/definitions/OpenIdConnectClientCredential", + "description": "The authentication credentials of the custom Open ID Connect provider." + }, + "openIdConnectConfiguration": { + "$ref": "#/definitions/OpenIdConnectConfig", + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider." + } + } + }, + "OpenIdConnectClientCredential": { + "description": "The authentication client credentials of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "method": { + "description": "The method that should be used to authenticate the user.", + "enum": [ + "ClientSecretPost" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientCredentialMethod", + "modelAsString": false + } + }, + "clientSecretSettingName": { + "description": "The app setting that contains the client secret for the custom Open ID Connect provider.", + "type": "string" + } + } + }, + "OpenIdConnectConfig": { + "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.", + "type": "object", + "properties": { + "authorizationEndpoint": { + "description": "The endpoint to be used to make an authorization request.", + "type": "string" + }, + "tokenEndpoint": { + "description": "The endpoint to be used to request a token.", + "type": "string" + }, + "issuer": { + "description": "The endpoint that issues the token.", + "type": "string" + }, + "certificationUri": { + "description": "The endpoint that provides the keys necessary to validate the token.", + "type": "string" + }, + "wellKnownOpenIdConfiguration": { + "description": "The endpoint that contains all the configuration endpoints for the provider.", + "type": "string" + } + } + }, + "OpenIdConnectLogin": { + "description": "The configuration settings of the login flow of the custom Open ID Connect provider.", + "type": "object", + "properties": { + "nameClaimType": { + "description": "The name of the claim that contains the users name.", + "type": "string" + }, + "scopes": { + "description": "A list of the scopes that should be requested while authenticating.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AvailableWorkloadProfiles.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AvailableWorkloadProfiles.json new file mode 100644 index 000000000000..34a8e1da76db --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/AvailableWorkloadProfiles.json @@ -0,0 +1,149 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/availableManagedEnvironmentsWorkloadProfileTypes": { + "get": { + "tags": [ + "AvailableWorkloadProfiles" + ], + "summary": "Get available workload profiles by location.", + "description": "Get all available workload profiles for a location.", + "operationId": "AvailableWorkloadProfiles_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailableWorkloadProfilesCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BillingMeters_Get": { + "$ref": "./examples/AvailableWorkloadProfiles_Get.json" + } + } + } + } + }, + "definitions": { + "AvailableWorkloadProfile": { + "description": "A workload profile with specific hardware configure to run container apps.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Region of the workload profile." + }, + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "category": { + "description": "Used to categorize workload profiles.", + "type": "string" + }, + "applicability": { + "type": "string", + "description": "indicates whether the profile is default for the location.", + "enum": [ + "LocationDefault", + "Custom" + ], + "x-ms-enum": { + "name": "Applicability", + "modelAsString": true + } + }, + "cores": { + "type": "integer", + "format": "int32", + "description": "Number of cores in CPU." + }, + "memoryGiB": { + "type": "integer", + "format": "int32", + "description": "Memory in GiB." + }, + "gpus": { + "type": "integer", + "format": "int32", + "description": "Number of GPUs." + }, + "displayName": { + "type": "string", + "description": "The everyday name of the workload profile." + } + } + } + } + }, + "AvailableWorkloadProfilesCollection": { + "description": "Collection of available workload profiles in the location.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of workload profiles.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailableWorkloadProfile" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/BillingMeters.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/BillingMeters.json new file mode 100644 index 000000000000..8f9d4ef60924 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/BillingMeters.json @@ -0,0 +1,133 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/billingMeters": { + "get": { + "tags": [ + "BillingMeters" + ], + "summary": "Get billing meters by location.", + "description": "Get all billingMeters for a location.", + "operationId": "BillingMeters_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingMeterCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingMeters_Get": { + "$ref": "./examples/BillingMeters_Get.json" + } + } + } + } + }, + "definitions": { + "BillingMeter": { + "description": "Billing meter.", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" + }, + "systemData": { + "readOnly": true, + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + }, + "location": { + "type": "string", + "description": "Region for the billing meter." + }, + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "category": { + "description": "Used to categorize billing meters.", + "type": "string" + }, + "meterType": { + "type": "string", + "description": "Billing meter type." + }, + "displayName": { + "type": "string", + "description": "The everyday name of the billing meter." + } + } + } + } + }, + "BillingMeterCollection": { + "description": "Collection of billing meters.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of billing meters.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeter" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builders.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builders.json new file mode 100644 index 000000000000..1051fc7477d9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builders.json @@ -0,0 +1,491 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/builders": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_ListBySubscription", + "description": "List BuilderResource resources 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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builders_ListBySubscription_0": { + "$ref": "./examples/Builders_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_ListByResourceGroup", + "description": "List BuilderResource resources 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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builders_ListByResourceGroup_0": { + "$ref": "./examples/Builders_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}": { + "get": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Get", + "description": "Get a BuilderResource", + "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" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Get_0": { + "$ref": "./examples/Builders_Get.json" + } + } + }, + "put": { + "tags": [ + "Builders" + ], + "operationId": "Builders_CreateOrUpdate", + "description": "Create or update a BuilderResource", + "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" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderEnvelope", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + } + ], + "responses": { + "200": { + "description": "ARM create or update operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "201": { + "description": "ARM create or update operation has been started.", + "schema": { + "$ref": "#/definitions/BuilderResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builders_CreateOrUpdate_0": { + "$ref": "./examples/Builders_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Update", + "description": "Update a BuilderResource", + "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" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + }, + { + "name": "builderEnvelope", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/BuilderResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuilderResource" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Update_0": { + "$ref": "./examples/Builders_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Builders" + ], + "operationId": "Builders_Delete", + "description": "Delete a BuilderResource", + "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" + }, + { + "$ref": "#/parameters/BuilderNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builders_Delete_0": { + "$ref": "./examples/Builders_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "BuilderProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuilderProvisioningState", + "description": "Provisioning state of a builder resource.", + "readOnly": true + }, + "environmentId": { + "type": "string", + "description": "Resource ID of the container apps environment that the builder is associated with.", + "format": "arm-id" + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "x-ms-identifiers": [ + "containerRegistryServer" + ], + "description": "List of mappings of container registries and the managed identity used to connect to it." + } + }, + "description": "The builder properties.", + "required": [ + "environmentId" + ] + }, + "BuilderResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuilderProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "description": "Information about the SourceToCloud builder resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "BuilderCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BuilderResource" + }, + "description": "The BuilderResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a BuilderResource list operation.", + "required": [ + "value" + ] + }, + "BuilderResourceUpdate": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/BuilderResourceUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the BuilderResource." + }, + "BuilderResourceUpdateProperties": { + "type": "object", + "properties": { + "environmentId": { + "type": "string", + "description": "Resource ID of the container apps environment that the builder is associated with.", + "format": "arm-id" + } + }, + "description": "The updatable properties of the BuilderResource." + }, + "ContainerRegistry": { + "type": "object", + "properties": { + "containerRegistryServer": { + "type": "string", + "description": "Login server of the container registry." + }, + "identityResourceId": { + "type": "string", + "description": "Resource ID of the managed identity.", + "format": "arm-id" + } + }, + "description": "Model representing a mapping from a container registry to the identity used to connect to it.", + "required": [ + "containerRegistryServer", + "identityResourceId" + ] + }, + "BuilderProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuilderProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "BuilderNameParameter": { + "name": "builderName", + "in": "path", + "required": true, + "description": "The name of the builder.", + "minLength": 2, + "maxLength": 32, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builds.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builds.json new file mode 100644 index 000000000000..ad24fbaeee51 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Builds.json @@ -0,0 +1,475 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds": { + "get": { + "tags": [ + "Builds" + ], + "operationId": "BuildsByBuilderResource_List", + "description": "List BuildResource resources by BuilderResource", + "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" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Builds_ListByBuilderResource_0": { + "$ref": "./examples/Builds_ListByBuilderResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}": { + "get": { + "tags": [ + "Builds" + ], + "operationId": "Builds_Get", + "description": "Get a BuildResource", + "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" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builds_Get_0": { + "$ref": "./examples/Builds_Get.json" + } + } + }, + "put": { + "tags": [ + "Builds" + ], + "operationId": "Builds_CreateOrUpdate", + "description": "Create a BuildResource", + "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" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + }, + { + "name": "buildEnvelope", + "in": "body", + "required": true, + "description": "Resource create or update parameters.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + } + ], + "responses": { + "200": { + "description": "ARM create or update operation completed successfully.", + "schema": { + "$ref": "#/definitions/BuildResource" + } + }, + "201": { + "description": "ARM create or update operation has been started.", + "schema": { + "$ref": "#/definitions/BuildResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Builds_CreateOrUpdate_WithConfig": { + "$ref": "./examples/Builds_CreateOrUpdate.json" + }, + "Builds_CreateOrUpdate_NoConfig": { + "$ref": "./examples/Builds_CreateOrUpdate_NoConfig.json" + } + } + }, + "delete": { + "tags": [ + "Builds" + ], + "operationId": "Builds_Delete", + "description": "Delete a BuildResource", + "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" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Builds_Delete_0": { + "$ref": "./examples/Builds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}/listAuthToken": { + "post": { + "tags": [ + "Builds" + ], + "operationId": "BuildAuthToken_List", + "description": "Gets the token used to connect to the endpoint where source code can be uploaded for a build.", + "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" + }, + { + "$ref": "./Builders.json#/parameters/BuilderNameParameter" + }, + { + "$ref": "#/parameters/BuildNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BuildToken" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Build Auth Token": { + "$ref": "./examples/Builds_ListAuthToken.json" + } + } + } + } + }, + "definitions": { + "BuildConfiguration": { + "type": "object", + "properties": { + "baseOs": { + "type": "string", + "description": "Base OS used to build and run the app." + }, + "platform": { + "type": "string", + "description": "Platform to be used to build and run the app." + }, + "platformVersion": { + "type": "string", + "description": "Platform version to be used to build and run the app." + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable." + }, + "preBuildSteps": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PreBuildStep" + }, + "x-ms-identifiers": [], + "description": "List of steps to perform before the build." + } + }, + "description": "Configuration of the build." + }, + "BuildProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuildProvisioningState", + "description": "Build provisioning state.", + "readOnly": true + }, + "buildStatus": { + "$ref": "#/definitions/BuildStatus", + "description": "Status of the build once it has been provisioned.", + "readOnly": true + }, + "destinationContainerRegistry": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerRegistryWithCustomImage", + "description": "Container registry that the final image will be uploaded to." + }, + "configuration": { + "$ref": "#/definitions/BuildConfiguration", + "description": "Configuration of the build." + }, + "uploadEndpoint": { + "type": "string", + "description": "Endpoint to which the source code should be uploaded.", + "readOnly": true + }, + "logStreamEndpoint": { + "type": "string", + "description": "Endpoint from which the build logs can be streamed.", + "readOnly": true + }, + "tokenEndpoint": { + "type": "string", + "description": "Endpoint to use to retrieve an authentication token for log streaming and uploading source code.", + "readOnly": true + } + }, + "description": "The build properties." + }, + "BuildResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/BuildProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "Information pertaining to an individual build.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "BuildCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BuildResource" + }, + "description": "The BuildResource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a BuildResource list operation.", + "required": [ + "value" + ] + }, + "BuildStatus": { + "type": "string", + "description": "Status of the build once it has been provisioned.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + } + }, + "BuildToken": { + "description": "Build Auth Token.", + "type": "object", + "properties": { + "token": { + "type": "string", + "x-ms-secret": true, + "description": "Authentication token.", + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + } + }, + "BuildProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "BuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "description": "The name of a build.", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/CommonDefinitions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/CommonDefinitions.json new file mode 100644 index 000000000000..3cc400faecae --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/CommonDefinitions.json @@ -0,0 +1,2183 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": {}, + "definitions": { + "EnvironmentVar": { + "description": "Container App container environment variable.", + "type": "object", + "properties": { + "name": { + "description": "Environment variable name.", + "type": "string" + }, + "value": { + "description": "Non-secret environment variable value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Container App secret from which to pull the environment variable value.", + "type": "string" + } + } + }, + "WorkloadProfileName": { + "description": "Workload profile name for container apps to execute on.", + "type": "string" + }, + "WorkloadProfileType": { + "description": "Workload profile type for container apps to execute on.", + "type": "string" + }, + "BaseContainer": { + "description": "Container App base container definition.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "imageType": { + "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image.", + "type": "string", + "enum": [ + "CloudBuild", + "ContainerImage" + ], + "x-ms-enum": { + "name": "imageType", + "modelAsString": true + } + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "#/definitions/ContainerResources", + "description": "Container resource requirements." + }, + "volumeMounts": { + "description": "Container volume mounts.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "InitContainer": { + "description": "Container App init container definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseContainer" + } + ] + }, + "Container": { + "description": "Container App container definition", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseContainer" + } + ], + "properties": { + "probes": { + "description": "List of probes for the container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppProbe" + }, + "x-ms-identifiers": [ + "type" + ] + } + } + }, + "ContainerResources": { + "description": "Container App container resource requirements.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"250Mb\"", + "type": "string" + }, + "ephemeralStorage": { + "description": "Ephemeral Storage, e.g. \"1Gi\"", + "type": "string", + "readOnly": true + } + } + }, + "ContainerAppProbe": { + "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", + "type": "object", + "properties": { + "failureThreshold": { + "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.", + "type": "integer", + "format": "int32" + }, + "httpGet": { + "description": "HTTPGet specifies the http request to perform.", + "type": "object", + "required": [ + "port" + ], + "properties": { + "host": { + "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead.", + "type": "string" + }, + "httpHeaders": { + "description": "Custom headers to set in the request. HTTP allows repeated headers.", + "type": "array", + "items": { + "description": "HTTPHeader describes a custom header to be used in HTTP probes", + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "description": "The header field name", + "type": "string" + }, + "value": { + "description": "The header field value", + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + }, + "path": { + "description": "Path to access on the HTTP server.", + "type": "string" + }, + "port": { + "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", + "type": "integer", + "format": "int32" + }, + "scheme": { + "description": "Scheme to use for connecting to the host. Defaults to HTTP.", + "enum": [ + "HTTP", + "HTTPS" + ], + "type": "string", + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + } + } + }, + "initialDelaySeconds": { + "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.", + "type": "integer", + "format": "int32" + }, + "tcpSocket": { + "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", + "type": "object", + "required": [ + "port" + ], + "properties": { + "host": { + "description": "Optional: Host name to connect to, defaults to the pod IP.", + "type": "string" + }, + "port": { + "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.", + "type": "integer", + "format": "int32" + } + } + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)", + "type": "integer", + "format": "int64" + }, + "timeoutSeconds": { + "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.", + "type": "integer", + "format": "int32" + }, + "type": { + "description": "The type of probe.", + "enum": [ + "Liveness", + "Readiness", + "Startup" + ], + "type": "string", + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "ContainerRegistryWithCustomImage": { + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it." + }, + "image": { + "type": "string", + "description": "Full name that the final image should be uploaded as, including both image name and tag." + } + }, + "description": "Container registry that the final image will be uploaded to.", + "required": [ + "server" + ] + }, + "CustomScaleRule": { + "description": "Container App container Custom scaling rule.", + "type": "object", + "properties": { + "type": { + "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe custom scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "CustomDomainConfiguration": { + "type": "object", + "description": "Configuration properties for apps environment custom domain", + "properties": { + "customDomainVerificationId": { + "description": "Id used to verify domain name ownership", + "type": "string", + "readOnly": true + }, + "dnsSuffix": { + "type": "string", + "description": "Dns suffix for the environment domain", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "certificateKeyVaultProperties": { + "description": "Certificate stored in Azure Key Vault.", + "$ref": "#/definitions/CertificateKeyVaultProperties" + }, + "certificateValue": { + "format": "byte", + "description": "PFX or PEM blob", + "type": "string", + "x-ms-secret": true + }, + "certificatePassword": { + "description": "Certificate password", + "type": "string", + "x-ms-secret": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + } + } + }, + "DefaultErrorResponse": { + "description": "App Service error response.", + "type": "object", + "properties": { + "error": { + "description": "Error model.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "details": { + "type": "array", + "description": "Details or the error", + "items": { + "description": "Detailed errors.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "x-ms-identifiers": [ + "code" + ] + }, + "innererror": { + "description": "More information to debug error.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + } + } + }, + "HttpGet": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL to make HTTP GET request against." + }, + "fileName": { + "type": "string", + "description": "Name of the file that the request should be saved to." + }, + "headers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of headers to send with the request." + } + }, + "description": "Model representing a http get request.", + "required": [ + "url" + ] + }, + "HttpScaleRule": { + "description": "Container App container Http scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe http scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the custom scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "PreBuildStep": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Description of the pre-build step." + }, + "scripts": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of custom commands to run." + }, + "httpGet": { + "$ref": "./CommonDefinitions.json#/definitions/HttpGet", + "description": "Http get request to send before the build.", + "x-ms-identifiers": [] + } + }, + "description": "Model representing a pre-build step." + }, + "TcpScaleRule": { + "description": "Container App container Tcp scaling rule.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata properties to describe tcp scale rule.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "auth": { + "description": "Authentication secrets for the tcp scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "QueueScaleRule": { + "description": "Container App container Azure Queue based scaling rule.", + "type": "object", + "properties": { + "accountName": { + "description": "Storage account name. required if using managed identity to authenticate", + "type": "string" + }, + "queueName": { + "description": "Queue name.", + "type": "string" + }, + "queueLength": { + "format": "int32", + "description": "Queue length.", + "type": "integer" + }, + "auth": { + "description": "Authentication secrets for the queue scale rule.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleAuth" + }, + "x-ms-identifiers": [ + "triggerParameter" + ] + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "Scale": { + "description": "Container App scaling configurations.", + "type": "object", + "properties": { + "minReplicas": { + "format": "int32", + "description": "Optional. Minimum number of container replicas.", + "type": "integer" + }, + "maxReplicas": { + "format": "int32", + "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", + "type": "integer", + "default": 10 + }, + "cooldownPeriod": { + "format": "int32", + "description": "Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set.", + "type": "integer" + }, + "pollingInterval": { + "format": "int32", + "description": "Optional. KEDA Polling Interval. Defaults to 30 seconds if not set.", + "type": "integer" + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRule" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ScaleRule": { + "description": "Container App container scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "azureQueue": { + "$ref": "#/definitions/QueueScaleRule", + "description": "Azure Queue based scaling." + }, + "custom": { + "$ref": "#/definitions/CustomScaleRule", + "description": "Custom scale rule." + }, + "http": { + "$ref": "#/definitions/HttpScaleRule", + "description": "HTTP requests based scaling." + }, + "tcp": { + "$ref": "#/definitions/TcpScaleRule", + "description": "Tcp requests based scaling." + } + } + }, + "ScaleRuleAuth": { + "description": "Auth Secrets for Scale Rule", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the secret from which to pull the auth params.", + "type": "string" + }, + "triggerParameter": { + "description": "Trigger Parameter that uses the secret", + "type": "string" + } + } + }, + "Secret": { + "description": "Secret definition.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string" + }, + "keyVaultUrl": { + "description": "Azure Key Vault URL pointing to the secret referenced by the container app.", + "type": "string" + } + } + }, + "Template": { + "description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created", + "type": "object", + "properties": { + "revisionSuffix": { + "description": "User friendly suffix that is appended to the revision name", + "type": "string" + }, + "terminationGracePeriodSeconds": { + "description": "Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.", + "format": "int64", + "type": "integer" + }, + "initContainers": { + "description": "List of specialized containers that run before app containers.", + "type": "array", + "items": { + "$ref": "#/definitions/InitContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "description": "List of container definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scale": { + "$ref": "#/definitions/Scale", + "description": "Scaling properties for the Container App." + }, + "volumes": { + "description": "List of volume definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "serviceBinds": { + "description": "List of container app services bound to the app", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Volume": { + "description": "Volume definitions for the Container App.", + "type": "object", + "properties": { + "name": { + "description": "Volume name.", + "type": "string" + }, + "storageType": { + "description": "Storage type for the volume. If not provided, use EmptyDir.", + "enum": [ + "AzureFile", + "EmptyDir", + "Secret", + "NfsAzureFile", + "Smb" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageName": { + "description": "Name of storage resource. No need to provide for EmptyDir and Secret.", + "type": "string" + }, + "secrets": { + "description": "List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.", + "type": "array", + "items": { + "$ref": "#/definitions/SecretVolumeItem" + }, + "x-ms-identifiers": [ + "secretRef" + ] + }, + "mountOptions": { + "description": "Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string.", + "type": "string" + } + } + }, + "SecretVolumeItem": { + "description": "Secret to be added to volume.", + "type": "object", + "properties": { + "secretRef": { + "description": "Name of the Container App secret from which to pull the secret value.", + "type": "string" + }, + "path": { + "description": "Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.", + "type": "string" + } + } + }, + "VolumeMount": { + "description": "Volume mount for the Container App.", + "type": "object", + "properties": { + "volumeName": { + "description": "This must match the Name of a Volume.", + "type": "string" + }, + "mountPath": { + "description": "Path within the container at which the volume should be mounted.Must not contain ':'.", + "type": "string" + }, + "subPath": { + "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root).", + "type": "string" + } + } + }, + "DaprComponentsCollection": { + "description": "Dapr Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprComponent": { + "description": "Dapr Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr Component resource specific properties", + "type": "object", + "properties": { + "componentType": { + "description": "Component type", + "type": "string" + }, + "version": { + "description": "Component version", + "type": "string" + }, + "ignoreErrors": { + "description": "Boolean describing if the component errors are ignores", + "type": "boolean", + "default": false + }, + "initTimeout": { + "description": "Initialization timeout", + "type": "string" + }, + "secrets": { + "description": "Collection of secrets used by a Dapr component", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "secretStoreComponent": { + "description": "Name of a Dapr component to retrieve component secrets from", + "type": "string" + }, + "metadata": { + "description": "Component metadata", + "type": "array", + "items": { + "$ref": "#/definitions/DaprMetadata" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "scopes": { + "description": "Names of container apps that can use this Dapr component", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceComponentBind": { + "description": "List of container app services that are bound to the Dapr component", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponentServiceBinding" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprMetadata": { + "description": "Dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Metadata property name.", + "type": "string" + }, + "value": { + "description": "Metadata property value.", + "type": "string" + }, + "secretRef": { + "description": "Name of the Dapr Component secret from which to pull the metadata property value.", + "type": "string" + } + } + }, + "DaprComponentServiceBinding": { + "description": "Configuration to bind a Dapr Component to a dev ContainerApp Service", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "type": "string" + }, + "metadata": { + "description": "Service bind metadata", + "type": "array", + "$ref": "#/definitions/DaprServiceBindMetadata" + } + } + }, + "DaprServiceBindMetadata": { + "description": "Dapr component metadata.", + "type": "object", + "properties": { + "name": { + "description": "Service bind metadata property name.", + "type": "string" + }, + "value": { + "description": "Service bind metadata property value.", + "type": "string" + } + } + }, + "DaprSecretsCollection": { + "description": "Dapr component Secrets Collection for ListSecrets Action.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of secrets used by a Dapr component", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DaprSecret": { + "description": "Dapr component Secret for ListSecrets Action", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + } + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationType", + "description": "The type of the extended location." + } + } + }, + "DaprComponentResiliencyPoliciesCollection": { + "description": "Dapr Component Resiliency Policies ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprComponentResiliencyPolicy" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprComponentResiliencyPolicy": { + "description": "Dapr Component Resiliency Policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr Component Resiliency Policy resource specific properties", + "type": "object", + "properties": { + "inboundPolicy": { + "description": "The optional inbound component resiliency policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyConfiguration" + }, + "outboundPolicy": { + "description": "The optional outbound component resiliency policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyConfiguration" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprComponentResiliencyPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Configuration.", + "type": "object", + "properties": { + "httpRetryPolicy": { + "description": "The optional HTTP retry policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration" + }, + "timeoutPolicy": { + "description": "The optional timeout policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyTimeoutPolicyConfiguration" + }, + "circuitBreakerPolicy": { + "description": "The optional circuit breaker policy configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.", + "type": "object", + "properties": { + "consecutiveErrors": { + "description": "The number of consecutive errors before the circuit is opened.", + "type": "integer", + "format": "int32" + }, + "timeoutInSeconds": { + "description": "The interval in seconds until a retry attempt is made after the circuit is opened.", + "type": "integer", + "format": "int32" + }, + "intervalInSeconds": { + "description": "The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used.", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy HTTP Retry Policy Configuration.", + "type": "object", + "properties": { + "maxRetries": { + "description": "The optional maximum number of retries", + "type": "integer", + "format": "int32" + }, + "retryBackOff": { + "description": "The optional retry backoff configuration", + "$ref": "#/definitions/DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration": { + "description": "Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.", + "type": "object", + "properties": { + "initialDelayInMilliseconds": { + "description": "The optional initial delay in milliseconds before an operation is retried", + "type": "integer", + "format": "int32" + }, + "maxIntervalInMilliseconds": { + "description": "The optional maximum time interval in milliseconds between retry attempts", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprComponentResiliencyPolicyTimeoutPolicyConfiguration": { + "description": "Dapr Component Resiliency Policy Timeout Policy Configuration.", + "type": "object", + "properties": { + "responseTimeoutInSeconds": { + "description": "The optional response timeout in seconds", + "type": "integer", + "format": "int32" + } + }, + "additionalProperties": false + }, + "DaprSubscriptionsCollection": { + "description": "Dapr Subscriptions ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprSubscription" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "DaprSubscription": { + "description": "Dapr PubSub Event Subscription.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Dapr PubSub Event Subscription resource specific properties", + "type": "object", + "properties": { + "pubsubName": { + "description": "Dapr PubSub component name", + "type": "string" + }, + "topic": { + "description": "Topic name", + "type": "string" + }, + "deadLetterTopic": { + "description": "Deadletter topic name", + "type": "string" + }, + "routes": { + "description": "Subscription routes", + "$ref": "#/definitions/DaprSubscriptionRoutes" + }, + "scopes": { + "description": "Application scopes to restrict the subscription to specific apps.", + "type": "array", + "items": { + "type": "string" + } + }, + "metadata": { + "description": "Subscription metadata", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "bulkSubscribe": { + "description": "Bulk subscription options", + "$ref": "#/definitions/DaprSubscriptionBulkSubscribeOptions" + } + }, + "x-ms-client-flatten": true + } + } + }, + "DaprSubscriptionBulkSubscribeOptions": { + "description": "Dapr PubSub Bulk Subscription Options.", + "type": "object", + "properties": { + "enabled": { + "description": "Enable bulk subscription", + "type": "boolean", + "default": false + }, + "maxMessagesCount": { + "description": "Maximum number of messages to deliver in a bulk message.", + "type": "integer", + "format": "int32" + }, + "maxAwaitDurationMs": { + "description": "Maximum duration in milliseconds to wait before a bulk message is sent to the app.", + "type": "integer", + "format": "int32" + } + } + }, + "DaprSubscriptionRoutes": { + "description": "Dapr PubSub Event Subscription Routes configuration.", + "type": "object", + "properties": { + "rules": { + "description": "The list of Dapr PubSub Event Subscription Route Rules.", + "type": "array", + "items": { + "$ref": "#/definitions/DaprSubscriptionRouteRule" + }, + "x-ms-identifiers": [] + }, + "default": { + "description": "The default path to deliver events that do not match any of the rules.", + "type": "string" + } + }, + "additionalProperties": false + }, + "DaprSubscriptionRouteRule": { + "description": "Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.", + "type": "object", + "properties": { + "match": { + "description": "The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list.", + "type": "string" + }, + "path": { + "description": "The path for events that match this rule", + "type": "string" + } + } + }, + "ExtendedLocationType": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true + } + }, + "AzureFileProperties": { + "description": "Azure File Properties.", + "type": "object", + "properties": { + "accountName": { + "description": "Storage account name for azure file.", + "type": "string" + }, + "accountKey": { + "description": "Storage account key for azure file.", + "type": "string", + "x-ms-secret": true + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "shareName": { + "description": "Azure file share name.", + "type": "string" + } + } + }, + "NfsAzureFileProperties": { + "description": "NFS Azure File Properties.", + "type": "object", + "properties": { + "server": { + "description": "Server for NFS azure file.", + "type": "string" + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + }, + "shareName": { + "description": "NFS Azure file share name.", + "type": "string" + } + } + }, + "SmbStorage": { + "description": "SMB storage properties", + "type": "object", + "properties": { + "host": { + "description": "The host name or IP address of the SMB server.", + "type": "string" + }, + "shareName": { + "description": "The path to the SMB shared folder.", + "type": "string" + }, + "username": { + "description": "The user to log on to the SMB server.", + "type": "string" + }, + "domain": { + "description": "The domain name for the user.", + "type": "string" + }, + "password": { + "description": "The password for the user.", + "type": "string", + "x-ms-secret": true + }, + "accessMode": { + "description": "Access mode for storage", + "enum": [ + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessMode", + "modelAsString": true + } + } + } + }, + "CertificateKeyVaultProperties": { + "description": "Properties for a certificate stored in a Key Vault.", + "type": "object", + "properties": { + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string" + }, + "keyVaultUrl": { + "description": "URL pointing to the Azure Key Vault secret that holds the certificate.", + "type": "string" + } + } + }, + "Certificate": { + "description": "Certificate used for Custom Domain bindings of Container Apps in a Managed Environment", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Certificate resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the certificate.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "DeleteFailed", + "Pending" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": true + } + }, + "certificateKeyVaultProperties": { + "description": "Properties for a certificate stored in a Key Vault.", + "$ref": "#/definitions/CertificateKeyVaultProperties" + }, + "password": { + "description": "Certificate password.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string", + "readOnly": true + }, + "subjectAlternativeNames": { + "description": "Subject alternative names the certificate applies to.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "value": { + "format": "byte", + "description": "PFX or PEM blob", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "issuer": { + "description": "Certificate issuer.", + "type": "string", + "readOnly": true + }, + "issueDate": { + "format": "date-time", + "description": "Certificate issue Date.", + "type": "string", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "Certificate expiration date.", + "type": "string", + "readOnly": true + }, + "thumbprint": { + "description": "Certificate thumbprint.", + "type": "string", + "readOnly": true + }, + "valid": { + "description": "Is the certificate valid?.", + "type": "boolean", + "readOnly": true + }, + "publicKeyHash": { + "description": "Public key hash.", + "type": "string", + "readOnly": true + }, + "certificateType": { + "description": "The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`", + "type": "string", + "enum": [ + "ServerSSLCertificate", + "ImagePullTrustedCA" + ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true + } + } + } + } + }, + "x-ms-client-flatten": true + }, + "CertificateCollection": { + "description": "Collection of Certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "CertificatePatch": { + "description": "A certificate to update", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + } + }, + "ManagedCertificate": { + "description": "Managed certificates used for Custom Domain bindings of Container Apps in a Managed Environment", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Certificate resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the certificate.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "DeleteFailed", + "Pending" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": true + } + }, + "subjectName": { + "description": "Subject name of the certificate.", + "type": "string" + }, + "error": { + "description": "Any error occurred during the certificate provision.", + "type": "string", + "readOnly": true + }, + "domainControlValidation": { + "description": "Selected type of domain control validation for managed certificates.", + "enum": [ + "CNAME", + "HTTP", + "TXT" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedCertificateDomainControlValidation", + "modelAsString": true + } + }, + "validationToken": { + "description": "A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates.", + "type": "string", + "readOnly": true + } + } + } + }, + "x-ms-client-flatten": true + }, + "ManagedCertificatePatch": { + "description": "A managed certificate to update", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Application-specific metadata in the form of key-value pairs." + } + } + }, + "ManagedCertificateCollection": { + "description": "Collection of Managed Certificates.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCertificate" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "JobTemplate": { + "description": "Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created", + "type": "object", + "properties": { + "initContainers": { + "description": "List of specialized containers that run before app containers.", + "type": "array", + "items": { + "$ref": "#/definitions/InitContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "containers": { + "description": "List of container definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "volumes": { + "description": "List of volume definitions for the Container App.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ServiceBind": { + "description": "Configuration to bind a ContainerApp to a dev ContainerApp Service", + "type": "object", + "properties": { + "serviceId": { + "description": "Resource id of the target service", + "type": "string" + }, + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "clientType": { + "description": "Type of the client to be used to connect to the service", + "type": "string" + }, + "customizedKeys": { + "description": "Customized keys for customizing injected values to the app", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AppResiliencyCollection": { + "description": "Collection of AppResiliency policies", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/AppResiliency" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "AppResiliency": { + "description": "Configuration to setup App Resiliency", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "type": "object", + "description": "App Resiliency resource specific properties", + "properties": { + "timeoutPolicy": { + "description": "Policy to set request timeouts", + "$ref": "#/definitions/TimeoutPolicy" + }, + "httpRetryPolicy": { + "description": "Policy that defines http request retry conditions", + "$ref": "#/definitions/HttpRetryPolicy" + }, + "tcpRetryPolicy": { + "description": "Policy that defines tcp request retry conditions", + "$ref": "#/definitions/TcpRetryPolicy" + }, + "circuitBreakerPolicy": { + "description": "Policy that defines circuit breaker conditions", + "$ref": "#/definitions/CircuitBreakerPolicy" + }, + "httpConnectionPool": { + "description": "Defines parameters for http connection pooling", + "$ref": "#/definitions/HttpConnectionPool" + }, + "tcpConnectionPool": { + "description": "Defines parameters for tcp connection pooling", + "$ref": "#/definitions/TcpConnectionPool" + } + }, + "x-ms-client-flatten": true + } + } + }, + "TimeoutPolicy": { + "description": "Policy to set request timeouts", + "type": "object", + "properties": { + "responseTimeoutInSeconds": { + "description": "Timeout, in seconds, for a request to respond", + "format": "int32", + "type": "integer" + }, + "connectionTimeoutInSeconds": { + "description": "Timeout, in seconds, for a request to initiate a connection", + "format": "int32", + "type": "integer" + } + } + }, + "HttpRetryPolicy": { + "description": "Policy that defines http request retry conditions", + "type": "object", + "properties": { + "maxRetries": { + "description": "Maximum number of times a request will retry", + "format": "int32", + "type": "integer" + }, + "retryBackOff": { + "description": "Settings for retry backoff characteristics", + "type": "object", + "properties": { + "initialDelayInMilliseconds": { + "description": "Initial delay, in milliseconds, before retrying a request", + "format": "int64", + "type": "integer" + }, + "maxIntervalInMilliseconds": { + "description": "Maximum interval, in milliseconds, between retries", + "format": "int64", + "type": "integer" + } + }, + "x-ms-client-flatten": true + }, + "matches": { + "description": "Conditions that must be met for a request to be retried", + "type": "object", + "properties": { + "headers": { + "description": "Headers that must be present for a request to be retried", + "type": "array", + "items": { + "$ref": "#/definitions/HeaderMatch" + }, + "x-ms-identifiers": [ + "header" + ] + }, + "httpStatusCodes": { + "description": "Additional http status codes that can trigger a retry", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "x-ms-identifiers": [] + }, + "errors": { + "description": "Errors that can trigger a retry", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-client-flatten": true + } + }, + "x-ms-client-flatten": true + }, + "TcpRetryPolicy": { + "description": "Policy that defines tcp request retry conditions", + "type": "object", + "properties": { + "maxConnectAttempts": { + "description": "Maximum number of attempts to connect to the tcp service", + "format": "int32", + "type": "integer" + } + } + }, + "CircuitBreakerPolicy": { + "description": "Policy that defines circuit breaker conditions", + "type": "object", + "properties": { + "consecutiveErrors": { + "description": "Number of consecutive errors before the circuit breaker opens", + "format": "int32", + "type": "integer" + }, + "intervalInSeconds": { + "description": "The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s.", + "format": "int32", + "type": "integer" + }, + "maxEjectionPercent": { + "description": "Maximum percentage of hosts that will be ejected after failure threshold has been met", + "format": "int32", + "type": "integer" + } + } + }, + "HttpConnectionPool": { + "description": "Defines parameters for http connection pooling", + "type": "object", + "properties": { + "http1MaxPendingRequests": { + "description": "Maximum number of pending http1 requests allowed", + "format": "int32", + "type": "integer" + }, + "http2MaxRequests": { + "description": "Maximum number of http2 requests allowed", + "format": "int32", + "type": "integer" + } + } + }, + "TcpConnectionPool": { + "description": "Defines parameters for tcp connection pooling", + "type": "object", + "properties": { + "maxConnections": { + "description": "Maximum number of tcp connections allowed", + "format": "int32", + "type": "integer" + } + } + }, + "HeaderMatch": { + "description": "Conditions required to match a header", + "type": "object", + "properties": { + "header": { + "description": "Name of the header", + "type": "string" + }, + "match": { + "description": "Type of match to perform", + "type": "object", + "properties": { + "exactMatch": { + "description": "Exact value of the header", + "type": "string" + }, + "prefixMatch": { + "description": "Prefix value of the header", + "type": "string" + }, + "suffixMatch": { + "description": "Suffix value of the header", + "type": "string" + }, + "regexMatch": { + "description": "Regex value of the header", + "type": "string" + } + }, + "x-ms-client-flatten": true + } + } + }, + "EnvironmentVariable": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Environment variable name." + }, + "value": { + "type": "string", + "description": "Environment variable value." + } + }, + "description": "Model representing an environment variable.", + "required": [ + "name", + "value" + ] + }, + "PrivateEndpoint": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "format": "arm-id", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "properties": { + "groupIds": { + "description": "The group ids for the private endpoint resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the private endpoint connection." + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "Updating", + "Deleting", + "Pending" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "List of private endpoint connection associated with the specified resource" + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "URL to get the next set of operation list results (if there are any).", + "readOnly": true + } + }, + "description": "A list of private link resources" + }, + "IdentitySettings": { + "description": "Optional settings for a Managed Identity that is assigned to the Container App.", + "type": "object", + "required": [ + "identity" + ], + "properties": { + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity.", + "type": "string" + }, + "lifecycle": { + "description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.", + "enum": [ + "Init", + "Main", + "None", + "All" + ], + "type": "string", + "default": "All", + "x-ms-enum": { + "name": "IdentitySettingsLifeCycle", + "modelAsString": true + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironments.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironments.json new file mode 100644 index 000000000000..16a52485877b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironments.json @@ -0,0 +1,469 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/connectedEnvironments": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Get all connectedEnvironments for a subscription.", + "description": "Get all connectedEnvironments for a subscription.", + "operationId": "ConnectedEnvironments_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List connected environments by subscription": { + "$ref": "./examples/ConnectedEnvironments_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "operationId": "ConnectedEnvironments_ListByResourceGroup", + "description": "Get all connectedEnvironments in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by resource group": { + "$ref": "./examples/ConnectedEnvironments_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}": { + "get": { + "tags": [ + "ConnectedEnvironments" + ], + "operationId": "ConnectedEnvironments_Get", + "description": "Get the properties of an connectedEnvironment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connected environment by connectedEnvironmentName": { + "$ref": "./examples/ConnectedEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironments" + ], + "description": "Creates or updates an connectedEnvironment.", + "operationId": "ConnectedEnvironments_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the connectedEnvironment.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create kube environments": { + "$ref": "./examples/ConnectedEnvironments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Delete an connectedEnvironment.", + "description": "Delete an connectedEnvironment.", + "operationId": "ConnectedEnvironments_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "202": { + "description": "Delete operation is accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "ConnectedEnvironment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connected environment by connectedEnvironmentName": { + "$ref": "./examples/ConnectedEnvironments_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Update connected Environment's properties.", + "description": "Patches a Managed Environment. Only patching of tags is supported currently", + "operationId": "ConnectedEnvironments_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connectedEnvironment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Environment": { + "$ref": "./examples/ConnectedEnvironments_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability": { + "post": { + "tags": [ + "ConnectedEnvironments" + ], + "summary": "Checks the resource connectedEnvironmentName availability.", + "description": "Checks if resource connectedEnvironmentName is available.", + "operationId": "ConnectedEnvironments_CheckNameAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityRequest", + "in": "body", + "description": "The check connectedEnvironmentName availability request.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_CheckNameAvailability": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json" + } + } + } + } + }, + "definitions": { + "ConnectedEnvironment": { + "description": "An environment for Kubernetes cluster specialized for web workloads by Azure App Service", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "properties": { + "description": "ConnectedEnvironment resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Kubernetes Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ConnectedEnvironmentProvisioningState", + "modelAsString": true + } + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the connectedEnvironment", + "type": "string" + }, + "daprAIConnectionString": { + "type": "string", + "description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "customDomainConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDomainConfiguration", + "description": "Custom domain configuration for the environment" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ConnectedEnvironmentCollection": { + "description": "Collection of connectedEnvironments", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsCertificates.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsCertificates.json new file mode 100644 index 000000000000..a31019143a0a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsCertificates.json @@ -0,0 +1,315 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates": { + "get": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Get the Certificates in a given connected environment.", + "operationId": "ConnectedEnvironmentsCertificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates by Connected Environment": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Get the specified Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Create or Update a Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Deletes the specified Certificate.", + "operationId": "ConnectedEnvironmentsCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ConnectedEnvironments", + "Certificates" + ], + "summary": "Update properties of a certificate", + "description": "Patches a certificate. Currently only patching of tags is supported", + "operationId": "ConnectedEnvironmentsCertificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Connected Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Certificate": { + "$ref": "./examples/ConnectedEnvironmentsCertificates_Patch.json" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsDaprComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsDaprComponents.json new file mode 100644 index 000000000000..0534ec7cda8b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsDaprComponents.json @@ -0,0 +1,307 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get the Dapr Components for a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr Components": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get a dapr component.", + "operationId": "ConnectedEnvironmentsDaprComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr Component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_Get.json" + } + } + }, + "put": { + "tags": [ + "DaprComponents" + ], + "summary": "Creates or updates a Dapr Component.", + "description": "Creates or updates a Dapr Component in a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponents" + ], + "summary": "Delete a Dapr Component.", + "description": "Delete a Dapr Component from a connected environment.", + "operationId": "ConnectedEnvironmentsDaprComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/daprComponents/{componentName}/listSecrets": { + "post": { + "tags": [ + "DaprComponents" + ], + "summary": "List secrets for a dapr component", + "operationId": "ConnectedEnvironmentsDaprComponents_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the connected environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsStorages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsStorages.json new file mode 100644 index 000000000000..102a9b184f2d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsStorages.json @@ -0,0 +1,294 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages": { + "get": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Get all storages for a connectedEnvironment.", + "description": "Get all storages for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStoragesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/storages/{storageName}": { + "get": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Get storage for a connectedEnvironment.", + "description": "Get storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "get a environments storage properties by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_Get.json" + } + } + }, + "put": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Create or update storage for a connectedEnvironment.", + "description": "Create or update storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "name": "storageEnvelope", + "in": "body", + "description": "Configuration details of storage.", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update environments storage": { + "$ref": "./examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConnectedEnvironmentsStorages" + ], + "summary": "Delete storage for a connectedEnvironment.", + "description": "Delete storage for a connectedEnvironment.", + "operationId": "ConnectedEnvironmentsStorages_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "connectedEnvironmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Storage does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ConnectedEnvironmentsStorages_Delete.json" + } + } + } + } + }, + "definitions": { + "ConnectedEnvironmentStoragesCollection": { + "description": "Collection of Storage for Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of storage resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectedEnvironmentStorage" + } + } + } + }, + "ConnectedEnvironmentStorage": { + "description": "Storage resource for connectedEnvironment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Storage properties", + "type": "object", + "properties": { + "azureFile": { + "$ref": "./CommonDefinitions.json#/definitions/AzureFileProperties", + "description": "Azure file properties" + }, + "smb": { + "$ref": "./CommonDefinitions.json#/definitions/SmbStorage", + "description": "SMB storage properties" + } + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerApps.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerApps.json new file mode 100644 index 000000000000..b7d351db2ae8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerApps.json @@ -0,0 +1,1554 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given subscription.", + "operationId": "ContainerApps_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by subscription": { + "$ref": "./examples/ContainerApps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the Container Apps in a given resource group.", + "operationId": "ContainerApps_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps by resource group": { + "$ref": "./examples/ContainerApps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}": { + "get": { + "tags": [ + "ContainerApps" + ], + "summary": "Get the properties of a Container App.", + "operationId": "ContainerApps_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App": { + "$ref": "./examples/ContainerApps_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerApps" + ], + "summary": "Create or update a Container App.", + "description": "Create or update a Container App.", + "operationId": "ContainerApps_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "containerAppEnvelope", + "in": "body", + "description": "Properties used to create a container app", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "No change performed on the Container App.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "201": { + "description": "Container App create or update has been started.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App": { + "$ref": "./examples/ContainerApps_CreateOrUpdate.json" + }, + "Create or Update Tcp App": { + "$ref": "./examples/ContainerApps_TcpApp_CreateOrUpdate.json" + }, + "Create or Update ManagedBy App": { + "$ref": "./examples/ContainerApps_ManagedBy_CreateOrUpdate.json" + }, + "Create or Update App Kind": { + "$ref": "./examples/ContainerApps_Kind_CreateOrUpdate.json" + }, + "Create or Update App On A Connected Environment": { + "$ref": "./examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json" + }, + "Create or Update SourceToCloud App": { + "$ref": "./examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "ContainerApps" + ], + "summary": "Delete a Container App.", + "description": "Delete a Container App.", + "operationId": "ContainerApps_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App deleted successfully." + }, + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Container App does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App": { + "$ref": "./examples/ContainerApps_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "ContainerApps" + ], + "summary": "Update properties of a Container App", + "description": "Patches a Container App using JSON Merge Patch", + "operationId": "ContainerApps_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "containerAppEnvelope", + "in": "body", + "required": true, + "description": "Properties of a Container App that need to be updated", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Container App": { + "$ref": "./examples/ContainerApps_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listCustomHostNameAnalysis": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Analyzes a custom hostname for a Container App", + "operationId": "ContainerApps_ListCustomHostNameAnalysis", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "customHostname", + "in": "query", + "description": "Custom hostname.", + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomHostnameAnalysisResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze Custom Hostname": { + "$ref": "./examples/ContainerApps_ListCustomHostNameAnalysis.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/listSecrets": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "List secrets for a container app", + "operationId": "ContainerApps_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/ContainerApps_ListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/getAuthtoken": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Get auth token for a container app", + "operationId": "ContainerApps_GetAuthToken", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppAuthToken" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App Auth Token": { + "$ref": "./examples/ContainerApps_GetAuthToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/start": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Start a container app", + "operationId": "ContainerApps_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Container App started successfully.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Start operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start Container App": { + "$ref": "./examples/ContainerApps_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/stop": { + "post": { + "tags": [ + "ContainerApps" + ], + "summary": "Stop a container app", + "operationId": "ContainerApps_Stop", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Container App stopped successfully.", + "schema": { + "$ref": "#/definitions/ContainerApp" + } + }, + "202": { + "description": "Stop operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop Container App": { + "$ref": "./examples/ContainerApps_Stop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "Configuration": { + "description": "Non versioned Container App configuration properties that define the mutable settings of a Container app", + "type": "object", + "properties": { + "secrets": { + "description": "Collection of secrets used by a Container app", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "activeRevisionsMode": { + "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n<list><item>Multiple: multiple revisions can be active.</item><item>Single: Only one revision can be active at a time. Revision weights can not be used in this mode. If no value if provided, this is the default.</item></list>", + "enum": [ + "Multiple", + "Single" + ], + "type": "string", + "default": "Single", + "x-ms-enum": { + "name": "ActiveRevisionsMode", + "modelAsString": true + } + }, + "ingress": { + "$ref": "#/definitions/Ingress", + "description": "Ingress configurations." + }, + "registries": { + "description": "Collection of private container registry credentials for containers used by the Container app", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryCredentials" + }, + "x-ms-identifiers": [ + "server" + ] + }, + "dapr": { + "$ref": "#/definitions/Dapr", + "description": "Dapr configuration for the Container App." + }, + "runtime": { + "$ref": "#/definitions/Runtime", + "description": "App runtime configuration for the Container App." + }, + "maxInactiveRevisions": { + "format": "int32", + "description": "Optional. Max inactive revisions a Container App can have.", + "type": "integer" + }, + "service": { + "$ref": "#/definitions/Service", + "description": "Container App to be a dev Container App Service" + }, + "identitySettings": { + "description": "Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/IdentitySettings" + }, + "x-ms-identifiers": [ + "identity" + ] + } + } + }, + "ContainerApp": { + "description": "Container App.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "managed identities for the Container App to interact with other Azure services without maintaining any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "managedBy": { + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource." + }, + "kind": { + "type": "string", + "enum": [ + "workflowapp" + ], + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "description": "Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value." + }, + "properties": { + "description": "ContainerApp resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Container App.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppProvisioningState", + "modelAsString": true + } + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment", + "type": "string", + "readOnly": true + }, + "managedEnvironmentId": { + "description": "Deprecated. Resource ID of the Container App's environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workloadProfileName": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile name to pin for container app execution." + }, + "patchingConfiguration": { + "description": "Container App auto patch configuration.", + "type": "object", + "properties": { + "patchingMode": { + "description": "Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching.", + "type": "string", + "enum": [ + "Automatic", + "Manual", + "Disabled" + ], + "x-ms-enum": { + "name": "patchingMode", + "modelAsString": true + } + } + } + }, + "latestRevisionName": { + "description": "Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "latestReadyRevisionName": { + "description": "Name of the latest ready revision of the Container App.", + "type": "string", + "readOnly": true + }, + "latestRevisionFqdn": { + "description": "Fully Qualified Domain Name of the latest revision of the Container App.", + "type": "string", + "readOnly": true + }, + "customDomainVerificationId": { + "description": "Id used to verify domain name ownership", + "type": "string", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/Configuration", + "description": "Non versioned Container App configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App versioned application definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses for container app.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container app.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "ContainerAppCollection": { + "description": "Container App collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerApp" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Dapr": { + "description": "Container App Dapr configuration.", + "type": "object", + "properties": { + "enabled": { + "description": "Boolean indicating if the Dapr side car is enabled", + "type": "boolean", + "default": false + }, + "appId": { + "description": "Dapr application identifier", + "type": "string" + }, + "appProtocol": { + "description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http", + "enum": [ + "http", + "grpc" + ], + "type": "string", + "default": "http", + "x-ms-enum": { + "name": "appProtocol", + "modelAsString": true + } + }, + "appPort": { + "format": "int32", + "description": "Tells Dapr which port your application is listening on", + "type": "integer" + }, + "httpReadBufferSize": { + "type": "integer", + "description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.", + "format": "int32" + }, + "httpMaxRequestSize": { + "type": "integer", + "description": "Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB.", + "format": "int32" + }, + "logLevel": { + "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.", + "enum": [ + "info", + "debug", + "warn", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "logLevel", + "modelAsString": true + } + }, + "enableApiLogging": { + "description": "Enables API logging for the Dapr sidecar", + "type": "boolean" + } + } + }, + "Runtime": { + "description": "Container App Runtime configuration.", + "type": "object", + "properties": { + "java": { + "description": "Java app configuration", + "type": "object", + "properties": { + "enableMetrics": { + "description": "Enable jmx core metrics for the java app", + "type": "boolean" + }, + "javaAgent": { + "description": "Diagnostic capabilities achieved by java agent", + "type": "object", + "properties": { + "enabled": { + "description": "Enable java agent injection for the java app.", + "type": "boolean" + }, + "logging": { + "description": "Capabilities on the java logging scenario.", + "type": "object", + "properties": { + "loggerSettings": { + "description": "Settings of the logger for the java app.", + "type": "array", + "items": { + "$ref": "#/definitions/LoggerSetting" + }, + "x-ms-identifiers": [ + "logger", + "level" + ] + } + } + } + } + } + } + }, + "dotnet": { + "description": ".NET app configuration", + "type": "object", + "properties": { + "autoConfigureDataProtection": { + "description": "Auto configure the ASP.NET Core Data Protection feature", + "type": "boolean" + } + } + } + } + }, + "LoggerSetting": { + "description": "Logger settings for java workloads.", + "type": "object", + "required": [ + "logger", + "level" + ], + "properties": { + "logger": { + "description": "Logger name.", + "type": "string" + }, + "level": { + "description": "The specified logger's log level.", + "enum": [ + "off", + "error", + "info", + "debug", + "trace", + "warn" + ], + "type": "string", + "x-ms-enum": { + "name": "level", + "modelAsString": true + } + } + } + }, + "Ingress": { + "description": "Container App Ingress configuration.", + "type": "object", + "properties": { + "fqdn": { + "description": "Hostname.", + "type": "string", + "readOnly": true + }, + "external": { + "description": "Bool indicating if app exposes an external http endpoint", + "default": false, + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Target Port in containers for traffic from ingress", + "type": "integer" + }, + "exposedPort": { + "format": "int32", + "description": "Exposed Port in containers for TCP traffic from ingress", + "type": "integer" + }, + "transport": { + "description": "Ingress transport protocol", + "enum": [ + "auto", + "http", + "http2", + "tcp" + ], + "type": "string", + "default": "auto", + "x-ms-enum": { + "name": "IngressTransportMethod", + "modelAsString": true + } + }, + "traffic": { + "description": "Traffic weights for app's revisions", + "type": "array", + "items": { + "$ref": "#/definitions/TrafficWeight" + }, + "x-ms-identifiers": [ + "revisionName" + ] + }, + "customDomains": { + "description": "custom domain bindings for Container Apps' hostnames.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomDomain" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "allowInsecure": { + "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", + "type": "boolean", + "default": false + }, + "ipSecurityRestrictions": { + "description": "Rules to restrict incoming IP address.", + "type": "array", + "items": { + "$ref": "#/definitions/IpSecurityRestrictionRule" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "stickySessions": { + "description": "Sticky Sessions for Single Revision Mode", + "type": "object", + "properties": { + "affinity": { + "description": "Sticky Session Affinity", + "enum": [ + "sticky", + "none" + ], + "type": "string", + "x-ms-enum": { + "name": "affinity", + "modelAsString": true + } + } + } + }, + "clientCertificateMode": { + "description": "Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.", + "enum": [ + "ignore", + "accept", + "require" + ], + "type": "string", + "x-ms-enum": { + "name": "IngressClientCertificateMode", + "modelAsString": true + } + }, + "corsPolicy": { + "description": "CORS policy for container app", + "$ref": "#/definitions/CorsPolicy" + }, + "additionalPortMappings": { + "description": "Settings to expose additional ports on container app", + "type": "array", + "items": { + "$ref": "#/definitions/IngressPortMapping" + }, + "x-ms-identifiers": [ + "targetPort" + ] + }, + "targetPortHttpScheme": { + "description": "Whether an http app listens on http or https", + "enum": [ + "http", + "https" + ], + "type": "string", + "x-ms-enum": { + "name": "IngressTargetPortHttpScheme", + "modelAsString": true + } + } + } + }, + "RegistryCredentials": { + "description": "Container App Private Registry", + "type": "object", + "properties": { + "server": { + "description": "Container Registry Server", + "type": "string" + }, + "username": { + "description": "Container Registry Username", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the Secret that contains the registry login password", + "type": "string" + }, + "identity": { + "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'", + "type": "string" + } + } + }, + "SecretsCollection": { + "description": "Container App Secrets Collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppSecret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ContainerAppSecret": { + "description": "Container App Secret.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "identity": { + "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity.", + "type": "string", + "readOnly": true + }, + "keyVaultUrl": { + "description": "Azure Key Vault URL pointing to the secret referenced by the container app.", + "type": "string", + "readOnly": true + } + } + }, + "TrafficWeight": { + "description": "Traffic weight assigned to a revision", + "type": "object", + "properties": { + "revisionName": { + "description": "Name of a revision", + "type": "string" + }, + "weight": { + "format": "int32", + "description": "Traffic weight assigned to a revision", + "type": "integer" + }, + "latestRevision": { + "description": "Indicates that the traffic weight belongs to a latest stable revision", + "default": false, + "type": "boolean" + }, + "label": { + "description": "Associates a traffic label with a revision", + "type": "string" + } + } + }, + "CustomDomain": { + "description": "Custom Domain of a Container App", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "Hostname.", + "type": "string" + }, + "bindingType": { + "description": "Custom Domain binding type.", + "enum": [ + "Disabled", + "SniEnabled" + ], + "type": "string", + "x-ms-enum": { + "name": "bindingType", + "modelAsString": true + } + }, + "certificateId": { + "description": "Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment.", + "type": "string" + } + } + }, + "IpSecurityRestrictionRule": { + "description": "Rule to restrict incoming IP address.", + "type": "object", + "required": [ + "name", + "ipAddressRange", + "action" + ], + "properties": { + "name": { + "description": "Name for the IP restriction rule.", + "type": "string" + }, + "description": { + "description": "Describe the IP restriction rule that is being sent to the container-app. This is an optional field.", + "type": "string" + }, + "ipAddressRange": { + "description": "CIDR notation to match incoming IP address", + "type": "string" + }, + "action": { + "description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "action", + "modelAsString": true + } + } + } + }, + "CorsPolicy": { + "description": "Cross-Origin-Resource-Sharing policy", + "type": "object", + "required": [ + "allowedOrigins" + ], + "properties": { + "allowedOrigins": { + "description": "Specifies the content for the access-control-allow-origins header", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedMethods": { + "description": "Specifies the content for the access-control-allow-methods header", + "type": "array", + "items": { + "type": "string" + } + }, + "allowedHeaders": { + "description": "Specifies the content for the access-control-allow-headers header", + "type": "array", + "items": { + "type": "string" + } + }, + "exposeHeaders": { + "description": "Specifies the content for the access-control-expose-headers header ", + "type": "array", + "items": { + "type": "string" + } + }, + "maxAge": { + "format": "int32", + "description": "Specifies the content for the access-control-max-age header", + "type": "integer" + }, + "allowCredentials": { + "description": "Specifies whether the resource allows credentials", + "type": "boolean" + } + } + }, + "IngressPortMapping": { + "description": "Port mappings of container app ingress", + "type": "object", + "required": [ + "external", + "targetPort" + ], + "properties": { + "external": { + "description": "Specifies whether the app port is accessible outside of the environment", + "type": "boolean" + }, + "targetPort": { + "format": "int32", + "description": "Specifies the port user's container listens on", + "type": "integer" + }, + "exposedPort": { + "format": "int32", + "description": "Specifies the exposed port for the target port. If not specified, it defaults to target port", + "type": "integer" + } + } + }, + "CustomHostnameAnalysisResult": { + "description": "Custom domain analysis.", + "type": "object", + "properties": { + "hostName": { + "description": "Host name that was analyzed", + "type": "string", + "readOnly": true + }, + "isHostnameAlreadyVerified": { + "description": "<code>true</code> if hostname is already verified; otherwise, <code>false</code>.", + "type": "boolean", + "readOnly": true + }, + "customDomainVerificationTest": { + "description": "DNS verification test result.", + "enum": [ + "Passed", + "Failed", + "Skipped" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DnsVerificationTestResult", + "modelAsString": false + } + }, + "customDomainVerificationFailureInfo": { + "description": "Raw failure information if DNS verification fails.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "details": { + "type": "array", + "description": "Details or the error", + "items": { + "description": "Detailed errors.", + "type": "object", + "properties": { + "code": { + "description": "Standardized string to programmatically identify the error.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Detailed error description and debugging information.", + "type": "string", + "readOnly": true + } + }, + "readOnly": true + }, + "x-ms-identifiers": [ + "code" + ] + } + }, + "readOnly": true + }, + "hasConflictOnManagedEnvironment": { + "description": "<code>true</code> if there is a conflict on the Container App's managed environment; otherwise, <code>false</code>.", + "type": "boolean", + "readOnly": true + }, + "conflictWithEnvironmentCustomDomain": { + "description": "<code>true</code> if there is a conflict on the Container App's managed environment level custom domain; otherwise, <code>false</code>.", + "type": "boolean", + "readOnly": true + }, + "conflictingContainerAppResourceId": { + "description": "Name of the conflicting Container App on the Managed Environment if it's within the same subscription.", + "type": "string", + "readOnly": true + }, + "cNameRecords": { + "description": "CName records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "txtRecords": { + "description": "TXT records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "aRecords": { + "description": "A records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateCNameRecords": { + "description": "Alternate CName records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + }, + "alternateTxtRecords": { + "description": "Alternate TXT records visible for this hostname.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-flatten": true + }, + "ContainerAppAuthToken": { + "description": "Container App Auth Token.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Container App auth token resource specific properties", + "type": "object", + "properties": { + "token": { + "description": "Auth token value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "Service": { + "description": "Container App to be a dev service", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Dev ContainerApp service type", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsBuilds.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsBuilds.json new file mode 100644 index 000000000000..bfec6ad5bb41 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsBuilds.json @@ -0,0 +1,348 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds": { + "get": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuildsByContainerApp_List", + "description": "List Container Apps Build resources by Container App", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsBuildCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerAppsBuilds_ListByContainerApp_0": { + "$ref": "./examples/ContainerAppsBuilds_ListByContainerApp.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/builds/{buildName}": { + "get": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuilds_Get", + "description": "Get a Container Apps Build resource", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsBuildNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsBuildResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsBuilds_Get_0": { + "$ref": "./examples/ContainerAppsBuilds_Get.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsBuilds" + ], + "operationId": "ContainerAppsBuilds_Delete", + "description": "Delete a Container Apps Build resource", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsBuildNameParameter" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsBuilds_Delete_0": { + "$ref": "./examples/ContainerAppsBuilds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ContainerAppsBuildConfiguration": { + "type": "object", + "properties": { + "baseOs": { + "type": "string", + "description": "Base OS used to build and run the app.", + "readOnly": true + }, + "platform": { + "type": "string", + "description": "Platform to be used to build and run the app.", + "readOnly": true + }, + "platformVersion": { + "type": "string", + "description": "Platform version to be used to build and run the app.", + "readOnly": true + }, + "environmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable.", + "readOnly": true + }, + "preBuildSteps": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PreBuildStep" + }, + "x-ms-identifiers": [], + "description": "List of steps to perform before the build.", + "readOnly": true + } + }, + "description": "Configuration of the build." + }, + "ContainerAppsBuildProperties": { + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/BuildProvisioningState", + "description": "Build provisioning state.", + "readOnly": true + }, + "buildStatus": { + "$ref": "#/definitions/BuildStatus", + "description": "Status of the build once it has been provisioned.", + "readOnly": true + }, + "destinationContainerRegistry": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerRegistryWithCustomImage", + "description": "Container registry that the final image will be uploaded to.", + "readOnly": true + }, + "configuration": { + "$ref": "#/definitions/ContainerAppsBuildConfiguration", + "description": "Configuration of the build.", + "readOnly": true + }, + "logStreamEndpoint": { + "type": "string", + "description": "Endpoint from which the build logs can be streamed.", + "readOnly": true + } + }, + "description": "The ContainerAppBuild properties." + }, + "ContainerAppsBuildResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ContainerAppsBuildProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read" + ] + } + }, + "description": "Information pertaining to an individual build.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ContainerAppsBuildCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppsBuildResource" + }, + "description": "The Container Apps Build Resource items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "description": "The response of a Container Apps Build Resource list operation.", + "required": [ + "value" + ] + }, + "BuildStatus": { + "type": "string", + "description": "Status of the build once it has been provisioned.", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "BuildStatus", + "modelAsString": true + }, + "readOnly": true + }, + "BuildProvisioningState": { + "type": "string", + "description": "Resource instance provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Updating", + "Deleting" + ], + "x-ms-enum": { + "name": "BuildProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "parameters": { + "ContainerAppsBuildNameParameter": { + "name": "buildName", + "in": "path", + "required": true, + "description": "The name of a build.", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "ContainerAppsNameParameter": { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App the Build is associated.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsPatches.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsPatches.json new file mode 100644 index 000000000000..5e17b399a50d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsPatches.json @@ -0,0 +1,555 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches": { + "get": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_ListByContainerApp", + "description": "List Container Apps Patch resources by ContainerApp.", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation. For example, $filter=properties/patchApplyStatus eq 'Succeeded'", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PatchCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerAppsPatches_ListByContainerApp_0": { + "$ref": "./examples/ContainerAppsPatches_ListByContainerApp.json" + } + }, + "x-ms-odata": "#/definitions/ContainerAppsContainerAppsPatchResource" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}": { + "get": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Get", + "description": "Get details for specific Container Apps Patch by patch name.", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "200": { + "description": "Patch information retrieved successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerAppsPatches_Get_0": { + "$ref": "./examples/ContainerAppsPatches_Get.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Delete", + "description": "Delete specific Container Apps Patch by patch name.", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "202": { + "description": "Patch deletion has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Patch does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Delete_0": { + "$ref": "./examples/ContainerAppsPatches_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/skipConfig": { + "post": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_SkipConfigure", + "description": "Configure the Container Apps Patch skip option by patch name.", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + }, + { + "name": "patchSkipConfig", + "in": "body", + "required": true, + "description": "Configure patcher to skip a patch or not.", + "schema": { + "$ref": "#/definitions/PatchSkipConfig" + } + } + ], + "responses": { + "202": { + "description": "Updating patch skipping detail. Updating status tracked by location header.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Skip_Configure_0": { + "$ref": "./examples/ContainerAppsPatches_Skip_Configure.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/patches/{patchName}/apply": { + "post": { + "tags": [ + "ContainerAppsPatches" + ], + "operationId": "ContainerAppsPatches_Apply", + "description": "Apply a Container Apps Patch resource with patch name.", + "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" + }, + { + "$ref": "#/parameters/ContainerAppsNameParameter" + }, + { + "$ref": "#/parameters/ContainerAppsPatchNameParameter" + } + ], + "responses": { + "200": { + "description": "Patching operation completed successfully.", + "schema": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "202": { + "description": "Patching operation has been started.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerAppsPatches_Apply_0": { + "$ref": "./examples/ContainerAppsPatches_Apply.json" + } + } + } + } + }, + "definitions": { + "ContainerAppsPatchResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PatchProperties", + "description": "Properties that describes current states of the patch resource.", + "x-ms-mutability": [ + "read", + "update" + ] + } + }, + "description": "Container App Patch", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PatchApplyStatus": { + "type": "string", + "description": "The status of the patch once it has been provisioned", + "enum": [ + "NotStarted", + "RebaseInProgress", + "CreatingRevision", + "Succeeded", + "Canceled", + "RebaseFailed", + "RevisionCreationFailed", + "ImagePushPullFailed", + "ManuallySkipped" + ], + "x-ms-enum": { + "name": "PatchApplyStatus", + "modelAsString": true + }, + "readOnly": true + }, + "DetectionStatus": { + "type": "string", + "description": "The status of the patch detection.", + "enum": [ + "Succeeded", + "RegistryLoginFailed", + "Failed" + ], + "x-ms-enum": { + "name": "DetectionStatus", + "modelAsString": true + }, + "readOnly": true + }, + "PatchDetails": { + "description": "The detailed info of patch operation performing when applying a patch.", + "type": "object", + "required": [ + "targetContainerName", + "targetImage", + "lastDetectionTime", + "detectionStatus" + ], + "properties": { + "targetContainerName": { + "type": "string", + "description": "The name of the target container for the patch.", + "readOnly": true + }, + "targetImage": { + "type": "string", + "description": "The name of the target image for the patch.", + "readOnly": true + }, + "lastDetectionTime": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes the latest detection was done.", + "readOnly": true + }, + "detectionStatus": { + "$ref": "#/definitions/DetectionStatus", + "description": "The status of the patch detection.", + "readOnly": true + }, + "newImageName": { + "type": "string", + "description": "The name of the new image created by the patch.", + "readOnly": true + }, + "newLayer": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The details of the new layer for the target image." + }, + "frameworkAndVersion": { + "type": "string", + "description": "The framework and its version in the new run image for the target image." + }, + "osAndVersion": { + "type": "string", + "description": "The OS name and its version in the new run image for the target image." + } + }, + "description": "New layer update details in the target image.", + "readOnly": true + }, + "oldLayer": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The details of the old layer for the target image." + }, + "frameworkAndVersion": { + "type": "string", + "description": "The framework and its version in the old run image for the target image." + }, + "osAndVersion": { + "type": "string", + "description": "The OS name and its version in the old run image for the target image." + } + }, + "description": "The old layer details in the target image.", + "readOnly": true + }, + "patchType": { + "type": "string", + "description": "The type for the patch.", + "enum": [ + "FrameworkSecurity", + "OSSecurity", + "FrameworkAndOSSecurity", + "Other" + ], + "x-ms-enum": { + "name": "PatchType", + "modelAsString": true + }, + "readOnly": true + } + }, + "readOnly": true + }, + "PatchProperties": { + "description": "Top level properties that describes current states of the patch resource", + "type": "object", + "properties": { + "targetEnvironmentId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target environment for the patch." + }, + "targetContainerAppId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target container app for the patch." + }, + "targetRevisionId": { + "format": "arm-id", + "type": "string", + "description": "The Azure resource id of the target revision for the patch." + }, + "patchApplyStatus": { + "$ref": "#/definitions/PatchApplyStatus", + "description": "The status of the patch operation.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes when the patch object was created.", + "readOnly": true + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The UTC timestamp that describes when the patch object was last updated.", + "readOnly": true + }, + "patchDetails": { + "description": "Detailed info describes the patch operation for the target container app.", + "type": "array", + "items": { + "$ref": "#/definitions/PatchDetails" + }, + "x-ms-identifiers": [], + "readOnly": true + } + }, + "readOnly": true + }, + "PatchCollection": { + "description": "Container App patch collection", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of patch resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerAppsPatchResource" + } + }, + "nextLink": { + "description": "the link to the next page of items", + "type": "string", + "format": "uri" + } + } + }, + "PatchSkipConfig": { + "description": "The configuration for patcher to skip a patch or not.", + "type": "object", + "properties": { + "skip": { + "type": "boolean", + "description": "The flag to indicate whether to skip the patch or not." + } + } + } + }, + "parameters": { + "ContainerAppsPatchNameParameter": { + "name": "patchName", + "in": "path", + "required": true, + "description": "The name of the patch", + "minLength": 2, + "maxLength": 64, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "ContainerAppsNameParameter": { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App the Patch is associated.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsRevisions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsRevisions.json new file mode 100644 index 000000000000..39dc645e8ebe --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ContainerAppsRevisions.json @@ -0,0 +1,682 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get the Revisions for a given Container App.", + "operationId": "ContainerAppsRevisions_ListRevisions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which Revisions are needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RevisionCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's revisions": { + "$ref": "./examples/Revisions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Revision" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}": { + "get": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Get a revision of a Container App.", + "operationId": "ContainerAppsRevisions_GetRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Revision" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision": { + "$ref": "./examples/Revisions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/activate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Activates a revision for a Container App", + "operationId": "ContainerAppsRevisions_ActivateRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was activated" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Activate Container App's revision": { + "$ref": "./examples/Revisions_Activate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/deactivate": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Deactivates a revision for a Container App", + "operationId": "ContainerAppsRevisions_DeactivateRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was deactivated" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deactivate Container App's revision": { + "$ref": "./examples/Revisions_Deactivate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas/{replicaName}": { + "get": { + "tags": [ + "ContainerAppsRevisionReplicas" + ], + "summary": "Get a replica for a Container App Revision.", + "operationId": "ContainerAppsRevisionReplicas_GetReplica", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "name": "replicaName", + "in": "path", + "description": "Name of the Container App Revision Replica.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Replica" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision replica": { + "$ref": "./examples/Replicas_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/replicas": { + "get": { + "tags": [ + "ContainerAppsRevisionReplicas" + ], + "summary": "List replicas for a Container App Revision.", + "operationId": "ContainerAppsRevisionReplicas_ListReplicas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicaCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's replicas": { + "$ref": "./examples/Replicas_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/restart": { + "post": { + "tags": [ + "ContainerAppsRevisions" + ], + "summary": "Restarts a revision for a Container App", + "operationId": "ContainerAppsRevisions_RestartRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App revision was restarted" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Restart Container App's revision": { + "$ref": "./examples/Revisions_Restart.json" + } + } + } + } + }, + "definitions": { + "Revision": { + "description": "Container App Revision.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Revision resource specific properties", + "type": "object", + "properties": { + "createdTime": { + "format": "date-time", + "description": "Timestamp describing when the revision was created\nby controller", + "type": "string", + "readOnly": true + }, + "lastActiveTime": { + "format": "date-time", + "description": "Timestamp describing when the revision was last active. Only meaningful when revision is inactive", + "type": "string", + "readOnly": true + }, + "fqdn": { + "description": "Fully qualified domain name of the revision", + "type": "string", + "readOnly": true + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/Template", + "description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time", + "readOnly": true + }, + "active": { + "description": "Boolean describing if the Revision is Active", + "type": "boolean", + "readOnly": true + }, + "replicas": { + "format": "int32", + "description": "Number of pods currently running for this revision", + "type": "integer", + "readOnly": true + }, + "trafficWeight": { + "format": "int32", + "description": "Traffic weight assigned to this revision", + "type": "integer", + "readOnly": true + }, + "provisioningError": { + "description": "Optional Field - Platform Error Message", + "type": "string", + "readOnly": true + }, + "healthState": { + "description": "Current health State of the revision", + "enum": [ + "Healthy", + "Unhealthy", + "None" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionHealthState", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Current provisioning State of the revision", + "enum": [ + "Provisioning", + "Provisioned", + "Failed", + "Deprovisioning", + "Deprovisioned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionProvisioningState", + "modelAsString": true + } + }, + "runningState": { + "description": "Current running state of the revision", + "enum": [ + "Running", + "Processing", + "Stopped", + "Degraded", + "Failed", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RevisionRunningState", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "RevisionCollection": { + "description": "Container App Revisions collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Revision" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Replica": { + "description": "Container App Revision Replica.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Replica resource specific properties", + "type": "object", + "properties": { + "createdTime": { + "type": "string", + "description": "Timestamp describing when the pod was created by controller", + "format": "date-time", + "readOnly": true + }, + "runningState": { + "description": "Current running state of the replica", + "enum": [ + "Running", + "NotRunning", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppReplicaRunningState", + "modelAsString": true + } + }, + "runningStateDetails": { + "description": "The details of replica current running state", + "type": "string", + "readOnly": true + }, + "containers": { + "description": "The containers collection under a replica.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "initContainers": { + "description": "The init containers collection under a replica.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaContainer" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "ReplicaCollection": { + "description": "Container App Revision Replicas collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Replica" + } + } + } + }, + "ReplicaContainer": { + "description": "Container object under Container App Revision Replica.", + "type": "object", + "properties": { + "name": { + "description": "The Name of the Container", + "type": "string" + }, + "containerId": { + "description": "The Id of the Container", + "type": "string" + }, + "ready": { + "description": "The container ready status", + "type": "boolean" + }, + "started": { + "description": "The container start status", + "type": "boolean" + }, + "restartCount": { + "format": "int32", + "description": "The container restart count", + "type": "integer" + }, + "runningState": { + "description": "Current running state of the container", + "enum": [ + "Running", + "Terminated", + "Waiting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerAppContainerRunningState", + "modelAsString": true + } + }, + "runningStateDetails": { + "description": "The details of container current running state", + "type": "string", + "readOnly": true + }, + "logStreamEndpoint": { + "description": "Log Stream endpoint", + "type": "string", + "readOnly": true + }, + "execEndpoint": { + "description": "Container exec endpoint", + "type": "string", + "readOnly": true + }, + "debugEndpoint": { + "description": "Container debug endpoint", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Diagnostics.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Diagnostics.json new file mode 100644 index 000000000000..233c3d1677ae --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Diagnostics.json @@ -0,0 +1,866 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Container App.", + "operationId": "ContainerAppsDiagnostics_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which detector info is needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostics for a given Container App": { + "$ref": "./examples/ContainerAppsDiagnostics_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectors/{detectorName}": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get a diagnostics result of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Container App Detector.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's diagnostics info": { + "$ref": "./examples/ContainerAppsDiagnostics_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the Revisions for a given Container App.", + "operationId": "ContainerAppsDiagnostics_ListRevisions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App for which Revisions are needed.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ContainerAppsRevisions.json#/definitions/RevisionCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container App's revisions": { + "$ref": "./examples/Revisions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Revision" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/revisionsApi/revisions/{revisionName}": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get a revision of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetRevision", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ContainerAppsRevisions.json#/definitions/Revision" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's revision": { + "$ref": "./examples/Revisions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/detectorProperties/rootApi/": { + "get": { + "tags": [ + "ContainerApps", + "Diagnostics" + ], + "summary": "Get the properties of a Container App.", + "operationId": "ContainerAppsDiagnostics_GetRoot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./ContainerApps.json#/definitions/ContainerApp" + } + }, + "404": { + "description": "Not found.", + "x-ms-error-response": true + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App": { + "$ref": "./examples/ContainerApps_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Managed Environment.", + "description": "Get the list of diagnostics for a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentDiagnostics_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostic data for a managed environments": { + "$ref": "./examples/ManagedEnvironmentDiagnostics_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectors/{detectorName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the diagnostics data for a given Managed Environment.", + "description": "Get the diagnostics data for a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentDiagnostics_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Managed Environment detector.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic data for a managed environments": { + "$ref": "./examples/ManagedEnvironmentDiagnostics_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/detectorProperties/rootApi/": { + "get": { + "tags": [ + "ManagedEnvironments", + "Diagnostics" + ], + "summary": "Get the properties of a Managed Environment.", + "description": "Get the properties of a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironmentsDiagnostics_GetRoot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./ManagedEnvironments.json#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get environments by name": { + "$ref": "./examples/ManagedEnvironments_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the list of diagnostics for a given Container App Job.", + "description": "Get the list of diagnostics for a Container App Job.", + "operationId": "Jobs_ListDetectors", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiagnosticsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the list of available diagnostic data for a Container App Job": { + "$ref": "./examples/Job_ListDetectors.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectors/{detectorName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the diagnostics data for a given Container App Job.", + "description": "Get the diagnostics data for a Container App Job.", + "operationId": "Jobs_GetDetector", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "detectorName", + "in": "path", + "description": "Name of the Container App Job detector.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Diagnostics" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get diagnostic data for a Container App Job": { + "$ref": "./examples/Job_GetDetector.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/detectorProperties/{apiName}": { + "get": { + "tags": [ + "Jobs", + "Diagnostics" + ], + "summary": "Get the properties for a given Container App Job.", + "description": "Get the properties of a Container App Job.", + "operationId": "Jobs_ProxyGet", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./Jobs.json#/parameters/JobNameParameter" + }, + { + "name": "apiName", + "in": "path", + "description": "Proxy API Name for Container App Job.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./Jobs.json#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App Job by name": { + "$ref": "./examples/Job_ProxyGet.json" + } + } + } + } + }, + "definitions": { + "DiagnosticsCollection": { + "description": "Diagnostics data collection for a resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of diagnostic data.", + "type": "array", + "items": { + "$ref": "#/definitions/Diagnostics" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "Diagnostics": { + "description": "Diagnostics data for a resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Diagnostics resource specific properties", + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/DiagnosticsDefinition", + "description": "Metadata of the diagnostics response." + }, + "dataset": { + "description": "Set of data collections associated with the response.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsDataApiResponse" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/DiagnosticsStatus", + "description": "Status of the diagnostics response." + }, + "dataProviderMetadata": { + "$ref": "#/definitions/DiagnosticDataProviderMetadata", + "description": "List of data providers' metadata." + } + } + } + } + }, + "DiagnosticsDefinition": { + "description": "Metadata of the diagnostics response", + "type": "object", + "properties": { + "id": { + "description": "Unique detector name", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Display Name of the detector", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Details of the diagnostics info", + "type": "string", + "readOnly": true + }, + "author": { + "description": "Authors' names of the detector", + "type": "string", + "readOnly": true + }, + "category": { + "description": "Category of the detector", + "type": "string", + "readOnly": true + }, + "supportTopicList": { + "description": "List of support topics", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticSupportTopic" + } + }, + "analysisTypes": { + "description": "List of analysis types", + "type": "array", + "items": { + "type": "string" + } + }, + "type": { + "description": "Authors' names of the detector", + "type": "string", + "readOnly": true + }, + "score": { + "description": "Authors' names of the detector", + "type": "number", + "readOnly": true + } + } + }, + "DiagnosticSupportTopic": { + "description": "Support topic information", + "type": "object", + "properties": { + "id": { + "description": "Unique topic identifier", + "type": "string", + "readOnly": true + }, + "pesId": { + "description": "PES identifier", + "type": "string", + "readOnly": true + } + } + }, + "DiagnosticsDataApiResponse": { + "description": "Diagnostics data returned from a detector", + "type": "object", + "properties": { + "table": { + "description": "Table response", + "$ref": "#/definitions/DiagnosticDataTableResponseObject" + }, + "renderingProperties": { + "description": "Details of the table response", + "$ref": "#/definitions/DiagnosticRendering" + } + } + }, + "DiagnosticDataTableResponseObject": { + "description": "Diagnostics data table", + "type": "object", + "properties": { + "tableName": { + "description": "Table name", + "type": "string" + }, + "columns": { + "description": "Columns in the table", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticDataTableResponseColumn" + }, + "x-ms-identifiers": [ + "columnName" + ] + }, + "rows": { + "description": "Rows in the table", + "type": "array", + "items": { + "type": "object" + }, + "x-ms-identifiers": [] + } + } + }, + "DiagnosticDataTableResponseColumn": { + "description": "Diagnostics data column", + "type": "object", + "properties": { + "columnName": { + "description": "Column name", + "type": "string" + }, + "dataType": { + "description": "Data type of the column", + "type": "string" + }, + "columnType": { + "description": "Column type", + "type": "string" + } + } + }, + "DiagnosticRendering": { + "description": "Rendering details of a diagnostics table", + "type": "object", + "properties": { + "type": { + "format": "int32", + "description": "Rendering type", + "type": "integer" + }, + "title": { + "description": "Title of the table", + "type": "string" + }, + "description": { + "description": "Description of the table", + "type": "string" + }, + "isVisible": { + "description": "Flag if the table should be rendered", + "type": "boolean" + } + } + }, + "DiagnosticsStatus": { + "description": "Rendering details of a diagnostics table", + "type": "object", + "properties": { + "message": { + "description": "Diagnostic message", + "type": "string" + }, + "statusId": { + "format": "int32", + "description": "Status", + "type": "integer" + } + } + }, + "DiagnosticDataProviderMetadata": { + "description": "Details of a diagnostics data provider", + "type": "object", + "properties": { + "providerName": { + "description": "Name of data provider", + "type": "string" + }, + "propertyBag": { + "description": "Collection of properties", + "type": "array", + "items": { + "description": "Property details", + "type": "object", + "properties": { + "name": { + "description": "Property name", + "type": "string" + }, + "value": { + "description": "Property value", + "type": "string" + } + } + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/DotNetComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/DotNetComponents.json new file mode 100644 index 000000000000..66ba3c4204b1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/DotNetComponents.json @@ -0,0 +1,479 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/dotNetComponents": { + "get": { + "tags": [ + "DotNetComponents" + ], + "summary": "Get the .NET Components for a managed environment.", + "operationId": "DotNetComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/DotNetComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List .NET Components": { + "$ref": "./examples/DotNetComponents_List.json" + }, + "List .NET Components with ServiceBinds": { + "$ref": "./examples/DotNetComponents_List_ServiceBind.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/dotNetComponents/{name}": { + "get": { + "tags": [ + "DotNetComponents" + ], + "summary": "Get a .NET Component.", + "operationId": "DotNetComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get .NET Component": { + "$ref": "./examples/DotNetComponents_Get.json" + }, + "Get .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_Get_ServiceBind.json" + } + } + }, + "put": { + "tags": [ + "DotNetComponents" + ], + "summary": "Creates or updates a .NET Component.", + "description": "Creates or updates a .NET Component in a Managed Environment.", + "operationId": "DotNetComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dotNetComponentEnvelope", + "in": "body", + "description": "Configuration details of the .NET Component.", + "required": true, + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + } + ], + "responses": { + "200": { + "description": "No change performed on the .NET Component.", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "201": { + "description": ".NET Component create or update has been started.", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update .NET Component": { + "$ref": "./examples/DotNetComponents_CreateOrUpdate.json" + }, + "Create or Update .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_CreateOrUpdate_ServiceBind.json" + } + } + }, + "patch": { + "tags": [ + "DotNetComponents" + ], + "summary": "Update properties of a .NET Component", + "description": "Patches a .NET Component using JSON Merge Patch", + "operationId": "DotNetComponents_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "dotNetComponentEnvelope", + "in": "body", + "description": "Configuration details of the .NET Component.", + "required": true, + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch .NET Component": { + "$ref": "./examples/DotNetComponents_Patch.json" + }, + "Patch .NET Component with ServiceBinds": { + "$ref": "./examples/DotNetComponents_Patch_ServiceBind.json" + } + } + }, + "delete": { + "tags": [ + "DotNetComponents" + ], + "summary": "Delete a .NET Component.", + "description": "Delete a .NET Component.", + "operationId": "DotNetComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the .NET Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": ".NET Component does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete .NET Component": { + "$ref": "./examples/DotNetComponents_Delete.json" + } + } + } + } + }, + "definitions": { + "DotNetComponentConfigurationProperty": { + "description": "Configuration properties for a .NET Component", + "type": "object", + "properties": { + "propertyName": { + "description": "The name of the property", + "type": "string" + }, + "value": { + "description": "The value of the property", + "type": "string" + } + } + }, + "DotNetComponentServiceBind": { + "description": "Configuration to bind a .NET Component to another .NET Component", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "format": "arm-id", + "type": "string" + } + } + }, + "DotNetComponent": { + "description": ".NET Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": ".NET Component resource specific properties", + "type": "object", + "properties": { + "componentType": { + "description": "Type of the .NET Component.", + "enum": [ + "AspireDashboard" + ], + "type": "string", + "x-ms-enum": { + "name": "DotNetComponentType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the .NET Component.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DotNetComponentProvisioningState", + "modelAsString": true + } + }, + "configurations": { + "description": "List of .NET Components configuration properties", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponentConfigurationProperty" + }, + "x-ms-identifiers": [ + "propertyName" + ] + }, + "serviceBinds": { + "description": "List of .NET Components that are bound to the .NET component", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponentServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true + } + } + }, + "DotNetComponentsCollection": { + "description": ".NET Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DotNetComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/FunctionsExtension.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/FunctionsExtension.json new file mode 100644 index 000000000000..b03718a04d20 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/FunctionsExtension.json @@ -0,0 +1,107 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client", + "description": "Functions is an extension resource to revisions and the api listed is used to proxy the call from Web RP to the function app's host process, this api is not exposed to users and only Web RP is allowed to invoke functions extension resource." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/revisions/{revisionName}/providers/Microsoft.App/functions/{functionAppName}/invoke": { + "post": { + "tags": [ + "FunctionsExtension" + ], + "summary": "Proxies a Functions host call to the function app backed by the container app.", + "operationId": "FunctionsExtension_InvokeFunctionsHost", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "revisionName", + "in": "path", + "description": "Name of the Container App Revision, the parent resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "functionAppName", + "in": "path", + "description": "Name of the Function App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Functions host call response.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Invoke Functions host using Functions Extension API": { + "$ref": "./examples/FunctionsExtension_Post.json" + } + } + } + } + }, + "definitions": { + "FunctionsProxySerializedResponse": { + "type": "string", + "description": "Functions host call response as a serialized string, a common type of string is used as multiple response structures are possible." + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Global.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Global.json new file mode 100644 index 000000000000..cbf8302bf613 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Global.json @@ -0,0 +1,140 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.App/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available RP operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AvailableOperations" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all operations": { + "$ref": "./examples/Operations_List.json" + } + } + } + } + }, + "definitions": { + "AvailableOperations": { + "description": "Available operations of the service", + "type": "object", + "properties": { + "value": { + "description": "Collection of available operation details", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/OperationDetail" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "nextLink": { + "description": "URL client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "OperationDetail": { + "description": "Operation detail payload", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Display of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationDisplay": { + "description": "Operation display payload", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider of the operation", + "type": "string" + }, + "resource": { + "description": "Resource of the operation", + "type": "string" + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json new file mode 100644 index 000000000000..058ada9dae4d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/JavaComponents.json @@ -0,0 +1,641 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents": { + "get": { + "tags": [ + "JavaComponents" + ], + "summary": "Get the Java Components for a managed environment.", + "operationId": "JavaComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/JavaComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Java Components": { + "$ref": "./examples/JavaComponents_List.json" + }, + "List Java Components with ServiceBinds": { + "$ref": "./examples/JavaComponents_List_ServiceBind.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/javaComponents/{name}": { + "get": { + "tags": [ + "JavaComponents" + ], + "summary": "Get a Java Component.", + "operationId": "JavaComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Java Component": { + "$ref": "./examples/JavaComponents_Get.json" + }, + "Get Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_Get_ServiceBind.json" + } + } + }, + "put": { + "tags": [ + "JavaComponents" + ], + "summary": "Creates or updates a Java Component.", + "description": "Creates or updates a Java Component in a Managed Environment.", + "operationId": "JavaComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "javaComponentEnvelope", + "in": "body", + "description": "Configuration details of the Java Component.", + "required": true, + "schema": { + "$ref": "#/definitions/JavaComponent" + } + } + ], + "responses": { + "200": { + "description": "No change performed on the Java Component.", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "201": { + "description": "Java Component create or update has been started.", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Java Component": { + "$ref": "./examples/JavaComponents_CreateOrUpdate.json" + }, + "Create or Update Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_CreateOrUpdate_ServiceBind.json" + } + } + }, + "patch": { + "tags": [ + "JavaComponents" + ], + "summary": "Update properties of a Java Component", + "description": "Patches a Java Component using JSON Merge Patch", + "operationId": "JavaComponents_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "javaComponentEnvelope", + "in": "body", + "description": "Configuration details of the Java Component.", + "required": true, + "schema": { + "$ref": "#/definitions/JavaComponent" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/JavaComponent" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch Java Component": { + "$ref": "./examples/JavaComponents_Patch.json" + }, + "Patch Java Component with ServiceBinds": { + "$ref": "./examples/JavaComponents_Patch_ServiceBind.json" + } + } + }, + "delete": { + "tags": [ + "JavaComponents" + ], + "summary": "Delete a Java Component.", + "description": "Delete a Java Component.", + "operationId": "JavaComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Java Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Java Component does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Java Component": { + "$ref": "./examples/JavaComponents_Delete.json" + } + } + } + } + }, + "definitions": { + "ScgRoute": { + "description": "Spring Cloud Gateway route definition", + "type": "object", + "required": [ + "id", + "uri" + ], + "properties": { + "id": { + "description": "Id of the route", + "type": "string" + }, + "uri": { + "description": "Uri of the route", + "type": "string" + }, + "predicates": { + "description": "Predicates of the route", + "type": "array", + "items": { + "type": "string" + } + }, + "filters": { + "description": "Filters of the route", + "type": "array", + "items": { + "type": "string" + } + }, + "order": { + "description": "Order of the route", + "type": "integer", + "format": "int64" + } + } + }, + "JavaComponentConfigurationProperty": { + "description": "Configuration properties for a Java Component", + "type": "object", + "properties": { + "propertyName": { + "description": "The name of the property", + "type": "string" + }, + "value": { + "description": "The value of the property", + "type": "string" + } + } + }, + "JavaComponentServiceBind": { + "description": "Configuration to bind a Java Component to another Java Component", + "type": "object", + "properties": { + "name": { + "description": "Name of the service bind", + "type": "string" + }, + "serviceId": { + "description": "Resource id of the target service", + "format": "arm-id", + "type": "string" + } + } + }, + "JavaComponent": { + "description": "Java Component.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Java Component resource specific properties", + "type": "object", + "$ref": "#/definitions/JavaComponentProperties" + } + } + }, + "JavaComponentProperties": { + "description": "Java Component common properties.", + "type": "object", + "required": [ + "componentType" + ], + "properties": { + "componentType": { + "description": "Type of the Java Component.", + "enum": [ + "SpringBootAdmin", + "SpringCloudEureka", + "SpringCloudConfig", + "SpringCloudGateway", + "Nacos" + ], + "type": "string", + "x-ms-enum": { + "name": "JavaComponentType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the Java Component.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JavaComponentProvisioningState", + "modelAsString": true + } + }, + "configurations": { + "description": "List of Java Components configuration properties", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponentConfigurationProperty" + }, + "x-ms-identifiers": [ + "propertyName" + ] + }, + "scale": { + "description": "Java component scaling configurations", + "type": "object", + "properties": { + "minReplicas": { + "format": "int32", + "description": "Optional. Minimum number of Java component replicas. Defaults to 1 if not set", + "type": "integer" + }, + "maxReplicas": { + "format": "int32", + "description": "Optional. Maximum number of Java component replicas", + "type": "integer" + } + } + }, + "serviceBinds": { + "description": "List of Java Components that are bound to the Java component", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponentServiceBind" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "x-ms-client-flatten": true, + "discriminator": "componentType" + }, + "JavaComponentIngress": { + "description": "Container App Ingress configuration.", + "type": "object", + "properties": { + "fqdn": { + "description": "Hostname of the Java Component endpoint", + "type": "string", + "readOnly": true + } + } + }, + "SpringCloudGatewayComponent": { + "description": "Spring Cloud Gateway properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + }, + "springCloudGatewayRoutes": { + "description": "Gateway route definition", + "type": "array", + "items": { + "$ref": "#/definitions/ScgRoute" + }, + "x-ms-identifiers": [ + "id" + ] + } + }, + "x-ms-discriminator-value": "SpringCloudGateway" + }, + "SpringBootAdminComponent": { + "description": "Spring Boot Admin properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "SpringBootAdmin" + }, + "NacosComponent": { + "description": "Nacos properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "Nacos" + }, + "SpringCloudEurekaComponent": { + "description": "Spring Cloud Eureka properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": { + "ingress": { + "$ref": "#/definitions/JavaComponentIngress", + "description": "Java Component Ingress configurations." + } + }, + "x-ms-discriminator-value": "SpringCloudEureka" + }, + "SpringCloudConfigComponent": { + "description": "Spring Cloud Config properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JavaComponentProperties" + } + ], + "properties": {}, + "x-ms-discriminator-value": "SpringCloudConfig" + }, + "JavaComponentsCollection": { + "description": "Java Components ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JavaComponent" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json new file mode 100644 index 000000000000..e04a94103eba --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Jobs.json @@ -0,0 +1,1423 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the Container Apps Jobs in a given subscription.", + "operationId": "Jobs_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobsCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Jobs by subscription": { + "$ref": "./examples/Jobs_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the Container Apps Jobs in a given resource group.", + "operationId": "Jobs_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Jobs by resource group": { + "$ref": "./examples/Jobs_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get the properties of a Container Apps Job.", + "operationId": "Jobs_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container Apps Job": { + "$ref": "./examples/Job_Get.json" + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "summary": "Create or Update a Container Apps Job.", + "description": "Create or Update a Container Apps Job.", + "operationId": "Jobs_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "JobEnvelope", + "in": "body", + "description": "Properties used to create a container apps job", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Container Apps Job create has been started.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "200": { + "description": "No change performed on the Container Apps Job.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container Apps Job": { + "$ref": "./examples/Job_CreateorUpdate.json" + }, + "Create or Update Container Apps Job With Event Driven Trigger": { + "$ref": "./examples/Job_CreateorUpdate_EventTrigger.json" + }, + "Create or Update Container Apps Job On A Connected Environment": { + "$ref": "./examples/Job_CreateorUpdate_ConnectedEnvironment.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "Jobs" + ], + "summary": "Delete a Container Apps Job.", + "description": "Delete a Container Apps Job.", + "operationId": "Jobs_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container Apps Job deleted successfully." + }, + "202": { + "description": "Delete operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Container Apps Job does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container Apps Job": { + "$ref": "./examples/Job_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "summary": "Update properties of a Container Apps Job", + "description": "Patches a Container Apps Job using JSON Merge Patch", + "operationId": "Jobs_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "JobEnvelope", + "in": "body", + "required": true, + "description": "Properties used to create a container apps job", + "schema": { + "$ref": "#/definitions/JobPatchProperties" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Patch operation is in progress.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Container Apps Job": { + "$ref": "./examples/Job_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/start": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Start a Container Apps Job", + "operationId": "Jobs_Start", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "name": "template", + "in": "body", + "description": "Properties used to start a job execution.", + "required": false, + "schema": { + "$ref": "#/definitions/JobExecutionTemplate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobExecutionBase" + } + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Run a Container Apps Job": { + "$ref": "./examples/Job_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}/stop": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Terminates execution of a running container apps job", + "operationId": "Jobs_StopExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/JobExecutionNameParameter" + } + ], + "responses": { + "200": { + "description": "Container Apps Jobs terminated successfully." + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Terminate a Container Apps Job": { + "$ref": "./examples/Job_Stop_Execution.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/stop": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Terminates execution of a running container apps job", + "operationId": "Jobs_StopMultipleExecutions", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "List of all the job executions that were requested to be stopped", + "schema": { + "$ref": "#/definitions/ContainerAppJobExecutions" + } + }, + "202": { + "description": "OK", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Terminate Multiple Container Apps Job": { + "$ref": "./examples/Job_Stop_Multiple.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get a Container Apps Job's executions", + "operationId": "JobsExecutions_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply on the operation.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerAppJobExecutions" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Container Apps Job Executions": { + "$ref": "./examples/Job_Executions_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Get details of a single job execution", + "operationId": "JobExecution", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + }, + { + "$ref": "#/parameters/JobExecutionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobExecution" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a single Job Execution": { + "$ref": "./examples/Job_Execution_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/listSecrets": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "List secrets for a container apps job", + "operationId": "Jobs_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Job Secrets": { + "$ref": "./examples/Job_ListSecrets.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/resume": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Resumes a suspended job", + "operationId": "Jobs_Resume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the Job.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Job resumed successfully.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Resume operation is in progress.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Resume Job": { + "$ref": "./examples/Jobs_Resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/suspend": { + "post": { + "tags": [ + "Jobs" + ], + "summary": "Suspends a job", + "operationId": "Jobs_Suspend", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the Job.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + } + ], + "responses": { + "200": { + "description": "Job suspended successfully.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "202": { + "description": "Suspend operation is in progress.", + "headers": { + "Azure-AsyncOperation": { + "type": "string" + }, + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Suspend Job": { + "$ref": "./examples/Jobs_Suspend.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "parameters": { + "JobNameParameter": { + "name": "jobName", + "in": "path", + "description": "Job Name", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + }, + "JobExecutionNameParameter": { + "name": "jobExecutionName", + "in": "path", + "description": "Job execution name.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "JobConfiguration": { + "description": "Non versioned Container Apps Job configuration properties", + "type": "object", + "required": [ + "replicaTimeout", + "triggerType" + ], + "properties": { + "secrets": { + "description": "Collection of secrets used by a Container Apps Job", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "triggerType": { + "description": "Trigger type of the job", + "enum": [ + "Schedule", + "Event", + "Manual" + ], + "type": "string", + "default": "Manual", + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true + } + }, + "replicaTimeout": { + "description": "Maximum number of seconds a replica is allowed to run.", + "format": "int32", + "type": "integer" + }, + "replicaRetryLimit": { + "format": "int32", + "description": "Maximum number of retries before failing the job.", + "type": "integer" + }, + "manualTriggerConfig": { + "type": "object", + "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + } + } + }, + "scheduleTriggerConfig": { + "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default", + "required": [ + "cronExpression" + ], + "type": "object", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "cronExpression": { + "description": "Cron formatted repeating schedule (\"* * * * *\") of a Cron Job.", + "type": "string" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + } + } + }, + "eventTriggerConfig": { + "type": "object", + "description": "Trigger configuration of an event driven job.", + "properties": { + "replicaCompletionCount": { + "$ref": "#/definitions/ReplicaCompletionCount" + }, + "parallelism": { + "$ref": "#/definitions/Parallelism" + }, + "scale": { + "$ref": "#/definitions/JobScale" + } + } + }, + "registries": { + "description": "Collection of private container registry credentials used by a Container apps job", + "type": "array", + "items": { + "$ref": "#/definitions/RegistryCredentials" + }, + "x-ms-identifiers": [ + "server" + ] + }, + "identitySettings": { + "description": "Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/IdentitySettings" + }, + "x-ms-identifiers": [ + "identity" + ] + } + } + }, + "Job": { + "type": "object", + "description": "Container App Job", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Container Apps Job resource specific properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Container Apps Job.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobProvisioningState", + "modelAsString": true + } + }, + "runningState": { + "description": "Current running state of the job", + "enum": [ + "Ready", + "Progressing", + "Suspended" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobRunningState", + "modelAsString": true + } + }, + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "workloadProfileName": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile name to pin for container apps job execution." + }, + "configuration": { + "$ref": "#/definitions/JobConfiguration", + "description": "Container Apps Job configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/JobTemplate", + "description": "Container Apps job definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses of a container apps job.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container apps job.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "JobPatchProperties": { + "type": "object", + "description": "Container Apps Job resource specific properties.", + "properties": { + "extendedLocation": { + "$ref": "./CommonDefinitions.json#/definitions/ExtendedLocation" + }, + "identity": { + "description": "Managed identities needed by a container app job to interact with other Azure services to not maintain any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "properties": { + "type": "object", + "properties": { + "environmentId": { + "description": "Resource ID of environment.", + "type": "string", + "x-ms-mutability": [ + "create", + "read", + "update" + ] + }, + "configuration": { + "$ref": "#/definitions/JobConfiguration", + "description": "Container Apps Job configuration properties." + }, + "template": { + "$ref": "./CommonDefinitions.json#/definitions/JobTemplate", + "description": "Container Apps job definition." + }, + "outboundIpAddresses": { + "description": "Outbound IP Addresses of a container apps job.", + "type": "array", + "items": { + "type": "string" + } + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the container apps job.", + "type": "string" + } + } + } + } + }, + "JobsCollection": { + "description": "Container Apps Jobs collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Job" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "RegistryCredentials": { + "description": "Container App Private Registry", + "type": "object", + "properties": { + "server": { + "description": "Container Registry Server", + "type": "string" + }, + "username": { + "description": "Container Registry Username", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the Secret that contains the registry login password", + "type": "string" + }, + "identity": { + "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'", + "type": "string" + } + } + }, + "JobSecretsCollection": { + "description": "Container Apps Job Secrets Collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/Secret" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ReplicaCompletionCount": { + "description": "Minimum number of successful replica completions before overall job completion.", + "format": "int32", + "type": "integer" + }, + "Parallelism": { + "description": "Number of parallel replicas of a job that can run at a given time.", + "format": "int32", + "type": "integer" + }, + "PollingInterval": { + "description": "Interval to check each event source in seconds. Defaults to 30s", + "format": "int32", + "type": "integer" + }, + "JobScaleRule": { + "description": "Scaling rule.", + "type": "object", + "properties": { + "name": { + "description": "Scale Rule Name", + "type": "string" + }, + "type": { + "description": "Type of the scale rule\neg: azure-servicebus, redis etc.", + "type": "string" + }, + "metadata": { + "description": "Metadata properties to describe the scale rule.", + "type": "object" + }, + "auth": { + "description": "Authentication secrets for the scale rule.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/ScaleRuleAuth" + } + }, + "identity": { + "description": "The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity.", + "type": "string" + } + } + }, + "JobScale": { + "description": "Scaling configurations for event driven jobs.", + "type": "object", + "properties": { + "pollingInterval": { + "$ref": "#/definitions/PollingInterval" + }, + "minExecutions": { + "format": "int32", + "description": "Minimum number of job executions that are created for a trigger, default 0", + "type": "integer", + "default": 0 + }, + "maxExecutions": { + "format": "int32", + "description": "Maximum number of job executions that are created for a trigger, default 100.", + "type": "integer", + "default": 100 + }, + "rules": { + "description": "Scaling rules.", + "type": "array", + "items": { + "$ref": "#/definitions/JobScaleRule" + } + } + } + }, + "JobExecutionBase": { + "description": "Container App's Job execution name.", + "type": "object", + "properties": { + "name": { + "description": "Job execution name.", + "type": "string" + }, + "id": { + "description": "Job execution Id.", + "type": "string" + } + } + }, + "JobExecution": { + "description": "Container Apps Job execution.", + "type": "object", + "properties": { + "name": { + "description": "Job execution Name.", + "type": "string" + }, + "id": { + "description": "Job execution Id.", + "type": "string" + }, + "type": { + "description": "Job execution type", + "type": "string" + }, + "properties": { + "description": "Container Apps Job execution specific properties.", + "type": "object", + "properties": { + "status": { + "description": "Current running State of the job", + "enum": [ + "Running", + "Processing", + "Stopped", + "Degraded", + "Failed", + "Unknown", + "Succeeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobExecutionRunningState", + "modelAsString": true + } + }, + "startTime": { + "description": "Job execution start time.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "Job execution end time.", + "format": "date-time", + "type": "string" + }, + "template": { + "description": "Job's execution container.", + "$ref": "#/definitions/JobExecutionTemplate" + }, + "detailedStatus": { + "description": "Detailed status of the job execution.", + "$ref": "#/definitions/ExecutionStatus" + } + }, + "x-ms-client-flatten": true + } + } + }, + "ExecutionStatus": { + "description": "Container Apps Job execution status.", + "type": "object", + "properties": { + "replicas": { + "description": "Replicas in the execution.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaExecutionStatus" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ReplicaExecutionStatus": { + "description": "Container Apps Job execution replica status.", + "type": "object", + "properties": { + "name": { + "description": "Replica Name.", + "type": "string" + }, + "containers": { + "description": "Containers in the execution replica", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerExecutionStatus" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "ContainerExecutionStatus": { + "description": "Container Apps Job execution container status. Contains status code and reason", + "type": "object", + "properties": { + "name": { + "description": "Container Name.", + "type": "string" + }, + "code": { + "description": "Exit code", + "type": "integer", + "format": "int32" + }, + "additionalInformation": { + "description": "Additional information for the container status", + "type": "string" + }, + "status": { + "description": "Status of the container", + "type": "string" + } + } + }, + "ContainerAppJobExecutions": { + "description": "Container App executions collection ARM resource.", + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecution" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "JobExecutionNamesCollection": { + "description": "Container App executions names list.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionBase" + } + } + } + }, + "JobExecutionTemplate": { + "description": "Job's execution template, containing container configuration for a job's execution", + "type": "object", + "properties": { + "containers": { + "description": "List of container definitions for the Container Apps Job.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "initContainers": { + "description": "List of specialized containers that run before job containers.", + "type": "array", + "items": { + "$ref": "#/definitions/JobExecutionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "JobExecutionContainer": { + "description": "Container Apps Jobs execution container definition.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "./CommonDefinitions.json#/definitions/ContainerResources", + "description": "Container resource requirements." + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/LogicAppsExtension.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/LogicAppsExtension.json new file mode 100644 index 000000000000..99516e33d838 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/LogicAppsExtension.json @@ -0,0 +1,750 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client", + "description": "Logic app is an extension resource on container app and the extension resource enables logic specific operations on the container app through the APIs listed." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "Gets a logic app extension resource.", + "operationId": "LogicApps_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get logic app extension by name ": { + "$ref": "./examples/LogicApps_Get.json" + } + } + }, + "put": { + "operationId": "LogicApps_CreateOrUpdate", + "tags": [ + "LogicApps" + ], + "description": "Create or update a Logic App extension resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "resource", + "in": "body", + "description": "Logic app resource properties.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/LogicApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create logic app extension": { + "$ref": "./examples/LogicApps_Create.json" + } + } + }, + "delete": { + "operationId": "LogicApps_Delete", + "tags": [ + "LogicApps" + ], + "description": "Deletes a Logic App extension resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Extension resource does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create logic app extension": { + "$ref": "./examples/LogicApps_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "List the workflows for a logic app.", + "operationId": "LogicApps_ListWorkflows", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelopeCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the workflows": { + "$ref": "./examples/LogicApps_ListWorkflows.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/workflows/{workflowName}": { + "get": { + "tags": [ + "LogicApps" + ], + "summary": "Get workflow information by its name", + "operationId": "LogicApps_GetWorkflow", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "workflowName", + "in": "path", + "description": "Workflow name.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63 + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Workflow information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "GET a workflow": { + "$ref": "./examples/LogicApps_GetWorkflow.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/deployWorkflowArtifacts": { + "post": { + "tags": [ + "LogicApps" + ], + "description": "Creates or updates the artifacts for the logic app", + "operationId": "LogicApps_DeployWorkflowArtifacts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "workflowArtifacts", + "in": "body", + "description": "Application settings and files of the workflow.", + "required": false, + "x-ms-secret": true, + "schema": { + "$ref": "#/definitions/WorkflowArtifacts" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Artifacts deployed." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Deploys workflow artifacts": { + "$ref": "./examples/LogicApps_PostDeployWorkflowArtifacts.json" + }, + "Delete workflow artifacts": { + "$ref": "./examples/LogicApps_DeleteDeployWorkflowArtifacts.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/listWorkflowsConnections": { + "post": { + "tags": [ + "LogicApps" + ], + "summary": "Gets logic app's connections.", + "operationId": "LogicApps_ListWorkflowsConnections", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the Logic App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Connections information returned.", + "schema": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List the Workflows Configuration Connections": { + "$ref": "./examples/LogicApps_ListConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/providers/Microsoft.App/logicApps/{logicAppName}/invoke": { + "post": { + "tags": [ + "LogicApps" + ], + "summary": "Proxies a the API call to the logic app backed by the container app.", + "operationId": "LogicApps_Invoke", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "logicAppName", + "in": "path", + "description": "Name of the LogicApp App, the extension resource.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "x-ms-logicApps-proxy-path", + "in": "header", + "description": "The proxy path for the API call", + "required": true, + "type": "string" + }, + { + "name": "x-ms-logicApps-proxy-method", + "in": "header", + "description": "The proxy method for the API call", + "required": true, + "type": "string", + "enum": [ + "GET", + "POST" + ], + "x-ms-enum": { + "name": "LogicAppsProxyMethod", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Logic App call response.", + "schema": { + "$ref": "#/definitions/Object" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get workflow list call back URL": { + "$ref": "./examples/LogicApps_ListCallbackURL.json" + } + } + } + } + }, + "definitions": { + "LogicApp": { + "type": "object", + "description": "A logic app extension resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogicAppProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "LogicAppProperties": { + "type": "object", + "description": "The properties of logic apps extension." + }, + "WorkflowEnvelope": { + "description": "Workflow properties definition.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The resource id." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Gets the resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Gets the resource type." + }, + "kind": { + "type": "string", + "description": "The resource kind." + }, + "location": { + "type": "string", + "description": "The resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "properties": { + "description": "Additional workflow properties.", + "type": "object", + "properties": { + "files": { + "description": "Gets or sets the files.", + "$ref": "#/definitions/WorkflowFiles" + }, + "flowState": { + "description": "Gets or sets the state of the workflow.", + "$ref": "#/definitions/WorkflowState" + }, + "health": { + "$ref": "#/definitions/WorkflowHealth", + "description": "Gets or sets workflow health." + } + } + } + } + }, + "WorkflowEnvelopeCollection": { + "description": "Collection of workflow information elements.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkflowEnvelope" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "WorkflowFiles": { + "description": "Gets or sets the files.", + "type": "object" + }, + "WorkflowHealth": { + "description": "Represents the workflow health.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Gets or sets the workflow health state.", + "enum": [ + "NotSpecified", + "Healthy", + "Unhealthy", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkflowHealthState", + "modelAsString": false + } + }, + "error": { + "$ref": "#/definitions/ErrorEntity", + "description": "Gets or sets the workflow error." + } + } + }, + "WorkflowState": { + "type": "string", + "description": "The workflow state.", + "enum": [ + "NotSpecified", + "Completed", + "Enabled", + "Disabled", + "Deleted", + "Suspended" + ], + "x-ms-enum": { + "name": "WorkflowState", + "modelAsString": true + } + }, + "WorkflowArtifacts": { + "type": "object", + "properties": { + "appSettings": { + "$ref": "#/definitions/Object", + "description": "Application settings of the workflow." + }, + "files": { + "$ref": "#/definitions/WorkflowFiles", + "description": "Files of the app." + }, + "filesToDelete": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Files of the app to delete." + } + }, + "description": "The workflow filter." + }, + "Object": { + "type": "object", + "properties": {} + }, + "ErrorEntity": { + "description": "Body of the error response returned from the API.", + "type": "object", + "properties": { + "extendedCode": { + "description": "Type of error.", + "type": "string" + }, + "messageTemplate": { + "description": "Message template.", + "type": "string" + }, + "parameters": { + "description": "Parameters for the template.", + "type": "array", + "items": { + "type": "string" + } + }, + "innerErrors": { + "description": "Inner errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "details": { + "description": "Error Details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorEntity" + }, + "x-ms-identifiers": [] + }, + "target": { + "description": "The error target.", + "type": "string" + }, + "code": { + "description": "Basic error code.", + "type": "string" + }, + "message": { + "description": "Any details of the error.", + "type": "string" + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironments.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironments.json new file mode 100644 index 000000000000..8b76eb50b93c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironments.json @@ -0,0 +1,1928 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/managedEnvironments": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all Environments for a subscription.", + "description": "Get all Managed Environments for a subscription.", + "operationId": "ManagedEnvironments_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by subscription": { + "$ref": "./examples/ManagedEnvironments_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all the Environments in a resource group.", + "description": "Get all the Managed Environments in a resource group.", + "operationId": "ManagedEnvironments_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by resource group": { + "$ref": "./examples/ManagedEnvironments_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get the properties of a Managed Environment.", + "description": "Get the properties of a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironments_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get environments by name": { + "$ref": "./examples/ManagedEnvironments_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Creates or updates a Managed Environment.", + "description": "Creates or updates a Managed Environment used to host container apps.", + "operationId": "ManagedEnvironments_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create environments": { + "$ref": "./examples/ManagedEnvironments_CreateOrUpdate.json" + }, + "Create environment with custom infrastructureResourceGroup": { + "$ref": "./examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Delete a Managed Environment.", + "description": "Delete a Managed Environment if it does not have any container apps.", + "operationId": "ManagedEnvironments_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "202": { + "description": "Delete operation is in progress" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete environment by name": { + "$ref": "./examples/ManagedEnvironments_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Update Managed Environment's properties.", + "description": "Patches a Managed Environment using JSON Merge Patch", + "operationId": "ManagedEnvironments_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "environmentEnvelope", + "in": "body", + "description": "Configuration details of the Environment.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "202": { + "description": "Patch operation is in progress." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Environment": { + "$ref": "./examples/ManagedEnvironments_Patch.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates": { + "get": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Get the Certificates in a given managed environment.", + "operationId": "Certificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Certificates by Managed Environment": { + "$ref": "./examples/Certificates_ListByManagedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/certificates/{certificateName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Get the specified Certificate.", + "operationId": "Certificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/Certificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Create or Update a Certificate.", + "operationId": "Certificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "description": "Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/Certificate_CreateOrUpdate.json" + }, + "Create or Update Certificate using Managed Identity": { + "$ref": "./examples/Certificate_CreateOrUpdate_FromKeyVault.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Deletes the specified Certificate.", + "operationId": "Certificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/Certificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedEnvironments", + "Certificates" + ], + "summary": "Update properties of a certificate", + "description": "Patches a certificate. Currently only patching of tags is supported", + "operationId": "Certificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "certificateName", + "in": "path", + "description": "Name of the Certificate.", + "required": true, + "type": "string" + }, + { + "name": "certificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/CertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Certificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Certificate": { + "$ref": "./examples/Certificates_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates/{managedCertificateName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Get the specified Managed Certificate.", + "operationId": "ManagedCertificates_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Certificate": { + "$ref": "./examples/ManagedCertificate_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Create or Update a Managed Certificate.", + "operationId": "ManagedCertificates_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateEnvelope", + "in": "body", + "description": "Managed Certificate to be created or updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "400": { + "description": "Bad Request.", + "x-ms-error-response": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Certificate": { + "$ref": "./examples/ManagedCertificate_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Deletes the specified Managed Certificate.", + "operationId": "ManagedCertificates_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Certificate does not exist" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Certificate": { + "$ref": "./examples/ManagedCertificate_Delete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Update tags of a managed certificate", + "description": "Patches a managed certificate. Oly patching of tags is supported", + "operationId": "ManagedCertificates_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateName", + "in": "path", + "description": "Name of the Managed Certificate.", + "required": true, + "type": "string" + }, + { + "name": "managedCertificateEnvelope", + "in": "body", + "required": true, + "description": "Properties of a managed certificate that need to be updated", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificatePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Managed Certificate updated successfully.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificate" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch Managed Certificate": { + "$ref": "./examples/ManagedCertificates_Patch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/managedCertificates": { + "get": { + "tags": [ + "ManagedEnvironments", + "ManagedCertificates" + ], + "summary": "Get the Managed Certificates in a given managed environment.", + "operationId": "ManagedCertificates_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/ManagedCertificateCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Managed Certificates by Managed Environment": { + "$ref": "./examples/ManagedCertificates_ListByManagedEnvironment.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/checkNameAvailability": { + "post": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Checks the resource name availability.", + "description": "Checks if resource name is available.", + "operationId": "Namespaces_CheckNameAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "checkNameAvailabilityRequest", + "in": "body", + "description": "The check name availability request.", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ContainerApps_CheckNameAvailability": { + "$ref": "./examples/ContainerApps_CheckNameAvailability.json" + }, + "Certificates_CheckNameAvailability": { + "$ref": "./examples/Certificates_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/getAuthtoken": { + "post": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get auth token for a managed environment", + "description": "Checks if resource name is available.", + "operationId": "ManagedEnvironments_GetAuthToken", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnvironmentAuthToken" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Managed Environment Auth Token": { + "$ref": "./examples/ManagedEnvironments_GetAuthToken.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/workloadProfileStates": { + "get": { + "tags": [ + "ManagedEnvironments" + ], + "summary": "Get all workload Profile States for a Managed Environment..", + "description": "Get all workload Profile States for a Managed Environment.", + "operationId": "ManagedEnvironments_ListWorkloadProfileStates", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/workloadProfileStatesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List environments by subscription": { + "$ref": "./examples/ManagedEnvironments_ListWorkloadProfileStates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "List private endpoint connections for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Get a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Update the state of a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionEnvelope", + "in": "body", + "description": "The resource of private endpoint and its properties", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ManagedEnvironments", + "PrivateEndpointConnections" + ], + "summary": "Delete a private endpoint connection for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "No content. Already deleted." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete a Private Endpoint Connection by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/privateLinkResources": { + "get": { + "tags": [ + "ManagedEnvironments", + "PrivateLinkResources" + ], + "summary": "List private link resources for a given managed environment.", + "operationId": "ManagedEnvironmentPrivateLinkResources_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Private Link Resources by Managed Environment": { + "$ref": "./examples/ManagedEnvironmentPrivateLinkResources_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AppLogsConfiguration": { + "description": "Configuration of application logs", + "type": "object", + "properties": { + "destination": { + "description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'", + "type": "string" + }, + "logAnalyticsConfiguration": { + "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", + "$ref": "#/definitions/LogAnalyticsConfiguration" + } + } + }, + "AppInsightsConfiguration": { + "description": "Configuration of Application Insights ", + "type": "object", + "properties": { + "connectionString": { + "description": "Application Insights connection string", + "type": "string", + "x-ms-secret": true + } + } + }, + "OpenTelemetryConfiguration": { + "description": "Configuration of Open Telemetry", + "type": "object", + "properties": { + "destinationsConfiguration": { + "description": "Open telemetry destinations configuration", + "$ref": "#/definitions/DestinationsConfiguration" + }, + "tracesConfiguration": { + "description": "Open telemetry trace configuration", + "$ref": "#/definitions/TracesConfiguration" + }, + "logsConfiguration": { + "description": "Open telemetry logs configuration", + "$ref": "#/definitions/LogsConfiguration" + }, + "metricsConfiguration": { + "description": "Open telemetry metrics configuration", + "$ref": "#/definitions/MetricsConfiguration" + } + } + }, + "DestinationsConfiguration": { + "description": "Configuration of Open Telemetry destinations", + "type": "object", + "properties": { + "dataDogConfiguration": { + "description": "Open telemetry datadog destination configuration", + "$ref": "#/definitions/DataDogConfiguration" + }, + "otlpConfigurations": { + "description": "Open telemetry otlp configurations", + "type": "array", + "items": { + "$ref": "#/definitions/OtlpConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "DataDogConfiguration": { + "description": "Configuration of datadog ", + "type": "object", + "properties": { + "site": { + "description": "The data dog site", + "type": "string" + }, + "key": { + "description": "The data dog api key", + "type": "string", + "x-ms-secret": true + } + } + }, + "OtlpConfiguration": { + "description": "Configuration of otlp ", + "type": "object", + "properties": { + "name": { + "description": "The name of otlp configuration", + "type": "string" + }, + "endpoint": { + "description": "The endpoint of otlp configuration", + "type": "string" + }, + "insecure": { + "description": "Boolean indicating if otlp configuration is insecure", + "type": "boolean" + }, + "headers": { + "description": "Headers of otlp configurations", + "type": "array", + "items": { + "$ref": "#/definitions/Header" + }, + "x-ms-identifiers": [ + "key" + ] + } + } + }, + "Header": { + "description": "Header of otlp configuration", + "type": "object", + "properties": { + "key": { + "description": "The key of otlp configuration header", + "type": "string" + }, + "value": { + "description": "The value of otlp configuration header", + "type": "string" + } + } + }, + "TracesConfiguration": { + "description": "Configuration of Open Telemetry traces", + "type": "object", + "properties": { + "includeDapr": { + "type": "boolean", + "description": "Boolean indicating if including dapr traces" + }, + "destinations": { + "description": "Open telemetry traces destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "LogsConfiguration": { + "description": "Configuration of Open Telemetry logs", + "type": "object", + "properties": { + "destinations": { + "description": "Open telemetry logs destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "MetricsConfiguration": { + "description": "Configuration of Open Telemetry metrics", + "type": "object", + "properties": { + "includeKeda": { + "type": "boolean", + "description": "Boolean indicating if including keda metrics" + }, + "destinations": { + "description": "Open telemetry metrics destinations", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "KedaConfiguration": { + "type": "object", + "description": "Configuration properties Keda component", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of Keda" + } + } + }, + "DaprConfiguration": { + "type": "object", + "description": "Configuration properties Dapr component", + "properties": { + "version": { + "type": "string", + "readOnly": true, + "description": "The version of Dapr" + } + } + }, + "VnetConfiguration": { + "type": "object", + "description": "Configuration properties for apps environment to join a Virtual Network", + "properties": { + "internal": { + "type": "boolean", + "description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "infrastructureSubnetId": { + "type": "string", + "description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "dockerBridgeCidr": { + "type": "string", + "description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedCidr": { + "type": "string", + "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "platformReservedDnsIP": { + "type": "string", + "description": " An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "Mtls": { + "type": "object", + "description": "Configuration properties for mutual TLS authentication", + "properties": { + "enabled": { + "type": "boolean", + "description": "Boolean indicating whether the mutual TLS authentication is enabled" + } + } + }, + "ManagedEnvironment": { + "description": "An environment for hosting container apps", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "kind": { + "type": "string", + "description": "Kind of the Environment." + }, + "identity": { + "description": "Managed identities for the Managed Environment to interact with other Azure services without maintaining any secrets or credentials in code.", + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Managed environment resource specific properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Environment.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Waiting", + "InitializationInProgress", + "InfrastructureSetupInProgress", + "InfrastructureSetupComplete", + "ScheduledForDelete", + "UpgradeRequested", + "UpgradeFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EnvironmentProvisioningState", + "modelAsString": true + } + }, + "daprAIInstrumentationKey": { + "type": "string", + "description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "daprAIConnectionString": { + "type": "string", + "description": "Application Insights connection string used by Dapr to export Service to Service communication telemetry", + "x-ms-secret": true + }, + "vnetConfiguration": { + "description": "Vnet configuration for the environment", + "$ref": "#/definitions/VnetConfiguration" + }, + "deploymentErrors": { + "description": "Any errors that occurred during deployment or deployment validation", + "type": "string", + "readOnly": true + }, + "defaultDomain": { + "description": "Default Domain Name for the cluster", + "type": "string", + "readOnly": true + }, + "staticIp": { + "description": "Static IP of the Environment", + "type": "string", + "readOnly": true + }, + "appLogsConfiguration": { + "$ref": "#/definitions/AppLogsConfiguration", + "description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported" + }, + "appInsightsConfiguration": { + "$ref": "#/definitions/AppInsightsConfiguration", + "description": "Environment level Application Insights configuration" + }, + "openTelemetryConfiguration": { + "$ref": "#/definitions/OpenTelemetryConfiguration", + "description": "Environment Open Telemetry configuration" + }, + "zoneRedundant": { + "description": "Whether or not this Managed Environment is zone-redundant.", + "type": "boolean", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "customDomainConfiguration": { + "$ref": "./CommonDefinitions.json#/definitions/CustomDomainConfiguration", + "description": "Custom domain configuration for the environment" + }, + "eventStreamEndpoint": { + "description": "The endpoint of the eventstream of the Environment.", + "type": "string", + "readOnly": true + }, + "workloadProfiles": { + "description": "Workload profiles configured for the Managed Environment.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadProfile" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "kedaConfiguration": { + "$ref": "#/definitions/KedaConfiguration", + "description": "The configuration of Keda component." + }, + "daprConfiguration": { + "$ref": "#/definitions/DaprConfiguration", + "description": "The configuration of Dapr component." + }, + "infrastructureResourceGroup": { + "description": "Name of the platform-managed resource group created for the Managed Environment to host infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as the subnet.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "peerAuthentication": { + "description": "Peer authentication settings for the Managed Environment", + "type": "object", + "properties": { + "mtls": { + "description": "Mutual TLS authentication settings for the Managed Environment", + "$ref": "#/definitions/Mtls" + } + } + }, + "peerTrafficConfiguration": { + "description": "Peer traffic settings for the Managed Environment", + "type": "object", + "properties": { + "encryption": { + "description": "Peer traffic encryption settings for the Managed Environment", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Boolean indicating whether the peer traffic encryption is enabled" + } + } + } + } + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the resource.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "enum": [ + "Enabled", + "Disabled" + ], + "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "ManagedEnvironmentsCollection": { + "description": "Collection of Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedEnvironment" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + }, + "LogAnalyticsConfiguration": { + "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", + "type": "object", + "properties": { + "customerId": { + "description": "Log analytics customer id", + "type": "string" + }, + "sharedKey": { + "description": "Log analytics customer key", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "dynamicJsonColumns": { + "description": "Boolean indicating whether to parse json string log into dynamic json columns", + "type": "boolean" + } + } + }, + "EnvironmentAuthToken": { + "description": "Environment Auth Token.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Environment auth token resource specific properties", + "type": "object", + "properties": { + "token": { + "description": "Auth token value.", + "type": "string", + "x-ms-secret": true, + "readOnly": true + }, + "expires": { + "format": "date-time", + "description": "Token expiration date.", + "type": "string", + "readOnly": true + } + }, + "x-ms-client-flatten": true + } + } + }, + "WorkloadProfile": { + "description": "Workload profile to scope container app execution.", + "type": "object", + "properties": { + "name": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileName", + "description": "Workload profile type for the workloads to run on." + }, + "enableFips": { + "type": "boolean", + "default": false, + "description": "Whether to use a FIPS-enabled OS. Supported only for dedicated workload profiles." + }, + "workloadProfileType": { + "$ref": "./CommonDefinitions.json#/definitions/WorkloadProfileType", + "description": "Workload profile type for the workloads to run on." + }, + "minimumCount": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity." + }, + "maximumCount": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity." + } + }, + "required": [ + "name", + "workloadProfileType" + ] + }, + "workloadProfileStates": { + "description": "Collection of all the workload Profile States for a Managed Environment..", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Workload Profile resource specific properties.", + "type": "object", + "properties": { + "minimumCount": { + "type": "integer", + "format": "int32", + "description": "Minimum count of instances." + }, + "maximumCount": { + "type": "integer", + "format": "int32", + "description": "Maximum count of nodes." + }, + "currentCount": { + "type": "integer", + "format": "int32", + "description": "Current count of nodes." + } + } + } + } + }, + "workloadProfileStatesCollection": { + "description": "Collection of workloadProfileStates", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/workloadProfileStates" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json new file mode 100644 index 000000000000..86493497d774 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/resiliencyPolicies": { + "get": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Get the resiliency policies for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPoliciesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr component resiliency policies": { + "$ref": "./examples/DaprComponentResiliencyPolicies_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/resiliencyPolicies/{name}": { + "get": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Get a Dapr component resiliency policy.", + "operationId": "DaprComponentResiliencyPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr component resiliency policy": { + "$ref": "./examples/DaprComponentResiliencyPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Creates or updates a Dapr component resiliency policy.", + "description": "Creates or updates a resiliency policy for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentResiliencyPolicyEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component Resiliency Policy.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentResiliencyPolicy" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component resiliency policy with all options": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json" + }, + "Create or update dapr component resiliency policy with outbound policy only": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json" + }, + "Create or update dapr component resiliency policy with sparse options": { + "$ref": "./examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponentResiliencyPolicies" + ], + "summary": "Delete a Dapr component resiliency policy.", + "description": "Delete a resiliency policy for a Dapr component.", + "operationId": "DaprComponentResiliencyPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr Component Resiliency Policy.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Dapr component does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component resiliency policy": { + "$ref": "./examples/DaprComponentResiliencyPolicies_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponents.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponents.json new file mode 100644 index 000000000000..a7b5fe73a07b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponents.json @@ -0,0 +1,313 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get the Dapr Components for a managed environment.", + "operationId": "DaprComponents_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponentsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr Components": { + "$ref": "./examples/DaprComponents_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}": { + "get": { + "tags": [ + "DaprComponents" + ], + "summary": "Get a dapr component.", + "operationId": "DaprComponents_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr Component with secrets": { + "$ref": "./examples/DaprComponents_Get_Secrets.json" + }, + "Get Dapr Component with secret store component": { + "$ref": "./examples/DaprComponents_Get_SecretStoreComponent.json" + } + } + }, + "put": { + "tags": [ + "DaprComponents" + ], + "summary": "Creates or updates a Dapr Component.", + "description": "Creates or updates a Dapr Component in a Managed Environment.", + "operationId": "DaprComponents_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "name": "daprComponentEnvelope", + "in": "body", + "description": "Configuration details of the Dapr Component.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprComponent" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr component with secrets": { + "$ref": "./examples/DaprComponents_CreateOrUpdate_Secrets.json" + }, + "Create or update dapr component with secret store component": { + "$ref": "./examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json" + } + } + }, + "delete": { + "tags": [ + "DaprComponents" + ], + "summary": "Delete a Dapr Component.", + "description": "Delete a Dapr Component from a Managed Environment.", + "operationId": "DaprComponents_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr component": { + "$ref": "./examples/DaprComponents_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprComponents/{componentName}/listSecrets": { + "post": { + "tags": [ + "DaprComponents" + ], + "summary": "List secrets for a dapr component", + "operationId": "DaprComponents_ListSecrets", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string" + }, + { + "name": "componentName", + "in": "path", + "description": "Name of the Dapr Component.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSecretsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Container Apps Secrets": { + "$ref": "./examples/DaprComponents_ListSecrets.json" + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprSubscriptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprSubscriptions.json new file mode 100644 index 000000000000..0b5d66ec7dee --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprSubscriptions.json @@ -0,0 +1,276 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprSubscriptions": { + "get": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Get the Dapr subscriptions for a managed environment.", + "operationId": "DaprSubscriptions_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscriptionsCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Dapr subscriptions": { + "$ref": "./examples/DaprSubscriptions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/daprSubscriptions/{name}": { + "get": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Get a dapr subscription.", + "operationId": "DaprSubscriptions_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Dapr subscription with default route only": { + "$ref": "./examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json" + }, + "Get Dapr subscription with bulk subscribe configuration and scopes": { + "$ref": "./examples/DaprSubscriptions_Get_DefaultRoute.json" + }, + "GetDapr subscription with route rules and metadata": { + "$ref": "./examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json" + } + } + }, + "put": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Creates or updates a Dapr subscription.", + "description": "Creates or updates a Dapr subscription in a Managed Environment.", + "operationId": "DaprSubscriptions_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "name": "daprSubscriptionEnvelope", + "in": "body", + "description": "Configuration details of the Dapr subscription.", + "required": true, + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DaprSubscription" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Create or update dapr subscription with default route only": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json" + }, + "Create or update dapr subscription with bulk subscribe configuration and scopes": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json" + }, + "Create or update dapr subscription with route rules and metadata": { + "$ref": "./examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json" + } + } + }, + "delete": { + "tags": [ + "DaprSubscriptions" + ], + "summary": "Delete a Dapr subscription.", + "description": "Delete a Dapr subscription from a Managed Environment.", + "operationId": "DaprSubscriptions_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Managed Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$" + }, + { + "name": "name", + "in": "path", + "description": "Name of the Dapr subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete operation completed" + }, + "204": { + "description": "Environment does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete dapr subscription": { + "$ref": "./examples/DaprSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation": false + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsStorages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsStorages.json new file mode 100644 index 000000000000..1d1b7b83545d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsStorages.json @@ -0,0 +1,300 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages": { + "get": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Get all storages for a managedEnvironment.", + "description": "Get all storages for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStoragesCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ManagedEnvironmentsStorages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/storages/{storageName}": { + "get": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Get storage for a managedEnvironment.", + "description": "Get storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "get a environments storage": { + "$ref": "./examples/ManagedEnvironmentsStorages_Get.json" + }, + "get a environments storage for NFS Azure file": { + "$ref": "./examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json" + } + } + }, + "put": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Create or update storage for a managedEnvironment.", + "description": "Create or update storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "name": "storageEnvelope", + "in": "body", + "description": "Configuration details of storage.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update environments storage": { + "$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate.json" + }, + "Create or update environments storage for NFS Azure file": { + "$ref": "./examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json" + } + } + }, + "delete": { + "tags": [ + "ManagedEnvironmentsStorages" + ], + "summary": "Delete storage for a managedEnvironment.", + "description": "Delete storage for a managedEnvironment.", + "operationId": "ManagedEnvironmentsStorages_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string" + }, + { + "name": "storageName", + "in": "path", + "description": "Name of the storage.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "Storage does not exist" + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List environments storages by subscription": { + "$ref": "./examples/ManagedEnvironmentsStorages_Delete.json" + } + } + } + } + }, + "definitions": { + "ManagedEnvironmentStoragesCollection": { + "description": "Collection of Storage for Environments", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of storage resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedEnvironmentStorage" + } + } + } + }, + "ManagedEnvironmentStorage": { + "description": "Storage resource for managedEnvironment.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Storage properties", + "type": "object", + "properties": { + "azureFile": { + "$ref": "./CommonDefinitions.json#/definitions/AzureFileProperties", + "description": "Azure file properties" + }, + "nfsAzureFile": { + "$ref": "./CommonDefinitions.json#/definitions/NfsAzureFileProperties", + "description": "NFS Azure file properties" + } + } + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SessionPools.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SessionPools.json new file mode 100644 index 000000000000..62095337f49e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SessionPools.json @@ -0,0 +1,708 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerApps API Client", + "version": "2024-08-02-preview" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "parameters": { + "SessionPoolNameParameter": { + "name": "sessionPoolName", + "in": "path", + "description": "Name of the session pool.", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "minLength": 3, + "maxLength": 63, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/sessionPools": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the session pools in a given subscription.", + "operationId": "ContainerAppsSessionPools_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionPoolCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Session Pools by subscription": { + "$ref": "./examples/SessionPools_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the session pools in a given resource group of a subscription.", + "operationId": "ContainerAppsSessionPools_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SessionPoolCollection" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Session Pools by resource group": { + "$ref": "./examples/SessionPools_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/sessionPools/{sessionPoolName}": { + "get": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Get the properties of a session pool.", + "operationId": "ContainerAppsSessionPools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Session Pool": { + "$ref": "./examples/SessionPools_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Create or update a session pool.", + "description": "Create or update a session pool with the given properties.", + "operationId": "ContainerAppsSessionPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "name": "sessionPoolEnvelope", + "in": "body", + "description": "Properties used to create a session pool", + "required": true, + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update succeeded", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "201": { + "description": "Session pool creation has started.", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create or Update Session Pool": { + "$ref": "./examples/SessionPools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Update properties of a session pool", + "description": "Patches a session pool using JSON merge patch", + "operationId": "ContainerAppsSessionPools_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "name": "sessionPoolEnvelope", + "in": "body", + "description": "Properties used to create a session pool", + "required": true, + "schema": { + "$ref": "#/definitions/SessionPoolUpdatableProperties" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Update succeeded", + "schema": { + "$ref": "#/definitions/SessionPool" + } + }, + "202": { + "description": "Session pool update has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Update Session Pool": { + "$ref": "./examples/SessionPools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "ContainerAppsSessionPools" + ], + "summary": "Delete a session pool.", + "description": "Delete the session pool with the given name.", + "operationId": "ContainerAppsSessionPools_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SessionPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Session pool delete has been started.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "Session pool does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Session Pool": { + "$ref": "./examples/SessionPools_Delete.json" + } + } + } + } + }, + "definitions": { + "ScaleConfiguration": { + "description": "Scale configuration.", + "type": "object", + "properties": { + "maxConcurrentSessions": { + "description": "The maximum count of sessions at the same time.", + "type": "integer", + "format": "int32" + }, + "readySessionInstances": { + "description": "The minimum count of ready session instances.", + "type": "integer", + "format": "int32" + } + } + }, + "SessionPoolSecret": { + "description": "Secret definition.", + "type": "object", + "properties": { + "name": { + "description": "Secret Name.", + "type": "string" + }, + "value": { + "description": "Secret Value.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "DynamicPoolConfiguration": { + "description": "Dynamic pool configuration.", + "type": "object", + "properties": { + "executionType": { + "description": "The execution type of the session pool.", + "enum": [ + "Timed" + ], + "type": "string", + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "cooldownPeriodInSeconds": { + "description": "The cooldown period of a session in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "SessionRegistryCredentials": { + "description": "Session pool private registry credentials.", + "type": "object", + "properties": { + "server": { + "description": "Container registry server.", + "type": "string" + }, + "username": { + "description": "Container registry username.", + "type": "string" + }, + "passwordSecretRef": { + "description": "The name of the secret that contains the registry login password", + "type": "string" + }, + "identity": { + "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'", + "type": "string" + } + } + }, + "SessionContainerResources": { + "description": "Container resource requirements for sessions of the session pool.", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "Required CPU in cores, e.g. 0.5", + "type": "number" + }, + "memory": { + "description": "Required memory, e.g. \"250Mb\"", + "type": "string" + } + } + }, + "SessionContainer": { + "description": "Container definitions for the sessions of the session pool.", + "type": "object", + "properties": { + "image": { + "description": "Container image tag.", + "type": "string" + }, + "name": { + "description": "Custom container name.", + "type": "string" + }, + "command": { + "description": "Container start command.", + "type": "array", + "items": { + "type": "string" + } + }, + "args": { + "description": "Container start command arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "env": { + "description": "Container environment variables.", + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVar" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "resources": { + "$ref": "#/definitions/SessionContainerResources", + "description": "Container resource requirements." + } + } + }, + "SessionIngress": { + "description": "Session pool ingress configuration.", + "type": "object", + "properties": { + "targetPort": { + "format": "int32", + "description": "Target port in containers for traffic from ingress", + "type": "integer" + } + } + }, + "CustomContainerTemplate": { + "description": "Custom container configuration.", + "type": "object", + "properties": { + "registryCredentials": { + "description": "Private container registry credentials for containers used by the sessions of the session pool.", + "$ref": "#/definitions/SessionRegistryCredentials" + }, + "containers": { + "description": "List of container definitions for the sessions of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionContainer" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "ingress": { + "description": "Session pool ingress configuration.", + "$ref": "#/definitions/SessionIngress" + } + } + }, + "SessionNetworkConfiguration": { + "description": "Session network configuration.", + "type": "object", + "properties": { + "status": { + "description": "Network status for the sessions.", + "type": "string", + "enum": [ + "EgressEnabled", + "EgressDisabled" + ], + "x-ms-enum": { + "name": "SessionNetworkStatus", + "modelAsString": true + } + } + } + }, + "SessionPool": { + "description": "Container App session pool.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Container App session pool resource specific properties", + "type": "object", + "properties": { + "environmentId": { + "description": "Resource ID of the session pool's environment.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.App/managedEnvironments" + } + ] + }, + "x-ms-mutability": [ + "create", + "read" + ] + }, + "containerType": { + "description": "The container type of the sessions.", + "enum": [ + "CustomContainer", + "PythonLTS" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true + } + }, + "poolManagementType": { + "description": "The pool management type of the session pool.", + "enum": [ + "Manual", + "Dynamic" + ], + "type": "string", + "x-ms-enum": { + "name": "PoolManagementType", + "modelAsString": true + } + }, + "nodeCount": { + "description": "The number of nodes the session pool is using.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "scaleConfiguration": { + "description": "The scale configuration of the session pool.", + "$ref": "#/definitions/ScaleConfiguration" + }, + "secrets": { + "description": "The secrets of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPoolSecret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dynamicPoolConfiguration": { + "description": "The pool configuration if the poolManagementType is dynamic.", + "$ref": "#/definitions/DynamicPoolConfiguration" + }, + "customContainerTemplate": { + "description": "The custom container configuration if the containerType is CustomContainer.", + "$ref": "#/definitions/CustomContainerTemplate" + }, + "sessionNetworkConfiguration": { + "description": "The network configuration of the sessions in the session pool.", + "$ref": "#/definitions/SessionNetworkConfiguration" + }, + "poolManagementEndpoint": { + "description": "The endpoint to manage the pool.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the session pool.", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled", + "Deleting" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SessionPoolProvisioningState", + "modelAsString": true + } + } + }, + "x-ms-client-flatten": true + } + } + }, + "SessionPoolUpdatableProperties": { + "description": "Container App session pool updatable properties.", + "type": "object", + "properties": { + "properties": { + "description": "Session pool resource specific updatable properties.", + "type": "object", + "properties": { + "scaleConfiguration": { + "description": "The scale configuration of the session pool.", + "$ref": "#/definitions/ScaleConfiguration" + }, + "secrets": { + "description": "The secrets of the session pool.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPoolSecret" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "dynamicPoolConfiguration": { + "description": "The pool configuration if the poolManagementType is dynamic.", + "$ref": "#/definitions/DynamicPoolConfiguration" + }, + "customContainerTemplate": { + "description": "The custom container configuration if the containerType is CustomContainer.", + "$ref": "#/definitions/CustomContainerTemplate" + }, + "sessionNetworkConfiguration": { + "description": "The network configuration of the sessions in the session pool.", + "$ref": "#/definitions/SessionNetworkConfiguration" + } + }, + "x-ms-client-flatten": true + } + } + }, + "SessionPoolCollection": { + "description": "Session pool collection Azure resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SessionPool" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json new file mode 100644 index 000000000000..46f1d8e44b58 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/SourceControls.json @@ -0,0 +1,488 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols": { + "get": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Get the Container App SourceControls in a given resource group.", + "operationId": "ContainerAppsSourceControls_ListByContainerApp", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlCollection" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List App's Source Controls": { + "$ref": "./examples/SourceControls_ListByContainer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/sourcecontrols/{sourceControlName}": { + "get": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Get a SourceControl of a Container App.", + "operationId": "ContainerAppsSourceControls_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Container App's SourceControl": { + "$ref": "./examples/SourceControls_Get.json" + } + } + }, + "put": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Create or update the SourceControl for a Container App.", + "description": "Create or update the SourceControl for a Container App.", + "operationId": "ContainerAppsSourceControls_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlEnvelope", + "in": "body", + "description": "Properties used to create a Container App SourceControl", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + { + "name": "x-ms-github-auxiliary", + "in": "header", + "description": "Github personal access token used for SourceControl.", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or Update Container App SourceControl": { + "$ref": "./examples/SourceControls_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ContainerAppsSourceControls" + ], + "summary": "Delete a Container App SourceControl.", + "description": "Delete a Container App SourceControl.", + "operationId": "ContainerAppsSourceControls_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "containerAppName", + "in": "path", + "description": "Name of the Container App.", + "required": true, + "type": "string" + }, + { + "name": "sourceControlName", + "in": "path", + "description": "Name of the Container App SourceControl.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-github-auxiliary", + "in": "header", + "description": "Github personal access token used for SourceControl.", + "required": false, + "type": "string" + }, + { + "name": "ignoreWorkflowDeletionFailure", + "in": "query", + "description": "Ignore Workflow Deletion Failure.", + "required": false, + "type": "boolean" + }, + { + "name": "deleteWorkflow", + "in": "query", + "description": "Delete workflow.", + "required": false, + "type": "boolean" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Container App SourceControl deleted successfully." + }, + "202": { + "description": "Delete operation is in progress." + }, + "204": { + "description": "Container App SourceControl does not exist." + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Container App SourceControl": { + "$ref": "./examples/SourceControls_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "SourceControl": { + "description": "Container App SourceControl.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SourceControl resource specific properties", + "type": "object", + "properties": { + "operationState": { + "description": "Current provisioning State of the operation", + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SourceControlOperationState", + "modelAsString": true + } + }, + "repoUrl": { + "description": "The repo url which will be integrated to ContainerApp.", + "type": "string" + }, + "branch": { + "description": "The branch which will trigger the auto deployment", + "type": "string" + }, + "githubActionConfiguration": { + "$ref": "#/definitions/GithubActionConfiguration", + "description": "Container App Revision Template with all possible settings and the\ndefaults if user did not provide them. The defaults are populated\nas they were at the creation time" + } + }, + "x-ms-client-flatten": true + } + } + }, + "GithubActionConfiguration": { + "description": "Configuration properties that define the mutable settings of a Container App SourceControl", + "type": "object", + "properties": { + "registryInfo": { + "$ref": "#/definitions/RegistryInfo", + "description": "Registry configurations." + }, + "azureCredentials": { + "$ref": "#/definitions/AzureCredentials", + "description": "AzureCredentials configurations." + }, + "contextPath": { + "description": "Context path", + "type": "string" + }, + "dockerfilePath": { + "description": "Dockerfile path", + "type": "string" + }, + "githubPersonalAccessToken": { + "description": "One time Github PAT to configure github environment", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "image": { + "description": "Image name", + "type": "string" + }, + "publishType": { + "description": "Code or Image", + "type": "string" + }, + "os": { + "description": "Operation system", + "type": "string" + }, + "runtimeStack": { + "description": "Runtime stack", + "type": "string" + }, + "runtimeVersion": { + "description": "Runtime version", + "type": "string" + }, + "buildEnvironmentVariables": { + "type": "array", + "items": { + "$ref": "./CommonDefinitions.json#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of environment variables to be passed to the build." + } + } + }, + "RegistryInfo": { + "description": "Container App registry information.", + "type": "object", + "properties": { + "registryUrl": { + "description": "registry server Url.", + "type": "string" + }, + "registryUserName": { + "description": "registry username.", + "type": "string" + }, + "registryPassword": { + "description": "registry secret.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + } + } + }, + "AzureCredentials": { + "description": "Container App credentials.", + "type": "object", + "properties": { + "clientId": { + "description": "Client Id.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "clientSecret": { + "description": "Client Secret.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "tenantId": { + "description": "Tenant Id.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ], + "x-ms-secret": true + }, + "kind": { + "description": "Kind of auth github does for deploying the template", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "subscriptionId": { + "description": "Subscription Id.", + "type": "string" + } + } + }, + "SourceControlCollection": { + "description": "SourceControl collection ARM resource.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "Collection of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/SourceControl" + } + }, + "nextLink": { + "description": "Link to next page of resources.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Subscriptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Subscriptions.json new file mode 100644 index 000000000000..8d3c2c50a759 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Subscriptions.json @@ -0,0 +1,80 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/getCustomDomainVerificationId": { + "post": { + "tags": [ + "Subscriptions" + ], + "description": "Get the verification id of a subscription used for verifying custom domains", + "operationId": "GetCustomDomainVerificationId", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The custom domain verification id has been returned successfully.", + "schema": { + "$ref": "#/definitions/CustomDomainVerificationId" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List all operations": { + "$ref": "./examples/Subscriptions_GetCustomDomainVerificationId.json" + } + } + } + } + }, + "definitions": { + "CustomDomainVerificationId": { + "description": "Custom domain verification Id of a subscription", + "type": "string", + "readOnly": true + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Usages.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Usages.json new file mode 100644 index 000000000000..78d99d867bac --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/Usages.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-08-02-preview", + "title": "ContainerApps API Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.App/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "Gets, for the specified location, the current resource usage information as well as the limits under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/Usages_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "ManagedEnvironmentUsages_List", + "description": "Gets the current usage information as well as the limits for environment.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "description": "Name of the Environment.", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "Common error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed environment usages": { + "$ref": "./examples/ManagedEnvironmentUsages_List.json" + } + } + } + } + }, + "definitions": { + "UsageName": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "number", + "format": "float", + "description": "The current usage of the resource." + }, + "limit": { + "type": "number", + "format": "float", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_CreateOrUpdate.json new file mode 100644 index 000000000000..5644fc0b3496 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_CreateOrUpdate.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-08-02-preview", + "resiliencyEnvelope": { + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Delete.json new file mode 100644 index 000000000000..7bfb1900a912 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Get.json new file mode 100644 index 000000000000..9b3423625e17 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_List.json new file mode 100644 index 000000000000..9b62547e9306 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_List.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 15, + "connectionTimeoutInSeconds": 5 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Patch.json new file mode 100644 index 000000000000..607830a4434a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AppResiliency_Patch.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "appName": "testcontainerApp0", + "name": "resiliency-policy-1", + "api-version": "2024-08-02-preview", + "resiliencyEnvelope": { + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 30, + "connectionTimeoutInSeconds": 40 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/resiliencyPolicies/resiliency-policy-1", + "name": "resiliency-policy-1", + "type": "Microsoft.App/containerApps/resiliencyPolicies", + "properties": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 30, + "connectionTimeoutInSeconds": 40 + }, + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 1000, + "maxIntervalInMilliseconds": 10000 + }, + "matches": { + "headers": [ + { + "header": "X-Content-Type", + "match": { + "prefixMatch": "GOATS" + } + } + ], + "httpStatusCodes": [ + 502, + 503 + ], + "errors": [ + "5xx", + "connect-failure", + "reset", + "retriable-headers", + "retriable-status-codes" + ] + } + }, + "tcpRetryPolicy": { + "maxConnectAttempts": 3 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "intervalInSeconds": 10, + "maxEjectionPercent": 50 + }, + "tcpConnectionPool": { + "maxConnections": 100 + }, + "httpConnectionPool": { + "http1MaxPendingRequests": 1024, + "http2MaxRequests": 1024 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_CreateOrUpdate.json new file mode 100644 index 000000000000..4b394610b3f4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_CreateOrUpdate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-08-02-preview", + "authConfigEnvelope": { + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Delete.json new file mode 100644 index 000000000000..122f9fcab2ff --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Get.json new file mode 100644 index 000000000000..4cd4e6f4d17a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "authConfigName": "current", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_ListByContainer.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_ListByContainer.json new file mode 100644 index 000000000000..c8d7d8b080f3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AuthConfigs_ListByContainer.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/authconfigs/current", + "name": "current", + "type": "Microsoft.App/containerapps/authconfigs", + "properties": { + "platform": { + "enabled": true + }, + "globalValidation": { + "unauthenticatedClientAction": "AllowAnonymous" + }, + "identityProviders": { + "facebook": { + "registration": { + "appId": "123", + "appSecretSettingName": "facebook-secret" + } + } + }, + "encryptionSettings": { + "containerAppAuthEncryptionSecretName": "testEncryptionSecretName", + "containerAppAuthSigningSecretName": "testSigningSecretName" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AvailableWorkloadProfiles_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AvailableWorkloadProfiles_Get.json new file mode 100644 index 000000000000..a65cf6a7d107 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/AvailableWorkloadProfiles_Get.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "East US", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D4", + "category": "General purpose D-series", + "applicability": "LocationDefault", + "cores": 4, + "memoryGiB": 16 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D4", + "name": "Dedicated-D4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D8", + "category": "General purpose D-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D8", + "name": "Dedicated-D4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-D16", + "category": "General purpose D-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 64 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-D16", + "name": "Dedicated-D16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E4", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 4, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E4", + "name": "Dedicated-E4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E8", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 64 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E8", + "name": "Dedicated-E8", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-E16", + "category": "Memory optimized E-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 128 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-E16", + "name": "Dedicated-E16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F4", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 4, + "memoryGiB": 8 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F4", + "name": "Dedicated-F4", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F8", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 8, + "memoryGiB": 16 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F8", + "name": "Dedicated-F8", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-F16", + "category": "Compute optimized F-series", + "applicability": "Custom", + "cores": 16, + "memoryGiB": 32 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Dedicated-F16", + "name": "Dedicated-F16", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Dedicated-NC48-A100", + "category": "GPU-NC-A100", + "applicability": "Custom", + "cores": 48, + "memoryGiB": 440, + "gpus": 2 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/NC48-A100", + "name": "NC48-A100", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + }, + { + "location": "East US", + "properties": { + "displayName": "Consumption", + "category": "Consumption", + "applicability": "Custom", + "cores": 3, + "memoryGiB": 3 + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes/Consumption", + "name": "Consumption", + "type": "Microsoft.App/availableManagedEnvironmentsWorkloadProfileTypes" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/BillingMeters_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/BillingMeters_Get.json new file mode 100644 index 000000000000..312e53abd512 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/BillingMeters_Get.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "location": "East US", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "East US", + "properties": { + "category": "General purpose D-series", + "meterType": "CPU", + "displayName": "General Purpose Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesCPU", + "name": "GeneralPurposeDseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "General purpose D-series", + "meterType": "Memory", + "displayName": "General Purpose Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralPurposeDseriesMemory", + "name": "GeneralPurposeDseriesMemory", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Memory optimized E-series", + "meterType": "CPU", + "displayName": "Memory Optimized Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesCPU", + "name": "MemoryOptimizedEseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Memory optimized E-series", + "meterType": "Memory", + "displayName": "Memory Optimized Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/MemoryOptimizedEseriesMemory", + "name": "MemoryOptimizedEseriesMemory", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Compute optimized F-series", + "meterType": "CPU", + "displayName": "Compute Optimized Cores per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/ComputeOptimizedFseriesCPU", + "name": "ComputeOptimizedFseriesCPU", + "type": "Microsoft.App/billingMeters" + }, + { + "location": "East US", + "properties": { + "category": "Compute optimized F-series", + "meterType": "Memory", + "displayName": "Compute Optimized Memory GiB per Second" + }, + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/GeneralComputeMemory", + "name": "GeneralComputeMemory", + "type": "Microsoft.App/billingMeters" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_CreateOrUpdate.json new file mode 100644 index 000000000000..8f2a3cea168e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_CreateOrUpdate.json @@ -0,0 +1,128 @@ +{ + "operationId": "Builders_CreateOrUpdate", + "title": "Builders_CreateOrUpdate_0", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "api-version": "2024-08-02-preview", + "builderEnvelope": { + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "tags": { + "company": "Microsoft" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "company": "Microsoft" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Creating", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "company": "Microsoft" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Delete.json new file mode 100644 index 000000000000..6a1453394956 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Delete.json @@ -0,0 +1,18 @@ +{ + "operationId": "Builders_Delete", + "title": "Builders_Delete_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Get.json new file mode 100644 index 000000000000..ae1ad23c723e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Get.json @@ -0,0 +1,56 @@ +{ + "operationId": "Builders_Get", + "title": "Builders_Get_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListByResourceGroup.json new file mode 100644 index 000000000000..d56c67db38ec --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListByResourceGroup.json @@ -0,0 +1,102 @@ +{ + "operationId": "Builders_ListByResourceGroup", + "title": "Builders_ListByResourceGroup_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder1", + "name": "testBuilder1", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder2", + "name": "testBuilder2", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListBySubscription.json new file mode 100644 index 000000000000..807764e40771 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_ListBySubscription.json @@ -0,0 +1,101 @@ +{ + "operationId": "Builders_ListBySubscription", + "title": "Builders_ListBySubscription_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.App/builders/testBuilder1", + "name": "testBuilder1", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg2/providers/Microsoft.App/builders/testBuilder2", + "name": "testBuilder2", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Update.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Update.json new file mode 100644 index 000000000000..dc99a9ba4f6d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builders_Update.json @@ -0,0 +1,66 @@ +{ + "operationId": "Builders_Update", + "title": "Builders_Update_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "builderEnvelope": { + "tags": { + "mytag1": "myvalue1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder", + "name": "testBuilder", + "type": "Microsoft.App/builders", + "location": "eastus", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/managedEnvironments/testEnv", + "containerRegistries": [ + { + "containerRegistryServer": "test.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + }, + { + "containerRegistryServer": "test2.azurecr.io", + "identityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + ] + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + }, + "tags": { + "mytag1": "myvalue1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate.json new file mode 100644 index 000000000000..2ca5f926c124 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate.json @@ -0,0 +1,214 @@ +{ + "operationId": "Builds_CreateOrUpdate", + "title": "Builds_CreateOrUpdate_WithConfig", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild-123456789az", + "api-version": "2024-08-02-preview", + "buildEnvelope": { + "properties": { + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild-123456789az", + "name": "testBuild-123456789az", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/build", + "properties": { + "provisioningState": "Creating", + "buildStatus": "NotStarted", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json new file mode 100644 index 000000000000..eafb6876a56d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_CreateOrUpdate_NoConfig.json @@ -0,0 +1,61 @@ +{ + "operationId": "Builds_CreateOrUpdate", + "title": "Builds_CreateOrUpdate_NoConfig", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild", + "api-version": "2024-08-02-preview", + "buildEnvelope": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/build", + "properties": { + "provisioningState": "Creating", + "buildStatus": "InProgress", + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Delete.json new file mode 100644 index 000000000000..51c78607494d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "Builds_Delete", + "title": "Builds_Delete_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Get.json new file mode 100644 index 000000000000..ff2aed462c71 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_Get.json @@ -0,0 +1,85 @@ +{ + "operationId": "Builds_Get", + "title": "Builds_Get_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListAuthToken.json new file mode 100644 index 000000000000..3da981536682 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListAuthToken.json @@ -0,0 +1,20 @@ +{ + "operationId": "Builds_ListAuthToken", + "title": "Builds_ListAuthToken_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder", + "buildName": "testBuild" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "token": "foobartoken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListByBuilderResource.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListByBuilderResource.json new file mode 100644 index 000000000000..84d5c1d73923 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Builds_ListByBuilderResource.json @@ -0,0 +1,159 @@ +{ + "operationId": "Builds_ListByBuilderResource", + "title": "Builds_ListByBuilderResource_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "builderName": "testBuilder" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild1", + "name": "testBuild1", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/builders/testBuilder/builds/testBuild2", + "name": "testBuild2", + "type": "Microsoft.App/builders/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "uploadEndpoint": "https://foo.azurecontainerapps.dev/upload", + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream", + "tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate.json new file mode 100644 index 000000000000..70a8dfb9bc1b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "password": "private key password", + "value": "Y2VydA==", + "certificateType": "ImagePullTrustedCA" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ImagePullTrustedCA" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json new file mode 100644 index 000000000000..5420a57da613 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_CreateOrUpdate_FromKeyVault.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "certificateKeyVaultProperties": { + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi", + "keyVaultUrl": "https://xxxxxxxx.vault.azure.net/certificates/certName" + }, + "certificateType": "ServerSSLCertificate" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "certificateKeyVaultProperties": { + "identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/test-user-mi", + "keyVaultUrl": "https://xxxxxxxx.vault.azure.net/certificates/certName" + }, + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Delete.json new file mode 100644 index 000000000000..74a445e86603 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Get.json new file mode 100644 index 000000000000..8b428b6b288d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificate_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_CheckNameAvailability.json new file mode 100644 index 000000000000..6214126feb82 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcertificatename", + "type": "Microsoft.App/managedEnvironments/certificates" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_ListByManagedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_ListByManagedEnvironment.json new file mode 100644 index 000000000000..6e81bf5ed4fe --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_ListByManagedEnvironment.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ImagePullTrustedCA" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_Patch.json new file mode 100644 index 000000000000..e63548baf716 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Certificates_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "certificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/Certificates", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true, + "certificateType": "ServerSSLCertificate" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json new file mode 100644 index 000000000000..5ad8b02a0517 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_CreateOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "certificateEnvelope": { + "location": "East US", + "properties": { + "password": "private key password", + "value": "Y2VydA==" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certififcates/certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json new file mode 100644 index 000000000000..35fdcad1bdb3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json new file mode 100644 index 000000000000..378b4852ce51 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificate_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json new file mode 100644 index 000000000000..a2dd603f9d4c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcertificatename", + "type": "Microsoft.App/connectedEnvironments/certificates" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json new file mode 100644 index 000000000000..b8c0df5072d1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_ListByConnectedEnvironment.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "name": "certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json new file mode 100644 index 000000000000..d07792b54b57 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsCertificates_Patch.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testcontainerenv", + "certificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "certificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testcontainerenv/certificates/certificate-firendly-name", + "type": "Microsoft.App/ConnectedEnvironments/Certificates", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "subjectName": "my-subject-name.company.country.net", + "subjectAlternativeNames": [ + "CN=my-subject-name.com" + ], + "issuer": "Issuer Name", + "issueDate": "2021-11-06T04:00:00Z", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT", + "valid": true + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..a4ad30dd068e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_CreateOrUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey", + "value": "keyvalue" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json new file mode 100644 index 000000000000..1fb8057f94bd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json new file mode 100644 index 000000000000..3fc5e218e87d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_Get.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json new file mode 100644 index 000000000000..f7506a5a8b41 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/myenvironment/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/connectedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json new file mode 100644 index 000000000000..c29931160eaa --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsDaprComponents_ListSecrets.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1", + "value": "value1" + }, + { + "name": "secret2", + "value": "value2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json new file mode 100644 index 000000000000..acfd1e31ada8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_CreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview", + "storageEnvelope": { + "properties": { + "azureFile": { + "accountName": "account1", + "accountKey": "key", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json new file mode 100644 index 000000000000..30c102604d6c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Get.json new file mode 100644 index 000000000000..e4ace335a5bd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "env", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/env/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_List.json new file mode 100644 index 000000000000..050676d53d87 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironmentsStorages_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "managedEnv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/connectedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..4cd8a0c0ca34 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_CreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testenv", + "api-version": "2024-08-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "environmentEnvelope": { + "location": "East US", + "properties": { + "staticIp": "1.2.3.4", + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "private key password" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "1.2.3.4", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Waiting", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "1.2.3.4" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Delete.json new file mode 100644 index 000000000000..13720133c0d0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "examplekenv", + "api-version": "2024-08-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Get.json new file mode 100644 index 000000000000..38996dca4cd5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "examplekenv", + "api-version": "2024-08-02-preview", + "kind": "kubernetes", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/examplekenv", + "name": "examplekenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "examplekenv.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..3d5c7b7157b1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListByResourceGroup.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1", + "name": "sample1", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample1.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample2", + "name": "sample2", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "extendedLocation": { + "name": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample2.k4apps.io", + "staticIp": "52.142.21.61", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..60579aec5cd7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/sample1", + "name": "sample1", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample1.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/connectedEnvironments/sample2", + "name": "sample2", + "type": "Microsoft.App/connectedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "sample2.k4apps.io", + "staticIp": "52.142.21.61", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Patch.json new file mode 100644 index 000000000000..4ddfd131f22e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ConnectedEnvironments_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "connectedEnvironmentName": "testenv", + "api-version": "2024-08-02-preview", + "location": "East US", + "environmentEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/connectedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/connectedEnvironments", + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testenv.k4apps.io", + "staticIp": "20.42.33.145", + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Delete.json new file mode 100644 index 000000000000..1656aa542f94 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ContainerAppsBuilds_Delete", + "title": "ContainerAppsBuilds_Delete_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp", + "buildName": "testBuild" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Get.json new file mode 100644 index 000000000000..54868af7299c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_Get.json @@ -0,0 +1,83 @@ +{ + "operationId": "ContainerAppsBuilds_Get", + "title": "ContainerAppsBuilds_Get_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp", + "buildName": "testBuild" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild", + "name": "testBuild", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json new file mode 100644 index 000000000000..bafe3e307bbf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsBuilds_ListByContainerApp.json @@ -0,0 +1,155 @@ +{ + "operationId": "ContainerAppsBuildsByContainerApp_List", + "title": "ContainerAppsBuilds_ListByContainerApp_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testCapp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild1", + "name": "testBuild1", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/Microsoft.App/containerApps/testCapp/builds/testBuild2", + "name": "testBuild2", + "type": "Microsoft.App/containerApps/builds", + "properties": { + "provisioningState": "Succeeded", + "buildStatus": "InProgress", + "destinationContainerRegistry": { + "server": "test.azurecr.io", + "image": "test.azurecr.io/repo:tag" + }, + "configuration": { + "baseOs": "DebianBullseye", + "platform": "dotnetcore", + "platformVersion": "7.0", + "environmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "preBuildSteps": [ + { + "description": "First pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'world'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo", + "bar" + ] + } + }, + { + "description": "Second pre build step.", + "scripts": [ + "echo 'hello'", + "echo 'again'" + ], + "httpGet": { + "url": "https://microsoft.com", + "fileName": "output.txt", + "headers": [ + "foo" + ] + } + } + ] + }, + "logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream" + }, + "systemData": { + "createdBy": "sample@microsoft.com", + "createdByType": "User", + "createdAt": "2022-10-11T11:05:51.4940669Z", + "lastModifiedBy": "sample@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2022-10-11T11:05:51.4940669Z" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_Get.json new file mode 100644 index 000000000000..9e7c41fd3c40 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "containerAppName": "mikono-capp-stage1", + "detectorName": "cappcontainerappnetworkIO", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappcontainerappnetworkIO", + "name": "cappcontainerappnetworkIO", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappcontainerappnetworkIO", + "name": "Container App Network Inbound and Outbound", + "description": "This detector shows the Container App Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Container Apps Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_List.json new file mode 100644 index 000000000000..006b47506619 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsDiagnostics_List.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "containerAppName": "mikono-capp-stage1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/containerApps/mikono-capp-stage1/detectors/cappContainerAppAvailabilityMetrics", + "name": "cappContainerAppAvailabilityMetrics", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappContainerAppAvailabilityMetrics", + "name": "Availability Metrics for Container Apps", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Apply.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Apply.json new file mode 100644 index 000000000000..5d680790f77e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Apply.json @@ -0,0 +1,53 @@ +{ + "operationId": "ContainerAppsPatches_Apply", + "title": "ContainerAppsPatches_Apply_0", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "Succeeded", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:latest", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:latest-patched-202210101206", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Delete.json new file mode 100644 index 000000000000..5ed304d93c95 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Delete.json @@ -0,0 +1,19 @@ +{ + "operationId": "ContainerAppsPatches_Delete", + "title": "ContainerAppsPatches_Delete_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Get.json new file mode 100644 index 000000000000..6a86a1b4318f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Get.json @@ -0,0 +1,48 @@ +{ + "operationId": "ContainerAppsPatches_Get", + "title": "ContainerAppsPatches_Get_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "NotStarted", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:latest", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:latest-patched-202210101206", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json new file mode 100644 index 000000000000..03090b1078c1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_ListByContainerApp.json @@ -0,0 +1,103 @@ +{ + "operationId": "ContainerAppsPatches_ListByContainerApp", + "title": "ContainerAppsPatches_ListByContainerApp_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-25fe4b", + "name": "testPatch-25fe4b", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/apps/test-app/revisions/test-app--jm3vvry", + "patchApplyStatus": "NotStarted", + "createdAt": "2022-10-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-10-10T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:release-1-patched-202209101206203421", + "lastDetectionTime": "2022-10-10T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-1-patched-202210101206185241", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.9-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.9", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app/patches/testPatch-27c3d5", + "name": "testPatch-27c3d5", + "type": "Microsoft.App/containerApps/patches", + "properties": { + "targetEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/test-env", + "targetContainerAppId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app", + "targetRevisionId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerApps/test-app2/revisions/test-app--z79h4oc", + "patchApplyStatus": "Succeeded", + "createdAt": "2022-09-10T12:06:20.3421+00:00", + "lastModifiedAt": "2022-09-20T12:06:20.3421+00:00", + "patchDetails": [ + { + "targetContainerName": "test-container", + "targetImage": "testregistry.azurecr.io/test-image:release-1", + "lastDetectionTime": "2022-09-21T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-1-patched-202209101206203421", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.5-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.5", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + }, + { + "targetContainerName": "test-container-2", + "targetImage": "testregistry.azurecr.io/test-image:release-2", + "lastDetectionTime": "2022-09-21T12:06:19.5241+00:00", + "detectionStatus": "Succeeded", + "newImageName": "testregistry.azurecr.io/test-image:release-2-patched-202209101206203421", + "newLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.7-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.7", + "osAndVersion": "cbl-mariner2.0" + }, + "oldLayer": { + "name": "mcr.microsoft.com/dotnet/aspnet:7.0.0-cbl-mariner2.0", + "frameworkAndVersion": "dotnet:7.0.0", + "osAndVersion": "cbl-mariner2.0" + }, + "patchType": "FrameworkSecurity" + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Skip_Configure.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Skip_Configure.json new file mode 100644 index 000000000000..92a354c5a7e5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerAppsPatches_Skip_Configure.json @@ -0,0 +1,21 @@ +{ + "operationId": "ContainerAppsPatches_SkipConfigure", + "title": "ContainerAppsPatches_Skip_Configure_0", + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "test-app", + "patchName": "testPatch-25fe4b", + "patchSkipConfig": { + "skip": true + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/{subscription-id}/providers/Microsoft.App/locations/{location}/operationStatuses/{operationId}" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CheckNameAvailability.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CheckNameAvailability.json new file mode 100644 index 000000000000..6d933b770ab3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "checkNameAvailabilityRequest": { + "name": "testcappname", + "type": "Microsoft.App/containerApps" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate.json new file mode 100644 index 000000000000..435f92aacb27 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate.json @@ -0,0 +1,660 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService", + "name": "redisService", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + }, + { + "name": "azure-queue", + "azureQueue": { + "accountName": "account1", + "queueName": "queue1", + "queueLength": 1, + "identity": "system" + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json new file mode 100644 index 000000000000..314419949c87 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_CreateOrUpdate_ConnectedEnvironment.json @@ -0,0 +1,464 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Delete.json new file mode 100644 index 000000000000..d38f35b3f76a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Get.json new file mode 100644 index 000000000000..b76efbb25691 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Get.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + }, + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + }, + { + "name": "servicebus", + "custom": { + "type": "azure-servicebus", + "metadata": { + "queueName": "myqueue", + "namespace": "mynamespace", + "messageCount": "5" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "404": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_GetAuthToken.json new file mode 100644 index 000000000000..6c79f8d92549 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_GetAuthToken.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps/accesstoken", + "location": "East US", + "properties": { + "token": "testToken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + }, + "404": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json new file mode 100644 index 000000000000..963b41764658 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Kind_CreateOrUpdate.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppKind", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East Us", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "external": true, + "targetPort": 80, + "allowInsecure": true + } + }, + "template": { + "containers": [ + { + "image": "default/logicapps-base:latest", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2.0Gi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 30, + "cooldownPeriod": 350, + "pollingInterval": 35 + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerapps/testcontainerAppKind", + "name": "testcontainerAppKind", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "workloadProfileName": null, + "latestRevisionName": "testcontainerAppKind--2rltv14", + "latestReadyRevisionName": "testcontainerAppKind--2rltv14", + "latestRevisionFqdn": "testcontainerAppKind--2rltv14.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "fqdn": "testcontainerAppKind.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "external": true, + "targetPort": 80, + "exposedPort": 0, + "transport": "auto", + "traffic": [ + { + "weight": 100, + "latestRevision": true + } + ], + "customDomains": null, + "allowInsecure": true, + "ipSecurityRestrictions": null, + "corsPolicy": null, + "clientCertificateMode": null, + "stickySessions": null, + "additionalPortMappings": null, + "targetPortHttpScheme": null + }, + "registries": null, + "dapr": null, + "runtime": null, + "maxInactiveRevisions": 100, + "service": null + }, + "template": { + "revisionSuffix": "", + "terminationGracePeriodSeconds": null, + "containers": [ + { + "image": "default/logicapps-base:latest", + "imageType": "ContainerImage", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2Gi", + "ephemeralStorage": "4Gi" + } + } + ], + "initContainers": null, + "scale": { + "minReplicas": 1, + "maxReplicas": 30, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": null + }, + "volumes": null, + "serviceBinds": null + }, + "eventStreamEndpoint": "https://azurecontainerapps-test.dev/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/containerApps/testcontainerAppKind/eventstream" + }, + "identity": { + "type": "None" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/containerapps/testcontainerAppKind", + "name": "testcontainerAppKind", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Web/sites/testcontainerAppKind", + "kind": "workflowapp", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "environmentId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testmanagedenv3", + "workloadProfileName": null, + "latestRevisionName": "testcontainerAppKind--2rltv14", + "latestReadyRevisionName": "testcontainerAppKind--2rltv14", + "latestRevisionFqdn": "testcontainerAppKind--2rltv14.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "configuration": { + "activeRevisionsMode": "Single", + "ingress": { + "fqdn": "testcontainerAppKind.nicefield-53acf186.eastus.azurecontainerapps-test.io", + "external": true, + "targetPort": 80, + "exposedPort": 0, + "transport": "auto", + "traffic": [ + { + "weight": 100, + "latestRevision": true + } + ], + "customDomains": null, + "allowInsecure": true, + "ipSecurityRestrictions": null, + "corsPolicy": null, + "clientCertificateMode": null, + "stickySessions": null, + "additionalPortMappings": null, + "targetPortHttpScheme": null + }, + "registries": null, + "dapr": null, + "runtime": null, + "maxInactiveRevisions": 100, + "service": null + }, + "template": { + "revisionSuffix": "", + "terminationGracePeriodSeconds": null, + "containers": [ + { + "image": "default/logicapps-base:latest", + "imageType": "ContainerImage", + "name": "logicapps-container", + "resources": { + "cpu": 1.0, + "memory": "2Gi", + "ephemeralStorage": "4Gi" + } + } + ], + "initContainers": null, + "scale": { + "minReplicas": 1, + "maxReplicas": 30, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": null + }, + "volumes": null, + "serviceBinds": null + }, + "eventStreamEndpoint": "https://azurecontainerapps-test.dev/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/containerApps/testcontainerAppKind/eventstream" + }, + "identity": { + "type": "None" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListByResourceGroup.json new file mode 100644 index 000000000000..86afdbd83311 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListByResourceGroup.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp1", + "name": "testcontainerApp1", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Failed", + "deploymentErrors": "Code: ContainerAppImagePullProvisionError, Message: Error pulling the container image. Please check the image name or any registry credentials to access if required.", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "Consumption", + "latestRevisionFqdn": "testcontainerApp1-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp1.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "targetPortHttpScheme": "http" + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp1:v4", + "name": "testcontainerApp1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp1:v4", + "name": "testcontainerApp1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35 + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListBySubscription.json new file mode 100644 index 000000000000..85648bd4140f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListBySubscription.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json new file mode 100644 index 000000000000..761dddfa560f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListCustomHostNameAnalysis.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "customHostname": "my.name.corp", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hostName": "my.name.corp", + "isHostnameAlreadyVerified": true, + "customDomainVerificationTest": "Passed", + "customDomainVerificationFailureInfo": {}, + "hasConflictOnManagedEnvironment": false, + "conflictingContainerAppResourceId": "", + "cNameRecords": [ + "cNameRecord1", + "cNameRecord2" + ], + "txtRecords": [ + "txtRecord1", + "txtRecord2" + ], + "aRecords": [ + "aRecord1", + "aRecord2" + ], + "alternateCNameRecords": [ + "cNameRecord1", + "cNameRecord2" + ], + "alternateTxtRecords": [ + "txtRecord1", + "txtRecord2" + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListSecrets.json new file mode 100644 index 000000000000..21e9b9d33d4c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ListSecrets.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json new file mode 100644 index 000000000000..b21555ee0572 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_ManagedBy_CreateOrUpdate.json @@ -0,0 +1,210 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppManagedBy", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerAppManagedBy-ab1234" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v1", + "name": "testcontainerAppManagedBy", + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", + "name": "testcontainerAppManagedBy", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerAppManagedBy-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppManagedBy-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppManagedBy-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v4", + "name": "testcontainerAppManagedBy", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppManagedBy", + "name": "testcontainerAppManagedBy", + "type": "Microsoft.App/containerApps", + "location": "East US", + "managedBy": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.AppPlatform/Spring/springapp", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppManagedBy-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppManagedBy.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppManagedBy-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppManagedBy-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppManagedBy:v4", + "name": "testcontainerAppManagedBy", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Patch.json new file mode 100644 index 000000000000..7dd35701dc24 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Patch.json @@ -0,0 +1,290 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + } + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v1", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/service", + "name": "service", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json new file mode 100644 index 000000000000..466b74726729 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_SourceToCloudApp_CreateOrUpdate.json @@ -0,0 +1,492 @@ +{ + "operationId": "ContainerApps_CreateOrUpdate", + "title": "ContainerApps_SourceToCloudApp_CreateOrUpdate", + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerApp0-ab1234", + "label": "production" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "clientCertificateMode": "accept", + "corsPolicy": { + "allowedOrigins": [ + "https://a.test.com", + "https://b.test.com" + ], + "allowedMethods": [ + "GET", + "POST" + ], + "allowedHeaders": [ + "HEADER1", + "HEADER2" + ], + "exposeHeaders": [ + "HEADER3", + "HEADER4" + ], + "maxAge": 1234, + "allowCredentials": true + }, + "additionalPortMappings": [ + { + "external": true, + "targetPort": 1234 + }, + { + "external": false, + "targetPort": 2345, + "exposedPort": 3456 + } + ] + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "maxInactiveRevisions": 10, + "service": { + "type": "redis" + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "custom": { + "type": "http", + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "serviceBinds": [ + { + "serviceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/redisService", + "name": "redisService", + "clientType": "dotnet", + "customizedKeys": { + "DesiredKey": "defaultKey" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my-other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "stickySessions": { + "affinity": "sticky" + }, + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "mcr.microsoft.com/k8se/cloudbuild-waiting-upload:latest", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30 + } + }, + "patchingConfiguration": { + "patchingMode": "Automatic" + }, + "template": { + "containers": [ + { + "image": "mcr.microsoft.com/k8se/cloudbuild-waiting-upload:latest", + "imageType": "CloudBuild", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + }, + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Start.json new file mode 100644 index 000000000000..7b3acf5c92fb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Start.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Stop.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Stop.json new file mode 100644 index 000000000000..bc634a7aec9e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_Stop.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testWorkerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "workloadProfileName": "My-GP-01", + "latestRevisionFqdn": "testcontainerApp0-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerApp0-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerApp0.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "transport": "auto", + "customDomains": [ + { + "name": "www.my-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-name-dot-com" + }, + { + "name": "www.my--other-name.com", + "bindingType": "SniEnabled", + "certificateId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube/certificates/my-certificate-for-my-other-name-dot-com" + } + ], + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerApp0-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerApp0-ab4321", + "label": "staging" + } + ], + "ipSecurityRestrictions": [ + { + "name": "Allow work IP A subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/32", + "action": "Allow" + }, + { + "name": "Allow work IP B subnet", + "description": "Allowing all IP's within the subnet below to access containerapp", + "ipAddressRange": "192.168.1.1/8", + "action": "Allow" + } + ], + "targetPortHttpScheme": "http" + }, + "dapr": { + "enabled": true, + "appPort": 3000, + "appProtocol": "http", + "httpReadBufferSize": 30, + "httpMaxRequestSize": 10, + "logLevel": "debug", + "enableApiLogging": true + }, + "runtime": { + "java": { + "enableMetrics": true, + "javaAgent": { + "enabled": true, + "logging": { + "loggerSettings": [ + { + "logger": "org.springframework.boot", + "level": "debug" + } + ] + } + } + }, + "dotnet": { + "autoConfigureDataProtection": true + } + }, + "maxInactiveRevisions": 10 + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerApp0:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/containerApps/testWorkerApp0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json new file mode 100644 index 000000000000..370c6bca1f0d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ContainerApps_TcpApp_CreateOrUpdate.json @@ -0,0 +1,207 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerAppTcp", + "api-version": "2024-08-02-preview", + "containerAppEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "ingress": { + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 100, + "revisionName": "testcontainerAppTcp-ab1234" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v1", + "name": "testcontainerAppTcp", + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", + "name": "testcontainerAppTcp", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "latestReadyRevisionName": "testcontainerAppTcp-pjxhsye", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppTcp-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppTcp-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v4", + "name": "testcontainerAppTcp", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerAppTcp", + "name": "testcontainerAppTcp", + "type": "Microsoft.App/containerApps", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "managedEnvironmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "latestRevisionFqdn": "testcontainerAppTcp-pjxhsye.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "configuration": { + "ingress": { + "fqdn": "testcontainerAppTcp.demokube-t24clv0g.eastus.containerApps.k4apps.io", + "external": true, + "targetPort": 3000, + "exposedPort": 4000, + "transport": "tcp", + "traffic": [ + { + "weight": 80, + "revisionName": "testcontainerAppTcp-ab1234" + }, + { + "weight": 20, + "revisionName": "testcontainerAppTcp-ab4321" + } + ] + } + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppTcp:v4", + "name": "testcontainerAppTcp", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "tcpSocket": { + "port": 8080 + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "cooldownPeriod": 350, + "pollingInterval": 35, + "rules": [ + { + "name": "tcpscalingrule", + "tcp": { + "metadata": { + "concurrentConnections": "50" + } + } + } + ] + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json new file mode 100644 index 000000000000..387aa3b3e273 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Get.json new file mode 100644 index 000000000000..19ca9324f840 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_List.json new file mode 100644 index 000000000000..24eff2cb118b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicies_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "something", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json new file mode 100644 index 000000000000..55c1c0e2c563 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_AllOptions.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-08-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 15, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 30 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 5, + "timeoutInSeconds": 10, + "intervalInSeconds": 4 + } + }, + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json new file mode 100644 index 000000000000..dc309ad8e5d0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_OutboundOnly.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-08-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "outboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 100, + "maxIntervalInMilliseconds": 30000 + } + }, + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20, + "intervalInSeconds": 60 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json new file mode 100644 index 000000000000..04a00d905bc3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponentResiliencyPolicy_CreateOrUpdate_SparseOptions.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "mydaprcomponent", + "name": "myresiliencypolicy", + "api-version": "2024-08-02-preview", + "daprComponentResiliencyPolicyEnvelope": { + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprComponents/mydaprcomponent/resiliencyPolicies/myresiliencypolicy", + "name": "myresiliencypolicy", + "type": "Microsoft.App/managedEnvironments/daprComponents/resiliencyPolicies", + "properties": { + "inboundPolicy": { + "httpRetryPolicy": { + "maxRetries": 5, + "retryBackOff": { + "initialDelayInMilliseconds": 2000, + "maxIntervalInMilliseconds": 5500 + } + }, + "circuitBreakerPolicy": { + "consecutiveErrors": 3, + "timeoutInSeconds": 20 + } + }, + "outboundPolicy": { + "timeoutPolicy": { + "responseTimeoutInSeconds": 12 + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json new file mode 100644 index 000000000000..72b7f4cc936e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_SecretStoreComponent.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json new file mode 100644 index 000000000000..ac14cbda9904 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_CreateOrUpdate_Secrets.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview", + "daprComponentEnvelope": { + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey", + "value": "keyvalue" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Delete.json new file mode 100644 index 000000000000..541e03214a7c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json new file mode 100644 index 000000000000..7738d9dc12bb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_SecretStoreComponent.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_Secrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_Secrets.json new file mode 100644 index 000000000000..e5e9d8124e9b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_Get_Secrets.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_List.json new file mode 100644 index 000000000000..09cb33e245cd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_List.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secrets": [ + { + "name": "masterkey" + } + ], + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog", + "name": "vaultdog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "value": "<COSMOS-URL>" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprcomponents/vaultdog", + "name": "vaultdog", + "type": "Microsoft.App/managedEnvironments/daprcomponents", + "properties": { + "componentType": "state.azure.cosmosdb", + "version": "v1", + "ignoreErrors": false, + "initTimeout": "50s", + "secretStoreComponent": "my-secret-store", + "metadata": [ + { + "name": "url", + "secretRef": "cosmosdb/url" + }, + { + "name": "database", + "value": "itemsDB" + }, + { + "name": "collection", + "value": "items" + }, + { + "name": "masterkey", + "secretRef": "cosmosdb/masterkey" + } + ], + "scopes": [ + "container-app-1", + "container-app-2" + ], + "serviceComponentBind": [ + { + "name": "statestore", + "serviceId": "/subscriptions/9f7371f1-b593-4c3c-84e2-9167806ad358/resourceGroups/ca-syn2-group/providers/Microsoft.App/containerapps/cappredis", + "metadata": { + "name": "daprcomponentBind", + "value": "redis-bind" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_ListSecrets.json new file mode 100644 index 000000000000..3eea5b4619e7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprComponents_ListSecrets.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "componentName": "reddog", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json new file mode 100644 index 000000000000..5c807307f089 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_BulkSubscribeAndScopes.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-08-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json new file mode 100644 index 000000000000..192a4c4cfa5d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_DefaultRoute.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-08-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "default": "/products" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json new file mode 100644 index 000000000000..1844a683ec13 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_CreateOrUpdate_RouteRulesAndMetadata.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-08-02-preview", + "daprSubscriptionEnvelope": { + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "metadata": { + "foo": "bar", + "hello": "world" + }, + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Delete.json new file mode 100644 index 000000000000..0e55b9ff55ad --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mysubscription", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json new file mode 100644 index 000000000000..ec3e54baa83d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_BulkSubscribeAndScopes.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "scopes": [ + "warehouseapp", + "customersupportapp" + ], + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json new file mode 100644 index 000000000000..a2e35957e8f9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_DefaultRoute.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json new file mode 100644 index 000000000000..513dfc45111d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_Get_RouteRulesAndMetadata.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mypubsubcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mysubscription", + "name": "mysubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_List.json new file mode 100644 index 000000000000..8620adc4a263 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DaprSubscriptions_List.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mybulksubscription", + "name": "mybulksubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + }, + "bulkSubscribe": { + "enabled": true, + "maxMessagesCount": 123, + "maxAwaitDurationMs": 500 + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/mydefaultsubscription", + "name": "mydefaultsubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [], + "default": "/products" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/daprSubscriptions/myroutingsubscription", + "name": "myroutingsubscription", + "type": "Microsoft.App/managedEnvironments/daprSubscriptions", + "properties": { + "pubsubName": "mypubsubcomponent", + "topic": "inventory", + "routes": { + "rules": [ + { + "match": "event.type == 'widget'", + "path": "/widgets" + }, + { + "match": "event.type == 'gadget'", + "path": "/gadgets" + } + ], + "default": "/products" + }, + "metadata": { + "foo": "bar", + "hello": "world" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..564a5ca0a147 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json new file mode 100644 index 000000000000..f5dc582ab091 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_CreateOrUpdate_ServiceBind.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Delete.json new file mode 100644 index 000000000000..1a6f9d5acfc2 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get.json new file mode 100644 index 000000000000..da327de15ffe --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get_ServiceBind.json new file mode 100644 index 000000000000..ffa3ad35e9ea --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Get_ServiceBind.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List.json new file mode 100644 index 000000000000..25f6d8375880 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "MyOtherDotNetComponentType", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "timeout-value", + "value": "10000ms" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List_ServiceBind.json new file mode 100644 index 000000000000..4802ef299e9d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_List_ServiceBind.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "MyOtherDotNetComponentType", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "timeout-value", + "value": "10000ms" + } + ], + "serviceBinds": [ + { + "name": "blueshark", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/blueshark" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch.json new file mode 100644 index 000000000000..590e4eb53f4b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch_ServiceBind.json new file mode 100644 index 000000000000..a237aeb44a6c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/DotNetComponents_Patch_ServiceBind.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "mydotnetcomponent", + "api-version": "2024-08-02-preview", + "dotNetComponentEnvelope": { + "properties": { + "componentType": "AspireDashboard", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/mydotnetcomponent", + "name": "mydotnetcomponent", + "type": "Microsoft.App/managedEnvironments/dotNetComponents", + "properties": { + "componentType": "AspireDashboard", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "dashboard-theme", + "value": "dark" + } + ], + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/dotNetComponents/yellowcat" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/FunctionsExtension_Post.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/FunctionsExtension_Post.json new file mode 100644 index 000000000000..39eb732f80a5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/FunctionsExtension_Post.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "functionAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": "{\"status\":\"success\"}" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate.json new file mode 100644 index 000000000000..1b7bfbc939b7 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json new file mode 100644 index 000000000000..df382d07058f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_CreateOrUpdate_ServiceBind.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "InProgress", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Delete.json new file mode 100644 index 000000000000..af3dd5e094bb --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get.json new file mode 100644 index 000000000000..f94584a5ba18 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get_ServiceBind.json new file mode 100644 index 000000000000..be15e7d3ca9b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Get_ServiceBind.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List.json new file mode 100644 index 000000000000..2157bec090b8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringCloudEureka", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.cloud.config.server.git.uri", + "value": "<GIT-URL>" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/reddog", + "name": "reddog", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringCloudGateway", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.cloud.gateway.enabled", + "value": "true" + } + ], + "springCloudGatewayRoutes": [ + { + "id": "route1", + "uri": "https://otherjavacomponent.myenvironment.test.net", + "predicates": [ + "Path=/v1/{path}", + "After=2024-01-20T17:42:47.789-07:00[America/Denver]" + ], + "filters": [ + "SetPath=/{path}" + ] + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List_ServiceBind.json new file mode 100644 index 000000000000..5bcc9c0afd74 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_List_ServiceBind.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark", + "name": "blueshark", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat", + "name": "yellowcat", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringCloudEureka", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.cloud.config.server.git.uri", + "value": "<GIT-URL>" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "blueshark", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/blueshark" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch.json new file mode 100644 index 000000000000..9ff0d07d0122 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "ingress": { + "fqdn": "myjavacomponent.myenvironment.test.net" + } + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch_ServiceBind.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch_ServiceBind.json new file mode 100644 index 000000000000..c9f40df8b5db --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/JavaComponents_Patch_ServiceBind.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "myenvironment", + "name": "myjavacomponent", + "api-version": "2024-08-02-preview", + "javaComponentEnvelope": { + "properties": { + "componentType": "SpringBootAdmin", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/myjavacomponent", + "name": "myjavacomponent", + "type": "Microsoft.App/managedEnvironments/javaComponents", + "properties": { + "componentType": "SpringBootAdmin", + "provisioningState": "Succeeded", + "configurations": [ + { + "propertyName": "spring.boot.admin.ui.enable-toasts", + "value": "true" + }, + { + "propertyName": "spring.boot.admin.monitor.status-interval", + "value": "10000ms" + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 1 + }, + "serviceBinds": [ + { + "name": "yellowcat", + "serviceId": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/myenvironment/javaComponents/yellowcat" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/providers/Microsoft.App/locations/eastus/operationResults/amF2YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate.json new file mode 100644 index 000000000000..ae43a9ec3f82 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate.json @@ -0,0 +1,325 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview", + "JobEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 5, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ], + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json new file mode 100644 index 000000000000..1d1bf3e21a03 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_ConnectedEnvironment.json @@ -0,0 +1,219 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview", + "JobEnvelope": { + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 5, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "extendedLocation": { + "name": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.ExtendedLocation/customLocations/testcustomlocation", + "type": "CustomLocation" + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/connectedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_EventTrigger.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_EventTrigger.json new file mode 100644 index 000000000000..f62f0f01e56f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_CreateorUpdate_EventTrigger.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview", + "JobEnvelope": { + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": {} + } + }, + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "pollingInterval": 40, + "minExecutions": 1, + "maxExecutions": 5, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "topicName": "my-topic" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0" + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "pollingInterval": 20, + "minExecutions": 1, + "maxExecutions": 5, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "topicName": "my-topic" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + }, + "201": { + "headers": { + "Location": "location" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "eventTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4, + "scale": { + "minExecutions": 1, + "maxExecutions": 5, + "pollingInterval": 20, + "rules": [ + { + "name": "servicebuscalingrule", + "type": "azure-servicebus", + "metadata": { + "queueName": "my-queue", + "messageCount": "50" + }, + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity" + } + ] + } + }, + "triggerType": "Event" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "eventStreamEndpoint": "testEndpoint" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Delete.json new file mode 100644 index 000000000000..616459b50af5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testWorkerContainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testWorkerContainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Execution_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Execution_Get.json new file mode 100644 index 000000000000..01454877e5cc --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Execution_Get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": "jobExecution1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "jobExecution1", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00", + "template": { + "containers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Executions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Executions_Get.json new file mode 100644 index 000000000000..891981cd819e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Executions_Get.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "testcontainerAppJob-27944454", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00", + "detailedStatus": { + "replicas": [ + { + "name": "testcontainerappsjob0-0", + "containers": [ + { + "name": "container1", + "code": 0, + "additionalInformation": "Completed", + "status": "Succeeded" + }, + { + "name": "container2", + "code": 0, + "additionalInformation": "Completed", + "status": "Succeeded" + } + ] + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testcontainerappsjob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerappsjob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.5, + "memory": "1Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Get.json new file mode 100644 index 000000000000..4b4710aa79ee --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Get.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "identity": { + "type": "SystemAssigned,UserAssigned", + "principalId": "24adfa4f-dedf-8dc0-ca29-b6d1a69ab319", + "tenantId": "23adfa4f-eedf-1dc0-ba29-a6d1a69ab3d0", + "userAssignedIdentities": { + "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity": { + "principalId": "74adfa4f-dedf-8dc0-ca29-b6d1a69ab312", + "clientId": "14adfa4f-eedf-1dc0-ba29-a6d1a69ab3df" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_GetDetector.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_GetDetector.json new file mode 100644 index 000000000000..185cea5f5450 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_GetDetector.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "jobName": "mikonojob1", + "detectorName": "containerappjobnetworkIO", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/containerappjobnetworkIO", + "name": "containerappjobnetworkIO", + "type": "Microsoft.App/jobs/detectors", + "properties": { + "metadata": { + "id": "containerappjobnetworkIO", + "name": "Container App Job Network Inbound and Outbound", + "description": "This detector shows the Container App Job Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Container App Job Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListDetectors.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListDetectors.json new file mode 100644 index 000000000000..44e74a79e92e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListDetectors.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "jobName": "mikonojob1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/jobs/mikonojob1/detectors/cappjobContainerAppAvailabilityMetrics", + "name": "cappjobContainerAppAvailabilityMetrics", + "type": "Microsoft.App/containerapps/detectors", + "properties": { + "metadata": { + "id": "cappjobContainerAppAvailabilityMetrics", + "name": "Availability Metrics for Container App Jobs", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListSecrets.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListSecrets.json new file mode 100644 index 000000000000..a4ea20db1811 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ListSecrets.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "secret1" + }, + { + "name": "secret2" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Patch.json new file mode 100644 index 000000000000..56c705db2d50 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Patch.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview", + "JobEnvelope": { + "properties": { + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v1", + "name": "testcontainerAppsJob0", + "probes": [ + { + "type": "Liveness", + "httpGet": { + "path": "/health", + "port": 8080, + "httpHeaders": [ + { + "name": "Custom-Header", + "value": "Awesome" + } + ] + }, + "initialDelaySeconds": 3, + "periodSeconds": 3 + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/containerappsjobOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ProxyGet.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ProxyGet.json new file mode 100644 index 000000000000..5ccb785bb1cf --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_ProxyGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "apiName": "rootApi", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0/detectorproperties/rootApi", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Start.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Start.json new file mode 100644 index 000000000000..c4751edfce19 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Start.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ] + }, + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "testcontainerAppsJob0-pjxhsye", + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/{containerAppsJobName}/executions/{jobExecutionName}" + } + }, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Execution.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Execution.json new file mode 100644 index 000000000000..c383991c3e95 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Execution.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": "jobExecution1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Multiple.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Multiple.json new file mode 100644 index 000000000000..89600796b0df --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Job_Stop_Multiple.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "jobExecutionName": { + "value": [ + { + "name": "jobExecution-27944453" + }, + { + "name": "jobExecution-27944452" + }, + { + "name": "jobExecution-27944451" + } + ] + }, + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "jobExecution-27944453", + "properties": { + "status": "Running", + "startTime": "2023-02-13T20:37:30+00:00", + "endTime": "2023-02-13T20:47:30+00:00" + } + }, + { + "name": "jobExecution-27944452", + "properties": { + "status": "Running", + "startTime": "2023-02-13T21:37:30+00:00", + "endTime": "2023-02-13T21:47:30+00:00" + } + }, + { + "name": "jobExecution-27944453", + "properties": { + "status": "Running", + "startTime": "2023-02-13T22:37:30+00:00", + "endTime": "2023-02-13T22:47:30+00:00" + } + } + ], + "nextLink": null + } + }, + "202": { + "headers": { + "Location": "location" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListByResourceGroup.json new file mode 100644 index 000000000000..b3825857ccb9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListByResourceGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", + "name": "testcontainerAppsJob1", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "scheduleTriggerConfig": { + "replicaCompletionCount": 1, + "cronExpression": "* * * * 5", + "parallelism": 4 + }, + "triggerType": "Scheduled" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testinitcontainerAppsJob1:v4", + "name": "testinitcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListBySubscription.json new file mode 100644 index 000000000000..0f103386cf67 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob1", + "name": "testcontainerAppsJob1", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "scheduleTriggerConfig": { + "replicaCompletionCount": 1, + "cronExpression": "* * * * 5", + "parallelism": 5 + }, + "triggerType": "Scheduled" + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testcontainerAppsJob1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob1:v4", + "name": "testinitcontainerAppsJob1", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Resume.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Resume.json new file mode 100644 index 000000000000..d44e8d229625 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Resume.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "runningState": "Ready", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testcontainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview", + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testcontainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Suspend.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Suspend.json new file mode 100644 index 000000000000..2ddf6d460684 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Jobs_Suspend.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "jobName": "testcontainerAppsJob0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/jobs/testcontainerAppsJob0", + "name": "testcontainerAppsJob0", + "type": "Microsoft.App/jobs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "runningState": "Suspended", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "configuration": { + "replicaTimeout": 10, + "replicaRetryLimit": 10, + "manualTriggerConfig": { + "replicaCompletionCount": 1, + "parallelism": 4 + }, + "triggerType": "Manual", + "identitySettings": [ + { + "identity": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myidentity", + "lifecycle": "All" + }, + { + "identity": "system", + "lifecycle": "Init" + } + ] + }, + "template": { + "containers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + }, + "volumeMounts": [ + { + "volumeName": "azurefile", + "mountPath": "/mnt/path1", + "subPath": "subPath1" + }, + { + "volumeName": "nfsazurefile", + "mountPath": "/mnt/path2", + "subPath": "subPath2" + } + ] + } + ], + "initContainers": [ + { + "image": "repo/testcontainerAppsJob0:v4", + "name": "testinitcontainerAppsJob0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "volumes": [ + { + "name": "azurefile", + "storageType": "AzureFile", + "storageName": "storage" + }, + { + "name": "nfsazurefile", + "storageType": "NfsAzureFile", + "storageName": "nfsStorage" + } + ] + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testcontainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview", + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/jobs/testcontainerAppsJob0/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Create.json new file mode 100644 index 000000000000..d8b8488644a8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Create.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "resource": { + "properties": {} + }, + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Delete.json new file mode 100644 index 000000000000..a07828378347 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..b11b2b3dc12b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_DeleteDeployWorkflowArtifacts.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-08-02-preview", + "workflowArtifacts": { + "filesToDelete": [ + "test/workflow.json", + "test/" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Get.json new file mode 100644 index 000000000000..1894e6f1d853 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0", + "name": "testcontainerApp0", + "type": "Microsoft.App/logicApps", + "properties": {} + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_GetWorkflow.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_GetWorkflow.json new file mode 100644 index 000000000000..ac7a3e5e0b4e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_GetWorkflow.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "workflowName": "stateful1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/stateful1", + "name": "testcontainerApp0/stateful1", + "type": "Microsoft.App/logicApps/workflows", + "kind": "Stateful", + "location": "East US", + "properties": { + "files": { + "workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "parameters": {}, + "triggers": {} + } + }, + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/brazilsouth/managedApis/office365" + }, + "connection": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/connections/office365-1" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListCallbackURL.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListCallbackURL.json new file mode 100644 index 000000000000..587326a1bf31 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListCallbackURL.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-08-02-preview", + "x-ms-logicapps-proxy-path": "/runtime/webhooks/workflow/api/management/workflows/Stateful1/triggers/When_a_HTTP_request_is_received/listCallbackUrl", + "x-ms-logicapps-proxy-method": "POST" + }, + "responses": { + "200": { + "body": { + "value": "https://testapp2.livelyriver-730e4fd9.eastasia.azurecontainerapps.io:443/api/test/triggers/When_a_HTTP_request_is_received/invoke?api-version=2022-05-01&sp=%2Ftriggers%2FWhen_a_HTTP_request_is_received%2Frun&sv=1.0&sig=<sig> ", + "method": "POST", + "basePath": "https://testapp2.livelyriver-730e4fd9.eastasia.azurecontainerapps.io /api/test/triggers/When_a_HTTP_request_is_received/invoke", + "queries": { + "api-version": "2022-05-01", + "sp": "/triggers/When_a_HTTP_request_is_received/run", + "sv": "1.0", + "sig": "IxEQ_ygZf6WNEQCbjV0Vs6p6Y4DyNEJVAa86U5B4xhk" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListConnections.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListConnections.json new file mode 100644 index 000000000000..5b53d39798d5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListConnections.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testapp2/providers/Microsoft.App/logicApps/testapp2/workflowconfigurations/connections", + "name": "testapp2/connections", + "type": "Microsoft.App/logicApps/workflowsconfiguration", + "location": "East US", + "properties": { + "files": { + "connections.json": { + "managedApiConnections": { + "office365": { + "api": { + "id": "string" + }, + "connection": { + "id": "string" + }, + "connectionRuntimeUrl": "string", + "authentication": { + "type": "Raw", + "scheme": "Key", + "parameter": "@appsetting('office365-connectionKey')" + } + } + } + } + }, + "health": { + "state": "Healthy" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListWorkflows.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListWorkflows.json new file mode 100644 index 000000000000..1b8eae8d6249 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_ListWorkflows.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "containerAppName": "testcontainerApp0", + "logicAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/a1", + "name": "testcontainerApp0/a1", + "type": "Microsoft.App/logicApps/workflows", + "location": "East US", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Healthy" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/containerApps/testcontainerApp0/providers/Microsoft.App/logicApps/testcontainerApp0/workflows/stateful2", + "name": "testcontainerApp0/stateful2", + "type": "Microsoft.App/logicApps/workflows", + "location": "East US", + "kind": "Stateful", + "properties": { + "flowState": "Enabled", + "health": { + "state": "Unhealthy", + "error": { + "code": "InvalidWorkflowJson", + "message": "Invalid character after parsing property name. Expected ':' but got: \". Path '', line 2, position 2." + } + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json new file mode 100644 index 000000000000..5c5d441682ac --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/LogicApps_PostDeployWorkflowArtifacts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "containerAppName": "testapp2", + "logicAppName": "testapp2", + "api-version": "2024-08-02-preview", + "workflowArtifacts": { + "files": { + "test1/workflow.json": { + "definition": { + "$schema": "https://schema.management.azure.com/providers/Microsoft.Logic/schemas/2016-06-01/workflowdefinition.json#", + "actions": {}, + "contentVersion": "1.0.0.0", + "outputs": {}, + "triggers": { + "When_events_are_available_in_Event_hub": { + "inputs": { + "parameters": { + "eventHubName": "test123" + }, + "serviceProviderConfiguration": { + "connectionName": "eventHub", + "operationId": "receiveEvents", + "serviceProviderId": "/serviceProviders/eventHub" + } + }, + "splitOn": "@triggerOutputs()?['body']", + "type": "ServiceProvider" + } + } + }, + "kind": "Stateful" + }, + "connections.json": { + "serviceProviderConnections": { + "eventHub": { + "parameterValues": { + "connectionString": "@appsetting('eventHub_connectionString')" + }, + "serviceProvider": { + "id": "/serviceProviders/eventHub" + }, + "displayName": "example1" + } + }, + "managedApiConnections": {} + } + }, + "appSettings": { + "eventHub_connectionString": "Endpoint=sb://example.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=EXAMPLE1a2b3c4d5e6fEXAMPLE=" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_CreateOrUpdate.json new file mode 100644 index 000000000000..129c8be2f9ef --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_CreateOrUpdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "managedCertificateEnvelope": { + "location": "East US", + "properties": { + "subjectName": "my-subject-name.company.country.net", + "domainControlValidation": "CNAME" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + }, + "201": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/locations/eastus/managedCertificateOperationStatuses/dc27c9cd-370f-4623-95d4-827b6dc4120a?api-version=2022-06-01-preview&azureAsyncOperation=true" + }, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Pending", + "domainControlValidation": "CNAME" + } + } + }, + "400": { + "code": "ManagedCertNoUpdate", + "message": "Properties of managed certificates cannot be updated. Please delete the current resource and retry or use a different resource id." + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Delete.json new file mode 100644 index 000000000000..31e40f4392f4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Get.json new file mode 100644 index 000000000000..8c7a1922c9e1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificate_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json new file mode 100644 index 000000000000..fc0ee5707a96 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_ListByManagedEnvironment.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-root", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "HTTP" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name-txt", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=txt.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "TXT" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_Patch.json new file mode 100644 index 000000000000..d39b0efabfba --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedCertificates_Patch.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "managedCertificateName": "certificate-firendly-name", + "api-version": "2024-08-02-preview", + "managedCertificateEnvelope": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv/managedCertificates/certificate-firendly-name", + "type": "Microsoft.App/ManagedEnvironments/managedCertificates", + "location": "East US", + "properties": { + "subjectName": "CN=my-subject-name.company.country.net", + "provisioningState": "Succeeded", + "domainControlValidation": "CNAME" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json new file mode 100644 index 000000000000..4ee4592808a5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "environmentName": "mikonokubeenv", + "detectorName": "ManagedEnvAvailabilityMetrics", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics", + "name": "ManagedEnvAvailabilityMetrics", + "type": "Microsoft.App/managedEnvironments/detectors", + "properties": { + "metadata": { + "id": "ManagedEnvAvailabilityMetrics", + "name": "Managed Env Netowrk Inbound and Outbound", + "description": "This detector shows the Managed Environment Network Inbound and Outbound.", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Detector", + "score": 0 + }, + "dataset": [ + { + "table": { + "tableName": "", + "columns": [ + { + "columnName": "TimeStamp", + "dataType": "DateTime" + }, + { + "columnName": "Metric", + "dataType": "String" + }, + { + "columnName": "Average", + "dataType": "Double" + } + ], + "rows": [ + [ + "2022-03-15T21:35:00", + "RxBytes", + 0 + ] + ] + }, + "renderingProperties": { + "type": 8, + "title": "Managed Environment Network Inbound ", + "description": "", + "isVisible": true + } + } + ], + "status": { + "statusId": 3 + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_List.json new file mode 100644 index 000000000000..32e49699f268 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentDiagnostics_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "f07f3711-b45e-40fe-a941-4e6d93f851e6", + "resourceGroupName": "mikono-workerapp-test-rg", + "environmentName": "mikonokubeenv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/f07f3711-b45e-40fe-a941-4e6d93f851e6/resourceGroups/mikono-workerapp-test-rg/providers/Microsoft.App/managedEnvironments/mikonokubeenv/detectors/ManagedEnvAvailabilityMetrics", + "name": "ManagedEnvAvailabilityMetrics", + "type": "Microsoft.App/managedEnvironments/detectors", + "properties": { + "metadata": { + "id": "ManagedEnvAvailabilityMetrics", + "name": "Availability Metrics for Managed Environments", + "author": "", + "category": "Availability and Performance", + "supportTopicList": [], + "type": "Analysis", + "score": 0 + }, + "dataset": [], + "status": { + "statusId": 4 + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json new file mode 100644 index 000000000000..ab746c22d239 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-08-02-preview", + "privateEndpointConnectionEnvelope": { + "properties": { + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..cba917b566a5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..7598686262b9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "privateEndpointConnectionName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Waiting" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json new file mode 100644 index 000000000000..10d67a995644 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateEndpointConnections_List.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Pending" + }, + "provisioningState": "Waiting" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateEndpointConenctions/jlaw-demo2", + "name": "jlaw-demo2", + "type": "Microsoft.App/managedEnvironments/privateEndpointConnections", + "properties": { + "groupIds": [ + "managedEnvironments" + ], + "privateEndpoint": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/pltest" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "status": "Approved" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json new file mode 100644 index 000000000000..4d5dc874bc0a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentPrivateLinkResources_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/privateLinkResources/managedEnvironments", + "name": "managedEnvironments", + "properties": { + "groupId": "managedEnvironments", + "requiredMembers": [ + "managedEnvironments" + ], + "requiredZoneNames": [ + "privatelink.northcentralusstage.azurecontainerapps.io" + ] + }, + "type": "Microsoft.App/managedEnvironments/privateLinkResources" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentUsages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentUsages_List.json new file mode 100644 index 000000000000..676e4d56e7a1 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentUsages_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-08-02-preview", + "subscriptionId": "subid", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 0.5, + "limit": 10, + "name": { + "localizedValue": "Managed Environment Consumption Cores", + "value": "ManagedEnvironmentConsumptionCores" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json new file mode 100644 index 000000000000..9bf48eca817c --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview", + "storageEnvelope": { + "properties": { + "azureFile": { + "accountName": "account1", + "accountKey": "key", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json new file mode 100644 index 000000000000..b3b3bc41c463 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_CreateOrUpdate_NfsAzureFile.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview", + "storageEnvelope": { + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Delete.json new file mode 100644 index 000000000000..23cdb79654bd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get.json new file mode 100644 index 000000000000..1206ccbcd5b8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json new file mode 100644 index 000000000000..ca561d2ffd4e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_Get_NfsAzureFile.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "storageName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_List.json new file mode 100644 index 000000000000..14a51624cd0d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironmentsStorages_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "managedEnv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "azureFile": { + "accountName": "account1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/managedEnv/storages/jlaw-demo2", + "name": "jlaw-demo2", + "type": "Microsoft.App/managedEnvironments/storages", + "properties": { + "nfsAzureFile": { + "server": "server1", + "shareName": "share1", + "accessMode": "ReadOnly" + } + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json new file mode 100644 index 000000000000..9a234ae08110 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CreateOrUpdate.json @@ -0,0 +1,323 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-08-02-preview", + "environmentEnvelope": { + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": {} + } + }, + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string", + "dynamicJsonColumns": true + } + }, + "appInsightsConfiguration": { + "connectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://eastus-8.in.applicationinsights.azure.com/;LiveEndpoint=https://eastus.livediagnostics.monitor.azure.com/" + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "string", + "key": "000000000000000000000000" + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true, + "headers": [ + { + "key": "api-key", + "value": "xxxxxxxxxxx" + } + ] + } + ] + }, + "tracesConfiguration": { + "includeDapr": true, + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "includeKeda": true, + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "peerAuthentication": { + "mtls": { + "enabled": true + } + }, + "peerTrafficConfiguration": { + "encryption": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "dynamicJsonColumns": true + } + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "datadoghq.com", + "key": null + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true + } + ] + }, + "tracesConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "appInsightsConfiguration": null, + "infrastructureResourceGroup": "capp-svc-testcontainerenv-eastus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "identity": { + "type": "SystemAssigned, UserAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso-resources/providers/Microsoft.ManagedIdentity/userAssignedIdentities/contoso-identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "clientId": "00000000-0000-0000-0000-000000000000" + } + } + }, + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "openTelemetryConfiguration": { + "destinationsConfiguration": { + "dataDogConfiguration": { + "site": "datadoghq.com", + "key": null + }, + "otlpConfigurations": [ + { + "name": "dashboard", + "endpoint": "dashboard.k8s.region.azurecontainerapps.io:80", + "insecure": true + } + ] + }, + "tracesConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "logsConfiguration": { + "destinations": [ + "appInsights" + ] + }, + "metricsConfiguration": { + "destinations": [ + "dataDog" + ] + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "appInsightsConfiguration": null, + "infrastructureResourceGroup": "capp-svc-testcontainerenv-eastus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json new file mode 100644 index 000000000000..5b09fe8ed0f5 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_CustomInfrastructureResourceGroup_Create.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-08-02-preview", + "environmentEnvelope": { + "location": "East US", + "properties": { + "daprAIConnectionString": "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://northcentralus-0.in.applicationinsights.azure.com/", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string", + "sharedKey": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "dnsSuffix": "www.my-name.com", + "certificateValue": "Y2VydA==", + "certificatePassword": "1234" + }, + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/testcontainerenv", + "name": "testcontainerenv", + "type": "Microsoft.App/managedEnvironments", + "location": "East US", + "properties": { + "provisioningState": "InitializationInProgress", + "deploymentErrors": null, + "defaultDomain": "testcontainerenv.k4apps.io", + "staticIp": "1.2.3.4", + "appLogsConfiguration": { + "logAnalyticsConfiguration": { + "customerId": "string" + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "myInfrastructureRgName" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Delete.json new file mode 100644 index 000000000000..4118619ef6cc --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "examplekenv", + "api-version": "2024-08-02-preview", + "location": "East US" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/localtions/eastus/operationResults/00000" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Get.json new file mode 100644 index 000000000000..0090288e464d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Get.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "kedaConfiguration": { + "version": "2.8.1" + }, + "daprConfiguration": { + "version": "1.9" + }, + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus", + "peerAuthentication": { + "mtls": { + "enabled": true + } + }, + "peerTrafficConfiguration": { + "encryption": { + "enabled": true + } + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_GetAuthToken.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_GetAuthToken.json new file mode 100644 index 000000000000..f54fb907767e --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_GetAuthToken.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "rg", + "environmentName": "testenv", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/testenv", + "name": "testenv", + "type": "Microsoft.App/environments/accesstoken", + "location": "East US", + "properties": { + "token": "testToken", + "expires": "2022-07-14T19:22:50.3080223Z" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..7adff3ab5810 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListByResourceGroup.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "appLogsConfiguration": null, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "appLogsConfiguration": null, + "zoneRedundant": true, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "infrastructureResourceGroup": "capp-svc-demo1-northcentralus" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..cd43a58907f8 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListBySubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "appLogsConfiguration": null, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + }, + { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/DemoRG/providers/Microsoft.App/managedEnvironments/demo1", + "name": "demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "demo1.k4apps.io", + "staticIp": "52.142.21.61", + "appLogsConfiguration": { + "destination": "log-analytics", + "logAnalyticsConfiguration": { + "customerId": "9ccccd4a-268f-4a9a-8d03-9bfe77c3fbd2", + "dynamicJsonColumns": true + } + }, + "zoneRedundant": true, + "vnetConfiguration": { + "infrastructureSubnetId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/RGName/providers/Microsoft.Network/virtualNetworks/VNetName/subnets/subnetName1" + }, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name2.com", + "subjectName": "CN=www.my-name2.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "infrastructureResourceGroup": "capp-svc-demo1-northcentralus" + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json new file mode 100644 index 000000000000..0effc6de38ff --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_ListWorkloadProfileStates.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "8efdecc5-919e-44eb-b179-915dca89ebf9", + "resourceGroupName": "examplerg", + "environmentName": "jlaw-demo1", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/GP1", + "name": "GP1", + "type": "/providers/Microsoft.App/workloadProfileStates", + "properties": { + "minimumCount": 3, + "maximumCount": 10, + "currentCount": 3 + } + }, + { + "id": "/subscriptions/55f240e3-3d66-44f6-8358-4e4f3d7a2e51/providers/Microsoft.App/workloadProfileStates/MO3", + "name": "MO3", + "type": "/providers/Microsoft.App/workloadProfileStates", + "properties": { + "minimumCount": 0, + "maximumCount": 2, + "currentCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Patch.json new file mode 100644 index 000000000000..8e9974cbe9dc --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/ManagedEnvironments_Patch.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "examplerg", + "environmentName": "testcontainerenv", + "api-version": "2024-08-02-preview", + "environmentEnvelope": { + "location": "East US", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/8efdecc5-919e-44eb-b179-915dca89ebf9/resourceGroups/examplerg/providers/Microsoft.App/managedEnvironments/jlaw-demo1", + "name": "jlaw-demo1", + "type": "Microsoft.App/managedEnvironments", + "location": "North Central US", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "deploymentErrors": null, + "defaultDomain": "jlaw-demo1.k4apps.io", + "staticIp": "20.42.33.145", + "zoneRedundant": true, + "customDomainConfiguration": { + "customDomainVerificationId": "custom domain verification id", + "dnsSuffix": "www.my-name.com", + "subjectName": "CN=www.my-name.com", + "expirationDate": "2022-11-06T04:00:00Z", + "thumbprint": "CERTIFICATE_THUMBPRINT" + }, + "eventStreamEndpoint": "testEndpoint", + "workloadProfiles": [ + { + "name": "My-GP-01", + "enableFips": true, + "workloadProfileType": "GeneralPurpose", + "minimumCount": 3, + "maximumCount": 12 + }, + { + "name": "My-MO-01", + "workloadProfileType": "MemoryOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-CO-01", + "workloadProfileType": "ComputeOptimized", + "minimumCount": 3, + "maximumCount": 6 + }, + { + "name": "My-consumption-01", + "workloadProfileType": "Consumption" + } + ], + "infrastructureResourceGroup": "capp-svc-jlaw-demo1-northcentralus" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/managedEnvironmentOperationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Operations_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Operations_List.json new file mode 100644 index 000000000000..c8fc869a6b40 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Operations_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.App/containerApps/Read", + "display": { + "provider": "Microsoft Apps", + "resource": "Container App", + "operation": "Get Container App", + "description": "Get the properties of a Container App" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_Get.json new file mode 100644 index 000000000000..a6d8bf0e1741 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "myapp", + "revisionName": "myapp--0wlqy09", + "replicaName": "myapp--0wlqy09-5d9774cff-5wnd8", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8", + "name": "myapp--0wlqy09-5d9774cff-5wnd8", + "type": "Microsoft.Web/containerapps/revisions/replicas", + "properties": { + "createdTime": "2022-01-25T19:42:45Z", + "runningState": "Running", + "runningStateDetails": "testDetail", + "containers": [ + { + "name": "hello92", + "containerId": "containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54", + "ready": true, + "started": true, + "restartCount": 0, + "runningState": "Running", + "runningStateDetails": "testDetail", + "logStreamEndpoint": "testLogStreamEndpoint", + "execEndpoint": "testExecEndpoint", + "debugEndpoint": "wss://eastasia.azurecontainerapps.dev/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8/debug?targetContainer=hello92" + } + ], + "initContainers": [] + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_List.json new file mode 100644 index 000000000000..bc149e076c57 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Replicas_List.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "myapp", + "revisionName": "myapp--0wlqy09", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8", + "name": "myapp--0wlqy09-5d9774cff-5wnd8", + "type": "Microsoft.Web/containerapps/revisions/replicas", + "properties": { + "createdTime": "2022-01-25T19:42:45Z", + "runningState": "Running", + "runningStateDetails": "testDetail", + "containers": [ + { + "name": "hello92", + "containerId": "containerd://6bac7bb3afed1c704b5fe563c34c0ecf59ac30c766bb73488f7fa552dc42ee54", + "ready": true, + "started": true, + "restartCount": 0, + "runningState": "Running", + "runningStateDetails": "testDetail", + "logStreamEndpoint": "testLogStreamEndpoint", + "execEndpoint": "testExecEndpoint", + "debugEndpoint": "wss://eastasia.azurecontainerapps.dev/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/containerApps/myapp/revisions/myapp--0wlqy09/replicas/myapp--0wlqy09-5d9774cff-5wnd8/debug?targetContainer=hello92" + } + ], + "initContainers": [] + } + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Activate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Activate.json new file mode 100644 index 000000000000..568cf94938ec --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Activate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Deactivate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Deactivate.json new file mode 100644 index 000000000000..568cf94938ec --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Deactivate.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Get.json new file mode 100644 index 000000000000..a46e7d953fb4 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.App/containerApps/revisions", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "lastActiveTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "trafficWeight": 80, + "active": true, + "replicas": 1, + "runningState": "Running" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_List.json new file mode 100644 index 000000000000..70bf28596b1d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testcontainerApp0", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/containerApps/testcontainerApp0/revisions/testcontainerApp0-pjxhsye", + "name": "testcontainerApp0-pjxhsye", + "type": "Microsoft.App/containerApps/revisions", + "properties": { + "createdTime": "2021-05-24T21:24:22+00:00", + "lastActiveTime": "2021-05-24T21:24:22+00:00", + "fqdn": "testcontainerApp0-pjxhsye.politehill-ab123456.eastus.azurecontainerapps.io", + "template": { + "containers": [ + { + "image": "repo/testcontainerApp0:v2", + "name": "testcontainerApp0", + "resources": { + "cpu": 0.2, + "memory": "100Mi" + } + } + ], + "scale": { + "minReplicas": 1, + "maxReplicas": 5, + "rules": [ + { + "name": "httpscalingrule", + "http": { + "metadata": { + "concurrentRequests": "50" + } + } + } + ] + } + }, + "trafficWeight": 80, + "active": true, + "replicas": 1 + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Restart.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Restart.json new file mode 100644 index 000000000000..74b837c721ab --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Revisions_Restart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "containerAppName": "testStaticSite0", + "revisionName": "testcontainerApp0-pjxhsye", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_CreateOrUpdate.json new file mode 100644 index 000000000000..003878890be9 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_CreateOrUpdate.json @@ -0,0 +1,158 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-08-02-preview", + "sessionPoolEnvelope": { + "location": "East US", + "properties": { + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "nodeCount": 1, + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + }, + "registryCredentials": { + "server": "test.azurecr.io", + "identity": "/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP" + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "InProgress", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + }, + "registryCredentials": { + "server": "test.azurecr.io", + "identity": "/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP" + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Delete.json new file mode 100644 index 000000000000..412ee283a976 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-08-02-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/operationResults/amF3YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Get.json new file mode 100644 index 000000000000..087ce2d628dd --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Get.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + }, + "registryCredentials": { + "server": "test.azurecr.io", + "identity": "/subscriptions/7a497526-bb8d-4816-9795-db1418a1f977/resourcegroups/test/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testSP" + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListByResourceGroup.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListByResourceGroup.json new file mode 100644 index 000000000000..dea9f1722d46 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListBySubscription.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListBySubscription.json new file mode 100644 index 000000000000..cc972c83147f --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Patch.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Patch.json new file mode 100644 index 000000000000..a84b402be296 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SessionPools_Patch.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "sessionPoolName": "testsessionpool", + "api-version": "2024-08-02-preview", + "sessionPoolEnvelope": { + "properties": { + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/sessionPools/testsessionpool", + "name": "testsessionpool", + "type": "Microsoft.App/sessionPools", + "location": "East US", + "properties": { + "provisioningState": "Succeeded", + "environmentId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.App/managedEnvironments/demokube", + "poolManagementType": "Dynamic", + "containerType": "CustomContainer", + "nodeCount": 1, + "scaleConfiguration": { + "maxConcurrentSessions": 500, + "readySessionInstances": 100 + }, + "dynamicPoolConfiguration": { + "executionType": "Timed", + "cooldownPeriodInSeconds": 600 + }, + "customContainerTemplate": { + "containers": [ + { + "image": "repo/testcontainer:v4", + "name": "testinitcontainer", + "resources": { + "cpu": 0.25, + "memory": "0.5Gi" + }, + "command": [ + "/bin/sh" + ], + "args": [ + "-c", + "while true; do echo hello; sleep 10;done" + ] + } + ], + "ingress": { + "targetPort": 80 + } + }, + "sessionNetworkConfiguration": { + "status": "EgressEnabled" + }, + "poolManagementEndpoint": "https://testsessionpool.agreeableriver-3d30edf1.eastus.azurecontainerapps.io" + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.App/locations/eastus/operationResults/amF3YUNvbXBvbmVudHM6OWFiZTM5OGUtY2ZjNi00NGZmLThmODQtNjRiOWJhMTUzZWYy?api-version=2024-08-02-preview" + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_CreateOrUpdate.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_CreateOrUpdate.json new file mode 100644 index 000000000000..d7e4d31889b3 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_CreateOrUpdate.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "x-ms-github-auxiliary": "githubaccesstoken", + "api-version": "2024-08-02-preview", + "sourceControlEnvelope": { + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "test-registry", + "registryPassword": "<registrypassword>" + }, + "azureCredentials": { + "clientId": "<clientid>", + "clientSecret": "<clientsecret>", + "tenantId": "<tenantid>", + "kind": "feaderated" + }, + "contextPath": "./", + "dockerfilePath": "./Dockerfile", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ], + "githubPersonalAccessToken": "test" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "operationState": "InProgress", + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "testreg" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + }, + "201": { + "headers": { + "location": "https://localhost/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/currentInOperationModel/operationresults/5a7f31af-8ae5-489b-a67e-f0a2d11df796?api-version=2021-03-01" + }, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "operationState": "InProgress", + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "test-registry.azurecr.io", + "registryUserName": "test-registry" + }, + "contextPath": "./", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Delete.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Delete.json new file mode 100644 index 000000000000..8cc6a088fd3d --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "x-ms-github-auxiliary": "githubaccesstoken", + "ignoreWorkflowDeletionFailure": false, + "deleteWorkflow": false, + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://localhost/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/myapp/sourcecontrols/currentInOperationModel/operationresults/14a787ee-c65f-462d-8a8b-897f69a2ab4f?api-version=2021-03-01" + } + }, + "204": {} + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Get.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Get.json new file mode 100644 index 000000000000..7b9fd525918a --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_Get.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "sourceControlName": "current", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "xwang971reg.azurecr.io", + "registryUserName": "xwang971reg" + }, + "contextPath": "./", + "dockerfilePath": "./Dockerfile", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_ListByContainer.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_ListByContainer.json new file mode 100644 index 000000000000..558ee3e41338 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/SourceControls_ListByContainer.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "651f8027-33e8-4ec4-97b4-f6e9f3dc8744", + "resourceGroupName": "workerapps-rg-xj", + "containerAppName": "testcanadacentral", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/651f8027-33e8-4ec4-97b4-f6e9f3dc8744/resourceGroups/workerapps-rg-xj/providers/Microsoft.App/containerApps/testcanadacentral/sourcecontrols/current", + "name": "current", + "type": "Microsoft.App/containerapps/sourcecontrols", + "properties": { + "repoUrl": "https://github.com/xwang971/ghatest", + "branch": "master", + "githubActionConfiguration": { + "registryInfo": { + "registryUrl": "xwang971reg.azurecr.io", + "registryUserName": "xwang971reg" + }, + "contextPath": "./", + "dockerfilePath": "./Dockerfile", + "image": "image/tag", + "buildEnvironmentVariables": [ + { + "name": "foo1", + "value": "bar1" + }, + { + "name": "foo2", + "value": "bar2" + } + ] + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json new file mode 100644 index 000000000000..b2c15f044be0 --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Subscriptions_GetCustomDomainVerificationId.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "d27c3573-f76e-4b26-b871-0ccd2203d08c", + "api-version": "2024-08-02-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": "5B406D5E790BBD224468CE0AA814C396203C7CE755F135A80E35D41865E51967" + } + } +} diff --git a/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Usages_List.json b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Usages_List.json new file mode 100644 index 000000000000..a47fee106b2b --- /dev/null +++ b/specification/app/resource-manager/Microsoft.App/preview/2024-08-02-preview/examples/Usages_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2024-08-02-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 5, + "limit": 10, + "name": { + "localizedValue": "ManagedEnvironmentCount", + "value": "ManagedEnvironmentCount" + }, + "unit": "Count" + }, + { + "currentValue": 3, + "limit": 20, + "name": { + "localizedValue": "ManagedEnvironmentCores", + "value": "ManagedEnvironmentCores" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/app/resource-manager/readme.md b/specification/app/resource-manager/readme.md index c3bf3a8afd65..8c1d1a5636b5 100644 --- a/specification/app/resource-manager/readme.md +++ b/specification/app/resource-manager/readme.md @@ -26,7 +26,51 @@ These are the global settings for the app. ``` yaml openapi-type: arm -tag: package-preview-2024-02 +tag: package-preview-2024-08 +``` + +### Tag: package-preview-2024-08 + +These settings apply only when `--tag=package-preview-2024-08` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-08' +input-file: + - Microsoft.App/preview/2024-08-02-preview/AppResiliency.json + - Microsoft.App/preview/2024-08-02-preview/AuthConfigs.json + - Microsoft.App/preview/2024-08-02-preview/AvailableWorkloadProfiles.json + - Microsoft.App/preview/2024-08-02-preview/BillingMeters.json + - Microsoft.App/preview/2024-08-02-preview/Builders.json + - Microsoft.App/preview/2024-08-02-preview/Builds.json + - Microsoft.App/preview/2024-08-02-preview/CommonDefinitions.json + - Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironments.json + - Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsCertificates.json + - Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsDaprComponents.json + - Microsoft.App/preview/2024-08-02-preview/ConnectedEnvironmentsStorages.json + - Microsoft.App/preview/2024-08-02-preview/ContainerApps.json + - Microsoft.App/preview/2024-08-02-preview/ContainerAppsBuilds.json + - Microsoft.App/preview/2024-08-02-preview/ContainerAppsPatches.json + - Microsoft.App/preview/2024-08-02-preview/ContainerAppsRevisions.json + - Microsoft.App/preview/2024-08-02-preview/Diagnostics.json + - Microsoft.App/preview/2024-08-02-preview/DotNetComponents.json + - Microsoft.App/preview/2024-08-02-preview/FunctionsExtension.json + - Microsoft.App/preview/2024-08-02-preview/Global.json + - Microsoft.App/preview/2024-08-02-preview/JavaComponents.json + - Microsoft.App/preview/2024-08-02-preview/Jobs.json + - Microsoft.App/preview/2024-08-02-preview/LogicAppsExtension.json + - Microsoft.App/preview/2024-08-02-preview/ManagedEnvironments.json + - Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponentResiliencyPolicies.json + - Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprComponents.json + - Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsDaprSubscriptions.json + - Microsoft.App/preview/2024-08-02-preview/ManagedEnvironmentsStorages.json + - Microsoft.App/preview/2024-08-02-preview/SessionPools.json + - Microsoft.App/preview/2024-08-02-preview/SourceControls.json + - Microsoft.App/preview/2024-08-02-preview/Subscriptions.json + - Microsoft.App/preview/2024-08-02-preview/Usages.json +directive: + - suppress: PatchBodyParametersSchema + from: JavaComponents.json + reason: | + Java Component is using componentType as the discriminator. While the discriminator is a required property, this rule prevent it being present in the patch request body. ``` ### Tag: package-preview-2024-02 diff --git a/specification/app/resource-manager/sdk-suppressions.yaml b/specification/app/resource-manager/sdk-suppressions.yaml index 940dd8da9cbe..921074abea6c 100644 --- a/specification/app/resource-manager/sdk-suppressions.yaml +++ b/specification/app/resource-manager/sdk-suppressions.yaml @@ -3,3 +3,13 @@ suppressions: - package: 'sdk/resourcemanager/appcontainers/armappcontainers' breaking-changes: - Field `EndTime`, `StartTime`, `Status`, `Template` of struct `JobExecution` has been removed + azure-sdk-for-python: + - package: azure-mgmt-appcontainers + breaking-changes: + - Model BillingMeter no longer has parameter system_data + - Operation ContainerAppsSourceControlsOperations.begin_create_or_update has a new required parameter x_ms_github_auxiliary + - Operation ContainerAppsSourceControlsOperations.begin_delete has a new required parameter x_ms_github_auxiliary + - Operation JobsOperations.proxy_get no longer has parameter api_name + - The 'JobsOperations' method 'proxy_get' had its parameter 'api_name' of kind 'positional_or_keyword' deleted or renamed in the current version + - The 'JobsOperations' method 'proxy_get' had its parameter 'api_name' of kind 'positional_or_keyword' deleted or renamed in the current version + - Method `JobsOperations.proxy_get` deleted or renamed its parameter `api_name` of kind `positional_or_keyword` From 9a8af2acfafc4d7a23eff41b859d2d332f51b0bc Mon Sep 17 00:00:00 2001 From: PriyankaHariharan <113563202+PriyankaHariharan@users.noreply.github.com> Date: Mon, 7 Oct 2024 20:32:52 -0700 Subject: [PATCH 058/101] [Microsoft.HybridConnectivity] Update `x-ms-mutalibility` to include read visibility for create only properties, operationId for one API and update 200 response model for LRO ASync operations for CLI commands (#30823) * add read visibility to create only properties, and update some nit typo * fix Swagger ModelValidation errors in examples * fix swagger model validation pattern invalid format errors * add 200 response for SyncNow * Update sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> --- ...nventory_ListBySolutionConfiguration.json} | 4 +- .../PublicCloudConnectors_CreateOrUpdate.json | 15 ++++-- .../2024-12-01/PublicCloudConnectors_Get.json | 8 ++-- ...icCloudConnectors_ListByResourceGroup.json | 6 ++- ...licCloudConnectors_ListBySubscription.json | 4 +- ...PublicCloudConnectors_TestPermissions.json | 48 ++++++++++++++++--- .../PublicCloudConnectors_Update.json | 10 ++-- .../SolutionConfigurations_SyncNow.json | 24 ++++++++++ .../PublicCloud.Management/main.tsp | 15 +++--- ...nventory_ListBySolutionConfiguration.json} | 4 +- .../PublicCloudConnectors_CreateOrUpdate.json | 15 ++++-- .../examples/PublicCloudConnectors_Get.json | 8 ++-- ...icCloudConnectors_ListByResourceGroup.json | 6 ++- ...licCloudConnectors_ListBySubscription.json | 4 +- ...PublicCloudConnectors_TestPermissions.json | 48 ++++++++++++++++--- .../PublicCloudConnectors_Update.json | 10 ++-- .../SolutionConfigurations_SyncNow.json | 24 ++++++++++ .../stable/2024-12-01/publicCloud.json | 19 ++++++-- .../resource-manager/sdk-suppressions.yaml | 1 + 19 files changed, 213 insertions(+), 60 deletions(-) rename specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/{Inventory_ListByWidget.json => Inventory_ListBySolutionConfiguration.json} (91%) rename specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/{Inventory_ListByWidget.json => Inventory_ListBySolutionConfiguration.json} (91%) diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListByWidget.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListBySolutionConfiguration.json similarity index 91% rename from specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListByWidget.json rename to specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListBySolutionConfiguration.json index 07ac880784b7..5487ee424c50 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListByWidget.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/Inventory_ListBySolutionConfiguration.json @@ -1,6 +1,6 @@ { - "title": "Inventory_ListByWidget", - "operationId": "Inventory_ListByWidget", + "title": "Inventory_ListBySolutionConfiguration", + "operationId": "Inventory_ListBySolutionConfiguration", "parameters": { "api-version": "2024-12-01", "resourceUri": "ymuj", diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_CreateOrUpdate.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_CreateOrUpdate.json index 781b9fbfa78c..e912d4434dc5 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_CreateOrUpdate.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_CreateOrUpdate.json @@ -26,9 +26,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -36,7 +38,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { @@ -56,16 +58,19 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "connectorPrimaryIdentifier": "20a4e2be-8158-4b9e-b512-7a1af6f827de" }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Get.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Get.json index 8d9ba2e072bf..406d019870b7 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Get.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Get.json @@ -1,5 +1,5 @@ { - "title": "publicCloudConnectors_Get", + "title": "PublicCloudConnectors_Get", "operationId": "PublicCloudConnectors_Get", "parameters": { "api-version": "2024-12-01", @@ -12,9 +12,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -22,7 +24,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListByResourceGroup.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListByResourceGroup.json index 7588e1d9248a..24cd5f63486a 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListByResourceGroup.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListByResourceGroup.json @@ -15,7 +15,9 @@ "awsCloudProfile": { "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "accountId": "troiiavknxmcpczvxwjhrdue", + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -23,7 +25,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListBySubscription.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListBySubscription.json index 6d547239bfd6..fc262550d422 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListBySubscription.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_ListBySubscription.json @@ -14,7 +14,9 @@ "awsCloudProfile": { "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "accountId": "troiiavknxmcpczvxwjhrdue", + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_TestPermissions.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_TestPermissions.json index 7cfaf55c9293..8cfddf0fb63b 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_TestPermissions.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_TestPermissions.json @@ -5,18 +5,54 @@ "api-version": "2024-12-01", "subscriptionId": "5ACC4579-DB34-4C2F-8F8C-25061168F342", "resourceGroupName": "rgpublicCloud", - "publicCloudConnector": "sjuahmnojgachluzcbhxhwkxwugbsi" + "publicCloudConnector": "rzygvnpsnrdylwzdbsscjazvamyxmh" }, "responses": { "200": { "body": { - "solutionTypes": [ + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "ppeygvsnaspxmpwalpmkqva", + "status": "toyjllkvm", + "percentComplete": 81, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [ { - "solutionType": "Microsoft.AssetManagement", - "status": "Connected", - "statusDetails": "ajulfugqtjtndrdrmyludqopydvcy" + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "svqtraeuwvyvblujlvqilypwpdrt", + "status": "bevmrejij", + "percentComplete": 15, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } } - ] + ], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } } }, "202": { diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Update.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Update.json index def3b5f8e42e..876d49e97ddd 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Update.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/PublicCloudConnectors_Update.json @@ -7,9 +7,7 @@ "resourceGroupName": "rgpublicCloud", "publicCloudConnector": "svtirlbyqpepbzyessjenlueeznhg", "properties": { - "tags": { - "key9552": "soitqufeilvijctivslnbtkdybuzmb" - }, + "tags": {}, "properties": { "awsCloudProfile": { "excludedAccounts": [ @@ -24,9 +22,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "zrbtd" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -34,7 +34,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/SolutionConfigurations_SyncNow.json b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/SolutionConfigurations_SyncNow.json index 69c6de3895c0..09c43c5f77e8 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/SolutionConfigurations_SyncNow.json +++ b/specification/hybridconnectivity/PublicCloud.Management/examples/2024-12-01/SolutionConfigurations_SyncNow.json @@ -7,6 +7,30 @@ "solutionConfiguration": "tks" }, "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "svqtraeuwvyvblujlvqilypwpdrt", + "status": "bevmrejij", + "percentComplete": 15, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } + } + }, "202": { "headers": { "location": "https://contoso.com/operationstatus" diff --git a/specification/hybridconnectivity/PublicCloud.Management/main.tsp b/specification/hybridconnectivity/PublicCloud.Management/main.tsp index acd5e6909c8b..d480834bcd6a 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/main.tsp +++ b/specification/hybridconnectivity/PublicCloud.Management/main.tsp @@ -117,7 +117,7 @@ model PublicCloudConnectorProperties { awsCloudProfile: AwsCloudProfile; @doc("Host cloud the public cloud connector.") - @visibility("create") + @visibility("create", "read") hostType: HostType; @doc("The resource provisioning state.") @@ -140,14 +140,14 @@ union HostType { @doc("cloud profile for AWS.") model AwsCloudProfile { @doc("Account id for the AWS account.") - @visibility("create") + @visibility("create", "read") accountId: string; @doc("List of AWS accounts which need to be excluded.") excludedAccounts?: string[]; @doc("Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account.") - @visibility("create") + @visibility("create", "read") isOrganizationalAccount?: boolean = false; } @@ -341,7 +341,7 @@ interface PublicCloudConnectors { testPermissions is ArmResourceActionAsync< PublicCloudConnector, void, - TestPermissionResult + Azure.ResourceManager.Foundations.OperationStatusResult >; } @@ -357,16 +357,17 @@ interface SolutionConfigurations { listByWidget is ArmResourceListAtScope<SolutionConfiguration>; @doc("Trigger immediate sync with source cloud") - syncNow is ArmResourceActionNoResponseContentAsync< + syncNow is ArmResourceActionAsync< SolutionConfiguration, - void + void, + Azure.ResourceManager.Foundations.OperationStatusResult >; } @armResourceOperations interface Inventory { get is ArmResourceRead<InventoryResource>; - listByWidget is ArmResourceListByParent<InventoryResource>; + listBySolutionConfiguration is ArmResourceListByParent<InventoryResource>; } @armResourceOperations diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListByWidget.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListBySolutionConfiguration.json similarity index 91% rename from specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListByWidget.json rename to specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListBySolutionConfiguration.json index 07ac880784b7..5487ee424c50 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListByWidget.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/Inventory_ListBySolutionConfiguration.json @@ -1,6 +1,6 @@ { - "title": "Inventory_ListByWidget", - "operationId": "Inventory_ListByWidget", + "title": "Inventory_ListBySolutionConfiguration", + "operationId": "Inventory_ListBySolutionConfiguration", "parameters": { "api-version": "2024-12-01", "resourceUri": "ymuj", diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_CreateOrUpdate.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_CreateOrUpdate.json index 781b9fbfa78c..e912d4434dc5 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_CreateOrUpdate.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_CreateOrUpdate.json @@ -26,9 +26,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -36,7 +38,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { @@ -56,16 +58,19 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", - "provisioningState": "Succeeded" + "provisioningState": "Succeeded", + "connectorPrimaryIdentifier": "20a4e2be-8158-4b9e-b512-7a1af6f827de" }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Get.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Get.json index 8d9ba2e072bf..406d019870b7 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Get.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Get.json @@ -1,5 +1,5 @@ { - "title": "publicCloudConnectors_Get", + "title": "PublicCloudConnectors_Get", "operationId": "PublicCloudConnectors_Get", "parameters": { "api-version": "2024-12-01", @@ -12,9 +12,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -22,7 +24,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListByResourceGroup.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListByResourceGroup.json index 7588e1d9248a..24cd5f63486a 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListByResourceGroup.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListByResourceGroup.json @@ -15,7 +15,9 @@ "awsCloudProfile": { "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "accountId": "troiiavknxmcpczvxwjhrdue", + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -23,7 +25,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListBySubscription.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListBySubscription.json index 6d547239bfd6..fc262550d422 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListBySubscription.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_ListBySubscription.json @@ -14,7 +14,9 @@ "awsCloudProfile": { "excludedAccounts": [ "rwgqpukglvbqmogqcliqolucp" - ] + ], + "accountId": "troiiavknxmcpczvxwjhrdue", + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_TestPermissions.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_TestPermissions.json index 7cfaf55c9293..8cfddf0fb63b 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_TestPermissions.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_TestPermissions.json @@ -5,18 +5,54 @@ "api-version": "2024-12-01", "subscriptionId": "5ACC4579-DB34-4C2F-8F8C-25061168F342", "resourceGroupName": "rgpublicCloud", - "publicCloudConnector": "sjuahmnojgachluzcbhxhwkxwugbsi" + "publicCloudConnector": "rzygvnpsnrdylwzdbsscjazvamyxmh" }, "responses": { "200": { "body": { - "solutionTypes": [ + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "ppeygvsnaspxmpwalpmkqva", + "status": "toyjllkvm", + "percentComplete": 81, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [ { - "solutionType": "Microsoft.AssetManagement", - "status": "Connected", - "statusDetails": "ajulfugqtjtndrdrmyludqopydvcy" + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "svqtraeuwvyvblujlvqilypwpdrt", + "status": "bevmrejij", + "percentComplete": 15, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } } - ] + ], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } } }, "202": { diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Update.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Update.json index def3b5f8e42e..876d49e97ddd 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Update.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/PublicCloudConnectors_Update.json @@ -7,9 +7,7 @@ "resourceGroupName": "rgpublicCloud", "publicCloudConnector": "svtirlbyqpepbzyessjenlueeznhg", "properties": { - "tags": { - "key9552": "soitqufeilvijctivslnbtkdybuzmb" - }, + "tags": {}, "properties": { "awsCloudProfile": { "excludedAccounts": [ @@ -24,9 +22,11 @@ "body": { "properties": { "awsCloudProfile": { + "accountId": "snbnuxckevyqpm", "excludedAccounts": [ "zrbtd" - ] + ], + "isOrganizationalAccount": true }, "hostType": "AWS", "provisioningState": "Succeeded", @@ -34,7 +34,7 @@ }, "tags": {}, "location": "jpiglusfxynfcewcjwvvnn", - "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/resourceGroups/rgpublicCloud/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", "name": "esixipkbydb", "type": "eelsjvqvkdxdncptsobrswhulnm", "systemData": { diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/SolutionConfigurations_SyncNow.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/SolutionConfigurations_SyncNow.json index 69c6de3895c0..09c43c5f77e8 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/SolutionConfigurations_SyncNow.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/examples/SolutionConfigurations_SyncNow.json @@ -7,6 +7,30 @@ "solutionConfiguration": "tks" }, "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.HybridConnectivity/PublicCloudConnectors/esixipkbydb", + "name": "svqtraeuwvyvblujlvqilypwpdrt", + "status": "bevmrejij", + "percentComplete": 15, + "startTime": "2024-10-02T18:38:19.143Z", + "endTime": "2024-10-02T18:38:19.143Z", + "operations": [], + "error": { + "code": "ykzvluyqiftfsumgvwzdh", + "message": "krbjgtqkjgiux", + "target": "nsaucxt", + "details": [], + "additionalInfo": [ + { + "type": "qivvrewsjvcildjgwwytgimwklh", + "info": {} + } + ] + } + } + }, "202": { "headers": { "location": "https://contoso.com/operationstatus" diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/publicCloud.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/publicCloud.json index 2c9b9eae9ed7..86da24074eb4 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/publicCloud.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/PublicCloud/stable/2024-12-01/publicCloud.json @@ -291,7 +291,7 @@ }, "/{resourceUri}/providers/Microsoft.HybridConnectivity/solutionConfigurations/{solutionConfiguration}/inventory": { "get": { - "operationId": "Inventory_ListByWidget", + "operationId": "Inventory_ListBySolutionConfiguration", "tags": [ "Inventory" ], @@ -327,8 +327,8 @@ } }, "x-ms-examples": { - "Inventory_ListByWidget": { - "$ref": "./examples/Inventory_ListByWidget.json" + "Inventory_ListBySolutionConfiguration": { + "$ref": "./examples/Inventory_ListBySolutionConfiguration.json" } }, "x-ms-pageable": { @@ -411,6 +411,12 @@ } ], "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, "202": { "description": "Resource operation accepted.", "headers": { @@ -649,7 +655,7 @@ } }, "x-ms-examples": { - "publicCloudConnectors_Get": { + "PublicCloudConnectors_Get": { "$ref": "./examples/PublicCloudConnectors_Get.json" } } @@ -859,7 +865,7 @@ "200": { "description": "Azure operation completed successfully.", "schema": { - "$ref": "#/definitions/TestPermissionResult" + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" } }, "202": { @@ -992,6 +998,7 @@ "type": "string", "description": "Account id for the AWS account.", "x-ms-mutability": [ + "read", "create" ] }, @@ -1007,6 +1014,7 @@ "description": "Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account.", "default": false, "x-ms-mutability": [ + "read", "create" ] } @@ -1249,6 +1257,7 @@ "$ref": "#/definitions/HostType", "description": "Host cloud the public cloud connector.", "x-ms-mutability": [ + "read", "create" ] }, diff --git a/specification/hybridconnectivity/resource-manager/sdk-suppressions.yaml b/specification/hybridconnectivity/resource-manager/sdk-suppressions.yaml index 01b1888ff071..6d8ba71c526e 100644 --- a/specification/hybridconnectivity/resource-manager/sdk-suppressions.yaml +++ b/specification/hybridconnectivity/resource-manager/sdk-suppressions.yaml @@ -6,4 +6,5 @@ suppressions: azure-sdk-for-python: - package: azure-mgmt-hybridconnectivity breaking-changes: + - Method `HybridConnectivityMgmtClient.__init__` inserted a `positional_or_keyword` parameter `subscription_id` - "'HybridConnectivityMgmtClient.__init__' method inserted a 'positional_or_keyword' parameter 'subscription_id'" From dce461bb4e89238f383f0a165d95859f54638fd6 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Mon, 7 Oct 2024 21:42:24 -0700 Subject: [PATCH 059/101] [ProtectedFiles] Allow bot account "dependabot" to edit protected files (#30899) --- .github/workflows/protected-files.yaml | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 37e7ae730f06..19c303b3f358 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -2,6 +2,10 @@ name: Protected Files on: pull_request +env: + # Users allowed to edit protected files without failing check + user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' || github.event.pull_request.user.login == 'dependabot' }} + jobs: protected-files: name: Protected Files @@ -9,20 +13,19 @@ jobs: runs-on: ubuntu-latest steps: - # Allow bot account 'azure-sdk' to update protected files. - # Since check is required, the job itself cannot be skipped. - - name: Allow bot account 'azure-sdk' - if: github.event.pull_request.user.login == 'azure-sdk' - run: echo "Bot account 'azure-sdk' is allowed to update protected files" + # Since check is required, the job must pass instead of being skipped + - name: User allowed + if: ${{ env.user-allowed == 'true' }} + run: echo "Account '${{ github.event.pull_request.user.login }}' is allowed to update protected files" - uses: actions/checkout@v4 - if: github.event.pull_request.user.login != 'azure-sdk' + if: ${{ env.user-allowed != 'true' }} with: # Required since "HEAD^" is passed to Get-ChangedFiles fetch-depth: 2 - name: Detect changes to protected files - if: github.event.pull_request.user.login != 'azure-sdk' + if: ${{ env.user-allowed != 'true' }} run: | . eng/scripts/ChangedFiles-Functions.ps1 From 7b0afdb9323450d76f48abfd1f5d0ce379bb49e6 Mon Sep 17 00:00:00 2001 From: Mike Harder <mharder@microsoft.com> Date: Mon, 7 Oct 2024 22:11:03 -0700 Subject: [PATCH 060/101] [ProtectedFiles] Update account name to "dependabot[bot]" (#30905) --- .github/workflows/protected-files.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/protected-files.yaml b/.github/workflows/protected-files.yaml index 19c303b3f358..1499df886693 100644 --- a/.github/workflows/protected-files.yaml +++ b/.github/workflows/protected-files.yaml @@ -4,7 +4,7 @@ on: pull_request env: # Users allowed to edit protected files without failing check - user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' || github.event.pull_request.user.login == 'dependabot' }} + user-allowed: ${{ github.event.pull_request.user.login == 'azure-sdk' || github.event.pull_request.user.login == 'dependabot[bot]' }} jobs: protected-files: From c4f4021bea5eee306fa202df3c7e19271a9f1f96 Mon Sep 17 00:00:00 2001 From: jkore1911 <jkore@microsoft.com> Date: Tue, 8 Oct 2024 15:56:27 +0530 Subject: [PATCH 061/101] Adding new API version 2024-10-01-preview for Microsoft.Elastic (#30791) * Adding the new API version 2024-10-01-preview * Changed the version to the new API version: 2024-10-01-preview * Revising max length limit of user and company info properities * Making changes in readme.md file * Revising max length limit of user and company info properities * Revising max length limit of user and company info properities --- .../preview/2024-10-01-preview/elastic.json | 3664 +++++++++++++++++ .../examples/AllTrafficFilters_list.json | 36 + .../AssociateTrafficFilter_Update.json | 16 + .../AssociatedFiltersForDeployment_list.json | 36 + .../examples/BillingInfo_Get.json | 29 + .../ConnectedPartnerResources_List.json | 24 + .../examples/DeploymentInfo_List.json | 28 + .../DetachAndDeleteTrafficFilter_Delete.json | 12 + .../examples/DetachTrafficFilters_Update.json | 16 + .../examples/ElasticVersions_List.json | 20 + .../examples/ExternalUserInfo.json | 25 + .../examples/IPTrafficFilter_Create.json | 18 + .../examples/Monitor_Upgrade.json | 18 + .../examples/MonitoredResources_List.json | 21 + ...MonitoredSubscriptions_CreateorUpdate.json | 152 + .../MonitoredSubscriptions_Delete.json | 17 + .../examples/MonitoredSubscriptions_Get.json | 60 + .../examples/MonitoredSubscriptions_List.json | 64 + .../MonitoredSubscriptions_Update.json | 108 + .../examples/Monitors_Create.json | 115 + .../examples/Monitors_Delete.json | 17 + .../examples/Monitors_Get.json | 43 + .../examples/Monitors_List.json | 45 + .../Monitors_ListByResourceGroup.json | 46 + .../examples/Monitors_Update.json | 125 + .../examples/OpenAI_CreateOrUpdate.json | 44 + .../examples/OpenAI_Delete.json | 13 + .../examples/OpenAI_Get.json | 24 + .../examples/OpenAI_GetStatus.json | 18 + .../examples/OpenAI_List.json | 27 + .../examples/Operations_List.json | 23 + .../examples/Organizations_GetApiKey.json | 18 + ..._GetElasticToAzureSubscriptionMapping.json | 25 + .../examples/Organizations_Resubscribe.json | 58 + .../PrivateLinkTrafficFilters_Create.json | 19 + .../examples/TagRules_CreateOrUpdate.json | 59 + .../examples/TagRules_Delete.json | 18 + .../examples/TagRules_Get.json | 38 + .../examples/TagRules_List.json | 41 + .../examples/TrafficFilters_Delete.json | 12 + .../examples/UpgradableVersions_Details.json | 19 + .../examples/VMCollection_Update.json | 15 + .../examples/VMHost_List.json | 19 + .../examples/VMIngestion_Details.json | 16 + .../elastic/resource-manager/readme.md | 11 +- 45 files changed, 5271 insertions(+), 1 deletion(-) create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/elastic.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AllTrafficFilters_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociateTrafficFilter_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociatedFiltersForDeployment_list.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/BillingInfo_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ConnectedPartnerResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DeploymentInfo_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachTrafficFilters_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ElasticVersions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ExternalUserInfo.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/IPTrafficFilter_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitor_Upgrade.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredResources_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_ListByResourceGroup.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_GetStatus.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Operations_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetApiKey.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_Resubscribe.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/PrivateLinkTrafficFilters_Create.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_CreateOrUpdate.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Get.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TrafficFilters_Delete.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/UpgradableVersions_Details.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMCollection_Update.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMHost_List.json create mode 100644 specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMIngestion_Details.json diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/elastic.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/elastic.json new file mode 100644 index 000000000000..2b5799b561bf --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/elastic.json @@ -0,0 +1,3664 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Elastic", + "version": "2024-10-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Microsoft Entra ID OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Elastic/operations": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all operations provided by Microsoft.Elastic.", + "operationId": "Operations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified subscription.", + "operationId": "Monitors_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_List": { + "$ref": "./examples/Monitors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/elasticVersions": { + "get": { + "tags": [ + "ElasticVersions" + ], + "summary": "Get a list of available versions for a region.", + "operationId": "ElasticVersions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "query", + "name": "region", + "description": "Region where elastic deployment will take place.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticVersionsListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ElasticVersions_List": { + "$ref": "./examples/ElasticVersions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "List all monitors under the specified resource group.", + "operationId": "Monitors_ListByResourceGroup", + "produces": [ + "application/json" + ], + "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": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_ListByResourceGroup": { + "$ref": "./examples/Monitors_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}": { + "get": { + "tags": [ + "MonitorsResource" + ], + "summary": "Get the properties of a specific monitor resource.", + "operationId": "Monitors_Get", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_Get": { + "$ref": "./examples/Monitors_Get.json" + } + } + }, + "put": { + "tags": [ + "MonitorsResource" + ], + "summary": "Create a monitor resource.", + "operationId": "Monitors_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic monitor resource model", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Monitors_Create": { + "$ref": "./examples/Monitors_Create.json" + } + } + }, + "patch": { + "tags": [ + "MonitorsResource" + ], + "summary": "Update a monitor resource.", + "operationId": "Monitors_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic resource model update parameters.", + "schema": { + "$ref": "#/definitions/ElasticMonitorResourceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Monitors_Update": { + "$ref": "./examples/Monitors_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitorsResource" + ], + "summary": "Delete a monitor resource.", + "operationId": "Monitors_Delete", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_Delete": { + "$ref": "./examples/Monitors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List all the subscriptions currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionPropertiesList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/monitoredSubscriptions/{configurationName}": { + "get": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "List all the subscriptions currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Monitors_GetMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "monitoredSubscriptions" + ], + "summary": "Add the subscriptions that should be monitored by the Elastic monitor resource.", + "operationId": "MonitoredSubscriptions_CreateorUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_AddMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_CreateorUpdate.json" + } + } + }, + "patch": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Elastic monitor resource", + "operationId": "MonitoredSubscriptions_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_UpdateMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Update.json" + } + } + }, + "delete": { + "tags": [ + "MonitoredSubscriptions" + ], + "summary": "Updates the subscriptions that are being monitored by the Elastic monitor resource", + "operationId": "MonitoredSubscriptions_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitors_DeleteMonitoredSubscriptions": { + "$ref": "./examples/MonitoredSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listMonitoredResources": { + "post": { + "tags": [ + "MonitoredResources" + ], + "summary": "List the resources currently being monitored by the Elastic monitor resource.", + "operationId": "MonitoredResources_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoredResourceListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "MonitoredResources_List": { + "$ref": "./examples/MonitoredResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listDeploymentInfo": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Fetch information regarding Elastic cloud deployment corresponding to the Elastic monitor resource.", + "operationId": "DeploymentInfo_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeploymentInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DeploymentInfo_List": { + "$ref": "./examples/DeploymentInfo_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createOrUpdateExternalUser": { + "post": { + "tags": [ + "DeploymentInfo" + ], + "summary": "Create User inside elastic deployment which are used by customers to perform operations on the elastic deployment", + "operationId": "ExternalUser_CreateOrUpdate", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic External User Creation Parameters", + "schema": { + "$ref": "#/definitions/ExternalUserInfo" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ExternalUserCreationResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "ExternalUser_CreateOrUpdate": { + "$ref": "./examples/ExternalUserInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/getBillingInfo": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "Get marketplace and organization info mapped to the given monitor.", + "operationId": "BillingInfo_Get", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/BillingInfoResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "BillingInfo_Get": { + "$ref": "./examples/BillingInfo_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listConnectedPartnerResources": { + "post": { + "tags": [ + "ConnectedResources" + ], + "summary": "List of all active deployments that are associated with the marketplace subscription linked to the given monitor.", + "operationId": "ConnectedPartnerResources_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ConnectedPartnerResourcesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ConnectedPartnerResources_List": { + "$ref": "./examples/ConnectedPartnerResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "List OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModelListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OpenAI_List": { + "$ref": "./examples/OpenAI_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}": { + "get": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Get", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Get": { + "$ref": "./examples/OpenAI_Get.json" + } + } + }, + "put": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Create or update a OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + }, + { + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_CreateOrUpdate": { + "$ref": "./examples/OpenAI_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Delete OpenAI integration rule for a given monitor resource.", + "operationId": "OpenAI_Delete", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_Delete": { + "$ref": "./examples/OpenAI_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/openAIIntegrations/{integrationName}/getStatus": { + "post": { + "tags": [ + "OpenAIIntegration" + ], + "summary": "Get OpenAI integration status for a given integration.", + "operationId": "OpenAI_GetStatus", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/OpenAIIntegrationNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenAI_GetStatus": { + "$ref": "./examples/OpenAI_GetStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules": { + "get": { + "tags": [ + "Rules" + ], + "summary": "List the tag rules for a given monitor resource.", + "operationId": "TagRules_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRulesListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TagRules_List": { + "$ref": "./examples/TagRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}": { + "put": { + "tags": [ + "Rules" + ], + "summary": "Create or update a tag rule set for a given monitor resource.", + "operationId": "TagRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + }, + { + "description": "request body of MonitoringTagRules", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_CreateOrUpdate": { + "$ref": "./examples/TagRules_CreateOrUpdate.json" + } + } + }, + "get": { + "tags": [ + "Rules" + ], + "summary": "Get a tag rule set for a given monitor resource.", + "operationId": "TagRules_Get", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TagRules_Get": { + "$ref": "./examples/TagRules_Get.json" + } + } + }, + "delete": { + "tags": [ + "Rules" + ], + "summary": "Delete a tag rule set for a given monitor resource.", + "operationId": "TagRules_Delete", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "$ref": "#/parameters/RuleSetNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Success" + }, + "204": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TagRules_Delete": { + "$ref": "./examples/TagRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listVMHost": { + "post": { + "tags": [ + "VMHHostList" + ], + "summary": "List the vm resources currently being monitored by the Elastic monitor resource.", + "operationId": "VMHost_List", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMHostListResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VMHost_List": { + "$ref": "./examples/VMHost_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmIngestionDetails": { + "post": { + "tags": [ + "VMIngestionDetails" + ], + "summary": "List the vm ingestion details that will be monitored by the Elastic monitor resource.", + "operationId": "VMIngestion_Details", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/VMIngestionDetailsResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMIngestion_Details": { + "$ref": "./examples/VMIngestion_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/vmCollectionUpdate": { + "post": { + "tags": [ + "VMCollectionUpdate" + ], + "summary": "Update the vm details that will be monitored by the Elastic monitor resource.", + "operationId": "VMCollection_Update", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "VM resource Id", + "schema": { + "$ref": "#/definitions/VMCollectionUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "VMCollection_Update": { + "$ref": "./examples/VMCollection_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listUpgradableVersions": { + "post": { + "tags": [ + "MonitorUpgradableVersions" + ], + "summary": "List of upgradable versions for a given monitor resource.", + "operationId": "UpgradableVersions_Details", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UpgradableVersionsList" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "UpgradableVersions_Details": { + "$ref": "./examples/UpgradableVersions_Details.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/upgrade": { + "post": { + "tags": [ + "DeploymentUpdate" + ], + "summary": "Upgradable version for a monitor resource.", + "operationId": "Monitor_Upgrade", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Elastic Monitor Upgrade Parameters", + "schema": { + "$ref": "#/definitions/ElasticMonitorUpgrade" + } + } + ], + "responses": { + "202": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Monitor_Upgrade": { + "$ref": "./examples/Monitor_Upgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAllTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all traffic filters for the account.", + "operationId": "AllTrafficFilters_list", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "AllTrafficFilters_list": { + "$ref": "./examples/AllTrafficFilters_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/listAssociatedTrafficFilters": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Get the list of all associated traffic filters for the given deployment.", + "operationId": "listAssociatedTrafficFilters_list", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticTrafficFilterResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "listAssociatedTrafficFilters_list": { + "$ref": "./examples/AssociatedFiltersForDeployment_list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociateIPFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate IP traffic filter for the given deployment.", + "operationId": "createAndAssociateIPFilter_Create", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "ips", + "description": "List of ips", + "type": "string" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociateIPFilter_Create": { + "$ref": "./examples/IPTrafficFilter_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/createAndAssociatePLFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Create and Associate private link traffic filter for the given deployment.", + "operationId": "createAndAssociatePLFilter_Create", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "name", + "description": "Name of the traffic filter", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointGuid", + "description": "Guid of the private endpoint", + "type": "string" + }, + { + "in": "query", + "name": "privateEndpointName", + "description": "Name of the private endpoint", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "createAndAssociatePLFilter_Create": { + "$ref": "./examples/PrivateLinkTrafficFilters_Create.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/associateTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Associate traffic filter for the given deployment.", + "operationId": "AssociateTrafficFilter_Associate", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "AssociateTrafficFilter_Associate": { + "$ref": "./examples/AssociateTrafficFilter_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachAndDeleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach and Delete traffic filter from the given deployment.", + "operationId": "DetachAndDeleteTrafficFilter_Delete", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "DetachAndDeleteTrafficFilter_Delete": { + "$ref": "./examples/DetachAndDeleteTrafficFilter_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/detachTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Detach traffic filter for the given deployment.", + "operationId": "DetachTrafficFilter_Update", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "DetachTrafficFilter_Update": { + "$ref": "./examples/DetachTrafficFilters_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/deleteTrafficFilter": { + "post": { + "tags": [ + "TrafficFilter" + ], + "summary": "Delete traffic filter from the account.", + "operationId": "TrafficFilters_Delete", + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "query", + "name": "rulesetId", + "description": "Ruleset Id of the filter", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "TrafficFilters_Delete": { + "$ref": "./examples/TrafficFilters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getOrganizationApiKey": { + "post": { + "tags": [ + "ApiKey" + ], + "summary": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "description": "Fetch User API Key from internal database, if it was generated and stored while creating the Elasticsearch Organization.", + "operationId": "Organizations_GetApiKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "in": "body", + "name": "body", + "description": "Email Id parameter of the User Organization, of which the API Key must be returned", + "schema": { + "$ref": "#/definitions/UserEmailId" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserApiKeyResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetApiKey": { + "$ref": "./examples/Organizations_GetApiKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Elastic/getElasticOrganizationToAzureSubscriptionMapping": { + "post": { + "tags": [ + "UserOrganization" + ], + "summary": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "description": "Get Elastic Organization To Azure Subscription Mapping details for the logged-in user.", + "operationId": "Organizations_GetElasticToAzureSubscriptionMapping", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponse" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organizations_GetElasticToAzureSubscriptionMapping": { + "$ref": "./examples/Organizations_GetElasticToAzureSubscriptionMapping.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/resubscribe": { + "post": { + "tags": [ + "Resubscribe" + ], + "summary": "Resubscribe the Elasticsearch Organization.", + "operationId": "Organizations_Resubscribe", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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" + }, + { + "$ref": "#/parameters/MonitorNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Resubscribe Properties", + "schema": { + "$ref": "#/definitions/ResubscribeProperties" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "Accepted" + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Organizations_Resubscribe": { + "$ref": "./examples/Organizations_Resubscribe.json" + } + } + } + } + }, + "definitions": { + "ErrorResponseBody": { + "description": "Error response body.", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + }, + "target": { + "description": "Error target.", + "type": "string" + }, + "details": { + "description": "Error details.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "description": "RP default error response.", + "type": "object", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider, i.e., Microsoft.Elastic.", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'monitors'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write monitors'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "A Microsoft.Elastic REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name, i.e., {provider}/{resource}/{operation}.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list the Microsoft.Elastic operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the Microsoft.Elastic provider.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ResourceSku": { + "description": "Microsoft.Elastic SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the SKU.", + "type": "string" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled", + "Deleted", + "NotSpecified" + ], + "type": "string", + "description": "Provisioning state of Elastic resource.", + "title": "ProvisioningState", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + }, + "readOnly": true + }, + "MonitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MonitoringStatus" + } + }, + "ElasticCloudUser": { + "description": "Details of the user's elastic account.", + "type": "object", + "properties": { + "emailAddress": { + "description": "Email of the Elastic User Account.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "User Id of the elastic account of the User.", + "type": "string", + "readOnly": true + }, + "elasticCloudSsoDefaultUrl": { + "description": "Elastic cloud default dashboard sso URL of the Elastic user account.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticCloudDeployment": { + "description": "Details of the user's elastic deployment associated with the monitor resource.", + "type": "object", + "properties": { + "name": { + "description": "Elastic deployment name", + "type": "string", + "readOnly": true + }, + "deploymentId": { + "description": "Elastic deployment Id", + "type": "string", + "readOnly": true + }, + "azureSubscriptionId": { + "description": "Associated Azure subscription Id for the elastic deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchRegion": { + "description": "Region where Deployment at Elastic side took place.", + "type": "string", + "readOnly": true + }, + "elasticsearchServiceUrl": { + "description": "Elasticsearch ingestion endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaServiceUrl": { + "description": "Kibana endpoint of the Elastic deployment.", + "type": "string", + "readOnly": true + }, + "kibanaSsoUrl": { + "description": "Kibana dashboard sso URL of the Elastic deployment.", + "type": "string", + "readOnly": true + } + } + }, + "ElasticProperties": { + "description": "Elastic Resource Properties.", + "type": "object", + "properties": { + "elasticCloudUser": { + "description": "Details of the user's elastic account.", + "$ref": "#/definitions/ElasticCloudUser" + }, + "elasticCloudDeployment": { + "description": "Details of the elastic cloud deployment.", + "$ref": "#/definitions/ElasticCloudDeployment" + } + } + }, + "CompanyInfo": { + "description": "Company information of the user to be passed to partners.", + "type": "object", + "properties": { + "domain": { + "description": "Domain of the company", + "maxLength": 256, + "type": "string" + }, + "business": { + "description": "Business of the company", + "maxLength": 128, + "type": "string" + }, + "employeesNumber": { + "description": "Number of employees in the company", + "maxLength": 20, + "type": "string" + }, + "state": { + "description": "State of the company location.", + "maxLength": 128, + "type": "string" + }, + "country": { + "description": "Country of the company location.", + "maxLength": 128, + "type": "string" + } + } + }, + "UserInfo": { + "description": "User Information to be passed to partners.", + "type": "object", + "properties": { + "firstName": { + "description": "First name of the user", + "maxLength": 128, + "type": "string" + }, + "lastName": { + "description": "Last name of the user", + "maxLength": 128, + "type": "string" + }, + "companyName": { + "description": "Company name of the user", + "maxLength": 128, + "type": "string" + }, + "emailAddress": { + "description": "Email of the user used by Elastic for contacting them if needed", + "pattern": "^([^<>()\\[\\]\\.,;:\\s@\"]+(\\.[^<>()\\[\\]\\.,;:\\s@\"]+)*)@(([a-zA-Z-_0-9]+\\.)+[a-zA-Z]{2,})$", + "type": "string" + }, + "companyInfo": { + "description": "Company information of the user to be passed to partners.", + "$ref": "#/definitions/CompanyInfo" + } + } + }, + "PlanDetails": { + "description": "Plan details of the monitor resource.", + "type": "object", + "properties": { + "offerID": { + "description": "Offer ID of the plan", + "type": "string" + }, + "publisherID": { + "description": "Publisher ID of the plan", + "type": "string" + }, + "termID": { + "description": "Term ID of the plan", + "type": "string" + }, + "planID": { + "description": "Plan ID", + "type": "string" + }, + "planName": { + "description": "Plan Name", + "type": "string" + } + } + }, + "LiftrResourceCategories": { + "enum": [ + "Unknown", + "MonitorLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "LiftrResourceCategories" + }, + "readOnly": true + }, + "MonitorProperties": { + "description": "Properties specific to the monitor resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitor resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "monitoringStatus": { + "description": "Flag specifying if the resource monitoring is enabled or disabled.", + "$ref": "#/definitions/MonitoringStatus" + }, + "elasticProperties": { + "description": "Elastic cloud properties.", + "$ref": "#/definitions/ElasticProperties" + }, + "userInfo": { + "description": "User information.", + "$ref": "#/definitions/UserInfo", + "x-ms-mutability": [ + "create" + ] + }, + "planDetails": { + "description": "Plan details of the monitor resource.", + "$ref": "#/definitions/PlanDetails" + }, + "version": { + "description": "Version of elastic of the monitor resource", + "type": "string" + }, + "subscriptionState": { + "description": "State of the Azure Subscription containing the monitor resource", + "type": "string" + }, + "saaSAzureSubscriptionStatus": { + "description": "Status of Azure Subscription where Marketplace SaaS is located.", + "type": "string" + }, + "sourceCampaignName": { + "description": "Name of the marketing campaign.", + "type": "string" + }, + "sourceCampaignId": { + "description": "A unique identifier associated with the campaign.", + "type": "string" + }, + "liftrResourceCategory": { + "$ref": "#/definitions/LiftrResourceCategories" + }, + "liftrResourcePreference": { + "description": "The priority of the resource.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "generateApiKey": { + "description": "Flag to determine if User API Key has to be generated and shared.", + "type": "boolean" + } + } + }, + "ManagedIdentityTypes": { + "enum": [ + "SystemAssigned" + ], + "type": "string", + "description": "Managed Identity types.", + "x-ms-enum": { + "modelAsString": true, + "name": "ManagedIdentityTypes" + } + }, + "IdentityProperties": { + "description": "Identity properties.", + "type": "object", + "properties": { + "principalId": { + "description": "The identity ID.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant ID of resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Managed identity type.", + "$ref": "#/definitions/ManagedIdentityTypes" + } + } + }, + "ElasticMonitorResource": { + "description": "Monitor resource.", + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "ARM id of the monitor resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the monitor resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitor resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "SKU of the monitor resource.", + "$ref": "#/definitions/ResourceSku" + }, + "properties": { + "description": "Properties of the monitor resource.", + "$ref": "#/definitions/MonitorProperties", + "x-ms-client-flatten": false + }, + "identity": { + "description": "Identity properties of the monitor resource.", + "$ref": "#/definitions/IdentityProperties" + }, + "tags": { + "description": "The tags of the monitor resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "The location of the monitor resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "ElasticMonitorResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/ElasticMonitorResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticMonitorResourceUpdateParameters": { + "description": "Monitor resource update parameters.", + "type": "object", + "properties": { + "tags": { + "description": "elastic monitor resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SendingLogs": { + "enum": [ + "True", + "False" + ], + "type": "string", + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "title": "SendingLogs", + "x-ms-enum": { + "modelAsString": true, + "name": "SendingLogs" + } + }, + "MonitoredResource": { + "description": "The properties of a resource currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string" + }, + "sendingLogs": { + "description": "Flag indicating the status of the resource for sending logs operation to Elastic.", + "$ref": "#/definitions/SendingLogs" + }, + "reasonForLogsStatus": { + "description": "Reason for why the resource is sending logs (or why it is not sending).", + "type": "string" + } + } + }, + "SubscriptionList": { + "description": "The request to update subscriptions needed to be monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "operation": { + "description": "The operation for the patch on the resource.", + "enum": [ + "AddBegin", + "AddComplete", + "DeleteBegin", + "DeleteComplete", + "Active" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Operation" + }, + "x-ms-mutability": [ + "create", + "update" + ] + }, + "monitoredSubscriptionList": { + "description": "List of subscriptions and the state of the monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscription" + }, + "x-ms-identifiers": [ + "properties/subscriptionId" + ] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of the resource", + "readOnly": true + } + } + }, + "MonitoredResourceListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoredResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredSubscriptionProperties": { + "description": "The request to update subscriptions needed to be monitored by the Elastic monitor resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the monitored subscription resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SubscriptionList" + } + } + }, + "MonitoredSubscriptionPropertiesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MonitoredSubscriptionProperties" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of items" + } + } + }, + "TagAction": { + "description": "Valid actions for a filtering tag. Exclusion takes priority over inclusion.", + "enum": [ + "Include", + "Exclude" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TagAction" + } + }, + "FilteringTag": { + "description": "The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.", + "type": "object", + "properties": { + "name": { + "description": "The name (also known as the key) of the tag.", + "type": "string" + }, + "value": { + "description": "The value of the tag.", + "type": "string" + }, + "action": { + "description": "Valid actions for a filtering tag.", + "$ref": "#/definitions/TagAction" + } + } + }, + "ElasticVersionListFormat": { + "description": "Elastic Version List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticVersionListProperties" + } + } + }, + "ElasticVersionListProperties": { + "description": "Elastic Version Properties", + "type": "object", + "properties": { + "version": { + "description": "Available elastic version of the given region", + "type": "string" + } + } + }, + "ElasticVersionsListResponse": { + "description": "List of elastic versions available in a region.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/version" + ], + "items": { + "$ref": "#/definitions/ElasticVersionListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "LogRules": { + "description": "Set of rules for sending logs for the Monitor resource.", + "type": "object", + "properties": { + "sendAadLogs": { + "description": "Flag specifying if AAD logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendSubscriptionLogs": { + "description": "Flag specifying if subscription logs should be sent for the Monitor resource.", + "type": "boolean" + }, + "sendActivityLogs": { + "description": "Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.", + "type": "boolean" + }, + "filteringTags": { + "description": "List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/FilteringTag" + } + } + } + }, + "MonitoringTagRulesProperties": { + "description": "Definition of the properties for a TagRules resource.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the monitoring tag rules.", + "$ref": "#/definitions/ProvisioningState" + }, + "logRules": { + "description": "Rules for sending logs.", + "$ref": "#/definitions/LogRules" + } + } + }, + "MonitoringTagRules": { + "description": "Capture logs and metrics of Azure resources based on ARM tags.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the rule set.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the rule set.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the rule set.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Properties of the monitoring tag rules.", + "$ref": "#/definitions/MonitoringTagRulesProperties", + "x-ms-client-flatten": false + }, + "systemData": { + "readOnly": true, + "description": "The system metadata relating to this resource", + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + } + } + }, + "MonitoringTagRulesListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/MonitoringTagRules" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "MonitoredSubscription": { + "description": "The list of subscriptions and it's monitoring status by current Elastic monitor.", + "type": "object", + "properties": { + "subscriptionId": { + "description": "The subscriptionId to be monitored.", + "required": [ + "subscriptionId" + ], + "type": "string" + }, + "status": { + "description": "The state of monitoring.", + "enum": [ + "InProgress", + "Active", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + }, + "type": "string" + }, + "error": { + "description": "The reason of not monitoring the subscription.", + "type": "string" + }, + "tagRules": { + "$ref": "#/definitions/MonitoringTagRulesProperties" + } + } + }, + "OpenAIIntegrationProperties": { + "description": "Open AI Integration details.", + "type": "object", + "properties": { + "openAIResourceId": { + "description": "The resource name of Open AI resource", + "type": "string" + }, + "openAIResourceEndpoint": { + "description": "The API endpoint for Open AI resource", + "type": "string" + }, + "openAIConnectorId": { + "description": "The connector id of Open AI resource", + "type": "string" + }, + "key": { + "description": "Value of API key for Open AI resource", + "type": "string", + "x-ms-secret": true + }, + "lastRefreshAt": { + "format": "date-time", + "description": "Last Update Timestamp for key updation", + "type": "string", + "readOnly": true + } + } + }, + "OpenAIIntegrationRPModel": { + "description": "Capture properties of Open AI resource Integration.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "name": { + "description": "Name of the integration.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "The id of the integration.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the integration.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/OpenAIIntegrationProperties" + } + } + }, + "OpenAIIntegrationRPModelListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OpenAIIntegrationRPModel" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OpenAIIntegrationStatusResponse": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/OpenAIIntegrationStatusResponseProperties" + } + } + }, + "OpenAIIntegrationStatusResponseProperties": { + "description": "Status of the OpenAI Integration", + "type": "object", + "properties": { + "status": { + "description": "Status of the OpenAI Integration", + "type": "string" + } + } + }, + "BillingInfoResponse": { + "description": "Marketplace Subscription and Organization details to which resource gets billed into.", + "type": "object", + "properties": { + "marketplaceSaasInfo": { + "description": "Marketplace Subscription details", + "$ref": "#/definitions/MarketplaceSaaSInfo" + }, + "partnerBillingEntity": { + "description": "Partner Billing Entity details: Organization Info", + "$ref": "#/definitions/PartnerBillingEntity" + } + } + }, + "MarketplaceSaaSInfo": { + "description": "Marketplace SAAS Info of the resource.", + "type": "object", + "properties": { + "marketplaceSubscription": { + "description": "Marketplace Subscription", + "type": "object", + "properties": { + "id": { + "description": "Marketplace Subscription Id. This is a GUID-formatted string.", + "type": "string" + }, + "publisherId": { + "description": "Publisher Id of the Marketplace offer.", + "type": "string" + }, + "offerId": { + "description": "Offer Id of the Marketplace offer,", + "type": "string" + } + } + }, + "marketplaceName": { + "description": "Marketplace Subscription Details: SAAS Name", + "type": "string" + }, + "marketplaceResourceId": { + "description": "Marketplace Subscription Details: Resource URI", + "type": "string" + }, + "marketplaceStatus": { + "description": "Marketplace Subscription Details: SaaS Subscription Status", + "type": "string" + }, + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into.", + "type": "string" + }, + "subscribed": { + "description": "Flag specifying if the Marketplace status is subscribed or not.", + "type": "boolean" + } + } + }, + "PartnerBillingEntity": { + "description": "Partner Billing details associated with the resource.", + "type": "object", + "properties": { + "id": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "name": { + "description": "The Elastic Organization Name.", + "type": "string" + }, + "partnerEntityUri": { + "description": "Link to the elastic organization page", + "type": "string" + } + } + }, + "ConnectedPartnerResourceProperties": { + "description": "Connected Partner Resource Properties", + "type": "object", + "properties": { + "partnerDeploymentName": { + "description": "Elastic deployment name", + "type": "string" + }, + "partnerDeploymentUri": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string" + }, + "azureResourceId": { + "description": "The azure resource Id of the deployment.", + "type": "string" + }, + "location": { + "description": "The location of the deployment.", + "type": "string" + } + } + }, + "ConnectedPartnerResourcesListFormat": { + "description": "Connected Partner Resources List Format", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConnectedPartnerResourceProperties" + } + } + }, + "ConnectedPartnerResourcesListResponse": { + "description": " List of all active elastic deployments.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [ + "properties/azureResourceId" + ], + "items": { + "$ref": "#/definitions/ConnectedPartnerResourcesListFormat" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "ElasticDeploymentStatus": { + "description": "Flag specifying if the Elastic deployment status is healthy or not.", + "enum": [ + "Healthy", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ElasticDeploymentStatus" + } + }, + "DeploymentInfoResponse": { + "description": "The properties of deployment in Elastic cloud corresponding to the Elastic monitor resource.", + "type": "object", + "properties": { + "status": { + "description": "The Elastic deployment status.", + "$ref": "#/definitions/ElasticDeploymentStatus", + "readOnly": true + }, + "version": { + "description": "Version of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "memoryCapacity": { + "description": "RAM capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "diskCapacity": { + "description": "Disk capacity of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "elasticsearchEndPoint": { + "description": "Elasticsearch endpoint in Elastic cloud deployment. This is either the aliased_endpoint if available, or the service_url otherwise.", + "type": "string", + "readOnly": true + }, + "deploymentUrl": { + "description": "Deployment URL of the elasticsearch in Elastic cloud deployment.", + "type": "string", + "readOnly": true + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + } + } + }, + "ExternalUserCreationResponse": { + "description": "The properties of the response we got from elastic while creating external user", + "type": "object", + "properties": { + "created": { + "description": "Shows if user is created or updated", + "type": "boolean", + "readOnly": true + } + } + }, + "ExternalUserInfo": { + "description": "The properties of the request required for creating user on elastic side", + "type": "object", + "properties": { + "userName": { + "description": "Username of the user to be created or updated", + "type": "string" + }, + "fullName": { + "description": "Full name of the user to be created or updated", + "type": "string" + }, + "password": { + "x-ms-secret": true, + "description": "Password of the user to be created or updated", + "type": "string" + }, + "emailId": { + "description": "Email id of the user to be created or updated", + "type": "string" + }, + "roles": { + "description": "Roles to be assigned for created or updated user", + "type": "array", + "x-ms-identifiers": [], + "items": { + "type": "string" + } + } + } + }, + "VMHostListResponse": { + "description": "Response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of a list operation.", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/VMResources" + } + }, + "nextLink": { + "description": "Link to the next Vm resource Id, if any.", + "type": "string" + } + } + }, + "VMResources": { + "description": "The vm resource properties that is currently being monitored by the Elastic monitor resource.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "The ARM id of the VM resource.", + "type": "string" + } + } + }, + "VMIngestionDetailsResponse": { + "description": "The vm ingestion details to install an agent.", + "type": "object", + "properties": { + "cloudId": { + "description": "The cloudId of given Elastic monitor resource.", + "type": "string" + }, + "ingestionKey": { + "description": "Ingestion details to install agent on given VM.", + "type": "string", + "x-ms-secret": true + } + } + }, + "OperationName": { + "enum": [ + "Add", + "Delete" + ], + "type": "string", + "description": "Operation to be performed on the given vm resource id.", + "title": "OperationName", + "x-ms-enum": { + "modelAsString": true, + "name": "OperationName" + } + }, + "VMCollectionUpdate": { + "description": "Update VM resource collection.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "vmResourceId": { + "description": "ARM id of the VM resource.", + "type": "string" + }, + "operationName": { + "description": "Operation to be performed for given VM.", + "$ref": "#/definitions/OperationName" + } + } + }, + "UpgradableVersionsList": { + "description": "Stack Versions that this version can upgrade to", + "type": "object", + "properties": { + "currentVersion": { + "type": "string", + "description": "Current version of the elastic monitor" + }, + "upgradableVersions": { + "type": "array", + "x-ms-identifiers": [], + "description": "Stack Versions that this version can upgrade to", + "items": { + "type": "string" + } + } + } + }, + "ElasticTrafficFilterResponse": { + "description": "List of elastic traffic filters in the account", + "type": "object", + "properties": { + "rulesets": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of elastic traffic filters in the account", + "items": { + "$ref": "#/definitions/ElasticTrafficFilter" + } + } + } + }, + "ElasticTrafficFilter": { + "description": "Elastic traffic filter object", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Id of the elastic filter" + }, + "name": { + "type": "string", + "description": "Name of the elastic filter" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter" + }, + "region": { + "type": "string", + "description": "Region of the elastic filter" + }, + "type": { + "enum": [ + "ip", + "azure_private_endpoint" + ], + "type": "string", + "description": "Type of the elastic filter", + "x-ms-enum": { + "modelAsString": true, + "name": "type" + } + }, + "includeByDefault": { + "type": "boolean", + "description": "IncludeByDefault for the elastic filter" + }, + "rules": { + "type": "array", + "description": "Rules in the elastic filter", + "items": { + "$ref": "#/definitions/ElasticTrafficFilterRule" + } + } + } + }, + "ElasticTrafficFilterRule": { + "description": "Elastic traffic filter rule object", + "type": "object", + "properties": { + "source": { + "type": "string", + "description": "IP of the elastic filter rule" + }, + "description": { + "type": "string", + "description": "Description of the elastic filter rule" + }, + "azureEndpointGuid": { + "type": "string", + "description": "Guid of Private Endpoint in the elastic filter rule" + }, + "azureEndpointName": { + "type": "string", + "description": "Name of the Private Endpoint in the elastic filter rule" + }, + "id": { + "type": "string", + "description": "Id of the elastic filter rule" + } + } + }, + "ElasticMonitorUpgrade": { + "description": "Upgrade elastic monitor version", + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Version to which the elastic monitor should be upgraded to" + } + } + }, + "UserEmailId": { + "description": "Email Id of the User Organization, of which the API Key must be returned", + "type": "object", + "properties": { + "emailId": { + "type": "string", + "description": "The User email Id" + } + } + }, + "UserApiKeyResponse": { + "description": "The User Api Key created for the Organization associated with the User Email Id that was passed in the request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserApiKeyResponseProperties" + } + } + }, + "UserApiKeyResponseProperties": { + "type": "object", + "properties": { + "apiKey": { + "description": "The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only.", + "type": "string", + "x-ms-secret": true + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponse": { + "description": "The Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticOrganizationToAzureSubscriptionMappingResponseProperties" + } + } + }, + "ElasticOrganizationToAzureSubscriptionMappingResponseProperties": { + "description": "The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into.", + "type": "object", + "properties": { + "billedAzureSubscriptionId": { + "description": "The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization.", + "type": "string" + }, + "marketplaceSaasInfo": { + "description": "Marketplace SaaS Info of the resource.", + "$ref": "#/definitions/MarketplaceSaaSInfo", + "readOnly": true + }, + "elasticOrganizationId": { + "description": "The Elastic Organization Id.", + "type": "string" + }, + "elasticOrganizationName": { + "description": "The Elastic Organization Name.", + "type": "string" + } + } + }, + "ResubscribeProperties": { + "description": "Resubscribe Properties", + "type": "object", + "properties": { + "planId": { + "description": "Newly selected plan Id to create the new Marketplace subscription for Resubscribe", + "type": "string" + }, + "term": { + "description": "Newly selected term to create the new Marketplace subscription for Resubscribe", + "type": "string" + }, + "subscriptionId": { + "description": "Newly selected Azure Subscription Id in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + }, + "resourceGroup": { + "description": "Newly selected Azure resource group in which the new Marketplace subscription will be created for Resubscribe", + "type": "string" + }, + "organizationId": { + "description": "Organization Id of the Elastic Organization that needs to be resubscribed", + "type": "string" + } + } + } + }, + "parameters": { + "MonitorNameParameter": { + "in": "path", + "name": "monitorName", + "description": "Monitor resource name", + "required": true, + "type": "string", + "pattern": "^.*$", + "x-ms-parameter-location": "method" + }, + "RuleSetNameParameter": { + "in": "path", + "name": "ruleSetName", + "description": "Tag Rule Set resource name", + "required": true, + "type": "string", + "pattern": "^.*$", + "x-ms-parameter-location": "method" + }, + "OpenAIIntegrationNameParameter": { + "in": "path", + "name": "integrationName", + "description": "OpenAI Integration name", + "required": true, + "type": "string", + "pattern": "^[a-z][a-z0-9]*$", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "description": "The configuration name. Only 'default' value is supported.", + "in": "path", + "name": "configurationName", + "pattern": "^.*$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AllTrafficFilters_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AllTrafficFilters_list.json new file mode 100644 index 000000000000..b666dbeb5c4d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AllTrafficFilters_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociateTrafficFilter_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociateTrafficFilter_Update.json new file mode 100644 index 000000000000..1d28a8517fe8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociateTrafficFilter_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/associateTrafficFilter?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociatedFiltersForDeployment_list.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociatedFiltersForDeployment_list.json new file mode 100644 index 000000000000..b666dbeb5c4d --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/AssociatedFiltersForDeployment_list.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "rulesets": [ + { + "id": "31d91b5afb6f4c2eaaf104c97b1991dd", + "name": "IPFromApi", + "description": "created from azure", + "type": "ip", + "includeByDefault": false, + "region": "azure-eastus", + "rules": [ + { + "id": "f0297dad72af4a5e964cddf817f35e65", + "description": "Allow inbound traffic from IP address 192.168.131.0", + "source": "192.168.131.0" + }, + { + "id": "f9c00169f0e54931ae72aabde326b589", + "description": "Allow inbound traffic from IP address block 192.168.132.6/22", + "source": "192.168.132.6/22" + } + ] + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/BillingInfo_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/BillingInfo_Get.json new file mode 100644 index 000000000000..32dd0da1da53 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/BillingInfo_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status", + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "subscribed": true + }, + "partnerBillingEntity": { + "id": "1234567890", + "name": "elasticOrganizationName", + "partnerEntityUri": "https://example.com" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ConnectedPartnerResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ConnectedPartnerResources_List.json new file mode 100644 index 000000000000..3c870bf52627 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ConnectedPartnerResources_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "partnerDeploymentName": "deploymentname", + "partnerDeploymentUri": "https://examplessourl.com", + "azureResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "location": "West US 2" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DeploymentInfo_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DeploymentInfo_List.json new file mode 100644 index 000000000000..9db821c2fb39 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DeploymentInfo_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "status": "Healthy", + "version": "7.9.3", + "memoryCapacity": "1024", + "diskCapacity": "245760", + "elasticsearchEndPoint": "alias.es.eastus2.staging.azure.foundit.no", + "deploymentUrl": "https://endpoint.eastus.kb.azure.elastic-cloud.com:9243", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json new file mode 100644 index 000000000000..1062345717b6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachAndDeleteTrafficFilter_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachTrafficFilters_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachTrafficFilters_Update.json new file mode 100644 index 000000000000..c61967c0422a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/DetachTrafficFilters_Update.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/detachTrafficFilter?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ElasticVersions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ElasticVersions_List.json new file mode 100644 index 000000000000..13d0890b6ef1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ElasticVersions_List.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "region": "myregion", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "version": "version1" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ExternalUserInfo.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ExternalUserInfo.json new file mode 100644 index 000000000000..cc638c99841f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/ExternalUserInfo.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "UserName": "newuser", + "FullName": "fullname", + "Password": "Password", + "EmailId": "myemail@outlook.com", + "Roles": [ + "admin", + "other_role1" + ] + } + }, + "responses": { + "200": { + "body": { + "created": true + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/IPTrafficFilter_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/IPTrafficFilter_Create.json new file mode 100644 index 000000000000..fd74ddb9d88f --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/IPTrafficFilter_Create.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "ips": "192.168.131.0, 192.168.132.6/22" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociateIPFilter?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitor_Upgrade.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitor_Upgrade.json new file mode 100644 index 000000000000..ec705866e032 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitor_Upgrade.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "version": "7.15.1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/upgrade?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredResources_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredResources_List.json new file mode 100644 index 000000000000..3511538012ba --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredResources_List.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "sendingLogs": "True", + "reasonForLogsStatus": "CapturedByRules" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json new file mode 100644 index 000000000000..e9c8bf2ff9b8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_CreateorUpdate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddBegin", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Delete.json new file mode 100644 index 000000000000..e5031f736134 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Elastic/monitors/test?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Get.json new file mode 100644 index 000000000000..c3eddfeec901 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_List.json new file mode 100644 index 000000000000..167a402909e5 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_List.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Update.json new file mode 100644 index 000000000000..e0a2147a31a8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/MonitoredSubscriptions_Update.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "configurationName": "default", + "requestBody": { + "properties": { + "operation": "AddComplete", + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/monitoredSubscriptions/default", + "type": "Microsoft.Elastic/monitors/monitoredSubscriptions", + "properties": { + "monitoredSubscriptionList": [ + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Active", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + }, + { + "subscriptionId": "/subscriptions/00000000-0000-0000-0000-000000000001", + "status": "Failed", + "tagRules": { + "provisioningState": "Accepted", + "logRules": { + "sendAadLogs": true, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "saokgpjvdlorciqbjmjxazpee", + "value": "sarxrqsxouhdjwsrqqicbeirdb", + "action": "Include" + } + ] + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Elastic/monitors/test?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Create.json new file mode 100644 index 000000000000..196a79b29a81 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Create.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + }, + "planDetails": { + "offerID": "00000", + "publisherID": "1234", + "termID": "free_Monthly", + "planID": "xxxyyy", + "planName": "myPlan" + }, + "subscriptionState": "Suspended", + "saaSAzureSubscriptionStatus": "Subscribed", + "sourceCampaignName": "Elastic", + "sourceCampaignId": "0000" + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Accepted", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Delete.json new file mode 100644 index 000000000000..afb227c5d5a9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2022-07-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Get.json new file mode 100644 index 000000000000..6db6b81664c1 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_List.json new file mode 100644 index 000000000000..75eb3499aada --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_ListByResourceGroup.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_ListByResourceGroup.json new file mode 100644 index 000000000000..d25f342b8196 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_ListByResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Update.json new file mode 100644 index 000000000000..06d66e8b66b7 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Monitors_Update.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "name": "myMonitor", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "userInfo": { + "firstName": "Alice", + "lastName": "Bob", + "companyName": "Microsoft", + "emailAddress": "alice@microsoft.com", + "companyInfo": { + "domain": "microsoft.com", + "business": "Technology", + "employeeNumber": "10000", + "state": "WA", + "country": "US" + } + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname?api-version=2024-10-01-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_CreateOrUpdate.json new file mode 100644 index 000000000000..dc98f683ebc9 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_CreateOrUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default", + "requestBody": { + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "key": "**" + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + }, + "201": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Delete.json new file mode 100644 index 000000000000..cee5469025a8 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Get.json new file mode 100644 index 000000000000..c4d9170e517a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_GetStatus.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_GetStatus.json new file mode 100644 index 000000000000..e95ba31827e6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_GetStatus.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "integrationName": "default" + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Succeeded" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_List.json new file mode 100644 index 000000000000..d485ae4892c0 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/OpenAI_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/openAIIntegration/default", + "type": "Microsoft.Elastic/monitors/openAIIntegration", + "properties": { + "openAIResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myOpenAI", + "openAIResourceEndpoint": "https://myOpenAI.openai.azure.com/", + "openAIConnectorId": "0000000000000000", + "lastRefreshAt": "2023-07-12T09:28:50.9579871Z" + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Operations_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..0039824d018a --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Elastic/monitors/write", + "display": { + "provider": "Microsoft.Elastic", + "resource": "monitors", + "operation": "write", + "description": "Write monitors resource" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetApiKey.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetApiKey.json new file mode 100644 index 000000000000..ab0a8054acbc --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetApiKey.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "requestBody": { + "emailId": "myemail@outlook.com" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "apiKey": "AbCdEfGhIjKlMnOpQrStUvWxYz" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json new file mode 100644 index 000000000000..25e17e416ff0 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_GetElasticToAzureSubscriptionMapping.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "properties": { + "billedAzureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "marketplaceSaasInfo": { + "marketplaceSubscription": { + "id": "12345678-1234-1234-1234-123456789012" + }, + "marketplaceName": "MP_RESOURCE", + "marketplaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SaaS/resources/AzElastic_b1190c8f", + "marketplaceStatus": "Status" + }, + "elasticOrganizationId": "1234567890", + "elasticOrganizationName": "elasticOrganizationName" + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_Resubscribe.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_Resubscribe.json new file mode 100644 index 000000000000..fa2c3d16eacb --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/Organizations_Resubscribe.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "planId": "planId", + "term": "term", + "subscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "organizationId": "organizationId" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor", + "name": "myMonitor", + "type": "Microsoft.Elastic/monitors", + "sku": { + "name": "free_Monthly" + }, + "properties": { + "provisioningState": "Succeeded", + "monitoringStatus": "Enabled", + "elasticProperties": { + "elasticCloudUser": { + "emailAddress": "alice@microsoft.com", + "id": "myid123", + "elasticCloudSsoDefaultUrl": "https://examplessourl.com" + }, + "elasticCloudDeployment": { + "name": "deploymentname", + "deploymentId": "deployment_id", + "azureSubscriptionId": "00000000-0000-0000-0000-000000000000", + "elasticsearchRegion": "azure-westus2", + "elasticsearchServiceUrl": "https://elasticsearchendpoint.com", + "kibanaServiceUrl": "https://kibanaserviceurl.com", + "kibanaSsoUrl": "https://kibanssourl.com" + } + }, + "liftrResourceCategory": "MonitorLogs", + "liftrResourcePreference": 0 + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US 2" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/resubscribe?api-version=2024-10-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/PrivateLinkTrafficFilters_Create.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/PrivateLinkTrafficFilters_Create.json new file mode 100644 index 000000000000..0a1435a41373 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/PrivateLinkTrafficFilters_Create.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd", + "privateEndpointName": "myPrivateEndpoint", + "privateEndpointGuid": "fdb54d3b-e85e-4d08-8958-0d2f7g523df9" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/createAndAssociatePLFilter?api-version=2022-07-01-preview" + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_CreateOrUpdate.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_CreateOrUpdate.json new file mode 100644 index 000000000000..fea663b35327 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_CreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default", + "requestBody": { + "properties": { + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Delete.json new file mode 100644 index 000000000000..ae77e0fc1b89 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/resourceGroup/providers/Microsoft.Elastic/monitor/monitorname/tagRules/tagRuleName?api-version=2024-10-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Get.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Get.json new file mode 100644 index 000000000000..348c0e90f755 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "ruleSetName": "default" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_List.json new file mode 100644 index 000000000000..c74f96bd0137 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TagRules_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Elastic/monitors/myMonitor/tagRules/default", + "type": "Microsoft.Elastic/monitors/tagRules", + "properties": { + "provisioningState": "Succeeded", + "logRules": { + "sendAadLogs": false, + "sendSubscriptionLogs": true, + "sendActivityLogs": true, + "filteringTags": [ + { + "name": "Environment", + "value": "Prod", + "action": "Include" + }, + { + "name": "Environment", + "value": "Dev", + "action": "Exclude" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TrafficFilters_Delete.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TrafficFilters_Delete.json new file mode 100644 index 000000000000..1062345717b6 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/TrafficFilters_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "rulesetId": "31d91b5afb6f4c2eaaf104c97b1991dd" + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/UpgradableVersions_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/UpgradableVersions_Details.json new file mode 100644 index 000000000000..2d2e6ea69c87 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/UpgradableVersions_Details.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "currentVersion": "7.15.0", + "upgradableVersions": [ + "7.15.1", + "7.16.0" + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMCollection_Update.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMCollection_Update.json new file mode 100644 index 000000000000..8071a75374a5 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMCollection_Update.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor", + "requestBody": { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM", + "operationName": "Add" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMHost_List.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMHost_List.json new file mode 100644 index 000000000000..acbebbc5575c --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMHost_List.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vmResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualmachines/myVM" + } + ] + } + } + } +} diff --git a/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMIngestion_Details.json b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMIngestion_Details.json new file mode 100644 index 000000000000..d52d95dff818 --- /dev/null +++ b/specification/elastic/resource-manager/Microsoft.Elastic/preview/2024-10-01-preview/examples/VMIngestion_Details.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-10-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "monitorName": "myMonitor" + }, + "responses": { + "200": { + "body": { + "cloudId": "myid123", + "ingestionKey": "Vmingeationkey" + } + } + } +} diff --git a/specification/elastic/resource-manager/readme.md b/specification/elastic/resource-manager/readme.md index cd366b7401f8..4cf51fff7951 100644 --- a/specification/elastic/resource-manager/readme.md +++ b/specification/elastic/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the elastic. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-06-15-preview +tag: package-2024-10-01-preview ``` ### Tag: package-2021-09-01-preview @@ -200,6 +200,15 @@ input-file: - Microsoft.Elastic/preview/2024-06-15-preview/elastic.json ``` +### Tag: package-2024-10-01-preview + +These settings apply only when `--tag=package-2024-10-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-10-01-preview' +input-file: + - Microsoft.Elastic/preview/2024-10-01-preview/elastic.json +``` + --- # Code Generation From bf6253c29a8491acf7a4398daf184619e3b1ab3f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 8 Oct 2024 12:00:51 -0700 Subject: [PATCH 062/101] Bump @azure-tools/rest-api-diff in the typespec group (#30872) Bumps the typespec group with 1 update: @azure-tools/rest-api-diff. Updates `@azure-tools/rest-api-diff` from 0.1.1 to 0.1.3 --- updated-dependencies: - dependency-name: "@azure-tools/rest-api-diff" dependency-type: indirect update-type: version-update:semver-patch dependency-group: typespec ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index 28789aac7893..b5677bb0bbc9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -819,11 +819,10 @@ } }, "node_modules/@azure-tools/rest-api-diff": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/@azure-tools/rest-api-diff/-/rest-api-diff-0.1.1.tgz", - "integrity": "sha512-/QhtngwxdszcE3iAL12KpCnUpMQWdFbVJgcggPh2TwHg73Qinzg0rq0AjAAhaukp342cXO35DXv2o4lIGfZkfw==", + "version": "0.1.3", + "resolved": "https://registry.npmjs.org/@azure-tools/rest-api-diff/-/rest-api-diff-0.1.3.tgz", + "integrity": "sha512-eCcs4jy3npaxCj0u69qSPvYs/0N/rDO+Hkqx28h5D3wp52V/gyc8Xw2OWz3zsu69u/tEbnEHLZpsmWsB4kUzWQ==", "dev": true, - "license": "MIT", "dependencies": { "@azure-tools/typespec-autorest": ">=0.44.0, <1.0.0", "@azure-tools/typespec-azure-core": ">=0.44.0, <1.0.0", @@ -840,6 +839,9 @@ "yargs": "^17.7.2", "yn": "^3.1.1" }, + "bin": { + "rest-api-diff": "cmd/rest-api-diff.js" + }, "engines": { "node": ">=18.0.0" } From 4af4e91f9db511382774523445c6e0b511f5da59 Mon Sep 17 00:00:00 2001 From: Minh-Anh Phan <111523473+minhanh-phan@users.noreply.github.com> Date: Tue, 8 Oct 2024 12:19:34 -0700 Subject: [PATCH 063/101] Mark details as optional property (#30892) --- .../inference/preview/2024-08-01-preview/generated.json | 3 +-- .../inference/preview/2024-08-01-preview/inference.yaml | 1 - .../inference/preview/2024-09-01-preview/inference.json | 3 +-- .../inference/preview/2024-09-01-preview/inference.yaml | 1 - 4 files changed, 2 insertions(+), 6 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/generated.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/generated.json index 7f27c167ad4f..def1bf243e6e 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/generated.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/generated.json @@ -2972,8 +2972,7 @@ } }, "required": [ - "filtered", - "details" + "filtered" ] }, "ContentFilterDetectionResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.yaml index 2520719e0729..c14e3732ae7a 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-08-01-preview/inference.yaml @@ -2062,7 +2062,6 @@ components: type: array required: - filtered - - details promptFilterResult: type: object description: Content filtering results for a single prompt in the request. diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json index c339e42d06a6..779ea6c8e439 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.json @@ -3251,8 +3251,7 @@ } ], "required": [ - "filtered", - "details" + "filtered" ] }, "promptFilterResult": { diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml index 73e77e64decb..98bd5609b7a3 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-09-01-preview/inference.yaml @@ -2062,7 +2062,6 @@ components: type: array required: - filtered - - details promptFilterResult: type: object description: Content filtering results for a single prompt in the request. From cf170ef8e99c2ed03edf520c54effa6d5435df28 Mon Sep 17 00:00:00 2001 From: Heath Stewart <heaths@microsoft.com> Date: Tue, 8 Oct 2024 14:07:18 -0700 Subject: [PATCH 064/101] Support date- and semver-based api-versions (#30891) Fixes #30889 --- eng/scripts/Copy-ApiVersion-Functions.ps1 | 46 ++++++++++++------- .../Copy-ApiVersion/Copy-ApiVersion.Tests.ps1 | 39 +++++++++++----- 2 files changed, 56 insertions(+), 29 deletions(-) diff --git a/eng/scripts/Copy-ApiVersion-Functions.ps1 b/eng/scripts/Copy-ApiVersion-Functions.ps1 index 53a5aebccc3c..a26d0c0f87f9 100644 --- a/eng/scripts/Copy-ApiVersion-Functions.ps1 +++ b/eng/scripts/Copy-ApiVersion-Functions.ps1 @@ -1,12 +1,12 @@ function Get-NewTagSection($apiVersion, $resourceProvider, $apiVersionStatus, $specFiles) { - $tagVersion = $apiVersion -match '(?<date>\d{4}-\d{2})-\d{2}' - $tagVersion = $Matches['date'] + $tagVersion = $apiVersion -match '(?<version>(\d{4}-\d{2}-\d{2}|\d+\.\d+)(-preview(\.\d+)?)?)' + $tagVersion = $Matches['version'] $baseDir = "$resourceProvider/$apiVersionStatus/$apiVersion" - - if ($apiVersionStatus -eq "preview") { - $tagVersion = "preview-" + $tagVersion - } + + if ($apiVersionStatus -eq "preview") { + $tagVersion = "preview-" + $tagVersion + } $content = @" ### Tag: package-$tagVersion @@ -31,23 +31,35 @@ function Get-ReadmeWithNewTag($readmeContent, $tagContent) { function Get-ReadmeWithLatestTag($readmeContent, $newApiVersion, $newApiVersionStatus ) { # Get the current tag date - $currentTag = $readmeContent -match '(?m)^(tag:\s*)(package-)(.*)(?<version>\d{4}-\d{2})(.*)' - $currentTag = $Matches['version'] - $latestVersionDate = [datetime]($currentTag -replace '-preview', '') + $currentTag = $readmeContent -match '(?m)^(tag:\s*)(package-)(.*)(?<apiVersion>(?<date>\d{4}-\d{2}-\d{2})|(?<version>\d+\.\d+))' + if ($currentTag = $Matches['date']) { + $latestVersionDate = [datetime]($currentTag -replace '-preview', '') - # Convert the new OpenAPI version to a date - $newVersionDate = [datetime]($newApiVersion -replace '-preview', '') + # Convert the new OpenAPI version to a date + $newVersionDate = [datetime]($newApiVersion -replace '-preview', '') - # Compare two dates - if ($latestVersionDate -gt $newVersionDate) { - Write-Warning "The new version is not newer than the current default version in the readme file." + # Compare two dates + if ($latestVersionDate -gt $newVersionDate) { + Write-Warning "The new version is not newer than the current default version in the readme file." + } + } elseif ($currentTag = $Matches['version']) { + $latestVersion = [version]($currentTag -replace '-preview', '') + + # Convert the new OpenAPI version to a date + $newVersion = [Version]($newApiVersion -replace '-preview', '') + + # Compare two semvers + if ($latestVersion -gt $newVersion) { + Write-Warning "The new version is not newer than the current default version in the readme file." + } } - $tagVersion = $newApiVersion -match '\d{4}-\d{2}' - $tagVersion = $Matches[0] + + $tagVersion = $newApiVersion -match '(?<apiVersion>(?<date>\d{4}-\d{2}-\d{2})|(?<version>\d+\.\d+)(-preview(\.\d+)?)?)' + $tagVersion = $Matches['apiVersion'] if ($newApiVersionStatus -eq "preview") { $tagVersion = "preview-" + $tagVersion } - return $readmeContent -replace '(?m)^(tag:\s*)(package-.*)', "tag: package-$tagVersion" + return $readmeContent -replace '(?m)^(tag:\s*)(package-.*)', "tag: package-$tagVersion" } function New-GitAddAndCommit { diff --git a/eng/scripts/Tests/Copy-ApiVersion/Copy-ApiVersion.Tests.ps1 b/eng/scripts/Tests/Copy-ApiVersion/Copy-ApiVersion.Tests.ps1 index ff4fe41e479a..9bbaa3b230b8 100644 --- a/eng/scripts/Tests/Copy-ApiVersion/Copy-ApiVersion.Tests.ps1 +++ b/eng/scripts/Tests/Copy-ApiVersion/Copy-ApiVersion.Tests.ps1 @@ -1,6 +1,8 @@ Import-Module Pester -. "$PSScriptRoot\..\..\Copy-ApiVersion-Functions.ps1" +BeforeAll { + . "$PSScriptRoot\..\..\Copy-ApiVersion-Functions.ps1" +} Describe "Copy-ApiVersion regex tests" { Context "Generate new version tag section" { @@ -16,6 +18,18 @@ Describe "Copy-ApiVersion regex tests" { provider = "Microsoft.Compute\ComputeRP" versionStatus = "stable" specsDir = '..\..\..\..\..\specification\compute\resource-manager\Microsoft.Compute\ComputeRP\stable\2023-09-01' + }, + @{ + version = "7.6-preview.1" + provider = "Microsoft.KeyVault" + versionStatus = "preview" + specsDir = '..\..\..\..\..\specification\keyvault\data-plane\Microsoft.KeyVault\preview\7.6-preview.1' + }, + @{ + version = "7.5" + provider = "Microsoft.Compute\ComputeRP" + versionStatus = "stable" + specsDir = '..\..\..\..\..\specification\keyvault\data-plane\Microsoft.KeyVault\stable\7.5' } ) { param($version, $provider, $versionStatus, $specsDir) @@ -23,36 +37,37 @@ Describe "Copy-ApiVersion regex tests" { $jsonFiles = Get-ChildItem $PSScriptRoot+$specsDir -Filter '*.json' | Select-Object -ExpandProperty Name $newTagSection = Get-NewTagSection $version $provider $versionStatus $jsonFiles - $version -match '\d{4}-\d{2}' - $tag = $Matches[0] + $tag = $version if ($versionStatus -eq "preview") { $tag = "preview-" + $tag } - $newTagSection | Should match "package-$tag" + $newTagSection | Should -Match "(?m)^### Tag: package-$tag$" } + # TODO: This is fragile. The tests stop working when a service team updates their readme.md. We should instead take fixed copies or something. It "Default version gets updated" -TestCases @( - @{ - inputReadme = '..\..\..\..\..\specification\agrifood\resource-manager\readme.md' - apiVersion = "2024-01-01-preview" - versionStatus = "preview" - }, @{ inputReadme = '..\..\..\..\..\specification\compute\resource-manager\readme.md' apiVersion = "2024-01-01" versionStatus = "stable" + }, + @{ + inputReadme = '..\..\..\..\..\specification\keyvault\data-plane\readme.md' + apiVersion = "7.6-preview.1" + versionStatus = "preview" } ) { param($inputReadme, $apiVersion, $versionStatus) $contents = Get-Content $PSScriptRoot+$inputReadme -Raw $output = Get-ReadmeWithLatestTag $contents $apiVersion $versionStatus - $tag = $apiVersion -match '\d{4}-\d{2}' - $tag = $Matches[0] + + $tag = $apiVersion if ($versionStatus -eq "preview") { $tag = "preview-" + $tag } - $output | Should match "(?m)^tag:\s*package-$tag" + + $output | Should -Match "(?m)^tag:\s*package-$tag$" } } } \ No newline at end of file From 0f52715d6c0052badefc81845982e9d11de0bc7a Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 9 Oct 2024 09:51:16 +0800 Subject: [PATCH 065/101] Update readme.python.md and readme.typescript.md for sdk release (#30740) * Update readme.python.md * Update readme.python.md * Update readme.python.md * Update readme.typescript.md --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../resource-manager/readme.python.md | 23 +++++++++++++++++++ .../resource-manager/readme.typescript.md | 7 ++++++ 2 files changed, 30 insertions(+) diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 47b1ef774a77..eb19b49303e0 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -88,6 +88,8 @@ batch: - multiapiscript-deploymentstacks: true - tag: package-changes-2022-05 - multiapiscript-changes: true + - tag: package-databoundaries-2024-08 + - multiapiscript-databoundaries: true ``` ```yaml $(multiapiscript-changes) @@ -187,6 +189,27 @@ perform-load: false clear-output-folder: false ``` +```yaml $(multiapiscript-databoundaries) +title: DataBoundaryMgmtClient +package-name: azure-mgmt-resource#databoundaries +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/databoundaries +perform-load: false +clear-output-folder: false +``` + +### Tag: package-databoundaries-2024-08 and python + +These settings apply only when `--tag=package-databoundaries-2024-08 --python` is specified on the command line. +Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`. + +``` yaml $(tag) == 'package-databoundaries-2024-08' +default-api-version: "2024-08-01" +title: DataBoundaryMgmtClient +namespace: azure.mgmt.resource.databoundaries.v2024_08_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/databoundaries/v2024_08_01 +``` + ### Tag: package-changes-2022-05 and python These settings apply only when `--tag=package-changes-2022-05 --python` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.typescript.md b/specification/resources/resource-manager/readme.typescript.md index 066d729dcc04..04c8eae80e72 100644 --- a/specification/resources/resource-manager/readme.typescript.md +++ b/specification/resources/resource-manager/readme.typescript.md @@ -19,6 +19,13 @@ batch: - package-subscriptions: true - package-changes: true - package-deploymentstacks: true + - package-databoundaries: true +``` + +```yaml $(typescript) && $(package-databoundaries) && !$(profile-content) +typescript: + package-name: "@azure/arm-databoundaries" + output-folder: "$(typescript-sdks-folder)/sdk/databoundaries/arm-databoundaries" ``` ```yaml $(typescript) && $(package-features) && !$(profile-content) From d77c9fb25ccfd04ba25fe80e1c3f5745c92fafa6 Mon Sep 17 00:00:00 2001 From: Gerry Tan <gerry.tan@microsoft.com> Date: Wed, 9 Oct 2024 13:02:23 +1100 Subject: [PATCH 066/101] Add final state model to LRO operation (#30918) So the generated SDK client code response object is properly typed --- .../terraform/Microsoft.AzureTerraform.Management/routes.tsp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/terraform/Microsoft.AzureTerraform.Management/routes.tsp b/specification/terraform/Microsoft.AzureTerraform.Management/routes.tsp index 0416b149ef42..005256d69d7c 100644 --- a/specification/terraform/Microsoft.AzureTerraform.Management/routes.tsp +++ b/specification/terraform/Microsoft.AzureTerraform.Management/routes.tsp @@ -33,7 +33,8 @@ op exportTerraform( exportParameter: BaseExportModel, ): ArmAcceptedLroResponse< "Export request accepted.", - ArmCombinedLroHeaders & Azure.Core.Foundations.RetryAfterHeader + ArmCombinedLroHeaders<ArmOperationStatus, OperationStatus> & + Azure.Core.Foundations.RetryAfterHeader > | ErrorResponse; #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "Cannot use @armResourceOperations decorator here, the auto-generated routes do not match feature requirements" From 63c41aa20e38fe6d2ddd1a367b4fe57e8b601c34 Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 9 Oct 2024 10:09:30 +0800 Subject: [PATCH 067/101] [App Configuration] Update readme.python.md (#30906) * Update readme.python.md * Update readme.python.md --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> --- .../resource-manager/readme.python.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/specification/appconfiguration/resource-manager/readme.python.md b/specification/appconfiguration/resource-manager/readme.python.md index 2b45ab6f8c27..5a7946f21271 100644 --- a/specification/appconfiguration/resource-manager/readme.python.md +++ b/specification/appconfiguration/resource-manager/readme.python.md @@ -8,6 +8,8 @@ license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-appconfiguration package-version: 1.0.0b1 no-namespace-folders: true +modelerfour: + lenient-model-deduplication: true ``` ### Python multi-api @@ -16,9 +18,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) clear-output-folder: true -default-api-version: "2023-03-01" +default-api-version: "2024-05-01" multiapi: true batch: + - tag: package-2024-05-01 - tag: package-2023-03-01 - tag: package-2022-05-01 - tag: package-2022-03-01-preview @@ -30,6 +33,16 @@ output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguratio perform-load: false ``` +### Tag: package-2024-05-01 and python + +These settings apply only when `--tag=package-2024-05-01 --python` is specified on the command line. +Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`. + +``` yaml $(tag) == 'package-2024-05-01' && $(python) +namespace: azure.mgmt.appconfiguration.v2024_05_01 +output-folder: $(python-sdks-folder)/appconfiguration/azure-mgmt-appconfiguration/azure/mgmt/appconfiguration/v2024_05_01 +``` + ### Tag: package-2023-03-01 and python These settings apply only when `--tag=package-2023-03-01 --python` is specified on the command line. From 18cd47e85bd88ebd94f7710feb56f2373c709c8a Mon Sep 17 00:00:00 2001 From: ChenxiJiang333 <119990644+ChenxiJiang333@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:06:39 +0800 Subject: [PATCH 068/101] [Workloads SapVirtualInstances] Update tspconfig for Python SDK (#30927) * Create client.tsp * Update tspconfig.yaml * Update tspconfig.yaml --- .../Workloads.SAPVirtualInstance.Management/client.tsp | 6 ++++++ .../tspconfig.yaml | 9 +++++++++ 2 files changed, 15 insertions(+) create mode 100644 specification/workloads/Workloads.SAPVirtualInstance.Management/client.tsp diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/client.tsp b/specification/workloads/Workloads.SAPVirtualInstance.Management/client.tsp new file mode 100644 index 000000000000..499545372081 --- /dev/null +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/client.tsp @@ -0,0 +1,6 @@ +import "./main.tsp"; +import "@azure-tools/typespec-client-generator-core"; + +using Azure.ClientGenerator.Core; + +@@clientName(Microsoft.Workloads, "WorkloadsSapVirtualInstanceMgmt", "python"); diff --git a/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml index 78a474392441..2275efd1c468 100644 --- a/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml +++ b/specification/workloads/Workloads.SAPVirtualInstance.Management/tspconfig.yaml @@ -1,3 +1,6 @@ +parameters: + "service-dir": + default: "sdk/workloads" emit: - "@azure-tools/typespec-autorest" options: @@ -10,6 +13,12 @@ options: # `arm-resource-flattening` is only used for back-compat for specs existed on July 2024. All new service spec should NOT use this flag arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/SAPVirtualInstance/{version-status}/{version}/SAPVirtualInstance.json" + "@azure-tools/typespec-python": + package-dir: "azure-mgmt-workloadssapvirtualinstance" + package-name: "{package-dir}" + flavor: "azure" + generate-test: true + generate-sample: true linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 4037b28c1014648f4cfa6f8c965e45f2476652e2 Mon Sep 17 00:00:00 2001 From: Han Chiang <han.chiang@microsoft.com> Date: Wed, 9 Oct 2024 16:47:33 +0800 Subject: [PATCH 069/101] Add client initialization parameters (#30924) * tsp, face, add clientInitialization * update client.tsp * add customization config * Add csharp with client init * Temporary remote client scope * Rename and remove java change * Fix validation --------- Co-authored-by: Weidong Xu <weidxu@microsoft.com> --- specification/ai/Face/client.tsp | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/specification/ai/Face/client.tsp b/specification/ai/Face/client.tsp index 82fa88cef001..2fd440d08a76 100644 --- a/specification/ai/Face/client.tsp +++ b/specification/ai/Face/client.tsp @@ -90,7 +90,29 @@ interface FaceClient { service: Face, }) namespace FaceAdministrationClient { + /** + * Client options for LargeFaceListClient + */ + model LargeFaceListClientOptions { + /** + * ID of LargeFaceList. + */ + largeFaceListId: collectionId; + } + + /** + * Client options for LargePersonGroupClient + */ + model LargePersonGroupClientOptions { + /** + * ID of LargePersonGroup. + */ + largePersonGroupId: collectionId; + } + + #suppress "@azure-tools/typespec-client-generator-core/client-service" "TCGC bug" @operationGroup + @clientInitialization(LargeFaceListClientOptions, "csharp,java") @clientName("LargeFaceListClientImpl", "csharp") interface LargeFaceList { @doc("Please refer to https://learn.microsoft.com/rest/api/face/face-list-operations/create-large-face-list for more details.") @@ -126,7 +148,9 @@ namespace FaceAdministrationClient { getFaces is FaceListOperations.getLargeFaceListFaces; } + #suppress "@azure-tools/typespec-client-generator-core/client-service" "TCGC bug" @operationGroup + @clientInitialization(LargePersonGroupClientOptions, "csharp,java") @clientName("LargePersonGroupClientImpl", "csharp") interface LargePersonGroup { @doc("Please refer to https://learn.microsoft.com/rest/api/face/person-group-operations/create-large-person-group for more details.") From 0f649fcc3b079d704b0f38f9433ffbe5727b0e31 Mon Sep 17 00:00:00 2001 From: wenqibu <153253179+wenqibu@users.noreply.github.com> Date: Wed, 9 Oct 2024 16:56:14 +0800 Subject: [PATCH 070/101] Salesforce V2 Read property support pageSize (#30559) --- .../stable/2018-06-01/entityTypes/Pipeline.json | 5 +++++ .../stable/2020-12-01/entityTypes/Pipeline.json | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index da3d2c987f1d..47572261546c 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -9175,6 +9175,11 @@ "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object", "x-ms-format": "dfe-bool" + }, + "pageSize": { + "type": "object", + "x-ms-format": "dfe-int", + "description": "Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer)." } } }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json index 642cb782201d..5e10280cc1ad 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json @@ -8075,6 +8075,10 @@ "includeDeletedObjects": { "description": "This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean).", "type": "object" + }, + "pageSize": { + "type": "object", + "description": "Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer)." } } }, From d38a2c3ce2e2dfc38053af2f6b5fc10cb6221961 Mon Sep 17 00:00:00 2001 From: Weidong Xu <weidxu@microsoft.com> Date: Wed, 9 Oct 2024 16:58:57 +0800 Subject: [PATCH 071/101] mgmt, java, config servicelinker (#30925) --- .../servicelinker/resource-manager/readme.java.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 specification/servicelinker/resource-manager/readme.java.md diff --git a/specification/servicelinker/resource-manager/readme.java.md b/specification/servicelinker/resource-manager/readme.java.md new file mode 100644 index 000000000000..d548eb7e399c --- /dev/null +++ b/specification/servicelinker/resource-manager/readme.java.md @@ -0,0 +1,9 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +```yaml $(java) +resource-collection-associations: +- resource: LinkerResource + collection: Linkers +``` From 0da1b7d10d07500a69b46af1b894851911992499 Mon Sep 17 00:00:00 2001 From: Lior Abadi <liorabadi@gmail.com> Date: Wed, 9 Oct 2024 15:47:36 +0300 Subject: [PATCH 072/101] Delete specification/adp/resource-manager directory (#30648) --- .../preview/2020-07-01-preview/adp.json | 1049 -------------- .../examples/AdpAccountDelete.json | 13 - .../examples/AdpAccountGet.json | 22 - .../examples/AdpAccountPatch.json | 33 - .../examples/AdpAccountPut.json | 34 - .../examples/AdpAccountsList.json | 26 - .../AdpAccountsListByResourceGroup.json | 26 - .../examples/AdpDataPoolDelete.json | 14 - .../examples/AdpDataPoolGet.json | 26 - .../examples/AdpDataPoolPatch.json | 48 - .../examples/AdpDataPoolPut.json | 48 - .../examples/AdpDataPoolsList.json | 30 - .../examples/AdpOperationsList.json | 40 - .../preview/2021-02-01-preview/adp.json | 1189 ---------------- .../AdpAccountCheckNameAvailability.json | 17 - .../examples/AdpAccountDelete.json | 13 - .../examples/AdpAccountGet.json | 22 - .../examples/AdpAccountPatch.json | 33 - .../examples/AdpAccountPut.json | 34 - .../examples/AdpAccountsList.json | 26 - .../AdpAccountsListByResourceGroup.json | 26 - .../examples/AdpDataPoolDelete.json | 14 - .../examples/AdpDataPoolGet.json | 26 - .../examples/AdpDataPoolPatch.json | 48 - .../examples/AdpDataPoolPut.json | 54 - .../examples/AdpDataPoolsList.json | 30 - .../examples/AdpOperationsList.json | 40 - .../preview/2021-11-01-preview/adp.json | 1251 ----------------- .../AdpAccountCheckNameAvailability.json | 17 - .../examples/AdpAccountDelete.json | 13 - .../examples/AdpAccountGet.json | 22 - .../examples/AdpAccountPatch.json | 33 - .../examples/AdpAccountPut.json | 34 - .../examples/AdpAccountsList.json | 26 - .../AdpAccountsListByResourceGroup.json | 26 - .../examples/AdpDataPoolDelete.json | 14 - .../examples/AdpDataPoolGet.json | 26 - .../examples/AdpDataPoolPatch.json | 48 - .../examples/AdpDataPoolPut.json | 54 - .../examples/AdpDataPoolsList.json | 30 - .../examples/AdpOperationsList.json | 40 - .../adp/resource-manager/readme.az.md | 18 - .../adp/resource-manager/readme.cli.md | 3 - .../adp/resource-manager/readme.csharp.md | 15 - .../adp/resource-manager/readme.go.md | 25 - specification/adp/resource-manager/readme.md | 95 -- .../adp/resource-manager/readme.python.md | 18 - .../adp/resource-manager/readme.typescript.md | 14 - 48 files changed, 4803 deletions(-) delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountCheckNameAvailability.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsListByResourceGroup.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpOperationsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/adp.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountCheckNameAvailability.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsListByResourceGroup.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolDelete.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolGet.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPatch.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPut.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolsList.json delete mode 100644 specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpOperationsList.json delete mode 100644 specification/adp/resource-manager/readme.az.md delete mode 100644 specification/adp/resource-manager/readme.cli.md delete mode 100644 specification/adp/resource-manager/readme.csharp.md delete mode 100644 specification/adp/resource-manager/readme.go.md delete mode 100644 specification/adp/resource-manager/readme.md delete mode 100644 specification/adp/resource-manager/readme.python.md delete mode 100644 specification/adp/resource-manager/readme.typescript.md diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json deleted file mode 100644 index ca8a6b363c96..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json +++ /dev/null @@ -1,1049 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-07-01-preview", - "title": "adp", - "description": "Microsoft Autonomous Development Platform" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.AutonomousDevelopmentPlatform/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Autonomous Development Platform provider operations.", - "operationId": "Operations_List", - "x-ms-examples": { - "List operations": { - "$ref": "./examples/AdpOperationsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_List", - "description": "List all ADP accounts available under the subscription", - "x-ms-examples": { - "List accounts": { - "$ref": "./examples/AdpAccountsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_ListByResourceGroup", - "description": "List all ADP accounts available under the resource group", - "x-ms-examples": { - "List accounts by resource group": { - "$ref": "./examples/AdpAccountsListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Get", - "description": "Gets the properties of an ADP account.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account properties were retrieved successfully.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get account": { - "$ref": "./examples/AdpAccountGet.json" - } - } - }, - "patch": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Update", - "x-ms-long-running-operation": true, - "description": "Updates the properties of an existing ADP account.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the current ADP account.", - "schema": { - "$ref": "#/definitions/AccountPatch" - } - } - ], - "responses": { - "200": { - "description": "The resource was updated successfully.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch account": { - "$ref": "./examples/AdpAccountPatch.json" - } - } - }, - "put": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_CreateOrUpdate", - "description": "Creates or updates an ADP account.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the ADP account.", - "schema": { - "$ref": "#/definitions/Account" - } - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully updated.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously.", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put account": { - "$ref": "./examples/AdpAccountPut.json" - } - } - }, - "delete": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Delete", - "description": "Deletes an ADP account.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully deleted." - }, - "202": { - "description": "The ADP account will be deleted asynchronously." - }, - "204": { - "description": "The ADP account does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete account": { - "$ref": "./examples/AdpAccountDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_List", - "description": "Lists the data pools under the ADP account.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of data pools that was successfully retrieved.", - "schema": { - "$ref": "#/definitions/DataPoolList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Data Pools": { - "$ref": "./examples/AdpDataPoolsList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName}": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Get", - "description": "Gets the properties of a Data Pool.", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool that was successfully retrieved.", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Data Pool": { - "$ref": "./examples/AdpDataPoolGet.json" - } - } - }, - "patch": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Update", - "description": "Updates the properties of an existing Data Pool.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool.", - "schema": { - "$ref": "#/definitions/DataPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was updated successfully.", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously.", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch Data Pool": { - "$ref": "./examples/AdpDataPoolPatch.json" - } - } - }, - "put": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_CreateOrUpdate", - "description": "Creates or updates a Data Pool.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool.", - "schema": { - "$ref": "#/definitions/DataPool" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully updated.", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously.", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Data Pool": { - "$ref": "./examples/AdpDataPoolPut.json" - } - } - }, - "delete": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Delete", - "description": "Deletes a Data Pool.", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully deleted." - }, - "202": { - "description": "The Data Pool will be deleted asynchronously." - }, - "204": { - "description": "The Data Pool does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Data Pool": { - "$ref": "./examples/AdpDataPoolDelete.json" - } - } - } - } - }, - "definitions": { - "Tags": { - "description": "Resource tags", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - } - } - }, - "Account": { - "description": "An ADP account.", - "type": "object", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ] - }, - "AccountPatch": { - "description": "An ADP account.", - "type": "object", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Tags" - } - ] - }, - "AccountProperties": { - "description": "ADP account properties", - "properties": { - "accountId": { - "description": "The account's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the account at the time the operation was called.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "AccountList": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Account" - }, - "description": "List of accounts and their properties." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - }, - "description": "The list operation response, that contains the data pools and their properties." - }, - "DataPool": { - "description": "An ADP Data Pool.", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolPatch": { - "description": "An ADP Data Pool.", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolBaseProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolBaseProperties": { - "description": "Data Pool properties", - "properties": { - "dataPoolId": { - "description": "The Data Pool's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the data pool at the time the operation was called.", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "locations": { - "type": "array", - "items": { - "$ref": "#/definitions/DataPoolLocation" - }, - "minItems": 1, - "description": "Gets or sets the collection of locations where Data Pool resources should be created." - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource.", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - } - }, - "DataPoolProperties": { - "description": "Data Pool properties", - "allOf": [ - { - "$ref": "#/definitions/DataPoolBaseProperties" - } - ], - "required": [ - "locations" - ] - }, - "DataPoolLocation": { - "description": "Location of a Data Pool", - "properties": { - "name": { - "description": "The location name", - "type": "string" - } - }, - "required": [ - "name" - ] - }, - "DataPoolList": { - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/DataPool" - }, - "description": "List of data pools and their properties." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - }, - "description": "The list operation response, that contains the data pools and their properties." - }, - "Operation": { - "description": "Operation detail payload", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "actionType": { - "description": "Indicates the action type.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Display of the operation" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation", - "x-ms-client-flatten": true - } - } - }, - "OperationDisplay": { - "description": "Operation display payload", - "type": "object", - "properties": { - "provider": { - "description": "Resource provider of the operation", - "type": "string" - }, - "resource": { - "description": "Resource of the operation", - "type": "string" - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string" - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string" - } - } - }, - "OperationProperties": { - "description": "Additional details about an operation.", - "type": "object", - "x-ms-client-flatten": true, - "properties": { - "serviceSpecification": { - "description": "Details about a service operation.", - "$ref": "#/definitions/OperationServiceSpecification" - } - } - }, - "OperationServiceSpecification": { - "description": "Details about a service operation.", - "type": "object", - "properties": { - "logSpecifications": { - "description": "Details about operations related to logs.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationLogSpecification" - } - }, - "metricSpecifications": { - "description": "Details about operations related to metrics.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricSpecification" - } - } - } - }, - "OperationLogSpecification": { - "description": "Details about an operation related to logs.", - "type": "object", - "properties": { - "name": { - "description": "The name of the log category.", - "type": "string" - }, - "displayName": { - "description": "Localized display name.", - "type": "string" - }, - "blobDuration": { - "description": "Blobs created in the customer storage account, per hour.", - "type": "string" - } - } - }, - "OperationMetricSpecification": { - "description": "Details about an operation related to metrics.", - "type": "object", - "properties": { - "name": { - "description": "The name of the metric.", - "type": "string" - }, - "displayName": { - "description": "Localized display name of the metric.", - "type": "string" - }, - "displayDescription": { - "description": "The description of the metric.", - "type": "string" - }, - "unit": { - "description": "The unit that the metric is measured in.", - "type": "string" - }, - "aggregationType": { - "description": "The type of metric aggregation.", - "type": "string" - }, - "enableRegionalMdmAccount": { - "description": "Whether or not the service is using regional MDM accounts.", - "type": "string" - }, - "sourceMdmAccount": { - "description": "The name of the MDM account.", - "type": "string" - }, - "sourceMdmNamespace": { - "description": "The name of the MDM namespace.", - "type": "string" - }, - "availabilities": { - "description": "Defines how often data for metrics becomes available.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricAvailability" - } - } - } - }, - "OperationMetricAvailability": { - "description": "Defines how often data for a metric becomes available.", - "type": "object", - "properties": { - "timeGrain": { - "description": "The granularity for the metric.", - "type": "string" - }, - "blobDuration": { - "description": "Blob created in the customer storage account, per hour.", - "type": "string" - } - } - }, - "OperationListResult": { - "description": "Available operations of the service.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of operations supported by the Resource Provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - }, - "ErrorResponse": { - "description": "Error response.", - "properties": { - "error": { - "$ref": "#/definitions/ErrorDefinition", - "description": "The error details." - } - } - }, - "ErrorDefinition": { - "description": "Error definition.", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error.", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Internal error details.", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDefinition" - }, - "readOnly": true - } - } - } - }, - "parameters": { - "AccountNameParameter": { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the ADP account.", - "pattern": "^[a-z0-9]+(-[a-z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - }, - "DataPoolNameParameter": { - "name": "dataPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Data Pool.", - "pattern": "^[a-z0-9]+(-[a-z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json deleted file mode 100644 index f56df2a354f3..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json deleted file mode 100644 index b26fb2fd4abb..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": { - "accountId": "id" - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json deleted file mode 100644 index 52f5a7518d75..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPatch.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json deleted file mode 100644 index 2eb9a55173d3..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountPut.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid", - "parameters": { - "location": "Global", - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json deleted file mode 100644 index ec1224c955e4..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsList.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json deleted file mode 100644 index d3a341af516f..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpAccountsListByResourceGroup.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2020-07-01-preview", - "subscriptionId": "subid", - "resourceGroupName": "adpClient" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json deleted file mode 100644 index ea2ac77d762c..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json deleted file mode 100644 index 6be7714e47a0..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json deleted file mode 100644 index 3e1343f70936..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPatch.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json deleted file mode 100644 index 3e1343f70936..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolPut.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json deleted file mode 100644 index 61c1d13a4930..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpDataPoolsList.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2020-07-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json deleted file mode 100644 index e2f05ce8376f..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/examples/AdpOperationsList.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2020-07-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/read", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Read accounts", - "description": "Read accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/write", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Update accounts", - "description": "Update accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/delete", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Delete accounts", - "description": "Delete accounts" - } - } - ] - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json deleted file mode 100644 index c9861bbbf7e4..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json +++ /dev/null @@ -1,1189 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2021-02-01-preview", - "title": "adp", - "description": "Microsoft Autonomous Development Platform" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.AutonomousDevelopmentPlatform/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Autonomous Development Platform provider operations", - "operationId": "Operations_List", - "x-ms-examples": { - "List operations": { - "$ref": "./examples/AdpOperationsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/checkNameAvailability": { - "post": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_CheckNameAvailability", - "description": "Checks that the account name is valid and is not already in use", - "x-ms-examples": { - "AccountCheckNameAvailability": { - "$ref": "./examples/AdpAccountCheckNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" - }, - "description": "The checkNameAvailability parameters." - } - ], - "responses": { - "200": { - "description": "OK -- Operation to check the account name availability was successful", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_List", - "description": "List all ADP accounts available under the subscription", - "x-ms-examples": { - "List accounts": { - "$ref": "./examples/AdpAccountsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_ListByResourceGroup", - "description": "List all ADP accounts available under the resource group", - "x-ms-examples": { - "List accounts by resource group": { - "$ref": "./examples/AdpAccountsListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Get", - "description": "Gets the properties of an ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account properties were retrieved successfully", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get account": { - "$ref": "./examples/AdpAccountGet.json" - } - } - }, - "patch": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Update", - "x-ms-long-running-operation": true, - "description": "Updates the properties of an existing ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the current ADP account", - "schema": { - "$ref": "#/definitions/AccountPatch" - } - } - ], - "responses": { - "200": { - "description": "The resource was updated successfully", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch account": { - "$ref": "./examples/AdpAccountPatch.json" - } - } - }, - "put": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_CreateOrUpdate", - "description": "Creates or updates an ADP account", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the ADP account", - "schema": { - "$ref": "#/definitions/Account" - } - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully updated", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put account": { - "$ref": "./examples/AdpAccountPut.json" - } - } - }, - "delete": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Delete", - "description": "Deletes an ADP account", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully deleted" - }, - "202": { - "description": "The ADP account will be deleted asynchronously" - }, - "204": { - "description": "The ADP account does not exist" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete account": { - "$ref": "./examples/AdpAccountDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_List", - "description": "Lists the data pools under the ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of data pools that was successfully retrieved", - "schema": { - "$ref": "#/definitions/DataPoolList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Data Pools": { - "$ref": "./examples/AdpDataPoolsList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName}": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Get", - "description": "Gets the properties of a Data Pool", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool that was successfully retrieved", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Data Pool": { - "$ref": "./examples/AdpDataPoolGet.json" - } - } - }, - "patch": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Update", - "description": "Updates the properties of an existing Data Pool", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool", - "schema": { - "$ref": "#/definitions/DataPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was updated successfully", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch Data Pool": { - "$ref": "./examples/AdpDataPoolPatch.json" - } - } - }, - "put": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_CreateOrUpdate", - "description": "Creates or updates a Data Pool", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool", - "schema": { - "$ref": "#/definitions/DataPool" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully updated", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Data Pool": { - "$ref": "./examples/AdpDataPoolPut.json" - } - } - }, - "delete": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Delete", - "description": "Deletes a Data Pool", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully deleted" - }, - "202": { - "description": "The Data Pool will be deleted asynchronously" - }, - "204": { - "description": "The Data Pool does not exist" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Data Pool": { - "$ref": "./examples/AdpDataPoolDelete.json" - } - } - } - } - }, - "definitions": { - "AccountCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string", - "description": "The account name", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.AutonomousDevelopmentPlatform/accounts" - ], - "x-ms-enum": { - "name": "Type", - "modelAsString": true - }, - "description": "The type of resource, Microsoft.AutonomousDevelopmentPlatform/accounts" - } - }, - "required": [ - "name", - "type" - ], - "description": "The parameters used to check the availability of the account name" - }, - "CheckNameAvailabilityResult": { - "description": "The checkNameAvailability operation response", - "properties": { - "nameAvailable": { - "readOnly": true, - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used" - }, - "reason": { - "readOnly": true, - "type": "string", - "description": "Gets the reason that an account name could not be used. The reason element is only returned if nameAvailable is false", - "enum": [ - "Invalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "CheckNameAvailabilityReason", - "modelAsString": true - } - }, - "message": { - "readOnly": true, - "type": "string", - "description": "Gets an error message explaining the reason value in more detail" - } - } - }, - "Tags": { - "type": "object", - "description": "Resource tags", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - } - }, - "Account": { - "type": "object", - "description": "ADP account", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ] - }, - "AccountPatch": { - "type": "object", - "description": "ADP account", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Tags" - } - ] - }, - "AccountProperties": { - "type": "object", - "description": "ADP account properties", - "properties": { - "accountId": { - "description": "The account's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the account at the time the operation was called", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "AccountList": { - "type": "object", - "description": "The list operation response, that contains the data pools and their properties", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Account" - }, - "description": "List of accounts and their properties" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - } - }, - "DataPool": { - "type": "object", - "description": "ADP Data Pool", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolPatch": { - "type": "object", - "description": "ADP Data Pool", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolBaseProperties" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolBaseProperties": { - "type": "object", - "description": "Data Pool properties", - "properties": { - "dataPoolId": { - "description": "The Data Pool's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the data pool at the time the operation was called", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "locations": { - "type": "array", - "items": { - "$ref": "#/definitions/DataPoolLocation" - }, - "description": "Gets or sets the collection of locations where Data Pool resources should be created" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - } - }, - "DataPoolProperties": { - "type": "object", - "description": "Data Pool properties", - "allOf": [ - { - "$ref": "#/definitions/DataPoolBaseProperties" - } - ], - "required": [ - "locations" - ] - }, - "DataPoolLocation": { - "type": "object", - "description": "Location of a Data Pool", - "properties": { - "name": { - "description": "The location name", - "type": "string" - }, - "encryption": { - "description": "Encryption properties of a Data Pool location", - "$ref": "#/definitions/DataPoolEncryption" - } - }, - "required": [ - "name" - ] - }, - "DataPoolEncryption": { - "type": "object", - "description": "Encryption properties of a Data Pool", - "properties": { - "keyVaultUri": { - "type": "string", - "description": "The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location" - }, - "keyName": { - "type": "string", - "description": "The name of Key Vault key" - }, - "keyVersion": { - "type": "string", - "description": "The version of Key Vault key" - }, - "userAssignedIdentity": { - "type": "string", - "description": "The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover" - } - }, - "required": [ - "keyVaultUri", - "keyName", - "userAssignedIdentity" - ] - }, - "DataPoolList": { - "type": "object", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/DataPool" - }, - "description": "List of data pools and their properties" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - }, - "description": "The list operation response, that contains the data pools and their properties" - }, - "Operation": { - "type": "object", - "description": "Operation detail payload", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "actionType": { - "description": "Indicates the action type", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Display of the operation" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation", - "x-ms-client-flatten": true - } - } - }, - "OperationDisplay": { - "type": "object", - "description": "Operation display payload", - "properties": { - "provider": { - "description": "Resource provider of the operation", - "type": "string" - }, - "resource": { - "description": "Resource of the operation", - "type": "string" - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string" - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string" - } - } - }, - "OperationProperties": { - "type": "object", - "description": "Additional details about an operation", - "x-ms-client-flatten": true, - "properties": { - "serviceSpecification": { - "description": "Details about a service operation", - "$ref": "#/definitions/OperationServiceSpecification" - } - } - }, - "OperationServiceSpecification": { - "type": "object", - "description": "Details about a service operation", - "properties": { - "logSpecifications": { - "description": "Details about operations related to logs", - "type": "array", - "items": { - "$ref": "#/definitions/OperationLogSpecification" - } - }, - "metricSpecifications": { - "description": "Details about operations related to metrics", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricSpecification" - } - } - } - }, - "OperationLogSpecification": { - "type": "object", - "description": "Details about an operation related to logs", - "properties": { - "name": { - "description": "The name of the log category", - "type": "string" - }, - "displayName": { - "description": "Localized display name", - "type": "string" - }, - "blobDuration": { - "description": "Blobs created in the customer storage account, per hour", - "type": "string" - } - } - }, - "OperationMetricSpecification": { - "type": "object", - "description": "Details about an operation related to metrics", - "properties": { - "name": { - "description": "The name of the metric", - "type": "string" - }, - "displayName": { - "description": "Localized display name of the metric", - "type": "string" - }, - "displayDescription": { - "description": "The description of the metric", - "type": "string" - }, - "unit": { - "description": "The unit that the metric is measured in", - "type": "string" - }, - "aggregationType": { - "description": "The type of metric aggregation", - "type": "string" - }, - "enableRegionalMdmAccount": { - "description": "Whether or not the service is using regional MDM accounts", - "type": "string" - }, - "sourceMdmAccount": { - "description": "The name of the MDM account", - "type": "string" - }, - "sourceMdmNamespace": { - "description": "The name of the MDM namespace", - "type": "string" - }, - "availabilities": { - "description": "Defines how often data for metrics becomes available", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricAvailability" - } - } - } - }, - "OperationMetricAvailability": { - "type": "object", - "description": "Defines how often data for a metric becomes available", - "properties": { - "timeGrain": { - "description": "The granularity for the metric", - "type": "string" - }, - "blobDuration": { - "description": "Blob created in the customer storage account, per hour", - "type": "string" - } - } - }, - "OperationListResult": { - "type": "object", - "description": "Available operations of the service", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of operations supported by the Resource Provider" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "Error response", - "properties": { - "error": { - "$ref": "#/definitions/ErrorDefinition", - "description": "The error details" - } - } - }, - "ErrorDefinition": { - "type": "object", - "description": "Error definition", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Internal error details", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDefinition" - }, - "readOnly": true - } - } - } - }, - "parameters": { - "AccountNameParameter": { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the ADP account", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - }, - "DataPoolNameParameter": { - "name": "dataPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Data Pool", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountCheckNameAvailability.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountCheckNameAvailability.json deleted file mode 100644 index ef24aa847e34..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountCheckNameAvailability.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "parameters": { - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts" - } - }, - "responses": { - "200": { - "body": { - "nameAvailable": true - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountDelete.json deleted file mode 100644 index 4f762116823a..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountGet.json deleted file mode 100644 index 11c41ab4a953..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": { - "accountId": "id" - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPatch.json deleted file mode 100644 index e820b2510a8d..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPatch.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPut.json deleted file mode 100644 index 8ae37fb6ff1f..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountPut.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "parameters": { - "location": "Global", - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsList.json deleted file mode 100644 index 8c017a5d432d..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsList.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsListByResourceGroup.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsListByResourceGroup.json deleted file mode 100644 index 2678be281d25..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpAccountsListByResourceGroup.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "resourceGroupName": "adpClient" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolDelete.json deleted file mode 100644 index 233b9bf29b7d..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolGet.json deleted file mode 100644 index 4e575ef35d2b..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPatch.json deleted file mode 100644 index f2b99f7a08b9..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPatch.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPut.json deleted file mode 100644 index 82f970d60d19..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolPut.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus", - "encryption": { - "keyVaultUri": "https://vaulturi", - "keyName": "key1", - "keyVersion": "123", - "userAssignedIdentity": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" - } - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolsList.json deleted file mode 100644 index 554a3e5870ec..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpDataPoolsList.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-02-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpOperationsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpOperationsList.json deleted file mode 100644 index c009f4bd294b..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/examples/AdpOperationsList.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2021-02-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/read", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Read accounts", - "description": "Read accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/write", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Update accounts", - "description": "Update accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/delete", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Delete accounts", - "description": "Delete accounts" - } - } - ] - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/adp.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/adp.json deleted file mode 100644 index 3eec324c255e..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/adp.json +++ /dev/null @@ -1,1251 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2021-11-01-preview", - "title": "adp", - "description": "Microsoft Autonomous Development Platform" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.AutonomousDevelopmentPlatform/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Autonomous Development Platform provider operations", - "operationId": "Operations_List", - "x-ms-examples": { - "List operations": { - "$ref": "./examples/AdpOperationsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/checkNameAvailability": { - "post": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_CheckNameAvailability", - "description": "Checks that the account name is valid and is not already in use", - "x-ms-examples": { - "AccountCheckNameAvailability": { - "$ref": "./examples/AdpAccountCheckNameAvailability.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AccountCheckNameAvailabilityParameters" - }, - "description": "The checkNameAvailability parameters." - } - ], - "responses": { - "200": { - "description": "OK -- Operation to check the account name availability was successful", - "schema": { - "$ref": "#/definitions/CheckNameAvailabilityResult" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_List", - "description": "List all ADP accounts available under the subscription", - "x-ms-examples": { - "List accounts": { - "$ref": "./examples/AdpAccountsList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_ListByResourceGroup", - "description": "List all ADP accounts available under the resource group", - "x-ms-examples": { - "List accounts by resource group": { - "$ref": "./examples/AdpAccountsListByResourceGroup.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}": { - "get": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Get", - "description": "Gets the properties of an ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account properties were retrieved successfully", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get account": { - "$ref": "./examples/AdpAccountGet.json" - } - } - }, - "patch": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Update", - "x-ms-long-running-operation": true, - "description": "Updates the properties of an existing ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the current ADP account", - "schema": { - "$ref": "#/definitions/AccountPatch" - } - } - ], - "responses": { - "200": { - "description": "The resource was updated successfully", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch account": { - "$ref": "./examples/AdpAccountPatch.json" - } - } - }, - "put": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_CreateOrUpdate", - "description": "Creates or updates an ADP account", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the ADP account", - "schema": { - "$ref": "#/definitions/Account" - } - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully updated", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "201": { - "description": "The resource will be updated asynchronously", - "schema": { - "$ref": "#/definitions/Account" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put account": { - "$ref": "./examples/AdpAccountPut.json" - } - } - }, - "delete": { - "tags": [ - "Accounts" - ], - "operationId": "Accounts_Delete", - "description": "Deletes an ADP account", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The ADP account was successfully deleted" - }, - "202": { - "description": "The ADP account will be deleted asynchronously" - }, - "204": { - "description": "The ADP account does not exist" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete account": { - "$ref": "./examples/AdpAccountDelete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_List", - "description": "Lists the data pools under the ADP account", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The list of data pools that was successfully retrieved", - "schema": { - "$ref": "#/definitions/DataPoolList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Data Pools": { - "$ref": "./examples/AdpDataPoolsList.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/{accountName}/dataPools/{dataPoolName}": { - "get": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Get", - "description": "Gets the properties of a Data Pool", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool that was successfully retrieved", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Data Pool": { - "$ref": "./examples/AdpDataPoolGet.json" - } - } - }, - "patch": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Update", - "description": "Updates the properties of an existing Data Pool", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool", - "schema": { - "$ref": "#/definitions/DataPoolPatch" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was updated successfully", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Patch Data Pool": { - "$ref": "./examples/AdpDataPoolPatch.json" - } - } - }, - "put": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_CreateOrUpdate", - "description": "Creates or updates a Data Pool", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "parameters", - "description": "The parameters to provide for the Data Pool", - "schema": { - "$ref": "#/definitions/DataPool" - } - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully updated", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "201": { - "description": "The Data Pool will be updated asynchronously", - "schema": { - "$ref": "#/definitions/DataPool" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Put Data Pool": { - "$ref": "./examples/AdpDataPoolPut.json" - } - } - }, - "delete": { - "tags": [ - "DataPools" - ], - "operationId": "DataPools_Delete", - "description": "Deletes a Data Pool", - "x-ms-long-running-operation": true, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/AccountNameParameter" - }, - { - "$ref": "#/parameters/DataPoolNameParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The Data Pool was successfully deleted" - }, - "202": { - "description": "The Data Pool will be deleted asynchronously" - }, - "204": { - "description": "The Data Pool does not exist" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Delete Data Pool": { - "$ref": "./examples/AdpDataPoolDelete.json" - } - } - } - } - }, - "definitions": { - "AccountCheckNameAvailabilityParameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The account name", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*" - }, - "type": { - "type": "string", - "enum": [ - "Microsoft.AutonomousDevelopmentPlatform/accounts" - ], - "x-ms-enum": { - "name": "Type", - "modelAsString": true - }, - "description": "The type of resource, Microsoft.AutonomousDevelopmentPlatform/accounts" - } - }, - "required": [ - "name", - "type" - ], - "description": "The parameters used to check the availability of the account name" - }, - "CheckNameAvailabilityResult": { - "description": "The checkNameAvailability operation response", - "type": "object", - "properties": { - "nameAvailable": { - "readOnly": true, - "type": "boolean", - "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used" - }, - "reason": { - "readOnly": true, - "type": "string", - "description": "Gets the reason that an account name could not be used. The reason element is only returned if nameAvailable is false", - "enum": [ - "Invalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "CheckNameAvailabilityReason", - "modelAsString": true - } - }, - "message": { - "readOnly": true, - "type": "string", - "description": "Gets an error message explaining the reason value in more detail" - } - } - }, - "Tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - }, - "Account": { - "type": "object", - "description": "ADP account", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" - } - ] - }, - "AccountPatch": { - "type": "object", - "description": "ADP account", - "properties": { - "properties": { - "description": "List of account properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AccountProperties" - }, - "tags": { - "$ref": "#/definitions/Tags" - } - } - }, - "AccountProperties": { - "type": "object", - "description": "ADP account properties", - "properties": { - "accountId": { - "description": "The account's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the account at the time the operation was called", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - } - } - }, - "AccountList": { - "type": "object", - "description": "The list operation response, that contains the data pools and their properties", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/Account" - }, - "description": "List of accounts and their properties" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - } - }, - "DataPool": { - "type": "object", - "description": "ADP Data Pool", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolPatch": { - "type": "object", - "description": "ADP Data Pool", - "properties": { - "properties": { - "description": "List of data pool properties", - "type": "object", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DataPoolBaseProperties" - }, - "systemData": { - "readOnly": true, - "description": "The system meta data relating to this resource", - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" - } - }, - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" - } - ] - }, - "DataPoolBaseProperties": { - "type": "object", - "description": "Data Pool properties", - "properties": { - "dataPoolId": { - "description": "The Data Pool's data-plane ID", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Gets the status of the data pool at the time the operation was called", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted", - "Provisioning", - "Deleting" - ], - "x-ms-enum": { - "name": "ProvisioningState", - "modelAsString": true - } - }, - "locations": { - "type": "array", - "items": { - "$ref": "#/definitions/DataPoolLocation" - }, - "x-ms-identifiers": [ - "name", - "encryption/keyName" - ], - "description": "Gets or sets the collection of locations where Data Pool resources should be created" - }, - "tags": { - "$ref": "#/definitions/Tags" - } - } - }, - "DataPoolProperties": { - "type": "object", - "description": "Data Pool properties", - "allOf": [ - { - "$ref": "#/definitions/DataPoolBaseProperties" - } - ], - "required": [ - "locations" - ] - }, - "DataPoolLocation": { - "type": "object", - "description": "Location of a Data Pool", - "properties": { - "name": { - "description": "The location name", - "type": "string" - }, - "encryption": { - "description": "Encryption properties of a Data Pool location", - "$ref": "#/definitions/DataPoolEncryption" - }, - "storageSku": { - "description": "The Storage SKU. Default: Standard_ZRS.", - "$ref": "#/definitions/storageSku", - "x-nullable": true - }, - "storageAccountCount": { - "description": "The amount of storage accounts provisioned per Data Pool. Default: 5", - "type": "integer", - "minimum": 1, - "format": "int32" - } - }, - "required": [ - "name" - ] - }, - "storageSku": { - "description": "The Storage SKU.", - "type": "object", - "properties": { - "name": { - "description": "The SKU name", - "type": "string", - "enum": [ - "Standard_LRS", - "Standard_GRS", - "Standard_Ragrs", - "Standard_ZRS", - "Premium_LRS", - "Premium_ZRS", - "Standard_Gzrs", - "Standard_Ragzrs" - ], - "x-ms-enum": { - "name": "StorageSkuName", - "modelAsString": true - } - } - }, - "required": [ - "name" - ] - }, - "DataPoolEncryption": { - "type": "object", - "description": "Encryption properties of a Data Pool", - "properties": { - "keyVaultUri": { - "type": "string", - "description": "The URI of a soft delete-enabled Key Vault that is in the same location as the Data Pool location" - }, - "keyName": { - "type": "string", - "description": "The name of Key Vault key" - }, - "keyVersion": { - "type": "string", - "description": "The version of Key Vault key" - }, - "userAssignedIdentity": { - "type": "string", - "description": "The resource ID of a user-assigned Managed Identity used to access the encryption key in the Key Vault. Requires access to the key operations get, wrap, unwrap, and recover" - } - }, - "required": [ - "keyVaultUri", - "keyName", - "userAssignedIdentity" - ] - }, - "DataPoolList": { - "type": "object", - "properties": { - "value": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/DataPool" - }, - "description": "List of data pools and their properties" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - }, - "description": "The list operation response, that contains the data pools and their properties" - }, - "Operation": { - "type": "object", - "description": "Operation detail payload", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "actionType": { - "description": "Indicates the action type", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "Display of the operation" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/OperationProperties", - "description": "Properties of the operation", - "x-ms-client-flatten": true - } - } - }, - "OperationDisplay": { - "type": "object", - "description": "Operation display payload", - "properties": { - "provider": { - "description": "Resource provider of the operation", - "type": "string" - }, - "resource": { - "description": "Resource of the operation", - "type": "string" - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string" - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string" - } - } - }, - "OperationProperties": { - "type": "object", - "description": "Additional details about an operation", - "x-ms-client-flatten": true, - "properties": { - "serviceSpecification": { - "description": "Details about a service operation", - "$ref": "#/definitions/OperationServiceSpecification" - } - } - }, - "OperationServiceSpecification": { - "type": "object", - "description": "Details about a service operation", - "properties": { - "logSpecifications": { - "description": "Details about operations related to logs", - "type": "array", - "items": { - "$ref": "#/definitions/OperationLogSpecification" - }, - "x-ms-identifiers": [ - "name" - ] - }, - "metricSpecifications": { - "description": "Details about operations related to metrics", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricSpecification" - }, - "x-ms-identifiers": [ - "name", - "sourceMdmAccount" - ] - } - } - }, - "OperationLogSpecification": { - "type": "object", - "description": "Details about an operation related to logs", - "properties": { - "name": { - "description": "The name of the log category", - "type": "string" - }, - "displayName": { - "description": "Localized display name", - "type": "string" - }, - "blobDuration": { - "description": "Blobs created in the customer storage account, per hour", - "type": "string" - } - } - }, - "OperationMetricSpecification": { - "type": "object", - "description": "Details about an operation related to metrics", - "properties": { - "name": { - "description": "The name of the metric", - "type": "string" - }, - "displayName": { - "description": "Localized display name of the metric", - "type": "string" - }, - "displayDescription": { - "description": "The description of the metric", - "type": "string" - }, - "unit": { - "description": "The unit that the metric is measured in", - "type": "string" - }, - "aggregationType": { - "description": "The type of metric aggregation", - "type": "string" - }, - "enableRegionalMdmAccount": { - "description": "Whether or not the service is using regional MDM accounts", - "type": "string" - }, - "sourceMdmAccount": { - "description": "The name of the MDM account", - "type": "string" - }, - "sourceMdmNamespace": { - "description": "The name of the MDM namespace", - "type": "string" - }, - "availabilities": { - "description": "Defines how often data for metrics becomes available", - "type": "array", - "items": { - "$ref": "#/definitions/OperationMetricAvailability" - }, - "x-ms-identifiers": [] - } - } - }, - "OperationMetricAvailability": { - "type": "object", - "description": "Defines how often data for a metric becomes available", - "properties": { - "timeGrain": { - "description": "The granularity for the metric", - "type": "string" - }, - "blobDuration": { - "description": "Blob created in the customer storage account, per hour", - "type": "string" - } - } - }, - "OperationListResult": { - "type": "object", - "description": "Available operations of the service", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ], - "description": "List of operations supported by the Resource Provider" - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any" - } - } - }, - "ErrorResponse": { - "type": "object", - "description": "Error response", - "properties": { - "error": { - "$ref": "#/definitions/ErrorDefinition", - "description": "The error details" - } - } - }, - "ErrorDefinition": { - "type": "object", - "description": "Error definition", - "properties": { - "code": { - "description": "Service specific error code which serves as the substatus for the HTTP error code", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Description of the error", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Internal error details", - "type": "array", - "items": { - "$ref": "#/definitions/ErrorDefinition" - }, - "x-ms-identifiers": [], - "readOnly": true - } - } - } - }, - "parameters": { - "AccountNameParameter": { - "name": "accountName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the ADP account", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - }, - "DataPoolNameParameter": { - "name": "dataPoolName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Data Pool", - "pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*", - "maxLength": 50, - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountCheckNameAvailability.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountCheckNameAvailability.json deleted file mode 100644 index 150b73ecd32e..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountCheckNameAvailability.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "parameters": { - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts" - } - }, - "responses": { - "200": { - "body": { - "nameAvailable": true - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountDelete.json deleted file mode 100644 index 32e1a38e5eea..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountGet.json deleted file mode 100644 index f940aae9b031..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": { - "accountId": "id" - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPatch.json deleted file mode 100644 index e47fee89306c..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPatch.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPut.json deleted file mode 100644 index 2d85fa92e934..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountPut.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "parameters": { - "location": "Global", - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "location": "Global", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "tags": {}, - "properties": {} - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsList.json deleted file mode 100644 index c921c1a6c51b..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsList.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsListByResourceGroup.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsListByResourceGroup.json deleted file mode 100644 index 9fa1dc761ec3..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpAccountsListByResourceGroup.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "resourceGroupName": "adpClient" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1", - "name": "adp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts", - "location": "Global", - "tags": {}, - "properties": { - "accountId": "id" - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolDelete.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolDelete.json deleted file mode 100644 index 69e18d83dc3e..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolGet.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolGet.json deleted file mode 100644 index f064f7781360..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPatch.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPatch.json deleted file mode 100644 index d0a7dbf11eaf..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPatch.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPut.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPut.json deleted file mode 100644 index 0c7be144f372..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolPut.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "dataPoolName": "sampledp", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid", - "parameters": { - "properties": { - "locations": [ - { - "name": "westus", - "encryption": { - "keyVaultUri": "https://vaulturi", - "keyName": "key1", - "keyVersion": "123", - "userAssignedIdentity": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1" - } - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - }, - "201": { - "body": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "locations": [ - { - "name": "westus" - } - ] - } - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolsList.json deleted file mode 100644 index e655afe44af2..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpDataPoolsList.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "accountName": "sampleacct", - "resourceGroupName": "adpClient", - "api-version": "2021-11-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.AutonomousDevelopmentPlatform/accounts/adp1/dataPools/dp1", - "name": "dp1", - "type": "Microsoft.AutonomousDevelopmentPlatform/accounts/dataPools", - "properties": { - "dataPoolId": "id", - "locations": [ - { - "name": "westus" - } - ] - } - } - ], - "nextLink": "link" - } - } - } -} diff --git a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpOperationsList.json b/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpOperationsList.json deleted file mode 100644 index e0d44d3e11da..000000000000 --- a/specification/adp/resource-manager/Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/examples/AdpOperationsList.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2021-11-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/read", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Read accounts", - "description": "Read accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/write", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Update accounts", - "description": "Update accounts" - } - }, - { - "name": "Microsoft.AutonomousDevelopmentPlatform/accounts/delete", - "display": { - "provider": "Microsoft Autonomous Development Platform", - "resource": "Account", - "operation": "Delete accounts", - "description": "Delete accounts" - } - } - ] - } - } - } -} diff --git a/specification/adp/resource-manager/readme.az.md b/specification/adp/resource-manager/readme.az.md deleted file mode 100644 index 3e0ecfd6e75d..000000000000 --- a/specification/adp/resource-manager/readme.az.md +++ /dev/null @@ -1,18 +0,0 @@ -## AZ - -These settings apply only when `--az` is specified on the command line. - -``` yaml $(az) && $(target-mode) != 'core' -az: - extensions: adp - namespace: azure.mgmt.adp - package-name: azure-mgmt-adp -az-output-folder: $(azure-cli-extension-folder)/src/adp -python-sdk-output-folder: "$(az-output-folder)/azext_adp/vendored_sdks/adp" - -directive: -- from: swagger-document - where: $.definitions.DataPoolLocation - transform: > - $.properties.encryption["x-ms-client-flatten"] = true; -``` diff --git a/specification/adp/resource-manager/readme.cli.md b/specification/adp/resource-manager/readme.cli.md deleted file mode 100644 index b7ee37d8290c..000000000000 --- a/specification/adp/resource-manager/readme.cli.md +++ /dev/null @@ -1,3 +0,0 @@ -## CLI - -These settings don't need to apply `--cli` on the command line. diff --git a/specification/adp/resource-manager/readme.csharp.md b/specification/adp/resource-manager/readme.csharp.md deleted file mode 100644 index 15d85c60b02b..000000000000 --- a/specification/adp/resource-manager/readme.csharp.md +++ /dev/null @@ -1,15 +0,0 @@ -## C - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=<path to "SDKs" directory of your azure-sdk-for-net clone>`. - -```yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - clear-output-folder: true - client-side-validation: false - namespace: Microsoft.Azure.Management.AutonomousDevelopmentPlatform - output-folder: $(csharp-sdks-folder)/adp/Microsoft.Azure.Management.AutonomousDevelopmentPlatform/Generated -``` diff --git a/specification/adp/resource-manager/readme.go.md b/specification/adp/resource-manager/readme.go.md deleted file mode 100644 index eea4256dd09a..000000000000 --- a/specification/adp/resource-manager/readme.go.md +++ /dev/null @@ -1,25 +0,0 @@ -## Go - -These settings apply only when `--go` is specified on the command line. - -```yaml $(go) -go: - license-header: MICROSOFT_MIT_NO_VERSION - namespace: adp - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2020-07-01-preview - - tag: package-2021-02-01-preview - - tag: package-2021-11-01-preview -``` - -Please also specify `--go-sdks-folder=<path to the root directory of your azure-sdk-for-go clone>`. - -```yaml $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/$(version)/$(namespace) -``` diff --git a/specification/adp/resource-manager/readme.md b/specification/adp/resource-manager/readme.md deleted file mode 100644 index 936b0c9042c0..000000000000 --- a/specification/adp/resource-manager/readme.md +++ /dev/null @@ -1,95 +0,0 @@ -# adp - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for adp. - -## Getting Started - -To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: - -> `autorest readme.md` - -To see additional help and options, run: - -> `autorest --help` - -For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. - ---- - -## Configuration - -### Basic Information - -These are the global settings for the adp. - -```yaml -title: AdpManagementClient -openapi-type: arm -openapi-subtype: rpaas -tag: package-2021-11-01-preview -``` - -### Tag: package-2020-07-01-preview - -```yaml $(tag) == 'package-2020-07-01-preview' -version: 2020-07-01-preview -version-with-underscores: 2020_07_01_preview -input-file: - - Microsoft.AutonomousDevelopmentPlatform/preview/2020-07-01-preview/adp.json -``` - -### Tag: package-2021-02-01-preview - -```yaml $(tag) == 'package-2021-02-01-preview' -version: 2021-02-01-preview -version-with-underscores: 2021_02_01_preview -input-file: - - Microsoft.AutonomousDevelopmentPlatform/preview/2021-02-01-preview/adp.json -``` - -### Tag: package-2021-11-01-preview - -```yaml $(tag) == 'package-2021-11-01-preview' -version: 2021-11-01-preview -version-with-underscores: 2021_11_01_preview -input-file: - - Microsoft.AutonomousDevelopmentPlatform/preview/2021-11-01-preview/adp.json -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -```yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-python - - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-cli-extensions - - repo: azure-resource-manager-schemas - - repo: azure-powershell -``` - -## Go - -See configuration in [readme.go.md](./readme.go.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## CSharp - -See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/adp/resource-manager/readme.python.md b/specification/adp/resource-manager/readme.python.md deleted file mode 100644 index 9911afd82004..000000000000 --- a/specification/adp/resource-manager/readme.python.md +++ /dev/null @@ -1,18 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=<path to the root directory of your azure-sdk-for-python clone>`. - -``` yaml $(python) -azure-arm: true -license-header: MICROSOFT_MIT_NO_VERSION -package-name: azure-mgmt-adp -namespace: azure.mgmt.adp -package-version: 1.0.0b1 -clear-output-folder: true -``` - -``` yaml $(python) -no-namespace-folders: true -output-folder: $(python-sdks-folder)/adp/azure-mgmt-adp/azure/mgmt/adp -``` diff --git a/specification/adp/resource-manager/readme.typescript.md b/specification/adp/resource-manager/readme.typescript.md deleted file mode 100644 index 5bc90c6d3cbd..000000000000 --- a/specification/adp/resource-manager/readme.typescript.md +++ /dev/null @@ -1,14 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=<path to root folder of your azure-sdk-for-js clone>`. - -```yaml $(typescript) -typescript: - azure-arm: true - package-name: "adp" - output-folder: "$(typescript-sdks-folder)/sdk/adp/arm-adp" - payload-flattening-threshold: 1 - generate-metadata: true - override-client-name: AdpManagementClient -``` From 6c28ca33ac307ad251f62129aeb75ad02a34feac Mon Sep 17 00:00:00 2001 From: v-huaemily <164205844+v-huaemily@users.noreply.github.com> Date: Wed, 9 Oct 2024 12:44:44 -0400 Subject: [PATCH 073/101] Remove read visibility from oracle spec models (#30593) * update specs * revert optional spec changes and update examples * adjust examples * update suppression and ts config --------- Co-authored-by: ehuaUser <ehuauser@ehuaVm2.myguest.virtualbox.org> Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> --- .../2023-09-01-preview/dbNodes_action.json | 3 +- .../examples/2023-09-01/dbNodes_action.json | 3 +- .../2024-06-01-preview/dbNodes_action.json | 3 +- .../examples/2024-06-01/dbNodes_action.json | 3 +- .../Oracle.Database.Management/tspconfig.yaml | 6 + .../autonomousDatabaseCharacterSet.tsp | 3 +- ...autonomousDatabaseNationalCharacterSet.tsp | 3 +- .../autonomousDatabaseVersion.tsp | 8 +- .../oracle/models/exadata/dbNodes.tsp | 32 +-- .../oracle/models/exadata/dbSystemShapes.tsp | 22 +- .../oracle/models/exadata/dnsPrivateViews.tsp | 23 +- .../oracle/models/exadata/dnsPrivateZones.tsp | 25 +- .../oracle/models/exadata/giVersions.tsp | 3 +- .../oracle/models/exadata/systemVersions.tsp | 3 +- .../examples/dbNodes_action.json | 3 +- .../preview/2023-09-01-preview/openapi.json | 266 ++++++++---------- .../examples/dbNodes_action.json | 3 +- .../preview/2024-06-01-preview/openapi.json | 266 ++++++++---------- .../2023-09-01/examples/dbNodes_action.json | 3 +- .../stable/2023-09-01/openapi.json | 266 ++++++++---------- .../2024-06-01/examples/dbNodes_action.json | 3 +- .../stable/2024-06-01/openapi.json | 266 ++++++++---------- .../resource-manager/sdk-suppressions.yaml | 10 + 23 files changed, 543 insertions(+), 683 deletions(-) create mode 100644 specification/oracle/resource-manager/sdk-suppressions.yaml diff --git a/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json index 37863366d8c0..d637828e38a9 100644 --- a/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json +++ b/specification/oracle/Oracle.Database.Management/examples/2023-09-01-preview/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json index 4caeab5517c5..99eab2a09379 100644 --- a/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json +++ b/specification/oracle/Oracle.Database.Management/examples/2023-09-01/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json index ba39d8bb992f..0dfb39627116 100644 --- a/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01-preview/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json index 8759060a9153..acac1fbfe3fa 100644 --- a/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json +++ b/specification/oracle/Oracle.Database.Management/examples/2024-06-01/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/Oracle.Database.Management/tspconfig.yaml b/specification/oracle/Oracle.Database.Management/tspconfig.yaml index 58927854d082..2a06611aca21 100644 --- a/specification/oracle/Oracle.Database.Management/tspconfig.yaml +++ b/specification/oracle/Oracle.Database.Management/tspconfig.yaml @@ -16,6 +16,12 @@ options: emitter-output-dir: "{project-root}/.." output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openapi.json" "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true package-dir: "arm-oracledatabase" packageDetails: name: "@azure/arm-oracledatabase" diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp index ff3c443f7557..61cbd705d19f 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseCharacterSet.tsp @@ -23,8 +23,7 @@ model AutonomousDatabaseCharacterSet @doc("AutonomousDatabaseCharacterSet resource model") model AutonomousDatabaseCharacterSetProperties { @doc("The Oracle Autonomous Database supported character sets.") - @visibility("read") @minLength(1) @maxLength(255) - characterSet?: string; + characterSet: string; } diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp index bf3d8b820d61..b71c5ac3e807 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseNationalCharacterSet.tsp @@ -23,8 +23,7 @@ model AutonomousDatabaseNationalCharacterSet @doc("AutonomousDatabaseNationalCharacterSet resource model") model AutonomousDatabaseNationalCharacterSetProperties { @doc("The Oracle Autonomous Database supported national character sets.") - @visibility("read") @minLength(1) @maxLength(255) - characterSet?: string; + characterSet: string; } diff --git a/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp index 3171fdebcc8e..615708050058 100644 --- a/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp +++ b/specification/oracle/models/autonomousdatabase/autonomousDatabaseVersion.tsp @@ -23,28 +23,22 @@ model AutonomousDbVersion is ProxyResource<AutonomousDbVersionProperties> { @doc("AutonomousDbVersion resource model") model AutonomousDbVersionProperties { @doc("Supported Autonomous Db versions.") - @visibility("read") @minLength(1) @maxLength(255) - version?: string; + version: string; @doc("The Autonomous Database workload type") - @visibility("read") dbWorkload?: WorkloadType; @doc("True if this version of the Oracle Database software's default is free.") - @visibility("read") isDefaultForFree?: boolean; @doc("True if this version of the Oracle Database software's default is paid.") - @visibility("read") isDefaultForPaid?: boolean; @doc("True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.") - @visibility("read") isFreeTierEnabled?: boolean; @doc("True if this version of the Oracle Database software has payments enabled.") - @visibility("read") isPaidEnabled?: boolean; } diff --git a/specification/oracle/models/exadata/dbNodes.tsp b/specification/oracle/models/exadata/dbNodes.tsp index 04c9556f6ec0..009894894acf 100644 --- a/specification/oracle/models/exadata/dbNodes.tsp +++ b/specification/oracle/models/exadata/dbNodes.tsp @@ -21,94 +21,72 @@ model DbNode is ProxyResource<DbNodeProperties> { @doc("The properties of DbNodeResource") model DbNodeProperties { @doc("DbNode OCID") - @visibility("read") - ocid?: Ocid; + ocid: Ocid; @doc("Additional information about the planned maintenance.") - @visibility("read") additionalDetails?: string; @doc("The OCID of the backup IP address associated with the database node.") - @visibility("read") backupIpId?: Ocid; @doc("The OCID of the second backup VNIC.") - @visibility("read") backupVnic2Id?: Ocid; @doc("The OCID of the backup VNIC.") - @visibility("read") backupVnicId?: Ocid; @doc("The number of CPU cores enabled on the Db node.") - @visibility("read") cpuCoreCount?: int32; @doc("The allocated local node storage in GBs on the Db node.") - @visibility("read") dbNodeStorageSizeInGbs?: int32; @doc("The OCID of the Exacc Db server associated with the database node.") - @visibility("read") dbServerId?: Ocid; @doc("The OCID of the DB system.") - @visibility("read") - dbSystemId?: Ocid; + dbSystemId: Ocid; @doc("The name of the Fault Domain the instance is contained in.") @minLength(1) @maxLength(255) - @visibility("read") faultDomain?: string; @doc("The OCID of the host IP address associated with the database node.") - @visibility("read") hostIpId?: Ocid; @doc("The host name for the database node.") - @visibility("read") hostname?: string; @doc("The current state of the database node.") - @visibility("read") - lifecycleState?: DbNodeProvisioningState; + lifecycleState: DbNodeProvisioningState; @doc("Lifecycle details of Db Node.") - @visibility("read") lifecycleDetails?: string; @doc("The type of database node maintenance.") - @visibility("read") maintenanceType?: DbNodeMaintenanceType; @doc("The allocated memory in GBs on the Db node.") - @visibility("read") memorySizeInGbs?: int32; @doc("The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.") - @visibility("read") softwareStorageSizeInGb?: int32; @doc("The date and time that the database node was created.") - @visibility("read") - timeCreated?: utcDateTime; + timeCreated: utcDateTime; @doc("End date and time of maintenance window.") - @visibility("read") timeMaintenanceWindowEnd?: utcDateTime; @doc("Start date and time of maintenance window.") - @visibility("read") timeMaintenanceWindowStart?: utcDateTime; @doc("The OCID of the second VNIC.") - @visibility("read") vnic2Id?: Ocid; @doc("The OCID of the VNIC.") - @visibility("read") - vnicId?: Ocid; + vnicId: Ocid; @doc("Azure resource provisioning state.") @visibility("read") diff --git a/specification/oracle/models/exadata/dbSystemShapes.tsp b/specification/oracle/models/exadata/dbSystemShapes.tsp index 3e80e8c9b6b9..6b298499d5f9 100644 --- a/specification/oracle/models/exadata/dbSystemShapes.tsp +++ b/specification/oracle/models/exadata/dbSystemShapes.tsp @@ -19,84 +19,64 @@ model DbSystemShape is ProxyResource<DbSystemShapeProperties> { @doc("DbSystemShape resource model") model DbSystemShapeProperties { @doc("The family of the shape used for the DB system.") - @visibility("read") @minLength(1) @maxLength(255) shapeFamily?: string; @doc("The maximum number of CPU cores that can be enabled on the DB system for this shape.") - @visibility("read") - availableCoreCount?: int32; + availableCoreCount: int32; @doc("The minimum number of CPU cores that can be enabled on the DB system for this shape.") - @visibility("read") minimumCoreCount?: int32; @doc("The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.") - @visibility("read") runtimeMinimumCoreCount?: int32; @doc("The discrete number by which the CPU core count for this shape can be increased or decreased.") - @visibility("read") coreCountIncrement?: int32; @doc("The minimum number of Exadata storage servers available for the Exadata infrastructure.") - @visibility("read") minStorageCount?: int32; @doc("The maximum number of Exadata storage servers available for the Exadata infrastructure.") - @visibility("read") maxStorageCount?: int32; @doc("The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.") - @visibility("read") availableDataStoragePerServerInTbs?: float64; @doc("The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.") - @visibility("read") availableMemoryPerNodeInGbs?: int32; @doc("The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.") - @visibility("read") availableDbNodePerNodeInGbs?: int32; @doc("The minimum number of CPU cores that can be enabled per node for this shape.") - @visibility("read") minCoreCountPerNode?: int32; @doc("The maximum memory that can be enabled for this shape.") - @visibility("read") availableMemoryInGbs?: int32; @doc("The minimum memory that need be allocated per node for this shape.") - @visibility("read") minMemoryPerNodeInGbs?: int32; @doc("The maximum Db Node storage that can be enabled for this shape.") - @visibility("read") availableDbNodeStorageInGbs?: int32; @doc("The minimum Db Node storage that need be allocated per node for this shape.") - @visibility("read") minDbNodeStoragePerNodeInGbs?: int32; @doc("The maximum DATA storage that can be enabled for this shape.") - @visibility("read") availableDataStorageInTbs?: int32; @doc("The minimum data storage that need be allocated for this shape.") - @visibility("read") minDataStorageInTbs?: int32; @doc("The minimum number of database nodes available for this shape.") - @visibility("read") minimumNodeCount?: int32; @doc("The maximum number of database nodes available for this shape.") - @visibility("read") maximumNodeCount?: int32; @doc("The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.") - @visibility("read") availableCoreCountPerNode?: int32; } diff --git a/specification/oracle/models/exadata/dnsPrivateViews.tsp b/specification/oracle/models/exadata/dnsPrivateViews.tsp index a961039310a2..5e0125d73316 100644 --- a/specification/oracle/models/exadata/dnsPrivateViews.tsp +++ b/specification/oracle/models/exadata/dnsPrivateViews.tsp @@ -20,32 +20,25 @@ model DnsPrivateView is ProxyResource<DnsPrivateViewProperties> { @doc("Views resource model") model DnsPrivateViewProperties { @doc("The OCID of the view") - @visibility("read") - ocid?: Ocid; + ocid: Ocid; @doc("The display name of the view resource") - @visibility("read") - displayName?: string; + displayName: string; @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") - @visibility("read") - isProtected?: boolean; + isProtected: boolean; @doc("Views lifecycleState") - @visibility("read") - lifecycleState?: DnsPrivateViewsLifecycleState; + lifecycleState: DnsPrivateViewsLifecycleState; @doc("The canonical absolute URL of the resource.") - @visibility("read") - self?: string; + self: string; @doc("views timeCreated") - @visibility("read") - timeCreated?: utcDateTime; + timeCreated: utcDateTime; - @doc("views timeCreated") - @visibility("read") - timeUpdated?: utcDateTime; + @doc("views timeUpdated") + timeUpdated: utcDateTime; @doc("Azure resource provisioning state.") @visibility("read") diff --git a/specification/oracle/models/exadata/dnsPrivateZones.tsp b/specification/oracle/models/exadata/dnsPrivateZones.tsp index 93fe7769b273..e933c63b9ffa 100644 --- a/specification/oracle/models/exadata/dnsPrivateZones.tsp +++ b/specification/oracle/models/exadata/dnsPrivateZones.tsp @@ -22,40 +22,31 @@ model DnsPrivateZone is ProxyResource<DnsPrivateZoneProperties> { @doc("Zones resource model") model DnsPrivateZoneProperties { @doc("The OCID of the Zone") - @visibility("read") - ocid?: Ocid; + ocid: Ocid; @doc("A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.") - @visibility("read") - isProtected?: boolean; + isProtected: boolean; @doc("Zones lifecycleState") - @visibility("read") - lifecycleState?: DnsPrivateZonesLifecycleState; + lifecycleState: DnsPrivateZonesLifecycleState; @doc("The canonical absolute URL of the resource.") - @visibility("read") - self?: string; + self: string; @doc("The current serial of the zone. As seen in the zone's SOA record.") - @visibility("read") - serial?: int32; + serial: int32; @doc("Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.") - @visibility("read") - version?: string; + version: string; @doc("The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.") - @visibility("read") viewId?: Ocid; @doc("The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.") - @visibility("read") - zoneType?: ZoneType; + zoneType: ZoneType; @doc("Zones timeCreated") - @visibility("read") - timeCreated?: utcDateTime; + timeCreated: utcDateTime; @doc("Azure resource provisioning state.") @visibility("read") diff --git a/specification/oracle/models/exadata/giVersions.tsp b/specification/oracle/models/exadata/giVersions.tsp index 5699089bf101..83269ce99653 100644 --- a/specification/oracle/models/exadata/giVersions.tsp +++ b/specification/oracle/models/exadata/giVersions.tsp @@ -19,8 +19,7 @@ model GiVersion is ProxyResource<GiVersionProperties> { @doc("GiVersion resource model") model GiVersionProperties { @doc("A valid Oracle Grid Infrastructure (GI) software version.") - @visibility("read") @minLength(1) @maxLength(255) - version?: string; + version: string; } diff --git a/specification/oracle/models/exadata/systemVersions.tsp b/specification/oracle/models/exadata/systemVersions.tsp index b47e22617554..afc2cb13f902 100644 --- a/specification/oracle/models/exadata/systemVersions.tsp +++ b/specification/oracle/models/exadata/systemVersions.tsp @@ -31,6 +31,5 @@ model SystemVersionsFilter { @doc("System Version Resource model") model SystemVersionProperties { @doc("A valid Oracle System Version") - @visibility("read") - systemVersion?: string; + systemVersion: string; } diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_action.json index 37863366d8c0..d637828e38a9 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_action.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/examples/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json index 382992784012..018111447822 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2023-09-01-preview/openapi.json @@ -4755,10 +4755,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5044,10 +5046,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported national character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseProperties": { "type": "object", @@ -5396,35 +5400,32 @@ "type": "string", "description": "Supported Autonomous Db versions.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "dbWorkload": { "$ref": "#/definitions/WorkloadType", - "description": "The Autonomous Database workload type", - "readOnly": true + "description": "The Autonomous Database workload type" }, "isDefaultForFree": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is free.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is free." }, "isDefaultForPaid": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is paid.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is paid." }, "isFreeTierEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", - "readOnly": true + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases." }, "isPaidEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software has payments enabled.", - "readOnly": true + "description": "True if this version of the Oracle Database software has payments enabled." } - } + }, + "required": [ + "version" + ] }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7021,129 +7022,114 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "DbNode OCID", - "readOnly": true + "description": "DbNode OCID" }, "additionalDetails": { "type": "string", - "description": "Additional information about the planned maintenance.", - "readOnly": true + "description": "Additional information about the planned maintenance." }, "backupIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the backup IP address associated with the database node." }, "backupVnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second backup VNIC.", - "readOnly": true + "description": "The OCID of the second backup VNIC." }, "backupVnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup VNIC.", - "readOnly": true + "description": "The OCID of the backup VNIC." }, "cpuCoreCount": { "type": "integer", "format": "int32", - "description": "The number of CPU cores enabled on the Db node.", - "readOnly": true + "description": "The number of CPU cores enabled on the Db node." }, "dbNodeStorageSizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated local node storage in GBs on the Db node.", - "readOnly": true + "description": "The allocated local node storage in GBs on the Db node." }, "dbServerId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Exacc Db server associated with the database node.", - "readOnly": true + "description": "The OCID of the Exacc Db server associated with the database node." }, "dbSystemId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the DB system.", - "readOnly": true + "description": "The OCID of the DB system." }, "faultDomain": { "type": "string", "description": "The name of the Fault Domain the instance is contained in.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "hostIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the host IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the host IP address associated with the database node." }, "hostname": { "type": "string", - "description": "The host name for the database node.", - "readOnly": true + "description": "The host name for the database node." }, "lifecycleState": { "$ref": "#/definitions/DbNodeProvisioningState", - "description": "The current state of the database node.", - "readOnly": true + "description": "The current state of the database node." }, "lifecycleDetails": { "type": "string", - "description": "Lifecycle details of Db Node.", - "readOnly": true + "description": "Lifecycle details of Db Node." }, "maintenanceType": { "$ref": "#/definitions/DbNodeMaintenanceType", - "description": "The type of database node maintenance.", - "readOnly": true + "description": "The type of database node maintenance." }, "memorySizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated memory in GBs on the Db node.", - "readOnly": true + "description": "The allocated memory in GBs on the Db node." }, "softwareStorageSizeInGb": { "type": "integer", "format": "int32", - "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", - "readOnly": true + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "The date and time that the database node was created.", - "readOnly": true + "description": "The date and time that the database node was created." }, "timeMaintenanceWindowEnd": { "type": "string", "format": "date-time", - "description": "End date and time of maintenance window.", - "readOnly": true + "description": "End date and time of maintenance window." }, "timeMaintenanceWindowStart": { "type": "string", "format": "date-time", - "description": "Start date and time of maintenance window.", - "readOnly": true + "description": "Start date and time of maintenance window." }, "vnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second VNIC.", - "readOnly": true + "description": "The OCID of the second VNIC." }, "vnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the VNIC.", - "readOnly": true + "description": "The OCID of the VNIC." }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "dbSystemId", + "lifecycleState", + "timeCreated", + "vnicId" + ] }, "DbNodeProvisioningState": { "type": "string", @@ -7537,124 +7523,107 @@ "type": "string", "description": "The family of the shape used for the DB system.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "availableCoreCount": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape." }, "minimumCoreCount": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape." }, "runtimeMinimumCoreCount": { "type": "integer", "format": "int32", - "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape." }, "coreCountIncrement": { "type": "integer", "format": "int32", - "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", - "readOnly": true + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased." }, "minStorageCount": { "type": "integer", "format": "int32", - "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure." }, "maxStorageCount": { "type": "integer", "format": "int32", - "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure." }, "availableDataStoragePerServerInTbs": { "type": "number", "format": "double", - "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes." }, "availableMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "availableDbNodePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "minCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled per node for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled per node for this shape." }, "availableMemoryInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory that can be enabled for this shape.", - "readOnly": true + "description": "The maximum memory that can be enabled for this shape." }, "minMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum memory that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum memory that need be allocated per node for this shape." }, "availableDbNodeStorageInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum Db Node storage that can be enabled for this shape." }, "minDbNodeStoragePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum Db Node storage that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum Db Node storage that need be allocated per node for this shape." }, "availableDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The maximum DATA storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum DATA storage that can be enabled for this shape." }, "minDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The minimum data storage that need be allocated for this shape.", - "readOnly": true + "description": "The minimum data storage that need be allocated for this shape." }, "minimumNodeCount": { "type": "integer", "format": "int32", - "description": "The minimum number of database nodes available for this shape.", - "readOnly": true + "description": "The minimum number of database nodes available for this shape." }, "maximumNodeCount": { "type": "integer", "format": "int32", - "description": "The maximum number of database nodes available for this shape.", - "readOnly": true + "description": "The maximum number of database nodes available for this shape." }, "availableCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes." } - } + }, + "required": [ + "availableCoreCount" + ] }, "DisasterRecoveryType": { "type": "string", @@ -7747,47 +7716,49 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the view", - "readOnly": true + "description": "The OCID of the view" }, "displayName": { "type": "string", - "description": "The display name of the view resource", - "readOnly": true + "description": "The display name of the view resource" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateViewsLifecycleState", - "description": "Views lifecycleState", - "readOnly": true + "description": "Views lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeCreated" }, "timeUpdated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeUpdated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "displayName", + "isProtected", + "lifecycleState", + "self", + "timeCreated", + "timeUpdated" + ] }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7868,57 +7839,58 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Zone", - "readOnly": true + "description": "The OCID of the Zone" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateZonesLifecycleState", - "description": "Zones lifecycleState", - "readOnly": true + "description": "Zones lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "serial": { "type": "integer", "format": "int32", - "description": "The current serial of the zone. As seen in the zone's SOA record.", - "readOnly": true + "description": "The current serial of the zone. As seen in the zone's SOA record." }, "version": { "type": "string", - "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", - "readOnly": true + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived." }, "viewId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", - "readOnly": true + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view." }, "zoneType": { "$ref": "#/definitions/ZoneType", - "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", - "readOnly": true + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "Zones timeCreated", - "readOnly": true + "description": "Zones timeCreated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "isProtected", + "lifecycleState", + "self", + "serial", + "version", + "zoneType", + "timeCreated" + ] }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8117,10 +8089,12 @@ "type": "string", "description": "A valid Oracle Grid Infrastructure (GI) software version.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "version" + ] }, "HostFormatType": { "type": "string", @@ -9415,10 +9389,12 @@ "properties": { "systemVersion": { "type": "string", - "description": "A valid Oracle System Version", - "readOnly": true + "description": "A valid Oracle System Version" } - } + }, + "required": [ + "systemVersion" + ] }, "SystemVersionsFilter": { "type": "object", diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json index ba39d8bb992f..0dfb39627116 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/examples/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json index 84c01a35bf38..5871996780ab 100644 --- a/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/preview/2024-06-01-preview/openapi.json @@ -4843,10 +4843,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5132,10 +5134,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported national character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseProperties": { "type": "object", @@ -5484,35 +5488,32 @@ "type": "string", "description": "Supported Autonomous Db versions.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "dbWorkload": { "$ref": "#/definitions/WorkloadType", - "description": "The Autonomous Database workload type", - "readOnly": true + "description": "The Autonomous Database workload type" }, "isDefaultForFree": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is free.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is free." }, "isDefaultForPaid": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is paid.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is paid." }, "isFreeTierEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", - "readOnly": true + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases." }, "isPaidEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software has payments enabled.", - "readOnly": true + "description": "True if this version of the Oracle Database software has payments enabled." } - } + }, + "required": [ + "version" + ] }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7125,129 +7126,114 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "DbNode OCID", - "readOnly": true + "description": "DbNode OCID" }, "additionalDetails": { "type": "string", - "description": "Additional information about the planned maintenance.", - "readOnly": true + "description": "Additional information about the planned maintenance." }, "backupIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the backup IP address associated with the database node." }, "backupVnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second backup VNIC.", - "readOnly": true + "description": "The OCID of the second backup VNIC." }, "backupVnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup VNIC.", - "readOnly": true + "description": "The OCID of the backup VNIC." }, "cpuCoreCount": { "type": "integer", "format": "int32", - "description": "The number of CPU cores enabled on the Db node.", - "readOnly": true + "description": "The number of CPU cores enabled on the Db node." }, "dbNodeStorageSizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated local node storage in GBs on the Db node.", - "readOnly": true + "description": "The allocated local node storage in GBs on the Db node." }, "dbServerId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Exacc Db server associated with the database node.", - "readOnly": true + "description": "The OCID of the Exacc Db server associated with the database node." }, "dbSystemId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the DB system.", - "readOnly": true + "description": "The OCID of the DB system." }, "faultDomain": { "type": "string", "description": "The name of the Fault Domain the instance is contained in.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "hostIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the host IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the host IP address associated with the database node." }, "hostname": { "type": "string", - "description": "The host name for the database node.", - "readOnly": true + "description": "The host name for the database node." }, "lifecycleState": { "$ref": "#/definitions/DbNodeProvisioningState", - "description": "The current state of the database node.", - "readOnly": true + "description": "The current state of the database node." }, "lifecycleDetails": { "type": "string", - "description": "Lifecycle details of Db Node.", - "readOnly": true + "description": "Lifecycle details of Db Node." }, "maintenanceType": { "$ref": "#/definitions/DbNodeMaintenanceType", - "description": "The type of database node maintenance.", - "readOnly": true + "description": "The type of database node maintenance." }, "memorySizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated memory in GBs on the Db node.", - "readOnly": true + "description": "The allocated memory in GBs on the Db node." }, "softwareStorageSizeInGb": { "type": "integer", "format": "int32", - "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", - "readOnly": true + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "The date and time that the database node was created.", - "readOnly": true + "description": "The date and time that the database node was created." }, "timeMaintenanceWindowEnd": { "type": "string", "format": "date-time", - "description": "End date and time of maintenance window.", - "readOnly": true + "description": "End date and time of maintenance window." }, "timeMaintenanceWindowStart": { "type": "string", "format": "date-time", - "description": "Start date and time of maintenance window.", - "readOnly": true + "description": "Start date and time of maintenance window." }, "vnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second VNIC.", - "readOnly": true + "description": "The OCID of the second VNIC." }, "vnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the VNIC.", - "readOnly": true + "description": "The OCID of the VNIC." }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "dbSystemId", + "lifecycleState", + "timeCreated", + "vnicId" + ] }, "DbNodeProvisioningState": { "type": "string", @@ -7641,124 +7627,107 @@ "type": "string", "description": "The family of the shape used for the DB system.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "availableCoreCount": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape." }, "minimumCoreCount": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape." }, "runtimeMinimumCoreCount": { "type": "integer", "format": "int32", - "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape." }, "coreCountIncrement": { "type": "integer", "format": "int32", - "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", - "readOnly": true + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased." }, "minStorageCount": { "type": "integer", "format": "int32", - "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure." }, "maxStorageCount": { "type": "integer", "format": "int32", - "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure." }, "availableDataStoragePerServerInTbs": { "type": "number", "format": "double", - "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes." }, "availableMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "availableDbNodePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "minCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled per node for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled per node for this shape." }, "availableMemoryInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory that can be enabled for this shape.", - "readOnly": true + "description": "The maximum memory that can be enabled for this shape." }, "minMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum memory that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum memory that need be allocated per node for this shape." }, "availableDbNodeStorageInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum Db Node storage that can be enabled for this shape." }, "minDbNodeStoragePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum Db Node storage that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum Db Node storage that need be allocated per node for this shape." }, "availableDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The maximum DATA storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum DATA storage that can be enabled for this shape." }, "minDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The minimum data storage that need be allocated for this shape.", - "readOnly": true + "description": "The minimum data storage that need be allocated for this shape." }, "minimumNodeCount": { "type": "integer", "format": "int32", - "description": "The minimum number of database nodes available for this shape.", - "readOnly": true + "description": "The minimum number of database nodes available for this shape." }, "maximumNodeCount": { "type": "integer", "format": "int32", - "description": "The maximum number of database nodes available for this shape.", - "readOnly": true + "description": "The maximum number of database nodes available for this shape." }, "availableCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes." } - } + }, + "required": [ + "availableCoreCount" + ] }, "DisasterRecoveryType": { "type": "string", @@ -7851,47 +7820,49 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the view", - "readOnly": true + "description": "The OCID of the view" }, "displayName": { "type": "string", - "description": "The display name of the view resource", - "readOnly": true + "description": "The display name of the view resource" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateViewsLifecycleState", - "description": "Views lifecycleState", - "readOnly": true + "description": "Views lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeCreated" }, "timeUpdated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeUpdated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "displayName", + "isProtected", + "lifecycleState", + "self", + "timeCreated", + "timeUpdated" + ] }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7972,57 +7943,58 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Zone", - "readOnly": true + "description": "The OCID of the Zone" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateZonesLifecycleState", - "description": "Zones lifecycleState", - "readOnly": true + "description": "Zones lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "serial": { "type": "integer", "format": "int32", - "description": "The current serial of the zone. As seen in the zone's SOA record.", - "readOnly": true + "description": "The current serial of the zone. As seen in the zone's SOA record." }, "version": { "type": "string", - "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", - "readOnly": true + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived." }, "viewId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", - "readOnly": true + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view." }, "zoneType": { "$ref": "#/definitions/ZoneType", - "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", - "readOnly": true + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "Zones timeCreated", - "readOnly": true + "description": "Zones timeCreated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "isProtected", + "lifecycleState", + "self", + "serial", + "version", + "zoneType", + "timeCreated" + ] }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8221,10 +8193,12 @@ "type": "string", "description": "A valid Oracle Grid Infrastructure (GI) software version.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "version" + ] }, "HostFormatType": { "type": "string", @@ -9537,10 +9511,12 @@ "properties": { "systemVersion": { "type": "string", - "description": "A valid Oracle System Version", - "readOnly": true + "description": "A valid Oracle System Version" } - } + }, + "required": [ + "systemVersion" + ] }, "SystemVersionsFilter": { "type": "object", diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json index 4caeab5517c5..99eab2a09379 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json index 6915309bf4bb..a5eabecedef5 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/openapi.json @@ -4755,10 +4755,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5044,10 +5046,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported national character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseProperties": { "type": "object", @@ -5396,35 +5400,32 @@ "type": "string", "description": "Supported Autonomous Db versions.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "dbWorkload": { "$ref": "#/definitions/WorkloadType", - "description": "The Autonomous Database workload type", - "readOnly": true + "description": "The Autonomous Database workload type" }, "isDefaultForFree": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is free.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is free." }, "isDefaultForPaid": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is paid.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is paid." }, "isFreeTierEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", - "readOnly": true + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases." }, "isPaidEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software has payments enabled.", - "readOnly": true + "description": "True if this version of the Oracle Database software has payments enabled." } - } + }, + "required": [ + "version" + ] }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7021,129 +7022,114 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "DbNode OCID", - "readOnly": true + "description": "DbNode OCID" }, "additionalDetails": { "type": "string", - "description": "Additional information about the planned maintenance.", - "readOnly": true + "description": "Additional information about the planned maintenance." }, "backupIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the backup IP address associated with the database node." }, "backupVnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second backup VNIC.", - "readOnly": true + "description": "The OCID of the second backup VNIC." }, "backupVnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup VNIC.", - "readOnly": true + "description": "The OCID of the backup VNIC." }, "cpuCoreCount": { "type": "integer", "format": "int32", - "description": "The number of CPU cores enabled on the Db node.", - "readOnly": true + "description": "The number of CPU cores enabled on the Db node." }, "dbNodeStorageSizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated local node storage in GBs on the Db node.", - "readOnly": true + "description": "The allocated local node storage in GBs on the Db node." }, "dbServerId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Exacc Db server associated with the database node.", - "readOnly": true + "description": "The OCID of the Exacc Db server associated with the database node." }, "dbSystemId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the DB system.", - "readOnly": true + "description": "The OCID of the DB system." }, "faultDomain": { "type": "string", "description": "The name of the Fault Domain the instance is contained in.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "hostIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the host IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the host IP address associated with the database node." }, "hostname": { "type": "string", - "description": "The host name for the database node.", - "readOnly": true + "description": "The host name for the database node." }, "lifecycleState": { "$ref": "#/definitions/DbNodeProvisioningState", - "description": "The current state of the database node.", - "readOnly": true + "description": "The current state of the database node." }, "lifecycleDetails": { "type": "string", - "description": "Lifecycle details of Db Node.", - "readOnly": true + "description": "Lifecycle details of Db Node." }, "maintenanceType": { "$ref": "#/definitions/DbNodeMaintenanceType", - "description": "The type of database node maintenance.", - "readOnly": true + "description": "The type of database node maintenance." }, "memorySizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated memory in GBs on the Db node.", - "readOnly": true + "description": "The allocated memory in GBs on the Db node." }, "softwareStorageSizeInGb": { "type": "integer", "format": "int32", - "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", - "readOnly": true + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "The date and time that the database node was created.", - "readOnly": true + "description": "The date and time that the database node was created." }, "timeMaintenanceWindowEnd": { "type": "string", "format": "date-time", - "description": "End date and time of maintenance window.", - "readOnly": true + "description": "End date and time of maintenance window." }, "timeMaintenanceWindowStart": { "type": "string", "format": "date-time", - "description": "Start date and time of maintenance window.", - "readOnly": true + "description": "Start date and time of maintenance window." }, "vnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second VNIC.", - "readOnly": true + "description": "The OCID of the second VNIC." }, "vnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the VNIC.", - "readOnly": true + "description": "The OCID of the VNIC." }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "dbSystemId", + "lifecycleState", + "timeCreated", + "vnicId" + ] }, "DbNodeProvisioningState": { "type": "string", @@ -7537,124 +7523,107 @@ "type": "string", "description": "The family of the shape used for the DB system.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "availableCoreCount": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape." }, "minimumCoreCount": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape." }, "runtimeMinimumCoreCount": { "type": "integer", "format": "int32", - "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape." }, "coreCountIncrement": { "type": "integer", "format": "int32", - "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", - "readOnly": true + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased." }, "minStorageCount": { "type": "integer", "format": "int32", - "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure." }, "maxStorageCount": { "type": "integer", "format": "int32", - "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure." }, "availableDataStoragePerServerInTbs": { "type": "number", "format": "double", - "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes." }, "availableMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "availableDbNodePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "minCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled per node for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled per node for this shape." }, "availableMemoryInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory that can be enabled for this shape.", - "readOnly": true + "description": "The maximum memory that can be enabled for this shape." }, "minMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum memory that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum memory that need be allocated per node for this shape." }, "availableDbNodeStorageInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum Db Node storage that can be enabled for this shape." }, "minDbNodeStoragePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum Db Node storage that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum Db Node storage that need be allocated per node for this shape." }, "availableDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The maximum DATA storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum DATA storage that can be enabled for this shape." }, "minDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The minimum data storage that need be allocated for this shape.", - "readOnly": true + "description": "The minimum data storage that need be allocated for this shape." }, "minimumNodeCount": { "type": "integer", "format": "int32", - "description": "The minimum number of database nodes available for this shape.", - "readOnly": true + "description": "The minimum number of database nodes available for this shape." }, "maximumNodeCount": { "type": "integer", "format": "int32", - "description": "The maximum number of database nodes available for this shape.", - "readOnly": true + "description": "The maximum number of database nodes available for this shape." }, "availableCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes." } - } + }, + "required": [ + "availableCoreCount" + ] }, "DisasterRecoveryType": { "type": "string", @@ -7747,47 +7716,49 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the view", - "readOnly": true + "description": "The OCID of the view" }, "displayName": { "type": "string", - "description": "The display name of the view resource", - "readOnly": true + "description": "The display name of the view resource" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateViewsLifecycleState", - "description": "Views lifecycleState", - "readOnly": true + "description": "Views lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeCreated" }, "timeUpdated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeUpdated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "displayName", + "isProtected", + "lifecycleState", + "self", + "timeCreated", + "timeUpdated" + ] }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7868,57 +7839,58 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Zone", - "readOnly": true + "description": "The OCID of the Zone" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateZonesLifecycleState", - "description": "Zones lifecycleState", - "readOnly": true + "description": "Zones lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "serial": { "type": "integer", "format": "int32", - "description": "The current serial of the zone. As seen in the zone's SOA record.", - "readOnly": true + "description": "The current serial of the zone. As seen in the zone's SOA record." }, "version": { "type": "string", - "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", - "readOnly": true + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived." }, "viewId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", - "readOnly": true + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view." }, "zoneType": { "$ref": "#/definitions/ZoneType", - "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", - "readOnly": true + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "Zones timeCreated", - "readOnly": true + "description": "Zones timeCreated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "isProtected", + "lifecycleState", + "self", + "serial", + "version", + "zoneType", + "timeCreated" + ] }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8117,10 +8089,12 @@ "type": "string", "description": "A valid Oracle Grid Infrastructure (GI) software version.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "version" + ] }, "HostFormatType": { "type": "string", @@ -9415,10 +9389,12 @@ "properties": { "systemVersion": { "type": "string", - "description": "A valid Oracle System Version", - "readOnly": true + "description": "A valid Oracle System Version" } - } + }, + "required": [ + "systemVersion" + ] }, "SystemVersionsFilter": { "type": "object", diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json index 8759060a9153..acac1fbfe3fa 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/examples/dbNodes_action.json @@ -36,7 +36,8 @@ "timeMaintenanceWindowEnd": "2023-10-21T13:44:04.924Z", "timeMaintenanceWindowStart": "2023-10-21T13:44:04.924Z", "vnic2Id": "ocid.vnic.id2", - "vnicId": "ocid.vnic.id1" + "vnicId": "ocid.vnic.id1", + "lifecycleState": "Available" } } }, diff --git a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json index a40dfc017dd0..0713d39e704e 100644 --- a/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json +++ b/specification/oracle/resource-manager/Oracle.Database/stable/2024-06-01/openapi.json @@ -4843,10 +4843,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseCloneProperties": { "type": "object", @@ -5132,10 +5134,12 @@ "type": "string", "description": "The Oracle Autonomous Database supported national character sets.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "characterSet" + ] }, "AutonomousDatabaseProperties": { "type": "object", @@ -5484,35 +5488,32 @@ "type": "string", "description": "Supported Autonomous Db versions.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "dbWorkload": { "$ref": "#/definitions/WorkloadType", - "description": "The Autonomous Database workload type", - "readOnly": true + "description": "The Autonomous Database workload type" }, "isDefaultForFree": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is free.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is free." }, "isDefaultForPaid": { "type": "boolean", - "description": "True if this version of the Oracle Database software's default is paid.", - "readOnly": true + "description": "True if this version of the Oracle Database software's default is paid." }, "isFreeTierEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases.", - "readOnly": true + "description": "True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases." }, "isPaidEnabled": { "type": "boolean", - "description": "True if this version of the Oracle Database software has payments enabled.", - "readOnly": true + "description": "True if this version of the Oracle Database software has payments enabled." } - } + }, + "required": [ + "version" + ] }, "AutonomousMaintenanceScheduleType": { "type": "string", @@ -7125,129 +7126,114 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "DbNode OCID", - "readOnly": true + "description": "DbNode OCID" }, "additionalDetails": { "type": "string", - "description": "Additional information about the planned maintenance.", - "readOnly": true + "description": "Additional information about the planned maintenance." }, "backupIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the backup IP address associated with the database node." }, "backupVnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second backup VNIC.", - "readOnly": true + "description": "The OCID of the second backup VNIC." }, "backupVnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the backup VNIC.", - "readOnly": true + "description": "The OCID of the backup VNIC." }, "cpuCoreCount": { "type": "integer", "format": "int32", - "description": "The number of CPU cores enabled on the Db node.", - "readOnly": true + "description": "The number of CPU cores enabled on the Db node." }, "dbNodeStorageSizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated local node storage in GBs on the Db node.", - "readOnly": true + "description": "The allocated local node storage in GBs on the Db node." }, "dbServerId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Exacc Db server associated with the database node.", - "readOnly": true + "description": "The OCID of the Exacc Db server associated with the database node." }, "dbSystemId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the DB system.", - "readOnly": true + "description": "The OCID of the DB system." }, "faultDomain": { "type": "string", "description": "The name of the Fault Domain the instance is contained in.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "hostIpId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the host IP address associated with the database node.", - "readOnly": true + "description": "The OCID of the host IP address associated with the database node." }, "hostname": { "type": "string", - "description": "The host name for the database node.", - "readOnly": true + "description": "The host name for the database node." }, "lifecycleState": { "$ref": "#/definitions/DbNodeProvisioningState", - "description": "The current state of the database node.", - "readOnly": true + "description": "The current state of the database node." }, "lifecycleDetails": { "type": "string", - "description": "Lifecycle details of Db Node.", - "readOnly": true + "description": "Lifecycle details of Db Node." }, "maintenanceType": { "$ref": "#/definitions/DbNodeMaintenanceType", - "description": "The type of database node maintenance.", - "readOnly": true + "description": "The type of database node maintenance." }, "memorySizeInGbs": { "type": "integer", "format": "int32", - "description": "The allocated memory in GBs on the Db node.", - "readOnly": true + "description": "The allocated memory in GBs on the Db node." }, "softwareStorageSizeInGb": { "type": "integer", "format": "int32", - "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.", - "readOnly": true + "description": "The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "The date and time that the database node was created.", - "readOnly": true + "description": "The date and time that the database node was created." }, "timeMaintenanceWindowEnd": { "type": "string", "format": "date-time", - "description": "End date and time of maintenance window.", - "readOnly": true + "description": "End date and time of maintenance window." }, "timeMaintenanceWindowStart": { "type": "string", "format": "date-time", - "description": "Start date and time of maintenance window.", - "readOnly": true + "description": "Start date and time of maintenance window." }, "vnic2Id": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the second VNIC.", - "readOnly": true + "description": "The OCID of the second VNIC." }, "vnicId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the VNIC.", - "readOnly": true + "description": "The OCID of the VNIC." }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "dbSystemId", + "lifecycleState", + "timeCreated", + "vnicId" + ] }, "DbNodeProvisioningState": { "type": "string", @@ -7641,124 +7627,107 @@ "type": "string", "description": "The family of the shape used for the DB system.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 }, "availableCoreCount": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The maximum number of CPU cores that can be enabled on the DB system for this shape." }, "minimumCoreCount": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled on the DB system for this shape." }, "runtimeMinimumCoreCount": { "type": "integer", "format": "int32", - "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.", - "readOnly": true + "description": "The runtime minimum number of CPU cores that can be enabled on the DB system for this shape." }, "coreCountIncrement": { "type": "integer", "format": "int32", - "description": "The discrete number by which the CPU core count for this shape can be increased or decreased.", - "readOnly": true + "description": "The discrete number by which the CPU core count for this shape can be increased or decreased." }, "minStorageCount": { "type": "integer", "format": "int32", - "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The minimum number of Exadata storage servers available for the Exadata infrastructure." }, "maxStorageCount": { "type": "integer", "format": "int32", - "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure.", - "readOnly": true + "description": "The maximum number of Exadata storage servers available for the Exadata infrastructure." }, "availableDataStoragePerServerInTbs": { "type": "number", "format": "double", - "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes." }, "availableMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "availableDbNodePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes." }, "minCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The minimum number of CPU cores that can be enabled per node for this shape.", - "readOnly": true + "description": "The minimum number of CPU cores that can be enabled per node for this shape." }, "availableMemoryInGbs": { "type": "integer", "format": "int32", - "description": "The maximum memory that can be enabled for this shape.", - "readOnly": true + "description": "The maximum memory that can be enabled for this shape." }, "minMemoryPerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum memory that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum memory that need be allocated per node for this shape." }, "availableDbNodeStorageInGbs": { "type": "integer", "format": "int32", - "description": "The maximum Db Node storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum Db Node storage that can be enabled for this shape." }, "minDbNodeStoragePerNodeInGbs": { "type": "integer", "format": "int32", - "description": "The minimum Db Node storage that need be allocated per node for this shape.", - "readOnly": true + "description": "The minimum Db Node storage that need be allocated per node for this shape." }, "availableDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The maximum DATA storage that can be enabled for this shape.", - "readOnly": true + "description": "The maximum DATA storage that can be enabled for this shape." }, "minDataStorageInTbs": { "type": "integer", "format": "int32", - "description": "The minimum data storage that need be allocated for this shape.", - "readOnly": true + "description": "The minimum data storage that need be allocated for this shape." }, "minimumNodeCount": { "type": "integer", "format": "int32", - "description": "The minimum number of database nodes available for this shape.", - "readOnly": true + "description": "The minimum number of database nodes available for this shape." }, "maximumNodeCount": { "type": "integer", "format": "int32", - "description": "The maximum number of database nodes available for this shape.", - "readOnly": true + "description": "The maximum number of database nodes available for this shape." }, "availableCoreCountPerNode": { "type": "integer", "format": "int32", - "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes.", - "readOnly": true + "description": "The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes." } - } + }, + "required": [ + "availableCoreCount" + ] }, "DisasterRecoveryType": { "type": "string", @@ -7851,47 +7820,49 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the view", - "readOnly": true + "description": "The OCID of the view" }, "displayName": { "type": "string", - "description": "The display name of the view resource", - "readOnly": true + "description": "The display name of the view resource" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateViewsLifecycleState", - "description": "Views lifecycleState", - "readOnly": true + "description": "Views lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeCreated" }, "timeUpdated": { "type": "string", "format": "date-time", - "description": "views timeCreated", - "readOnly": true + "description": "views timeUpdated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "displayName", + "isProtected", + "lifecycleState", + "self", + "timeCreated", + "timeUpdated" + ] }, "DnsPrivateViewsLifecycleState": { "type": "string", @@ -7972,57 +7943,58 @@ "properties": { "ocid": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the Zone", - "readOnly": true + "description": "The OCID of the Zone" }, "isProtected": { "type": "boolean", - "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.", - "readOnly": true + "description": "A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed." }, "lifecycleState": { "$ref": "#/definitions/DnsPrivateZonesLifecycleState", - "description": "Zones lifecycleState", - "readOnly": true + "description": "Zones lifecycleState" }, "self": { "type": "string", - "description": "The canonical absolute URL of the resource.", - "readOnly": true + "description": "The canonical absolute URL of the resource." }, "serial": { "type": "integer", "format": "int32", - "description": "The current serial of the zone. As seen in the zone's SOA record.", - "readOnly": true + "description": "The current serial of the zone. As seen in the zone's SOA record." }, "version": { "type": "string", - "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived.", - "readOnly": true + "description": "Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived." }, "viewId": { "$ref": "#/definitions/Ocid", - "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.", - "readOnly": true + "description": "The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view." }, "zoneType": { "$ref": "#/definitions/ZoneType", - "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones.", - "readOnly": true + "description": "The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones." }, "timeCreated": { "type": "string", "format": "date-time", - "description": "Zones timeCreated", - "readOnly": true + "description": "Zones timeCreated" }, "provisioningState": { "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState", "description": "Azure resource provisioning state.", "readOnly": true } - } + }, + "required": [ + "ocid", + "isProtected", + "lifecycleState", + "self", + "serial", + "version", + "zoneType", + "timeCreated" + ] }, "DnsPrivateZonesLifecycleState": { "type": "string", @@ -8221,10 +8193,12 @@ "type": "string", "description": "A valid Oracle Grid Infrastructure (GI) software version.", "minLength": 1, - "maxLength": 255, - "readOnly": true + "maxLength": 255 } - } + }, + "required": [ + "version" + ] }, "HostFormatType": { "type": "string", @@ -9537,10 +9511,12 @@ "properties": { "systemVersion": { "type": "string", - "description": "A valid Oracle System Version", - "readOnly": true + "description": "A valid Oracle System Version" } - } + }, + "required": [ + "systemVersion" + ] }, "SystemVersionsFilter": { "type": "object", diff --git a/specification/oracle/resource-manager/sdk-suppressions.yaml b/specification/oracle/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..abb3320b65e8 --- /dev/null +++ b/specification/oracle/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,10 @@ +suppressions: + azure-sdk-for-js: + - package: "@azure/arm-oracledatabase" + breaking-changes: + - Parameter displayName of interface DnsPrivateViewProperties is now required + - Parameter lifecycleState of interface DbNodeProperties is now required + - Parameter lifecycleState of interface DnsPrivateViewProperties is now required + - Parameter lifecycleState of interface DnsPrivateZoneProperties is now required + - Parameter timeCreated of interface DbNodeProperties is now required + - Parameter vnicId of interface DbNodeProperties is now required \ No newline at end of file From 06dbd784b9a8ebecfb231280dabbfcbea920c05e Mon Sep 17 00:00:00 2001 From: ymohammedMS <140201188+ymohammedMS@users.noreply.github.com> Date: Wed, 9 Oct 2024 09:48:29 -0700 Subject: [PATCH 074/101] Update Swagger for New Remediations API (#30767) * Copy base api-versions * Make changes for 2024-10 api version * Fix broken path * Change api versions in remediations examples to 2024-10-01 --- .../stable/2024-10-01/attestations.json | 791 +++++++ .../2024-10-01/checkPolicyRestrictions.json | 474 ++++ .../2024-10-01/componentPolicyStates.json | 843 ++++++++ ...Attestations_CreateResourceGroupScope.json | 102 + .../Attestations_CreateResourceScope.json | 101 + .../Attestations_CreateSubscriptionScope.json | 59 + ...CreateSubscriptionScope_AllProperties.json | 101 + ...Attestations_DeleteResourceGroupScope.json | 16 + .../Attestations_DeleteResourceScope.json | 15 + .../Attestations_DeleteSubscriptionScope.json | 15 + .../Attestations_GetResourceGroupScope.json | 46 + .../Attestations_GetResourceScope.json | 45 + .../Attestations_GetSubscriptionScope.json | 45 + .../Attestations_ListResourceGroupScope.json | 68 + ...ions_ListResourceGroupScope_WithQuery.json | 51 + .../Attestations_ListResourceScope.json | 67 + ...estations_ListResourceScope_WithQuery.json | 50 + .../Attestations_ListSubscriptionScope.json | 67 + ...tions_ListSubscriptionScope_WithQuery.json | 50 + ...PolicyStates_QueryNestedResourceScope.json | 88 + ...sourceGroupLevelPolicyAssignmentScope.json | 92 + ...tPolicyStates_QueryResourceGroupScope.json | 90 + ...copeGroupByComponentTypeWithAggregate.json | 30 + ...ponentPolicyStates_QueryResourceScope.json | 89 + ...rceScopeExpandPolicyEvaluationDetails.json | 97 + ...QueryResourceScopeFilterByComponentId.json | 90 + ...copeGroupByComponentTypeWithAggregate.json | 29 + ...ubscriptionLevelPolicyAssignmentScope.json | 90 + ...ubscriptionLevelPolicyDefinitionScope.json | 86 + ...ntPolicyStates_QuerySubscriptionScope.json | 89 + ...copeGroupByComponentTypeWithAggregate.json | 29 + .../examples/Operations_ListOperations.json | 50 + .../PolicyEvents_FilterAndAggregateOnly.json | 25 + ...yEvents_FilterAndGroupByWithAggregate.json | 39 + ...ents_FilterAndGroupByWithoutAggregate.json | 37 + .../PolicyEvents_FilterAndMultipleGroups.json | 64 + ...olicyEvents_QueryManagementGroupScope.json | 83 + ...nts_QueryManagementGroupScopeNextLink.json | 84 + ...ManagementGroupScopeNextLinkSkipToken.json | 82 + ...PolicyEvents_QueryNestedResourceScope.json | 82 + ...sourceGroupLevelPolicyAssignmentScope.json | 85 + ...oupLevelPolicyAssignmentScopeNextLink.json | 86 + .../PolicyEvents_QueryResourceGroupScope.json | 83 + ...vents_QueryResourceGroupScopeNextLink.json | 84 + .../PolicyEvents_QueryResourceScope.json | 82 + ...ts_QueryResourceScopeExpandComponents.json | 71 + ...eExpandComponentsGroupByWithAggregate.json | 59 + ...licyEvents_QueryResourceScopeNextLink.json | 83 + ...ySubscriptionLevelNestedResourceScope.json | 82 + ...ubscriptionLevelPolicyAssignmentScope.json | 84 + ...ionLevelPolicyAssignmentScopeNextLink.json | 85 + ...ubscriptionLevelPolicyDefinitionScope.json | 84 + ...ionLevelPolicyDefinitionScopeNextLink.json | 85 + ...criptionLevelPolicySetDefinitionScope.json | 84 + ...LevelPolicySetDefinitionScopeNextLink.json | 85 + ...s_QuerySubscriptionLevelResourceScope.json | 82 + .../PolicyEvents_QuerySubscriptionScope.json | 82 + ...Events_QuerySubscriptionScopeNextLink.json | 83 + .../PolicyEvents_TimeRangeSortSelectTop.json | 42 + .../examples/PolicyMetadata_GetResource.json | 26 + .../examples/PolicyMetadata_List.json | 27 + .../examples/PolicyMetadata_List_WithTop.json | 28 + ...trictions_CheckAtManagementGroupScope.json | 45 + ...estrictions_CheckAtResourceGroupScope.json | 148 ++ ...tResourceGroupScopeIncludeAuditEffect.json | 150 ++ ...Restrictions_CheckAtSubscriptionScope.json | 147 ++ ...AtSubscriptionScopeIncludeAuditEffect.json | 149 ++ .../PolicyStates_FilterAndAggregateOnly.json | 25 + ...yStates_FilterAndGroupByWithAggregate.json | 40 + ...ates_FilterAndGroupByWithoutAggregate.json | 37 + .../PolicyStates_FilterAndMultipleGroups.json | 111 + ...olicyStates_QueryManagementGroupScope.json | 91 + ...tes_QueryManagementGroupScopeNextLink.json | 86 + ...ManagementGroupScopeNextLinkSkipToken.json | 83 + ...PolicyStates_QueryNestedResourceScope.json | 90 + ...sourceGroupLevelPolicyAssignmentScope.json | 93 + ...oupLevelPolicyAssignmentScopeNextLink.json | 88 + .../PolicyStates_QueryResourceGroupScope.json | 91 + ...tates_QueryResourceGroupScopeNextLink.json | 86 + .../PolicyStates_QueryResourceScope.json | 90 + ...es_QueryResourceScopeExpandComponents.json | 86 + ...eExpandComponentsGroupByWithAggregate.json | 59 + ...rceScopeExpandPolicyEvaluationDetails.json | 127 ++ ...licyStates_QueryResourceScopeNextLink.json | 85 + ...ySubscriptionLevelNestedResourceScope.json | 90 + ...ubscriptionLevelPolicyAssignmentScope.json | 92 + ...ionLevelPolicyAssignmentScopeNextLink.json | 87 + ...ubscriptionLevelPolicyDefinitionScope.json | 92 + ...ionLevelPolicyDefinitionScopeNextLink.json | 87 + ...criptionLevelPolicySetDefinitionScope.json | 92 + ...LevelPolicySetDefinitionScopeNextLink.json | 87 + ...s_QuerySubscriptionLevelResourceScope.json | 90 + .../PolicyStates_QuerySubscriptionScope.json | 90 + ...States_QuerySubscriptionScopeNextLink.json | 85 + ...yStates_SummarizeManagementGroupScope.json | 54 + ...sourceGroupLevelPolicyAssignmentScope.json | 151 ++ ...icyStates_SummarizeResourceGroupScope.json | 247 +++ .../PolicyStates_SummarizeResourceScope.json | 241 +++ ...ubscriptionLevelPolicyAssignmentScope.json | 252 +++ ...ubscriptionLevelPolicyDefinitionScope.json | 419 ++++ ...criptionLevelPolicySetDefinitionScope.json | 51 + ...licyStates_SummarizeSubscriptionScope.json | 603 ++++++ ...marizeSubscriptionScopeForPolicyGroup.json | 184 ++ .../PolicyStates_TimeRangeSortSelectTop.json | 46 + ...States_TriggerResourceGroupEvaluation.json | 18 + ...yStates_TriggerSubscriptionEvaluation.json | 17 + ...mediations_CancelManagementGroupScope.json | 45 + ...Remediations_CancelResourceGroupScope.json | 45 + .../Remediations_CancelResourceScope.json | 44 + .../Remediations_CancelSubscriptionScope.json | 44 + ...mediations_CreateManagementGroupScope.json | 67 + ...Remediations_CreateResourceGroupScope.json | 75 + .../Remediations_CreateResourceScope.json | 74 + .../Remediations_CreateSubscriptionScope.json | 74 + ...CreateSubscriptionScope_AllProperties.json | 99 + ...teSubscriptionScope_ResourceIdsFilter.json | 135 ++ ...mediations_DeleteManagementGroupScope.json | 48 + ...Remediations_DeleteResourceGroupScope.json | 48 + .../Remediations_DeleteResourceScope.json | 47 + .../Remediations_DeleteSubscriptionScope.json | 47 + .../Remediations_GetManagementGroupScope.json | 45 + .../Remediations_GetResourceGroupScope.json | 45 + .../Remediations_GetResourceScope.json | 44 + .../Remediations_GetSubscriptionScope.json | 44 + ...s_ListDeploymentsManagementGroupScope.json | 33 + ...ons_ListDeploymentsResourceGroupScope.json | 33 + ...diations_ListDeploymentsResourceScope.json | 24 + ...ions_ListDeploymentsSubscriptionScope.json | 32 + ...Remediations_ListManagementGroupScope.json | 75 + ...ns_ListManagementGroupScope_WithQuery.json | 50 + .../Remediations_ListResourceGroupScope.json | 75 + ...ions_ListResourceGroupScope_WithQuery.json | 77 + .../Remediations_ListResourceScope.json | 47 + ...ediations_ListResourceScope_WithQuery.json | 49 + .../Remediations_ListSubscriptionScope.json | 79 + ...tions_ListSubscriptionScope_WithQuery.json | 78 + .../stable/2024-10-01/operations.json | 137 ++ .../stable/2024-10-01/policyEvents.json | 1140 ++++++++++ .../stable/2024-10-01/policyMetadata.json | 325 +++ .../stable/2024-10-01/policyStates.json | 1923 +++++++++++++++++ .../stable/2024-10-01/remediations.json | 1454 +++++++++++++ .../policyinsights/resource-manager/readme.md | 18 +- 142 files changed, 17943 insertions(+), 1 deletion(-) create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/attestations.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/checkPolicyRestrictions.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/componentPolicyStates.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope_AllProperties.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryNestedResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Operations_ListOperations.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndAggregateOnly.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndMultipleGroups.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLinkSkipToken.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryNestedResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponents.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponentsGroupByWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_TimeRangeSortSelectTop.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_GetResource.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List_WithTop.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScopeIncludeAuditEffect.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScopeIncludeAuditEffect.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndAggregateOnly.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndMultipleGroups.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLinkSkipToken.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryNestedResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponents.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponentsGroupByWithAggregate.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScopeForPolicyGroup.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TimeRangeSortSelectTop.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerResourceGroupEvaluation.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerSubscriptionEvaluation.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_AllProperties.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_ResourceIdsFilter.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope_WithQuery.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/operations.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyEvents.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyMetadata.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyStates.json create mode 100644 specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/remediations.json diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/attestations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/attestations.json new file mode 100644 index 000000000000..19cf7baaddee --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/attestations.json @@ -0,0 +1,791 @@ +{ + "swagger": "2.0", + "info": { + "title": "AttestationsClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/attestations": { + "get": { + "operationId": "Attestations_ListForSubscription", + "description": "Gets all attestations for the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestations.", + "schema": { + "$ref": "#/definitions/AttestationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List attestations at subscription scope": { + "$ref": "./examples/Attestations_ListSubscriptionScope.json" + }, + "List attestations at subscription scope with query parameters": { + "$ref": "./examples/Attestations_ListSubscriptionScope_WithQuery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}": { + "put": { + "operationId": "Attestations_CreateOrUpdateAtSubscription", + "description": "Creates or updates an attestation at subscription scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Attestation" + }, + "description": "The attestation parameters." + } + ], + "responses": { + "200": { + "description": "The updated attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "201": { + "description": "The created attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create attestation at subscription scope": { + "$ref": "./examples/Attestations_CreateSubscriptionScope.json" + }, + "Create attestation at subscription scope with all properties": { + "$ref": "./examples/Attestations_CreateSubscriptionScope_AllProperties.json" + } + } + }, + "get": { + "operationId": "Attestations_GetAtSubscription", + "description": "Gets an existing attestation at subscription scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get attestation at subscription scope": { + "$ref": "./examples/Attestations_GetSubscriptionScope.json" + } + } + }, + "delete": { + "operationId": "Attestations_DeleteAtSubscription", + "description": "Deletes an existing attestation at subscription scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The attestation was successfully deleted." + }, + "204": { + "description": "The attestation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete attestation at subscription scope": { + "$ref": "./examples/Attestations_DeleteSubscriptionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/attestations": { + "get": { + "operationId": "Attestations_ListForResourceGroup", + "description": "Gets all attestations for the resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestations.", + "schema": { + "$ref": "#/definitions/AttestationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List attestations at resource group scope": { + "$ref": "./examples/Attestations_ListResourceGroupScope.json" + }, + "List attestations at resource group scope with query parameters": { + "$ref": "./examples/Attestations_ListResourceGroupScope_WithQuery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/attestations/{attestationName}": { + "put": { + "operationId": "Attestations_CreateOrUpdateAtResourceGroup", + "description": "Creates or updates an attestation at resource group scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Attestation" + }, + "description": "The attestation parameters." + } + ], + "responses": { + "200": { + "description": "The updated attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "201": { + "description": "The created attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create attestation at resource group scope": { + "$ref": "./examples/Attestations_CreateResourceGroupScope.json" + } + } + }, + "get": { + "operationId": "Attestations_GetAtResourceGroup", + "description": "Gets an existing attestation at resource group scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get attestation at resource group scope": { + "$ref": "./examples/Attestations_GetResourceGroupScope.json" + } + } + }, + "delete": { + "operationId": "Attestations_DeleteAtResourceGroup", + "description": "Deletes an existing attestation at resource group scope.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The attestation was successfully deleted." + }, + "204": { + "description": "The attestation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete attestation at resource group scope": { + "$ref": "./examples/Attestations_DeleteResourceGroupScope.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/attestations": { + "get": { + "operationId": "Attestations_ListForResource", + "description": "Gets all attestations for a resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestations.", + "schema": { + "$ref": "#/definitions/AttestationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List attestations at individual resource scope": { + "$ref": "./examples/Attestations_ListResourceScope.json" + }, + "List attestations at individual resource scope with query parameters": { + "$ref": "./examples/Attestations_ListResourceScope_WithQuery.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}": { + "put": { + "operationId": "Attestations_CreateOrUpdateAtResource", + "description": "Creates or updates an attestation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Attestation" + }, + "description": "The attestation parameters." + } + ], + "responses": { + "200": { + "description": "The updated attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "201": { + "description": "The created attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create attestation at individual resource scope": { + "$ref": "./examples/Attestations_CreateResourceScope.json" + } + } + }, + "get": { + "operationId": "Attestations_GetAtResource", + "description": "Gets an existing attestation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved attestation.", + "schema": { + "$ref": "#/definitions/Attestation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get attestation at individual resource scope": { + "$ref": "./examples/Attestations_GetResourceScope.json" + } + } + }, + "delete": { + "operationId": "Attestations_DeleteAtResource", + "description": "Deletes an existing attestation at individual resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/attestationNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The attestation was successfully deleted." + }, + "204": { + "description": "The attestation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete attestation at individual resource scope": { + "$ref": "./examples/Attestations_DeleteResourceScope.json" + } + } + } + } + }, + "definitions": { + "AttestationListResult": { + "description": "List of attestations.", + "properties": { + "value": { + "description": "Array of attestation definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/Attestation" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + } + }, + "Attestation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttestationProperties", + "description": "Properties for the attestation." + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "An attestation resource." + }, + "AttestationProperties": { + "properties": { + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment that the attestation is setting the state for." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The policy definition reference ID from a policy set definition that the attestation is setting the state for. If the policy assignment assigns a policy set definition the attestation can choose a definition within the set definition with this property or omit this and set the state for the entire set definition." + }, + "complianceState": { + "type": "string", + "enum": [ + "Compliant", + "NonCompliant", + "Unknown" + ], + "x-ms-enum": { + "name": "ComplianceState", + "modelAsString": true, + "values": [ + { + "value": "Compliant", + "description": "The resource is in compliance with the policy." + }, + { + "value": "NonCompliant", + "description": "The resource is not in compliance with the policy." + }, + { + "value": "Unknown", + "description": "The compliance state of the resource is not known." + } + ] + }, + "description": "The compliance state that should be set on the resource." + }, + "expiresOn": { + "type": "string", + "format": "date-time", + "description": "The time the compliance state should expire." + }, + "owner": { + "type": "string", + "description": "The person responsible for setting the state of the resource. This value is typically an Azure Active Directory object ID." + }, + "comments": { + "type": "string", + "description": "Comments describing why this attestation was created." + }, + "evidence": { + "type": "array", + "items": { + "$ref": "#/definitions/AttestationEvidence" + }, + "x-ms-identifiers": [], + "description": "The evidence supporting the compliance state set in this attestation." + }, + "provisioningState": { + "type": "string", + "description": "The status of the attestation.", + "readOnly": true + }, + "lastComplianceStateChangeAt": { + "type": "string", + "format": "date-time", + "description": "The time the compliance state was last changed in this attestation.", + "readOnly": true + }, + "assessmentDate": { + "type": "string", + "format": "date-time", + "description": "The time the evidence was assessed" + }, + "metadata": { + "type": "object", + "description": "Additional metadata for this attestation" + } + }, + "required": [ + "policyAssignmentId" + ], + "description": "The properties of an attestation resource." + }, + "AttestationEvidence": { + "properties": { + "description": { + "type": "string", + "description": "The description for this piece of evidence." + }, + "sourceUri": { + "type": "string", + "description": "The URI location of the evidence." + } + }, + "description": "A piece of evidence supporting the compliance state set in the attestation." + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "additionalInfo": { + "description": "Additional scenario specific error details.", + "type": "array", + "items": { + "$ref": "#/definitions/TypedErrorInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "TypedErrorInfo": { + "description": "Scenario specific error details.", + "properties": { + "type": { + "description": "The type of included error details.", + "type": "string", + "readOnly": true + }, + "info": { + "description": "The scenario specific error details.", + "readOnly": true + } + } + } + }, + "parameters": { + "attestationNameParameter": { + "name": "attestationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the attestation.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/checkPolicyRestrictions.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/checkPolicyRestrictions.json new file mode 100644 index 000000000000..19a42afeaa2b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/checkPolicyRestrictions.json @@ -0,0 +1,474 @@ +{ + "swagger": "2.0", + "info": { + "title": "CheckPolicyRestrictionsClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions": { + "post": { + "operationId": "PolicyRestrictions_CheckAtSubscriptionScope", + "description": "Checks what restrictions Azure Policy will place on a resource within a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckRestrictionsRequest" + }, + "description": "The check policy restrictions parameters." + } + ], + "responses": { + "200": { + "description": "The restrictions that will be placed on the resource by Azure Policy.", + "schema": { + "$ref": "#/definitions/CheckRestrictionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check policy restrictions at subscription scope": { + "$ref": "./examples/PolicyRestrictions_CheckAtSubscriptionScope.json" + }, + "Check policy restrictions at subscription scope including audit effect": { + "$ref": "./examples/PolicyRestrictions_CheckAtSubscriptionScopeIncludeAuditEffect.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions": { + "post": { + "operationId": "PolicyRestrictions_CheckAtResourceGroupScope", + "description": "Checks what restrictions Azure Policy will place on a resource within a resource group. Use this when the resource group the resource will be created in is already known.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckRestrictionsRequest" + }, + "description": "The check policy restrictions parameters." + } + ], + "responses": { + "200": { + "description": "The restrictions that will be placed on the resource by Azure Policy.", + "schema": { + "$ref": "#/definitions/CheckRestrictionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check policy restrictions at resource group scope": { + "$ref": "./examples/PolicyRestrictions_CheckAtResourceGroupScope.json" + }, + "Check policy restrictions at resource group scope including audit effect": { + "$ref": "./examples/PolicyRestrictions_CheckAtResourceGroupScopeIncludeAuditEffect.json" + } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/checkPolicyRestrictions": { + "post": { + "operationId": "PolicyRestrictions_CheckAtManagementGroupScope", + "description": "Checks what restrictions Azure Policy will place on resources within a management group.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckManagementGroupRestrictionsRequest" + }, + "description": "The check policy restrictions parameters." + } + ], + "responses": { + "200": { + "description": "The restrictions that will be placed on the resource by Azure Policy.", + "schema": { + "$ref": "#/definitions/CheckRestrictionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check policy restrictions at management group scope": { + "$ref": "./examples/PolicyRestrictions_CheckAtManagementGroupScope.json" + } + } + } + } + }, + "definitions": { + "CheckRestrictionsRequest": { + "description": "The check policy restrictions parameters describing the resource that is being evaluated.", + "properties": { + "resourceDetails": { + "description": "The information about the resource that will be evaluated.", + "$ref": "#/definitions/CheckRestrictionsResourceDetails" + }, + "pendingFields": { + "description": "The list of fields and values that should be evaluated for potential restrictions.", + "type": "array", + "items": { + "$ref": "#/definitions/PendingField" + } + }, + "includeAuditEffect": { + "description": "Whether to include policies with the 'audit' effect in the results. Defaults to false.", + "type": "boolean", + "default": false + } + }, + "required": [ + "resourceDetails" + ] + }, + "CheckManagementGroupRestrictionsRequest": { + "type": "object", + "description": "The check policy restrictions parameters describing the resource that is being evaluated.", + "properties": { + "resourceDetails": { + "description": "The information about the resource that will be evaluated.", + "$ref": "#/definitions/CheckRestrictionsResourceDetails" + }, + "pendingFields": { + "description": "The list of fields and values that should be evaluated for potential restrictions.", + "type": "array", + "items": { + "$ref": "#/definitions/PendingField" + }, + "x-ms-identifiers": [] + } + } + }, + "CheckRestrictionsResourceDetails": { + "description": "The information about the resource that will be evaluated.", + "properties": { + "resourceContent": { + "description": "The resource content. This should include whatever properties are already known and can be a partial set of all resource properties.", + "type": "object" + }, + "apiVersion": { + "description": "The api-version of the resource content.", + "type": "string" + }, + "scope": { + "description": "The scope where the resource is being created. For example, if the resource is a child resource this would be the parent resource's resource ID.", + "type": "string" + } + }, + "required": [ + "resourceContent" + ] + }, + "PendingField": { + "description": "A field that should be evaluated against Azure Policy to determine restrictions.", + "properties": { + "field": { + "description": "The name of the field. This can be a top-level property like 'name' or 'type' or an Azure Policy field alias.", + "type": "string" + }, + "values": { + "description": "The list of potential values for the field that should be evaluated against Azure Policy.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "field" + ] + }, + "CheckRestrictionsResult": { + "description": "The result of a check policy restrictions evaluation on a resource.", + "properties": { + "fieldRestrictions": { + "description": "The restrictions that will be placed on various fields in the resource by policy.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldRestrictions" + }, + "readOnly": true + }, + "contentEvaluationResult": { + "description": "Evaluation results for the provided partial resource content.", + "properties": { + "policyEvaluations": { + "description": "Policy evaluation results against the given resource content. This will indicate if the partial content that was provided will be denied as-is.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyEvaluationResult" + } + } + }, + "readOnly": true + } + } + }, + "FieldRestrictions": { + "description": "The restrictions that will be placed on a field in the resource by policy.", + "properties": { + "field": { + "description": "The name of the field. This can be a top-level property like 'name' or 'type' or an Azure Policy field alias.", + "type": "string", + "readOnly": true + }, + "restrictions": { + "description": "The restrictions placed on that field by policy.", + "type": "array", + "items": { + "$ref": "#/definitions/FieldRestriction" + } + } + } + }, + "FieldRestriction": { + "description": "The restrictions on a field imposed by a specific policy.", + "properties": { + "result": { + "description": "The type of restriction that is imposed on the field.", + "type": "string", + "enum": [ + "Required", + "Removed", + "Deny", + "Audit" + ], + "x-ms-enum": { + "name": "FieldRestrictionResult", + "modelAsString": true, + "values": [ + { + "value": "Required", + "description": "The field and/or values are required by policy." + }, + { + "value": "Removed", + "description": "The field will be removed by policy." + }, + { + "value": "Deny", + "description": "The field and/or values will be denied by policy." + }, + { + "value": "Audit", + "description": "The field and/or values will be audited by policy." + } + ] + }, + "readOnly": true + }, + "defaultValue": { + "description": "The value that policy will set for the field if the user does not provide a value.", + "type": "string", + "readOnly": true + }, + "values": { + "description": "The values that policy either requires or denies for the field.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "policy": { + "description": "The details of the policy that is causing the field restriction.", + "$ref": "#/definitions/PolicyReference", + "readOnly": true + }, + "policyEffect": { + "description": "The effect of the policy that is causing the field restriction. http://aka.ms/policyeffects", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "The reason for the restriction.", + "type": "string", + "readOnly": true + } + } + }, + "PolicyEvaluationResult": { + "description": "The result of a non-compliant policy evaluation against the given resource content.", + "properties": { + "policyInfo": { + "description": "The details of the policy that was evaluated.", + "$ref": "#/definitions/PolicyReference", + "readOnly": true + }, + "evaluationResult": { + "description": "The result of the policy evaluation against the resource. This will typically be 'NonCompliant' but may contain other values if errors were encountered.", + "type": "string", + "readOnly": true + }, + "evaluationDetails": { + "description": "The detailed results of the policy expressions and values that were evaluated.", + "$ref": "#/definitions/CheckRestrictionEvaluationDetails", + "readOnly": true + }, + "effectDetails": { + "description": "The details of the effect that was applied to the resource.", + "$ref": "#/definitions/PolicyEffectDetails", + "readOnly": true + } + } + }, + "PolicyReference": { + "description": "Resource identifiers for a policy.", + "properties": { + "policyDefinitionId": { + "description": "The resource identifier of the policy definition.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionId": { + "description": "The resource identifier of the policy set definition.", + "type": "string", + "readOnly": true + }, + "policyDefinitionReferenceId": { + "description": "The reference identifier of a specific policy definition within a policy set definition.", + "type": "string", + "readOnly": true + }, + "policyAssignmentId": { + "description": "The resource identifier of the policy assignment.", + "type": "string", + "readOnly": true + } + } + }, + "PolicyEffectDetails": { + "type": "object", + "description": "The details of the effect that was applied to the resource.", + "properties": { + "policyEffect": { + "description": "The effect that was applied to the resource. http://aka.ms/policyeffects", + "type": "string", + "readOnly": true + } + } + }, + "CheckRestrictionEvaluationDetails": { + "type": "object", + "description": "Policy evaluation details.", + "properties": { + "evaluatedExpressions": { + "description": "Details of the evaluated expressions.", + "type": "array", + "items": { + "$ref": "../../stable/2024-10-01/policyStates.json#/definitions/ExpressionEvaluationDetails" + }, + "x-ms-identifiers": [] + }, + "ifNotExistsDetails": { + "description": "Evaluation details of IfNotExists effect.", + "type": "object", + "$ref": "../../stable/2024-10-01/policyStates.json#/definitions/IfNotExistsEvaluationDetails" + }, + "reason": { + "description": "The reason for the evaluation result.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "Management group ID.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/componentPolicyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/componentPolicyStates.json new file mode 100644 index 000000000000..95253779f02a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/componentPolicyStates.json @@ -0,0 +1,843 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComponentPolicyStatesClient", + "version": "2024-10-01", + "description": "Query component policy states at varying resource scopes for Resource Provider mode policies." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForSubscription", + "description": "Queries component policy states under subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest component policy states at subscription scope": { + "$ref": "./examples/ComponentPolicyStates_QuerySubscriptionScope.json" + }, + "Query latest component policy compliance state count grouped by component type at subscription scope filtered by given assignment.": { + "$ref": "./examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForResourceGroup", + "description": "Queries component policy states under resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest component policy states at resource group scope": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceGroupScope.json" + }, + "Query latest component policy compliance state count grouped by component type at resource group scope filtered by given assignment.": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForResource", + "description": "Queries component policy states for the resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceId" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + }, + { + "$ref": "#/parameters/componentPolicyStatesExpand" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest component policy states at resource scope": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceScope.json" + }, + "Query latest component policy states at resource scope and expand policyEvaluationDetails": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json" + }, + "Query latest component policy compliance state count grouped by component type at resource scope filtered by given assignment.": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json" + }, + "Query latest component policy states at nested resource scope": { + "$ref": "./examples/ComponentPolicyStates_QueryNestedResourceScope.json" + }, + "Query latest component policy compliance state at resource scope filtered by given component id.": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForPolicyDefinition", + "description": "Queries component policy states for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespace" + }, + { + "$ref": "#/parameters/policyDefinitionName" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest component policy states at subscription level policy definition scope": { + "$ref": "./examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForSubscriptionLevelPolicyAssignment", + "description": "Queries component policy states for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespace" + }, + { + "$ref": "#/parameters/policyAssignmentName" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest at subscription level policy assignment scope": { + "$ref": "./examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults": { + "post": { + "operationId": "ComponentPolicyStates_ListQueryResultsForResourceGroupLevelPolicyAssignment", + "description": "Queries component policy states for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/authorizationNamespace" + }, + { + "$ref": "#/parameters/policyAssignmentName" + }, + { + "$ref": "#/parameters/componentPolicyStatesResource" + }, + { + "$ref": "#/parameters/apiVersion" + }, + { + "$ref": "#/parameters/top" + }, + { + "$ref": "#/parameters/orderBy" + }, + { + "$ref": "#/parameters/select" + }, + { + "$ref": "#/parameters/from" + }, + { + "$ref": "#/parameters/to" + }, + { + "$ref": "#/parameters/filter" + }, + { + "$ref": "#/parameters/apply" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/ComponentPolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2024-10-01/policyMetadata.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query latest at resource group level policy assignment scope": { + "$ref": "./examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json" + } + } + } + } + }, + "definitions": { + "ComponentPolicyStatesQueryResults": { + "type": "object", + "description": "Query results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of policy state records returned.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentPolicyState" + }, + "x-ms-identifiers": [] + } + } + }, + "ComponentPolicyState": { + "type": "object", + "description": "Component Policy State record.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since component policy state records do not have an entity ID.", + "type": "string", + "readOnly": true + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string", + "readOnly": true + }, + "timestamp": { + "description": "Timestamp for the component policy state record.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "componentId": { + "description": "Component Id.", + "type": "string", + "readOnly": true + }, + "componentType": { + "description": "Component type.", + "type": "string", + "readOnly": true + }, + "componentName": { + "description": "Component name.", + "type": "string", + "readOnly": true + }, + "resourceId": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string", + "readOnly": true + }, + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "Subscription ID.", + "type": "string", + "readOnly": true + }, + "resourceType": { + "description": "Resource type.", + "type": "string", + "readOnly": true + }, + "resourceLocation": { + "description": "Resource location.", + "type": "string", + "readOnly": true + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string", + "readOnly": true + }, + "policyAssignmentName": { + "description": "Policy assignment name.", + "type": "string", + "readOnly": true + }, + "policyAssignmentOwner": { + "description": "Policy assignment owner.", + "type": "string", + "readOnly": true + }, + "policyAssignmentParameters": { + "description": "Policy assignment parameters.", + "type": "string", + "readOnly": true + }, + "policyAssignmentScope": { + "description": "Policy assignment scope.", + "type": "string", + "readOnly": true + }, + "policyDefinitionName": { + "description": "Policy definition name.", + "type": "string", + "readOnly": true + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string", + "readOnly": true + }, + "policyDefinitionCategory": { + "description": "Policy definition category.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionName": { + "description": "Policy set definition name, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionOwner": { + "description": "Policy set definition owner, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionCategory": { + "description": "Policy set definition category, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionParameters": { + "description": "Policy set definition parameters, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "policyDefinitionReferenceId": { + "description": "Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.", + "type": "string", + "readOnly": true + }, + "complianceState": { + "description": "Compliance state of the resource.", + "type": "string", + "readOnly": true + }, + "policyEvaluationDetails": { + "description": "Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails.", + "type": "object", + "$ref": "#/definitions/ComponentPolicyEvaluationDetails" + }, + "policyDefinitionGroupNames": { + "description": "Policy definition group names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "policyDefinitionVersion": { + "description": "Evaluated policy definition version.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionVersion": { + "description": "Evaluated policy set definition version.", + "type": "string", + "readOnly": true + }, + "policyAssignmentVersion": { + "description": "Evaluated policy assignment version.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "ComponentPolicyEvaluationDetails": { + "type": "object", + "description": "Policy evaluation details.", + "properties": { + "evaluatedExpressions": { + "description": "Details of the evaluated expressions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComponentExpressionEvaluationDetails" + }, + "x-ms-identifiers": [] + }, + "reason": { + "description": "Additional textual reason for the evaluation outcome.", + "type": "string" + } + } + }, + "ComponentExpressionEvaluationDetails": { + "type": "object", + "description": "Evaluation details of policy language expressions.", + "properties": { + "result": { + "description": "Evaluation result.", + "type": "string" + }, + "expression": { + "description": "Expression evaluated.", + "type": "string", + "readOnly": true + }, + "expressionKind": { + "description": "The kind of expression that was evaluated.", + "type": "string", + "readOnly": true + }, + "path": { + "description": "Property path if the expression is a field or an alias.", + "type": "string", + "readOnly": true + }, + "expressionValue": { + "description": "Value of the expression.", + "type": "object", + "readOnly": true + }, + "targetValue": { + "description": "Target value to be compared with the expression value.", + "type": "object", + "readOnly": true + }, + "operator": { + "description": "Operator to compare the expression value and the target value.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "componentPolicyStatesResource": { + "name": "componentPolicyStatesResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "latest" + ], + "x-ms-enum": { + "name": "ComponentPolicyStatesResource", + "modelAsString": true + }, + "description": "The virtual resource under ComponentPolicyStates resource type. In a given time range, 'latest' represents the latest component policy state(s).", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceId": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "authorizationNamespace": { + "name": "authorizationNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Authorization" + ], + "x-ms-enum": { + "name": "AuthorizationNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", + "x-ms-parameter-location": "method" + }, + "policyDefinitionName": { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy definition name.", + "pattern": "^[^<>%&:\\\\?/#]*$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "policyAssignmentName": { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name.", + "pattern": "^[^<>%&:\\\\?/#]*$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "apiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "top": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "Top" + }, + "orderBy": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\".", + "x-ms-parameter-location": "method", + "x-ms-client-name": "OrderBy" + }, + "select": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-client-name": "Select" + }, + "from": { + "name": "$from", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).", + "x-ms-parameter-location": "method", + "x-ms-client-name": "From" + }, + "to": { + "name": "$to", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "To" + }, + "filter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "Filter" + }, + "apply": { + "name": "$apply", + "in": "query", + "required": false, + "type": "string", + "description": "OData apply expression for aggregations.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "Apply" + }, + "componentPolicyStatesExpand": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter.", + "x-ms-parameter-location": "method", + "x-ms-client-name": "Expand" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceGroupScope.json new file mode 100644 index 000000000000..f2fd8c8e3a85 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceGroupScope.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "resourceGroupName": "myRg", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceScope.json new file mode 100644 index 000000000000..6b0feb44f6e4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateResourceScope.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope.json new file mode 100644 index 000000000000..8d475ed26d37 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "complianceState": "Compliant" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope_AllProperties.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope_AllProperties.json new file mode 100644 index 000000000000..24f3a7a486b2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_CreateSubscriptionScope_AllProperties.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceGroupScope.json new file mode 100644 index 000000000000..f547be24d5c3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceGroupScope.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myRg", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceScope.json new file mode 100644 index 000000000000..2badea28f3ef --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteResourceScope.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteSubscriptionScope.json new file mode 100644 index 000000000000..1a2cc791eebf --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_DeleteSubscriptionScope.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e" + }, + "responses": { + "200": { + "headers": {} + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceGroupScope.json new file mode 100644 index 000000000000..efb9210d97b2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceGroupScope.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myRg", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceScope.json new file mode 100644 index 000000000000..658e43b2394b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetResourceScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetSubscriptionScope.json new file mode 100644 index 000000000000..c73102decece --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_GetSubscriptionScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "attestationName": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope.json new file mode 100644 index 000000000000..37b0bcb32368 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myRg", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/090a47f8-13e9-441e-ad90-dc666cc5d487", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "name": "689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope_WithQuery.json new file mode 100644 index 000000000000..b4801d95d46d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceGroupScope_WithQuery.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myRg", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5' AND PolicyDefinitionReferenceId eq '0b158b46-ff42-4799-8e39-08a5c23b4551'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope.json new file mode 100644 index 000000000000..02dd8daee846 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/090a47f8-13e9-441e-ad90-dc666cc5d487", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "name": "689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope_WithQuery.json new file mode 100644 index 000000000000..523d8c10967c --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListResourceScope_WithQuery.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5' AND PolicyDefinitionReferenceId eq '0b158b46-ff42-4799-8e39-08a5c23b4551'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.compute/virtualMachines/devVM/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope.json new file mode 100644 index 000000000000..c29591f660a7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/090a47f8-13e9-441e-ad90-dc666cc5d487", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "34709f31-f267-4eee-8479-0da11925f2f2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myrg/providers/microsoft.policyinsights/attestations/689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "name": "689bfc0c-a012-49fc-af40-3ebea35ff3ed", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope_WithQuery.json new file mode 100644 index 000000000000..992f8dcbd6d3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Attestations_ListSubscriptionScope_WithQuery.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5' AND PolicyDefinitionReferenceId eq '0b158b46-ff42-4799-8e39-08a5c23b4551'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "0b158b46-ff42-4799-8e39-08a5c23b4551", + "complianceState": "Compliant", + "lastComplianceStateChangeAt": "2020-06-15T18:52:27Z", + "expiresOn": "2021-06-15T00:00:00Z", + "owner": "55a32e28-3aa5-4eea-9b5a-4cd85153b966", + "comments": "This subscription has passed a security audit.", + "evidence": [ + { + "description": "The results of the security audit.", + "sourceUri": "https://gist.github.com/contoso/9573e238762c60166c090ae16b814011" + } + ], + "assessmentDate": "2021-06-10T00:00:00Z", + "metadata": { + "departmentId": "NYC-MARKETING-1" + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/attestations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/attestations" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryNestedResourceScope.json new file mode 100644 index 000000000000..f32523a46dd7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryNestedResourceScope.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "isCompliant": true, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults/myVault", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..fb671cbb2852 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json new file mode 100644 index 000000000000..2da1f98fbad9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-2", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-2", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json new file mode 100644 index 000000000000..7a391712a6e7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceGroupScopeGroupByComponentTypeWithAggregate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$apply": "groupby((type,complianceState),aggregate($count as count))" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "componentType": "Certificate", + "complianceState": "NonCompliant", + "count": 26 + }, + { + "componentType": "Certificate", + "complianceState": "Compliant", + "count": 10 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScope.json new file mode 100644 index 000000000000..e597a9bdf48f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScope.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-2", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-2", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json new file mode 100644 index 000000000000..05b6cda7a6b3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster", + "api-version": "2024-10-01", + "$expand": "PolicyEvaluationDetails", + "$filter": "componentType eq 'pod' AND componentId eq 'default/test-pod' AND componentName eq 'test-pod'" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providersMicrosoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "default/test-pod", + "componentType": "pod", + "componentName": "test-pod", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ContainerService/managedClusters", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit Kubernetes policy", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0", + "policyEvaluationDetails": { + "reason": "tbd reason for evaluation outcome" + } + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providersMicrosoft.ContainerService/managedClusters/myCluster/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "default/test-pod", + "componentType": "pod", + "componentName": "test-pod", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ContainerService/managedClusters/myCluster", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test2", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ContainerService/managedClusters", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit Kubernetes policy", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0", + "policyEvaluationDetails": { + "reason": "tbd reason for evaluation outcome" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json new file mode 100644 index 000000000000..984b8052f941 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "componentId eq cert-RSA-cert-3" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test1", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test2", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json new file mode 100644 index 000000000000..0f9bc2eb4685 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "resourceId": "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$apply": "groupby((componentType,complianceState),aggregate($count as count))" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "componentType": "Certificate", + "complianceState": "NonCompliant", + "count": 26 + }, + { + "componentType": "Certificate", + "complianceState": "Compliant", + "count": 10 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..88bc7d2acf8b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": "2124621540977569058", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": "14799174781370023846", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..87159a5f8bd9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json new file mode 100644 index 000000000000..016d9d424839 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScope.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-3", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-3", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df56", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df56", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest/$entity", + "componentId": "cert-RSA-cert-2", + "componentType": "Certificate", + "componentName": "cert-RSA-cert-2", + "timestamp": "2022-04-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.KeyVault/vaults", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "complianceReasonCode": "tbd", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json new file mode 100644 index 000000000000..6c120fc37635 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/ComponentPolicyStates_QuerySubscriptionScopeGroupByComponentTypeWithAggregate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "componentPolicyStatesResource": "latest", + "subscriptionId": "e78961ba-36fe-4739-9212-e3031b4c8db7", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$apply": "groupby((componentType,complianceState),aggregate($count as count))" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/Microsoft.PolicyInsights/componentPolicyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "componentType": "Certificate", + "complianceState": "NonCompliant", + "count": 26 + }, + { + "componentType": "Certificate", + "complianceState": "Compliant", + "count": 10 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Operations_ListOperations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Operations_ListOperations.json new file mode 100644 index 000000000000..0d5ae2858f10 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Operations_ListOperations.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.count": 4, + "value": [ + { + "name": "Microsoft.PolicyInsights/policyEvents/queryResults/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy Events", + "operation": "Query Policy Events", + "description": "Query information about policy events." + } + }, + { + "name": "Microsoft.PolicyInsights/policyStates/queryResults/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy States", + "operation": "Query Policy States", + "description": "Query information about policy states." + } + }, + { + "name": "Microsoft.PolicyInsights/policyStates/summarize/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Policy States", + "operation": "Query Policy Latest States Summary", + "description": "Query summary information about policy latest states." + } + }, + { + "name": "Microsoft.PolicyInsights/componentPolicyStates/queryResults/action", + "display": { + "provider": "Microsoft Policy Insights", + "resource": "Component Policy States", + "operation": "Query Component Policy States", + "description": "Query information about component policy states." + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndAggregateOnly.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndAggregateOnly.json new file mode 100644 index 000000000000..62f0beb2fa4d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndAggregateOnly.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2018-02-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "aggregate($count as NumDenyEvents)" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "NumDenyEvents": 40 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithAggregate.json new file mode 100644 index 000000000000..20f2f2c70a9d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithAggregate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2018-02-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate($count as NumEvents))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService", + "NumEvents": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d6be6bb37e5f4333baa95c2a", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/5948d091-78b7-4d3b-a404-cc6a0329b0c6", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/resourcescachemonitor/services/myService", + "NumEvents": 1 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json new file mode 100644 index 000000000000..db58b331e6f2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2018-01-05T18:00:00Z", + "$filter": "PolicyDefinitionAction ne 'audit' and PolicyDefinitionAction ne 'append'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "policyDefinitionAction": "deny", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.storage/storageaccounts/7d528d3a" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "policyDefinitionAction": "deny", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/mysa1" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndMultipleGroups.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndMultipleGroups.json new file mode 100644 index 000000000000..f85fd59d1b51 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_FilterAndMultipleGroups.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2018-01-01T00:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, ResourceId))/groupby((PolicyAssignmentId, PolicyDefinitionId), aggregate($count as NumDeniedResources))", + "$orderby": "NumDeniedResources desc", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 6, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/0591f497c35344fcbaf7a393", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/e56962a6-4747-49cd-b67b-bf8b01975c4c", + "NumDeniedResources": 3 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition1", + "NumDeniedResources": 2 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup1/providers/microsoft.authorization/policyassignments/myassignment1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition2", + "NumDeniedResources": 2 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/5bc427ca-0089-4d0d-85bd-e98d1e40b3bf/providers/microsoft.authorization/policyassignments/storageaccountsku", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/7433c107-6db4-4ad1-b57a-a76dce0154a1", + "NumDeniedResources": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/da43b50031bf4bce84584faa", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/1e30110a-5ceb-460c-a204-c1c3969c6d62", + "NumDeniedResources": 1 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/myassignment2", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/mydefinition3", + "NumDeniedResources": 1 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScope.json new file mode 100644 index 000000000000..aec8e26a3d29 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScope.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "policyEventsResource": "default", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/95816fce53454b15a7ed803d", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/a2c0414b-82e4-459d-97d5-94c79a89232c", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "95816fce53454b15a7ed803d", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"eastus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "a2c0414b-82e4-459d-97d5-94c79a89232c", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json new file mode 100644 index 000000000000..2eca7a3bd714 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "policyEventsResource": "default", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/95816fce53454b15a7ed803d", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/a2c0414b-82e4-459d-97d5-94c79a89232c", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "95816fce53454b15a7ed803d", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"eastus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "a2c0414b-82e4-459d-97d5-94c79a89232c", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLinkSkipToken.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLinkSkipToken.json new file mode 100644 index 000000000000..03da6ac182e4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLinkSkipToken.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD", + "nextLink": "{nextLink}" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T22:19:18.8896095Z", + "resourceId": "/subscriptions/fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef/resourceGroups/myrg/providers/Microsoft.Compute/virtualMachines/myvm1/extensions/DAExtension", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/95816fce53454b15a7ed803d", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/a2c0414b-82e4-459d-97d5-94c79a89232c", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff8dfdb-fff3-fff0-fff4-fffdcbe6b2ef", + "resourceType": "/Microsoft.Compute/virtualMachines/extensions", + "resourceLocation": "westeurope", + "resourceGroup": "myrg", + "resourceTags": "tbd", + "policyAssignmentName": "95816fce53454b15a7ed803d", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"eastus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "a2c0414b-82e4-459d-97d5-94c79a89232c", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff3e452-fff2-fff1-fff8-fff12618f1b8", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryNestedResourceScope.json new file mode 100644 index 000000000000..c2eabe106be6 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryNestedResourceScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/microsoft.servicefabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..cc3f50824409 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:07:16.2804863Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:06:08.4302267Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json new file mode 100644 index 000000000000..5aedba305f9a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:07:16.2804863Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T00:06:08.4302267Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.operationalinsights/workspaces/defaultworkspace-fffedd8f-ffff-fffd-fffd-fffed2f84852-eus", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyDefinitions/myPolicyDefinition", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.operationalinsights/workspaces", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": null, + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup", + "policyDefinitionName": "myPolicyAssignment", + "policyDefinitionAction": "deny", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff2f355-fff2-fffc-fffb-fff1639dff94", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScope.json new file mode 100644 index 000000000000..c4e33eef9212 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScope.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json new file mode 100644 index 000000000000..fc018ccab47b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScope.json new file mode 100644 index 000000000000..3851caaa1bd8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.8473851Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.5842458Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponents.json new file mode 100644 index 000000000000..7e80cf0c8d63 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponents.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$expand": "components" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2020-02-21T19:42:08.3252921Z", + "resourceId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName", + "policyAssignmentId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8", + "policyDefinitionId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policydefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "effectiveParameters": "", + "isCompliant": false, + "subscriptionId": "e78961ba-36fe-4739-9212-e3031b4c8db7", + "resourceType": "Microsoft.KeyVault/vaults", + "resourceLocation": "westcentralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "560050f83dbb4a24974323f8", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "", + "policyAssignmentScope": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": "", + "policySetDefinitionCategory": "", + "policySetDefinitionParameters": "", + "managementGroupIds": "PolicyUIMG,AzGovTest5,72f988bf-86f1-41af-91ab-2d7cd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "tenantId": "", + "principalOid": "", + "components": [ + { + "id": "cert-RSA-cert-3", + "type": "Certificate", + "name": "cert-RSA-cert-3", + "timestamp": "2020-02-21T17:45:23.0367Z", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "principalOid": "0d81b461-6bb0-4909-a102-d51803a7d275", + "policyDefinitionAction": "audit" + }, + { + "id": "cert-RSA-cert-2", + "type": "Certificate", + "name": "cert-RSA-cert-2", + "timestamp": "2020-02-21T17:45:22.7682778Z", + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "principalOid": "0d81b461-6bb0-4909-a102-d51803a7d275", + "policyDefinitionAction": "audit" + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponentsGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponentsGroupByWithAggregate.json new file mode 100644 index 000000000000..fffa4a71c1f4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeExpandComponentsGroupByWithAggregate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$expand": "components($apply=groupby((tenantId, principalOid, policyDefinitionAction), aggregate($count as totalActions)))" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2020-02-21T19:42:08.3252921Z", + "resourceId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName", + "policyAssignmentId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8", + "policyDefinitionId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policydefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "effectiveParameters": "", + "isCompliant": false, + "subscriptionId": "e78961ba-36fe-4739-9212-e3031b4c8db7", + "resourceType": "Microsoft.KeyVault/vaults", + "resourceLocation": "westcentralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "560050f83dbb4a24974323f8", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "", + "policyAssignmentScope": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": "", + "policySetDefinitionCategory": "", + "policySetDefinitionParameters": "", + "managementGroupIds": "PolicyUIMG,AzGovTest5,72f988bf-86f1-41af-91ab-2d7cd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "tenantId": "", + "principalOid": "", + "components": [ + { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "principalOid": "0d81b461-6bb0-4909-a102-d51803a7d275", + "policyDefinitionAction": "audit", + "totalActions": 6 + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json new file mode 100644 index 000000000000..6381d00dbf08 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.8473851Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.5842458Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json new file mode 100644 index 000000000000..b4b698e641c5 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..0891278698d4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:38.6401747Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:34.2017762Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json new file mode 100644 index 000000000000..fa12834a5ca3 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:38.6401747Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:59:34.2017762Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..2bbde5f16705 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "1679708035638239273", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json new file mode 100644 index 000000000000..d0d4cc5ca97f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:58:11.590596Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/deploymentSlots/production/state/start", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/f4cc58b7db524a9799381531", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/deploymentSlots/state", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "f4cc58b7db524a9799381531", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"NA\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "1679708035638239273", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..cc62f7550b88 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9539023Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFFBDAF1FFFF109FFFD95FFFC9B0FFFD6F264FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9498186Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFF36C1CFFF4BEA57FFFEFCFFF17B9F81B710FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json new file mode 100644 index 000000000000..9b7b63da456f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9539023Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFFBDAF1FFFF109FFFD95FFFC9B0FFFD6F264FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-08T19:49:32.9498186Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/serviceCertificates/sha1-FFF36C1CFFF4BEA57FFFEFCFFF17B9F81B710FFF", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ClassicCompute/domainNames/serviceCertificates", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json new file mode 100644 index 000000000000..ec7c83becca2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.8473851Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T15:14:39.5842458Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "d15545b8-ff50-409a-a6e3-5bd5cc954003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "201ea587-7c90-41c3-910f-c280ae01cfd6", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fff890fa-fff0-fff3-fff9-fffd7653f078", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScope.json new file mode 100644 index 000000000000..2c894918ad85 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScope.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json new file mode 100644 index 000000000000..9f8bce89dd59 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "181565554491747128", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-07T20:43:04.6971328Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/ec62f9b2a454487296f2ccd4", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec62f9b2a454487296f2ccd4", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"ALLOWEDRESOURCEGROUPS_1\":{\"value\":[\"rg1\",\"rg2\"]},\"ALLOWEDRESOURCEGROUPS_2\":{\"value\":[\"myrg3\",\"myrg4\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionName": "00b36c66-612b-44e2-9f8e-b758296d40fe", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "624540685646900425", + "tenantId": "fff988bf-fff1-ffff-fffb-fffcd011db47", + "principalOid": "fffdfc0f-fff5-fff0-fff3-fff1a968dcc6", + "complianceState": "NonCompliant" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_TimeRangeSortSelectTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_TimeRangeSortSelectTop.json new file mode 100644 index 000000000000..1c53f674560b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyEvents_TimeRangeSortSelectTop.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "policyEventsResource": "default", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2018-02-05T18:00:00Z", + "$to": "2018-02-06T18:00:00Z", + "$orderby": "Timestamp desc, PolicyAssignmentId asc, SubscriptionId asc, ResourceGroup asc, ResourceId", + "$select": "Timestamp, PolicyAssignmentId, PolicyDefinitionId, SubscriptionId, ResourceGroup, ResourceId", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-05T22:34:02.3475017Z", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/89b27f38-e9e4-4468-ab81-801c84b8c017", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myResourceGroup", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomain" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyEvents/$metadata#default/$entity", + "timestamp": "2018-02-05T22:34:01.6135357Z", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/Enable Monitoring in Azure Security Center", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/201ea587-7c90-41c3-910f-c280ae01cfd6", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myResourceGroup", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomain" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_GetResource.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_GetResource.json new file mode 100644 index 000000000000..8371342ce585 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_GetResource.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "NIST_SP_800-53_R4_AC-2", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "metadataId": "NIST SP 800-53 R4 AC-2", + "category": "Access control", + "title": "Account Management", + "owner": "Shared", + "description": "Description of NIST SP 800-53 R4 AC-2", + "requirements": "List the requirements for NIST SP 800-53 R4 AC-2", + "additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2", + "metadata": {} + }, + "id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2", + "name": "NIST_SP_800-53_R4_AC-2", + "type": "Microsoft.PolicyInsights/policyMetadata" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List.json new file mode 100644 index 000000000000..c1bf024370bf --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "metadataId": "NIST SP 800-53 R4 AC-2", + "category": "Access control", + "title": "Account Management", + "owner": "Shared", + "additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2", + "metadata": {} + }, + "id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2", + "name": "NIST_SP_800-53_R4_AC-2", + "type": "Microsoft.PolicyInsights/policyMetadata" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List_WithTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List_WithTop.json new file mode 100644 index 000000000000..aef92b5124f7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyMetadata_List_WithTop.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "$top": 1 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "metadataId": "NIST SP 800-53 R4 AC-2", + "category": "Access control", + "title": "Account Management", + "owner": "Shared", + "additionalContentUrl": "https://aka.ms/NIST_SP_800-53_R4_AC-2", + "metadata": {} + }, + "id": "/providers/Microsoft.PolicyInsights/policyMetadata/NIST_SP_800-53_R4_AC-2", + "name": "NIST_SP_800-53_R4_AC-2", + "type": "Microsoft.PolicyInsights/policyMetadata" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtManagementGroupScope.json new file mode 100644 index 000000000000..c067b260b72d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtManagementGroupScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "api-version": "2024-10-01", + "parameters": { + "pendingFields": [ + { + "field": "type" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "fieldRestrictions": [ + { + "field": "type", + "restrictions": [ + { + "result": "Required", + "values": [ + "Microsoft.Compute/virtualMachines" + ], + "policy": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyDefinitions/allowedTypes", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyAssignments/7EB1508A", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policySetDefinitions/735551F1", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "type not allowed" + } + ] + } + ], + "contentEvaluationResult": { + "policyEvaluations": [] + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScope.json new file mode 100644 index 000000000000..992a972f077f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScope.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "vmRg", + "api-version": "2024-10-01", + "parameters": { + "resourceDetails": { + "resourceContent": { + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "priority": "Spot" + } + }, + "apiVersion": "2019-12-01" + }, + "pendingFields": [ + { + "field": "name", + "values": [ + "myVMName" + ] + }, + { + "field": "location", + "values": [ + "eastus", + "westus", + "westus2", + "westeurope" + ] + }, + { + "field": "tags" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "fieldRestrictions": [ + { + "field": "tags.newtag", + "restrictions": [ + { + "result": "Required", + "defaultValue": "defaultVal", + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.newtag is required" + } + ] + }, + { + "field": "tags.environment", + "restrictions": [ + { + "result": "Required", + "values": [ + "Prod", + "Int", + "Test" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.environment is required" + } + ] + }, + { + "field": "location", + "restrictions": [ + { + "result": "Deny", + "values": [ + "west europe" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "location must be one of the following: eastus, westus, westus2" + }, + { + "result": "Deny", + "values": [ + "eastus", + "westus" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "location must be one of the following: westus2" + } + ] + } + ], + "contentEvaluationResult": { + "policyEvaluations": [ + { + "policyInfo": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E", + "policyDefinitionReferenceId": "defref222", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37" + }, + "evaluationResult": "NonCompliant", + "evaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expressionKind": "field", + "expression": "type", + "path": "type", + "expressionValue": "microsoft.compute/virtualmachines", + "targetValue": "microsoft.compute/virtualmachines", + "operator": "equals" + } + ] + }, + "effectDetails": { + "policyEffect": "Deny" + } + } + ] + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScopeIncludeAuditEffect.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScopeIncludeAuditEffect.json new file mode 100644 index 000000000000..488074dfa96b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtResourceGroupScopeIncludeAuditEffect.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "vmRg", + "api-version": "2024-10-01", + "parameters": { + "resourceDetails": { + "resourceContent": { + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "priority": "Spot" + } + }, + "apiVersion": "2019-12-01" + }, + "pendingFields": [ + { + "field": "name", + "values": [ + "myVMName" + ] + }, + { + "field": "location", + "values": [ + "eastus", + "westus", + "westus2", + "westeurope" + ] + }, + { + "field": "tags" + } + ], + "includeAuditEffect": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "fieldRestrictions": [ + { + "field": "tags.newtag", + "restrictions": [ + { + "result": "Required", + "defaultValue": "defaultVal", + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.newtag is required" + } + ] + }, + { + "field": "tags.environment", + "restrictions": [ + { + "result": "Required", + "values": [ + "Prod", + "Int", + "Test" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Audit", + "reason": "tags.environment is required" + } + ] + }, + { + "field": "location", + "restrictions": [ + { + "result": "Deny", + "values": [ + "west europe" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "The selected location is not allowed" + }, + { + "result": "Audit", + "values": [ + "eastus", + "westus" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Audit", + "reason": "The selected location is not allowed" + } + ] + } + ], + "contentEvaluationResult": { + "policyEvaluations": [ + { + "policyInfo": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E", + "policyDefinitionReferenceId": "defref222", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37" + }, + "evaluationResult": "NonCompliant", + "evaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expressionKind": "field", + "expression": "type", + "path": "type", + "expressionValue": "microsoft.compute/virtualmachines", + "targetValue": "microsoft.compute/virtualmachines", + "operator": "equals" + } + ], + "reason": "Resource creation of the selected type is not allowed" + }, + "effectDetails": { + "policyEffect": "Audit" + } + } + ] + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScope.json new file mode 100644 index 000000000000..15a43caeb4a9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScope.json @@ -0,0 +1,147 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "parameters": { + "resourceDetails": { + "resourceContent": { + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "priority": "Spot" + } + }, + "apiVersion": "2019-12-01" + }, + "pendingFields": [ + { + "field": "name", + "values": [ + "myVMName" + ] + }, + { + "field": "location", + "values": [ + "eastus", + "westus", + "westus2", + "westeurope" + ] + }, + { + "field": "tags" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "fieldRestrictions": [ + { + "field": "tags.newtag", + "restrictions": [ + { + "result": "Required", + "defaultValue": "defaultVal", + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.newtag is required" + } + ] + }, + { + "field": "tags.environment", + "restrictions": [ + { + "result": "Required", + "values": [ + "Prod", + "Int", + "Test" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.environment is required" + } + ] + }, + { + "field": "location", + "restrictions": [ + { + "result": "Deny", + "values": [ + "west europe" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "location must be one of the following: eastus, westus, westus2" + }, + { + "result": "Deny", + "values": [ + "eastus", + "westus" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "location must be one of the following: westus2" + } + ] + } + ], + "contentEvaluationResult": { + "policyEvaluations": [ + { + "policyInfo": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E", + "policyDefinitionReferenceId": "defref222", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37" + }, + "evaluationResult": "NonCompliant", + "evaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expressionKind": "field", + "expression": "type", + "path": "type", + "expressionValue": "microsoft.compute/virtualmachines", + "targetValue": "microsoft.compute/virtualmachines", + "operator": "equals" + } + ] + }, + "effectDetails": { + "policyEffect": "Deny" + } + } + ] + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScopeIncludeAuditEffect.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScopeIncludeAuditEffect.json new file mode 100644 index 000000000000..add78484d825 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyRestrictions_CheckAtSubscriptionScopeIncludeAuditEffect.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "parameters": { + "resourceDetails": { + "resourceContent": { + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "priority": "Spot" + } + }, + "apiVersion": "2019-12-01" + }, + "pendingFields": [ + { + "field": "name", + "values": [ + "myVMName" + ] + }, + { + "field": "location", + "values": [ + "eastus", + "westus", + "westus2", + "westeurope" + ] + }, + { + "field": "tags" + } + ], + "includeAuditEffect": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "fieldRestrictions": [ + { + "field": "tags.newtag", + "restrictions": [ + { + "result": "Required", + "defaultValue": "defaultVal", + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/1D0906C3", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/57DAC8A0", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/05D92080", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "tags.newtag is required" + } + ] + }, + { + "field": "tags.environment", + "restrictions": [ + { + "result": "Required", + "values": [ + "Prod", + "Int", + "Test" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/30BD79F6", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/7EB1508A", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/735551F1", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Audit", + "reason": "tags.environment is required" + } + ] + }, + { + "field": "location", + "restrictions": [ + { + "result": "Deny", + "values": [ + "west europe" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/0711CCC1", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/1563EBD3", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/1E17783A", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Deny", + "reason": "The selected location is not allowed" + }, + { + "result": "Audit", + "values": [ + "eastus", + "westus" + ], + "policy": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/25C9F66B", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/5382A69D", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/392D107B", + "policyDefinitionReferenceId": "DefRef" + }, + "policyEffect": "Audit", + "reason": "The selected location is not allowed" + } + ] + } + ], + "contentEvaluationResult": { + "policyEvaluations": [ + { + "policyInfo": { + "policyDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyDefinitions/435CAE41", + "policySetDefinitionId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policySetDefinitions/2162358E", + "policyDefinitionReferenceId": "defref222", + "policyAssignmentId": "/subscriptions/d8db6de6-2b96-46af-b825-07aef2033c0b/providers/microsoft.authorization/policyAssignments/2FF66C37" + }, + "evaluationResult": "NonCompliant", + "evaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expressionKind": "field", + "expression": "type", + "path": "type", + "expressionValue": "microsoft.compute/virtualmachines", + "targetValue": "microsoft.compute/virtualmachines", + "operator": "equals" + } + ], + "reason": "Resource creation of the selected type is not allowed" + }, + "effectDetails": { + "policyEffect": "Audit" + } + } + ] + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndAggregateOnly.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndAggregateOnly.json new file mode 100644 index 000000000000..5cbdef147ec9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndAggregateOnly.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$apply": "aggregate($count as NumDenyStates)" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "NumDenyStates": 6 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithAggregate.json new file mode 100644 index 000000000000..5d9418d2e8f9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithAggregate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$filter": "IsCompliant eq false and (PolicyDefinitionAction eq 'audit' or PolicyDefinitionAction eq 'deny')", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId), aggregate($count as NumAuditDenyNonComplianceRecords))", + "$orderby": "NumAuditDenyNonComplianceRecords desc", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.classiccompute/domainnames/myDomainName", + "NumAuditDenyNonComplianceRecords": 10 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.classiccompute/domainnames/myDomainName", + "NumAuditDenyNonComplianceRecords": 10 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json new file mode 100644 index 000000000000..fd20a003d5de --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndGroupByWithoutAggregate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$filter": "IsCompliant eq false and (PolicyDefinitionAction ne 'audit' and PolicyDefinitionAction ne 'append')", + "$apply": "groupby((PolicyAssignmentId, PolicyDefinitionId, PolicyDefinitionAction, ResourceId))", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/enable monitoring in azure security center", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "policyDefinitionAction": "auditifnotexists", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/vnet" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/89b27f38-e9e4-4468-ab81-801c84b8c017", + "policyDefinitionId": "/providers/microsoft.authorization/policydefinitions/44452482-524f-4bf4-b852-0bff7cc4a3ed", + "policyDefinitionAction": "auditifnotexists", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myrg/providers/microsoft.network/virtualnetworks/vnet" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndMultipleGroups.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndMultipleGroups.json new file mode 100644 index 000000000000..050472e5f376 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_FilterAndMultipleGroups.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$filter": "IsCompliant eq false", + "$apply": "groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, PolicyDefinitionReferenceId, ResourceId))/groupby((PolicyAssignmentId, PolicySetDefinitionId, PolicyDefinitionId, PolicyDefinitionReferenceId), aggregate($count as NumNonCompliantResources))", + "$orderby": "NumNonCompliantResources desc", + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 10, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "14799174781370023846", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "1679708035638239273", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "14799174781370023846", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "1679708035638239273", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49", + "policySetDefinitionId": "", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 557 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 552 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "8935913113203900114", + "NumNonCompliantResources": 544 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874", + "policySetDefinitionId": "", + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionReferenceId": "", + "NumNonCompliantResources": 526 + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "2124621540977569058", + "NumNonCompliantResources": 509 + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScope.json new file mode 100644 index 000000000000..a82618547b66 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScope.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json new file mode 100644 index 000000000000..27e02a37e6c0 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLinkSkipToken.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLinkSkipToken.json new file mode 100644 index 000000000000..2de3905dfe01 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLinkSkipToken.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2024-10-01", + "$skiptoken": "WpmghrfhqlwpqqdrwpwmgWfBSvPhkAK6QD", + "nextLink": "{nextLink}" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/1ef5d536aec743a0aa801c1a", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "1ef5d536aec743a0aa801c1a", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policySetDefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionName": "335cefd2-ab16-430f-b364-974a170eb1d5", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "15521232277412542086", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:41:47Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/microsoft.insights/autoscalesettings/mytest1", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/microsoft.insights/autoscalesettings", + "resourceLocation": "westus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "myManagementGroup,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryNestedResourceScope.json new file mode 100644 index 000000000000..32b137831eb9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryNestedResourceScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..0197728c50b2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Security/policies", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Authorization/policyAssignments", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json new file mode 100644 index 000000000000..408533613765 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "myPolicyAssignment", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Security/policies/mySecurityPolicy", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Security/policies", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:38:50Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/test", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Authorization/policyAssignments", + "resourceLocation": null, + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "myPolicyAssignment", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"EUS, WEU\"]}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup", + "policyDefinitionName": "4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScope.json new file mode 100644 index 000000000000..aa2d37945656 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScope.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json new file mode 100644 index 000000000000..bf7038f1b5f1 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T18:42:42Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Storage/storageAccounts", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScope.json new file mode 100644 index 000000000000..b18c0042192d --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponents.json new file mode 100644 index 000000000000..860770f6d12a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponents.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "resourceId": "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$expand": "components($filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant')" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2020-02-21T19:42:08.3252921Z", + "resourceId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName", + "policyAssignmentId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8", + "policyDefinitionId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policydefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "effectiveParameters": "", + "isCompliant": false, + "subscriptionId": "e78961ba-36fe-4739-9212-e3031b4c8db7", + "resourceType": "Microsoft.KeyVault/vaults", + "resourceLocation": "westcentralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "560050f83dbb4a24974323f8", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "", + "policyAssignmentScope": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": "", + "policySetDefinitionCategory": "", + "policySetDefinitionParameters": "", + "managementGroupIds": "PolicyUIMG,AzGovTest5,72f988bf-86f1-41af-91ab-2d7cd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "components": [ + { + "id": "cert-RSA-cert-3", + "type": "Certificate", + "name": "cert-RSA-cert-3", + "timestamp": "2020-02-21T17:45:23.0367Z", + "complianceState": "NonCompliant" + }, + { + "id": "cert-RSA-cert-2", + "type": "Certificate", + "name": "cert-RSA-cert-2", + "timestamp": "2020-02-21T17:45:22.7682778Z", + "complianceState": "NonCompliant" + }, + { + "id": "cert-rsa-cert-expires-2months", + "type": "Certificate", + "name": "cert-rsa-cert-expires-2months", + "timestamp": "2020-02-21T17:45:22.6849056Z", + "complianceState": "NonCompliant" + }, + { + "id": "cert-RSA-cert-1", + "type": "Certificate", + "name": "cert-RSA-cert-1", + "timestamp": "2020-02-21T17:45:22.6504951Z", + "complianceState": "Compliant" + }, + { + "id": "cert-rsa-cert-expires-1month", + "type": "Certificate", + "name": "cert-rsa-cert-expires-1month", + "timestamp": "2020-02-21T17:45:22.5523666Z", + "complianceState": "NonCompliant" + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponentsGroupByWithAggregate.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponentsGroupByWithAggregate.json new file mode 100644 index 000000000000..796a6bc152d2 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandComponentsGroupByWithAggregate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "resourceId": "subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName", + "api-version": "2024-10-01", + "$filter": "policyAssignmentId eq '/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8'", + "$expand": "components($filter=ComplianceState eq 'NonCompliant' or ComplianceState eq 'Compliant';$apply=groupby((complianceState),aggregate($count as count)))" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/Microsoft.KeyVault/Vaults/myKVName/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2020-02-21T19:42:08.3252921Z", + "resourceId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/resourcegroups/myResourceGroup/providers/microsoft.keyvault/vaults/myKVName", + "policyAssignmentId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policyassignments/560050f83dbb4a24974323f8", + "policyDefinitionId": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7/providers/microsoft.authorization/policydefinitions/ab108bc4-32df-4677-8b38-fa8b2905df59", + "effectiveParameters": "", + "isCompliant": false, + "subscriptionId": "e78961ba-36fe-4739-9212-e3031b4c8db7", + "resourceType": "Microsoft.KeyVault/vaults", + "resourceLocation": "westcentralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "560050f83dbb4a24974323f8", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "", + "policyAssignmentScope": "/subscriptions/e78961ba-36fe-4739-9212-e3031b4c8db7", + "policyDefinitionName": "ab108bc4-32df-4677-8b38-fa8b2905df59", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "", + "policySetDefinitionName": "", + "policySetDefinitionOwner": "", + "policySetDefinitionCategory": "", + "policySetDefinitionParameters": "", + "managementGroupIds": "PolicyUIMG,AzGovTest5,72f988bf-86f1-41af-91ab-2d7cd011db47", + "policyDefinitionReferenceId": "", + "complianceState": "NonCompliant", + "components": [ + { + "complianceState": "NonCompliant", + "count": 5 + }, + { + "complianceState": "Compliant", + "count": 14 + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json new file mode 100644 index 000000000000..32df4d63c5a8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2024-10-01", + "$expand": "PolicyEvaluationDetails" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0", + "policyEvaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expression": "type", + "path": "type", + "expressionValue": "Microsoft.ClassicCompute/domainNames", + "targetValue": "Microsoft.ClassicCompute/domainNames", + "operator": "Equals" + }, + { + "result": "False", + "expression": "name", + "path": "name", + "expressionValue": "myDomainName", + "targetValue": "someName", + "operator": "Equals" + } + ] + } + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test2", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/AuditIfNotExistsTest", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "AuditIfNotExists test", + "policyDefinitionAction": "auditifnotexists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0", + "policyEvaluationDetails": { + "evaluatedExpressions": [ + { + "result": "True", + "expression": "tags", + "path": "tags", + "expressionValue": {}, + "targetValue": "global-opco", + "operator": "NotContainsKey" + } + ], + "ifNotExistsDetails": { + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "totalResources": 1 + } + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json new file mode 100644 index 000000000000..566158320e06 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourcegroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.ClassicCompute/domainNames", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json new file mode 100644 index 000000000000..8a9b1902ef22 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResource/someNestedResourceType/someNestedResource", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyAssignments/186044306c044a1d8c0ff76c", + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/mymg/providers/Microsoft.Authorization/policyDefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType/someNestedResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "186044306c044a1d8c0ff76c", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"allowedLocations\":{\"value\":[\"centralus\"]}}", + "policyAssignmentScope": "/providers/Microsoft.Management/managementGroups/mymg", + "policyDefinitionName": "022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..4370276f28ec --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "2124621540977569058", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json new file mode 100644 index 000000000000..f739ff093457 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "2124621540977569058", + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:45:19Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/my-ip-1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"TAGNAME_1\":{\"value\":\"test\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionName": "12b58873-e0f8-4b95-936c-86cbe7c9d697", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": "14799174781370023846", + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..688d869228ce --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json new file mode 100644 index 000000000000..51870bdcfb6c --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:50:27Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.ServiceFabric/clusters/myCluster/applications/myApplication/services/myService", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/d9da7e80af6344ab9d342aa7", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.ServiceFabric/clusters/applications/services", + "resourceLocation": "eastus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "d9da7e80af6344ab9d342aa7", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"MyTag\"}}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..9dd6aa8134c9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/LocationAuditDefinition", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "LocationAuditDefinition", + "policyDefinitionAction": "Audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json new file mode 100644 index 000000000000..de7e9b03dada --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-13T00:54:58Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/mySite", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29", + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/LocationAuditDefinition", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Web/sites", + "resourceLocation": "centralus", + "resourceGroup": "myResourceGroup", + "resourceTags": "tbd", + "policyAssignmentName": "3f3c4330183b4e218fe6fd29", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "LocationAuditDefinition", + "policyDefinitionAction": "Audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json new file mode 100644 index 000000000000..8255091df70a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionLevelResourceScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "policyStatesResource": "default", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName/providers/Microsoft.PolicyInsights/policyStates/$metadata#default/$entity", + "timestamp": "2019-10-09T16:04:31Z", + "resourceId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.SomeNamespace/someResourceType/someResourceName", + "policyAssignmentId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyAssignments/test", + "policyDefinitionId": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/providers/Microsoft.Authorization/policyDefinitions/Audit a tag and it's value", + "effectiveParameters": null, + "isCompliant": true, + "subscriptionId": "fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "resourceType": "/Microsoft.SomeNamespace/someResourceType", + "resourceLocation": "eastus", + "resourceGroup": "", + "resourceTags": "tbd", + "policyAssignmentName": "test", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{\"tagName\":{\"value\":\"no\"},\"tagValue\":{\"value\":\"no\"}}", + "policyAssignmentScope": "/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5", + "policyDefinitionName": "Audit a tag and it's value", + "policyDefinitionAction": "audit", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": null, + "policySetDefinitionName": null, + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "Compliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": null, + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScope.json new file mode 100644 index 000000000000..41659eb53657 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScope.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/Enable Monitoring in Azure Security Center", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "Enable Monitoring in Azure Security Center", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/9ac09b0657d942e5ad4041a6", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "9ac09b0657d942e5ad4041a6", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ], + "policyDefinitionVersion": "1.0.0-preview", + "policySetDefinitionVersion": "2.0.1", + "policyAssignmentVersion": "1.0.0" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json new file mode 100644 index 000000000000..44e79095e146 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$skiptoken": "WpmWfBSvPhkAK6QD" + }, + "responses": { + "200": { + "body": { + "@odata.nextLink": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/Enable Monitoring in Azure Security Center", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "Enable Monitoring in Azure Security Center", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-09T17:48:05Z", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Network/publicIPAddresses/mypubip1", + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/9ac09b0657d942e5ad4041a6", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/9daedab3-fb2d-461e-b861-71790eead4f6", + "effectiveParameters": null, + "isCompliant": false, + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceType": "/Microsoft.Network/publicIPAddresses", + "resourceLocation": "eastus", + "resourceGroup": "myrg1", + "resourceTags": "tbd", + "policyAssignmentName": "9ac09b0657d942e5ad4041a6", + "policyAssignmentOwner": "tbd", + "policyAssignmentParameters": "{}", + "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852", + "policyDefinitionName": "9daedab3-fb2d-461e-b861-71790eead4f6", + "policyDefinitionAction": "AuditIfNotExists", + "policyDefinitionCategory": "tbd", + "policySetDefinitionId": "/providers/Microsoft.Authorization/policySetDefinitions/1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionName": "1f3afdf9-d0c9-4c3d-847f-89da613e70a8", + "policySetDefinitionOwner": null, + "policySetDefinitionCategory": null, + "policySetDefinitionParameters": null, + "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47", + "policyDefinitionReferenceId": null, + "complianceState": "NonCompliant", + "policyDefinitionGroupNames": [ + "myGroup" + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json new file mode 100644 index 000000000000..389754bed387 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeManagementGroupScope.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupName": "myManagementGroup", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$to": "2019-10-06T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit'", + "$top": 0 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny' or PolicyDefinitionAction eq 'audit') and IsCompliant eq false", + "nonCompliantResources": 15410, + "nonCompliantPolicies": 68, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 1400 + }, + { + "complianceState": "noncompliant", + "count": 15410 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 68 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 14 + } + ] + }, + "policyAssignments": [] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..988b1166d3e0 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "b7a1ca2596524e3ab19597f2", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false", + "nonCompliantResources": 7, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 7 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2'", + "nonCompliantResources": 7, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 7 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60", + "policyDefinitionReferenceId": "2134906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Authorization/policyAssignments/b7a1ca2596524e3ab19597f2/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-22 23:54:22Z&$to=2019-10-23 23:54:22Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/4a0425e4-97bf-4ad0-ab36-145b94083c60'", + "nonCompliantResources": 7, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 7 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/b7a1ca2596524e3ab19597f2' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 7 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupScope.json new file mode 100644 index 000000000000..ac7582a3bb28 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceGroupScope.json @@ -0,0 +1,247 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false", + "nonCompliantResources": 55, + "nonCompliantPolicies": 20, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 55 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c'", + "nonCompliantResources": 55, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 55 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 100, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 100 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/186044306c044a1d8c0ff76c' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 100, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 100 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 55, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 55 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/d0610b27-9663-4c05-89f8-5b4be01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:55:09Z&$to=2019-10-13 19:55:09Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 55, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 55 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 55 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceScope.json new file mode 100644 index 000000000000..09c649fe2b64 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeResourceScope.json @@ -0,0 +1,241 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault", + "api-version": "2024-10-01", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false", + "nonCompliantResources": 1, + "nonCompliantPolicies": 14, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/72c0c41a-c752-4bc0-9c61-0d6adc567066'", + "nonCompliantResources": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/8174043a1e2849179635b874'", + "nonCompliantResources": 7, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 1, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/my-vault/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:59:17Z&$to=2019-10-13 19:59:17Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/mymg/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 100, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json new file mode 100644 index 000000000000..0225e1182deb --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json @@ -0,0 +1,252 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 4, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 4 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "2134906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "3424906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "7943906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 220, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 220 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionReferenceId": "1234906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:09:24Z&$to=2019-10-13 20:09:24Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682'", + "nonCompliantResources": 54, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 54 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 100, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 100 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json new file mode 100644 index 000000000000..ef11ee4a3ab0 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json @@ -0,0 +1,419 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false", + "nonCompliantResources": 561, + "nonCompliantPolicies": 4, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 561 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 558, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 558 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 558, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 558 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 7, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 558 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29'", + "nonCompliantResources": 553, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 553 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "2481303924813039", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 553, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 553 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 553, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 553 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/ddd8ef92e3714a5ea3d208c1' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531'", + "nonCompliantResources": 531, + "nonCompliantPolicies": 1 + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 20:07:10Z&$to=2019-10-13 20:07:10Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/12b58873-e0f8-4b95-936c-86cbe7c9d697' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/f4cc58b7db524a9799381531' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 531 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json new file mode 100644 index 000000000000..386c5a2b53f7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "authorizationNamespace": "Microsoft.Authorization", + "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$to": "2019-10-06T18:00:00Z", + "$filter": "PolicyDefinitionAction eq 'deny'", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny') and IsCompliant eq false", + "nonCompliantResources": 0, + "nonCompliantPolicies": 0, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + } + ], + "policyDetails": [ + { + "complianceState": "compliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "compliant", + "count": 1 + } + ] + }, + "policyAssignments": [] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScope.json new file mode 100644 index 000000000000..6cf7dd85a4b7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScope.json @@ -0,0 +1,603 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$top": 5 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false", + "nonCompliantResources": 619, + "nonCompliantPolicies": 40, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 619 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "1b249ab8b4741b249ab8b474", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 531, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/d9da7e80af6344ab9d342aa7'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49", + "policySetDefinitionId": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "", + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/c8b79b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/dcda79d769674aea8bfcaa49'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a", + "policySetDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d", + "policyDefinitionReferenceId": "2134906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and PolicyDefinitionId eq '/providers/microsoft.management/managementgroups/myManagementGroup/providers/microsoft.authorization/policydefinitions/022d9357-5a90-46f7-9554-21d30ce4c32d'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/335cefd2-ab16-430f-b364-974a170eb1d5' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/1ef5d536aec743a0aa801c1a' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + }, + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29'", + "nonCompliantResources": 552, + "nonCompliantPolicies": 3, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 552 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 3 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "5434906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 552, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 552 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition", + "policyDefinitionReferenceId": "8724906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/locationauditdefinition'", + "nonCompliantResources": 29, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 29 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682", + "policyDefinitionReferenceId": "7254906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter=IsCompliant eq false and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682'", + "nonCompliantResources": 2, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/3f3c4330183b4e218fe6fd29' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 552 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 3 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScopeForPolicyGroup.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScopeForPolicyGroup.json new file mode 100644 index 000000000000..7c35fcef0173 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_SummarizeSubscriptionScopeForPolicyGroup.json @@ -0,0 +1,184 @@ +{ + "parameters": { + "policyStatesSummaryResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$filter": "'group1' IN PolicyDefinitionGroupNames", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary", + "@odata.count": 1, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 17 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyAssignments": [ + { + "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01", + "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01'", + "nonCompliantResources": 557, + "nonCompliantPolicies": 1, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 140 + }, + { + "complianceState": "noncompliant", + "count": 17 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + }, + "policyDefinitions": [ + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/ab379b49-a579-4045-984e-1b249ab8b474", + "policyDefinitionReferenceId": "1595906828137356523", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/ab379b49-a579-4045-984e-1b249ab8b474'", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + }, + { + "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1", + "policyDefinitionReferenceId": "2134906828137356512", + "policyDefinitionGroupNames": [ + "group1" + ], + "effect": "audit", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and PolicyDefinitionId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policydefinitions/24813039-7534-408a-9842-eb99f45721b1'", + "nonCompliantResources": 34, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 510 + }, + { + "complianceState": "noncompliant", + "count": 34 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ], + "policyGroups": [ + { + "policyGroupName": "group1", + "results": { + "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$from=2019-10-12 19:48:53Z&$to=2019-10-13 19:48:53Z&$filter='group1' IN PolicyDefinitionGroupNames and PolicySetDefinitiontId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policysetdefinitions/a03db67e-a286-43c3-9098-b2da83d361ad' and PolicyAssignmentId eq '/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/microsoft.authorization/policyassignments/e46af646ebdb461dba708e01' and 'group1' IN PolicyDefinitionGroupNames", + "nonCompliantResources": 557, + "resourceDetails": [ + { + "complianceState": "compliant", + "count": 14 + }, + { + "complianceState": "noncompliant", + "count": 557 + } + ], + "policyDetails": [ + { + "complianceState": "noncompliant", + "count": 2 + } + ], + "policyGroupDetails": [ + { + "complianceState": "noncompliant", + "count": 1 + } + ] + } + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TimeRangeSortSelectTop.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TimeRangeSortSelectTop.json new file mode 100644 index 000000000000..696d93856b43 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TimeRangeSortSelectTop.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "policyStatesResource": "latest", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01", + "$from": "2019-10-05T18:00:00Z", + "$to": "2019-10-06T18:00:00Z", + "$orderby": "Timestamp desc, PolicyAssignmentId asc, SubscriptionId asc, ResourceGroup asc, ResourceId", + "$select": "Timestamp, PolicyAssignmentId, PolicyDefinitionId, SubscriptionId, ResourceGroup, ResourceId, policyDefinitionGroupNames", + "$top": 2 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest", + "@odata.count": 2, + "value": [ + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-06T17:58:00Z", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/8cb1e007-947f-423a-ad0c-7ab7dc7d0255/providers/Microsoft.Authorization/policyAssignments/1654a0254ab34920a60f94eb", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myrg1", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg1/providers/Microsoft.Storage/storageAccounts/mysa1", + "policyDefinitionGroupNames": [ + "myGroup" + ] + }, + { + "@odata.id": null, + "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity", + "timestamp": "2019-10-06T17:58:00Z", + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/8cb1e007-947f-423a-ad0c-7ab7dc7d0255/providers/Microsoft.Authorization/policyAssignments/1654a0254ab34920a60f94eb", + "policyDefinitionId": "/providers/Microsoft.Authorization/policyDefinitions/655cb504-bcee-4362-bd4c-402e6aa38759", + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroup": "myrg2", + "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myrg2/providers/Microsoft.Storage/storageAccounts/mysa2", + "policyDefinitionGroupNames": [] + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerResourceGroupEvaluation.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerResourceGroupEvaluation.json new file mode 100644 index 000000000000..11ebf41d0b79 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerResourceGroupEvaluation.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Code": "202", + "Message": "Accepted", + "Retry-After": "30", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.PolicyInsights/asyncOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerSubscriptionEvaluation.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerSubscriptionEvaluation.json new file mode 100644 index 000000000000..ac228f7cb5ae --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/PolicyStates_TriggerSubscriptionEvaluation.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", + "api-version": "2024-10-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Code": "202", + "Message": "Accepted", + "Retry-After": "30", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.PolicyInsights/asyncOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-10-01" + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelManagementGroupScope.json new file mode 100644 index 000000000000..1c32bb61898f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelManagementGroupScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Cancelling", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/myRemediation", + "name": "myRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceGroupScope.json new file mode 100644 index 000000000000..f347e97ec2f4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceGroupScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Cancelling", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/myRemediation", + "name": "myRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceScope.json new file mode 100644 index 000000000000..8af9f52ee06e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelResourceScope.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Cancelling", + "createdOn": "2018-09-13T21:51:09.085918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 1, + "successfulDeployments": 1, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/myRemediation", + "name": "myRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelSubscriptionScope.json new file mode 100644 index 000000000000..cfedf3772f22 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CancelSubscriptionScope.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Cancelling", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/myRemediation", + "name": "myRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateManagementGroupScope.json new file mode 100644 index 000000000000..dbf116d61437 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateManagementGroupScope.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations" + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceGroupScope.json new file mode 100644 index 000000000000..a1c29dfc4d3c --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceGroupScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2020-06-15T18:52:27Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-15T18:52:27Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceScope.json new file mode 100644 index 000000000000..be8630e9c113 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateResourceScope.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope.json new file mode 100644 index 000000000000..64637f8fa390 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_AllProperties.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_AllProperties.json new file mode 100644 index 000000000000..d69608b986e8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_AllProperties.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ReEvaluateCompliance", + "filters": { + "locations": [ + "eastus", + "westus" + ] + }, + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ReEvaluateCompliance", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ReEvaluateCompliance", + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_ResourceIdsFilter.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_ResourceIdsFilter.json new file mode 100644 index 000000000000..3ef522642fe1 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_CreateSubscriptionScope_ResourceIdsFilter.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "remediationName": "storageRemediation", + "api-version": "2024-10-01", + "parameters": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ExistingNonCompliant", + "filters": { + "locations": [ + "eastus", + "westus" + ], + "resourceIds": [ + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174" + ] + }, + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ExistingNonCompliant", + "filters": { + "locations": [ + "eastus", + "westus" + ], + "resourceIds": [ + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174" + ] + }, + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + }, + "201": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "8c8fa9e4", + "resourceDiscoveryMode": "ExistingNonCompliant", + "filters": { + "locations": [ + "eastus", + "westus" + ], + "resourceIds": [ + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res2627/providers/Microsoft.Storage/storageAccounts/sto1125", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto3699", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto6637", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/res8186/providers/Microsoft.Storage/storageAccounts/sto834", + "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/testcmk3/providers/Microsoft.Storage/storageAccounts/sto9174" + ] + }, + "provisioningState": "Accepted", + "createdOn": "2018-09-12T20:58:58.7531298Z", + "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 0, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-12T20:58:58.7531298Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-12T20:58:58.7531298Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteManagementGroupScope.json new file mode 100644 index 000000000000..5cfc3ca70f1a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteManagementGroupScope.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceGroupScope.json new file mode 100644 index 000000000000..278697eabcbd --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceGroupScope.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceScope.json new file mode 100644 index 000000000000..9927235a8c61 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteResourceScope.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 1, + "successfulDeployments": 1, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteSubscriptionScope.json new file mode 100644 index 000000000000..971d3a668ee5 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_DeleteSubscriptionScope.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + }, + "204": { + "headers": {} + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetManagementGroupScope.json new file mode 100644 index 000000000000..b01a1ad1b41f --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetManagementGroupScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceGroupScope.json new file mode 100644 index 000000000000..8e2c07ed6ad8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceGroupScope.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceScope.json new file mode 100644 index 000000000000..d3ee7ac77ec7 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetResourceScope.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 1, + "successfulDeployments": 1, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetSubscriptionScope.json new file mode 100644 index 000000000000..ab96496e83fa --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_GetSubscriptionScope.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "remediationName": "storageRemediation", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation", + "name": "storageRemediation", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsManagementGroupScope.json new file mode 100644 index 000000000000..9fd76376ab82 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsManagementGroupScope.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.resources/deployments/a088e8fd-8600-4126-8d74-fc7ead0e9ae4", + "status": "Succeeded", + "resourceLocation": "eastus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8919106Z" + }, + { + "remediatedResourceId": "/subscriptions/c1164d71-0942-499f-bc2f-b6b7b0bae493/resourcegroups/myResourceGroup2/providers/microsoft.storage/storageaccounts/stor1", + "deploymentId": "/subscriptions/c1164d71-0942-499f-bc2f-b6b7b0bae493/resourcegroups/myResourceGroup2/providers/microsoft.resources/deployments/6b8898c0-18a2-449e-987a-8d4d4f634f56", + "status": "Succeeded", + "resourceLocation": "westus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8761679Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceGroupScope.json new file mode 100644 index 000000000000..8930efef613c --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceGroupScope.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.resources/deployments/a088e8fd-8600-4126-8d74-fc7ead0e9ae4", + "status": "Succeeded", + "resourceLocation": "eastus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8919106Z" + }, + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/stor2", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.resources/deployments/6b8898c0-18a2-449e-987a-8d4d4f634f56", + "status": "Succeeded", + "resourceLocation": "westus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8761679Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceScope.json new file mode 100644 index 000000000000..d409f3a5e1d8 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsResourceScope.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.resources/deployments/a088e8fd-8600-4126-8d74-fc7ead0e9ae4", + "status": "Succeeded", + "resourceLocation": "eastus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8919106Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsSubscriptionScope.json new file mode 100644 index 000000000000..3febfd287f5b --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListDeploymentsSubscriptionScope.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01", + "remediationName": "myRemediation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.resources/deployments/a088e8fd-8600-4126-8d74-fc7ead0e9ae4", + "status": "Succeeded", + "resourceLocation": "eastus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8919106Z" + }, + { + "remediatedResourceId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup2/providers/microsoft.storage/storageaccounts/stor1", + "deploymentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup2/providers/microsoft.resources/deployments/6b8898c0-18a2-449e-987a-8d4d4f634f56", + "status": "Succeeded", + "resourceLocation": "westus", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:09.8761679Z" + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope.json new file mode 100644 index 000000000000..935a9513fdba --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + }, + { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:49:16.4638131Z", + "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "957378d3-a143-421e-8b0e-3048dff01932" + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope_WithQuery.json new file mode 100644 index 000000000000..7668e77ce464 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListManagementGroupScope_WithQuery.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "managementGroupsNamespace": "Microsoft.Management", + "managementGroupId": "financeMg", + "$filter": "PolicyAssignmentId eq '/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope.json new file mode 100644 index 000000000000..3abfc635b5fd --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:49:16.4638131Z", + "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "957378d3-a143-421e-8b0e-3048dff01932" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope_WithQuery.json new file mode 100644 index 000000000000..590f30b633bd --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceGroupScope_WithQuery.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "resourceGroupName": "myResourceGroup", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourceGroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:49:16.4638131Z", + "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "957378d3-a143-421e-8b0e-3048dff01932" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope.json new file mode 100644 index 000000000000..33f047c5afeb --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 1, + "successfulDeployments": 1, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope_WithQuery.json new file mode 100644 index 000000000000..dc26dcfd5fe4 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListResourceScope_WithQuery.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceId": "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 1, + "successfulDeployments": 1, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:51:09.075918Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:52:10.0011706Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope.json new file mode 100644 index 000000000000..cfd3c21de8e9 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:49:16.4638131Z", + "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "957378d3-a143-421e-8b0e-3048dff01932", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup2/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope_WithQuery.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope_WithQuery.json new file mode 100644 index 000000000000..bfde6753f865 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/examples/Remediations_ListSubscriptionScope_WithQuery.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "35ee058e-5fa0-414c-8145-3ebb8d09b6e2", + "$filter": "PolicyAssignmentId eq '/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5' AND PolicyDefinitionReferenceId eq 'storageSkuDef'", + "$top": 1, + "api-version": "2024-10-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "storageSkuDef", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:51:09.075918Z", + "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6", + "resourceCount": 42, + "parallelDeployments": 6, + "failureThreshold": { + "percentage": 0.1 + } + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + }, + { + "properties": { + "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5", + "policyDefinitionReferenceId": "storageSkuDef", + "provisioningState": "Succeeded", + "createdOn": "2018-09-13T21:49:16.4638131Z", + "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z", + "resourceDiscoveryMode": "ExistingNonCompliant", + "deploymentStatus": { + "totalDeployments": 2, + "successfulDeployments": 2, + "failedDeployments": 0 + }, + "statusMessage": "Remediation extended status", + "correlationId": "957378d3-a143-421e-8b0e-3048dff01932" + }, + "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/rg2/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8", + "type": "Microsoft.PolicyInsights/remediations", + "systemData": { + "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "createdByType": "User", + "createdAt": "2018-09-13T21:49:16.4638131Z", + "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6", + "lastModifiedByType": "User", + "lastModifiedAt": "2018-09-13T21:50:18.4647478Z" + } + } + ] + } + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/operations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/operations.json new file mode 100644 index 000000000000..adb5fd293f9a --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/operations.json @@ -0,0 +1,137 @@ +{ + "swagger": "2.0", + "info": { + "title": "Policy Insights Operations API", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.PolicyInsights/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of available operations.", + "schema": { + "$ref": "#/definitions/OperationsListResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../stable/2019-10-01/operations.json#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "List operations": { + "$ref": "./examples/Operations_ListOperations.json" + } + } + } + } + }, + "definitions": { + "OperationsListResults": { + "description": "List of available operations.", + "type": "object", + "properties": { + "@odata.count": { + "description": "OData entity count; represents the number of operations returned.", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Operation": { + "description": "Operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "display": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Resource provider name.", + "type": "string" + }, + "resource": { + "description": "Resource name on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation name.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "API version to use with the client requests.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyEvents.json new file mode 100644 index 000000000000..3e5a4c62d5aa --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyEvents.json @@ -0,0 +1,1140 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyEventsClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForManagementGroup", + "description": "Queries policy events for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at management group scope": { + "$ref": "./examples/PolicyEvents_QueryManagementGroupScope.json" + }, + "Query at management group scope with next link": { + "$ref": "./examples/PolicyEvents_QueryManagementGroupScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForSubscription", + "description": "Queries policy events for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at subscription scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionScope.json" + }, + "Query at subscription scope with next link": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionScopeNextLink.json" + }, + "Time range; sort, select and limit": { + "$ref": "./examples/PolicyEvents_TimeRangeSortSelectTop.json" + }, + "Filter and group with aggregate": { + "$ref": "./examples/PolicyEvents_FilterAndGroupByWithAggregate.json" + }, + "Filter and group without aggregate": { + "$ref": "./examples/PolicyEvents_FilterAndGroupByWithoutAggregate.json" + }, + "Filter and aggregate only": { + "$ref": "./examples/PolicyEvents_FilterAndAggregateOnly.json" + }, + "Filter and multiple groups": { + "$ref": "./examples/PolicyEvents_FilterAndMultipleGroups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResourceGroup", + "description": "Queries policy events for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at resource group scope": { + "$ref": "./examples/PolicyEvents_QueryResourceGroupScope.json" + }, + "Query at resource group scope with next link": { + "$ref": "./examples/PolicyEvents_QueryResourceGroupScopeNextLink.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResource", + "description": "Queries policy events for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/expandParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at resource scope": { + "$ref": "./examples/PolicyEvents_QueryResourceScope.json" + }, + "Query at resource scope with next link": { + "$ref": "./examples/PolicyEvents_QueryResourceScopeNextLink.json" + }, + "Query at subscription level resource scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json" + }, + "Query at nested resource scope": { + "$ref": "./examples/PolicyEvents_QueryNestedResourceScope.json" + }, + "Query at subscription level nested resource scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json" + }, + "Query components policy events for resource scope filtered by given assignment.": { + "$ref": "./examples/PolicyEvents_QueryResourceScopeExpandComponents.json" + }, + "Query components policy events count grouped by user and action type for resource scope filtered by given assignment.": { + "$ref": "./examples/PolicyEvents_QueryResourceScopeExpandComponentsGroupByWithAggregate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForPolicySetDefinition", + "description": "Queries policy events for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at subscription level policy set definition scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScope.json" + }, + "Query at subscription level policy set definition scope with next link": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForPolicyDefinition", + "description": "Queries policy events for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at subscription level policy definition scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScope.json" + }, + "Query at subscription level policy definition scope with next link": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForSubscriptionLevelPolicyAssignment", + "description": "Queries policy events for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at subscription level policy assignment scope": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScope.json" + }, + "Query at subscription level policy assignment scope with next link": { + "$ref": "./examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults": { + "post": { + "operationId": "PolicyEvents_ListQueryResultsForResourceGroupLevelPolicyAssignment", + "description": "Queries policy events for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyEventsResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyEvents_NextLink" + }, + "x-ms-examples": { + "Query at resource group level policy assignment scope": { + "$ref": "./examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScope.json" + }, + "Query at resource group level policy assignment scope with next link": { + "$ref": "./examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json" + } + } + } + } + }, + "x-ms-paths": { + "{nextLink}?Next paging op for policy events": { + "post": { + "operationId": "PolicyEvents_NextLink", + "description": "Subsequent post calls to the next link", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + }, + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyEventsQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at resource group level policy assignment scope with next link": { + "$ref": "./examples/PolicyEvents_QueryManagementGroupScopeNextLinkSkipToken.json" + } + } + } + } + }, + "definitions": { + "PolicyEventsQueryResults": { + "description": "Query results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of policy event records returned.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "@odata.nextLink": { + "description": "Odata next link; URL to get the next set of results.", + "type": "string" + }, + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyEvent" + }, + "x-ms-identifiers": [] + } + } + }, + "PolicyEvent": { + "type": "object", + "description": "Policy event record.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since policy event records do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "timestamp": { + "description": "Timestamp for the policy event record.", + "type": "string", + "format": "date-time" + }, + "resourceId": { + "description": "Resource ID.", + "type": "string" + }, + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "effectiveParameters": { + "description": "Effective parameters for the policy assignment.", + "type": "string" + }, + "isCompliant": { + "description": "Flag which states whether the resource is compliant against the policy assignment it was evaluated against.", + "type": "boolean" + }, + "subscriptionId": { + "description": "Subscription ID.", + "type": "string" + }, + "resourceType": { + "description": "Resource type.", + "type": "string" + }, + "resourceLocation": { + "description": "Resource location.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + }, + "resourceTags": { + "description": "List of resource tags.", + "type": "string" + }, + "policyAssignmentName": { + "description": "Policy assignment name.", + "type": "string" + }, + "policyAssignmentOwner": { + "description": "Policy assignment owner.", + "type": "string" + }, + "policyAssignmentParameters": { + "description": "Policy assignment parameters.", + "type": "string" + }, + "policyAssignmentScope": { + "description": "Policy assignment scope.", + "type": "string" + }, + "policyDefinitionName": { + "description": "Policy definition name.", + "type": "string" + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string" + }, + "policyDefinitionCategory": { + "description": "Policy definition category.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionName": { + "description": "Policy set definition name, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionOwner": { + "description": "Policy set definition owner, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionCategory": { + "description": "Policy set definition category, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionParameters": { + "description": "Policy set definition parameters, if the policy assignment is for a policy set.", + "type": "string" + }, + "managementGroupIds": { + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.", + "type": "string" + }, + "complianceState": { + "description": "Compliance state of the resource.", + "type": "string" + }, + "tenantId": { + "description": "Tenant ID for the policy event record.", + "type": "string" + }, + "principalOid": { + "description": "Principal object ID for the user who initiated the resource operation that triggered the policy event.", + "type": "string" + }, + "components": { + "description": "Components events records populated only when URL contains $expand=components clause.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentEventDetails" + } + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "ComponentEventDetails": { + "type": "object", + "description": "Component event details.", + "properties": { + "id": { + "description": "Component Id.", + "type": "string" + }, + "type": { + "description": "Component type.", + "type": "string" + }, + "name": { + "description": "Component name.", + "type": "string" + }, + "timestamp": { + "description": "Timestamp for component policy event record.", + "type": "string", + "format": "date-time" + }, + "tenantId": { + "description": "Tenant ID for the policy event record.", + "type": "string" + }, + "principalOid": { + "description": "Principal object ID for the user who initiated the resource component operation that triggered the policy event.", + "type": "string" + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string" + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "QueryFailure": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "MetadataDocument": { + "description": "Metadata XML document.", + "type": "string" + } + }, + "parameters": { + "policyEventsResourceParameter": { + "name": "policyEventsResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "PolicyEventsResourceType", + "modelAsString": true + }, + "description": "The name of the virtual resource under PolicyEvents resource type; only \"default\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Management group name.", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "authorizationNamespaceParameter": { + "name": "authorizationNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Authorization" + ], + "x-ms-enum": { + "name": "AuthorizationNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", + "x-ms-parameter-location": "method" + }, + "policySetDefinitionNameParameter": { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy set definition name.", + "x-ms-parameter-location": "method" + }, + "policyDefinitionNameParameter": { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy definition name.", + "x-ms-parameter-location": "method" + }, + "policyAssignmentNameParameter": { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name.", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "orderByParameter": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "OrderBy" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "fromParameter": { + "name": "$from", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "From" + }, + "toParameter": { + "name": "$to", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "To" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "applyParameter": { + "name": "$apply", + "in": "query", + "required": false, + "type": "string", + "description": "OData apply expression for aggregations.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + "expandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to expand components use $expand=components", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Expand" + }, + "skipTokenParameter": { + "name": "$skiptoken", + "in": "query", + "required": false, + "type": "string", + "description": "Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "SkipToken" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyMetadata.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyMetadata.json new file mode 100644 index 000000000000..adf0a04e1e42 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyMetadata.json @@ -0,0 +1,325 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyMetadataClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}": { + "get": { + "operationId": "PolicyMetadata_GetResource", + "description": "Get policy metadata resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Policy metadata resource definition.", + "schema": { + "$ref": "#/definitions/PolicyMetadata" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a single policy metadata resource": { + "$ref": "./examples/PolicyMetadata_GetResource.json" + } + } + } + }, + "/providers/Microsoft.PolicyInsights/policyMetadata": { + "get": { + "operationId": "PolicyMetadata_List", + "description": "Get a list of the policy metadata resources.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + } + ], + "responses": { + "200": { + "description": "Policy metadata resource collection.", + "schema": { + "$ref": "#/definitions/PolicyMetadataCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get collection of policy metadata resources": { + "$ref": "./examples/PolicyMetadata_List.json" + }, + "Get collection of policy metadata resources using top query parameter": { + "$ref": "./examples/PolicyMetadata_List_WithTop.json" + } + } + } + } + }, + "definitions": { + "PolicyMetadata": { + "description": "Policy metadata resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyMetadataProperties", + "description": "Properties of the policy metadata." + }, + "id": { + "type": "string", + "description": "The ID of the policy metadata.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the policy metadata.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the policy metadata.", + "readOnly": true + } + } + }, + "PolicyMetadataSlimProperties": { + "description": "The properties of the policy metadata, excluding properties containing large strings", + "properties": { + "metadataId": { + "description": "The policy metadata identifier.", + "type": "string", + "readOnly": true + }, + "category": { + "description": "The category of the policy metadata.", + "type": "string", + "readOnly": true + }, + "title": { + "description": "The title of the policy metadata.", + "type": "string", + "readOnly": true + }, + "owner": { + "description": "The owner of the policy metadata.", + "type": "string", + "readOnly": true + }, + "additionalContentUrl": { + "description": "Url for getting additional content about the resource metadata.", + "type": "string", + "readOnly": true + }, + "metadata": { + "description": "Additional metadata.", + "type": "object", + "readOnly": true + } + } + }, + "PolicyMetadataProperties": { + "description": "The properties of the policy metadata.", + "properties": { + "description": { + "description": "The description of the policy metadata.", + "type": "string", + "readOnly": true + }, + "requirements": { + "description": "The requirements of the policy metadata.", + "type": "string", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/PolicyMetadataSlimProperties" + } + ] + }, + "SlimPolicyMetadata": { + "description": "Slim version of policy metadata resource definition, excluding properties with large strings", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyMetadataSlimProperties", + "description": "Properties of the policy metadata." + }, + "id": { + "type": "string", + "description": "The ID of the policy metadata.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the policy metadata.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the policy metadata.", + "readOnly": true + } + } + }, + "PolicyMetadataCollection": { + "description": "Collection of policy metadata resources.", + "properties": { + "value": { + "description": "Array of policy metadata definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/SlimPolicyMetadata" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "additionalInfo": { + "description": "Additional scenario specific error details.", + "type": "array", + "items": { + "$ref": "#/definitions/TypedErrorInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "TypedErrorInfo": { + "description": "Scenario specific error details.", + "properties": { + "type": { + "description": "The type of included error details.", + "type": "string", + "readOnly": true + }, + "info": { + "description": "The scenario specific error details.", + "readOnly": true + } + } + } + }, + "parameters": { + "resourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the policy metadata resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyStates.json new file mode 100644 index 000000000000..cbf0b53e3871 --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/policyStates.json @@ -0,0 +1,1923 @@ +{ + "swagger": "2.0", + "info": { + "title": "PolicyStatesClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForManagementGroup", + "description": "Queries policy states for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at management group scope": { + "$ref": "./examples/PolicyStates_QueryManagementGroupScope.json" + }, + "Query latest at management group scope with next link": { + "$ref": "./examples/PolicyStates_QueryManagementGroupScopeNextLink.json" + } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForManagementGroup", + "description": "Summarizes policy states for the resources under the management group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at management group scope": { + "$ref": "./examples/PolicyStates_SummarizeManagementGroupScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForSubscription", + "description": "Queries policy states for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at subscription scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionScope.json" + }, + "Query latest at subscription scope with next link": { + "$ref": "./examples/PolicyStates_QuerySubscriptionScopeNextLink.json" + }, + "Time range; sort, select and limit": { + "$ref": "./examples/PolicyStates_TimeRangeSortSelectTop.json" + }, + "Filter and group with aggregate": { + "$ref": "./examples/PolicyStates_FilterAndGroupByWithAggregate.json" + }, + "Filter and group without aggregate": { + "$ref": "./examples/PolicyStates_FilterAndGroupByWithoutAggregate.json" + }, + "Filter and aggregate only": { + "$ref": "./examples/PolicyStates_FilterAndAggregateOnly.json" + }, + "Filter and multiple groups": { + "$ref": "./examples/PolicyStates_FilterAndMultipleGroups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForSubscription", + "description": "Summarizes policy states for the resources under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at subscription scope": { + "$ref": "./examples/PolicyStates_SummarizeSubscriptionScope.json" + }, + "Summarize at subscription scope for a policy definition group": { + "$ref": "./examples/PolicyStates_SummarizeSubscriptionScopeForPolicyGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResourceGroup", + "description": "Queries policy states for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at resource group scope": { + "$ref": "./examples/PolicyStates_QueryResourceGroupScope.json" + }, + "Query latest at resource group scope with next link": { + "$ref": "./examples/PolicyStates_QueryResourceGroupScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResourceGroup", + "description": "Summarizes policy states for the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at resource group scope": { + "$ref": "./examples/PolicyStates_SummarizeResourceGroupScope.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResource", + "description": "Queries policy states for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/expandParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query all policy states at resource scope": { + "$ref": "./examples/PolicyStates_QueryResourceScope.json" + }, + "Query all policy states at resource scope with next link": { + "$ref": "./examples/PolicyStates_QueryResourceScopeNextLink.json" + }, + "Query all policy states at subscription level resource scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelResourceScope.json" + }, + "Query all policy states at nested resource scope": { + "$ref": "./examples/PolicyStates_QueryNestedResourceScope.json" + }, + "Query all policy states at subscription level nested resource scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json" + }, + "Query all policy states at resource scope and expand policyEvaluationDetails": { + "$ref": "./examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json" + }, + "Query component policy compliance state at resource scope filtered by given assignment.": { + "$ref": "./examples/PolicyStates_QueryResourceScopeExpandComponents.json" + }, + "Query component policy compliance state count grouped by state type at resource scope filtered by given assignment.": { + "$ref": "./examples/PolicyStates_QueryResourceScopeExpandComponentsGroupByWithAggregate.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResource", + "description": "Summarizes policy states for the resource.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at resource scope": { + "$ref": "./examples/PolicyStates_SummarizeResourceScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/policyStates/latest/triggerEvaluation": { + "post": { + "operationId": "PolicyStates_TriggerSubscriptionEvaluation", + "description": "Triggers a policy evaluation scan for all the resources under the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The scan is done." + }, + "202": { + "description": "The scan was successfully triggered." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Trigger evaluations for all resources in a subscription": { + "$ref": "./examples/PolicyStates_TriggerSubscriptionEvaluation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/latest/triggerEvaluation": { + "post": { + "operationId": "PolicyStates_TriggerResourceGroupEvaluation", + "description": "Triggers a policy evaluation scan for all the resources under the resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The scan is done." + }, + "202": { + "description": "The scan was successfully triggered." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Trigger evaluations for all resources in a resource group": { + "$ref": "./examples/PolicyStates_TriggerResourceGroupEvaluation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForPolicySetDefinition", + "description": "Queries policy states for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at subscription level policy set definition scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScope.json" + }, + "Query latest at subscription level policy set definition scope with next link": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForPolicySetDefinition", + "description": "Summarizes policy states for the subscription level policy set definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policySetDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy set definition scope": { + "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicySetDefinitionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForPolicyDefinition", + "description": "Queries policy states for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at subscription level policy definition scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScope.json" + }, + "Query latest at subscription level policy definition scope with next link": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyDefinitions/{policyDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForPolicyDefinition", + "description": "Summarizes policy states for the subscription level policy definition.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyDefinitionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy definition scope": { + "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicyDefinitionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForSubscriptionLevelPolicyAssignment", + "description": "Queries policy states for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at subscription level policy assignment scope": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScope.json" + }, + "Query latest at subscription level policy assignment scope with next link": { + "$ref": "./examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForSubscriptionLevelPolicyAssignment", + "description": "Summarizes policy states for the subscription level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy assignment scope": { + "$ref": "./examples/PolicyStates_SummarizeSubscriptionLevelPolicyAssignmentScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults": { + "post": { + "operationId": "PolicyStates_ListQueryResultsForResourceGroupLevelPolicyAssignment", + "description": "Queries policy states for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/orderByParameter" + }, + { + "$ref": "#/parameters/selectParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/applyParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink", + "operationName": "PolicyStates_NextLink" + }, + "x-ms-examples": { + "Query latest at resource group level policy assignment scope": { + "$ref": "./examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScope.json" + }, + "Query latest at resource group level policy assignment scope with next link": { + "$ref": "./examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{authorizationNamespace}/policyAssignments/{policyAssignmentName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize": { + "post": { + "operationId": "PolicyStates_SummarizeForResourceGroupLevelPolicyAssignment", + "description": "Summarizes policy states for the resource group level policy assignment.", + "parameters": [ + { + "$ref": "#/parameters/policyStatesSummaryResourceParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/authorizationNamespaceParameter" + }, + { + "$ref": "#/parameters/policyAssignmentNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/fromParameter" + }, + { + "$ref": "#/parameters/toParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "Summarize results.", + "schema": { + "$ref": "#/definitions/SummarizeResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Summarize at policy assignment scope": { + "$ref": "./examples/PolicyStates_SummarizeResourceGroupLevelPolicyAssignmentScope.json" + } + } + } + } + }, + "x-ms-paths": { + "{nextLink}?Next paging op for policy states": { + "post": { + "operationId": "PolicyStates_NextLink", + "description": "Subsequent post calls to the next link", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/skipTokenParameter" + }, + { + "name": "nextLink", + "in": "path", + "required": true, + "type": "string", + "description": "Next link for list operation.", + "x-ms-skip-url-encoding": true + } + ], + "responses": { + "200": { + "description": "Query results.", + "schema": { + "$ref": "#/definitions/PolicyStatesQueryResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/QueryFailure" + } + } + }, + "x-ms-examples": { + "Query latest at resource group level policy assignment scope with next link": { + "$ref": "./examples/PolicyStates_QueryManagementGroupScopeNextLinkSkipToken.json" + } + } + } + } + }, + "definitions": { + "PolicyStatesQueryResults": { + "description": "Query results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of policy state records returned.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "@odata.nextLink": { + "description": "Odata next link; URL to get the next set of results.", + "type": "string" + }, + "value": { + "description": "Query results.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyState" + }, + "x-ms-identifiers": [] + } + } + }, + "PolicyState": { + "type": "object", + "description": "Policy state record.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since policy state records do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "timestamp": { + "description": "Timestamp for the policy state record.", + "type": "string", + "format": "date-time" + }, + "resourceId": { + "description": "Resource ID.", + "type": "string" + }, + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "effectiveParameters": { + "description": "Effective parameters for the policy assignment.", + "type": "string" + }, + "isCompliant": { + "description": "Flag which states whether the resource is compliant against the policy assignment it was evaluated against. This property is deprecated; please use ComplianceState instead.", + "type": "boolean" + }, + "subscriptionId": { + "description": "Subscription ID.", + "type": "string" + }, + "resourceType": { + "description": "Resource type.", + "type": "string" + }, + "resourceLocation": { + "description": "Resource location.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + }, + "resourceTags": { + "description": "List of resource tags.", + "type": "string" + }, + "policyAssignmentName": { + "description": "Policy assignment name.", + "type": "string" + }, + "policyAssignmentOwner": { + "description": "Policy assignment owner.", + "type": "string" + }, + "policyAssignmentParameters": { + "description": "Policy assignment parameters.", + "type": "string" + }, + "policyAssignmentScope": { + "description": "Policy assignment scope.", + "type": "string" + }, + "policyDefinitionName": { + "description": "Policy definition name.", + "type": "string" + }, + "policyDefinitionAction": { + "description": "Policy definition action, i.e. effect.", + "type": "string" + }, + "policyDefinitionCategory": { + "description": "Policy definition category.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionName": { + "description": "Policy set definition name, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionOwner": { + "description": "Policy set definition owner, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionCategory": { + "description": "Policy set definition category, if the policy assignment is for a policy set.", + "type": "string" + }, + "policySetDefinitionParameters": { + "description": "Policy set definition parameters, if the policy assignment is for a policy set.", + "type": "string" + }, + "managementGroupIds": { + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set.", + "type": "string" + }, + "complianceState": { + "description": "Compliance state of the resource.", + "type": "string" + }, + "policyEvaluationDetails": { + "description": "Policy evaluation details.", + "type": "object", + "$ref": "#/definitions/PolicyEvaluationDetails" + }, + "policyDefinitionGroupNames": { + "description": "Policy definition group names.", + "type": "array", + "items": { + "type": "string" + } + }, + "components": { + "description": "Components state compliance records populated only when URL contains $expand=components clause.", + "type": "array", + "items": { + "$ref": "#/definitions/ComponentStateDetails" + } + }, + "policyDefinitionVersion": { + "description": "Evaluated policy definition version.", + "type": "string", + "readOnly": true + }, + "policySetDefinitionVersion": { + "description": "Evaluated policy set definition version.", + "type": "string", + "readOnly": true + }, + "policyAssignmentVersion": { + "description": "Evaluated policy assignment version.", + "type": "string", + "readOnly": true + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "PolicyEvaluationDetails": { + "type": "object", + "description": "Policy evaluation details.", + "properties": { + "evaluatedExpressions": { + "description": "Details of the evaluated expressions.", + "type": "array", + "items": { + "$ref": "#/definitions/ExpressionEvaluationDetails" + }, + "x-ms-identifiers": [] + }, + "ifNotExistsDetails": { + "description": "Evaluation details of IfNotExists effect.", + "type": "object", + "$ref": "#/definitions/IfNotExistsEvaluationDetails" + } + } + }, + "ComponentStateDetails": { + "type": "object", + "description": "Component state details.", + "properties": { + "id": { + "description": "Component Id.", + "type": "string" + }, + "type": { + "description": "Component type.", + "type": "string" + }, + "name": { + "description": "Component name.", + "type": "string" + }, + "timestamp": { + "description": "Component compliance evaluation timestamp.", + "type": "string", + "format": "date-time" + }, + "complianceState": { + "description": "Component compliance state.", + "type": "string" + } + }, + "additionalProperties": { + "description": "The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated" + } + }, + "ExpressionEvaluationDetails": { + "type": "object", + "description": "Evaluation details of policy language expressions.", + "properties": { + "result": { + "description": "Evaluation result.", + "type": "string" + }, + "expression": { + "description": "Expression evaluated.", + "type": "string" + }, + "expressionKind": { + "description": "The kind of expression that was evaluated.", + "type": "string", + "readOnly": true + }, + "path": { + "description": "Property path if the expression is a field or an alias.", + "type": "string" + }, + "expressionValue": { + "description": "Value of the expression.", + "type": "object" + }, + "targetValue": { + "description": "Target value to be compared with the expression value.", + "type": "object" + }, + "operator": { + "description": "Operator to compare the expression value and the target value.", + "type": "string" + } + } + }, + "IfNotExistsEvaluationDetails": { + "type": "object", + "description": "Evaluation details of IfNotExists effect.", + "properties": { + "resourceId": { + "description": "ID of the last evaluated resource for IfNotExists effect.", + "type": "string" + }, + "totalResources": { + "description": "Total number of resources to which the existence condition is applicable.", + "type": "integer" + } + } + }, + "SummarizeResults": { + "description": "Summarize action results.", + "properties": { + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "@odata.count": { + "description": "OData entity count; represents the number of summaries returned; always set to 1.", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 1 + }, + "value": { + "description": "Summarize action results.", + "type": "array", + "items": { + "$ref": "#/definitions/Summary" + }, + "x-ms-identifiers": [] + } + } + }, + "Summary": { + "description": "Summary results.", + "properties": { + "@odata.id": { + "description": "OData entity ID; always set to null since summaries do not have an entity ID.", + "type": "string" + }, + "@odata.context": { + "description": "OData context string; used by OData clients to resolve type information based on metadata.", + "type": "string" + }, + "results": { + "description": "Compliance summary for all policy assignments.", + "$ref": "#/definitions/SummaryResults" + }, + "policyAssignments": { + "description": "Policy assignments summary.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyAssignmentSummary" + }, + "x-ms-identifiers": [ + "policyAssignmentId" + ] + } + } + }, + "SummaryResults": { + "description": "Compliance summary on a particular summary level.", + "properties": { + "queryResultsUri": { + "description": "HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the compliance summary. This property will not be available by default in future API versions, but could be queried explicitly.", + "type": "string" + }, + "nonCompliantResources": { + "description": "Number of non-compliant resources.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "nonCompliantPolicies": { + "description": "Number of non-compliant policies.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "resourceDetails": { + "description": "The resources summary at this level.", + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceDetail" + }, + "x-ms-identifiers": [] + }, + "policyDetails": { + "description": "The policy artifact summary at this level. For query scope level, it represents policy assignment summary. For policy assignment level, it represents policy definitions summary.", + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceDetail" + }, + "x-ms-identifiers": [] + }, + "policyGroupDetails": { + "description": "The policy definition group summary at this level.", + "type": "array", + "items": { + "$ref": "#/definitions/ComplianceDetail" + }, + "x-ms-identifiers": [] + } + } + }, + "ComplianceDetail": { + "description": "The compliance state rollup.", + "properties": { + "complianceState": { + "description": "The compliance state.", + "type": "string" + }, + "count": { + "description": "Summarized count value for this compliance state.", + "type": "integer", + "format": "int32" + } + } + }, + "PolicyAssignmentSummary": { + "description": "Policy assignment summary.", + "properties": { + "policyAssignmentId": { + "description": "Policy assignment ID.", + "type": "string" + }, + "policySetDefinitionId": { + "description": "Policy set definition ID, if the policy assignment is for a policy set.", + "type": "string" + }, + "results": { + "description": "Compliance summary for the policy assignment.", + "$ref": "#/definitions/SummaryResults" + }, + "policyDefinitions": { + "description": "Policy definitions summary.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyDefinitionSummary" + }, + "x-ms-identifiers": [ + "policyDefinitionId" + ] + }, + "policyGroups": { + "description": "Policy definition group summary.", + "type": "array", + "items": { + "$ref": "#/definitions/PolicyGroupSummary" + }, + "x-ms-identifiers": [ + "policyGroupName" + ] + } + } + }, + "PolicyDefinitionSummary": { + "description": "Policy definition summary.", + "properties": { + "policyDefinitionId": { + "description": "Policy definition ID.", + "type": "string" + }, + "policyDefinitionReferenceId": { + "description": "Policy definition reference ID.", + "type": "string" + }, + "policyDefinitionGroupNames": { + "description": "Policy definition group names.", + "type": "array", + "items": { + "type": "string" + } + }, + "effect": { + "description": "Policy effect, i.e. policy definition action.", + "type": "string" + }, + "results": { + "description": "Compliance summary for the policy definition.", + "$ref": "#/definitions/SummaryResults" + } + } + }, + "PolicyGroupSummary": { + "description": "Policy definition group summary.", + "properties": { + "policyGroupName": { + "description": "Policy group name.", + "type": "string" + }, + "results": { + "description": "Compliance summary for the policy definition group.", + "$ref": "#/definitions/SummaryResults" + } + } + }, + "QueryFailure": { + "description": "Error response.", + "properties": { + "error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "MetadataDocument": { + "description": "Metadata XML document.", + "type": "string" + } + }, + "parameters": { + "policyStatesResourceParameter": { + "name": "policyStatesResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "default", + "latest" + ], + "x-ms-enum": { + "name": "PolicyStatesResource", + "modelAsString": true + }, + "description": "The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s).", + "x-ms-parameter-location": "method" + }, + "policyStatesSummaryResourceParameter": { + "name": "policyStatesSummaryResource", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "latest" + ], + "x-ms-enum": { + "name": "PolicyStatesSummaryResourceType", + "modelAsString": true + }, + "description": "The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupNameParameter": { + "name": "managementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Management group name.", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "authorizationNamespaceParameter": { + "name": "authorizationNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Authorization" + ], + "x-ms-enum": { + "name": "AuthorizationNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Authorization resource provider; only \"Microsoft.Authorization\" is allowed.", + "x-ms-parameter-location": "method" + }, + "policySetDefinitionNameParameter": { + "name": "policySetDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy set definition name.", + "x-ms-parameter-location": "method" + }, + "policyDefinitionNameParameter": { + "name": "policyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy definition name.", + "x-ms-parameter-location": "method" + }, + "policyAssignmentNameParameter": { + "name": "policyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Policy assignment name.", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "orderByParameter": { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Ordering expression using OData notation. One or more comma-separated column names with an optional \"desc\" (the default) or \"asc\", e.g. \"$orderby=PolicyAssignmentId, ResourceId asc\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "OrderBy" + }, + "selectParameter": { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Select expression using OData notation. Limits the columns on each record to just those requested, e.g. \"$select=PolicyAssignmentId, ResourceId\".", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Select" + }, + "fromParameter": { + "name": "$from", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day).", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "From" + }, + "toParameter": { + "name": "$to", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "To" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "applyParameter": { + "name": "$apply", + "in": "query", + "required": false, + "type": "string", + "description": "OData apply expression for aggregations.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Apply" + }, + "expandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to expand components use $expand=components", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Expand" + }, + "skipTokenParameter": { + "name": "$skiptoken", + "in": "query", + "required": false, + "type": "string", + "description": "Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "SkipToken" + } + } +} diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/remediations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/remediations.json new file mode 100644 index 000000000000..fb499be4381e --- /dev/null +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2024-10-01/remediations.json @@ -0,0 +1,1454 @@ +{ + "swagger": "2.0", + "info": { + "title": "RemediationsClient", + "version": "2024-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments": { + "post": { + "operationId": "Remediations_ListDeploymentsAtManagementGroup", + "description": "Gets all deployments for a remediation at management group scope.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation deployments.", + "schema": { + "$ref": "#/definitions/RemediationDeploymentsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deployments for a remediation at management group scope": { + "$ref": "./examples/Remediations_ListDeploymentsManagementGroupScope.json" + } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel": { + "post": { + "operationId": "Remediations_CancelAtManagementGroup", + "description": "Cancels a remediation at management group scope.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The remediation that was canceled.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a remediation at management group scope": { + "$ref": "./examples/Remediations_CancelManagementGroupScope.json" + } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations": { + "get": { + "operationId": "Remediations_ListForManagementGroup", + "description": "Gets all remediations for the management group.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediations.", + "schema": { + "$ref": "#/definitions/RemediationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List remediations at management group scope": { + "$ref": "./examples/Remediations_ListManagementGroupScope.json" + }, + "List remediations at management group scope with query parameters": { + "$ref": "./examples/Remediations_ListManagementGroupScope_WithQuery.json" + } + } + } + }, + "/providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}": { + "put": { + "operationId": "Remediations_CreateOrUpdateAtManagementGroup", + "description": "Creates or updates a remediation at management group scope.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Remediation" + }, + "description": "The remediation parameters." + } + ], + "responses": { + "200": { + "description": "The updated remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "201": { + "description": "The created remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create remediation at management group scope": { + "$ref": "./examples/Remediations_CreateManagementGroupScope.json" + } + } + }, + "get": { + "operationId": "Remediations_GetAtManagementGroup", + "description": "Gets an existing remediation at management group scope.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get remediation at management group scope": { + "$ref": "./examples/Remediations_GetManagementGroupScope.json" + } + } + }, + "delete": { + "operationId": "Remediations_DeleteAtManagementGroup", + "description": "Deletes an existing remediation at management group scope.", + "parameters": [ + { + "$ref": "#/parameters/managementGroupsNamespaceParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "204": { + "description": "The remediation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete remediation at management group scope": { + "$ref": "./examples/Remediations_DeleteManagementGroupScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments": { + "post": { + "operationId": "Remediations_ListDeploymentsAtSubscription", + "description": "Gets all deployments for a remediation at subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation deployments.", + "schema": { + "$ref": "#/definitions/RemediationDeploymentsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deployments for a remediation at subscription scope": { + "$ref": "./examples/Remediations_ListDeploymentsSubscriptionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel": { + "post": { + "operationId": "Remediations_CancelAtSubscription", + "description": "Cancels a remediation at subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The remediation that was canceled.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a remediation at subscription scope": { + "$ref": "./examples/Remediations_CancelSubscriptionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations": { + "get": { + "operationId": "Remediations_ListForSubscription", + "description": "Gets all remediations for the subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediations.", + "schema": { + "$ref": "#/definitions/RemediationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List remediations at subscription scope": { + "$ref": "./examples/Remediations_ListSubscriptionScope.json" + }, + "List remediations at subscription scope with query parameters": { + "$ref": "./examples/Remediations_ListSubscriptionScope_WithQuery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}": { + "put": { + "operationId": "Remediations_CreateOrUpdateAtSubscription", + "description": "Creates or updates a remediation at subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Remediation" + }, + "description": "The remediation parameters." + } + ], + "responses": { + "200": { + "description": "The updated remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "201": { + "description": "The created remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create remediation at subscription scope": { + "$ref": "./examples/Remediations_CreateSubscriptionScope.json" + }, + "Create remediation at subscription scope with all properties": { + "$ref": "./examples/Remediations_CreateSubscriptionScope_AllProperties.json" + }, + "Create remediation at subscription scope with resourceIds filter": { + "$ref": "./examples/Remediations_CreateSubscriptionScope_ResourceIdsFilter.json" + } + } + }, + "get": { + "operationId": "Remediations_GetAtSubscription", + "description": "Gets an existing remediation at subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get remediation at subscription scope": { + "$ref": "./examples/Remediations_GetSubscriptionScope.json" + } + } + }, + "delete": { + "operationId": "Remediations_DeleteAtSubscription", + "description": "Deletes an existing remediation at subscription scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "204": { + "description": "The remediation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete remediation at subscription scope": { + "$ref": "./examples/Remediations_DeleteSubscriptionScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments": { + "post": { + "operationId": "Remediations_ListDeploymentsAtResourceGroup", + "description": "Gets all deployments for a remediation at resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation deployments.", + "schema": { + "$ref": "#/definitions/RemediationDeploymentsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deployments for a remediation at resource group scope": { + "$ref": "./examples/Remediations_ListDeploymentsResourceGroupScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel": { + "post": { + "operationId": "Remediations_CancelAtResourceGroup", + "description": "Cancels a remediation at resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The remediation that was canceled.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a remediation at resource group scope": { + "$ref": "./examples/Remediations_CancelResourceGroupScope.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations": { + "get": { + "operationId": "Remediations_ListForResourceGroup", + "description": "Gets all remediations for the subscription.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediations.", + "schema": { + "$ref": "#/definitions/RemediationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List remediations at resource group scope": { + "$ref": "./examples/Remediations_ListResourceGroupScope.json" + }, + "List remediations at resource group scope with query parameters": { + "$ref": "./examples/Remediations_ListResourceGroupScope_WithQuery.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/remediations/{remediationName}": { + "put": { + "operationId": "Remediations_CreateOrUpdateAtResourceGroup", + "description": "Creates or updates a remediation at resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Remediation" + }, + "description": "The remediation parameters." + } + ], + "responses": { + "200": { + "description": "The updated remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "201": { + "description": "The created remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create remediation at resource group scope": { + "$ref": "./examples/Remediations_CreateResourceGroupScope.json" + } + } + }, + "get": { + "operationId": "Remediations_GetAtResourceGroup", + "description": "Gets an existing remediation at resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get remediation at resource group scope": { + "$ref": "./examples/Remediations_GetResourceGroupScope.json" + } + } + }, + "delete": { + "operationId": "Remediations_DeleteAtResourceGroup", + "description": "Deletes an existing remediation at resource group scope.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "204": { + "description": "The remediation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete remediation at resource group scope": { + "$ref": "./examples/Remediations_DeleteResourceGroupScope.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments": { + "post": { + "operationId": "Remediations_ListDeploymentsAtResource", + "description": "Gets all deployments for a remediation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation deployments.", + "schema": { + "$ref": "#/definitions/RemediationDeploymentsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List deployments for a remediation at individual resource scope": { + "$ref": "./examples/Remediations_ListDeploymentsResourceScope.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel": { + "post": { + "operationId": "Remediations_CancelAtResource", + "description": "Cancel a remediation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The remediation that was canceled.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Cancel a remediation at individual resource scope": { + "$ref": "./examples/Remediations_CancelResourceScope.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/remediations": { + "get": { + "operationId": "Remediations_ListForResource", + "description": "Gets all remediations for a resource.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/topParameter" + }, + { + "$ref": "#/parameters/filterParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediations.", + "schema": { + "$ref": "#/definitions/RemediationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List remediations at individual resource scope": { + "$ref": "./examples/Remediations_ListResourceScope.json" + }, + "List remediations at individual resource scope with query parameters": { + "$ref": "./examples/Remediations_ListResourceScope_WithQuery.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}": { + "put": { + "operationId": "Remediations_CreateOrUpdateAtResource", + "description": "Creates or updates a remediation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Remediation" + }, + "description": "The remediation parameters." + } + ], + "responses": { + "200": { + "description": "The updated remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "201": { + "description": "The created remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create remediation at individual resource scope": { + "$ref": "./examples/Remediations_CreateResourceScope.json" + } + } + }, + "get": { + "operationId": "Remediations_GetAtResource", + "description": "Gets an existing remediation at resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The retrieved remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get remediation at individual resource scope": { + "$ref": "./examples/Remediations_GetResourceScope.json" + } + } + }, + "delete": { + "operationId": "Remediations_DeleteAtResource", + "description": "Deletes an existing remediation at individual resource scope.", + "parameters": [ + { + "$ref": "#/parameters/resourceIdParameter" + }, + { + "$ref": "#/parameters/remediationNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deleted remediation.", + "schema": { + "$ref": "#/definitions/Remediation" + } + }, + "204": { + "description": "The remediation did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete remediation at individual resource scope": { + "$ref": "./examples/Remediations_DeleteResourceScope.json" + } + } + } + } + }, + "definitions": { + "RemediationListResult": { + "description": "List of remediations.", + "properties": { + "value": { + "description": "Array of remediation definitions.", + "type": "array", + "items": { + "$ref": "#/definitions/Remediation" + }, + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + } + }, + "RemediationDeploymentsListResult": { + "description": "List of deployments for a remediation.", + "properties": { + "value": { + "description": "Array of deployments for the remediation.", + "type": "array", + "items": { + "$ref": "#/definitions/RemediationDeployment" + }, + "x-ms-identifiers": [ + "remediatedResourceId" + ], + "readOnly": true + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + } + }, + "RemediationDeployment": { + "description": "Details of a single deployment created by the remediation.", + "properties": { + "remediatedResourceId": { + "type": "string", + "description": "Resource ID of the resource that is being remediated by the deployment.", + "readOnly": true + }, + "deploymentId": { + "type": "string", + "description": "Resource ID of the template deployment that will remediate the resource.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of the remediation deployment.", + "readOnly": true + }, + "resourceLocation": { + "type": "string", + "description": "Location of the resource that is being remediated.", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "Error encountered while remediated the resource.", + "readOnly": true + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "The time at which the remediation was created.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time", + "description": "The time at which the remediation deployment was last updated.", + "readOnly": true + } + } + }, + "Remediation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RemediationProperties", + "description": "Properties for the remediation." + }, + "id": { + "type": "string", + "description": "The ID of the remediation.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of the remediation.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "The name of the remediation.", + "readOnly": true + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "description": "The remediation definition.", + "x-ms-azure-resource": true + }, + "RemediationProperties": { + "properties": { + "policyAssignmentId": { + "type": "string", + "description": "The resource ID of the policy assignment that should be remediated." + }, + "policyDefinitionReferenceId": { + "type": "string", + "description": "The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition." + }, + "resourceDiscoveryMode": { + "type": "string", + "enum": [ + "ExistingNonCompliant", + "ReEvaluateCompliance" + ], + "x-ms-enum": { + "name": "ResourceDiscoveryMode", + "modelAsString": true, + "values": [ + { + "value": "ExistingNonCompliant", + "description": "Remediate resources that are already known to be non-compliant." + }, + { + "value": "ReEvaluateCompliance", + "description": "Re-evaluate the compliance state of resources and then remediate the resources found to be non-compliant. The resourceIds filter cannot be used in this mode." + } + ] + }, + "description": "The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified." + }, + "provisioningState": { + "type": "string", + "description": "The status of the remediation. This refers to the entire remediation task, not individual deployments. Allowed values are Evaluating, Canceled, Cancelling, Failed, Complete, or Succeeded.", + "readOnly": true + }, + "createdOn": { + "type": "string", + "format": "date-time", + "description": "The time at which the remediation was created.", + "readOnly": true + }, + "lastUpdatedOn": { + "type": "string", + "format": "date-time", + "description": "The time at which the remediation was last updated.", + "readOnly": true + }, + "filters": { + "$ref": "#/definitions/RemediationFilters", + "description": "The filters that will be applied to determine which resources to remediate." + }, + "deploymentStatus": { + "$ref": "#/definitions/RemediationDeploymentSummary", + "description": "The deployment status summary for all deployments created by the remediation.", + "readOnly": true + }, + "statusMessage": { + "type": "string", + "description": "The remediation status message. Provides additional details regarding the state of the remediation.", + "readOnly": true + }, + "correlationId": { + "type": "string", + "description": "The remediation correlation Id. Can be used to find events related to the remediation in the activity log.", + "readOnly": true + }, + "resourceCount": { + "type": "integer", + "format": "int32", + "description": "Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used." + }, + "parallelDeployments": { + "type": "integer", + "format": "int32", + "description": "Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used." + }, + "failureThreshold": { + "type": "object", + "properties": { + "percentage": { + "type": "number", + "format": "float", + "description": "A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold." + } + }, + "description": "The remediation failure threshold settings" + } + }, + "description": "The remediation properties." + }, + "RemediationFilters": { + "properties": { + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The resource locations that will be remediated." + }, + "resourceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the resources that will be remediated. Can specify at most 100 IDs. This filter cannot be used when ReEvaluateCompliance is set to ReEvaluateCompliance, and cannot be empty if provided." + } + }, + "description": "The filters that will be applied to determine which resources to remediate." + }, + "RemediationDeploymentSummary": { + "properties": { + "totalDeployments": { + "type": "integer", + "description": "The number of deployments required by the remediation.", + "readOnly": true + }, + "successfulDeployments": { + "type": "integer", + "description": "The number of deployments required by the remediation that have succeeded.", + "readOnly": true + }, + "failedDeployments": { + "type": "integer", + "description": "The number of deployments required by the remediation that have failed.", + "readOnly": true + } + }, + "description": "The deployment status summary for all deployments created by the remediation." + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "additionalInfo": { + "description": "Additional scenario specific error details.", + "type": "array", + "items": { + "$ref": "#/definitions/TypedErrorInfo" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "TypedErrorInfo": { + "description": "Scenario specific error details.", + "properties": { + "type": { + "description": "The type of included error details.", + "type": "string", + "readOnly": true + }, + "info": { + "description": "The scenario specific error details.", + "readOnly": true + } + } + } + }, + "parameters": { + "remediationNameParameter": { + "name": "remediationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the remediation.", + "x-ms-parameter-location": "method" + }, + "managementGroupsNamespaceParameter": { + "name": "managementGroupsNamespace", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "Microsoft.Management" + ], + "x-ms-enum": { + "name": "ManagementGroupsNamespaceType", + "modelAsString": false + }, + "description": "The namespace for Microsoft Management RP; only \"Microsoft.Management\" is allowed.", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "Management group ID.", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group name.", + "x-ms-parameter-location": "method" + }, + "resourceIdParameter": { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "Resource ID.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "topParameter": { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Maximum number of records to return.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Top" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression.", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "QueryOptions" + }, + "x-ms-client-name": "Filter" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Microsoft Azure subscription ID." + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/policyinsights/resource-manager/readme.md b/specification/policyinsights/resource-manager/readme.md index 3803a5f20d39..06cc8f86a12c 100644 --- a/specification/policyinsights/resource-manager/readme.md +++ b/specification/policyinsights/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the PolicyInsights API. ``` yaml title: PolicyInsightsClient openapi-type: arm -tag: package-2023-03 +tag: package-2024-10 ``` ### Validations @@ -138,6 +138,22 @@ directive: transform: delete $['post']['x-ms-pageable']['operationName'] ``` +### Tag: package-2024-10 + +These settings apply only when `--tag=package-2024-10` is specified on the command line. + +```yaml $(tag) == 'package-2024-10' +input-file: + - Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json + - Microsoft.PolicyInsights/stable/2024-10-01/remediations.json + - Microsoft.PolicyInsights/stable/2024-10-01/policyEvents.json + - Microsoft.PolicyInsights/stable/2024-10-01/policyStates.json + - Microsoft.PolicyInsights/stable/2024-10-01/policyMetadata.json + - Microsoft.PolicyInsights/stable/2024-10-01/checkPolicyRestrictions.json + - Microsoft.PolicyInsights/stable/2024-10-01/componentPolicyStates.json + - Microsoft.PolicyInsights/stable/2024-10-01/operations.json + - Microsoft.PolicyInsights/stable/2024-10-01/attestations.json +``` ### Tag: package-2023-03 From 59f7381be37e16ae2777339cdaf3fa2f88a6411d Mon Sep 17 00:00:00 2001 From: Daniel Jurek <djurek@microsoft.com> Date: Wed, 9 Oct 2024 11:00:48 -0700 Subject: [PATCH 075/101] Removes azure-resource-manager-schemas from SDK automation. It can be re-added without reverting this commit. (#30893) This change produces an extra warning but no obvious new errors. --- specificationRepositoryConfiguration.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index b623d3513ea6..9c6ad529e741 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -29,10 +29,6 @@ "integrationRepository": "azure-sdk/azure-sdk-for-python", "mainRepository": "Azure/azure-sdk-for-python" }, - "azure-resource-manager-schemas": { - "integrationRepository": "azure-sdk/azure-resource-manager-schemas", - "mainRepository": "Azure/azure-resource-manager-schemas" - }, "azure-powershell": { "integrationRepository": "azure-sdk/azure-powershell", "mainRepository": "Azure/azure-powershell" From 1a49c263cc521ad1e0aef27c07a626156d697c8b Mon Sep 17 00:00:00 2001 From: PriyankaHariharan <113563202+PriyankaHariharan@users.noreply.github.com> Date: Wed, 9 Oct 2024 11:45:43 -0700 Subject: [PATCH 076/101] [Microsoft.AwsConnector] Add awsConnector RP for GA version 20241201 (#30601) * add awsConnector RP for GA version 20241201 * update readme * remove unwanted json * remove policheck word pee * fix json * add suppressions in readme * remove iam polciy group, iampolicy user, iam policy role and ec2 instance type info * remove duplicate tag * remove createvolumepermsission as no SDK or CC support * update IAM role * update typespec to ArmResourceCreateOrReplaceAsync from ArmResourceCreateOrUpdateAsync, fix swaggers that were updated to SM * add new resources and fix some more object,string to Record<unknown> type, remove elasticLoadBalancingV2ListenerRule * fix cSpell and poliCheck errors * remove /wafv2WebACLAssociation /wafv2WebACL wafv2IPSet sageMakerImage sageMakerDeviceSummary licenseManagerLicense iamUser elasticsearchDomain applicationAutoScalingScalableTarget, and update cSpell * update typespec operation id from CreateOrUpdate to CreateOrReplace and fix RestApi policy string property * remove go sdk from readme config * remove sage maker image * remove s3MultiRegionAccessPointPolicy CC resource, replaced by SM * remove route53 CC and S3MulitRegionAccessPointPolicy CC * add TargetHealthDescription and FunctionCodeLocation * remove unnecessary example file * add start/stop/restart for ec2Instances Async POST calls * remove sage maker device * update ec2 stop api and remove restart async * fix examples resources id * update AWS::CloudWatch::Alarm threshold number to float * update AWS::RDS::DBCluster MinCapacity/MaxCapacity number to double --- cSpell.json | 178 +- ...cessAnalyzerAnalyzers_CreateOrReplace.json | 196 + .../AccessAnalyzerAnalyzers_Delete.json | 18 + .../AccessAnalyzerAnalyzers_Get.json | 77 + ...AnalyzerAnalyzers_ListByResourceGroup.json | 81 + ...sAnalyzerAnalyzers_ListBySubscription.json | 80 + .../AccessAnalyzerAnalyzers_Update.json | 87 + .../main.tsp | 178 + .../tspconfig.yaml | 13 + ...mCertificateSummaries_CreateOrReplace.json | 196 + .../AcmCertificateSummaries_Delete.json | 18 + .../AcmCertificateSummaries_Get.json | 77 + ...tificateSummaries_ListByResourceGroup.json | 81 + ...rtificateSummaries_ListBySubscription.json | 80 + .../AcmCertificateSummaries_Update.json | 87 + .../AcmCertificateSummary.Management/main.tsp | 375 + .../tspconfig.yaml | 13 + .../ApiGatewayRestApis_CreateOrReplace.json | 214 + .../2024-12-01/ApiGatewayRestApis_Delete.json | 18 + .../2024-12-01/ApiGatewayRestApis_Get.json | 83 + ...piGatewayRestApis_ListByResourceGroup.json | 87 + ...ApiGatewayRestApis_ListBySubscription.json | 86 + .../2024-12-01/ApiGatewayRestApis_Update.json | 93 + .../ApiGatewayRestApi.Management/main.tsp | 195 + .../tspconfig.yaml | 13 + .../ApiGatewayStages_CreateOrReplace.json | 232 + .../2024-12-01/ApiGatewayStages_Delete.json | 18 + .../2024-12-01/ApiGatewayStages_Get.json | 89 + .../ApiGatewayStages_ListByResourceGroup.json | 93 + .../ApiGatewayStages_ListBySubscription.json | 92 + .../2024-12-01/ApiGatewayStages_Update.json | 99 + .../ApiGatewayStage.Management/main.tsp | 221 + .../ApiGatewayStage.Management/tspconfig.yaml | 13 + .../AppSyncGraphqlApis_CreateOrReplace.json | 373 + .../2024-12-01/AppSyncGraphqlApis_Delete.json | 18 + .../2024-12-01/AppSyncGraphqlApis_Get.json | 136 + ...ppSyncGraphqlApis_ListByResourceGroup.json | 140 + ...AppSyncGraphqlApis_ListBySubscription.json | 139 + .../2024-12-01/AppSyncGraphqlApis_Update.json | 146 + .../AppSyncGraphqlApi.Management/main.tsp | 493 ++ .../tspconfig.yaml | 13 + ...lingAutoScalingGroups_CreateOrReplace.json | 634 ++ .../AutoScalingAutoScalingGroups_Delete.json | 18 + .../AutoScalingAutoScalingGroups_Get.json | 223 + ...AutoScalingGroups_ListByResourceGroup.json | 227 + ...gAutoScalingGroups_ListBySubscription.json | 226 + .../AutoScalingAutoScalingGroups_Update.json | 233 + .../main.tsp | 578 ++ .../tspconfig.yaml | 13 + .../examples/2024-12-01/Operations_List.json | 28 + .../Awsconnector.Management/main.tsp | 33 + .../Awsconnector.Management/tspconfig.yaml | 13 + .../CloudFormationStacks_CreateOrReplace.json | 217 + .../CloudFormationStacks_Delete.json | 18 + .../2024-12-01/CloudFormationStacks_Get.json | 84 + ...udFormationStacks_ListByResourceGroup.json | 88 + ...oudFormationStacks_ListBySubscription.json | 87 + .../CloudFormationStacks_Update.json | 94 + .../CloudFormationStack.Management/main.tsp | 288 + .../tspconfig.yaml | 13 + ...oudFormationStackSets_CreateOrReplace.json | 292 + .../CloudFormationStackSets_Delete.json | 18 + .../CloudFormationStackSets_Get.json | 109 + ...ormationStackSets_ListByResourceGroup.json | 113 + ...FormationStackSets_ListBySubscription.json | 112 + .../CloudFormationStackSets_Update.json | 119 + .../main.tsp | 313 + .../tspconfig.yaml | 13 + ...oudFrontDistributions_CreateOrReplace.json | 802 ++ .../CloudFrontDistributions_Delete.json | 18 + .../CloudFrontDistributions_Get.json | 279 + ...rontDistributions_ListByResourceGroup.json | 283 + ...FrontDistributions_ListBySubscription.json | 282 + .../CloudFrontDistributions_Update.json | 289 + .../main.tsp | 699 ++ .../tspconfig.yaml | 13 + .../CloudTrailTrails_CreateOrReplace.json | 310 + .../2024-12-01/CloudTrailTrails_Delete.json | 18 + .../2024-12-01/CloudTrailTrails_Get.json | 115 + .../CloudTrailTrails_ListByResourceGroup.json | 119 + .../CloudTrailTrails_ListBySubscription.json | 118 + .../2024-12-01/CloudTrailTrails_Update.json | 125 + .../CloudTrailTrail.Management/main.tsp | 273 + .../CloudTrailTrail.Management/tspconfig.yaml | 13 + .../CloudWatchAlarms_CreateOrReplace.json | 289 + .../2024-12-01/CloudWatchAlarms_Delete.json | 18 + .../2024-12-01/CloudWatchAlarms_Get.json | 108 + .../CloudWatchAlarms_ListByResourceGroup.json | 112 + .../CloudWatchAlarms_ListBySubscription.json | 111 + .../2024-12-01/CloudWatchAlarms_Update.json | 118 + .../CloudWatchAlarm.Management/main.tsp | 260 + .../CloudWatchAlarm.Management/tspconfig.yaml | 13 + .../CodeBuildProjects_CreateOrReplace.json | 817 ++ .../2024-12-01/CodeBuildProjects_Delete.json | 18 + .../2024-12-01/CodeBuildProjects_Get.json | 284 + ...CodeBuildProjects_ListByResourceGroup.json | 288 + .../CodeBuildProjects_ListBySubscription.json | 287 + .../2024-12-01/CodeBuildProjects_Update.json | 294 + .../CodeBuildProject.Management/main.tsp | 1098 +++ .../tspconfig.yaml | 13 + ...ourceCredentialsInfos_CreateOrReplace.json | 124 + ...odeBuildSourceCredentialsInfos_Delete.json | 18 + .../CodeBuildSourceCredentialsInfos_Get.json | 53 + ...eCredentialsInfos_ListByResourceGroup.json | 57 + ...ceCredentialsInfos_ListBySubscription.json | 56 + ...odeBuildSourceCredentialsInfos_Update.json | 63 + .../main.tsp | 178 + .../tspconfig.yaml | 13 + ...onfigurationRecorders_CreateOrReplace.json | 205 + ...gServiceConfigurationRecorders_Delete.json | 18 + ...nfigServiceConfigurationRecorders_Get.json | 80 + ...gurationRecorders_ListByResourceGroup.json | 84 + ...igurationRecorders_ListBySubscription.json | 83 + ...gServiceConfigurationRecorders_Update.json | 90 + .../main.tsp | 1476 ++++ .../tspconfig.yaml | 13 + ...ationRecorderStatuses_CreateOrReplace.json | 130 + ...eConfigurationRecorderStatuses_Delete.json | 18 + ...viceConfigurationRecorderStatuses_Get.json | 55 + ...nRecorderStatuses_ListByResourceGroup.json | 59 + ...onRecorderStatuses_ListBySubscription.json | 58 + ...eConfigurationRecorderStatuses_Update.json | 65 + .../main.tsp | 157 + .../tspconfig.yaml | 13 + ...rviceDeliveryChannels_CreateOrReplace.json | 130 + .../ConfigServiceDeliveryChannels_Delete.json | 18 + .../ConfigServiceDeliveryChannels_Get.json | 55 + ...eDeliveryChannels_ListByResourceGroup.json | 59 + ...ceDeliveryChannels_ListBySubscription.json | 58 + .../ConfigServiceDeliveryChannels_Update.json | 65 + .../main.tsp | 166 + .../tspconfig.yaml | 13 + ...eReplicationInstances_CreateOrReplace.json | 277 + ...ionServiceReplicationInstances_Delete.json | 18 + ...rationServiceReplicationInstances_Get.json | 104 + ...licationInstances_ListByResourceGroup.json | 108 + ...plicationInstances_ListBySubscription.json | 107 + ...ionServiceReplicationInstances_Update.json | 114 + .../main.tsp | 276 + .../tspconfig.yaml | 13 + .../DaxClusters_CreateOrReplace.json | 271 + .../2024-12-01/DaxClusters_Delete.json | 18 + .../examples/2024-12-01/DaxClusters_Get.json | 102 + .../DaxClusters_ListByResourceGroup.json | 106 + .../DaxClusters_ListBySubscription.json | 105 + .../2024-12-01/DaxClusters_Update.json | 112 + .../DaxCluster.Management/main.tsp | 300 + .../DaxCluster.Management/tspconfig.yaml | 13 + ...usBackupsDescriptions_CreateOrReplace.json | 130 + ...bContinuousBackupsDescriptions_Delete.json | 18 + ...moDbContinuousBackupsDescriptions_Get.json | 55 + ...ckupsDescriptions_ListByResourceGroup.json | 59 + ...ackupsDescriptions_ListBySubscription.json | 58 + ...bContinuousBackupsDescriptions_Update.json | 65 + .../main.tsp | 173 + .../tspconfig.yaml | 13 + .../DynamoDbTables_CreateOrReplace.json | 430 + .../2024-12-01/DynamoDbTables_Delete.json | 18 + .../2024-12-01/DynamoDbTables_Get.json | 155 + .../DynamoDbTables_ListByResourceGroup.json | 159 + .../DynamoDbTables_ListBySubscription.json | 158 + .../2024-12-01/DynamoDbTables_Update.json | 165 + .../DynamoDBTable.Management/main.tsp | 421 + .../DynamoDBTable.Management/tspconfig.yaml | 13 + .../Ec2AccountAttributes_CreateOrReplace.json | 118 + .../Ec2AccountAttributes_Delete.json | 18 + .../2024-12-01/Ec2AccountAttributes_Get.json | 51 + ...AccountAttributes_ListByResourceGroup.json | 55 + ...2AccountAttributes_ListBySubscription.json | 54 + .../Ec2AccountAttributes_Update.json | 61 + .../Ec2AccountAttribute.Management/main.tsp | 118 + .../tspconfig.yaml | 13 + .../Ec2Addresses_CreateOrReplace.json | 163 + .../2024-12-01/Ec2Addresses_Delete.json | 18 + .../examples/2024-12-01/Ec2Addresses_Get.json | 66 + .../Ec2Addresses_ListByResourceGroup.json | 70 + .../Ec2Addresses_ListBySubscription.json | 69 + .../2024-12-01/Ec2Addresses_Update.json | 76 + .../Ec2Address.Management/main.tsp | 178 + .../Ec2Address.Management/tspconfig.yaml | 13 + .../Ec2FlowLogs_CreateOrReplace.json | 166 + .../2024-12-01/Ec2FlowLogs_Delete.json | 18 + .../examples/2024-12-01/Ec2FlowLogs_Get.json | 67 + .../Ec2FlowLogs_ListByResourceGroup.json | 71 + .../Ec2FlowLogs_ListBySubscription.json | 70 + .../2024-12-01/Ec2FlowLogs_Update.json | 77 + .../Ec2FlowLog.Management/main.tsp | 223 + .../Ec2FlowLog.Management/tspconfig.yaml | 13 + .../2024-12-01/Ec2Images_CreateOrReplace.json | 361 + .../examples/2024-12-01/Ec2Images_Delete.json | 18 + .../examples/2024-12-01/Ec2Images_Get.json | 132 + .../Ec2Images_ListByResourceGroup.json | 136 + .../Ec2Images_ListBySubscription.json | 135 + .../examples/2024-12-01/Ec2Images_Update.json | 142 + .../awsconnector/Ec2Image.Management/main.tsp | 586 ++ .../Ec2Image.Management/tspconfig.yaml | 13 + .../Ec2Instances_CreateOrReplace.json | 914 +++ .../2024-12-01/Ec2Instances_Delete.json | 16 + .../examples/2024-12-01/Ec2Instances_Get.json | 315 + .../2024-12-01/Ec2Instances_List.json | 320 + .../2024-12-01/Ec2Instances_Start.json | 39 + .../2024-12-01/Ec2Instances_Stop.json | 43 + .../Ec2Instance.Management/main.tsp | 3751 +++++++++ .../Ec2Instance.Management/tspconfig.yaml | 13 + .../Ec2InstanceStatuses_CreateOrReplace.json | 259 + .../Ec2InstanceStatuses_Delete.json | 18 + .../2024-12-01/Ec2InstanceStatuses_Get.json | 98 + ...2InstanceStatuses_ListByResourceGroup.json | 102 + ...c2InstanceStatuses_ListBySubscription.json | 101 + .../Ec2InstanceStatuses_Update.json | 108 + .../Ec2InstanceStatus.Management/main.tsp | 329 + .../tspconfig.yaml | 13 + .../2024-12-01/Ec2Ipams_CreateOrReplace.json | 187 + .../examples/2024-12-01/Ec2Ipams_Delete.json | 18 + .../examples/2024-12-01/Ec2Ipams_Get.json | 74 + .../Ec2Ipams_ListByResourceGroup.json | 78 + .../Ec2Ipams_ListBySubscription.json | 77 + .../examples/2024-12-01/Ec2Ipams_Update.json | 84 + .../awsconnector/Ec2Ipam.Management/main.tsp | 246 + .../Ec2Ipam.Management/tspconfig.yaml | 13 + .../Ec2KeyPairs_CreateOrReplace.json | 136 + .../2024-12-01/Ec2KeyPairs_Delete.json | 18 + .../examples/2024-12-01/Ec2KeyPairs_Get.json | 57 + .../Ec2KeyPairs_ListByResourceGroup.json | 61 + .../Ec2KeyPairs_ListBySubscription.json | 60 + .../2024-12-01/Ec2KeyPairs_Update.json | 67 + .../Ec2KeyPair.Management/main.tsp | 152 + .../Ec2KeyPair.Management/tspconfig.yaml | 13 + .../Ec2NetworkAcls_CreateOrReplace.json | 124 + .../2024-12-01/Ec2NetworkAcls_Delete.json | 18 + .../2024-12-01/Ec2NetworkAcls_Get.json | 53 + .../Ec2NetworkAcls_ListByResourceGroup.json | 57 + .../Ec2NetworkAcls_ListBySubscription.json | 56 + .../2024-12-01/Ec2NetworkAcls_Update.json | 63 + .../Ec2NetworkAcl.Management/main.tsp | 118 + .../Ec2NetworkAcl.Management/tspconfig.yaml | 13 + .../Ec2NetworkInterfaces_CreateOrReplace.json | 256 + .../Ec2NetworkInterfaces_Delete.json | 18 + .../2024-12-01/Ec2NetworkInterfaces_Get.json | 97 + ...NetworkInterfaces_ListByResourceGroup.json | 101 + ...2NetworkInterfaces_ListBySubscription.json | 100 + .../Ec2NetworkInterfaces_Update.json | 107 + .../Ec2NetworkInterface.Management/main.tsp | 240 + .../tspconfig.yaml | 13 + .../Ec2RouteTables_CreateOrReplace.json | 124 + .../2024-12-01/Ec2RouteTables_Delete.json | 18 + .../2024-12-01/Ec2RouteTables_Get.json | 53 + .../Ec2RouteTables_ListByResourceGroup.json | 57 + .../Ec2RouteTables_ListBySubscription.json | 56 + .../2024-12-01/Ec2RouteTables_Update.json | 63 + .../Ec2RouteTable.Management/main.tsp | 118 + .../Ec2RouteTable.Management/tspconfig.yaml | 13 + .../Ec2SecurityGroups_CreateOrReplace.json | 349 + .../2024-12-01/Ec2SecurityGroups_Delete.json | 18 + .../2024-12-01/Ec2SecurityGroups_Get.json | 128 + ...Ec2SecurityGroups_ListByResourceGroup.json | 132 + .../Ec2SecurityGroups_ListBySubscription.json | 131 + .../2024-12-01/Ec2SecurityGroups_Update.json | 138 + .../Ec2SecurityGroup.Management/main.tsp | 241 + .../tspconfig.yaml | 13 + .../Ec2Snapshots_CreateOrReplace.json | 187 + .../2024-12-01/Ec2Snapshots_Delete.json | 18 + .../examples/2024-12-01/Ec2Snapshots_Get.json | 74 + .../Ec2Snapshots_ListByResourceGroup.json | 78 + .../Ec2Snapshots_ListBySubscription.json | 77 + .../2024-12-01/Ec2Snapshots_Update.json | 84 + .../Ec2Snapshot.Management/main.tsp | 244 + .../Ec2Snapshot.Management/tspconfig.yaml | 13 + .../Ec2Subnets_CreateOrReplace.json | 193 + .../2024-12-01/Ec2Subnets_Delete.json | 18 + .../examples/2024-12-01/Ec2Subnets_Get.json | 76 + .../Ec2Subnets_ListByResourceGroup.json | 80 + .../Ec2Subnets_ListBySubscription.json | 79 + .../2024-12-01/Ec2Subnets_Update.json | 86 + .../Ec2Subnet.Management/main.tsp | 186 + .../Ec2Subnet.Management/tspconfig.yaml | 13 + .../Ec2VpcEndpoints_CreateOrReplace.json | 166 + .../2024-12-01/Ec2VpcEndpoints_Delete.json | 18 + .../2024-12-01/Ec2VpcEndpoints_Get.json | 67 + .../Ec2VpcEndpoints_ListByResourceGroup.json | 71 + .../Ec2VpcEndpoints_ListBySubscription.json | 70 + .../2024-12-01/Ec2VpcEndpoints_Update.json | 77 + .../Ec2VPCEndpoint.Management/main.tsp | 150 + .../Ec2VPCEndpoint.Management/tspconfig.yaml | 13 + ...VpcPeeringConnections_CreateOrReplace.json | 136 + .../Ec2VpcPeeringConnections_Delete.json | 18 + .../Ec2VpcPeeringConnections_Get.json | 57 + ...eeringConnections_ListByResourceGroup.json | 61 + ...PeeringConnections_ListBySubscription.json | 60 + .../Ec2VpcPeeringConnections_Update.json | 67 + .../main.tsp | 131 + .../tspconfig.yaml | 13 + .../Ec2Volumes_CreateOrReplace.json | 154 + .../2024-12-01/Ec2Volumes_Delete.json | 18 + .../examples/2024-12-01/Ec2Volumes_Get.json | 63 + .../Ec2Volumes_ListByResourceGroup.json | 67 + .../Ec2Volumes_ListBySubscription.json | 66 + .../2024-12-01/Ec2Volumes_Update.json | 73 + .../Ec2Volume.Management/main.tsp | 148 + .../Ec2Volume.Management/tspconfig.yaml | 13 + .../2024-12-01/Ec2Vpcs_CreateOrReplace.json | 163 + .../examples/2024-12-01/Ec2Vpcs_Delete.json | 18 + .../examples/2024-12-01/Ec2Vpcs_Get.json | 66 + .../Ec2Vpcs_ListByResourceGroup.json | 70 + .../Ec2Vpcs_ListBySubscription.json | 69 + .../examples/2024-12-01/Ec2Vpcs_Update.json | 76 + .../awsconnector/Ec2Vpc.Management/main.tsp | 147 + .../Ec2Vpc.Management/tspconfig.yaml | 13 + .../EcrImageDetails_CreateOrReplace.json | 172 + .../2024-12-01/EcrImageDetails_Delete.json | 18 + .../2024-12-01/EcrImageDetails_Get.json | 69 + .../EcrImageDetails_ListByResourceGroup.json | 73 + .../EcrImageDetails_ListBySubscription.json | 72 + .../2024-12-01/EcrImageDetails_Update.json | 79 + .../EcrImageDetail.Management/main.tsp | 203 + .../EcrImageDetail.Management/tspconfig.yaml | 13 + .../EcrRepositories_CreateOrReplace.json | 169 + .../2024-12-01/EcrRepositories_Delete.json | 18 + .../2024-12-01/EcrRepositories_Get.json | 68 + .../EcrRepositories_ListByResourceGroup.json | 72 + .../EcrRepositories_ListBySubscription.json | 71 + .../2024-12-01/EcrRepositories_Update.json | 78 + .../EcrRepository.Management/main.tsp | 197 + .../EcrRepository.Management/tspconfig.yaml | 13 + .../EcsClusters_CreateOrReplace.json | 220 + .../2024-12-01/EcsClusters_Delete.json | 18 + .../examples/2024-12-01/EcsClusters_Get.json | 85 + .../EcsClusters_ListByResourceGroup.json | 89 + .../EcsClusters_ListBySubscription.json | 88 + .../2024-12-01/EcsClusters_Update.json | 95 + .../EcsCluster.Management/main.tsp | 223 + .../EcsCluster.Management/tspconfig.yaml | 13 + .../EcsServices_CreateOrReplace.json | 547 ++ .../2024-12-01/EcsServices_Delete.json | 18 + .../examples/2024-12-01/EcsServices_Get.json | 194 + .../EcsServices_ListByResourceGroup.json | 198 + .../EcsServices_ListBySubscription.json | 197 + .../2024-12-01/EcsServices_Update.json | 204 + .../EcsService.Management/main.tsp | 650 ++ .../EcsService.Management/tspconfig.yaml | 13 + .../EcsTaskDefinitions_CreateOrReplace.json | 844 ++ .../2024-12-01/EcsTaskDefinitions_Delete.json | 18 + .../2024-12-01/EcsTaskDefinitions_Get.json | 293 + ...csTaskDefinitions_ListByResourceGroup.json | 297 + ...EcsTaskDefinitions_ListBySubscription.json | 296 + .../2024-12-01/EcsTaskDefinitions_Update.json | 303 + .../EcsTaskDefinition.Management/main.tsp | 839 ++ .../tspconfig.yaml | 13 + .../EfsFileSystems_CreateOrReplace.json | 214 + .../2024-12-01/EfsFileSystems_Delete.json | 18 + .../2024-12-01/EfsFileSystems_Get.json | 83 + .../EfsFileSystems_ListByResourceGroup.json | 87 + .../EfsFileSystems_ListBySubscription.json | 86 + .../2024-12-01/EfsFileSystems_Update.json | 93 + .../EfsFileSystem.Management/main.tsp | 243 + .../EfsFileSystem.Management/tspconfig.yaml | 13 + .../EfsMountTargets_CreateOrReplace.json | 121 + .../2024-12-01/EfsMountTargets_Delete.json | 18 + .../2024-12-01/EfsMountTargets_Get.json | 52 + .../EfsMountTargets_ListByResourceGroup.json | 56 + .../EfsMountTargets_ListBySubscription.json | 55 + .../2024-12-01/EfsMountTargets_Update.json | 62 + .../EfsMountTarget.Management/main.tsp | 111 + .../EfsMountTarget.Management/tspconfig.yaml | 13 + .../EksClusters_CreateOrReplace.json | 386 + .../2024-12-01/EksClusters_Delete.json | 16 + .../examples/2024-12-01/EksClusters_Get.json | 139 + .../examples/2024-12-01/EksClusters_List.json | 144 + .../EksCluster.Management/main.tsp | 548 ++ .../EksCluster.Management/tspconfig.yaml | 13 + .../EksNodegroups_CreateOrReplace.json | 250 + .../2024-12-01/EksNodegroups_Delete.json | 18 + .../2024-12-01/EksNodegroups_Get.json | 95 + .../EksNodegroups_ListByResourceGroup.json | 99 + .../EksNodegroups_ListBySubscription.json | 98 + .../2024-12-01/EksNodegroups_Update.json | 105 + .../EksNodegroup.Management/main.tsp | 233 + .../EksNodegroup.Management/tspconfig.yaml | 13 + ...BeanstalkApplications_CreateOrReplace.json | 151 + .../ElasticBeanstalkApplications_Delete.json | 18 + .../ElasticBeanstalkApplications_Get.json | 62 + ...stalkApplications_ListByResourceGroup.json | 66 + ...nstalkApplications_ListBySubscription.json | 65 + .../ElasticBeanstalkApplications_Update.json | 72 + .../main.tsp | 163 + .../tspconfig.yaml | 13 + ...onfigurationTemplates_CreateOrReplace.json | 154 + ...eanstalkConfigurationTemplates_Delete.json | 18 + ...icBeanstalkConfigurationTemplates_Get.json | 63 + ...gurationTemplates_ListByResourceGroup.json | 67 + ...igurationTemplates_ListBySubscription.json | 66 + ...eanstalkConfigurationTemplates_Update.json | 73 + .../main.tsp | 159 + .../tspconfig.yaml | 13 + ...BeanstalkEnvironments_CreateOrReplace.json | 187 + .../ElasticBeanstalkEnvironments_Delete.json | 18 + .../ElasticBeanstalkEnvironments_Get.json | 74 + ...stalkEnvironments_ListByResourceGroup.json | 78 + ...nstalkEnvironments_ListBySubscription.json | 77 + .../ElasticBeanstalkEnvironments_Update.json | 84 + .../main.tsp | 185 + .../tspconfig.yaml | 13 + ...dBalancingV2Listeners_CreateOrReplace.json | 334 + ...lasticLoadBalancingV2Listeners_Delete.json | 18 + .../ElasticLoadBalancingV2Listeners_Get.json | 123 + ...ancingV2Listeners_ListByResourceGroup.json | 127 + ...lancingV2Listeners_ListBySubscription.json | 126 + ...lasticLoadBalancingV2Listeners_Update.json | 133 + .../main.tsp | 345 + .../tspconfig.yaml | 13 + ...ancingV2LoadBalancers_CreateOrReplace.json | 208 + ...icLoadBalancingV2LoadBalancers_Delete.json | 18 + ...asticLoadBalancingV2LoadBalancers_Get.json | 81 + ...ngV2LoadBalancers_ListByResourceGroup.json | 85 + ...ingV2LoadBalancers_ListBySubscription.json | 84 + ...icLoadBalancingV2LoadBalancers_Update.json | 91 + .../main.tsp | 199 + .../tspconfig.yaml | 13 + ...lancingV2TargetGroups_CreateOrReplace.json | 232 + ...ticLoadBalancingV2TargetGroups_Delete.json | 18 + ...lasticLoadBalancingV2TargetGroups_Get.json | 89 + ...ingV2TargetGroups_ListByResourceGroup.json | 93 + ...cingV2TargetGroups_ListBySubscription.json | 92 + ...ticLoadBalancingV2TargetGroups_Update.json | 99 + .../main.tsp | 232 + .../tspconfig.yaml | 13 + ...getHealthDescriptions_CreateOrReplace.json | 169 + ...cingv2TargetHealthDescriptions_Delete.json | 18 + ...lancingv2TargetHealthDescriptions_Get.json | 68 + ...ealthDescriptions_ListByResourceGroup.json | 72 + ...HealthDescriptions_ListBySubscription.json | 71 + ...cingv2TargetHealthDescriptions_Update.json | 78 + .../main.tsp | 296 + .../tspconfig.yaml | 13 + .../EmrClusters_CreateOrReplace.json | 469 ++ .../2024-12-01/EmrClusters_Delete.json | 18 + .../examples/2024-12-01/EmrClusters_Get.json | 168 + .../EmrClusters_ListByResourceGroup.json | 172 + .../EmrClusters_ListBySubscription.json | 171 + .../2024-12-01/EmrClusters_Update.json | 178 + .../EmrCluster.Management/main.tsp | 598 ++ .../EmrCluster.Management/tspconfig.yaml | 13 + .../EmrClusterSummaries_CreateOrReplace.json | 190 + .../EmrClusterSummaries_Delete.json | 18 + .../2024-12-01/EmrClusterSummaries_Get.json | 75 + ...rClusterSummaries_ListByResourceGroup.json | 79 + ...mrClusterSummaries_ListBySubscription.json | 78 + .../EmrClusterSummaries_Update.json | 85 + .../EmrClusterSummary.Management/main.tsp | 267 + .../tspconfig.yaml | 13 + .../GuardDutyDetectors_CreateOrReplace.json | 208 + .../2024-12-01/GuardDutyDetectors_Delete.json | 18 + .../2024-12-01/GuardDutyDetectors_Get.json | 81 + ...uardDutyDetectors_ListByResourceGroup.json | 85 + ...GuardDutyDetectors_ListBySubscription.json | 84 + .../2024-12-01/GuardDutyDetectors_Update.json | 91 + .../GuardDutyDetector.Management/main.tsp | 235 + .../tspconfig.yaml | 13 + ...IamAccessKeyLastUseds_CreateOrReplace.json | 109 + .../IamAccessKeyLastUseds_Delete.json | 18 + .../2024-12-01/IamAccessKeyLastUseds_Get.json | 48 + ...ccessKeyLastUseds_ListByResourceGroup.json | 52 + ...AccessKeyLastUseds_ListBySubscription.json | 51 + .../IamAccessKeyLastUseds_Update.json | 58 + .../IamAccessKeyLastUsed.Management/main.tsp | 110 + .../tspconfig.yaml | 13 + ...AccessKeyMetadataInfo_CreateOrReplace.json | 118 + .../IamAccessKeyMetadataInfo_Delete.json | 18 + .../IamAccessKeyMetadataInfo_Get.json | 51 + ...ssKeyMetadataInfo_ListByResourceGroup.json | 55 + ...essKeyMetadataInfo_ListBySubscription.json | 54 + .../IamAccessKeyMetadataInfo_Update.json | 61 + .../IamAccessKeyMetadata.Management/main.tsp | 134 + .../tspconfig.yaml | 13 + .../2024-12-01/IamGroups_CreateOrReplace.json | 136 + .../examples/2024-12-01/IamGroups_Delete.json | 18 + .../examples/2024-12-01/IamGroups_Get.json | 57 + .../IamGroups_ListByResourceGroup.json | 61 + .../IamGroups_ListBySubscription.json | 60 + .../examples/2024-12-01/IamGroups_Update.json | 67 + .../awsconnector/IamGroup.Management/main.tsp | 125 + .../IamGroup.Management/tspconfig.yaml | 13 + .../IamInstanceProfiles_CreateOrUpdate.json | 118 + .../IamInstanceProfiles_Delete.json | 18 + .../2024-12-01/IamInstanceProfiles_Get.json | 51 + ...mInstanceProfiles_ListByResourceGroup.json | 55 + ...amInstanceProfiles_ListBySubscription.json | 54 + .../IamInstanceProfiles_Update.json | 61 + .../IamInstanceProfile.Management/main.tsp | 108 + .../tspconfig.yaml | 13 + .../IamMfaDevices_CreateOrReplace.json | 109 + .../2024-12-01/IamMfaDevices_Delete.json | 18 + .../2024-12-01/IamMfaDevices_Get.json | 48 + .../IamMfaDevices_ListByResourceGroup.json | 52 + .../IamMfaDevices_ListBySubscription.json | 51 + .../2024-12-01/IamMfaDevices_Update.json | 58 + .../IamMFADevice.Management/main.tsp | 110 + .../IamMFADevice.Management/tspconfig.yaml | 13 + .../IamPasswordPolicies_CreateOrReplace.json | 130 + .../IamPasswordPolicies_Delete.json | 18 + .../2024-12-01/IamPasswordPolicies_Get.json | 55 + ...mPasswordPolicies_ListByResourceGroup.json | 59 + ...amPasswordPolicies_ListBySubscription.json | 58 + .../IamPasswordPolicies_Update.json | 65 + .../IamPasswordPolicy.Management/main.tsp | 131 + .../tspconfig.yaml | 13 + .../IamPolicyVersions_CreateOrReplace.json | 112 + .../2024-12-01/IamPolicyVersions_Delete.json | 18 + .../2024-12-01/IamPolicyVersions_Get.json | 49 + ...IamPolicyVersions_ListByResourceGroup.json | 53 + .../IamPolicyVersions_ListBySubscription.json | 52 + .../2024-12-01/IamPolicyVersions_Update.json | 59 + .../IamPolicyVersion.Management/main.tsp | 113 + .../tspconfig.yaml | 13 + .../2024-12-01/IamRoles_CreateOrReplace.json | 169 + .../examples/2024-12-01/IamRoles_Delete.json | 18 + .../examples/2024-12-01/IamRoles_Get.json | 68 + .../IamRoles_ListByResourceGroup.json | 72 + .../IamRoles_ListBySubscription.json | 71 + .../examples/2024-12-01/IamRoles_Update.json | 78 + .../awsconnector/IamRole.Management/main.tsp | 157 + .../IamRole.Management/tspconfig.yaml | 13 + ...IamServerCertificates_CreateOrReplace.json | 136 + .../IamServerCertificates_Delete.json | 18 + .../2024-12-01/IamServerCertificates_Get.json | 57 + ...erverCertificates_ListByResourceGroup.json | 61 + ...ServerCertificates_ListBySubscription.json | 60 + .../IamServerCertificates_Update.json | 67 + .../IamServerCertificate.Management/main.tsp | 130 + .../tspconfig.yaml | 13 + .../IamVirtualMfaDevices_CreateOrReplace.json | 136 + .../IamVirtualMfaDevices_Delete.json | 18 + .../2024-12-01/IamVirtualMfaDevices_Get.json | 57 + ...VirtualMfaDevices_ListByResourceGroup.json | 61 + ...mVirtualMfaDevices_ListBySubscription.json | 60 + .../IamVirtualMfaDevices_Update.json | 67 + .../IamVirtualMFADevice.Management/main.tsp | 125 + .../tspconfig.yaml | 13 + .../KmsAliases_CreateOrReplace.json | 106 + .../2024-12-01/KmsAliases_Delete.json | 18 + .../examples/2024-12-01/KmsAliases_Get.json | 47 + .../KmsAliases_ListByResourceGroup.json | 51 + .../KmsAliases_ListBySubscription.json | 50 + .../2024-12-01/KmsAliases_Update.json | 57 + .../awsconnector/KmsAlias.Management/main.tsp | 101 + .../KmsAlias.Management/tspconfig.yaml | 13 + .../2024-12-01/KmsKeys_CreateOrReplace.json | 157 + .../examples/2024-12-01/KmsKeys_Delete.json | 18 + .../examples/2024-12-01/KmsKeys_Get.json | 64 + .../KmsKeys_ListByResourceGroup.json | 68 + .../KmsKeys_ListBySubscription.json | 67 + .../examples/2024-12-01/KmsKeys_Update.json | 74 + .../awsconnector/KmsKey.Management/main.tsp | 220 + .../KmsKey.Management/tspconfig.yaml | 13 + .../LambdaFunctions_CreateOrReplace.json | 358 + .../2024-12-01/LambdaFunctions_Delete.json | 18 + .../2024-12-01/LambdaFunctions_Get.json | 131 + .../LambdaFunctions_ListByResourceGroup.json | 135 + .../LambdaFunctions_ListBySubscription.json | 134 + .../2024-12-01/LambdaFunctions_Update.json | 141 + .../LambdaFunction.Management/main.tsp | 487 ++ .../LambdaFunction.Management/tspconfig.yaml | 13 + ...FunctionCodeLocations_CreateOrReplace.json | 112 + .../LambdaFunctionCodeLocations_Delete.json | 18 + .../LambdaFunctionCodeLocations_Get.json | 49 + ...tionCodeLocations_ListByResourceGroup.json | 53 + ...ctionCodeLocations_ListBySubscription.json | 52 + .../LambdaFunctionCodeLocations_Update.json | 59 + .../main.tsp | 120 + .../tspconfig.yaml | 13 + .../LightsailBuckets_CreateOrReplace.json | 166 + .../2024-12-01/LightsailBuckets_Delete.json | 18 + .../2024-12-01/LightsailBuckets_Get.json | 67 + .../LightsailBuckets_ListByResourceGroup.json | 71 + .../LightsailBuckets_ListBySubscription.json | 70 + .../2024-12-01/LightsailBuckets_Update.json | 77 + .../LightsailBucket.Management/main.tsp | 154 + .../LightsailBucket.Management/tspconfig.yaml | 13 + .../LightsailInstances_CreateOrReplace.json | 331 + .../2024-12-01/LightsailInstances_Delete.json | 18 + .../2024-12-01/LightsailInstances_Get.json | 122 + ...ightsailInstances_ListByResourceGroup.json | 126 + ...LightsailInstances_ListBySubscription.json | 125 + .../2024-12-01/LightsailInstances_Update.json | 132 + .../LightsailInstance.Management/main.tsp | 357 + .../tspconfig.yaml | 13 + .../LogsLogGroups_CreateOrReplace.json | 133 + .../2024-12-01/LogsLogGroups_Delete.json | 18 + .../2024-12-01/LogsLogGroups_Get.json | 56 + .../LogsLogGroups_ListByResourceGroup.json | 60 + .../LogsLogGroups_ListBySubscription.json | 59 + .../2024-12-01/LogsLogGroups_Update.json | 66 + .../LogsLogGroup.Management/main.tsp | 141 + .../LogsLogGroup.Management/tspconfig.yaml | 13 + .../LogsLogStreams_CreateOrReplace.json | 106 + .../2024-12-01/LogsLogStreams_Delete.json | 18 + .../2024-12-01/LogsLogStreams_Get.json | 47 + .../LogsLogStreams_ListByResourceGroup.json | 51 + .../LogsLogStreams_ListBySubscription.json | 50 + .../2024-12-01/LogsLogStreams_Update.json | 57 + .../LogsLogStream.Management/main.tsp | 101 + .../LogsLogStream.Management/tspconfig.yaml | 13 + .../LogsMetricFilters_CreateOrReplace.json | 154 + .../2024-12-01/LogsMetricFilters_Delete.json | 18 + .../2024-12-01/LogsMetricFilters_Get.json | 63 + ...LogsMetricFilters_ListByResourceGroup.json | 67 + .../LogsMetricFilters_ListBySubscription.json | 66 + .../2024-12-01/LogsMetricFilters_Update.json | 73 + .../LogsMetricFilter.Management/main.tsp | 233 + .../tspconfig.yaml | 13 + ...gsSubscriptionFilters_CreateOrReplace.json | 118 + .../LogsSubscriptionFilters_Delete.json | 18 + .../LogsSubscriptionFilters_Get.json | 51 + ...bscriptionFilters_ListByResourceGroup.json | 55 + ...ubscriptionFilters_ListBySubscription.json | 54 + .../LogsSubscriptionFilters_Update.json | 61 + .../main.tsp | 125 + .../tspconfig.yaml | 13 + .../Macie2JobSummaries_CreateOrReplace.json | 355 + .../2024-12-01/Macie2JobSummaries_Delete.json | 18 + .../2024-12-01/Macie2JobSummaries_Get.json | 130 + ...acie2JobSummaries_ListByResourceGroup.json | 134 + ...Macie2JobSummaries_ListBySubscription.json | 133 + .../2024-12-01/Macie2JobSummaries_Update.json | 140 + .../Macie2JobSummary.Management/main.tsp | 391 + .../tspconfig.yaml | 13 + .../MacieAllowLists_CreateOrReplace.json | 154 + .../2024-12-01/MacieAllowLists_Delete.json | 18 + .../2024-12-01/MacieAllowLists_Get.json | 63 + .../MacieAllowLists_ListByResourceGroup.json | 67 + .../MacieAllowLists_ListBySubscription.json | 66 + .../2024-12-01/MacieAllowLists_Update.json | 73 + .../MacieAllowList.Management/main.tsp | 185 + .../MacieAllowList.Management/tspconfig.yaml | 13 + ...workFirewallFirewalls_CreateOrReplace.json | 172 + .../NetworkFirewallFirewalls_Delete.json | 18 + .../NetworkFirewallFirewalls_Get.json | 69 + ...FirewallFirewalls_ListByResourceGroup.json | 73 + ...kFirewallFirewalls_ListBySubscription.json | 72 + .../NetworkFirewallFirewalls_Update.json | 79 + .../main.tsp | 161 + .../tspconfig.yaml | 13 + ...ewallFirewallPolicies_CreateOrReplace.json | 292 + ...etworkFirewallFirewallPolicies_Delete.json | 18 + .../NetworkFirewallFirewallPolicies_Get.json | 109 + ...lFirewallPolicies_ListByResourceGroup.json | 113 + ...llFirewallPolicies_ListBySubscription.json | 112 + ...etworkFirewallFirewallPolicies_Update.json | 119 + .../main.tsp | 325 + .../tspconfig.yaml | 13 + ...orkFirewallRuleGroups_CreateOrReplace.json | 508 ++ .../NetworkFirewallRuleGroups_Delete.json | 18 + .../NetworkFirewallRuleGroups_Get.json | 181 + ...irewallRuleGroups_ListByResourceGroup.json | 185 + ...FirewallRuleGroups_ListBySubscription.json | 184 + .../NetworkFirewallRuleGroups_Update.json | 191 + .../main.tsp | 590 ++ .../tspconfig.yaml | 13 + ...nSearchDomainStatuses_CreateOrReplace.json | 604 ++ .../OpenSearchDomainStatuses_Delete.json | 18 + .../OpenSearchDomainStatuses_Get.json | 213 + ...rchDomainStatuses_ListByResourceGroup.json | 217 + ...archDomainStatuses_ListBySubscription.json | 216 + .../OpenSearchDomainStatuses_Update.json | 223 + .../main.tsp | 1193 +++ .../tspconfig.yaml | 13 + ...OrganizationsAccounts_CreateOrReplace.json | 151 + .../OrganizationsAccounts_Delete.json | 18 + .../2024-12-01/OrganizationsAccounts_Get.json | 62 + ...nizationsAccounts_ListByResourceGroup.json | 66 + ...anizationsAccounts_ListBySubscription.json | 65 + .../OrganizationsAccounts_Update.json | 72 + .../OrganizationsAccount.Management/main.tsp | 165 + .../tspconfig.yaml | 13 + ...izationsOrganizations_CreateOrReplace.json | 121 + .../OrganizationsOrganizations_Delete.json | 18 + .../OrganizationsOrganizations_Get.json | 52 + ...ionsOrganizations_ListByResourceGroup.json | 56 + ...tionsOrganizations_ListBySubscription.json | 55 + .../OrganizationsOrganizations_Update.json | 62 + .../main.tsp | 128 + .../tspconfig.yaml | 13 + .../RdsDbClusters_CreateOrReplace.json | 379 + .../2024-12-01/RdsDbClusters_Delete.json | 18 + .../2024-12-01/RdsDbClusters_Get.json | 138 + .../RdsDbClusters_ListByResourceGroup.json | 142 + .../RdsDbClusters_ListBySubscription.json | 141 + .../2024-12-01/RdsDbClusters_Update.json | 148 + .../RdsDBCluster.Management/main.tsp | 377 + .../RdsDBCluster.Management/tspconfig.yaml | 13 + .../RdsDbInstances_CreateOrReplace.json | 439 + .../2024-12-01/RdsDbInstances_Delete.json | 18 + .../2024-12-01/RdsDbInstances_Get.json | 158 + .../RdsDbInstances_ListByResourceGroup.json | 162 + .../RdsDbInstances_ListBySubscription.json | 161 + .../2024-12-01/RdsDbInstances_Update.json | 168 + .../RdsDBInstance.Management/main.tsp | 434 + .../RdsDBInstance.Management/tspconfig.yaml | 13 + .../RdsDbSnapshots_CreateOrReplace.json | 238 + .../2024-12-01/RdsDbSnapshots_Delete.json | 18 + .../2024-12-01/RdsDbSnapshots_Get.json | 91 + .../RdsDbSnapshots_ListByResourceGroup.json | 95 + .../RdsDbSnapshots_ListBySubscription.json | 94 + .../2024-12-01/RdsDbSnapshots_Update.json | 101 + .../RdsDBSnapshot.Management/main.tsp | 237 + .../RdsDBSnapshot.Management/tspconfig.yaml | 13 + ...shotAttributesResults_CreateOrReplace.json | 127 + ...RdsDbSnapshotAttributesResults_Delete.json | 18 + .../RdsDbSnapshotAttributesResults_Get.json | 54 + ...AttributesResults_ListByResourceGroup.json | 58 + ...tAttributesResults_ListBySubscription.json | 57 + ...RdsDbSnapshotAttributesResults_Update.json | 64 + .../main.tsp | 129 + .../tspconfig.yaml | 13 + ...RdsEventSubscriptions_CreateOrReplace.json | 148 + .../RdsEventSubscriptions_Delete.json | 18 + .../2024-12-01/RdsEventSubscriptions_Get.json | 61 + ...ventSubscriptions_ListByResourceGroup.json | 65 + ...EventSubscriptions_ListBySubscription.json | 64 + .../RdsEventSubscriptions_Update.json | 71 + .../RdsEventSubscription.Management/main.tsp | 132 + .../tspconfig.yaml | 13 + .../RdsExportTasks_CreateOrReplace.json | 160 + .../2024-12-01/RdsExportTasks_Delete.json | 18 + .../2024-12-01/RdsExportTasks_Get.json | 65 + .../RdsExportTasks_ListByResourceGroup.json | 69 + .../RdsExportTasks_ListBySubscription.json | 68 + .../2024-12-01/RdsExportTasks_Update.json | 75 + .../RdsExportTask.Management/main.tsp | 171 + .../RdsExportTask.Management/tspconfig.yaml | 13 + .../RedshiftClusters_CreateOrReplace.json | 313 + .../2024-12-01/RedshiftClusters_Delete.json | 18 + .../2024-12-01/RedshiftClusters_Get.json | 116 + .../RedshiftClusters_ListByResourceGroup.json | 120 + .../RedshiftClusters_ListBySubscription.json | 119 + .../2024-12-01/RedshiftClusters_Update.json | 126 + .../RedshiftCluster.Management/main.tsp | 303 + .../RedshiftCluster.Management/tspconfig.yaml | 13 + ...lusterParameterGroups_CreateOrReplace.json | 145 + ...RedshiftClusterParameterGroups_Delete.json | 18 + .../RedshiftClusterParameterGroups_Get.json | 60 + ...erParameterGroups_ListByResourceGroup.json | 64 + ...terParameterGroups_ListBySubscription.json | 63 + ...RedshiftClusterParameterGroups_Update.json | 70 + .../main.tsp | 145 + .../tspconfig.yaml | 13 + ...omainsDomainSummaries_CreateOrReplace.json | 112 + .../Route53DomainsDomainSummaries_Delete.json | 18 + .../Route53DomainsDomainSummaries_Get.json | 49 + ...nsDomainSummaries_ListByResourceGroup.json | 53 + ...insDomainSummaries_ListBySubscription.json | 52 + .../Route53DomainsDomainSummaries_Update.json | 59 + .../main.tsp | 120 + .../tspconfig.yaml | 13 + .../Route53HostedZones_CreateOrReplace.json | 169 + .../2024-12-01/Route53HostedZones_Delete.json | 18 + .../2024-12-01/Route53HostedZones_Get.json | 68 + ...oute53HostedZones_ListByResourceGroup.json | 72 + ...Route53HostedZones_ListBySubscription.json | 71 + .../2024-12-01/Route53HostedZones_Update.json | 78 + .../Route53HostedZone.Management/main.tsp | 165 + .../tspconfig.yaml | 13 + ...e53ResourceRecordSets_CreateOrReplace.json | 232 + .../Route53ResourceRecordSets_Delete.json | 18 + .../Route53ResourceRecordSets_Get.json | 89 + ...esourceRecordSets_ListByResourceGroup.json | 93 + ...ResourceRecordSets_ListBySubscription.json | 92 + .../Route53ResourceRecordSets_Update.json | 99 + .../main.tsp | 418 + .../tspconfig.yaml | 13 + .../S3AccessPoints_CreateOrReplace.json | 145 + .../2024-12-01/S3AccessPoints_Delete.json | 18 + .../2024-12-01/S3AccessPoints_Get.json | 60 + .../S3AccessPoints_ListByResourceGroup.json | 64 + .../S3AccessPoints_ListBySubscription.json | 63 + .../2024-12-01/S3AccessPoints_Update.json | 70 + .../S3AccessPoint.Management/main.tsp | 162 + .../S3AccessPoint.Management/tspconfig.yaml | 13 + .../2024-12-01/S3Buckets_CreateOrReplace.json | 1135 +++ .../examples/2024-12-01/S3Buckets_Delete.json | 18 + .../examples/2024-12-01/S3Buckets_Get.json | 390 + .../S3Buckets_ListByResourceGroup.json | 394 + .../S3Buckets_ListBySubscription.json | 393 + .../examples/2024-12-01/S3Buckets_Update.json | 400 + .../awsconnector/S3Bucket.Management/main.tsp | 1488 ++++ .../S3Bucket.Management/tspconfig.yaml | 13 + .../S3BucketPolicies_CreateOrReplace.json | 103 + .../2024-12-01/S3BucketPolicies_Delete.json | 18 + .../2024-12-01/S3BucketPolicies_Get.json | 46 + .../S3BucketPolicies_ListByResourceGroup.json | 50 + .../S3BucketPolicies_ListBySubscription.json | 49 + .../2024-12-01/S3BucketPolicies_Update.json | 56 + .../S3BucketPolicy.Management/main.tsp | 111 + .../S3BucketPolicy.Management/tspconfig.yaml | 13 + ...sPointPolicyDocuments_CreateOrReplace.json | 118 + ...gionAccessPointPolicyDocuments_Delete.json | 18 + ...iRegionAccessPointPolicyDocuments_Get.json | 51 + ...ntPolicyDocuments_ListByResourceGroup.json | 55 + ...intPolicyDocuments_ListBySubscription.json | 54 + ...gionAccessPointPolicyDocuments_Update.json | 61 + .../main.tsp | 138 + .../tspconfig.yaml | 13 + .../SageMakerApps_CreateOrReplace.json | 148 + .../2024-12-01/SageMakerApps_Delete.json | 18 + .../2024-12-01/SageMakerApps_Get.json | 61 + .../SageMakerApps_ListByResourceGroup.json | 65 + .../SageMakerApps_ListBySubscription.json | 64 + .../2024-12-01/SageMakerApps_Update.json | 71 + .../SageMakerApp.Management/main.tsp | 360 + .../SageMakerApp.Management/tspconfig.yaml | 13 + ...bookInstanceSummaries_CreateOrReplace.json | 148 + ...MakerNotebookInstanceSummaries_Delete.json | 18 + ...ageMakerNotebookInstanceSummaries_Get.json | 61 + ...InstanceSummaries_ListByResourceGroup.json | 65 + ...kInstanceSummaries_ListBySubscription.json | 64 + ...MakerNotebookInstanceSummaries_Update.json | 71 + .../main.tsp | 662 ++ .../tspconfig.yaml | 13 + ...nagerResourcePolicies_CreateOrReplace.json | 109 + ...SecretsManagerResourcePolicies_Delete.json | 18 + .../SecretsManagerResourcePolicies_Get.json | 48 + ...rResourcePolicies_ListByResourceGroup.json | 52 + ...erResourcePolicies_ListBySubscription.json | 51 + ...SecretsManagerResourcePolicies_Update.json | 58 + .../main.tsp | 114 + .../tspconfig.yaml | 13 + ...SecretsManagerSecrets_CreateOrReplace.json | 187 + .../SecretsManagerSecrets_Delete.json | 18 + .../2024-12-01/SecretsManagerSecrets_Get.json | 74 + ...etsManagerSecrets_ListByResourceGroup.json | 78 + ...retsManagerSecrets_ListBySubscription.json | 77 + .../SecretsManagerSecrets_Update.json | 84 + .../SecretsManagerSecret.Management/main.tsp | 184 + .../tspconfig.yaml | 13 + .../SnsSubscriptions_CreateOrReplace.json | 115 + .../2024-12-01/SnsSubscriptions_Delete.json | 18 + .../2024-12-01/SnsSubscriptions_Get.json | 50 + .../SnsSubscriptions_ListByResourceGroup.json | 54 + .../SnsSubscriptions_ListBySubscription.json | 53 + .../2024-12-01/SnsSubscriptions_Update.json | 60 + .../SnsSubscription.Management/main.tsp | 116 + .../SnsSubscription.Management/tspconfig.yaml | 13 + .../2024-12-01/SnsTopics_CreateOrReplace.json | 184 + .../examples/2024-12-01/SnsTopics_Delete.json | 18 + .../examples/2024-12-01/SnsTopics_Get.json | 73 + .../SnsTopics_ListByResourceGroup.json | 77 + .../SnsTopics_ListBySubscription.json | 76 + .../examples/2024-12-01/SnsTopics_Update.json | 83 + .../awsconnector/SnsTopic.Management/main.tsp | 202 + .../SnsTopic.Management/tspconfig.yaml | 13 + .../2024-12-01/SqsQueues_CreateOrReplace.json | 169 + .../examples/2024-12-01/SqsQueues_Delete.json | 18 + .../examples/2024-12-01/SqsQueues_Get.json | 68 + .../SqsQueues_ListByResourceGroup.json | 72 + .../SqsQueues_ListBySubscription.json | 71 + .../examples/2024-12-01/SqsQueues_Update.json | 78 + .../awsconnector/SqsQueue.Management/main.tsp | 163 + .../SqsQueue.Management/tspconfig.yaml | 13 + ...mInstanceInformations_CreateOrReplace.json | 202 + .../SsmInstanceInformations_Delete.json | 18 + .../SsmInstanceInformations_Get.json | 79 + ...tanceInformations_ListByResourceGroup.json | 83 + ...stanceInformations_ListBySubscription.json | 82 + .../SsmInstanceInformations_Update.json | 89 + .../main.tsp | 271 + .../tspconfig.yaml | 13 + .../SsmParameters_CreateOrReplace.json | 124 + .../2024-12-01/SsmParameters_Delete.json | 18 + .../2024-12-01/SsmParameters_Get.json | 53 + .../SsmParameters_ListByResourceGroup.json | 57 + .../SsmParameters_ListBySubscription.json | 56 + .../2024-12-01/SsmParameters_Update.json | 63 + .../SsmParameter.Management/main.tsp | 158 + .../SsmParameter.Management/tspconfig.yaml | 13 + ...omplianceSummaryItems_CreateOrReplace.json | 208 + ...ResourceComplianceSummaryItems_Delete.json | 18 + ...SsmResourceComplianceSummaryItems_Get.json | 81 + ...ianceSummaryItems_ListByResourceGroup.json | 85 + ...lianceSummaryItems_ListBySubscription.json | 84 + ...ResourceComplianceSummaryItems_Update.json | 91 + .../main.tsp | 254 + .../tspconfig.yaml | 13 + .../WafWebAclSummaries_CreateOrReplace.json | 106 + .../2024-12-01/WafWebAclSummaries_Delete.json | 18 + .../2024-12-01/WafWebAclSummaries_Get.json | 47 + ...afWebAclSummaries_ListByResourceGroup.json | 51 + ...WafWebAclSummaries_ListBySubscription.json | 50 + .../2024-12-01/WafWebAclSummaries_Update.json | 57 + .../WafWebACLSummary.Management/main.tsp | 107 + .../tspconfig.yaml | 13 + ...LoggingConfigurations_CreateOrReplace.json | 193 + .../Wafv2LoggingConfigurations_Delete.json | 18 + .../Wafv2LoggingConfigurations_Get.json | 76 + ...ingConfigurations_ListByResourceGroup.json | 80 + ...gingConfigurations_ListBySubscription.json | 79 + .../Wafv2LoggingConfigurations_Update.json | 86 + .../main.tsp | 262 + .../tspconfig.yaml | 13 + .../2024-12-01/accessAnalyzerAnalyzer.json | 655 ++ .../2024-12-01/acmCertificateSummary.json | 1016 +++ .../stable/2024-12-01/apiGatewayRestApi.json | 681 ++ .../stable/2024-12-01/apiGatewayStage.json | 712 ++ .../stable/2024-12-01/appSyncGraphqlApi.json | 1120 +++ .../autoScalingAutoScalingGroup.json | 1192 +++ .../2024-12-01/cloudFormationStack.json | 868 ++ .../2024-12-01/cloudFormationStackSet.json | 876 ++ .../2024-12-01/cloudFrontDistribution.json | 1368 ++++ .../stable/2024-12-01/cloudTrailTrail.json | 808 ++ .../stable/2024-12-01/cloudWatchAlarm.json | 771 ++ .../stable/2024-12-01/codeBuildProject.json | 2007 +++++ .../codeBuildSourceCredentialsInfo.json | 656 ++ .../configServiceConfigurationRecorder.json | 3190 ++++++++ ...figServiceConfigurationRecorderStatus.json | 617 ++ .../configServiceDeliveryChannel.json | 628 ++ ...seMigrationServiceReplicationInstance.json | 768 ++ .../stable/2024-12-01/daxCluster.json | 818 ++ .../dynamoDBContinuousBackupsDescription.json | 638 ++ .../stable/2024-12-01/dynamoDBTable.json | 951 +++ .../2024-12-01/ec2AccountAttribute.json | 564 ++ .../stable/2024-12-01/ec2Address.json | 650 ++ .../stable/2024-12-01/ec2FlowLog.json | 757 ++ .../stable/2024-12-01/ec2Image.json | 1281 +++ .../stable/2024-12-01/ec2Instance.json | 7119 +++++++++++++++++ .../stable/2024-12-01/ec2InstanceStatus.json | 895 +++ .../stable/2024-12-01/ec2Ipam.json | 768 ++ .../stable/2024-12-01/ec2KeyPair.json | 678 ++ .../stable/2024-12-01/ec2NetworkAcl.json | 572 ++ .../2024-12-01/ec2NetworkInterface.json | 741 ++ .../stable/2024-12-01/ec2RouteTable.json | 572 ++ .../stable/2024-12-01/ec2SecurityGroup.json | 728 ++ .../stable/2024-12-01/ec2Snapshot.json | 761 ++ .../stable/2024-12-01/ec2Subnet.json | 665 ++ .../stable/2024-12-01/ec2VPCEndpoint.json | 641 ++ .../2024-12-01/ec2VPCPeeringConnection.json | 588 ++ .../stable/2024-12-01/ec2Volume.json | 615 ++ .../stable/2024-12-01/ec2Vpc.json | 617 ++ .../stable/2024-12-01/ecrImageDetail.json | 701 ++ .../stable/2024-12-01/ecrRepository.json | 687 ++ .../stable/2024-12-01/ecsCluster.json | 702 ++ .../stable/2024-12-01/ecsService.json | 1342 ++++ .../stable/2024-12-01/ecsTaskDefinition.json | 1556 ++++ .../stable/2024-12-01/efsFileSystem.json | 746 ++ .../stable/2024-12-01/efsMountTarget.json | 566 ++ .../stable/2024-12-01/eksCluster.json | 1067 +++ .../stable/2024-12-01/eksNodegroup.json | 732 ++ .../elasticBeanstalkApplication.json | 620 ++ ...elasticBeanstalkConfigurationTemplate.json | 614 ++ .../elasticBeanstalkEnvironment.json | 656 ++ .../elasticLoadBalancingV2Listener.json | 852 ++ .../elasticLoadBalancingV2LoadBalancer.json | 672 ++ .../elasticLoadBalancingV2TargetGroup.json | 716 ++ ...oadBalancingV2TargetHealthDescription.json | 835 ++ .../stable/2024-12-01/emrCluster.json | 1282 +++ .../stable/2024-12-01/emrClusterSummary.json | 788 ++ ...cessAnalyzerAnalyzers_CreateOrReplace.json | 196 + .../AccessAnalyzerAnalyzers_Delete.json | 18 + .../examples/AccessAnalyzerAnalyzers_Get.json | 77 + ...AnalyzerAnalyzers_ListByResourceGroup.json | 81 + ...sAnalyzerAnalyzers_ListBySubscription.json | 80 + .../AccessAnalyzerAnalyzers_Update.json | 87 + ...mCertificateSummaries_CreateOrReplace.json | 196 + .../AcmCertificateSummaries_Delete.json | 18 + .../examples/AcmCertificateSummaries_Get.json | 77 + ...tificateSummaries_ListByResourceGroup.json | 81 + ...rtificateSummaries_ListBySubscription.json | 80 + .../AcmCertificateSummaries_Update.json | 87 + .../ApiGatewayRestApis_CreateOrReplace.json | 214 + .../examples/ApiGatewayRestApis_Delete.json | 18 + .../examples/ApiGatewayRestApis_Get.json | 83 + ...piGatewayRestApis_ListByResourceGroup.json | 87 + ...ApiGatewayRestApis_ListBySubscription.json | 86 + .../examples/ApiGatewayRestApis_Update.json | 93 + .../ApiGatewayStages_CreateOrReplace.json | 232 + .../examples/ApiGatewayStages_Delete.json | 18 + .../examples/ApiGatewayStages_Get.json | 89 + .../ApiGatewayStages_ListByResourceGroup.json | 93 + .../ApiGatewayStages_ListBySubscription.json | 92 + .../examples/ApiGatewayStages_Update.json | 99 + .../AppSyncGraphqlApis_CreateOrReplace.json | 373 + .../examples/AppSyncGraphqlApis_Delete.json | 18 + .../examples/AppSyncGraphqlApis_Get.json | 136 + ...ppSyncGraphqlApis_ListByResourceGroup.json | 140 + ...AppSyncGraphqlApis_ListBySubscription.json | 139 + .../examples/AppSyncGraphqlApis_Update.json | 146 + ...lingAutoScalingGroups_CreateOrReplace.json | 634 ++ .../AutoScalingAutoScalingGroups_Delete.json | 18 + .../AutoScalingAutoScalingGroups_Get.json | 223 + ...AutoScalingGroups_ListByResourceGroup.json | 227 + ...gAutoScalingGroups_ListBySubscription.json | 226 + .../AutoScalingAutoScalingGroups_Update.json | 233 + ...oudFormationStackSets_CreateOrReplace.json | 292 + .../CloudFormationStackSets_Delete.json | 18 + .../examples/CloudFormationStackSets_Get.json | 109 + ...ormationStackSets_ListByResourceGroup.json | 113 + ...FormationStackSets_ListBySubscription.json | 112 + .../CloudFormationStackSets_Update.json | 119 + .../CloudFormationStacks_CreateOrReplace.json | 217 + .../examples/CloudFormationStacks_Delete.json | 18 + .../examples/CloudFormationStacks_Get.json | 84 + ...udFormationStacks_ListByResourceGroup.json | 88 + ...oudFormationStacks_ListBySubscription.json | 87 + .../examples/CloudFormationStacks_Update.json | 94 + ...oudFrontDistributions_CreateOrReplace.json | 802 ++ .../CloudFrontDistributions_Delete.json | 18 + .../examples/CloudFrontDistributions_Get.json | 279 + ...rontDistributions_ListByResourceGroup.json | 283 + ...FrontDistributions_ListBySubscription.json | 282 + .../CloudFrontDistributions_Update.json | 289 + .../CloudTrailTrails_CreateOrReplace.json | 310 + .../examples/CloudTrailTrails_Delete.json | 18 + .../examples/CloudTrailTrails_Get.json | 115 + .../CloudTrailTrails_ListByResourceGroup.json | 119 + .../CloudTrailTrails_ListBySubscription.json | 118 + .../examples/CloudTrailTrails_Update.json | 125 + .../CloudWatchAlarms_CreateOrReplace.json | 289 + .../examples/CloudWatchAlarms_Delete.json | 18 + .../examples/CloudWatchAlarms_Get.json | 108 + .../CloudWatchAlarms_ListByResourceGroup.json | 112 + .../CloudWatchAlarms_ListBySubscription.json | 111 + .../examples/CloudWatchAlarms_Update.json | 118 + .../CodeBuildProjects_CreateOrReplace.json | 817 ++ .../examples/CodeBuildProjects_Delete.json | 18 + .../examples/CodeBuildProjects_Get.json | 284 + ...CodeBuildProjects_ListByResourceGroup.json | 288 + .../CodeBuildProjects_ListBySubscription.json | 287 + .../examples/CodeBuildProjects_Update.json | 294 + ...ourceCredentialsInfos_CreateOrReplace.json | 124 + ...odeBuildSourceCredentialsInfos_Delete.json | 18 + .../CodeBuildSourceCredentialsInfos_Get.json | 53 + ...eCredentialsInfos_ListByResourceGroup.json | 57 + ...ceCredentialsInfos_ListBySubscription.json | 56 + ...odeBuildSourceCredentialsInfos_Update.json | 63 + ...ationRecorderStatuses_CreateOrReplace.json | 130 + ...eConfigurationRecorderStatuses_Delete.json | 18 + ...viceConfigurationRecorderStatuses_Get.json | 55 + ...nRecorderStatuses_ListByResourceGroup.json | 59 + ...onRecorderStatuses_ListBySubscription.json | 58 + ...eConfigurationRecorderStatuses_Update.json | 65 + ...onfigurationRecorders_CreateOrReplace.json | 205 + ...gServiceConfigurationRecorders_Delete.json | 18 + ...nfigServiceConfigurationRecorders_Get.json | 80 + ...gurationRecorders_ListByResourceGroup.json | 84 + ...igurationRecorders_ListBySubscription.json | 83 + ...gServiceConfigurationRecorders_Update.json | 90 + ...rviceDeliveryChannels_CreateOrReplace.json | 130 + .../ConfigServiceDeliveryChannels_Delete.json | 18 + .../ConfigServiceDeliveryChannels_Get.json | 55 + ...eDeliveryChannels_ListByResourceGroup.json | 59 + ...ceDeliveryChannels_ListBySubscription.json | 58 + .../ConfigServiceDeliveryChannels_Update.json | 65 + ...eReplicationInstances_CreateOrReplace.json | 277 + ...ionServiceReplicationInstances_Delete.json | 18 + ...rationServiceReplicationInstances_Get.json | 104 + ...licationInstances_ListByResourceGroup.json | 108 + ...plicationInstances_ListBySubscription.json | 107 + ...ionServiceReplicationInstances_Update.json | 114 + .../examples/DaxClusters_CreateOrReplace.json | 271 + .../examples/DaxClusters_Delete.json | 18 + .../2024-12-01/examples/DaxClusters_Get.json | 102 + .../DaxClusters_ListByResourceGroup.json | 106 + .../DaxClusters_ListBySubscription.json | 105 + .../examples/DaxClusters_Update.json | 112 + ...usBackupsDescriptions_CreateOrReplace.json | 130 + ...bContinuousBackupsDescriptions_Delete.json | 18 + ...moDbContinuousBackupsDescriptions_Get.json | 55 + ...ckupsDescriptions_ListByResourceGroup.json | 59 + ...ackupsDescriptions_ListBySubscription.json | 58 + ...bContinuousBackupsDescriptions_Update.json | 65 + .../DynamoDbTables_CreateOrReplace.json | 430 + .../examples/DynamoDbTables_Delete.json | 18 + .../examples/DynamoDbTables_Get.json | 155 + .../DynamoDbTables_ListByResourceGroup.json | 159 + .../DynamoDbTables_ListBySubscription.json | 158 + .../examples/DynamoDbTables_Update.json | 165 + .../Ec2AccountAttributes_CreateOrReplace.json | 118 + .../examples/Ec2AccountAttributes_Delete.json | 18 + .../examples/Ec2AccountAttributes_Get.json | 51 + ...AccountAttributes_ListByResourceGroup.json | 55 + ...2AccountAttributes_ListBySubscription.json | 54 + .../examples/Ec2AccountAttributes_Update.json | 61 + .../Ec2Addresses_CreateOrReplace.json | 163 + .../examples/Ec2Addresses_Delete.json | 18 + .../2024-12-01/examples/Ec2Addresses_Get.json | 66 + .../Ec2Addresses_ListByResourceGroup.json | 70 + .../Ec2Addresses_ListBySubscription.json | 69 + .../examples/Ec2Addresses_Update.json | 76 + .../examples/Ec2FlowLogs_CreateOrReplace.json | 166 + .../examples/Ec2FlowLogs_Delete.json | 18 + .../2024-12-01/examples/Ec2FlowLogs_Get.json | 67 + .../Ec2FlowLogs_ListByResourceGroup.json | 71 + .../Ec2FlowLogs_ListBySubscription.json | 70 + .../examples/Ec2FlowLogs_Update.json | 77 + .../examples/Ec2Images_CreateOrReplace.json | 361 + .../2024-12-01/examples/Ec2Images_Delete.json | 18 + .../2024-12-01/examples/Ec2Images_Get.json | 132 + .../Ec2Images_ListByResourceGroup.json | 136 + .../Ec2Images_ListBySubscription.json | 135 + .../2024-12-01/examples/Ec2Images_Update.json | 142 + .../Ec2InstanceStatuses_CreateOrReplace.json | 259 + .../examples/Ec2InstanceStatuses_Delete.json | 18 + .../examples/Ec2InstanceStatuses_Get.json | 98 + ...2InstanceStatuses_ListByResourceGroup.json | 102 + ...c2InstanceStatuses_ListBySubscription.json | 101 + .../examples/Ec2InstanceStatuses_Update.json | 108 + .../Ec2Instances_CreateOrReplace.json | 914 +++ .../examples/Ec2Instances_Delete.json | 16 + .../2024-12-01/examples/Ec2Instances_Get.json | 315 + .../examples/Ec2Instances_List.json | 320 + .../examples/Ec2Instances_Start.json | 39 + .../examples/Ec2Instances_Stop.json | 43 + .../examples/Ec2Ipams_CreateOrReplace.json | 187 + .../2024-12-01/examples/Ec2Ipams_Delete.json | 18 + .../2024-12-01/examples/Ec2Ipams_Get.json | 74 + .../Ec2Ipams_ListByResourceGroup.json | 78 + .../examples/Ec2Ipams_ListBySubscription.json | 77 + .../2024-12-01/examples/Ec2Ipams_Update.json | 84 + .../examples/Ec2KeyPairs_CreateOrReplace.json | 136 + .../examples/Ec2KeyPairs_Delete.json | 18 + .../2024-12-01/examples/Ec2KeyPairs_Get.json | 57 + .../Ec2KeyPairs_ListByResourceGroup.json | 61 + .../Ec2KeyPairs_ListBySubscription.json | 60 + .../examples/Ec2KeyPairs_Update.json | 67 + .../Ec2NetworkAcls_CreateOrReplace.json | 124 + .../examples/Ec2NetworkAcls_Delete.json | 18 + .../examples/Ec2NetworkAcls_Get.json | 53 + .../Ec2NetworkAcls_ListByResourceGroup.json | 57 + .../Ec2NetworkAcls_ListBySubscription.json | 56 + .../examples/Ec2NetworkAcls_Update.json | 63 + .../Ec2NetworkInterfaces_CreateOrReplace.json | 256 + .../examples/Ec2NetworkInterfaces_Delete.json | 18 + .../examples/Ec2NetworkInterfaces_Get.json | 97 + ...NetworkInterfaces_ListByResourceGroup.json | 101 + ...2NetworkInterfaces_ListBySubscription.json | 100 + .../examples/Ec2NetworkInterfaces_Update.json | 107 + .../Ec2RouteTables_CreateOrReplace.json | 124 + .../examples/Ec2RouteTables_Delete.json | 18 + .../examples/Ec2RouteTables_Get.json | 53 + .../Ec2RouteTables_ListByResourceGroup.json | 57 + .../Ec2RouteTables_ListBySubscription.json | 56 + .../examples/Ec2RouteTables_Update.json | 63 + .../Ec2SecurityGroups_CreateOrReplace.json | 349 + .../examples/Ec2SecurityGroups_Delete.json | 18 + .../examples/Ec2SecurityGroups_Get.json | 128 + ...Ec2SecurityGroups_ListByResourceGroup.json | 132 + .../Ec2SecurityGroups_ListBySubscription.json | 131 + .../examples/Ec2SecurityGroups_Update.json | 138 + .../Ec2Snapshots_CreateOrReplace.json | 187 + .../examples/Ec2Snapshots_Delete.json | 18 + .../2024-12-01/examples/Ec2Snapshots_Get.json | 74 + .../Ec2Snapshots_ListByResourceGroup.json | 78 + .../Ec2Snapshots_ListBySubscription.json | 77 + .../examples/Ec2Snapshots_Update.json | 84 + .../examples/Ec2Subnets_CreateOrReplace.json | 193 + .../examples/Ec2Subnets_Delete.json | 18 + .../2024-12-01/examples/Ec2Subnets_Get.json | 76 + .../Ec2Subnets_ListByResourceGroup.json | 80 + .../Ec2Subnets_ListBySubscription.json | 79 + .../examples/Ec2Subnets_Update.json | 86 + .../examples/Ec2Volumes_CreateOrReplace.json | 154 + .../examples/Ec2Volumes_Delete.json | 18 + .../2024-12-01/examples/Ec2Volumes_Get.json | 63 + .../Ec2Volumes_ListByResourceGroup.json | 67 + .../Ec2Volumes_ListBySubscription.json | 66 + .../examples/Ec2Volumes_Update.json | 73 + .../Ec2VpcEndpoints_CreateOrReplace.json | 166 + .../examples/Ec2VpcEndpoints_Delete.json | 18 + .../examples/Ec2VpcEndpoints_Get.json | 67 + .../Ec2VpcEndpoints_ListByResourceGroup.json | 71 + .../Ec2VpcEndpoints_ListBySubscription.json | 70 + .../examples/Ec2VpcEndpoints_Update.json | 77 + ...VpcPeeringConnections_CreateOrReplace.json | 136 + .../Ec2VpcPeeringConnections_Delete.json | 18 + .../Ec2VpcPeeringConnections_Get.json | 57 + ...eeringConnections_ListByResourceGroup.json | 61 + ...PeeringConnections_ListBySubscription.json | 60 + .../Ec2VpcPeeringConnections_Update.json | 67 + .../examples/Ec2Vpcs_CreateOrReplace.json | 163 + .../2024-12-01/examples/Ec2Vpcs_Delete.json | 18 + .../2024-12-01/examples/Ec2Vpcs_Get.json | 66 + .../examples/Ec2Vpcs_ListByResourceGroup.json | 70 + .../examples/Ec2Vpcs_ListBySubscription.json | 69 + .../2024-12-01/examples/Ec2Vpcs_Update.json | 76 + .../EcrImageDetails_CreateOrReplace.json | 172 + .../examples/EcrImageDetails_Delete.json | 18 + .../examples/EcrImageDetails_Get.json | 69 + .../EcrImageDetails_ListByResourceGroup.json | 73 + .../EcrImageDetails_ListBySubscription.json | 72 + .../examples/EcrImageDetails_Update.json | 79 + .../EcrRepositories_CreateOrReplace.json | 169 + .../examples/EcrRepositories_Delete.json | 18 + .../examples/EcrRepositories_Get.json | 68 + .../EcrRepositories_ListByResourceGroup.json | 72 + .../EcrRepositories_ListBySubscription.json | 71 + .../examples/EcrRepositories_Update.json | 78 + .../examples/EcsClusters_CreateOrReplace.json | 220 + .../examples/EcsClusters_Delete.json | 18 + .../2024-12-01/examples/EcsClusters_Get.json | 85 + .../EcsClusters_ListByResourceGroup.json | 89 + .../EcsClusters_ListBySubscription.json | 88 + .../examples/EcsClusters_Update.json | 95 + .../examples/EcsServices_CreateOrReplace.json | 547 ++ .../examples/EcsServices_Delete.json | 18 + .../2024-12-01/examples/EcsServices_Get.json | 194 + .../EcsServices_ListByResourceGroup.json | 198 + .../EcsServices_ListBySubscription.json | 197 + .../examples/EcsServices_Update.json | 204 + .../EcsTaskDefinitions_CreateOrReplace.json | 844 ++ .../examples/EcsTaskDefinitions_Delete.json | 18 + .../examples/EcsTaskDefinitions_Get.json | 293 + ...csTaskDefinitions_ListByResourceGroup.json | 297 + ...EcsTaskDefinitions_ListBySubscription.json | 296 + .../examples/EcsTaskDefinitions_Update.json | 303 + .../EfsFileSystems_CreateOrReplace.json | 214 + .../examples/EfsFileSystems_Delete.json | 18 + .../examples/EfsFileSystems_Get.json | 83 + .../EfsFileSystems_ListByResourceGroup.json | 87 + .../EfsFileSystems_ListBySubscription.json | 86 + .../examples/EfsFileSystems_Update.json | 93 + .../EfsMountTargets_CreateOrReplace.json | 121 + .../examples/EfsMountTargets_Delete.json | 18 + .../examples/EfsMountTargets_Get.json | 52 + .../EfsMountTargets_ListByResourceGroup.json | 56 + .../EfsMountTargets_ListBySubscription.json | 55 + .../examples/EfsMountTargets_Update.json | 62 + .../examples/EksClusters_CreateOrReplace.json | 386 + .../examples/EksClusters_Delete.json | 16 + .../2024-12-01/examples/EksClusters_Get.json | 139 + .../2024-12-01/examples/EksClusters_List.json | 144 + .../EksNodegroups_CreateOrReplace.json | 250 + .../examples/EksNodegroups_Delete.json | 18 + .../examples/EksNodegroups_Get.json | 95 + .../EksNodegroups_ListByResourceGroup.json | 99 + .../EksNodegroups_ListBySubscription.json | 98 + .../examples/EksNodegroups_Update.json | 105 + ...BeanstalkApplications_CreateOrReplace.json | 151 + .../ElasticBeanstalkApplications_Delete.json | 18 + .../ElasticBeanstalkApplications_Get.json | 62 + ...stalkApplications_ListByResourceGroup.json | 66 + ...nstalkApplications_ListBySubscription.json | 65 + .../ElasticBeanstalkApplications_Update.json | 72 + ...onfigurationTemplates_CreateOrReplace.json | 154 + ...eanstalkConfigurationTemplates_Delete.json | 18 + ...icBeanstalkConfigurationTemplates_Get.json | 63 + ...gurationTemplates_ListByResourceGroup.json | 67 + ...igurationTemplates_ListBySubscription.json | 66 + ...eanstalkConfigurationTemplates_Update.json | 73 + ...BeanstalkEnvironments_CreateOrReplace.json | 187 + .../ElasticBeanstalkEnvironments_Delete.json | 18 + .../ElasticBeanstalkEnvironments_Get.json | 74 + ...stalkEnvironments_ListByResourceGroup.json | 78 + ...nstalkEnvironments_ListBySubscription.json | 77 + .../ElasticBeanstalkEnvironments_Update.json | 84 + ...dBalancingV2Listeners_CreateOrReplace.json | 334 + ...lasticLoadBalancingV2Listeners_Delete.json | 18 + .../ElasticLoadBalancingV2Listeners_Get.json | 123 + ...ancingV2Listeners_ListByResourceGroup.json | 127 + ...lancingV2Listeners_ListBySubscription.json | 126 + ...lasticLoadBalancingV2Listeners_Update.json | 133 + ...ancingV2LoadBalancers_CreateOrReplace.json | 208 + ...icLoadBalancingV2LoadBalancers_Delete.json | 18 + ...asticLoadBalancingV2LoadBalancers_Get.json | 81 + ...ngV2LoadBalancers_ListByResourceGroup.json | 85 + ...ingV2LoadBalancers_ListBySubscription.json | 84 + ...icLoadBalancingV2LoadBalancers_Update.json | 91 + ...lancingV2TargetGroups_CreateOrReplace.json | 232 + ...ticLoadBalancingV2TargetGroups_Delete.json | 18 + ...lasticLoadBalancingV2TargetGroups_Get.json | 89 + ...ingV2TargetGroups_ListByResourceGroup.json | 93 + ...cingV2TargetGroups_ListBySubscription.json | 92 + ...ticLoadBalancingV2TargetGroups_Update.json | 99 + ...getHealthDescriptions_CreateOrReplace.json | 169 + ...cingv2TargetHealthDescriptions_Delete.json | 18 + ...lancingv2TargetHealthDescriptions_Get.json | 68 + ...ealthDescriptions_ListByResourceGroup.json | 72 + ...HealthDescriptions_ListBySubscription.json | 71 + ...cingv2TargetHealthDescriptions_Update.json | 78 + .../EmrClusterSummaries_CreateOrReplace.json | 190 + .../examples/EmrClusterSummaries_Delete.json | 18 + .../examples/EmrClusterSummaries_Get.json | 75 + ...rClusterSummaries_ListByResourceGroup.json | 79 + ...mrClusterSummaries_ListBySubscription.json | 78 + .../examples/EmrClusterSummaries_Update.json | 85 + .../examples/EmrClusters_CreateOrReplace.json | 469 ++ .../examples/EmrClusters_Delete.json | 18 + .../2024-12-01/examples/EmrClusters_Get.json | 168 + .../EmrClusters_ListByResourceGroup.json | 172 + .../EmrClusters_ListBySubscription.json | 171 + .../examples/EmrClusters_Update.json | 178 + .../GuardDutyDetectors_CreateOrReplace.json | 208 + .../examples/GuardDutyDetectors_Delete.json | 18 + .../examples/GuardDutyDetectors_Get.json | 81 + ...uardDutyDetectors_ListByResourceGroup.json | 85 + ...GuardDutyDetectors_ListBySubscription.json | 84 + .../examples/GuardDutyDetectors_Update.json | 91 + ...IamAccessKeyLastUseds_CreateOrReplace.json | 109 + .../IamAccessKeyLastUseds_Delete.json | 18 + .../examples/IamAccessKeyLastUseds_Get.json | 48 + ...ccessKeyLastUseds_ListByResourceGroup.json | 52 + ...AccessKeyLastUseds_ListBySubscription.json | 51 + .../IamAccessKeyLastUseds_Update.json | 58 + ...AccessKeyMetadataInfo_CreateOrReplace.json | 118 + .../IamAccessKeyMetadataInfo_Delete.json | 18 + .../IamAccessKeyMetadataInfo_Get.json | 51 + ...ssKeyMetadataInfo_ListByResourceGroup.json | 55 + ...essKeyMetadataInfo_ListBySubscription.json | 54 + .../IamAccessKeyMetadataInfo_Update.json | 61 + .../examples/IamGroups_CreateOrReplace.json | 136 + .../2024-12-01/examples/IamGroups_Delete.json | 18 + .../2024-12-01/examples/IamGroups_Get.json | 57 + .../IamGroups_ListByResourceGroup.json | 61 + .../IamGroups_ListBySubscription.json | 60 + .../2024-12-01/examples/IamGroups_Update.json | 67 + .../IamInstanceProfiles_CreateOrUpdate.json | 118 + .../examples/IamInstanceProfiles_Delete.json | 18 + .../examples/IamInstanceProfiles_Get.json | 51 + ...mInstanceProfiles_ListByResourceGroup.json | 55 + ...amInstanceProfiles_ListBySubscription.json | 54 + .../examples/IamInstanceProfiles_Update.json | 61 + .../IamMfaDevices_CreateOrReplace.json | 109 + .../examples/IamMfaDevices_Delete.json | 18 + .../examples/IamMfaDevices_Get.json | 48 + .../IamMfaDevices_ListByResourceGroup.json | 52 + .../IamMfaDevices_ListBySubscription.json | 51 + .../examples/IamMfaDevices_Update.json | 58 + .../IamPasswordPolicies_CreateOrReplace.json | 130 + .../examples/IamPasswordPolicies_Delete.json | 18 + .../examples/IamPasswordPolicies_Get.json | 55 + ...mPasswordPolicies_ListByResourceGroup.json | 59 + ...amPasswordPolicies_ListBySubscription.json | 58 + .../examples/IamPasswordPolicies_Update.json | 65 + .../IamPolicyVersions_CreateOrReplace.json | 112 + .../examples/IamPolicyVersions_Delete.json | 18 + .../examples/IamPolicyVersions_Get.json | 49 + ...IamPolicyVersions_ListByResourceGroup.json | 53 + .../IamPolicyVersions_ListBySubscription.json | 52 + .../examples/IamPolicyVersions_Update.json | 59 + .../examples/IamRoles_CreateOrReplace.json | 169 + .../2024-12-01/examples/IamRoles_Delete.json | 18 + .../2024-12-01/examples/IamRoles_Get.json | 68 + .../IamRoles_ListByResourceGroup.json | 72 + .../examples/IamRoles_ListBySubscription.json | 71 + .../2024-12-01/examples/IamRoles_Update.json | 78 + ...IamServerCertificates_CreateOrReplace.json | 136 + .../IamServerCertificates_Delete.json | 18 + .../examples/IamServerCertificates_Get.json | 57 + ...erverCertificates_ListByResourceGroup.json | 61 + ...ServerCertificates_ListBySubscription.json | 60 + .../IamServerCertificates_Update.json | 67 + .../IamVirtualMfaDevices_CreateOrReplace.json | 136 + .../examples/IamVirtualMfaDevices_Delete.json | 18 + .../examples/IamVirtualMfaDevices_Get.json | 57 + ...VirtualMfaDevices_ListByResourceGroup.json | 61 + ...mVirtualMfaDevices_ListBySubscription.json | 60 + .../examples/IamVirtualMfaDevices_Update.json | 67 + .../examples/KmsAliases_CreateOrReplace.json | 106 + .../examples/KmsAliases_Delete.json | 18 + .../2024-12-01/examples/KmsAliases_Get.json | 47 + .../KmsAliases_ListByResourceGroup.json | 51 + .../KmsAliases_ListBySubscription.json | 50 + .../examples/KmsAliases_Update.json | 57 + .../examples/KmsKeys_CreateOrReplace.json | 157 + .../2024-12-01/examples/KmsKeys_Delete.json | 18 + .../2024-12-01/examples/KmsKeys_Get.json | 64 + .../examples/KmsKeys_ListByResourceGroup.json | 68 + .../examples/KmsKeys_ListBySubscription.json | 67 + .../2024-12-01/examples/KmsKeys_Update.json | 74 + ...FunctionCodeLocations_CreateOrReplace.json | 112 + .../LambdaFunctionCodeLocations_Delete.json | 18 + .../LambdaFunctionCodeLocations_Get.json | 49 + ...tionCodeLocations_ListByResourceGroup.json | 53 + ...ctionCodeLocations_ListBySubscription.json | 52 + .../LambdaFunctionCodeLocations_Update.json | 59 + .../LambdaFunctions_CreateOrReplace.json | 358 + .../examples/LambdaFunctions_Delete.json | 18 + .../examples/LambdaFunctions_Get.json | 131 + .../LambdaFunctions_ListByResourceGroup.json | 135 + .../LambdaFunctions_ListBySubscription.json | 134 + .../examples/LambdaFunctions_Update.json | 141 + .../LightsailBuckets_CreateOrReplace.json | 166 + .../examples/LightsailBuckets_Delete.json | 18 + .../examples/LightsailBuckets_Get.json | 67 + .../LightsailBuckets_ListByResourceGroup.json | 71 + .../LightsailBuckets_ListBySubscription.json | 70 + .../examples/LightsailBuckets_Update.json | 77 + .../LightsailInstances_CreateOrReplace.json | 331 + .../examples/LightsailInstances_Delete.json | 18 + .../examples/LightsailInstances_Get.json | 122 + ...ightsailInstances_ListByResourceGroup.json | 126 + ...LightsailInstances_ListBySubscription.json | 125 + .../examples/LightsailInstances_Update.json | 132 + .../LogsLogGroups_CreateOrReplace.json | 133 + .../examples/LogsLogGroups_Delete.json | 18 + .../examples/LogsLogGroups_Get.json | 56 + .../LogsLogGroups_ListByResourceGroup.json | 60 + .../LogsLogGroups_ListBySubscription.json | 59 + .../examples/LogsLogGroups_Update.json | 66 + .../LogsLogStreams_CreateOrReplace.json | 106 + .../examples/LogsLogStreams_Delete.json | 18 + .../examples/LogsLogStreams_Get.json | 47 + .../LogsLogStreams_ListByResourceGroup.json | 51 + .../LogsLogStreams_ListBySubscription.json | 50 + .../examples/LogsLogStreams_Update.json | 57 + .../LogsMetricFilters_CreateOrReplace.json | 154 + .../examples/LogsMetricFilters_Delete.json | 18 + .../examples/LogsMetricFilters_Get.json | 63 + ...LogsMetricFilters_ListByResourceGroup.json | 67 + .../LogsMetricFilters_ListBySubscription.json | 66 + .../examples/LogsMetricFilters_Update.json | 73 + ...gsSubscriptionFilters_CreateOrReplace.json | 118 + .../LogsSubscriptionFilters_Delete.json | 18 + .../examples/LogsSubscriptionFilters_Get.json | 51 + ...bscriptionFilters_ListByResourceGroup.json | 55 + ...ubscriptionFilters_ListBySubscription.json | 54 + .../LogsSubscriptionFilters_Update.json | 61 + .../Macie2JobSummaries_CreateOrReplace.json | 355 + .../examples/Macie2JobSummaries_Delete.json | 18 + .../examples/Macie2JobSummaries_Get.json | 130 + ...acie2JobSummaries_ListByResourceGroup.json | 134 + ...Macie2JobSummaries_ListBySubscription.json | 133 + .../examples/Macie2JobSummaries_Update.json | 140 + .../MacieAllowLists_CreateOrReplace.json | 154 + .../examples/MacieAllowLists_Delete.json | 18 + .../examples/MacieAllowLists_Get.json | 63 + .../MacieAllowLists_ListByResourceGroup.json | 67 + .../MacieAllowLists_ListBySubscription.json | 66 + .../examples/MacieAllowLists_Update.json | 73 + ...ewallFirewallPolicies_CreateOrReplace.json | 292 + ...etworkFirewallFirewallPolicies_Delete.json | 18 + .../NetworkFirewallFirewallPolicies_Get.json | 109 + ...lFirewallPolicies_ListByResourceGroup.json | 113 + ...llFirewallPolicies_ListBySubscription.json | 112 + ...etworkFirewallFirewallPolicies_Update.json | 119 + ...workFirewallFirewalls_CreateOrReplace.json | 172 + .../NetworkFirewallFirewalls_Delete.json | 18 + .../NetworkFirewallFirewalls_Get.json | 69 + ...FirewallFirewalls_ListByResourceGroup.json | 73 + ...kFirewallFirewalls_ListBySubscription.json | 72 + .../NetworkFirewallFirewalls_Update.json | 79 + ...orkFirewallRuleGroups_CreateOrReplace.json | 508 ++ .../NetworkFirewallRuleGroups_Delete.json | 18 + .../NetworkFirewallRuleGroups_Get.json | 181 + ...irewallRuleGroups_ListByResourceGroup.json | 185 + ...FirewallRuleGroups_ListBySubscription.json | 184 + .../NetworkFirewallRuleGroups_Update.json | 191 + ...nSearchDomainStatuses_CreateOrReplace.json | 604 ++ .../OpenSearchDomainStatuses_Delete.json | 18 + .../OpenSearchDomainStatuses_Get.json | 213 + ...rchDomainStatuses_ListByResourceGroup.json | 217 + ...archDomainStatuses_ListBySubscription.json | 216 + .../OpenSearchDomainStatuses_Update.json | 223 + .../2024-12-01/examples/Operations_List.json | 28 + ...OrganizationsAccounts_CreateOrReplace.json | 151 + .../OrganizationsAccounts_Delete.json | 18 + .../examples/OrganizationsAccounts_Get.json | 62 + ...nizationsAccounts_ListByResourceGroup.json | 66 + ...anizationsAccounts_ListBySubscription.json | 65 + .../OrganizationsAccounts_Update.json | 72 + ...izationsOrganizations_CreateOrReplace.json | 121 + .../OrganizationsOrganizations_Delete.json | 18 + .../OrganizationsOrganizations_Get.json | 52 + ...ionsOrganizations_ListByResourceGroup.json | 56 + ...tionsOrganizations_ListBySubscription.json | 55 + .../OrganizationsOrganizations_Update.json | 62 + .../RdsDbClusters_CreateOrReplace.json | 379 + .../examples/RdsDbClusters_Delete.json | 18 + .../examples/RdsDbClusters_Get.json | 138 + .../RdsDbClusters_ListByResourceGroup.json | 142 + .../RdsDbClusters_ListBySubscription.json | 141 + .../examples/RdsDbClusters_Update.json | 148 + .../RdsDbInstances_CreateOrReplace.json | 439 + .../examples/RdsDbInstances_Delete.json | 18 + .../examples/RdsDbInstances_Get.json | 158 + .../RdsDbInstances_ListByResourceGroup.json | 162 + .../RdsDbInstances_ListBySubscription.json | 161 + .../examples/RdsDbInstances_Update.json | 168 + ...shotAttributesResults_CreateOrReplace.json | 127 + ...RdsDbSnapshotAttributesResults_Delete.json | 18 + .../RdsDbSnapshotAttributesResults_Get.json | 54 + ...AttributesResults_ListByResourceGroup.json | 58 + ...tAttributesResults_ListBySubscription.json | 57 + ...RdsDbSnapshotAttributesResults_Update.json | 64 + .../RdsDbSnapshots_CreateOrReplace.json | 238 + .../examples/RdsDbSnapshots_Delete.json | 18 + .../examples/RdsDbSnapshots_Get.json | 91 + .../RdsDbSnapshots_ListByResourceGroup.json | 95 + .../RdsDbSnapshots_ListBySubscription.json | 94 + .../examples/RdsDbSnapshots_Update.json | 101 + ...RdsEventSubscriptions_CreateOrReplace.json | 148 + .../RdsEventSubscriptions_Delete.json | 18 + .../examples/RdsEventSubscriptions_Get.json | 61 + ...ventSubscriptions_ListByResourceGroup.json | 65 + ...EventSubscriptions_ListBySubscription.json | 64 + .../RdsEventSubscriptions_Update.json | 71 + .../RdsExportTasks_CreateOrReplace.json | 160 + .../examples/RdsExportTasks_Delete.json | 18 + .../examples/RdsExportTasks_Get.json | 65 + .../RdsExportTasks_ListByResourceGroup.json | 69 + .../RdsExportTasks_ListBySubscription.json | 68 + .../examples/RdsExportTasks_Update.json | 75 + ...lusterParameterGroups_CreateOrReplace.json | 145 + ...RedshiftClusterParameterGroups_Delete.json | 18 + .../RedshiftClusterParameterGroups_Get.json | 60 + ...erParameterGroups_ListByResourceGroup.json | 64 + ...terParameterGroups_ListBySubscription.json | 63 + ...RedshiftClusterParameterGroups_Update.json | 70 + .../RedshiftClusters_CreateOrReplace.json | 313 + .../examples/RedshiftClusters_Delete.json | 18 + .../examples/RedshiftClusters_Get.json | 116 + .../RedshiftClusters_ListByResourceGroup.json | 120 + .../RedshiftClusters_ListBySubscription.json | 119 + .../examples/RedshiftClusters_Update.json | 126 + ...omainsDomainSummaries_CreateOrReplace.json | 112 + .../Route53DomainsDomainSummaries_Delete.json | 18 + .../Route53DomainsDomainSummaries_Get.json | 49 + ...nsDomainSummaries_ListByResourceGroup.json | 53 + ...insDomainSummaries_ListBySubscription.json | 52 + .../Route53DomainsDomainSummaries_Update.json | 59 + .../Route53HostedZones_CreateOrReplace.json | 169 + .../examples/Route53HostedZones_Delete.json | 18 + .../examples/Route53HostedZones_Get.json | 68 + ...oute53HostedZones_ListByResourceGroup.json | 72 + ...Route53HostedZones_ListBySubscription.json | 71 + .../examples/Route53HostedZones_Update.json | 78 + ...e53ResourceRecordSets_CreateOrReplace.json | 232 + .../Route53ResourceRecordSets_Delete.json | 18 + .../Route53ResourceRecordSets_Get.json | 89 + ...esourceRecordSets_ListByResourceGroup.json | 93 + ...ResourceRecordSets_ListBySubscription.json | 92 + .../Route53ResourceRecordSets_Update.json | 99 + .../S3AccessPoints_CreateOrReplace.json | 145 + .../examples/S3AccessPoints_Delete.json | 18 + .../examples/S3AccessPoints_Get.json | 60 + .../S3AccessPoints_ListByResourceGroup.json | 64 + .../S3AccessPoints_ListBySubscription.json | 63 + .../examples/S3AccessPoints_Update.json | 70 + .../S3BucketPolicies_CreateOrReplace.json | 103 + .../examples/S3BucketPolicies_Delete.json | 18 + .../examples/S3BucketPolicies_Get.json | 46 + .../S3BucketPolicies_ListByResourceGroup.json | 50 + .../S3BucketPolicies_ListBySubscription.json | 49 + .../examples/S3BucketPolicies_Update.json | 56 + .../examples/S3Buckets_CreateOrReplace.json | 1135 +++ .../2024-12-01/examples/S3Buckets_Delete.json | 18 + .../2024-12-01/examples/S3Buckets_Get.json | 390 + .../S3Buckets_ListByResourceGroup.json | 394 + .../S3Buckets_ListBySubscription.json | 393 + .../2024-12-01/examples/S3Buckets_Update.json | 400 + ...sPointPolicyDocuments_CreateOrReplace.json | 118 + ...gionAccessPointPolicyDocuments_Delete.json | 18 + ...iRegionAccessPointPolicyDocuments_Get.json | 51 + ...ntPolicyDocuments_ListByResourceGroup.json | 55 + ...intPolicyDocuments_ListBySubscription.json | 54 + ...gionAccessPointPolicyDocuments_Update.json | 61 + .../SageMakerApps_CreateOrReplace.json | 148 + .../examples/SageMakerApps_Delete.json | 18 + .../examples/SageMakerApps_Get.json | 61 + .../SageMakerApps_ListByResourceGroup.json | 65 + .../SageMakerApps_ListBySubscription.json | 64 + .../examples/SageMakerApps_Update.json | 71 + ...bookInstanceSummaries_CreateOrReplace.json | 148 + ...MakerNotebookInstanceSummaries_Delete.json | 18 + ...ageMakerNotebookInstanceSummaries_Get.json | 61 + ...InstanceSummaries_ListByResourceGroup.json | 65 + ...kInstanceSummaries_ListBySubscription.json | 64 + ...MakerNotebookInstanceSummaries_Update.json | 71 + ...nagerResourcePolicies_CreateOrReplace.json | 109 + ...SecretsManagerResourcePolicies_Delete.json | 18 + .../SecretsManagerResourcePolicies_Get.json | 48 + ...rResourcePolicies_ListByResourceGroup.json | 52 + ...erResourcePolicies_ListBySubscription.json | 51 + ...SecretsManagerResourcePolicies_Update.json | 58 + ...SecretsManagerSecrets_CreateOrReplace.json | 187 + .../SecretsManagerSecrets_Delete.json | 18 + .../examples/SecretsManagerSecrets_Get.json | 74 + ...etsManagerSecrets_ListByResourceGroup.json | 78 + ...retsManagerSecrets_ListBySubscription.json | 77 + .../SecretsManagerSecrets_Update.json | 84 + .../SnsSubscriptions_CreateOrReplace.json | 115 + .../examples/SnsSubscriptions_Delete.json | 18 + .../examples/SnsSubscriptions_Get.json | 50 + .../SnsSubscriptions_ListByResourceGroup.json | 54 + .../SnsSubscriptions_ListBySubscription.json | 53 + .../examples/SnsSubscriptions_Update.json | 60 + .../examples/SnsTopics_CreateOrReplace.json | 184 + .../2024-12-01/examples/SnsTopics_Delete.json | 18 + .../2024-12-01/examples/SnsTopics_Get.json | 73 + .../SnsTopics_ListByResourceGroup.json | 77 + .../SnsTopics_ListBySubscription.json | 76 + .../2024-12-01/examples/SnsTopics_Update.json | 83 + .../examples/SqsQueues_CreateOrReplace.json | 169 + .../2024-12-01/examples/SqsQueues_Delete.json | 18 + .../2024-12-01/examples/SqsQueues_Get.json | 68 + .../SqsQueues_ListByResourceGroup.json | 72 + .../SqsQueues_ListBySubscription.json | 71 + .../2024-12-01/examples/SqsQueues_Update.json | 78 + ...mInstanceInformations_CreateOrReplace.json | 202 + .../SsmInstanceInformations_Delete.json | 18 + .../examples/SsmInstanceInformations_Get.json | 79 + ...tanceInformations_ListByResourceGroup.json | 83 + ...stanceInformations_ListBySubscription.json | 82 + .../SsmInstanceInformations_Update.json | 89 + .../SsmParameters_CreateOrReplace.json | 124 + .../examples/SsmParameters_Delete.json | 18 + .../examples/SsmParameters_Get.json | 53 + .../SsmParameters_ListByResourceGroup.json | 57 + .../SsmParameters_ListBySubscription.json | 56 + .../examples/SsmParameters_Update.json | 63 + ...omplianceSummaryItems_CreateOrReplace.json | 208 + ...ResourceComplianceSummaryItems_Delete.json | 18 + ...SsmResourceComplianceSummaryItems_Get.json | 81 + ...ianceSummaryItems_ListByResourceGroup.json | 85 + ...lianceSummaryItems_ListBySubscription.json | 84 + ...ResourceComplianceSummaryItems_Update.json | 91 + .../WafWebAclSummaries_CreateOrReplace.json | 106 + .../examples/WafWebAclSummaries_Delete.json | 18 + .../examples/WafWebAclSummaries_Get.json | 47 + ...afWebAclSummaries_ListByResourceGroup.json | 51 + ...WafWebAclSummaries_ListBySubscription.json | 50 + .../examples/WafWebAclSummaries_Update.json | 57 + ...LoggingConfigurations_CreateOrReplace.json | 193 + .../Wafv2LoggingConfigurations_Delete.json | 18 + .../Wafv2LoggingConfigurations_Get.json | 76 + ...ingConfigurations_ListByResourceGroup.json | 80 + ...gingConfigurations_ListBySubscription.json | 79 + .../Wafv2LoggingConfigurations_Update.json | 86 + .../stable/2024-12-01/guardDutyDetector.json | 716 ++ .../2024-12-01/iamAccessKeyLastUsed.json | 555 ++ .../2024-12-01/iamAccessKeyMetadata.json | 593 ++ .../stable/2024-12-01/iamGroup.json | 585 ++ .../stable/2024-12-01/iamInstanceProfile.json | 562 ++ .../stable/2024-12-01/iamMFADevice.json | 555 ++ .../stable/2024-12-01/iamPasswordPolicy.json | 585 ++ .../stable/2024-12-01/iamPolicyVersion.json | 559 ++ .../stable/2024-12-01/iamRole.json | 630 ++ .../2024-12-01/iamServerCertificate.json | 588 ++ .../2024-12-01/iamVirtualMFADevice.json | 584 ++ .../stable/2024-12-01/kmsAlias.json | 550 ++ .../stable/2024-12-01/kmsKey.json | 899 +++ .../stable/2024-12-01/lambdaFunction.json | 1155 +++ .../lambdaFunctionCodeLocation.json | 558 ++ .../stable/2024-12-01/lightsailBucket.json | 622 ++ .../stable/2024-12-01/lightsailInstance.json | 902 +++ .../stable/2024-12-01/logsLogGroup.json | 633 ++ .../stable/2024-12-01/logsLogStream.json | 550 ++ .../stable/2024-12-01/logsMetricFilter.json | 785 ++ .../2024-12-01/logsSubscriptionFilter.json | 590 ++ .../stable/2024-12-01/macie2JobSummary.json | 969 +++ .../stable/2024-12-01/macieAllowList.json | 676 ++ .../2024-12-01/networkFirewallFirewall.json | 630 ++ .../networkFirewallFirewallPolicy.json | 855 ++ .../2024-12-01/networkFirewallRuleGroup.json | 1282 +++ .../2024-12-01/openSearchDomainStatus.json | 2276 ++++++ .../stable/2024-12-01/operations.json | 86 + .../2024-12-01/organizationsAccount.json | 659 ++ .../2024-12-01/organizationsOrganization.json | 615 ++ .../stable/2024-12-01/rdsDBCluster.json | 925 +++ .../stable/2024-12-01/rdsDBInstance.json | 1011 +++ .../stable/2024-12-01/rdsDBSnapshot.json | 731 ++ .../rdsDBSnapshotAttributesResult.json | 572 ++ .../2024-12-01/rdsEventSubscription.json | 597 ++ .../stable/2024-12-01/rdsExportTask.json | 649 ++ .../stable/2024-12-01/redshiftCluster.json | 825 ++ .../redshiftClusterParameterGroup.json | 598 ++ .../route53DomainsDomainSummary.json | 559 ++ .../stable/2024-12-01/route53HostedZone.json | 630 ++ .../2024-12-01/route53ResourceRecordSet.json | 1047 +++ .../stable/2024-12-01/s3AccessPoint.json | 633 ++ .../stable/2024-12-01/s3Bucket.json | 2633 ++++++ .../stable/2024-12-01/s3BucketPolicy.json | 546 ++ ...lMultiRegionAccessPointPolicyDocument.json | 570 ++ .../stable/2024-12-01/sageMakerApp.json | 1038 +++ .../sageMakerNotebookInstanceSummary.json | 1616 ++++ .../secretsManagerResourcePolicy.json | 557 ++ .../2024-12-01/secretsManagerSecret.json | 657 ++ .../stable/2024-12-01/snsSubscription.json | 562 ++ .../stable/2024-12-01/snsTopic.json | 696 ++ .../stable/2024-12-01/sqsQueue.json | 640 ++ .../2024-12-01/ssmInstanceInformation.json | 802 ++ .../stable/2024-12-01/ssmParameter.json | 655 ++ .../ssmResourceComplianceSummaryItem.json | 751 ++ .../stable/2024-12-01/wafWebACLSummary.json | 550 ++ .../2024-12-01/wafv2LoggingConfiguration.json | 793 ++ .../awsconnector/resource-manager/readme.md | 218 + specification/awsconnector/shared/main.tsp | 52 + 1684 files changed, 277481 insertions(+), 1 deletion(-) create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_CreateOrReplace.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Delete.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Get.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListByResourceGroup.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListBySubscription.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Update.json create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/main.tsp create mode 100644 specification/awsconnector/AccessAnalyzerAnalyzer.Management/tspconfig.yaml create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Delete.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Get.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Update.json create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/main.tsp create mode 100644 specification/awsconnector/AcmCertificateSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_CreateOrReplace.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Delete.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Get.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListByResourceGroup.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListBySubscription.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Update.json create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/main.tsp create mode 100644 specification/awsconnector/ApiGatewayRestApi.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_CreateOrReplace.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Delete.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Get.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListByResourceGroup.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListBySubscription.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Update.json create mode 100644 specification/awsconnector/ApiGatewayStage.Management/main.tsp create mode 100644 specification/awsconnector/ApiGatewayStage.Management/tspconfig.yaml create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_CreateOrReplace.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Delete.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Get.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListByResourceGroup.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListBySubscription.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Update.json create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/main.tsp create mode 100644 specification/awsconnector/AppSyncGraphqlApi.Management/tspconfig.yaml create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Delete.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Get.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListBySubscription.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Update.json create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/main.tsp create mode 100644 specification/awsconnector/AutoScalingAutoScalingGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Awsconnector.Management/examples/2024-12-01/Operations_List.json create mode 100644 specification/awsconnector/Awsconnector.Management/main.tsp create mode 100644 specification/awsconnector/Awsconnector.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_CreateOrReplace.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Delete.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Get.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListByResourceGroup.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListBySubscription.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Update.json create mode 100644 specification/awsconnector/CloudFormationStack.Management/main.tsp create mode 100644 specification/awsconnector/CloudFormationStack.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_CreateOrReplace.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Delete.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Get.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListByResourceGroup.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListBySubscription.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Update.json create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/main.tsp create mode 100644 specification/awsconnector/CloudFormationStackSet.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_CreateOrReplace.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Delete.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Get.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListByResourceGroup.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListBySubscription.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Update.json create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/main.tsp create mode 100644 specification/awsconnector/CloudFrontDistribution.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_CreateOrReplace.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Delete.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Get.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListByResourceGroup.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListBySubscription.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Update.json create mode 100644 specification/awsconnector/CloudTrailTrail.Management/main.tsp create mode 100644 specification/awsconnector/CloudTrailTrail.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_CreateOrReplace.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Delete.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Get.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListByResourceGroup.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListBySubscription.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Update.json create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/main.tsp create mode 100644 specification/awsconnector/CloudWatchAlarm.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_CreateOrReplace.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Delete.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Get.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListByResourceGroup.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListBySubscription.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Update.json create mode 100644 specification/awsconnector/CodeBuildProject.Management/main.tsp create mode 100644 specification/awsconnector/CodeBuildProject.Management/tspconfig.yaml create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_CreateOrReplace.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Delete.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Get.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListBySubscription.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Update.json create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/main.tsp create mode 100644 specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_CreateOrReplace.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Delete.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Get.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListByResourceGroup.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListBySubscription.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Update.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/main.tsp create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorder.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Delete.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Get.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Update.json create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/main.tsp create mode 100644 specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_CreateOrReplace.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Delete.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Get.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListByResourceGroup.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListBySubscription.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Update.json create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/main.tsp create mode 100644 specification/awsconnector/ConfigServiceDeliveryChannel.Management/tspconfig.yaml create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Delete.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Get.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Update.json create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/main.tsp create mode 100644 specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/tspconfig.yaml create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Delete.json create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Get.json create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListBySubscription.json create mode 100644 specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Update.json create mode 100644 specification/awsconnector/DaxCluster.Management/main.tsp create mode 100644 specification/awsconnector/DaxCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Delete.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Get.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Update.json create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/main.tsp create mode 100644 specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/tspconfig.yaml create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_CreateOrReplace.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Delete.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Get.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListByResourceGroup.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListBySubscription.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Update.json create mode 100644 specification/awsconnector/DynamoDBTable.Management/main.tsp create mode 100644 specification/awsconnector/DynamoDBTable.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Delete.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Get.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Update.json create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/main.tsp create mode 100644 specification/awsconnector/Ec2AccountAttribute.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Delete.json create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Get.json create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Update.json create mode 100644 specification/awsconnector/Ec2Address.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Address.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Delete.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Get.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Update.json create mode 100644 specification/awsconnector/Ec2FlowLog.Management/main.tsp create mode 100644 specification/awsconnector/Ec2FlowLog.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Delete.json create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Get.json create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Update.json create mode 100644 specification/awsconnector/Ec2Image.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Image.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Delete.json create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Get.json create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_List.json create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Start.json create mode 100644 specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Stop.json create mode 100644 specification/awsconnector/Ec2Instance.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Instance.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Delete.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Get.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Update.json create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/main.tsp create mode 100644 specification/awsconnector/Ec2InstanceStatus.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Delete.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Get.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Update.json create mode 100644 specification/awsconnector/Ec2Ipam.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Ipam.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Delete.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Get.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Update.json create mode 100644 specification/awsconnector/Ec2KeyPair.Management/main.tsp create mode 100644 specification/awsconnector/Ec2KeyPair.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Delete.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Get.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Update.json create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/main.tsp create mode 100644 specification/awsconnector/Ec2NetworkAcl.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Delete.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Get.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Update.json create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/main.tsp create mode 100644 specification/awsconnector/Ec2NetworkInterface.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Delete.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Get.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Update.json create mode 100644 specification/awsconnector/Ec2RouteTable.Management/main.tsp create mode 100644 specification/awsconnector/Ec2RouteTable.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Delete.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Get.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Update.json create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/main.tsp create mode 100644 specification/awsconnector/Ec2SecurityGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Delete.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Get.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Update.json create mode 100644 specification/awsconnector/Ec2Snapshot.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Snapshot.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Delete.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Get.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Update.json create mode 100644 specification/awsconnector/Ec2Subnet.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Subnet.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Delete.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Get.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Update.json create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/main.tsp create mode 100644 specification/awsconnector/Ec2VPCEndpoint.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Delete.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Get.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Update.json create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/main.tsp create mode 100644 specification/awsconnector/Ec2VPCPeeringConnection.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Delete.json create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Get.json create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Update.json create mode 100644 specification/awsconnector/Ec2Volume.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Volume.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_CreateOrReplace.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Delete.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Get.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListByResourceGroup.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListBySubscription.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Update.json create mode 100644 specification/awsconnector/Ec2Vpc.Management/main.tsp create mode 100644 specification/awsconnector/Ec2Vpc.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_CreateOrReplace.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Delete.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Get.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListByResourceGroup.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListBySubscription.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Update.json create mode 100644 specification/awsconnector/EcrImageDetail.Management/main.tsp create mode 100644 specification/awsconnector/EcrImageDetail.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_CreateOrReplace.json create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Delete.json create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Get.json create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListByResourceGroup.json create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListBySubscription.json create mode 100644 specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Update.json create mode 100644 specification/awsconnector/EcrRepository.Management/main.tsp create mode 100644 specification/awsconnector/EcrRepository.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Delete.json create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Get.json create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListBySubscription.json create mode 100644 specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Update.json create mode 100644 specification/awsconnector/EcsCluster.Management/main.tsp create mode 100644 specification/awsconnector/EcsCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_CreateOrReplace.json create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Delete.json create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Get.json create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListByResourceGroup.json create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListBySubscription.json create mode 100644 specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Update.json create mode 100644 specification/awsconnector/EcsService.Management/main.tsp create mode 100644 specification/awsconnector/EcsService.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_CreateOrReplace.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Delete.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Get.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListByResourceGroup.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListBySubscription.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Update.json create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/main.tsp create mode 100644 specification/awsconnector/EcsTaskDefinition.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_CreateOrReplace.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Delete.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Get.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListByResourceGroup.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListBySubscription.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Update.json create mode 100644 specification/awsconnector/EfsFileSystem.Management/main.tsp create mode 100644 specification/awsconnector/EfsFileSystem.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_CreateOrReplace.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Delete.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Get.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListByResourceGroup.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListBySubscription.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Update.json create mode 100644 specification/awsconnector/EfsMountTarget.Management/main.tsp create mode 100644 specification/awsconnector/EfsMountTarget.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Delete.json create mode 100644 specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Get.json create mode 100644 specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_List.json create mode 100644 specification/awsconnector/EksCluster.Management/main.tsp create mode 100644 specification/awsconnector/EksCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_CreateOrReplace.json create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Delete.json create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Get.json create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListBySubscription.json create mode 100644 specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Update.json create mode 100644 specification/awsconnector/EksNodegroup.Management/main.tsp create mode 100644 specification/awsconnector/EksNodegroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Delete.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Get.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Update.json create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/main.tsp create mode 100644 specification/awsconnector/ElasticBeanstalkApplication.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Delete.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Get.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Update.json create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/main.tsp create mode 100644 specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Delete.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Get.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Update.json create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/main.tsp create mode 100644 specification/awsconnector/ElasticBeanstalkEnvironment.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Delete.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Get.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Update.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/main.tsp create mode 100644 specification/awsconnector/ElasticLoadBalancingV2Listener.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Delete.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Get.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Update.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/main.tsp create mode 100644 specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Delete.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Get.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Update.json create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/main.tsp create mode 100644 specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/main.tsp create mode 100644 specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Delete.json create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Get.json create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListBySubscription.json create mode 100644 specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Update.json create mode 100644 specification/awsconnector/EmrCluster.Management/main.tsp create mode 100644 specification/awsconnector/EmrCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Delete.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Get.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Update.json create mode 100644 specification/awsconnector/EmrClusterSummary.Management/main.tsp create mode 100644 specification/awsconnector/EmrClusterSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_CreateOrReplace.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Delete.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Get.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListByResourceGroup.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListBySubscription.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Update.json create mode 100644 specification/awsconnector/GuardDutyDetector.Management/main.tsp create mode 100644 specification/awsconnector/GuardDutyDetector.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_CreateOrReplace.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Delete.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Get.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListBySubscription.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Update.json create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/main.tsp create mode 100644 specification/awsconnector/IamAccessKeyLastUsed.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_CreateOrReplace.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Delete.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Get.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListBySubscription.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Update.json create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/main.tsp create mode 100644 specification/awsconnector/IamAccessKeyMetadata.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Delete.json create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Get.json create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListBySubscription.json create mode 100644 specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Update.json create mode 100644 specification/awsconnector/IamGroup.Management/main.tsp create mode 100644 specification/awsconnector/IamGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_CreateOrUpdate.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Delete.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Get.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListBySubscription.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Update.json create mode 100644 specification/awsconnector/IamInstanceProfile.Management/main.tsp create mode 100644 specification/awsconnector/IamInstanceProfile.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_CreateOrReplace.json create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Delete.json create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Get.json create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListBySubscription.json create mode 100644 specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Update.json create mode 100644 specification/awsconnector/IamMFADevice.Management/main.tsp create mode 100644 specification/awsconnector/IamMFADevice.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Delete.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Get.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Update.json create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/main.tsp create mode 100644 specification/awsconnector/IamPasswordPolicy.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_CreateOrReplace.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Delete.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Get.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListBySubscription.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Update.json create mode 100644 specification/awsconnector/IamPolicyVersion.Management/main.tsp create mode 100644 specification/awsconnector/IamPolicyVersion.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_CreateOrReplace.json create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Delete.json create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Get.json create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListBySubscription.json create mode 100644 specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Update.json create mode 100644 specification/awsconnector/IamRole.Management/main.tsp create mode 100644 specification/awsconnector/IamRole.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_CreateOrReplace.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Delete.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Get.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListBySubscription.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Update.json create mode 100644 specification/awsconnector/IamServerCertificate.Management/main.tsp create mode 100644 specification/awsconnector/IamServerCertificate.Management/tspconfig.yaml create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_CreateOrReplace.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Delete.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Get.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListByResourceGroup.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListBySubscription.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Update.json create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/main.tsp create mode 100644 specification/awsconnector/IamVirtualMFADevice.Management/tspconfig.yaml create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_CreateOrReplace.json create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Delete.json create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Get.json create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListByResourceGroup.json create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListBySubscription.json create mode 100644 specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Update.json create mode 100644 specification/awsconnector/KmsAlias.Management/main.tsp create mode 100644 specification/awsconnector/KmsAlias.Management/tspconfig.yaml create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_CreateOrReplace.json create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Delete.json create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Get.json create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListByResourceGroup.json create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListBySubscription.json create mode 100644 specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Update.json create mode 100644 specification/awsconnector/KmsKey.Management/main.tsp create mode 100644 specification/awsconnector/KmsKey.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_CreateOrReplace.json create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Delete.json create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Get.json create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListByResourceGroup.json create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListBySubscription.json create mode 100644 specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Update.json create mode 100644 specification/awsconnector/LambdaFunction.Management/main.tsp create mode 100644 specification/awsconnector/LambdaFunction.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_CreateOrReplace.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Delete.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Get.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListByResourceGroup.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListBySubscription.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Update.json create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/main.tsp create mode 100644 specification/awsconnector/LambdaFunctionCodeLocation.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_CreateOrReplace.json create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Delete.json create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Get.json create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListByResourceGroup.json create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListBySubscription.json create mode 100644 specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Update.json create mode 100644 specification/awsconnector/LightsailBucket.Management/main.tsp create mode 100644 specification/awsconnector/LightsailBucket.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Delete.json create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Get.json create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListBySubscription.json create mode 100644 specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Update.json create mode 100644 specification/awsconnector/LightsailInstance.Management/main.tsp create mode 100644 specification/awsconnector/LightsailInstance.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Delete.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Get.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListBySubscription.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Update.json create mode 100644 specification/awsconnector/LogsLogGroup.Management/main.tsp create mode 100644 specification/awsconnector/LogsLogGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_CreateOrReplace.json create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Delete.json create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Get.json create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListByResourceGroup.json create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListBySubscription.json create mode 100644 specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Update.json create mode 100644 specification/awsconnector/LogsLogStream.Management/main.tsp create mode 100644 specification/awsconnector/LogsLogStream.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_CreateOrReplace.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Delete.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Get.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListByResourceGroup.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListBySubscription.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Update.json create mode 100644 specification/awsconnector/LogsMetricFilter.Management/main.tsp create mode 100644 specification/awsconnector/LogsMetricFilter.Management/tspconfig.yaml create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_CreateOrReplace.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Delete.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Get.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListByResourceGroup.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListBySubscription.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Update.json create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/main.tsp create mode 100644 specification/awsconnector/LogsSubscriptionFilter.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Delete.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Get.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Update.json create mode 100644 specification/awsconnector/Macie2JobSummary.Management/main.tsp create mode 100644 specification/awsconnector/Macie2JobSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_CreateOrReplace.json create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Delete.json create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Get.json create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListByResourceGroup.json create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListBySubscription.json create mode 100644 specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Update.json create mode 100644 specification/awsconnector/MacieAllowList.Management/main.tsp create mode 100644 specification/awsconnector/MacieAllowList.Management/tspconfig.yaml create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_CreateOrReplace.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Delete.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Get.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListByResourceGroup.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListBySubscription.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Update.json create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/main.tsp create mode 100644 specification/awsconnector/NetworkFirewallFirewall.Management/tspconfig.yaml create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Delete.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Get.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Update.json create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/main.tsp create mode 100644 specification/awsconnector/NetworkFirewallFirewallPolicy.Management/tspconfig.yaml create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Delete.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Get.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListBySubscription.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Update.json create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/main.tsp create mode 100644 specification/awsconnector/NetworkFirewallRuleGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Delete.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Get.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Update.json create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/main.tsp create mode 100644 specification/awsconnector/OpenSearchDomainStatus.Management/tspconfig.yaml create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_CreateOrReplace.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Delete.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Get.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListByResourceGroup.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListBySubscription.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Update.json create mode 100644 specification/awsconnector/OrganizationsAccount.Management/main.tsp create mode 100644 specification/awsconnector/OrganizationsAccount.Management/tspconfig.yaml create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_CreateOrReplace.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Delete.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Get.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListByResourceGroup.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListBySubscription.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Update.json create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/main.tsp create mode 100644 specification/awsconnector/OrganizationsOrganization.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Delete.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Get.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListBySubscription.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Update.json create mode 100644 specification/awsconnector/RdsDBCluster.Management/main.tsp create mode 100644 specification/awsconnector/RdsDBCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Delete.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Get.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListBySubscription.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Update.json create mode 100644 specification/awsconnector/RdsDBInstance.Management/main.tsp create mode 100644 specification/awsconnector/RdsDBInstance.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Delete.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Get.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListBySubscription.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Update.json create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/main.tsp create mode 100644 specification/awsconnector/RdsDBSnapshot.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Delete.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Get.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListBySubscription.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Update.json create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/main.tsp create mode 100644 specification/awsconnector/RdsDBSnapshotAttributesResult.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Delete.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Get.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListBySubscription.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Update.json create mode 100644 specification/awsconnector/RdsEventSubscription.Management/main.tsp create mode 100644 specification/awsconnector/RdsEventSubscription.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_CreateOrReplace.json create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Delete.json create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Get.json create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListByResourceGroup.json create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListBySubscription.json create mode 100644 specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Update.json create mode 100644 specification/awsconnector/RdsExportTask.Management/main.tsp create mode 100644 specification/awsconnector/RdsExportTask.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Delete.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Get.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListBySubscription.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Update.json create mode 100644 specification/awsconnector/RedshiftCluster.Management/main.tsp create mode 100644 specification/awsconnector/RedshiftCluster.Management/tspconfig.yaml create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Delete.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Get.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListBySubscription.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Update.json create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/main.tsp create mode 100644 specification/awsconnector/RedshiftClusterParameterGroup.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Delete.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Get.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Update.json create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/main.tsp create mode 100644 specification/awsconnector/Route53DomainsDomainSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_CreateOrReplace.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Delete.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Get.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListByResourceGroup.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListBySubscription.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Update.json create mode 100644 specification/awsconnector/Route53HostedZone.Management/main.tsp create mode 100644 specification/awsconnector/Route53HostedZone.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_CreateOrReplace.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Delete.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Get.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListByResourceGroup.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListBySubscription.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Update.json create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/main.tsp create mode 100644 specification/awsconnector/Route53ResourceRecordSet.Management/tspconfig.yaml create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_CreateOrReplace.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Delete.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Get.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListByResourceGroup.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListBySubscription.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Update.json create mode 100644 specification/awsconnector/S3AccessPoint.Management/main.tsp create mode 100644 specification/awsconnector/S3AccessPoint.Management/tspconfig.yaml create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_CreateOrReplace.json create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Delete.json create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Get.json create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListByResourceGroup.json create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListBySubscription.json create mode 100644 specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Update.json create mode 100644 specification/awsconnector/S3Bucket.Management/main.tsp create mode 100644 specification/awsconnector/S3Bucket.Management/tspconfig.yaml create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Delete.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Get.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Update.json create mode 100644 specification/awsconnector/S3BucketPolicy.Management/main.tsp create mode 100644 specification/awsconnector/S3BucketPolicy.Management/tspconfig.yaml create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/main.tsp create mode 100644 specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_CreateOrReplace.json create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Delete.json create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Get.json create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListByResourceGroup.json create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListBySubscription.json create mode 100644 specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Update.json create mode 100644 specification/awsconnector/SageMakerApp.Management/main.tsp create mode 100644 specification/awsconnector/SageMakerApp.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Delete.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Get.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Update.json create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/main.tsp create mode 100644 specification/awsconnector/SageMakerNotebookInstanceSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Delete.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Get.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListBySubscription.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Update.json create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/main.tsp create mode 100644 specification/awsconnector/SecretsManagerResourcePolicy.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_CreateOrReplace.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Delete.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Get.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListByResourceGroup.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListBySubscription.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Update.json create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/main.tsp create mode 100644 specification/awsconnector/SecretsManagerSecret.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Delete.json create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Get.json create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListBySubscription.json create mode 100644 specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Update.json create mode 100644 specification/awsconnector/SnsSubscription.Management/main.tsp create mode 100644 specification/awsconnector/SnsSubscription.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_CreateOrReplace.json create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Delete.json create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Get.json create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListByResourceGroup.json create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListBySubscription.json create mode 100644 specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Update.json create mode 100644 specification/awsconnector/SnsTopic.Management/main.tsp create mode 100644 specification/awsconnector/SnsTopic.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_CreateOrReplace.json create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Delete.json create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Get.json create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListByResourceGroup.json create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListBySubscription.json create mode 100644 specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Update.json create mode 100644 specification/awsconnector/SqsQueue.Management/main.tsp create mode 100644 specification/awsconnector/SqsQueue.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_CreateOrReplace.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Delete.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Get.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListByResourceGroup.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListBySubscription.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Update.json create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/main.tsp create mode 100644 specification/awsconnector/SsmInstanceInformation.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_CreateOrReplace.json create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Delete.json create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Get.json create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListByResourceGroup.json create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListBySubscription.json create mode 100644 specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Update.json create mode 100644 specification/awsconnector/SsmParameter.Management/main.tsp create mode 100644 specification/awsconnector/SsmParameter.Management/tspconfig.yaml create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_CreateOrReplace.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Delete.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Get.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListByResourceGroup.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListBySubscription.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Update.json create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/main.tsp create mode 100644 specification/awsconnector/SsmResourceComplianceSummaryItem.Management/tspconfig.yaml create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Delete.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Get.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Update.json create mode 100644 specification/awsconnector/WafWebACLSummary.Management/main.tsp create mode 100644 specification/awsconnector/WafWebACLSummary.Management/tspconfig.yaml create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_CreateOrReplace.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Delete.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Get.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListByResourceGroup.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListBySubscription.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Update.json create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/main.tsp create mode 100644 specification/awsconnector/Wafv2LoggingConfiguration.Management/tspconfig.yaml create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/accessAnalyzerAnalyzer.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/acmCertificateSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayRestApi.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayStage.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/appSyncGraphqlApi.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/autoScalingAutoScalingGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStack.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStackSet.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFrontDistribution.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudTrailTrail.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudWatchAlarm.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildProject.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildSourceCredentialsInfo.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorder.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorderStatus.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceDeliveryChannel.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/databaseMigrationServiceReplicationInstance.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/daxCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBContinuousBackupsDescription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBTable.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2AccountAttribute.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Address.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2FlowLog.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Image.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Instance.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2InstanceStatus.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Ipam.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2KeyPair.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkAcl.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkInterface.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2RouteTable.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2SecurityGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Snapshot.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Subnet.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCEndpoint.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCPeeringConnection.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Volume.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Vpc.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrImageDetail.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrRepository.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsService.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsTaskDefinition.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsFileSystem.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsMountTarget.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksNodegroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkApplication.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkConfigurationTemplate.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkEnvironment.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2Listener.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2LoadBalancer.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetHealthDescription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrClusterSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_List.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Start.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Stop.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_List.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_CreateOrUpdate.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Operations_List.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_CreateOrReplace.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Delete.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Get.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListByResourceGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListBySubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Update.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/guardDutyDetector.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyLastUsed.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyMetadata.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamInstanceProfile.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamMFADevice.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPasswordPolicy.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPolicyVersion.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamRole.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamServerCertificate.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamVirtualMFADevice.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsAlias.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsKey.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunction.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunctionCodeLocation.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailBucket.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailInstance.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogStream.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsMetricFilter.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsSubscriptionFilter.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macie2JobSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macieAllowList.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewall.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewallPolicy.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallRuleGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/openSearchDomainStatus.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/operations.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsAccount.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsOrganization.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBInstance.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshot.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshotAttributesResult.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsEventSubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsExportTask.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftCluster.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftClusterParameterGroup.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53DomainsDomainSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53HostedZone.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53ResourceRecordSet.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3AccessPoint.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3Bucket.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3BucketPolicy.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3ControlMultiRegionAccessPointPolicyDocument.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerApp.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerNotebookInstanceSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerResourcePolicy.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerSecret.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsSubscription.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsTopic.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sqsQueue.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmInstanceInformation.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmParameter.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmResourceComplianceSummaryItem.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafWebACLSummary.json create mode 100644 specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafv2LoggingConfiguration.json create mode 100644 specification/awsconnector/resource-manager/readme.md create mode 100644 specification/awsconnector/shared/main.tsp diff --git a/cSpell.json b/cSpell.json index d30e94ab13fe..256f00c50ab5 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1300,24 +1300,200 @@ { "filename": "**/specification/awsconnector/resource-manager/Microsoft.AwsConnector/**/*.json", "words": [ + "ABAC", + "ACFP", + "ACMPCA", "ACUs", + "assemblyline", + "autoprovision", + "Aviv", + "AWSACM", + "AWSACMPCA", + "AWSAPS", + "AWSDMS", + "AWSEC", + "AWSECR", + "AWSECS", + "AWSEFS", + "AWSEKS", + "AWSELB", + "AWSEMR", + "awsfirelens", + "AWSFIS", + "AWSIAM", + "AWSIAMSAML", + "AWSIVS", + "AWSKMS", + "awslogs", + "AWSM", + "AWSMSK", + "AWSQLDB", "AWSRDS", + "AWSRDSDB", + "AWSRUM", + "AWSS", + "AWSSES", + "AWSSNS", + "AWSSQS", + "AWSSSM", + "awsvpc", + "AWSWAF", + "AWSX", + "binpack", + "buildspec", + "CFNS", + "CMAP", + "CMK's", + "CODECONNECTIONS", + "cooldowns", + "credentialspec", + "credentialspecdomainless", + "credspec", + "daxs", "DCERPC", + "dd'T'HH", + "desync", + "diratime", + "dirsync", + "domainless", "Dsse", "dsse", + "Dtest", + "Dtestsecret", "dualstack", + "EEZNYKUA", + "efgyghrtguk", + "Elong", + "emaccess", + "ENCHIPHERMENT", "ENIs", + "FARGAT", "Fargate", + "FDTNDATAQYW", + "Firelens", + "firelens", + "fluentbit", + "FOWNER", + "FPGAs", + "fpgas", + "FSETID", + "Fuota", + "Gelf", + "gelf", + "GENEVE", + "Geoproximity", + "healthcheck", + "hostedzone", + "hypens", + "IJCEXJP", + "Ilong", + "Inferentia", + "instancegroup", + "Intlong", + "IPAM's", + "Ipams", + "JDBC", + "kadmin", + "keytabs", + "logentries", + "lowercased", + "mand", + "maxage", + "MKNOD", + "mknod", + "Mlong", + "mpol", + "mqueue", + "mrap", + "MSAs", + "msgmax", + "msgmnb", + "msgmni", + "multicloud", "multimaster", + "multivalue", + "Multivalue", + "myawslogbucket", + "mycluster", + "mydomain", + "mykeyspace", + "mymanaged", + "myprefix", + "myrepinstance", + "myselfmanaged", + "mytable", + "nfsvers", + "Ningxia", + "Nlong", + "noatime", "nodegroup", "Nodegroups", + "nodev", + "nodiratime", + "NOERROR", + "noexec", + "nohup", + "nomand", "nondefault", + "norelatime", + "nostrictatime", + "nosuid", + "Nshort", + "oemagent", "ONEZONE", + "PACCT", "parallelquery", + "Paulo", + "Plong", "preconfigures", + "PRERELEASED", + "PTRACE", + "Radeon", + "radeon", + "RAWIO", + "rbind", + "RDSCDB", + "redrive", + "relatime", + "resouce", + "retrans", + "rmid", + "Robo", + "rprivate", + "rshared", + "rsize", + "rslave", + "runbindable", + "SETFCAP", + "SETPCAP", + "shmall", + "shmmax", + "shmmni", + "SIEXAMPLE", + "slowquery", + "Sqli", + "sqli", + "sqlserver", + "ss'Z", + "strictatime", + "subdivisioncode", "tierings", + "timeo", + "ulimits", + "Ultrawarm", + "ultrawarm", + "unbindable", + "untagging", + "Useds", "VPC's", - "wihtin" + "webacl", + "whitespaces", + "wihtin", + "workdir", + "wsize", + "xxdriver", + "xxlabel", + "xxopt" ] }, { diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_CreateOrReplace.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_CreateOrReplace.json new file mode 100644 index 000000000000..7df378f571fb --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_CreateOrReplace.json @@ -0,0 +1,196 @@ +{ + "title": "AccessAnalyzerAnalyzers_CreateOrReplace", + "operationId": "AccessAnalyzerAnalyzers_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + } + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Delete.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Delete.json new file mode 100644 index 000000000000..8927311ebc49 --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessAnalyzerAnalyzers_Delete", + "operationId": "AccessAnalyzerAnalyzers_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Get.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Get.json new file mode 100644 index 000000000000..62c2f082be31 --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Get.json @@ -0,0 +1,77 @@ +{ + "title": "AccessAnalyzerAnalyzers_Get", + "operationId": "AccessAnalyzerAnalyzers_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListByResourceGroup.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListByResourceGroup.json new file mode 100644 index 000000000000..dffcd2fbfe71 --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListByResourceGroup.json @@ -0,0 +1,81 @@ +{ + "title": "AccessAnalyzerAnalyzers_ListByResourceGroup", + "operationId": "AccessAnalyzerAnalyzers_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListBySubscription.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListBySubscription.json new file mode 100644 index 000000000000..559d289adb65 --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_ListBySubscription.json @@ -0,0 +1,80 @@ +{ + "title": "AccessAnalyzerAnalyzers_ListBySubscription", + "operationId": "AccessAnalyzerAnalyzers_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Update.json b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Update.json new file mode 100644 index 000000000000..702449a00623 --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/examples/2024-12-01/AccessAnalyzerAnalyzers_Update.json @@ -0,0 +1,87 @@ +{ + "title": "AccessAnalyzerAnalyzers_Update", + "operationId": "AccessAnalyzerAnalyzers_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1003": "qwlcozyqjeulbpmknq" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/main.tsp b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/main.tsp new file mode 100644 index 000000000000..9618fcfb5dac --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/main.tsp @@ -0,0 +1,178 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- AccessAnalyzerAnalyzers ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Access Analyzer Analyzer", + plural: "Access Analyzer Analyzers", + }, + keywords: ["Microsoft.AwsConnector", "Access", "Analyzer", "Analyzer"], +}) +@doc("A Microsoft.AwsConnector resource") +model AccessAnalyzerAnalyzer + is TrackedResource<AccessAnalyzerAnalyzerProperties> { + @doc("Name of AccessAnalyzerAnalyzer") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("accessAnalyzerAnalyzers") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccessAnalyzerAnalyzer") +model AccessAnalyzerAnalyzerProperties { + @doc("AWS Properties") + awsProperties?: AwsAccessAnalyzerAnalyzerProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsAccessAnalyzerAnalyzer") +model AwsAccessAnalyzerAnalyzerProperties { + @doc("The configuration for the analyzer") + analyzerConfiguration?: UnusedAccessConfiguration; + + @doc("Analyzer name") + analyzerName?: string; + + @doc("Property archiveRules") + @extension("x-ms-identifiers", []) + archiveRules?: ArchiveRule[]; + + @doc("Amazon Resource Name (ARN) of the analyzer") + arn?: string; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of UnusedAccessConfiguration") +model UnusedAccessConfiguration { + @doc("The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days.") + unusedAccessAge?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArchiveRule") +model ArchiveRule { + @doc("Property filter") + @extension("x-ms-identifiers", []) + filter?: Filter[]; + + @doc("The archive rule name") + ruleName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Filter") +model Filter { + @doc("Property contains") + @extension("x-ms-identifiers", []) + contains?: string[]; + + @doc("Property eq") + @extension("x-ms-identifiers", []) + eq?: string[]; + + @doc("Property exists") + exists?: boolean; + + @doc("Property neq") + @extension("x-ms-identifiers", []) + neq?: string[]; + + @doc("Property property") + property?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface AccessAnalyzerAnalyzers { + get is ArmResourceRead<AccessAnalyzerAnalyzer>; + @doc("Create a AccessAnalyzerAnalyzer. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<AccessAnalyzerAnalyzer>; + update is ArmCustomPatchAsync< + AccessAnalyzerAnalyzer, + Azure.ResourceManager.Foundations.TagsUpdateModel<AccessAnalyzerAnalyzer> + >; + delete is ArmResourceDeleteWithoutOkAsync<AccessAnalyzerAnalyzer>; + listByResourceGroup is ArmResourceListByParent<AccessAnalyzerAnalyzer>; + listBySubscription is ArmListBySubscription<AccessAnalyzerAnalyzer>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::AccessAnalyzer::Analyzer +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/AccessAnalyzerAnalyzer.Management/tspconfig.yaml b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/tspconfig.yaml new file mode 100644 index 000000000000..42cde854cebb --- /dev/null +++ b/specification/awsconnector/AccessAnalyzerAnalyzer.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/accessAnalyzerAnalyzer.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_CreateOrReplace.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..d434a5d8d233 --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_CreateOrReplace.json @@ -0,0 +1,196 @@ +{ + "title": "AcmCertificateSummaries_CreateOrReplace", + "operationId": "AcmCertificateSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + } + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + } + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Delete.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Delete.json new file mode 100644 index 000000000000..be7591ee60f5 --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AcmCertificateSummaries_Delete", + "operationId": "AcmCertificateSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Get.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Get.json new file mode 100644 index 000000000000..2a81bc86b829 --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Get.json @@ -0,0 +1,77 @@ +{ + "title": "AcmCertificateSummaries_Get", + "operationId": "AcmCertificateSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + } + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListByResourceGroup.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..27a8f5108708 --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListByResourceGroup.json @@ -0,0 +1,81 @@ +{ + "title": "AcmCertificateSummaries_ListByResourceGroup", + "operationId": "AcmCertificateSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListBySubscription.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListBySubscription.json new file mode 100644 index 000000000000..ac9237c67192 --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_ListBySubscription.json @@ -0,0 +1,80 @@ +{ + "title": "AcmCertificateSummaries_ListBySubscription", + "operationId": "AcmCertificateSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Update.json b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Update.json new file mode 100644 index 000000000000..0e1fce25965c --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/examples/2024-12-01/AcmCertificateSummaries_Update.json @@ -0,0 +1,87 @@ +{ + "title": "AcmCertificateSummaries_Update", + "operationId": "AcmCertificateSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3895": "kebzsfrojxzzoumlemmuisxjnshoch" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/AcmCertificateSummary.Management/main.tsp b/specification/awsconnector/AcmCertificateSummary.Management/main.tsp new file mode 100644 index 000000000000..2f0b9773af7c --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/main.tsp @@ -0,0 +1,375 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- AcmCertificateSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ACM Certificate Summary", + plural: "ACM Certificate Summaries", + }, + keywords: ["Microsoft.AwsConnector", "ACM", "Certificate", "Summary"], +}) +@doc("A Microsoft.AwsConnector resource") +model AcmCertificateSummary + is TrackedResource<AcmCertificateSummaryProperties> { + @doc("Name of AcmCertificateSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("acmCertificateSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AcmCertificateSummary") +model AcmCertificateSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsAcmCertificateSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsAcmCertificateSummary") +model AwsAcmCertificateSummaryProperties { + @doc("<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href='https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html'>Amazon Resource Names (ARNs)</a>.</p>") + certificateArn?: string; + + @doc("<p>The time at which the certificate was requested.</p>") + createdAt?: utcDateTime; + + @doc("<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>") + domainName?: string; + + @doc("<p>Indicates whether the certificate has been exported. This value exists only when the certificate type is <code>PRIVATE</code>.</p>") + exported?: boolean; + + @doc("<p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>") + @extension("x-ms-identifiers", []) + extendedKeyUsages?: ExtendedKeyUsageName[]; + + @doc("<p>When called by <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'>ListCertificates</a>, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'>DescribeCertificate</a>.</p>") + hasAdditionalSubjectAlternativeNames?: boolean; + + @doc("<p>The date and time when the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>") + importedAt?: utcDateTime; + + @doc("<p>Indicates whether the certificate is currently in use by any Amazon Web Services resources.</p>") + inUse?: boolean; + + @doc("<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>") + issuedAt?: utcDateTime; + + @doc("<p>The algorithm that was used to generate the public-private key pair.</p>") + keyAlgorithm?: KeyAlgorithmEnumValue; + + @doc("<p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>") + @extension("x-ms-identifiers", []) + keyUsages?: KeyUsageName[]; + + @doc("<p>The time after which the certificate is not valid.</p>") + notAfter?: utcDateTime; + + @doc("<p>The time before which the certificate is not valid.</p>") + notBefore?: utcDateTime; + + @doc("<p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>") + renewalEligibility?: RenewalEligibilityEnumValue; + + @doc("<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>") + revokedAt?: utcDateTime; + + @doc("<p>The status of the certificate.</p> <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic <a href='https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html'>Certificate request fails</a>. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href='https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html'>DNS validation</a> or <a href='https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html'>Email validation</a>, and try again. If validation succeeds, the certificate enters status ISSUED. </p>") + status?: CertificateStatusEnumValue; + + @doc("<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p> <p>When called by <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'>ListCertificates</a>, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'>DescribeCertificate</a>.</p>") + @extension("x-ms-identifiers", []) + subjectAlternativeNameSummaries?: string[]; + + @doc("<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href='https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html'>managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href='https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html'>Importing Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>") + type?: CertificateTypeEnumValue; +} + +@doc("ExtendedKeyUsageName enum") +union ExtendedKeyUsageName { + @doc("ExtendedKeyUsageName enum ANY") + ANY: "ANY", + + @doc("ExtendedKeyUsageName enum CODE_SIGNING") + CODE_SIGNING: "CODE_SIGNING", + + @doc("ExtendedKeyUsageName enum CUSTOM") + CUSTOM: "CUSTOM", + + @doc("ExtendedKeyUsageName enum EMAIL_PROTECTION") + EMAIL_PROTECTION: "EMAIL_PROTECTION", + + @doc("ExtendedKeyUsageName enum IPSEC_END_SYSTEM") + IPSEC_END_SYSTEM: "IPSEC_END_SYSTEM", + + @doc("ExtendedKeyUsageName enum IPSEC_TUNNEL") + IPSEC_TUNNEL: "IPSEC_TUNNEL", + + @doc("ExtendedKeyUsageName enum IPSEC_USER") + IPSEC_USER: "IPSEC_USER", + + @doc("ExtendedKeyUsageName enum NONE") + NONE: "NONE", + + @doc("ExtendedKeyUsageName enum OCSP_SIGNING") + OCSP_SIGNING: "OCSP_SIGNING", + + @doc("ExtendedKeyUsageName enum TIME_STAMPING") + TIME_STAMPING: "TIME_STAMPING", + + @doc("ExtendedKeyUsageName enum TLS_WEB_CLIENT_AUTHENTICATION") + TLS_WEB_CLIENT_AUTHENTICATION: "TLS_WEB_CLIENT_AUTHENTICATION", + + @doc("ExtendedKeyUsageName enum TLS_WEB_SERVER_AUTHENTICATION") + TLS_WEB_SERVER_AUTHENTICATION: "TLS_WEB_SERVER_AUTHENTICATION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ExtendedKeyUsageNameEnumValue") +model ExtendedKeyUsageNameEnumValue { + @doc("Property value") + value?: ExtendedKeyUsageName; +} + +@doc("KeyUsageName enum") +union KeyUsageName { + @doc("KeyUsageName enum ANY") + ANY: "ANY", + + @doc("KeyUsageName enum CERTIFICATE_SIGNING") + CERTIFICATE_SIGNING: "CERTIFICATE_SIGNING", + + @doc("KeyUsageName enum CRL_SIGNING") + CRL_SIGNING: "CRL_SIGNING", + + @doc("KeyUsageName enum CUSTOM") + CUSTOM: "CUSTOM", + + @doc("KeyUsageName enum DATA_ENCIPHERMENT") + DATA_ENCIPHERMENT: "DATA_ENCIPHERMENT", + + @doc("KeyUsageName enum DECIPHER_ONLY") + DECIPHER_ONLY: "DECIPHER_ONLY", + + @doc("KeyUsageName enum DIGITAL_SIGNATURE") + DIGITAL_SIGNATURE: "DIGITAL_SIGNATURE", + + @doc("KeyUsageName enum ENCIPHER_ONLY") + ENCIPHER_ONLY: "ENCIPHER_ONLY", + + @doc("KeyUsageName enum KEY_AGREEMENT") + KEY_AGREEMENT: "KEY_AGREEMENT", + + @doc("KeyUsageName enum KEY_ENCIPHERMENT") + KEY_ENCIPHERMENT: "KEY_ENCIPHERMENT", + + @doc("KeyUsageName enum NON_REPUDIATION") + NON_REPUDIATION: "NON_REPUDIATION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KeyUsageNameEnumValue") +model KeyUsageNameEnumValue { + @doc("Property value") + value?: KeyUsageName; +} + +@doc("CertificateStatus enum") +union CertificateStatus { + @doc("CertificateStatus enum EXPIRED") + EXPIRED: "EXPIRED", + + @doc("CertificateStatus enum FAILED") + FAILED: "FAILED", + + @doc("CertificateStatus enum INACTIVE") + INACTIVE: "INACTIVE", + + @doc("CertificateStatus enum ISSUED") + ISSUED: "ISSUED", + + @doc("CertificateStatus enum PENDING_VALIDATION") + PENDING_VALIDATION: "PENDING_VALIDATION", + + @doc("CertificateStatus enum REVOKED") + REVOKED: "REVOKED", + + @doc("CertificateStatus enum VALIDATION_TIMED_OUT") + VALIDATION_TIMED_OUT: "VALIDATION_TIMED_OUT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CertificateStatusEnumValue") +model CertificateStatusEnumValue { + @doc("Property value") + value?: CertificateStatus; +} + +@doc("KeyAlgorithm enum") +union KeyAlgorithm { + @doc("KeyAlgorithm enum EC_prime256v1") + EC_prime256v1: "EC_prime256v1", + + @doc("KeyAlgorithm enum EC_secp384r1") + EC_secp384r1: "EC_secp384r1", + + @doc("KeyAlgorithm enum EC_secp521r1") + EC_secp521r1: "EC_secp521r1", + + @doc("KeyAlgorithm enum RSA_1024") + RSA_1024: "RSA_1024", + + @doc("KeyAlgorithm enum RSA_2048") + RSA_2048: "RSA_2048", + + @doc("KeyAlgorithm enum RSA_3072") + RSA_3072: "RSA_3072", + + @doc("KeyAlgorithm enum RSA_4096") + RSA_4096: "RSA_4096", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KeyAlgorithmEnumValue") +model KeyAlgorithmEnumValue { + @doc("Property value") + value?: KeyAlgorithm; +} + +@doc("CertificateType enum") +union CertificateType { + @doc("CertificateType enum AMAZON_ISSUED") + AMAZON_ISSUED: "AMAZON_ISSUED", + + @doc("CertificateType enum IMPORTED") + IMPORTED: "IMPORTED", + + @doc("CertificateType enum PRIVATE") + PRIVATE: "PRIVATE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CertificateTypeEnumValue") +model CertificateTypeEnumValue { + @doc("Property value") + value?: CertificateType; +} + +@doc("RenewalEligibility enum") +union RenewalEligibility { + @doc("RenewalEligibility enum ELIGIBLE") + ELIGIBLE: "ELIGIBLE", + + @doc("RenewalEligibility enum INELIGIBLE") + INELIGIBLE: "INELIGIBLE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RenewalEligibilityEnumValue") +model RenewalEligibilityEnumValue { + @doc("Property value") + value?: RenewalEligibility; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface AcmCertificateSummaries { + get is ArmResourceRead<AcmCertificateSummary>; + @doc("Create a AcmCertificateSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<AcmCertificateSummary>; + update is ArmCustomPatchAsync< + AcmCertificateSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<AcmCertificateSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<AcmCertificateSummary>; + listByResourceGroup is ArmResourceListByParent<AcmCertificateSummary>; + listBySubscription is ArmListBySubscription<AcmCertificateSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\acm\acm-2015-12-08.normal.json +// AWS Shape: CertificateSummary +// +// Related information for backend service: +// AWS Servcie : ACM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.300.83 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/AcmCertificateSummary.Management/tspconfig.yaml b/specification/awsconnector/AcmCertificateSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..d8e13fedf58c --- /dev/null +++ b/specification/awsconnector/AcmCertificateSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/acmCertificateSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_CreateOrReplace.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_CreateOrReplace.json new file mode 100644 index 000000000000..0c2029eef305 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_CreateOrReplace.json @@ -0,0 +1,214 @@ +{ + "title": "ApiGatewayRestApis_CreateOrReplace", + "operationId": "ApiGatewayRestApis_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + } + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Delete.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Delete.json new file mode 100644 index 000000000000..06f36879e989 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ApiGatewayRestApis_Delete", + "operationId": "ApiGatewayRestApis_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Get.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Get.json new file mode 100644 index 000000000000..5e9dc554036c --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Get.json @@ -0,0 +1,83 @@ +{ + "title": "ApiGatewayRestApis_Get", + "operationId": "ApiGatewayRestApis_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListByResourceGroup.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListByResourceGroup.json new file mode 100644 index 000000000000..09fda07831e9 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "title": "ApiGatewayRestApis_ListByResourceGroup", + "operationId": "ApiGatewayRestApis_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListBySubscription.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListBySubscription.json new file mode 100644 index 000000000000..6fe6baf45280 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_ListBySubscription.json @@ -0,0 +1,86 @@ +{ + "title": "ApiGatewayRestApis_ListBySubscription", + "operationId": "ApiGatewayRestApis_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Update.json b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Update.json new file mode 100644 index 000000000000..02507dfa7b4d --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/examples/2024-12-01/ApiGatewayRestApis_Update.json @@ -0,0 +1,93 @@ +{ + "title": "ApiGatewayRestApis_Update", + "operationId": "ApiGatewayRestApis_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2677": "xut" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/main.tsp b/specification/awsconnector/ApiGatewayRestApi.Management/main.tsp new file mode 100644 index 000000000000..f980f6ff7d63 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/main.tsp @@ -0,0 +1,195 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ApiGatewayRestApis ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Api Gateway Rest Api", + plural: "Api Gateway Rest Apis", + }, + keywords: ["Microsoft.AwsConnector", "Api", "Gateway", "Rest", "Api"], +}) +@doc("A Microsoft.AwsConnector resource") +model ApiGatewayRestApi is TrackedResource<ApiGatewayRestApiProperties> { + @doc("Name of ApiGatewayRestApi") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("apiGatewayRestApis") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ApiGatewayRestApi") +model ApiGatewayRestApiProperties { + @doc("AWS Properties") + awsProperties?: AwsApiGatewayRestApiProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsApiGatewayRestApi") +model AwsApiGatewayRestApiProperties { + @doc("The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer.") + apiKeySourceType?: string; + + @doc("The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.") + @extension("x-ms-identifiers", []) + binaryMediaTypes?: string[]; + + @doc("An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.") + body?: Record<unknown>; + + @doc("The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification.") + bodyS3Location?: S3Location; + + @doc("The ID of the RestApi that you want to clone from.") + cloneFrom?: string; + + @doc("The description of the RestApi.") + description?: string; + + @doc("Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint") + disableExecuteApiEndpoint?: boolean; + + @doc("A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.") + endpointConfiguration?: EndpointConfiguration; + + @doc("A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``.") + failOnWarnings?: boolean; + + @doc("A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.") + minimumCompressionSize?: int32; + + @doc("This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.") + mode?: string; + + @doc("The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.") + name?: string; + + @doc("Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.") + parameters?: Record<string>; + + @doc("A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``''`` as delimiter and values of ``'execute-api:/'`` and ``'*'``.") + policy?: string; + + @doc("Property restApiId") + restApiId?: string; + + @doc("Property rootResourceId") + rootResourceId?: string; + + @doc("The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3Location") +model S3Location { + @doc("The name of the S3 bucket where the OpenAPI file is stored.") + bucket?: string; + + @doc("The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.") + eTag?: string; + + @doc("The file name of the OpenAPI file (Amazon S3 object name).") + key?: string; + + @doc("For versioning-enabled buckets, a specific version of the OpenAPI file.") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EndpointConfiguration") +model EndpointConfiguration { + @doc("A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``'EDGE'``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``.") + @extension("x-ms-identifiers", []) + types?: string[]; + + @doc("A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.") + @extension("x-ms-identifiers", []) + vpcEndpointIds?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ApiGatewayRestApis { + get is ArmResourceRead<ApiGatewayRestApi>; + @doc("Create a ApiGatewayRestApi. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ApiGatewayRestApi>; + update is ArmCustomPatchAsync< + ApiGatewayRestApi, + Azure.ResourceManager.Foundations.TagsUpdateModel<ApiGatewayRestApi> + >; + delete is ArmResourceDeleteWithoutOkAsync<ApiGatewayRestApi>; + listByResourceGroup is ArmResourceListByParent<ApiGatewayRestApi>; + listBySubscription is ArmListBySubscription<ApiGatewayRestApi>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ApiGateway::RestApi +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ApiGatewayRestApi.Management/tspconfig.yaml b/specification/awsconnector/ApiGatewayRestApi.Management/tspconfig.yaml new file mode 100644 index 000000000000..478bbb594b88 --- /dev/null +++ b/specification/awsconnector/ApiGatewayRestApi.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/apiGatewayRestApi.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_CreateOrReplace.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_CreateOrReplace.json new file mode 100644 index 000000000000..a2db84b89df5 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "ApiGatewayStages_CreateOrReplace", + "operationId": "ApiGatewayStages_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + } + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Delete.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Delete.json new file mode 100644 index 000000000000..7083d9efbb91 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ApiGatewayStages_Delete", + "operationId": "ApiGatewayStages_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Get.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Get.json new file mode 100644 index 000000000000..a217d729e484 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Get.json @@ -0,0 +1,89 @@ +{ + "title": "ApiGatewayStages_Get", + "operationId": "ApiGatewayStages_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListByResourceGroup.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListByResourceGroup.json new file mode 100644 index 000000000000..a9d38201d101 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "ApiGatewayStages_ListByResourceGroup", + "operationId": "ApiGatewayStages_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListBySubscription.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListBySubscription.json new file mode 100644 index 000000000000..2f080c824549 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "ApiGatewayStages_ListBySubscription", + "operationId": "ApiGatewayStages_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Update.json b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Update.json new file mode 100644 index 000000000000..39b014205f8d --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/examples/2024-12-01/ApiGatewayStages_Update.json @@ -0,0 +1,99 @@ +{ + "title": "ApiGatewayStages_Update", + "operationId": "ApiGatewayStages_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key149": "wpmvxfqmbbskeejljljiimipwn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ApiGatewayStage.Management/main.tsp b/specification/awsconnector/ApiGatewayStage.Management/main.tsp new file mode 100644 index 000000000000..e4c9494fdf22 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/main.tsp @@ -0,0 +1,221 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ApiGatewayStages ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Api Gateway Stage", + plural: "Api Gateway Stages", + }, + keywords: ["Microsoft.AwsConnector", "Api", "Gateway", "Stage"], +}) +@doc("A Microsoft.AwsConnector resource") +model ApiGatewayStage is TrackedResource<ApiGatewayStageProperties> { + @doc("Name of ApiGatewayStage") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("apiGatewayStages") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ApiGatewayStage") +model ApiGatewayStageProperties { + @doc("AWS Properties") + awsProperties?: AwsApiGatewayStageProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsApiGatewayStage") +model AwsApiGatewayStageProperties { + @doc("Access log settings, including the access log format and access log destination ARN. The ``AccessLogSetting`` property type specifies settings for logging access in this stage. ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.") + accessLogSetting?: AccessLogSetting; + + @doc("Specifies whether a cache cluster is enabled for the stage.") + cacheClusterEnabled?: boolean; + + @doc("The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html).") + cacheClusterSize?: string; + + @doc("Settings for the canary deployment in this stage. Configuration settings of a canary deployment.") + canarySetting?: CanarySetting; + + @doc("The identifier of a client certificate for an API stage.") + clientCertificateId?: string; + + @doc("The identifier of the Deployment that the stage points to.") + deploymentId?: string; + + @doc("The stage's description.") + description?: string; + + @doc("The version of the associated API documentation.") + documentationVersion?: string; + + @doc("A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage.") + @extension("x-ms-identifiers", []) + methodSettings?: MethodSetting[]; + + @doc("The string identifier of the associated RestApi.") + restApiId?: string; + + @doc("The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.") + stageName?: string; + + @doc("The collection of tags. Each tag element is associated with a given resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Specifies whether active tracing with X-ray is enabled for the Stage.") + tracingEnabled?: boolean; + + @doc("A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.") + variables?: Record<string>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccessLogSetting") +model AccessLogSetting { + @doc("The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging.") + destinationArn?: string; + + @doc("A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging.") + format?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CanarySetting") +model CanarySetting { + @doc("The ID of the canary deployment.") + deploymentId?: string; + + @doc("The percent (0-100) of traffic diverted to a canary deployment.") + percentTraffic?: int32; + + @doc("Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.") + stageVariableOverrides?: Record<string>; + + @doc("A Boolean flag to indicate whether the canary deployment uses the stage cache or not.") + useStageCache?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MethodSetting") +model MethodSetting { + @doc("Specifies whether the cached responses are encrypted.") + cacheDataEncrypted?: boolean; + + @doc("Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.") + cacheTtlInSeconds?: int32; + + @doc("Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.") + cachingEnabled?: boolean; + + @doc("Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.") + dataTraceEnabled?: boolean; + + @doc("The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.") + httpMethod?: string; + + @doc("Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.") + loggingLevel?: string; + + @doc("Specifies whether Amazon CloudWatch metrics are enabled for this method.") + metricsEnabled?: boolean; + + @doc("The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``.") + resourcePath?: string; + + @doc("Specifies the throttling burst limit.") + throttlingBurstLimit?: int32; + + @doc("Specifies the throttling rate limit.") + throttlingRateLimit?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ApiGatewayStages { + get is ArmResourceRead<ApiGatewayStage>; + @doc("Create a ApiGatewayStage. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ApiGatewayStage>; + update is ArmCustomPatchAsync< + ApiGatewayStage, + Azure.ResourceManager.Foundations.TagsUpdateModel<ApiGatewayStage> + >; + delete is ArmResourceDeleteWithoutOkAsync<ApiGatewayStage>; + listByResourceGroup is ArmResourceListByParent<ApiGatewayStage>; + listBySubscription is ArmListBySubscription<ApiGatewayStage>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ApiGateway::Stage +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ApiGatewayStage.Management/tspconfig.yaml b/specification/awsconnector/ApiGatewayStage.Management/tspconfig.yaml new file mode 100644 index 000000000000..22f939224439 --- /dev/null +++ b/specification/awsconnector/ApiGatewayStage.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/apiGatewayStage.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_CreateOrReplace.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_CreateOrReplace.json new file mode 100644 index 000000000000..60e2d1689306 --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_CreateOrReplace.json @@ -0,0 +1,373 @@ +{ + "title": "AppSyncGraphqlApis_CreateOrReplace", + "operationId": "AppSyncGraphqlApis_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + } + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + } + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Delete.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Delete.json new file mode 100644 index 000000000000..c35a8f273b3a --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AppSyncGraphqlApis_Delete", + "operationId": "AppSyncGraphqlApis_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Get.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Get.json new file mode 100644 index 000000000000..c391e93ee2aa --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Get.json @@ -0,0 +1,136 @@ +{ + "title": "AppSyncGraphqlApis_Get", + "operationId": "AppSyncGraphqlApis_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + } + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListByResourceGroup.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListByResourceGroup.json new file mode 100644 index 000000000000..19b91a18ad71 --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListByResourceGroup.json @@ -0,0 +1,140 @@ +{ + "title": "AppSyncGraphqlApis_ListByResourceGroup", + "operationId": "AppSyncGraphqlApis_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListBySubscription.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListBySubscription.json new file mode 100644 index 000000000000..72f432ee7c42 --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_ListBySubscription.json @@ -0,0 +1,139 @@ +{ + "title": "AppSyncGraphqlApis_ListBySubscription", + "operationId": "AppSyncGraphqlApis_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Update.json b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Update.json new file mode 100644 index 000000000000..e3e757764418 --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/examples/2024-12-01/AppSyncGraphqlApis_Update.json @@ -0,0 +1,146 @@ +{ + "title": "AppSyncGraphqlApis_Update", + "operationId": "AppSyncGraphqlApis_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3768": "kvlymhymfpmbabwtapgkdngrmsbyd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/main.tsp b/specification/awsconnector/AppSyncGraphqlApi.Management/main.tsp new file mode 100644 index 000000000000..05ca261b565c --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/main.tsp @@ -0,0 +1,493 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- AppSyncGraphqlApis ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "App Sync Graphql Api", + plural: "App Sync Graphql Apis", + }, + keywords: ["Microsoft.AwsConnector", "App", "Sync", "Graphql", "Api"], +}) +@doc("A Microsoft.AwsConnector resource") +model AppSyncGraphqlApi is TrackedResource<AppSyncGraphqlApiProperties> { + @doc("Name of AppSyncGraphqlApi") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("appSyncGraphqlApis") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AppSyncGraphqlApi") +model AppSyncGraphqlApiProperties { + @doc("AWS Properties") + awsProperties?: AwsAppSyncGraphqlApiProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsAppSyncGraphqlApi") +model AwsAppSyncGraphqlApiProperties { + @doc("<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>") + @extension("x-ms-identifiers", []) + additionalAuthenticationProviders?: AdditionalAuthenticationProvider[]; + + @doc("<p>The API ID.</p>") + apiId?: string; + + @doc("<p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>") + apiType?: GraphQLApiTypeEnumValue; + + @doc("<p>The Amazon Resource Name (ARN).</p>") + arn?: string; + + @doc("<p>The authentication type.</p>") + authenticationType?: AuthenticationTypeEnumValue; + + @doc("<p>The DNS records for the API.</p>") + dns?: Record<string>; + + @doc("<p>The <code>enhancedMetricsConfig</code> object.</p>") + enhancedMetricsConfig?: EnhancedMetricsConfig; + + @doc("<p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>) introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.</p> <p>For more information about introspection, see <a href='https://graphql.org/learn/introspection/'>GraphQL introspection</a>.</p>") + introspectionConfig?: GraphQLApiIntrospectionConfigEnumValue; + + @doc("<p>Configuration for Lambda function authorization.</p>") + lambdaAuthorizerConfig?: LambdaAuthorizerConfig; + + @doc("<p>The Amazon CloudWatch Logs configuration.</p>") + logConfig?: LogConfig; + + @doc("<p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>") + mergedApiExecutionRoleArn?: string; + + @doc("<p>The API name.</p>") + name?: string; + + @doc("<p>The OpenID Connect configuration.</p>") + openIDConnectConfig?: OpenIDConnectConfig; + + @doc("<p>The account owner of the GraphQL API.</p>") + owner?: string; + + @doc("<p>The owner contact information for an API resource.</p> <p>This field accepts any string input with a length of 0 - 256 characters.</p>") + ownerContact?: string; + + @doc("<p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will produce a limit error if the operation falls out of bounds.</p> <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.</p>") + queryDepthLimit?: int32; + + @doc("<p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out of bounds.</p>") + resolverCountLimit?: int32; + + @doc("<p>The tags.</p>") + tags?: Record<string>; + + @doc("<p>The URIs.</p>") + uris?: Record<string>; + + @doc("<p>The Amazon Cognito user pool configuration.</p>") + userPoolConfig?: UserPoolConfig; + + @doc("<p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed once the API has been created.</p>") + visibility?: GraphQLApiVisibilityEnumValue; + + @doc("<p>The ARN of the WAF access control list (ACL) associated with this <code>GraphqlApi</code>, if one exists.</p>") + wafWebAclArn?: string; + + @doc("<p>A flag indicating whether to use X-Ray tracing for this <code>GraphqlApi</code>.</p>") + xrayEnabled?: boolean; +} + +@doc("GraphQLApiType enum") +union GraphQLApiType { + @doc("GraphQLApiType enum GRAPHQL") + GRAPHQL: "GRAPHQL", + + @doc("GraphQLApiType enum MERGED") + MERGED: "MERGED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GraphQLApiTypeEnumValue") +model GraphQLApiTypeEnumValue { + @doc("Property value") + value?: GraphQLApiType; +} + +@doc("GraphQLApiIntrospectionConfig enum") +union GraphQLApiIntrospectionConfig { + @doc("GraphQLApiIntrospectionConfig enum DISABLED") + DISABLED: "DISABLED", + + @doc("GraphQLApiIntrospectionConfig enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GraphQLApiIntrospectionConfigEnumValue") +model GraphQLApiIntrospectionConfigEnumValue { + @doc("Property value") + value?: GraphQLApiIntrospectionConfig; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AdditionalAuthenticationProvider") +model AdditionalAuthenticationProvider { + @doc("<p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>") + authenticationType?: AuthenticationTypeEnumValue; + + @doc("<p>Configuration for Lambda function authorization.</p>") + lambdaAuthorizerConfig?: LambdaAuthorizerConfig; + + @doc("<p>The OIDC configuration.</p>") + openIDConnectConfig?: OpenIDConnectConfig; + + @doc("<p>The Amazon Cognito user pool configuration.</p>") + userPoolConfig?: CognitoUserPoolConfig; +} + +@doc("AuthenticationType enum") +union AuthenticationType { + @doc("AuthenticationType enum AMAZON_COGNITO_USER_POOLS") + AMAZON_COGNITO_USER_POOLS: "AMAZON_COGNITO_USER_POOLS", + + @doc("AuthenticationType enum API_KEY") + API_KEY: "API_KEY", + + @doc("AuthenticationType enum AWS_IAM") + AWS_IAM: "AWS_IAM", + + @doc("AuthenticationType enum AWS_LAMBDA") + AWS_LAMBDA: "AWS_LAMBDA", + + @doc("AuthenticationType enum OPENID_CONNECT") + OPENID_CONNECT: "OPENID_CONNECT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthenticationTypeEnumValue") +model AuthenticationTypeEnumValue { + @doc("Property value") + value?: AuthenticationType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnhancedMetricsConfig") +model EnhancedMetricsConfig { + @doc("<p>Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:</p> <ul> <li> <p>Requests: The number of invocations that occured during a request.</p> </li> <li> <p>Latency: The time to complete a data source invocation.</p> </li> <li> <p>Errors: The number of errors that occurred during a data source invocation.</p> </li> </ul> <p>These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. <code>dataSourceLevelMetricsBehavior</code> accepts one of these values at a time:</p> <ul> <li> <p> <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric data for all data sources in the request.</p> </li> <li> <p> <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for data sources that have the <code>metricsConfig</code> value set to <code>ENABLED</code>.</p> </li> </ul>") + dataSourceLevelMetricsBehavior?: DataSourceLevelMetricsBehaviorEnumValue; + + @doc("<p> Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:</p> <ul> <li> <p>Requests: The number of times a specified GraphQL operation was called.</p> </li> <li> <p>GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.</p> </li> </ul> <p>Metrics will be recorded by API ID and operation name. You can set the value to <code>ENABLED</code> or <code>DISABLED</code>.</p>") + operationLevelMetricsConfig?: OperationLevelMetricsConfigEnumValue; + + @doc("<p>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:</p> <ul> <li> <p>GraphQL errors: The number of GraphQL errors that occurred.</p> </li> <li> <p>Requests: The number of invocations that occurred during a request. </p> </li> <li> <p>Latency: The time to complete a resolver invocation.</p> </li> <li> <p>Cache hits: The number of cache hits during a request.</p> </li> <li> <p>Cache misses: The number of cache misses during a request.</p> </li> </ul> <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. <code>resolverLevelMetricsBehavior</code> accepts one of these values at a time:</p> <ul> <li> <p> <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data for all resolvers in the request.</p> </li> <li> <p> <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for resolvers that have the <code>metricsConfig</code> value set to <code>ENABLED</code>.</p> </li> </ul>") + resolverLevelMetricsBehavior?: ResolverLevelMetricsBehaviorEnumValue; +} + +@doc("GraphQLApiVisibility enum") +union GraphQLApiVisibility { + @doc("GraphQLApiVisibility enum GLOBAL") + GLOBAL: "GLOBAL", + + @doc("GraphQLApiVisibility enum PRIVATE") + PRIVATE: "PRIVATE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GraphQLApiVisibilityEnumValue") +model GraphQLApiVisibilityEnumValue { + @doc("Property value") + value?: GraphQLApiVisibility; +} + +@doc("OperationLevelMetricsConfig enum") +union OperationLevelMetricsConfig { + @doc("OperationLevelMetricsConfig enum DISABLED") + DISABLED: "DISABLED", + + @doc("OperationLevelMetricsConfig enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OperationLevelMetricsConfigEnumValue") +model OperationLevelMetricsConfigEnumValue { + @doc("Property value") + value?: OperationLevelMetricsConfig; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LambdaAuthorizerConfig") +model LambdaAuthorizerConfig { + @doc("<p>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a <code>ttlOverride</code> key in its response.</p>") + authorizerResultTtlInSeconds?: int32; + + @doc("<p>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (<code>.../v3</code>), or an alias ARN. </p> <p> <b>Note</b>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:</p> <p> <code>aws lambda add-permission --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction</code> </p>") + authorizerUri?: string; + + @doc("<p>A regular expression for validation of tokens before the Lambda function is called.</p>") + identityValidationExpression?: string; +} + +@doc("DataSourceLevelMetricsBehavior enum") +union DataSourceLevelMetricsBehavior { + @doc("DataSourceLevelMetricsBehavior enum FULL_REQUEST_DATA_SOURCE_METRICS") + FULL_REQUEST_DATA_SOURCE_METRICS: "FULL_REQUEST_DATA_SOURCE_METRICS", + + @doc("DataSourceLevelMetricsBehavior enum PER_DATA_SOURCE_METRICS") + PER_DATA_SOURCE_METRICS: "PER_DATA_SOURCE_METRICS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DataSourceLevelMetricsBehaviorEnumValue") +model DataSourceLevelMetricsBehaviorEnumValue { + @doc("Property value") + value?: DataSourceLevelMetricsBehavior; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogConfig") +model LogConfig { + @doc("<p>The service role that AppSync assumes to publish to CloudWatch logs in your account.</p>") + cloudWatchLogsRoleArn?: string; + + @doc("<p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</p>") + excludeVerboseContent?: boolean; + + @doc("<p>The field logging level. Values can be NONE, ERROR, or ALL.</p> <ul> <li> <p> <b>NONE</b>: No field-level logs are captured.</p> </li> <li> <p> <b>ERROR</b>: Logs the following information only for the fields that are in error:</p> <ul> <li> <p>The error section in the server response.</p> </li> <li> <p>Field-level errors.</p> </li> <li> <p>The generated request/response functions that got resolved for error fields.</p> </li> </ul> </li> <li> <p> <b>ALL</b>: The following information is logged for all fields in the query:</p> <ul> <li> <p>Field-level tracing information.</p> </li> <li> <p>The generated request/response functions that got resolved for each field.</p> </li> </ul> </li> </ul>") + fieldLogLevel?: FieldLogLevelEnumValue; +} + +@doc("ResolverLevelMetricsBehavior enum") +union ResolverLevelMetricsBehavior { + @doc("ResolverLevelMetricsBehavior enum FULL_REQUEST_RESOLVER_METRICS") + FULL_REQUEST_RESOLVER_METRICS: "FULL_REQUEST_RESOLVER_METRICS", + + @doc("ResolverLevelMetricsBehavior enum PER_RESOLVER_METRICS") + PER_RESOLVER_METRICS: "PER_RESOLVER_METRICS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResolverLevelMetricsBehaviorEnumValue") +model ResolverLevelMetricsBehaviorEnumValue { + @doc("Property value") + value?: ResolverLevelMetricsBehavior; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OpenIDConnectConfig") +model OpenIDConnectConfig { + @doc("<p>The number of milliseconds that a token is valid after being authenticated.</p>") + authTTL?: int64; + + @doc("<p>The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.</p>") + clientId?: string; + + @doc("<p>The number of milliseconds that a token is valid after it's issued to a user.</p>") + iatTTL?: int64; + + @doc("<p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of <code>iss</code> in the ID token.</p>") + issuer?: string; +} + +@doc("FieldLogLevel enum") +union FieldLogLevel { + @doc("FieldLogLevel enum ALL") + ALL: "ALL", + + @doc("FieldLogLevel enum ERROR") + ERROR: "ERROR", + + @doc("FieldLogLevel enum NONE") + NONE: "NONE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FieldLogLevelEnumValue") +model FieldLogLevelEnumValue { + @doc("Property value") + value?: FieldLogLevel; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of UserPoolConfig") +model UserPoolConfig { + @doc("<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.</p>") + appIdClientRegex?: string; + + @doc("<p>The Amazon Web Services Region in which the user pool was created.</p>") + awsRegion?: string; + + @doc("<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.</p>") + defaultAction?: DefaultActionEnumValue; + + @doc("<p>The user pool ID.</p>") + userPoolId?: string; +} + +@doc("DefaultAction enum") +union DefaultAction { + @doc("DefaultAction enum ALLOW") + ALLOW: "ALLOW", + + @doc("DefaultAction enum DENY") + DENY: "DENY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DefaultActionEnumValue") +model DefaultActionEnumValue { + @doc("Property value") + value?: DefaultAction; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CognitoUserPoolConfig") +model CognitoUserPoolConfig { + @doc("<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.</p>") + appIdClientRegex?: string; + + @doc("<p>The Amazon Web Services Region in which the user pool was created.</p>") + awsRegion?: string; + + @doc("<p>The user pool ID.</p>") + userPoolId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface AppSyncGraphqlApis { + get is ArmResourceRead<AppSyncGraphqlApi>; + @doc("Create a AppSyncGraphqlApi. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<AppSyncGraphqlApi>; + update is ArmCustomPatchAsync< + AppSyncGraphqlApi, + Azure.ResourceManager.Foundations.TagsUpdateModel<AppSyncGraphqlApi> + >; + delete is ArmResourceDeleteWithoutOkAsync<AppSyncGraphqlApi>; + listByResourceGroup is ArmResourceListByParent<AppSyncGraphqlApi>; + listBySubscription is ArmListBySubscription<AppSyncGraphqlApi>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\appsync\appsync-2017-07-25.normal.json +// AWS Shape: GraphqlApi +// +// Related information for backend service: +// AWS Servcie : AppSync +// Product Version : 3.7.798.0 +// SDK Version : 3.7.305.1 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/AppSyncGraphqlApi.Management/tspconfig.yaml b/specification/awsconnector/AppSyncGraphqlApi.Management/tspconfig.yaml new file mode 100644 index 000000000000..113d64fcc83e --- /dev/null +++ b/specification/awsconnector/AppSyncGraphqlApi.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/appSyncGraphqlApi.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_CreateOrReplace.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_CreateOrReplace.json new file mode 100644 index 000000000000..f49b2fe94b4e --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_CreateOrReplace.json @@ -0,0 +1,634 @@ +{ + "title": "AutoScalingAutoScalingGroups_CreateOrReplace", + "operationId": "AutoScalingAutoScalingGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + } + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + } + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Delete.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Delete.json new file mode 100644 index 000000000000..fc1317166c5b --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AutoScalingAutoScalingGroups_Delete", + "operationId": "AutoScalingAutoScalingGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Get.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Get.json new file mode 100644 index 000000000000..824651aa6398 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Get.json @@ -0,0 +1,223 @@ +{ + "title": "AutoScalingAutoScalingGroups_Get", + "operationId": "AutoScalingAutoScalingGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + } + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListByResourceGroup.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..095eec3a2081 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListByResourceGroup.json @@ -0,0 +1,227 @@ +{ + "title": "AutoScalingAutoScalingGroups_ListByResourceGroup", + "operationId": "AutoScalingAutoScalingGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListBySubscription.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListBySubscription.json new file mode 100644 index 000000000000..94ea9340c6a5 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_ListBySubscription.json @@ -0,0 +1,226 @@ +{ + "title": "AutoScalingAutoScalingGroups_ListBySubscription", + "operationId": "AutoScalingAutoScalingGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Update.json b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Update.json new file mode 100644 index 000000000000..e42e89567703 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/examples/2024-12-01/AutoScalingAutoScalingGroups_Update.json @@ -0,0 +1,233 @@ +{ + "title": "AutoScalingAutoScalingGroups_Update", + "operationId": "AutoScalingAutoScalingGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9673": "yqeoapxnqtawdycgpvk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/main.tsp b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/main.tsp new file mode 100644 index 000000000000..975b9546fc53 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/main.tsp @@ -0,0 +1,578 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- AutoScalingAutoScalingGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Auto Scaling Auto Scaling Group", + plural: "Auto Scaling Auto Scaling Groups", + }, + keywords: [ + "Microsoft.AwsConnector", + "Auto", + "Scaling", + "Auto", + "Scaling", + "Group" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model AutoScalingAutoScalingGroup + is TrackedResource<AutoScalingAutoScalingGroupProperties> { + @doc("Name of AutoScalingAutoScalingGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("autoScalingAutoScalingGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AutoScalingAutoScalingGroup") +model AutoScalingAutoScalingGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsAutoScalingAutoScalingGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsAutoScalingAutoScalingGroup") +model AwsAutoScalingAutoScalingGroupProperties { + @doc("The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name.") + autoScalingGroupName?: string; + + @doc("A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.") + @extension("x-ms-identifiers", []) + availabilityZones?: string[]; + + @doc("Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.") + capacityRebalance?: boolean; + + @doc("Reserved.") + context?: string; + + @doc("*Only needed if you use simple scaling policies.* The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds") + cooldown?: string; + + @doc("The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None") + defaultInstanceWarmup?: int32; + + @doc("The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.") + desiredCapacity?: string; + + @doc("The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib``") + desiredCapacityType?: string; + + @doc("The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``0`` seconds") + healthCheckGracePeriod?: int32; + + @doc("A comma-separated value string of one or more health check types. The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set.") + healthCheckType?: string; + + @doc("The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``.") + instanceId?: string; + + @doc("An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*.") + instanceMaintenancePolicy?: InstanceMaintenancePolicy; + + @doc("The name of the launch configuration to use to launch instances. Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``.") + launchConfigurationName?: string; + + @doc("Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource.") + launchTemplate?: LaunchTemplateSpecification; + + @doc("One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.") + @extension("x-ms-identifiers", []) + lifecycleHookSpecificationList?: LifecycleHookSpecification[]; + + @doc("A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.") + @extension("x-ms-identifiers", []) + loadBalancerNames?: string[]; + + @doc("The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*.") + maxInstanceLifetime?: int32; + + @doc("The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).") + maxSize?: string; + + @doc("Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.") + @extension("x-ms-identifiers", []) + metricsCollection?: MetricsCollection[]; + + @doc("The minimum size of the group.") + minSize?: string; + + @doc("An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. There are key differences between Spot Instances and On-Demand Instances: + The price for Spot Instances varies based on demand + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource.") + mixedInstancesPolicy?: MixedInstancesPolicy; + + @doc("Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*.") + newInstancesProtectedFromScaleIn?: boolean; + + @doc("A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*.") + notificationConfiguration?: NotificationConfiguration; + + @doc("Configures an Auto Scaling group to send notifications when specified events take place.") + @extension("x-ms-identifiers", []) + notificationConfigurations?: NotificationConfiguration[]; + + @doc("The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.") + placementGroup?: string; + + @doc("The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*.") + serviceLinkedRoleARN?: string; + + @doc("One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.") + @extension("x-ms-identifiers", []) + tags?: TagProperty[]; + + @doc("The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.") + @extension("x-ms-identifiers", []) + targetGroupARNs?: string[]; + + @doc("A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``") + @extension("x-ms-identifiers", []) + terminationPolicies?: string[]; + + @doc("A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.") + @extension("x-ms-identifiers", []) + vpcZoneIdentifier?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMaintenancePolicy") +model InstanceMaintenancePolicy { + @doc("Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time.") + maxHealthyPercentage?: int32; + + @doc("Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``.") + minHealthyPercentage?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LaunchTemplateSpecification") +model LaunchTemplateSpecification { + @doc("The ID of the launch template. You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both.") + launchTemplateId?: string; + + @doc("The name of the launch template. You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both.") + launchTemplateName?: string; + + @doc("The version number of the launch template. Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource.") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LifecycleHookSpecification") +model LifecycleHookSpecification { + @doc("The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. Valid values: ``CONTINUE`` | ``ABANDON``") + defaultResult?: string; + + @doc("The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour).") + heartbeatTimeout?: int32; + + @doc("The name of the lifecycle hook.") + lifecycleHookName?: string; + + @doc("The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``.") + lifecycleTransition?: string; + + @doc("Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.") + notificationMetadata?: string; + + @doc("The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.") + notificationTargetARN?: string; + + @doc("The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.") + roleARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MetricsCollection") +model MetricsCollection { + @doc("The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``.") + granularity?: string; + + @doc("Identifies the metrics to enable. You can specify one or more of the following metrics: + ``GroupMinSize`` + ``GroupMaxSize`` + ``GroupDesiredCapacity`` + ``GroupInServiceInstances`` + ``GroupPendingInstances`` + ``GroupStandbyInstances`` + ``GroupTerminatingInstances`` + ``GroupTotalInstances`` + ``GroupInServiceCapacity`` + ``GroupPendingCapacity`` + ``GroupStandbyCapacity`` + ``GroupTerminatingCapacity`` + ``GroupTotalCapacity`` + ``WarmPoolDesiredCapacity`` + ``WarmPoolWarmedCapacity`` + ``WarmPoolPendingCapacity`` + ``WarmPoolTerminatingCapacity`` + ``WarmPoolTotalCapacity`` + ``GroupAndWarmPoolDesiredCapacity`` + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*.") + @extension("x-ms-identifiers", []) + metrics?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MixedInstancesPolicy") +model MixedInstancesPolicy { + @doc("The instances distribution. Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.") + instancesDistribution?: InstancesDistribution; + + @doc("One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type.") + launchTemplate?: LaunchTemplate; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NotificationConfiguration") +model NotificationConfiguration { + @doc("A list of event types that send a notification. Event types can include any of the following types. *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + ``autoscaling:TEST_NOTIFICATION``") + @extension("x-ms-identifiers", []) + notificationTypes?: string[]; + + @doc("The Amazon Resource Name (ARN) of the Amazon SNS topic.") + topicARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TagProperty") +model TagProperty { + @doc("The tag key.") + key?: string; + + @doc("Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group.") + propagateAtLaunch?: boolean; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstancesDistribution") +model InstancesDistribution { + @doc("The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.") + onDemandAllocationStrategy?: string; + + @doc("The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. Default: 0 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.") + onDemandBaseCapacity?: int32; + + @doc("Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. Default: 100 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.") + onDemandPercentageAboveBaseCapacity?: int32; + + @doc("The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.") + spotAllocationStrategy?: string; + + @doc("The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. Default: 2") + spotInstancePools?: int32; + + @doc("The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ('') for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001") + spotMaxPrice?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LaunchTemplate") +model LaunchTemplate { + @doc("The launch template. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource.") + launchTemplateSpecification?: LaunchTemplateSpecification; + + @doc("Any properties that you specify override the same properties in the launch template.") + @extension("x-ms-identifiers", []) + overrides?: LaunchTemplateOverrides[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LaunchTemplateOverrides") +model LaunchTemplateOverrides { + @doc("The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type.") + instanceRequirements?: InstanceRequirements; + + @doc("The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. You can specify up to 40 instance types per Auto Scaling group.") + instanceType?: string; + + @doc("Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource.") + launchTemplateSpecification?: LaunchTemplateSpecification; + + @doc("If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.") + weightedCapacity?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceRequirements") +model InstanceRequirements { + @doc("The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type.") + acceleratorCount?: AcceleratorCountRequest; + + @doc("Indicates whether instance types must have accelerators by specific manufacturers. + For instance types with NVIDIA devices, specify ``nvidia``. + For instance types with AMD devices, specify ``amd``. + For instance types with AWS devices, specify ``amazon-web-services``. + For instance types with Xilinx devices, specify ``xilinx``. Default: Any manufacturer") + @extension("x-ms-identifiers", []) + acceleratorManufacturers?: string[]; + + @doc("Lists the accelerators that must be on an instance type. + For instance types with NVIDIA A100 GPUs, specify ``a100``. + For instance types with NVIDIA V100 GPUs, specify ``v100``. + For instance types with NVIDIA K80 GPUs, specify ``k80``. + For instance types with NVIDIA T4 GPUs, specify ``t4``. + For instance types with NVIDIA M60 GPUs, specify ``m60``. + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. Default: Any accelerator") + @extension("x-ms-identifiers", []) + acceleratorNames?: string[]; + + @doc("The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB.") + acceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRequest; + + @doc("Lists the accelerator types that must be on an instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type") + @extension("x-ms-identifiers", []) + acceleratorTypes?: string[]; + + @doc("The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. Default: All instance types") + @extension("x-ms-identifiers", []) + allowedInstanceTypes?: string[]; + + @doc("Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded``") + bareMetal?: string; + + @doc("The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: No minimum or maximum limits ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps.") + baselineEbsBandwidthMbps?: BaselineEbsBandwidthMbpsRequest; + + @doc("Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``excluded``") + burstablePerformance?: string; + + @doc("Lists which specific CPU manufacturers to include. + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer") + @extension("x-ms-identifiers", []) + cpuManufacturers?: string[]; + + @doc("The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. Default: No excluded instance types") + @extension("x-ms-identifiers", []) + excludedInstanceTypes?: string[]; + + @doc("Indicates whether current or previous generation instance types are included. + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + For previous generation instance types, specify ``previous``. Default: Any current or previous generation") + @extension("x-ms-identifiers", []) + instanceGenerations?: string[]; + + @doc("Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``included``") + localStorage?: string; + + @doc("Indicates the type of local storage that is required. + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + For instance types with solid state drive (SSD) storage, specify ``ssd``. Default: Any local storage type") + @extension("x-ms-identifiers", []) + localStorageTypes?: string[]; + + @doc("[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``.") + maxSpotPriceAsPercentageOfOptimalOnDemandPrice?: int32; + + @doc("The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB.") + memoryGiBPerVCpu?: MemoryGiBPerVCpuRequest; + + @doc("The minimum and maximum instance memory size for an instance type, in MiB. ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB.") + memoryMiB?: MemoryMiBRequest; + + @doc("The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*.") + networkBandwidthGbps?: NetworkBandwidthGbpsRequest; + + @doc("The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type.") + networkInterfaceCount?: NetworkInterfaceCountRequest; + + @doc("[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default: ``20``") + onDemandMaxPricePercentageOverLowestPrice?: int32; + + @doc("Indicates whether instance types must provide On-Demand Instance hibernation support. Default: ``false``") + requireHibernateSupport?: boolean; + + @doc("[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. Default: ``100``") + spotMaxPricePercentageOverLowestPrice?: int32; + + @doc("The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB.") + totalLocalStorageGB?: TotalLocalStorageGBRequest; + + @doc("The minimum and maximum number of vCPUs for an instance type. ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type.") + vCpuCount?: VCpuCountRequest; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AcceleratorCountRequest") +model AcceleratorCountRequest { + @doc("The maximum value.") + max?: int32; + + @doc("The minimum value.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AcceleratorTotalMemoryMiBRequest") +model AcceleratorTotalMemoryMiBRequest { + @doc("The memory maximum in MiB.") + max?: int32; + + @doc("The memory minimum in MiB.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BaselineEbsBandwidthMbpsRequest") +model BaselineEbsBandwidthMbpsRequest { + @doc("The maximum value in Mbps.") + max?: int32; + + @doc("The minimum value in Mbps.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MemoryGiBPerVCpuRequest") +model MemoryGiBPerVCpuRequest { + @doc("The memory maximum in GiB.") + max?: int32; + + @doc("The memory minimum in GiB.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MemoryMiBRequest") +model MemoryMiBRequest { + @doc("The memory maximum in MiB.") + max?: int32; + + @doc("The memory minimum in MiB.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkBandwidthGbpsRequest") +model NetworkBandwidthGbpsRequest { + @doc("The maximum amount of network bandwidth, in gigabits per second (Gbps).") + max?: int32; + + @doc("The minimum amount of network bandwidth, in gigabits per second (Gbps).") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkInterfaceCountRequest") +model NetworkInterfaceCountRequest { + @doc("The maximum number of network interfaces.") + max?: int32; + + @doc("The minimum number of network interfaces.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TotalLocalStorageGBRequest") +model TotalLocalStorageGBRequest { + @doc("The storage maximum in GB.") + max?: int32; + + @doc("The storage minimum in GB.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VCpuCountRequest") +model VCpuCountRequest { + @doc("The maximum number of vCPUs.") + max?: int32; + + @doc("The minimum number of vCPUs.") + min?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface AutoScalingAutoScalingGroups { + get is ArmResourceRead<AutoScalingAutoScalingGroup>; + @doc("Create a AutoScalingAutoScalingGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<AutoScalingAutoScalingGroup>; + update is ArmCustomPatchAsync< + AutoScalingAutoScalingGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<AutoScalingAutoScalingGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<AutoScalingAutoScalingGroup>; + listByResourceGroup is ArmResourceListByParent<AutoScalingAutoScalingGroup>; + listBySubscription is ArmListBySubscription<AutoScalingAutoScalingGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::AutoScaling::AutoScalingGroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/AutoScalingAutoScalingGroup.Management/tspconfig.yaml b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..4f8f46357146 --- /dev/null +++ b/specification/awsconnector/AutoScalingAutoScalingGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/autoScalingAutoScalingGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Awsconnector.Management/examples/2024-12-01/Operations_List.json b/specification/awsconnector/Awsconnector.Management/examples/2024-12-01/Operations_List.json new file mode 100644 index 000000000000..e60a5541785e --- /dev/null +++ b/specification/awsconnector/Awsconnector.Management/examples/2024-12-01/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpwxgidstbncuictrf", + "isDataAction": true, + "display": { + "provider": "scgogcdp", + "resource": "uamuwbdfznlancdbyxn", + "operation": "rwlqmshjawphrvtzxrkxczvmglbt", + "description": "zd" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Awsconnector.Management/main.tsp b/specification/awsconnector/Awsconnector.Management/main.tsp new file mode 100644 index 000000000000..6228ba1e599b --- /dev/null +++ b/specification/awsconnector/Awsconnector.Management/main.tsp @@ -0,0 +1,33 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; + +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/awsconnector/Awsconnector.Management/tspconfig.yaml b/specification/awsconnector/Awsconnector.Management/tspconfig.yaml new file mode 100644 index 000000000000..ba3574a6ea76 --- /dev/null +++ b/specification/awsconnector/Awsconnector.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/operations.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_CreateOrReplace.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_CreateOrReplace.json new file mode 100644 index 000000000000..7851f7de800c --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_CreateOrReplace.json @@ -0,0 +1,217 @@ +{ + "title": "CloudFormationStacks_CreateOrReplace", + "operationId": "CloudFormationStacks_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + } + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Delete.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Delete.json new file mode 100644 index 000000000000..2d1774c12cbc --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFormationStacks_Delete", + "operationId": "CloudFormationStacks_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Get.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Get.json new file mode 100644 index 000000000000..5405fff719f3 --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Get.json @@ -0,0 +1,84 @@ +{ + "title": "CloudFormationStacks_Get", + "operationId": "CloudFormationStacks_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListByResourceGroup.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListByResourceGroup.json new file mode 100644 index 000000000000..d4d45a07999d --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListByResourceGroup.json @@ -0,0 +1,88 @@ +{ + "title": "CloudFormationStacks_ListByResourceGroup", + "operationId": "CloudFormationStacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListBySubscription.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListBySubscription.json new file mode 100644 index 000000000000..74c0716d8801 --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_ListBySubscription.json @@ -0,0 +1,87 @@ +{ + "title": "CloudFormationStacks_ListBySubscription", + "operationId": "CloudFormationStacks_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Update.json b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Update.json new file mode 100644 index 000000000000..9b37437fcc05 --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/examples/2024-12-01/CloudFormationStacks_Update.json @@ -0,0 +1,94 @@ +{ + "title": "CloudFormationStacks_Update", + "operationId": "CloudFormationStacks_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4726": "kdjkjuleajxhzwpjfvyivjrislx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStack.Management/main.tsp b/specification/awsconnector/CloudFormationStack.Management/main.tsp new file mode 100644 index 000000000000..dfff9ff8f8f9 --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/main.tsp @@ -0,0 +1,288 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CloudFormationStacks ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Cloud Formation Stack", + plural: "Cloud Formation Stacks", + }, + keywords: ["Microsoft.AwsConnector", "Cloud", "Formation", "Stack"], +}) +@doc("A Microsoft.AwsConnector resource") +model CloudFormationStack is TrackedResource<CloudFormationStackProperties> { + @doc("Name of CloudFormationStack") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("cloudFormationStacks") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudFormationStack") +model CloudFormationStackProperties { + @doc("AWS Properties") + awsProperties?: AwsCloudFormationStackProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCloudFormationStack") +model AwsCloudFormationStackProperties { + @doc("Property capabilities") + @extension("x-ms-identifiers", []) + capabilities?: Capabilities[]; + + @doc("Property changeSetId") + changeSetId?: string; + + @doc("Property creationTime") + creationTime?: string; + + @doc("Property description") + description?: string; + + @doc("Property disableRollback") + disableRollback?: boolean; + + @doc("Property enableTerminationProtection") + enableTerminationProtection?: boolean; + + @doc("Property lastUpdateTime") + lastUpdateTime?: string; + + @doc("Property notificationARNs") + @extension("x-ms-identifiers", []) + notificationARNs?: string[]; + + @doc("Property outputs") + @extension("x-ms-identifiers", []) + outputs?: Output[]; + + @doc("Property parameters") + parameters?: Record<string>; + + @doc("Property parentId") + parentId?: string; + + @doc("Property roleARN") + roleARN?: string; + + @doc("Property rootId") + rootId?: string; + + @doc("Property stackId") + stackId?: string; + + @doc("Property stackName") + stackName?: string; + + @doc("Property stackPolicyBody") + stackPolicyBody?: unknown; + + @doc("Property stackPolicyURL") + stackPolicyURL?: string; + + @doc("Property stackStatus") + stackStatus?: StackStatus; + + @doc("Property stackStatusReason") + stackStatusReason?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property templateBody") + templateBody?: unknown; + + @doc("Property templateURL") + templateURL?: string; + + @doc("Property timeoutInMinutes") + timeoutInMinutes?: int32; +} + +@doc("Capabilities enum") +union Capabilities { + @doc("Capabilities enum CAPABILITY_AUTO_EXPAND") + CAPABILITY_AUTO_EXPAND: "CAPABILITY_AUTO_EXPAND", + + @doc("Capabilities enum CAPABILITY_IAM") + CAPABILITY_IAM: "CAPABILITY_IAM", + + @doc("Capabilities enum CAPABILITY_NAMED_IAM") + CAPABILITY_NAMED_IAM: "CAPABILITY_NAMED_IAM", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Output") +model Output { + @doc("Property description") + description?: string; + + @doc("Property exportName") + exportName?: string; + + @doc("Property outputKey") + outputKey?: string; + + @doc("Property outputValue") + outputValue?: string; +} + +@doc("StackStatus enum") +union StackStatus { + @doc("StackStatus enum CREATE_COMPLETE") + CREATE_COMPLETE: "CREATE_COMPLETE", + + @doc("StackStatus enum CREATE_FAILED") + CREATE_FAILED: "CREATE_FAILED", + + @doc("StackStatus enum CREATE_IN_PROGRESS") + CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS", + + @doc("StackStatus enum DELETE_COMPLETE") + DELETE_COMPLETE: "DELETE_COMPLETE", + + @doc("StackStatus enum DELETE_FAILED") + DELETE_FAILED: "DELETE_FAILED", + + @doc("StackStatus enum DELETE_IN_PROGRESS") + DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS", + + @doc("StackStatus enum IMPORT_COMPLETE") + IMPORT_COMPLETE: "IMPORT_COMPLETE", + + @doc("StackStatus enum IMPORT_IN_PROGRESS") + IMPORT_IN_PROGRESS: "IMPORT_IN_PROGRESS", + + @doc("StackStatus enum IMPORT_ROLLBACK_COMPLETE") + IMPORT_ROLLBACK_COMPLETE: "IMPORT_ROLLBACK_COMPLETE", + + @doc("StackStatus enum IMPORT_ROLLBACK_FAILED") + IMPORT_ROLLBACK_FAILED: "IMPORT_ROLLBACK_FAILED", + + @doc("StackStatus enum IMPORT_ROLLBACK_IN_PROGRESS") + IMPORT_ROLLBACK_IN_PROGRESS: "IMPORT_ROLLBACK_IN_PROGRESS", + + @doc("StackStatus enum REVIEW_IN_PROGRESS") + REVIEW_IN_PROGRESS: "REVIEW_IN_PROGRESS", + + @doc("StackStatus enum ROLLBACK_COMPLETE") + ROLLBACK_COMPLETE: "ROLLBACK_COMPLETE", + + @doc("StackStatus enum ROLLBACK_FAILED") + ROLLBACK_FAILED: "ROLLBACK_FAILED", + + @doc("StackStatus enum ROLLBACK_IN_PROGRESS") + ROLLBACK_IN_PROGRESS: "ROLLBACK_IN_PROGRESS", + + @doc("StackStatus enum UPDATE_COMPLETE") + UPDATE_COMPLETE: "UPDATE_COMPLETE", + + @doc("StackStatus enum UPDATE_COMPLETE_CLEANUP_IN_PROGRESS") + UPDATE_COMPLETE_CLEANUP_IN_PROGRESS: "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + + @doc("StackStatus enum UPDATE_FAILED") + UPDATE_FAILED: "UPDATE_FAILED", + + @doc("StackStatus enum UPDATE_IN_PROGRESS") + UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS", + + @doc("StackStatus enum UPDATE_ROLLBACK_COMPLETE") + UPDATE_ROLLBACK_COMPLETE: "UPDATE_ROLLBACK_COMPLETE", + + @doc("StackStatus enum UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS") + UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS: "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + + @doc("StackStatus enum UPDATE_ROLLBACK_FAILED") + UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED", + + @doc("StackStatus enum UPDATE_ROLLBACK_IN_PROGRESS") + UPDATE_ROLLBACK_IN_PROGRESS: "UPDATE_ROLLBACK_IN_PROGRESS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CloudFormationStacks { + get is ArmResourceRead<CloudFormationStack>; + @doc("Create a CloudFormationStack. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CloudFormationStack>; + update is ArmCustomPatchAsync< + CloudFormationStack, + Azure.ResourceManager.Foundations.TagsUpdateModel<CloudFormationStack> + >; + delete is ArmResourceDeleteWithoutOkAsync<CloudFormationStack>; + listByResourceGroup is ArmResourceListByParent<CloudFormationStack>; + listBySubscription is ArmListBySubscription<CloudFormationStack>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::CloudFormation::Stack +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CloudFormationStack.Management/tspconfig.yaml b/specification/awsconnector/CloudFormationStack.Management/tspconfig.yaml new file mode 100644 index 000000000000..e180ec168d55 --- /dev/null +++ b/specification/awsconnector/CloudFormationStack.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/cloudFormationStack.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_CreateOrReplace.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_CreateOrReplace.json new file mode 100644 index 000000000000..56224e7b0853 --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_CreateOrReplace.json @@ -0,0 +1,292 @@ +{ + "title": "CloudFormationStackSets_CreateOrReplace", + "operationId": "CloudFormationStackSets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + } + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Delete.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Delete.json new file mode 100644 index 000000000000..bbea0ff2cece --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFormationStackSets_Delete", + "operationId": "CloudFormationStackSets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Get.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Get.json new file mode 100644 index 000000000000..fb999cf12e13 --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Get.json @@ -0,0 +1,109 @@ +{ + "title": "CloudFormationStackSets_Get", + "operationId": "CloudFormationStackSets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListByResourceGroup.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListByResourceGroup.json new file mode 100644 index 000000000000..89263cf199be --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListByResourceGroup.json @@ -0,0 +1,113 @@ +{ + "title": "CloudFormationStackSets_ListByResourceGroup", + "operationId": "CloudFormationStackSets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListBySubscription.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListBySubscription.json new file mode 100644 index 000000000000..66afeecb8dec --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_ListBySubscription.json @@ -0,0 +1,112 @@ +{ + "title": "CloudFormationStackSets_ListBySubscription", + "operationId": "CloudFormationStackSets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Update.json b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Update.json new file mode 100644 index 000000000000..224bc75fcca0 --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/examples/2024-12-01/CloudFormationStackSets_Update.json @@ -0,0 +1,119 @@ +{ + "title": "CloudFormationStackSets_Update", + "operationId": "CloudFormationStackSets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6480": "nmdqcvijhytk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CloudFormationStackSet.Management/main.tsp b/specification/awsconnector/CloudFormationStackSet.Management/main.tsp new file mode 100644 index 000000000000..ed0b0105f1fd --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/main.tsp @@ -0,0 +1,313 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CloudFormationStackSets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Cloud Formation Stack Set", + plural: "Cloud Formation Stack Sets", + }, + keywords: ["Microsoft.AwsConnector", "Cloud", "Formation", "Stack", "Set"], +}) +@doc("A Microsoft.AwsConnector resource") +model CloudFormationStackSet + is TrackedResource<CloudFormationStackSetProperties> { + @doc("Name of CloudFormationStackSet") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("cloudFormationStackSets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudFormationStackSet") +model CloudFormationStackSetProperties { + @doc("AWS Properties") + awsProperties?: AwsCloudFormationStackSetProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCloudFormationStackSet") +model AwsCloudFormationStackSetProperties { + @doc("The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.") + administrationRoleARN?: string; + + @doc("Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.") + autoDeployment?: AutoDeployment; + + @doc("Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.") + callAs?: CallAs; + + @doc("In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.") + @extension("x-ms-identifiers", []) + capabilities?: string[]; + + @doc("A description of the stack set. You can use the description to identify the stack set's purpose or other important information.") + description?: string; + + @doc("The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.") + executionRoleName?: string; + + @doc("Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.") + managedExecution?: ActiveModel; + + @doc("The user-specified preferences for how AWS CloudFormation performs a stack set operation.") + operationPreferences?: OperationPreferences; + + @doc("The input parameters for the stack set template.") + @extension("x-ms-identifiers", []) + parameters?: Parameter[]; + + @doc("Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.") + permissionModel?: PermissionModel; + + @doc("A group of stack instances with parameters in some specific accounts and regions.") + @extension("x-ms-identifiers", []) + stackInstancesGroup?: StackInstances[]; + + @doc("The ID of the stack set that you're creating.") + stackSetId?: string; + + @doc("The name to associate with the stack set. The name must be unique in the Region where you create your stack set.") + stackSetName?: string; + + @doc("The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.") + templateBody?: string; + + @doc("Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.") + templateURL?: string; +} + +@doc("CallAs enum") +union CallAs { + @doc("CallAs enum DELEGATED_ADMIN") + DELEGATED_ADMIN: "DELEGATED_ADMIN", + + @doc("CallAs enum SELF") + SELF: "SELF", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AutoDeployment") +model AutoDeployment { + @doc("If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.") + enabled?: boolean; + + @doc("If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.") + retainStacksOnAccountRemoval?: boolean; +} + +@doc("PermissionModel enum") +union PermissionModel { + @doc("PermissionModel enum SELF_MANAGED") + SELF_MANAGED: "SELF_MANAGED", + + @doc("PermissionModel enum SERVICE_MANAGED") + SERVICE_MANAGED: "SERVICE_MANAGED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Active") +model ActiveModel { + @doc("When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.") + @clientName("activecsharp", "csharp") + active?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OperationPreferences") +model OperationPreferences { + @doc("Property failureToleranceCount") + failureToleranceCount?: int32; + + @doc("Property failureTolerancePercentage") + failureTolerancePercentage?: int32; + + @doc("Property maxConcurrentCount") + maxConcurrentCount?: int32; + + @doc("Property maxConcurrentPercentage") + maxConcurrentPercentage?: int32; + + @doc("The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time") + regionConcurrencyType?: OperationPreferencesRegionConcurrencyType; + + @doc("Property regionOrder") + @extension("x-ms-identifiers", []) + regionOrder?: string[]; +} + +@doc("OperationPreferencesRegionConcurrencyType enum") +union OperationPreferencesRegionConcurrencyType { + @doc("OperationPreferencesRegionConcurrencyType enum PARALLEL") + PARALLEL: "PARALLEL", + + @doc("OperationPreferencesRegionConcurrencyType enum SEQUENTIAL") + SEQUENTIAL: "SEQUENTIAL", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Parameter") +model Parameter { + @doc("The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.") + parameterKey?: string; + + @doc("The input value associated with the parameter.") + parameterValue?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StackInstances") +model StackInstances { + @doc("The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.") + deploymentTargets?: DeploymentTargets; + + @doc("A list of stack set parameters whose values you want to override in the selected stack instances.") + @extension("x-ms-identifiers", []) + parameterOverrides?: Parameter[]; + + @doc("The names of one or more Regions where you want to create stack instances using the specified AWS account(s).") + @extension("x-ms-identifiers", []) + regions?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("A string used to identify this tag. You can specify a maximum of 127 characters for a tag key.") + key?: string; + + @doc("A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentTargets") +model DeploymentTargets { + @doc("The filter type you want to apply on organizational units and accounts.") + accountFilterType?: DeploymentTargetsAccountFilterType; + + @doc("AWS accounts that you want to create stack instances in the specified Region(s) for.") + @extension("x-ms-identifiers", []) + accounts?: string[]; + + @doc("Returns the value of the AccountsUrl property.") + accountsUrl?: string; + + @doc("The organization root ID or organizational unit (OU) IDs to which StackSets deploys.") + @extension("x-ms-identifiers", []) + organizationalUnitIds?: string[]; +} + +@doc("DeploymentTargetsAccountFilterType enum") +union DeploymentTargetsAccountFilterType { + @doc("DeploymentTargetsAccountFilterType enum DIFFERENCE") + DIFFERENCE: "DIFFERENCE", + + @doc("DeploymentTargetsAccountFilterType enum INTERSECTION") + INTERSECTION: "INTERSECTION", + + @doc("DeploymentTargetsAccountFilterType enum NONE") + NONE: "NONE", + + @doc("DeploymentTargetsAccountFilterType enum UNION") + UNION: "UNION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CloudFormationStackSets { + get is ArmResourceRead<CloudFormationStackSet>; + @doc("Create a CloudFormationStackSet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CloudFormationStackSet>; + update is ArmCustomPatchAsync< + CloudFormationStackSet, + Azure.ResourceManager.Foundations.TagsUpdateModel<CloudFormationStackSet> + >; + delete is ArmResourceDeleteWithoutOkAsync<CloudFormationStackSet>; + listByResourceGroup is ArmResourceListByParent<CloudFormationStackSet>; + listBySubscription is ArmListBySubscription<CloudFormationStackSet>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::CloudFormation::StackSet +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CloudFormationStackSet.Management/tspconfig.yaml b/specification/awsconnector/CloudFormationStackSet.Management/tspconfig.yaml new file mode 100644 index 000000000000..5a72fbfc7654 --- /dev/null +++ b/specification/awsconnector/CloudFormationStackSet.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/cloudFormationStackSet.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_CreateOrReplace.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_CreateOrReplace.json new file mode 100644 index 000000000000..5f9804aad87b --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_CreateOrReplace.json @@ -0,0 +1,802 @@ +{ + "title": "CloudFrontDistributions_CreateOrReplace", + "operationId": "CloudFrontDistributions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + } + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Delete.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Delete.json new file mode 100644 index 000000000000..67f1f455ec47 --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFrontDistributions_Delete", + "operationId": "CloudFrontDistributions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Get.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Get.json new file mode 100644 index 000000000000..a9266f72fdd9 --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Get.json @@ -0,0 +1,279 @@ +{ + "title": "CloudFrontDistributions_Get", + "operationId": "CloudFrontDistributions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListByResourceGroup.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListByResourceGroup.json new file mode 100644 index 000000000000..9e483267b6ed --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListByResourceGroup.json @@ -0,0 +1,283 @@ +{ + "title": "CloudFrontDistributions_ListByResourceGroup", + "operationId": "CloudFrontDistributions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListBySubscription.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListBySubscription.json new file mode 100644 index 000000000000..6e10e9577396 --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_ListBySubscription.json @@ -0,0 +1,282 @@ +{ + "title": "CloudFrontDistributions_ListBySubscription", + "operationId": "CloudFrontDistributions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Update.json b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Update.json new file mode 100644 index 000000000000..7645351c4329 --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/examples/2024-12-01/CloudFrontDistributions_Update.json @@ -0,0 +1,289 @@ +{ + "title": "CloudFrontDistributions_Update", + "operationId": "CloudFrontDistributions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3727": "xzqjsgia" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CloudFrontDistribution.Management/main.tsp b/specification/awsconnector/CloudFrontDistribution.Management/main.tsp new file mode 100644 index 000000000000..ee64d62043c5 --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/main.tsp @@ -0,0 +1,699 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CloudFrontDistributions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Cloud Front Distribution", + plural: "Cloud Front Distributions", + }, + keywords: ["Microsoft.AwsConnector", "Cloud", "Front", "Distribution"], +}) +@doc("A Microsoft.AwsConnector resource") +model CloudFrontDistribution + is TrackedResource<CloudFrontDistributionProperties> { + @doc("Name of CloudFrontDistribution") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("cloudFrontDistributions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudFrontDistribution") +model CloudFrontDistributionProperties { + @doc("AWS Properties") + awsProperties?: AwsCloudFrontDistributionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCloudFrontDistribution") +model AwsCloudFrontDistributionProperties { + @doc("The distribution's configuration. A distribution configuration.") + distributionConfig?: DistributionConfig; + + @doc("Property domainName") + domainName?: string; + + @doc("Property id") + id?: string; + + @doc("A complex type that contains zero or more ``Tag`` elements.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DistributionConfig") +model DistributionConfig { + @doc("A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.") + @extension("x-ms-identifiers", []) + aliases?: string[]; + + @doc("Property cnamEs") + @extension("x-ms-identifiers", []) + cnamEs?: string[]; + + @doc("A complex type that contains zero or more ``CacheBehavior`` elements.") + @extension("x-ms-identifiers", []) + cacheBehaviors?: CacheBehavior[]; + + @doc("A comment to describe the distribution. The comment cannot be longer than 128 characters.") + comment?: string; + + @doc("The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``.") + continuousDeploymentPolicyId?: string; + + @doc("A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + customErrorResponses?: CustomErrorResponse[]; + + @doc("Property customOrigin") + customOrigin?: LegacyCustomOrigin; + + @doc("A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior.") + defaultCacheBehavior?: DefaultCacheBehavior; + + @doc("The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*.") + defaultRootObject?: string; + + @doc("From this field, you can enable or disable the selected distribution.") + enabled?: boolean; + + @doc("(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).") + httpVersion?: string = "http1.1"; + + @doc("If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.") + ipV6Enabled?: boolean; + + @doc("A complex type that controls whether access logs are written for the distribution. For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. A complex type that controls whether access logs are written for the distribution.") + logging?: Logging; + + @doc("A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution.") + originGroups?: OriginGroups; + + @doc("A complex type that contains information about origins for this distribution.") + @extension("x-ms-identifiers", []) + origins?: Origin[]; + + @doc("The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/).") + priceClass?: string = "PriceClass_All"; + + @doc("A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content.") + restrictions?: Restrictions; + + @doc("Property s3Origin") + s3Origin?: LegacyS3Origin; + + @doc("A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution.") + staging?: boolean; + + @doc("A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*.") + viewerCertificate?: ViewerCertificate; + + @doc("A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).") + webACLId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("A string that contains ``Tag`` key. The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.") + key?: string; + + @doc("A string that contains an optional ``Tag`` value. The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CacheBehavior") +model CacheBehavior { + @doc("A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.") + @extension("x-ms-identifiers", []) + allowedMethods?: string[]; + + @doc("The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.") + cachePolicyId?: string; + + @doc("A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.") + @extension("x-ms-identifiers", []) + cachedMethods?: string[]; + + @doc("Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.") + compress?: boolean; + + @doc("This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + defaultTTL?: int32 = 86400; + + @doc("The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior.") + fieldLevelEncryptionId?: string; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.") + forwardedValues?: ForwardedValues; + + @doc("A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.") + @extension("x-ms-identifiers", []) + functionAssociations?: FunctionAssociation[]; + + @doc("A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.") + @extension("x-ms-identifiers", []) + lambdaFunctionAssociations?: LambdaFunctionAssociation[]; + + @doc("This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + maxTTL?: int32 = 31536000; + + @doc("This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).") + minTTL?: int32; + + @doc("The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.") + originRequestPolicyId?: string; + + @doc("The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*.") + pathPattern?: string; + + @doc("The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.") + realtimeLogConfigArn?: string; + + @doc("The identifier for a response headers policy.") + responseHeadersPolicyId?: string; + + @doc("Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.") + smoothStreaming?: boolean; + + @doc("The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior.") + targetOriginId?: string; + + @doc("A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + trustedKeyGroups?: string[]; + + @doc("We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + trustedSigners?: string[]; + + @doc("The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + viewerProtocolPolicy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CustomErrorResponse") +model CustomErrorResponse { + @doc("The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.") + errorCachingMinTTL?: int32 = 300; + + @doc("The HTTP status code for which you want to specify a custom error page and/or a caching duration.") + errorCode?: int32; + + @doc("The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``.") + responseCode?: int32; + + @doc("The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.") + responsePagePath?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LegacyCustomOrigin") +model LegacyCustomOrigin { + @doc("Property dnsName") + dnsName?: string; + + @doc("Property httpPort") + httpPort?: int32 = 80; + + @doc("Property httpsPort") + httpsPort?: int32 = 443; + + @doc("Property originProtocolPolicy") + originProtocolPolicy?: string; + + @doc("Property originSSLProtocols") + @extension("x-ms-identifiers", []) + originSSLProtocols?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DefaultCacheBehavior") +model DefaultCacheBehavior { + @doc("A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.") + @extension("x-ms-identifiers", []) + allowedMethods?: string[]; + + @doc("The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``.") + cachePolicyId?: string; + + @doc("A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.") + @extension("x-ms-identifiers", []) + cachedMethods?: string[]; + + @doc("Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*.") + compress?: boolean; + + @doc("This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + defaultTTL?: int32 = 86400; + + @doc("The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior.") + fieldLevelEncryptionId?: string; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.") + forwardedValues?: ForwardedValues; + + @doc("A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.") + @extension("x-ms-identifiers", []) + functionAssociations?: FunctionAssociation[]; + + @doc("A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.") + @extension("x-ms-identifiers", []) + lambdaFunctionAssociations?: LambdaFunctionAssociation[]; + + @doc("This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + maxTTL?: int32 = 31536000; + + @doc("This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``).") + minTTL?: int32; + + @doc("The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*.") + originRequestPolicyId?: string; + + @doc("The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*.") + realtimeLogConfigArn?: string; + + @doc("The identifier for a response headers policy.") + responseHeadersPolicyId?: string; + + @doc("Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``.") + smoothStreaming?: boolean; + + @doc("The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior.") + targetOriginId?: string; + + @doc("A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + trustedKeyGroups?: string[]; + + @doc("We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + trustedSigners?: string[]; + + @doc("The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.") + viewerProtocolPolicy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Logging") +model Logging { + @doc("The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``.") + bucket?: string; + + @doc("Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``.") + includeCookies?: boolean; + + @doc("An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element.") + prefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginGroups") +model OriginGroups { + @doc("The items (origin groups) in a distribution.") + @extension("x-ms-identifiers", []) + items?: OriginGroup[]; + + @doc("The number of origin groups.") + quantity?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Origin") +model Origin { + @doc("The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*.") + connectionAttempts?: int32; + + @doc("The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*.") + connectionTimeout?: int32; + + @doc("Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin.") + customOriginConfig?: CustomOriginConfig; + + @doc("The domain name for the origin. For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*.") + domainName?: string; + + @doc("A unique identifier for the origin. This value must be unique within the distribution. Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``.") + id?: string; + + @doc("The unique identifier of an origin access control for this origin. For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*.") + originAccessControlId?: string; + + @doc("A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + originCustomHeaders?: OriginCustomHeader[]; + + @doc("An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*.") + originPath?: string; + + @doc("CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*.") + originShield?: OriginShield; + + @doc("Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead.") + s3OriginConfig?: S3OriginConfig; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Restrictions") +model Restrictions { + @doc("A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template.") + geoRestriction?: GeoRestriction; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LegacyS3Origin") +model LegacyS3Origin { + @doc("Property dnsName") + dnsName?: string; + + @doc("Property originAccessIdentity") + originAccessIdentity?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ViewerCertificate") +model ViewerCertificate { + @doc("In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``). If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)") + acmCertificateArn?: string; + + @doc("If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields: + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + ``MinimumProtocolVersion`` + ``SslSupportMethod``") + cloudFrontDefaultCertificate?: boolean; + + @doc("In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)") + iamCertificateId?: string; + + @doc("If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings: + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. + The ciphers that CloudFront can use to encrypt the content that it returns to viewers. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*. On the CloudFront console, this setting is called *Security Policy*. When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here.") + minimumProtocolVersion?: string; + + @doc("In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from. + ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. + ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home). If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field.") + sslSupportMethod?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ForwardedValues") +model ForwardedValues { + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*.") + cookies?: Cookies; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + headers?: string[]; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*.") + queryString?: boolean; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.") + @extension("x-ms-identifiers", []) + queryStringCacheKeys?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FunctionAssociation") +model FunctionAssociation { + @doc("The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function.") + eventType?: string; + + @doc("The Amazon Resource Name (ARN) of the function.") + functionARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LambdaFunctionAssociation") +model LambdaFunctionAssociation { + @doc("Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.") + eventType?: string; + + @doc("A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide.") + includeBody?: boolean; + + @doc("The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST.") + lambdaFunctionARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginGroup") +model OriginGroup { + @doc("A complex type that contains information about the failover criteria for an origin group. A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.") + failoverCriteria?: OriginGroupFailoverCriteria; + + @doc("The origin group's ID.") + id?: string; + + @doc("A complex type that contains information about the origins in an origin group. A complex data type for the origins included in an origin group.") + members?: OriginGroupMembers; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CustomOriginConfig") +model CustomOriginConfig { + @doc("The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.") + httpPort?: int32 = 80; + + @doc("The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.") + httpsPort?: int32 = 443; + + @doc("Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.") + originKeepaliveTimeout?: int32 = 5; + + @doc("Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: + ``http-only`` – CloudFront always uses HTTP to connect to the origin. + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + ``https-only`` – CloudFront always uses HTTPS to connect to the origin.") + originProtocolPolicy?: string; + + @doc("Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.") + originReadTimeout?: int32 = 30; + + @doc("Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + originSSLProtocols?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginCustomHeader") +model OriginCustomHeader { + @doc("The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*.") + headerName?: string; + + @doc("The value for the header that you specified in the ``HeaderName`` field.") + headerValue?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginShield") +model OriginShield { + @doc("A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches.") + enabled?: boolean; + + @doc("The AWS-Region for Origin Shield. Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*.") + originShieldRegion?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3OriginConfig") +model S3OriginConfig { + @doc("The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: origin-access-identity/cloudfront/*ID-of-origin-access-identity* where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.") + originAccessIdentity?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GeoRestriction") +model GeoRestriction { + @doc("A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content or not distribute your content.") + @extension("x-ms-identifiers", []) + locations?: string[]; + + @doc("The method that you want to use to restrict distribution of your content by country.") + restrictionType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Cookies") +model Cookies { + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element.") + forward?: string; + + @doc("This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.") + @extension("x-ms-identifiers", []) + whitelistedNames?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginGroupFailoverCriteria") +model OriginGroupFailoverCriteria { + @doc("The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.") + statusCodes?: StatusCodes; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginGroupMembers") +model OriginGroupMembers { + @doc("Items (origins) in an origin group.") + @extension("x-ms-identifiers", []) + items?: OriginGroupMember[]; + + @doc("The number of origins in an origin group.") + quantity?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatusCodes") +model StatusCodes { + @doc("The items (status codes) for an origin group.") + @extension("x-ms-identifiers", []) + items?: int32[]; + + @doc("The number of status codes.") + quantity?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OriginGroupMember") +model OriginGroupMember { + @doc("The ID for an origin in an origin group.") + originId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CloudFrontDistributions { + get is ArmResourceRead<CloudFrontDistribution>; + @doc("Create a CloudFrontDistribution. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CloudFrontDistribution>; + update is ArmCustomPatchAsync< + CloudFrontDistribution, + Azure.ResourceManager.Foundations.TagsUpdateModel<CloudFrontDistribution> + >; + delete is ArmResourceDeleteWithoutOkAsync<CloudFrontDistribution>; + listByResourceGroup is ArmResourceListByParent<CloudFrontDistribution>; + listBySubscription is ArmListBySubscription<CloudFrontDistribution>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::CloudFront::Distribution +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CloudFrontDistribution.Management/tspconfig.yaml b/specification/awsconnector/CloudFrontDistribution.Management/tspconfig.yaml new file mode 100644 index 000000000000..4bbcb35a0f0f --- /dev/null +++ b/specification/awsconnector/CloudFrontDistribution.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/cloudFrontDistribution.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_CreateOrReplace.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_CreateOrReplace.json new file mode 100644 index 000000000000..d1c83cb20a68 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_CreateOrReplace.json @@ -0,0 +1,310 @@ +{ + "title": "CloudTrailTrails_CreateOrReplace", + "operationId": "CloudTrailTrails_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + } + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Delete.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Delete.json new file mode 100644 index 000000000000..1641e4e719a2 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudTrailTrails_Delete", + "operationId": "CloudTrailTrails_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Get.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Get.json new file mode 100644 index 000000000000..0efd16b516f9 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Get.json @@ -0,0 +1,115 @@ +{ + "title": "CloudTrailTrails_Get", + "operationId": "CloudTrailTrails_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListByResourceGroup.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListByResourceGroup.json new file mode 100644 index 000000000000..abc04a196a83 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListByResourceGroup.json @@ -0,0 +1,119 @@ +{ + "title": "CloudTrailTrails_ListByResourceGroup", + "operationId": "CloudTrailTrails_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + ], + "nextLink": "https://microsoft.com/almmmg" + } + } + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListBySubscription.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListBySubscription.json new file mode 100644 index 000000000000..e4652dfe9dde --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_ListBySubscription.json @@ -0,0 +1,118 @@ +{ + "title": "CloudTrailTrails_ListBySubscription", + "operationId": "CloudTrailTrails_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + ], + "nextLink": "https://microsoft.com/almmmg" + } + } + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Update.json b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Update.json new file mode 100644 index 000000000000..d5c3bf2f2780 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/examples/2024-12-01/CloudTrailTrails_Update.json @@ -0,0 +1,125 @@ +{ + "title": "CloudTrailTrails_Update", + "operationId": "CloudTrailTrails_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1706": "ukvxmoyptghknfzltnxpz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CloudTrailTrail.Management/main.tsp b/specification/awsconnector/CloudTrailTrail.Management/main.tsp new file mode 100644 index 000000000000..074163457f41 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/main.tsp @@ -0,0 +1,273 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CloudTrailTrails ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Cloud Trail Trail", + plural: "Cloud Trail Trails", + }, + keywords: ["Microsoft.AwsConnector", "Cloud", "Trail", "Trail"], +}) +@doc("A Microsoft.AwsConnector resource") +model CloudTrailTrail is TrackedResource<CloudTrailTrailProperties> { + @doc("Name of CloudTrailTrail") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("cloudTrailTrails") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudTrailTrail") +model CloudTrailTrailProperties { + @doc("AWS Properties") + awsProperties?: AwsCloudTrailTrailProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCloudTrailTrail") +model AwsCloudTrailTrailProperties { + @doc("The advanced event selectors that were used to select events for the data store.") + @extension("x-ms-identifiers", []) + advancedEventSelectors?: AdvancedEventSelector[]; + + @doc("Property arn") + arn?: string; + + @doc("Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.") + cloudWatchLogsLogGroupArn?: string; + + @doc("Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.") + cloudWatchLogsRoleArn?: string; + + @doc("Specifies whether log file validation is enabled. The default is false.") + enableLogFileValidation?: boolean; + + @doc("Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.") + @extension("x-ms-identifiers", []) + eventSelectors?: EventSelector[]; + + @doc("Specifies whether the trail is publishing events from global services such as IAM to the log files.") + includeGlobalServiceEvents?: boolean; + + @doc("Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.") + @extension("x-ms-identifiers", []) + insightSelectors?: InsightSelector[]; + + @doc("Whether the CloudTrail is currently logging AWS API calls.") + isLogging?: boolean; + + @doc("Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.") + isMultiRegionTrail?: boolean; + + @doc("Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.") + isOrganizationTrail?: boolean; + + @doc("Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.") + kmsKeyId?: string; + + @doc("Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.") + s3BucketName?: string; + + @doc("Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.") + s3KeyPrefix?: string; + + @doc("Property snsTopicArn") + snsTopicArn?: string; + + @doc("Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.") + snsTopicName?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property trailName") + trailName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AdvancedEventSelector") +model AdvancedEventSelector { + @doc("Contains all selector statements in an advanced event selector.") + @extension("x-ms-identifiers", []) + fieldSelectors?: AdvancedFieldSelector[]; + + @doc("An optional, descriptive name for an advanced event selector, such as 'Log data events for only two S3 buckets'.") + name?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EventSelector") +model EventSelector { + @doc("Property dataResources") + @extension("x-ms-identifiers", []) + dataResources?: DataResource[]; + + @doc("An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing 'kms.amazonaws.com'. By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.") + @extension("x-ms-identifiers", []) + excludeManagementEventSources?: string[]; + + @doc("Specify if you want your event selector to include management events for your trail.") + includeManagementEvents?: boolean; + + @doc("Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.") + readWriteType?: EventSelectorReadWriteType; +} + +@doc("EventSelectorReadWriteType enum") +union EventSelectorReadWriteType { + @doc("EventSelectorReadWriteType enum All") + All: "All", + + @doc("EventSelectorReadWriteType enum ReadOnly") + ReadOnly: "ReadOnly", + + @doc("EventSelectorReadWriteType enum WriteOnly") + WriteOnly: "WriteOnly", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InsightSelector") +model InsightSelector { + @doc("The type of insight to log on a trail.") + insightType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AdvancedFieldSelector") +model AdvancedFieldSelector { + @doc("An operator that includes events that match the last few characters of the event record field specified as the value of Field.") + @extension("x-ms-identifiers", []) + endsWith?: string[]; + + @doc("An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.") + @extension("x-ms-identifiers", []) + equals?: string[]; + + @doc("A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.") + field?: string; + + @doc("An operator that excludes events that match the last few characters of the event record field specified as the value of Field.") + @extension("x-ms-identifiers", []) + notEndsWith?: string[]; + + @doc("An operator that excludes events that match the exact value of the event record field specified as the value of Field.") + @extension("x-ms-identifiers", []) + notEquals?: string[]; + + @doc("An operator that excludes events that match the first few characters of the event record field specified as the value of Field.") + @extension("x-ms-identifiers", []) + notStartsWith?: string[]; + + @doc("An operator that includes events that match the first few characters of the event record field specified as the value of Field.") + @extension("x-ms-identifiers", []) + startsWith?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DataResource") +model DataResource { + @doc("The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.") + type?: string; + + @doc("An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.") + @extension("x-ms-identifiers", []) + values?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CloudTrailTrails { + get is ArmResourceRead<CloudTrailTrail>; + @doc("Create a CloudTrailTrail. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CloudTrailTrail>; + update is ArmCustomPatchAsync< + CloudTrailTrail, + Azure.ResourceManager.Foundations.TagsUpdateModel<CloudTrailTrail> + >; + delete is ArmResourceDeleteWithoutOkAsync<CloudTrailTrail>; + listByResourceGroup is ArmResourceListByParent<CloudTrailTrail>; + listBySubscription is ArmListBySubscription<CloudTrailTrail>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::CloudTrail::Trail +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CloudTrailTrail.Management/tspconfig.yaml b/specification/awsconnector/CloudTrailTrail.Management/tspconfig.yaml new file mode 100644 index 000000000000..04865bb771d7 --- /dev/null +++ b/specification/awsconnector/CloudTrailTrail.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/cloudTrailTrail.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_CreateOrReplace.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_CreateOrReplace.json new file mode 100644 index 000000000000..957422acf55d --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_CreateOrReplace.json @@ -0,0 +1,289 @@ +{ + "title": "CloudWatchAlarms_CreateOrReplace", + "operationId": "CloudWatchAlarms_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + } + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Delete.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Delete.json new file mode 100644 index 000000000000..97e845093217 --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudWatchAlarms_Delete", + "operationId": "CloudWatchAlarms_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Get.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Get.json new file mode 100644 index 000000000000..5fa00f46e3cd --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Get.json @@ -0,0 +1,108 @@ +{ + "title": "CloudWatchAlarms_Get", + "operationId": "CloudWatchAlarms_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + } + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListByResourceGroup.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListByResourceGroup.json new file mode 100644 index 000000000000..79ec6fb57ba4 --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListByResourceGroup.json @@ -0,0 +1,112 @@ +{ + "title": "CloudWatchAlarms_ListByResourceGroup", + "operationId": "CloudWatchAlarms_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListBySubscription.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListBySubscription.json new file mode 100644 index 000000000000..bc2b1bb5634a --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_ListBySubscription.json @@ -0,0 +1,111 @@ +{ + "title": "CloudWatchAlarms_ListBySubscription", + "operationId": "CloudWatchAlarms_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Update.json b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Update.json new file mode 100644 index 000000000000..aef84cc71f4c --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/examples/2024-12-01/CloudWatchAlarms_Update.json @@ -0,0 +1,118 @@ +{ + "title": "CloudWatchAlarms_Update", + "operationId": "CloudWatchAlarms_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5472": "xkr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CloudWatchAlarm.Management/main.tsp b/specification/awsconnector/CloudWatchAlarm.Management/main.tsp new file mode 100644 index 000000000000..d678904d66d9 --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/main.tsp @@ -0,0 +1,260 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CloudWatchAlarms ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Cloud Watch Alarm", + plural: "Cloud Watch Alarms", + }, + keywords: ["Microsoft.AwsConnector", "Cloud", "Watch", "Alarm"], +}) +@doc("A Microsoft.AwsConnector resource") +model CloudWatchAlarm is TrackedResource<CloudWatchAlarmProperties> { + @doc("Name of CloudWatchAlarm") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("cloudWatchAlarms") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudWatchAlarm") +model CloudWatchAlarmProperties { + @doc("AWS Properties") + awsProperties?: AwsCloudWatchAlarmProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCloudWatchAlarm") +model AwsCloudWatchAlarmProperties { + @doc("Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.") + actionsEnabled?: boolean = true; + + @doc("The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.") + @extension("x-ms-identifiers", []) + alarmActions?: string[]; + + @doc("The description of the alarm.") + alarmDescription?: string; + + @doc("The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + alarmName?: string; + + @doc("Property arn") + arn?: string; + + @doc("The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.") + comparisonOperator?: string; + + @doc("The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an 'M out of N' alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching.") + datapointsToAlarm?: int32; + + @doc("The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.") + @extension("x-ms-identifiers", []) + dimensions?: Dimension[]; + + @doc("Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.") + evaluateLowSampleCountPercentile?: string; + + @doc("The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an 'M out of N' alarm, this value is the N, and ``DatapointsToAlarm`` is the M. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*.") + evaluationPeriods?: int32; + + @doc("The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``.") + extendedStatistic?: string; + + @doc("The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).") + @extension("x-ms-identifiers", []) + insufficientDataActions?: string[]; + + @doc("The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``.") + metricName?: string; + + @doc("An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.") + @extension("x-ms-identifiers", []) + metrics?: MetricDataQuery[]; + + @doc("The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)") + `namespace`?: string; + + @doc("The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).") + @extension("x-ms-identifiers", []) + okActions?: string[]; + + @doc("The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. *Minimum:* 10") + period?: int32; + + @doc("The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``.") + statistic?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The value to compare with the specified statistic.") + threshold?: float32; + + @doc("In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm.") + thresholdMetricId?: string; + + @doc("Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. If you omit this parameter, the default behavior of ``missing`` is used.") + treatMissingData?: string; + + @doc("The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.") + unit?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Dimension") +model Dimension { + @doc("The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published.") + name?: string; + + @doc("The value for the dimension, from 1–255 characters in length.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MetricDataQuery") +model MetricDataQuery { + @doc("The ID of the account where the metrics are located, if this is a cross-account alarm.") + accountId?: string; + + @doc("The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both.") + expression?: string; + + @doc("A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.") + id?: string; + + @doc("A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default.") + label?: string; + + @doc("The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. This structure defines the metric to be returned, along with the statistics, period, and units. ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.") + metricStat?: MetricStat; + + @doc("The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``.") + period?: int32; + + @doc("This option indicates whether to return the timestamps and raw data values of this metric. When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. This field is required.") + returnData?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources.") + key?: string; + + @doc("The value for the specified tag key.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MetricStat") +model MetricStat { + @doc("The metric to return, including the metric name, namespace, and dimensions. The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type.") + metric?: Metric; + + @doc("The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).") + period?: int32; + + @doc("The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.") + stat?: string; + + @doc("The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.") + unit?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Metric") +model Metric { + @doc("The metric dimensions that you want to be used for the metric that the alarm will watch.") + @extension("x-ms-identifiers", []) + dimensions?: Dimension[]; + + @doc("The name of the metric that you want the alarm to watch. This is a required field.") + metricName?: string; + + @doc("The namespace of the metric that the alarm will watch.") + `namespace`?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CloudWatchAlarms { + get is ArmResourceRead<CloudWatchAlarm>; + @doc("Create a CloudWatchAlarm. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CloudWatchAlarm>; + update is ArmCustomPatchAsync< + CloudWatchAlarm, + Azure.ResourceManager.Foundations.TagsUpdateModel<CloudWatchAlarm> + >; + delete is ArmResourceDeleteWithoutOkAsync<CloudWatchAlarm>; + listByResourceGroup is ArmResourceListByParent<CloudWatchAlarm>; + listBySubscription is ArmListBySubscription<CloudWatchAlarm>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::CloudWatch::Alarm +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CloudWatchAlarm.Management/tspconfig.yaml b/specification/awsconnector/CloudWatchAlarm.Management/tspconfig.yaml new file mode 100644 index 000000000000..b9e4bc615ce0 --- /dev/null +++ b/specification/awsconnector/CloudWatchAlarm.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/cloudWatchAlarm.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_CreateOrReplace.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_CreateOrReplace.json new file mode 100644 index 000000000000..4947d1a6ea12 --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_CreateOrReplace.json @@ -0,0 +1,817 @@ +{ + "title": "CodeBuildProjects_CreateOrReplace", + "operationId": "CodeBuildProjects_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + } + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + } + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Delete.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Delete.json new file mode 100644 index 000000000000..9787fb1ab4ab --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CodeBuildProjects_Delete", + "operationId": "CodeBuildProjects_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Get.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Get.json new file mode 100644 index 000000000000..dab865044732 --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Get.json @@ -0,0 +1,284 @@ +{ + "title": "CodeBuildProjects_Get", + "operationId": "CodeBuildProjects_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + } + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListByResourceGroup.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListByResourceGroup.json new file mode 100644 index 000000000000..9199623cd9af --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListByResourceGroup.json @@ -0,0 +1,288 @@ +{ + "title": "CodeBuildProjects_ListByResourceGroup", + "operationId": "CodeBuildProjects_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListBySubscription.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListBySubscription.json new file mode 100644 index 000000000000..4d3221002282 --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_ListBySubscription.json @@ -0,0 +1,287 @@ +{ + "title": "CodeBuildProjects_ListBySubscription", + "operationId": "CodeBuildProjects_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Update.json b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Update.json new file mode 100644 index 000000000000..6b605168c1ee --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/examples/2024-12-01/CodeBuildProjects_Update.json @@ -0,0 +1,294 @@ +{ + "title": "CodeBuildProjects_Update", + "operationId": "CodeBuildProjects_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2639": "icrtpvdmqclauovfcehwm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildProject.Management/main.tsp b/specification/awsconnector/CodeBuildProject.Management/main.tsp new file mode 100644 index 000000000000..804e518a4d08 --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/main.tsp @@ -0,0 +1,1098 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CodeBuildProjects ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Code Build Project", + plural: "Code Build Projects", + }, + keywords: ["Microsoft.AwsConnector", "Code", "Build", "Project"], +}) +@doc("A Microsoft.AwsConnector resource") +model CodeBuildProject is TrackedResource<CodeBuildProjectProperties> { + @doc("Name of CodeBuildProject") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("codeBuildProjects") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CodeBuildProject") +model CodeBuildProjectProperties { + @doc("AWS Properties") + awsProperties?: AwsCodeBuildProjectProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCodeBuildProject") +model AwsCodeBuildProjectProperties { + @doc("<p>The Amazon Resource Name (ARN) of the build project.</p>") + arn?: string; + + @doc("<p>Information about the build output artifacts for the build project.</p>") + artifacts?: ProjectArtifacts; + + @doc("<p>Information about the build badge for the build project.</p>") + badge?: ProjectBadge; + + @doc("<p>A <a>ProjectBuildBatchConfig</a> object that defines the batch build options for the project.</p>") + buildBatchConfig?: ProjectBuildBatchConfig; + + @doc("<p>Information about the cache for the build project.</p>") + cache?: ProjectCache; + + @doc("<p>The maximum number of concurrent builds that are allowed for this project.</p> <p>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</p>") + concurrentBuildLimit?: int32; + + @doc("<p>When the build project was created, expressed in Unix time format.</p>") + created?: utcDateTime; + + @doc("<p>A description that makes the build project easy to identify.</p>") + description?: string; + + @doc("<p>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). </p>") + encryptionKey?: string; + + @doc("<p>Information about the build environment for this build project.</p>") + environment?: ProjectEnvironment; + + @doc("<p> An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </p>") + @extension("x-ms-identifiers", []) + fileSystemLocations?: ProjectFileSystemLocation[]; + + @doc("<p>When the build project's settings were last modified, expressed in Unix time format.</p>") + lastModified?: utcDateTime; + + @doc("<p>Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. </p>") + logsConfig?: LogsConfig; + + @doc("<p>The name of the build project.</p>") + name?: string; + + @doc("Property projectVisibility") + projectVisibility?: ProjectVisibilityTypeEnumValue; + + @doc("<p>Contains the project identifier used with the public build APIs. </p>") + publicProjectAlias?: string; + + @doc("<p>The number of minutes a build is allowed to be queued before it times out. </p>") + queuedTimeoutInMinutes?: int32; + + @doc("<p>The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.</p>") + resourceAccessRole?: string; + + @doc("<p>An array of <code>ProjectArtifacts</code> objects. </p>") + @extension("x-ms-identifiers", []) + secondaryArtifacts?: ProjectArtifacts[]; + + @doc("<p>An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). </p>") + @extension("x-ms-identifiers", []) + secondarySourceVersions?: ProjectSourceVersion[]; + + @doc("<p>An array of <code>ProjectSource</code> objects. </p>") + @extension("x-ms-identifiers", []) + secondarySources?: ProjectSource[]; + + @doc("<p>The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.</p>") + serviceRole?: string; + + @doc("<p>Information about the build input source code for this build project.</p>") + source?: ProjectSource; + + @doc("<p>A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p>If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </p> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'>Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>") + sourceVersion?: string; + + @doc("<p>A list of tag key and value pairs associated with this build project.</p> <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.</p>") + timeoutInMinutes?: int32; + + @doc("<p>Information about the VPC configuration that CodeBuild accesses.</p>") + vpcConfig?: VpcConfig; + + @doc("<p>Information about a webhook that connects repository events to a build project in CodeBuild.</p>") + webhook?: Webhook; +} + +@doc("ProjectVisibilityType enum") +union ProjectVisibilityType { + @doc("ProjectVisibilityType enum PRIVATE") + PRIVATE: "PRIVATE", + + @doc("ProjectVisibilityType enum PUBLIC_READ") + PUBLIC_READ: "PUBLIC_READ", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectVisibilityTypeEnumValue") +model ProjectVisibilityTypeEnumValue { + @doc("Property value") + value?: ProjectVisibilityType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectArtifacts") +model ProjectArtifacts { + @doc("<p> An identifier for this artifact definition. </p>") + artifactIdentifier?: string; + + @doc("Property bucketOwnerAccess") + bucketOwnerAccess?: BucketOwnerAccessEnumValue; + + @doc("<p> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </p>") + encryptionDisabled?: boolean; + + @doc("<p>Information about the build output artifact location:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>") + location?: string; + + @doc("<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash ('/'), the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to '<code>/</code>', the output artifact is stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to '<code>/</code>', the output artifact is stored in <code>MyArtifacts/<build-ID></code>. </p> </li> </ul>") + name?: string; + + @doc("<p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>") + namespaceType?: ArtifactNamespaceEnumValue; + + @doc("<p> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </p>") + overrideArtifactName?: boolean; + + @doc("<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>") + packaging?: ArtifactPackagingEnumValue; + + @doc("<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>") + path?: string; + + @doc("<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>") + type?: ArtifactsTypeEnumValue; +} + +@doc("BucketOwnerAccess enum") +union BucketOwnerAccess { + @doc("BucketOwnerAccess enum FULL") + FULL: "FULL", + + @doc("BucketOwnerAccess enum NONE") + NONE: "NONE", + + @doc("BucketOwnerAccess enum READ_ONLY") + READ_ONLY: "READ_ONLY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BucketOwnerAccessEnumValue") +model BucketOwnerAccessEnumValue { + @doc("Property value") + value?: BucketOwnerAccess; +} + +@doc("ArtifactPackaging enum") +union ArtifactPackaging { + @doc("ArtifactPackaging enum NONE") + NONE: "NONE", + + @doc("ArtifactPackaging enum ZIP") + ZIP: "ZIP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArtifactPackagingEnumValue") +model ArtifactPackagingEnumValue { + @doc("Property value") + value?: ArtifactPackaging; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectBadge") +model ProjectBadge { + @doc("<p>Set this to true to generate a publicly accessible URL for your project's build badge.</p>") + badgeEnabled?: boolean; + + @doc("<p>The publicly-accessible URL through which you can access the build badge for your project. </p>") + badgeRequestUrl?: string; +} + +@doc("ArtifactNamespace enum") +union ArtifactNamespace { + @doc("ArtifactNamespace enum BUILD_ID") + BUILD_ID: "BUILD_ID", + + @doc("ArtifactNamespace enum NONE") + NONE: "NONE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArtifactNamespaceEnumValue") +model ArtifactNamespaceEnumValue { + @doc("Property value") + value?: ArtifactNamespace; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectBuildBatchConfig") +model ProjectBuildBatchConfig { + @doc("<p>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</p> <dl> <dt>REPORT_AGGREGATED_BATCH</dt> <dd> <p>(Default) Aggregate all of the build statuses into a single status report.</p> </dd> <dt>REPORT_INDIVIDUAL_BUILDS</dt> <dd> <p>Send a separate status report for each individual build.</p> </dd> </dl>") + batchReportMode?: BatchReportModeTypeEnumValue; + + @doc("<p>Specifies if the build artifacts for the batch build should be combined into a single artifact location.</p>") + combineArtifacts?: boolean; + + @doc("<p>A <code>BatchRestrictions</code> object that specifies the restrictions for the batch build.</p>") + restrictions?: BatchRestrictions; + + @doc("<p>Specifies the service role ARN for the batch build project.</p>") + serviceRole?: string; + + @doc("<p>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</p>") + timeoutInMins?: int32; +} + +@doc("ArtifactsType enum") +union ArtifactsType { + @doc("ArtifactsType enum CODEPIPELINE") + CODEPIPELINE: "CODEPIPELINE", + + @doc("ArtifactsType enum NO_ARTIFACTS") + NO_ARTIFACTS: "NO_ARTIFACTS", + + @doc("ArtifactsType enum S3") + S3: "S3", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArtifactsTypeEnumValue") +model ArtifactsTypeEnumValue { + @doc("Property value") + value?: ArtifactsType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectCache") +model ProjectCache { + @doc("<p>Information about the cache location: </p> <ul> <li> <p> <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>") + location?: string; + + @doc("<p>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</p> <p>Possible values are:</p> <dl> <dt>LOCAL_SOURCE_CACHE</dt> <dd> <p>Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </p> </dd> <dt>LOCAL_DOCKER_LAYER_CACHE</dt> <dd> <p>Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p>You can use a Docker layer cache in the Linux environment only. </p> </li> <li> <p>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </p> </li> <li> <p>You should consider the security implications before you use a Docker layer cache. </p> </li> </ul> </note> </dd> <dt>LOCAL_CUSTOM_CACHE</dt> <dd> <p>Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p>Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p>Symlinks are used to reference cached directories. </p> </li> <li> <p>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </dd> </dl>") + @extension("x-ms-identifiers", []) + modes?: CacheMode[]; + + @doc("<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> <li> <p> <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</p> </li> </ul>") + type?: CacheTypeEnumValue; +} + +@doc("BatchReportModeType enum") +union BatchReportModeType { + @doc("BatchReportModeType enum REPORT_AGGREGATED_BATCH") + REPORT_AGGREGATED_BATCH: "REPORT_AGGREGATED_BATCH", + + @doc("BatchReportModeType enum REPORT_INDIVIDUAL_BUILDS") + REPORT_INDIVIDUAL_BUILDS: "REPORT_INDIVIDUAL_BUILDS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BatchReportModeTypeEnumValue") +model BatchReportModeTypeEnumValue { + @doc("Property value") + value?: BatchReportModeType; +} + +@doc("CacheType enum") +union CacheType { + @doc("CacheType enum LOCAL") + LOCAL: "LOCAL", + + @doc("CacheType enum NO_CACHE") + NO_CACHE: "NO_CACHE", + + @doc("CacheType enum S3") + S3: "S3", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CacheTypeEnumValue") +model CacheTypeEnumValue { + @doc("Property value") + value?: CacheType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectEnvironment") +model ProjectEnvironment { + @doc("<p>The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate'>certificate</a> in the <i>CodeBuild User Guide</i>.</p>") + certificate?: string; + + @doc("<p>Information about the compute resources the build project uses. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_XLARGE</code>: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.</p> </li> <li> <p> <code>BUILD_LAMBDA_1GB</code>: Use up to 1 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_2GB</code>: Use up to 2 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_4GB</code>: Use up to 4 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_8GB</code>: Use up to 8 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_10GB</code>: Use up to 10 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_SMALL</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 3 GB memory and 2 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</p> </li> </ul> <note> <p>If you're using compute fleets during project creation, <code>computeType</code> will be ignored.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build Environment Compute Types</a> in the <i>CodeBuild User Guide.</i> </p>") + computeType?: ComputeTypeEnumValue; + + @doc("<p>A set of environment variables to make available to builds for this build project.</p>") + @extension("x-ms-identifiers", []) + environmentVariables?: EnvironmentVariable[]; + + @doc("<p>A ProjectFleet object to use for this build project.</p>") + fleet?: ProjectFleet; + + @doc("<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code><registry>/<repository>@<digest></code>. For example, to specify an image with the digest 'sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,' use <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html'>Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</p>") + image?: string; + + @doc("<p> The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </p>") + imagePullCredentialsType?: ImagePullCredentialsTypeEnumValue; + + @doc("<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is <code>false</code>.</p> <p>You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'</code> </p>") + privilegedMode?: boolean; + + @doc("<p> The credentials for access to a private registry.</p>") + registryCredential?: RegistryCredential; + + @doc("<p>The type of build environment to use for related builds.</p> <ul> <li> <p>The environment type <code>ARM_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).</p> </li> <li> <p>The environment type <code>LINUX_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> </li> <li> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> </li> </ul> <ul> <li> <p>The environment types <code>ARM_LAMBDA_CONTAINER</code> and <code>LINUX_LAMBDA_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).</p> </li> </ul> <ul> <li> <p>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</p> </li> </ul> <note> <p>If you're using compute fleets during project creation, <code>type</code> will be ignored.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build environment compute types</a> in the <i>CodeBuild user guide</i>.</p>") + type?: EnvironmentTypeEnumValue; +} + +@doc("CacheMode enum") +union CacheMode { + @doc("CacheMode enum LOCAL_CUSTOM_CACHE") + LOCAL_CUSTOM_CACHE: "LOCAL_CUSTOM_CACHE", + + @doc("CacheMode enum LOCAL_DOCKER_LAYER_CACHE") + LOCAL_DOCKER_LAYER_CACHE: "LOCAL_DOCKER_LAYER_CACHE", + + @doc("CacheMode enum LOCAL_SOURCE_CACHE") + LOCAL_SOURCE_CACHE: "LOCAL_SOURCE_CACHE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CacheModeEnumValue") +model CacheModeEnumValue { + @doc("Property value") + value?: CacheMode; +} + +@doc("ImagePullCredentialsType enum") +union ImagePullCredentialsType { + @doc("ImagePullCredentialsType enum CODEBUILD") + CODEBUILD: "CODEBUILD", + + @doc("ImagePullCredentialsType enum SERVICE_ROLE") + SERVICE_ROLE: "SERVICE_ROLE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImagePullCredentialsTypeEnumValue") +model ImagePullCredentialsTypeEnumValue { + @doc("Property value") + value?: ImagePullCredentialsType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectFileSystemLocation") +model ProjectFileSystemLocation { + @doc("<p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>") + identifier?: string; + + @doc("<p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>") + location?: string; + + @doc("<p> The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href='https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html'>Recommended NFS Mount Options</a>. </p>") + mountOptions?: string; + + @doc("<p>The location in the container where you mount the file system. </p>") + mountPoint?: string; + + @doc("<p> The type of the file system. The one supported type is <code>EFS</code>. </p>") + type?: FileSystemTypeEnumValue; +} + +@doc("ComputeType enum") +union ComputeType { + @doc("ComputeType enum BUILD_GENERAL1_2XLARGE") + BUILD_GENERAL1_2XLARGE: "BUILD_GENERAL1_2XLARGE", + + @doc("ComputeType enum BUILD_GENERAL1_LARGE") + BUILD_GENERAL1_LARGE: "BUILD_GENERAL1_LARGE", + + @doc("ComputeType enum BUILD_GENERAL1_MEDIUM") + BUILD_GENERAL1_MEDIUM: "BUILD_GENERAL1_MEDIUM", + + @doc("ComputeType enum BUILD_GENERAL1_SMALL") + BUILD_GENERAL1_SMALL: "BUILD_GENERAL1_SMALL", + + @doc("ComputeType enum BUILD_GENERAL1_XLARGE") + BUILD_GENERAL1_XLARGE: "BUILD_GENERAL1_XLARGE", + + @doc("ComputeType enum BUILD_LAMBDA_10GB") + BUILD_LAMBDA_10GB: "BUILD_LAMBDA_10GB", + + @doc("ComputeType enum BUILD_LAMBDA_1GB") + BUILD_LAMBDA_1GB: "BUILD_LAMBDA_1GB", + + @doc("ComputeType enum BUILD_LAMBDA_2GB") + BUILD_LAMBDA_2GB: "BUILD_LAMBDA_2GB", + + @doc("ComputeType enum BUILD_LAMBDA_4GB") + BUILD_LAMBDA_4GB: "BUILD_LAMBDA_4GB", + + @doc("ComputeType enum BUILD_LAMBDA_8GB") + BUILD_LAMBDA_8GB: "BUILD_LAMBDA_8GB", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ComputeTypeEnumValue") +model ComputeTypeEnumValue { + @doc("Property value") + value?: ComputeType; +} + +@doc("FileSystemType enum") +union FileSystemType { + @doc("FileSystemType enum EFS") + EFS: "EFS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FileSystemTypeEnumValue") +model FileSystemTypeEnumValue { + @doc("Property value") + value?: FileSystemType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsConfig") +model LogsConfig { + @doc("<p> Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. </p>") + cloudWatchLogs?: CloudWatchLogsConfig; + + @doc("<p> Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. </p>") + s3Logs?: S3LogsConfig; +} + +@doc("EnvironmentType enum") +union EnvironmentType { + @doc("EnvironmentType enum ARM_CONTAINER") + ARM_CONTAINER: "ARM_CONTAINER", + + @doc("EnvironmentType enum ARM_LAMBDA_CONTAINER") + ARM_LAMBDA_CONTAINER: "ARM_LAMBDA_CONTAINER", + + @doc("EnvironmentType enum LINUX_CONTAINER") + LINUX_CONTAINER: "LINUX_CONTAINER", + + @doc("EnvironmentType enum LINUX_GPU_CONTAINER") + LINUX_GPU_CONTAINER: "LINUX_GPU_CONTAINER", + + @doc("EnvironmentType enum LINUX_LAMBDA_CONTAINER") + LINUX_LAMBDA_CONTAINER: "LINUX_LAMBDA_CONTAINER", + + @doc("EnvironmentType enum WINDOWS_CONTAINER") + WINDOWS_CONTAINER: "WINDOWS_CONTAINER", + + @doc("EnvironmentType enum WINDOWS_SERVER_2019_CONTAINER") + WINDOWS_SERVER_2019_CONTAINER: "WINDOWS_SERVER_2019_CONTAINER", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnvironmentTypeEnumValue") +model EnvironmentTypeEnumValue { + @doc("Property value") + value?: EnvironmentType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectSourceVersion") +model ProjectSourceVersion { + @doc("<p>An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </p>") + sourceIdentifier?: string; + + @doc("<p>The source version for the corresponding source identifier. If specified, must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub or GitLab: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p> For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'>Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>") + sourceVersion?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectSource") +model ProjectSource { + @doc("<p>Information about the authorization settings for CodeBuild to access the source code to be built.</p> <p>This information is for the CodeBuild console's use only. Your code should not get or set this information directly.</p>") + auth?: SourceAuth; + + @doc("<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>") + buildStatusConfig?: BuildStatusConfig; + + @doc("<p>The buildspec file declaration to use for the builds in this build project.</p> <p> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage'>Buildspec File Name and Storage Location</a>. </p>") + buildspec?: string; + + @doc("<p>Information about the Git clone depth for the build project.</p>") + gitCloneDepth?: int32; + + @doc("<p> Information about the Git submodules configuration for the build project. </p>") + gitSubmodulesConfig?: GitSubmodulesConfig; + + @doc("<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>") + insecureSsl?: boolean; + + @doc("<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name></code>).</p> </li> <li> <p>For source code in an Amazon S3 input bucket, one of the following. </p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code><bucket-name>/<path>/<object-name>.zip</code>). </p> </li> <li> <p>The path to the folder that contains the source code (for example, <code><bucket-name>/<path-to-source-code>/<folder>/</code>). </p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections <b>Authorize application</b> page, choose <b>Authorize</b>. Then on the CodeConnections <b>Create GitLab connection</b> page, choose <b>Connect to GitLab</b>. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the <code>auth</code> object's <code>type</code> value to <code>CODECONNECTIONS</code> in the <code>source</code> object.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul> <p> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </p>") + location?: string; + + @doc("<p> Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html'>Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> <p>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</p>") + reportBuildStatus?: boolean; + + @doc("<p>An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </p>") + sourceIdentifier?: string; + + @doc("<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</p> </li> <li> <p> <code>GITLAB</code>: The source code is in a GitLab repository.</p> </li> <li> <p> <code>GITLAB_SELF_MANAGED</code>: The source code is in a self-managed GitLab repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon S3 bucket.</p> </li> </ul>") + type?: SourceTypeEnumValue; +} + +@doc("SourceType enum") +union SourceType { + @doc("SourceType enum BITBUCKET") + BITBUCKET: "BITBUCKET", + + @doc("SourceType enum CODECOMMIT") + CODECOMMIT: "CODECOMMIT", + + @doc("SourceType enum CODEPIPELINE") + CODEPIPELINE: "CODEPIPELINE", + + @doc("SourceType enum GITHUB") + GITHUB: "GITHUB", + + @doc("SourceType enum GITHUB_ENTERPRISE") + GITHUB_ENTERPRISE: "GITHUB_ENTERPRISE", + + @doc("SourceType enum GITLAB") + GITLAB: "GITLAB", + + @doc("SourceType enum GITLAB_SELF_MANAGED") + GITLAB_SELF_MANAGED: "GITLAB_SELF_MANAGED", + + @doc("SourceType enum NO_SOURCE") + NO_SOURCE: "NO_SOURCE", + + @doc("SourceType enum S3") + S3: "S3", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceTypeEnumValue") +model SourceTypeEnumValue { + @doc("Property value") + value?: SourceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The tag's key.</p>") + key?: string; + + @doc("<p>The tag's value.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VpcConfig") +model VpcConfig { + @doc("<p>A list of one or more security groups IDs in your Amazon VPC.</p>") + @extension("x-ms-identifiers", []) + securityGroupIds?: string[]; + + @doc("<p>A list of one or more subnet IDs in your Amazon VPC.</p>") + @extension("x-ms-identifiers", []) + subnets?: string[]; + + @doc("<p>The ID of the Amazon VPC.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Webhook") +model Webhook { + @doc("<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p>It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>") + branchFilter?: string; + + @doc("<p>Specifies the type of build this webhook will trigger.</p>") + buildType?: WebhookBuildTypeEnumValue; + + @doc("<p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>") + @extension("x-ms-identifiers", []) + filterGroups?: FilterGroup[]; + + @doc("<p>A timestamp that indicates the last time a repository's secret token was modified. </p>") + lastModifiedSecret?: utcDateTime; + + @doc("<p>The CodeBuild endpoint where webhook events are sent.</p>") + payloadUrl?: string; + + @doc("<p>The secret token of the associated repository. </p> <note> <p>A Bitbucket webhook does not support <code>secret</code>. </p> </note>") + secret?: string; + + @doc("<p>The URL to the webhook.</p>") + url?: string; +} + +@doc("WebhookBuildType enum") +union WebhookBuildType { + @doc("WebhookBuildType enum BUILD") + BUILD: "BUILD", + + @doc("WebhookBuildType enum BUILD_BATCH") + BUILD_BATCH: "BUILD_BATCH", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WebhookBuildTypeEnumValue") +model WebhookBuildTypeEnumValue { + @doc("Property value") + value?: WebhookBuildType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BatchRestrictions") +model BatchRestrictions { + @doc("<p>An array of strings that specify the compute types that are allowed for the batch build. See <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build environment compute types</a> in the <i>CodeBuild User Guide</i> for these values. </p>") + @extension("x-ms-identifiers", []) + computeTypesAllowed?: string[]; + + @doc("<p>Specifies the maximum number of builds allowed.</p>") + maximumBuildsAllowed?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnvironmentVariable") +model EnvironmentVariable { + @doc("<p>The name or key of the environment variable.</p>") + name?: string; + + @doc("<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the <code>value</code> of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store'>env/parameter-store</a> in the <i>CodeBuild User Guide</i>.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plain text format. This is the default value.</p> </li> <li> <p> <code>SECRETS_MANAGER</code>: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the <code>value</code> of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager'>env/secrets-manager</a> in the <i>CodeBuild User Guide</i>.</p> </li> </ul>") + type?: EnvironmentVariableTypeEnumValue; + + @doc("<p>The value of the environment variable.</p> <important> <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to store sensitive values, especially Amazon Web Services secret key IDs. <code>PLAINTEXT</code> environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type <code>PARAMETER_STORE</code> or <code>SECRETS_MANAGER</code>. </p> </important>") + value?: string; +} + +@doc("EnvironmentVariableType enum") +union EnvironmentVariableType { + @doc("EnvironmentVariableType enum PARAMETER_STORE") + PARAMETER_STORE: "PARAMETER_STORE", + + @doc("EnvironmentVariableType enum PLAINTEXT") + PLAINTEXT: "PLAINTEXT", + + @doc("EnvironmentVariableType enum SECRETS_MANAGER") + SECRETS_MANAGER: "SECRETS_MANAGER", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnvironmentVariableTypeEnumValue") +model EnvironmentVariableTypeEnumValue { + @doc("Property value") + value?: EnvironmentVariableType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProjectFleet") +model ProjectFleet { + @doc("<p>Specifies the compute fleet ARN for the build project.</p>") + fleetArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RegistryCredential") +model RegistryCredential { + @doc("<p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </p> </note>") + credential?: string; + + @doc("<p> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </p>") + credentialProvider?: CredentialProviderTypeEnumValue; +} + +@doc("CredentialProviderType enum") +union CredentialProviderType { + @doc("CredentialProviderType enum SECRETS_MANAGER") + SECRETS_MANAGER: "SECRETS_MANAGER", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CredentialProviderTypeEnumValue") +model CredentialProviderTypeEnumValue { + @doc("Property value") + value?: CredentialProviderType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CloudWatchLogsConfig") +model CloudWatchLogsConfig { + @doc("<p> The group name of the logs in CloudWatch Logs. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'>Working with Log Groups and Log Streams</a>. </p>") + groupName?: string; + + @doc("<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>") + status?: LogsConfigStatusTypeEnumValue; + + @doc("<p> The prefix of the stream name of the CloudWatch Logs. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'>Working with Log Groups and Log Streams</a>. </p>") + streamName?: string; +} + +@doc("LogsConfigStatusType enum") +union LogsConfigStatusType { + @doc("LogsConfigStatusType enum DISABLED") + DISABLED: "DISABLED", + + @doc("LogsConfigStatusType enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsConfigStatusTypeEnumValue") +model LogsConfigStatusTypeEnumValue { + @doc("Property value") + value?: LogsConfigStatusType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3LogsConfig") +model S3LogsConfig { + @doc("Property bucketOwnerAccess") + bucketOwnerAccess?: BucketOwnerAccessEnumValue; + + @doc("<p> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </p>") + encryptionDisabled?: boolean; + + @doc("<p> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </p>") + location?: string; + + @doc("<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>") + status?: LogsConfigStatusTypeEnumValue; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceAuth") +model SourceAuth { + @doc("<p>The resource value that applies to the specified authorization type.</p>") + resource?: string; + + @doc("<p>The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.</p>") + type?: SourceAuthTypeEnumValue; +} + +@doc("SourceAuthType enum") +union SourceAuthType { + @doc("SourceAuthType enum CODECONNECTIONS") + CODECONNECTIONS: "CODECONNECTIONS", + + @doc("SourceAuthType enum OAUTH") + OAUTH: "OAUTH", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceAuthTypeEnumValue") +model SourceAuthTypeEnumValue { + @doc("Property value") + value?: SourceAuthType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BuildStatusConfig") +model BuildStatusConfig { + @doc("<p>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'>build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'>Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>") + context?: string; + + @doc("<p>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'>build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'>Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>") + targetUrl?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GitSubmodulesConfig") +model GitSubmodulesConfig { + @doc("<p> Set to true to fetch Git submodules for your CodeBuild build project. </p>") + fetchSubmodules?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FilterGroup") +model FilterGroup { + @doc("Property webhookFilter") + webhookFilter?: WebhookFilter; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WebhookFilter") +model WebhookFilter { + @doc("<p> Used to indicate that the <code>pattern</code> determines which webhook events do not trigger a build. If true, then a webhook event that does not match the <code>pattern</code> triggers a build. If false, then a webhook event that matches the <code>pattern</code> triggers a build. </p>") + excludeMatchedPattern?: boolean; + + @doc("<p> For a <code>WebHookFilter</code> that uses <code>EVENT</code> type, a comma-separated string that specifies one or more events. For example, the webhook filter <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request created, and pull request updated events to trigger a build. </p> <p> For a <code>WebHookFilter</code> that uses any of the other filter types, a regular expression pattern. For example, a <code>WebHookFilter</code> that uses <code>HEAD_REF</code> for its <code>type</code> and the pattern <code>^refs/heads/</code> triggers a build when the head reference is a branch with a reference name <code>refs/heads/branch-name</code>. </p>") + pattern?: string; + + @doc("<p> The type of webhook filter. There are nine webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, <code>RELEASE_NAME</code>, and <code>WORKFLOW_NAME</code>. </p> <ul> <li> <p> EVENT </p> <ul> <li> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of nine event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>, <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. The <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code> work with GitHub only.</p> </note> </li> </ul> </li> <li> <p>ACTOR_ACCOUNT_ID</p> <ul> <li> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </li> </ul> </li> <li> <p>HEAD_REF</p> <ul> <li> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p> </note> </li> </ul> </li> <li> <p>BASE_REF</p> <ul> <li> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </li> </ul> </li> <li> <p>FILE_PATH</p> <ul> <li> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>COMMIT_MESSAGE</p> <ul> <li> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>TAG_NAME</p> <ul> <li> <p>A webhook triggers a build when the tag name of the release matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>RELEASE_NAME</p> <ul> <li> <p>A webhook triggers a build when the release name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>WORKFLOW_NAME</p> <ul> <li> <p>A webhook triggers a build when the workflow name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>WORKFLOW_JOB_QUEUED</code> events only. </p> </note> </li> </ul> </li> </ul>") + type?: WebhookFilterTypeEnumValue; +} + +@doc("WebhookFilterType enum") +union WebhookFilterType { + @doc("WebhookFilterType enum ACTOR_ACCOUNT_ID") + ACTOR_ACCOUNT_ID: "ACTOR_ACCOUNT_ID", + + @doc("WebhookFilterType enum BASE_REF") + BASE_REF: "BASE_REF", + + @doc("WebhookFilterType enum COMMIT_MESSAGE") + COMMIT_MESSAGE: "COMMIT_MESSAGE", + + @doc("WebhookFilterType enum EVENT") + EVENT: "EVENT", + + @doc("WebhookFilterType enum FILE_PATH") + FILE_PATH: "FILE_PATH", + + @doc("WebhookFilterType enum HEAD_REF") + HEAD_REF: "HEAD_REF", + + @doc("WebhookFilterType enum RELEASE_NAME") + RELEASE_NAME: "RELEASE_NAME", + + @doc("WebhookFilterType enum TAG_NAME") + TAG_NAME: "TAG_NAME", + + @doc("WebhookFilterType enum WORKFLOW_NAME") + WORKFLOW_NAME: "WORKFLOW_NAME", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WebhookFilterTypeEnumValue") +model WebhookFilterTypeEnumValue { + @doc("Property value") + value?: WebhookFilterType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CodeBuildProjects { + get is ArmResourceRead<CodeBuildProject>; + @doc("Create a CodeBuildProject. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CodeBuildProject>; + update is ArmCustomPatchAsync< + CodeBuildProject, + Azure.ResourceManager.Foundations.TagsUpdateModel<CodeBuildProject> + >; + delete is ArmResourceDeleteWithoutOkAsync<CodeBuildProject>; + listByResourceGroup is ArmResourceListByParent<CodeBuildProject>; + listBySubscription is ArmListBySubscription<CodeBuildProject>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\codeBuild\codebuild-2016-10-06.normal.json +// AWS Shape: Project +// +// Related information for backend service: +// AWS Servcie : CodeBuild +// Product Version : 3.7.798.0 +// SDK Version : 3.7.306.11 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CodeBuildProject.Management/tspconfig.yaml b/specification/awsconnector/CodeBuildProject.Management/tspconfig.yaml new file mode 100644 index 000000000000..a345235b52be --- /dev/null +++ b/specification/awsconnector/CodeBuildProject.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeBuildProject.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_CreateOrReplace.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_CreateOrReplace.json new file mode 100644 index 000000000000..dae255bfc868 --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_CreateOrReplace", + "operationId": "CodeBuildSourceCredentialsInfos_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + } + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + } + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Delete.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Delete.json new file mode 100644 index 000000000000..87cabdec5b1a --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Delete", + "operationId": "CodeBuildSourceCredentialsInfos_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Get.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Get.json new file mode 100644 index 000000000000..f1952a16ec43 --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Get.json @@ -0,0 +1,53 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Get", + "operationId": "CodeBuildSourceCredentialsInfos_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + } + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json new file mode 100644 index 000000000000..d750aa88fd4f --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_ListByResourceGroup", + "operationId": "CodeBuildSourceCredentialsInfos_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + ], + "nextLink": "https://microsoft.com/axwdn" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListBySubscription.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListBySubscription.json new file mode 100644 index 000000000000..ab5df27c0c58 --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_ListBySubscription", + "operationId": "CodeBuildSourceCredentialsInfos_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + ], + "nextLink": "https://microsoft.com/axwdn" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Update.json b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Update.json new file mode 100644 index 000000000000..cd658a993030 --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/examples/2024-12-01/CodeBuildSourceCredentialsInfos_Update.json @@ -0,0 +1,63 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Update", + "operationId": "CodeBuildSourceCredentialsInfos_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7809": "woid" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/main.tsp b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/main.tsp new file mode 100644 index 000000000000..7c71f7bd0edc --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/main.tsp @@ -0,0 +1,178 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- CodeBuildSourceCredentialsInfos ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Code Build Source Credentials Info", + plural: "Code Build Source Credentials Infos", + }, + keywords: [ + "Microsoft.AwsConnector", + "Code", + "Build", + "Source", + "Credentials", + "Info" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model CodeBuildSourceCredentialsInfo + is TrackedResource<CodeBuildSourceCredentialsInfoProperties> { + @doc("Name of CodeBuildSourceCredentialsInfo") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("codeBuildSourceCredentialsInfos") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CodeBuildSourceCredentialsInfo") +model CodeBuildSourceCredentialsInfoProperties { + @doc("AWS Properties") + awsProperties?: AwsCodeBuildSourceCredentialsInfoProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsCodeBuildSourceCredentialsInfo") +model AwsCodeBuildSourceCredentialsInfoProperties { + @doc("<p> The Amazon Resource Name (ARN) of the token. </p>") + arn?: string; + + @doc("<p> The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS. </p>") + authType?: AuthTypeEnumValue; + + @doc("<p>The connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.</p>") + resource?: string; + + @doc("<p> The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET. </p>") + serverType?: ServerTypeEnumValue; +} + +@doc("AuthType enum") +union AuthType { + @doc("AuthType enum BASIC_AUTH") + BASIC_AUTH: "BASIC_AUTH", + + @doc("AuthType enum CODECONNECTIONS") + CODECONNECTIONS: "CODECONNECTIONS", + + @doc("AuthType enum OAUTH") + OAUTH: "OAUTH", + + @doc("AuthType enum PERSONAL_ACCESS_TOKEN") + PERSONAL_ACCESS_TOKEN: "PERSONAL_ACCESS_TOKEN", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthTypeEnumValue") +model AuthTypeEnumValue { + @doc("Property value") + value?: AuthType; +} + +@doc("ServerType enum") +union ServerType { + @doc("ServerType enum BITBUCKET") + BITBUCKET: "BITBUCKET", + + @doc("ServerType enum GITHUB") + GITHUB: "GITHUB", + + @doc("ServerType enum GITHUB_ENTERPRISE") + GITHUB_ENTERPRISE: "GITHUB_ENTERPRISE", + + @doc("ServerType enum GITLAB") + GITLAB: "GITLAB", + + @doc("ServerType enum GITLAB_SELF_MANAGED") + GITLAB_SELF_MANAGED: "GITLAB_SELF_MANAGED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServerTypeEnumValue") +model ServerTypeEnumValue { + @doc("Property value") + value?: ServerType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface CodeBuildSourceCredentialsInfos { + get is ArmResourceRead<CodeBuildSourceCredentialsInfo>; + @doc("Create a CodeBuildSourceCredentialsInfo. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<CodeBuildSourceCredentialsInfo>; + update is ArmCustomPatchAsync< + CodeBuildSourceCredentialsInfo, + Azure.ResourceManager.Foundations.TagsUpdateModel<CodeBuildSourceCredentialsInfo> + >; + delete is ArmResourceDeleteWithoutOkAsync<CodeBuildSourceCredentialsInfo>; + listByResourceGroup is ArmResourceListByParent<CodeBuildSourceCredentialsInfo>; + listBySubscription is ArmListBySubscription<CodeBuildSourceCredentialsInfo>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\codeBuild\codebuild-2016-10-06.normal.json +// AWS Shape: SourceCredentialsInfo +// +// Related information for backend service: +// AWS Servcie : CodeBuild +// Product Version : 3.7.798.0 +// SDK Version : 3.7.306.11 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/tspconfig.yaml b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/tspconfig.yaml new file mode 100644 index 000000000000..0a7c57412b93 --- /dev/null +++ b/specification/awsconnector/CodeBuildSourceCredentialsInfo.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/codeBuildSourceCredentialsInfo.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_CreateOrReplace.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_CreateOrReplace.json new file mode 100644 index 000000000000..b656543c61d1 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_CreateOrReplace.json @@ -0,0 +1,205 @@ +{ + "title": "ConfigServiceConfigurationRecorders_CreateOrReplace", + "operationId": "ConfigServiceConfigurationRecorders_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + } + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Delete.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Delete.json new file mode 100644 index 000000000000..0db75e6cf334 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Delete", + "operationId": "ConfigServiceConfigurationRecorders_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Get.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Get.json new file mode 100644 index 000000000000..3ddcdfcf347f --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Get.json @@ -0,0 +1,80 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Get", + "operationId": "ConfigServiceConfigurationRecorders_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListByResourceGroup.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListByResourceGroup.json new file mode 100644 index 000000000000..61e269e00e06 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListByResourceGroup.json @@ -0,0 +1,84 @@ +{ + "title": "ConfigServiceConfigurationRecorders_ListByResourceGroup", + "operationId": "ConfigServiceConfigurationRecorders_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListBySubscription.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListBySubscription.json new file mode 100644 index 000000000000..15997e14fa58 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_ListBySubscription.json @@ -0,0 +1,83 @@ +{ + "title": "ConfigServiceConfigurationRecorders_ListBySubscription", + "operationId": "ConfigServiceConfigurationRecorders_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Update.json b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Update.json new file mode 100644 index 000000000000..6abf8635e109 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/examples/2024-12-01/ConfigServiceConfigurationRecorders_Update.json @@ -0,0 +1,90 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Update", + "operationId": "ConfigServiceConfigurationRecorders_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key455": "tocjreejshcvi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/main.tsp b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/main.tsp new file mode 100644 index 000000000000..b4a8825fcb8e --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/main.tsp @@ -0,0 +1,1476 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ConfigServiceConfigurationRecorders ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Config Service Configuration Recorder", + plural: "Config Service Configuration Recorders", + }, + keywords: [ + "Microsoft.AwsConnector", + "Config ", + "Service", + "Configuration", + "Recorder" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ConfigServiceConfigurationRecorder + is TrackedResource<ConfigServiceConfigurationRecorderProperties> { + @doc("Name of ConfigServiceConfigurationRecorder") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("configServiceConfigurationRecorders") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigServiceConfigurationRecorder") +model ConfigServiceConfigurationRecorderProperties { + @doc("AWS Properties") + awsProperties?: AwsConfigServiceConfigurationRecorderProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsConfigServiceConfigurationRecorder") +model AwsConfigServiceConfigurationRecorderProperties { + @doc("<p>The name of the configuration recorder. Config automatically assigns the name of 'default' when creating the configuration recorder.</p> <note> <p>You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. </p> </note>") + name?: string; + + @doc("<p>Specifies which resource types Config records for configuration changes.</p> <note> <p> <b> High Number of Config Evaluations</b> </p> <p>You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.</p> <p>If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An <i>ephemeral workload</i> is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.</p> </note>") + recordingGroup?: RecordingGroup; + + @doc("<p>Specifies the default recording frequency that Config uses to record configuration changes. Config supports <i>Continuous recording</i> and <i>Daily recording</i>.</p> <ul> <li> <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p> </li> <li> <p>Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. </p> </li> </ul> <note> <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.</p> </note> <p>You can also override the recording frequency for specific resource types.</p>") + recordingMode?: RecordingMode; + + @doc("<p>Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.</p> <note> <p>While the API model does not require this field, the server will reject a request without a defined <code>roleARN</code> for the configuration recorder.</p> </note> <note> <p> <b>Pre-existing Config role</b> </p> <p>If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected. </p> <p>For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html'> <b>Identity and Access Management for Config</b> </a> in the <i>Config Developer Guide</i>. </p> </note>") + roleARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingGroup") +model RecordingGroup { + @doc("<p>Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.</p> <p>If you set this field to <code>true</code>, when Config adds support for a new resource type, Config starts recording resources of that type automatically.</p> <p>If you set this field to <code>true</code>, you cannot enumerate specific resource types to record in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>, or to exclude in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> <note> <p> <b>Region availability</b> </p> <p>Check <a href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'>Resource Coverage by Region Availability</a> to see if a resource type is supported in the Amazon Web Services Region where you set up Config.</p> </note>") + allSupported?: boolean; + + @doc("<p>An object that specifies how Config excludes resource types from being recorded by the configuration recorder.</p> <note> <p> <b>Required fields</b> </p> <p>To use this option, you must set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>.</p> </note>") + exclusionByResourceTypes?: ExclusionByResourceTypes; + + @doc("<p>This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> <important> <p> <b>Aurora global clusters are recorded in all enabled Regions</b> </p> <p>The <code>AWS::RDS::GlobalCluster</code> resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if <code>includeGlobalResourceTypes</code> is set<code>false</code>. The <code>includeGlobalResourceTypes</code> option is a bundle which only applies to IAM users, groups, roles, and customer managed policies. </p> <p>If you do not want to record <code>AWS::RDS::GlobalCluster</code> in all enabled Regions, use one of the following recording strategies:</p> <ol> <li> <p> <b>Record all current and future resource types with exclusions</b> (<code>EXCLUSION_BY_RESOURCE_TYPES</code>), or</p> </li> <li> <p> <b>Record specific resource types</b> (<code>INCLUSION_BY_RESOURCE_TYPES</code>).</p> </li> </ol> <p>For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all'>Selecting Which Resources are Recorded</a> in the <i>Config developer guide</i>.</p> </important> <important> <p> <b>includeGlobalResourceTypes and the exclusion recording strategy</b> </p> <p>The <code>includeGlobalResourceTypes</code> field has no impact on the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for <code>exclusionByResourceTypes</code> when <code>includeGlobalResourceTypes</code> is set to <code>false</code>.</p> <p>The <code>includeGlobalResourceTypes</code> field should only be used to modify the <code>AllSupported</code> field, as the default for the <code>AllSupported</code> field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when <code>AllSupported</code> is set to <code>true</code>, make sure to set <code>includeGlobalResourceTypes</code> to <code>true</code>.</p> <p>To exclude the global IAM resource types for the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, you need to manually add them to the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </important> <note> <p> <b>Required and optional fields</b> </p> <p>Before you set this field to <code>true</code>, set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. Optionally, you can set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you set this field to <code>false</code> but list global IAM resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>, Config will still record configuration changes for those specified resource types <i>regardless</i> of if you set the <code>includeGlobalResourceTypes</code> field to false.</p> <p>If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the <code>resourceTypes</code> field in addition to setting the <code>includeGlobalResourceTypes</code> field to false.</p> </note>") + includeGlobalResourceTypes?: boolean; + + @doc("<p>An object that specifies the recording strategy for the configuration recorder.</p> <ul> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. When Config adds support for a new resource type, Config automatically starts recording resources of that type.</p> </li> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for only the resource types you specify in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> </li> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </li> </ul> <note> <p> <b>Required and optional fields</b> </p> <p>The <code>recordingStrategy</code> field is optional when you set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>.</p> <p>The <code>recordingStrategy</code> field is optional when you list resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p> <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </note> <note> <p> <b>Global resources types and the resource exclusion recording strategy</b> </p> <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.</p> <p>Unless specifically listed as exclusions, <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p> <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> </note>") + recordingStrategy?: RecordingStrategy; + + @doc("<p>A comma-separated list that specifies which resource types Config records.</p> <p>For a list of valid <code>resourceTypes</code> values, see the <b>Resource Type Value</b> column in <a href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'>Supported Amazon Web Services resource Types</a> in the <i>Config developer guide</i>.</p> <note> <p> <b>Required and optional fields</b> </p> <p>Optionally, you can set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>.</p> <p>To record all configuration changes, set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>, and either omit this field or don't specify any resource types in this field. If you set the <code>allSupported</code> field to <code>false</code> and specify values for <code>resourceTypes</code>, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.</p> </note> <note> <p> <b>Region availability</b> </p> <p>Before specifying a resource type for Config to track, check <a href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'>Resource Coverage by Region Availability</a> to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.</p> </note>") + @extension("x-ms-identifiers", []) + resourceTypes?: ResourceType[]; +} + +@doc("ResourceType enum") +union ResourceType { + @doc("ResourceType enum AWS::ACM::Certificate") + AWSACMCertificate: "AWS::ACM::Certificate", + + @doc("ResourceType enum AWS::ACMPCA::CertificateAuthority") + AWSACMPCACertificateAuthority: "AWS::ACMPCA::CertificateAuthority", + + @doc("ResourceType enum AWS::ACMPCA::CertificateAuthorityActivation") + AWSACMPCACertificateAuthorityActivation: "AWS::ACMPCA::CertificateAuthorityActivation", + + @doc("ResourceType enum AWS::APS::RuleGroupsNamespace") + AWSAPSRuleGroupsNamespace: "AWS::APS::RuleGroupsNamespace", + + @doc("ResourceType enum AWS::AccessAnalyzer::Analyzer") + AWSAccessAnalyzerAnalyzer: "AWS::AccessAnalyzer::Analyzer", + + @doc("ResourceType enum AWS::AmazonMQ::Broker") + AWSAmazonMQBroker: "AWS::AmazonMQ::Broker", + + @doc("ResourceType enum AWS::Amplify::App") + AWSAmplifyApp: "AWS::Amplify::App", + + @doc("ResourceType enum AWS::Amplify::Branch") + AWSAmplifyBranch: "AWS::Amplify::Branch", + + @doc("ResourceType enum AWS::ApiGateway::RestApi") + AWSApiGatewayRestApi: "AWS::ApiGateway::RestApi", + + @doc("ResourceType enum AWS::ApiGateway::Stage") + AWSApiGatewayStage: "AWS::ApiGateway::Stage", + + @doc("ResourceType enum AWS::ApiGatewayV2::Api") + AWSApiGatewayV2Api: "AWS::ApiGatewayV2::Api", + + @doc("ResourceType enum AWS::ApiGatewayV2::Stage") + AWSApiGatewayV2Stage: "AWS::ApiGatewayV2::Stage", + + @doc("ResourceType enum AWS::AppConfig::Application") + AWSAppConfigApplication: "AWS::AppConfig::Application", + + @doc("ResourceType enum AWS::AppConfig::ConfigurationProfile") + AWSAppConfigConfigurationProfile: "AWS::AppConfig::ConfigurationProfile", + + @doc("ResourceType enum AWS::AppConfig::DeploymentStrategy") + AWSAppConfigDeploymentStrategy: "AWS::AppConfig::DeploymentStrategy", + + @doc("ResourceType enum AWS::AppConfig::Environment") + AWSAppConfigEnvironment: "AWS::AppConfig::Environment", + + @doc("ResourceType enum AWS::AppConfig::HostedConfigurationVersion") + AWSAppConfigHostedConfigurationVersion: "AWS::AppConfig::HostedConfigurationVersion", + + @doc("ResourceType enum AWS::AppFlow::Flow") + AWSAppFlowFlow: "AWS::AppFlow::Flow", + + @doc("ResourceType enum AWS::AppIntegrations::EventIntegration") + AWSAppIntegrationsEventIntegration: "AWS::AppIntegrations::EventIntegration", + + @doc("ResourceType enum AWS::AppMesh::GatewayRoute") + AWSAppMeshGatewayRoute: "AWS::AppMesh::GatewayRoute", + + @doc("ResourceType enum AWS::AppMesh::Mesh") + AWSAppMeshMesh: "AWS::AppMesh::Mesh", + + @doc("ResourceType enum AWS::AppMesh::Route") + AWSAppMeshRoute: "AWS::AppMesh::Route", + + @doc("ResourceType enum AWS::AppMesh::VirtualGateway") + AWSAppMeshVirtualGateway: "AWS::AppMesh::VirtualGateway", + + @doc("ResourceType enum AWS::AppMesh::VirtualNode") + AWSAppMeshVirtualNode: "AWS::AppMesh::VirtualNode", + + @doc("ResourceType enum AWS::AppMesh::VirtualRouter") + AWSAppMeshVirtualRouter: "AWS::AppMesh::VirtualRouter", + + @doc("ResourceType enum AWS::AppMesh::VirtualService") + AWSAppMeshVirtualService: "AWS::AppMesh::VirtualService", + + @doc("ResourceType enum AWS::AppRunner::Service") + AWSAppRunnerService: "AWS::AppRunner::Service", + + @doc("ResourceType enum AWS::AppRunner::VpcConnector") + AWSAppRunnerVpcConnector: "AWS::AppRunner::VpcConnector", + + @doc("ResourceType enum AWS::AppStream::Application") + AWSAppStreamApplication: "AWS::AppStream::Application", + + @doc("ResourceType enum AWS::AppStream::DirectoryConfig") + AWSAppStreamDirectoryConfig: "AWS::AppStream::DirectoryConfig", + + @doc("ResourceType enum AWS::AppStream::Fleet") + AWSAppStreamFleet: "AWS::AppStream::Fleet", + + @doc("ResourceType enum AWS::AppStream::Stack") + AWSAppStreamStack: "AWS::AppStream::Stack", + + @doc("ResourceType enum AWS::AppSync::GraphQLApi") + AWSAppSyncGraphQLApi: "AWS::AppSync::GraphQLApi", + + @doc("ResourceType enum AWS::Athena::DataCatalog") + AWSAthenaDataCatalog: "AWS::Athena::DataCatalog", + + @doc("ResourceType enum AWS::Athena::PreparedStatement") + AWSAthenaPreparedStatement: "AWS::Athena::PreparedStatement", + + @doc("ResourceType enum AWS::Athena::WorkGroup") + AWSAthenaWorkGroup: "AWS::Athena::WorkGroup", + + @doc("ResourceType enum AWS::AuditManager::Assessment") + AWSAuditManagerAssessment: "AWS::AuditManager::Assessment", + + @doc("ResourceType enum AWS::AutoScaling::AutoScalingGroup") + AWSAutoScalingAutoScalingGroup: "AWS::AutoScaling::AutoScalingGroup", + + @doc("ResourceType enum AWS::AutoScaling::LaunchConfiguration") + AWSAutoScalingLaunchConfiguration: "AWS::AutoScaling::LaunchConfiguration", + + @doc("ResourceType enum AWS::AutoScaling::ScalingPolicy") + AWSAutoScalingScalingPolicy: "AWS::AutoScaling::ScalingPolicy", + + @doc("ResourceType enum AWS::AutoScaling::ScheduledAction") + AWSAutoScalingScheduledAction: "AWS::AutoScaling::ScheduledAction", + + @doc("ResourceType enum AWS::AutoScaling::WarmPool") + AWSAutoScalingWarmPool: "AWS::AutoScaling::WarmPool", + + @doc("ResourceType enum AWS::Backup::BackupPlan") + AWSBackupBackupPlan: "AWS::Backup::BackupPlan", + + @doc("ResourceType enum AWS::Backup::BackupSelection") + AWSBackupBackupSelection: "AWS::Backup::BackupSelection", + + @doc("ResourceType enum AWS::Backup::BackupVault") + AWSBackupBackupVault: "AWS::Backup::BackupVault", + + @doc("ResourceType enum AWS::Backup::RecoveryPoint") + AWSBackupRecoveryPoint: "AWS::Backup::RecoveryPoint", + + @doc("ResourceType enum AWS::Backup::ReportPlan") + AWSBackupReportPlan: "AWS::Backup::ReportPlan", + + @doc("ResourceType enum AWS::Batch::ComputeEnvironment") + AWSBatchComputeEnvironment: "AWS::Batch::ComputeEnvironment", + + @doc("ResourceType enum AWS::Batch::JobQueue") + AWSBatchJobQueue: "AWS::Batch::JobQueue", + + @doc("ResourceType enum AWS::Batch::SchedulingPolicy") + AWSBatchSchedulingPolicy: "AWS::Batch::SchedulingPolicy", + + @doc("ResourceType enum AWS::Budgets::BudgetsAction") + AWSBudgetsBudgetsAction: "AWS::Budgets::BudgetsAction", + + @doc("ResourceType enum AWS::Cassandra::Keyspace") + AWSCassandraKeyspace: "AWS::Cassandra::Keyspace", + + @doc("ResourceType enum AWS::Cloud9::EnvironmentEC2") + AWSCloud9EnvironmentEC2: "AWS::Cloud9::EnvironmentEC2", + + @doc("ResourceType enum AWS::CloudFormation::Stack") + AWSCloudFormationStack: "AWS::CloudFormation::Stack", + + @doc("ResourceType enum AWS::CloudFront::Distribution") + AWSCloudFrontDistribution: "AWS::CloudFront::Distribution", + + @doc("ResourceType enum AWS::CloudFront::StreamingDistribution") + AWSCloudFrontStreamingDistribution: "AWS::CloudFront::StreamingDistribution", + + @doc("ResourceType enum AWS::CloudTrail::Trail") + AWSCloudTrailTrail: "AWS::CloudTrail::Trail", + + @doc("ResourceType enum AWS::CloudWatch::Alarm") + AWSCloudWatchAlarm: "AWS::CloudWatch::Alarm", + + @doc("ResourceType enum AWS::CloudWatch::MetricStream") + AWSCloudWatchMetricStream: "AWS::CloudWatch::MetricStream", + + @doc("ResourceType enum AWS::CodeArtifact::Repository") + AWSCodeArtifactRepository: "AWS::CodeArtifact::Repository", + + @doc("ResourceType enum AWS::CodeBuild::Project") + AWSCodeBuildProject: "AWS::CodeBuild::Project", + + @doc("ResourceType enum AWS::CodeBuild::ReportGroup") + AWSCodeBuildReportGroup: "AWS::CodeBuild::ReportGroup", + + @doc("ResourceType enum AWS::CodeDeploy::Application") + AWSCodeDeployApplication: "AWS::CodeDeploy::Application", + + @doc("ResourceType enum AWS::CodeDeploy::DeploymentConfig") + AWSCodeDeployDeploymentConfig: "AWS::CodeDeploy::DeploymentConfig", + + @doc("ResourceType enum AWS::CodeDeploy::DeploymentGroup") + AWSCodeDeployDeploymentGroup: "AWS::CodeDeploy::DeploymentGroup", + + @doc("ResourceType enum AWS::CodeGuruProfiler::ProfilingGroup") + AWSCodeGuruProfilerProfilingGroup: "AWS::CodeGuruProfiler::ProfilingGroup", + + @doc("ResourceType enum AWS::CodeGuruReviewer::RepositoryAssociation") + AWSCodeGuruReviewerRepositoryAssociation: "AWS::CodeGuruReviewer::RepositoryAssociation", + + @doc("ResourceType enum AWS::CodePipeline::Pipeline") + AWSCodePipelinePipeline: "AWS::CodePipeline::Pipeline", + + @doc("ResourceType enum AWS::Cognito::UserPool") + AWSCognitoUserPool: "AWS::Cognito::UserPool", + + @doc("ResourceType enum AWS::Cognito::UserPoolClient") + AWSCognitoUserPoolClient: "AWS::Cognito::UserPoolClient", + + @doc("ResourceType enum AWS::Cognito::UserPoolGroup") + AWSCognitoUserPoolGroup: "AWS::Cognito::UserPoolGroup", + + @doc("ResourceType enum AWS::Config::ConformancePackCompliance") + AWSConfigConformancePackCompliance: "AWS::Config::ConformancePackCompliance", + + @doc("ResourceType enum AWS::Config::ResourceCompliance") + AWSConfigResourceCompliance: "AWS::Config::ResourceCompliance", + + @doc("ResourceType enum AWS::Connect::Instance") + AWSConnectInstance: "AWS::Connect::Instance", + + @doc("ResourceType enum AWS::Connect::PhoneNumber") + AWSConnectPhoneNumber: "AWS::Connect::PhoneNumber", + + @doc("ResourceType enum AWS::Connect::QuickConnect") + AWSConnectQuickConnect: "AWS::Connect::QuickConnect", + + @doc("ResourceType enum AWS::CustomerProfiles::Domain") + AWSCustomerProfilesDomain: "AWS::CustomerProfiles::Domain", + + @doc("ResourceType enum AWS::CustomerProfiles::ObjectType") + AWSCustomerProfilesObjectType: "AWS::CustomerProfiles::ObjectType", + + @doc("ResourceType enum AWS::DMS::Certificate") + AWSDMSCertificate: "AWS::DMS::Certificate", + + @doc("ResourceType enum AWS::DMS::Endpoint") + AWSDMSEndpoint: "AWS::DMS::Endpoint", + + @doc("ResourceType enum AWS::DMS::EventSubscription") + AWSDMSEventSubscription: "AWS::DMS::EventSubscription", + + @doc("ResourceType enum AWS::DMS::ReplicationSubnetGroup") + AWSDMSReplicationSubnetGroup: "AWS::DMS::ReplicationSubnetGroup", + + @doc("ResourceType enum AWS::DataSync::LocationEFS") + AWSDataSyncLocationEFS: "AWS::DataSync::LocationEFS", + + @doc("ResourceType enum AWS::DataSync::LocationFSxLustre") + AWSDataSyncLocationFSxLustre: "AWS::DataSync::LocationFSxLustre", + + @doc("ResourceType enum AWS::DataSync::LocationFSxWindows") + AWSDataSyncLocationFSxWindows: "AWS::DataSync::LocationFSxWindows", + + @doc("ResourceType enum AWS::DataSync::LocationHDFS") + AWSDataSyncLocationHDFS: "AWS::DataSync::LocationHDFS", + + @doc("ResourceType enum AWS::DataSync::LocationNFS") + AWSDataSyncLocationNFS: "AWS::DataSync::LocationNFS", + + @doc("ResourceType enum AWS::DataSync::LocationObjectStorage") + AWSDataSyncLocationObjectStorage: "AWS::DataSync::LocationObjectStorage", + + @doc("ResourceType enum AWS::DataSync::LocationS3") + AWSDataSyncLocationS3: "AWS::DataSync::LocationS3", + + @doc("ResourceType enum AWS::DataSync::LocationSMB") + AWSDataSyncLocationSMB: "AWS::DataSync::LocationSMB", + + @doc("ResourceType enum AWS::DataSync::Task") + AWSDataSyncTask: "AWS::DataSync::Task", + + @doc("ResourceType enum AWS::Detective::Graph") + AWSDetectiveGraph: "AWS::Detective::Graph", + + @doc("ResourceType enum AWS::DeviceFarm::InstanceProfile") + AWSDeviceFarmInstanceProfile: "AWS::DeviceFarm::InstanceProfile", + + @doc("ResourceType enum AWS::DeviceFarm::Project") + AWSDeviceFarmProject: "AWS::DeviceFarm::Project", + + @doc("ResourceType enum AWS::DeviceFarm::TestGridProject") + AWSDeviceFarmTestGridProject: "AWS::DeviceFarm::TestGridProject", + + @doc("ResourceType enum AWS::DynamoDB::Table") + AWSDynamoDBTable: "AWS::DynamoDB::Table", + + @doc("ResourceType enum AWS::EC2::CapacityReservation") + AWSEC2CapacityReservation: "AWS::EC2::CapacityReservation", + + @doc("ResourceType enum AWS::EC2::CarrierGateway") + AWSEC2CarrierGateway: "AWS::EC2::CarrierGateway", + + @doc("ResourceType enum AWS::EC2::ClientVpnEndpoint") + AWSEC2ClientVpnEndpoint: "AWS::EC2::ClientVpnEndpoint", + + @doc("ResourceType enum AWS::EC2::CustomerGateway") + AWSEC2CustomerGateway: "AWS::EC2::CustomerGateway", + + @doc("ResourceType enum AWS::EC2::DHCPOptions") + AWSEC2DHCPOptions: "AWS::EC2::DHCPOptions", + + @doc("ResourceType enum AWS::EC2::EC2Fleet") + AWSEC2EC2Fleet: "AWS::EC2::EC2Fleet", + + @doc("ResourceType enum AWS::EC2::EIP") + AWSEC2EIP: "AWS::EC2::EIP", + + @doc("ResourceType enum AWS::EC2::EgressOnlyInternetGateway") + AWSEC2EgressOnlyInternetGateway: "AWS::EC2::EgressOnlyInternetGateway", + + @doc("ResourceType enum AWS::EC2::FlowLog") + AWSEC2FlowLog: "AWS::EC2::FlowLog", + + @doc("ResourceType enum AWS::EC2::Host") + AWSEC2Host: "AWS::EC2::Host", + + @doc("ResourceType enum AWS::EC2::IPAM") + AWSEC2IPAM: "AWS::EC2::IPAM", + + @doc("ResourceType enum AWS::EC2::IPAMPool") + AWSEC2IPAMPool: "AWS::EC2::IPAMPool", + + @doc("ResourceType enum AWS::EC2::IPAMScope") + AWSEC2IPAMScope: "AWS::EC2::IPAMScope", + + @doc("ResourceType enum AWS::EC2::Instance") + AWSEC2Instance: "AWS::EC2::Instance", + + @doc("ResourceType enum AWS::EC2::InternetGateway") + AWSEC2InternetGateway: "AWS::EC2::InternetGateway", + + @doc("ResourceType enum AWS::EC2::LaunchTemplate") + AWSEC2LaunchTemplate: "AWS::EC2::LaunchTemplate", + + @doc("ResourceType enum AWS::EC2::NatGateway") + AWSEC2NatGateway: "AWS::EC2::NatGateway", + + @doc("ResourceType enum AWS::EC2::NetworkAcl") + AWSEC2NetworkAcl: "AWS::EC2::NetworkAcl", + + @doc("ResourceType enum AWS::EC2::NetworkInsightsAccessScope") + AWSEC2NetworkInsightsAccessScope: "AWS::EC2::NetworkInsightsAccessScope", + + @doc("ResourceType enum AWS::EC2::NetworkInsightsAccessScopeAnalysis") + AWSEC2NetworkInsightsAccessScopeAnalysis: "AWS::EC2::NetworkInsightsAccessScopeAnalysis", + + @doc("ResourceType enum AWS::EC2::NetworkInsightsAnalysis") + AWSEC2NetworkInsightsAnalysis: "AWS::EC2::NetworkInsightsAnalysis", + + @doc("ResourceType enum AWS::EC2::NetworkInsightsPath") + AWSEC2NetworkInsightsPath: "AWS::EC2::NetworkInsightsPath", + + @doc("ResourceType enum AWS::EC2::NetworkInterface") + AWSEC2NetworkInterface: "AWS::EC2::NetworkInterface", + + @doc("ResourceType enum AWS::EC2::PrefixList") + AWSEC2PrefixList: "AWS::EC2::PrefixList", + + @doc("ResourceType enum AWS::EC2::RegisteredHAInstance") + AWSEC2RegisteredHAInstance: "AWS::EC2::RegisteredHAInstance", + + @doc("ResourceType enum AWS::EC2::RouteTable") + AWSEC2RouteTable: "AWS::EC2::RouteTable", + + @doc("ResourceType enum AWS::EC2::SecurityGroup") + AWSEC2SecurityGroup: "AWS::EC2::SecurityGroup", + + @doc("ResourceType enum AWS::EC2::SpotFleet") + AWSEC2SpotFleet: "AWS::EC2::SpotFleet", + + @doc("ResourceType enum AWS::EC2::Subnet") + AWSEC2Subnet: "AWS::EC2::Subnet", + + @doc("ResourceType enum AWS::EC2::SubnetRouteTableAssociation") + AWSEC2SubnetRouteTableAssociation: "AWS::EC2::SubnetRouteTableAssociation", + + @doc("ResourceType enum AWS::EC2::TrafficMirrorFilter") + AWSEC2TrafficMirrorFilter: "AWS::EC2::TrafficMirrorFilter", + + @doc("ResourceType enum AWS::EC2::TrafficMirrorSession") + AWSEC2TrafficMirrorSession: "AWS::EC2::TrafficMirrorSession", + + @doc("ResourceType enum AWS::EC2::TrafficMirrorTarget") + AWSEC2TrafficMirrorTarget: "AWS::EC2::TrafficMirrorTarget", + + @doc("ResourceType enum AWS::EC2::TransitGateway") + AWSEC2TransitGateway: "AWS::EC2::TransitGateway", + + @doc("ResourceType enum AWS::EC2::TransitGatewayAttachment") + AWSEC2TransitGatewayAttachment: "AWS::EC2::TransitGatewayAttachment", + + @doc("ResourceType enum AWS::EC2::TransitGatewayConnect") + AWSEC2TransitGatewayConnect: "AWS::EC2::TransitGatewayConnect", + + @doc("ResourceType enum AWS::EC2::TransitGatewayMulticastDomain") + AWSEC2TransitGatewayMulticastDomain: "AWS::EC2::TransitGatewayMulticastDomain", + + @doc("ResourceType enum AWS::EC2::TransitGatewayRouteTable") + AWSEC2TransitGatewayRouteTable: "AWS::EC2::TransitGatewayRouteTable", + + @doc("ResourceType enum AWS::EC2::VPC") + AWSEC2VPC: "AWS::EC2::VPC", + + @doc("ResourceType enum AWS::EC2::VPCEndpoint") + AWSEC2VPCEndpoint: "AWS::EC2::VPCEndpoint", + + @doc("ResourceType enum AWS::EC2::VPCEndpointService") + AWSEC2VPCEndpointService: "AWS::EC2::VPCEndpointService", + + @doc("ResourceType enum AWS::EC2::VPCPeeringConnection") + AWSEC2VPCPeeringConnection: "AWS::EC2::VPCPeeringConnection", + + @doc("ResourceType enum AWS::EC2::VPNConnection") + AWSEC2VPNConnection: "AWS::EC2::VPNConnection", + + @doc("ResourceType enum AWS::EC2::VPNGateway") + AWSEC2VPNGateway: "AWS::EC2::VPNGateway", + + @doc("ResourceType enum AWS::EC2::Volume") + AWSEC2Volume: "AWS::EC2::Volume", + + @doc("ResourceType enum AWS::ECR::PublicRepository") + AWSECRPublicRepository: "AWS::ECR::PublicRepository", + + @doc("ResourceType enum AWS::ECR::PullThroughCacheRule") + AWSECRPullThroughCacheRule: "AWS::ECR::PullThroughCacheRule", + + @doc("ResourceType enum AWS::ECR::RegistryPolicy") + AWSECRRegistryPolicy: "AWS::ECR::RegistryPolicy", + + @doc("ResourceType enum AWS::ECR::Repository") + AWSECRRepository: "AWS::ECR::Repository", + + @doc("ResourceType enum AWS::ECS::CapacityProvider") + AWSECSCapacityProvider: "AWS::ECS::CapacityProvider", + + @doc("ResourceType enum AWS::ECS::Cluster") + AWSECSCluster: "AWS::ECS::Cluster", + + @doc("ResourceType enum AWS::ECS::Service") + AWSECSService: "AWS::ECS::Service", + + @doc("ResourceType enum AWS::ECS::TaskDefinition") + AWSECSTaskDefinition: "AWS::ECS::TaskDefinition", + + @doc("ResourceType enum AWS::ECS::TaskSet") + AWSECSTaskSet: "AWS::ECS::TaskSet", + + @doc("ResourceType enum AWS::EFS::AccessPoint") + AWSEFSAccessPoint: "AWS::EFS::AccessPoint", + + @doc("ResourceType enum AWS::EFS::FileSystem") + AWSEFSFileSystem: "AWS::EFS::FileSystem", + + @doc("ResourceType enum AWS::EKS::Addon") + AWSEKSAddon: "AWS::EKS::Addon", + + @doc("ResourceType enum AWS::EKS::Cluster") + AWSEKSCluster: "AWS::EKS::Cluster", + + @doc("ResourceType enum AWS::EKS::FargateProfile") + AWSEKSFargateProfile: "AWS::EKS::FargateProfile", + + @doc("ResourceType enum AWS::EKS::IdentityProviderConfig") + AWSEKSIdentityProviderConfig: "AWS::EKS::IdentityProviderConfig", + + @doc("ResourceType enum AWS::EMR::SecurityConfiguration") + AWSEMRSecurityConfiguration: "AWS::EMR::SecurityConfiguration", + + @doc("ResourceType enum AWS::ElasticBeanstalk::Application") + AWSElasticBeanstalkApplication: "AWS::ElasticBeanstalk::Application", + + @doc("ResourceType enum AWS::ElasticBeanstalk::ApplicationVersion") + AWSElasticBeanstalkApplicationVersion: "AWS::ElasticBeanstalk::ApplicationVersion", + + @doc("ResourceType enum AWS::ElasticBeanstalk::Environment") + AWSElasticBeanstalkEnvironment: "AWS::ElasticBeanstalk::Environment", + + @doc("ResourceType enum AWS::ElasticLoadBalancing::LoadBalancer") + AWSElasticLoadBalancingLoadBalancer: "AWS::ElasticLoadBalancing::LoadBalancer", + + @doc("ResourceType enum AWS::ElasticLoadBalancingV2::Listener") + AWSElasticLoadBalancingV2Listener: "AWS::ElasticLoadBalancingV2::Listener", + + @doc("ResourceType enum AWS::ElasticLoadBalancingV2::LoadBalancer") + AWSElasticLoadBalancingV2LoadBalancer: "AWS::ElasticLoadBalancingV2::LoadBalancer", + + @doc("ResourceType enum AWS::Elasticsearch::Domain") + AWSElasticsearchDomain: "AWS::Elasticsearch::Domain", + + @doc("ResourceType enum AWS::EventSchemas::Discoverer") + AWSEventSchemasDiscoverer: "AWS::EventSchemas::Discoverer", + + @doc("ResourceType enum AWS::EventSchemas::Registry") + AWSEventSchemasRegistry: "AWS::EventSchemas::Registry", + + @doc("ResourceType enum AWS::EventSchemas::RegistryPolicy") + AWSEventSchemasRegistryPolicy: "AWS::EventSchemas::RegistryPolicy", + + @doc("ResourceType enum AWS::EventSchemas::Schema") + AWSEventSchemasSchema: "AWS::EventSchemas::Schema", + + @doc("ResourceType enum AWS::Events::ApiDestination") + AWSEventsApiDestination: "AWS::Events::ApiDestination", + + @doc("ResourceType enum AWS::Events::Archive") + AWSEventsArchive: "AWS::Events::Archive", + + @doc("ResourceType enum AWS::Events::Connection") + AWSEventsConnection: "AWS::Events::Connection", + + @doc("ResourceType enum AWS::Events::Endpoint") + AWSEventsEndpoint: "AWS::Events::Endpoint", + + @doc("ResourceType enum AWS::Events::EventBus") + AWSEventsEventBus: "AWS::Events::EventBus", + + @doc("ResourceType enum AWS::Events::Rule") + AWSEventsRule: "AWS::Events::Rule", + + @doc("ResourceType enum AWS::Evidently::Launch") + AWSEvidentlyLaunch: "AWS::Evidently::Launch", + + @doc("ResourceType enum AWS::Evidently::Project") + AWSEvidentlyProject: "AWS::Evidently::Project", + + @doc("ResourceType enum AWS::FIS::ExperimentTemplate") + AWSFISExperimentTemplate: "AWS::FIS::ExperimentTemplate", + + @doc("ResourceType enum AWS::Forecast::Dataset") + AWSForecastDataset: "AWS::Forecast::Dataset", + + @doc("ResourceType enum AWS::Forecast::DatasetGroup") + AWSForecastDatasetGroup: "AWS::Forecast::DatasetGroup", + + @doc("ResourceType enum AWS::FraudDetector::EntityType") + AWSFraudDetectorEntityType: "AWS::FraudDetector::EntityType", + + @doc("ResourceType enum AWS::FraudDetector::Label") + AWSFraudDetectorLabel: "AWS::FraudDetector::Label", + + @doc("ResourceType enum AWS::FraudDetector::Outcome") + AWSFraudDetectorOutcome: "AWS::FraudDetector::Outcome", + + @doc("ResourceType enum AWS::FraudDetector::Variable") + AWSFraudDetectorVariable: "AWS::FraudDetector::Variable", + + @doc("ResourceType enum AWS::GlobalAccelerator::Accelerator") + AWSGlobalAcceleratorAccelerator: "AWS::GlobalAccelerator::Accelerator", + + @doc("ResourceType enum AWS::GlobalAccelerator::EndpointGroup") + AWSGlobalAcceleratorEndpointGroup: "AWS::GlobalAccelerator::EndpointGroup", + + @doc("ResourceType enum AWS::GlobalAccelerator::Listener") + AWSGlobalAcceleratorListener: "AWS::GlobalAccelerator::Listener", + + @doc("ResourceType enum AWS::Glue::Classifier") + AWSGlueClassifier: "AWS::Glue::Classifier", + + @doc("ResourceType enum AWS::Glue::Job") + AWSGlueJob: "AWS::Glue::Job", + + @doc("ResourceType enum AWS::Glue::MLTransform") + AWSGlueMLTransform: "AWS::Glue::MLTransform", + + @doc("ResourceType enum AWS::Grafana::Workspace") + AWSGrafanaWorkspace: "AWS::Grafana::Workspace", + + @doc("ResourceType enum AWS::GreengrassV2::ComponentVersion") + AWSGreengrassV2ComponentVersion: "AWS::GreengrassV2::ComponentVersion", + + @doc("ResourceType enum AWS::GroundStation::Config") + AWSGroundStationConfig: "AWS::GroundStation::Config", + + @doc("ResourceType enum AWS::GroundStation::DataflowEndpointGroup") + AWSGroundStationDataflowEndpointGroup: "AWS::GroundStation::DataflowEndpointGroup", + + @doc("ResourceType enum AWS::GroundStation::MissionProfile") + AWSGroundStationMissionProfile: "AWS::GroundStation::MissionProfile", + + @doc("ResourceType enum AWS::GuardDuty::Detector") + AWSGuardDutyDetector: "AWS::GuardDuty::Detector", + + @doc("ResourceType enum AWS::GuardDuty::Filter") + AWSGuardDutyFilter: "AWS::GuardDuty::Filter", + + @doc("ResourceType enum AWS::GuardDuty::IPSet") + AWSGuardDutyIPSet: "AWS::GuardDuty::IPSet", + + @doc("ResourceType enum AWS::GuardDuty::ThreatIntelSet") + AWSGuardDutyThreatIntelSet: "AWS::GuardDuty::ThreatIntelSet", + + @doc("ResourceType enum AWS::HealthLake::FHIRDatastore") + AWSHealthLakeFHIRDatastore: "AWS::HealthLake::FHIRDatastore", + + @doc("ResourceType enum AWS::IAM::Group") + AWSIAMGroup: "AWS::IAM::Group", + + @doc("ResourceType enum AWS::IAM::InstanceProfile") + AWSIAMInstanceProfile: "AWS::IAM::InstanceProfile", + + @doc("ResourceType enum AWS::IAM::Policy") + AWSIAMPolicy: "AWS::IAM::Policy", + + @doc("ResourceType enum AWS::IAM::Role") + AWSIAMRole: "AWS::IAM::Role", + + @doc("ResourceType enum AWS::IAM::SAMLProvider") + AWSIAMSAMLProvider: "AWS::IAM::SAMLProvider", + + @doc("ResourceType enum AWS::IAM::ServerCertificate") + AWSIAMServerCertificate: "AWS::IAM::ServerCertificate", + + @doc("ResourceType enum AWS::IAM::User") + AWSIAMUser: "AWS::IAM::User", + + @doc("ResourceType enum AWS::IVS::Channel") + AWSIVSChannel: "AWS::IVS::Channel", + + @doc("ResourceType enum AWS::IVS::PlaybackKeyPair") + AWSIVSPlaybackKeyPair: "AWS::IVS::PlaybackKeyPair", + + @doc("ResourceType enum AWS::IVS::RecordingConfiguration") + AWSIVSRecordingConfiguration: "AWS::IVS::RecordingConfiguration", + + @doc("ResourceType enum AWS::ImageBuilder::ContainerRecipe") + AWSImageBuilderContainerRecipe: "AWS::ImageBuilder::ContainerRecipe", + + @doc("ResourceType enum AWS::ImageBuilder::DistributionConfiguration") + AWSImageBuilderDistributionConfiguration: "AWS::ImageBuilder::DistributionConfiguration", + + @doc("ResourceType enum AWS::ImageBuilder::ImagePipeline") + AWSImageBuilderImagePipeline: "AWS::ImageBuilder::ImagePipeline", + + @doc("ResourceType enum AWS::ImageBuilder::ImageRecipe") + AWSImageBuilderImageRecipe: "AWS::ImageBuilder::ImageRecipe", + + @doc("ResourceType enum AWS::ImageBuilder::InfrastructureConfiguration") + AWSImageBuilderInfrastructureConfiguration: "AWS::ImageBuilder::InfrastructureConfiguration", + + @doc("ResourceType enum AWS::InspectorV2::Filter") + AWSInspectorV2Filter: "AWS::InspectorV2::Filter", + + @doc("ResourceType enum AWS::IoT::AccountAuditConfiguration") + AWSIoTAccountAuditConfiguration: "AWS::IoT::AccountAuditConfiguration", + + @doc("ResourceType enum AWS::IoT::Authorizer") + AWSIoTAuthorizer: "AWS::IoT::Authorizer", + + @doc("ResourceType enum AWS::IoT::CACertificate") + AWSIoTCACertificate: "AWS::IoT::CACertificate", + + @doc("ResourceType enum AWS::IoT::CustomMetric") + AWSIoTCustomMetric: "AWS::IoT::CustomMetric", + + @doc("ResourceType enum AWS::IoT::Dimension") + AWSIoTDimension: "AWS::IoT::Dimension", + + @doc("ResourceType enum AWS::IoT::FleetMetric") + AWSIoTFleetMetric: "AWS::IoT::FleetMetric", + + @doc("ResourceType enum AWS::IoT::JobTemplate") + AWSIoTJobTemplate: "AWS::IoT::JobTemplate", + + @doc("ResourceType enum AWS::IoT::MitigationAction") + AWSIoTMitigationAction: "AWS::IoT::MitigationAction", + + @doc("ResourceType enum AWS::IoT::Policy") + AWSIoTPolicy: "AWS::IoT::Policy", + + @doc("ResourceType enum AWS::IoT::ProvisioningTemplate") + AWSIoTProvisioningTemplate: "AWS::IoT::ProvisioningTemplate", + + @doc("ResourceType enum AWS::IoT::RoleAlias") + AWSIoTRoleAlias: "AWS::IoT::RoleAlias", + + @doc("ResourceType enum AWS::IoT::ScheduledAudit") + AWSIoTScheduledAudit: "AWS::IoT::ScheduledAudit", + + @doc("ResourceType enum AWS::IoT::SecurityProfile") + AWSIoTSecurityProfile: "AWS::IoT::SecurityProfile", + + @doc("ResourceType enum AWS::IoTAnalytics::Channel") + AWSIoTAnalyticsChannel: "AWS::IoTAnalytics::Channel", + + @doc("ResourceType enum AWS::IoTAnalytics::Dataset") + AWSIoTAnalyticsDataset: "AWS::IoTAnalytics::Dataset", + + @doc("ResourceType enum AWS::IoTAnalytics::Datastore") + AWSIoTAnalyticsDatastore: "AWS::IoTAnalytics::Datastore", + + @doc("ResourceType enum AWS::IoTAnalytics::Pipeline") + AWSIoTAnalyticsPipeline: "AWS::IoTAnalytics::Pipeline", + + @doc("ResourceType enum AWS::IoTEvents::AlarmModel") + AWSIoTEventsAlarmModel: "AWS::IoTEvents::AlarmModel", + + @doc("ResourceType enum AWS::IoTEvents::DetectorModel") + AWSIoTEventsDetectorModel: "AWS::IoTEvents::DetectorModel", + + @doc("ResourceType enum AWS::IoTEvents::Input") + AWSIoTEventsInput: "AWS::IoTEvents::Input", + + @doc("ResourceType enum AWS::IoTSiteWise::AssetModel") + AWSIoTSiteWiseAssetModel: "AWS::IoTSiteWise::AssetModel", + + @doc("ResourceType enum AWS::IoTSiteWise::Dashboard") + AWSIoTSiteWiseDashboard: "AWS::IoTSiteWise::Dashboard", + + @doc("ResourceType enum AWS::IoTSiteWise::Gateway") + AWSIoTSiteWiseGateway: "AWS::IoTSiteWise::Gateway", + + @doc("ResourceType enum AWS::IoTSiteWise::Portal") + AWSIoTSiteWisePortal: "AWS::IoTSiteWise::Portal", + + @doc("ResourceType enum AWS::IoTSiteWise::Project") + AWSIoTSiteWiseProject: "AWS::IoTSiteWise::Project", + + @doc("ResourceType enum AWS::IoTTwinMaker::ComponentType") + AWSIoTTwinMakerComponentType: "AWS::IoTTwinMaker::ComponentType", + + @doc("ResourceType enum AWS::IoTTwinMaker::Entity") + AWSIoTTwinMakerEntity: "AWS::IoTTwinMaker::Entity", + + @doc("ResourceType enum AWS::IoTTwinMaker::Scene") + AWSIoTTwinMakerScene: "AWS::IoTTwinMaker::Scene", + + @doc("ResourceType enum AWS::IoTTwinMaker::SyncJob") + AWSIoTTwinMakerSyncJob: "AWS::IoTTwinMaker::SyncJob", + + @doc("ResourceType enum AWS::IoTTwinMaker::Workspace") + AWSIoTTwinMakerWorkspace: "AWS::IoTTwinMaker::Workspace", + + @doc("ResourceType enum AWS::IoTWireless::FuotaTask") + AWSIoTWirelessFuotaTask: "AWS::IoTWireless::FuotaTask", + + @doc("ResourceType enum AWS::IoTWireless::MulticastGroup") + AWSIoTWirelessMulticastGroup: "AWS::IoTWireless::MulticastGroup", + + @doc("ResourceType enum AWS::IoTWireless::ServiceProfile") + AWSIoTWirelessServiceProfile: "AWS::IoTWireless::ServiceProfile", + + @doc("ResourceType enum AWS::KMS::Alias") + AWSKMSAlias: "AWS::KMS::Alias", + + @doc("ResourceType enum AWS::KMS::Key") + AWSKMSKey: "AWS::KMS::Key", + + @doc("ResourceType enum AWS::KafkaConnect::Connector") + AWSKafkaConnectConnector: "AWS::KafkaConnect::Connector", + + @doc("ResourceType enum AWS::Kendra::Index") + AWSKendraIndex: "AWS::Kendra::Index", + + @doc("ResourceType enum AWS::Kinesis::Stream") + AWSKinesisStream: "AWS::Kinesis::Stream", + + @doc("ResourceType enum AWS::Kinesis::StreamConsumer") + AWSKinesisStreamConsumer: "AWS::Kinesis::StreamConsumer", + + @doc("ResourceType enum AWS::KinesisAnalyticsV2::Application") + AWSKinesisAnalyticsV2Application: "AWS::KinesisAnalyticsV2::Application", + + @doc("ResourceType enum AWS::KinesisFirehose::DeliveryStream") + AWSKinesisFirehoseDeliveryStream: "AWS::KinesisFirehose::DeliveryStream", + + @doc("ResourceType enum AWS::KinesisVideo::SignalingChannel") + AWSKinesisVideoSignalingChannel: "AWS::KinesisVideo::SignalingChannel", + + @doc("ResourceType enum AWS::KinesisVideo::Stream") + AWSKinesisVideoStream: "AWS::KinesisVideo::Stream", + + @doc("ResourceType enum AWS::Lambda::CodeSigningConfig") + AWSLambdaCodeSigningConfig: "AWS::Lambda::CodeSigningConfig", + + @doc("ResourceType enum AWS::Lambda::Function") + AWSLambdaFunction: "AWS::Lambda::Function", + + @doc("ResourceType enum AWS::Lex::Bot") + AWSLexBot: "AWS::Lex::Bot", + + @doc("ResourceType enum AWS::Lex::BotAlias") + AWSLexBotAlias: "AWS::Lex::BotAlias", + + @doc("ResourceType enum AWS::Lightsail::Bucket") + AWSLightsailBucket: "AWS::Lightsail::Bucket", + + @doc("ResourceType enum AWS::Lightsail::Certificate") + AWSLightsailCertificate: "AWS::Lightsail::Certificate", + + @doc("ResourceType enum AWS::Lightsail::Disk") + AWSLightsailDisk: "AWS::Lightsail::Disk", + + @doc("ResourceType enum AWS::Lightsail::StaticIp") + AWSLightsailStaticIp: "AWS::Lightsail::StaticIp", + + @doc("ResourceType enum AWS::Logs::Destination") + AWSLogsDestination: "AWS::Logs::Destination", + + @doc("ResourceType enum AWS::LookoutMetrics::Alert") + AWSLookoutMetricsAlert: "AWS::LookoutMetrics::Alert", + + @doc("ResourceType enum AWS::LookoutVision::Project") + AWSLookoutVisionProject: "AWS::LookoutVision::Project", + + @doc("ResourceType enum AWS::M2::Environment") + AWSM2Environment: "AWS::M2::Environment", + + @doc("ResourceType enum AWS::MSK::BatchScramSecret") + AWSMSKBatchScramSecret: "AWS::MSK::BatchScramSecret", + + @doc("ResourceType enum AWS::MSK::Cluster") + AWSMSKCluster: "AWS::MSK::Cluster", + + @doc("ResourceType enum AWS::MSK::Configuration") + AWSMSKConfiguration: "AWS::MSK::Configuration", + + @doc("ResourceType enum AWS::MediaConnect::FlowEntitlement") + AWSMediaConnectFlowEntitlement: "AWS::MediaConnect::FlowEntitlement", + + @doc("ResourceType enum AWS::MediaConnect::FlowSource") + AWSMediaConnectFlowSource: "AWS::MediaConnect::FlowSource", + + @doc("ResourceType enum AWS::MediaConnect::FlowVpcInterface") + AWSMediaConnectFlowVpcInterface: "AWS::MediaConnect::FlowVpcInterface", + + @doc("ResourceType enum AWS::MediaPackage::PackagingConfiguration") + AWSMediaPackagePackagingConfiguration: "AWS::MediaPackage::PackagingConfiguration", + + @doc("ResourceType enum AWS::MediaPackage::PackagingGroup") + AWSMediaPackagePackagingGroup: "AWS::MediaPackage::PackagingGroup", + + @doc("ResourceType enum AWS::MediaTailor::PlaybackConfiguration") + AWSMediaTailorPlaybackConfiguration: "AWS::MediaTailor::PlaybackConfiguration", + + @doc("ResourceType enum AWS::NetworkFirewall::Firewall") + AWSNetworkFirewallFirewall: "AWS::NetworkFirewall::Firewall", + + @doc("ResourceType enum AWS::NetworkFirewall::FirewallPolicy") + AWSNetworkFirewallFirewallPolicy: "AWS::NetworkFirewall::FirewallPolicy", + + @doc("ResourceType enum AWS::NetworkFirewall::RuleGroup") + AWSNetworkFirewallRuleGroup: "AWS::NetworkFirewall::RuleGroup", + + @doc("ResourceType enum AWS::NetworkManager::ConnectPeer") + AWSNetworkManagerConnectPeer: "AWS::NetworkManager::ConnectPeer", + + @doc("ResourceType enum AWS::NetworkManager::CustomerGatewayAssociation") + AWSNetworkManagerCustomerGatewayAssociation: "AWS::NetworkManager::CustomerGatewayAssociation", + + @doc("ResourceType enum AWS::NetworkManager::Device") + AWSNetworkManagerDevice: "AWS::NetworkManager::Device", + + @doc("ResourceType enum AWS::NetworkManager::GlobalNetwork") + AWSNetworkManagerGlobalNetwork: "AWS::NetworkManager::GlobalNetwork", + + @doc("ResourceType enum AWS::NetworkManager::Link") + AWSNetworkManagerLink: "AWS::NetworkManager::Link", + + @doc("ResourceType enum AWS::NetworkManager::LinkAssociation") + AWSNetworkManagerLinkAssociation: "AWS::NetworkManager::LinkAssociation", + + @doc("ResourceType enum AWS::NetworkManager::Site") + AWSNetworkManagerSite: "AWS::NetworkManager::Site", + + @doc("ResourceType enum AWS::NetworkManager::TransitGatewayRegistration") + AWSNetworkManagerTransitGatewayRegistration: "AWS::NetworkManager::TransitGatewayRegistration", + + @doc("ResourceType enum AWS::OpenSearch::Domain") + AWSOpenSearchDomain: "AWS::OpenSearch::Domain", + + @doc("ResourceType enum AWS::Panorama::Package") + AWSPanoramaPackage: "AWS::Panorama::Package", + + @doc("ResourceType enum AWS::Personalize::Dataset") + AWSPersonalizeDataset: "AWS::Personalize::Dataset", + + @doc("ResourceType enum AWS::Personalize::DatasetGroup") + AWSPersonalizeDatasetGroup: "AWS::Personalize::DatasetGroup", + + @doc("ResourceType enum AWS::Personalize::Schema") + AWSPersonalizeSchema: "AWS::Personalize::Schema", + + @doc("ResourceType enum AWS::Personalize::Solution") + AWSPersonalizeSolution: "AWS::Personalize::Solution", + + @doc("ResourceType enum AWS::Pinpoint::App") + AWSPinpointApp: "AWS::Pinpoint::App", + + @doc("ResourceType enum AWS::Pinpoint::ApplicationSettings") + AWSPinpointApplicationSettings: "AWS::Pinpoint::ApplicationSettings", + + @doc("ResourceType enum AWS::Pinpoint::Campaign") + AWSPinpointCampaign: "AWS::Pinpoint::Campaign", + + @doc("ResourceType enum AWS::Pinpoint::EmailChannel") + AWSPinpointEmailChannel: "AWS::Pinpoint::EmailChannel", + + @doc("ResourceType enum AWS::Pinpoint::EmailTemplate") + AWSPinpointEmailTemplate: "AWS::Pinpoint::EmailTemplate", + + @doc("ResourceType enum AWS::Pinpoint::EventStream") + AWSPinpointEventStream: "AWS::Pinpoint::EventStream", + + @doc("ResourceType enum AWS::Pinpoint::InAppTemplate") + AWSPinpointInAppTemplate: "AWS::Pinpoint::InAppTemplate", + + @doc("ResourceType enum AWS::Pinpoint::Segment") + AWSPinpointSegment: "AWS::Pinpoint::Segment", + + @doc("ResourceType enum AWS::QLDB::Ledger") + AWSQLDBLedger: "AWS::QLDB::Ledger", + + @doc("ResourceType enum AWS::QuickSight::DataSource") + AWSQuickSightDataSource: "AWS::QuickSight::DataSource", + + @doc("ResourceType enum AWS::QuickSight::Template") + AWSQuickSightTemplate: "AWS::QuickSight::Template", + + @doc("ResourceType enum AWS::QuickSight::Theme") + AWSQuickSightTheme: "AWS::QuickSight::Theme", + + @doc("ResourceType enum AWS::RDS::DBCluster") + AWSRDSDBCluster: "AWS::RDS::DBCluster", + + @doc("ResourceType enum AWS::RDS::DBClusterSnapshot") + AWSRDSDBClusterSnapshot: "AWS::RDS::DBClusterSnapshot", + + @doc("ResourceType enum AWS::RDS::DBInstance") + AWSRDSDBInstance: "AWS::RDS::DBInstance", + + @doc("ResourceType enum AWS::RDS::DBSecurityGroup") + AWSRDSDBSecurityGroup: "AWS::RDS::DBSecurityGroup", + + @doc("ResourceType enum AWS::RDS::DBSnapshot") + AWSRDSDBSnapshot: "AWS::RDS::DBSnapshot", + + @doc("ResourceType enum AWS::RDS::DBSubnetGroup") + AWSRDSDBSubnetGroup: "AWS::RDS::DBSubnetGroup", + + @doc("ResourceType enum AWS::RDS::EventSubscription") + AWSRDSEventSubscription: "AWS::RDS::EventSubscription", + + @doc("ResourceType enum AWS::RDS::GlobalCluster") + AWSRDSGlobalCluster: "AWS::RDS::GlobalCluster", + + @doc("ResourceType enum AWS::RDS::OptionGroup") + AWSRDSOptionGroup: "AWS::RDS::OptionGroup", + + @doc("ResourceType enum AWS::RUM::AppMonitor") + AWSRUMAppMonitor: "AWS::RUM::AppMonitor", + + @doc("ResourceType enum AWS::Redshift::Cluster") + AWSRedshiftCluster: "AWS::Redshift::Cluster", + + @doc("ResourceType enum AWS::Redshift::ClusterParameterGroup") + AWSRedshiftClusterParameterGroup: "AWS::Redshift::ClusterParameterGroup", + + @doc("ResourceType enum AWS::Redshift::ClusterSecurityGroup") + AWSRedshiftClusterSecurityGroup: "AWS::Redshift::ClusterSecurityGroup", + + @doc("ResourceType enum AWS::Redshift::ClusterSnapshot") + AWSRedshiftClusterSnapshot: "AWS::Redshift::ClusterSnapshot", + + @doc("ResourceType enum AWS::Redshift::ClusterSubnetGroup") + AWSRedshiftClusterSubnetGroup: "AWS::Redshift::ClusterSubnetGroup", + + @doc("ResourceType enum AWS::Redshift::EndpointAccess") + AWSRedshiftEndpointAccess: "AWS::Redshift::EndpointAccess", + + @doc("ResourceType enum AWS::Redshift::EventSubscription") + AWSRedshiftEventSubscription: "AWS::Redshift::EventSubscription", + + @doc("ResourceType enum AWS::Redshift::ScheduledAction") + AWSRedshiftScheduledAction: "AWS::Redshift::ScheduledAction", + + @doc("ResourceType enum AWS::ResilienceHub::App") + AWSResilienceHubApp: "AWS::ResilienceHub::App", + + @doc("ResourceType enum AWS::ResilienceHub::ResiliencyPolicy") + AWSResilienceHubResiliencyPolicy: "AWS::ResilienceHub::ResiliencyPolicy", + + @doc("ResourceType enum AWS::ResourceExplorer2::Index") + AWSResourceExplorer2Index: "AWS::ResourceExplorer2::Index", + + @doc("ResourceType enum AWS::RoboMaker::RobotApplication") + AWSRoboMakerRobotApplication: "AWS::RoboMaker::RobotApplication", + + @doc("ResourceType enum AWS::RoboMaker::RobotApplicationVersion") + AWSRoboMakerRobotApplicationVersion: "AWS::RoboMaker::RobotApplicationVersion", + + @doc("ResourceType enum AWS::RoboMaker::SimulationApplication") + AWSRoboMakerSimulationApplication: "AWS::RoboMaker::SimulationApplication", + + @doc("ResourceType enum AWS::Route53::HostedZone") + AWSRoute53HostedZone: "AWS::Route53::HostedZone", + + @doc("ResourceType enum AWS::Route53RecoveryControl::Cluster") + AWSRoute53RecoveryControlCluster: "AWS::Route53RecoveryControl::Cluster", + + @doc("ResourceType enum AWS::Route53RecoveryControl::ControlPanel") + AWSRoute53RecoveryControlControlPanel: "AWS::Route53RecoveryControl::ControlPanel", + + @doc("ResourceType enum AWS::Route53RecoveryControl::RoutingControl") + AWSRoute53RecoveryControlRoutingControl: "AWS::Route53RecoveryControl::RoutingControl", + + @doc("ResourceType enum AWS::Route53RecoveryControl::SafetyRule") + AWSRoute53RecoveryControlSafetyRule: "AWS::Route53RecoveryControl::SafetyRule", + + @doc("ResourceType enum AWS::Route53RecoveryReadiness::Cell") + AWSRoute53RecoveryReadinessCell: "AWS::Route53RecoveryReadiness::Cell", + + @doc("ResourceType enum AWS::Route53RecoveryReadiness::ReadinessCheck") + AWSRoute53RecoveryReadinessReadinessCheck: "AWS::Route53RecoveryReadiness::ReadinessCheck", + + @doc("ResourceType enum AWS::Route53RecoveryReadiness::RecoveryGroup") + AWSRoute53RecoveryReadinessRecoveryGroup: "AWS::Route53RecoveryReadiness::RecoveryGroup", + + @doc("ResourceType enum AWS::Route53RecoveryReadiness::ResourceSet") + AWSRoute53RecoveryReadinessResourceSet: "AWS::Route53RecoveryReadiness::ResourceSet", + + @doc("ResourceType enum AWS::Route53Resolver::FirewallDomainList") + AWSRoute53ResolverFirewallDomainList: "AWS::Route53Resolver::FirewallDomainList", + + @doc("ResourceType enum AWS::Route53Resolver::FirewallRuleGroup") + AWSRoute53ResolverFirewallRuleGroup: "AWS::Route53Resolver::FirewallRuleGroup", + + @doc("ResourceType enum AWS::Route53Resolver::FirewallRuleGroupAssociation") + AWSRoute53ResolverFirewallRuleGroupAssociation: "AWS::Route53Resolver::FirewallRuleGroupAssociation", + + @doc("ResourceType enum AWS::Route53Resolver::ResolverEndpoint") + AWSRoute53ResolverResolverEndpoint: "AWS::Route53Resolver::ResolverEndpoint", + + @doc("ResourceType enum AWS::Route53Resolver::ResolverQueryLoggingConfig") + AWSRoute53ResolverResolverQueryLoggingConfig: "AWS::Route53Resolver::ResolverQueryLoggingConfig", + + @doc("ResourceType enum AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation") + AWSRoute53ResolverResolverQueryLoggingConfigAssociation: "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation", + + @doc("ResourceType enum AWS::Route53Resolver::ResolverRule") + AWSRoute53ResolverResolverRule: "AWS::Route53Resolver::ResolverRule", + + @doc("ResourceType enum AWS::Route53Resolver::ResolverRuleAssociation") + AWSRoute53ResolverResolverRuleAssociation: "AWS::Route53Resolver::ResolverRuleAssociation", + + @doc("ResourceType enum AWS::S3::AccessPoint") + AWSS3AccessPoint: "AWS::S3::AccessPoint", + + @doc("ResourceType enum AWS::S3::AccountPublicAccessBlock") + AWSS3AccountPublicAccessBlock: "AWS::S3::AccountPublicAccessBlock", + + @doc("ResourceType enum AWS::S3::Bucket") + AWSS3Bucket: "AWS::S3::Bucket", + + @doc("ResourceType enum AWS::S3::MultiRegionAccessPoint") + AWSS3MultiRegionAccessPoint: "AWS::S3::MultiRegionAccessPoint", + + @doc("ResourceType enum AWS::S3::StorageLens") + AWSS3StorageLens: "AWS::S3::StorageLens", + + @doc("ResourceType enum AWS::SES::ConfigurationSet") + AWSSESConfigurationSet: "AWS::SES::ConfigurationSet", + + @doc("ResourceType enum AWS::SES::ContactList") + AWSSESContactList: "AWS::SES::ContactList", + + @doc("ResourceType enum AWS::SES::ReceiptFilter") + AWSSESReceiptFilter: "AWS::SES::ReceiptFilter", + + @doc("ResourceType enum AWS::SES::ReceiptRuleSet") + AWSSESReceiptRuleSet: "AWS::SES::ReceiptRuleSet", + + @doc("ResourceType enum AWS::SES::Template") + AWSSESTemplate: "AWS::SES::Template", + + @doc("ResourceType enum AWS::SNS::Topic") + AWSSNSTopic: "AWS::SNS::Topic", + + @doc("ResourceType enum AWS::SQS::Queue") + AWSSQSQueue: "AWS::SQS::Queue", + + @doc("ResourceType enum AWS::SSM::AssociationCompliance") + AWSSSMAssociationCompliance: "AWS::SSM::AssociationCompliance", + + @doc("ResourceType enum AWS::SSM::Document") + AWSSSMDocument: "AWS::SSM::Document", + + @doc("ResourceType enum AWS::SSM::FileData") + AWSSSMFileData: "AWS::SSM::FileData", + + @doc("ResourceType enum AWS::SSM::ManagedInstanceInventory") + AWSSSMManagedInstanceInventory: "AWS::SSM::ManagedInstanceInventory", + + @doc("ResourceType enum AWS::SSM::PatchCompliance") + AWSSSMPatchCompliance: "AWS::SSM::PatchCompliance", + + @doc("ResourceType enum AWS::SageMaker::AppImageConfig") + AWSSageMakerAppImageConfig: "AWS::SageMaker::AppImageConfig", + + @doc("ResourceType enum AWS::SageMaker::CodeRepository") + AWSSageMakerCodeRepository: "AWS::SageMaker::CodeRepository", + + @doc("ResourceType enum AWS::SageMaker::Domain") + AWSSageMakerDomain: "AWS::SageMaker::Domain", + + @doc("ResourceType enum AWS::SageMaker::FeatureGroup") + AWSSageMakerFeatureGroup: "AWS::SageMaker::FeatureGroup", + + @doc("ResourceType enum AWS::SageMaker::Image") + AWSSageMakerImage: "AWS::SageMaker::Image", + + @doc("ResourceType enum AWS::SageMaker::Model") + AWSSageMakerModel: "AWS::SageMaker::Model", + + @doc("ResourceType enum AWS::SageMaker::NotebookInstanceLifecycleConfig") + AWSSageMakerNotebookInstanceLifecycleConfig: "AWS::SageMaker::NotebookInstanceLifecycleConfig", + + @doc("ResourceType enum AWS::SageMaker::Workteam") + AWSSageMakerWorkteam: "AWS::SageMaker::Workteam", + + @doc("ResourceType enum AWS::SecretsManager::Secret") + AWSSecretsManagerSecret: "AWS::SecretsManager::Secret", + + @doc("ResourceType enum AWS::ServiceCatalog::CloudFormationProduct") + AWSServiceCatalogCloudFormationProduct: "AWS::ServiceCatalog::CloudFormationProduct", + + @doc("ResourceType enum AWS::ServiceCatalog::CloudFormationProvisionedProduct") + AWSServiceCatalogCloudFormationProvisionedProduct: "AWS::ServiceCatalog::CloudFormationProvisionedProduct", + + @doc("ResourceType enum AWS::ServiceCatalog::Portfolio") + AWSServiceCatalogPortfolio: "AWS::ServiceCatalog::Portfolio", + + @doc("ResourceType enum AWS::ServiceDiscovery::HttpNamespace") + AWSServiceDiscoveryHttpNamespace: "AWS::ServiceDiscovery::HttpNamespace", + + @doc("ResourceType enum AWS::ServiceDiscovery::Instance") + AWSServiceDiscoveryInstance: "AWS::ServiceDiscovery::Instance", + + @doc("ResourceType enum AWS::ServiceDiscovery::PublicDnsNamespace") + AWSServiceDiscoveryPublicDnsNamespace: "AWS::ServiceDiscovery::PublicDnsNamespace", + + @doc("ResourceType enum AWS::ServiceDiscovery::Service") + AWSServiceDiscoveryService: "AWS::ServiceDiscovery::Service", + + @doc("ResourceType enum AWS::Shield::Protection") + AWSShieldProtection: "AWS::Shield::Protection", + + @doc("ResourceType enum AWS::ShieldRegional::Protection") + AWSShieldRegionalProtection: "AWS::ShieldRegional::Protection", + + @doc("ResourceType enum AWS::Signer::SigningProfile") + AWSSignerSigningProfile: "AWS::Signer::SigningProfile", + + @doc("ResourceType enum AWS::StepFunctions::Activity") + AWSStepFunctionsActivity: "AWS::StepFunctions::Activity", + + @doc("ResourceType enum AWS::StepFunctions::StateMachine") + AWSStepFunctionsStateMachine: "AWS::StepFunctions::StateMachine", + + @doc("ResourceType enum AWS::Transfer::Agreement") + AWSTransferAgreement: "AWS::Transfer::Agreement", + + @doc("ResourceType enum AWS::Transfer::Certificate") + AWSTransferCertificate: "AWS::Transfer::Certificate", + + @doc("ResourceType enum AWS::Transfer::Connector") + AWSTransferConnector: "AWS::Transfer::Connector", + + @doc("ResourceType enum AWS::Transfer::Workflow") + AWSTransferWorkflow: "AWS::Transfer::Workflow", + + @doc("ResourceType enum AWS::WAF::RateBasedRule") + AWSWAFRateBasedRule: "AWS::WAF::RateBasedRule", + + @doc("ResourceType enum AWS::WAF::Rule") + AWSWAFRule: "AWS::WAF::Rule", + + @doc("ResourceType enum AWS::WAF::RuleGroup") + AWSWAFRuleGroup: "AWS::WAF::RuleGroup", + + @doc("ResourceType enum AWS::WAF::WebACL") + AWSWAFWebACL: "AWS::WAF::WebACL", + + @doc("ResourceType enum AWS::WAFRegional::RateBasedRule") + AWSWAFRegionalRateBasedRule: "AWS::WAFRegional::RateBasedRule", + + @doc("ResourceType enum AWS::WAFRegional::Rule") + AWSWAFRegionalRule: "AWS::WAFRegional::Rule", + + @doc("ResourceType enum AWS::WAFRegional::RuleGroup") + AWSWAFRegionalRuleGroup: "AWS::WAFRegional::RuleGroup", + + @doc("ResourceType enum AWS::WAFRegional::WebACL") + AWSWAFRegionalWebACL: "AWS::WAFRegional::WebACL", + + @doc("ResourceType enum AWS::WAFv2::IPSet") + AWSWAFv2IPSet: "AWS::WAFv2::IPSet", + + @doc("ResourceType enum AWS::WAFv2::ManagedRuleSet") + AWSWAFv2ManagedRuleSet: "AWS::WAFv2::ManagedRuleSet", + + @doc("ResourceType enum AWS::WAFv2::RegexPatternSet") + AWSWAFv2RegexPatternSet: "AWS::WAFv2::RegexPatternSet", + + @doc("ResourceType enum AWS::WAFv2::RuleGroup") + AWSWAFv2RuleGroup: "AWS::WAFv2::RuleGroup", + + @doc("ResourceType enum AWS::WAFv2::WebACL") + AWSWAFv2WebACL: "AWS::WAFv2::WebACL", + + @doc("ResourceType enum AWS::WorkSpaces::ConnectionAlias") + AWSWorkSpacesConnectionAlias: "AWS::WorkSpaces::ConnectionAlias", + + @doc("ResourceType enum AWS::WorkSpaces::Workspace") + AWSWorkSpacesWorkspace: "AWS::WorkSpaces::Workspace", + + @doc("ResourceType enum AWS::XRay::EncryptionConfig") + AWSXRayEncryptionConfig: "AWS::XRay::EncryptionConfig", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceTypeEnumValue") +model ResourceTypeEnumValue { + @doc("Property value") + value?: ResourceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingMode") +model RecordingMode { + @doc("<p>The default recording frequency that Config uses to record configuration changes.</p> <important> <p>Daily recording is not supported for the following resource types:</p> <ul> <li> <p> <code>AWS::Config::ResourceCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConformancePackCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConfigurationRecorder</code> </p> </li> </ul> <p>For the <b>allSupported</b> (<code>ALL_SUPPORTED_RESOURCE_TYPES</code>) recording strategy, these resource types will be set to Continuous recording.</p> </important>") + recordingFrequency?: RecordingFrequencyEnumValue; + + @doc("<p>An array of <code>recordingModeOverride</code> objects for you to specify your overrides for the recording mode. The <code>recordingModeOverride</code> object in the <code>recordingModeOverrides</code> array consists of three fields: a <code>description</code>, the new <code>recordingFrequency</code>, and an array of <code>resourceTypes</code> to override.</p>") + @extension("x-ms-identifiers", []) + recordingModeOverrides?: RecordingModeOverride[]; +} + +@doc("RecordingFrequency enum") +union RecordingFrequency { + @doc("RecordingFrequency enum CONTINUOUS") + CONTINUOUS: "CONTINUOUS", + + @doc("RecordingFrequency enum DAILY") + DAILY: "DAILY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingFrequencyEnumValue") +model RecordingFrequencyEnumValue { + @doc("Property value") + value?: RecordingFrequency; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ExclusionByResourceTypes") +model ExclusionByResourceTypes { + @doc("<p>A comma-separated list of resource types to exclude from recording by the configuration recorder.</p>") + @extension("x-ms-identifiers", []) + resourceTypes?: ResourceType[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingStrategy") +model RecordingStrategy { + @doc("<p>The recording strategy for the configuration recorder.</p> <ul> <li> <p>If you set this option to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'>Supported Resource Types</a> in the <i>Config developer guide</i>.</p> </li> <li> <p>If you set this option to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for only the resource types that you specify in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> </li> <li> <p>If you set this option to <code>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </li> </ul> <note> <p> <b>Required and optional fields</b> </p> <p>The <code>recordingStrategy</code> field is optional when you set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>.</p> <p>The <code>recordingStrategy</code> field is optional when you list resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p> <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </note> <note> <p> <b>Global resource types and the exclusion recording strategy</b> </p> <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.</p> <p>Unless specifically listed as exclusions, <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p> <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> </note>") + useOnly?: RecordingStrategyTypeEnumValue; +} + +@doc("RecordingStrategyType enum") +union RecordingStrategyType { + @doc("RecordingStrategyType enum ALL_SUPPORTED_RESOURCE_TYPES") + ALL_SUPPORTED_RESOURCE_TYPES: "ALL_SUPPORTED_RESOURCE_TYPES", + + @doc("RecordingStrategyType enum EXCLUSION_BY_RESOURCE_TYPES") + EXCLUSION_BY_RESOURCE_TYPES: "EXCLUSION_BY_RESOURCE_TYPES", + + @doc("RecordingStrategyType enum INCLUSION_BY_RESOURCE_TYPES") + INCLUSION_BY_RESOURCE_TYPES: "INCLUSION_BY_RESOURCE_TYPES", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingStrategyTypeEnumValue") +model RecordingStrategyTypeEnumValue { + @doc("Property value") + value?: RecordingStrategyType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecordingModeOverride") +model RecordingModeOverride { + @doc("<p>A description that you provide for the override.</p>") + description?: string; + + @doc("<p>The recording frequency that will be applied to all the resource types specified in the override.</p> <ul> <li> <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p> </li> <li> <p>Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. </p> </li> </ul> <note> <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.</p> </note>") + recordingFrequency?: RecordingFrequencyEnumValue; + + @doc("<p>A comma-separated list that specifies which resource types Config includes in the override.</p> <important> <p>Daily recording is not supported for the following resource types:</p> <ul> <li> <p> <code>AWS::Config::ResourceCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConformancePackCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConfigurationRecorder</code> </p> </li> </ul> </important>") + @extension("x-ms-identifiers", []) + resourceTypes?: ResourceType[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ConfigServiceConfigurationRecorders { + get is ArmResourceRead<ConfigServiceConfigurationRecorder>; + @doc("Create a ConfigServiceConfigurationRecorder. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ConfigServiceConfigurationRecorder>; + update is ArmCustomPatchAsync< + ConfigServiceConfigurationRecorder, + Azure.ResourceManager.Foundations.TagsUpdateModel<ConfigServiceConfigurationRecorder> + >; + delete is ArmResourceDeleteWithoutOkAsync<ConfigServiceConfigurationRecorder>; + listByResourceGroup is ArmResourceListByParent<ConfigServiceConfigurationRecorder>; + listBySubscription is ArmListBySubscription<ConfigServiceConfigurationRecorder>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\config\config-2014-11-12.normal.json +// AWS Shape: ConfigurationRecorder +// +// Related information for backend service: +// AWS Servcie : Config Service +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.55 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/tspconfig.yaml b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/tspconfig.yaml new file mode 100644 index 000000000000..267c3a8ad0f4 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorder.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/configServiceConfigurationRecorder.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..e2c91a50aa59 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace", + "operationId": "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + } + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Delete.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Delete.json new file mode 100644 index 000000000000..d22ad0b53bf8 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Delete", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Get.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Get.json new file mode 100644 index 000000000000..da2160dc18c4 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Get.json @@ -0,0 +1,55 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Get", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..d01f8e1a3336 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup", + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json new file mode 100644 index 000000000000..7a0b1b20e4a0 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_ListBySubscription", + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Update.json b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Update.json new file mode 100644 index 000000000000..e060a85a36f3 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/examples/2024-12-01/ConfigServiceConfigurationRecorderStatuses_Update.json @@ -0,0 +1,65 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Update", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4598": "hgelyjfovofeafmyrvss" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/main.tsp b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/main.tsp new file mode 100644 index 000000000000..32df7da4ec25 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/main.tsp @@ -0,0 +1,157 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ConfigServiceConfigurationRecorderStatuses ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Config Service Configuration Recorder Status", + plural: "Config Service Configuration Recorder Statuses", + }, + keywords: [ + "Microsoft.AwsConnector", + "Config ", + "Service", + "Configuration", + "Recorder", + "Status" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ConfigServiceConfigurationRecorderStatus + is TrackedResource<ConfigServiceConfigurationRecorderStatusProperties> { + @doc("Name of ConfigServiceConfigurationRecorderStatus") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("configServiceConfigurationRecorderStatuses") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigServiceConfigurationRecorderStatus") +model ConfigServiceConfigurationRecorderStatusProperties { + @doc("AWS Properties") + awsProperties?: AwsConfigServiceConfigurationRecorderStatusProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsConfigServiceConfigurationRecorderStatus") +model AwsConfigServiceConfigurationRecorderStatusProperties { + @doc("<p>The latest error code from when the recorder last failed.</p>") + lastErrorCode?: string; + + @doc("<p>The latest error message from when the recorder last failed.</p>") + lastErrorMessage?: string; + + @doc("<p>The time the recorder was last started.</p>") + lastStartTime?: utcDateTime; + + @doc("<p>The status of the latest recording event processed by the recorder.</p>") + lastStatus?: RecorderStatusEnumValue; + + @doc("<p>The time of the latest change in status of an recording event processed by the recorder.</p>") + lastStatusChangeTime?: utcDateTime; + + @doc("<p>The time the recorder was last stopped.</p>") + lastStopTime?: utcDateTime; + + @doc("<p>The name of the configuration recorder.</p>") + name?: string; + + @doc("<p>Specifies whether or not the recorder is currently recording.</p>") + recording?: boolean; +} + +@doc("RecorderStatus enum") +union RecorderStatus { + @doc("RecorderStatus enum Failure") + Failure: "Failure", + + @doc("RecorderStatus enum Pending") + Pending: "Pending", + + @doc("RecorderStatus enum Success") + Success: "Success", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RecorderStatusEnumValue") +model RecorderStatusEnumValue { + @doc("Property value") + value?: RecorderStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ConfigServiceConfigurationRecorderStatuses { + get is ArmResourceRead<ConfigServiceConfigurationRecorderStatus>; + @doc("Create a ConfigServiceConfigurationRecorderStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ConfigServiceConfigurationRecorderStatus>; + update is ArmCustomPatchAsync< + ConfigServiceConfigurationRecorderStatus, + Azure.ResourceManager.Foundations.TagsUpdateModel<ConfigServiceConfigurationRecorderStatus> + >; + delete is ArmResourceDeleteWithoutOkAsync<ConfigServiceConfigurationRecorderStatus>; + listByResourceGroup is ArmResourceListByParent<ConfigServiceConfigurationRecorderStatus>; + listBySubscription is ArmListBySubscription<ConfigServiceConfigurationRecorderStatus>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\config\config-2014-11-12.normal.json +// AWS Shape: ConfigurationRecorderStatus +// +// Related information for backend service: +// AWS Servcie : Config Service +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.55 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/tspconfig.yaml b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/tspconfig.yaml new file mode 100644 index 000000000000..f3760e58bc88 --- /dev/null +++ b/specification/awsconnector/ConfigServiceConfigurationRecorderStatus.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/configServiceConfigurationRecorderStatus.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_CreateOrReplace.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_CreateOrReplace.json new file mode 100644 index 000000000000..17bafce66d3a --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "ConfigServiceDeliveryChannels_CreateOrReplace", + "operationId": "ConfigServiceDeliveryChannels_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + } + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Delete.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Delete.json new file mode 100644 index 000000000000..38eb40a966ba --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceDeliveryChannels_Delete", + "operationId": "ConfigServiceDeliveryChannels_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Get.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Get.json new file mode 100644 index 000000000000..d7ef897bd3f8 --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Get.json @@ -0,0 +1,55 @@ +{ + "title": "ConfigServiceDeliveryChannels_Get", + "operationId": "ConfigServiceDeliveryChannels_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListByResourceGroup.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListByResourceGroup.json new file mode 100644 index 000000000000..2aaf344b6fa4 --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "ConfigServiceDeliveryChannels_ListByResourceGroup", + "operationId": "ConfigServiceDeliveryChannels_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListBySubscription.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListBySubscription.json new file mode 100644 index 000000000000..7a2f159eaff1 --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "ConfigServiceDeliveryChannels_ListBySubscription", + "operationId": "ConfigServiceDeliveryChannels_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Update.json b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Update.json new file mode 100644 index 000000000000..bd41285e7c0b --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/examples/2024-12-01/ConfigServiceDeliveryChannels_Update.json @@ -0,0 +1,65 @@ +{ + "title": "ConfigServiceDeliveryChannels_Update", + "operationId": "ConfigServiceDeliveryChannels_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7397": "invrdhnkjivqigdyp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/main.tsp b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/main.tsp new file mode 100644 index 000000000000..f964910925d3 --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/main.tsp @@ -0,0 +1,166 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ConfigServiceDeliveryChannels ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Config Service Delivery Channel", + plural: "Config Service Delivery Channels", + }, + keywords: [ + "Microsoft.AwsConnector", + "Config ", + "Service", + "Delivery", + "Channel" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ConfigServiceDeliveryChannel + is TrackedResource<ConfigServiceDeliveryChannelProperties> { + @doc("Name of ConfigServiceDeliveryChannel") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("configServiceDeliveryChannels") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigServiceDeliveryChannel") +model ConfigServiceDeliveryChannelProperties { + @doc("AWS Properties") + awsProperties?: AwsConfigServiceDeliveryChannelProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsConfigServiceDeliveryChannel") +model AwsConfigServiceDeliveryChannelProperties { + @doc("<p>The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.</p>") + configSnapshotDeliveryProperties?: ConfigSnapshotDeliveryProperties; + + @doc("<p>The name of the delivery channel. By default, Config assigns the name 'default' when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.</p>") + name?: string; + + @doc("<p>The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.</p> <p>If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html'>Permissions for the Amazon S3 Bucket</a> in the <i>Config Developer Guide</i>.</p>") + s3BucketName?: string; + + @doc("<p>The prefix for the specified Amazon S3 bucket.</p>") + s3KeyPrefix?: string; + + @doc("<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.</p>") + s3KmsKeyArn?: string; + + @doc("<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.</p> <p>If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html'>Permissions for the Amazon SNS Topic</a> in the <i>Config Developer Guide</i>.</p>") + snsTopicARN?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigSnapshotDeliveryProperties") +model ConfigSnapshotDeliveryProperties { + @doc("<p>The frequency with which Config delivers configuration snapshots.</p>") + deliveryFrequency?: MaximumExecutionFrequencyEnumValue; +} + +@doc("MaximumExecutionFrequency enum") +union MaximumExecutionFrequency { + @doc("MaximumExecutionFrequency enum One_Hour") + One_Hour: "One_Hour", + + @doc("MaximumExecutionFrequency enum Six_Hours") + Six_Hours: "Six_Hours", + + @doc("MaximumExecutionFrequency enum Three_Hours") + Three_Hours: "Three_Hours", + + @doc("MaximumExecutionFrequency enum Twelve_Hours") + Twelve_Hours: "Twelve_Hours", + + @doc("MaximumExecutionFrequency enum TwentyFour_Hours") + TwentyFour_Hours: "TwentyFour_Hours", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MaximumExecutionFrequencyEnumValue") +model MaximumExecutionFrequencyEnumValue { + @doc("Property value") + value?: MaximumExecutionFrequency; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ConfigServiceDeliveryChannels { + get is ArmResourceRead<ConfigServiceDeliveryChannel>; + @doc("Create a ConfigServiceDeliveryChannel. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ConfigServiceDeliveryChannel>; + update is ArmCustomPatchAsync< + ConfigServiceDeliveryChannel, + Azure.ResourceManager.Foundations.TagsUpdateModel<ConfigServiceDeliveryChannel> + >; + delete is ArmResourceDeleteWithoutOkAsync<ConfigServiceDeliveryChannel>; + listByResourceGroup is ArmResourceListByParent<ConfigServiceDeliveryChannel>; + listBySubscription is ArmListBySubscription<ConfigServiceDeliveryChannel>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\config\config-2014-11-12.normal.json +// AWS Shape: DeliveryChannel +// +// Related information for backend service: +// AWS Servcie : Config Service +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.55 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ConfigServiceDeliveryChannel.Management/tspconfig.yaml b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/tspconfig.yaml new file mode 100644 index 000000000000..d65622609f24 --- /dev/null +++ b/specification/awsconnector/ConfigServiceDeliveryChannel.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/configServiceDeliveryChannel.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json new file mode 100644 index 000000000000..5ef08fd52c52 --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json @@ -0,0 +1,277 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", + "operationId": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + } + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + } + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Delete.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Delete.json new file mode 100644 index 000000000000..5879bd50dbb4 --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Delete", + "operationId": "DatabaseMigrationServiceReplicationInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Get.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Get.json new file mode 100644 index 000000000000..e400ae964715 --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Get.json @@ -0,0 +1,104 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Get", + "operationId": "DatabaseMigrationServiceReplicationInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + } + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..b22ef6926cb1 --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json @@ -0,0 +1,108 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", + "operationId": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json new file mode 100644 index 000000000000..53383e2fa53f --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json @@ -0,0 +1,107 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", + "operationId": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Update.json b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Update.json new file mode 100644 index 000000000000..d5a926d7499a --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/examples/2024-12-01/DatabaseMigrationServiceReplicationInstances_Update.json @@ -0,0 +1,114 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Update", + "operationId": "DatabaseMigrationServiceReplicationInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4401": "wvciimt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/main.tsp b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/main.tsp new file mode 100644 index 000000000000..53e881a7d18c --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/main.tsp @@ -0,0 +1,276 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- DatabaseMigrationServiceReplicationInstances ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Database Migration Service Replication Instance", + plural: "Database Migration Service Replication Instances", + }, + keywords: [ + "Microsoft.AwsConnector", + "Database ", + "Migration ", + "Service", + "Replication", + "Instance" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model DatabaseMigrationServiceReplicationInstance + is TrackedResource<DatabaseMigrationServiceReplicationInstanceProperties> { + @doc("Name of DatabaseMigrationServiceReplicationInstance") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("databaseMigrationServiceReplicationInstances") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DatabaseMigrationServiceReplicationInstance") +model DatabaseMigrationServiceReplicationInstanceProperties { + @doc("AWS Properties") + awsProperties?: AwsDatabaseMigrationServiceReplicationInstanceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsDatabaseMigrationServiceReplicationInstance") +model AwsDatabaseMigrationServiceReplicationInstanceProperties { + @doc("<p>The amount of storage (in gigabytes) that is allocated for the replication instance.</p>") + allocatedStorage?: int32; + + @doc("<p>Boolean value indicating if minor version upgrades will be automatically applied to the instance.</p>") + autoMinorVersionUpgrade?: boolean; + + @doc("<p>The Availability Zone for the instance.</p>") + availabilityZone?: string; + + @doc("<p>The DNS name servers supported for the replication instance to access your on-premise source or target database.</p>") + dnsNameServers?: string; + + @doc("<p>The engine version number of the replication instance.</p> <p>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>") + engineVersion?: string; + + @doc("<p> The expiration date of the free replication instance that is part of the Free DMS program. </p>") + freeUntil?: utcDateTime; + + @doc("<p>The time the replication instance was created.</p>") + instanceCreateTime?: utcDateTime; + + @doc("<p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>") + kmsKeyId?: string; + + @doc("<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>") + multiAZ?: boolean; + + @doc("<p>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>") + networkType?: string; + + @doc("<p>The pending modification values.</p>") + pendingModifiedValues?: ReplicationPendingModifiedValues; + + @doc("<p>The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.</p>") + preferredMaintenanceWindow?: string; + + @doc("<p> Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>. </p>") + publiclyAccessible?: boolean; + + @doc("<p>The Amazon Resource Name (ARN) of the replication instance.</p>") + replicationInstanceArn?: string; + + @doc("<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'> Selecting the right DMS replication instance for your migration</a>. </p>") + replicationInstanceClass?: string; + + @doc("<p>The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>") + replicationInstanceIdentifier?: string; + + @doc("<p>One or more IPv6 addresses for the replication instance.</p>") + @extension("x-ms-identifiers", []) + replicationInstanceIpv6Addresses?: string[]; + + @doc("<p>The private IP address of the replication instance.</p>") + replicationInstancePrivateIpAddress?: string; + + @doc("<p>One or more private IP addresses for the replication instance.</p>") + @extension("x-ms-identifiers", []) + replicationInstancePrivateIpAddresses?: string[]; + + @doc("<p>The public IP address of the replication instance.</p>") + replicationInstancePublicIpAddress?: string; + + @doc("<p>One or more public IP addresses for the replication instance.</p>") + @extension("x-ms-identifiers", []) + replicationInstancePublicIpAddresses?: string[]; + + @doc("<p>The status of the replication instance. The possible return values include:</p> <ul> <li> <p> <code>'available'</code> </p> </li> <li> <p> <code>'creating'</code> </p> </li> <li> <p> <code>'deleted'</code> </p> </li> <li> <p> <code>'deleting'</code> </p> </li> <li> <p> <code>'failed'</code> </p> </li> <li> <p> <code>'modifying'</code> </p> </li> <li> <p> <code>'upgrading'</code> </p> </li> <li> <p> <code>'rebooting'</code> </p> </li> <li> <p> <code>'resetting-master-credentials'</code> </p> </li> <li> <p> <code>'storage-full'</code> </p> </li> <li> <p> <code>'incompatible-credentials'</code> </p> </li> <li> <p> <code>'incompatible-network'</code> </p> </li> <li> <p> <code>'maintenance'</code> </p> </li> </ul>") + replicationInstanceStatus?: string; + + @doc("<p>The subnet group for the replication instance.</p>") + replicationSubnetGroup?: ReplicationSubnetGroup; + + @doc("<p>The Availability Zone of the standby replication instance in a Multi-AZ deployment.</p>") + secondaryAvailabilityZone?: string; + + @doc("<p>The VPC security group for the instance.</p>") + @extension("x-ms-identifiers", []) + vpcSecurityGroups?: VpcSecurityGroupMembership[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationPendingModifiedValues") +model ReplicationPendingModifiedValues { + @doc("<p>The amount of storage (in gigabytes) that is allocated for the replication instance.</p>") + allocatedStorage?: int32; + + @doc("<p>The engine version number of the replication instance.</p>") + engineVersion?: string; + + @doc("<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>") + multiAZ?: boolean; + + @doc("<p>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>") + networkType?: string; + + @doc("<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'> Selecting the right DMS replication instance for your migration</a>. </p>") + replicationInstanceClass?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationSubnetGroup") +model ReplicationSubnetGroup { + @doc("<p>A description for the replication subnet group.</p>") + replicationSubnetGroupDescription?: string; + + @doc("<p>The identifier of the replication instance subnet group.</p>") + replicationSubnetGroupIdentifier?: string; + + @doc("<p>The status of the subnet group.</p>") + subnetGroupStatus?: string; + + @doc("<p>The subnets that are in the subnet group.</p>") + @extension("x-ms-identifiers", []) + subnets?: Subnet[]; + + @doc("<p>The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>") + @extension("x-ms-identifiers", []) + supportedNetworkTypes?: string[]; + + @doc("<p>The ID of the VPC.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VpcSecurityGroupMembership") +model VpcSecurityGroupMembership { + @doc("<p>The status of the VPC security group.</p>") + status?: string; + + @doc("<p>The VPC security group ID.</p>") + vpcSecurityGroupId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Subnet") +model Subnet { + @doc("<p>The Availability Zone of the subnet.</p>") + subnetAvailabilityZone?: AvailabilityZone; + + @doc("<p>The subnet identifier.</p>") + subnetIdentifier?: string; + + @doc("<p>The status of the subnet.</p>") + subnetStatus?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AvailabilityZone") +model AvailabilityZone { + @doc("<p>The name of the Availability Zone.</p>") + name?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface DatabaseMigrationServiceReplicationInstances { + get is ArmResourceRead<DatabaseMigrationServiceReplicationInstance>; + @doc("Create a DatabaseMigrationServiceReplicationInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<DatabaseMigrationServiceReplicationInstance>; + update is ArmCustomPatchAsync< + DatabaseMigrationServiceReplicationInstance, + Azure.ResourceManager.Foundations.TagsUpdateModel<DatabaseMigrationServiceReplicationInstance> + >; + delete is ArmResourceDeleteWithoutOkAsync<DatabaseMigrationServiceReplicationInstance>; + listByResourceGroup is ArmResourceListByParent<DatabaseMigrationServiceReplicationInstance>; + listBySubscription is ArmListBySubscription<DatabaseMigrationServiceReplicationInstance>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\dms\dms-2016-01-01.normal.json +// AWS Shape: ReplicationInstance +// +// Related information for backend service: +// AWS Servcie : Database Migration Service +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.82 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/tspconfig.yaml b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/tspconfig.yaml new file mode 100644 index 000000000000..05c4dfe712cf --- /dev/null +++ b/specification/awsconnector/DatabaseMigrationServiceReplicationInstance.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/databaseMigrationServiceReplicationInstance.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_CreateOrReplace.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_CreateOrReplace.json new file mode 100644 index 000000000000..bf8abbf11d18 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_CreateOrReplace.json @@ -0,0 +1,271 @@ +{ + "title": "DaxClusters_CreateOrReplace", + "operationId": "DaxClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + } + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + } + } +} diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Delete.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Delete.json new file mode 100644 index 000000000000..204f98e668f5 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DaxClusters_Delete", + "operationId": "DaxClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Get.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Get.json new file mode 100644 index 000000000000..9ed848473df6 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Get.json @@ -0,0 +1,102 @@ +{ + "title": "DaxClusters_Get", + "operationId": "DaxClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + } + } +} diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListByResourceGroup.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..fde01ef3574b --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListByResourceGroup.json @@ -0,0 +1,106 @@ +{ + "title": "DaxClusters_ListByResourceGroup", + "operationId": "DaxClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListBySubscription.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListBySubscription.json new file mode 100644 index 000000000000..ea68600bd8dd --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_ListBySubscription.json @@ -0,0 +1,105 @@ +{ + "title": "DaxClusters_ListBySubscription", + "operationId": "DaxClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Update.json b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Update.json new file mode 100644 index 000000000000..f955396ef599 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/examples/2024-12-01/DaxClusters_Update.json @@ -0,0 +1,112 @@ +{ + "title": "DaxClusters_Update", + "operationId": "DaxClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3464": "umdxculs" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/DaxCluster.Management/main.tsp b/specification/awsconnector/DaxCluster.Management/main.tsp new file mode 100644 index 000000000000..7110a7636352 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/main.tsp @@ -0,0 +1,300 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- DaxClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "DAX Cluster", + plural: "DAX Clusters", + }, + keywords: ["Microsoft.AwsConnector", "DAX", "Cluster"], +}) +@doc("A Microsoft.AwsConnector resource") +model DaxCluster is TrackedResource<DaxClusterProperties> { + @doc("Name of DaxCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("daxClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DaxCluster") +model DaxClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsDaxClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsDaxCluster") +model AwsDaxClusterProperties { + @doc("<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p>") + activeNodes?: int32; + + @doc("<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p>") + clusterArn?: string; + + @doc("<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p>") + clusterDiscoveryEndpoint?: Endpoint; + + @doc("<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul>") + clusterEndpointEncryptionType?: ClusterEndpointEncryptionTypeEnumValue; + + @doc("<p>The name of the DAX cluster.</p>") + clusterName?: string; + + @doc("<p>The description of the cluster.</p>") + description?: string; + + @doc("<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p>") + iamRoleArn?: string; + + @doc("<p>A list of nodes to be removed from the cluster.</p>") + @extension("x-ms-identifiers", []) + nodeIdsToRemove?: string[]; + + @doc("<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p>") + nodeType?: string; + + @doc("<p>A list of nodes that are currently in the cluster.</p>") + @extension("x-ms-identifiers", []) + nodes?: Node[]; + + @doc("<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p>") + notificationConfiguration?: NotificationConfiguration; + + @doc("<p>The parameter group being used by nodes in the cluster.</p>") + parameterGroup?: ParameterGroupStatus; + + @doc("<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p>") + preferredMaintenanceWindow?: string; + + @doc("<p>The description of the server-side encryption status on the specified DAX cluster.</p>") + sseDescription?: SSEDescription; + + @doc("<p>A list of security groups, and the status of each, for the nodes in the cluster.</p>") + @extension("x-ms-identifiers", []) + securityGroups?: SecurityGroupMembership[]; + + @doc("<p>The current status of the cluster.</p>") + status?: string; + + @doc("<p>The subnet group where the DAX cluster is running.</p>") + subnetGroup?: string; + + @doc("<p>The total number of nodes in the cluster.</p>") + totalNodes?: int32; +} + +@doc("ClusterEndpointEncryptionType enum") +union ClusterEndpointEncryptionType { + @doc("ClusterEndpointEncryptionType enum NONE") + NONE: "NONE", + + @doc("ClusterEndpointEncryptionType enum TLS") + TLS: "TLS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterEndpointEncryptionTypeEnumValue") +model ClusterEndpointEncryptionTypeEnumValue { + @doc("Property value") + value?: ClusterEndpointEncryptionType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Endpoint") +model Endpoint { + @doc("<p>The DNS hostname of the endpoint.</p>") + address?: string; + + @doc("<p>The port number that applications should use to connect to the endpoint.</p>") + port?: int32; + + @doc("<p>The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.</p>") + url?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Node") +model Node { + @doc("<p>The Availability Zone (AZ) in which the node has been deployed.</p>") + availabilityZone?: string; + + @doc("<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p>") + endpoint?: Endpoint; + + @doc("<p>The date and time (in UNIX epoch format) when the node was launched.</p>") + nodeCreateTime?: utcDateTime; + + @doc("<p>A system-generated identifier for the node.</p>") + nodeId?: string; + + @doc("<p>The current status of the node. For example: <code>available</code>.</p>") + nodeStatus?: string; + + @doc("<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p>") + parameterGroupStatus?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NotificationConfiguration") +model NotificationConfiguration { + @doc("<p>The Amazon Resource Name (ARN) that identifies the topic. </p>") + topicArn?: string; + + @doc("<p>The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.</p>") + topicStatus?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ParameterGroupStatus") +model ParameterGroupStatus { + @doc("<p>The node IDs of one or more nodes to be rebooted.</p>") + @extension("x-ms-identifiers", []) + nodeIdsToReboot?: string[]; + + @doc("<p>The status of parameter updates. </p>") + parameterApplyStatus?: string; + + @doc("<p>The name of the parameter group.</p>") + parameterGroupName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SSEDescription") +model SSEDescription { + @doc("<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>") + status?: SSEStatusEnumValue; +} + +@doc("SSEStatus enum") +union SSEStatus { + @doc("SSEStatus enum DISABLED") + DISABLED: "DISABLED", + + @doc("SSEStatus enum DISABLING") + DISABLING: "DISABLING", + + @doc("SSEStatus enum ENABLED") + ENABLED: "ENABLED", + + @doc("SSEStatus enum ENABLING") + ENABLING: "ENABLING", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SSEStatusEnumValue") +model SSEStatusEnumValue { + @doc("Property value") + value?: SSEStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SecurityGroupMembership") +model SecurityGroupMembership { + @doc("<p>The unique ID for this security group.</p>") + securityGroupIdentifier?: string; + + @doc("<p>The status of this security group.</p>") + status?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface DaxClusters { + get is ArmResourceRead<DaxCluster>; + @doc("Create a DaxCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<DaxCluster>; + update is ArmCustomPatchAsync< + DaxCluster, + Azure.ResourceManager.Foundations.TagsUpdateModel<DaxCluster> + >; + delete is ArmResourceDeleteWithoutOkAsync<DaxCluster>; + listByResourceGroup is ArmResourceListByParent<DaxCluster>; + listBySubscription is ArmListBySubscription<DaxCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\dax\dax-2017-04-19.normal.json +// AWS Shape: Cluster +// +// Related information for backend service: +// AWS Servcie : DAX +// Product Version : 3.7.798.0 +// SDK Version : 3.7.300.83 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/DaxCluster.Management/tspconfig.yaml b/specification/awsconnector/DaxCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..02d7025a86d7 --- /dev/null +++ b/specification/awsconnector/DaxCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/daxCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json new file mode 100644 index 000000000000..005131b6dfb2 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_CreateOrReplace", + "operationId": "DynamoDbContinuousBackupsDescriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + } + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + } + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Delete.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Delete.json new file mode 100644 index 000000000000..493e82f3b22c --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Delete", + "operationId": "DynamoDbContinuousBackupsDescriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Get.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Get.json new file mode 100644 index 000000000000..f7f108c75a01 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Get.json @@ -0,0 +1,55 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Get", + "operationId": "DynamoDbContinuousBackupsDescriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + } + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..cbaa3af0ee71 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup", + "operationId": "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json new file mode 100644 index 000000000000..c4a7d2823b53 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_ListBySubscription", + "operationId": "DynamoDbContinuousBackupsDescriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Update.json b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Update.json new file mode 100644 index 000000000000..45105a1d3bc3 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/examples/2024-12-01/DynamoDbContinuousBackupsDescriptions_Update.json @@ -0,0 +1,65 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Update", + "operationId": "DynamoDbContinuousBackupsDescriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5810": "lxzzovaxoagbrbvsf" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/main.tsp b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/main.tsp new file mode 100644 index 000000000000..a54579653fe5 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/main.tsp @@ -0,0 +1,173 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- DynamoDBContinuousBackupsDescriptions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Dynamo DB Continuous Backups Description", + plural: "Dynamo DB Continuous Backups Descriptions", + }, + keywords: [ + "Microsoft.AwsConnector", + "Dynamo", + "DB", + "Continuous", + "Backups", + "Description" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model DynamoDBContinuousBackupsDescription + is TrackedResource<DynamoDBContinuousBackupsDescriptionProperties> { + @doc("Name of DynamoDBContinuousBackupsDescription") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("dynamoDBContinuousBackupsDescriptions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DynamoDBContinuousBackupsDescription") +model DynamoDBContinuousBackupsDescriptionProperties { + @doc("AWS Properties") + awsProperties?: AwsDynamoDBContinuousBackupsDescriptionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsDynamoDBContinuousBackupsDescription") +model AwsDynamoDBContinuousBackupsDescriptionProperties { + @doc("<p> <code>ContinuousBackupsStatus</code> can be one of the following states: ENABLED, DISABLED</p>") + continuousBackupsStatus?: ContinuousBackupsStatusEnumValue; + + @doc("<p>The description of the point in time recovery settings applied to the table.</p>") + pointInTimeRecoveryDescription?: PointInTimeRecoveryDescription; +} + +@doc("ContinuousBackupsStatus enum") +union ContinuousBackupsStatus { + @doc("ContinuousBackupsStatus enum DISABLED") + DISABLED: "DISABLED", + + @doc("ContinuousBackupsStatus enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ContinuousBackupsStatusEnumValue") +model ContinuousBackupsStatusEnumValue { + @doc("Property value") + value?: ContinuousBackupsStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PointInTimeRecoveryDescription") +model PointInTimeRecoveryDescription { + @doc("<p>Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days. </p>") + earliestRestorableDateTime?: utcDateTime; + + @doc("<p> <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. </p>") + latestRestorableDateTime?: utcDateTime; + + @doc("<p>The current state of point in time recovery:</p> <ul> <li> <p> <code>ENABLED</code> - Point in time recovery is enabled.</p> </li> <li> <p> <code>DISABLED</code> - Point in time recovery is disabled.</p> </li> </ul>") + pointInTimeRecoveryStatus?: PointInTimeRecoveryStatusEnumValue; +} + +@doc("PointInTimeRecoveryStatus enum") +union PointInTimeRecoveryStatus { + @doc("PointInTimeRecoveryStatus enum DISABLED") + DISABLED: "DISABLED", + + @doc("PointInTimeRecoveryStatus enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PointInTimeRecoveryStatusEnumValue") +model PointInTimeRecoveryStatusEnumValue { + @doc("Property value") + value?: PointInTimeRecoveryStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface DynamoDBContinuousBackupsDescriptions { + get is ArmResourceRead<DynamoDBContinuousBackupsDescription>; + @doc("Create a DynamoDBContinuousBackupsDescription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<DynamoDBContinuousBackupsDescription>; + update is ArmCustomPatchAsync< + DynamoDBContinuousBackupsDescription, + Azure.ResourceManager.Foundations.TagsUpdateModel<DynamoDBContinuousBackupsDescription> + >; + delete is ArmResourceDeleteWithoutOkAsync<DynamoDBContinuousBackupsDescription>; + listByResourceGroup is ArmResourceListByParent<DynamoDBContinuousBackupsDescription>; + listBySubscription is ArmListBySubscription<DynamoDBContinuousBackupsDescription>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\dynamodb\dynamodb-2012-08-10.normal.json +// AWS Shape: ContinuousBackupsDescription +// +// Related information for backend service: +// AWS Servcie : DynamoDB +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.24 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/tspconfig.yaml b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/tspconfig.yaml new file mode 100644 index 000000000000..dc7182f58c85 --- /dev/null +++ b/specification/awsconnector/DynamoDBContinuousBackupsDescription.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/dynamoDBContinuousBackupsDescription.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_CreateOrReplace.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_CreateOrReplace.json new file mode 100644 index 000000000000..8de5997b48ab --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_CreateOrReplace.json @@ -0,0 +1,430 @@ +{ + "title": "DynamoDbTables_CreateOrReplace", + "operationId": "DynamoDbTables_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + } + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + } + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Delete.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Delete.json new file mode 100644 index 000000000000..ff065f650b5a --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DynamoDbTables_Delete", + "operationId": "DynamoDbTables_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Get.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Get.json new file mode 100644 index 000000000000..d0dc64beba16 --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Get.json @@ -0,0 +1,155 @@ +{ + "title": "DynamoDbTables_Get", + "operationId": "DynamoDbTables_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + } + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListByResourceGroup.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListByResourceGroup.json new file mode 100644 index 000000000000..71da58ddec14 --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListByResourceGroup.json @@ -0,0 +1,159 @@ +{ + "title": "DynamoDbTables_ListByResourceGroup", + "operationId": "DynamoDbTables_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListBySubscription.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListBySubscription.json new file mode 100644 index 000000000000..aee8cf381953 --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_ListBySubscription.json @@ -0,0 +1,158 @@ +{ + "title": "DynamoDbTables_ListBySubscription", + "operationId": "DynamoDbTables_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Update.json b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Update.json new file mode 100644 index 000000000000..dd2fb464ac2e --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/examples/2024-12-01/DynamoDbTables_Update.json @@ -0,0 +1,165 @@ +{ + "title": "DynamoDbTables_Update", + "operationId": "DynamoDbTables_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6429": "nawwkfqhaidvxvsiy" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/DynamoDBTable.Management/main.tsp b/specification/awsconnector/DynamoDBTable.Management/main.tsp new file mode 100644 index 000000000000..46932c1b7b60 --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/main.tsp @@ -0,0 +1,421 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- DynamoDBTables ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Dynamo DB Table", + plural: "Dynamo DB Tables", + }, + keywords: ["Microsoft.AwsConnector", "Dynamo", "DB", "Table"], +}) +@doc("A Microsoft.AwsConnector resource") +model DynamoDBTable is TrackedResource<DynamoDBTableProperties> { + @doc("Name of DynamoDBTable") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("dynamoDBTables") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DynamoDBTable") +model DynamoDBTableProperties { + @doc("AWS Properties") + awsProperties?: AwsDynamoDBTableProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsDynamoDBTable") +model AwsDynamoDBTableProperties { + @doc("Property arn") + arn?: string; + + @doc("A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.") + @extension("x-ms-identifiers", []) + attributeDefinitions?: AttributeDefinition[]; + + @doc("Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). If not specified, the default is ``PROVISIONED``.") + billingMode?: string; + + @doc("The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights.") + contributorInsightsSpecification?: ContributorInsightsSpecification; + + @doc("Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*.") + deletionProtectionEnabled?: boolean; + + @doc("Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.") + @extension("x-ms-identifiers", []) + globalSecondaryIndexes?: GlobalSecondaryIndex[]; + + @doc("Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. Specifies the properties of data being imported from the S3 bucket source to the table.") + importSourceSpecification?: ImportSourceSpecification; + + @doc("Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.") + @extension("x-ms-identifiers", []) + keySchema?: KeySchema[]; + + @doc("The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table.") + kinesisStreamSpecification?: KinesisStreamSpecification; + + @doc("Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.") + @extension("x-ms-identifiers", []) + localSecondaryIndexes?: LocalSecondaryIndex[]; + + @doc("The settings used to enable point in time recovery. The settings used to enable point in time recovery.") + pointInTimeRecoverySpecification?: PointInTimeRecoverySpecification; + + @doc("Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).") + provisionedThroughput?: ProvisionedThroughput; + + @doc("A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).") + resourcePolicy?: ResourcePolicy; + + @doc("Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption.") + sseSpecification?: SSESpecification; + + @doc("Property streamArn") + streamArn?: string; + + @doc("The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB.") + streamSpecification?: StreamSpecification; + + @doc("The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``.") + tableClass?: string; + + @doc("A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + tableName?: string; + + @doc("An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table.") + timeToLiveSpecification?: TimeToLiveSpecification; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AttributeDefinition") +model AttributeDefinition { + @doc("A name for the attribute.") + attributeName?: string; + + @doc("The data type for the attribute, where: + ``S`` - the attribute is of type String + ``N`` - the attribute is of type Number + ``B`` - the attribute is of type Binary") + attributeType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ContributorInsightsSpecification") +model ContributorInsightsSpecification { + @doc("Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false).") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GlobalSecondaryIndex") +model GlobalSecondaryIndex { + @doc("The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights.") + contributorInsightsSpecification?: ContributorInsightsSpecification; + + @doc("The name of the global secondary index. The name must be unique among all other indexes on this table.") + indexName?: string; + + @doc("The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.") + @extension("x-ms-identifiers", []) + keySchema?: KeySchema[]; + + @doc("Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.") + `projection`?: Projection; + + @doc("Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html).") + provisionedThroughput?: ProvisionedThroughput; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImportSourceSpecification") +model ImportSourceSpecification { + @doc("Type of compression to be used on the input coming from the imported table.") + inputCompressionType?: string; + + @doc("The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``.") + inputFormat?: string; + + @doc("Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption.") + inputFormatOptions?: InputFormatOptions; + + @doc("The S3 bucket that provides the source for the import. The S3 bucket that is being imported from.") + s3BucketSource?: S3BucketSource; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KeySchema") +model KeySchema { + @doc("The name of a key attribute.") + attributeName?: string; + + @doc("The role that this key attribute will assume: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.") + keyType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KinesisStreamSpecification") +model KinesisStreamSpecification { + @doc("The precision for the time and date that the stream was created.") + approximateCreationDateTimePrecision?: KinesisStreamSpecificationApproximateCreationDateTimePrecision; + + @doc("The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024.") + streamArn?: string; +} + +@doc("KinesisStreamSpecificationApproximateCreationDateTimePrecision enum") +union KinesisStreamSpecificationApproximateCreationDateTimePrecision { + @doc("KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MICROSECOND") + MICROSECOND: "MICROSECOND", + + @doc("KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MILLISECOND") + MILLISECOND: "MILLISECOND", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LocalSecondaryIndex") +model LocalSecondaryIndex { + @doc("The name of the local secondary index. The name must be unique among all other indexes on this table.") + indexName?: string; + + @doc("The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.") + @extension("x-ms-identifiers", []) + keySchema?: KeySchema[]; + + @doc("Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.") + `projection`?: Projection; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PointInTimeRecoverySpecification") +model PointInTimeRecoverySpecification { + @doc("Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.") + pointInTimeRecoveryEnabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProvisionedThroughput") +model ProvisionedThroughput { + @doc("The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.") + readCapacityUnits?: int32; + + @doc("The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0.") + writeCapacityUnits?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourcePolicy") +model ResourcePolicy { + @doc("A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html).") + policyDocument?: unknown; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SSESpecification") +model SSESpecification { + @doc("The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``.") + kmsMasterKeyId?: string; + + @doc("Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key.") + sseEnabled?: boolean; + + @doc("Server-side encryption type. The only supported value is: + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply).") + sseType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StreamSpecification") +model StreamSpecification { + @doc("Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html).") + resourcePolicy?: ResourcePolicy; + + @doc("When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream.") + streamViewType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.") + key?: string; + + @doc("The value of the tag. Tag values are case-sensitive and can be null.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TimeToLiveSpecification") +model TimeToLiveSpecification { + @doc("The name of the TTL attribute used to store the expiration time for items in the table. + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name.") + attributeName?: string; + + @doc("Indicates whether TTL is to be enabled (true) or disabled (false) on the table.") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Projection") +model Projection { + @doc("Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.") + @extension("x-ms-identifiers", []) + nonKeyAttributes?: string[]; + + @doc("The set of attributes that are projected into the index: + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default.") + projectionType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InputFormatOptions") +model InputFormatOptions { + @doc("The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList.") + csv?: Csv; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3BucketSource") +model S3BucketSource { + @doc("The S3 bucket that is being imported from.") + s3Bucket?: string; + + @doc("The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.") + s3BucketOwner?: string; + + @doc("The key prefix shared by all S3 Objects that are being imported.") + s3KeyPrefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Csv") +model Csv { + @doc("The delimiter used for separating items in the CSV file being imported.") + delimiter?: string; + + @doc("List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.") + @extension("x-ms-identifiers", []) + headerList?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface DynamoDBTables { + get is ArmResourceRead<DynamoDBTable>; + @doc("Create a DynamoDBTable. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<DynamoDBTable>; + update is ArmCustomPatchAsync< + DynamoDBTable, + Azure.ResourceManager.Foundations.TagsUpdateModel<DynamoDBTable> + >; + delete is ArmResourceDeleteWithoutOkAsync<DynamoDBTable>; + listByResourceGroup is ArmResourceListByParent<DynamoDBTable>; + listBySubscription is ArmListBySubscription<DynamoDBTable>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::DynamoDB::Table +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/DynamoDBTable.Management/tspconfig.yaml b/specification/awsconnector/DynamoDBTable.Management/tspconfig.yaml new file mode 100644 index 000000000000..1ee8c8b14666 --- /dev/null +++ b/specification/awsconnector/DynamoDBTable.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/dynamoDBTable.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_CreateOrReplace.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_CreateOrReplace.json new file mode 100644 index 000000000000..5dd056a54243 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "Ec2AccountAttributes_CreateOrReplace", + "operationId": "Ec2AccountAttributes_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + } + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Delete.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Delete.json new file mode 100644 index 000000000000..21cd80d93ab8 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2AccountAttributes_Delete", + "operationId": "Ec2AccountAttributes_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Get.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Get.json new file mode 100644 index 000000000000..dfc5f4ad856a --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Get.json @@ -0,0 +1,51 @@ +{ + "title": "Ec2AccountAttributes_Get", + "operationId": "Ec2AccountAttributes_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListByResourceGroup.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListByResourceGroup.json new file mode 100644 index 000000000000..294386c99005 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "Ec2AccountAttributes_ListByResourceGroup", + "operationId": "Ec2AccountAttributes_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListBySubscription.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListBySubscription.json new file mode 100644 index 000000000000..a39f3cff7259 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "Ec2AccountAttributes_ListBySubscription", + "operationId": "Ec2AccountAttributes_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Update.json b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Update.json new file mode 100644 index 000000000000..676aa3b2ced7 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/examples/2024-12-01/Ec2AccountAttributes_Update.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2AccountAttributes_Update", + "operationId": "Ec2AccountAttributes_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key675": "dcdcpzbhvgkomzutrzgdjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/main.tsp b/specification/awsconnector/Ec2AccountAttribute.Management/main.tsp new file mode 100644 index 000000000000..37beac955a55 --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/main.tsp @@ -0,0 +1,118 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2AccountAttributes ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Account Attribute", + plural: "EC2 Account Attributes", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Account", "Attribute"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2AccountAttribute is TrackedResource<Ec2AccountAttributeProperties> { + @doc("Name of Ec2AccountAttribute") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2AccountAttributes") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2AccountAttribute") +model Ec2AccountAttributeProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2AccountAttributeProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2AccountAttribute") +model AwsEc2AccountAttributeProperties { + @doc("<p>The name of the account attribute.</p>") + attributeName?: string; + + @doc("<p>The values for the account attribute.</p>") + @extension("x-ms-identifiers", []) + attributeValues?: AccountAttributeValue[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccountAttributeValue") +model AccountAttributeValue { + @doc("<p>The value of the attribute.</p>") + attributeValue?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2AccountAttributes { + get is ArmResourceRead<Ec2AccountAttribute>; + @doc("Create a Ec2AccountAttribute. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2AccountAttribute>; + update is ArmCustomPatchAsync< + Ec2AccountAttribute, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2AccountAttribute> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2AccountAttribute>; + listByResourceGroup is ArmResourceListByParent<Ec2AccountAttribute>; + listBySubscription is ArmListBySubscription<Ec2AccountAttribute>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: AccountAttribute +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2AccountAttribute.Management/tspconfig.yaml b/specification/awsconnector/Ec2AccountAttribute.Management/tspconfig.yaml new file mode 100644 index 000000000000..ee24627be65d --- /dev/null +++ b/specification/awsconnector/Ec2AccountAttribute.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2AccountAttribute.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_CreateOrReplace.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_CreateOrReplace.json new file mode 100644 index 000000000000..2517f0a0f5fd --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_CreateOrReplace.json @@ -0,0 +1,163 @@ +{ + "title": "Ec2Addresses_CreateOrReplace", + "operationId": "Ec2Addresses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + } + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Delete.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Delete.json new file mode 100644 index 000000000000..3b9570e77ee0 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Addresses_Delete", + "operationId": "Ec2Addresses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Get.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Get.json new file mode 100644 index 000000000000..33a664243aa2 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Get.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Addresses_Get", + "operationId": "Ec2Addresses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListByResourceGroup.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListByResourceGroup.json new file mode 100644 index 000000000000..3be9d076b894 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2Addresses_ListByResourceGroup", + "operationId": "Ec2Addresses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListBySubscription.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListBySubscription.json new file mode 100644 index 000000000000..f9d593d33eb7 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "title": "Ec2Addresses_ListBySubscription", + "operationId": "Ec2Addresses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Update.json b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Update.json new file mode 100644 index 000000000000..a1b726af51e0 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/examples/2024-12-01/Ec2Addresses_Update.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Addresses_Update", + "operationId": "Ec2Addresses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key976": "okhsskkdfuoqrebdxesgrmpcsif" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Address.Management/main.tsp b/specification/awsconnector/Ec2Address.Management/main.tsp new file mode 100644 index 000000000000..0673feb1f7d2 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/main.tsp @@ -0,0 +1,178 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Addresses ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Address", + plural: "EC2 Addresses", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Address"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Address is TrackedResource<Ec2AddressProperties> { + @doc("Name of Ec2Address") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Addresses") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Address") +model Ec2AddressProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2AddressProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Address") +model AwsEc2AddressProperties { + @doc("<p>The ID representing the allocation of the address.</p>") + allocationId?: string; + + @doc("<p>The ID representing the association of the address with an instance.</p>") + associationId?: string; + + @doc("<p>The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). </p>") + carrierIp?: string; + + @doc("<p>The customer-owned IP address.</p>") + customerOwnedIp?: string; + + @doc("<p>The ID of the customer-owned address pool.</p>") + customerOwnedIpv4Pool?: string; + + @doc("<p>The network (<code>vpc</code>).</p>") + domain?: DomainTypeEnumValue; + + @doc("<p>The ID of the instance that the address is associated with (if any).</p>") + instanceId?: string; + + @doc("<p>The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.</p>") + networkBorderGroup?: string; + + @doc("<p>The ID of the network interface.</p>") + networkInterfaceId?: string; + + @doc("<p>The ID of the Amazon Web Services account that owns the network interface.</p>") + networkInterfaceOwnerId?: string; + + @doc("<p>The private IP address associated with the Elastic IP address.</p>") + privateIpAddress?: string; + + @doc("<p>The Elastic IP address.</p>") + publicIp?: string; + + @doc("<p>The ID of an address pool.</p>") + publicIpv4Pool?: string; + + @doc("<p>Any tags assigned to the Elastic IP address.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("DomainType enum") +union DomainType { + @doc("DomainType enum standard") + Standard: "standard", + + @doc("DomainType enum vpc") + Vpc: "vpc", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DomainTypeEnumValue") +model DomainTypeEnumValue { + @doc("Property value") + value?: DomainType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Addresses { + get is ArmResourceRead<Ec2Address>; + @doc("Create a Ec2Address. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Address>; + update is ArmCustomPatchAsync< + Ec2Address, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Address> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Address>; + listByResourceGroup is ArmResourceListByParent<Ec2Address>; + listBySubscription is ArmListBySubscription<Ec2Address>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: Address +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Address.Management/tspconfig.yaml b/specification/awsconnector/Ec2Address.Management/tspconfig.yaml new file mode 100644 index 000000000000..541f98abfdf4 --- /dev/null +++ b/specification/awsconnector/Ec2Address.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Address.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_CreateOrReplace.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_CreateOrReplace.json new file mode 100644 index 000000000000..56a82e86c3fa --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "Ec2FlowLogs_CreateOrReplace", + "operationId": "Ec2FlowLogs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + } + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Delete.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Delete.json new file mode 100644 index 000000000000..21c4ddde163b --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2FlowLogs_Delete", + "operationId": "Ec2FlowLogs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Get.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Get.json new file mode 100644 index 000000000000..a9170f864f1e --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Get.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2FlowLogs_Get", + "operationId": "Ec2FlowLogs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListByResourceGroup.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListByResourceGroup.json new file mode 100644 index 000000000000..11e021fa1017 --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "Ec2FlowLogs_ListByResourceGroup", + "operationId": "Ec2FlowLogs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListBySubscription.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListBySubscription.json new file mode 100644 index 000000000000..aa50d956dd96 --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2FlowLogs_ListBySubscription", + "operationId": "Ec2FlowLogs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Update.json b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Update.json new file mode 100644 index 000000000000..3d3ee8a7f1d5 --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/examples/2024-12-01/Ec2FlowLogs_Update.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2FlowLogs_Update", + "operationId": "Ec2FlowLogs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6176": "oqawryfimbztptk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2FlowLog.Management/main.tsp b/specification/awsconnector/Ec2FlowLog.Management/main.tsp new file mode 100644 index 000000000000..f8df95105df2 --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/main.tsp @@ -0,0 +1,223 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2FlowLogs ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Flow Log", + plural: "EC2 Flow Logs", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Flow", "Log"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2FlowLog is TrackedResource<Ec2FlowLogProperties> { + @doc("Name of Ec2FlowLog") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2FlowLogs") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2FlowLog") +model Ec2FlowLogProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2FlowLogProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2FlowLog") +model AwsEc2FlowLogProperties { + @doc("The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts.") + deliverCrossAccountRole?: string; + + @doc("The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.") + deliverLogsPermissionArn?: string; + + @doc("Property destinationOptions") + destinationOptions?: DestinationOptionsModelProperties; + + @doc("The Flow Log ID") + id?: string; + + @doc("Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType.") + logDestination?: string; + + @doc("Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.") + logDestinationType?: LogDestinationType; + + @doc("The fields to include in the flow log record, in the order in which they should appear.") + logFormat?: string; + + @doc("The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName.") + logGroupName?: string; + + @doc("The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).") + maxAggregationInterval?: int32; + + @doc("The ID of the subnet, network interface, or VPC for which you want to create a flow log.") + resourceId?: string; + + @doc("The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.") + resourceType?: ResourceType; + + @doc("The tags to apply to the flow logs.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.") + trafficType?: TrafficType; +} + +@doc("LogDestinationType enum") +union LogDestinationType { + @doc("LogDestinationType enum cloud-watch-logs") + CloudWatchLogs: "cloud-watch-logs", + + @doc("LogDestinationType enum kinesis-data-firehose") + KinesisDataFirehose: "kinesis-data-firehose", + + @doc("LogDestinationType enum s3") + s3: "s3", + + string, +} + +@doc("TrafficType enum") +union TrafficType { + @doc("TrafficType enum ACCEPT") + ACCEPT: "ACCEPT", + + @doc("TrafficType enum ALL") + ALL: "ALL", + + @doc("TrafficType enum REJECT") + REJECT: "REJECT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DestinationOptionsModelProperties") +model DestinationOptionsModelProperties { + @doc("Property fileFormat") + fileFormat?: FileFormat; + + @doc("Property hiveCompatiblePartitions") + hiveCompatiblePartitions?: boolean; + + @doc("Property perHourPartition") + perHourPartition?: boolean; +} + +@doc("ResourceType enum") +union ResourceType { + @doc("ResourceType enum NetworkInterface") + NetworkInterface: "NetworkInterface", + + @doc("ResourceType enum Subnet") + Subnet: "Subnet", + + @doc("ResourceType enum TransitGateway") + TransitGateway: "TransitGateway", + + @doc("ResourceType enum TransitGatewayAttachment") + TransitGatewayAttachment: "TransitGatewayAttachment", + + @doc("ResourceType enum VPC") + VPC: "VPC", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +@doc("FileFormat enum") +union FileFormat { + @doc("FileFormat enum parquet") + parquet: "parquet", + + @doc("FileFormat enum plain-text") + PlainText: "plain-text", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2FlowLogs { + get is ArmResourceRead<Ec2FlowLog>; + @doc("Create a Ec2FlowLog. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2FlowLog>; + update is ArmCustomPatchAsync< + Ec2FlowLog, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2FlowLog> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2FlowLog>; + listByResourceGroup is ArmResourceListByParent<Ec2FlowLog>; + listBySubscription is ArmListBySubscription<Ec2FlowLog>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::FlowLog +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2FlowLog.Management/tspconfig.yaml b/specification/awsconnector/Ec2FlowLog.Management/tspconfig.yaml new file mode 100644 index 000000000000..9f7314ed328d --- /dev/null +++ b/specification/awsconnector/Ec2FlowLog.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2FlowLog.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_CreateOrReplace.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_CreateOrReplace.json new file mode 100644 index 000000000000..d799c600a5eb --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_CreateOrReplace.json @@ -0,0 +1,361 @@ +{ + "title": "Ec2Images_CreateOrReplace", + "operationId": "Ec2Images_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + } + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Delete.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Delete.json new file mode 100644 index 000000000000..aa414e5f36dd --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Images_Delete", + "operationId": "Ec2Images_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Get.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Get.json new file mode 100644 index 000000000000..f7bd2279a66c --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Get.json @@ -0,0 +1,132 @@ +{ + "title": "Ec2Images_Get", + "operationId": "Ec2Images_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListByResourceGroup.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListByResourceGroup.json new file mode 100644 index 000000000000..d6aa67e04588 --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListByResourceGroup.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2Images_ListByResourceGroup", + "operationId": "Ec2Images_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListBySubscription.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListBySubscription.json new file mode 100644 index 000000000000..d9105a595f70 --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_ListBySubscription.json @@ -0,0 +1,135 @@ +{ + "title": "Ec2Images_ListBySubscription", + "operationId": "Ec2Images_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Update.json b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Update.json new file mode 100644 index 000000000000..bd65f0094f8a --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/examples/2024-12-01/Ec2Images_Update.json @@ -0,0 +1,142 @@ +{ + "title": "Ec2Images_Update", + "operationId": "Ec2Images_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1684": "vawzenjlufhqre" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Image.Management/main.tsp b/specification/awsconnector/Ec2Image.Management/main.tsp new file mode 100644 index 000000000000..fed84f567671 --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/main.tsp @@ -0,0 +1,586 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Images ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Image", + plural: "EC2 Images", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Image"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Image is TrackedResource<Ec2ImageProperties> { + @doc("Name of Ec2Image") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Images") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Image") +model Ec2ImageProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2ImageProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Image") +model AwsEc2ImageProperties { + @doc("<p>The architecture of the image.</p>") + architecture?: ArchitectureValuesEnumValue; + + @doc("<p>Any block device mapping entries.</p>") + @extension("x-ms-identifiers", []) + blockDeviceMappings?: BlockDeviceMapping[]; + + @doc("<p>The boot mode of the image. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>") + bootMode?: BootModeValuesEnumValue; + + @doc("<p>The date and time the image was created.</p>") + creationDate?: string; + + @doc("<p>The date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.</p>") + deprecationTime?: string; + + @doc("<p>Indicates whether deregistration protection is enabled for the AMI.</p>") + deregistrationProtection?: string; + + @doc("<p>The description of the AMI that was provided during image creation.</p>") + description?: string; + + @doc("<p>Specifies whether enhanced networking with ENA is enabled.</p>") + enaSupport?: boolean; + + @doc("<p>The hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.</p>") + hypervisor?: HypervisorTypeEnumValue; + + @doc("<p>The ID of the AMI.</p>") + imageId?: string; + + @doc("<p>The location of the AMI.</p>") + imageLocation?: string; + + @doc("<p>The owner alias (<code>amazon</code> | <code>aws-marketplace</code>).</p>") + imageOwnerAlias?: string; + + @doc("<p>The type of image.</p>") + imageType?: ImageTypeValuesEnumValue; + + @doc("<p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'>Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p>") + imdsSupport?: ImdsSupportValuesEnumValue; + + @doc("<p>The kernel associated with the image, if any. Only applicable for machine images.</p>") + kernelId?: string; + + @doc("<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note>") + lastLaunchedTime?: string; + + @doc("<p>The name of the AMI that was provided during image creation.</p>") + name?: string; + + @doc("<p>The ID of the Amazon Web Services account that owns the image.</p>") + ownerId?: string; + + @doc("<p>This value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.</p>") + platform?: PlatformValuesEnumValue; + + @doc("<p>The platform details associated with the billing code of the AMI. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'>Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p>") + platformDetails?: string; + + @doc("<p>Any product codes associated with the AMI.</p>") + @extension("x-ms-identifiers", []) + productCodes?: ProductCode[]; + + @doc("<p>Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.</p>") + public?: boolean; + + @doc("<p>The RAM disk associated with the image, if any. Only applicable for machine images.</p>") + ramdiskId?: string; + + @doc("<p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>") + rootDeviceName?: string; + + @doc("<p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.</p>") + rootDeviceType?: DeviceTypeEnumValue; + + @doc("<p>The ID of the instance that the AMI was created from if the AMI was created using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>. This field only appears if the AMI was created using CreateImage.</p>") + sourceInstanceId?: string; + + @doc("<p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>") + sriovNetSupport?: string; + + @doc("<p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p>") + state?: ImageStateEnumValue; + + @doc("<p>The reason for the state change.</p>") + stateReason?: StateReason; + + @doc("<p>Any tags assigned to the image.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>") + tpmSupport?: TpmSupportValuesEnumValue; + + @doc("<p>The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'>lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'>Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'>DescribeImages</a> command in the Amazon EC2 API, or the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'>describe-images</a> command in the CLI.</p>") + usageOperation?: string; + + @doc("<p>The type of virtualization of the AMI.</p>") + virtualizationType?: VirtualizationTypeEnumValue; +} + +@doc("ArchitectureValues enum") +union ArchitectureValues { + @doc("ArchitectureValues enum arm64") + Arm64: "arm64", + + @doc("ArchitectureValues enum arm64_mac") + Arm64_mac: "arm64_mac", + + @doc("ArchitectureValues enum i386") + I386: "i386", + + @doc("ArchitectureValues enum x86_64") + X86_64: "x86_64", + + @doc("ArchitectureValues enum x86_64_mac") + X86_64_mac: "x86_64_mac", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArchitectureValuesEnumValue") +model ArchitectureValuesEnumValue { + @doc("Property value") + value?: ArchitectureValues; +} + +@doc("HypervisorType enum") +union HypervisorType { + @doc("HypervisorType enum ovm") + Ovm: "ovm", + + @doc("HypervisorType enum xen") + Xen: "xen", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HypervisorTypeEnumValue") +model HypervisorTypeEnumValue { + @doc("Property value") + value?: HypervisorType; +} + +@doc("ImdsSupportValues enum") +union ImdsSupportValues { + @doc("ImdsSupportValues enum v2.0") + V20: "v2.0", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImdsSupportValuesEnumValue") +model ImdsSupportValuesEnumValue { + @doc("Property value") + value?: ImdsSupportValues; +} + +@doc("DeviceType enum") +union DeviceType { + @doc("DeviceType enum ebs") + Ebs: "ebs", + + @doc("DeviceType enum instance-store") + InstanceStore: "instance-store", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeviceTypeEnumValue") +model DeviceTypeEnumValue { + @doc("Property value") + value?: DeviceType; +} + +@doc("TpmSupportValues enum") +union TpmSupportValues { + @doc("TpmSupportValues enum v2.0") + V20: "v2.0", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TpmSupportValuesEnumValue") +model TpmSupportValuesEnumValue { + @doc("Property value") + value?: TpmSupportValues; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BlockDeviceMapping") +model BlockDeviceMapping { + @doc("<p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>") + deviceName?: string; + + @doc("<p>Parameters used to automatically set up EBS volumes when the instance is launched.</p>") + ebs?: EbsBlockDevice; + + @doc("<p>To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.</p>") + noDevice?: string; + + @doc("<p>The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.</p> <p>NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.</p> <p>Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.</p>") + virtualName?: string; +} + +@doc("BootModeValues enum") +union BootModeValues { + @doc("BootModeValues enum legacy-bios") + LegacyBios: "legacy-bios", + + @doc("BootModeValues enum uefi") + Uefi: "uefi", + + @doc("BootModeValues enum uefi-preferred") + UefiPreferred: "uefi-preferred", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BootModeValuesEnumValue") +model BootModeValuesEnumValue { + @doc("Property value") + value?: BootModeValues; +} + +@doc("PlatformValues enum") +union PlatformValues { + @doc("PlatformValues enum Windows") + Windows: "Windows", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlatformValuesEnumValue") +model PlatformValuesEnumValue { + @doc("Property value") + value?: PlatformValues; +} + +@doc("VirtualizationType enum") +union VirtualizationType { + @doc("VirtualizationType enum hvm") + Hvm: "hvm", + + @doc("VirtualizationType enum paravirtual") + Paravirtual: "paravirtual", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VirtualizationTypeEnumValue") +model VirtualizationTypeEnumValue { + @doc("Property value") + value?: VirtualizationType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProductCode") +model ProductCode { + @doc("<p>The product code.</p>") + productCodeId?: string; + + @doc("<p>The type of product code.</p>") + productCodeType?: ProductCodeValuesEnumValue; +} + +@doc("ImageTypeValues enum") +union ImageTypeValues { + @doc("ImageTypeValues enum kernel") + Kernel: "kernel", + + @doc("ImageTypeValues enum machine") + Machine: "machine", + + @doc("ImageTypeValues enum ramdisk") + Ramdisk: "ramdisk", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageTypeValuesEnumValue") +model ImageTypeValuesEnumValue { + @doc("Property value") + value?: ImageTypeValues; +} + +@doc("ProductCodeValues enum") +union ProductCodeValues { + @doc("ProductCodeValues enum devpay") + Devpay: "devpay", + + @doc("ProductCodeValues enum marketplace") + Marketplace: "marketplace", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProductCodeValuesEnumValue") +model ProductCodeValuesEnumValue { + @doc("Property value") + value?: ProductCodeValues; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StateReason") +model StateReason { + @doc("<p>The reason code for the state change.</p>") + code?: string; + + @doc("<p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul>") + message?: string; +} + +@doc("ImageState enum") +union ImageState { + @doc("ImageState enum available") + Available: "available", + + @doc("ImageState enum deregistered") + Deregistered: "deregistered", + + @doc("ImageState enum disabled") + Disabled: "disabled", + + @doc("ImageState enum error") + Error: "error", + + @doc("ImageState enum failed") + Failed: "failed", + + @doc("ImageState enum invalid") + Invalid: "invalid", + + @doc("ImageState enum pending") + Pending: "pending", + + @doc("ImageState enum transient") + Transient: "transient", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageStateEnumValue") +model ImageStateEnumValue { + @doc("Property value") + value?: ImageState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EbsBlockDevice") +model EbsBlockDevice { + @doc("<p>Indicates whether the EBS volume is deleted on instance termination. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'>Preserving Amazon EBS volumes on instance termination</a> in the <i>Amazon EC2 User Guide</i>.</p>") + deleteOnTermination?: boolean; + + @doc("<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'>Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'>Supported instance types</a>.</p> <p>This parameter is not returned by <a>DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.</p> <ul> <li> <p>If you are creating a block device mapping for a <b>new (empty) volume</b>, you can include this parameter, and specify either <code>true</code> for an encrypted volume, or <code>false</code> for an unencrypted volume. If you omit this parameter, it defaults to <code>false</code> (unencrypted).</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted or unencrypted snapshot</b>, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing unencrypted volume</b>, you can include this parameter, but you must specify <code>false</code>. If you specify <code>true</code>, the request will fail. In this case, we recommend that you omit the parameter.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted volume</b>, you can include this parameter, and specify either <code>true</code> or <code>false</code>. However, if you specify <code>false</code>, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.</p> </li> </ul>") + encrypted?: boolean; + + @doc("<p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type:</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'>instances built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p> <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.</p>") + iops?: int32; + + @doc("<p>Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.</p> <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>, <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'>RequestSpotFleet</a>, and <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'>RequestSpotInstances</a>.</p>") + kmsKeyId?: string; + + @doc("<p>The ARN of the Outpost on which the snapshot is stored.</p> <p>This parameter is not supported when using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>.</p>") + outpostArn?: string; + + @doc("<p>The ID of the snapshot.</p>") + snapshotId?: string; + + @doc("<p>The throughput that the volume supports, in MiB/s.</p> <p>This parameter is valid only for <code>gp3</code> volumes.</p> <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>") + throughput?: int32; + + @doc("<p>The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.</p> <p>The following are the supported sizes for each volume type:</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p> </li> <li> <p> <code>io1</code>: 4 - 16,384 GiB</p> </li> <li> <p> <code>io2</code>: 4 - 65,536 GiB</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p> </li> <li> <p> <code>standard</code>: 1 - 1024 GiB</p> </li> </ul>") + volumeSize?: int32; + + @doc("<p>The volume type. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'>Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p>") + volumeType?: VolumeTypeEnumValue; +} + +@doc("VolumeType enum") +union VolumeType { + @doc("VolumeType enum gp2") + Gp2: "gp2", + + @doc("VolumeType enum gp3") + Gp3: "gp3", + + @doc("VolumeType enum io1") + Io1: "io1", + + @doc("VolumeType enum io2") + Io2: "io2", + + @doc("VolumeType enum sc1") + Sc1: "sc1", + + @doc("VolumeType enum st1") + St1: "st1", + + @doc("VolumeType enum standard") + Standard: "standard", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VolumeTypeEnumValue") +model VolumeTypeEnumValue { + @doc("Property value") + value?: VolumeType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Images { + get is ArmResourceRead<Ec2Image>; + @doc("Create a Ec2Image. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Image>; + update is ArmCustomPatchAsync< + Ec2Image, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Image> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Image>; + listByResourceGroup is ArmResourceListByParent<Ec2Image>; + listBySubscription is ArmListBySubscription<Ec2Image>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: Image +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Image.Management/tspconfig.yaml b/specification/awsconnector/Ec2Image.Management/tspconfig.yaml new file mode 100644 index 000000000000..6aafd5e3411c --- /dev/null +++ b/specification/awsconnector/Ec2Image.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Image.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_CreateOrReplace.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_CreateOrReplace.json new file mode 100644 index 000000000000..f031639091fd --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_CreateOrReplace.json @@ -0,0 +1,914 @@ +{ + "title": "Ec2Instances_CreateOrReplace", + "operationId": "Ec2Instances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c", + "resource": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Delete.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Delete.json new file mode 100644 index 000000000000..e14f139cc921 --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Delete.json @@ -0,0 +1,16 @@ +{ + "title": "Ec2Instances_Delete", + "operationId": "Ec2Instances_Delete", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Get.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Get.json new file mode 100644 index 000000000000..6826dc42085b --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Get.json @@ -0,0 +1,315 @@ +{ + "title": "Ec2Instances_Get", + "operationId": "Ec2Instances_Get", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_List.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_List.json new file mode 100644 index 000000000000..b89a8a4e3cf8 --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_List.json @@ -0,0 +1,320 @@ +{ + "title": "Ec2Instances_List", + "operationId": "Ec2Instances_List", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Start.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Start.json new file mode 100644 index 000000000000..b760f02d207f --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Start.json @@ -0,0 +1,39 @@ +{ + "title": "Ec2Instances_Start", + "operationId": "Ec2Instances_Start", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "name": "vqjtjwjblwnsoworqkrls", + "status": "vrcsdllflyxcatvyvrwa", + "percentComplete": 96, + "startTime": "2024-10-08T16:46:17.519Z", + "endTime": "2024-10-08T16:46:17.519Z", + "operations": [], + "error": { + "code": "juzxifzmyic", + "message": "hqzuumjoqnagcxvrcooyuwrixjl", + "target": "grzkrahafxmciozivwqargn", + "details": [], + "additionalInfo": [ + { + "type": "pfubhxblfnkmfjqu", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Stop.json b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Stop.json new file mode 100644 index 000000000000..b6bc913af175 --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/examples/2024-12-01/Ec2Instances_Stop.json @@ -0,0 +1,43 @@ +{ + "title": "Ec2Instances_Stop", + "operationId": "Ec2Instances_Stop", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c", + "body": { + "force": true, + "hibernate": true + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "name": "vqjtjwjblwnsoworqkrls", + "status": "vrcsdllflyxcatvyvrwa", + "percentComplete": 96, + "startTime": "2024-10-08T16:46:17.519Z", + "endTime": "2024-10-08T16:46:17.519Z", + "operations": [], + "error": { + "code": "juzxifzmyic", + "message": "hqzuumjoqnagcxvrcooyuwrixjl", + "target": "grzkrahafxmciozivwqargn", + "details": [], + "additionalInfo": [ + { + "type": "pfubhxblfnkmfjqu", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Instance.Management/main.tsp b/specification/awsconnector/Ec2Instance.Management/main.tsp new file mode 100644 index 000000000000..fa2479e72aa9 --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/main.tsp @@ -0,0 +1,3751 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Instances ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@doc("A Microsoft.AwsConnector resource") +@singleton +model Ec2Instance is ExtensionResource<Ec2InstanceProperties> { + @doc("Name of Ec2Instance") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Instances") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Instance") +model Ec2InstanceProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2InstanceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Instance") +model AwsEc2InstanceProperties { + @doc("<p>The AMI launch index, which can be used to find this instance in the launch group.</p>") + amiLaunchIndex?: int32; + + @doc("<p>The architecture of the image.</p>") + architecture?: ArchitectureValuesEnumValue; + + @doc("<p>Any block device mapping entries for the instance.</p>") + @extension("x-ms-identifiers", []) + blockDeviceMappings?: InstanceBlockDeviceMapping[]; + + @doc("<p>The boot mode that was specified by the AMI. If the value is <code>uefi-preferred</code>, the AMI supports both UEFI and Legacy BIOS. The <code>currentInstanceBootMode</code> parameter is the boot mode that is used to boot the instance at launch or start.</p> <note> <p>The operating system contained in the AMI must be configured to support the specified boot mode.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>") + bootMode?: BootModeValuesEnumValue; + + @doc("<p>The ID of the Capacity Reservation.</p>") + capacityReservationId?: string; + + @doc("<p>Information about the Capacity Reservation targeting option.</p>") + capacityReservationSpecification?: CapacityReservationSpecificationResponse; + + @doc("<p>The idempotency token you provided when you launched the instance, if applicable.</p>") + clientToken?: string; + + @doc("<p>The CPU options for the instance.</p>") + cpuOptions?: CpuOptions; + + @doc("<p>The boot mode that is used to boot the instance at launch or start. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>") + currentInstanceBootMode?: InstanceBootModeValuesEnumValue; + + @doc("<p>Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.</p>") + ebsOptimized?: boolean; + + @doc("<p>Deprecated.</p> <note> <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.</p> </note>") + @extension("x-ms-identifiers", []) + elasticGpuAssociations?: ElasticGpuAssociation[]; + + @doc("<p>The elastic inference accelerator associated with the instance.</p>") + @extension("x-ms-identifiers", []) + elasticInferenceAcceleratorAssociations?: ElasticInferenceAcceleratorAssociation[]; + + @doc("<p>Specifies whether enhanced networking with ENA is enabled.</p>") + enaSupport?: boolean; + + @doc("<p>Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.</p>") + enclaveOptions?: EnclaveOptions; + + @doc("<p>Indicates whether the instance is enabled for hibernation.</p>") + hibernationOptions?: HibernationOptions; + + @doc("<p>The hypervisor type of the instance. The value <code>xen</code> is used for both Xen and Nitro hypervisors.</p>") + hypervisor?: HypervisorTypeEnumValue; + + @doc("<p>The IAM instance profile associated with the instance, if applicable.</p>") + iamInstanceProfile?: IamInstanceProfile; + + @doc("<p>The ID of the AMI used to launch the instance.</p>") + imageId?: string; + + @doc("<p>The ID of the instance.</p>") + instanceId?: string; + + @doc("<p>Indicates whether this is a Spot Instance or a Scheduled Instance.</p>") + instanceLifecycle?: InstanceLifecycleTypeEnumValue; + + @doc("<p>The instance type.</p>") + instanceType?: InstanceTypeEnumValue; + + @doc("<p>The IPv6 address assigned to the instance.</p>") + ipv6Address?: string; + + @doc("<p>The kernel associated with this instance, if applicable.</p>") + kernelId?: string; + + @doc("<p>The name of the key pair, if this instance was launched with an associated key pair.</p>") + keyName?: string; + + @doc("<p>The time the instance was launched.</p>") + launchTime?: utcDateTime; + + @doc("<p>The license configurations for the instance.</p>") + @extension("x-ms-identifiers", []) + licenses?: LicenseConfiguration[]; + + @doc("<p>Provides information on the recovery and maintenance options of your instance.</p>") + maintenanceOptions?: InstanceMaintenanceOptions; + + @doc("<p>The metadata options for the instance.</p>") + metadataOptions?: InstanceMetadataOptionsResponse; + + @doc("<p>The monitoring for the instance.</p>") + monitoring?: Monitoring; + + @doc("<p>The network interfaces for the instance.</p>") + @extension("x-ms-identifiers", []) + networkInterfaces?: InstanceNetworkInterface[]; + + @doc("<p>The Amazon Resource Name (ARN) of the Outpost.</p>") + outpostArn?: string; + + @doc("<p>The location where the instance launched, if applicable.</p>") + placement?: Placement; + + @doc("<p>The platform. This value is <code>windows</code> for Windows instances; otherwise, it is empty.</p>") + platform?: PlatformValuesEnumValue; + + @doc("<p>The platform details value for the instance. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'>AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>") + platformDetails?: string; + + @doc("<p>[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the <code>running</code> state. </p> <p>The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.</p>") + privateDnsName?: string; + + @doc("<p>The options for the instance hostname.</p>") + privateDnsNameOptions?: PrivateDnsNameOptionsResponse; + + @doc("<p>The private IPv4 address assigned to the instance.</p>") + privateIpAddress?: string; + + @doc("<p>The product codes attached to this instance, if applicable.</p>") + @extension("x-ms-identifiers", []) + productCodes?: ProductCode[]; + + @doc("<p>[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. This name is only available if you've enabled DNS hostnames for your VPC.</p>") + publicDnsName?: string; + + @doc("<p>The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.</p> <p>A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.</p>") + publicIpAddress?: string; + + @doc("<p>The RAM disk associated with this instance, if applicable.</p>") + ramdiskId?: string; + + @doc("<p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>") + rootDeviceName?: string; + + @doc("<p>The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.</p>") + rootDeviceType?: DeviceTypeEnumValue; + + @doc("<p>The security groups for the instance.</p>") + @extension("x-ms-identifiers", []) + securityGroups?: GroupIdentifier[]; + + @doc("<p>Indicates whether source/destination checking is enabled.</p>") + sourceDestCheck?: boolean; + + @doc("<p>If the request is a Spot Instance request, the ID of the request.</p>") + spotInstanceRequestId?: string; + + @doc("<p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>") + sriovNetSupport?: string; + + @doc("<p>The current state of the instance.</p>") + state?: InstanceState; + + @doc("<p>The reason for the most recent state transition.</p>") + stateReason?: StateReason; + + @doc("<p>The reason for the most recent state transition. This might be an empty string.</p>") + stateTransitionReason?: string; + + @doc("<p>The ID of the subnet in which the instance is running.</p>") + subnetId?: string; + + @doc("<p>Any tags assigned to the instance.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>If the instance is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>") + tpmSupport?: string; + + @doc("<p>The usage operation value for the instance. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'>AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>") + usageOperation?: string; + + @doc("<p>The time that the usage operation was last updated.</p>") + usageOperationUpdateTime?: utcDateTime; + + @doc("<p>The virtualization type of the instance.</p>") + virtualizationType?: VirtualizationTypeEnumValue; + + @doc("<p>The ID of the VPC in which the instance is running.</p>") + vpcId?: string; +} + +@doc("ArchitectureValues enum") +union ArchitectureValues { + @doc("ArchitectureValues enum arm64") + Arm64: "arm64", + + @doc("ArchitectureValues enum arm64_mac") + Arm64_mac: "arm64_mac", + + @doc("ArchitectureValues enum i386") + I386: "i386", + + @doc("ArchitectureValues enum x86_64") + X86_64: "x86_64", + + @doc("ArchitectureValues enum x86_64_mac") + X86_64_mac: "x86_64_mac", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ArchitectureValuesEnumValue") +model ArchitectureValuesEnumValue { + @doc("Property value") + value?: ArchitectureValues; +} + +@doc("InstanceBootModeValues enum") +union InstanceBootModeValues { + @doc("InstanceBootModeValues enum legacy-bios") + LegacyBios: "legacy-bios", + + @doc("InstanceBootModeValues enum uefi") + Uefi: "uefi", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceBootModeValuesEnumValue") +model InstanceBootModeValuesEnumValue { + @doc("Property value") + value?: InstanceBootModeValues; +} + +@doc("InstanceLifecycleType enum") +union InstanceLifecycleType { + @doc("InstanceLifecycleType enum capacity-block") + CapacityBlock: "capacity-block", + + @doc("InstanceLifecycleType enum scheduled") + Scheduled: "scheduled", + + @doc("InstanceLifecycleType enum spot") + Spot: "spot", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceLifecycleTypeEnumValue") +model InstanceLifecycleTypeEnumValue { + @doc("Property value") + value?: InstanceLifecycleType; +} + +@doc("PlatformValues enum") +union PlatformValues { + @doc("PlatformValues enum Windows") + Windows: "Windows", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlatformValuesEnumValue") +model PlatformValuesEnumValue { + @doc("Property value") + value?: PlatformValues; +} + +@doc("VirtualizationType enum") +union VirtualizationType { + @doc("VirtualizationType enum hvm") + Hvm: "hvm", + + @doc("VirtualizationType enum paravirtual") + Paravirtual: "paravirtual", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VirtualizationTypeEnumValue") +model VirtualizationTypeEnumValue { + @doc("Property value") + value?: VirtualizationType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceBlockDeviceMapping") +model InstanceBlockDeviceMapping { + @doc("<p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>") + deviceName?: string; + + @doc("<p>Parameters used to automatically set up EBS volumes when the instance is launched.</p>") + ebs?: EbsInstanceBlockDevice; +} + +@doc("BootModeValues enum") +union BootModeValues { + @doc("BootModeValues enum legacy-bios") + LegacyBios: "legacy-bios", + + @doc("BootModeValues enum uefi") + Uefi: "uefi", + + @doc("BootModeValues enum uefi-preferred") + UefiPreferred: "uefi-preferred", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BootModeValuesEnumValue") +model BootModeValuesEnumValue { + @doc("Property value") + value?: BootModeValues; +} + +@doc("InstanceType enum") +union InstanceType { + @doc("InstanceType enum a1.2xlarge") + A12xlarge: "a1.2xlarge", + + @doc("InstanceType enum a1.4xlarge") + A14xlarge: "a1.4xlarge", + + @doc("InstanceType enum a1.large") + A1Large: "a1.large", + + @doc("InstanceType enum a1.medium") + A1Medium: "a1.medium", + + @doc("InstanceType enum a1.metal") + A1Metal: "a1.metal", + + @doc("InstanceType enum a1.xlarge") + A1Xlarge: "a1.xlarge", + + @doc("InstanceType enum c1.medium") + C1Medium: "c1.medium", + + @doc("InstanceType enum c1.xlarge") + C1Xlarge: "c1.xlarge", + + @doc("InstanceType enum c3.2xlarge") + C32xlarge: "c3.2xlarge", + + @doc("InstanceType enum c3.4xlarge") + C34xlarge: "c3.4xlarge", + + @doc("InstanceType enum c3.8xlarge") + C38xlarge: "c3.8xlarge", + + @doc("InstanceType enum c3.large") + C3Large: "c3.large", + + @doc("InstanceType enum c3.xlarge") + C3Xlarge: "c3.xlarge", + + @doc("InstanceType enum c4.2xlarge") + C42xlarge: "c4.2xlarge", + + @doc("InstanceType enum c4.4xlarge") + C44xlarge: "c4.4xlarge", + + @doc("InstanceType enum c4.8xlarge") + C48xlarge: "c4.8xlarge", + + @doc("InstanceType enum c4.large") + C4Large: "c4.large", + + @doc("InstanceType enum c4.xlarge") + C4Xlarge: "c4.xlarge", + + @doc("InstanceType enum c5.12xlarge") + C512xlarge: "c5.12xlarge", + + @doc("InstanceType enum c5.18xlarge") + C518xlarge: "c5.18xlarge", + + @doc("InstanceType enum c5.24xlarge") + C524xlarge: "c5.24xlarge", + + @doc("InstanceType enum c5.2xlarge") + C52xlarge: "c5.2xlarge", + + @doc("InstanceType enum c5.4xlarge") + C54xlarge: "c5.4xlarge", + + @doc("InstanceType enum c5.9xlarge") + C59xlarge: "c5.9xlarge", + + @doc("InstanceType enum c5.large") + C5Large: "c5.large", + + @doc("InstanceType enum c5.metal") + C5Metal: "c5.metal", + + @doc("InstanceType enum c5.xlarge") + C5Xlarge: "c5.xlarge", + + @doc("InstanceType enum c5a.12xlarge") + C5a12xlarge: "c5a.12xlarge", + + @doc("InstanceType enum c5a.16xlarge") + C5a16xlarge: "c5a.16xlarge", + + @doc("InstanceType enum c5a.24xlarge") + C5a24xlarge: "c5a.24xlarge", + + @doc("InstanceType enum c5a.2xlarge") + C5a2xlarge: "c5a.2xlarge", + + @doc("InstanceType enum c5a.4xlarge") + C5a4xlarge: "c5a.4xlarge", + + @doc("InstanceType enum c5a.8xlarge") + C5a8xlarge: "c5a.8xlarge", + + @doc("InstanceType enum c5a.large") + C5aLarge: "c5a.large", + + @doc("InstanceType enum c5a.xlarge") + C5aXlarge: "c5a.xlarge", + + @doc("InstanceType enum c5ad.12xlarge") + C5ad12xlarge: "c5ad.12xlarge", + + @doc("InstanceType enum c5ad.16xlarge") + C5ad16xlarge: "c5ad.16xlarge", + + @doc("InstanceType enum c5ad.24xlarge") + C5ad24xlarge: "c5ad.24xlarge", + + @doc("InstanceType enum c5ad.2xlarge") + C5ad2xlarge: "c5ad.2xlarge", + + @doc("InstanceType enum c5ad.4xlarge") + C5ad4xlarge: "c5ad.4xlarge", + + @doc("InstanceType enum c5ad.8xlarge") + C5ad8xlarge: "c5ad.8xlarge", + + @doc("InstanceType enum c5ad.large") + C5adLarge: "c5ad.large", + + @doc("InstanceType enum c5ad.xlarge") + C5adXlarge: "c5ad.xlarge", + + @doc("InstanceType enum c5d.12xlarge") + C5d12xlarge: "c5d.12xlarge", + + @doc("InstanceType enum c5d.18xlarge") + C5d18xlarge: "c5d.18xlarge", + + @doc("InstanceType enum c5d.24xlarge") + C5d24xlarge: "c5d.24xlarge", + + @doc("InstanceType enum c5d.2xlarge") + C5d2xlarge: "c5d.2xlarge", + + @doc("InstanceType enum c5d.4xlarge") + C5d4xlarge: "c5d.4xlarge", + + @doc("InstanceType enum c5d.9xlarge") + C5d9xlarge: "c5d.9xlarge", + + @doc("InstanceType enum c5d.large") + C5dLarge: "c5d.large", + + @doc("InstanceType enum c5d.metal") + C5dMetal: "c5d.metal", + + @doc("InstanceType enum c5d.xlarge") + C5dXlarge: "c5d.xlarge", + + @doc("InstanceType enum c5n.18xlarge") + C5n18xlarge: "c5n.18xlarge", + + @doc("InstanceType enum c5n.2xlarge") + C5n2xlarge: "c5n.2xlarge", + + @doc("InstanceType enum c5n.4xlarge") + C5n4xlarge: "c5n.4xlarge", + + @doc("InstanceType enum c5n.9xlarge") + C5n9xlarge: "c5n.9xlarge", + + @doc("InstanceType enum c5n.large") + C5nLarge: "c5n.large", + + @doc("InstanceType enum c5n.metal") + C5nMetal: "c5n.metal", + + @doc("InstanceType enum c5n.xlarge") + C5nXlarge: "c5n.xlarge", + + @doc("InstanceType enum c6a.12xlarge") + C6a12xlarge: "c6a.12xlarge", + + @doc("InstanceType enum c6a.16xlarge") + C6a16xlarge: "c6a.16xlarge", + + @doc("InstanceType enum c6a.24xlarge") + C6a24xlarge: "c6a.24xlarge", + + @doc("InstanceType enum c6a.2xlarge") + C6a2xlarge: "c6a.2xlarge", + + @doc("InstanceType enum c6a.32xlarge") + C6a32xlarge: "c6a.32xlarge", + + @doc("InstanceType enum c6a.48xlarge") + C6a48xlarge: "c6a.48xlarge", + + @doc("InstanceType enum c6a.4xlarge") + C6a4xlarge: "c6a.4xlarge", + + @doc("InstanceType enum c6a.8xlarge") + C6a8xlarge: "c6a.8xlarge", + + @doc("InstanceType enum c6a.large") + C6aLarge: "c6a.large", + + @doc("InstanceType enum c6a.metal") + C6aMetal: "c6a.metal", + + @doc("InstanceType enum c6a.xlarge") + C6aXlarge: "c6a.xlarge", + + @doc("InstanceType enum c6g.12xlarge") + C6g12xlarge: "c6g.12xlarge", + + @doc("InstanceType enum c6g.16xlarge") + C6g16xlarge: "c6g.16xlarge", + + @doc("InstanceType enum c6g.2xlarge") + C6g2xlarge: "c6g.2xlarge", + + @doc("InstanceType enum c6g.4xlarge") + C6g4xlarge: "c6g.4xlarge", + + @doc("InstanceType enum c6g.8xlarge") + C6g8xlarge: "c6g.8xlarge", + + @doc("InstanceType enum c6g.large") + C6gLarge: "c6g.large", + + @doc("InstanceType enum c6g.medium") + C6gMedium: "c6g.medium", + + @doc("InstanceType enum c6g.metal") + C6gMetal: "c6g.metal", + + @doc("InstanceType enum c6g.xlarge") + C6gXlarge: "c6g.xlarge", + + @doc("InstanceType enum c6gd.12xlarge") + C6gd12xlarge: "c6gd.12xlarge", + + @doc("InstanceType enum c6gd.16xlarge") + C6gd16xlarge: "c6gd.16xlarge", + + @doc("InstanceType enum c6gd.2xlarge") + C6gd2xlarge: "c6gd.2xlarge", + + @doc("InstanceType enum c6gd.4xlarge") + C6gd4xlarge: "c6gd.4xlarge", + + @doc("InstanceType enum c6gd.8xlarge") + C6gd8xlarge: "c6gd.8xlarge", + + @doc("InstanceType enum c6gd.large") + C6gdLarge: "c6gd.large", + + @doc("InstanceType enum c6gd.medium") + C6gdMedium: "c6gd.medium", + + @doc("InstanceType enum c6gd.metal") + C6gdMetal: "c6gd.metal", + + @doc("InstanceType enum c6gd.xlarge") + C6gdXlarge: "c6gd.xlarge", + + @doc("InstanceType enum c6gn.12xlarge") + C6gn12xlarge: "c6gn.12xlarge", + + @doc("InstanceType enum c6gn.16xlarge") + C6gn16xlarge: "c6gn.16xlarge", + + @doc("InstanceType enum c6gn.2xlarge") + C6gn2xlarge: "c6gn.2xlarge", + + @doc("InstanceType enum c6gn.4xlarge") + C6gn4xlarge: "c6gn.4xlarge", + + @doc("InstanceType enum c6gn.8xlarge") + C6gn8xlarge: "c6gn.8xlarge", + + @doc("InstanceType enum c6gn.large") + C6gnLarge: "c6gn.large", + + @doc("InstanceType enum c6gn.medium") + C6gnMedium: "c6gn.medium", + + @doc("InstanceType enum c6gn.xlarge") + C6gnXlarge: "c6gn.xlarge", + + @doc("InstanceType enum c6i.12xlarge") + C6i12xlarge: "c6i.12xlarge", + + @doc("InstanceType enum c6i.16xlarge") + C6i16xlarge: "c6i.16xlarge", + + @doc("InstanceType enum c6i.24xlarge") + C6i24xlarge: "c6i.24xlarge", + + @doc("InstanceType enum c6i.2xlarge") + C6i2xlarge: "c6i.2xlarge", + + @doc("InstanceType enum c6i.32xlarge") + C6i32xlarge: "c6i.32xlarge", + + @doc("InstanceType enum c6i.4xlarge") + C6i4xlarge: "c6i.4xlarge", + + @doc("InstanceType enum c6i.8xlarge") + C6i8xlarge: "c6i.8xlarge", + + @doc("InstanceType enum c6i.large") + C6iLarge: "c6i.large", + + @doc("InstanceType enum c6i.metal") + C6iMetal: "c6i.metal", + + @doc("InstanceType enum c6i.xlarge") + C6iXlarge: "c6i.xlarge", + + @doc("InstanceType enum c6id.12xlarge") + C6id12xlarge: "c6id.12xlarge", + + @doc("InstanceType enum c6id.16xlarge") + C6id16xlarge: "c6id.16xlarge", + + @doc("InstanceType enum c6id.24xlarge") + C6id24xlarge: "c6id.24xlarge", + + @doc("InstanceType enum c6id.2xlarge") + C6id2xlarge: "c6id.2xlarge", + + @doc("InstanceType enum c6id.32xlarge") + C6id32xlarge: "c6id.32xlarge", + + @doc("InstanceType enum c6id.4xlarge") + C6id4xlarge: "c6id.4xlarge", + + @doc("InstanceType enum c6id.8xlarge") + C6id8xlarge: "c6id.8xlarge", + + @doc("InstanceType enum c6id.large") + C6idLarge: "c6id.large", + + @doc("InstanceType enum c6id.metal") + C6idMetal: "c6id.metal", + + @doc("InstanceType enum c6id.xlarge") + C6idXlarge: "c6id.xlarge", + + @doc("InstanceType enum c6in.12xlarge") + C6in12xlarge: "c6in.12xlarge", + + @doc("InstanceType enum c6in.16xlarge") + C6in16xlarge: "c6in.16xlarge", + + @doc("InstanceType enum c6in.24xlarge") + C6in24xlarge: "c6in.24xlarge", + + @doc("InstanceType enum c6in.2xlarge") + C6in2xlarge: "c6in.2xlarge", + + @doc("InstanceType enum c6in.32xlarge") + C6in32xlarge: "c6in.32xlarge", + + @doc("InstanceType enum c6in.4xlarge") + C6in4xlarge: "c6in.4xlarge", + + @doc("InstanceType enum c6in.8xlarge") + C6in8xlarge: "c6in.8xlarge", + + @doc("InstanceType enum c6in.large") + C6inLarge: "c6in.large", + + @doc("InstanceType enum c6in.metal") + C6inMetal: "c6in.metal", + + @doc("InstanceType enum c6in.xlarge") + C6inXlarge: "c6in.xlarge", + + @doc("InstanceType enum c7a.12xlarge") + C7a12xlarge: "c7a.12xlarge", + + @doc("InstanceType enum c7a.16xlarge") + C7a16xlarge: "c7a.16xlarge", + + @doc("InstanceType enum c7a.24xlarge") + C7a24xlarge: "c7a.24xlarge", + + @doc("InstanceType enum c7a.2xlarge") + C7a2xlarge: "c7a.2xlarge", + + @doc("InstanceType enum c7a.32xlarge") + C7a32xlarge: "c7a.32xlarge", + + @doc("InstanceType enum c7a.48xlarge") + C7a48xlarge: "c7a.48xlarge", + + @doc("InstanceType enum c7a.4xlarge") + C7a4xlarge: "c7a.4xlarge", + + @doc("InstanceType enum c7a.8xlarge") + C7a8xlarge: "c7a.8xlarge", + + @doc("InstanceType enum c7a.large") + C7aLarge: "c7a.large", + + @doc("InstanceType enum c7a.medium") + C7aMedium: "c7a.medium", + + @doc("InstanceType enum c7a.metal-48xl") + C7aMetal48xl: "c7a.metal-48xl", + + @doc("InstanceType enum c7a.xlarge") + C7aXlarge: "c7a.xlarge", + + @doc("InstanceType enum c7g.12xlarge") + C7g12xlarge: "c7g.12xlarge", + + @doc("InstanceType enum c7g.16xlarge") + C7g16xlarge: "c7g.16xlarge", + + @doc("InstanceType enum c7g.2xlarge") + C7g2xlarge: "c7g.2xlarge", + + @doc("InstanceType enum c7g.4xlarge") + C7g4xlarge: "c7g.4xlarge", + + @doc("InstanceType enum c7g.8xlarge") + C7g8xlarge: "c7g.8xlarge", + + @doc("InstanceType enum c7g.large") + C7gLarge: "c7g.large", + + @doc("InstanceType enum c7g.medium") + C7gMedium: "c7g.medium", + + @doc("InstanceType enum c7g.metal") + C7gMetal: "c7g.metal", + + @doc("InstanceType enum c7g.xlarge") + C7gXlarge: "c7g.xlarge", + + @doc("InstanceType enum c7gd.12xlarge") + C7gd12xlarge: "c7gd.12xlarge", + + @doc("InstanceType enum c7gd.16xlarge") + C7gd16xlarge: "c7gd.16xlarge", + + @doc("InstanceType enum c7gd.2xlarge") + C7gd2xlarge: "c7gd.2xlarge", + + @doc("InstanceType enum c7gd.4xlarge") + C7gd4xlarge: "c7gd.4xlarge", + + @doc("InstanceType enum c7gd.8xlarge") + C7gd8xlarge: "c7gd.8xlarge", + + @doc("InstanceType enum c7gd.large") + C7gdLarge: "c7gd.large", + + @doc("InstanceType enum c7gd.medium") + C7gdMedium: "c7gd.medium", + + @doc("InstanceType enum c7gd.metal") + C7gdMetal: "c7gd.metal", + + @doc("InstanceType enum c7gd.xlarge") + C7gdXlarge: "c7gd.xlarge", + + @doc("InstanceType enum c7gn.12xlarge") + C7gn12xlarge: "c7gn.12xlarge", + + @doc("InstanceType enum c7gn.16xlarge") + C7gn16xlarge: "c7gn.16xlarge", + + @doc("InstanceType enum c7gn.2xlarge") + C7gn2xlarge: "c7gn.2xlarge", + + @doc("InstanceType enum c7gn.4xlarge") + C7gn4xlarge: "c7gn.4xlarge", + + @doc("InstanceType enum c7gn.8xlarge") + C7gn8xlarge: "c7gn.8xlarge", + + @doc("InstanceType enum c7gn.large") + C7gnLarge: "c7gn.large", + + @doc("InstanceType enum c7gn.medium") + C7gnMedium: "c7gn.medium", + + @doc("InstanceType enum c7gn.xlarge") + C7gnXlarge: "c7gn.xlarge", + + @doc("InstanceType enum c7i.12xlarge") + C7i12xlarge: "c7i.12xlarge", + + @doc("InstanceType enum c7i.16xlarge") + C7i16xlarge: "c7i.16xlarge", + + @doc("InstanceType enum c7i.24xlarge") + C7i24xlarge: "c7i.24xlarge", + + @doc("InstanceType enum c7i.2xlarge") + C7i2xlarge: "c7i.2xlarge", + + @doc("InstanceType enum c7i.48xlarge") + C7i48xlarge: "c7i.48xlarge", + + @doc("InstanceType enum c7i.4xlarge") + C7i4xlarge: "c7i.4xlarge", + + @doc("InstanceType enum c7i.8xlarge") + C7i8xlarge: "c7i.8xlarge", + + @doc("InstanceType enum c7i.large") + C7iLarge: "c7i.large", + + @doc("InstanceType enum c7i.metal-24xl") + C7iMetal24xl: "c7i.metal-24xl", + + @doc("InstanceType enum c7i.metal-48xl") + C7iMetal48xl: "c7i.metal-48xl", + + @doc("InstanceType enum c7i.xlarge") + C7iXlarge: "c7i.xlarge", + + @doc("InstanceType enum cc1.4xlarge") + Cc14xlarge: "cc1.4xlarge", + + @doc("InstanceType enum cc2.8xlarge") + Cc28xlarge: "cc2.8xlarge", + + @doc("InstanceType enum cg1.4xlarge") + Cg14xlarge: "cg1.4xlarge", + + @doc("InstanceType enum cr1.8xlarge") + Cr18xlarge: "cr1.8xlarge", + + @doc("InstanceType enum d2.2xlarge") + D22xlarge: "d2.2xlarge", + + @doc("InstanceType enum d2.4xlarge") + D24xlarge: "d2.4xlarge", + + @doc("InstanceType enum d2.8xlarge") + D28xlarge: "d2.8xlarge", + + @doc("InstanceType enum d2.xlarge") + D2Xlarge: "d2.xlarge", + + @doc("InstanceType enum d3.2xlarge") + D32xlarge: "d3.2xlarge", + + @doc("InstanceType enum d3.4xlarge") + D34xlarge: "d3.4xlarge", + + @doc("InstanceType enum d3.8xlarge") + D38xlarge: "d3.8xlarge", + + @doc("InstanceType enum d3.xlarge") + D3Xlarge: "d3.xlarge", + + @doc("InstanceType enum d3en.12xlarge") + D3en12xlarge: "d3en.12xlarge", + + @doc("InstanceType enum d3en.2xlarge") + D3en2xlarge: "d3en.2xlarge", + + @doc("InstanceType enum d3en.4xlarge") + D3en4xlarge: "d3en.4xlarge", + + @doc("InstanceType enum d3en.6xlarge") + D3en6xlarge: "d3en.6xlarge", + + @doc("InstanceType enum d3en.8xlarge") + D3en8xlarge: "d3en.8xlarge", + + @doc("InstanceType enum d3en.xlarge") + D3enXlarge: "d3en.xlarge", + + @doc("InstanceType enum dl1.24xlarge") + Dl124xlarge: "dl1.24xlarge", + + @doc("InstanceType enum dl2q.24xlarge") + Dl2q24xlarge: "dl2q.24xlarge", + + @doc("InstanceType enum f1.16xlarge") + F116xlarge: "f1.16xlarge", + + @doc("InstanceType enum f1.2xlarge") + F12xlarge: "f1.2xlarge", + + @doc("InstanceType enum f1.4xlarge") + F14xlarge: "f1.4xlarge", + + @doc("InstanceType enum g2.2xlarge") + G22xlarge: "g2.2xlarge", + + @doc("InstanceType enum g2.8xlarge") + G28xlarge: "g2.8xlarge", + + @doc("InstanceType enum g3.16xlarge") + G316xlarge: "g3.16xlarge", + + @doc("InstanceType enum g3.4xlarge") + G34xlarge: "g3.4xlarge", + + @doc("InstanceType enum g3.8xlarge") + G38xlarge: "g3.8xlarge", + + @doc("InstanceType enum g3s.xlarge") + G3sXlarge: "g3s.xlarge", + + @doc("InstanceType enum g4ad.16xlarge") + G4ad16xlarge: "g4ad.16xlarge", + + @doc("InstanceType enum g4ad.2xlarge") + G4ad2xlarge: "g4ad.2xlarge", + + @doc("InstanceType enum g4ad.4xlarge") + G4ad4xlarge: "g4ad.4xlarge", + + @doc("InstanceType enum g4ad.8xlarge") + G4ad8xlarge: "g4ad.8xlarge", + + @doc("InstanceType enum g4ad.xlarge") + G4adXlarge: "g4ad.xlarge", + + @doc("InstanceType enum g4dn.12xlarge") + G4dn12xlarge: "g4dn.12xlarge", + + @doc("InstanceType enum g4dn.16xlarge") + G4dn16xlarge: "g4dn.16xlarge", + + @doc("InstanceType enum g4dn.2xlarge") + G4dn2xlarge: "g4dn.2xlarge", + + @doc("InstanceType enum g4dn.4xlarge") + G4dn4xlarge: "g4dn.4xlarge", + + @doc("InstanceType enum g4dn.8xlarge") + G4dn8xlarge: "g4dn.8xlarge", + + @doc("InstanceType enum g4dn.metal") + G4dnMetal: "g4dn.metal", + + @doc("InstanceType enum g4dn.xlarge") + G4dnXlarge: "g4dn.xlarge", + + @doc("InstanceType enum g5.12xlarge") + G512xlarge: "g5.12xlarge", + + @doc("InstanceType enum g5.16xlarge") + G516xlarge: "g5.16xlarge", + + @doc("InstanceType enum g5.24xlarge") + G524xlarge: "g5.24xlarge", + + @doc("InstanceType enum g5.2xlarge") + G52xlarge: "g5.2xlarge", + + @doc("InstanceType enum g5.48xlarge") + G548xlarge: "g5.48xlarge", + + @doc("InstanceType enum g5.4xlarge") + G54xlarge: "g5.4xlarge", + + @doc("InstanceType enum g5.8xlarge") + G58xlarge: "g5.8xlarge", + + @doc("InstanceType enum g5.xlarge") + G5Xlarge: "g5.xlarge", + + @doc("InstanceType enum g5g.16xlarge") + G5g16xlarge: "g5g.16xlarge", + + @doc("InstanceType enum g5g.2xlarge") + G5g2xlarge: "g5g.2xlarge", + + @doc("InstanceType enum g5g.4xlarge") + G5g4xlarge: "g5g.4xlarge", + + @doc("InstanceType enum g5g.8xlarge") + G5g8xlarge: "g5g.8xlarge", + + @doc("InstanceType enum g5g.metal") + G5gMetal: "g5g.metal", + + @doc("InstanceType enum g5g.xlarge") + G5gXlarge: "g5g.xlarge", + + @doc("InstanceType enum g6.12xlarge") + G612xlarge: "g6.12xlarge", + + @doc("InstanceType enum g6.16xlarge") + G616xlarge: "g6.16xlarge", + + @doc("InstanceType enum g6.24xlarge") + G624xlarge: "g6.24xlarge", + + @doc("InstanceType enum g6.2xlarge") + G62xlarge: "g6.2xlarge", + + @doc("InstanceType enum g6.48xlarge") + G648xlarge: "g6.48xlarge", + + @doc("InstanceType enum g6.4xlarge") + G64xlarge: "g6.4xlarge", + + @doc("InstanceType enum g6.8xlarge") + G68xlarge: "g6.8xlarge", + + @doc("InstanceType enum g6.xlarge") + G6Xlarge: "g6.xlarge", + + @doc("InstanceType enum gr6.4xlarge") + Gr64xlarge: "gr6.4xlarge", + + @doc("InstanceType enum gr6.8xlarge") + Gr68xlarge: "gr6.8xlarge", + + @doc("InstanceType enum h1.16xlarge") + H116xlarge: "h1.16xlarge", + + @doc("InstanceType enum h1.2xlarge") + H12xlarge: "h1.2xlarge", + + @doc("InstanceType enum h1.4xlarge") + H14xlarge: "h1.4xlarge", + + @doc("InstanceType enum h1.8xlarge") + H18xlarge: "h1.8xlarge", + + @doc("InstanceType enum hi1.4xlarge") + Hi14xlarge: "hi1.4xlarge", + + @doc("InstanceType enum hpc6a.48xlarge") + Hpc6a48xlarge: "hpc6a.48xlarge", + + @doc("InstanceType enum hpc6id.32xlarge") + Hpc6id32xlarge: "hpc6id.32xlarge", + + @doc("InstanceType enum hpc7a.12xlarge") + Hpc7a12xlarge: "hpc7a.12xlarge", + + @doc("InstanceType enum hpc7a.24xlarge") + Hpc7a24xlarge: "hpc7a.24xlarge", + + @doc("InstanceType enum hpc7a.48xlarge") + Hpc7a48xlarge: "hpc7a.48xlarge", + + @doc("InstanceType enum hpc7a.96xlarge") + Hpc7a96xlarge: "hpc7a.96xlarge", + + @doc("InstanceType enum hpc7g.16xlarge") + Hpc7g16xlarge: "hpc7g.16xlarge", + + @doc("InstanceType enum hpc7g.4xlarge") + Hpc7g4xlarge: "hpc7g.4xlarge", + + @doc("InstanceType enum hpc7g.8xlarge") + Hpc7g8xlarge: "hpc7g.8xlarge", + + @doc("InstanceType enum hs1.8xlarge") + Hs18xlarge: "hs1.8xlarge", + + @doc("InstanceType enum i2.2xlarge") + I22xlarge: "i2.2xlarge", + + @doc("InstanceType enum i2.4xlarge") + I24xlarge: "i2.4xlarge", + + @doc("InstanceType enum i2.8xlarge") + I28xlarge: "i2.8xlarge", + + @doc("InstanceType enum i2.xlarge") + I2Xlarge: "i2.xlarge", + + @doc("InstanceType enum i3.16xlarge") + I316xlarge: "i3.16xlarge", + + @doc("InstanceType enum i3.2xlarge") + I32xlarge: "i3.2xlarge", + + @doc("InstanceType enum i3.4xlarge") + I34xlarge: "i3.4xlarge", + + @doc("InstanceType enum i3.8xlarge") + I38xlarge: "i3.8xlarge", + + @doc("InstanceType enum i3.large") + I3Large: "i3.large", + + @doc("InstanceType enum i3.metal") + I3Metal: "i3.metal", + + @doc("InstanceType enum i3.xlarge") + I3Xlarge: "i3.xlarge", + + @doc("InstanceType enum i3en.12xlarge") + I3en12xlarge: "i3en.12xlarge", + + @doc("InstanceType enum i3en.24xlarge") + I3en24xlarge: "i3en.24xlarge", + + @doc("InstanceType enum i3en.2xlarge") + I3en2xlarge: "i3en.2xlarge", + + @doc("InstanceType enum i3en.3xlarge") + I3en3xlarge: "i3en.3xlarge", + + @doc("InstanceType enum i3en.6xlarge") + I3en6xlarge: "i3en.6xlarge", + + @doc("InstanceType enum i3en.large") + I3enLarge: "i3en.large", + + @doc("InstanceType enum i3en.metal") + I3enMetal: "i3en.metal", + + @doc("InstanceType enum i3en.xlarge") + I3enXlarge: "i3en.xlarge", + + @doc("InstanceType enum i4g.16xlarge") + I4g16xlarge: "i4g.16xlarge", + + @doc("InstanceType enum i4g.2xlarge") + I4g2xlarge: "i4g.2xlarge", + + @doc("InstanceType enum i4g.4xlarge") + I4g4xlarge: "i4g.4xlarge", + + @doc("InstanceType enum i4g.8xlarge") + I4g8xlarge: "i4g.8xlarge", + + @doc("InstanceType enum i4g.large") + I4gLarge: "i4g.large", + + @doc("InstanceType enum i4g.xlarge") + I4gXlarge: "i4g.xlarge", + + @doc("InstanceType enum i4i.12xlarge") + I4i12xlarge: "i4i.12xlarge", + + @doc("InstanceType enum i4i.16xlarge") + I4i16xlarge: "i4i.16xlarge", + + @doc("InstanceType enum i4i.24xlarge") + I4i24xlarge: "i4i.24xlarge", + + @doc("InstanceType enum i4i.2xlarge") + I4i2xlarge: "i4i.2xlarge", + + @doc("InstanceType enum i4i.32xlarge") + I4i32xlarge: "i4i.32xlarge", + + @doc("InstanceType enum i4i.4xlarge") + I4i4xlarge: "i4i.4xlarge", + + @doc("InstanceType enum i4i.8xlarge") + I4i8xlarge: "i4i.8xlarge", + + @doc("InstanceType enum i4i.large") + I4iLarge: "i4i.large", + + @doc("InstanceType enum i4i.metal") + I4iMetal: "i4i.metal", + + @doc("InstanceType enum i4i.xlarge") + I4iXlarge: "i4i.xlarge", + + @doc("InstanceType enum im4gn.16xlarge") + Im4gn16xlarge: "im4gn.16xlarge", + + @doc("InstanceType enum im4gn.2xlarge") + Im4gn2xlarge: "im4gn.2xlarge", + + @doc("InstanceType enum im4gn.4xlarge") + Im4gn4xlarge: "im4gn.4xlarge", + + @doc("InstanceType enum im4gn.8xlarge") + Im4gn8xlarge: "im4gn.8xlarge", + + @doc("InstanceType enum im4gn.large") + Im4gnLarge: "im4gn.large", + + @doc("InstanceType enum im4gn.xlarge") + Im4gnXlarge: "im4gn.xlarge", + + @doc("InstanceType enum inf1.24xlarge") + Inf124xlarge: "inf1.24xlarge", + + @doc("InstanceType enum inf1.2xlarge") + Inf12xlarge: "inf1.2xlarge", + + @doc("InstanceType enum inf1.6xlarge") + Inf16xlarge: "inf1.6xlarge", + + @doc("InstanceType enum inf1.xlarge") + Inf1Xlarge: "inf1.xlarge", + + @doc("InstanceType enum inf2.24xlarge") + Inf224xlarge: "inf2.24xlarge", + + @doc("InstanceType enum inf2.48xlarge") + Inf248xlarge: "inf2.48xlarge", + + @doc("InstanceType enum inf2.8xlarge") + Inf28xlarge: "inf2.8xlarge", + + @doc("InstanceType enum inf2.xlarge") + Inf2Xlarge: "inf2.xlarge", + + @doc("InstanceType enum is4gen.2xlarge") + Is4gen2xlarge: "is4gen.2xlarge", + + @doc("InstanceType enum is4gen.4xlarge") + Is4gen4xlarge: "is4gen.4xlarge", + + @doc("InstanceType enum is4gen.8xlarge") + Is4gen8xlarge: "is4gen.8xlarge", + + @doc("InstanceType enum is4gen.large") + Is4genLarge: "is4gen.large", + + @doc("InstanceType enum is4gen.medium") + Is4genMedium: "is4gen.medium", + + @doc("InstanceType enum is4gen.xlarge") + Is4genXlarge: "is4gen.xlarge", + + @doc("InstanceType enum m1.large") + M1Large: "m1.large", + + @doc("InstanceType enum m1.medium") + M1Medium: "m1.medium", + + @doc("InstanceType enum m1.small") + M1Small: "m1.small", + + @doc("InstanceType enum m1.xlarge") + M1Xlarge: "m1.xlarge", + + @doc("InstanceType enum m2.2xlarge") + M22xlarge: "m2.2xlarge", + + @doc("InstanceType enum m2.4xlarge") + M24xlarge: "m2.4xlarge", + + @doc("InstanceType enum m2.xlarge") + M2Xlarge: "m2.xlarge", + + @doc("InstanceType enum m3.2xlarge") + M32xlarge: "m3.2xlarge", + + @doc("InstanceType enum m3.large") + M3Large: "m3.large", + + @doc("InstanceType enum m3.medium") + M3Medium: "m3.medium", + + @doc("InstanceType enum m3.xlarge") + M3Xlarge: "m3.xlarge", + + @doc("InstanceType enum m4.10xlarge") + M410xlarge: "m4.10xlarge", + + @doc("InstanceType enum m4.16xlarge") + M416xlarge: "m4.16xlarge", + + @doc("InstanceType enum m4.2xlarge") + M42xlarge: "m4.2xlarge", + + @doc("InstanceType enum m4.4xlarge") + M44xlarge: "m4.4xlarge", + + @doc("InstanceType enum m4.large") + M4Large: "m4.large", + + @doc("InstanceType enum m4.xlarge") + M4Xlarge: "m4.xlarge", + + @doc("InstanceType enum m5.12xlarge") + M512xlarge: "m5.12xlarge", + + @doc("InstanceType enum m5.16xlarge") + M516xlarge: "m5.16xlarge", + + @doc("InstanceType enum m5.24xlarge") + M524xlarge: "m5.24xlarge", + + @doc("InstanceType enum m5.2xlarge") + M52xlarge: "m5.2xlarge", + + @doc("InstanceType enum m5.4xlarge") + M54xlarge: "m5.4xlarge", + + @doc("InstanceType enum m5.8xlarge") + M58xlarge: "m5.8xlarge", + + @doc("InstanceType enum m5.large") + M5Large: "m5.large", + + @doc("InstanceType enum m5.metal") + M5Metal: "m5.metal", + + @doc("InstanceType enum m5.xlarge") + M5Xlarge: "m5.xlarge", + + @doc("InstanceType enum m5a.12xlarge") + M5a12xlarge: "m5a.12xlarge", + + @doc("InstanceType enum m5a.16xlarge") + M5a16xlarge: "m5a.16xlarge", + + @doc("InstanceType enum m5a.24xlarge") + M5a24xlarge: "m5a.24xlarge", + + @doc("InstanceType enum m5a.2xlarge") + M5a2xlarge: "m5a.2xlarge", + + @doc("InstanceType enum m5a.4xlarge") + M5a4xlarge: "m5a.4xlarge", + + @doc("InstanceType enum m5a.8xlarge") + M5a8xlarge: "m5a.8xlarge", + + @doc("InstanceType enum m5a.large") + M5aLarge: "m5a.large", + + @doc("InstanceType enum m5a.xlarge") + M5aXlarge: "m5a.xlarge", + + @doc("InstanceType enum m5ad.12xlarge") + M5ad12xlarge: "m5ad.12xlarge", + + @doc("InstanceType enum m5ad.16xlarge") + M5ad16xlarge: "m5ad.16xlarge", + + @doc("InstanceType enum m5ad.24xlarge") + M5ad24xlarge: "m5ad.24xlarge", + + @doc("InstanceType enum m5ad.2xlarge") + M5ad2xlarge: "m5ad.2xlarge", + + @doc("InstanceType enum m5ad.4xlarge") + M5ad4xlarge: "m5ad.4xlarge", + + @doc("InstanceType enum m5ad.8xlarge") + M5ad8xlarge: "m5ad.8xlarge", + + @doc("InstanceType enum m5ad.large") + M5adLarge: "m5ad.large", + + @doc("InstanceType enum m5ad.xlarge") + M5adXlarge: "m5ad.xlarge", + + @doc("InstanceType enum m5d.12xlarge") + M5d12xlarge: "m5d.12xlarge", + + @doc("InstanceType enum m5d.16xlarge") + M5d16xlarge: "m5d.16xlarge", + + @doc("InstanceType enum m5d.24xlarge") + M5d24xlarge: "m5d.24xlarge", + + @doc("InstanceType enum m5d.2xlarge") + M5d2xlarge: "m5d.2xlarge", + + @doc("InstanceType enum m5d.4xlarge") + M5d4xlarge: "m5d.4xlarge", + + @doc("InstanceType enum m5d.8xlarge") + M5d8xlarge: "m5d.8xlarge", + + @doc("InstanceType enum m5d.large") + M5dLarge: "m5d.large", + + @doc("InstanceType enum m5d.metal") + M5dMetal: "m5d.metal", + + @doc("InstanceType enum m5d.xlarge") + M5dXlarge: "m5d.xlarge", + + @doc("InstanceType enum m5dn.12xlarge") + M5dn12xlarge: "m5dn.12xlarge", + + @doc("InstanceType enum m5dn.16xlarge") + M5dn16xlarge: "m5dn.16xlarge", + + @doc("InstanceType enum m5dn.24xlarge") + M5dn24xlarge: "m5dn.24xlarge", + + @doc("InstanceType enum m5dn.2xlarge") + M5dn2xlarge: "m5dn.2xlarge", + + @doc("InstanceType enum m5dn.4xlarge") + M5dn4xlarge: "m5dn.4xlarge", + + @doc("InstanceType enum m5dn.8xlarge") + M5dn8xlarge: "m5dn.8xlarge", + + @doc("InstanceType enum m5dn.large") + M5dnLarge: "m5dn.large", + + @doc("InstanceType enum m5dn.metal") + M5dnMetal: "m5dn.metal", + + @doc("InstanceType enum m5dn.xlarge") + M5dnXlarge: "m5dn.xlarge", + + @doc("InstanceType enum m5n.12xlarge") + M5n12xlarge: "m5n.12xlarge", + + @doc("InstanceType enum m5n.16xlarge") + M5n16xlarge: "m5n.16xlarge", + + @doc("InstanceType enum m5n.24xlarge") + M5n24xlarge: "m5n.24xlarge", + + @doc("InstanceType enum m5n.2xlarge") + M5n2xlarge: "m5n.2xlarge", + + @doc("InstanceType enum m5n.4xlarge") + M5n4xlarge: "m5n.4xlarge", + + @doc("InstanceType enum m5n.8xlarge") + M5n8xlarge: "m5n.8xlarge", + + @doc("InstanceType enum m5n.large") + M5nLarge: "m5n.large", + + @doc("InstanceType enum m5n.metal") + M5nMetal: "m5n.metal", + + @doc("InstanceType enum m5n.xlarge") + M5nXlarge: "m5n.xlarge", + + @doc("InstanceType enum m5zn.12xlarge") + M5zn12xlarge: "m5zn.12xlarge", + + @doc("InstanceType enum m5zn.2xlarge") + M5zn2xlarge: "m5zn.2xlarge", + + @doc("InstanceType enum m5zn.3xlarge") + M5zn3xlarge: "m5zn.3xlarge", + + @doc("InstanceType enum m5zn.6xlarge") + M5zn6xlarge: "m5zn.6xlarge", + + @doc("InstanceType enum m5zn.large") + M5znLarge: "m5zn.large", + + @doc("InstanceType enum m5zn.metal") + M5znMetal: "m5zn.metal", + + @doc("InstanceType enum m5zn.xlarge") + M5znXlarge: "m5zn.xlarge", + + @doc("InstanceType enum m6a.12xlarge") + M6a12xlarge: "m6a.12xlarge", + + @doc("InstanceType enum m6a.16xlarge") + M6a16xlarge: "m6a.16xlarge", + + @doc("InstanceType enum m6a.24xlarge") + M6a24xlarge: "m6a.24xlarge", + + @doc("InstanceType enum m6a.2xlarge") + M6a2xlarge: "m6a.2xlarge", + + @doc("InstanceType enum m6a.32xlarge") + M6a32xlarge: "m6a.32xlarge", + + @doc("InstanceType enum m6a.48xlarge") + M6a48xlarge: "m6a.48xlarge", + + @doc("InstanceType enum m6a.4xlarge") + M6a4xlarge: "m6a.4xlarge", + + @doc("InstanceType enum m6a.8xlarge") + M6a8xlarge: "m6a.8xlarge", + + @doc("InstanceType enum m6a.large") + M6aLarge: "m6a.large", + + @doc("InstanceType enum m6a.metal") + M6aMetal: "m6a.metal", + + @doc("InstanceType enum m6a.xlarge") + M6aXlarge: "m6a.xlarge", + + @doc("InstanceType enum m6g.12xlarge") + M6g12xlarge: "m6g.12xlarge", + + @doc("InstanceType enum m6g.16xlarge") + M6g16xlarge: "m6g.16xlarge", + + @doc("InstanceType enum m6g.2xlarge") + M6g2xlarge: "m6g.2xlarge", + + @doc("InstanceType enum m6g.4xlarge") + M6g4xlarge: "m6g.4xlarge", + + @doc("InstanceType enum m6g.8xlarge") + M6g8xlarge: "m6g.8xlarge", + + @doc("InstanceType enum m6g.large") + M6gLarge: "m6g.large", + + @doc("InstanceType enum m6g.medium") + M6gMedium: "m6g.medium", + + @doc("InstanceType enum m6g.metal") + M6gMetal: "m6g.metal", + + @doc("InstanceType enum m6g.xlarge") + M6gXlarge: "m6g.xlarge", + + @doc("InstanceType enum m6gd.12xlarge") + M6gd12xlarge: "m6gd.12xlarge", + + @doc("InstanceType enum m6gd.16xlarge") + M6gd16xlarge: "m6gd.16xlarge", + + @doc("InstanceType enum m6gd.2xlarge") + M6gd2xlarge: "m6gd.2xlarge", + + @doc("InstanceType enum m6gd.4xlarge") + M6gd4xlarge: "m6gd.4xlarge", + + @doc("InstanceType enum m6gd.8xlarge") + M6gd8xlarge: "m6gd.8xlarge", + + @doc("InstanceType enum m6gd.large") + M6gdLarge: "m6gd.large", + + @doc("InstanceType enum m6gd.medium") + M6gdMedium: "m6gd.medium", + + @doc("InstanceType enum m6gd.metal") + M6gdMetal: "m6gd.metal", + + @doc("InstanceType enum m6gd.xlarge") + M6gdXlarge: "m6gd.xlarge", + + @doc("InstanceType enum m6i.12xlarge") + M6i12xlarge: "m6i.12xlarge", + + @doc("InstanceType enum m6i.16xlarge") + M6i16xlarge: "m6i.16xlarge", + + @doc("InstanceType enum m6i.24xlarge") + M6i24xlarge: "m6i.24xlarge", + + @doc("InstanceType enum m6i.2xlarge") + M6i2xlarge: "m6i.2xlarge", + + @doc("InstanceType enum m6i.32xlarge") + M6i32xlarge: "m6i.32xlarge", + + @doc("InstanceType enum m6i.4xlarge") + M6i4xlarge: "m6i.4xlarge", + + @doc("InstanceType enum m6i.8xlarge") + M6i8xlarge: "m6i.8xlarge", + + @doc("InstanceType enum m6i.large") + M6iLarge: "m6i.large", + + @doc("InstanceType enum m6i.metal") + M6iMetal: "m6i.metal", + + @doc("InstanceType enum m6i.xlarge") + M6iXlarge: "m6i.xlarge", + + @doc("InstanceType enum m6id.12xlarge") + M6id12xlarge: "m6id.12xlarge", + + @doc("InstanceType enum m6id.16xlarge") + M6id16xlarge: "m6id.16xlarge", + + @doc("InstanceType enum m6id.24xlarge") + M6id24xlarge: "m6id.24xlarge", + + @doc("InstanceType enum m6id.2xlarge") + M6id2xlarge: "m6id.2xlarge", + + @doc("InstanceType enum m6id.32xlarge") + M6id32xlarge: "m6id.32xlarge", + + @doc("InstanceType enum m6id.4xlarge") + M6id4xlarge: "m6id.4xlarge", + + @doc("InstanceType enum m6id.8xlarge") + M6id8xlarge: "m6id.8xlarge", + + @doc("InstanceType enum m6id.large") + M6idLarge: "m6id.large", + + @doc("InstanceType enum m6id.metal") + M6idMetal: "m6id.metal", + + @doc("InstanceType enum m6id.xlarge") + M6idXlarge: "m6id.xlarge", + + @doc("InstanceType enum m6idn.12xlarge") + M6idn12xlarge: "m6idn.12xlarge", + + @doc("InstanceType enum m6idn.16xlarge") + M6idn16xlarge: "m6idn.16xlarge", + + @doc("InstanceType enum m6idn.24xlarge") + M6idn24xlarge: "m6idn.24xlarge", + + @doc("InstanceType enum m6idn.2xlarge") + M6idn2xlarge: "m6idn.2xlarge", + + @doc("InstanceType enum m6idn.32xlarge") + M6idn32xlarge: "m6idn.32xlarge", + + @doc("InstanceType enum m6idn.4xlarge") + M6idn4xlarge: "m6idn.4xlarge", + + @doc("InstanceType enum m6idn.8xlarge") + M6idn8xlarge: "m6idn.8xlarge", + + @doc("InstanceType enum m6idn.large") + M6idnLarge: "m6idn.large", + + @doc("InstanceType enum m6idn.metal") + M6idnMetal: "m6idn.metal", + + @doc("InstanceType enum m6idn.xlarge") + M6idnXlarge: "m6idn.xlarge", + + @doc("InstanceType enum m6in.12xlarge") + M6in12xlarge: "m6in.12xlarge", + + @doc("InstanceType enum m6in.16xlarge") + M6in16xlarge: "m6in.16xlarge", + + @doc("InstanceType enum m6in.24xlarge") + M6in24xlarge: "m6in.24xlarge", + + @doc("InstanceType enum m6in.2xlarge") + M6in2xlarge: "m6in.2xlarge", + + @doc("InstanceType enum m6in.32xlarge") + M6in32xlarge: "m6in.32xlarge", + + @doc("InstanceType enum m6in.4xlarge") + M6in4xlarge: "m6in.4xlarge", + + @doc("InstanceType enum m6in.8xlarge") + M6in8xlarge: "m6in.8xlarge", + + @doc("InstanceType enum m6in.large") + M6inLarge: "m6in.large", + + @doc("InstanceType enum m6in.metal") + M6inMetal: "m6in.metal", + + @doc("InstanceType enum m6in.xlarge") + M6inXlarge: "m6in.xlarge", + + @doc("InstanceType enum m7a.12xlarge") + M7a12xlarge: "m7a.12xlarge", + + @doc("InstanceType enum m7a.16xlarge") + M7a16xlarge: "m7a.16xlarge", + + @doc("InstanceType enum m7a.24xlarge") + M7a24xlarge: "m7a.24xlarge", + + @doc("InstanceType enum m7a.2xlarge") + M7a2xlarge: "m7a.2xlarge", + + @doc("InstanceType enum m7a.32xlarge") + M7a32xlarge: "m7a.32xlarge", + + @doc("InstanceType enum m7a.48xlarge") + M7a48xlarge: "m7a.48xlarge", + + @doc("InstanceType enum m7a.4xlarge") + M7a4xlarge: "m7a.4xlarge", + + @doc("InstanceType enum m7a.8xlarge") + M7a8xlarge: "m7a.8xlarge", + + @doc("InstanceType enum m7a.large") + M7aLarge: "m7a.large", + + @doc("InstanceType enum m7a.medium") + M7aMedium: "m7a.medium", + + @doc("InstanceType enum m7a.metal-48xl") + M7aMetal48xl: "m7a.metal-48xl", + + @doc("InstanceType enum m7a.xlarge") + M7aXlarge: "m7a.xlarge", + + @doc("InstanceType enum m7g.12xlarge") + M7g12xlarge: "m7g.12xlarge", + + @doc("InstanceType enum m7g.16xlarge") + M7g16xlarge: "m7g.16xlarge", + + @doc("InstanceType enum m7g.2xlarge") + M7g2xlarge: "m7g.2xlarge", + + @doc("InstanceType enum m7g.4xlarge") + M7g4xlarge: "m7g.4xlarge", + + @doc("InstanceType enum m7g.8xlarge") + M7g8xlarge: "m7g.8xlarge", + + @doc("InstanceType enum m7g.large") + M7gLarge: "m7g.large", + + @doc("InstanceType enum m7g.medium") + M7gMedium: "m7g.medium", + + @doc("InstanceType enum m7g.metal") + M7gMetal: "m7g.metal", + + @doc("InstanceType enum m7g.xlarge") + M7gXlarge: "m7g.xlarge", + + @doc("InstanceType enum m7gd.12xlarge") + M7gd12xlarge: "m7gd.12xlarge", + + @doc("InstanceType enum m7gd.16xlarge") + M7gd16xlarge: "m7gd.16xlarge", + + @doc("InstanceType enum m7gd.2xlarge") + M7gd2xlarge: "m7gd.2xlarge", + + @doc("InstanceType enum m7gd.4xlarge") + M7gd4xlarge: "m7gd.4xlarge", + + @doc("InstanceType enum m7gd.8xlarge") + M7gd8xlarge: "m7gd.8xlarge", + + @doc("InstanceType enum m7gd.large") + M7gdLarge: "m7gd.large", + + @doc("InstanceType enum m7gd.medium") + M7gdMedium: "m7gd.medium", + + @doc("InstanceType enum m7gd.metal") + M7gdMetal: "m7gd.metal", + + @doc("InstanceType enum m7gd.xlarge") + M7gdXlarge: "m7gd.xlarge", + + @doc("InstanceType enum m7i-flex.2xlarge") + M7iFlex2xlarge: "m7i-flex.2xlarge", + + @doc("InstanceType enum m7i-flex.4xlarge") + M7iFlex4xlarge: "m7i-flex.4xlarge", + + @doc("InstanceType enum m7i-flex.8xlarge") + M7iFlex8xlarge: "m7i-flex.8xlarge", + + @doc("InstanceType enum m7i-flex.large") + M7iFlexLarge: "m7i-flex.large", + + @doc("InstanceType enum m7i-flex.xlarge") + M7iFlexXlarge: "m7i-flex.xlarge", + + @doc("InstanceType enum m7i.12xlarge") + M7i12xlarge: "m7i.12xlarge", + + @doc("InstanceType enum m7i.16xlarge") + M7i16xlarge: "m7i.16xlarge", + + @doc("InstanceType enum m7i.24xlarge") + M7i24xlarge: "m7i.24xlarge", + + @doc("InstanceType enum m7i.2xlarge") + M7i2xlarge: "m7i.2xlarge", + + @doc("InstanceType enum m7i.48xlarge") + M7i48xlarge: "m7i.48xlarge", + + @doc("InstanceType enum m7i.4xlarge") + M7i4xlarge: "m7i.4xlarge", + + @doc("InstanceType enum m7i.8xlarge") + M7i8xlarge: "m7i.8xlarge", + + @doc("InstanceType enum m7i.large") + M7iLarge: "m7i.large", + + @doc("InstanceType enum m7i.metal-24xl") + M7iMetal24xl: "m7i.metal-24xl", + + @doc("InstanceType enum m7i.metal-48xl") + M7iMetal48xl: "m7i.metal-48xl", + + @doc("InstanceType enum m7i.xlarge") + M7iXlarge: "m7i.xlarge", + + @doc("InstanceType enum mac1.metal") + Mac1Metal: "mac1.metal", + + @doc("InstanceType enum mac2-m2.metal") + Mac2M2Metal: "mac2-m2.metal", + + @doc("InstanceType enum mac2-m2pro.metal") + Mac2M2proMetal: "mac2-m2pro.metal", + + @doc("InstanceType enum mac2.metal") + Mac2Metal: "mac2.metal", + + @doc("InstanceType enum p2.16xlarge") + P216xlarge: "p2.16xlarge", + + @doc("InstanceType enum p2.8xlarge") + P28xlarge: "p2.8xlarge", + + @doc("InstanceType enum p2.xlarge") + P2Xlarge: "p2.xlarge", + + @doc("InstanceType enum p3.16xlarge") + P316xlarge: "p3.16xlarge", + + @doc("InstanceType enum p3.2xlarge") + P32xlarge: "p3.2xlarge", + + @doc("InstanceType enum p3.8xlarge") + P38xlarge: "p3.8xlarge", + + @doc("InstanceType enum p3dn.24xlarge") + P3dn24xlarge: "p3dn.24xlarge", + + @doc("InstanceType enum p4d.24xlarge") + P4d24xlarge: "p4d.24xlarge", + + @doc("InstanceType enum p4de.24xlarge") + P4de24xlarge: "p4de.24xlarge", + + @doc("InstanceType enum p5.48xlarge") + P548xlarge: "p5.48xlarge", + + @doc("InstanceType enum r3.2xlarge") + R32xlarge: "r3.2xlarge", + + @doc("InstanceType enum r3.4xlarge") + R34xlarge: "r3.4xlarge", + + @doc("InstanceType enum r3.8xlarge") + R38xlarge: "r3.8xlarge", + + @doc("InstanceType enum r3.large") + R3Large: "r3.large", + + @doc("InstanceType enum r3.xlarge") + R3Xlarge: "r3.xlarge", + + @doc("InstanceType enum r4.16xlarge") + R416xlarge: "r4.16xlarge", + + @doc("InstanceType enum r4.2xlarge") + R42xlarge: "r4.2xlarge", + + @doc("InstanceType enum r4.4xlarge") + R44xlarge: "r4.4xlarge", + + @doc("InstanceType enum r4.8xlarge") + R48xlarge: "r4.8xlarge", + + @doc("InstanceType enum r4.large") + R4Large: "r4.large", + + @doc("InstanceType enum r4.xlarge") + R4Xlarge: "r4.xlarge", + + @doc("InstanceType enum r5.12xlarge") + R512xlarge: "r5.12xlarge", + + @doc("InstanceType enum r5.16xlarge") + R516xlarge: "r5.16xlarge", + + @doc("InstanceType enum r5.24xlarge") + R524xlarge: "r5.24xlarge", + + @doc("InstanceType enum r5.2xlarge") + R52xlarge: "r5.2xlarge", + + @doc("InstanceType enum r5.4xlarge") + R54xlarge: "r5.4xlarge", + + @doc("InstanceType enum r5.8xlarge") + R58xlarge: "r5.8xlarge", + + @doc("InstanceType enum r5.large") + R5Large: "r5.large", + + @doc("InstanceType enum r5.metal") + R5Metal: "r5.metal", + + @doc("InstanceType enum r5.xlarge") + R5Xlarge: "r5.xlarge", + + @doc("InstanceType enum r5a.12xlarge") + R5a12xlarge: "r5a.12xlarge", + + @doc("InstanceType enum r5a.16xlarge") + R5a16xlarge: "r5a.16xlarge", + + @doc("InstanceType enum r5a.24xlarge") + R5a24xlarge: "r5a.24xlarge", + + @doc("InstanceType enum r5a.2xlarge") + R5a2xlarge: "r5a.2xlarge", + + @doc("InstanceType enum r5a.4xlarge") + R5a4xlarge: "r5a.4xlarge", + + @doc("InstanceType enum r5a.8xlarge") + R5a8xlarge: "r5a.8xlarge", + + @doc("InstanceType enum r5a.large") + R5aLarge: "r5a.large", + + @doc("InstanceType enum r5a.xlarge") + R5aXlarge: "r5a.xlarge", + + @doc("InstanceType enum r5ad.12xlarge") + R5ad12xlarge: "r5ad.12xlarge", + + @doc("InstanceType enum r5ad.16xlarge") + R5ad16xlarge: "r5ad.16xlarge", + + @doc("InstanceType enum r5ad.24xlarge") + R5ad24xlarge: "r5ad.24xlarge", + + @doc("InstanceType enum r5ad.2xlarge") + R5ad2xlarge: "r5ad.2xlarge", + + @doc("InstanceType enum r5ad.4xlarge") + R5ad4xlarge: "r5ad.4xlarge", + + @doc("InstanceType enum r5ad.8xlarge") + R5ad8xlarge: "r5ad.8xlarge", + + @doc("InstanceType enum r5ad.large") + R5adLarge: "r5ad.large", + + @doc("InstanceType enum r5ad.xlarge") + R5adXlarge: "r5ad.xlarge", + + @doc("InstanceType enum r5b.12xlarge") + R5b12xlarge: "r5b.12xlarge", + + @doc("InstanceType enum r5b.16xlarge") + R5b16xlarge: "r5b.16xlarge", + + @doc("InstanceType enum r5b.24xlarge") + R5b24xlarge: "r5b.24xlarge", + + @doc("InstanceType enum r5b.2xlarge") + R5b2xlarge: "r5b.2xlarge", + + @doc("InstanceType enum r5b.4xlarge") + R5b4xlarge: "r5b.4xlarge", + + @doc("InstanceType enum r5b.8xlarge") + R5b8xlarge: "r5b.8xlarge", + + @doc("InstanceType enum r5b.large") + R5bLarge: "r5b.large", + + @doc("InstanceType enum r5b.metal") + R5bMetal: "r5b.metal", + + @doc("InstanceType enum r5b.xlarge") + R5bXlarge: "r5b.xlarge", + + @doc("InstanceType enum r5d.12xlarge") + R5d12xlarge: "r5d.12xlarge", + + @doc("InstanceType enum r5d.16xlarge") + R5d16xlarge: "r5d.16xlarge", + + @doc("InstanceType enum r5d.24xlarge") + R5d24xlarge: "r5d.24xlarge", + + @doc("InstanceType enum r5d.2xlarge") + R5d2xlarge: "r5d.2xlarge", + + @doc("InstanceType enum r5d.4xlarge") + R5d4xlarge: "r5d.4xlarge", + + @doc("InstanceType enum r5d.8xlarge") + R5d8xlarge: "r5d.8xlarge", + + @doc("InstanceType enum r5d.large") + R5dLarge: "r5d.large", + + @doc("InstanceType enum r5d.metal") + R5dMetal: "r5d.metal", + + @doc("InstanceType enum r5d.xlarge") + R5dXlarge: "r5d.xlarge", + + @doc("InstanceType enum r5dn.12xlarge") + R5dn12xlarge: "r5dn.12xlarge", + + @doc("InstanceType enum r5dn.16xlarge") + R5dn16xlarge: "r5dn.16xlarge", + + @doc("InstanceType enum r5dn.24xlarge") + R5dn24xlarge: "r5dn.24xlarge", + + @doc("InstanceType enum r5dn.2xlarge") + R5dn2xlarge: "r5dn.2xlarge", + + @doc("InstanceType enum r5dn.4xlarge") + R5dn4xlarge: "r5dn.4xlarge", + + @doc("InstanceType enum r5dn.8xlarge") + R5dn8xlarge: "r5dn.8xlarge", + + @doc("InstanceType enum r5dn.large") + R5dnLarge: "r5dn.large", + + @doc("InstanceType enum r5dn.metal") + R5dnMetal: "r5dn.metal", + + @doc("InstanceType enum r5dn.xlarge") + R5dnXlarge: "r5dn.xlarge", + + @doc("InstanceType enum r5n.12xlarge") + R5n12xlarge: "r5n.12xlarge", + + @doc("InstanceType enum r5n.16xlarge") + R5n16xlarge: "r5n.16xlarge", + + @doc("InstanceType enum r5n.24xlarge") + R5n24xlarge: "r5n.24xlarge", + + @doc("InstanceType enum r5n.2xlarge") + R5n2xlarge: "r5n.2xlarge", + + @doc("InstanceType enum r5n.4xlarge") + R5n4xlarge: "r5n.4xlarge", + + @doc("InstanceType enum r5n.8xlarge") + R5n8xlarge: "r5n.8xlarge", + + @doc("InstanceType enum r5n.large") + R5nLarge: "r5n.large", + + @doc("InstanceType enum r5n.metal") + R5nMetal: "r5n.metal", + + @doc("InstanceType enum r5n.xlarge") + R5nXlarge: "r5n.xlarge", + + @doc("InstanceType enum r6a.12xlarge") + R6a12xlarge: "r6a.12xlarge", + + @doc("InstanceType enum r6a.16xlarge") + R6a16xlarge: "r6a.16xlarge", + + @doc("InstanceType enum r6a.24xlarge") + R6a24xlarge: "r6a.24xlarge", + + @doc("InstanceType enum r6a.2xlarge") + R6a2xlarge: "r6a.2xlarge", + + @doc("InstanceType enum r6a.32xlarge") + R6a32xlarge: "r6a.32xlarge", + + @doc("InstanceType enum r6a.48xlarge") + R6a48xlarge: "r6a.48xlarge", + + @doc("InstanceType enum r6a.4xlarge") + R6a4xlarge: "r6a.4xlarge", + + @doc("InstanceType enum r6a.8xlarge") + R6a8xlarge: "r6a.8xlarge", + + @doc("InstanceType enum r6a.large") + R6aLarge: "r6a.large", + + @doc("InstanceType enum r6a.metal") + R6aMetal: "r6a.metal", + + @doc("InstanceType enum r6a.xlarge") + R6aXlarge: "r6a.xlarge", + + @doc("InstanceType enum r6g.12xlarge") + R6g12xlarge: "r6g.12xlarge", + + @doc("InstanceType enum r6g.16xlarge") + R6g16xlarge: "r6g.16xlarge", + + @doc("InstanceType enum r6g.2xlarge") + R6g2xlarge: "r6g.2xlarge", + + @doc("InstanceType enum r6g.4xlarge") + R6g4xlarge: "r6g.4xlarge", + + @doc("InstanceType enum r6g.8xlarge") + R6g8xlarge: "r6g.8xlarge", + + @doc("InstanceType enum r6g.large") + R6gLarge: "r6g.large", + + @doc("InstanceType enum r6g.medium") + R6gMedium: "r6g.medium", + + @doc("InstanceType enum r6g.metal") + R6gMetal: "r6g.metal", + + @doc("InstanceType enum r6g.xlarge") + R6gXlarge: "r6g.xlarge", + + @doc("InstanceType enum r6gd.12xlarge") + R6gd12xlarge: "r6gd.12xlarge", + + @doc("InstanceType enum r6gd.16xlarge") + R6gd16xlarge: "r6gd.16xlarge", + + @doc("InstanceType enum r6gd.2xlarge") + R6gd2xlarge: "r6gd.2xlarge", + + @doc("InstanceType enum r6gd.4xlarge") + R6gd4xlarge: "r6gd.4xlarge", + + @doc("InstanceType enum r6gd.8xlarge") + R6gd8xlarge: "r6gd.8xlarge", + + @doc("InstanceType enum r6gd.large") + R6gdLarge: "r6gd.large", + + @doc("InstanceType enum r6gd.medium") + R6gdMedium: "r6gd.medium", + + @doc("InstanceType enum r6gd.metal") + R6gdMetal: "r6gd.metal", + + @doc("InstanceType enum r6gd.xlarge") + R6gdXlarge: "r6gd.xlarge", + + @doc("InstanceType enum r6i.12xlarge") + R6i12xlarge: "r6i.12xlarge", + + @doc("InstanceType enum r6i.16xlarge") + R6i16xlarge: "r6i.16xlarge", + + @doc("InstanceType enum r6i.24xlarge") + R6i24xlarge: "r6i.24xlarge", + + @doc("InstanceType enum r6i.2xlarge") + R6i2xlarge: "r6i.2xlarge", + + @doc("InstanceType enum r6i.32xlarge") + R6i32xlarge: "r6i.32xlarge", + + @doc("InstanceType enum r6i.4xlarge") + R6i4xlarge: "r6i.4xlarge", + + @doc("InstanceType enum r6i.8xlarge") + R6i8xlarge: "r6i.8xlarge", + + @doc("InstanceType enum r6i.large") + R6iLarge: "r6i.large", + + @doc("InstanceType enum r6i.metal") + R6iMetal: "r6i.metal", + + @doc("InstanceType enum r6i.xlarge") + R6iXlarge: "r6i.xlarge", + + @doc("InstanceType enum r6id.12xlarge") + R6id12xlarge: "r6id.12xlarge", + + @doc("InstanceType enum r6id.16xlarge") + R6id16xlarge: "r6id.16xlarge", + + @doc("InstanceType enum r6id.24xlarge") + R6id24xlarge: "r6id.24xlarge", + + @doc("InstanceType enum r6id.2xlarge") + R6id2xlarge: "r6id.2xlarge", + + @doc("InstanceType enum r6id.32xlarge") + R6id32xlarge: "r6id.32xlarge", + + @doc("InstanceType enum r6id.4xlarge") + R6id4xlarge: "r6id.4xlarge", + + @doc("InstanceType enum r6id.8xlarge") + R6id8xlarge: "r6id.8xlarge", + + @doc("InstanceType enum r6id.large") + R6idLarge: "r6id.large", + + @doc("InstanceType enum r6id.metal") + R6idMetal: "r6id.metal", + + @doc("InstanceType enum r6id.xlarge") + R6idXlarge: "r6id.xlarge", + + @doc("InstanceType enum r6idn.12xlarge") + R6idn12xlarge: "r6idn.12xlarge", + + @doc("InstanceType enum r6idn.16xlarge") + R6idn16xlarge: "r6idn.16xlarge", + + @doc("InstanceType enum r6idn.24xlarge") + R6idn24xlarge: "r6idn.24xlarge", + + @doc("InstanceType enum r6idn.2xlarge") + R6idn2xlarge: "r6idn.2xlarge", + + @doc("InstanceType enum r6idn.32xlarge") + R6idn32xlarge: "r6idn.32xlarge", + + @doc("InstanceType enum r6idn.4xlarge") + R6idn4xlarge: "r6idn.4xlarge", + + @doc("InstanceType enum r6idn.8xlarge") + R6idn8xlarge: "r6idn.8xlarge", + + @doc("InstanceType enum r6idn.large") + R6idnLarge: "r6idn.large", + + @doc("InstanceType enum r6idn.metal") + R6idnMetal: "r6idn.metal", + + @doc("InstanceType enum r6idn.xlarge") + R6idnXlarge: "r6idn.xlarge", + + @doc("InstanceType enum r6in.12xlarge") + R6in12xlarge: "r6in.12xlarge", + + @doc("InstanceType enum r6in.16xlarge") + R6in16xlarge: "r6in.16xlarge", + + @doc("InstanceType enum r6in.24xlarge") + R6in24xlarge: "r6in.24xlarge", + + @doc("InstanceType enum r6in.2xlarge") + R6in2xlarge: "r6in.2xlarge", + + @doc("InstanceType enum r6in.32xlarge") + R6in32xlarge: "r6in.32xlarge", + + @doc("InstanceType enum r6in.4xlarge") + R6in4xlarge: "r6in.4xlarge", + + @doc("InstanceType enum r6in.8xlarge") + R6in8xlarge: "r6in.8xlarge", + + @doc("InstanceType enum r6in.large") + R6inLarge: "r6in.large", + + @doc("InstanceType enum r6in.metal") + R6inMetal: "r6in.metal", + + @doc("InstanceType enum r6in.xlarge") + R6inXlarge: "r6in.xlarge", + + @doc("InstanceType enum r7a.12xlarge") + R7a12xlarge: "r7a.12xlarge", + + @doc("InstanceType enum r7a.16xlarge") + R7a16xlarge: "r7a.16xlarge", + + @doc("InstanceType enum r7a.24xlarge") + R7a24xlarge: "r7a.24xlarge", + + @doc("InstanceType enum r7a.2xlarge") + R7a2xlarge: "r7a.2xlarge", + + @doc("InstanceType enum r7a.32xlarge") + R7a32xlarge: "r7a.32xlarge", + + @doc("InstanceType enum r7a.48xlarge") + R7a48xlarge: "r7a.48xlarge", + + @doc("InstanceType enum r7a.4xlarge") + R7a4xlarge: "r7a.4xlarge", + + @doc("InstanceType enum r7a.8xlarge") + R7a8xlarge: "r7a.8xlarge", + + @doc("InstanceType enum r7a.large") + R7aLarge: "r7a.large", + + @doc("InstanceType enum r7a.medium") + R7aMedium: "r7a.medium", + + @doc("InstanceType enum r7a.metal-48xl") + R7aMetal48xl: "r7a.metal-48xl", + + @doc("InstanceType enum r7a.xlarge") + R7aXlarge: "r7a.xlarge", + + @doc("InstanceType enum r7g.12xlarge") + R7g12xlarge: "r7g.12xlarge", + + @doc("InstanceType enum r7g.16xlarge") + R7g16xlarge: "r7g.16xlarge", + + @doc("InstanceType enum r7g.2xlarge") + R7g2xlarge: "r7g.2xlarge", + + @doc("InstanceType enum r7g.4xlarge") + R7g4xlarge: "r7g.4xlarge", + + @doc("InstanceType enum r7g.8xlarge") + R7g8xlarge: "r7g.8xlarge", + + @doc("InstanceType enum r7g.large") + R7gLarge: "r7g.large", + + @doc("InstanceType enum r7g.medium") + R7gMedium: "r7g.medium", + + @doc("InstanceType enum r7g.metal") + R7gMetal: "r7g.metal", + + @doc("InstanceType enum r7g.xlarge") + R7gXlarge: "r7g.xlarge", + + @doc("InstanceType enum r7gd.12xlarge") + R7gd12xlarge: "r7gd.12xlarge", + + @doc("InstanceType enum r7gd.16xlarge") + R7gd16xlarge: "r7gd.16xlarge", + + @doc("InstanceType enum r7gd.2xlarge") + R7gd2xlarge: "r7gd.2xlarge", + + @doc("InstanceType enum r7gd.4xlarge") + R7gd4xlarge: "r7gd.4xlarge", + + @doc("InstanceType enum r7gd.8xlarge") + R7gd8xlarge: "r7gd.8xlarge", + + @doc("InstanceType enum r7gd.large") + R7gdLarge: "r7gd.large", + + @doc("InstanceType enum r7gd.medium") + R7gdMedium: "r7gd.medium", + + @doc("InstanceType enum r7gd.metal") + R7gdMetal: "r7gd.metal", + + @doc("InstanceType enum r7gd.xlarge") + R7gdXlarge: "r7gd.xlarge", + + @doc("InstanceType enum r7i.12xlarge") + R7i12xlarge: "r7i.12xlarge", + + @doc("InstanceType enum r7i.16xlarge") + R7i16xlarge: "r7i.16xlarge", + + @doc("InstanceType enum r7i.24xlarge") + R7i24xlarge: "r7i.24xlarge", + + @doc("InstanceType enum r7i.2xlarge") + R7i2xlarge: "r7i.2xlarge", + + @doc("InstanceType enum r7i.48xlarge") + R7i48xlarge: "r7i.48xlarge", + + @doc("InstanceType enum r7i.4xlarge") + R7i4xlarge: "r7i.4xlarge", + + @doc("InstanceType enum r7i.8xlarge") + R7i8xlarge: "r7i.8xlarge", + + @doc("InstanceType enum r7i.large") + R7iLarge: "r7i.large", + + @doc("InstanceType enum r7i.metal-24xl") + R7iMetal24xl: "r7i.metal-24xl", + + @doc("InstanceType enum r7i.metal-48xl") + R7iMetal48xl: "r7i.metal-48xl", + + @doc("InstanceType enum r7i.xlarge") + R7iXlarge: "r7i.xlarge", + + @doc("InstanceType enum r7iz.12xlarge") + R7iz12xlarge: "r7iz.12xlarge", + + @doc("InstanceType enum r7iz.16xlarge") + R7iz16xlarge: "r7iz.16xlarge", + + @doc("InstanceType enum r7iz.2xlarge") + R7iz2xlarge: "r7iz.2xlarge", + + @doc("InstanceType enum r7iz.32xlarge") + R7iz32xlarge: "r7iz.32xlarge", + + @doc("InstanceType enum r7iz.4xlarge") + R7iz4xlarge: "r7iz.4xlarge", + + @doc("InstanceType enum r7iz.8xlarge") + R7iz8xlarge: "r7iz.8xlarge", + + @doc("InstanceType enum r7iz.large") + R7izLarge: "r7iz.large", + + @doc("InstanceType enum r7iz.metal-16xl") + R7izMetal16xl: "r7iz.metal-16xl", + + @doc("InstanceType enum r7iz.metal-32xl") + R7izMetal32xl: "r7iz.metal-32xl", + + @doc("InstanceType enum r7iz.xlarge") + R7izXlarge: "r7iz.xlarge", + + @doc("InstanceType enum t1.micro") + T1Micro: "t1.micro", + + @doc("InstanceType enum t2.2xlarge") + T22xlarge: "t2.2xlarge", + + @doc("InstanceType enum t2.large") + T2Large: "t2.large", + + @doc("InstanceType enum t2.medium") + T2Medium: "t2.medium", + + @doc("InstanceType enum t2.micro") + T2Micro: "t2.micro", + + @doc("InstanceType enum t2.nano") + T2Nano: "t2.nano", + + @doc("InstanceType enum t2.small") + T2Small: "t2.small", + + @doc("InstanceType enum t2.xlarge") + T2Xlarge: "t2.xlarge", + + @doc("InstanceType enum t3.2xlarge") + T32xlarge: "t3.2xlarge", + + @doc("InstanceType enum t3.large") + T3Large: "t3.large", + + @doc("InstanceType enum t3.medium") + T3Medium: "t3.medium", + + @doc("InstanceType enum t3.micro") + T3Micro: "t3.micro", + + @doc("InstanceType enum t3.nano") + T3Nano: "t3.nano", + + @doc("InstanceType enum t3.small") + T3Small: "t3.small", + + @doc("InstanceType enum t3.xlarge") + T3Xlarge: "t3.xlarge", + + @doc("InstanceType enum t3a.2xlarge") + T3a2xlarge: "t3a.2xlarge", + + @doc("InstanceType enum t3a.large") + T3aLarge: "t3a.large", + + @doc("InstanceType enum t3a.medium") + T3aMedium: "t3a.medium", + + @doc("InstanceType enum t3a.micro") + T3aMicro: "t3a.micro", + + @doc("InstanceType enum t3a.nano") + T3aNano: "t3a.nano", + + @doc("InstanceType enum t3a.small") + T3aSmall: "t3a.small", + + @doc("InstanceType enum t3a.xlarge") + T3aXlarge: "t3a.xlarge", + + @doc("InstanceType enum t4g.2xlarge") + T4g2xlarge: "t4g.2xlarge", + + @doc("InstanceType enum t4g.large") + T4gLarge: "t4g.large", + + @doc("InstanceType enum t4g.medium") + T4gMedium: "t4g.medium", + + @doc("InstanceType enum t4g.micro") + T4gMicro: "t4g.micro", + + @doc("InstanceType enum t4g.nano") + T4gNano: "t4g.nano", + + @doc("InstanceType enum t4g.small") + T4gSmall: "t4g.small", + + @doc("InstanceType enum t4g.xlarge") + T4gXlarge: "t4g.xlarge", + + @doc("InstanceType enum trn1.2xlarge") + Trn12xlarge: "trn1.2xlarge", + + @doc("InstanceType enum trn1.32xlarge") + Trn132xlarge: "trn1.32xlarge", + + @doc("InstanceType enum trn1n.32xlarge") + Trn1n32xlarge: "trn1n.32xlarge", + + @doc("InstanceType enum u-12tb1.112xlarge") + U12tb1112xlarge: "u-12tb1.112xlarge", + + @doc("InstanceType enum u-12tb1.metal") + U12tb1Metal: "u-12tb1.metal", + + @doc("InstanceType enum u-18tb1.112xlarge") + U18tb1112xlarge: "u-18tb1.112xlarge", + + @doc("InstanceType enum u-18tb1.metal") + U18tb1Metal: "u-18tb1.metal", + + @doc("InstanceType enum u-24tb1.112xlarge") + U24tb1112xlarge: "u-24tb1.112xlarge", + + @doc("InstanceType enum u-24tb1.metal") + U24tb1Metal: "u-24tb1.metal", + + @doc("InstanceType enum u-3tb1.56xlarge") + U3tb156xlarge: "u-3tb1.56xlarge", + + @doc("InstanceType enum u-6tb1.112xlarge") + U6tb1112xlarge: "u-6tb1.112xlarge", + + @doc("InstanceType enum u-6tb1.56xlarge") + U6tb156xlarge: "u-6tb1.56xlarge", + + @doc("InstanceType enum u-6tb1.metal") + U6tb1Metal: "u-6tb1.metal", + + @doc("InstanceType enum u-9tb1.112xlarge") + U9tb1112xlarge: "u-9tb1.112xlarge", + + @doc("InstanceType enum u-9tb1.metal") + U9tb1Metal: "u-9tb1.metal", + + @doc("InstanceType enum vt1.24xlarge") + Vt124xlarge: "vt1.24xlarge", + + @doc("InstanceType enum vt1.3xlarge") + Vt13xlarge: "vt1.3xlarge", + + @doc("InstanceType enum vt1.6xlarge") + Vt16xlarge: "vt1.6xlarge", + + @doc("InstanceType enum x1.16xlarge") + X116xlarge: "x1.16xlarge", + + @doc("InstanceType enum x1.32xlarge") + X132xlarge: "x1.32xlarge", + + @doc("InstanceType enum x1e.16xlarge") + X1e16xlarge: "x1e.16xlarge", + + @doc("InstanceType enum x1e.2xlarge") + X1e2xlarge: "x1e.2xlarge", + + @doc("InstanceType enum x1e.32xlarge") + X1e32xlarge: "x1e.32xlarge", + + @doc("InstanceType enum x1e.4xlarge") + X1e4xlarge: "x1e.4xlarge", + + @doc("InstanceType enum x1e.8xlarge") + X1e8xlarge: "x1e.8xlarge", + + @doc("InstanceType enum x1e.xlarge") + X1eXlarge: "x1e.xlarge", + + @doc("InstanceType enum x2gd.12xlarge") + X2gd12xlarge: "x2gd.12xlarge", + + @doc("InstanceType enum x2gd.16xlarge") + X2gd16xlarge: "x2gd.16xlarge", + + @doc("InstanceType enum x2gd.2xlarge") + X2gd2xlarge: "x2gd.2xlarge", + + @doc("InstanceType enum x2gd.4xlarge") + X2gd4xlarge: "x2gd.4xlarge", + + @doc("InstanceType enum x2gd.8xlarge") + X2gd8xlarge: "x2gd.8xlarge", + + @doc("InstanceType enum x2gd.large") + X2gdLarge: "x2gd.large", + + @doc("InstanceType enum x2gd.medium") + X2gdMedium: "x2gd.medium", + + @doc("InstanceType enum x2gd.metal") + X2gdMetal: "x2gd.metal", + + @doc("InstanceType enum x2gd.xlarge") + X2gdXlarge: "x2gd.xlarge", + + @doc("InstanceType enum x2idn.16xlarge") + X2idn16xlarge: "x2idn.16xlarge", + + @doc("InstanceType enum x2idn.24xlarge") + X2idn24xlarge: "x2idn.24xlarge", + + @doc("InstanceType enum x2idn.32xlarge") + X2idn32xlarge: "x2idn.32xlarge", + + @doc("InstanceType enum x2idn.metal") + X2idnMetal: "x2idn.metal", + + @doc("InstanceType enum x2iedn.16xlarge") + X2iedn16xlarge: "x2iedn.16xlarge", + + @doc("InstanceType enum x2iedn.24xlarge") + X2iedn24xlarge: "x2iedn.24xlarge", + + @doc("InstanceType enum x2iedn.2xlarge") + X2iedn2xlarge: "x2iedn.2xlarge", + + @doc("InstanceType enum x2iedn.32xlarge") + X2iedn32xlarge: "x2iedn.32xlarge", + + @doc("InstanceType enum x2iedn.4xlarge") + X2iedn4xlarge: "x2iedn.4xlarge", + + @doc("InstanceType enum x2iedn.8xlarge") + X2iedn8xlarge: "x2iedn.8xlarge", + + @doc("InstanceType enum x2iedn.metal") + X2iednMetal: "x2iedn.metal", + + @doc("InstanceType enum x2iedn.xlarge") + X2iednXlarge: "x2iedn.xlarge", + + @doc("InstanceType enum x2iezn.12xlarge") + X2iezn12xlarge: "x2iezn.12xlarge", + + @doc("InstanceType enum x2iezn.2xlarge") + X2iezn2xlarge: "x2iezn.2xlarge", + + @doc("InstanceType enum x2iezn.4xlarge") + X2iezn4xlarge: "x2iezn.4xlarge", + + @doc("InstanceType enum x2iezn.6xlarge") + X2iezn6xlarge: "x2iezn.6xlarge", + + @doc("InstanceType enum x2iezn.8xlarge") + X2iezn8xlarge: "x2iezn.8xlarge", + + @doc("InstanceType enum x2iezn.metal") + X2ieznMetal: "x2iezn.metal", + + @doc("InstanceType enum z1d.12xlarge") + Z1d12xlarge: "z1d.12xlarge", + + @doc("InstanceType enum z1d.2xlarge") + Z1d2xlarge: "z1d.2xlarge", + + @doc("InstanceType enum z1d.3xlarge") + Z1d3xlarge: "z1d.3xlarge", + + @doc("InstanceType enum z1d.6xlarge") + Z1d6xlarge: "z1d.6xlarge", + + @doc("InstanceType enum z1d.large") + Z1dLarge: "z1d.large", + + @doc("InstanceType enum z1d.metal") + Z1dMetal: "z1d.metal", + + @doc("InstanceType enum z1d.xlarge") + Z1dXlarge: "z1d.xlarge", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceTypeEnumValue") +model InstanceTypeEnumValue { + @doc("Property value") + value?: InstanceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CapacityReservationSpecificationResponse") +model CapacityReservationSpecificationResponse { + @doc("<p>Describes the instance's Capacity Reservation preferences. Possible preferences include:</p> <ul> <li> <p> <code>open</code> - The instance can run in any <code>open</code> Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).</p> </li> <li> <p> <code>none</code> - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.</p> </li> </ul>") + capacityReservationPreference?: CapacityReservationPreferenceEnumValue; + + @doc("<p>Information about the targeted Capacity Reservation or Capacity Reservation group.</p>") + capacityReservationTarget?: CapacityReservationTargetResponse; +} + +@doc("HypervisorType enum") +union HypervisorType { + @doc("HypervisorType enum ovm") + Ovm: "ovm", + + @doc("HypervisorType enum xen") + Xen: "xen", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HypervisorTypeEnumValue") +model HypervisorTypeEnumValue { + @doc("Property value") + value?: HypervisorType; +} + +@doc("CapacityReservationPreference enum") +union CapacityReservationPreference { + @doc("CapacityReservationPreference enum none") + None: "none", + + @doc("CapacityReservationPreference enum open") + Open: "open", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CapacityReservationPreferenceEnumValue") +model CapacityReservationPreferenceEnumValue { + @doc("Property value") + value?: CapacityReservationPreference; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CpuOptions") +model CpuOptions { + @doc("<p>Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html'>AMD SEV-SNP</a>.</p>") + amdSevSnp?: AmdSevSnpSpecificationEnumValue; + + @doc("<p>The number of CPU cores for the instance.</p>") + coreCount?: int32; + + @doc("<p>The number of threads per CPU core.</p>") + threadsPerCore?: int32; +} + +@doc("DeviceType enum") +union DeviceType { + @doc("DeviceType enum ebs") + Ebs: "ebs", + + @doc("DeviceType enum instance-store") + InstanceStore: "instance-store", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeviceTypeEnumValue") +model DeviceTypeEnumValue { + @doc("Property value") + value?: DeviceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticGpuAssociation") +model ElasticGpuAssociation { + @doc("<p>The ID of the association.</p>") + elasticGpuAssociationId?: string; + + @doc("<p>The state of the association between the instance and the Elastic Graphics accelerator.</p>") + elasticGpuAssociationState?: string; + + @doc("<p>The time the Elastic Graphics accelerator was associated with the instance.</p>") + elasticGpuAssociationTime?: string; + + @doc("<p>The ID of the Elastic Graphics accelerator.</p>") + elasticGpuId?: string; +} + +@doc("AmdSevSnpSpecification enum") +union AmdSevSnpSpecification { + @doc("AmdSevSnpSpecification enum disabled") + Disabled: "disabled", + + @doc("AmdSevSnpSpecification enum enabled") + Enabled: "enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AmdSevSnpSpecificationEnumValue") +model AmdSevSnpSpecificationEnumValue { + @doc("Property value") + value?: AmdSevSnpSpecification; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticInferenceAcceleratorAssociation") +model ElasticInferenceAcceleratorAssociation { + @doc("<p> The Amazon Resource Name (ARN) of the elastic inference accelerator. </p>") + elasticInferenceAcceleratorArn?: string; + + @doc("<p> The ID of the association. </p>") + elasticInferenceAcceleratorAssociationId?: string; + + @doc("<p> The state of the elastic inference accelerator. </p>") + elasticInferenceAcceleratorAssociationState?: string; + + @doc("<p> The time at which the elastic inference accelerator is associated with an instance. </p>") + elasticInferenceAcceleratorAssociationTime?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnclaveOptions") +model EnclaveOptions { + @doc("<p>If this parameter is set to <code>true</code>, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.</p>") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HibernationOptions") +model HibernationOptions { + @doc("<p>If <code>true</code>, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.</p>") + configured?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamInstanceProfile") +model IamInstanceProfile { + @doc("<p>The Amazon Resource Name (ARN) of the instance profile.</p>") + arn?: string; + + @doc("<p>The ID of the instance profile.</p>") + id?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LicenseConfiguration") +model LicenseConfiguration { + @doc("<p>The Amazon Resource Name (ARN) of the license configuration.</p>") + licenseConfigurationArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMaintenanceOptions") +model InstanceMaintenanceOptions { + @doc("<p>Provides information on the current automatic recovery behavior of your instance.</p>") + autoRecovery?: InstanceAutoRecoveryStateEnumValue; +} + +@doc("InstanceAutoRecoveryState enum") +union InstanceAutoRecoveryState { + @doc("InstanceAutoRecoveryState enum default") + Default: "default", + + @doc("InstanceAutoRecoveryState enum disabled") + Disabled: "disabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceAutoRecoveryStateEnumValue") +model InstanceAutoRecoveryStateEnumValue { + @doc("Property value") + value?: InstanceAutoRecoveryState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMetadataOptionsResponse") +model InstanceMetadataOptionsResponse { + @doc("<p>Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.</p> <p>If the value is <code>disabled</code>, you cannot access your instance metadata.</p>") + httpEndpoint?: InstanceMetadataEndpointStateEnumValue; + + @doc("<p>Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.</p> <p>Default: <code>disabled</code> </p>") + httpProtocolIpv6?: InstanceMetadataProtocolStateEnumValue; + + @doc("<p>The maximum number of hops that the metadata token can travel.</p> <p>Possible values: Integers from <code>1</code> to <code>64</code> </p>") + httpPutResponseHopLimit?: int32; + + @doc("<p>Indicates whether IMDSv2 is required.</p> <ul> <li> <p> <code>optional</code> - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.</p> </li> <li> <p> <code>required</code> - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.</p> </li> </ul>") + httpTokens?: HttpTokensStateEnumValue; + + @doc("<p>Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS'>Work with instance tags using the instance metadata</a>.</p>") + instanceMetadataTags?: InstanceMetadataTagsStateEnumValue; + + @doc("<p>The state of the metadata option changes.</p> <p> <code>pending</code> - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.</p> <p> <code>applied</code> - The metadata options have been successfully applied on the instance.</p>") + state?: InstanceMetadataOptionsStateEnumValue; +} + +@doc("InstanceMetadataEndpointState enum") +union InstanceMetadataEndpointState { + @doc("InstanceMetadataEndpointState enum disabled") + Disabled: "disabled", + + @doc("InstanceMetadataEndpointState enum enabled") + Enabled: "enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMetadataEndpointStateEnumValue") +model InstanceMetadataEndpointStateEnumValue { + @doc("Property value") + value?: InstanceMetadataEndpointState; +} + +@doc("HttpTokensState enum") +union HttpTokensState { + @doc("HttpTokensState enum optional") + Optional: "optional", + + @doc("HttpTokensState enum required") + Required: "required", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HttpTokensStateEnumValue") +model HttpTokensStateEnumValue { + @doc("Property value") + value?: HttpTokensState; +} + +@doc("InstanceMetadataOptionsState enum") +union InstanceMetadataOptionsState { + @doc("InstanceMetadataOptionsState enum applied") + Applied: "applied", + + @doc("InstanceMetadataOptionsState enum pending") + Pending: "pending", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMetadataOptionsStateEnumValue") +model InstanceMetadataOptionsStateEnumValue { + @doc("Property value") + value?: InstanceMetadataOptionsState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Monitoring") +model Monitoring { + @doc("<p>Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.</p>") + state?: MonitoringStateEnumValue; +} + +@doc("InstanceMetadataProtocolState enum") +union InstanceMetadataProtocolState { + @doc("InstanceMetadataProtocolState enum disabled") + Disabled: "disabled", + + @doc("InstanceMetadataProtocolState enum enabled") + Enabled: "enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMetadataProtocolStateEnumValue") +model InstanceMetadataProtocolStateEnumValue { + @doc("Property value") + value?: InstanceMetadataProtocolState = "disabled"; +} + +@doc("MonitoringState enum") +union MonitoringState { + @doc("MonitoringState enum disabled") + Disabled: "disabled", + + @doc("MonitoringState enum disabling") + Disabling: "disabling", + + @doc("MonitoringState enum enabled") + Enabled: "enabled", + + @doc("MonitoringState enum pending") + Pending: "pending", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MonitoringStateEnumValue") +model MonitoringStateEnumValue { + @doc("Property value") + value?: MonitoringState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceNetworkInterface") +model InstanceNetworkInterface { + @doc("<p>The association information for an Elastic IPv4 associated with the network interface.</p>") + association?: InstanceNetworkInterfaceAssociation; + + @doc("<p>The network interface attachment.</p>") + attachment?: InstanceNetworkInterfaceAttachment; + + @doc("<p>A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts'>Connection tracking timeouts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>") + connectionTrackingConfiguration?: ConnectionTrackingSpecificationResponse; + + @doc("<p>The description.</p>") + description?: string; + + @doc("<p>The security groups.</p>") + @extension("x-ms-identifiers", []) + groups?: GroupIdentifier[]; + + @doc("<p>The type of network interface.</p> <p>Valid values: <code>interface</code> | <code>efa</code> | <code>trunk</code> </p>") + interfaceType?: string; + + @doc("<p>The IPv4 delegated prefixes that are assigned to the network interface.</p>") + @extension("x-ms-identifiers", []) + ipv4Prefixes?: InstanceIpv4Prefix[]; + + @doc("<p>The IPv6 addresses associated with the network interface.</p>") + @extension("x-ms-identifiers", []) + ipv6Addresses?: InstanceIpv6Address[]; + + @doc("<p>The IPv6 delegated prefixes that are assigned to the network interface.</p>") + @extension("x-ms-identifiers", []) + ipv6Prefixes?: InstanceIpv6Prefix[]; + + @doc("<p>The MAC address.</p>") + macAddress?: string; + + @doc("<p>The ID of the network interface.</p>") + networkInterfaceId?: string; + + @doc("<p>The ID of the Amazon Web Services account that created the network interface.</p>") + ownerId?: string; + + @doc("<p>The private DNS name.</p>") + privateDnsName?: string; + + @doc("<p>The IPv4 address of the network interface within the subnet.</p>") + privateIpAddress?: string; + + @doc("<p>The private IPv4 addresses associated with the network interface.</p>") + @extension("x-ms-identifiers", []) + privateIpAddresses?: InstancePrivateIpAddress[]; + + @doc("<p>Indicates whether source/destination checking is enabled.</p>") + sourceDestCheck?: boolean; + + @doc("<p>The status of the network interface.</p>") + status?: NetworkInterfaceStatusEnumValue; + + @doc("<p>The ID of the subnet.</p>") + subnetId?: string; + + @doc("<p>The ID of the VPC.</p>") + vpcId?: string; +} + +@doc("InstanceMetadataTagsState enum") +union InstanceMetadataTagsState { + @doc("InstanceMetadataTagsState enum disabled") + Disabled: "disabled", + + @doc("InstanceMetadataTagsState enum enabled") + Enabled: "enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceMetadataTagsStateEnumValue") +model InstanceMetadataTagsStateEnumValue { + @doc("Property value") + value?: InstanceMetadataTagsState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Placement") +model Placement { + @doc("<p>The affinity setting for the instance on the Dedicated Host.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a> or <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a>.</p>") + affinity?: string; + + @doc("<p>The Availability Zone of the instance.</p> <p>If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>") + availabilityZone?: string; + + @doc("<p>The ID of the placement group that the instance is in. If you specify <code>GroupId</code>, you can't specify <code>GroupName</code>.</p>") + groupId?: string; + + @doc("<p>The name of the placement group that the instance is in. If you specify <code>GroupName</code>, you can't specify <code>GroupId</code>.</p>") + groupName?: string; + + @doc("<p>The ID of the Dedicated Host on which the instance resides.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a> or <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a>.</p>") + hostId?: string; + + @doc("<p>The ARN of the host resource group in which to launch the instances.</p> <p>If you specify this parameter, either omit the <b>Tenancy</b> parameter or set it to <code>host</code>.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>") + hostResourceGroupArn?: string; + + @doc("<p>The number of the partition that the instance is in. Valid only if the placement group strategy is set to <code>partition</code>.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>") + partitionNumber?: int32; + + @doc("<p>Reserved for future use.</p>") + spreadDomain?: string; + + @doc("<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>. The <code>host</code> tenancy is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a> or for T3 instances that are configured for the <code>unlimited</code> CPU credit option.</p>") + tenancy?: TenancyEnumValue; +} + +@doc("NetworkInterfaceStatus enum") +union NetworkInterfaceStatus { + @doc("NetworkInterfaceStatus enum associated") + Associated: "associated", + + @doc("NetworkInterfaceStatus enum attaching") + Attaching: "attaching", + + @doc("NetworkInterfaceStatus enum available") + Available: "available", + + @doc("NetworkInterfaceStatus enum detaching") + Detaching: "detaching", + + @doc("NetworkInterfaceStatus enum in-use") + InUse: "in-use", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkInterfaceStatusEnumValue") +model NetworkInterfaceStatusEnumValue { + @doc("Property value") + value?: NetworkInterfaceStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PrivateDnsNameOptionsResponse") +model PrivateDnsNameOptionsResponse { + @doc("<p>Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.</p>") + enableResourceNameDnsAAAARecord?: boolean; + + @doc("<p>Indicates whether to respond to DNS queries for instance hostnames with DNS A records.</p>") + enableResourceNameDnsARecord?: boolean; + + @doc("<p>The type of hostname to assign to an instance.</p>") + hostnameType?: HostnameTypeEnumValue; +} + +@doc("Tenancy enum") +union Tenancy { + @doc("Tenancy enum dedicated") + Dedicated: "dedicated", + + @doc("Tenancy enum default") + Default: "default", + + @doc("Tenancy enum host") + Host: "host", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TenancyEnumValue") +model TenancyEnumValue { + @doc("Property value") + value?: Tenancy; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProductCode") +model ProductCode { + @doc("<p>The product code.</p>") + productCodeId?: string; + + @doc("<p>The type of product code.</p>") + productCodeType?: ProductCodeValuesEnumValue; +} + +@doc("HostnameType enum") +union HostnameType { + @doc("HostnameType enum ip-name") + IpName: "ip-name", + + @doc("HostnameType enum resource-name") + ResourceName: "resource-name", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HostnameTypeEnumValue") +model HostnameTypeEnumValue { + @doc("Property value") + value?: HostnameType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GroupIdentifier") +model GroupIdentifier { + @doc("<p>The ID of the security group.</p>") + groupId?: string; + + @doc("<p>The name of the security group.</p>") + groupName?: string; +} + +@doc("ProductCodeValues enum") +union ProductCodeValues { + @doc("ProductCodeValues enum devpay") + Devpay: "devpay", + + @doc("ProductCodeValues enum marketplace") + Marketplace: "marketplace", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProductCodeValuesEnumValue") +model ProductCodeValuesEnumValue { + @doc("Property value") + value?: ProductCodeValues; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceState") +model InstanceState { + @doc("<p>The state of the instance as a 16-bit unsigned integer. </p> <p>The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.</p> <p>The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. </p> <p>The valid values for instance-state-code will all be in the range of the low byte and they are:</p> <ul> <li> <p> <code>0</code> : <code>pending</code> </p> </li> <li> <p> <code>16</code> : <code>running</code> </p> </li> <li> <p> <code>32</code> : <code>shutting-down</code> </p> </li> <li> <p> <code>48</code> : <code>terminated</code> </p> </li> <li> <p> <code>64</code> : <code>stopping</code> </p> </li> <li> <p> <code>80</code> : <code>stopped</code> </p> </li> </ul> <p>You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.</p>") + code?: int32; + + @doc("<p>The current state of the instance.</p>") + name?: InstanceStateNameEnumValue; +} + +@doc("InstanceStateName enum") +union InstanceStateName { + @doc("InstanceStateName enum pending") + Pending: "pending", + + @doc("InstanceStateName enum running") + Running: "running", + + @doc("InstanceStateName enum shutting-down") + ShuttingDown: "shutting-down", + + @doc("InstanceStateName enum stopped") + Stopped: "stopped", + + @doc("InstanceStateName enum stopping") + Stopping: "stopping", + + @doc("InstanceStateName enum terminated") + Terminated: "terminated", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceStateNameEnumValue") +model InstanceStateNameEnumValue { + @doc("Property value") + value?: InstanceStateName; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StateReason") +model StateReason { + @doc("<p>The reason code for the state change.</p>") + code?: string; + + @doc("<p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul>") + message?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EbsInstanceBlockDevice") +model EbsInstanceBlockDevice { + @doc("<p>The ARN of the Amazon ECS or Fargate task to which the volume is attached.</p>") + associatedResource?: string; + + @doc("<p>The time stamp when the attachment initiated.</p>") + attachTime?: utcDateTime; + + @doc("<p>Indicates whether the volume is deleted on instance termination.</p>") + deleteOnTermination?: boolean; + + @doc("<p>The attachment state.</p>") + status?: AttachmentStatusEnumValue; + + @doc("<p>The ID of the EBS volume.</p>") + volumeId?: string; + + @doc("<p>The ID of the Amazon Web Services account that owns the volume.</p> <p>This parameter is returned only for volumes that are attached to Fargate tasks.</p>") + volumeOwnerId?: string; +} + +@doc("AttachmentStatus enum") +union AttachmentStatus { + @doc("AttachmentStatus enum attached") + Attached: "attached", + + @doc("AttachmentStatus enum attaching") + Attaching: "attaching", + + @doc("AttachmentStatus enum detached") + Detached: "detached", + + @doc("AttachmentStatus enum detaching") + Detaching: "detaching", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AttachmentStatusEnumValue") +model AttachmentStatusEnumValue { + @doc("Property value") + value?: AttachmentStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CapacityReservationTargetResponse") +model CapacityReservationTargetResponse { + @doc("<p>The ID of the targeted Capacity Reservation.</p>") + capacityReservationId?: string; + + @doc("<p>The ARN of the targeted Capacity Reservation group.</p>") + capacityReservationResourceGroupArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceNetworkInterfaceAssociation") +model InstanceNetworkInterfaceAssociation { + @doc("<p>The carrier IP address associated with the network interface.</p>") + carrierIp?: string; + + @doc("<p>The customer-owned IP address associated with the network interface.</p>") + customerOwnedIp?: string; + + @doc("<p>The ID of the owner of the Elastic IP address.</p>") + ipOwnerId?: string; + + @doc("<p>The public DNS name.</p>") + publicDnsName?: string; + + @doc("<p>The public IP address or Elastic IP address bound to the network interface.</p>") + publicIp?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceNetworkInterfaceAttachment") +model InstanceNetworkInterfaceAttachment { + @doc("<p>The time stamp when the attachment initiated.</p>") + attachTime?: utcDateTime; + + @doc("<p>The ID of the network interface attachment.</p>") + attachmentId?: string; + + @doc("<p>Indicates whether the network interface is deleted when the instance is terminated.</p>") + deleteOnTermination?: boolean; + + @doc("<p>The index of the device on the instance for the network interface attachment.</p>") + deviceIndex?: int32; + + @doc("<p>Contains the ENA Express settings for the network interface that's attached to the instance.</p>") + enaSrdSpecification?: InstanceAttachmentEnaSrdSpecification; + + @doc("<p>The index of the network card.</p>") + networkCardIndex?: int32; + + @doc("<p>The attachment state.</p>") + status?: AttachmentStatusEnumValue; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConnectionTrackingSpecificationResponse") +model ConnectionTrackingSpecificationResponse { + @doc("<p>Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.</p>") + tcpEstablishedTimeout?: int32 = 432000; + + @doc("<p>Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.</p>") + udpStreamTimeout?: int32 = 180; + + @doc("<p>Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.</p>") + udpTimeout?: int32 = 30; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceIpv4Prefix") +model InstanceIpv4Prefix { + @doc("<p>One or more IPv4 prefixes assigned to the network interface.</p>") + ipv4Prefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceIpv6Address") +model InstanceIpv6Address { + @doc("<p>The IPv6 address.</p>") + ipv6Address?: string; + + @doc("<p>Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>.</p>") + isPrimaryIpv6?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceIpv6Prefix") +model InstanceIpv6Prefix { + @doc("<p>One or more IPv6 prefixes assigned to the network interface.</p>") + ipv6Prefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstancePrivateIpAddress") +model InstancePrivateIpAddress { + @doc("<p>The association information for an Elastic IP address for the network interface.</p>") + association?: InstanceNetworkInterfaceAssociation; + + @doc("<p>Indicates whether this IPv4 address is the primary private IP address of the network interface.</p>") + primary?: boolean; + + @doc("<p>The private IPv4 DNS name.</p>") + privateDnsName?: string; + + @doc("<p>The private IPv4 address of the network interface.</p>") + privateIpAddress?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceAttachmentEnaSrdSpecification") +model InstanceAttachmentEnaSrdSpecification { + @doc("<p>Indicates whether ENA Express is enabled for the network interface.</p>") + enaSrdEnabled?: boolean; + + @doc("<p>Configures ENA Express for UDP network traffic.</p>") + enaSrdUdpSpecification?: InstanceAttachmentEnaSrdUdpSpecification; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceAttachmentEnaSrdUdpSpecification") +model InstanceAttachmentEnaSrdUdpSpecification { + @doc("<p>Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.</p>") + enaSrdUdpEnabled?: boolean; +} + +@doc("Defines the stop action properties.") +model StopEc2InstanceOptions { + @doc("Forces the instance to stop. The instance does not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Defaults to false.") + force?: boolean = false; + + @doc("Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. Defaults to false.") + hibernate?: boolean = false; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Instances { + get is ArmResourceRead<Ec2Instance>; + @doc("Create a Ec2Instance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Instance>; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Instance>; + list is ArmResourceListByParent<Ec2Instance>; + Start is ArmResourceActionAsync< + Ec2Instance, + void, + Azure.ResourceManager.Foundations.OperationStatusResult + >; + Stop is ArmResourceActionAsync< + Ec2Instance, + StopEc2InstanceOptions, + Azure.ResourceManager.Foundations.OperationStatusResult + >; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: Instance +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Instance.Management/tspconfig.yaml b/specification/awsconnector/Ec2Instance.Management/tspconfig.yaml new file mode 100644 index 000000000000..6254cc552685 --- /dev/null +++ b/specification/awsconnector/Ec2Instance.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Instance.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_CreateOrReplace.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..2ce8b4595a1c --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_CreateOrReplace.json @@ -0,0 +1,259 @@ +{ + "title": "Ec2InstanceStatuses_CreateOrReplace", + "operationId": "Ec2InstanceStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + } + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Delete.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Delete.json new file mode 100644 index 000000000000..e21a1b86c65a --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2InstanceStatuses_Delete", + "operationId": "Ec2InstanceStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Get.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Get.json new file mode 100644 index 000000000000..4cd5fcf6fc0a --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Get.json @@ -0,0 +1,98 @@ +{ + "title": "Ec2InstanceStatuses_Get", + "operationId": "Ec2InstanceStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListByResourceGroup.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..fe98c2b88652 --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListByResourceGroup.json @@ -0,0 +1,102 @@ +{ + "title": "Ec2InstanceStatuses_ListByResourceGroup", + "operationId": "Ec2InstanceStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + ], + "nextLink": "https://microsoft.com/alckbe" + } + } + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListBySubscription.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListBySubscription.json new file mode 100644 index 000000000000..d3aeabcd329d --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_ListBySubscription.json @@ -0,0 +1,101 @@ +{ + "title": "Ec2InstanceStatuses_ListBySubscription", + "operationId": "Ec2InstanceStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + ], + "nextLink": "https://microsoft.com/alckbe" + } + } + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Update.json b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Update.json new file mode 100644 index 000000000000..21272dc6fb69 --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/examples/2024-12-01/Ec2InstanceStatuses_Update.json @@ -0,0 +1,108 @@ +{ + "title": "Ec2InstanceStatuses_Update", + "operationId": "Ec2InstanceStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3283": "pkbbgzmxkmwygqdlfzoz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/main.tsp b/specification/awsconnector/Ec2InstanceStatus.Management/main.tsp new file mode 100644 index 000000000000..40b0bc6127bc --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/main.tsp @@ -0,0 +1,329 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2InstanceStatuses ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Instance Status", + plural: "EC2 Instance Statuses", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Instance", "Status"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2InstanceStatus is TrackedResource<Ec2InstanceStatusProperties> { + @doc("Name of Ec2InstanceStatus") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2InstanceStatuses") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2InstanceStatus") +model Ec2InstanceStatusProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2InstanceStatusProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2InstanceStatus") +model AwsEc2InstanceStatusProperties { + @doc("<p>The Availability Zone of the instance.</p>") + availabilityZone?: string; + + @doc("<p>Any scheduled events associated with the instance.</p>") + @extension("x-ms-identifiers", []) + events?: InstanceStatusEvent[]; + + @doc("<p>The ID of the instance.</p>") + instanceId?: string; + + @doc("<p>The intended state of the instance. <a>DescribeInstanceStatus</a> requires that an instance be in the <code>running</code> state.</p>") + instanceState?: InstanceState; + + @doc("<p>Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.</p>") + instanceStatus?: InstanceStatusSummary; + + @doc("<p>The Amazon Resource Name (ARN) of the Outpost.</p>") + outpostArn?: string; + + @doc("<p>Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.</p>") + systemStatus?: InstanceStatusSummary; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceStatusEvent") +model InstanceStatusEvent { + @doc("<p>The event code.</p>") + code?: EventCodeEnumValue; + + @doc("<p>A description of the event.</p> <p>After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].</p>") + description?: string; + + @doc("<p>The ID of the event.</p>") + instanceEventId?: string; + + @doc("<p>The latest scheduled end time for the event.</p>") + notAfter?: utcDateTime; + + @doc("<p>The earliest scheduled start time for the event.</p>") + notBefore?: utcDateTime; + + @doc("<p>The deadline for starting the event.</p>") + notBeforeDeadline?: utcDateTime; +} + +@doc("EventCode enum") +union EventCode { + @doc("EventCode enum instance-reboot") + InstanceReboot: "instance-reboot", + + @doc("EventCode enum instance-retirement") + InstanceRetirement: "instance-retirement", + + @doc("EventCode enum instance-stop") + InstanceStop: "instance-stop", + + @doc("EventCode enum system-maintenance") + SystemMaintenance: "system-maintenance", + + @doc("EventCode enum system-reboot") + SystemReboot: "system-reboot", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EventCodeEnumValue") +model EventCodeEnumValue { + @doc("Property value") + value?: EventCode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceState") +model InstanceState { + @doc("<p>The state of the instance as a 16-bit unsigned integer. </p> <p>The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.</p> <p>The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. </p> <p>The valid values for instance-state-code will all be in the range of the low byte and they are:</p> <ul> <li> <p> <code>0</code> : <code>pending</code> </p> </li> <li> <p> <code>16</code> : <code>running</code> </p> </li> <li> <p> <code>32</code> : <code>shutting-down</code> </p> </li> <li> <p> <code>48</code> : <code>terminated</code> </p> </li> <li> <p> <code>64</code> : <code>stopping</code> </p> </li> <li> <p> <code>80</code> : <code>stopped</code> </p> </li> </ul> <p>You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.</p>") + code?: int32; + + @doc("<p>The current state of the instance.</p>") + name?: InstanceStateNameEnumValue; +} + +@doc("InstanceStateName enum") +union InstanceStateName { + @doc("InstanceStateName enum pending") + Pending: "pending", + + @doc("InstanceStateName enum running") + Running: "running", + + @doc("InstanceStateName enum shutting-down") + ShuttingDown: "shutting-down", + + @doc("InstanceStateName enum stopped") + Stopped: "stopped", + + @doc("InstanceStateName enum stopping") + Stopping: "stopping", + + @doc("InstanceStateName enum terminated") + Terminated: "terminated", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceStateNameEnumValue") +model InstanceStateNameEnumValue { + @doc("Property value") + value?: InstanceStateName; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceStatusSummary") +model InstanceStatusSummary { + @doc("<p>The system instance health or application instance health.</p>") + @extension("x-ms-identifiers", []) + details?: InstanceStatusDetails[]; + + @doc("<p>The status.</p>") + status?: SummaryStatusEnumValue; +} + +@doc("SummaryStatus enum") +union SummaryStatus { + @doc("SummaryStatus enum impaired") + Impaired: "impaired", + + @doc("SummaryStatus enum initializing") + Initializing: "initializing", + + @doc("SummaryStatus enum insufficient-data") + InsufficientData: "insufficient-data", + + @doc("SummaryStatus enum not-applicable") + NotApplicable: "not-applicable", + + @doc("SummaryStatus enum ok") + Ok: "ok", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SummaryStatusEnumValue") +model SummaryStatusEnumValue { + @doc("Property value") + value?: SummaryStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceStatusDetails") +model InstanceStatusDetails { + @doc("<p>The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.</p>") + impairedSince?: utcDateTime; + + @doc("<p>The type of instance status.</p>") + name?: StatusNameEnumValue; + + @doc("<p>The status.</p>") + status?: StatusTypeEnumValue; +} + +@doc("StatusName enum") +union StatusName { + @doc("StatusName enum reachability") + Reachability: "reachability", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatusNameEnumValue") +model StatusNameEnumValue { + @doc("Property value") + value?: StatusName; +} + +@doc("StatusType enum") +union StatusType { + @doc("StatusType enum failed") + Failed: "failed", + + @doc("StatusType enum initializing") + Initializing: "initializing", + + @doc("StatusType enum insufficient-data") + InsufficientData: "insufficient-data", + + @doc("StatusType enum passed") + Passed: "passed", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatusTypeEnumValue") +model StatusTypeEnumValue { + @doc("Property value") + value?: StatusType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2InstanceStatuses { + get is ArmResourceRead<Ec2InstanceStatus>; + @doc("Create a Ec2InstanceStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2InstanceStatus>; + update is ArmCustomPatchAsync< + Ec2InstanceStatus, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2InstanceStatus> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2InstanceStatus>; + listByResourceGroup is ArmResourceListByParent<Ec2InstanceStatus>; + listBySubscription is ArmListBySubscription<Ec2InstanceStatus>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: InstanceStatus +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2InstanceStatus.Management/tspconfig.yaml b/specification/awsconnector/Ec2InstanceStatus.Management/tspconfig.yaml new file mode 100644 index 000000000000..1b1cd4da23a9 --- /dev/null +++ b/specification/awsconnector/Ec2InstanceStatus.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2InstanceStatus.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_CreateOrReplace.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_CreateOrReplace.json new file mode 100644 index 000000000000..1e5afc0ac99d --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "Ec2Ipams_CreateOrReplace", + "operationId": "Ec2Ipams_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + } + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Delete.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Delete.json new file mode 100644 index 000000000000..5d1f0a331e34 --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Ipams_Delete", + "operationId": "Ec2Ipams_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Get.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Get.json new file mode 100644 index 000000000000..1a08a578d54e --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Get.json @@ -0,0 +1,74 @@ +{ + "title": "Ec2Ipams_Get", + "operationId": "Ec2Ipams_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListByResourceGroup.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListByResourceGroup.json new file mode 100644 index 000000000000..effe5146e90d --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "Ec2Ipams_ListByResourceGroup", + "operationId": "Ec2Ipams_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListBySubscription.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListBySubscription.json new file mode 100644 index 000000000000..a118782d52b9 --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2Ipams_ListBySubscription", + "operationId": "Ec2Ipams_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Update.json b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Update.json new file mode 100644 index 000000000000..8ca1823c50b5 --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/examples/2024-12-01/Ec2Ipams_Update.json @@ -0,0 +1,84 @@ +{ + "title": "Ec2Ipams_Update", + "operationId": "Ec2Ipams_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1619": "cpquimegsosw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Ipam.Management/main.tsp b/specification/awsconnector/Ec2Ipam.Management/main.tsp new file mode 100644 index 000000000000..ec12381a57bc --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/main.tsp @@ -0,0 +1,246 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Ipams ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Ipam", + plural: "EC2 Ipams", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Ipam"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Ipam is TrackedResource<Ec2IpamProperties> { + @doc("Name of Ec2Ipam") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Ipams") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Ipam") +model Ec2IpamProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2IpamProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Ipam") +model AwsEc2IpamProperties { + @doc("<p>The IPAM's default resource discovery association ID.</p>") + defaultResourceDiscoveryAssociationId?: string; + + @doc("<p>The IPAM's default resource discovery ID.</p>") + defaultResourceDiscoveryId?: string; + + @doc("<p>The description for the IPAM.</p>") + description?: string; + + @doc("<p>The Amazon Resource Name (ARN) of the IPAM.</p>") + ipamArn?: string; + + @doc("<p>The ID of the IPAM.</p>") + ipamId?: string; + + @doc("<p>The Amazon Web Services Region of the IPAM.</p>") + ipamRegion?: string; + + @doc("<p>The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.</p> <p>For more information about operating Regions, see <a href='https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html'>Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>") + @extension("x-ms-identifiers", []) + operatingRegions?: IpamOperatingRegion[]; + + @doc("<p>The Amazon Web Services account ID of the owner of the IPAM.</p>") + ownerId?: string; + + @doc("<p>The ID of the IPAM's default private scope.</p>") + privateDefaultScopeId?: string; + + @doc("<p>The ID of the IPAM's default public scope.</p>") + publicDefaultScopeId?: string; + + @doc("<p>The IPAM's resource discovery association count.</p>") + resourceDiscoveryAssociationCount?: int32; + + @doc("<p>The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see <a href='https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html'>Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>") + scopeCount?: int32; + + @doc("<p>The state of the IPAM.</p>") + state?: IpamStateEnumValue; + + @doc("<p>The state message.</p>") + stateMessage?: string; + + @doc("<p>The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see <a href='http://aws.amazon.com/vpc/pricing/'>Amazon VPC pricing > IPAM tab</a>.</p>") + tier?: IpamTierEnumValue; +} + +@doc("IpamState enum") +union IpamState { + @doc("IpamState enum create-complete") + CreateComplete: "create-complete", + + @doc("IpamState enum create-failed") + CreateFailed: "create-failed", + + @doc("IpamState enum create-in-progress") + CreateInProgress: "create-in-progress", + + @doc("IpamState enum delete-complete") + DeleteComplete: "delete-complete", + + @doc("IpamState enum delete-failed") + DeleteFailed: "delete-failed", + + @doc("IpamState enum delete-in-progress") + DeleteInProgress: "delete-in-progress", + + @doc("IpamState enum isolate-complete") + IsolateComplete: "isolate-complete", + + @doc("IpamState enum isolate-in-progress") + IsolateInProgress: "isolate-in-progress", + + @doc("IpamState enum modify-complete") + ModifyComplete: "modify-complete", + + @doc("IpamState enum modify-failed") + ModifyFailed: "modify-failed", + + @doc("IpamState enum modify-in-progress") + ModifyInProgress: "modify-in-progress", + + @doc("IpamState enum restore-in-progress") + RestoreInProgress: "restore-in-progress", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpamStateEnumValue") +model IpamStateEnumValue { + @doc("Property value") + value?: IpamState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpamOperatingRegion") +model IpamOperatingRegion { + @doc("<p>The name of the operating Region.</p>") + regionName?: string; +} + +@doc("IpamTier enum") +union IpamTier { + @doc("IpamTier enum advanced") + Advanced: "advanced", + + @doc("IpamTier enum free") + Free: "free", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpamTierEnumValue") +model IpamTierEnumValue { + @doc("Property value") + value?: IpamTier; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Ipams { + get is ArmResourceRead<Ec2Ipam>; + @doc("Create a Ec2Ipam. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Ipam>; + update is ArmCustomPatchAsync< + Ec2Ipam, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Ipam> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Ipam>; + listByResourceGroup is ArmResourceListByParent<Ec2Ipam>; + listBySubscription is ArmListBySubscription<Ec2Ipam>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: Ipam +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Ipam.Management/tspconfig.yaml b/specification/awsconnector/Ec2Ipam.Management/tspconfig.yaml new file mode 100644 index 000000000000..49bce0878d50 --- /dev/null +++ b/specification/awsconnector/Ec2Ipam.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Ipam.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_CreateOrReplace.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_CreateOrReplace.json new file mode 100644 index 000000000000..c5ee1aa5d088 --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2KeyPairs_CreateOrReplace", + "operationId": "Ec2KeyPairs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + } + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Delete.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Delete.json new file mode 100644 index 000000000000..6ba207e3d090 --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2KeyPairs_Delete", + "operationId": "Ec2KeyPairs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Get.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Get.json new file mode 100644 index 000000000000..4c9c52a22cf6 --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Get.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2KeyPairs_Get", + "operationId": "Ec2KeyPairs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListByResourceGroup.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListByResourceGroup.json new file mode 100644 index 000000000000..19eb3bfbdfdf --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2KeyPairs_ListByResourceGroup", + "operationId": "Ec2KeyPairs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + ], + "nextLink": "https://microsoft.com/aejjm" + } + } + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListBySubscription.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListBySubscription.json new file mode 100644 index 000000000000..4f8974c2e45e --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "Ec2KeyPairs_ListBySubscription", + "operationId": "Ec2KeyPairs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + ], + "nextLink": "https://microsoft.com/aejjm" + } + } + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Update.json b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Update.json new file mode 100644 index 000000000000..ec76bc9af358 --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/examples/2024-12-01/Ec2KeyPairs_Update.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2KeyPairs_Update", + "operationId": "Ec2KeyPairs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7068": "ocrsjoz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2KeyPair.Management/main.tsp b/specification/awsconnector/Ec2KeyPair.Management/main.tsp new file mode 100644 index 000000000000..2d2c570c8f54 --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/main.tsp @@ -0,0 +1,152 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2KeyPairs ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Key Pair", + plural: "EC2 Key Pairs", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Key", "Pair"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2KeyPair is TrackedResource<Ec2KeyPairProperties> { + @doc("Name of Ec2KeyPair") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2KeyPairs") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2KeyPair") +model Ec2KeyPairProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2KeyPairProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2KeyPair") +model AwsEc2KeyPairProperties { + @doc("Property keyFingerprint") + keyFingerprint?: string; + + @doc("The format of the key pair. Default: ``pem``") + keyFormat?: KeyFormat = "pem"; + + @doc("A unique name for the key pair. Constraints: Up to 255 ASCII characters") + keyName?: string; + + @doc("Property keyPairId") + keyPairId?: string; + + @doc("The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa``") + keyType?: KeyType = "rsa"; + + @doc("The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created.") + publicKeyMaterial?: string; + + @doc("The tags to apply to the key pair.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("KeyFormat enum") +union KeyFormat { + @doc("KeyFormat enum pem") + pem: "pem", + + @doc("KeyFormat enum ppk") + ppk: "ppk", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +@doc("KeyType enum") +union KeyType { + @doc("KeyType enum ed25519") + ed25519: "ed25519", + + @doc("KeyType enum rsa") + rsa: "rsa", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2KeyPairs { + get is ArmResourceRead<Ec2KeyPair>; + @doc("Create a Ec2KeyPair. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2KeyPair>; + update is ArmCustomPatchAsync< + Ec2KeyPair, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2KeyPair> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2KeyPair>; + listByResourceGroup is ArmResourceListByParent<Ec2KeyPair>; + listBySubscription is ArmListBySubscription<Ec2KeyPair>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::KeyPair +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2KeyPair.Management/tspconfig.yaml b/specification/awsconnector/Ec2KeyPair.Management/tspconfig.yaml new file mode 100644 index 000000000000..0089ff18b9ce --- /dev/null +++ b/specification/awsconnector/Ec2KeyPair.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2KeyPair.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_CreateOrReplace.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_CreateOrReplace.json new file mode 100644 index 000000000000..e953bfaafff4 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "Ec2NetworkAcls_CreateOrReplace", + "operationId": "Ec2NetworkAcls_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + } + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Delete.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Delete.json new file mode 100644 index 000000000000..c8981c9a1dbc --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2NetworkAcls_Delete", + "operationId": "Ec2NetworkAcls_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Get.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Get.json new file mode 100644 index 000000000000..c00619b4ae45 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Get.json @@ -0,0 +1,53 @@ +{ + "title": "Ec2NetworkAcls_Get", + "operationId": "Ec2NetworkAcls_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListByResourceGroup.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListByResourceGroup.json new file mode 100644 index 000000000000..26427da59228 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2NetworkAcls_ListByResourceGroup", + "operationId": "Ec2NetworkAcls_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + ], + "nextLink": "https://microsoft.com/alylrur" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListBySubscription.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListBySubscription.json new file mode 100644 index 000000000000..a7b6c618c6ef --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "Ec2NetworkAcls_ListBySubscription", + "operationId": "Ec2NetworkAcls_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + ], + "nextLink": "https://microsoft.com/alylrur" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Update.json b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Update.json new file mode 100644 index 000000000000..3ee3ff552a35 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/examples/2024-12-01/Ec2NetworkAcls_Update.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2NetworkAcls_Update", + "operationId": "Ec2NetworkAcls_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5032": "fvynstjrcxzoxpxzwnqrny" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/main.tsp b/specification/awsconnector/Ec2NetworkAcl.Management/main.tsp new file mode 100644 index 000000000000..a8fd1046a302 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/main.tsp @@ -0,0 +1,118 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2NetworkAcls ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Network Acl", + plural: "EC2 Network Acls", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Network", "Acl"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2NetworkAcl is TrackedResource<Ec2NetworkAclProperties> { + @doc("Name of Ec2NetworkAcl") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2NetworkAcls") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2NetworkAcl") +model Ec2NetworkAclProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2NetworkAclProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2NetworkAcl") +model AwsEc2NetworkAclProperties { + @doc("Property id") + id?: string; + + @doc("The tags for the network ACL.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ID of the VPC for the network ACL.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2NetworkAcls { + get is ArmResourceRead<Ec2NetworkAcl>; + @doc("Create a Ec2NetworkAcl. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2NetworkAcl>; + update is ArmCustomPatchAsync< + Ec2NetworkAcl, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2NetworkAcl> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2NetworkAcl>; + listByResourceGroup is ArmResourceListByParent<Ec2NetworkAcl>; + listBySubscription is ArmListBySubscription<Ec2NetworkAcl>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::NetworkAcl +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2NetworkAcl.Management/tspconfig.yaml b/specification/awsconnector/Ec2NetworkAcl.Management/tspconfig.yaml new file mode 100644 index 000000000000..e7e72bdc2be8 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkAcl.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2NetworkAcl.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_CreateOrReplace.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_CreateOrReplace.json new file mode 100644 index 000000000000..c59dbf62998d --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_CreateOrReplace.json @@ -0,0 +1,256 @@ +{ + "title": "Ec2NetworkInterfaces_CreateOrReplace", + "operationId": "Ec2NetworkInterfaces_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + } + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Delete.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..732896803af0 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2NetworkInterfaces_Delete", + "operationId": "Ec2NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Get.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Get.json new file mode 100644 index 000000000000..548740f3f2f2 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Get.json @@ -0,0 +1,97 @@ +{ + "title": "Ec2NetworkInterfaces_Get", + "operationId": "Ec2NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListByResourceGroup.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..f8bbd18999d4 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "title": "Ec2NetworkInterfaces_ListByResourceGroup", + "operationId": "Ec2NetworkInterfaces_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListBySubscription.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListBySubscription.json new file mode 100644 index 000000000000..52508041f84b --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "title": "Ec2NetworkInterfaces_ListBySubscription", + "operationId": "Ec2NetworkInterfaces_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Update.json b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Update.json new file mode 100644 index 000000000000..bf6b2aa65e2d --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/examples/2024-12-01/Ec2NetworkInterfaces_Update.json @@ -0,0 +1,107 @@ +{ + "title": "Ec2NetworkInterfaces_Update", + "operationId": "Ec2NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6326": "yfsrjdai" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/main.tsp b/specification/awsconnector/Ec2NetworkInterface.Management/main.tsp new file mode 100644 index 000000000000..3dfee6aa2d72 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/main.tsp @@ -0,0 +1,240 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2NetworkInterfaces ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Network Interface", + plural: "EC2 Network Interfaces", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Network", "Interface"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2NetworkInterface is TrackedResource<Ec2NetworkInterfaceProperties> { + @doc("Name of Ec2NetworkInterface") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2NetworkInterfaces") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2NetworkInterface") +model Ec2NetworkInterfaceProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2NetworkInterfaceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2NetworkInterface") +model AwsEc2NetworkInterfaceProperties { + @doc("Property connectionTrackingSpecification") + connectionTrackingSpecification?: ConnectionTrackingSpecification; + + @doc("A description for the network interface.") + description?: string; + + @doc("If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address.") + enablePrimaryIpv6?: boolean; + + @doc("A list of security group IDs associated with this network interface.") + @extension("x-ms-identifiers", []) + groupSet?: string[]; + + @doc("Network interface id.") + id?: string; + + @doc("Indicates the type of network interface.") + interfaceType?: string; + + @doc("The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.") + ipv4PrefixCount?: int32; + + @doc("Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.") + @extension("x-ms-identifiers", []) + ipv4Prefixes?: Ipv4PrefixSpecification[]; + + @doc("The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property.") + ipv6AddressCount?: int32; + + @doc("One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.") + @extension("x-ms-identifiers", []) + ipv6Addresses?: InstanceIpv6Address[]; + + @doc("The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.") + ipv6PrefixCount?: int32; + + @doc("Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.") + @extension("x-ms-identifiers", []) + ipv6Prefixes?: Ipv6PrefixSpecification[]; + + @doc("The primary IPv6 address") + primaryIpv6Address?: string; + + @doc("Returns the primary private IP address of the network interface.") + primaryPrivateIpAddress?: string; + + @doc("Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property.") + privateIpAddress?: string; + + @doc("Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.") + @extension("x-ms-identifiers", []) + privateIpAddresses?: PrivateIpAddressSpecification[]; + + @doc("The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses") + secondaryPrivateIpAddressCount?: int32; + + @doc("Returns the secondary private IP addresses of the network interface.") + @extension("x-ms-identifiers", []) + secondaryPrivateIpAddresses?: string[]; + + @doc("Indicates whether traffic to or from the instance is validated.") + sourceDestCheck?: boolean; + + @doc("The ID of the subnet to associate with the network interface.") + subnetId?: string; + + @doc("An arbitrary set of tags (key-value pairs) for this network interface.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ID of the VPC") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConnectionTrackingSpecification") +model ConnectionTrackingSpecification { + @doc("Property tcpEstablishedTimeout") + tcpEstablishedTimeout?: int32; + + @doc("Property udpStreamTimeout") + udpStreamTimeout?: int32; + + @doc("Property udpTimeout") + udpTimeout?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ipv4PrefixSpecification") +model Ipv4PrefixSpecification { + @doc("Property ipv4Prefix") + ipv4Prefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceIpv6Address") +model InstanceIpv6Address { + @doc("Property ipv6Address") + ipv6Address?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ipv6PrefixSpecification") +model Ipv6PrefixSpecification { + @doc("Property ipv6Prefix") + ipv6Prefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PrivateIpAddressSpecification") +model PrivateIpAddressSpecification { + @doc("Property primary") + primary?: boolean; + + @doc("Property privateIpAddress") + privateIpAddress?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2NetworkInterfaces { + get is ArmResourceRead<Ec2NetworkInterface>; + @doc("Create a Ec2NetworkInterface. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2NetworkInterface>; + update is ArmCustomPatchAsync< + Ec2NetworkInterface, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2NetworkInterface> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2NetworkInterface>; + listByResourceGroup is ArmResourceListByParent<Ec2NetworkInterface>; + listBySubscription is ArmListBySubscription<Ec2NetworkInterface>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::NetworkInterface +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2NetworkInterface.Management/tspconfig.yaml b/specification/awsconnector/Ec2NetworkInterface.Management/tspconfig.yaml new file mode 100644 index 000000000000..8380f1859ac5 --- /dev/null +++ b/specification/awsconnector/Ec2NetworkInterface.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2NetworkInterface.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_CreateOrReplace.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_CreateOrReplace.json new file mode 100644 index 000000000000..e98c4c447e8b --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "Ec2RouteTables_CreateOrReplace", + "operationId": "Ec2RouteTables_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + } + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Delete.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Delete.json new file mode 100644 index 000000000000..298eabe0f837 --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2RouteTables_Delete", + "operationId": "Ec2RouteTables_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Get.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Get.json new file mode 100644 index 000000000000..95c8fa2a82cb --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Get.json @@ -0,0 +1,53 @@ +{ + "title": "Ec2RouteTables_Get", + "operationId": "Ec2RouteTables_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListByResourceGroup.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListByResourceGroup.json new file mode 100644 index 000000000000..7ef01bb877e4 --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2RouteTables_ListByResourceGroup", + "operationId": "Ec2RouteTables_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + ], + "nextLink": "https://microsoft.com/ajb" + } + } + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListBySubscription.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListBySubscription.json new file mode 100644 index 000000000000..13a6996e534b --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "Ec2RouteTables_ListBySubscription", + "operationId": "Ec2RouteTables_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + ], + "nextLink": "https://microsoft.com/ajb" + } + } + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Update.json b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Update.json new file mode 100644 index 000000000000..5d3b3aaaa476 --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/examples/2024-12-01/Ec2RouteTables_Update.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2RouteTables_Update", + "operationId": "Ec2RouteTables_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9656": "qcdyodtyhafniokwmpyrtscnmlbu" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2RouteTable.Management/main.tsp b/specification/awsconnector/Ec2RouteTable.Management/main.tsp new file mode 100644 index 000000000000..c219291bad8d --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/main.tsp @@ -0,0 +1,118 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2RouteTables ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Route Table", + plural: "EC2 Route Tables", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Route", "Table"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2RouteTable is TrackedResource<Ec2RouteTableProperties> { + @doc("Name of Ec2RouteTable") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2RouteTables") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2RouteTable") +model Ec2RouteTableProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2RouteTableProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2RouteTable") +model AwsEc2RouteTableProperties { + @doc("Property routeTableId") + routeTableId?: string; + + @doc("Any tags assigned to the route table.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ID of the VPC.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2RouteTables { + get is ArmResourceRead<Ec2RouteTable>; + @doc("Create a Ec2RouteTable. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2RouteTable>; + update is ArmCustomPatchAsync< + Ec2RouteTable, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2RouteTable> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2RouteTable>; + listByResourceGroup is ArmResourceListByParent<Ec2RouteTable>; + listBySubscription is ArmListBySubscription<Ec2RouteTable>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::RouteTable +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2RouteTable.Management/tspconfig.yaml b/specification/awsconnector/Ec2RouteTable.Management/tspconfig.yaml new file mode 100644 index 000000000000..e7c11266d0d3 --- /dev/null +++ b/specification/awsconnector/Ec2RouteTable.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2RouteTable.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_CreateOrReplace.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_CreateOrReplace.json new file mode 100644 index 000000000000..e7a16e7a79e0 --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_CreateOrReplace.json @@ -0,0 +1,349 @@ +{ + "title": "Ec2SecurityGroups_CreateOrReplace", + "operationId": "Ec2SecurityGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + } + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Delete.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Delete.json new file mode 100644 index 000000000000..b49e35b31274 --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2SecurityGroups_Delete", + "operationId": "Ec2SecurityGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Get.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Get.json new file mode 100644 index 000000000000..1228296a401a --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Get.json @@ -0,0 +1,128 @@ +{ + "title": "Ec2SecurityGroups_Get", + "operationId": "Ec2SecurityGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListByResourceGroup.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..5c29b4070148 --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "title": "Ec2SecurityGroups_ListByResourceGroup", + "operationId": "Ec2SecurityGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + ], + "nextLink": "https://microsoft.com/ak" + } + } + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListBySubscription.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListBySubscription.json new file mode 100644 index 000000000000..ff4a02fca702 --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_ListBySubscription.json @@ -0,0 +1,131 @@ +{ + "title": "Ec2SecurityGroups_ListBySubscription", + "operationId": "Ec2SecurityGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + ], + "nextLink": "https://microsoft.com/ak" + } + } + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Update.json b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Update.json new file mode 100644 index 000000000000..a21444b12896 --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/examples/2024-12-01/Ec2SecurityGroups_Update.json @@ -0,0 +1,138 @@ +{ + "title": "Ec2SecurityGroups_Update", + "operationId": "Ec2SecurityGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3161": "pirvmhaosavvjlkhaio" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/main.tsp b/specification/awsconnector/Ec2SecurityGroup.Management/main.tsp new file mode 100644 index 000000000000..384bab4a70cb --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/main.tsp @@ -0,0 +1,241 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2SecurityGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Security Group", + plural: "EC2 Security Groups", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Security", "Group"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2SecurityGroup is TrackedResource<Ec2SecurityGroupProperties> { + @doc("Name of Ec2SecurityGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2SecurityGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2SecurityGroup") +model Ec2SecurityGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2SecurityGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2SecurityGroup") +model AwsEc2SecurityGroupProperties { + @doc("<p>A description of the security group.</p>") + description?: string; + + @doc("<p>The ID of the security group.</p>") + groupId?: string; + + @doc("<p>The name of the security group.</p>") + groupName?: string; + + @doc("<p>The inbound rules associated with the security group.</p>") + @extension("x-ms-identifiers", []) + ipPermissions?: IpPermission[]; + + @doc("<p>The outbound rules associated with the security group.</p>") + @extension("x-ms-identifiers", []) + ipPermissionsEgress?: IpPermission[]; + + @doc("<p>The Amazon Web Services account ID of the owner of the security group.</p>") + ownerId?: string; + + @doc("<p>Any tags assigned to the security group.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>The ID of the VPC for the security group.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpPermission") +model IpPermission { + @doc("<p>If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).</p>") + fromPort?: int32; + + @doc("<p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number (see <a href='http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml'>Protocol Numbers</a>).</p> <p>Use <code>-1</code> to specify all protocols. When authorizing security group rules, specifying <code>-1</code> or a protocol number other than <code>tcp</code>, <code>udp</code>, <code>icmp</code>, or <code>icmpv6</code> allows traffic on all ports, regardless of any port range you specify. For <code>tcp</code>, <code>udp</code>, and <code>icmp</code>, you must specify a port range. For <code>icmpv6</code>, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.</p>") + ipProtocol?: string; + + @doc("<p>The IPv4 address ranges.</p>") + @extension("x-ms-identifiers", []) + ipRanges?: IpRange[]; + + @doc("<p>The IPv6 address ranges.</p>") + @extension("x-ms-identifiers", []) + ipv6Ranges?: Ipv6Range[]; + + @doc("<p>The prefix list IDs.</p>") + @extension("x-ms-identifiers", []) + prefixListIds?: PrefixListId[]; + + @doc("<p>If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).</p>") + toPort?: int32; + + @doc("<p>The security group and Amazon Web Services account ID pairs.</p>") + @extension("x-ms-identifiers", []) + userIdGroupPairs?: UserIdGroupPair[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpRange") +model IpRange { + @doc("<p>The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.</p>") + cidrIp?: string; + + @doc("<p>A description for the security group rule that references this IPv4 address range.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</p>") + description?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ipv6Range") +model Ipv6Range { + @doc("<p>The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.</p>") + cidrIpv6?: string; + + @doc("<p>A description for the security group rule that references this IPv6 address range.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</p>") + description?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PrefixListId") +model PrefixListId { + @doc("<p>A description for the security group rule that references this prefix list ID.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*</p>") + description?: string; + + @doc("<p>The ID of the prefix.</p>") + @clientName("prefixListIdcsharp", "csharp") + prefixListId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of UserIdGroupPair") +model UserIdGroupPair { + @doc("<p>A description for the security group rule that references this user ID group pair.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*</p>") + description?: string; + + @doc("<p>The ID of the security group.</p>") + groupId?: string; + + @doc("<p>[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. </p> <p>For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.</p>") + groupName?: string; + + @doc("<p>The status of a VPC peering connection, if applicable.</p>") + peeringStatus?: string; + + @doc("<p>The ID of an Amazon Web Services account.</p> <p>For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.</p>") + userId?: string; + + @doc("<p>The ID of the VPC for the referenced security group, if applicable.</p>") + vpcId?: string; + + @doc("<p>The ID of the VPC peering connection, if applicable.</p>") + vpcPeeringConnectionId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2SecurityGroups { + get is ArmResourceRead<Ec2SecurityGroup>; + @doc("Create a Ec2SecurityGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2SecurityGroup>; + update is ArmCustomPatchAsync< + Ec2SecurityGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2SecurityGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2SecurityGroup>; + listByResourceGroup is ArmResourceListByParent<Ec2SecurityGroup>; + listBySubscription is ArmListBySubscription<Ec2SecurityGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: SecurityGroup +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2SecurityGroup.Management/tspconfig.yaml b/specification/awsconnector/Ec2SecurityGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..5ae83475294e --- /dev/null +++ b/specification/awsconnector/Ec2SecurityGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2SecurityGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_CreateOrReplace.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_CreateOrReplace.json new file mode 100644 index 000000000000..80f5d96d4a62 --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "Ec2Snapshots_CreateOrReplace", + "operationId": "Ec2Snapshots_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + } + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Delete.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Delete.json new file mode 100644 index 000000000000..5941d3de6c31 --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Snapshots_Delete", + "operationId": "Ec2Snapshots_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Get.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Get.json new file mode 100644 index 000000000000..aea7f7d5bf0c --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Get.json @@ -0,0 +1,74 @@ +{ + "title": "Ec2Snapshots_Get", + "operationId": "Ec2Snapshots_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListByResourceGroup.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListByResourceGroup.json new file mode 100644 index 000000000000..1617e1fe7fb6 --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "Ec2Snapshots_ListByResourceGroup", + "operationId": "Ec2Snapshots_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListBySubscription.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListBySubscription.json new file mode 100644 index 000000000000..047d1a278eaa --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2Snapshots_ListBySubscription", + "operationId": "Ec2Snapshots_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Update.json b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Update.json new file mode 100644 index 000000000000..641914bf9321 --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/examples/2024-12-01/Ec2Snapshots_Update.json @@ -0,0 +1,84 @@ +{ + "title": "Ec2Snapshots_Update", + "operationId": "Ec2Snapshots_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9290": "rhda" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Snapshot.Management/main.tsp b/specification/awsconnector/Ec2Snapshot.Management/main.tsp new file mode 100644 index 000000000000..431082114e4f --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/main.tsp @@ -0,0 +1,244 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Snapshots ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Snapshot", + plural: "EC2 Snapshots", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Snapshot"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Snapshot is TrackedResource<Ec2SnapshotProperties> { + @doc("Name of Ec2Snapshot") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Snapshots") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Snapshot") +model Ec2SnapshotProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2SnapshotProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Snapshot") +model AwsEc2SnapshotProperties { + @doc("<p>The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by <a>DescribeSnapshots</a>.</p>") + dataEncryptionKeyId?: string; + + @doc("<p>The description for the snapshot.</p>") + description?: string; + + @doc("<p>Indicates whether the snapshot is encrypted.</p>") + encrypted?: boolean; + + @doc("<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.</p>") + kmsKeyId?: string; + + @doc("<p>The ARN of the Outpost on which the snapshot is stored. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html'>Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EBS User Guide</i>.</p>") + outpostArn?: string; + + @doc("<p>The Amazon Web Services owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console.</p>") + ownerAlias?: string; + + @doc("<p>The ID of the Amazon Web Services account that owns the EBS snapshot.</p>") + ownerId?: string; + + @doc("<p>The progress of the snapshot, as a percentage.</p>") + progress?: string; + + @doc("<p>Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.</p>") + restoreExpiryTime?: utcDateTime; + + @doc("<p>The ID of the snapshot. Each snapshot receives a unique identifier when it is created.</p>") + snapshotId?: string; + + @doc("<p>Reserved for future use.</p>") + sseType?: SSETypeEnumValue; + + @doc("<p>The time stamp when the snapshot was initiated.</p>") + startTime?: utcDateTime; + + @doc("<p>The snapshot state.</p>") + state?: SnapshotStateEnumValue; + + @doc("<p>Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by <a>DescribeSnapshots</a>.</p>") + stateMessage?: string; + + @doc("<p>The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used.</p>") + storageTier?: StorageTierEnumValue; + + @doc("<p>Any tags assigned to the snapshot.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>The ID of the volume that was used to create the snapshot. Snapshots created by the <a>CopySnapshot</a> action have an arbitrary volume ID that should not be used for any purpose.</p>") + volumeId?: string; + + @doc("<p>The size of the volume, in GiB.</p>") + volumeSize?: int32; +} + +@doc("SSEType enum") +union SSEType { + @doc("SSEType enum none") + None: "none", + + @doc("SSEType enum sse-ebs") + SseEbs: "sse-ebs", + + @doc("SSEType enum sse-kms") + SseKms: "sse-kms", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SSETypeEnumValue") +model SSETypeEnumValue { + @doc("Property value") + value?: SSEType; +} + +@doc("StorageTier enum") +union StorageTier { + @doc("StorageTier enum archive") + Archive: "archive", + + @doc("StorageTier enum standard") + Standard: "standard", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StorageTierEnumValue") +model StorageTierEnumValue { + @doc("Property value") + value?: StorageTier; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>") + key?: string; + + @doc("<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>") + value?: string; +} + +@doc("SnapshotState enum") +union SnapshotState { + @doc("SnapshotState enum completed") + Completed: "completed", + + @doc("SnapshotState enum error") + Error: "error", + + @doc("SnapshotState enum pending") + Pending: "pending", + + @doc("SnapshotState enum recoverable") + Recoverable: "recoverable", + + @doc("SnapshotState enum recovering") + Recovering: "recovering", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnapshotStateEnumValue") +model SnapshotStateEnumValue { + @doc("Property value") + value?: SnapshotState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Snapshots { + get is ArmResourceRead<Ec2Snapshot>; + @doc("Create a Ec2Snapshot. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Snapshot>; + update is ArmCustomPatchAsync< + Ec2Snapshot, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Snapshot> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Snapshot>; + listByResourceGroup is ArmResourceListByParent<Ec2Snapshot>; + listBySubscription is ArmListBySubscription<Ec2Snapshot>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ec2\ec2-2016-11-15.normal.json +// AWS Shape: Snapshot +// +// Related information for backend service: +// AWS Servcie : EC2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.325.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Snapshot.Management/tspconfig.yaml b/specification/awsconnector/Ec2Snapshot.Management/tspconfig.yaml new file mode 100644 index 000000000000..e9c48c12c959 --- /dev/null +++ b/specification/awsconnector/Ec2Snapshot.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Snapshot.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_CreateOrReplace.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_CreateOrReplace.json new file mode 100644 index 000000000000..d0b3e7cc8b94 --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_CreateOrReplace.json @@ -0,0 +1,193 @@ +{ + "title": "Ec2Subnets_CreateOrReplace", + "operationId": "Ec2Subnets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + } + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Delete.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Delete.json new file mode 100644 index 000000000000..e54825235c1b --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Subnets_Delete", + "operationId": "Ec2Subnets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Get.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Get.json new file mode 100644 index 000000000000..4353780f4b49 --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Get.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Subnets_Get", + "operationId": "Ec2Subnets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListByResourceGroup.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListByResourceGroup.json new file mode 100644 index 000000000000..12da4001818f --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "Ec2Subnets_ListByResourceGroup", + "operationId": "Ec2Subnets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListBySubscription.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListBySubscription.json new file mode 100644 index 000000000000..77d0c5320550 --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "Ec2Subnets_ListBySubscription", + "operationId": "Ec2Subnets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Update.json b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Update.json new file mode 100644 index 000000000000..985afe0a4d0f --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/examples/2024-12-01/Ec2Subnets_Update.json @@ -0,0 +1,86 @@ +{ + "title": "Ec2Subnets_Update", + "operationId": "Ec2Subnets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1062": "onsypwaxapyschj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Subnet.Management/main.tsp b/specification/awsconnector/Ec2Subnet.Management/main.tsp new file mode 100644 index 000000000000..5cfc25c08cbc --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/main.tsp @@ -0,0 +1,186 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Subnets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Subnet", + plural: "EC2 Subnets", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Subnet"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Subnet is TrackedResource<Ec2SubnetProperties> { + @doc("Name of Ec2Subnet") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Subnets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Subnet") +model Ec2SubnetProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2SubnetProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Subnet") +model AwsEc2SubnetProperties { + @doc("Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.") + assignIpv6AddressOnCreation?: boolean; + + @doc("The Availability Zone of the subnet. If you update this property, you must also update the ``CidrBlock`` property.") + availabilityZone?: string; + + @doc("The AZ ID of the subnet.") + availabilityZoneId?: string; + + @doc("The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one.") + cidrBlock?: string; + + @doc("Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*.") + enableDns64?: boolean; + + @doc("Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1).") + enableLniAtDeviceIndex?: int32; + + @doc("An IPv4 IPAM pool ID for the subnet.") + ipv4IpamPoolId?: string; + + @doc("An IPv4 netmask length for the subnet.") + ipv4NetmaskLength?: int32; + + @doc("The IPv6 CIDR block. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block.") + ipv6CidrBlock?: string; + + @doc("The IPv6 network ranges for the subnet, in CIDR notation.") + @extension("x-ms-identifiers", []) + ipv6CidrBlocks?: string[]; + + @doc("An IPv6 IPAM pool ID for the subnet.") + ipv6IpamPoolId?: string; + + @doc("Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*.") + ipv6Native?: boolean; + + @doc("An IPv6 netmask length for the subnet.") + ipv6NetmaskLength?: int32; + + @doc("Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/).") + mapPublicIpOnLaunch?: boolean; + + @doc("Property networkAclAssociationId") + networkAclAssociationId?: string; + + @doc("The Amazon Resource Name (ARN) of the Outpost.") + outpostArn?: string; + + @doc("The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. Available options: + EnableResourceNameDnsAAAARecord (true | false) + EnableResourceNameDnsARecord (true | false) + HostnameType (ip-name | resource-name)") + privateDnsNameOptionsOnLaunch?: PrivateDnsNameOptionsOnLaunchModelProperties; + + @doc("Property subnetId") + subnetId?: string; + + @doc("Any tags assigned to the subnet.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ID of the VPC the subnet is in. If you update this property, you must also update the ``CidrBlock`` property.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PrivateDnsNameOptionsOnLaunchModelProperties") +model PrivateDnsNameOptionsOnLaunchModelProperties { + @doc("Property enableResourceNameDnsAAAARecord") + enableResourceNameDnsAAAARecord?: boolean; + + @doc("Property enableResourceNameDnsARecord") + enableResourceNameDnsARecord?: boolean; + + @doc("Property hostnameType") + hostnameType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Subnets { + get is ArmResourceRead<Ec2Subnet>; + @doc("Create a Ec2Subnet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Subnet>; + update is ArmCustomPatchAsync< + Ec2Subnet, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Subnet> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Subnet>; + listByResourceGroup is ArmResourceListByParent<Ec2Subnet>; + listBySubscription is ArmListBySubscription<Ec2Subnet>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::Subnet +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Subnet.Management/tspconfig.yaml b/specification/awsconnector/Ec2Subnet.Management/tspconfig.yaml new file mode 100644 index 000000000000..2a1e5f98a7d4 --- /dev/null +++ b/specification/awsconnector/Ec2Subnet.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Subnet.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_CreateOrReplace.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_CreateOrReplace.json new file mode 100644 index 000000000000..f0c5c74cc07c --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "Ec2VpcEndpoints_CreateOrReplace", + "operationId": "Ec2VpcEndpoints_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + } + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Delete.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Delete.json new file mode 100644 index 000000000000..0652a0211166 --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2VpcEndpoints_Delete", + "operationId": "Ec2VpcEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Get.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Get.json new file mode 100644 index 000000000000..3450b7b5c825 --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Get.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2VpcEndpoints_Get", + "operationId": "Ec2VpcEndpoints_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListByResourceGroup.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListByResourceGroup.json new file mode 100644 index 000000000000..477aba117454 --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "Ec2VpcEndpoints_ListByResourceGroup", + "operationId": "Ec2VpcEndpoints_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListBySubscription.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..562bb3a38a0a --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2VpcEndpoints_ListBySubscription", + "operationId": "Ec2VpcEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Update.json b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Update.json new file mode 100644 index 000000000000..db55153bbef1 --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/examples/2024-12-01/Ec2VpcEndpoints_Update.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2VpcEndpoints_Update", + "operationId": "Ec2VpcEndpoints_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7567": "dieflmamsskecyh" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/main.tsp b/specification/awsconnector/Ec2VPCEndpoint.Management/main.tsp new file mode 100644 index 000000000000..e5153723f145 --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/main.tsp @@ -0,0 +1,150 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2VPCEndpoints ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 VPCEndpoint", + plural: "EC2 VPCEndpoints", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "VPCEndpoint"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2VPCEndpoint is TrackedResource<Ec2VPCEndpointProperties> { + @doc("Name of Ec2VPCEndpoint") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2VPCEndpoints") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2VPCEndpoint") +model Ec2VPCEndpointProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2VPCEndpointProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2VPCEndpoint") +model AwsEc2VPCEndpointProperties { + @doc("Property creationTimestamp") + creationTimestamp?: string; + + @doc("Property dnsEntries") + @extension("x-ms-identifiers", []) + dnsEntries?: string[]; + + @doc("Property id") + id?: string; + + @doc("Property networkInterfaceIds") + @extension("x-ms-identifiers", []) + networkInterfaceIds?: string[]; + + @doc("An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.") + policyDocument?: Record<unknown>; + + @doc("Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. This property is supported only for interface endpoints. Default: ``false``") + privateDnsEnabled?: boolean; + + @doc("The IDs of the route tables. Routing is supported only for gateway endpoints.") + @extension("x-ms-identifiers", []) + routeTableIds?: string[]; + + @doc("The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.") + @extension("x-ms-identifiers", []) + securityGroupIds?: string[]; + + @doc("The name of the endpoint service.") + serviceName?: string; + + @doc("The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.") + @extension("x-ms-identifiers", []) + subnetIds?: string[]; + + @doc("The type of endpoint. Default: Gateway") + vpcEndpointType?: VpcEndpointType; + + @doc("The ID of the VPC.") + vpcId?: string; +} + +@doc("VpcEndpointType enum") +union VpcEndpointType { + @doc("VpcEndpointType enum Gateway") + Gateway: "Gateway", + + @doc("VpcEndpointType enum GatewayLoadBalancer") + GatewayLoadBalancer: "GatewayLoadBalancer", + + @doc("VpcEndpointType enum Interface") + Interface: "Interface", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2VPCEndpoints { + get is ArmResourceRead<Ec2VPCEndpoint>; + @doc("Create a Ec2VPCEndpoint. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2VPCEndpoint>; + update is ArmCustomPatchAsync< + Ec2VPCEndpoint, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2VPCEndpoint> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2VPCEndpoint>; + listByResourceGroup is ArmResourceListByParent<Ec2VPCEndpoint>; + listBySubscription is ArmListBySubscription<Ec2VPCEndpoint>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::VPCEndpoint +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2VPCEndpoint.Management/tspconfig.yaml b/specification/awsconnector/Ec2VPCEndpoint.Management/tspconfig.yaml new file mode 100644 index 000000000000..2e32662944ed --- /dev/null +++ b/specification/awsconnector/Ec2VPCEndpoint.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2VPCEndpoint.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_CreateOrReplace.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_CreateOrReplace.json new file mode 100644 index 000000000000..05775c4a5303 --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2VpcPeeringConnections_CreateOrReplace", + "operationId": "Ec2VpcPeeringConnections_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + } + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Delete.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Delete.json new file mode 100644 index 000000000000..c321df60e88d --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2VpcPeeringConnections_Delete", + "operationId": "Ec2VpcPeeringConnections_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Get.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Get.json new file mode 100644 index 000000000000..c051560f7656 --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Get.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2VpcPeeringConnections_Get", + "operationId": "Ec2VpcPeeringConnections_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListByResourceGroup.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..b90c39e5e6ee --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2VpcPeeringConnections_ListByResourceGroup", + "operationId": "Ec2VpcPeeringConnections_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListBySubscription.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListBySubscription.json new file mode 100644 index 000000000000..e8f0b19bec07 --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "Ec2VpcPeeringConnections_ListBySubscription", + "operationId": "Ec2VpcPeeringConnections_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Update.json b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Update.json new file mode 100644 index 000000000000..50e5040afcf7 --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/examples/2024-12-01/Ec2VpcPeeringConnections_Update.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2VpcPeeringConnections_Update", + "operationId": "Ec2VpcPeeringConnections_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4874": "wcyzrmbcyrznrbumoexbxplkl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/main.tsp b/specification/awsconnector/Ec2VPCPeeringConnection.Management/main.tsp new file mode 100644 index 000000000000..bded966e2bcb --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/main.tsp @@ -0,0 +1,131 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2VPCPeeringConnections ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 VPCPeering Connection", + plural: "EC2 VPCPeering Connections", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "VPCPeering", "Connection"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2VPCPeeringConnection + is TrackedResource<Ec2VPCPeeringConnectionProperties> { + @doc("Name of Ec2VPCPeeringConnection") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2VPCPeeringConnections") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2VPCPeeringConnection") +model Ec2VPCPeeringConnectionProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2VPCPeeringConnectionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2VPCPeeringConnection") +model AwsEc2VPCPeeringConnectionProperties { + @doc("Property id") + id?: string; + + @doc("The AWS account ID of the owner of the accepter VPC.") + peerOwnerId?: string; + + @doc("The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.") + peerRegion?: string; + + @doc("The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account.") + peerRoleArn?: string; + + @doc("The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.") + peerVpcId?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ID of the VPC.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2VPCPeeringConnections { + get is ArmResourceRead<Ec2VPCPeeringConnection>; + @doc("Create a Ec2VPCPeeringConnection. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2VPCPeeringConnection>; + update is ArmCustomPatchAsync< + Ec2VPCPeeringConnection, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2VPCPeeringConnection> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2VPCPeeringConnection>; + listByResourceGroup is ArmResourceListByParent<Ec2VPCPeeringConnection>; + listBySubscription is ArmListBySubscription<Ec2VPCPeeringConnection>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::VPCPeeringConnection +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2VPCPeeringConnection.Management/tspconfig.yaml b/specification/awsconnector/Ec2VPCPeeringConnection.Management/tspconfig.yaml new file mode 100644 index 000000000000..a8906109f7ab --- /dev/null +++ b/specification/awsconnector/Ec2VPCPeeringConnection.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2VPCPeeringConnection.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_CreateOrReplace.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_CreateOrReplace.json new file mode 100644 index 000000000000..2ab22ce4a2ae --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "Ec2Volumes_CreateOrReplace", + "operationId": "Ec2Volumes_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + } + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Delete.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Delete.json new file mode 100644 index 000000000000..17d5842aeb0e --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Volumes_Delete", + "operationId": "Ec2Volumes_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Get.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Get.json new file mode 100644 index 000000000000..122992bb74d8 --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Get.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2Volumes_Get", + "operationId": "Ec2Volumes_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListByResourceGroup.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListByResourceGroup.json new file mode 100644 index 000000000000..ef4aff77b31b --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2Volumes_ListByResourceGroup", + "operationId": "Ec2Volumes_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + ], + "nextLink": "https://microsoft.com/azolzog" + } + } + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListBySubscription.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListBySubscription.json new file mode 100644 index 000000000000..c85a6e02202d --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Volumes_ListBySubscription", + "operationId": "Ec2Volumes_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + ], + "nextLink": "https://microsoft.com/azolzog" + } + } + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Update.json b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Update.json new file mode 100644 index 000000000000..a38fb88fb334 --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/examples/2024-12-01/Ec2Volumes_Update.json @@ -0,0 +1,73 @@ +{ + "title": "Ec2Volumes_Update", + "operationId": "Ec2Volumes_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2751": "bwfiobg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Volume.Management/main.tsp b/specification/awsconnector/Ec2Volume.Management/main.tsp new file mode 100644 index 000000000000..321e06dc527b --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/main.tsp @@ -0,0 +1,148 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Volumes ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 Volume", + plural: "EC2 Volumes", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "Volume"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Volume is TrackedResource<Ec2VolumeProperties> { + @doc("Name of Ec2Volume") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Volumes") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Volume") +model Ec2VolumeProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2VolumeProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Volume") +model AwsEc2VolumeProperties { + @doc("Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.") + autoEnableIO?: boolean; + + @doc("The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``.") + availabilityZone?: string; + + @doc("Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances).") + encrypted?: boolean; + + @doc("The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes.") + iops?: int32; + + @doc("The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.") + kmsKeyId?: string; + + @doc("Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume.") + multiAttachEnabled?: boolean; + + @doc("The Amazon Resource Name (ARN) of the Outpost.") + outpostArn?: string; + + @doc("The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + ``gp2`` and ``gp3``: 1 - 16,384 GiB + ``io1``: 4 - 16,384 GiB + ``io2``: 4 - 65,536 GiB + ``st1`` and ``sc1``: 125 - 16,384 GiB + ``standard``: 1 - 1024 GiB") + size?: int32; + + @doc("The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.") + snapshotId?: string; + + @doc("The tags to apply to the volume during creation.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000.") + throughput?: int32; + + @doc("Property volumeId") + volumeId?: string; + + @doc("The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. Default: ``gp2``") + volumeType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Volumes { + get is ArmResourceRead<Ec2Volume>; + @doc("Create a Ec2Volume. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Volume>; + update is ArmCustomPatchAsync< + Ec2Volume, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Volume> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Volume>; + listByResourceGroup is ArmResourceListByParent<Ec2Volume>; + listBySubscription is ArmListBySubscription<Ec2Volume>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::Volume +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Volume.Management/tspconfig.yaml b/specification/awsconnector/Ec2Volume.Management/tspconfig.yaml new file mode 100644 index 000000000000..c572a7ca8c51 --- /dev/null +++ b/specification/awsconnector/Ec2Volume.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Volume.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_CreateOrReplace.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_CreateOrReplace.json new file mode 100644 index 000000000000..fc5c12ed0eb7 --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_CreateOrReplace.json @@ -0,0 +1,163 @@ +{ + "title": "Ec2Vpcs_CreateOrReplace", + "operationId": "Ec2Vpcs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + } + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Delete.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Delete.json new file mode 100644 index 000000000000..a824a84e0a82 --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Vpcs_Delete", + "operationId": "Ec2Vpcs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Get.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Get.json new file mode 100644 index 000000000000..787208753143 --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Get.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Vpcs_Get", + "operationId": "Ec2Vpcs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + } + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListByResourceGroup.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListByResourceGroup.json new file mode 100644 index 000000000000..0dcb3b4f6108 --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2Vpcs_ListByResourceGroup", + "operationId": "Ec2Vpcs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListBySubscription.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListBySubscription.json new file mode 100644 index 000000000000..6c98c5b35eec --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "title": "Ec2Vpcs_ListBySubscription", + "operationId": "Ec2Vpcs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Update.json b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Update.json new file mode 100644 index 000000000000..4afa0025a39e --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/examples/2024-12-01/Ec2Vpcs_Update.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Vpcs_Update", + "operationId": "Ec2Vpcs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5864": "bqtbbunnw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Ec2Vpc.Management/main.tsp b/specification/awsconnector/Ec2Vpc.Management/main.tsp new file mode 100644 index 000000000000..02558f3375cf --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/main.tsp @@ -0,0 +1,147 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Ec2Vpcs ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EC2 VPC", + plural: "EC2 VPCS", + }, + keywords: ["Microsoft.AwsConnector", "EC2", "VPC"], +}) +@doc("A Microsoft.AwsConnector resource") +model Ec2Vpc is TrackedResource<Ec2VpcProperties> { + @doc("Name of Ec2Vpc") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ec2Vpcs") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2Vpc") +model Ec2VpcProperties { + @doc("AWS Properties") + awsProperties?: AwsEc2VpcProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEc2Vpc") +model AwsEc2VpcProperties { + @doc("The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.") + cidrBlock?: string; + + @doc("Property cidrBlockAssociations") + @extension("x-ms-identifiers", []) + cidrBlockAssociations?: string[]; + + @doc("Property defaultNetworkAcl") + defaultNetworkAcl?: string; + + @doc("Property defaultSecurityGroup") + defaultSecurityGroup?: string; + + @doc("Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). You can only enable DNS hostnames if you've enabled DNS support.") + enableDnsHostnames?: boolean; + + @doc("Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range 'plus two' succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support).") + enableDnsSupport?: boolean; + + @doc("The allowed tenancy of instances launched into the VPC. + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement.") + instanceTenancy?: string; + + @doc("The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``.") + ipv4IpamPoolId?: string; + + @doc("The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*.") + ipv4NetmaskLength?: int32; + + @doc("Property ipv6CidrBlocks") + @extension("x-ms-identifiers", []) + ipv6CidrBlocks?: string[]; + + @doc("The tags for the VPC.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property vpcId") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Ec2Vpcs { + get is ArmResourceRead<Ec2Vpc>; + @doc("Create a Ec2Vpc. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Ec2Vpc>; + update is ArmCustomPatchAsync< + Ec2Vpc, + Azure.ResourceManager.Foundations.TagsUpdateModel<Ec2Vpc> + >; + delete is ArmResourceDeleteWithoutOkAsync<Ec2Vpc>; + listByResourceGroup is ArmResourceListByParent<Ec2Vpc>; + listBySubscription is ArmListBySubscription<Ec2Vpc>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EC2::VPC +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Ec2Vpc.Management/tspconfig.yaml b/specification/awsconnector/Ec2Vpc.Management/tspconfig.yaml new file mode 100644 index 000000000000..d26c5c3a8dee --- /dev/null +++ b/specification/awsconnector/Ec2Vpc.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ec2Vpc.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_CreateOrReplace.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_CreateOrReplace.json new file mode 100644 index 000000000000..084b4195e0b2 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_CreateOrReplace.json @@ -0,0 +1,172 @@ +{ + "title": "EcrImageDetails_CreateOrReplace", + "operationId": "EcrImageDetails_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + } + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Delete.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Delete.json new file mode 100644 index 000000000000..b187c646b738 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcrImageDetails_Delete", + "operationId": "EcrImageDetails_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Get.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Get.json new file mode 100644 index 000000000000..6f015adfe997 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Get.json @@ -0,0 +1,69 @@ +{ + "title": "EcrImageDetails_Get", + "operationId": "EcrImageDetails_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListByResourceGroup.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListByResourceGroup.json new file mode 100644 index 000000000000..d25eadf96455 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "title": "EcrImageDetails_ListByResourceGroup", + "operationId": "EcrImageDetails_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListBySubscription.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListBySubscription.json new file mode 100644 index 000000000000..9109ff90378d --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_ListBySubscription.json @@ -0,0 +1,72 @@ +{ + "title": "EcrImageDetails_ListBySubscription", + "operationId": "EcrImageDetails_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Update.json b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Update.json new file mode 100644 index 000000000000..4a27c8fab8a9 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/examples/2024-12-01/EcrImageDetails_Update.json @@ -0,0 +1,79 @@ +{ + "title": "EcrImageDetails_Update", + "operationId": "EcrImageDetails_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5066": "opul" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EcrImageDetail.Management/main.tsp b/specification/awsconnector/EcrImageDetail.Management/main.tsp new file mode 100644 index 000000000000..59ec1d722c19 --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/main.tsp @@ -0,0 +1,203 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EcrImageDetails ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ECR Image Detail", + plural: "ECR Image Details", + }, + keywords: ["Microsoft.AwsConnector", "ECR", "Image", "Detail"], +}) +@doc("A Microsoft.AwsConnector resource") +model EcrImageDetail is TrackedResource<EcrImageDetailProperties> { + @doc("Name of EcrImageDetail") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ecrImageDetails") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EcrImageDetail") +model EcrImageDetailProperties { + @doc("AWS Properties") + awsProperties?: AwsEcrImageDetailProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEcrImageDetail") +model AwsEcrImageDetailProperties { + @doc("<p>The artifact media type of the image.</p>") + artifactMediaType?: string; + + @doc("<p>The <code>sha256</code> digest of the image manifest.</p>") + imageDigest?: string; + + @doc("<p>The media type of the image manifest.</p>") + imageManifestMediaType?: string; + + @doc("<p>The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. </p>") + imagePushedAt?: utcDateTime; + + @doc("<p>A summary of the last completed image scan.</p>") + imageScanFindingsSummary?: ImageScanFindingsSummary; + + @doc("<p>The current state of the scan.</p>") + imageScanStatus?: ImageScanStatus; + + @doc("<p>The size, in bytes, of the image in the repository.</p> <p>If the image is a manifest list, this will be the max size of all manifests in the list.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>") + imageSizeInBytes?: int64; + + @doc("<p>The list of tags associated with this image.</p>") + @extension("x-ms-identifiers", []) + imageTags?: string[]; + + @doc("<p>The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.</p> <note> <p>Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the <code>lastRecordedPullTime</code> timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the <code>lastRecordedPullTime</code> timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.</p> </note>") + lastRecordedPullTime?: utcDateTime; + + @doc("<p>The Amazon Web Services account ID associated with the registry to which this image belongs.</p>") + registryId?: string; + + @doc("<p>The name of the repository to which this image belongs.</p>") + repositoryName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageScanFindingsSummary") +model ImageScanFindingsSummary { + @doc("<p>The image vulnerability counts, sorted by severity.</p>") + findingSeverityCounts?: Record<int32>; + + @doc("<p>The time of the last completed image scan.</p>") + imageScanCompletedAt?: utcDateTime; + + @doc("<p>The time when the vulnerability data was last scanned.</p>") + vulnerabilitySourceUpdatedAt?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageScanStatus") +model ImageScanStatus { + @doc("<p>The description of the image scan status.</p>") + description?: string; + + @doc("<p>The current state of an image scan.</p>") + status?: ScanStatusEnumValue; +} + +@doc("ScanStatus enum") +union ScanStatus { + @doc("ScanStatus enum ACTIVE") + ACTIVE: "ACTIVE", + + @doc("ScanStatus enum COMPLETE") + COMPLETE: "COMPLETE", + + @doc("ScanStatus enum FAILED") + FAILED: "FAILED", + + @doc("ScanStatus enum FINDINGS_UNAVAILABLE") + FINDINGS_UNAVAILABLE: "FINDINGS_UNAVAILABLE", + + @doc("ScanStatus enum IN_PROGRESS") + IN_PROGRESS: "IN_PROGRESS", + + @doc("ScanStatus enum PENDING") + PENDING: "PENDING", + + @doc("ScanStatus enum SCAN_ELIGIBILITY_EXPIRED") + SCAN_ELIGIBILITY_EXPIRED: "SCAN_ELIGIBILITY_EXPIRED", + + @doc("ScanStatus enum UNSUPPORTED_IMAGE") + UNSUPPORTED_IMAGE: "UNSUPPORTED_IMAGE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ScanStatusEnumValue") +model ScanStatusEnumValue { + @doc("Property value") + value?: ScanStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EcrImageDetails { + get is ArmResourceRead<EcrImageDetail>; + @doc("Create a EcrImageDetail. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EcrImageDetail>; + update is ArmCustomPatchAsync< + EcrImageDetail, + Azure.ResourceManager.Foundations.TagsUpdateModel<EcrImageDetail> + >; + delete is ArmResourceDeleteWithoutOkAsync<EcrImageDetail>; + listByResourceGroup is ArmResourceListByParent<EcrImageDetail>; + listBySubscription is ArmListBySubscription<EcrImageDetail>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ecr\ecr-2015-09-21.normal.json +// AWS Shape: ImageDetail +// +// Related information for backend service: +// AWS Servcie : ECR +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.78 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EcrImageDetail.Management/tspconfig.yaml b/specification/awsconnector/EcrImageDetail.Management/tspconfig.yaml new file mode 100644 index 000000000000..3dfa66b444bf --- /dev/null +++ b/specification/awsconnector/EcrImageDetail.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ecrImageDetail.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_CreateOrReplace.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_CreateOrReplace.json new file mode 100644 index 000000000000..c2d29299e1b5 --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "EcrRepositories_CreateOrReplace", + "operationId": "EcrRepositories_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + } + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Delete.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Delete.json new file mode 100644 index 000000000000..5efd618ef00c --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcrRepositories_Delete", + "operationId": "EcrRepositories_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Get.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Get.json new file mode 100644 index 000000000000..f194249ec620 --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Get.json @@ -0,0 +1,68 @@ +{ + "title": "EcrRepositories_Get", + "operationId": "EcrRepositories_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListByResourceGroup.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListByResourceGroup.json new file mode 100644 index 000000000000..9e3f870206be --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "EcrRepositories_ListByResourceGroup", + "operationId": "EcrRepositories_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListBySubscription.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListBySubscription.json new file mode 100644 index 000000000000..c5cd3f1cc365 --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "EcrRepositories_ListBySubscription", + "operationId": "EcrRepositories_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Update.json b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Update.json new file mode 100644 index 000000000000..bc995bce1f9e --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/examples/2024-12-01/EcrRepositories_Update.json @@ -0,0 +1,78 @@ +{ + "title": "EcrRepositories_Update", + "operationId": "EcrRepositories_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2760": "sdwhuflvnahjhywxmi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EcrRepository.Management/main.tsp b/specification/awsconnector/EcrRepository.Management/main.tsp new file mode 100644 index 000000000000..86779e73f43c --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/main.tsp @@ -0,0 +1,197 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EcrRepositories ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ECR Repository", + plural: "ECR Repositories", + }, + keywords: ["Microsoft.AwsConnector", "ECR", "Repository"], +}) +@doc("A Microsoft.AwsConnector resource") +model EcrRepository is TrackedResource<EcrRepositoryProperties> { + @doc("Name of EcrRepository") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ecrRepositories") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EcrRepository") +model EcrRepositoryProperties { + @doc("AWS Properties") + awsProperties?: AwsEcrRepositoryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEcrRepository") +model AwsEcrRepositoryProperties { + @doc("Property arn") + arn?: string; + + @doc("If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories.") + emptyOnDelete?: boolean; + + @doc("The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*.") + encryptionConfiguration?: EncryptionConfiguration; + + @doc("The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. The image scanning configuration for a repository.") + imageScanningConfiguration?: ImageScanningConfiguration; + + @doc("The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.") + imageTagMutability?: ImageTagMutability; + + @doc("Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*.") + lifecyclePolicy?: LifecyclePolicy; + + @doc("The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + repositoryName?: string; + + @doc("The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.") + repositoryPolicyText?: Record<unknown>; + + @doc("Property repositoryUri") + repositoryUri?: string; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("ImageTagMutability enum") +union ImageTagMutability { + @doc("ImageTagMutability enum IMMUTABLE") + IMMUTABLE: "IMMUTABLE", + + @doc("ImageTagMutability enum MUTABLE") + MUTABLE: "MUTABLE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EncryptionConfiguration") +model EncryptionConfiguration { + @doc("The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use.") + encryptionType?: EncryptionConfigurationEncryptionType; + + @doc("If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used.") + kmsKey?: string; +} + +@doc("EncryptionConfigurationEncryptionType enum") +union EncryptionConfigurationEncryptionType { + @doc("EncryptionConfigurationEncryptionType enum AES256") + AES256: "AES256", + + @doc("EncryptionConfigurationEncryptionType enum KMS") + KMS: "KMS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageScanningConfiguration") +model ImageScanningConfiguration { + @doc("The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. The setting that determines whether images are scanned after being pushed to a repository.") + scanOnPush?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LifecyclePolicy") +model LifecyclePolicy { + @doc("The JSON repository policy text to apply to the repository. The JSON repository policy text to apply to the repository.") + lifecyclePolicyText?: string; + + @doc("The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed. The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.") + registryId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.") + key?: string; + + @doc("A ``value`` acts as a descriptor within a tag category (key).") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EcrRepositories { + get is ArmResourceRead<EcrRepository>; + @doc("Create a EcrRepository. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EcrRepository>; + update is ArmCustomPatchAsync< + EcrRepository, + Azure.ResourceManager.Foundations.TagsUpdateModel<EcrRepository> + >; + delete is ArmResourceDeleteWithoutOkAsync<EcrRepository>; + listByResourceGroup is ArmResourceListByParent<EcrRepository>; + listBySubscription is ArmListBySubscription<EcrRepository>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ECR::Repository +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EcrRepository.Management/tspconfig.yaml b/specification/awsconnector/EcrRepository.Management/tspconfig.yaml new file mode 100644 index 000000000000..0255b4a259a5 --- /dev/null +++ b/specification/awsconnector/EcrRepository.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ecrRepository.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_CreateOrReplace.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_CreateOrReplace.json new file mode 100644 index 000000000000..61ac34f34ad8 --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_CreateOrReplace.json @@ -0,0 +1,220 @@ +{ + "title": "EcsClusters_CreateOrReplace", + "operationId": "EcsClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + } + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Delete.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Delete.json new file mode 100644 index 000000000000..b50d7f2493b7 --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsClusters_Delete", + "operationId": "EcsClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Get.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Get.json new file mode 100644 index 000000000000..1e2aaf57be3a --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Get.json @@ -0,0 +1,85 @@ +{ + "title": "EcsClusters_Get", + "operationId": "EcsClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListByResourceGroup.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..c2b22bed25c1 --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "title": "EcsClusters_ListByResourceGroup", + "operationId": "EcsClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListBySubscription.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListBySubscription.json new file mode 100644 index 000000000000..8c3bab43a2cc --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_ListBySubscription.json @@ -0,0 +1,88 @@ +{ + "title": "EcsClusters_ListBySubscription", + "operationId": "EcsClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Update.json b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Update.json new file mode 100644 index 000000000000..4dbdb5861fb4 --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/examples/2024-12-01/EcsClusters_Update.json @@ -0,0 +1,95 @@ +{ + "title": "EcsClusters_Update", + "operationId": "EcsClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key657": "dd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EcsCluster.Management/main.tsp b/specification/awsconnector/EcsCluster.Management/main.tsp new file mode 100644 index 000000000000..a384e29e46aa --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/main.tsp @@ -0,0 +1,223 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EcsClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ECS Cluster", + plural: "ECS Clusters", + }, + keywords: ["Microsoft.AwsConnector", "ECS", "Cluster"], +}) +@doc("A Microsoft.AwsConnector resource") +model EcsCluster is TrackedResource<EcsClusterProperties> { + @doc("Name of EcsCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ecsClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EcsCluster") +model EcsClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsEcsClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEcsCluster") +model AwsEcsClusterProperties { + @doc("Property arn") + arn?: string; + + @doc("The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created.") + @extension("x-ms-identifiers", []) + capacityProviders?: string[]; + + @doc("A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.") + clusterName?: string; + + @doc("The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.") + @extension("x-ms-identifiers", []) + clusterSettings?: ClusterSettings[]; + + @doc("The execute command configuration for the cluster. The execute command configuration for the cluster.") + configuration?: ClusterConfiguration; + + @doc("The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.") + @extension("x-ms-identifiers", []) + defaultCapacityProviderStrategy?: CapacityProviderStrategyItem[]; + + @doc("Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + serviceConnectDefaults?: ServiceConnectDefaults; + + @doc("The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterSettings") +model ClusterSettings { + @doc("The name of the cluster setting. The value is ``containerInsights`` .") + name?: string; + + @doc("The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html).") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterConfiguration") +model ClusterConfiguration { + @doc("The details of the execute command configuration. The details of the execute command configuration.") + executeCommandConfiguration?: ExecuteCommandConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CapacityProviderStrategyItem") +model CapacityProviderStrategyItem { + @doc("The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.") + base?: int32; + + @doc("The short name of the capacity provider.") + capacityProvider?: string; + + @doc("The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.") + weight?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectDefaults") +model ServiceConnectDefaults { + @doc("The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the 'API calls' method of instance discovery only. This instance discovery method is the 'HTTP' namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. If you update the cluster with an empty string ``''`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.") + `namespace`?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.") + key?: string; + + @doc("The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ExecuteCommandConfiguration") +model ExecuteCommandConfiguration { + @doc("Specify an KMSlong key ID to encrypt the data between the local client and the container.") + kmsKeyId?: string; + + @doc("The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.") + logConfiguration?: ExecuteCommandLogConfiguration; + + @doc("The log setting to use for redirecting logs for your execute command results. The following log settings are available. + ``NONE``: The execute command session is not logged. + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required.") + logging?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ExecuteCommandLogConfiguration") +model ExecuteCommandLogConfiguration { + @doc("Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.") + cloudWatchEncryptionEnabled?: boolean; + + @doc("The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.") + cloudWatchLogGroupName?: string; + + @doc("The name of the S3 bucket to send logs to. The S3 bucket must already be created.") + s3BucketName?: string; + + @doc("Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.") + s3EncryptionEnabled?: boolean; + + @doc("An optional folder in the S3 bucket to place logs in.") + s3KeyPrefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EcsClusters { + get is ArmResourceRead<EcsCluster>; + @doc("Create a EcsCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EcsCluster>; + update is ArmCustomPatchAsync< + EcsCluster, + Azure.ResourceManager.Foundations.TagsUpdateModel<EcsCluster> + >; + delete is ArmResourceDeleteWithoutOkAsync<EcsCluster>; + listByResourceGroup is ArmResourceListByParent<EcsCluster>; + listBySubscription is ArmListBySubscription<EcsCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ECS::Cluster +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EcsCluster.Management/tspconfig.yaml b/specification/awsconnector/EcsCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..a495b0927e8e --- /dev/null +++ b/specification/awsconnector/EcsCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ecsCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_CreateOrReplace.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_CreateOrReplace.json new file mode 100644 index 000000000000..5ef25451b8c8 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_CreateOrReplace.json @@ -0,0 +1,547 @@ +{ + "title": "EcsServices_CreateOrReplace", + "operationId": "EcsServices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + } + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Delete.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Delete.json new file mode 100644 index 000000000000..4a7ed47db3d3 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsServices_Delete", + "operationId": "EcsServices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Get.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Get.json new file mode 100644 index 000000000000..80feda57229a --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Get.json @@ -0,0 +1,194 @@ +{ + "title": "EcsServices_Get", + "operationId": "EcsServices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListByResourceGroup.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListByResourceGroup.json new file mode 100644 index 000000000000..fa2d83f0d0c4 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListByResourceGroup.json @@ -0,0 +1,198 @@ +{ + "title": "EcsServices_ListByResourceGroup", + "operationId": "EcsServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListBySubscription.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListBySubscription.json new file mode 100644 index 000000000000..2125444ad745 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_ListBySubscription.json @@ -0,0 +1,197 @@ +{ + "title": "EcsServices_ListBySubscription", + "operationId": "EcsServices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Update.json b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Update.json new file mode 100644 index 000000000000..18515f2c3e45 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/examples/2024-12-01/EcsServices_Update.json @@ -0,0 +1,204 @@ +{ + "title": "EcsServices_Update", + "operationId": "EcsServices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8601": "aoipoqkrtxvtshttbllkc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EcsService.Management/main.tsp b/specification/awsconnector/EcsService.Management/main.tsp new file mode 100644 index 000000000000..146a59c22fb4 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/main.tsp @@ -0,0 +1,650 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EcsServices ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ECS Service", + plural: "ECS Services", + }, + keywords: ["Microsoft.AwsConnector", "ECS", "Service"], +}) +@doc("A Microsoft.AwsConnector resource") +model EcsService is TrackedResource<EcsServiceProperties> { + @doc("Name of EcsService") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ecsServices") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EcsService") +model EcsServiceProperties { + @doc("AWS Properties") + awsProperties?: AwsEcsServiceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEcsService") +model AwsEcsServiceProperties { + @doc("The capacity provider strategy to use for the service. If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers.") + @extension("x-ms-identifiers", []) + capacityProviderStrategy?: CapacityProviderStrategyItem[]; + + @doc("The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.") + cluster?: string; + + @doc("Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.") + deploymentConfiguration?: DeploymentConfiguration; + + @doc("The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*.") + deploymentController?: DeploymentController; + + @doc("The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation.") + desiredCount?: int32; + + @doc("Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter.") + enableECSManagedTags?: boolean; + + @doc("Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service.") + enableExecuteCommand?: boolean; + + @doc("The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.") + healthCheckGracePeriodSeconds?: int32; + + @doc("The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.") + launchType?: LaunchType; + + @doc("A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + loadBalancers?: LoadBalancer[]; + + @doc("Property name") + name?: string; + + @doc("The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service.") + networkConfiguration?: NetworkConfiguration; + + @doc("An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.") + @extension("x-ms-identifiers", []) + placementConstraints?: PlacementConstraint[]; + + @doc("The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.") + @extension("x-ms-identifiers", []) + placementStrategies?: PlacementStrategy[]; + + @doc("The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.") + platformVersion?: string = "LATEST"; + + @doc("Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``.") + propagateTags?: PropagateTags; + + @doc("The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.") + role?: string; + + @doc("The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.") + schedulingStrategy?: SchedulingStrategy; + + @doc("Property serviceArn") + serviceArn?: string; + + @doc("The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + serviceConnectConfiguration?: ServiceConnectConfiguration; + + @doc("The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster.") + serviceName?: string; + + @doc("The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries for each service isn't supported.") + @extension("x-ms-identifiers", []) + serviceRegistries?: ServiceRegistry[]; + + @doc("The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).") + taskDefinition?: string; + + @doc("The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.") + @extension("x-ms-identifiers", []) + volumeConfigurations?: ServiceVolumeConfiguration[]; +} + +@doc("LaunchType enum") +union LaunchType { + @doc("LaunchType enum EC2") + EC2: "EC2", + + @doc("LaunchType enum EXTERNAL") + EXTERNAL: "EXTERNAL", + + @doc("LaunchType enum FARGATE") + FARGATE: "FARGATE", + + string, +} + +@doc("SchedulingStrategy enum") +union SchedulingStrategy { + @doc("SchedulingStrategy enum DAEMON") + DAEMON: "DAEMON", + + @doc("SchedulingStrategy enum REPLICA") + REPLICA: "REPLICA", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CapacityProviderStrategyItem") +model CapacityProviderStrategyItem { + @doc("The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used.") + base?: int32; + + @doc("The short name of the capacity provider.") + capacityProvider?: string; + + @doc("The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*.") + weight?: int32; +} + +@doc("PropagateTags enum") +union PropagateTags { + @doc("PropagateTags enum SERVICE") + SERVICE: "SERVICE", + + @doc("PropagateTags enum TASK_DEFINITION") + TASK_DEFINITION: "TASK_DEFINITION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentConfiguration") +model DeploymentConfiguration { + @doc("Information about the CloudWatch alarms. One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update). For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*.") + alarms?: DeploymentAlarms; + + @doc("The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*.") + deploymentCircuitBreaker?: DeploymentCircuitBreaker; + + @doc("If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.") + maximumPercent?: int32; + + @doc("If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that *do not* use a load balancer, the following should be noted: + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services that *do* use a load balancer, the following should be noted: + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.") + minimumHealthyPercent?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentController") +model DeploymentController { + @doc("The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.") + type?: DeploymentControllerType; +} + +@doc("DeploymentControllerType enum") +union DeploymentControllerType { + @doc("DeploymentControllerType enum CODE_DEPLOY") + CODE_DEPLOY: "CODE_DEPLOY", + + @doc("DeploymentControllerType enum ECS") + ECS: "ECS", + + @doc("DeploymentControllerType enum EXTERNAL") + EXTERNAL: "EXTERNAL", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoadBalancer") +model LoadBalancer { + @doc("The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer.") + containerName?: string; + + @doc("The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping.") + containerPort?: int32; + + @doc("The name of the load balancer to associate with the Amazon ECS service or task set. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.") + loadBalancerName?: string; + + @doc("The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type.") + targetGroupArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkConfiguration") +model NetworkConfiguration { + @doc("The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC. An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=['subnet-12344321'],securityGroups=['sg-12344321']}``") + awsvpcConfiguration?: AwsVpcConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlacementConstraint") +model PlacementConstraint { + @doc("A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.") + expression?: string; + + @doc("The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.") + type?: PlacementConstraintType; +} + +@doc("PlacementConstraintType enum") +union PlacementConstraintType { + @doc("PlacementConstraintType enum distinctInstance") + distinctInstance: "distinctInstance", + + @doc("PlacementConstraintType enum memberOf") + memberOf: "memberOf", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlacementStrategy") +model PlacementStrategy { + @doc("The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used.") + field?: string; + + @doc("The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.") + type?: PlacementStrategyType; +} + +@doc("PlacementStrategyType enum") +union PlacementStrategyType { + @doc("PlacementStrategyType enum binpack") + binpack: "binpack", + + @doc("PlacementStrategyType enum random") + random: "random", + + @doc("PlacementStrategyType enum spread") + spread: "spread", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectConfiguration") +model ServiceConnectConfiguration { + @doc("Specifies whether to use Service Connect with this service.") + enabled?: boolean; + + @doc("The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.") + logConfiguration?: LogConfiguration; + + @doc("The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*.") + `namespace`?: string; + + @doc("The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a 'client' Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service.") + @extension("x-ms-identifiers", []) + services?: ServiceConnectService[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceRegistry") +model ServiceRegistry { + @doc("The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.") + containerName?: string; + + @doc("The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both.") + containerPort?: int32; + + @doc("The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used.") + port?: int32; + + @doc("The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).") + registryArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.") + key?: string; + + @doc("The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceVolumeConfiguration") +model ServiceVolumeConfiguration { + @doc("The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.") + managedEBSVolume?: ServiceManagedEBSVolumeConfiguration; + + @doc("The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition.") + name?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentAlarms") +model DeploymentAlarms { + @doc("One or more CloudWatch alarm names. Use a ',' to separate the alarms.") + @extension("x-ms-identifiers", []) + alarmNames?: string[]; + + @doc("Determines whether to use the CloudWatch alarm option in the service deployment process.") + enable?: boolean; + + @doc("Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.") + rollback?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentCircuitBreaker") +model DeploymentCircuitBreaker { + @doc("Determines whether to use the deployment circuit breaker logic for the service.") + enable?: boolean; + + @doc("Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.") + rollback?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AwsVpcConfiguration") +model AwsVpcConfiguration { + @doc("Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``.") + assignPublicIp?: AwsVpcConfigurationAssignPublicIp; + + @doc("The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. All specified security groups must be from the same VPC.") + @extension("x-ms-identifiers", []) + securityGroups?: string[]; + + @doc("The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. All specified subnets must be from the same VPC.") + @extension("x-ms-identifiers", []) + subnets?: string[]; +} + +@doc("AwsVpcConfigurationAssignPublicIp enum") +union AwsVpcConfigurationAssignPublicIp { + @doc("AwsVpcConfigurationAssignPublicIp enum DISABLED") + DISABLED: "DISABLED", + + @doc("AwsVpcConfigurationAssignPublicIp enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogConfiguration") +model LogConfiguration { + @doc("The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.") + logDriver?: string; + + @doc("The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``") + options?: unknown; + + @doc("The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + secretOptions?: Secret[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectService") +model ServiceConnectService { + @doc("The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias ('endpoint') is a fully-qualified name and port number that other Amazon ECS tasks ('clients') can use to connect to this service. Each name and port mapping must be unique within the namespace. For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``.") + @extension("x-ms-identifiers", []) + clientAliases?: ServiceConnectClientAlias[]; + + @doc("The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``.") + discoveryName?: string; + + @doc("The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy.") + ingressPortOverride?: int32; + + @doc("The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service.") + portName?: string; + + @doc("A reference to an object that represents the configured timeouts for Service Connect. An object that represents the timeout configurations for Service Connect. If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``.") + timeout?: TimeoutConfiguration; + + @doc("A reference to an object that represents a Transport Layer Security (TLS) configuration. An object that represents the configuration for Service Connect TLS.") + tls?: ServiceConnectTlsConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceManagedEBSVolumeConfiguration") +model ServiceManagedEBSVolumeConfiguration { + @doc("Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.") + encrypted?: boolean; + + @doc("The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types are
 ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default.") + filesystemType?: string; + + @doc("The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.") + iops?: int32; + + @doc("The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.") + kmsKeyId?: string; + + @doc("The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*.") + roleArn?: string; + + @doc("The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. The following are the supported volume size values for each volume type. + ``gp2`` and ``gp3``: 1-16,384 + ``io1`` and ``io2``: 4-16,384 + ``st1`` and ``sc1``: 125-16,384 + ``standard``: 1-1,024") + sizeInGiB?: int32; + + @doc("The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.") + snapshotId?: string; + + @doc("The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.") + @extension("x-ms-identifiers", []) + tagSpecifications?: EBSTagSpecification[]; + + @doc("The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. This parameter is only supported for the ``gp3`` volume type.") + throughput?: int32; + + @doc("The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. The following are the supported volume types. + General Purpose SSD: ``gp2``|``gp3`` + Provisioned IOPS SSD: ``io1``|``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` The magnetic volume type is not supported on Fargate.") + volumeType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Secret") +model Secret { + @doc("The name of the secret.") + name?: string; + + @doc("The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.") + valueFrom?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectClientAlias") +model ServiceConnectClientAlias { + @doc("The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + dnsName?: string; + + @doc("The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + port?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TimeoutConfiguration") +model TimeoutConfiguration { + @doc("The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``. The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes. The ``idleTimeout`` default for ``TCP`` is 1 hour.") + idleTimeoutSeconds?: int32; + + @doc("The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``.") + perRequestTimeoutSeconds?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectTlsConfiguration") +model ServiceConnectTlsConfiguration { + @doc("The signer certificate authority. An object that represents the AWS Private Certificate Authority certificate.") + issuerCertificateAuthority?: ServiceConnectTlsCertificateAuthority; + + @doc("The AWS Key Management Service key.") + kmsKey?: string; + + @doc("The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS.") + roleArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EBSTagSpecification") +model EBSTagSpecification { + @doc("Determines whether to propagate the tags from the task definition to 
the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in 
``ServiceVolumeConfiguration``. If no value is specified, the tags aren't 
propagated.") + propagateTags?: EBSTagSpecificationPropagateTags; + + @doc("The type of volume resource.") + resourceType?: string; + + @doc("The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("EBSTagSpecificationPropagateTags enum") +union EBSTagSpecificationPropagateTags { + @doc("EBSTagSpecificationPropagateTags enum SERVICE") + SERVICE: "SERVICE", + + @doc("EBSTagSpecificationPropagateTags enum TASK_DEFINITION") + TASK_DEFINITION: "TASK_DEFINITION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceConnectTlsCertificateAuthority") +model ServiceConnectTlsCertificateAuthority { + @doc("The ARN of the AWS Private Certificate Authority certificate.") + awsPcaAuthorityArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EcsServices { + get is ArmResourceRead<EcsService>; + @doc("Create a EcsService. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EcsService>; + update is ArmCustomPatchAsync< + EcsService, + Azure.ResourceManager.Foundations.TagsUpdateModel<EcsService> + >; + delete is ArmResourceDeleteWithoutOkAsync<EcsService>; + listByResourceGroup is ArmResourceListByParent<EcsService>; + listBySubscription is ArmListBySubscription<EcsService>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ECS::Service +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EcsService.Management/tspconfig.yaml b/specification/awsconnector/EcsService.Management/tspconfig.yaml new file mode 100644 index 000000000000..7899ed8b0674 --- /dev/null +++ b/specification/awsconnector/EcsService.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ecsService.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_CreateOrReplace.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_CreateOrReplace.json new file mode 100644 index 000000000000..eb7bf605ff34 --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_CreateOrReplace.json @@ -0,0 +1,844 @@ +{ + "title": "EcsTaskDefinitions_CreateOrReplace", + "operationId": "EcsTaskDefinitions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + } + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Delete.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Delete.json new file mode 100644 index 000000000000..47e96480db14 --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsTaskDefinitions_Delete", + "operationId": "EcsTaskDefinitions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Get.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Get.json new file mode 100644 index 000000000000..26038bbcf9df --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Get.json @@ -0,0 +1,293 @@ +{ + "title": "EcsTaskDefinitions_Get", + "operationId": "EcsTaskDefinitions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + } + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListByResourceGroup.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListByResourceGroup.json new file mode 100644 index 000000000000..1aea54f4f47a --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListByResourceGroup.json @@ -0,0 +1,297 @@ +{ + "title": "EcsTaskDefinitions_ListByResourceGroup", + "operationId": "EcsTaskDefinitions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + ], + "nextLink": "https://microsoft.com/am" + } + } + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListBySubscription.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListBySubscription.json new file mode 100644 index 000000000000..f2c29309d834 --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_ListBySubscription.json @@ -0,0 +1,296 @@ +{ + "title": "EcsTaskDefinitions_ListBySubscription", + "operationId": "EcsTaskDefinitions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + ], + "nextLink": "https://microsoft.com/am" + } + } + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Update.json b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Update.json new file mode 100644 index 000000000000..a08dc7cbcc44 --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/examples/2024-12-01/EcsTaskDefinitions_Update.json @@ -0,0 +1,303 @@ +{ + "title": "EcsTaskDefinitions_Update", + "operationId": "EcsTaskDefinitions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2531": "emmihvsstpbrxrsbykfncbdrvczwt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EcsTaskDefinition.Management/main.tsp b/specification/awsconnector/EcsTaskDefinition.Management/main.tsp new file mode 100644 index 000000000000..40a8433a9a6d --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/main.tsp @@ -0,0 +1,839 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EcsTaskDefinitions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "ECS Task Definition", + plural: "ECS Task Definitions", + }, + keywords: ["Microsoft.AwsConnector", "ECS", "Task", "Definition"], +}) +@doc("A Microsoft.AwsConnector resource") +model EcsTaskDefinition is TrackedResource<EcsTaskDefinitionProperties> { + @doc("Name of EcsTaskDefinition") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ecsTaskDefinitions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EcsTaskDefinition") +model EcsTaskDefinitionProperties { + @doc("AWS Properties") + awsProperties?: AwsEcsTaskDefinitionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEcsTaskDefinition") +model AwsEcsTaskDefinitionProperties { + @doc("A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + containerDefinitions?: ContainerDefinition[]; + + @doc("The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later.") + cpu?: string; + + @doc("The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version ``1.4.0`` or later. + Windows platform version ``1.0.0`` or later.") + ephemeralStorage?: EphemeralStorage; + + @doc("The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*.") + executionRoleArn?: string; + + @doc("The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it.") + family?: string; + + @doc("The Elastic Inference accelerators to use for the containers in the task.") + @extension("x-ms-identifiers", []) + inferenceAccelerators?: InferenceAccelerator[]; + + @doc("The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong.") + ipcMode?: string; + + @doc("The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) This option requires Linux platform ``1.4.0`` or later. + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) This option requires Linux platform ``1.4.0`` or later.") + memory?: string; + + @doc("The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``<default>`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*.") + networkMode?: string; + + @doc("The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.") + pidMode?: string; + + @doc("An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.") + @extension("x-ms-identifiers", []) + placementConstraints?: TaskDefinitionPlacementConstraint[]; + + @doc("The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)") + proxyConfiguration?: ProxyConfiguration; + + @doc("The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + requiresCompatibilities?: string[]; + + @doc("The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. Information about the platform for the Amazon ECS service or task. For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*.") + runtimePlatform?: RuntimePlatform; + + @doc("The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property taskDefinitionArn") + taskDefinitionArn?: string; + + @doc("The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*.") + taskRoleArn?: string; + + @doc("The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.") + @extension("x-ms-identifiers", []) + volumes?: Volume[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ContainerDefinition") +model ContainerDefinition { + @doc("The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array.") + @extension("x-ms-identifiers", []) + command?: string[]; + + @doc("The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU.") + cpu?: int32; + + @doc("A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).") + @extension("x-ms-identifiers", []) + credentialSpecs?: string[]; + + @doc("The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.") + @extension("x-ms-identifiers", []) + dependsOn?: ContainerDependency[]; + + @doc("When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). This parameter is not supported for Windows containers.") + disableNetworking?: boolean; + + @doc("A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers.") + @extension("x-ms-identifiers", []) + dnsSearchDomains?: string[]; + + @doc("A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers.") + @extension("x-ms-identifiers", []) + dnsServers?: string[]; + + @doc("A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``") + dockerLabels?: unknown; + + @doc("A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath'") + @extension("x-ms-identifiers", []) + dockerSecurityOptions?: string[]; + + @doc("Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint).") + @extension("x-ms-identifiers", []) + entryPoint?: string[]; + + @doc("The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.") + @extension("x-ms-identifiers", []) + environment?: KeyValuePair[]; + + @doc("A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/). If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + environmentFiles?: EnvironmentFile[]; + + @doc("If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*.") + essential?: boolean; + + @doc("A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode.") + @extension("x-ms-identifiers", []) + extraHosts?: HostEntry[]; + + @doc("The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*.") + firelensConfiguration?: FirelensConfiguration; + + @doc("The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.") + healthCheck?: HealthCheck; + + @doc("The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode.") + hostname?: string; + + @doc("The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest`` or ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``).") + image?: string; + + @doc("When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).") + interactive?: boolean; + + @doc("The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.") + @extension("x-ms-identifiers", []) + links?: string[]; + + @doc("Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).") + linuxParameters?: LinuxParameters; + + @doc("The log configuration specification for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container.") + logConfiguration?: LogConfiguration; + + @doc("The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.") + memory?: int32; + + @doc("The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.") + memoryReservation?: int32; + + @doc("The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives.") + @extension("x-ms-identifiers", []) + mountPoints?: MountPoint[]; + + @doc("The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).") + name?: string; + + @doc("The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.") + @extension("x-ms-identifiers", []) + portMappings?: PortMapping[]; + + @doc("When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers or tasks run on FARGATElong.") + privileged?: boolean; + + @doc("When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).") + pseudoTerminal?: boolean; + + @doc("When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers.") + readonlyRootFilesystem?: boolean; + + @doc("The private repository authentication credentials to use. The repository credentials for private registry authentication.") + repositoryCredentials?: RepositoryCredentials; + + @doc("The type and amount of a resource to assign to a container. The only supported resource is a GPU.") + @extension("x-ms-identifiers", []) + resourceRequirements?: ResourceRequirement[]; + + @doc("The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + secrets?: Secret[]; + + @doc("Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds.") + startTimeout?: int32; + + @doc("Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds.") + stopTimeout?: int32; + + @doc("A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.") + @extension("x-ms-identifiers", []) + systemControls?: SystemControl[]; + + @doc("A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers.") + @extension("x-ms-identifiers", []) + ulimits?: Ulimit[]; + + @doc("The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + ``user`` + ``user:group`` + ``uid`` + ``uid:gid`` + ``user:gid`` + ``uid:group`` This parameter is not supported for Windows containers.") + user?: string; + + @doc("Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).") + @extension("x-ms-identifiers", []) + volumesFrom?: VolumeFrom[]; + + @doc("The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).") + workingDirectory?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EphemeralStorage") +model EphemeralStorage { + @doc("The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB.") + sizeInGiB?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InferenceAccelerator") +model InferenceAccelerator { + @doc("The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html).") + deviceName?: string; + + @doc("The Elastic Inference accelerator type to use.") + deviceType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TaskDefinitionPlacementConstraint") +model TaskDefinitionPlacementConstraint { + @doc("A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*.") + expression?: string; + + @doc("The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates.") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProxyConfiguration") +model ProxyConfiguration { + @doc("The name of the container that will serve as the App Mesh proxy.") + containerName?: string; + + @doc("The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.") + @extension("x-ms-identifiers", []) + proxyConfigurationProperties?: KeyValuePair[]; + + @doc("The proxy type. The only supported value is ``APPMESH``.") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuntimePlatform") +model RuntimePlatform { + @doc("The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate.") + cpuArchitecture?: string; + + @doc("The operating system.") + operatingSystemFamily?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values.") + key?: string; + + @doc("The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key).") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Volume") +model Volume { + @doc("Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs.") + configuredAtLaunch?: boolean; + + @doc("This parameter is specified when you use Docker volumes. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead. Docker volumes aren't supported by tasks run on FARGATElong. The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead.") + dockerVolumeConfiguration?: DockerVolumeConfiguration; + + @doc("This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.") + efsVolumeConfiguration?: EFSVolumeConfiguration; + + @doc("This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*.") + fSxWindowsFileServerVolumeConfiguration?: FSxWindowsFileServerVolumeConfiguration; + + @doc("This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``. The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume.") + host?: HostVolumeProperties; + + @doc("The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task. For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition. When a volume is using the ``efsVolumeConfiguration``, the name is required.") + name?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ContainerDependency") +model ContainerDependency { + @doc("The dependency condition of the container. The following are the available conditions and their behavior: + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.") + condition?: string; + + @doc("The name of a container.") + containerName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KeyValuePair") +model KeyValuePair { + @doc("The name of the key-value pair. For environment variables, this is the name of the environment variable.") + name?: string; + + @doc("The value of the key-value pair. For environment variables, this is the value of the environment variable.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EnvironmentFile") +model EnvironmentFile { + @doc("The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``.") + type?: string; + + @doc("The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HostEntry") +model HostEntry { + @doc("The hostname to use in the ``/etc/hosts`` entry.") + hostname?: string; + + @doc("The IP address to use in the ``/etc/hosts`` entry.") + ipAddress?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FirelensConfiguration") +model FirelensConfiguration { + @doc("The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + ``config-file-type``, which can be ``s3`` or ``file`` + ``config-file-value``, which is either an S3 ARN or a file path") + options?: unknown; + + @doc("The log router to use. The valid values are ``fluentd`` or ``fluentbit``.") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HealthCheck") +model HealthCheck { + @doc("A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. ``[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).") + @extension("x-ms-identifiers", []) + command?: string[]; + + @doc("The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.") + interval?: int32; + + @doc("The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.") + retries?: int32; + + @doc("The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.") + startPeriod?: int32; + + @doc("The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.") + timeout?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LinuxParameters") +model LinuxParameters { + @doc("The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page.") + capabilities?: KernelCapabilities; + + @doc("Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported.") + @extension("x-ms-identifiers", []) + devices?: Device[]; + + @doc("Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``") + initProcessEnabled?: boolean; + + @doc("The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.") + maxSwap?: int32; + + @doc("The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported.") + sharedMemorySize?: int32; + + @doc("This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported.") + swappiness?: int32; + + @doc("The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported.") + @extension("x-ms-identifiers", []) + tmpfs?: Tmpfs[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogConfiguration") +model LogConfiguration { + @doc("The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software.") + logDriver?: string; + + @doc("The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``") + options?: unknown; + + @doc("The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.") + @extension("x-ms-identifiers", []) + secretOptions?: Secret[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MountPoint") +model MountPoint { + @doc("The path on the container to mount the host volume at.") + containerPath?: string; + + @doc("If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.") + readOnly?: boolean; + + @doc("The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``.") + sourceVolume?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PortMapping") +model PortMapping { + @doc("The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + appProtocol?: PortMappingAppProtocol; + + @doc("The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.") + containerPort?: int32; + + @doc("The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + The ``containerPortRange`` valid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports.") + containerPortRange?: string; + + @doc("The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota.") + hostPort?: int32; + + @doc("The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.") + name?: string; + + @doc("The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment.") + protocol?: string; +} + +@doc("PortMappingAppProtocol enum") +union PortMappingAppProtocol { + @doc("PortMappingAppProtocol enum grpc") + grpc: "grpc", + + @doc("PortMappingAppProtocol enum http") + http: "http", + + @doc("PortMappingAppProtocol enum http2") + http2: "http2", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RepositoryCredentials") +model RepositoryCredentials { + @doc("The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret.") + credentialsParameter?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceRequirement") +model ResourceRequirement { + @doc("The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``.") + type?: string; + + @doc("The value for the specified resource type. If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Secret") +model Secret { + @doc("The name of the secret.") + name?: string; + + @doc("The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.") + valueFrom?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SystemControl") +model SystemControl { + @doc("The namespaced kernel parameter to set a ``value`` for.") + `namespace`?: string; + + @doc("The namespaced kernel parameter to set a ``value`` for. Valid IPC namespace values: ``'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced'``, and ``Sysctls`` that start with ``'fs.mqueue.*'`` Valid network namespace values: ``Sysctls`` that start with ``'net.*'`` All of these values are supported by Fargate.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ulimit") +model Ulimit { + @doc("The hard limit for the ``ulimit`` type.") + hardLimit?: int32; + + @doc("The ``type`` of the ``ulimit``.") + name?: string; + + @doc("The soft limit for the ``ulimit`` type.") + softLimit?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VolumeFrom") +model VolumeFrom { + @doc("If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``.") + readOnly?: boolean; + + @doc("The name of another container within the same task definition to mount volumes from.") + sourceContainer?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DockerVolumeConfiguration") +model DockerVolumeConfiguration { + @doc("If this value is ``true``, the Docker volume is created if it doesn't already exist. This field is only used if the ``scope`` is ``shared``.") + autoprovision?: boolean; + + @doc("The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).") + driver?: string; + + @doc("A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).") + driverOpts?: unknown; + + @doc("Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/).") + labels?: unknown; + + @doc("The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops.") + scope?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EFSVolumeConfiguration") +model EFSVolumeConfiguration { + @doc("The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system.") + authorizationConfig?: AuthorizationConfig; + + @doc("The Amazon EFS file system ID to use.") + filesystemId?: string; + + @doc("The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point.") + rootDirectory?: string; + + @doc("Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.") + transitEncryption?: EFSVolumeConfigurationTransitEncryption; + + @doc("The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*.") + transitEncryptionPort?: int32; +} + +@doc("EFSVolumeConfigurationTransitEncryption enum") +union EFSVolumeConfigurationTransitEncryption { + @doc("EFSVolumeConfigurationTransitEncryption enum DISABLED") + DISABLED: "DISABLED", + + @doc("EFSVolumeConfigurationTransitEncryption enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FSxWindowsFileServerVolumeConfiguration") +model FSxWindowsFileServerVolumeConfiguration { + @doc("The authorization configuration details for the Amazon FSx for Windows File Server file system.") + authorizationConfig?: FSxAuthorizationConfig; + + @doc("The Amazon FSx for Windows File Server file system ID to use.") + fileSystemId?: string; + + @doc("The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.") + rootDirectory?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HostVolumeProperties") +model HostVolumeProperties { + @doc("When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported.") + sourcePath?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KernelCapabilities") +model KernelCapabilities { + @doc("The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``") + @extension("x-ms-identifiers", []) + add?: string[]; + + @doc("The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``") + @extension("x-ms-identifiers", []) + drop?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Device") +model Device { + @doc("The path inside the container at which to expose the host device.") + containerPath?: string; + + @doc("The path for the device on the host container instance.") + hostPath?: string; + + @doc("The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device.") + @extension("x-ms-identifiers", []) + permissions?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tmpfs") +model Tmpfs { + @doc("The absolute file path where the tmpfs volume is to be mounted.") + containerPath?: string; + + @doc("The list of tmpfs volume mount options.") + @extension("x-ms-identifiers", []) + mountOptions?: string[]; + + @doc("The maximum size (in MiB) of the tmpfs volume.") + size?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthorizationConfig") +model AuthorizationConfig { + @doc("The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*.") + accessPointId?: string; + + @doc("Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.") + iam?: AuthorizationConfigIAM; +} + +@doc("AuthorizationConfigIAM enum") +union AuthorizationConfigIAM { + @doc("AuthorizationConfigIAM enum DISABLED") + DISABLED: "DISABLED", + + @doc("AuthorizationConfigIAM enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FSxAuthorizationConfig") +model FSxAuthorizationConfig { + @doc("Property credentialsParameter") + credentialsParameter?: string; + + @doc("Property domain") + domain?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EcsTaskDefinitions { + get is ArmResourceRead<EcsTaskDefinition>; + @doc("Create a EcsTaskDefinition. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EcsTaskDefinition>; + update is ArmCustomPatchAsync< + EcsTaskDefinition, + Azure.ResourceManager.Foundations.TagsUpdateModel<EcsTaskDefinition> + >; + delete is ArmResourceDeleteWithoutOkAsync<EcsTaskDefinition>; + listByResourceGroup is ArmResourceListByParent<EcsTaskDefinition>; + listBySubscription is ArmListBySubscription<EcsTaskDefinition>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ECS::TaskDefinition +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EcsTaskDefinition.Management/tspconfig.yaml b/specification/awsconnector/EcsTaskDefinition.Management/tspconfig.yaml new file mode 100644 index 000000000000..d05b362876b8 --- /dev/null +++ b/specification/awsconnector/EcsTaskDefinition.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ecsTaskDefinition.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_CreateOrReplace.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_CreateOrReplace.json new file mode 100644 index 000000000000..fe0ec57de18f --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_CreateOrReplace.json @@ -0,0 +1,214 @@ +{ + "title": "EfsFileSystems_CreateOrReplace", + "operationId": "EfsFileSystems_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + } + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + } + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Delete.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Delete.json new file mode 100644 index 000000000000..2f69b26176ee --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EfsFileSystems_Delete", + "operationId": "EfsFileSystems_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Get.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Get.json new file mode 100644 index 000000000000..f04a01020ac1 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Get.json @@ -0,0 +1,83 @@ +{ + "title": "EfsFileSystems_Get", + "operationId": "EfsFileSystems_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + } + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListByResourceGroup.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListByResourceGroup.json new file mode 100644 index 000000000000..cba4315ab760 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "title": "EfsFileSystems_ListByResourceGroup", + "operationId": "EfsFileSystems_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListBySubscription.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListBySubscription.json new file mode 100644 index 000000000000..f3cc17530477 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_ListBySubscription.json @@ -0,0 +1,86 @@ +{ + "title": "EfsFileSystems_ListBySubscription", + "operationId": "EfsFileSystems_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Update.json b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Update.json new file mode 100644 index 000000000000..d1c92904e859 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/examples/2024-12-01/EfsFileSystems_Update.json @@ -0,0 +1,93 @@ +{ + "title": "EfsFileSystems_Update", + "operationId": "EfsFileSystems_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5392": "lawsukb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EfsFileSystem.Management/main.tsp b/specification/awsconnector/EfsFileSystem.Management/main.tsp new file mode 100644 index 000000000000..027a9482f364 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/main.tsp @@ -0,0 +1,243 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EfsFileSystems ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EFS File System", + plural: "EFS File Systems", + }, + keywords: ["Microsoft.AwsConnector", "EFS", "File", "System"], +}) +@doc("A Microsoft.AwsConnector resource") +model EfsFileSystem is TrackedResource<EfsFileSystemProperties> { + @doc("Name of EfsFileSystem") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("efsFileSystems") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EfsFileSystem") +model EfsFileSystemProperties { + @doc("AWS Properties") + awsProperties?: AwsEfsFileSystemProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEfsFileSystem") +model AwsEfsFileSystemProperties { + @doc("Property arn") + arn?: string; + + @doc("For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.") + availabilityZoneName?: string; + + @doc("Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. The backup policy turns automatic backups for the file system on or off.") + backupPolicy?: BackupPolicy; + + @doc("(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.") + bypassPolicyLockoutSafetyCheck?: boolean; + + @doc("A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.") + encrypted?: boolean; + + @doc("Property fileSystemId") + fileSystemId?: string; + + @doc("The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.") + fileSystemPolicy?: unknown; + + @doc("Describes the protection on the file system. Describes the protection on the file system.") + fileSystemProtection?: FileSystemProtection; + + @doc("Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``'Key':'Name','Value':'{value}'`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.") + @extension("x-ms-identifiers", []) + fileSystemTags?: ElasticFileSystemTag[]; + + @doc("The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.") + kmsKeyId?: string; + + @doc("An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. + When to move files in the file system from primary storage or IA storage to Archive storage. + When to move files that are in IA or Archive storage to primary storage. EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.") + @extension("x-ms-identifiers", []) + lifecyclePolicies?: LifecyclePolicy[]; + + @doc("The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``.") + performanceMode?: string; + + @doc("The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.") + provisionedThroughputInMibps?: int32; + + @doc("Describes the replication configuration for a specific file system. Describes the replication configuration for a specific file system.") + replicationConfiguration?: ReplicationConfiguration; + + @doc("Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. Default is ``bursting``.") + throughputMode?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BackupPolicy") +model BackupPolicy { + @doc("Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system.") + status?: BackupPolicyStatus; +} + +@doc("BackupPolicyStatus enum") +union BackupPolicyStatus { + @doc("BackupPolicyStatus enum DISABLED") + DISABLED: "DISABLED", + + @doc("BackupPolicyStatus enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FileSystemProtection") +model FileSystemProtection { + @doc("The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.") + replicationOverwriteProtection?: FileSystemProtectionReplicationOverwriteProtection; +} + +@doc("FileSystemProtectionReplicationOverwriteProtection enum") +union FileSystemProtectionReplicationOverwriteProtection { + @doc("FileSystemProtectionReplicationOverwriteProtection enum DISABLED") + DISABLED: "DISABLED", + + @doc("FileSystemProtectionReplicationOverwriteProtection enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticFileSystemTag") +model ElasticFileSystemTag { + @doc("The tag key (String). The key can't start with ``aws:``.") + key?: string; + + @doc("The value of the tag key.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LifecyclePolicy") +model LifecyclePolicy { + @doc("The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.") + transitionToArchive?: string; + + @doc("The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.") + transitionToIA?: string; + + @doc("Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.") + transitionToPrimaryStorageClass?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationConfiguration") +model ReplicationConfiguration { + @doc("An array of destination objects. Only one destination object is supported.") + @extension("x-ms-identifiers", []) + destinations?: ReplicationDestination[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationDestination") +model ReplicationDestination { + @doc("The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.") + availabilityZoneName?: string; + + @doc("The ID of the destination Amazon EFS file system.") + fileSystemId?: string; + + @doc("The ID of an kms-key-long used to protect the encrypted file system.") + kmsKeyId?: string; + + @doc("The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.") + region?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EfsFileSystems { + get is ArmResourceRead<EfsFileSystem>; + @doc("Create a EfsFileSystem. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EfsFileSystem>; + update is ArmCustomPatchAsync< + EfsFileSystem, + Azure.ResourceManager.Foundations.TagsUpdateModel<EfsFileSystem> + >; + delete is ArmResourceDeleteWithoutOkAsync<EfsFileSystem>; + listByResourceGroup is ArmResourceListByParent<EfsFileSystem>; + listBySubscription is ArmListBySubscription<EfsFileSystem>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EFS::FileSystem +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EfsFileSystem.Management/tspconfig.yaml b/specification/awsconnector/EfsFileSystem.Management/tspconfig.yaml new file mode 100644 index 000000000000..e0227e023b20 --- /dev/null +++ b/specification/awsconnector/EfsFileSystem.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/efsFileSystem.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_CreateOrReplace.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_CreateOrReplace.json new file mode 100644 index 000000000000..24f8761a9757 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_CreateOrReplace.json @@ -0,0 +1,121 @@ +{ + "title": "EfsMountTargets_CreateOrReplace", + "operationId": "EfsMountTargets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + } + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + } + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Delete.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Delete.json new file mode 100644 index 000000000000..8879153c57d0 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EfsMountTargets_Delete", + "operationId": "EfsMountTargets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Get.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Get.json new file mode 100644 index 000000000000..247730ff8ce0 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Get.json @@ -0,0 +1,52 @@ +{ + "title": "EfsMountTargets_Get", + "operationId": "EfsMountTargets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + } + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListByResourceGroup.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListByResourceGroup.json new file mode 100644 index 000000000000..c3c847ca8013 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "title": "EfsMountTargets_ListByResourceGroup", + "operationId": "EfsMountTargets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListBySubscription.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListBySubscription.json new file mode 100644 index 000000000000..81bb1f34bb45 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "title": "EfsMountTargets_ListBySubscription", + "operationId": "EfsMountTargets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Update.json b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Update.json new file mode 100644 index 000000000000..7d60bd811504 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/examples/2024-12-01/EfsMountTargets_Update.json @@ -0,0 +1,62 @@ +{ + "title": "EfsMountTargets_Update", + "operationId": "EfsMountTargets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7998": "dgmfqhihmwujctuugirbw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EfsMountTarget.Management/main.tsp b/specification/awsconnector/EfsMountTarget.Management/main.tsp new file mode 100644 index 000000000000..b51cf3f8b0b5 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/main.tsp @@ -0,0 +1,111 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EfsMountTargets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EFS Mount Target", + plural: "EFS Mount Targets", + }, + keywords: ["Microsoft.AwsConnector", "EFS", "Mount", "Target"], +}) +@doc("A Microsoft.AwsConnector resource") +model EfsMountTarget is TrackedResource<EfsMountTargetProperties> { + @doc("Name of EfsMountTarget") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("efsMountTargets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EfsMountTarget") +model EfsMountTargetProperties { + @doc("AWS Properties") + awsProperties?: AwsEfsMountTargetProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEfsMountTarget") +model AwsEfsMountTargetProperties { + @doc("The ID of the file system for which to create the mount target.") + fileSystemId?: string; + + @doc("Property id") + id?: string; + + @doc("Valid IPv4 address within the address range of the specified subnet.") + ipAddress?: string; + + @doc("Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.") + @extension("x-ms-identifiers", []) + securityGroups?: string[]; + + @doc("The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone.") + subnetId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EfsMountTargets { + get is ArmResourceRead<EfsMountTarget>; + @doc("Create a EfsMountTarget. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EfsMountTarget>; + update is ArmCustomPatchAsync< + EfsMountTarget, + Azure.ResourceManager.Foundations.TagsUpdateModel<EfsMountTarget> + >; + delete is ArmResourceDeleteWithoutOkAsync<EfsMountTarget>; + listByResourceGroup is ArmResourceListByParent<EfsMountTarget>; + listBySubscription is ArmListBySubscription<EfsMountTarget>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EFS::MountTarget +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EfsMountTarget.Management/tspconfig.yaml b/specification/awsconnector/EfsMountTarget.Management/tspconfig.yaml new file mode 100644 index 000000000000..301731403c78 --- /dev/null +++ b/specification/awsconnector/EfsMountTarget.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/efsMountTarget.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_CreateOrReplace.json b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_CreateOrReplace.json new file mode 100644 index 000000000000..66b7ff757fb0 --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_CreateOrReplace.json @@ -0,0 +1,386 @@ +{ + "title": "EksClusters_CreateOrReplace", + "operationId": "EksClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx", + "resource": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + } + } +} diff --git a/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Delete.json b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Delete.json new file mode 100644 index 000000000000..f342c4b0fcd6 --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "title": "EksClusters_Delete", + "operationId": "EksClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Get.json b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Get.json new file mode 100644 index 000000000000..cc926b2d59b9 --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_Get.json @@ -0,0 +1,139 @@ +{ + "title": "EksClusters_Get", + "operationId": "EksClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + } + } +} diff --git a/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_List.json b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_List.json new file mode 100644 index 000000000000..71a370f03d0b --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/examples/2024-12-01/EksClusters_List.json @@ -0,0 +1,144 @@ +{ + "title": "EksClusters_List", + "operationId": "EksClusters_List", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EksCluster.Management/main.tsp b/specification/awsconnector/EksCluster.Management/main.tsp new file mode 100644 index 000000000000..8b3497376352 --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/main.tsp @@ -0,0 +1,548 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EksClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@doc("A Microsoft.AwsConnector resource") +@singleton +model EksCluster is ExtensionResource<EksClusterProperties> { + @doc("Name of EksCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("eksClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EksCluster") +model EksClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsEksClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEksCluster") +model AwsEksClusterProperties { + @doc("<p>The access configuration for the cluster.</p>") + accessConfig?: AccessConfigResponse; + + @doc("<p>The Amazon Resource Name (ARN) of the cluster.</p>") + arn?: string; + + @doc("<p>The <code>certificate-authority-data</code> for your cluster.</p>") + certificateAuthority?: Certificate; + + @doc("<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>") + clientRequestToken?: string; + + @doc("<p>The configuration used to connect to a cluster for registration.</p>") + connectorConfig?: ConnectorConfigResponse; + + @doc("<p>The Unix epoch timestamp at object creation.</p>") + createdAt?: utcDateTime; + + @doc("<p>The encryption configuration for the cluster.</p>") + @extension("x-ms-identifiers", []) + encryptionConfig?: EncryptionConfig[]; + + @doc("<p>The endpoint for your Kubernetes API server.</p>") + endpoint?: string; + + @doc("<p>An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>") + health?: ClusterHealth; + + @doc("<p>The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.</p>") + id?: string; + + @doc("<p>The identity provider information for the cluster.</p>") + identity?: Identity; + + @doc("<p>The Kubernetes network configuration for the cluster.</p>") + kubernetesNetworkConfig?: KubernetesNetworkConfigResponse; + + @doc("<p>The logging configuration for your cluster.</p>") + logging?: Logging; + + @doc("<p>The name of your cluster.</p>") + name?: string; + + @doc("<p>An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>") + outpostConfig?: OutpostConfigResponse; + + @doc("<p>The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html'>Platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>. For more information about local clusters deployed on an Outpost, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html'>Amazon EKS local cluster platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>") + platformVersion?: string; + + @doc("<p>The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html'>Cluster VPC considerations</a> and <a href='https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html'>Cluster security group considerations</a> in the <i>Amazon EKS User Guide</i>.</p>") + resourcesVpcConfig?: VpcConfigResponse; + + @doc("<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.</p>") + roleArn?: string; + + @doc("<p>The current status of the cluster.</p>") + status?: ClusterStatusEnumValue; + + @doc("<p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</p>") + tags?: Record<string>; + + @doc("<p>The Kubernetes server version for the cluster.</p>") + version?: string; +} + +@doc("ClusterStatus enum") +union ClusterStatus { + @doc("ClusterStatus enum ACTIVE") + ACTIVE: "ACTIVE", + + @doc("ClusterStatus enum CREATING") + CREATING: "CREATING", + + @doc("ClusterStatus enum DELETING") + DELETING: "DELETING", + + @doc("ClusterStatus enum FAILED") + FAILED: "FAILED", + + @doc("ClusterStatus enum PENDING") + PENDING: "PENDING", + + @doc("ClusterStatus enum UPDATING") + UPDATING: "UPDATING", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStatusEnumValue") +model ClusterStatusEnumValue { + @doc("Property value") + value?: ClusterStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccessConfigResponse") +model AccessConfigResponse { + @doc("<p>The current authentication mode of the cluster.</p>") + authenticationMode?: AuthenticationModeEnumValue; + + @doc("<p>Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.</p>") + bootstrapClusterCreatorAdminPermissions?: boolean; +} + +@doc("AuthenticationMode enum") +union AuthenticationMode { + @doc("AuthenticationMode enum API") + API: "API", + + @doc("AuthenticationMode enum API_AND_CONFIG_MAP") + API_AND_CONFIG_MAP: "API_AND_CONFIG_MAP", + + @doc("AuthenticationMode enum CONFIG_MAP") + CONFIG_MAP: "CONFIG_MAP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthenticationModeEnumValue") +model AuthenticationModeEnumValue { + @doc("Property value") + value?: AuthenticationMode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Certificate") +model Certificate { + @doc("<p>The Base64-encoded certificate data required to communicate with your cluster. Add this to the <code>certificate-authority-data</code> section of the <code>kubeconfig</code> file for your cluster.</p>") + data?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConnectorConfigResponse") +model ConnectorConfigResponse { + @doc("<p>A unique code associated with the cluster for registration purposes.</p>") + activationCode?: string; + + @doc("<p>The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.</p>") + activationExpiry?: utcDateTime; + + @doc("<p>A unique ID associated with the cluster for registration purposes.</p>") + activationId?: string; + + @doc("<p>The cluster's cloud service provider.</p>") + provider?: string; + + @doc("<p>The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.</p>") + roleArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EncryptionConfig") +model EncryptionConfig { + @doc("<p>Key Management Service (KMS) key. Either the ARN or the alias can be used.</p>") + provider?: Provider; + + @doc("<p>Specifies the resources to be encrypted. The only supported value is <code>secrets</code>.</p>") + @extension("x-ms-identifiers", []) + resources?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterHealth") +model ClusterHealth { + @doc("<p>An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.</p>") + @extension("x-ms-identifiers", []) + issues?: ClusterIssue[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Identity") +model Identity { + @doc("<p>An object representing the <a href='https://openid.net/connect/'>OpenID Connect</a> identity provider information.</p>") + oidc?: OIDC; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KubernetesNetworkConfigResponse") +model KubernetesNetworkConfigResponse { + @doc("<p>The IP family used to assign Kubernetes <code>Pod</code> and <code>Service</code> objects IP addresses. The IP family is always <code>ipv4</code>, unless you have a <code>1.21</code> or later cluster running version <code>1.10.1</code> or later of the Amazon VPC CNI plugin for Kubernetes and specified <code>ipv6</code> when you created the cluster. </p>") + ipFamily?: IpFamilyEnumValue; + + @doc("<p>The CIDR block that Kubernetes <code>Pod</code> and <code>Service</code> object IP addresses are assigned from. Kubernetes assigns addresses from an <code>IPv4</code> CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the <code>10.100.0.0/16</code> or <code>172.20.0.0/16</code> CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.</p>") + serviceIpv4Cidr?: string; + + @doc("<p>The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified <code>ipv6</code> for <b>ipFamily</b> when you created the cluster. Kubernetes assigns service addresses from the unique local address range (<code>fc00::/7</code>) because you can't specify a custom IPv6 CIDR block when you create the cluster.</p>") + serviceIpv6Cidr?: string; +} + +@doc("IpFamily enum") +union IpFamily { + @doc("IpFamily enum ipv4") + Ipv4: "ipv4", + + @doc("IpFamily enum ipv6") + Ipv6: "ipv6", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IpFamilyEnumValue") +model IpFamilyEnumValue { + @doc("Property value") + value?: IpFamily; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Logging") +model Logging { + @doc("<p>The cluster control plane logging configuration for your cluster.</p>") + @extension("x-ms-identifiers", []) + clusterLogging?: LogSetup[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OutpostConfigResponse") +model OutpostConfigResponse { + @doc("<p>The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.</p>") + controlPlaneInstanceType?: string; + + @doc("<p>An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html'>Capacity considerations</a> in the <i>Amazon EKS User Guide</i>.</p>") + controlPlanePlacement?: ControlPlanePlacementResponse; + + @doc("<p>The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.</p>") + @extension("x-ms-identifiers", []) + outpostArns?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VpcConfigResponse") +model VpcConfigResponse { + @doc("<p>The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.</p>") + clusterSecurityGroupId?: string; + + @doc("<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html'>Amazon EKS cluster endpoint access control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>") + endpointPrivateAccess?: boolean; + + @doc("<p>Whether the public API server endpoint is enabled.</p>") + endpointPublicAccess?: boolean; + + @doc("<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.</p>") + @extension("x-ms-identifiers", []) + publicAccessCidrs?: string[]; + + @doc("<p>The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.</p>") + @extension("x-ms-identifiers", []) + securityGroupIds?: string[]; + + @doc("<p>The subnets associated with your cluster.</p>") + @extension("x-ms-identifiers", []) + subnetIds?: string[]; + + @doc("<p>The VPC associated with your cluster.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Provider") +model Provider { + @doc("<p>Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the <a href='https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html'>IAM principal</a> must have access to the KMS key. For more information, see <a href='https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html'>Allowing users in other accounts to use a KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>") + keyArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterIssue") +model ClusterIssue { + @doc("<p>The error code of the issue.</p>") + code?: ClusterIssueCodeEnumValue; + + @doc("<p>A description of the issue.</p>") + message?: string; + + @doc("<p>The resource IDs that the issue relates to.</p>") + @extension("x-ms-identifiers", []) + resourceIds?: string[]; +} + +@doc("ClusterIssueCode enum") +union ClusterIssueCode { + @doc("ClusterIssueCode enum AccessDenied") + AccessDenied: "AccessDenied", + + @doc("ClusterIssueCode enum ClusterUnreachable") + ClusterUnreachable: "ClusterUnreachable", + + @doc("ClusterIssueCode enum ConfigurationConflict") + ConfigurationConflict: "ConfigurationConflict", + + @doc("ClusterIssueCode enum Ec2SecurityGroupNotFound") + Ec2SecurityGroupNotFound: "Ec2SecurityGroupNotFound", + + @doc("ClusterIssueCode enum Ec2ServiceNotSubscribed") + Ec2ServiceNotSubscribed: "Ec2ServiceNotSubscribed", + + @doc("ClusterIssueCode enum Ec2SubnetNotFound") + Ec2SubnetNotFound: "Ec2SubnetNotFound", + + @doc("ClusterIssueCode enum IamRoleNotFound") + IamRoleNotFound: "IamRoleNotFound", + + @doc("ClusterIssueCode enum InsufficientFreeAddresses") + InsufficientFreeAddresses: "InsufficientFreeAddresses", + + @doc("ClusterIssueCode enum InternalFailure") + InternalFailure: "InternalFailure", + + @doc("ClusterIssueCode enum KmsGrantRevoked") + KmsGrantRevoked: "KmsGrantRevoked", + + @doc("ClusterIssueCode enum KmsKeyDisabled") + KmsKeyDisabled: "KmsKeyDisabled", + + @doc("ClusterIssueCode enum KmsKeyMarkedForDeletion") + KmsKeyMarkedForDeletion: "KmsKeyMarkedForDeletion", + + @doc("ClusterIssueCode enum KmsKeyNotFound") + KmsKeyNotFound: "KmsKeyNotFound", + + @doc("ClusterIssueCode enum Other") + Other: "Other", + + @doc("ClusterIssueCode enum ResourceLimitExceeded") + ResourceLimitExceeded: "ResourceLimitExceeded", + + @doc("ClusterIssueCode enum ResourceNotFound") + ResourceNotFound: "ResourceNotFound", + + @doc("ClusterIssueCode enum StsRegionalEndpointDisabled") + StsRegionalEndpointDisabled: "StsRegionalEndpointDisabled", + + @doc("ClusterIssueCode enum UnsupportedVersion") + UnsupportedVersion: "UnsupportedVersion", + + @doc("ClusterIssueCode enum VpcNotFound") + VpcNotFound: "VpcNotFound", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterIssueCodeEnumValue") +model ClusterIssueCodeEnumValue { + @doc("Property value") + value?: ClusterIssueCode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OIDC") +model OIDC { + @doc("<p>The issuer URL for the OIDC identity provider.</p>") + issuer?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogSetup") +model LogSetup { + @doc("<p>If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.</p>") + enabled?: boolean; + + @doc("<p>The available cluster control plane log types.</p>") + @extension("x-ms-identifiers", []) + types?: LogType[]; +} + +@doc("LogType enum") +union LogType { + @doc("LogType enum api") + Api: "api", + + @doc("LogType enum audit") + Audit: "audit", + + @doc("LogType enum authenticator") + Authenticator: "authenticator", + + @doc("LogType enum controllerManager") + ControllerManager: "controllerManager", + + @doc("LogType enum scheduler") + Scheduler: "scheduler", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogTypeEnumValue") +model LogTypeEnumValue { + @doc("Property value") + value?: LogType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ControlPlanePlacementResponse") +model ControlPlanePlacementResponse { + @doc("<p>The name of the placement group for the Kubernetes control plane instances.</p>") + groupName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EksClusters { + get is ArmResourceRead<EksCluster>; + @doc("Create a EksCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EksCluster>; + delete is ArmResourceDeleteWithoutOkAsync<EksCluster>; + list is ArmResourceListByParent<EksCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\eks\eks-2017-11-01.normal.json +// AWS Shape: Cluster +// +// Related information for backend service: +// AWS Servcie : EKS +// Product Version : 3.7.798.0 +// SDK Version : 3.7.305.19 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EksCluster.Management/tspconfig.yaml b/specification/awsconnector/EksCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..12c284d9978e --- /dev/null +++ b/specification/awsconnector/EksCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/eksCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_CreateOrReplace.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_CreateOrReplace.json new file mode 100644 index 000000000000..40eb3501e40a --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_CreateOrReplace.json @@ -0,0 +1,250 @@ +{ + "title": "EksNodegroups_CreateOrReplace", + "operationId": "EksNodegroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + } + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + } + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Delete.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Delete.json new file mode 100644 index 000000000000..34bf7a269e34 --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EksNodegroups_Delete", + "operationId": "EksNodegroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Get.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Get.json new file mode 100644 index 000000000000..b2901d0b47d9 --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Get.json @@ -0,0 +1,95 @@ +{ + "title": "EksNodegroups_Get", + "operationId": "EksNodegroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + } + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListByResourceGroup.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListByResourceGroup.json new file mode 100644 index 000000000000..daf38b990016 --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListByResourceGroup.json @@ -0,0 +1,99 @@ +{ + "title": "EksNodegroups_ListByResourceGroup", + "operationId": "EksNodegroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListBySubscription.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListBySubscription.json new file mode 100644 index 000000000000..2e44d8b917b6 --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_ListBySubscription.json @@ -0,0 +1,98 @@ +{ + "title": "EksNodegroups_ListBySubscription", + "operationId": "EksNodegroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Update.json b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Update.json new file mode 100644 index 000000000000..232b1d317a9c --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/examples/2024-12-01/EksNodegroups_Update.json @@ -0,0 +1,105 @@ +{ + "title": "EksNodegroups_Update", + "operationId": "EksNodegroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2267": "ejnwsgjwwastrflkarwmrckdqi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EksNodegroup.Management/main.tsp b/specification/awsconnector/EksNodegroup.Management/main.tsp new file mode 100644 index 000000000000..583768cc1476 --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/main.tsp @@ -0,0 +1,233 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EksNodegroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EKS Nodegroup", + plural: "EKS Nodegroups", + }, + keywords: ["Microsoft.AwsConnector", "EKS", "Nodegroup"], +}) +@doc("A Microsoft.AwsConnector resource") +model EksNodegroup is TrackedResource<EksNodegroupProperties> { + @doc("Name of EksNodegroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("eksNodegroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EksNodegroup") +model EksNodegroupProperties { + @doc("AWS Properties") + awsProperties?: AwsEksNodegroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEksNodegroup") +model AwsEksNodegroupProperties { + @doc("The AMI type for your node group.") + amiType?: string; + + @doc("Property arn") + arn?: string; + + @doc("The capacity type of your managed node group.") + capacityType?: string; + + @doc("Name of the cluster to create the node group in.") + clusterName?: string; + + @doc("The root device disk size (in GiB) for your node group instances.") + diskSize?: int32; + + @doc("Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.") + forceUpdateEnabled?: boolean; + + @doc("Property id") + id?: string; + + @doc("Specify the instance types for a node group.") + @extension("x-ms-identifiers", []) + instanceTypes?: string[]; + + @doc("The Kubernetes labels to be applied to the nodes in the node group when they are created.") + labels?: Record<string>; + + @doc("An object representing a node group's launch template specification. An object representing a launch template specification for AWS EKS Nodegroup.") + launchTemplate?: LaunchTemplateSpecification; + + @doc("The Amazon Resource Name (ARN) of the IAM role to associate with your node group.") + nodeRole?: string; + + @doc("The unique name to give your node group.") + nodegroupName?: string; + + @doc("The AMI version of the Amazon EKS-optimized AMI to use with your node group.") + releaseVersion?: string; + + @doc("The remote access (SSH) configuration to use with your node group. An object representing a remote access configuration specification for AWS EKS Nodegroup.") + remoteAccess?: RemoteAccess; + + @doc("The scaling configuration details for the Auto Scaling group that is created for your node group. An object representing a auto scaling group specification for AWS EKS Nodegroup.") + scalingConfig?: ScalingConfig; + + @doc("The subnets to use for the Auto Scaling group that is created for your node group.") + @extension("x-ms-identifiers", []) + subnets?: string[]; + + @doc("The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.") + tags?: Record<string>; + + @doc("The Kubernetes taints to be applied to the nodes in the node group when they are created.") + @extension("x-ms-identifiers", []) + taints?: Taint[]; + + @doc("The node group update configuration. The node group update configuration.") + updateConfig?: UpdateConfig; + + @doc("The Kubernetes version to use for your managed nodes.") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LaunchTemplateSpecification") +model LaunchTemplateSpecification { + @doc("Property id") + id?: string; + + @doc("Property name") + name?: string; + + @doc("Property version") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RemoteAccess") +model RemoteAccess { + @doc("Property ec2SshKey") + ec2SshKey?: string; + + @doc("Property sourceSecurityGroups") + @extension("x-ms-identifiers", []) + sourceSecurityGroups?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ScalingConfig") +model ScalingConfig { + @doc("Property desiredSize") + desiredSize?: int32; + + @doc("Property maxSize") + maxSize?: int32; + + @doc("Property minSize") + minSize?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Taint") +model Taint { + @doc("Property effect") + effect?: string; + + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of UpdateConfig") +model UpdateConfig { + @doc("The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100.") + maxUnavailable?: int32; + + @doc("The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.") + maxUnavailablePercentage?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EksNodegroups { + get is ArmResourceRead<EksNodegroup>; + @doc("Create a EksNodegroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EksNodegroup>; + update is ArmCustomPatchAsync< + EksNodegroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<EksNodegroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<EksNodegroup>; + listByResourceGroup is ArmResourceListByParent<EksNodegroup>; + listBySubscription is ArmListBySubscription<EksNodegroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::EKS::Nodegroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EksNodegroup.Management/tspconfig.yaml b/specification/awsconnector/EksNodegroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..97d3b36be32c --- /dev/null +++ b/specification/awsconnector/EksNodegroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/eksNodegroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_CreateOrReplace.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_CreateOrReplace.json new file mode 100644 index 000000000000..15294ba254e3 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_CreateOrReplace.json @@ -0,0 +1,151 @@ +{ + "title": "ElasticBeanstalkApplications_CreateOrReplace", + "operationId": "ElasticBeanstalkApplications_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + } + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Delete.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Delete.json new file mode 100644 index 000000000000..5ca1fceca6eb --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkApplications_Delete", + "operationId": "ElasticBeanstalkApplications_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Get.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Get.json new file mode 100644 index 000000000000..2827c8cd38bd --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Get.json @@ -0,0 +1,62 @@ +{ + "title": "ElasticBeanstalkApplications_Get", + "operationId": "ElasticBeanstalkApplications_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListByResourceGroup.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListByResourceGroup.json new file mode 100644 index 000000000000..0b49630f290e --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "ElasticBeanstalkApplications_ListByResourceGroup", + "operationId": "ElasticBeanstalkApplications_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListBySubscription.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListBySubscription.json new file mode 100644 index 000000000000..3086564ff075 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "ElasticBeanstalkApplications_ListBySubscription", + "operationId": "ElasticBeanstalkApplications_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Update.json b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Update.json new file mode 100644 index 000000000000..e6b680779254 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/examples/2024-12-01/ElasticBeanstalkApplications_Update.json @@ -0,0 +1,72 @@ +{ + "title": "ElasticBeanstalkApplications_Update", + "operationId": "ElasticBeanstalkApplications_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key483": "ydsxoqpgkqbwfamrvfmrqswlaz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/main.tsp b/specification/awsconnector/ElasticBeanstalkApplication.Management/main.tsp new file mode 100644 index 000000000000..edfb9e5ec6a8 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/main.tsp @@ -0,0 +1,163 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticBeanstalkApplications ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Beanstalk Application", + plural: "Elastic Beanstalk Applications", + }, + keywords: ["Microsoft.AwsConnector", "Elastic", "Beanstalk", "Application"], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticBeanstalkApplication + is TrackedResource<ElasticBeanstalkApplicationProperties> { + @doc("Name of ElasticBeanstalkApplication") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticBeanstalkApplications") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticBeanstalkApplication") +model ElasticBeanstalkApplicationProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticBeanstalkApplicationProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticBeanstalkApplication") +model AwsElasticBeanstalkApplicationProperties { + @doc("A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name.") + applicationName?: string; + + @doc("Your description of the application.") + description?: string; + + @doc("Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions.") + resourceLifecycleConfig?: ApplicationResourceLifecycleConfig; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ApplicationResourceLifecycleConfig") +model ApplicationResourceLifecycleConfig { + @doc("The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value.") + serviceRole?: string; + + @doc("Defines lifecycle settings for application versions.") + versionLifecycleConfig?: ApplicationVersionLifecycleConfig; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ApplicationVersionLifecycleConfig") +model ApplicationVersionLifecycleConfig { + @doc("Specify a max age rule to restrict the length of time that application versions are retained for an application.") + maxAgeRule?: MaxAgeRule; + + @doc("Specify a max count rule to restrict the number of application versions that are retained for an application.") + maxCountRule?: MaxCountRule; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MaxAgeRule") +model MaxAgeRule { + @doc("Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.") + deleteSourceFromS3?: boolean; + + @doc("Specify true to apply the rule, or false to disable it.") + enabled?: boolean; + + @doc("Specify the number of days to retain an application versions.") + maxAgeInDays?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MaxCountRule") +model MaxCountRule { + @doc("Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.") + deleteSourceFromS3?: boolean; + + @doc("Specify true to apply the rule, or false to disable it.") + enabled?: boolean; + + @doc("Specify the maximum number of application versions to retain.") + maxCount?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticBeanstalkApplications { + get is ArmResourceRead<ElasticBeanstalkApplication>; + @doc("Create a ElasticBeanstalkApplication. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticBeanstalkApplication>; + update is ArmCustomPatchAsync< + ElasticBeanstalkApplication, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticBeanstalkApplication> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticBeanstalkApplication>; + listByResourceGroup is ArmResourceListByParent<ElasticBeanstalkApplication>; + listBySubscription is ArmListBySubscription<ElasticBeanstalkApplication>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticBeanstalk::Application +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticBeanstalkApplication.Management/tspconfig.yaml b/specification/awsconnector/ElasticBeanstalkApplication.Management/tspconfig.yaml new file mode 100644 index 000000000000..034f7543ce73 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkApplication.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticBeanstalkApplication.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json new file mode 100644 index 000000000000..fdb8531c5cc4 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", + "operationId": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + } + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Delete.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Delete.json new file mode 100644 index 000000000000..35b5eb779d59 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Delete", + "operationId": "ElasticBeanstalkConfigurationTemplates_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Get.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Get.json new file mode 100644 index 000000000000..da12b002a95c --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Get.json @@ -0,0 +1,63 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Get", + "operationId": "ElasticBeanstalkConfigurationTemplates_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json new file mode 100644 index 000000000000..b6b3de422214 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", + "operationId": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + ], + "nextLink": "https://microsoft.com/awfzeg" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json new file mode 100644 index 000000000000..b48c3090ca80 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", + "operationId": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + ], + "nextLink": "https://microsoft.com/awfzeg" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Update.json b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Update.json new file mode 100644 index 000000000000..8f67ef04831a --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/examples/2024-12-01/ElasticBeanstalkConfigurationTemplates_Update.json @@ -0,0 +1,73 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Update", + "operationId": "ElasticBeanstalkConfigurationTemplates_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5550": "peipqgaljpx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/main.tsp b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/main.tsp new file mode 100644 index 000000000000..b31fe0b172c6 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/main.tsp @@ -0,0 +1,159 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticBeanstalkConfigurationTemplates ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Beanstalk Configuration Template", + plural: "Elastic Beanstalk Configuration Templates", + }, + keywords: [ + "Microsoft.AwsConnector", + "Elastic", + "Beanstalk", + "Configuration", + "Template" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticBeanstalkConfigurationTemplate + is TrackedResource<ElasticBeanstalkConfigurationTemplateProperties> { + @doc("Name of ElasticBeanstalkConfigurationTemplate") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticBeanstalkConfigurationTemplates") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticBeanstalkConfigurationTemplate") +model ElasticBeanstalkConfigurationTemplateProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticBeanstalkConfigurationTemplateProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticBeanstalkConfigurationTemplate") +model AwsElasticBeanstalkConfigurationTemplateProperties { + @doc("The name of the Elastic Beanstalk application to associate with this configuration template.") + applicationName?: string; + + @doc("An optional description for this configuration.") + description?: string; + + @doc("The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration.") + environmentId?: string; + + @doc("Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.") + @extension("x-ms-identifiers", []) + optionSettings?: ConfigurationOptionSetting[]; + + @doc("The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide.") + platformArn?: string; + + @doc("The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.") + solutionStackName?: string; + + @doc("An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.") + sourceConfiguration?: SourceConfiguration; + + @doc("The name of the configuration template") + templateName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigurationOptionSetting") +model ConfigurationOptionSetting { + @doc("A unique namespace that identifies the option's associated AWS resource.") + `namespace`?: string; + + @doc("The name of the configuration option.") + optionName?: string; + + @doc("A unique resource name for the option setting. Use it for a time–based scaling configuration option.") + resourceName?: string; + + @doc("The current value for the configuration option.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceConfiguration") +model SourceConfiguration { + @doc("The name of the application associated with the configuration.") + applicationName?: string; + + @doc("The name of the configuration template.") + templateName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticBeanstalkConfigurationTemplates { + get is ArmResourceRead<ElasticBeanstalkConfigurationTemplate>; + @doc("Create a ElasticBeanstalkConfigurationTemplate. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticBeanstalkConfigurationTemplate>; + update is ArmCustomPatchAsync< + ElasticBeanstalkConfigurationTemplate, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticBeanstalkConfigurationTemplate> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticBeanstalkConfigurationTemplate>; + listByResourceGroup is ArmResourceListByParent<ElasticBeanstalkConfigurationTemplate>; + listBySubscription is ArmListBySubscription<ElasticBeanstalkConfigurationTemplate>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticBeanstalk::ConfigurationTemplate +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/tspconfig.yaml b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/tspconfig.yaml new file mode 100644 index 000000000000..77cc52155205 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkConfigurationTemplate.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticBeanstalkConfigurationTemplate.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_CreateOrReplace.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_CreateOrReplace.json new file mode 100644 index 000000000000..26bdea3a6db8 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "ElasticBeanstalkEnvironments_CreateOrReplace", + "operationId": "ElasticBeanstalkEnvironments_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + } + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Delete.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Delete.json new file mode 100644 index 000000000000..bdc85f60cfa5 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkEnvironments_Delete", + "operationId": "ElasticBeanstalkEnvironments_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Get.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Get.json new file mode 100644 index 000000000000..84c8c2f73c87 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Get.json @@ -0,0 +1,74 @@ +{ + "title": "ElasticBeanstalkEnvironments_Get", + "operationId": "ElasticBeanstalkEnvironments_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListByResourceGroup.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..a93bb6e089c9 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticBeanstalkEnvironments_ListByResourceGroup", + "operationId": "ElasticBeanstalkEnvironments_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + ], + "nextLink": "https://microsoft.com/alne" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListBySubscription.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..2d641fb81ff6 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "ElasticBeanstalkEnvironments_ListBySubscription", + "operationId": "ElasticBeanstalkEnvironments_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + ], + "nextLink": "https://microsoft.com/alne" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Update.json b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Update.json new file mode 100644 index 000000000000..70efa2be96a1 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/examples/2024-12-01/ElasticBeanstalkEnvironments_Update.json @@ -0,0 +1,84 @@ +{ + "title": "ElasticBeanstalkEnvironments_Update", + "operationId": "ElasticBeanstalkEnvironments_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4897": "jbyvhlrhylk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/main.tsp b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/main.tsp new file mode 100644 index 000000000000..662b31895245 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/main.tsp @@ -0,0 +1,185 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticBeanstalkEnvironments ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Beanstalk Environment", + plural: "Elastic Beanstalk Environments", + }, + keywords: ["Microsoft.AwsConnector", "Elastic", "Beanstalk", "Environment"], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticBeanstalkEnvironment + is TrackedResource<ElasticBeanstalkEnvironmentProperties> { + @doc("Name of ElasticBeanstalkEnvironment") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticBeanstalkEnvironments") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticBeanstalkEnvironment") +model ElasticBeanstalkEnvironmentProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticBeanstalkEnvironmentProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticBeanstalkEnvironment") +model AwsElasticBeanstalkEnvironmentProperties { + @doc("The name of the application that is associated with this environment.") + applicationName?: string; + + @doc("If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.") + cnamePrefix?: string; + + @doc("Your description for this environment.") + description?: string; + + @doc("Property endpointURL") + endpointURL?: string; + + @doc("A unique name for the environment.") + environmentName?: string; + + @doc("The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.") + operationsRole?: string; + + @doc("Key-value pairs defining configuration options for this environment, such as the instance type.") + @extension("x-ms-identifiers", []) + optionSettings?: OptionSetting[]; + + @doc("The Amazon Resource Name (ARN) of the custom platform to use with the environment.") + platformArn?: string; + + @doc("The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.") + solutionStackName?: string; + + @doc("Specifies the tags applied to resources in the environment.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The name of the Elastic Beanstalk configuration template to use with the environment.") + templateName?: string; + + @doc("Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.") + tier?: Tier; + + @doc("The name of the application version to deploy.") + versionLabel?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OptionSetting") +model OptionSetting { + @doc("A unique namespace that identifies the option's associated AWS resource.") + `namespace`?: string; + + @doc("The name of the configuration option.") + optionName?: string; + + @doc("A unique resource name for the option setting. Use it for a time–based scaling configuration option.") + resourceName?: string; + + @doc("The current value for the configuration option.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag.") + key?: string; + + @doc("The value for the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tier") +model Tier { + @doc("The name of this environment tier.") + name?: string; + + @doc("The type of this environment tier.") + type?: string; + + @doc("The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.") + version?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticBeanstalkEnvironments { + get is ArmResourceRead<ElasticBeanstalkEnvironment>; + @doc("Create a ElasticBeanstalkEnvironment. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticBeanstalkEnvironment>; + update is ArmCustomPatchAsync< + ElasticBeanstalkEnvironment, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticBeanstalkEnvironment> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticBeanstalkEnvironment>; + listByResourceGroup is ArmResourceListByParent<ElasticBeanstalkEnvironment>; + listBySubscription is ArmListBySubscription<ElasticBeanstalkEnvironment>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticBeanstalk::Environment +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticBeanstalkEnvironment.Management/tspconfig.yaml b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/tspconfig.yaml new file mode 100644 index 000000000000..1f58784fae55 --- /dev/null +++ b/specification/awsconnector/ElasticBeanstalkEnvironment.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticBeanstalkEnvironment.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_CreateOrReplace.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_CreateOrReplace.json new file mode 100644 index 000000000000..a826f5cbff94 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_CreateOrReplace.json @@ -0,0 +1,334 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2Listeners_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + } + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Delete.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Delete.json new file mode 100644 index 000000000000..80ecc49b02a0 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Delete", + "operationId": "ElasticLoadBalancingV2Listeners_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Get.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Get.json new file mode 100644 index 000000000000..6476f42302ca --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Get.json @@ -0,0 +1,123 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Get", + "operationId": "ElasticLoadBalancingV2Listeners_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json new file mode 100644 index 000000000000..42318a51d149 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json @@ -0,0 +1,127 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2Listeners_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListBySubscription.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListBySubscription.json new file mode 100644 index 000000000000..51e88db30f1b --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_ListBySubscription.json @@ -0,0 +1,126 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_ListBySubscription", + "operationId": "ElasticLoadBalancingV2Listeners_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Update.json b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Update.json new file mode 100644 index 000000000000..3d4bc32af0fc --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/examples/2024-12-01/ElasticLoadBalancingV2Listeners_Update.json @@ -0,0 +1,133 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Update", + "operationId": "ElasticLoadBalancingV2Listeners_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1036": "styywfjbytpruluzsccjxbrqukn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/main.tsp b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/main.tsp new file mode 100644 index 000000000000..ab2713eafbcc --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/main.tsp @@ -0,0 +1,345 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticLoadBalancingV2Listeners ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Load Balancing V2 Listener", + plural: "Elastic Load Balancing V2 Listeners", + }, + keywords: [ + "Microsoft.AwsConnector", + "Elastic", + "Load", + "Balancing", + "V2", + "Listener" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticLoadBalancingV2Listener + is TrackedResource<ElasticLoadBalancingV2ListenerProperties> { + @doc("Name of ElasticLoadBalancingV2Listener") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticLoadBalancingV2Listeners") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticLoadBalancingV2Listener") +model ElasticLoadBalancingV2ListenerProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticLoadBalancingV2ListenerProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticLoadBalancingV2Listener") +model AwsElasticLoadBalancingV2ListenerProperties { + @doc("[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.") + @extension("x-ms-identifiers", []) + alpnPolicy?: string[]; + + @doc("The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).") + @extension("x-ms-identifiers", []) + certificates?: Certificate[]; + + @doc("The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).") + @extension("x-ms-identifiers", []) + defaultActions?: Action[]; + + @doc("Property listenerArn") + listenerArn?: string; + + @doc("The Amazon Resource Name (ARN) of the load balancer.") + loadBalancerArn?: string; + + @doc("The mutual authentication configuration information. Specifies the configuration information for mutual authentication.") + mutualAuthentication?: MutualAuthentication; + + @doc("The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer.") + port?: int32; + + @doc("The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer.") + protocol?: string; + + @doc("[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*.") + sslPolicy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Certificate") +model Certificate { + @doc("The Amazon Resource Name (ARN) of the certificate.") + certificateArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Action") +model Action { + @doc("[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. Specifies information required when integrating with Amazon Cognito to authenticate users.") + authenticateCognitoConfig?: AuthenticateCognitoConfig; + + @doc("[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.") + authenticateOidcConfig?: AuthenticateOidcConfig; + + @doc("[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. Specifies information required when returning a custom HTTP response.") + fixedResponseConfig?: FixedResponseConfig; + + @doc("Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``.") + forwardConfig?: ForwardConfig; + + @doc("The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first.") + order?: int32; + + @doc("[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading '/' is removed) + #{query} For example, you can change the path to '/new/#{path}', the hostname to 'example.#{host}', or the query to '#{query}&value=xyz'.") + redirectConfig?: RedirectConfig; + + @doc("The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead.") + targetGroupArn?: string; + + @doc("The type of action.") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MutualAuthentication") +model MutualAuthentication { + @doc("Indicates whether expired client certificates are ignored.") + ignoreClientCertificateExpiry?: boolean; + + @doc("The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``.") + mode?: string; + + @doc("The Amazon Resource Name (ARN) of the trust store.") + trustStoreArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthenticateCognitoConfig") +model AuthenticateCognitoConfig { + @doc("The query parameters (up to 10) to include in the redirect request to the authorization endpoint.") + authenticationRequestExtraParams?: Record<string>; + + @doc("The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.") + onUnauthenticatedRequest?: string; + + @doc("The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.") + scope?: string; + + @doc("The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.") + sessionCookieName?: string; + + @doc("The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).") + sessionTimeout?: string; + + @doc("The Amazon Resource Name (ARN) of the Amazon Cognito user pool.") + userPoolArn?: string; + + @doc("The ID of the Amazon Cognito user pool client.") + userPoolClientId?: string; + + @doc("The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.") + userPoolDomain?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AuthenticateOidcConfig") +model AuthenticateOidcConfig { + @doc("The query parameters (up to 10) to include in the redirect request to the authorization endpoint.") + authenticationRequestExtraParams?: Record<string>; + + @doc("The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.") + authorizationEndpoint?: string; + + @doc("The OAuth 2.0 client identifier.") + clientId?: string; + + @doc("The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true.") + clientSecret?: string; + + @doc("The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.") + issuer?: string; + + @doc("The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value.") + onUnauthenticatedRequest?: string; + + @doc("The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.") + scope?: string; + + @doc("The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.") + sessionCookieName?: string; + + @doc("The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).") + sessionTimeout?: string; + + @doc("The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.") + tokenEndpoint?: string; + + @doc("Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.") + useExistingClientSecret?: boolean; + + @doc("The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.") + userInfoEndpoint?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FixedResponseConfig") +model FixedResponseConfig { + @doc("The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json") + contentType?: string; + + @doc("The message.") + messageBody?: string; + + @doc("The HTTP response code (2XX, 4XX, or 5XX).") + statusCode?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ForwardConfig") +model ForwardConfig { + @doc("Information about the target group stickiness for a rule. Information about the target group stickiness for a rule.") + targetGroupStickinessConfig?: TargetGroupStickinessConfig; + + @doc("Information about how traffic will be distributed between multiple target groups in a forward rule.") + @extension("x-ms-identifiers", []) + targetGroups?: TargetGroupTuple[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RedirectConfig") +model RedirectConfig { + @doc("The hostname. This component is not percent-encoded. The hostname can contain #{host}.") + host?: string; + + @doc("The absolute path, starting with the leading '/'. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.") + path?: string; + + @doc("The port. You can specify a value from 1 to 65535 or #{port}.") + port?: string; + + @doc("The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.") + protocol?: string; + + @doc("The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading '?', as it is automatically added. You can specify any of the reserved keywords.") + query?: string; + + @doc("The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).") + statusCode?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetGroupStickinessConfig") +model TargetGroupStickinessConfig { + @doc("The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days).") + durationSeconds?: int32; + + @doc("Indicates whether target group stickiness is enabled.") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetGroupTuple") +model TargetGroupTuple { + @doc("The Amazon Resource Name (ARN) of the target group.") + targetGroupArn?: string; + + @doc("The weight. The range is 0 to 999.") + weight?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticLoadBalancingV2Listeners { + get is ArmResourceRead<ElasticLoadBalancingV2Listener>; + @doc("Create a ElasticLoadBalancingV2Listener. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticLoadBalancingV2Listener>; + update is ArmCustomPatchAsync< + ElasticLoadBalancingV2Listener, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticLoadBalancingV2Listener> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticLoadBalancingV2Listener>; + listByResourceGroup is ArmResourceListByParent<ElasticLoadBalancingV2Listener>; + listBySubscription is ArmListBySubscription<ElasticLoadBalancingV2Listener>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticLoadBalancingV2::Listener +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/tspconfig.yaml b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/tspconfig.yaml new file mode 100644 index 000000000000..378f0f1f381f --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2Listener.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticLoadBalancingV2Listener.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json new file mode 100644 index 000000000000..ed177a8340f5 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + } + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Delete.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Delete.json new file mode 100644 index 000000000000..7c3551c9cac4 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Delete", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Get.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Get.json new file mode 100644 index 000000000000..c6bd3ab753ac --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Get.json @@ -0,0 +1,81 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Get", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json new file mode 100644 index 000000000000..c8c7baa8c180 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json new file mode 100644 index 000000000000..79a71545b10c --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_ListBySubscription", + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Update.json b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Update.json new file mode 100644 index 000000000000..ecd9e5a2c1a8 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/examples/2024-12-01/ElasticLoadBalancingV2LoadBalancers_Update.json @@ -0,0 +1,91 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Update", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3447": "otmheephfjuagmhdycwlabgupbwrgo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/main.tsp b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/main.tsp new file mode 100644 index 000000000000..338bec04a160 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/main.tsp @@ -0,0 +1,199 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticLoadBalancingV2LoadBalancers ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Load Balancing V2 Load Balancer", + plural: "Elastic Load Balancing V2 Load Balancers", + }, + keywords: [ + "Microsoft.AwsConnector", + "Elastic", + "Load", + "Balancing", + "V2", + "Load", + "Balancer" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticLoadBalancingV2LoadBalancer + is TrackedResource<ElasticLoadBalancingV2LoadBalancerProperties> { + @doc("Name of ElasticLoadBalancingV2LoadBalancer") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticLoadBalancingV2LoadBalancers") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticLoadBalancingV2LoadBalancer") +model ElasticLoadBalancingV2LoadBalancerProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticLoadBalancingV2LoadBalancerProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticLoadBalancingV2LoadBalancer") +model AwsElasticLoadBalancingV2LoadBalancerProperties { + @doc("Property canonicalHostedZoneID") + canonicalHostedZoneID?: string; + + @doc("Property dnsName") + dnsName?: string; + + @doc("Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink.") + enforceSecurityGroupInboundRulesOnPrivateLinkTraffic?: string; + + @doc("The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener.") + ipAddressType?: string; + + @doc("Property loadBalancerArn") + loadBalancerArn?: string; + + @doc("The load balancer attributes.") + @extension("x-ms-identifiers", []) + loadBalancerAttributes?: LoadBalancerAttribute[]; + + @doc("Property loadBalancerFullName") + loadBalancerFullName?: string; + + @doc("Property loadBalancerName") + loadBalancerName?: string; + + @doc("The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name.") + name?: string; + + @doc("The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer.") + scheme?: string; + + @doc("[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.") + @extension("x-ms-identifiers", []) + securityGroups?: string[]; + + @doc("The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.") + @extension("x-ms-identifiers", []) + subnetMappings?: SubnetMapping[]; + + @doc("The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.") + @extension("x-ms-identifiers", []) + subnets?: string[]; + + @doc("The tags to assign to the load balancer.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The type of load balancer. The default is ``application``.") + type?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoadBalancerAttribute") +model LoadBalancerAttribute { + @doc("The name of the attribute. The following attributes are supported by all load balancers: + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. The following attributes are supported by only Network Load Balancers: + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity.") + key?: string; + + @doc("The value of the attribute.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SubnetMapping") +model SubnetMapping { + @doc("[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.") + allocationId?: string; + + @doc("[Network Load Balancers] The IPv6 address.") + iPv6Address?: string; + + @doc("[Network Load Balancers] The private IPv4 address for an internal load balancer.") + privateIPv4Address?: string; + + @doc("The ID of the subnet.") + subnetId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key of the tag.") + key?: string; + + @doc("The value of the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticLoadBalancingV2LoadBalancers { + get is ArmResourceRead<ElasticLoadBalancingV2LoadBalancer>; + @doc("Create a ElasticLoadBalancingV2LoadBalancer. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticLoadBalancingV2LoadBalancer>; + update is ArmCustomPatchAsync< + ElasticLoadBalancingV2LoadBalancer, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticLoadBalancingV2LoadBalancer> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticLoadBalancingV2LoadBalancer>; + listByResourceGroup is ArmResourceListByParent<ElasticLoadBalancingV2LoadBalancer>; + listBySubscription is ArmListBySubscription<ElasticLoadBalancingV2LoadBalancer>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticLoadBalancingV2::LoadBalancer +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/tspconfig.yaml b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/tspconfig.yaml new file mode 100644 index 000000000000..1d79314265e6 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2LoadBalancer.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticLoadBalancingV2LoadBalancer.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json new file mode 100644 index 000000000000..39d5ef0319ed --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2TargetGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + } + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Delete.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Delete.json new file mode 100644 index 000000000000..aa3424591544 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Delete", + "operationId": "ElasticLoadBalancingV2TargetGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Get.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Get.json new file mode 100644 index 000000000000..d1f7ea6f2765 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Get.json @@ -0,0 +1,89 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Get", + "operationId": "ElasticLoadBalancingV2TargetGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..28aa45d660bb --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json new file mode 100644 index 000000000000..709559e1172e --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_ListBySubscription", + "operationId": "ElasticLoadBalancingV2TargetGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Update.json b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Update.json new file mode 100644 index 000000000000..176a4488ff71 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/examples/2024-12-01/ElasticLoadBalancingV2TargetGroups_Update.json @@ -0,0 +1,99 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Update", + "operationId": "ElasticLoadBalancingV2TargetGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2200": "sfyiwfoulfuntkhqpphpfjfcnqqjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/main.tsp b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/main.tsp new file mode 100644 index 000000000000..0c91ace4466a --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/main.tsp @@ -0,0 +1,232 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticLoadBalancingV2TargetGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Load Balancing V2 Target Group", + plural: "Elastic Load Balancing V2 Target Groups", + }, + keywords: [ + "Microsoft.AwsConnector", + "Elastic", + "Load", + "Balancing", + "V2", + "Target", + "Group" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticLoadBalancingV2TargetGroup + is TrackedResource<ElasticLoadBalancingV2TargetGroupProperties> { + @doc("Name of ElasticLoadBalancingV2TargetGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticLoadBalancingV2TargetGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticLoadBalancingV2TargetGroup") +model ElasticLoadBalancingV2TargetGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticLoadBalancingV2TargetGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticLoadBalancingV2TargetGroup") +model AwsElasticLoadBalancingV2TargetGroupProperties { + @doc("Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled.") + healthCheckEnabled?: boolean; + + @doc("The approximate amount of time, in seconds, between health checks of an individual target.") + healthCheckIntervalSeconds?: int32; + + @doc("[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck.") + healthCheckPath?: string; + + @doc("The port the load balancer uses when performing health checks on targets.") + healthCheckPort?: string; + + @doc("The protocol the load balancer uses when performing health checks on targets.") + healthCheckProtocol?: string; + + @doc("The amount of time, in seconds, during which no response from a target means a failed health check.") + healthCheckTimeoutSeconds?: int32; + + @doc("The number of consecutive health checks successes required before considering an unhealthy target healthy.") + healthyThresholdCount?: int32; + + @doc("The type of IP address used for this target group. The possible values are ipv4 and ipv6.") + ipAddressType?: string; + + @doc("The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.") + @extension("x-ms-identifiers", []) + loadBalancerArns?: string[]; + + @doc("[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target.") + matcher?: Matcher; + + @doc("The name of the target group.") + name?: string; + + @doc("The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.") + port?: int32; + + @doc("The protocol to use for routing traffic to the targets.") + protocol?: string; + + @doc("[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2.") + protocolVersion?: string; + + @doc("The tags.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The ARN of the Target Group") + targetGroupArn?: string; + + @doc("The attributes.") + @extension("x-ms-identifiers", []) + targetGroupAttributes?: TargetGroupAttribute[]; + + @doc("The full name of the target group.") + targetGroupFullName?: string; + + @doc("The name of the target group.") + targetGroupName?: string; + + @doc("The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.") + targetType?: string; + + @doc("The targets.") + @extension("x-ms-identifiers", []) + targets?: TargetDescription[]; + + @doc("The number of consecutive health check failures required before considering a target unhealthy.") + unhealthyThresholdCount?: int32; + + @doc("The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Matcher") +model Matcher { + @doc("You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12.") + grpcCode?: string; + + @doc("For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values.") + httpCode?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The value for the tag.") + key?: string; + + @doc("The key name of the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetGroupAttribute") +model TargetGroupAttribute { + @doc("The value of the attribute.") + key?: string; + + @doc("The name of the attribute.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetDescription") +model TargetDescription { + @doc("An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.") + availabilityZone?: string; + + @doc("The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.") + id?: string; + + @doc("The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.") + port?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticLoadBalancingV2TargetGroups { + get is ArmResourceRead<ElasticLoadBalancingV2TargetGroup>; + @doc("Create a ElasticLoadBalancingV2TargetGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticLoadBalancingV2TargetGroup>; + update is ArmCustomPatchAsync< + ElasticLoadBalancingV2TargetGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticLoadBalancingV2TargetGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticLoadBalancingV2TargetGroup>; + listByResourceGroup is ArmResourceListByParent<ElasticLoadBalancingV2TargetGroup>; + listBySubscription is ArmListBySubscription<ElasticLoadBalancingV2TargetGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::ElasticLoadBalancingV2::TargetGroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/tspconfig.yaml b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..5cf812d88f2c --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingV2TargetGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticLoadBalancingV2TargetGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json new file mode 100644 index 000000000000..ec514952fa18 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + } + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json new file mode 100644 index 000000000000..94c3ea742b82 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Delete", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json new file mode 100644 index 000000000000..1250deb97c4d --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json @@ -0,0 +1,68 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Get", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..53d717f7f046 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json new file mode 100644 index 000000000000..f7c5299c3684 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json new file mode 100644 index 000000000000..2a8173f218cb --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/examples/2024-12-01/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Update", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5261": "sfmsrb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/main.tsp b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/main.tsp new file mode 100644 index 000000000000..ce73f2fc7bb8 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/main.tsp @@ -0,0 +1,296 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- ElasticLoadBalancingv2TargetHealthDescriptions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Elastic Load Balancing v2 Target Health Description", + plural: "Elastic Load Balancing v2 Target Health Descriptions", + }, + keywords: [ + "Microsoft.AwsConnector", + "Elastic ", + "Load ", + "Balancing v2", + "Target", + "Health", + "Description" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model ElasticLoadBalancingv2TargetHealthDescription + is TrackedResource<ElasticLoadBalancingv2TargetHealthDescriptionProperties> { + @doc("Name of ElasticLoadBalancingv2TargetHealthDescription") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("elasticLoadBalancingV2TargetHealthDescriptions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ElasticLoadBalancingv2TargetHealthDescription") +model ElasticLoadBalancingv2TargetHealthDescriptionProperties { + @doc("AWS Properties") + awsProperties?: AwsElasticLoadBalancingv2TargetHealthDescriptionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsElasticLoadBalancingv2TargetHealthDescription") +model AwsElasticLoadBalancingv2TargetHealthDescriptionProperties { + @doc("<p>The anomaly detection result for the target.</p> <p>If no anomalies were detected, the result is <code>normal</code>.</p> <p>If anomalies were detected, the result is <code>anomalous</code>.</p>") + anomalyDetection?: AnomalyDetection; + + @doc("<p>The port to use to connect with the target.</p>") + healthCheckPort?: string; + + @doc("<p>The description of the target.</p>") + target?: TargetDescription; + + @doc("<p>The health information for the target.</p>") + targetHealth?: TargetHealth; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AnomalyDetection") +model AnomalyDetection { + @doc("<p>Indicates whether anomaly mitigation is in progress.</p>") + mitigationInEffect?: MitigationInEffectEnumEnumValue; + + @doc("<p>The latest anomaly detection result.</p>") + result?: AnomalyResultEnumEnumValue; +} + +@doc("MitigationInEffectEnum enum") +union MitigationInEffectEnum { + @doc("MitigationInEffectEnum enum no") + No: "no", + + @doc("MitigationInEffectEnum enum yes") + Yes: "yes", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MitigationInEffectEnumEnumValue") +model MitigationInEffectEnumEnumValue { + @doc("Property value") + value?: MitigationInEffectEnum; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetDescription") +model TargetDescription { + @doc("<p>An Availability Zone or <code>all</code>. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.</p> <p>For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as <code>all</code>.</p> <p>This parameter is not supported if the target type of the target group is <code>instance</code> or <code>alb</code>.</p> <p>If the target type is <code>ip</code> and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.</p> <p>For Application Load Balancer target groups with cross-zone load balancing off, if the target type is <code>ip</code> and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.</p> <p>If the target type is <code>lambda</code>, this parameter is optional and the only supported value is <code>all</code>.</p>") + availabilityZone?: string; + + @doc("<p>The ID of the target. If the target type of the target group is <code>instance</code>, specify an instance ID. If the target type is <code>ip</code>, specify an IP address. If the target type is <code>lambda</code>, specify the ARN of the Lambda function. If the target type is <code>alb</code>, specify the ARN of the Application Load Balancer target. </p>") + id?: string; + + @doc("<p>The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is <code>alb</code>, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.</p>") + port?: int32; +} + +@doc("AnomalyResultEnum enum") +union AnomalyResultEnum { + @doc("AnomalyResultEnum enum anomalous") + Anomalous: "anomalous", + + @doc("AnomalyResultEnum enum normal") + Normal: "normal", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AnomalyResultEnumEnumValue") +model AnomalyResultEnumEnumValue { + @doc("Property value") + value?: AnomalyResultEnum; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetHealth") +model TargetHealth { + @doc("<p>A description of the target health that provides additional details. If the state is <code>healthy</code>, a description is not provided.</p>") + description?: string; + + @doc("<p>The reason code.</p> <p>If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The load balancer received an error while establishing a connection to the target or the target response was malformed.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error. Applies only to Application Load Balancers.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> <li> <p> <code>Target.IpUnusable</code> - The target IP address is reserved for use by a load balancer.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul> <p>If the target state is <code>unavailable</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.HealthCheckDisabled</code> - Health checks are disabled for the target group. Applies only to Application Load Balancers.</p> </li> <li> <p> <code>Elb.InternalError</code> - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.</p> </li> </ul>") + reason?: TargetHealthReasonEnumEnumValue; + + @doc("<p>The state of the target.</p>") + state?: TargetHealthStateEnumEnumValue; +} + +@doc("TargetHealthReasonEnum enum") +union TargetHealthReasonEnum { + @doc("TargetHealthReasonEnum enum Elb.InitialHealthChecking") + ElbInitialHealthChecking: "Elb.InitialHealthChecking", + + @doc("TargetHealthReasonEnum enum Elb.InternalError") + ElbInternalError: "Elb.InternalError", + + @doc("TargetHealthReasonEnum enum Elb.RegistrationInProgress") + ElbRegistrationInProgress: "Elb.RegistrationInProgress", + + @doc("TargetHealthReasonEnum enum Target.DeregistrationInProgress") + TargetDeregistrationInProgress: "Target.DeregistrationInProgress", + + @doc("TargetHealthReasonEnum enum Target.FailedHealthChecks") + TargetFailedHealthChecks: "Target.FailedHealthChecks", + + @doc("TargetHealthReasonEnum enum Target.HealthCheckDisabled") + TargetHealthCheckDisabled: "Target.HealthCheckDisabled", + + @doc("TargetHealthReasonEnum enum Target.InvalidState") + TargetInvalidState: "Target.InvalidState", + + @doc("TargetHealthReasonEnum enum Target.IpUnusable") + TargetIpUnusable: "Target.IpUnusable", + + @doc("TargetHealthReasonEnum enum Target.NotInUse") + TargetNotInUse: "Target.NotInUse", + + @doc("TargetHealthReasonEnum enum Target.NotRegistered") + TargetNotRegistered: "Target.NotRegistered", + + @doc("TargetHealthReasonEnum enum Target.ResponseCodeMismatch") + TargetResponseCodeMismatch: "Target.ResponseCodeMismatch", + + @doc("TargetHealthReasonEnum enum Target.Timeout") + TargetTimeout: "Target.Timeout", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetHealthReasonEnumEnumValue") +model TargetHealthReasonEnumEnumValue { + @doc("Property value") + value?: TargetHealthReasonEnum; +} + +@doc("TargetHealthStateEnum enum") +union TargetHealthStateEnum { + @doc("TargetHealthStateEnum enum draining") + Draining: "draining", + + @doc("TargetHealthStateEnum enum healthy") + Healthy: "healthy", + + @doc("TargetHealthStateEnum enum initial") + Initial: "initial", + + @doc("TargetHealthStateEnum enum unavailable") + Unavailable: "unavailable", + + @doc("TargetHealthStateEnum enum unhealthy") + Unhealthy: "unhealthy", + + @doc("TargetHealthStateEnum enum unhealthy.draining") + UnhealthyDraining: "unhealthy.draining", + + @doc("TargetHealthStateEnum enum unused") + Unused: "unused", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetHealthStateEnumEnumValue") +model TargetHealthStateEnumEnumValue { + @doc("Property value") + value?: TargetHealthStateEnum; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface ElasticLoadBalancingv2TargetHealthDescriptions { + get is ArmResourceRead<ElasticLoadBalancingv2TargetHealthDescription>; + @doc("Create a ElasticLoadBalancingv2TargetHealthDescription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<ElasticLoadBalancingv2TargetHealthDescription>; + update is ArmCustomPatchAsync< + ElasticLoadBalancingv2TargetHealthDescription, + Azure.ResourceManager.Foundations.TagsUpdateModel<ElasticLoadBalancingv2TargetHealthDescription> + >; + delete is ArmResourceDeleteWithoutOkAsync<ElasticLoadBalancingv2TargetHealthDescription>; + listByResourceGroup is ArmResourceListByParent<ElasticLoadBalancingv2TargetHealthDescription>; + listBySubscription is ArmListBySubscription<ElasticLoadBalancingv2TargetHealthDescription>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\elasticloadbalancingv2\elasticloadbalancingv2-2015-12-01.normal.json +// AWS Shape: TargetHealthDescription +// +// Related information for backend service: +// AWS Servcie : Elastic Load Balancing v2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.39 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/tspconfig.yaml b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/tspconfig.yaml new file mode 100644 index 000000000000..efb422a0c3e3 --- /dev/null +++ b/specification/awsconnector/ElasticLoadBalancingv2TargetHealthDescription.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/elasticLoadBalancingV2TargetHealthDescription.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_CreateOrReplace.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_CreateOrReplace.json new file mode 100644 index 000000000000..42e13af6e0eb --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_CreateOrReplace.json @@ -0,0 +1,469 @@ +{ + "title": "EmrClusters_CreateOrReplace", + "operationId": "EmrClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + } + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + } + } +} diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Delete.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Delete.json new file mode 100644 index 000000000000..671accfe5c87 --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EmrClusters_Delete", + "operationId": "EmrClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Get.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Get.json new file mode 100644 index 000000000000..ba87d34d476c --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Get.json @@ -0,0 +1,168 @@ +{ + "title": "EmrClusters_Get", + "operationId": "EmrClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + } + } +} diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListByResourceGroup.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..ea7f8ce172f7 --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListByResourceGroup.json @@ -0,0 +1,172 @@ +{ + "title": "EmrClusters_ListByResourceGroup", + "operationId": "EmrClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListBySubscription.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListBySubscription.json new file mode 100644 index 000000000000..45b4a741b604 --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_ListBySubscription.json @@ -0,0 +1,171 @@ +{ + "title": "EmrClusters_ListBySubscription", + "operationId": "EmrClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Update.json b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Update.json new file mode 100644 index 000000000000..573755cd4914 --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/examples/2024-12-01/EmrClusters_Update.json @@ -0,0 +1,178 @@ +{ + "title": "EmrClusters_Update", + "operationId": "EmrClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1560": "gzdvjynwqlvywjwutal" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EmrCluster.Management/main.tsp b/specification/awsconnector/EmrCluster.Management/main.tsp new file mode 100644 index 000000000000..24398430977e --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/main.tsp @@ -0,0 +1,598 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EmrClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EMR Cluster", + plural: "EMR Clusters", + }, + keywords: ["Microsoft.AwsConnector", "EMR", "Cluster"], +}) +@doc("A Microsoft.AwsConnector resource") +model EmrCluster is TrackedResource<EmrClusterProperties> { + @doc("Name of EmrCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("emrClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EmrCluster") +model EmrClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsEmrClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEmrCluster") +model AwsEmrClusterProperties { + @doc("<p>The applications installed on this cluster.</p>") + @extension("x-ms-identifiers", []) + applications?: Application[]; + + @doc("<p>An IAM role for automatic scaling policies. The default role is <code>EMR_AutoScaling_DefaultRole</code>. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.</p>") + autoScalingRole?: string; + + @doc("<p>Specifies whether the cluster should terminate after completing all steps.</p>") + autoTerminate?: boolean; + + @doc("<p>The Amazon Resource Name of the cluster.</p>") + clusterArn?: string; + + @doc("<p>Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.</p>") + @extension("x-ms-identifiers", []) + configurations?: Configuration[]; + + @doc("<p>Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.</p>") + customAmiId?: string; + + @doc("<p>The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.</p>") + ebsRootVolumeIops?: int32; + + @doc("<p>The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.</p>") + ebsRootVolumeSize?: int32; + + @doc("<p>The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.</p>") + ebsRootVolumeThroughput?: int32; + + @doc("<p>Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.</p>") + ec2InstanceAttributes?: Ec2InstanceAttributes; + + @doc("<p>The unique identifier for the cluster.</p>") + id?: string; + + @doc("<note> <p>The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.</p> </note> <p>The instance group configuration of the cluster. A value of <code>INSTANCE_GROUP</code> indicates a uniform instance group configuration. A value of <code>INSTANCE_FLEET</code> indicates an instance fleets configuration.</p>") + instanceCollectionType?: InstanceCollectionTypeEnumValue; + + @doc("<p>Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html'>Use Kerberos Authentication</a> in the <i>Amazon EMR Management Guide</i>.</p>") + kerberosAttributes?: KerberosAttributes; + + @doc("<p> The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. </p>") + logEncryptionKmsKeyId?: string; + + @doc("<p>The path to the Amazon S3 location where logs for this cluster are stored.</p>") + logUri?: string; + + @doc("<p>The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.</p>") + masterPublicDnsName?: string; + + @doc("<p>The name of the cluster. This parameter can't contain the characters <, >, $, |, or ` (backtick).</p>") + name?: string; + + @doc("<p>An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.</p>") + normalizedInstanceHours?: int32; + + @doc("<p>The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.</p>") + osReleaseLabel?: string; + + @doc("<p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>") + outpostArn?: string; + + @doc("<p>Placement group configured for an Amazon EMR cluster.</p>") + @extension("x-ms-identifiers", []) + placementGroups?: PlacementGroupConfig[]; + + @doc("<p>The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version such as <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href='https://docs.aws.amazon.com/emr/latest/ReleaseGuide/'>https://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use <code>AmiVersion</code>.</p>") + releaseLabel?: string; + + @doc("<p>Applies only when <code>CustomAmiID</code> is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.</p>") + repoUpgradeOnBoot?: RepoUpgradeOnBootEnumValue; + + @doc("<p>The AMI version requested for this cluster.</p>") + requestedAmiVersion?: string; + + @doc("<p>The AMI version running on this cluster.</p>") + runningAmiVersion?: string; + + @doc("<p>The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. <code>TERMINATE_AT_INSTANCE_HOUR</code> indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. <code>TERMINATE_AT_TASK_COMPLETION</code> indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. <code>TERMINATE_AT_TASK_COMPLETION</code> is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.</p>") + scaleDownBehavior?: ScaleDownBehaviorEnumValue; + + @doc("<p>The name of the security configuration applied to the cluster.</p>") + securityConfiguration?: string; + + @doc("<p>The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.</p>") + serviceRole?: string; + + @doc("<p>The current status details about the cluster.</p>") + status?: ClusterStatus; + + @doc("<p>Specifies the number of steps that can be executed concurrently.</p>") + stepConcurrencyLevel?: int32; + + @doc("<p>A list of tags associated with a cluster.</p>") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("<p>Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.</p>") + terminationProtected?: boolean; + + @doc("<p>Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.</p>") + unhealthyNodeReplacement?: boolean; + + @doc("<p>Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When <code>true</code>, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p> <p>The default value is <code>true</code> if a value is not provided when creating a cluster using the Amazon EMR API <a>RunJobFlow</a> command, the CLI <a href='https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html'>create-cluster</a> command, or the Amazon Web Services Management Console.</p>") + visibleToAllUsers?: boolean; +} + +@doc("InstanceCollectionType enum") +union InstanceCollectionType { + @doc("InstanceCollectionType enum INSTANCE_FLEET") + INSTANCE_FLEET: "INSTANCE_FLEET", + + @doc("InstanceCollectionType enum INSTANCE_GROUP") + INSTANCE_GROUP: "INSTANCE_GROUP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceCollectionTypeEnumValue") +model InstanceCollectionTypeEnumValue { + @doc("Property value") + value?: InstanceCollectionType; +} + +@doc("ScaleDownBehavior enum") +union ScaleDownBehavior { + @doc("ScaleDownBehavior enum TERMINATE_AT_INSTANCE_HOUR") + TERMINATE_AT_INSTANCE_HOUR: "TERMINATE_AT_INSTANCE_HOUR", + + @doc("ScaleDownBehavior enum TERMINATE_AT_TASK_COMPLETION") + TERMINATE_AT_TASK_COMPLETION: "TERMINATE_AT_TASK_COMPLETION", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ScaleDownBehaviorEnumValue") +model ScaleDownBehaviorEnumValue { + @doc("Property value") + value?: ScaleDownBehavior; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Application") +model Application { + @doc("<p>This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.</p>") + additionalInfo?: Record<string>; + + @doc("<p>Arguments for Amazon EMR to pass to the application.</p>") + @extension("x-ms-identifiers", []) + args?: string[]; + + @doc("<p>The name of the application.</p>") + name?: string; + + @doc("<p>The version of the application.</p>") + version?: string; +} + +@doc("RepoUpgradeOnBoot enum") +union RepoUpgradeOnBoot { + @doc("RepoUpgradeOnBoot enum NONE") + NONE: "NONE", + + @doc("RepoUpgradeOnBoot enum SECURITY") + SECURITY: "SECURITY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RepoUpgradeOnBootEnumValue") +model RepoUpgradeOnBootEnumValue { + @doc("Property value") + value?: RepoUpgradeOnBoot; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Configuration") +model Configuration { + @doc("<p>The classification within a configuration.</p>") + classification?: string; + + @doc("<p>A list of additional configurations to apply within a configuration object.</p>") + @extension("x-ms-identifiers", []) + configurations?: Configuration[]; + + @doc("<p>A set of properties specified within a configuration classification.</p>") + properties?: Record<string>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Ec2InstanceAttributes") +model Ec2InstanceAttributes { + @doc("<p>A list of additional Amazon EC2 security group IDs for the master node.</p>") + @extension("x-ms-identifiers", []) + additionalMasterSecurityGroups?: string[]; + + @doc("<p>A list of additional Amazon EC2 security group IDs for the core and task nodes.</p>") + @extension("x-ms-identifiers", []) + additionalSlaveSecurityGroups?: string[]; + + @doc("<p>The Availability Zone in which the cluster will run. </p>") + ec2AvailabilityZone?: string; + + @doc("<p>The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named 'hadoop'.</p>") + ec2KeyName?: string; + + @doc("<p>Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.</p>") + ec2SubnetId?: string; + + @doc("<p>The identifier of the Amazon EC2 security group for the master node.</p>") + emrManagedMasterSecurityGroup?: string; + + @doc("<p>The identifier of the Amazon EC2 security group for the core and task nodes.</p>") + emrManagedSlaveSecurityGroup?: string; + + @doc("<p>The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.</p>") + iamInstanceProfile?: string; + + @doc("<p>Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of <code>RequestedEc2AvailabilityZones</code>, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>") + @extension("x-ms-identifiers", []) + requestedEc2AvailabilityZones?: string[]; + + @doc("<p>Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of <code>RequestedEc2SubnetIds</code>, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses <code>RequestedEc2AvailabilityZones</code> instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>") + @extension("x-ms-identifiers", []) + requestedEc2SubnetIds?: string[]; + + @doc("<p>The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.</p>") + serviceAccessSecurityGroup?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KerberosAttributes") +model KerberosAttributes { + @doc("<p>The Active Directory password for <code>ADDomainJoinUser</code>.</p>") + adDomainJoinPassword?: string; + + @doc("<p>Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.</p>") + adDomainJoinUser?: string; + + @doc("<p>Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.</p>") + crossRealmTrustPrincipalPassword?: string; + + @doc("<p>The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.</p>") + kdcAdminPassword?: string; + + @doc("<p>The name of the Kerberos realm to which all nodes in a cluster belong. For example, <code>EC2.INTERNAL</code>. </p>") + realm?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlacementGroupConfig") +model PlacementGroupConfig { + @doc("<p>Role of the instance in the cluster.</p> <p>Starting with Amazon EMR release 5.23.0, the only supported instance role is <code>MASTER</code>.</p>") + instanceRole?: InstanceRoleTypeEnumValue; + + @doc("<p>Amazon EC2 Placement Group strategy associated with instance role.</p> <p>Starting with Amazon EMR release 5.23.0, the only supported placement strategy is <code>SPREAD</code> for the <code>MASTER</code> instance role.</p>") + placementStrategy?: PlacementGroupStrategyEnumValue; +} + +@doc("InstanceRoleType enum") +union InstanceRoleType { + @doc("InstanceRoleType enum CORE") + CORE: "CORE", + + @doc("InstanceRoleType enum MASTER") + MASTER: "MASTER", + + @doc("InstanceRoleType enum TASK") + TASK: "TASK", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceRoleTypeEnumValue") +model InstanceRoleTypeEnumValue { + @doc("Property value") + value?: InstanceRoleType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStatus") +model ClusterStatus { + @doc("<p>A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different <code>ErrorDetail</code> tuples.</p>") + @extension("x-ms-identifiers", []) + errorDetails?: ErrorDetail[]; + + @doc("<p>The current state of the cluster.</p>") + state?: ClusterStateEnumValue; + + @doc("<p>The reason for the cluster status change.</p>") + stateChangeReason?: ClusterStateChangeReason; + + @doc("<p>A timeline that represents the status of a cluster over the lifetime of the cluster.</p>") + timeline?: ClusterTimeline; +} + +@doc("PlacementGroupStrategy enum") +union PlacementGroupStrategy { + @doc("PlacementGroupStrategy enum CLUSTER") + CLUSTER: "CLUSTER", + + @doc("PlacementGroupStrategy enum NONE") + NONE: "NONE", + + @doc("PlacementGroupStrategy enum PARTITION") + PARTITION: "PARTITION", + + @doc("PlacementGroupStrategy enum SPREAD") + SPREAD: "SPREAD", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlacementGroupStrategyEnumValue") +model PlacementGroupStrategyEnumValue { + @doc("Property value") + value?: PlacementGroupStrategy; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>A user-defined key, which is the minimum required information for a valid tag. For more information, see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html'>Tag</a>. </p>") + key?: string; + + @doc("<p>A user-defined value, which is optional in a tag. For more information, see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html'>Tag Clusters</a>. </p>") + value?: string; +} + +@doc("ClusterState enum") +union ClusterState { + @doc("ClusterState enum BOOTSTRAPPING") + BOOTSTRAPPING: "BOOTSTRAPPING", + + @doc("ClusterState enum RUNNING") + RUNNING: "RUNNING", + + @doc("ClusterState enum STARTING") + STARTING: "STARTING", + + @doc("ClusterState enum TERMINATED") + TERMINATED: "TERMINATED", + + @doc("ClusterState enum TERMINATED_WITH_ERRORS") + TERMINATED_WITH_ERRORS: "TERMINATED_WITH_ERRORS", + + @doc("ClusterState enum TERMINATING") + TERMINATING: "TERMINATING", + + @doc("ClusterState enum WAITING") + WAITING: "WAITING", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateEnumValue") +model ClusterStateEnumValue { + @doc("Property value") + value?: ClusterState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ErrorDetail") +model ErrorDetail { + @doc("<p>The name or code associated with the error.</p>") + errorCode?: string; + + @doc("<p>A list of key value pairs that provides contextual information about why an error occured.</p>") + @extension("x-ms-identifiers", []) + errorData?: StringMap[]; + + @doc("<p>A message that describes the error.</p>") + errorMessage?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateChangeReason") +model ClusterStateChangeReason { + @doc("<p>The programmatic code for the state change reason.</p>") + code?: ClusterStateChangeReasonCodeEnumValue; + + @doc("<p>The descriptive message for the state change reason.</p>") + message?: string; +} + +@doc("ClusterStateChangeReasonCode enum") +union ClusterStateChangeReasonCode { + @doc("ClusterStateChangeReasonCode enum ALL_STEPS_COMPLETED") + ALL_STEPS_COMPLETED: "ALL_STEPS_COMPLETED", + + @doc("ClusterStateChangeReasonCode enum BOOTSTRAP_FAILURE") + BOOTSTRAP_FAILURE: "BOOTSTRAP_FAILURE", + + @doc("ClusterStateChangeReasonCode enum INSTANCE_FAILURE") + INSTANCE_FAILURE: "INSTANCE_FAILURE", + + @doc("ClusterStateChangeReasonCode enum INSTANCE_FLEET_TIMEOUT") + INSTANCE_FLEET_TIMEOUT: "INSTANCE_FLEET_TIMEOUT", + + @doc("ClusterStateChangeReasonCode enum INTERNAL_ERROR") + INTERNAL_ERROR: "INTERNAL_ERROR", + + @doc("ClusterStateChangeReasonCode enum STEP_FAILURE") + STEP_FAILURE: "STEP_FAILURE", + + @doc("ClusterStateChangeReasonCode enum USER_REQUEST") + USER_REQUEST: "USER_REQUEST", + + @doc("ClusterStateChangeReasonCode enum VALIDATION_ERROR") + VALIDATION_ERROR: "VALIDATION_ERROR", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateChangeReasonCodeEnumValue") +model ClusterStateChangeReasonCodeEnumValue { + @doc("Property value") + value?: ClusterStateChangeReasonCode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterTimeline") +model ClusterTimeline { + @doc("<p>The creation date and time of the cluster.</p>") + creationDateTime?: utcDateTime; + + @doc("<p>The date and time when the cluster was terminated.</p>") + endDateTime?: utcDateTime; + + @doc("<p>The date and time when the cluster was ready to run steps.</p>") + readyDateTime?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StringMap") +model StringMap {} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EmrClusters { + get is ArmResourceRead<EmrCluster>; + @doc("Create a EmrCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EmrCluster>; + update is ArmCustomPatchAsync< + EmrCluster, + Azure.ResourceManager.Foundations.TagsUpdateModel<EmrCluster> + >; + delete is ArmResourceDeleteWithoutOkAsync<EmrCluster>; + listByResourceGroup is ArmResourceListByParent<EmrCluster>; + listBySubscription is ArmListBySubscription<EmrCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\elasticmapreduce\elasticmapreduce-2009-03-31.normal.json +// AWS Shape: Cluster +// +// Related information for backend service: +// AWS Servcie : EMR +// Product Version : 3.7.798.0 +// SDK Version : 3.7.304.31 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EmrCluster.Management/tspconfig.yaml b/specification/awsconnector/EmrCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..f36dd47e2deb --- /dev/null +++ b/specification/awsconnector/EmrCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/emrCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_CreateOrReplace.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..2b26aeeca733 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_CreateOrReplace.json @@ -0,0 +1,190 @@ +{ + "title": "EmrClusterSummaries_CreateOrReplace", + "operationId": "EmrClusterSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + } + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + } + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Delete.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Delete.json new file mode 100644 index 000000000000..eec088dc07d8 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EmrClusterSummaries_Delete", + "operationId": "EmrClusterSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Get.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Get.json new file mode 100644 index 000000000000..b6cb16398033 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Get.json @@ -0,0 +1,75 @@ +{ + "title": "EmrClusterSummaries_Get", + "operationId": "EmrClusterSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + } + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListByResourceGroup.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..902b984a2e32 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListByResourceGroup.json @@ -0,0 +1,79 @@ +{ + "title": "EmrClusterSummaries_ListByResourceGroup", + "operationId": "EmrClusterSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListBySubscription.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListBySubscription.json new file mode 100644 index 000000000000..60f8a68d0d17 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "title": "EmrClusterSummaries_ListBySubscription", + "operationId": "EmrClusterSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Update.json b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Update.json new file mode 100644 index 000000000000..e5276e931ce7 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/examples/2024-12-01/EmrClusterSummaries_Update.json @@ -0,0 +1,85 @@ +{ + "title": "EmrClusterSummaries_Update", + "operationId": "EmrClusterSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1151": "meekyuohznsay" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/EmrClusterSummary.Management/main.tsp b/specification/awsconnector/EmrClusterSummary.Management/main.tsp new file mode 100644 index 000000000000..b0082e187f11 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/main.tsp @@ -0,0 +1,267 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- EmrClusterSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "EMR Cluster Summary", + plural: "EMR Cluster Summaries", + }, + keywords: ["Microsoft.AwsConnector", "EMR", "Cluster", "Summary"], +}) +@doc("A Microsoft.AwsConnector resource") +model EmrClusterSummary is TrackedResource<EmrClusterSummaryProperties> { + @doc("Name of EmrClusterSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("emrClusterSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EmrClusterSummary") +model EmrClusterSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsEmrClusterSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsEmrClusterSummary") +model AwsEmrClusterSummaryProperties { + @doc("<p>The Amazon Resource Name of the cluster.</p>") + clusterArn?: string; + + @doc("<p>The unique identifier for the cluster.</p>") + id?: string; + + @doc("<p>The name of the cluster.</p>") + name?: string; + + @doc("<p>An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.</p>") + normalizedInstanceHours?: int32; + + @doc("<p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>") + outpostArn?: string; + + @doc("<p>The details about the current status of the cluster.</p>") + status?: ClusterStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStatus") +model ClusterStatus { + @doc("<p>A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different <code>ErrorDetail</code> tuples.</p>") + @extension("x-ms-identifiers", []) + errorDetails?: ErrorDetail[]; + + @doc("<p>The current state of the cluster.</p>") + state?: ClusterStateEnumValue; + + @doc("<p>The reason for the cluster status change.</p>") + stateChangeReason?: ClusterStateChangeReason; + + @doc("<p>A timeline that represents the status of a cluster over the lifetime of the cluster.</p>") + timeline?: ClusterTimeline; +} + +@doc("ClusterState enum") +union ClusterState { + @doc("ClusterState enum BOOTSTRAPPING") + BOOTSTRAPPING: "BOOTSTRAPPING", + + @doc("ClusterState enum RUNNING") + RUNNING: "RUNNING", + + @doc("ClusterState enum STARTING") + STARTING: "STARTING", + + @doc("ClusterState enum TERMINATED") + TERMINATED: "TERMINATED", + + @doc("ClusterState enum TERMINATED_WITH_ERRORS") + TERMINATED_WITH_ERRORS: "TERMINATED_WITH_ERRORS", + + @doc("ClusterState enum TERMINATING") + TERMINATING: "TERMINATING", + + @doc("ClusterState enum WAITING") + WAITING: "WAITING", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateEnumValue") +model ClusterStateEnumValue { + @doc("Property value") + value?: ClusterState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ErrorDetail") +model ErrorDetail { + @doc("<p>The name or code associated with the error.</p>") + errorCode?: string; + + @doc("<p>A list of key value pairs that provides contextual information about why an error occured.</p>") + @extension("x-ms-identifiers", []) + errorData?: StringMap[]; + + @doc("<p>A message that describes the error.</p>") + errorMessage?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateChangeReason") +model ClusterStateChangeReason { + @doc("<p>The programmatic code for the state change reason.</p>") + code?: ClusterStateChangeReasonCodeEnumValue; + + @doc("<p>The descriptive message for the state change reason.</p>") + message?: string; +} + +@doc("ClusterStateChangeReasonCode enum") +union ClusterStateChangeReasonCode { + @doc("ClusterStateChangeReasonCode enum ALL_STEPS_COMPLETED") + ALL_STEPS_COMPLETED: "ALL_STEPS_COMPLETED", + + @doc("ClusterStateChangeReasonCode enum BOOTSTRAP_FAILURE") + BOOTSTRAP_FAILURE: "BOOTSTRAP_FAILURE", + + @doc("ClusterStateChangeReasonCode enum INSTANCE_FAILURE") + INSTANCE_FAILURE: "INSTANCE_FAILURE", + + @doc("ClusterStateChangeReasonCode enum INSTANCE_FLEET_TIMEOUT") + INSTANCE_FLEET_TIMEOUT: "INSTANCE_FLEET_TIMEOUT", + + @doc("ClusterStateChangeReasonCode enum INTERNAL_ERROR") + INTERNAL_ERROR: "INTERNAL_ERROR", + + @doc("ClusterStateChangeReasonCode enum STEP_FAILURE") + STEP_FAILURE: "STEP_FAILURE", + + @doc("ClusterStateChangeReasonCode enum USER_REQUEST") + USER_REQUEST: "USER_REQUEST", + + @doc("ClusterStateChangeReasonCode enum VALIDATION_ERROR") + VALIDATION_ERROR: "VALIDATION_ERROR", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterStateChangeReasonCodeEnumValue") +model ClusterStateChangeReasonCodeEnumValue { + @doc("Property value") + value?: ClusterStateChangeReasonCode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterTimeline") +model ClusterTimeline { + @doc("<p>The creation date and time of the cluster.</p>") + creationDateTime?: utcDateTime; + + @doc("<p>The date and time when the cluster was terminated.</p>") + endDateTime?: utcDateTime; + + @doc("<p>The date and time when the cluster was ready to run steps.</p>") + readyDateTime?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StringMap") +model StringMap {} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface EmrClusterSummaries { + get is ArmResourceRead<EmrClusterSummary>; + @doc("Create a EmrClusterSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<EmrClusterSummary>; + update is ArmCustomPatchAsync< + EmrClusterSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<EmrClusterSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<EmrClusterSummary>; + listByResourceGroup is ArmResourceListByParent<EmrClusterSummary>; + listBySubscription is ArmListBySubscription<EmrClusterSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\elasticmapreduce\elasticmapreduce-2009-03-31.normal.json +// AWS Shape: ClusterSummary +// +// Related information for backend service: +// AWS Servcie : EMR +// Product Version : 3.7.798.0 +// SDK Version : 3.7.304.31 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/EmrClusterSummary.Management/tspconfig.yaml b/specification/awsconnector/EmrClusterSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..54bf3ef7ab64 --- /dev/null +++ b/specification/awsconnector/EmrClusterSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/emrClusterSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_CreateOrReplace.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_CreateOrReplace.json new file mode 100644 index 000000000000..2b19b883fd53 --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "GuardDutyDetectors_CreateOrReplace", + "operationId": "GuardDutyDetectors_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + } + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + } + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Delete.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Delete.json new file mode 100644 index 000000000000..70070e7c4a2c --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "GuardDutyDetectors_Delete", + "operationId": "GuardDutyDetectors_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Get.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Get.json new file mode 100644 index 000000000000..5faca73476cb --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Get.json @@ -0,0 +1,81 @@ +{ + "title": "GuardDutyDetectors_Get", + "operationId": "GuardDutyDetectors_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + } + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListByResourceGroup.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListByResourceGroup.json new file mode 100644 index 000000000000..9531ce33fbca --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "GuardDutyDetectors_ListByResourceGroup", + "operationId": "GuardDutyDetectors_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + ], + "nextLink": "https://microsoft.com/aajhdrra" + } + } + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListBySubscription.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListBySubscription.json new file mode 100644 index 000000000000..eab5560a4770 --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "GuardDutyDetectors_ListBySubscription", + "operationId": "GuardDutyDetectors_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + ], + "nextLink": "https://microsoft.com/aajhdrra" + } + } + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Update.json b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Update.json new file mode 100644 index 000000000000..3e6474690ace --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/examples/2024-12-01/GuardDutyDetectors_Update.json @@ -0,0 +1,91 @@ +{ + "title": "GuardDutyDetectors_Update", + "operationId": "GuardDutyDetectors_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2754": "wadidsugspeyhxziareediaqw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/GuardDutyDetector.Management/main.tsp b/specification/awsconnector/GuardDutyDetector.Management/main.tsp new file mode 100644 index 000000000000..58acba76cf5d --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/main.tsp @@ -0,0 +1,235 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- GuardDutyDetectors ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Guard Duty Detector", + plural: "Guard Duty Detectors", + }, + keywords: ["Microsoft.AwsConnector", "Guard", "Duty", "Detector"], +}) +@doc("A Microsoft.AwsConnector resource") +model GuardDutyDetector is TrackedResource<GuardDutyDetectorProperties> { + @doc("Name of GuardDutyDetector") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("guardDutyDetectors") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GuardDutyDetector") +model GuardDutyDetectorProperties { + @doc("AWS Properties") + awsProperties?: AwsGuardDutyDetectorProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsGuardDutyDetector") +model AwsGuardDutyDetectorProperties { + @doc("Property dataSources") + dataSources?: CFNDataSourceConfigurations; + + @doc("Property enable") + enable?: boolean; + + @doc("Property features") + @extension("x-ms-identifiers", []) + features?: CFNFeatureConfiguration[]; + + @doc("Property findingPublishingFrequency") + findingPublishingFrequency?: string; + + @doc("Property id") + id?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: TagItem[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNDataSourceConfigurations") +model CFNDataSourceConfigurations { + @doc("Property kubernetes") + kubernetes?: CFNKubernetesConfiguration; + + @doc("Property malwareProtection") + malwareProtection?: CFNMalwareProtectionConfiguration; + + @doc("Property s3Logs") + s3Logs?: CFNS3LogsConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNFeatureConfiguration") +model CFNFeatureConfiguration { + @doc("Property additionalConfiguration") + @extension("x-ms-identifiers", []) + additionalConfiguration?: CFNFeatureAdditionalConfiguration[]; + + @doc("Property name") + name?: string; + + @doc("Property status") + status?: CFNFeatureConfigurationStatus; +} + +@doc("CFNFeatureConfigurationStatus enum") +union CFNFeatureConfigurationStatus { + @doc("CFNFeatureConfigurationStatus enum DISABLED") + DISABLED: "DISABLED", + + @doc("CFNFeatureConfigurationStatus enum ENABLED") + ENABLED: "ENABLED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TagItem") +model TagItem { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNKubernetesConfiguration") +model CFNKubernetesConfiguration { + @doc("Property auditLogs") + auditLogs?: CFNKubernetesAuditLogsConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNMalwareProtectionConfiguration") +model CFNMalwareProtectionConfiguration { + @doc("Property scanEc2InstanceWithFindings") + scanEc2InstanceWithFindings?: CFNScanEc2InstanceWithFindingsConfiguration; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNS3LogsConfiguration") +model CFNS3LogsConfiguration { + @doc("Property enable") + enable?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNFeatureAdditionalConfiguration") +model CFNFeatureAdditionalConfiguration { + @doc("Property name") + name?: string; + + @doc("Property status") + status?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNKubernetesAuditLogsConfiguration") +model CFNKubernetesAuditLogsConfiguration { + @doc("Property enable") + enable?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CFNScanEc2InstanceWithFindingsConfiguration") +model CFNScanEc2InstanceWithFindingsConfiguration { + @doc("Property ebsVolumes") + ebsVolumes?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface GuardDutyDetectors { + get is ArmResourceRead<GuardDutyDetector>; + @doc("Create a GuardDutyDetector. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<GuardDutyDetector>; + update is ArmCustomPatchAsync< + GuardDutyDetector, + Azure.ResourceManager.Foundations.TagsUpdateModel<GuardDutyDetector> + >; + delete is ArmResourceDeleteWithoutOkAsync<GuardDutyDetector>; + listByResourceGroup is ArmResourceListByParent<GuardDutyDetector>; + listBySubscription is ArmListBySubscription<GuardDutyDetector>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::GuardDuty::Detector +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/GuardDutyDetector.Management/tspconfig.yaml b/specification/awsconnector/GuardDutyDetector.Management/tspconfig.yaml new file mode 100644 index 000000000000..8040d722b26a --- /dev/null +++ b/specification/awsconnector/GuardDutyDetector.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/guardDutyDetector.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_CreateOrReplace.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_CreateOrReplace.json new file mode 100644 index 000000000000..52e282abf92a --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "IamAccessKeyLastUseds_CreateOrReplace", + "operationId": "IamAccessKeyLastUseds_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + } + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Delete.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Delete.json new file mode 100644 index 000000000000..b047d2483ebd --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamAccessKeyLastUseds_Delete", + "operationId": "IamAccessKeyLastUseds_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Get.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Get.json new file mode 100644 index 000000000000..291f1e2bc559 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Get.json @@ -0,0 +1,48 @@ +{ + "title": "IamAccessKeyLastUseds_Get", + "operationId": "IamAccessKeyLastUseds_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListByResourceGroup.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListByResourceGroup.json new file mode 100644 index 000000000000..c224aa5719d1 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "IamAccessKeyLastUseds_ListByResourceGroup", + "operationId": "IamAccessKeyLastUseds_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListBySubscription.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListBySubscription.json new file mode 100644 index 000000000000..ddb3d7128584 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "IamAccessKeyLastUseds_ListBySubscription", + "operationId": "IamAccessKeyLastUseds_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Update.json b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Update.json new file mode 100644 index 000000000000..a633147aa229 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/examples/2024-12-01/IamAccessKeyLastUseds_Update.json @@ -0,0 +1,58 @@ +{ + "title": "IamAccessKeyLastUseds_Update", + "operationId": "IamAccessKeyLastUseds_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2474": "rlwlhpzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/main.tsp b/specification/awsconnector/IamAccessKeyLastUsed.Management/main.tsp new file mode 100644 index 000000000000..ed8fe9da46f0 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/main.tsp @@ -0,0 +1,110 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamAccessKeyLastUseds ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Access Key Last Used", + plural: "IAM Access Key Last Useds", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Access", "Key", "Last", "Used"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamAccessKeyLastUsed is TrackedResource<IamAccessKeyLastUsedProperties> { + @doc("Name of IamAccessKeyLastUsed") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamAccessKeyLastUseds") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamAccessKeyLastUsed") +model IamAccessKeyLastUsedProperties { + @doc("AWS Properties") + awsProperties?: AwsIamAccessKeyLastUsedProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamAccessKeyLastUsed") +model AwsIamAccessKeyLastUsedProperties { + @doc("<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the access key was most recently used. This field is null in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM began tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul>") + lastUsedDate?: utcDateTime; + + @doc("<p>The Amazon Web Services Region where this access key was most recently used. The value for this field is 'N/A' in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM began tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul> <p>For more information about Amazon Web Services Regions, see <a href='https://docs.aws.amazon.com/general/latest/gr/rande.html'>Regions and endpoints</a> in the Amazon Web Services General Reference.</p>") + region?: string; + + @doc("<p>The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is 'N/A' in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM started tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul>") + serviceName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamAccessKeyLastUseds { + get is ArmResourceRead<IamAccessKeyLastUsed>; + @doc("Create a IamAccessKeyLastUsed. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamAccessKeyLastUsed>; + update is ArmCustomPatchAsync< + IamAccessKeyLastUsed, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamAccessKeyLastUsed> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamAccessKeyLastUsed>; + listByResourceGroup is ArmResourceListByParent<IamAccessKeyLastUsed>; + listBySubscription is ArmListBySubscription<IamAccessKeyLastUsed>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\iam\iam-2010-05-08.normal.json +// AWS Shape: AccessKeyLastUsed +// +// Related information for backend service: +// AWS Servcie : IAM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.9 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamAccessKeyLastUsed.Management/tspconfig.yaml b/specification/awsconnector/IamAccessKeyLastUsed.Management/tspconfig.yaml new file mode 100644 index 000000000000..7fcb977b2cdb --- /dev/null +++ b/specification/awsconnector/IamAccessKeyLastUsed.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamAccessKeyLastUsed.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_CreateOrReplace.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_CreateOrReplace.json new file mode 100644 index 000000000000..7b6f7e430c69 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "IamAccessKeyMetadataInfo_CreateOrReplace", + "operationId": "IamAccessKeyMetadataInfo_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + } + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Delete.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Delete.json new file mode 100644 index 000000000000..33c3401d1611 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamAccessKeyMetadataInfo_Delete", + "operationId": "IamAccessKeyMetadataInfo_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Get.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Get.json new file mode 100644 index 000000000000..f15ebf541917 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Get.json @@ -0,0 +1,51 @@ +{ + "title": "IamAccessKeyMetadataInfo_Get", + "operationId": "IamAccessKeyMetadataInfo_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListByResourceGroup.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListByResourceGroup.json new file mode 100644 index 000000000000..6329fd895440 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "IamAccessKeyMetadataInfo_ListByResourceGroup", + "operationId": "IamAccessKeyMetadataInfo_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListBySubscription.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListBySubscription.json new file mode 100644 index 000000000000..896df1b2425d --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "IamAccessKeyMetadataInfo_ListBySubscription", + "operationId": "IamAccessKeyMetadataInfo_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Update.json b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Update.json new file mode 100644 index 000000000000..caa85892864b --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/examples/2024-12-01/IamAccessKeyMetadataInfo_Update.json @@ -0,0 +1,61 @@ +{ + "title": "IamAccessKeyMetadataInfo_Update", + "operationId": "IamAccessKeyMetadataInfo_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2001": "hwqnseiqjeuyygxcahrf" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/main.tsp b/specification/awsconnector/IamAccessKeyMetadata.Management/main.tsp new file mode 100644 index 000000000000..177356ec0b81 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/main.tsp @@ -0,0 +1,134 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamAccessKeyMetadata ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Access Key Metadata", + plural: "IAM Access Key Metadata", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Access", "Key", "Metadata"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamAccessKeyMetadata is TrackedResource<IamAccessKeyMetadataProperties> { + @doc("Name of IamAccessKeyMetadata") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamAccessKeyMetadata") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamAccessKeyMetadata") +model IamAccessKeyMetadataProperties { + @doc("AWS Properties") + awsProperties?: AwsIamAccessKeyMetadataProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamAccessKeyMetadata") +model AwsIamAccessKeyMetadataProperties { + @doc("<p>The ID for this access key.</p>") + accessKeyId?: string; + + @doc("<p>The date when the access key was created.</p>") + createDate?: utcDateTime; + + @doc("<p>The status of the access key. <code>Active</code> means that the key is valid for API calls; <code>Inactive</code> means it is not.</p>") + status?: statusTypeEnumValue; + + @doc("<p>The name of the IAM user that the key is associated with.</p>") + userName?: string; +} + +@doc("statusType enum") +union statusType { + @doc("statusType enum Active") + Active: "Active", + + @doc("statusType enum Inactive") + Inactive: "Inactive", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of statusTypeEnumValue") +model statusTypeEnumValue { + @doc("Property value") + value?: statusType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamAccessKeyMetadataInfo { + get is ArmResourceRead<IamAccessKeyMetadata>; + @doc("Create a IamAccessKeyMetadata. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamAccessKeyMetadata>; + update is ArmCustomPatchAsync< + IamAccessKeyMetadata, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamAccessKeyMetadata> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamAccessKeyMetadata>; + listByResourceGroup is ArmResourceListByParent<IamAccessKeyMetadata>; + listBySubscription is ArmListBySubscription<IamAccessKeyMetadata>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\iam\iam-2010-05-08.normal.json +// AWS Shape: AccessKeyMetadata +// +// Related information for backend service: +// AWS Servcie : IAM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.9 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamAccessKeyMetadata.Management/tspconfig.yaml b/specification/awsconnector/IamAccessKeyMetadata.Management/tspconfig.yaml new file mode 100644 index 000000000000..5d5c3ee00089 --- /dev/null +++ b/specification/awsconnector/IamAccessKeyMetadata.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamAccessKeyMetadata.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_CreateOrReplace.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_CreateOrReplace.json new file mode 100644 index 000000000000..316fd32ad661 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamGroups_CreateOrReplace", + "operationId": "IamGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + } + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Delete.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Delete.json new file mode 100644 index 000000000000..f317e2f78324 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamGroups_Delete", + "operationId": "IamGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Get.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Get.json new file mode 100644 index 000000000000..54a3a10676b3 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamGroups_Get", + "operationId": "IamGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListByResourceGroup.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..f163352a12dd --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamGroups_ListByResourceGroup", + "operationId": "IamGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListBySubscription.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListBySubscription.json new file mode 100644 index 000000000000..ffb5d6f8dec8 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamGroups_ListBySubscription", + "operationId": "IamGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Update.json b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Update.json new file mode 100644 index 000000000000..5c452becdc10 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/examples/2024-12-01/IamGroups_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamGroups_Update", + "operationId": "IamGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6243": "zwl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamGroup.Management/main.tsp b/specification/awsconnector/IamGroup.Management/main.tsp new file mode 100644 index 000000000000..42abc70eea34 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/main.tsp @@ -0,0 +1,125 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Group", + plural: "IAM Groups", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Group"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamGroup is TrackedResource<IamGroupProperties> { + @doc("Name of IamGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamGroup") +model IamGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsIamGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamGroup") +model AwsIamGroupProperties { + @doc("Property arn") + arn?: string; + + @doc("The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both 'ADMINS' and 'admins'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{'Fn::Join': ['', [{'Ref': 'AWS::Region'}, {'Ref': 'MyResourceName'}]]}``.") + groupName?: string; + + @doc("The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.") + @extension("x-ms-identifiers", []) + managedPolicyArns?: string[]; + + @doc("The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.") + path?: string; + + @doc("Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.") + @extension("x-ms-identifiers", []) + policies?: Policy[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Policy") +model Policy { + @doc("The policy document.") + policyDocument?: Record<unknown>; + + @doc("The friendly name (not ARN) identifying the policy.") + policyName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamGroups { + get is ArmResourceRead<IamGroup>; + @doc("Create a IamGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamGroup>; + update is ArmCustomPatchAsync< + IamGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamGroup>; + listByResourceGroup is ArmResourceListByParent<IamGroup>; + listBySubscription is ArmListBySubscription<IamGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::IAM::Group +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamGroup.Management/tspconfig.yaml b/specification/awsconnector/IamGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..6d2bdcd526b3 --- /dev/null +++ b/specification/awsconnector/IamGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_CreateOrUpdate.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_CreateOrUpdate.json new file mode 100644 index 000000000000..50f2a6f2153d --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_CreateOrUpdate.json @@ -0,0 +1,118 @@ +{ + "title": "IamInstanceProfiles_CreateOrUpdate", + "operationId": "IamInstanceProfiles_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + } + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Delete.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Delete.json new file mode 100644 index 000000000000..4673b68e5728 --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamInstanceProfiles_Delete", + "operationId": "IamInstanceProfiles_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Get.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Get.json new file mode 100644 index 000000000000..29b00d8de17e --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Get.json @@ -0,0 +1,51 @@ +{ + "title": "IamInstanceProfiles_Get", + "operationId": "IamInstanceProfiles_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListByResourceGroup.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListByResourceGroup.json new file mode 100644 index 000000000000..2179c4f23394 --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "IamInstanceProfiles_ListByResourceGroup", + "operationId": "IamInstanceProfiles_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListBySubscription.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListBySubscription.json new file mode 100644 index 000000000000..fa4845b4835a --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "IamInstanceProfiles_ListBySubscription", + "operationId": "IamInstanceProfiles_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Update.json b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Update.json new file mode 100644 index 000000000000..8a1df63b5eda --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/examples/2024-12-01/IamInstanceProfiles_Update.json @@ -0,0 +1,61 @@ +{ + "title": "IamInstanceProfiles_Update", + "operationId": "IamInstanceProfiles_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5002": "ueaanaxejudathtufe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamInstanceProfile.Management/main.tsp b/specification/awsconnector/IamInstanceProfile.Management/main.tsp new file mode 100644 index 000000000000..87bae73d2c03 --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/main.tsp @@ -0,0 +1,108 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamInstanceProfiles ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Instance Profile", + plural: "IAM Instance Profiles", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Instance", "Profile"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamInstanceProfile is TrackedResource<IamInstanceProfileProperties> { + @doc("Name of IamInstanceProfile") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamInstanceProfiles") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamInstanceProfile") +model IamInstanceProfileProperties { + @doc("AWS Properties") + awsProperties?: AwsIamInstanceProfileProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamInstanceProfile") +model AwsIamInstanceProfileProperties { + @doc("Property arn") + arn?: string; + + @doc("The name of the instance profile to create. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-") + instanceProfileName?: string; + + @doc("The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.") + path?: string; + + @doc("The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.") + @extension("x-ms-identifiers", []) + roles?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamInstanceProfiles { + get is ArmResourceRead<IamInstanceProfile>; + @doc("Create a IamInstanceProfile. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrUpdate is ArmResourceCreateOrUpdateAsync<IamInstanceProfile>; + update is ArmCustomPatchAsync< + IamInstanceProfile, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamInstanceProfile> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamInstanceProfile>; + listByResourceGroup is ArmResourceListByParent<IamInstanceProfile>; + listBySubscription is ArmListBySubscription<IamInstanceProfile>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::IAM::InstanceProfile +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamInstanceProfile.Management/tspconfig.yaml b/specification/awsconnector/IamInstanceProfile.Management/tspconfig.yaml new file mode 100644 index 000000000000..fcff0996acc6 --- /dev/null +++ b/specification/awsconnector/IamInstanceProfile.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamInstanceProfile.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_CreateOrReplace.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_CreateOrReplace.json new file mode 100644 index 000000000000..e5dc490ec6b8 --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "IamMfaDevices_CreateOrReplace", + "operationId": "IamMfaDevices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + } + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Delete.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Delete.json new file mode 100644 index 000000000000..b88988a6293d --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamMfaDevices_Delete", + "operationId": "IamMfaDevices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Get.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Get.json new file mode 100644 index 000000000000..1c094afab0d5 --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Get.json @@ -0,0 +1,48 @@ +{ + "title": "IamMfaDevices_Get", + "operationId": "IamMfaDevices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListByResourceGroup.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..527d84092adf --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "IamMfaDevices_ListByResourceGroup", + "operationId": "IamMfaDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + ], + "nextLink": "https://microsoft.com/ag" + } + } + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListBySubscription.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListBySubscription.json new file mode 100644 index 000000000000..90b752a3ec90 --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "IamMfaDevices_ListBySubscription", + "operationId": "IamMfaDevices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + ], + "nextLink": "https://microsoft.com/ag" + } + } + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Update.json b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Update.json new file mode 100644 index 000000000000..01c3effcf1f7 --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/examples/2024-12-01/IamMfaDevices_Update.json @@ -0,0 +1,58 @@ +{ + "title": "IamMfaDevices_Update", + "operationId": "IamMfaDevices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2615": "bqskxobjjgas" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamMFADevice.Management/main.tsp b/specification/awsconnector/IamMFADevice.Management/main.tsp new file mode 100644 index 000000000000..aa438b6f6849 --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/main.tsp @@ -0,0 +1,110 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamMFADevices ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM MFADevice", + plural: "IAM MFADevices", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "MFADevice"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamMFADevice is TrackedResource<IamMFADeviceProperties> { + @doc("Name of IamMFADevice") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamMFADevices") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamMFADevice") +model IamMFADeviceProperties { + @doc("AWS Properties") + awsProperties?: AwsIamMFADeviceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamMFADevice") +model AwsIamMFADeviceProperties { + @doc("<p>The date when the MFA device was enabled for the user.</p>") + enableDate?: utcDateTime; + + @doc("<p>The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.</p>") + serialNumber?: string; + + @doc("<p>The user with whom the MFA device is associated.</p>") + userName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamMFADevices { + get is ArmResourceRead<IamMFADevice>; + @doc("Create a IamMFADevice. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamMFADevice>; + update is ArmCustomPatchAsync< + IamMFADevice, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamMFADevice> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamMFADevice>; + listByResourceGroup is ArmResourceListByParent<IamMFADevice>; + listBySubscription is ArmListBySubscription<IamMFADevice>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\iam\iam-2010-05-08.normal.json +// AWS Shape: MFADevice +// +// Related information for backend service: +// AWS Servcie : IAM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.9 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamMFADevice.Management/tspconfig.yaml b/specification/awsconnector/IamMFADevice.Management/tspconfig.yaml new file mode 100644 index 000000000000..aca7d3343d7e --- /dev/null +++ b/specification/awsconnector/IamMFADevice.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamMFADevice.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_CreateOrReplace.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..18bf4e16cadb --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "IamPasswordPolicies_CreateOrReplace", + "operationId": "IamPasswordPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + } + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Delete.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Delete.json new file mode 100644 index 000000000000..6ad598232a39 --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamPasswordPolicies_Delete", + "operationId": "IamPasswordPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Get.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Get.json new file mode 100644 index 000000000000..74ec718eb7db --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Get.json @@ -0,0 +1,55 @@ +{ + "title": "IamPasswordPolicies_Get", + "operationId": "IamPasswordPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListByResourceGroup.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..2132932c950e --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "IamPasswordPolicies_ListByResourceGroup", + "operationId": "IamPasswordPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListBySubscription.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListBySubscription.json new file mode 100644 index 000000000000..7fcee86f092b --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "IamPasswordPolicies_ListBySubscription", + "operationId": "IamPasswordPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Update.json b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Update.json new file mode 100644 index 000000000000..0c874d953d93 --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/examples/2024-12-01/IamPasswordPolicies_Update.json @@ -0,0 +1,65 @@ +{ + "title": "IamPasswordPolicies_Update", + "operationId": "IamPasswordPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6732": "jiafbj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamPasswordPolicy.Management/main.tsp b/specification/awsconnector/IamPasswordPolicy.Management/main.tsp new file mode 100644 index 000000000000..7a2281d3e2b8 --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/main.tsp @@ -0,0 +1,131 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamPasswordPolicies ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Password Policy", + plural: "IAM Password Policies", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Password", "Policy"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamPasswordPolicy is TrackedResource<IamPasswordPolicyProperties> { + @doc("Name of IamPasswordPolicy") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamPasswordPolicies") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamPasswordPolicy") +model IamPasswordPolicyProperties { + @doc("AWS Properties") + awsProperties?: AwsIamPasswordPolicyProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamPasswordPolicy") +model AwsIamPasswordPolicyProperties { + @doc("<p>Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to <code>iam:ChangePassword</code> for only their user and to the <code>iam:GetAccountPasswordPolicy</code> action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.</p>") + allowUsersToChangePassword?: boolean; + + @doc("<p>Indicates whether passwords in the account expire. Returns true if <code>MaxPasswordAge</code> contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.</p>") + expirePasswords?: boolean; + + @doc("<p>Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with <code>iam:ChangePassword</code> permission and active access keys can reset their own expired console password using the CLI or API.</p>") + hardExpiry?: boolean; + + @doc("<p>The number of days that an IAM user password is valid.</p>") + maxPasswordAge?: int32; + + @doc("<p>Minimum length to require for IAM user passwords.</p>") + minimumPasswordLength?: int32; + + @doc("<p>Specifies the number of previous passwords that IAM users are prevented from reusing.</p>") + passwordReusePrevention?: int32; + + @doc("<p>Specifies whether IAM user passwords must contain at least one lowercase character (a to z).</p>") + requireLowercaseCharacters?: boolean; + + @doc("<p>Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).</p>") + requireNumbers?: boolean; + + @doc("<p>Specifies whether IAM user passwords must contain at least one of the following symbols:</p> <p>! @ # $ % ^ & * ( ) _ + - = [ ] { } | '</p>") + requireSymbols?: boolean; + + @doc("<p>Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).</p>") + requireUppercaseCharacters?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamPasswordPolicies { + get is ArmResourceRead<IamPasswordPolicy>; + @doc("Create a IamPasswordPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamPasswordPolicy>; + update is ArmCustomPatchAsync< + IamPasswordPolicy, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamPasswordPolicy> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamPasswordPolicy>; + listByResourceGroup is ArmResourceListByParent<IamPasswordPolicy>; + listBySubscription is ArmListBySubscription<IamPasswordPolicy>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\iam\iam-2010-05-08.normal.json +// AWS Shape: PasswordPolicy +// +// Related information for backend service: +// AWS Servcie : IAM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.9 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamPasswordPolicy.Management/tspconfig.yaml b/specification/awsconnector/IamPasswordPolicy.Management/tspconfig.yaml new file mode 100644 index 000000000000..c431a866b986 --- /dev/null +++ b/specification/awsconnector/IamPasswordPolicy.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamPasswordPolicy.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_CreateOrReplace.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_CreateOrReplace.json new file mode 100644 index 000000000000..56d679e07707 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "IamPolicyVersions_CreateOrReplace", + "operationId": "IamPolicyVersions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + } + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Delete.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Delete.json new file mode 100644 index 000000000000..36abb6ab13b4 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamPolicyVersions_Delete", + "operationId": "IamPolicyVersions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Get.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Get.json new file mode 100644 index 000000000000..ad0f7cb38c60 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Get.json @@ -0,0 +1,49 @@ +{ + "title": "IamPolicyVersions_Get", + "operationId": "IamPolicyVersions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListByResourceGroup.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListByResourceGroup.json new file mode 100644 index 000000000000..85b2b548364b --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "IamPolicyVersions_ListByResourceGroup", + "operationId": "IamPolicyVersions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListBySubscription.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListBySubscription.json new file mode 100644 index 000000000000..bb5de80354a1 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "IamPolicyVersions_ListBySubscription", + "operationId": "IamPolicyVersions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Update.json b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Update.json new file mode 100644 index 000000000000..1c1e111fb2e3 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/examples/2024-12-01/IamPolicyVersions_Update.json @@ -0,0 +1,59 @@ +{ + "title": "IamPolicyVersions_Update", + "operationId": "IamPolicyVersions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2276": "wpzrumrbucflp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamPolicyVersion.Management/main.tsp b/specification/awsconnector/IamPolicyVersion.Management/main.tsp new file mode 100644 index 000000000000..c394f801760b --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/main.tsp @@ -0,0 +1,113 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamPolicyVersions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Policy Version", + plural: "IAM Policy Versions", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Policy", "Version"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamPolicyVersion is TrackedResource<IamPolicyVersionProperties> { + @doc("Name of IamPolicyVersion") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamPolicyVersions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamPolicyVersion") +model IamPolicyVersionProperties { + @doc("AWS Properties") + awsProperties?: AwsIamPolicyVersionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamPolicyVersion") +model AwsIamPolicyVersionProperties { + @doc("<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the policy version was created.</p>") + createDate?: utcDateTime; + + @doc("<p>The policy document.</p> <p>The policy document is returned in the response to the <a>GetPolicyVersion</a> and <a>GetAccountAuthorizationDetails</a> operations. It is not returned in the response to the <a>CreatePolicyVersion</a> or <a>ListPolicyVersions</a> operations. </p> <p>The policy document returned in this structure is URL-encoded compliant with <a href='https://tools.ietf.org/html/rfc3986'>RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p>") + document?: string; + + @doc("<p>Specifies whether the policy version is set as the policy's default version.</p>") + isDefaultVersion?: boolean; + + @doc("<p>The identifier for the policy version.</p> <p>Policy version identifiers always begin with <code>v</code> (always lowercase). When a policy is created, the first policy version is <code>v1</code>. </p>") + versionId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamPolicyVersions { + get is ArmResourceRead<IamPolicyVersion>; + @doc("Create a IamPolicyVersion. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamPolicyVersion>; + update is ArmCustomPatchAsync< + IamPolicyVersion, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamPolicyVersion> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamPolicyVersion>; + listByResourceGroup is ArmResourceListByParent<IamPolicyVersion>; + listBySubscription is ArmListBySubscription<IamPolicyVersion>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\iam\iam-2010-05-08.normal.json +// AWS Shape: PolicyVersion +// +// Related information for backend service: +// AWS Servcie : IAM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.9 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamPolicyVersion.Management/tspconfig.yaml b/specification/awsconnector/IamPolicyVersion.Management/tspconfig.yaml new file mode 100644 index 000000000000..6c0bc968eff4 --- /dev/null +++ b/specification/awsconnector/IamPolicyVersion.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamPolicyVersion.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_CreateOrReplace.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_CreateOrReplace.json new file mode 100644 index 000000000000..77d73768a0d9 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "IamRoles_CreateOrReplace", + "operationId": "IamRoles_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + } + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Delete.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Delete.json new file mode 100644 index 000000000000..07feb5972282 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamRoles_Delete", + "operationId": "IamRoles_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Get.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Get.json new file mode 100644 index 000000000000..60326be0e323 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Get.json @@ -0,0 +1,68 @@ +{ + "title": "IamRoles_Get", + "operationId": "IamRoles_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListByResourceGroup.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListByResourceGroup.json new file mode 100644 index 000000000000..33fb061a5268 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "IamRoles_ListByResourceGroup", + "operationId": "IamRoles_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListBySubscription.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListBySubscription.json new file mode 100644 index 000000000000..f2fcbff6c98b --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "IamRoles_ListBySubscription", + "operationId": "IamRoles_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Update.json b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Update.json new file mode 100644 index 000000000000..8f60e645d276 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/examples/2024-12-01/IamRoles_Update.json @@ -0,0 +1,78 @@ +{ + "title": "IamRoles_Update", + "operationId": "IamRoles_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3141": "cahhkifdlxcj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamRole.Management/main.tsp b/specification/awsconnector/IamRole.Management/main.tsp new file mode 100644 index 000000000000..08bcac87a719 --- /dev/null +++ b/specification/awsconnector/IamRole.Management/main.tsp @@ -0,0 +1,157 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamRoles ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Role", + plural: "IAM Roles", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Role"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamRole is TrackedResource<IamRoleProperties> { + @doc("Name of IamRole") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamRoles") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamRole") +model IamRoleProperties { + @doc("AWS Properties") + awsProperties?: AwsIamRoleProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamRole") +model AwsIamRoleProperties { + @doc("Property arn") + arn?: string; + + @doc("The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.") + assumeRolePolicyDocument?: Record<unknown>; + + @doc("A description of the role that you provide.") + description?: string; + + @doc("A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.") + @extension("x-ms-identifiers", []) + managedPolicyArns?: string[]; + + @doc("The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.") + maxSessionDuration?: int32; + + @doc("The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.") + path?: string = "/"; + + @doc("The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.") + permissionsBoundary?: string; + + @doc("Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. If an external policy (such as ``AWS::IAM::Policy`` or") + @extension("x-ms-identifiers", []) + policies?: Policy[]; + + @doc("Property roleId") + roleId?: string; + + @doc("A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both 'Role1' and 'role1'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use") + roleName?: string; + + @doc("A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Policy") +model Policy { + @doc("The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).") + policyDocument?: Record<unknown>; + + @doc("The friendly name (not ARN) identifying the policy.") + policyName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.") + key?: string; + + @doc("The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamRoles { + get is ArmResourceRead<IamRole>; + @doc("Create a IamRole. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamRole>; + update is ArmCustomPatchAsync< + IamRole, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamRole> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamRole>; + listByResourceGroup is ArmResourceListByParent<IamRole>; + listBySubscription is ArmListBySubscription<IamRole>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::IAM::Role +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamRole.Management/tspconfig.yaml b/specification/awsconnector/IamRole.Management/tspconfig.yaml new file mode 100644 index 000000000000..d7c8cf69469b --- /dev/null +++ b/specification/awsconnector/IamRole.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamRole.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_CreateOrReplace.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_CreateOrReplace.json new file mode 100644 index 000000000000..6a40f99d8261 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamServerCertificates_CreateOrReplace", + "operationId": "IamServerCertificates_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + } + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Delete.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Delete.json new file mode 100644 index 000000000000..67acdb0ef7d2 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamServerCertificates_Delete", + "operationId": "IamServerCertificates_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Get.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Get.json new file mode 100644 index 000000000000..d1ca8c645fdc --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamServerCertificates_Get", + "operationId": "IamServerCertificates_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListByResourceGroup.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListByResourceGroup.json new file mode 100644 index 000000000000..24a82a1d0776 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamServerCertificates_ListByResourceGroup", + "operationId": "IamServerCertificates_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListBySubscription.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListBySubscription.json new file mode 100644 index 000000000000..5df165cb62e9 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamServerCertificates_ListBySubscription", + "operationId": "IamServerCertificates_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Update.json b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Update.json new file mode 100644 index 000000000000..9069f2e58f8f --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/examples/2024-12-01/IamServerCertificates_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamServerCertificates_Update", + "operationId": "IamServerCertificates_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4287": "vtxxwxtnykpliagzasaedqcb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamServerCertificate.Management/main.tsp b/specification/awsconnector/IamServerCertificate.Management/main.tsp new file mode 100644 index 000000000000..77f4a6de8608 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/main.tsp @@ -0,0 +1,130 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamServerCertificates ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Server Certificate", + plural: "IAM Server Certificates", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Server", "Certificate"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamServerCertificate is TrackedResource<IamServerCertificateProperties> { + @doc("Name of IamServerCertificate") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamServerCertificates") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamServerCertificate") +model IamServerCertificateProperties { + @doc("AWS Properties") + awsProperties?: AwsIamServerCertificateProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamServerCertificate") +model AwsIamServerCertificateProperties { + @doc("Amazon Resource Name (ARN) of the server certificate") + arn?: string; + + @doc("Property certificateBody") + certificateBody?: string; + + @doc("Property certificateChain") + certificateChain?: string; + + @doc("Property path") + path?: string; + + @doc("Property privateKey") + privateKey?: string; + + @doc("Property serverCertificateName") + serverCertificateName?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamServerCertificates { + get is ArmResourceRead<IamServerCertificate>; + @doc("Create a IamServerCertificate. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamServerCertificate>; + update is ArmCustomPatchAsync< + IamServerCertificate, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamServerCertificate> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamServerCertificate>; + listByResourceGroup is ArmResourceListByParent<IamServerCertificate>; + listBySubscription is ArmListBySubscription<IamServerCertificate>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::IAM::ServerCertificate +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamServerCertificate.Management/tspconfig.yaml b/specification/awsconnector/IamServerCertificate.Management/tspconfig.yaml new file mode 100644 index 000000000000..396dc5f32ed4 --- /dev/null +++ b/specification/awsconnector/IamServerCertificate.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamServerCertificate.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_CreateOrReplace.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_CreateOrReplace.json new file mode 100644 index 000000000000..11046a9fd293 --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamVirtualMfaDevices_CreateOrReplace", + "operationId": "IamVirtualMfaDevices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + } + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Delete.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Delete.json new file mode 100644 index 000000000000..fa55e60f6795 --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamVirtualMfaDevices_Delete", + "operationId": "IamVirtualMfaDevices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Get.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Get.json new file mode 100644 index 000000000000..38e61f92568d --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamVirtualMfaDevices_Get", + "operationId": "IamVirtualMfaDevices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + } + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListByResourceGroup.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..3ed24463f332 --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamVirtualMfaDevices_ListByResourceGroup", + "operationId": "IamVirtualMfaDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListBySubscription.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListBySubscription.json new file mode 100644 index 000000000000..f733e98c170f --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamVirtualMfaDevices_ListBySubscription", + "operationId": "IamVirtualMfaDevices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Update.json b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Update.json new file mode 100644 index 000000000000..3ebcabbee292 --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/examples/2024-12-01/IamVirtualMfaDevices_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamVirtualMfaDevices_Update", + "operationId": "IamVirtualMfaDevices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1836": "hmiagognhtuiiokxcnouibgjadizrt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/main.tsp b/specification/awsconnector/IamVirtualMFADevice.Management/main.tsp new file mode 100644 index 000000000000..7ee7bfc75827 --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/main.tsp @@ -0,0 +1,125 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- IamVirtualMFADevices ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "IAM Virtual MFADevice", + plural: "IAM Virtual MFADevices", + }, + keywords: ["Microsoft.AwsConnector", "IAM", "Virtual", "MFADevice"], +}) +@doc("A Microsoft.AwsConnector resource") +model IamVirtualMFADevice is TrackedResource<IamVirtualMFADeviceProperties> { + @doc("Name of IamVirtualMFADevice") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("iamVirtualMFADevices") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IamVirtualMFADevice") +model IamVirtualMFADeviceProperties { + @doc("AWS Properties") + awsProperties?: AwsIamVirtualMFADeviceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsIamVirtualMFADevice") +model AwsIamVirtualMFADeviceProperties { + @doc("Property path") + path?: string; + + @doc("Property serialNumber") + serialNumber?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property users") + @extension("x-ms-identifiers", []) + users?: string[]; + + @doc("Property virtualMfaDeviceName") + virtualMfaDeviceName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface IamVirtualMFADevices { + get is ArmResourceRead<IamVirtualMFADevice>; + @doc("Create a IamVirtualMFADevice. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<IamVirtualMFADevice>; + update is ArmCustomPatchAsync< + IamVirtualMFADevice, + Azure.ResourceManager.Foundations.TagsUpdateModel<IamVirtualMFADevice> + >; + delete is ArmResourceDeleteWithoutOkAsync<IamVirtualMFADevice>; + listByResourceGroup is ArmResourceListByParent<IamVirtualMFADevice>; + listBySubscription is ArmListBySubscription<IamVirtualMFADevice>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::IAM::VirtualMFADevice +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/IamVirtualMFADevice.Management/tspconfig.yaml b/specification/awsconnector/IamVirtualMFADevice.Management/tspconfig.yaml new file mode 100644 index 000000000000..2fbc3c61b12e --- /dev/null +++ b/specification/awsconnector/IamVirtualMFADevice.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/iamVirtualMFADevice.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_CreateOrReplace.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_CreateOrReplace.json new file mode 100644 index 000000000000..2271e7ee482c --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "KmsAliases_CreateOrReplace", + "operationId": "KmsAliases_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + } + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Delete.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Delete.json new file mode 100644 index 000000000000..5988c5aa74b1 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "KmsAliases_Delete", + "operationId": "KmsAliases_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Get.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Get.json new file mode 100644 index 000000000000..7a5484cc91a4 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Get.json @@ -0,0 +1,47 @@ +{ + "title": "KmsAliases_Get", + "operationId": "KmsAliases_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListByResourceGroup.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListByResourceGroup.json new file mode 100644 index 000000000000..a48076cccc32 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "KmsAliases_ListByResourceGroup", + "operationId": "KmsAliases_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListBySubscription.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListBySubscription.json new file mode 100644 index 000000000000..a7a6563537b8 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "KmsAliases_ListBySubscription", + "operationId": "KmsAliases_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Update.json b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Update.json new file mode 100644 index 000000000000..b8fcdf12df94 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/examples/2024-12-01/KmsAliases_Update.json @@ -0,0 +1,57 @@ +{ + "title": "KmsAliases_Update", + "operationId": "KmsAliases_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4840": "vvbyxuqukn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/KmsAlias.Management/main.tsp b/specification/awsconnector/KmsAlias.Management/main.tsp new file mode 100644 index 000000000000..42d2c7ec8e80 --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/main.tsp @@ -0,0 +1,101 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- KmsAliases ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "KMS Alias", + plural: "KMS Aliases", + }, + keywords: ["Microsoft.AwsConnector", "KMS", "Alias"], +}) +@doc("A Microsoft.AwsConnector resource") +model KmsAlias is TrackedResource<KmsAliasProperties> { + @doc("Name of KmsAlias") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("kmsAliases") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KmsAlias") +model KmsAliasProperties { + @doc("AWS Properties") + awsProperties?: AwsKmsAliasProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsKmsAlias") +model AwsKmsAliasProperties { + @doc("Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).") + aliasName?: string; + + @doc("Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).") + targetKeyId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface KmsAliases { + get is ArmResourceRead<KmsAlias>; + @doc("Create a KmsAlias. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<KmsAlias>; + update is ArmCustomPatchAsync< + KmsAlias, + Azure.ResourceManager.Foundations.TagsUpdateModel<KmsAlias> + >; + delete is ArmResourceDeleteWithoutOkAsync<KmsAlias>; + listByResourceGroup is ArmResourceListByParent<KmsAlias>; + listBySubscription is ArmListBySubscription<KmsAlias>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::KMS::Alias +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/KmsAlias.Management/tspconfig.yaml b/specification/awsconnector/KmsAlias.Management/tspconfig.yaml new file mode 100644 index 000000000000..11fc53cf1e3c --- /dev/null +++ b/specification/awsconnector/KmsAlias.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/kmsAlias.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_CreateOrReplace.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_CreateOrReplace.json new file mode 100644 index 000000000000..0efc967a758c --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_CreateOrReplace.json @@ -0,0 +1,157 @@ +{ + "title": "KmsKeys_CreateOrReplace", + "operationId": "KmsKeys_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + } + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + } + } +} diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Delete.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Delete.json new file mode 100644 index 000000000000..91d4ad573fa5 --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "KmsKeys_Delete", + "operationId": "KmsKeys_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Get.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Get.json new file mode 100644 index 000000000000..fe748ce17727 --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Get.json @@ -0,0 +1,64 @@ +{ + "title": "KmsKeys_Get", + "operationId": "KmsKeys_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + } + } +} diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListByResourceGroup.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListByResourceGroup.json new file mode 100644 index 000000000000..ee8a3b4cb00a --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "title": "KmsKeys_ListByResourceGroup", + "operationId": "KmsKeys_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListBySubscription.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListBySubscription.json new file mode 100644 index 000000000000..d00c32ff8352 --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "title": "KmsKeys_ListBySubscription", + "operationId": "KmsKeys_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Update.json b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Update.json new file mode 100644 index 000000000000..6d3af64aa25a --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/examples/2024-12-01/KmsKeys_Update.json @@ -0,0 +1,74 @@ +{ + "title": "KmsKeys_Update", + "operationId": "KmsKeys_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2630": "ricxxxkbcqrtuipdpdxsutvqetomj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/KmsKey.Management/main.tsp b/specification/awsconnector/KmsKey.Management/main.tsp new file mode 100644 index 000000000000..9174682a8d2d --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/main.tsp @@ -0,0 +1,220 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- KmsKeys ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "KMS Key", + plural: "KMS Keys", + }, + keywords: ["Microsoft.AwsConnector", "KMS", "Key"], +}) +@doc("A Microsoft.AwsConnector resource") +model KmsKey is TrackedResource<KmsKeyProperties> { + @doc("Name of KmsKey") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("kmsKeys") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of KmsKey") +model KmsKeyProperties { + @doc("AWS Properties") + awsProperties?: AwsKmsKeyProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsKmsKey") +model AwsKmsKeyProperties { + @doc("Property arn") + arn?: string; + + @doc("Skips ('bypasses') the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key.") + bypassPolicyLockoutSafetyCheck?: boolean; + + @doc("A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use.") + description?: string; + + @doc("Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*.") + enableKeyRotation?: boolean; + + @doc("Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*.") + enabled?: boolean; + + @doc("Property keyId") + keyId?: string; + + @doc("The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. A key policy document can include only the following characters: + Printable ASCII characters + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters *Minimum*: ``1`` *Maximum*: ``32768``") + keyPolicy?: Record<unknown>; + + @doc("Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2``") + keySpec?: KeySpec = "SYMMETRIC_DEFAULT"; + + @doc("Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.") + keyUsage?: KeyUsage = "ENCRYPT_DECRYPT"; + + @doc("Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key.") + multiRegion?: boolean; + + @doc("The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.") + origin?: Origin = "AWS_KMS"; + + @doc("Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*.") + pendingWindowInDays?: int32; + + @doc("Property rotationPeriodInDays") + rotationPeriodInDays?: int32 = 365; + + @doc("Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("KeySpec enum") +union KeySpec { + @doc("KeySpec enum ECC_NIST_P256") + ECC_NIST_P256: "ECC_NIST_P256", + + @doc("KeySpec enum ECC_NIST_P384") + ECC_NIST_P384: "ECC_NIST_P384", + + @doc("KeySpec enum ECC_NIST_P521") + ECC_NIST_P521: "ECC_NIST_P521", + + @doc("KeySpec enum ECC_SECG_P256K1") + ECC_SECG_P256K1: "ECC_SECG_P256K1", + + @doc("KeySpec enum HMAC_224") + HMAC_224: "HMAC_224", + + @doc("KeySpec enum HMAC_256") + HMAC_256: "HMAC_256", + + @doc("KeySpec enum HMAC_384") + HMAC_384: "HMAC_384", + + @doc("KeySpec enum HMAC_512") + HMAC_512: "HMAC_512", + + @doc("KeySpec enum RSA_2048") + RSA_2048: "RSA_2048", + + @doc("KeySpec enum RSA_3072") + RSA_3072: "RSA_3072", + + @doc("KeySpec enum RSA_4096") + RSA_4096: "RSA_4096", + + @doc("KeySpec enum SM2") + SM2: "SM2", + + @doc("KeySpec enum SYMMETRIC_DEFAULT") + SYMMETRIC_DEFAULT: "SYMMETRIC_DEFAULT", + + string, +} + +@doc("Origin enum") +union Origin { + @doc("Origin enum AWS_KMS") + AWS_KMS: "AWS_KMS", + + @doc("Origin enum EXTERNAL") + EXTERNAL: "EXTERNAL", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +@doc("KeyUsage enum") +union KeyUsage { + @doc("KeyUsage enum ENCRYPT_DECRYPT") + ENCRYPT_DECRYPT: "ENCRYPT_DECRYPT", + + @doc("KeyUsage enum GENERATE_VERIFY_MAC") + GENERATE_VERIFY_MAC: "GENERATE_VERIFY_MAC", + + @doc("KeyUsage enum SIGN_VERIFY") + SIGN_VERIFY: "SIGN_VERIFY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface KmsKeys { + get is ArmResourceRead<KmsKey>; + @doc("Create a KmsKey. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<KmsKey>; + update is ArmCustomPatchAsync< + KmsKey, + Azure.ResourceManager.Foundations.TagsUpdateModel<KmsKey> + >; + delete is ArmResourceDeleteWithoutOkAsync<KmsKey>; + listByResourceGroup is ArmResourceListByParent<KmsKey>; + listBySubscription is ArmListBySubscription<KmsKey>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::KMS::Key +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/KmsKey.Management/tspconfig.yaml b/specification/awsconnector/KmsKey.Management/tspconfig.yaml new file mode 100644 index 000000000000..1ea0b575fda4 --- /dev/null +++ b/specification/awsconnector/KmsKey.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/kmsKey.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_CreateOrReplace.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_CreateOrReplace.json new file mode 100644 index 000000000000..3be94f916d17 --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_CreateOrReplace.json @@ -0,0 +1,358 @@ +{ + "title": "LambdaFunctions_CreateOrReplace", + "operationId": "LambdaFunctions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + } + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + } + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Delete.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Delete.json new file mode 100644 index 000000000000..07d4b73e0f3f --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LambdaFunctions_Delete", + "operationId": "LambdaFunctions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Get.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Get.json new file mode 100644 index 000000000000..2930c832171b --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Get.json @@ -0,0 +1,131 @@ +{ + "title": "LambdaFunctions_Get", + "operationId": "LambdaFunctions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + } + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListByResourceGroup.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListByResourceGroup.json new file mode 100644 index 000000000000..656c20da255d --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListByResourceGroup.json @@ -0,0 +1,135 @@ +{ + "title": "LambdaFunctions_ListByResourceGroup", + "operationId": "LambdaFunctions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + ], + "nextLink": "https://microsoft.com/afquez" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListBySubscription.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListBySubscription.json new file mode 100644 index 000000000000..bb76f009cc07 --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_ListBySubscription.json @@ -0,0 +1,134 @@ +{ + "title": "LambdaFunctions_ListBySubscription", + "operationId": "LambdaFunctions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + ], + "nextLink": "https://microsoft.com/afquez" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Update.json b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Update.json new file mode 100644 index 000000000000..54e2d5c5d50c --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/examples/2024-12-01/LambdaFunctions_Update.json @@ -0,0 +1,141 @@ +{ + "title": "LambdaFunctions_Update", + "operationId": "LambdaFunctions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6434": "ezegqcosapc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunction.Management/main.tsp b/specification/awsconnector/LambdaFunction.Management/main.tsp new file mode 100644 index 000000000000..392b01323a97 --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/main.tsp @@ -0,0 +1,487 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LambdaFunctions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Lambda Function", + plural: "Lambda Functions", + }, + keywords: ["Microsoft.AwsConnector", "Lambda", "Function"], +}) +@doc("A Microsoft.AwsConnector resource") +model LambdaFunction is TrackedResource<LambdaFunctionProperties> { + @doc("Name of LambdaFunction") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("lambdaFunctions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LambdaFunction") +model LambdaFunctionProperties { + @doc("AWS Properties") + awsProperties?: AwsLambdaFunctionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLambdaFunction") +model AwsLambdaFunctionProperties { + @doc("The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.") + @extension("x-ms-identifiers", []) + architectures?: Architectures[]; + + @doc("Property arn") + arn?: string; + + @doc("The code for the function. The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template.") + code?: Code; + + @doc("To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.") + codeSigningConfigArn?: string; + + @doc("A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations.") + deadLetterConfig?: DeadLetterConfig; + + @doc("A description of the function.") + description?: string; + + @doc("Environment variables that are accessible from function code during execution. A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration.") + environment?: Environment; + + @doc("The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB.") + ephemeralStorage?: EphemeralStorage; + + @doc("Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).") + @extension("x-ms-identifiers", []) + fileSystemConfigs?: FileSystemConfig[]; + + @doc("The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + functionName?: string; + + @doc("The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).") + handler?: string; + + @doc("Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).") + imageConfig?: ImageConfig; + + @doc("The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key.") + kmsKeyArn?: string; + + @doc("A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.") + @extension("x-ms-identifiers", []) + layers?: string[]; + + @doc("The function's Amazon CloudWatch Logs configuration settings. The function's Amazon CloudWatch Logs configuration settings.") + loggingConfig?: LoggingConfig; + + @doc("The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.") + memorySize?: int32; + + @doc("The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.") + packageType?: PackageType; + + @doc("The number of simultaneous executions to reserve for the function.") + reservedConcurrentExecutions?: int32; + + @doc("The Amazon Resource Name (ARN) of the function's execution role.") + role?: string; + + @doc("The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy).") + runtime?: string; + + @doc("Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html).") + runtimeManagementConfig?: RuntimeManagementConfig; + + @doc("The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.") + snapStart?: SnapStart; + + @doc("The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting.") + snapStartResponse?: SnapStartResponse; + + @doc("A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).") + timeout?: int32; + + @doc("Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``.") + tracingConfig?: TracingConfig; + + @doc("For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted.") + vpcConfig?: VpcConfig; +} + +@doc("Architectures enum") +union Architectures { + @doc("Architectures enum arm64") + arm64: "arm64", + + @doc("Architectures enum x86_64") + x86_64: "x86_64", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Code") +model Code { + @doc("URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry.") + imageUri?: string; + + @doc("An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account.") + s3Bucket?: string; + + @doc("The Amazon S3 key of the deployment package.") + s3Key?: string; + + @doc("For versioned objects, the version of the deployment package object to use.") + s3ObjectVersion?: string; + + @doc("(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details.") + zipFile?: string; +} + +@doc("PackageType enum") +union PackageType { + @doc("PackageType enum Image") + Image: "Image", + + @doc("PackageType enum Zip") + Zip: "Zip", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeadLetterConfig") +model DeadLetterConfig { + @doc("The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.") + targetArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Environment") +model Environment { + @doc("Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).") + variables?: Record<string>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EphemeralStorage") +model EphemeralStorage { + @doc("The size of the function's ``/tmp`` directory.") + size?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FileSystemConfig") +model FileSystemConfig { + @doc("The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system.") + arn?: string; + + @doc("The path where the function can access the file system, starting with ``/mnt/``.") + localMountPath?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ImageConfig") +model ImageConfig { + @doc("Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.") + @extension("x-ms-identifiers", []) + command?: string[]; + + @doc("Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.") + @extension("x-ms-identifiers", []) + entryPoint?: string[]; + + @doc("Specifies the working directory. The length of the directory string cannot exceed 1,000 characters.") + workingDirectory?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoggingConfig") +model LoggingConfig { + @doc("Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest.") + applicationLogLevel?: LoggingConfigApplicationLogLevel; + + @doc("The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.") + logFormat?: LoggingConfigLogFormat; + + @doc("The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name>``. To use a different log group, enter an existing log group or enter a new log group name.") + logGroup?: string; + + @doc("Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.") + systemLogLevel?: LoggingConfigSystemLogLevel; +} + +@doc("LoggingConfigApplicationLogLevel enum") +union LoggingConfigApplicationLogLevel { + @doc("LoggingConfigApplicationLogLevel enum DEBUG") + DEBUG: "DEBUG", + + @doc("LoggingConfigApplicationLogLevel enum ERROR") + ERROR: "ERROR", + + @doc("LoggingConfigApplicationLogLevel enum FATAL") + FATAL: "FATAL", + + @doc("LoggingConfigApplicationLogLevel enum INFO") + INFO: "INFO", + + @doc("LoggingConfigApplicationLogLevel enum TRACE") + TRACE: "TRACE", + + @doc("LoggingConfigApplicationLogLevel enum WARN") + WARN: "WARN", + + string, +} + +@doc("LoggingConfigSystemLogLevel enum") +union LoggingConfigSystemLogLevel { + @doc("LoggingConfigSystemLogLevel enum DEBUG") + DEBUG: "DEBUG", + + @doc("LoggingConfigSystemLogLevel enum INFO") + INFO: "INFO", + + @doc("LoggingConfigSystemLogLevel enum WARN") + WARN: "WARN", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuntimeManagementConfig") +model RuntimeManagementConfig { + @doc("The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode.") + runtimeVersionArn?: string; + + @doc("Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``") + updateRuntimeOn?: RuntimeManagementConfigUpdateRuntimeOn; +} + +@doc("LoggingConfigLogFormat enum") +union LoggingConfigLogFormat { + @doc("LoggingConfigLogFormat enum JSON") + JSON: "JSON", + + @doc("LoggingConfigLogFormat enum Text") + Text: "Text", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnapStart") +model SnapStart { + @doc("Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.") + applyOn?: SnapStartApplyOn; +} + +@doc("RuntimeManagementConfigUpdateRuntimeOn enum") +union RuntimeManagementConfigUpdateRuntimeOn { + @doc("RuntimeManagementConfigUpdateRuntimeOn enum Auto") + Auto: "Auto", + + @doc("RuntimeManagementConfigUpdateRuntimeOn enum FunctionUpdate") + FunctionUpdate: "FunctionUpdate", + + @doc("RuntimeManagementConfigUpdateRuntimeOn enum Manual") + Manual: "Manual", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnapStartResponse") +model SnapStartResponse { + @doc("When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version.") + applyOn?: SnapStartResponseApplyOn; + + @doc("When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version.") + optimizationStatus?: SnapStartResponseOptimizationStatus; +} + +@doc("SnapStartApplyOn enum") +union SnapStartApplyOn { + @doc("SnapStartApplyOn enum None") + None: "None", + + @doc("SnapStartApplyOn enum PublishedVersions") + PublishedVersions: "PublishedVersions", + + string, +} + +@doc("SnapStartResponseOptimizationStatus enum") +union SnapStartResponseOptimizationStatus { + @doc("SnapStartResponseOptimizationStatus enum Off") + Off: "Off", + + @doc("SnapStartResponseOptimizationStatus enum On") + On: "On", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +@doc("SnapStartResponseApplyOn enum") +union SnapStartResponseApplyOn { + @doc("SnapStartResponseApplyOn enum None") + None: "None", + + @doc("SnapStartResponseApplyOn enum PublishedVersions") + PublishedVersions: "PublishedVersions", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TracingConfig") +model TracingConfig { + @doc("The tracing mode.") + mode?: TracingConfigMode; +} + +@doc("TracingConfigMode enum") +union TracingConfigMode { + @doc("TracingConfigMode enum Active") + Active: "Active", + + @doc("TracingConfigMode enum PassThrough") + PassThrough: "PassThrough", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VpcConfig") +model VpcConfig { + @doc("Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.") + ipv6AllowedForDualStack?: boolean; + + @doc("A list of VPC security group IDs.") + @extension("x-ms-identifiers", []) + securityGroupIds?: string[]; + + @doc("A list of VPC subnet IDs.") + @extension("x-ms-identifiers", []) + subnetIds?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LambdaFunctions { + get is ArmResourceRead<LambdaFunction>; + @doc("Create a LambdaFunction. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LambdaFunction>; + update is ArmCustomPatchAsync< + LambdaFunction, + Azure.ResourceManager.Foundations.TagsUpdateModel<LambdaFunction> + >; + delete is ArmResourceDeleteWithoutOkAsync<LambdaFunction>; + listByResourceGroup is ArmResourceListByParent<LambdaFunction>; + listBySubscription is ArmListBySubscription<LambdaFunction>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Lambda::Function +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LambdaFunction.Management/tspconfig.yaml b/specification/awsconnector/LambdaFunction.Management/tspconfig.yaml new file mode 100644 index 000000000000..7c1c60f28826 --- /dev/null +++ b/specification/awsconnector/LambdaFunction.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/lambdaFunction.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_CreateOrReplace.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_CreateOrReplace.json new file mode 100644 index 000000000000..8e59ffb5a041 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "LambdaFunctionCodeLocations_CreateOrReplace", + "operationId": "LambdaFunctionCodeLocations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + } + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + } + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Delete.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Delete.json new file mode 100644 index 000000000000..e1d4b8451143 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LambdaFunctionCodeLocations_Delete", + "operationId": "LambdaFunctionCodeLocations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Get.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Get.json new file mode 100644 index 000000000000..5fb3ec4809e4 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Get.json @@ -0,0 +1,49 @@ +{ + "title": "LambdaFunctionCodeLocations_Get", + "operationId": "LambdaFunctionCodeLocations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + } + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListByResourceGroup.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListByResourceGroup.json new file mode 100644 index 000000000000..3a34f6241828 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "LambdaFunctionCodeLocations_ListByResourceGroup", + "operationId": "LambdaFunctionCodeLocations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListBySubscription.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListBySubscription.json new file mode 100644 index 000000000000..48769924f671 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "LambdaFunctionCodeLocations_ListBySubscription", + "operationId": "LambdaFunctionCodeLocations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Update.json b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Update.json new file mode 100644 index 000000000000..fe6d3ab6188d --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/examples/2024-12-01/LambdaFunctionCodeLocations_Update.json @@ -0,0 +1,59 @@ +{ + "title": "LambdaFunctionCodeLocations_Update", + "operationId": "LambdaFunctionCodeLocations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2617": "iwaalayfaojfhxd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/main.tsp b/specification/awsconnector/LambdaFunctionCodeLocation.Management/main.tsp new file mode 100644 index 000000000000..a9cb703f0cf6 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/main.tsp @@ -0,0 +1,120 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LambdaFunctionCodeLocations ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Lambda Function Code Location", + plural: "Lambda Function Code Locations", + }, + keywords: [ + "Microsoft.AwsConnector", + "Lambda", + "Function", + "Code", + "Location" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model LambdaFunctionCodeLocation + is TrackedResource<LambdaFunctionCodeLocationProperties> { + @doc("Name of LambdaFunctionCodeLocation") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("lambdaFunctionCodeLocations") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LambdaFunctionCodeLocation") +model LambdaFunctionCodeLocationProperties { + @doc("AWS Properties") + awsProperties?: AwsLambdaFunctionCodeLocationProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLambdaFunctionCodeLocation") +model AwsLambdaFunctionCodeLocationProperties { + @doc("<p>URI of a container image in the Amazon ECR registry.</p>") + imageUri?: string; + + @doc("<p>A presigned URL that you can use to download the deployment package.</p>") + location?: string; + + @doc("<p>The service that's hosting the file.</p>") + repositoryType?: string; + + @doc("<p>The resolved URI for the image.</p>") + resolvedImageUri?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LambdaFunctionCodeLocations { + get is ArmResourceRead<LambdaFunctionCodeLocation>; + @doc("Create a LambdaFunctionCodeLocation. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LambdaFunctionCodeLocation>; + update is ArmCustomPatchAsync< + LambdaFunctionCodeLocation, + Azure.ResourceManager.Foundations.TagsUpdateModel<LambdaFunctionCodeLocation> + >; + delete is ArmResourceDeleteWithoutOkAsync<LambdaFunctionCodeLocation>; + listByResourceGroup is ArmResourceListByParent<LambdaFunctionCodeLocation>; + listBySubscription is ArmListBySubscription<LambdaFunctionCodeLocation>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\lambda\lambda-2015-03-31.normal.json +// AWS Shape: FunctionCodeLocation +// +// Related information for backend service: +// AWS Servcie : Lambda +// Product Version : 3.7.798.0 +// SDK Version : 3.7.305.15 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LambdaFunctionCodeLocation.Management/tspconfig.yaml b/specification/awsconnector/LambdaFunctionCodeLocation.Management/tspconfig.yaml new file mode 100644 index 000000000000..50745cb004a2 --- /dev/null +++ b/specification/awsconnector/LambdaFunctionCodeLocation.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/lambdaFunctionCodeLocation.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_CreateOrReplace.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_CreateOrReplace.json new file mode 100644 index 000000000000..67571dfc1146 --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "LightsailBuckets_CreateOrReplace", + "operationId": "LightsailBuckets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + } + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + } + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Delete.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Delete.json new file mode 100644 index 000000000000..f1bb06c1a795 --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LightsailBuckets_Delete", + "operationId": "LightsailBuckets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Get.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Get.json new file mode 100644 index 000000000000..29f0620b3ccd --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Get.json @@ -0,0 +1,67 @@ +{ + "title": "LightsailBuckets_Get", + "operationId": "LightsailBuckets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + } + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListByResourceGroup.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListByResourceGroup.json new file mode 100644 index 000000000000..2af052fbe847 --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "LightsailBuckets_ListByResourceGroup", + "operationId": "LightsailBuckets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListBySubscription.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListBySubscription.json new file mode 100644 index 000000000000..32a2580d7770 --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "LightsailBuckets_ListBySubscription", + "operationId": "LightsailBuckets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Update.json b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Update.json new file mode 100644 index 000000000000..b31d46093bed --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/examples/2024-12-01/LightsailBuckets_Update.json @@ -0,0 +1,77 @@ +{ + "title": "LightsailBuckets_Update", + "operationId": "LightsailBuckets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1875": "hdyasteghcrytmfrujlkng" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LightsailBucket.Management/main.tsp b/specification/awsconnector/LightsailBucket.Management/main.tsp new file mode 100644 index 000000000000..ef8cb8347c29 --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/main.tsp @@ -0,0 +1,154 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LightsailBuckets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Lightsail Bucket", + plural: "Lightsail Buckets", + }, + keywords: ["Microsoft.AwsConnector", "Lightsail", "Bucket"], +}) +@doc("A Microsoft.AwsConnector resource") +model LightsailBucket is TrackedResource<LightsailBucketProperties> { + @doc("Name of LightsailBucket") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("lightsailBuckets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LightsailBucket") +model LightsailBucketProperties { + @doc("AWS Properties") + awsProperties?: AwsLightsailBucketProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLightsailBucket") +model AwsLightsailBucketProperties { + @doc("Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle.") + ableToUpdateBundle?: boolean; + + @doc("An object that sets the public accessibility of objects in the specified bucket.") + accessRules?: AccessRules; + + @doc("Property bucketArn") + bucketArn?: string; + + @doc("The name for the bucket.") + bucketName?: string; + + @doc("The ID of the bundle to use for the bucket.") + bundleId?: string; + + @doc("Specifies whether to enable or disable versioning of objects in the bucket.") + objectVersioning?: boolean; + + @doc("An array of strings to specify the AWS account IDs that can access the bucket.") + @extension("x-ms-identifiers", []) + readOnlyAccessAccounts?: string[]; + + @doc("The names of the Lightsail resources for which to set bucket access.") + @extension("x-ms-identifiers", []) + resourcesReceivingAccess?: string[]; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The URL of the bucket.") + url?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccessRules") +model AccessRules { + @doc("A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.") + allowPublicOverrides?: boolean; + + @doc("Specifies the anonymous access to all objects in a bucket.") + getObject?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LightsailBuckets { + get is ArmResourceRead<LightsailBucket>; + @doc("Create a LightsailBucket. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LightsailBucket>; + update is ArmCustomPatchAsync< + LightsailBucket, + Azure.ResourceManager.Foundations.TagsUpdateModel<LightsailBucket> + >; + delete is ArmResourceDeleteWithoutOkAsync<LightsailBucket>; + listByResourceGroup is ArmResourceListByParent<LightsailBucket>; + listBySubscription is ArmListBySubscription<LightsailBucket>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Lightsail::Bucket +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LightsailBucket.Management/tspconfig.yaml b/specification/awsconnector/LightsailBucket.Management/tspconfig.yaml new file mode 100644 index 000000000000..ba99e93a1a6f --- /dev/null +++ b/specification/awsconnector/LightsailBucket.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/lightsailBucket.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_CreateOrReplace.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_CreateOrReplace.json new file mode 100644 index 000000000000..b8e48b0e2b50 --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_CreateOrReplace.json @@ -0,0 +1,331 @@ +{ + "title": "LightsailInstances_CreateOrReplace", + "operationId": "LightsailInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + } + }, + "tags": { + "key2601": "s" + }, + "location": "cry" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + } + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Delete.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Delete.json new file mode 100644 index 000000000000..def4c4e15f32 --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LightsailInstances_Delete", + "operationId": "LightsailInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Get.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Get.json new file mode 100644 index 000000000000..fc6a17718149 --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Get.json @@ -0,0 +1,122 @@ +{ + "title": "LightsailInstances_Get", + "operationId": "LightsailInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + } + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListByResourceGroup.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..3f5c9269a5df --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListByResourceGroup.json @@ -0,0 +1,126 @@ +{ + "title": "LightsailInstances_ListByResourceGroup", + "operationId": "LightsailInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListBySubscription.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListBySubscription.json new file mode 100644 index 000000000000..54a15afad654 --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_ListBySubscription.json @@ -0,0 +1,125 @@ +{ + "title": "LightsailInstances_ListBySubscription", + "operationId": "LightsailInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Update.json b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Update.json new file mode 100644 index 000000000000..3a41991c6250 --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/examples/2024-12-01/LightsailInstances_Update.json @@ -0,0 +1,132 @@ +{ + "title": "LightsailInstances_Update", + "operationId": "LightsailInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7201": "ueivrzjdihomqggzrzaissujr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LightsailInstance.Management/main.tsp b/specification/awsconnector/LightsailInstance.Management/main.tsp new file mode 100644 index 000000000000..5eae61c0b27e --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/main.tsp @@ -0,0 +1,357 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LightsailInstances ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Lightsail Instance", + plural: "Lightsail Instances", + }, + keywords: ["Microsoft.AwsConnector", "Lightsail", "Instance"], +}) +@doc("A Microsoft.AwsConnector resource") +model LightsailInstance is TrackedResource<LightsailInstanceProperties> { + @doc("Name of LightsailInstance") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("lightsailInstances") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LightsailInstance") +model LightsailInstanceProperties { + @doc("AWS Properties") + awsProperties?: AwsLightsailInstanceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLightsailInstance") +model AwsLightsailInstanceProperties { + @doc("An array of objects representing the add-ons to enable for the new instance.") + @extension("x-ms-identifiers", []) + addOns?: AddOn[]; + + @doc("The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.") + availabilityZone?: string; + + @doc("The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).") + blueprintId?: string; + + @doc("The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).") + bundleId?: string; + + @doc("Hardware of the Instance.") + hardware?: Hardware; + + @doc("Property instanceArn") + instanceArn?: string; + + @doc("The names to use for your new Lightsail instance.") + instanceName?: string; + + @doc("Is the IP Address of the Instance is the static IP") + isStaticIp?: boolean; + + @doc("The name of your key pair.") + keyPairName?: string; + + @doc("Location of a resource.") + location?: Location; + + @doc("Networking of the Instance.") + networking?: Networking; + + @doc("Private IP Address of the Instance") + privateIpAddress?: string; + + @doc("Public IP Address of the Instance") + publicIpAddress?: string; + + @doc("Resource type of Lightsail instance.") + resourceType?: string; + + @doc("SSH Key Name of the Lightsail instance.") + sshKeyName?: string; + + @doc("Current State of the Instance.") + state?: State; + + @doc("Support code to help identify any issues") + supportCode?: string; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.") + userData?: string; + + @doc("Username of the Lightsail instance.") + userName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AddOn") +model AddOn { + @doc("The add-on type") + addOnType?: string; + + @doc("An object that represents additional parameters when enabling or modifying the automatic snapshot add-on") + autoSnapshotAddOnRequest?: AutoSnapshotAddOn; + + @doc("Status of the Addon") + status?: AddOnStatus; +} + +@doc("AddOnStatus enum") +union AddOnStatus { + @doc("AddOnStatus enum Disabled") + Disabled: "Disabled", + + @doc("AddOnStatus enum Disabling") + Disabling: "Disabling", + + @doc("AddOnStatus enum Enabled") + Enabled: "Enabled", + + @doc("AddOnStatus enum Enabling") + Enabling: "Enabling", + + @doc("AddOnStatus enum Failed") + Failed: "Failed", + + @doc("AddOnStatus enum Terminated") + Terminated: "Terminated", + + @doc("AddOnStatus enum Terminating") + Terminating: "Terminating", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Hardware") +model Hardware { + @doc("CPU count of the Instance.") + cpuCount?: int32; + + @doc("Disks attached to the Instance.") + @extension("x-ms-identifiers", []) + disks?: Disk[]; + + @doc("RAM Size of the Instance.") + ramSizeInGb?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Location") +model Location { + @doc("The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.") + availabilityZone?: string; + + @doc("The Region Name in which to create your instance.") + regionName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Networking") +model Networking { + @doc("Monthly Transfer of the Instance.") + monthlyTransfer?: MonthlyTransfer; + + @doc("Ports to the Instance.") + @extension("x-ms-identifiers", []) + ports?: Port[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of State") +model State { + @doc("Status code of the Instance.") + code?: int32; + + @doc("Status code of the Instance.") + name?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AutoSnapshotAddOn") +model AutoSnapshotAddOn { + @doc("The daily time when an automatic snapshot will be created.") + snapshotTimeOfDay?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Disk") +model Disk { + @doc("Instance attached to the disk.") + attachedTo?: string; + + @doc("Attachment state of the disk.") + attachmentState?: string; + + @doc("The names to use for your new Lightsail disk.") + diskName?: string; + + @doc("IOPS of disk.") + iops?: int32; + + @doc("Is the Attached disk is the system disk of the Instance.") + isSystemDisk?: boolean; + + @doc("Path of the disk attached to the instance.") + path?: string; + + @doc("Size of the disk attached to the Instance.") + sizeInGb?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MonthlyTransfer") +model MonthlyTransfer { + @doc("GbPerMonthAllocated of the Instance.") + gbPerMonthAllocated?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Port") +model Port { + @doc("Access Direction for Protocol of the Instance(inbound/outbound).") + accessDirection?: string; + + @doc("Access From Protocol of the Instance.") + accessFrom?: string; + + @doc("Access Type Protocol of the Instance.") + accessType?: string; + + @doc("cidr List Aliases") + @extension("x-ms-identifiers", []) + cidrListAliases?: string[]; + + @doc("Property cidrs") + @extension("x-ms-identifiers", []) + cidrs?: string[]; + + @doc("CommonName for Protocol of the Instance.") + commonName?: string; + + @doc("From Port of the Instance.") + fromPort?: int32; + + @doc("IPv6 Cidrs") + @extension("x-ms-identifiers", []) + ipv6Cidrs?: string[]; + + @doc("Port Protocol of the Instance.") + protocol?: string; + + @doc("To Port of the Instance.") + toPort?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LightsailInstances { + get is ArmResourceRead<LightsailInstance>; + @doc("Create a LightsailInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LightsailInstance>; + update is ArmCustomPatchAsync< + LightsailInstance, + Azure.ResourceManager.Foundations.TagsUpdateModel<LightsailInstance> + >; + delete is ArmResourceDeleteWithoutOkAsync<LightsailInstance>; + listByResourceGroup is ArmResourceListByParent<LightsailInstance>; + listBySubscription is ArmListBySubscription<LightsailInstance>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Lightsail::Instance +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LightsailInstance.Management/tspconfig.yaml b/specification/awsconnector/LightsailInstance.Management/tspconfig.yaml new file mode 100644 index 000000000000..9b205b70764e --- /dev/null +++ b/specification/awsconnector/LightsailInstance.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/lightsailInstance.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_CreateOrReplace.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_CreateOrReplace.json new file mode 100644 index 000000000000..87ccfd5f46c6 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_CreateOrReplace.json @@ -0,0 +1,133 @@ +{ + "title": "LogsLogGroups_CreateOrReplace", + "operationId": "LogsLogGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + } + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Delete.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Delete.json new file mode 100644 index 000000000000..6dd783152022 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsLogGroups_Delete", + "operationId": "LogsLogGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Get.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Get.json new file mode 100644 index 000000000000..0426fcd862e8 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Get.json @@ -0,0 +1,56 @@ +{ + "title": "LogsLogGroups_Get", + "operationId": "LogsLogGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListByResourceGroup.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..89d756291eb7 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "title": "LogsLogGroups_ListByResourceGroup", + "operationId": "LogsLogGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListBySubscription.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListBySubscription.json new file mode 100644 index 000000000000..5ed82370d081 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_ListBySubscription.json @@ -0,0 +1,59 @@ +{ + "title": "LogsLogGroups_ListBySubscription", + "operationId": "LogsLogGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Update.json b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Update.json new file mode 100644 index 000000000000..9dedde6971c8 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/examples/2024-12-01/LogsLogGroups_Update.json @@ -0,0 +1,66 @@ +{ + "title": "LogsLogGroups_Update", + "operationId": "LogsLogGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1200": "cwjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LogsLogGroup.Management/main.tsp b/specification/awsconnector/LogsLogGroup.Management/main.tsp new file mode 100644 index 000000000000..1e1067c1842b --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/main.tsp @@ -0,0 +1,141 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LogsLogGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Logs Log Group", + plural: "Logs Log Groups", + }, + keywords: ["Microsoft.AwsConnector", "Logs", "Log", "Group"], +}) +@doc("A Microsoft.AwsConnector resource") +model LogsLogGroup is TrackedResource<LogsLogGroupProperties> { + @doc("Name of LogsLogGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("logsLogGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsLogGroup") +model LogsLogGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsLogsLogGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLogsLogGroup") +model AwsLogsLogGroupProperties { + @doc("Property arn") + arn?: string; + + @doc("Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html).") + dataProtectionPolicy?: unknown; + + @doc("The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)") + kmsKeyId?: string; + + @doc("Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)") + logGroupClass?: LogGroupClass = "STANDARD"; + + @doc("The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group.") + logGroupName?: string; + + @doc("The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html).") + retentionInDays?: int32; + + @doc("An array of key-value pairs to apply to the log group. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("LogGroupClass enum") +union LogGroupClass { + @doc("LogGroupClass enum INFREQUENT_ACCESS") + INFREQUENT_ACCESS: "INFREQUENT_ACCESS", + + @doc("LogGroupClass enum STANDARD") + STANDARD: "STANDARD", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LogsLogGroups { + get is ArmResourceRead<LogsLogGroup>; + @doc("Create a LogsLogGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LogsLogGroup>; + update is ArmCustomPatchAsync< + LogsLogGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<LogsLogGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<LogsLogGroup>; + listByResourceGroup is ArmResourceListByParent<LogsLogGroup>; + listBySubscription is ArmListBySubscription<LogsLogGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Logs::LogGroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LogsLogGroup.Management/tspconfig.yaml b/specification/awsconnector/LogsLogGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..25e8aa139418 --- /dev/null +++ b/specification/awsconnector/LogsLogGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/logsLogGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_CreateOrReplace.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_CreateOrReplace.json new file mode 100644 index 000000000000..c9504c339d67 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "LogsLogStreams_CreateOrReplace", + "operationId": "LogsLogStreams_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + } + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Delete.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Delete.json new file mode 100644 index 000000000000..994dc6e1d7f5 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsLogStreams_Delete", + "operationId": "LogsLogStreams_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Get.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Get.json new file mode 100644 index 000000000000..717f3190e088 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Get.json @@ -0,0 +1,47 @@ +{ + "title": "LogsLogStreams_Get", + "operationId": "LogsLogStreams_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListByResourceGroup.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListByResourceGroup.json new file mode 100644 index 000000000000..8d1325a1afe0 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "LogsLogStreams_ListByResourceGroup", + "operationId": "LogsLogStreams_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListBySubscription.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListBySubscription.json new file mode 100644 index 000000000000..c2bdca633c2e --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "LogsLogStreams_ListBySubscription", + "operationId": "LogsLogStreams_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Update.json b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Update.json new file mode 100644 index 000000000000..581ec2c1b115 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/examples/2024-12-01/LogsLogStreams_Update.json @@ -0,0 +1,57 @@ +{ + "title": "LogsLogStreams_Update", + "operationId": "LogsLogStreams_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5713": "imsoeale" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LogsLogStream.Management/main.tsp b/specification/awsconnector/LogsLogStream.Management/main.tsp new file mode 100644 index 000000000000..1a177666f43e --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/main.tsp @@ -0,0 +1,101 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LogsLogStreams ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Logs Log Stream", + plural: "Logs Log Streams", + }, + keywords: ["Microsoft.AwsConnector", "Logs", "Log", "Stream"], +}) +@doc("A Microsoft.AwsConnector resource") +model LogsLogStream is TrackedResource<LogsLogStreamProperties> { + @doc("Name of LogsLogStream") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("logsLogStreams") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsLogStream") +model LogsLogStreamProperties { + @doc("AWS Properties") + awsProperties?: AwsLogsLogStreamProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLogsLogStream") +model AwsLogsLogStreamProperties { + @doc("The name of the log group where the log stream is created.") + logGroupName?: string; + + @doc("The name of the log stream. The name must be unique wihtin the log group.") + logStreamName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LogsLogStreams { + get is ArmResourceRead<LogsLogStream>; + @doc("Create a LogsLogStream. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LogsLogStream>; + update is ArmCustomPatchAsync< + LogsLogStream, + Azure.ResourceManager.Foundations.TagsUpdateModel<LogsLogStream> + >; + delete is ArmResourceDeleteWithoutOkAsync<LogsLogStream>; + listByResourceGroup is ArmResourceListByParent<LogsLogStream>; + listBySubscription is ArmListBySubscription<LogsLogStream>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Logs::LogStream +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LogsLogStream.Management/tspconfig.yaml b/specification/awsconnector/LogsLogStream.Management/tspconfig.yaml new file mode 100644 index 000000000000..2641b7a1aa87 --- /dev/null +++ b/specification/awsconnector/LogsLogStream.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/logsLogStream.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_CreateOrReplace.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_CreateOrReplace.json new file mode 100644 index 000000000000..0f77888380ac --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "LogsMetricFilters_CreateOrReplace", + "operationId": "LogsMetricFilters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + } + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Delete.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Delete.json new file mode 100644 index 000000000000..4f14d28d920a --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsMetricFilters_Delete", + "operationId": "LogsMetricFilters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Get.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Get.json new file mode 100644 index 000000000000..cae0b4dc1509 --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Get.json @@ -0,0 +1,63 @@ +{ + "title": "LogsMetricFilters_Get", + "operationId": "LogsMetricFilters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListByResourceGroup.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListByResourceGroup.json new file mode 100644 index 000000000000..d8e95aa3e1e3 --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "LogsMetricFilters_ListByResourceGroup", + "operationId": "LogsMetricFilters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListBySubscription.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListBySubscription.json new file mode 100644 index 000000000000..af9eebda7845 --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "LogsMetricFilters_ListBySubscription", + "operationId": "LogsMetricFilters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Update.json b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Update.json new file mode 100644 index 000000000000..b92b9a830e8a --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/examples/2024-12-01/LogsMetricFilters_Update.json @@ -0,0 +1,73 @@ +{ + "title": "LogsMetricFilters_Update", + "operationId": "LogsMetricFilters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key75": "kgh" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LogsMetricFilter.Management/main.tsp b/specification/awsconnector/LogsMetricFilter.Management/main.tsp new file mode 100644 index 000000000000..8ce3a774651a --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/main.tsp @@ -0,0 +1,233 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LogsMetricFilters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Logs Metric Filter", + plural: "Logs Metric Filters", + }, + keywords: ["Microsoft.AwsConnector", "Logs", "Metric", "Filter"], +}) +@doc("A Microsoft.AwsConnector resource") +model LogsMetricFilter is TrackedResource<LogsMetricFilterProperties> { + @doc("Name of LogsMetricFilter") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("logsMetricFilters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsMetricFilter") +model LogsMetricFilterProperties { + @doc("AWS Properties") + awsProperties?: AwsLogsMetricFilterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLogsMetricFilter") +model AwsLogsMetricFilterProperties { + @doc("The name of the metric filter.") + filterName?: string; + + @doc("A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).") + filterPattern?: string; + + @doc("The name of an existing log group that you want to associate with this metric filter.") + logGroupName?: string; + + @doc("The metric transformations.") + @extension("x-ms-identifiers", []) + metricTransformations?: MetricTransformation[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MetricTransformation") +model MetricTransformation { + @doc("(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.") + defaultValue?: int32; + + @doc("The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).") + @extension("x-ms-identifiers", []) + dimensions?: Dimension[]; + + @doc("The name of the CloudWatch metric.") + metricName?: string; + + @doc("A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace).") + metricNamespace?: string; + + @doc("The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``.") + metricValue?: string; + + @doc("The unit to assign to the metric. If you omit this, the unit is set as ``None``.") + unit?: MetricTransformationUnit; +} + +@doc("MetricTransformationUnit enum") +union MetricTransformationUnit { + @doc("MetricTransformationUnit enum Bits") + Bits: "Bits", + + @doc("MetricTransformationUnit enum Bits/Second") + BitsSecond: "Bits/Second", + + @doc("MetricTransformationUnit enum Bytes") + Bytes: "Bytes", + + @doc("MetricTransformationUnit enum Bytes/Second") + BytesSecond: "Bytes/Second", + + @doc("MetricTransformationUnit enum Count") + Count: "Count", + + @doc("MetricTransformationUnit enum Count/Second") + CountSecond: "Count/Second", + + @doc("MetricTransformationUnit enum Gigabits") + Gigabits: "Gigabits", + + @doc("MetricTransformationUnit enum Gigabits/Second") + GigabitsSecond: "Gigabits/Second", + + @doc("MetricTransformationUnit enum Gigabytes") + Gigabytes: "Gigabytes", + + @doc("MetricTransformationUnit enum Gigabytes/Second") + GigabytesSecond: "Gigabytes/Second", + + @doc("MetricTransformationUnit enum Kilobits") + Kilobits: "Kilobits", + + @doc("MetricTransformationUnit enum Kilobits/Second") + KilobitsSecond: "Kilobits/Second", + + @doc("MetricTransformationUnit enum Kilobytes") + Kilobytes: "Kilobytes", + + @doc("MetricTransformationUnit enum Kilobytes/Second") + KilobytesSecond: "Kilobytes/Second", + + @doc("MetricTransformationUnit enum Megabits") + Megabits: "Megabits", + + @doc("MetricTransformationUnit enum Megabits/Second") + MegabitsSecond: "Megabits/Second", + + @doc("MetricTransformationUnit enum Megabytes") + Megabytes: "Megabytes", + + @doc("MetricTransformationUnit enum Megabytes/Second") + MegabytesSecond: "Megabytes/Second", + + @doc("MetricTransformationUnit enum Microseconds") + Microseconds: "Microseconds", + + @doc("MetricTransformationUnit enum Milliseconds") + Milliseconds: "Milliseconds", + + @doc("MetricTransformationUnit enum None") + None: "None", + + @doc("MetricTransformationUnit enum Percent") + Percent: "Percent", + + @doc("MetricTransformationUnit enum Seconds") + Seconds: "Seconds", + + @doc("MetricTransformationUnit enum Terabits") + Terabits: "Terabits", + + @doc("MetricTransformationUnit enum Terabits/Second") + TerabitsSecond: "Terabits/Second", + + @doc("MetricTransformationUnit enum Terabytes") + Terabytes: "Terabytes", + + @doc("MetricTransformationUnit enum Terabytes/Second") + TerabytesSecond: "Terabytes/Second", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Dimension") +model Dimension { + @doc("The name for the CW metric dimension that the metric filter creates. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).") + key?: string; + + @doc("The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LogsMetricFilters { + get is ArmResourceRead<LogsMetricFilter>; + @doc("Create a LogsMetricFilter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LogsMetricFilter>; + update is ArmCustomPatchAsync< + LogsMetricFilter, + Azure.ResourceManager.Foundations.TagsUpdateModel<LogsMetricFilter> + >; + delete is ArmResourceDeleteWithoutOkAsync<LogsMetricFilter>; + listByResourceGroup is ArmResourceListByParent<LogsMetricFilter>; + listBySubscription is ArmListBySubscription<LogsMetricFilter>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Logs::MetricFilter +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LogsMetricFilter.Management/tspconfig.yaml b/specification/awsconnector/LogsMetricFilter.Management/tspconfig.yaml new file mode 100644 index 000000000000..50779dd08965 --- /dev/null +++ b/specification/awsconnector/LogsMetricFilter.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/logsMetricFilter.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_CreateOrReplace.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_CreateOrReplace.json new file mode 100644 index 000000000000..472136effecd --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "LogsSubscriptionFilters_CreateOrReplace", + "operationId": "LogsSubscriptionFilters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + } + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Delete.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Delete.json new file mode 100644 index 000000000000..c4ba58bac994 --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsSubscriptionFilters_Delete", + "operationId": "LogsSubscriptionFilters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Get.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Get.json new file mode 100644 index 000000000000..54dd99e4387c --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Get.json @@ -0,0 +1,51 @@ +{ + "title": "LogsSubscriptionFilters_Get", + "operationId": "LogsSubscriptionFilters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + } + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListByResourceGroup.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListByResourceGroup.json new file mode 100644 index 000000000000..77cde08d6f91 --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "LogsSubscriptionFilters_ListByResourceGroup", + "operationId": "LogsSubscriptionFilters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListBySubscription.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListBySubscription.json new file mode 100644 index 000000000000..9daa1ccc1073 --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "LogsSubscriptionFilters_ListBySubscription", + "operationId": "LogsSubscriptionFilters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Update.json b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Update.json new file mode 100644 index 000000000000..d426a87561c9 --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/examples/2024-12-01/LogsSubscriptionFilters_Update.json @@ -0,0 +1,61 @@ +{ + "title": "LogsSubscriptionFilters_Update", + "operationId": "LogsSubscriptionFilters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6314": "jqbixrisvuk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/main.tsp b/specification/awsconnector/LogsSubscriptionFilter.Management/main.tsp new file mode 100644 index 000000000000..fa9cf918468b --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/main.tsp @@ -0,0 +1,125 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- LogsSubscriptionFilters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Logs Subscription Filter", + plural: "Logs Subscription Filters", + }, + keywords: ["Microsoft.AwsConnector", "Logs", "Subscription", "Filter"], +}) +@doc("A Microsoft.AwsConnector resource") +model LogsSubscriptionFilter + is TrackedResource<LogsSubscriptionFilterProperties> { + @doc("Name of LogsSubscriptionFilter") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("logsSubscriptionFilters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogsSubscriptionFilter") +model LogsSubscriptionFilterProperties { + @doc("AWS Properties") + awsProperties?: AwsLogsSubscriptionFilterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsLogsSubscriptionFilter") +model AwsLogsSubscriptionFilterProperties { + @doc("The Amazon Resource Name (ARN) of the destination.") + destinationArn?: string; + + @doc("The method used to distribute log data to the destination, which can be either random or grouped by log stream.") + distribution?: Distribution; + + @doc("The name of the subscription filter.") + filterName?: string; + + @doc("The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html).") + filterPattern?: string; + + @doc("The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events.") + logGroupName?: string; + + @doc("The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.") + roleArn?: string; +} + +@doc("Distribution enum") +union Distribution { + @doc("Distribution enum ByLogStream") + ByLogStream: "ByLogStream", + + @doc("Distribution enum Random") + Random: "Random", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface LogsSubscriptionFilters { + get is ArmResourceRead<LogsSubscriptionFilter>; + @doc("Create a LogsSubscriptionFilter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<LogsSubscriptionFilter>; + update is ArmCustomPatchAsync< + LogsSubscriptionFilter, + Azure.ResourceManager.Foundations.TagsUpdateModel<LogsSubscriptionFilter> + >; + delete is ArmResourceDeleteWithoutOkAsync<LogsSubscriptionFilter>; + listByResourceGroup is ArmResourceListByParent<LogsSubscriptionFilter>; + listBySubscription is ArmListBySubscription<LogsSubscriptionFilter>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Logs::SubscriptionFilter +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/LogsSubscriptionFilter.Management/tspconfig.yaml b/specification/awsconnector/LogsSubscriptionFilter.Management/tspconfig.yaml new file mode 100644 index 000000000000..dde20154ed9d --- /dev/null +++ b/specification/awsconnector/LogsSubscriptionFilter.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/logsSubscriptionFilter.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_CreateOrReplace.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..5ea477a2e539 --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_CreateOrReplace.json @@ -0,0 +1,355 @@ +{ + "title": "Macie2JobSummaries_CreateOrReplace", + "operationId": "Macie2JobSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + } + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + } + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Delete.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Delete.json new file mode 100644 index 000000000000..501cd4d8476e --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Macie2JobSummaries_Delete", + "operationId": "Macie2JobSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Get.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Get.json new file mode 100644 index 000000000000..411307f8423a --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Get.json @@ -0,0 +1,130 @@ +{ + "title": "Macie2JobSummaries_Get", + "operationId": "Macie2JobSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + } + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListByResourceGroup.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..53e03259d489 --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListByResourceGroup.json @@ -0,0 +1,134 @@ +{ + "title": "Macie2JobSummaries_ListByResourceGroup", + "operationId": "Macie2JobSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListBySubscription.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListBySubscription.json new file mode 100644 index 000000000000..e1257c005e46 --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_ListBySubscription.json @@ -0,0 +1,133 @@ +{ + "title": "Macie2JobSummaries_ListBySubscription", + "operationId": "Macie2JobSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Update.json b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Update.json new file mode 100644 index 000000000000..0c5d3362b11d --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/examples/2024-12-01/Macie2JobSummaries_Update.json @@ -0,0 +1,140 @@ +{ + "title": "Macie2JobSummaries_Update", + "operationId": "Macie2JobSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4316": "ujowm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Macie2JobSummary.Management/main.tsp b/specification/awsconnector/Macie2JobSummary.Management/main.tsp new file mode 100644 index 000000000000..33e494625504 --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/main.tsp @@ -0,0 +1,391 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Macie2JobSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Macie2 Job Summary", + plural: "Macie2 Job Summaries", + }, + keywords: ["Microsoft.AwsConnector", "Macie2", "Job", "Summary"], +}) +@doc("A Microsoft.AwsConnector resource") +model Macie2JobSummary is TrackedResource<Macie2JobSummaryProperties> { + @doc("Name of Macie2JobSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("macie2JobSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Macie2JobSummary") +model Macie2JobSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsMacie2JobSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsMacie2JobSummary") +model AwsMacie2JobSummaryProperties { + @doc("<p>The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.</p>") + bucketCriteria?: S3BucketCriteriaForJob; + + @doc("<p>An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.</p>") + @extension("x-ms-identifiers", []) + bucketDefinitions?: S3BucketDefinitionForJob[]; + + @doc("<p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>") + createdAt?: utcDateTime; + + @doc("<p>The unique identifier for the job.</p>") + jobId?: string; + + @doc("<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>") + jobStatus?: JobStatusEnumValue; + + @doc("<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis.</p></li></ul>") + jobType?: JobTypeEnumValue; + + @doc("<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>") + lastRunErrorStatus?: LastRunErrorStatus; + + @doc("<p>The custom name of the job.</p>") + name?: string; + + @doc("<p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>") + userPausedDetails?: UserPausedDetails; +} + +@doc("JobStatus enum") +union JobStatus { + @doc("JobStatus enum CANCELLED") + CANCELLED: "CANCELLED", + + @doc("JobStatus enum COMPLETE") + COMPLETE: "COMPLETE", + + @doc("JobStatus enum IDLE") + IDLE: "IDLE", + + @doc("JobStatus enum PAUSED") + PAUSED: "PAUSED", + + @doc("JobStatus enum RUNNING") + RUNNING: "RUNNING", + + @doc("JobStatus enum USER_PAUSED") + USER_PAUSED: "USER_PAUSED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of JobStatusEnumValue") +model JobStatusEnumValue { + @doc("Property value") + value?: JobStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3BucketCriteriaForJob") +model S3BucketCriteriaForJob { + @doc("<p>The property- and tag-based conditions that determine which buckets to exclude from the job.</p>") + excludes?: CriteriaBlockForJob; + + @doc("<p>The property- and tag-based conditions that determine which buckets to include in the job.</p>") + includes?: CriteriaBlockForJob; +} + +@doc("JobType enum") +union JobType { + @doc("JobType enum ONE_TIME") + ONE_TIME: "ONE_TIME", + + @doc("JobType enum SCHEDULED") + SCHEDULED: "SCHEDULED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of JobTypeEnumValue") +model JobTypeEnumValue { + @doc("Property value") + value?: JobType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3BucketDefinitionForJob") +model S3BucketDefinitionForJob { + @doc("<p>The unique identifier for the Amazon Web Services account that owns the buckets.</p>") + accountId?: string; + + @doc("<p>An array that lists the names of the buckets.</p>") + @extension("x-ms-identifiers", []) + buckets?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LastRunErrorStatus") +model LastRunErrorStatus { + @doc("<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:</p> <ul><li><p>ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.</p></li> <li><p>NONE - No errors occurred. Macie processed all the data specified for the job.</p></li></ul>") + code?: LastRunErrorStatusCodeEnumValue; +} + +@doc("LastRunErrorStatusCode enum") +union LastRunErrorStatusCode { + @doc("LastRunErrorStatusCode enum ERROR") + ERROR: "ERROR", + + @doc("LastRunErrorStatusCode enum NONE") + NONE: "NONE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LastRunErrorStatusCodeEnumValue") +model LastRunErrorStatusCodeEnumValue { + @doc("Property value") + value?: LastRunErrorStatusCode; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of UserPausedDetails") +model UserPausedDetails { + @doc("<p>The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.</p>") + jobExpiresAt?: utcDateTime; + + @doc("<p>The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.</p>") + jobImminentExpirationHealthEventArn?: string; + + @doc("<p>The date and time, in UTC and extended ISO 8601 format, when you paused the job.</p>") + jobPausedAt?: utcDateTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CriteriaBlockForJob") +model CriteriaBlockForJob { + @doc("<p>An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.</p>") + @extension("x-ms-identifiers", []) + and?: CriteriaForJob[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CriteriaForJob") +model CriteriaForJob { + @doc("<p>A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.</p>") + simpleCriterion?: SimpleCriterionForJob; + + @doc("<p>A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.</p>") + tagCriterion?: TagCriterionForJob; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SimpleCriterionForJob") +model SimpleCriterionForJob { + @doc("<p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>") + comparator?: JobComparatorEnumValue; + + @doc("<p>The property to use in the condition.</p>") + key?: SimpleCriterionKeyForJobEnumValue; + + @doc("<p>An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:</p> <ul><li><p>ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.</p></li> <li><p>S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the <a href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission'>BucketPublicAccess.effectivePermission</a> property of a bucket.</p></li> <li><p>S3_BUCKET_NAME - A string that represents the name of a bucket.</p></li> <li><p>S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the <a href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess'>BucketMetadata.sharedAccess</a> property of a bucket.</p></li></ul> <p>Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.</p>") + @extension("x-ms-identifiers", []) + values?: string[]; +} + +@doc("JobComparator enum") +union JobComparator { + @doc("JobComparator enum CONTAINS") + CONTAINS: "CONTAINS", + + @doc("JobComparator enum EQ") + EQ: "EQ", + + @doc("JobComparator enum GT") + GT: "GT", + + @doc("JobComparator enum GTE") + GTE: "GTE", + + @doc("JobComparator enum LT") + LT: "LT", + + @doc("JobComparator enum LTE") + LTE: "LTE", + + @doc("JobComparator enum NE") + NE: "NE", + + @doc("JobComparator enum STARTS_WITH") + STARTS_WITH: "STARTS_WITH", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of JobComparatorEnumValue") +model JobComparatorEnumValue { + @doc("Property value") + value?: JobComparator; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TagCriterionForJob") +model TagCriterionForJob { + @doc("<p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>") + comparator?: JobComparatorEnumValue; + + @doc("<p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>") + @extension("x-ms-identifiers", []) + tagValues?: TagCriterionPairForJob[]; +} + +@doc("SimpleCriterionKeyForJob enum") +union SimpleCriterionKeyForJob { + @doc("SimpleCriterionKeyForJob enum ACCOUNT_ID") + ACCOUNT_ID: "ACCOUNT_ID", + + @doc("SimpleCriterionKeyForJob enum S3_BUCKET_EFFECTIVE_PERMISSION") + S3_BUCKET_EFFECTIVE_PERMISSION: "S3_BUCKET_EFFECTIVE_PERMISSION", + + @doc("SimpleCriterionKeyForJob enum S3_BUCKET_NAME") + S3_BUCKET_NAME: "S3_BUCKET_NAME", + + @doc("SimpleCriterionKeyForJob enum S3_BUCKET_SHARED_ACCESS") + S3_BUCKET_SHARED_ACCESS: "S3_BUCKET_SHARED_ACCESS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SimpleCriterionKeyForJobEnumValue") +model SimpleCriterionKeyForJobEnumValue { + @doc("Property value") + value?: SimpleCriterionKeyForJob; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TagCriterionPairForJob") +model TagCriterionPairForJob { + @doc("<p>The value for the tag key to use in the condition.</p>") + key?: string; + + @doc("<p>The tag value to use in the condition.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Macie2JobSummaries { + get is ArmResourceRead<Macie2JobSummary>; + @doc("Create a Macie2JobSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Macie2JobSummary>; + update is ArmCustomPatchAsync< + Macie2JobSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<Macie2JobSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<Macie2JobSummary>; + listByResourceGroup is ArmResourceListByParent<Macie2JobSummary>; + listBySubscription is ArmListBySubscription<Macie2JobSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\macie2\macie2-2020-01-01.normal.json +// AWS Shape: JobSummary +// +// Related information for backend service: +// AWS Servcie : Macie2 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.46 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Macie2JobSummary.Management/tspconfig.yaml b/specification/awsconnector/Macie2JobSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..5822a7f05c4e --- /dev/null +++ b/specification/awsconnector/Macie2JobSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/macie2JobSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_CreateOrReplace.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_CreateOrReplace.json new file mode 100644 index 000000000000..4d0c89514698 --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "MacieAllowLists_CreateOrReplace", + "operationId": "MacieAllowLists_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + } + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + } + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Delete.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Delete.json new file mode 100644 index 000000000000..5a6e3956bc75 --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "MacieAllowLists_Delete", + "operationId": "MacieAllowLists_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Get.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Get.json new file mode 100644 index 000000000000..18caf5413c0d --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Get.json @@ -0,0 +1,63 @@ +{ + "title": "MacieAllowLists_Get", + "operationId": "MacieAllowLists_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + } + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListByResourceGroup.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListByResourceGroup.json new file mode 100644 index 000000000000..7a112119e58d --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "MacieAllowLists_ListByResourceGroup", + "operationId": "MacieAllowLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListBySubscription.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListBySubscription.json new file mode 100644 index 000000000000..59d57811d463 --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "MacieAllowLists_ListBySubscription", + "operationId": "MacieAllowLists_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Update.json b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Update.json new file mode 100644 index 000000000000..7981355efb06 --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/examples/2024-12-01/MacieAllowLists_Update.json @@ -0,0 +1,73 @@ +{ + "title": "MacieAllowLists_Update", + "operationId": "MacieAllowLists_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3904": "gamym" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/MacieAllowList.Management/main.tsp b/specification/awsconnector/MacieAllowList.Management/main.tsp new file mode 100644 index 000000000000..210da4359a13 --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/main.tsp @@ -0,0 +1,185 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- MacieAllowLists ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Macie Allow List", + plural: "Macie Allow Lists", + }, + keywords: ["Microsoft.AwsConnector", "Macie", "Allow", "List"], +}) +@doc("A Microsoft.AwsConnector resource") +model MacieAllowList is TrackedResource<MacieAllowListProperties> { + @doc("Name of MacieAllowList") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("macieAllowLists") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MacieAllowList") +model MacieAllowListProperties { + @doc("AWS Properties") + awsProperties?: AwsMacieAllowListProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsMacieAllowList") +model AwsMacieAllowListProperties { + @doc("AllowList ARN.") + arn?: string; + + @doc("AllowList criteria. The regex or s3 object to use for the AllowList.") + criteria?: Criteria; + + @doc("Description of AllowList.") + description?: string; + + @doc("AllowList ID.") + id?: string; + + @doc("Name of AllowList.") + name?: string; + + @doc("AllowList status. The status for the AllowList") + status?: Status; + + @doc("A collection of tags associated with a resource") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("Status enum") +union Status { + @doc("Status enum OK") + OK: "OK", + + @doc("Status enum S3_OBJECT_ACCESS_DENIED") + S3_OBJECT_ACCESS_DENIED: "S3_OBJECT_ACCESS_DENIED", + + @doc("Status enum S3_OBJECT_EMPTY") + S3_OBJECT_EMPTY: "S3_OBJECT_EMPTY", + + @doc("Status enum S3_OBJECT_NOT_FOUND") + S3_OBJECT_NOT_FOUND: "S3_OBJECT_NOT_FOUND", + + @doc("Status enum S3_OBJECT_OVERSIZE") + S3_OBJECT_OVERSIZE: "S3_OBJECT_OVERSIZE", + + @doc("Status enum S3_THROTTLED") + S3_THROTTLED: "S3_THROTTLED", + + @doc("Status enum S3_USER_ACCESS_DENIED") + S3_USER_ACCESS_DENIED: "S3_USER_ACCESS_DENIED", + + @doc("Status enum UNKNOWN_ERROR") + UNKNOWN_ERROR: "UNKNOWN_ERROR", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Criteria") +model Criteria { + @doc("The S3 object key for the AllowList.") + regex?: string; + + @doc("The S3 location for the AllowList.") + s3WordsList?: S3WordsList; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The tag's key.") + key?: string; + + @doc("The tag's value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3WordsList") +model S3WordsList { + @doc("Property bucketName") + bucketName?: string; + + @doc("Property objectKey") + objectKey?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface MacieAllowLists { + get is ArmResourceRead<MacieAllowList>; + @doc("Create a MacieAllowList. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<MacieAllowList>; + update is ArmCustomPatchAsync< + MacieAllowList, + Azure.ResourceManager.Foundations.TagsUpdateModel<MacieAllowList> + >; + delete is ArmResourceDeleteWithoutOkAsync<MacieAllowList>; + listByResourceGroup is ArmResourceListByParent<MacieAllowList>; + listBySubscription is ArmListBySubscription<MacieAllowList>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Macie::AllowList +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/MacieAllowList.Management/tspconfig.yaml b/specification/awsconnector/MacieAllowList.Management/tspconfig.yaml new file mode 100644 index 000000000000..9905340a81cc --- /dev/null +++ b/specification/awsconnector/MacieAllowList.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/macieAllowList.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_CreateOrReplace.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_CreateOrReplace.json new file mode 100644 index 000000000000..c57de77c14f3 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_CreateOrReplace.json @@ -0,0 +1,172 @@ +{ + "title": "NetworkFirewallFirewalls_CreateOrReplace", + "operationId": "NetworkFirewallFirewalls_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + } + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Delete.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Delete.json new file mode 100644 index 000000000000..59a01bf3e9a5 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallFirewalls_Delete", + "operationId": "NetworkFirewallFirewalls_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Get.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Get.json new file mode 100644 index 000000000000..f45480ca013c --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Get.json @@ -0,0 +1,69 @@ +{ + "title": "NetworkFirewallFirewalls_Get", + "operationId": "NetworkFirewallFirewalls_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListByResourceGroup.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListByResourceGroup.json new file mode 100644 index 000000000000..334e659125ac --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "title": "NetworkFirewallFirewalls_ListByResourceGroup", + "operationId": "NetworkFirewallFirewalls_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + ], + "nextLink": "https://microsoft.com/aobno" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListBySubscription.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListBySubscription.json new file mode 100644 index 000000000000..c002b8406ed1 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_ListBySubscription.json @@ -0,0 +1,72 @@ +{ + "title": "NetworkFirewallFirewalls_ListBySubscription", + "operationId": "NetworkFirewallFirewalls_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + ], + "nextLink": "https://microsoft.com/aobno" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Update.json b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Update.json new file mode 100644 index 000000000000..b39910237ea9 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/examples/2024-12-01/NetworkFirewallFirewalls_Update.json @@ -0,0 +1,79 @@ +{ + "title": "NetworkFirewallFirewalls_Update", + "operationId": "NetworkFirewallFirewalls_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3088": "vjjgvfr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/main.tsp b/specification/awsconnector/NetworkFirewallFirewall.Management/main.tsp new file mode 100644 index 000000000000..a262ec10b593 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/main.tsp @@ -0,0 +1,161 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- NetworkFirewallFirewalls ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Network Firewall Firewall", + plural: "Network Firewall Firewalls", + }, + keywords: ["Microsoft.AwsConnector", "Network", "Firewall", "Firewall"], +}) +@doc("A Microsoft.AwsConnector resource") +model NetworkFirewallFirewall + is TrackedResource<NetworkFirewallFirewallProperties> { + @doc("Name of NetworkFirewallFirewall") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("networkFirewallFirewalls") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkFirewallFirewall") +model NetworkFirewallFirewallProperties { + @doc("AWS Properties") + awsProperties?: AwsNetworkFirewallFirewallProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsNetworkFirewallFirewall") +model AwsNetworkFirewallFirewallProperties { + @doc("Property deleteProtection") + deleteProtection?: boolean; + + @doc("Property description") + description?: string; + + @doc("Property endpointIds") + @extension("x-ms-identifiers", []) + endpointIds?: string[]; + + @doc("A resource ARN.") + firewallArn?: string; + + @doc("Property firewallId") + firewallId?: string; + + @doc("Property firewallName") + firewallName?: string; + + @doc("A resource ARN.") + firewallPolicyArn?: string; + + @doc("Property firewallPolicyChangeProtection") + firewallPolicyChangeProtection?: boolean; + + @doc("Property subnetChangeProtection") + subnetChangeProtection?: boolean; + + @doc("Property subnetMappings") + @extension("x-ms-identifiers", []) + subnetMappings?: SubnetMapping[]; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property vpcId") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SubnetMapping") +model SubnetMapping { + @doc("A IPAddressType") + ipAddressType?: string; + + @doc("A SubnetId.") + subnetId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface NetworkFirewallFirewalls { + get is ArmResourceRead<NetworkFirewallFirewall>; + @doc("Create a NetworkFirewallFirewall. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<NetworkFirewallFirewall>; + update is ArmCustomPatchAsync< + NetworkFirewallFirewall, + Azure.ResourceManager.Foundations.TagsUpdateModel<NetworkFirewallFirewall> + >; + delete is ArmResourceDeleteWithoutOkAsync<NetworkFirewallFirewall>; + listByResourceGroup is ArmResourceListByParent<NetworkFirewallFirewall>; + listBySubscription is ArmListBySubscription<NetworkFirewallFirewall>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::NetworkFirewall::Firewall +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/NetworkFirewallFirewall.Management/tspconfig.yaml b/specification/awsconnector/NetworkFirewallFirewall.Management/tspconfig.yaml new file mode 100644 index 000000000000..c1cc3457bd4c --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewall.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkFirewallFirewall.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_CreateOrReplace.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..7c52bfeb0195 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_CreateOrReplace.json @@ -0,0 +1,292 @@ +{ + "title": "NetworkFirewallFirewallPolicies_CreateOrReplace", + "operationId": "NetworkFirewallFirewallPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + } + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Delete.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Delete.json new file mode 100644 index 000000000000..76f971e09080 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Delete", + "operationId": "NetworkFirewallFirewallPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Get.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Get.json new file mode 100644 index 000000000000..807200cbaa77 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Get.json @@ -0,0 +1,109 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Get", + "operationId": "NetworkFirewallFirewallPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListByResourceGroup.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..13dd0d489995 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListByResourceGroup.json @@ -0,0 +1,113 @@ +{ + "title": "NetworkFirewallFirewallPolicies_ListByResourceGroup", + "operationId": "NetworkFirewallFirewallPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListBySubscription.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListBySubscription.json new file mode 100644 index 000000000000..a3347433de09 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_ListBySubscription.json @@ -0,0 +1,112 @@ +{ + "title": "NetworkFirewallFirewallPolicies_ListBySubscription", + "operationId": "NetworkFirewallFirewallPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Update.json b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Update.json new file mode 100644 index 000000000000..5d30ffe97094 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/examples/2024-12-01/NetworkFirewallFirewallPolicies_Update.json @@ -0,0 +1,119 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Update", + "operationId": "NetworkFirewallFirewallPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1616": "holwoveppqufirqaboze" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/main.tsp b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/main.tsp new file mode 100644 index 000000000000..2e927e29e2e5 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/main.tsp @@ -0,0 +1,325 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- NetworkFirewallFirewallPolicies ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Network Firewall Firewall Policy", + plural: "Network Firewall Firewall Policies", + }, + keywords: [ + "Microsoft.AwsConnector", + "Network", + "Firewall", + "Firewall", + "Policy" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model NetworkFirewallFirewallPolicy + is TrackedResource<NetworkFirewallFirewallPolicyProperties> { + @doc("Name of NetworkFirewallFirewallPolicy") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("networkFirewallFirewallPolicies") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkFirewallFirewallPolicy") +model NetworkFirewallFirewallPolicyProperties { + @doc("AWS Properties") + awsProperties?: AwsNetworkFirewallFirewallPolicyProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsNetworkFirewallFirewallPolicy") +model AwsNetworkFirewallFirewallPolicyProperties { + @doc("Property description") + description?: string; + + @doc("Property firewallPolicy") + firewallPolicy?: FirewallPolicy; + + @doc("A resource ARN.") + firewallPolicyArn?: string; + + @doc("Property firewallPolicyId") + firewallPolicyId?: string; + + @doc("Property firewallPolicyName") + firewallPolicyName?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FirewallPolicy") +model FirewallPolicy { + @doc("Property policyVariables") + policyVariables?: RuleVariablesModel; + + @doc("Property statefulDefaultActions") + @extension("x-ms-identifiers", []) + statefulDefaultActions?: string[]; + + @doc("Property statefulEngineOptions") + statefulEngineOptions?: StatefulEngineOptions; + + @doc("Property statefulRuleGroupReferences") + @extension("x-ms-identifiers", []) + statefulRuleGroupReferences?: StatefulRuleGroupReference[]; + + @doc("Property statelessCustomActions") + @extension("x-ms-identifiers", []) + statelessCustomActions?: CustomAction[]; + + @doc("Property statelessDefaultActions") + @extension("x-ms-identifiers", []) + statelessDefaultActions?: string[]; + + @doc("Property statelessFragmentDefaultActions") + @extension("x-ms-identifiers", []) + statelessFragmentDefaultActions?: string[]; + + @doc("Property statelessRuleGroupReferences") + @extension("x-ms-identifiers", []) + statelessRuleGroupReferences?: StatelessRuleGroupReference[]; + + @doc("A resource ARN.") + tlsInspectionConfigurationArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuleVariables") +model RuleVariablesModel { + @doc("Property ruleVariables") + @clientName("ruleVariablescsharp", "csharp") + ruleVariables?: Record<IPSet>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatefulEngineOptions") +model StatefulEngineOptions { + @doc("Property ruleOrder") + ruleOrder?: StatefulEngineOptionsRuleOrder; + + @doc("Property streamExceptionPolicy") + streamExceptionPolicy?: StatefulEngineOptionsStreamExceptionPolicy; +} + +@doc("StatefulEngineOptionsRuleOrder enum") +union StatefulEngineOptionsRuleOrder { + @doc("StatefulEngineOptionsRuleOrder enum DEFAULT_ACTION_ORDER") + DEFAULT_ACTION_ORDER: "DEFAULT_ACTION_ORDER", + + @doc("StatefulEngineOptionsRuleOrder enum STRICT_ORDER") + STRICT_ORDER: "STRICT_ORDER", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatefulRuleGroupReference") +model StatefulRuleGroupReference { + @doc("Property override") + override?: StatefulRuleGroupOverride; + + @doc("Property priority") + priority?: int32; + + @doc("A resource ARN.") + resourceArn?: string; +} + +@doc("StatefulEngineOptionsStreamExceptionPolicy enum") +union StatefulEngineOptionsStreamExceptionPolicy { + @doc("StatefulEngineOptionsStreamExceptionPolicy enum CONTINUE") + CONTINUE: "CONTINUE", + + @doc("StatefulEngineOptionsStreamExceptionPolicy enum DROP") + DROP: "DROP", + + @doc("StatefulEngineOptionsStreamExceptionPolicy enum REJECT") + REJECT: "REJECT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CustomAction") +model CustomAction { + @doc("Property actionDefinition") + actionDefinition?: ActionDefinition; + + @doc("Property actionName") + actionName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatelessRuleGroupReference") +model StatelessRuleGroupReference { + @doc("Property priority") + priority?: int32; + + @doc("A resource ARN.") + resourceArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IPSet") +model IPSet { + @doc("Property definition") + @extension("x-ms-identifiers", []) + definition?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatefulRuleGroupOverride") +model StatefulRuleGroupOverride { + @doc("Property action") + action?: StatefulRuleGroupOverrideAction; +} + +@doc("StatefulRuleGroupOverrideAction enum") +union StatefulRuleGroupOverrideAction { + @doc("StatefulRuleGroupOverrideAction enum DROP_TO_ALERT") + DROP_TO_ALERT: "DROP_TO_ALERT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ActionDefinition") +model ActionDefinition { + @doc("Property publishMetricAction") + publishMetricAction?: PublishMetricAction; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PublishMetricAction") +model PublishMetricAction { + @doc("Property dimensions") + @extension("x-ms-identifiers", []) + dimensions?: Dimension[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Dimension") +model Dimension { + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface NetworkFirewallFirewallPolicies { + get is ArmResourceRead<NetworkFirewallFirewallPolicy>; + @doc("Create a NetworkFirewallFirewallPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<NetworkFirewallFirewallPolicy>; + update is ArmCustomPatchAsync< + NetworkFirewallFirewallPolicy, + Azure.ResourceManager.Foundations.TagsUpdateModel<NetworkFirewallFirewallPolicy> + >; + delete is ArmResourceDeleteWithoutOkAsync<NetworkFirewallFirewallPolicy>; + listByResourceGroup is ArmResourceListByParent<NetworkFirewallFirewallPolicy>; + listBySubscription is ArmListBySubscription<NetworkFirewallFirewallPolicy>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::NetworkFirewall::FirewallPolicy +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/tspconfig.yaml b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/tspconfig.yaml new file mode 100644 index 000000000000..f1d3e993d4ba --- /dev/null +++ b/specification/awsconnector/NetworkFirewallFirewallPolicy.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkFirewallFirewallPolicy.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_CreateOrReplace.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_CreateOrReplace.json new file mode 100644 index 000000000000..e121b17b7130 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_CreateOrReplace.json @@ -0,0 +1,508 @@ +{ + "title": "NetworkFirewallRuleGroups_CreateOrReplace", + "operationId": "NetworkFirewallRuleGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + } + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Delete.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Delete.json new file mode 100644 index 000000000000..34286306ae15 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallRuleGroups_Delete", + "operationId": "NetworkFirewallRuleGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Get.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Get.json new file mode 100644 index 000000000000..3bed1067086a --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Get.json @@ -0,0 +1,181 @@ +{ + "title": "NetworkFirewallRuleGroups_Get", + "operationId": "NetworkFirewallRuleGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListByResourceGroup.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..9b90cff840a6 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListByResourceGroup.json @@ -0,0 +1,185 @@ +{ + "title": "NetworkFirewallRuleGroups_ListByResourceGroup", + "operationId": "NetworkFirewallRuleGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + ], + "nextLink": "https://microsoft.com/aggil" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListBySubscription.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListBySubscription.json new file mode 100644 index 000000000000..bfb3124edefc --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_ListBySubscription.json @@ -0,0 +1,184 @@ +{ + "title": "NetworkFirewallRuleGroups_ListBySubscription", + "operationId": "NetworkFirewallRuleGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + ], + "nextLink": "https://microsoft.com/aggil" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Update.json b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Update.json new file mode 100644 index 000000000000..f7ee0b22ddf3 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/examples/2024-12-01/NetworkFirewallRuleGroups_Update.json @@ -0,0 +1,191 @@ +{ + "title": "NetworkFirewallRuleGroups_Update", + "operationId": "NetworkFirewallRuleGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6654": "hotlqlsbbihxanwfhmjmc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/main.tsp b/specification/awsconnector/NetworkFirewallRuleGroup.Management/main.tsp new file mode 100644 index 000000000000..fe4850d50445 --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/main.tsp @@ -0,0 +1,590 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- NetworkFirewallRuleGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Network Firewall Rule Group", + plural: "Network Firewall Rule Groups", + }, + keywords: ["Microsoft.AwsConnector", "Network", "Firewall", "Rule", "Group"], +}) +@doc("A Microsoft.AwsConnector resource") +model NetworkFirewallRuleGroup + is TrackedResource<NetworkFirewallRuleGroupProperties> { + @doc("Name of NetworkFirewallRuleGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("networkFirewallRuleGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NetworkFirewallRuleGroup") +model NetworkFirewallRuleGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsNetworkFirewallRuleGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsNetworkFirewallRuleGroup") +model AwsNetworkFirewallRuleGroupProperties { + @doc("Property capacity") + capacity?: int32; + + @doc("Property description") + description?: string; + + @doc("Property ruleGroup") + ruleGroup?: RuleGroup; + + @doc("A resource ARN.") + ruleGroupArn?: string; + + @doc("Property ruleGroupId") + ruleGroupId?: string; + + @doc("Property ruleGroupName") + ruleGroupName?: string; + + @doc("Property tags") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property type") + type?: Type; +} + +@doc("Type enum") +union Type { + @doc("Type enum STATEFUL") + STATEFUL: "STATEFUL", + + @doc("Type enum STATELESS") + STATELESS: "STATELESS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuleGroup") +model RuleGroup { + @doc("Property referenceSets") + referenceSets?: ReferenceSets; + + @doc("Property ruleVariables") + ruleVariables?: RuleVariables; + + @doc("Property rulesSource") + rulesSource?: RulesSource; + + @doc("Property statefulRuleOptions") + statefulRuleOptions?: StatefulRuleOptions; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReferenceSets") +model ReferenceSets { + @doc("Property ipSetReferences") + ipSetReferences?: Record<IPSetReference>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuleVariables") +model RuleVariables { + @doc("Property ipSets") + ipSets?: Record<IPSet>; + + @doc("Property portSets") + portSets?: Record<PortSet>; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RulesSource") +model RulesSource { + @doc("Property rulesSourceList") + rulesSourceList?: RulesSourceList; + + @doc("Property rulesString") + rulesString?: string; + + @doc("Property statefulRules") + @extension("x-ms-identifiers", []) + statefulRules?: StatefulRule[]; + + @doc("Property statelessRulesAndCustomActions") + statelessRulesAndCustomActions?: StatelessRulesAndCustomActions; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatefulRuleOptions") +model StatefulRuleOptions { + @doc("Property ruleOrder") + ruleOrder?: StatefulRuleOptionsRuleOrder; +} + +@doc("StatefulRuleOptionsRuleOrder enum") +union StatefulRuleOptionsRuleOrder { + @doc("StatefulRuleOptionsRuleOrder enum DEFAULT_ACTION_ORDER") + DEFAULT_ACTION_ORDER: "DEFAULT_ACTION_ORDER", + + @doc("StatefulRuleOptionsRuleOrder enum STRICT_ORDER") + STRICT_ORDER: "STRICT_ORDER", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IPSetReference") +model IPSetReference { + @doc("A resource ARN.") + referenceArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IPSet") +model IPSet { + @doc("Property definition") + @extension("x-ms-identifiers", []) + definition?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PortSet") +model PortSet { + @doc("Property definition") + @extension("x-ms-identifiers", []) + definition?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RulesSourceList") +model RulesSourceList { + @doc("Property generatedRulesType") + generatedRulesType?: RulesSourceListGeneratedRulesType; + + @doc("Property targetTypes") + @extension("x-ms-identifiers", []) + targetTypes?: string[]; + + @doc("Property targets") + @extension("x-ms-identifiers", []) + targets?: string[]; +} + +@doc("RulesSourceListGeneratedRulesType enum") +union RulesSourceListGeneratedRulesType { + @doc("RulesSourceListGeneratedRulesType enum ALLOWLIST") + ALLOWLIST: "ALLOWLIST", + + @doc("RulesSourceListGeneratedRulesType enum DENYLIST") + DENYLIST: "DENYLIST", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatefulRule") +model StatefulRule { + @doc("Property action") + action?: StatefulRuleAction; + + @doc("Property header") + header?: Header; + + @doc("Property ruleOptions") + @extension("x-ms-identifiers", []) + ruleOptions?: RuleOption[]; +} + +@doc("StatefulRuleAction enum") +union StatefulRuleAction { + @doc("StatefulRuleAction enum ALERT") + ALERT: "ALERT", + + @doc("StatefulRuleAction enum DROP") + DROP: "DROP", + + @doc("StatefulRuleAction enum PASS") + PASS: "PASS", + + @doc("StatefulRuleAction enum REJECT") + REJECT: "REJECT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatelessRulesAndCustomActions") +model StatelessRulesAndCustomActions { + @doc("Property customActions") + @extension("x-ms-identifiers", []) + customActions?: CustomAction[]; + + @doc("Property statelessRules") + @extension("x-ms-identifiers", []) + statelessRules?: StatelessRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Header") +model Header { + @doc("Property destination") + destination?: string; + + @doc("Property destinationPort") + destinationPort?: string; + + @doc("Property direction") + direction?: HeaderDirection; + + @doc("Property protocol") + protocol?: HeaderProtocol; + + @doc("Property source") + source?: string; + + @doc("Property sourcePort") + sourcePort?: string; +} + +@doc("HeaderDirection enum") +union HeaderDirection { + @doc("HeaderDirection enum ANY") + ANY: "ANY", + + @doc("HeaderDirection enum FORWARD") + FORWARD: "FORWARD", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuleOption") +model RuleOption { + @doc("Property keyword") + keyword?: string; + + @doc("Property settings") + @extension("x-ms-identifiers", []) + settings?: string[]; +} + +@doc("HeaderProtocol enum") +union HeaderProtocol { + @doc("HeaderProtocol enum DCERPC") + DCERPC: "DCERPC", + + @doc("HeaderProtocol enum DHCP") + DHCP: "DHCP", + + @doc("HeaderProtocol enum DNS") + DNS: "DNS", + + @doc("HeaderProtocol enum FTP") + FTP: "FTP", + + @doc("HeaderProtocol enum HTTP") + HTTP: "HTTP", + + @doc("HeaderProtocol enum ICMP") + ICMP: "ICMP", + + @doc("HeaderProtocol enum IKEV2") + IKEV2: "IKEV2", + + @doc("HeaderProtocol enum IMAP") + IMAP: "IMAP", + + @doc("HeaderProtocol enum IP") + IP: "IP", + + @doc("HeaderProtocol enum KRB5") + KRB5: "KRB5", + + @doc("HeaderProtocol enum MSN") + MSN: "MSN", + + @doc("HeaderProtocol enum NTP") + NTP: "NTP", + + @doc("HeaderProtocol enum SMB") + SMB: "SMB", + + @doc("HeaderProtocol enum SMTP") + SMTP: "SMTP", + + @doc("HeaderProtocol enum SSH") + SSH: "SSH", + + @doc("HeaderProtocol enum TCP") + TCP: "TCP", + + @doc("HeaderProtocol enum TFTP") + TFTP: "TFTP", + + @doc("HeaderProtocol enum TLS") + TLS: "TLS", + + @doc("HeaderProtocol enum UDP") + UDP: "UDP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CustomAction") +model CustomAction { + @doc("Property actionDefinition") + actionDefinition?: ActionDefinition; + + @doc("Property actionName") + actionName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StatelessRule") +model StatelessRule { + @doc("Property priority") + priority?: int32; + + @doc("Property ruleDefinition") + ruleDefinition?: RuleDefinition; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ActionDefinition") +model ActionDefinition { + @doc("Property publishMetricAction") + publishMetricAction?: PublishMetricAction; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RuleDefinition") +model RuleDefinition { + @doc("Property actions") + @extension("x-ms-identifiers", []) + actions?: string[]; + + @doc("Property matchAttributes") + matchAttributes?: MatchAttributes; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PublishMetricAction") +model PublishMetricAction { + @doc("Property dimensions") + @extension("x-ms-identifiers", []) + dimensions?: Dimension[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MatchAttributes") +model MatchAttributes { + @doc("Property destinationPorts") + @extension("x-ms-identifiers", []) + destinationPorts?: PortRange[]; + + @doc("Property destinations") + @extension("x-ms-identifiers", []) + destinations?: Address[]; + + @doc("Property protocols") + @extension("x-ms-identifiers", []) + protocols?: int32[]; + + @doc("Property sourcePorts") + @extension("x-ms-identifiers", []) + sourcePorts?: PortRange[]; + + @doc("Property sources") + @extension("x-ms-identifiers", []) + sources?: Address[]; + + @doc("Property tcpFlags") + @extension("x-ms-identifiers", []) + tcpFlags?: TCPFlagField[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Dimension") +model Dimension { + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PortRange") +model PortRange { + @doc("Property fromPort") + fromPort?: int32; + + @doc("Property toPort") + toPort?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Address") +model Address { + @doc("Property addressDefinition") + addressDefinition?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TCPFlagField") +model TCPFlagField { + @doc("Property flags") + @extension("x-ms-identifiers", []) + flags?: string[]; + + @doc("Property masks") + @extension("x-ms-identifiers", []) + masks?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface NetworkFirewallRuleGroups { + get is ArmResourceRead<NetworkFirewallRuleGroup>; + @doc("Create a NetworkFirewallRuleGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<NetworkFirewallRuleGroup>; + update is ArmCustomPatchAsync< + NetworkFirewallRuleGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<NetworkFirewallRuleGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<NetworkFirewallRuleGroup>; + listByResourceGroup is ArmResourceListByParent<NetworkFirewallRuleGroup>; + listBySubscription is ArmListBySubscription<NetworkFirewallRuleGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::NetworkFirewall::RuleGroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/NetworkFirewallRuleGroup.Management/tspconfig.yaml b/specification/awsconnector/NetworkFirewallRuleGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..b3b141e2590b --- /dev/null +++ b/specification/awsconnector/NetworkFirewallRuleGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/networkFirewallRuleGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_CreateOrReplace.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..421e3cc0d50b --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_CreateOrReplace.json @@ -0,0 +1,604 @@ +{ + "title": "OpenSearchDomainStatuses_CreateOrReplace", + "operationId": "OpenSearchDomainStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + } + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + } + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Delete.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Delete.json new file mode 100644 index 000000000000..ae173c53df92 --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OpenSearchDomainStatuses_Delete", + "operationId": "OpenSearchDomainStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Get.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Get.json new file mode 100644 index 000000000000..98c6809d5b86 --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Get.json @@ -0,0 +1,213 @@ +{ + "title": "OpenSearchDomainStatuses_Get", + "operationId": "OpenSearchDomainStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + } + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListByResourceGroup.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..596fdd8d791a --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListByResourceGroup.json @@ -0,0 +1,217 @@ +{ + "title": "OpenSearchDomainStatuses_ListByResourceGroup", + "operationId": "OpenSearchDomainStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListBySubscription.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListBySubscription.json new file mode 100644 index 000000000000..95cefbefe79d --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_ListBySubscription.json @@ -0,0 +1,216 @@ +{ + "title": "OpenSearchDomainStatuses_ListBySubscription", + "operationId": "OpenSearchDomainStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Update.json b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Update.json new file mode 100644 index 000000000000..bf48626aabc4 --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/examples/2024-12-01/OpenSearchDomainStatuses_Update.json @@ -0,0 +1,223 @@ +{ + "title": "OpenSearchDomainStatuses_Update", + "operationId": "OpenSearchDomainStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7395": "hktrfj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/main.tsp b/specification/awsconnector/OpenSearchDomainStatus.Management/main.tsp new file mode 100644 index 000000000000..c95981babbf4 --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/main.tsp @@ -0,0 +1,1193 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- OpenSearchDomainStatuses ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Open Search Domain Status", + plural: "Open Search Domain Statuses", + }, + keywords: ["Microsoft.AwsConnector", "Open", "Search", "Domain", "Status"], +}) +@doc("A Microsoft.AwsConnector resource") +model OpenSearchDomainStatus + is TrackedResource<OpenSearchDomainStatusProperties> { + @doc("Name of OpenSearchDomainStatus") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("openSearchDomainStatuses") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OpenSearchDomainStatus") +model OpenSearchDomainStatusProperties { + @doc("AWS Properties") + awsProperties?: AwsOpenSearchDomainStatusProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsOpenSearchDomainStatus") +model AwsOpenSearchDomainStatusProperties { + @doc("<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href='https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html'>IAM identifiers </a> in the <i>AWS Identity and Access Management User Guide</i>.</p>") + arn?: string; + + @doc("<p>Identity and Access Management (IAM) policy document specifying the access policies for the domain.</p>") + accessPolicies?: string; + + @doc("<p>Key-value pairs that specify advanced configuration options.</p>") + advancedOptions?: Record<string>; + + @doc("<p>Settings for fine-grained access control.</p>") + advancedSecurityOptions?: AdvancedSecurityOptions; + + @doc("<p>Auto-Tune settings for the domain.</p>") + autoTuneOptions?: AutoTuneOptionsOutput; + + @doc("<p>Information about a configuration change happening on the domain.</p>") + changeProgressDetails?: ChangeProgressDetails; + + @doc("<p>Container for the cluster configuration of the domain.</p>") + clusterConfig?: ClusterConfig; + + @doc("<p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>") + cognitoOptions?: CognitoOptions; + + @doc("<p>Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.</p>") + created?: boolean; + + @doc("<p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.</p>") + deleted?: boolean; + + @doc("<p>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.</p>") + domainEndpointOptions?: DomainEndpointOptions; + + @doc("<p>Unique identifier for the domain.</p>") + domainId?: string; + + @doc("<p>Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.</p>") + domainName?: string; + + @doc("<p>The status of any changes that are currently in progress for the domain.</p>") + domainProcessingStatus?: DomainProcessingStatusTypeEnumValue; + + @doc("<p>Container for EBS-based storage settings for the domain.</p>") + ebsOptions?: EBSOptions; + + @doc("<p>Encryption at rest settings for the domain.</p>") + encryptionAtRestOptions?: EncryptionAtRestOptions; + + @doc("<p>Domain-specific endpoint used to submit index, search, and data upload requests to the domain.</p>") + endpoint?: string; + + @doc("<p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. </p>") + endpointV2?: string; + + @doc("<p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>") + endpoints?: Record<string>; + + @doc("<p>Version of OpenSearch or Elasticsearch that the domain is running, in the format <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>") + engineVersion?: string; + + @doc("<p>The type of IP addresses supported by the endpoint for the domain.</p>") + ipAddressType?: IPAddressTypeEnumValue; + + @doc("<p>Log publishing options for the domain.</p>") + logPublishingOptions?: Record<LogPublishingOption>; + + @doc("<p>Information about the domain properties that are currently being modified.</p>") + @extension("x-ms-identifiers", []) + modifyingProperties?: ModifyingProperties[]; + + @doc("<p>Whether node-to-node encryption is enabled or disabled.</p>") + nodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions; + + @doc("<p>Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.</p>") + offPeakWindowOptions?: OffPeakWindowOptions; + + @doc("<p>The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.</p>") + processing?: boolean; + + @doc("<p>The current status of the domain's service software.</p>") + serviceSoftwareOptions?: ServiceSoftwareOptions; + + @doc("<p>DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.</p>") + snapshotOptions?: SnapshotOptions; + + @doc("<p>Service software update options for the domain.</p>") + softwareUpdateOptions?: SoftwareUpdateOptions; + + @doc("<p>The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.</p>") + upgradeProcessing?: boolean; + + @doc("<p>The VPC configuration for the domain.</p>") + vpcOptions?: VPCDerivedInfo; +} + +@doc("DomainProcessingStatusType enum") +union DomainProcessingStatusType { + @doc("DomainProcessingStatusType enum Active") + Active: "Active", + + @doc("DomainProcessingStatusType enum Creating") + Creating: "Creating", + + @doc("DomainProcessingStatusType enum Deleting") + Deleting: "Deleting", + + @doc("DomainProcessingStatusType enum Isolated") + Isolated: "Isolated", + + @doc("DomainProcessingStatusType enum Modifying") + Modifying: "Modifying", + + @doc("DomainProcessingStatusType enum UpdatingServiceSoftware") + UpdatingServiceSoftware: "UpdatingServiceSoftware", + + @doc("DomainProcessingStatusType enum UpgradingEngineVersion") + UpgradingEngineVersion: "UpgradingEngineVersion", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DomainProcessingStatusTypeEnumValue") +model DomainProcessingStatusTypeEnumValue { + @doc("Property value") + value?: DomainProcessingStatusType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AdvancedSecurityOptions") +model AdvancedSecurityOptions { + @doc("<p>Date and time when the migration period will be disabled. Only necessary when <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'>enabling fine-grained access control on an existing domain</a>.</p>") + anonymousAuthDisableDate?: utcDateTime; + + @doc("<p>True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'>enabling fine-grained access control on an existing domain</a>.</p>") + anonymousAuthEnabled?: boolean; + + @doc("<p>True if fine-grained access control is enabled.</p>") + enabled?: boolean; + + @doc("<p>True if the internal user database is enabled.</p>") + internalUserDatabaseEnabled?: boolean; + + @doc("<p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>") + samlOptions?: SAMLOptionsOutput; +} + +@doc("IPAddressType enum") +union IPAddressType { + @doc("IPAddressType enum dualstack") + Dualstack: "dualstack", + + @doc("IPAddressType enum ipv4") + Ipv4: "ipv4", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IPAddressTypeEnumValue") +model IPAddressTypeEnumValue { + @doc("Property value") + value?: IPAddressType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AutoTuneOptionsOutput") +model AutoTuneOptionsOutput { + @doc("<p>Any errors that occurred while enabling or disabling Auto-Tune.</p>") + errorMessage?: string; + + @doc("<p>The current state of Auto-Tune on the domain.</p>") + state?: AutoTuneStateEnumValue; + + @doc("<p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.</p>") + useOffPeakWindow?: boolean; +} + +@doc("AutoTuneState enum") +union AutoTuneState { + @doc("AutoTuneState enum DISABLED") + DISABLED: "DISABLED", + + @doc("AutoTuneState enum DISABLED_AND_ROLLBACK_COMPLETE") + DISABLED_AND_ROLLBACK_COMPLETE: "DISABLED_AND_ROLLBACK_COMPLETE", + + @doc("AutoTuneState enum DISABLED_AND_ROLLBACK_ERROR") + DISABLED_AND_ROLLBACK_ERROR: "DISABLED_AND_ROLLBACK_ERROR", + + @doc("AutoTuneState enum DISABLED_AND_ROLLBACK_IN_PROGRESS") + DISABLED_AND_ROLLBACK_IN_PROGRESS: "DISABLED_AND_ROLLBACK_IN_PROGRESS", + + @doc("AutoTuneState enum DISABLED_AND_ROLLBACK_SCHEDULED") + DISABLED_AND_ROLLBACK_SCHEDULED: "DISABLED_AND_ROLLBACK_SCHEDULED", + + @doc("AutoTuneState enum DISABLE_IN_PROGRESS") + DISABLE_IN_PROGRESS: "DISABLE_IN_PROGRESS", + + @doc("AutoTuneState enum ENABLED") + ENABLED: "ENABLED", + + @doc("AutoTuneState enum ENABLE_IN_PROGRESS") + ENABLE_IN_PROGRESS: "ENABLE_IN_PROGRESS", + + @doc("AutoTuneState enum ERROR") + ERROR: "ERROR", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AutoTuneStateEnumValue") +model AutoTuneStateEnumValue { + @doc("Property value") + value?: AutoTuneState; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ChangeProgressDetails") +model ChangeProgressDetails { + @doc("<p>The ID of the configuration change.</p>") + changeId?: string; + + @doc("<p>The current status of the configuration change.</p>") + configChangeStatus?: ConfigChangeStatusEnumValue; + + @doc("<p>The IAM principal who initiated the configuration change.</p>") + initiatedBy?: InitiatedByEnumValue; + + @doc("<p>The last time that the configuration change was updated.</p>") + lastUpdatedTime?: utcDateTime; + + @doc("<p>A message corresponding to the status of the configuration change.</p>") + message?: string; + + @doc("<p>The time that the configuration change was initiated, in Universal Coordinated Time (UTC).</p>") + startTime?: utcDateTime; +} + +@doc("ConfigChangeStatus enum") +union ConfigChangeStatus { + @doc("ConfigChangeStatus enum ApplyingChanges") + ApplyingChanges: "ApplyingChanges", + + @doc("ConfigChangeStatus enum Cancelled") + Cancelled: "Cancelled", + + @doc("ConfigChangeStatus enum Completed") + Completed: "Completed", + + @doc("ConfigChangeStatus enum Initializing") + Initializing: "Initializing", + + @doc("ConfigChangeStatus enum Pending") + Pending: "Pending", + + @doc("ConfigChangeStatus enum PendingUserInput") + PendingUserInput: "PendingUserInput", + + @doc("ConfigChangeStatus enum Validating") + Validating: "Validating", + + @doc("ConfigChangeStatus enum ValidationFailed") + ValidationFailed: "ValidationFailed", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ConfigChangeStatusEnumValue") +model ConfigChangeStatusEnumValue { + @doc("Property value") + value?: ConfigChangeStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ClusterConfig") +model ClusterConfig { + @doc("<p>Container for cold storage configuration options.</p>") + coldStorageOptions?: ColdStorageOptions; + + @doc("<p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.</p>") + dedicatedMasterCount?: int32; + + @doc("<p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code> if the cluster will use a dedicated master node.<code>False</code> if the cluster will not.</p>") + dedicatedMasterEnabled?: boolean; + + @doc("<p>OpenSearch Service instance type of the dedicated master nodes in the cluster.</p>") + dedicatedMasterType?: OpenSearchPartitionInstanceTypeEnumValue; + + @doc("<p>Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.</p>") + instanceCount?: int32; + + @doc("<p>Instance type of data nodes in the cluster.</p>") + instanceType?: OpenSearchPartitionInstanceTypeEnumValue; + + @doc("<p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'>Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </p>") + multiAZWithStandbyEnabled?: boolean; + + @doc("<p>The number of warm nodes in the cluster.</p>") + warmCount?: int32; + + @doc("<p>Whether to enable warm storage for the cluster.</p>") + warmEnabled?: boolean; + + @doc("<p>The instance type for the cluster's warm nodes.</p>") + warmType?: OpenSearchWarmPartitionInstanceTypeEnumValue; + + @doc("<p>Container for zone awareness configuration options. Only required if <code>ZoneAwarenessEnabled</code> is <code>true</code>.</p>") + zoneAwarenessConfig?: ZoneAwarenessConfig; + + @doc("<p>Indicates whether multiple Availability Zones are enabled. For more information, see <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'>Configuring a multi-AZ domain in Amazon OpenSearch Service</a>.</p>") + zoneAwarenessEnabled?: boolean; +} + +@doc("InitiatedBy enum") +union InitiatedBy { + @doc("InitiatedBy enum CUSTOMER") + CUSTOMER: "CUSTOMER", + + @doc("InitiatedBy enum SERVICE") + SERVICE: "SERVICE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InitiatedByEnumValue") +model InitiatedByEnumValue { + @doc("Property value") + value?: InitiatedBy; +} + +@doc("OpenSearchWarmPartitionInstanceType enum") +union OpenSearchWarmPartitionInstanceType { + @doc("OpenSearchWarmPartitionInstanceType enum ultrawarm1.large.search") + Ultrawarm1LargeSearch: "ultrawarm1.large.search", + + @doc("OpenSearchWarmPartitionInstanceType enum ultrawarm1.medium.search") + Ultrawarm1MediumSearch: "ultrawarm1.medium.search", + + @doc("OpenSearchWarmPartitionInstanceType enum ultrawarm1.xlarge.search") + Ultrawarm1XlargeSearch: "ultrawarm1.xlarge.search", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OpenSearchWarmPartitionInstanceTypeEnumValue") +model OpenSearchWarmPartitionInstanceTypeEnumValue { + @doc("Property value") + value?: OpenSearchWarmPartitionInstanceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CognitoOptions") +model CognitoOptions { + @doc("<p>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</p>") + enabled?: boolean; + + @doc("<p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>") + identityPoolId?: string; + + @doc("<p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch Service to configure your user pool and identity pool.</p>") + roleArn?: string; + + @doc("<p>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>") + userPoolId?: string; +} + +@doc("OpenSearchPartitionInstanceType enum") +union OpenSearchPartitionInstanceType { + @doc("OpenSearchPartitionInstanceType enum c4.2xlarge.search") + C42xlargeSearch: "c4.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c4.4xlarge.search") + C44xlargeSearch: "c4.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c4.8xlarge.search") + C48xlargeSearch: "c4.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c4.large.search") + C4LargeSearch: "c4.large.search", + + @doc("OpenSearchPartitionInstanceType enum c4.xlarge.search") + C4XlargeSearch: "c4.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c5.18xlarge.search") + C518xlargeSearch: "c5.18xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c5.2xlarge.search") + C52xlargeSearch: "c5.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c5.4xlarge.search") + C54xlargeSearch: "c5.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c5.9xlarge.search") + C59xlargeSearch: "c5.9xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c5.large.search") + C5LargeSearch: "c5.large.search", + + @doc("OpenSearchPartitionInstanceType enum c5.xlarge.search") + C5XlargeSearch: "c5.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.12xlarge.search") + C6g12xlargeSearch: "c6g.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.2xlarge.search") + C6g2xlargeSearch: "c6g.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.4xlarge.search") + C6g4xlargeSearch: "c6g.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.8xlarge.search") + C6g8xlargeSearch: "c6g.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.large.search") + C6gLargeSearch: "c6g.large.search", + + @doc("OpenSearchPartitionInstanceType enum c6g.xlarge.search") + C6gXlargeSearch: "c6g.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum d2.2xlarge.search") + D22xlargeSearch: "d2.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum d2.4xlarge.search") + D24xlargeSearch: "d2.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum d2.8xlarge.search") + D28xlargeSearch: "d2.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum d2.xlarge.search") + D2XlargeSearch: "d2.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i2.2xlarge.search") + I22xlargeSearch: "i2.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i2.xlarge.search") + I2XlargeSearch: "i2.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i3.16xlarge.search") + I316xlargeSearch: "i3.16xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i3.2xlarge.search") + I32xlargeSearch: "i3.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i3.4xlarge.search") + I34xlargeSearch: "i3.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i3.8xlarge.search") + I38xlargeSearch: "i3.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum i3.large.search") + I3LargeSearch: "i3.large.search", + + @doc("OpenSearchPartitionInstanceType enum i3.xlarge.search") + I3XlargeSearch: "i3.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m3.2xlarge.search") + M32xlargeSearch: "m3.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m3.large.search") + M3LargeSearch: "m3.large.search", + + @doc("OpenSearchPartitionInstanceType enum m3.medium.search") + M3MediumSearch: "m3.medium.search", + + @doc("OpenSearchPartitionInstanceType enum m3.xlarge.search") + M3XlargeSearch: "m3.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m4.10xlarge.search") + M410xlargeSearch: "m4.10xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m4.2xlarge.search") + M42xlargeSearch: "m4.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m4.4xlarge.search") + M44xlargeSearch: "m4.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m4.large.search") + M4LargeSearch: "m4.large.search", + + @doc("OpenSearchPartitionInstanceType enum m4.xlarge.search") + M4XlargeSearch: "m4.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m5.12xlarge.search") + M512xlargeSearch: "m5.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m5.24xlarge.search") + M524xlargeSearch: "m5.24xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m5.2xlarge.search") + M52xlargeSearch: "m5.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m5.4xlarge.search") + M54xlargeSearch: "m5.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m5.large.search") + M5LargeSearch: "m5.large.search", + + @doc("OpenSearchPartitionInstanceType enum m5.xlarge.search") + M5XlargeSearch: "m5.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.12xlarge.search") + M6g12xlargeSearch: "m6g.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.2xlarge.search") + M6g2xlargeSearch: "m6g.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.4xlarge.search") + M6g4xlargeSearch: "m6g.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.8xlarge.search") + M6g8xlargeSearch: "m6g.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.large.search") + M6gLargeSearch: "m6g.large.search", + + @doc("OpenSearchPartitionInstanceType enum m6g.xlarge.search") + M6gXlargeSearch: "m6g.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.12xlarge.search") + Or112xlargeSearch: "or1.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.16xlarge.search") + Or116xlargeSearch: "or1.16xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.2xlarge.search") + Or12xlargeSearch: "or1.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.4xlarge.search") + Or14xlargeSearch: "or1.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.8xlarge.search") + Or18xlargeSearch: "or1.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum or1.large.search") + Or1LargeSearch: "or1.large.search", + + @doc("OpenSearchPartitionInstanceType enum or1.medium.search") + Or1MediumSearch: "or1.medium.search", + + @doc("OpenSearchPartitionInstanceType enum or1.xlarge.search") + Or1XlargeSearch: "or1.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r3.2xlarge.search") + R32xlargeSearch: "r3.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r3.4xlarge.search") + R34xlargeSearch: "r3.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r3.8xlarge.search") + R38xlargeSearch: "r3.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r3.large.search") + R3LargeSearch: "r3.large.search", + + @doc("OpenSearchPartitionInstanceType enum r3.xlarge.search") + R3XlargeSearch: "r3.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r4.16xlarge.search") + R416xlargeSearch: "r4.16xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r4.2xlarge.search") + R42xlargeSearch: "r4.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r4.4xlarge.search") + R44xlargeSearch: "r4.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r4.8xlarge.search") + R48xlargeSearch: "r4.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r4.large.search") + R4LargeSearch: "r4.large.search", + + @doc("OpenSearchPartitionInstanceType enum r4.xlarge.search") + R4XlargeSearch: "r4.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r5.12xlarge.search") + R512xlargeSearch: "r5.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r5.24xlarge.search") + R524xlargeSearch: "r5.24xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r5.2xlarge.search") + R52xlargeSearch: "r5.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r5.4xlarge.search") + R54xlargeSearch: "r5.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r5.large.search") + R5LargeSearch: "r5.large.search", + + @doc("OpenSearchPartitionInstanceType enum r5.xlarge.search") + R5XlargeSearch: "r5.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.12xlarge.search") + R6g12xlargeSearch: "r6g.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.2xlarge.search") + R6g2xlargeSearch: "r6g.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.4xlarge.search") + R6g4xlargeSearch: "r6g.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.8xlarge.search") + R6g8xlargeSearch: "r6g.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.large.search") + R6gLargeSearch: "r6g.large.search", + + @doc("OpenSearchPartitionInstanceType enum r6g.xlarge.search") + R6gXlargeSearch: "r6g.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.12xlarge.search") + R6gd12xlargeSearch: "r6gd.12xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.16xlarge.search") + R6gd16xlargeSearch: "r6gd.16xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.2xlarge.search") + R6gd2xlargeSearch: "r6gd.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.4xlarge.search") + R6gd4xlargeSearch: "r6gd.4xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.8xlarge.search") + R6gd8xlargeSearch: "r6gd.8xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.large.search") + R6gdLargeSearch: "r6gd.large.search", + + @doc("OpenSearchPartitionInstanceType enum r6gd.xlarge.search") + R6gdXlargeSearch: "r6gd.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum t2.medium.search") + T2MediumSearch: "t2.medium.search", + + @doc("OpenSearchPartitionInstanceType enum t2.micro.search") + T2MicroSearch: "t2.micro.search", + + @doc("OpenSearchPartitionInstanceType enum t2.small.search") + T2SmallSearch: "t2.small.search", + + @doc("OpenSearchPartitionInstanceType enum t3.2xlarge.search") + T32xlargeSearch: "t3.2xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum t3.large.search") + T3LargeSearch: "t3.large.search", + + @doc("OpenSearchPartitionInstanceType enum t3.medium.search") + T3MediumSearch: "t3.medium.search", + + @doc("OpenSearchPartitionInstanceType enum t3.micro.search") + T3MicroSearch: "t3.micro.search", + + @doc("OpenSearchPartitionInstanceType enum t3.nano.search") + T3NanoSearch: "t3.nano.search", + + @doc("OpenSearchPartitionInstanceType enum t3.small.search") + T3SmallSearch: "t3.small.search", + + @doc("OpenSearchPartitionInstanceType enum t3.xlarge.search") + T3XlargeSearch: "t3.xlarge.search", + + @doc("OpenSearchPartitionInstanceType enum t4g.medium.search") + T4gMediumSearch: "t4g.medium.search", + + @doc("OpenSearchPartitionInstanceType enum t4g.small.search") + T4gSmallSearch: "t4g.small.search", + + @doc("OpenSearchPartitionInstanceType enum ultrawarm1.large.search") + Ultrawarm1LargeSearch: "ultrawarm1.large.search", + + @doc("OpenSearchPartitionInstanceType enum ultrawarm1.medium.search") + Ultrawarm1MediumSearch: "ultrawarm1.medium.search", + + @doc("OpenSearchPartitionInstanceType enum ultrawarm1.xlarge.search") + Ultrawarm1XlargeSearch: "ultrawarm1.xlarge.search", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OpenSearchPartitionInstanceTypeEnumValue") +model OpenSearchPartitionInstanceTypeEnumValue { + @doc("Property value") + value?: OpenSearchPartitionInstanceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DomainEndpointOptions") +model DomainEndpointOptions { + @doc("<p>The fully qualified URL for the custom endpoint.</p>") + customEndpoint?: string; + + @doc("<p>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</p>") + customEndpointCertificateArn?: string; + + @doc("<p>Whether to enable a custom endpoint for the domain.</p>") + customEndpointEnabled?: boolean; + + @doc("<p>True to require that all traffic to the domain arrive over HTTPS.</p>") + enforceHTTPS?: boolean; + + @doc("<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:</p> <ul> <li> <p> <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that supports only TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p> </li> </ul>") + tlsSecurityPolicy?: TLSSecurityPolicyEnumValue; +} + +@doc("TLSSecurityPolicy enum") +union TLSSecurityPolicy { + @doc("TLSSecurityPolicy enum Policy-Min-TLS-1-0-2019-07") + PolicyMinTLS10201907: "Policy-Min-TLS-1-0-2019-07", + + @doc("TLSSecurityPolicy enum Policy-Min-TLS-1-2-2019-07") + PolicyMinTLS12201907: "Policy-Min-TLS-1-2-2019-07", + + @doc("TLSSecurityPolicy enum Policy-Min-TLS-1-2-PFS-2023-10") + PolicyMinTLS12PFS202310: "Policy-Min-TLS-1-2-PFS-2023-10", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TLSSecurityPolicyEnumValue") +model TLSSecurityPolicyEnumValue { + @doc("Property value") + value?: TLSSecurityPolicy; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EBSOptions") +model EBSOptions { + @doc("<p>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</p>") + ebsEnabled?: boolean; + + @doc("<p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> and provisioned IOPS EBS volume types.</p>") + iops?: int32; + + @doc("<p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> volume type.</p>") + throughput?: int32; + + @doc("<p>Specifies the size (in GiB) of EBS volumes attached to data nodes.</p>") + volumeSize?: int32; + + @doc("<p>Specifies the type of EBS volumes attached to data nodes.</p>") + volumeType?: VolumeTypeEnumValue; +} + +@doc("VolumeType enum") +union VolumeType { + @doc("VolumeType enum gp2") + Gp2: "gp2", + + @doc("VolumeType enum gp3") + Gp3: "gp3", + + @doc("VolumeType enum io1") + Io1: "io1", + + @doc("VolumeType enum standard") + Standard: "standard", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VolumeTypeEnumValue") +model VolumeTypeEnumValue { + @doc("Property value") + value?: VolumeType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EncryptionAtRestOptions") +model EncryptionAtRestOptions { + @doc("<p>True to enable encryption at rest.</p>") + enabled?: boolean; + + @doc("<p>The KMS key ID. Takes the form <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>") + kmsKeyId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LogPublishingOption") +model LogPublishingOption { + @doc("<p>The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.</p>") + cloudWatchLogsLogGroupArn?: string; + + @doc("<p>Whether the log should be published.</p>") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ModifyingProperties") +model ModifyingProperties { + @doc("<p>The current value of the domain property that is being modified.</p>") + activeValue?: string; + + @doc("<p>The name of the property that is currently being modified.</p>") + name?: string; + + @doc("<p>The value that the property that is currently being modified will eventually have.</p>") + pendingValue?: string; + + @doc("<p>The type of value that is currently being modified. Properties can have two types:</p> <ul> <li> <p> <code>PLAIN_TEXT</code>: Contain direct values such as '1', 'True', or 'c5.large.search'.</p> </li> <li> <p> <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as {'Enabled':'True'}'.</p> </li> </ul>") + valueType?: PropertyValueTypeEnumValue; +} + +@doc("PropertyValueType enum") +union PropertyValueType { + @doc("PropertyValueType enum PLAIN_TEXT") + PLAIN_TEXT: "PLAIN_TEXT", + + @doc("PropertyValueType enum STRINGIFIED_JSON") + STRINGIFIED_JSON: "STRINGIFIED_JSON", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PropertyValueTypeEnumValue") +model PropertyValueTypeEnumValue { + @doc("Property value") + value?: PropertyValueType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NodeToNodeEncryptionOptions") +model NodeToNodeEncryptionOptions { + @doc("<p>True to enable node-to-node encryption.</p>") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OffPeakWindowOptions") +model OffPeakWindowOptions { + @doc("<p>Whether to enable an off-peak window.</p> <p>This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.</p>") + enabled?: boolean; + + @doc("<p>Off-peak window settings for the domain.</p>") + offPeakWindow?: OffPeakWindow; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServiceSoftwareOptions") +model ServiceSoftwareOptions { + @doc("<p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>") + automatedUpdateDate?: utcDateTime; + + @doc("<p> True if you're able to cancel your service software version update. False if you can't cancel your service software update.</p>") + cancellable?: boolean; + + @doc("<p>The current service software version present on the domain.</p>") + currentVersion?: string; + + @doc("<p>A description of the service software update status.</p>") + description?: string; + + @doc("<p>The new service software version, if one is available.</p>") + newVersion?: string; + + @doc("<p>True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.</p>") + optionalDeployment?: boolean; + + @doc("<p>True if you're able to update your service software version. False if you can't update your service software version.</p>") + updateAvailable?: boolean; + + @doc("<p>The status of your service software update.</p>") + updateStatus?: DeploymentStatusEnumValue; +} + +@doc("DeploymentStatus enum") +union DeploymentStatus { + @doc("DeploymentStatus enum COMPLETED") + COMPLETED: "COMPLETED", + + @doc("DeploymentStatus enum ELIGIBLE") + ELIGIBLE: "ELIGIBLE", + + @doc("DeploymentStatus enum IN_PROGRESS") + IN_PROGRESS: "IN_PROGRESS", + + @doc("DeploymentStatus enum NOT_ELIGIBLE") + NOT_ELIGIBLE: "NOT_ELIGIBLE", + + @doc("DeploymentStatus enum PENDING_UPDATE") + PENDING_UPDATE: "PENDING_UPDATE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeploymentStatusEnumValue") +model DeploymentStatusEnumValue { + @doc("Property value") + value?: DeploymentStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnapshotOptions") +model SnapshotOptions { + @doc("<p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours.</p>") + automatedSnapshotStartHour?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SoftwareUpdateOptions") +model SoftwareUpdateOptions { + @doc("<p>Whether automatic service software updates are enabled for the domain.</p>") + autoSoftwareUpdateEnabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VPCDerivedInfo") +model VPCDerivedInfo { + @doc("<p>The list of Availability Zones associated with the VPC subnets.</p>") + @extension("x-ms-identifiers", []) + availabilityZones?: string[]; + + @doc("<p>The list of security group IDs associated with the VPC endpoints for the domain.</p>") + @extension("x-ms-identifiers", []) + securityGroupIds?: string[]; + + @doc("<p>A list of subnet IDs associated with the VPC endpoints for the domain.</p>") + @extension("x-ms-identifiers", []) + subnetIds?: string[]; + + @doc("<p>The ID for your VPC. Amazon VPC generates this value when you create a VPC.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SAMLOptionsOutput") +model SAMLOptionsOutput { + @doc("<p>True if SAML is enabled.</p>") + enabled?: boolean; + + @doc("<p>Describes the SAML identity provider's information.</p>") + idp?: SAMLIdp; + + @doc("<p>The key used for matching the SAML roles attribute.</p>") + rolesKey?: string; + + @doc("<p>The duration, in minutes, after which a user session becomes inactive.</p>") + sessionTimeoutMinutes?: int32; + + @doc("<p>The key used for matching the SAML subject attribute.</p>") + subjectKey?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ColdStorageOptions") +model ColdStorageOptions { + @doc("<p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.</p>") + enabled?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ZoneAwarenessConfig") +model ZoneAwarenessConfig { + @doc("<p>If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are <code>2</code> and <code>3</code>. If your domain is provisioned within a VPC, this value be equal to number of subnets.</p>") + availabilityZoneCount?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OffPeakWindow") +model OffPeakWindow { + @doc("<p>A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.</p>") + windowStartTime?: WindowStartTime; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SAMLIdp") +model SAMLIdp { + @doc("<p>The unique entity ID of the application in the SAML identity provider.</p>") + entityId?: string; + + @doc("<p>The metadata of the SAML application, in XML format.</p>") + metadataContent?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WindowStartTime") +model WindowStartTime { + @doc("<p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, <code>17</code> refers to 5:00 P.M. UTC.</p>") + hours?: int64; + + @doc("<p>The start minute of the window, in UTC.</p>") + minutes?: int64; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface OpenSearchDomainStatuses { + get is ArmResourceRead<OpenSearchDomainStatus>; + @doc("Create a OpenSearchDomainStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<OpenSearchDomainStatus>; + update is ArmCustomPatchAsync< + OpenSearchDomainStatus, + Azure.ResourceManager.Foundations.TagsUpdateModel<OpenSearchDomainStatus> + >; + delete is ArmResourceDeleteWithoutOkAsync<OpenSearchDomainStatus>; + listByResourceGroup is ArmResourceListByParent<OpenSearchDomainStatus>; + listBySubscription is ArmListBySubscription<OpenSearchDomainStatus>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\OpenSearch\opensearch-2021-01-01.normal.json +// AWS Shape: DomainStatus +// +// Related information for backend service: +// AWS Servcie : OpenSearch +// Product Version : 3.7.798.0 +// SDK Version : undefined +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/OpenSearchDomainStatus.Management/tspconfig.yaml b/specification/awsconnector/OpenSearchDomainStatus.Management/tspconfig.yaml new file mode 100644 index 000000000000..6333af624b9b --- /dev/null +++ b/specification/awsconnector/OpenSearchDomainStatus.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/openSearchDomainStatus.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_CreateOrReplace.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_CreateOrReplace.json new file mode 100644 index 000000000000..620c3e4e605f --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_CreateOrReplace.json @@ -0,0 +1,151 @@ +{ + "title": "OrganizationsAccounts_CreateOrReplace", + "operationId": "OrganizationsAccounts_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + } + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + } + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Delete.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Delete.json new file mode 100644 index 000000000000..de3453547214 --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OrganizationsAccounts_Delete", + "operationId": "OrganizationsAccounts_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Get.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Get.json new file mode 100644 index 000000000000..ec8d031d637c --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Get.json @@ -0,0 +1,62 @@ +{ + "title": "OrganizationsAccounts_Get", + "operationId": "OrganizationsAccounts_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + } + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListByResourceGroup.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..75a8f46fb714 --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "OrganizationsAccounts_ListByResourceGroup", + "operationId": "OrganizationsAccounts_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListBySubscription.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListBySubscription.json new file mode 100644 index 000000000000..2fe43622fc69 --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "OrganizationsAccounts_ListBySubscription", + "operationId": "OrganizationsAccounts_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Update.json b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Update.json new file mode 100644 index 000000000000..a1fc5ac8a8ad --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/examples/2024-12-01/OrganizationsAccounts_Update.json @@ -0,0 +1,72 @@ +{ + "title": "OrganizationsAccounts_Update", + "operationId": "OrganizationsAccounts_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8859": "bqumxpfvigc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsAccount.Management/main.tsp b/specification/awsconnector/OrganizationsAccount.Management/main.tsp new file mode 100644 index 000000000000..448492eb621f --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/main.tsp @@ -0,0 +1,165 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- OrganizationsAccounts ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Organizations Account", + plural: "Organizations Accounts", + }, + keywords: ["Microsoft.AwsConnector", "Organizations", "Account"], +}) +@doc("A Microsoft.AwsConnector resource") +model OrganizationsAccount is TrackedResource<OrganizationsAccountProperties> { + @doc("Name of OrganizationsAccount") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("organizationsAccounts") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OrganizationsAccount") +model OrganizationsAccountProperties { + @doc("AWS Properties") + awsProperties?: AwsOrganizationsAccountProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsOrganizationsAccount") +model AwsOrganizationsAccountProperties { + @doc("If the account was created successfully, the unique identifier (ID) of the new account.") + accountId?: string; + + @doc("The friendly name of the member account.") + accountName?: string; + + @doc("The Amazon Resource Name (ARN) of the account.") + arn?: string; + + @doc("The email address of the owner to assign to the new member account.") + email?: string; + + @doc("The method by which the account joined the organization.") + joinedMethod?: JoinedMethod; + + @doc("The date the account became a part of the organization.") + joinedTimestamp?: string; + + @doc("List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.") + @extension("x-ms-identifiers", []) + parentIds?: string[]; + + @doc("The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.") + roleName?: string = "OrganizationAccountAccessRole"; + + @doc("The status of the account in the organization.") + status?: Status; + + @doc("A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +@doc("JoinedMethod enum") +union JoinedMethod { + @doc("JoinedMethod enum CREATED") + CREATED: "CREATED", + + @doc("JoinedMethod enum INVITED") + INVITED: "INVITED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key identifier, or name, of the tag.") + key?: string; + + @doc("The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.") + value?: string; +} + +@doc("Status enum") +union Status { + @doc("Status enum ACTIVE") + ACTIVE: "ACTIVE", + + @doc("Status enum PENDING_CLOSURE") + PENDING_CLOSURE: "PENDING_CLOSURE", + + @doc("Status enum SUSPENDED") + SUSPENDED: "SUSPENDED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface OrganizationsAccounts { + get is ArmResourceRead<OrganizationsAccount>; + @doc("Create a OrganizationsAccount. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<OrganizationsAccount>; + update is ArmCustomPatchAsync< + OrganizationsAccount, + Azure.ResourceManager.Foundations.TagsUpdateModel<OrganizationsAccount> + >; + delete is ArmResourceDeleteWithoutOkAsync<OrganizationsAccount>; + listByResourceGroup is ArmResourceListByParent<OrganizationsAccount>; + listBySubscription is ArmListBySubscription<OrganizationsAccount>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Organizations::Account +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/OrganizationsAccount.Management/tspconfig.yaml b/specification/awsconnector/OrganizationsAccount.Management/tspconfig.yaml new file mode 100644 index 000000000000..62f5e85910ab --- /dev/null +++ b/specification/awsconnector/OrganizationsAccount.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/organizationsAccount.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_CreateOrReplace.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_CreateOrReplace.json new file mode 100644 index 000000000000..b10f1fc9d951 --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_CreateOrReplace.json @@ -0,0 +1,121 @@ +{ + "title": "OrganizationsOrganizations_CreateOrReplace", + "operationId": "OrganizationsOrganizations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + } + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + } + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Delete.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Delete.json new file mode 100644 index 000000000000..0613a02f307a --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OrganizationsOrganizations_Delete", + "operationId": "OrganizationsOrganizations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Get.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Get.json new file mode 100644 index 000000000000..1a6cced26ffa --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Get.json @@ -0,0 +1,52 @@ +{ + "title": "OrganizationsOrganizations_Get", + "operationId": "OrganizationsOrganizations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + } + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListByResourceGroup.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListByResourceGroup.json new file mode 100644 index 000000000000..66e4a563c0ac --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "title": "OrganizationsOrganizations_ListByResourceGroup", + "operationId": "OrganizationsOrganizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListBySubscription.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListBySubscription.json new file mode 100644 index 000000000000..ca8f58bc7793 --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "title": "OrganizationsOrganizations_ListBySubscription", + "operationId": "OrganizationsOrganizations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Update.json b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Update.json new file mode 100644 index 000000000000..0e6b805afc2f --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/examples/2024-12-01/OrganizationsOrganizations_Update.json @@ -0,0 +1,62 @@ +{ + "title": "OrganizationsOrganizations_Update", + "operationId": "OrganizationsOrganizations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5330": "yjjrlmjwsholqusyzoosxblcjwppe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/OrganizationsOrganization.Management/main.tsp b/specification/awsconnector/OrganizationsOrganization.Management/main.tsp new file mode 100644 index 000000000000..a9588405f2a5 --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/main.tsp @@ -0,0 +1,128 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- OrganizationsOrganizations ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Organizations Organization", + plural: "Organizations Organizations", + }, + keywords: ["Microsoft.AwsConnector", "Organizations", "Organization"], +}) +@doc("A Microsoft.AwsConnector resource") +model OrganizationsOrganization + is TrackedResource<OrganizationsOrganizationProperties> { + @doc("Name of OrganizationsOrganization") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("organizationsOrganizations") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OrganizationsOrganization") +model OrganizationsOrganizationProperties { + @doc("AWS Properties") + awsProperties?: AwsOrganizationsOrganizationProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsOrganizationsOrganization") +model AwsOrganizationsOrganizationProperties { + @doc("The Amazon Resource Name (ARN) of an organization.") + arn?: string; + + @doc("Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.") + featureSet?: FeatureSet = "ALL"; + + @doc("The unique identifier (ID) of an organization.") + id?: string; + + @doc("The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization.") + managementAccountArn?: string; + + @doc("The email address that is associated with the AWS account that is designated as the management account for the organization.") + managementAccountEmail?: string; + + @doc("The unique identifier (ID) of the management account of an organization.") + managementAccountId?: string; + + @doc("The unique identifier (ID) for the root.") + rootId?: string; +} + +@doc("FeatureSet enum") +union FeatureSet { + @doc("FeatureSet enum ALL") + ALL: "ALL", + + @doc("FeatureSet enum CONSOLIDATED_BILLING") + CONSOLIDATED_BILLING: "CONSOLIDATED_BILLING", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface OrganizationsOrganizations { + get is ArmResourceRead<OrganizationsOrganization>; + @doc("Create a OrganizationsOrganization. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<OrganizationsOrganization>; + update is ArmCustomPatchAsync< + OrganizationsOrganization, + Azure.ResourceManager.Foundations.TagsUpdateModel<OrganizationsOrganization> + >; + delete is ArmResourceDeleteWithoutOkAsync<OrganizationsOrganization>; + listByResourceGroup is ArmResourceListByParent<OrganizationsOrganization>; + listBySubscription is ArmListBySubscription<OrganizationsOrganization>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Organizations::Organization +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/OrganizationsOrganization.Management/tspconfig.yaml b/specification/awsconnector/OrganizationsOrganization.Management/tspconfig.yaml new file mode 100644 index 000000000000..73e8f506771d --- /dev/null +++ b/specification/awsconnector/OrganizationsOrganization.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/organizationsOrganization.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_CreateOrReplace.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_CreateOrReplace.json new file mode 100644 index 000000000000..3de69e2e2ff2 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_CreateOrReplace.json @@ -0,0 +1,379 @@ +{ + "title": "RdsDbClusters_CreateOrReplace", + "operationId": "RdsDbClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + } + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Delete.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Delete.json new file mode 100644 index 000000000000..372c08b9a255 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbClusters_Delete", + "operationId": "RdsDbClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Get.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Get.json new file mode 100644 index 000000000000..123bf181e81a --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Get.json @@ -0,0 +1,138 @@ +{ + "title": "RdsDbClusters_Get", + "operationId": "RdsDbClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListByResourceGroup.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..fb16be2e2640 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListByResourceGroup.json @@ -0,0 +1,142 @@ +{ + "title": "RdsDbClusters_ListByResourceGroup", + "operationId": "RdsDbClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListBySubscription.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListBySubscription.json new file mode 100644 index 000000000000..6b4a6846699b --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_ListBySubscription.json @@ -0,0 +1,141 @@ +{ + "title": "RdsDbClusters_ListBySubscription", + "operationId": "RdsDbClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Update.json b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Update.json new file mode 100644 index 000000000000..456b06eb0a02 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/examples/2024-12-01/RdsDbClusters_Update.json @@ -0,0 +1,148 @@ +{ + "title": "RdsDbClusters_Update", + "operationId": "RdsDbClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7248": "xdfiauzxmaizplcudjpyspzbyovzp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsDBCluster.Management/main.tsp b/specification/awsconnector/RdsDBCluster.Management/main.tsp new file mode 100644 index 000000000000..4f33ba2050e8 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/main.tsp @@ -0,0 +1,377 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsDBClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS DBCluster", + plural: "RDS DBClusters", + }, + keywords: ["Microsoft.AwsConnector", "RDS", "DBCluster"], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsDBCluster is TrackedResource<RdsDBClusterProperties> { + @doc("Name of RdsDBCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsDBClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsDBCluster") +model RdsDBClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsDBClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsDBCluster") +model AwsRdsDBClusterProperties { + @doc("The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.") + allocatedStorage?: int32; + + @doc("Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.") + @extension("x-ms-identifiers", []) + associatedRoles?: DBClusterRole[]; + + @doc("A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.") + autoMinorVersionUpgrade?: boolean; + + @doc("A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.") + @extension("x-ms-identifiers", []) + availabilityZones?: string[]; + + @doc("The target backtrack window, in seconds. To disable backtracking, set this value to 0.") + backtrackWindow?: int32; + + @doc("The number of days for which automated backups are retained.") + backupRetentionPeriod?: int32 = 1; + + @doc("A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.") + copyTagsToSnapshot?: boolean; + + @doc("The Amazon Resource Name (ARN) for the DB cluster.") + dbClusterArn?: string; + + @doc("The DB cluster identifier. This parameter is stored as a lowercase string.") + dbClusterIdentifier?: string; + + @doc("The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.") + dbClusterInstanceClass?: string; + + @doc("The name of the DB cluster parameter group to associate with this DB cluster.") + dbClusterParameterGroupName?: string = "default.aurora5.6"; + + @doc("The AWS Region-unique, immutable identifier for the DB cluster.") + dbClusterResourceId?: string; + + @doc("The name of the DB parameter group to apply to all instances of the DB cluster.") + dbInstanceParameterGroupName?: string; + + @doc("A DB subnet group that you want to associate with this DB cluster.") + dbSubnetGroupName?: string; + + @doc("Reserved for future use.") + dbSystemId?: string; + + @doc("The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide.") + databaseName?: string; + + @doc("A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.") + deletionProtection?: boolean; + + @doc("The Active Directory directory ID to create the DB cluster in.") + domain?: string; + + @doc("Specify the name of the IAM role to be used when making API calls to the Directory Service.") + domainIAMRoleName?: string; + + @doc("The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.") + @extension("x-ms-identifiers", []) + enableCloudwatchLogsExports?: string[]; + + @doc("Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.") + enableGlobalWriteForwarding?: boolean; + + @doc("A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled.") + enableHttpEndpoint?: boolean; + + @doc("A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.") + enableIAMDatabaseAuthentication?: boolean; + + @doc("Property endpoint") + endpoint?: Endpoint; + + @doc("The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql") + engine?: string; + + @doc("The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.") + engineMode?: string; + + @doc("The version number of the database engine to use.") + engineVersion?: string; + + @doc("If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.If you aren't configuring a global database cluster, don't specify this property.") + globalClusterIdentifier?: string; + + @doc("The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.") + iops?: int32; + + @doc("The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.") + kmsKeyId?: string; + + @doc("A value that indicates whether to manage the master user password with AWS Secrets Manager.") + manageMasterUserPassword?: boolean; + + @doc("The master password for the DB instance.") + masterUserPassword?: string; + + @doc("Contains the secret managed by RDS in AWS Secrets Manager for the master user password.") + masterUserSecret?: MasterUserSecret; + + @doc("The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername.") + masterUsername?: string; + + @doc("The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.") + monitoringInterval?: int32; + + @doc("The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.") + monitoringRoleArn?: string; + + @doc("The network type of the DB cluster.") + networkType?: string; + + @doc("A value that indicates whether to turn on Performance Insights for the DB cluster.") + performanceInsightsEnabled?: boolean; + + @doc("The Amazon Web Services KMS key identifier for encryption of Performance Insights data.") + performanceInsightsKmsKeyId?: string; + + @doc("The amount of time, in days, to retain Performance Insights data.") + performanceInsightsRetentionPeriod?: int32; + + @doc("The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.") + port?: int32; + + @doc("The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.") + preferredBackupWindow?: string; + + @doc("The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.") + preferredMaintenanceWindow?: string; + + @doc("A value that indicates whether the DB cluster is publicly accessible.") + publiclyAccessible?: boolean; + + @doc("Property readEndpoint") + readEndpoint?: ReadEndpoint; + + @doc("The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.") + replicationSourceIdentifier?: string; + + @doc("The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z") + restoreToTime?: string; + + @doc("The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.") + restoreType?: string = "full-copy"; + + @doc("The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.") + scalingConfiguration?: ScalingConfiguration; + + @doc("Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster.") + serverlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration; + + @doc("The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.") + snapshotIdentifier?: string; + + @doc("The identifier of the source DB cluster from which to restore.") + sourceDBClusterIdentifier?: string; + + @doc("The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1.") + sourceRegion?: string; + + @doc("Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance.") + storageEncrypted?: boolean; + + @doc("Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type.") + storageThroughput?: int32; + + @doc("Specifies the storage type to be associated with the DB cluster.") + storageType?: string; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.") + useLatestRestorableTime?: boolean; + + @doc("A list of EC2 VPC security groups to associate with this DB cluster.") + @extension("x-ms-identifiers", []) + vpcSecurityGroupIds?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DBClusterRole") +model DBClusterRole { + @doc("The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference.") + featureName?: string; + + @doc("The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.") + roleArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Endpoint") +model Endpoint { + @doc("The connection endpoint for the DB cluster.") + address?: string; + + @doc("The port number that will accept connections on this DB cluster.") + port?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MasterUserSecret") +model MasterUserSecret { + @doc("The AWS KMS key identifier that is used to encrypt the secret.") + kmsKeyId?: string; + + @doc("The Amazon Resource Name (ARN) of the secret.") + secretArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReadEndpoint") +model ReadEndpoint { + @doc("The reader endpoint for the DB cluster.") + address?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ScalingConfiguration") +model ScalingConfiguration { + @doc("A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).") + autoPause?: boolean; + + @doc("The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity.") + maxCapacity?: int32; + + @doc("The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity.") + minCapacity?: int32; + + @doc("The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.The default is 300.") + secondsBeforeTimeout?: int32; + + @doc("The time, in seconds, before an Aurora DB cluster in serverless mode is paused.") + secondsUntilAutoPause?: int32; + + @doc("The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.") + timeoutAction?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServerlessV2ScalingConfiguration") +model ServerlessV2ScalingConfiguration { + @doc("The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.") + maxCapacity?: float32; + + @doc("The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.") + minCapacity?: float32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsDBClusters { + get is ArmResourceRead<RdsDBCluster>; + @doc("Create a RdsDBCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsDBCluster>; + update is ArmCustomPatchAsync< + RdsDBCluster, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsDBCluster> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsDBCluster>; + listByResourceGroup is ArmResourceListByParent<RdsDBCluster>; + listBySubscription is ArmListBySubscription<RdsDBCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::RDS::DBCluster +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsDBCluster.Management/tspconfig.yaml b/specification/awsconnector/RdsDBCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..3273f5359d59 --- /dev/null +++ b/specification/awsconnector/RdsDBCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsDBCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_CreateOrReplace.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_CreateOrReplace.json new file mode 100644 index 000000000000..c031804c07bd --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_CreateOrReplace.json @@ -0,0 +1,439 @@ +{ + "title": "RdsDbInstances_CreateOrReplace", + "operationId": "RdsDbInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + } + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Delete.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Delete.json new file mode 100644 index 000000000000..e6f68e50cf55 --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbInstances_Delete", + "operationId": "RdsDbInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Get.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Get.json new file mode 100644 index 000000000000..e7146b4bd6bf --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Get.json @@ -0,0 +1,158 @@ +{ + "title": "RdsDbInstances_Get", + "operationId": "RdsDbInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListByResourceGroup.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..aa9af7216cd9 --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListByResourceGroup.json @@ -0,0 +1,162 @@ +{ + "title": "RdsDbInstances_ListByResourceGroup", + "operationId": "RdsDbInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListBySubscription.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListBySubscription.json new file mode 100644 index 000000000000..5df1017f8afa --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_ListBySubscription.json @@ -0,0 +1,161 @@ +{ + "title": "RdsDbInstances_ListBySubscription", + "operationId": "RdsDbInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Update.json b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Update.json new file mode 100644 index 000000000000..e0a075a5ca21 --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/examples/2024-12-01/RdsDbInstances_Update.json @@ -0,0 +1,168 @@ +{ + "title": "RdsDbInstances_Update", + "operationId": "RdsDbInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9889": "dcsdkwhyjigrrwuu" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsDBInstance.Management/main.tsp b/specification/awsconnector/RdsDBInstance.Management/main.tsp new file mode 100644 index 000000000000..dae27029eab8 --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/main.tsp @@ -0,0 +1,434 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsDBInstances ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS DBInstance", + plural: "RDS DBInstances", + }, + keywords: ["Microsoft.AwsConnector", "RDS", "DBInstance"], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsDBInstance is TrackedResource<RdsDBInstanceProperties> { + @doc("Name of RdsDBInstance") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsDBInstances") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsDBInstance") +model RdsDBInstanceProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsDBInstanceProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsDBInstance") +model AwsRdsDBInstanceProperties { + @doc("The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). *Amazon Aurora* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. *MySQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *MariaDB* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *PostgreSQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *Oracle* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. *SQL Server* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024.") + allocatedStorage?: string; + + @doc("A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version.") + allowMajorVersionUpgrade?: boolean; + + @doc("The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster.") + @extension("x-ms-identifiers", []) + associatedRoles?: DBInstanceRole[]; + + @doc("A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.") + autoMinorVersionUpgrade?: boolean; + + @doc("Property automaticBackupReplicationKmsKeyId") + automaticBackupReplicationKmsKeyId?: string; + + @doc("The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*.") + automaticBackupReplicationRegion?: string; + + @doc("The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example: ``us-east-1d``") + availabilityZone?: string; + + @doc("The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas") + backupRetentionPeriod?: int32 = 1; + + @doc("The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.") + caCertificateIdentifier?: string; + + @doc("The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*.") + certificateDetails?: CertificateDetails; + + @doc("Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances.") + certificateRotationRestart?: boolean; + + @doc("For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html).") + characterSetName?: string; + + @doc("Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.") + copyTagsToSnapshot?: boolean; + + @doc("The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*.") + customIAMInstanceProfile?: string; + + @doc("The identifier of the DB cluster that the instance will belong to.") + dbClusterIdentifier?: string; + + @doc("The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when ``DBSnapshotIdentifier`` is specified. + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot.") + dbClusterSnapshotIdentifier?: string; + + @doc("Property dbInstanceArn") + dbInstanceArn?: string; + + @doc("The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*.") + dbInstanceClass?: string; + + @doc("A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + dbInstanceIdentifier?: string; + + @doc("The meaning of this parameter differs according to the database engine you use. If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. Default: ``ORCL`` Constraints: + Can't be longer than 8 characters *SQL Server* Not applicable. Must be null.") + dbName?: string; + + @doc("The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used.") + dbParameterGroupName?: string; + + @doc("A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + ``AllocatedStorage`` + ``AutoMinorVersionUpgrade`` + ``AvailabilityZone`` + ``BackupRetentionPeriod`` + ``CharacterSetName`` + ``DBInstanceClass`` + ``DBName`` + ``DBParameterGroupName`` + ``DBSecurityGroups`` + ``DBSubnetGroupName`` + ``Engine`` + ``EngineVersion`` + ``Iops`` + ``LicenseModel`` + ``MasterUsername`` + ``MasterUserPassword`` + ``MultiAZ`` + ``OptionGroupName`` + ``PreferredBackupWindow`` + ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.") + @extension("x-ms-identifiers", []) + dbSecurityGroups?: string[]; + + @doc("The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + ``CharacterSetName`` + ``DBClusterIdentifier`` + ``DBName`` + ``DeleteAutomatedBackups`` + ``EnablePerformanceInsights`` + ``KmsKeyId`` + ``MasterUsername`` + ``MasterUserPassword`` + ``PerformanceInsightsKMSKeyId`` + ``PerformanceInsightsRetentionPeriod`` + ``PromotionTier`` + ``SourceDBInstanceIdentifier`` + ``SourceRegion`` + ``StorageEncrypted`` (for an encrypted snapshot) + ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster.") + dbSnapshotIdentifier?: string; + + @doc("A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.") + dbSubnetGroupName?: string; + + @doc("The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB.") + dbSystemId?: string; + + @doc("Property dbiResourceId") + dbiResourceId?: string; + + @doc("Indicates whether the DB instance has a dedicated log volume (DLV) enabled.") + dedicatedLogVolume?: boolean; + + @doc("A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.") + deleteAutomatedBackups?: boolean; + + @doc("A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.") + deletionProtection?: boolean; + + @doc("The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*.") + domain?: string; + + @doc("The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``") + domainAuthSecretArn?: string; + + @doc("The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``") + @extension("x-ms-identifiers", []) + domainDnsIps?: string[]; + + @doc("The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example: ``mymanagedADtest.mymanagedAD.mydomain``") + domainFqdn?: string; + + @doc("The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom") + domainIAMRoleName?: string; + + @doc("The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``") + domainOu?: string; + + @doc("The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* Valid values: ``diag.log``, ``notify.log`` *MariaDB* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* Valid values: ``agent``, ``error`` *MySQL* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade``") + @extension("x-ms-identifiers", []) + enableCloudwatchLogsExports?: string[]; + + @doc("A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.") + enableIAMDatabaseAuthentication?: boolean; + + @doc("Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances.") + enablePerformanceInsights?: boolean; + + @doc("The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of ``creating``. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` + ``DescribeDBInstances`` + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.") + endpoint?: Endpoint; + + @doc("The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` or ``oracle-ee-cdb`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web``") + engine?: string; + + @doc("The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. *Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* *MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* *PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*") + engineVersion?: string; + + @doc("The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.") + iops?: int32; + + @doc("The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The KMS key identifier is managed by the DB cluster.") + kmsKeyId?: string; + + @doc("License model information for this DB instance. Valid Values: + Aurora MySQL - ``general-public-license`` + Aurora PostgreSQL - ``postgresql-license`` + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + RDS for MariaDB - ``general-public-license`` + RDS for Microsoft SQL Server - ``license-included`` + RDS for MySQL - ``general-public-license`` + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.") + licenseModel?: string; + + @doc("Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified.") + manageMasterUserPassword?: boolean; + + @doc("The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters.") + masterUserPassword?: string; + + @doc("The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*") + masterUserSecret?: MasterUserSecret; + + @doc("The master user name for the DB instance. If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. *Amazon Aurora* Not applicable. The name for the master user is managed by the DB cluster. *RDS for Db2* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MariaDB* Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for Oracle* Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for PostgreSQL* Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine.") + masterUsername?: string; + + @doc("The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom") + maxAllocatedStorage?: int32; + + @doc("The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: ``0, 1, 5, 10, 15, 30, 60``") + monitoringInterval?: int32; + + @doc("The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances.") + monitoringRoleArn?: string; + + @doc("Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set.") + multiAZ?: boolean; + + @doc("The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances.") + ncharCharacterSetName?: string; + + @doc("The network type of the DB instance. Valid values: + ``IPV4`` + ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*") + networkType?: string; + + @doc("Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.") + optionGroupName?: string; + + @doc("The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights).") + performanceInsightsKMSKeyId?: string; + + @doc("The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error.") + performanceInsightsRetentionPeriod?: int32; + + @doc("The port number on which the database accepts connections. *Amazon Aurora* Not applicable. The port number is managed by the DB cluster. *Db2* Default value: ``50000``") + port?: string; + + @doc("The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: + Must be in the format ``hh24:mi-hh24:mi``. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster.") + preferredBackupWindow?: string; + + @doc("The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.") + preferredMaintenanceWindow?: string; + + @doc("The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.") + @extension("x-ms-identifiers", []) + processorFeatures?: ProcessorFeature[]; + + @doc("The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``") + promotionTier?: int32 = 1; + + @doc("Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*.") + publiclyAccessible?: boolean; + + @doc("The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This setting is only supported in RDS for Oracle. Default: ``open-read-only`` Valid Values: ``open-read-only`` or ``mounted``") + replicaMode?: string; + + @doc("The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. Example: ``2009-09-07T23:45:00Z``") + restoreTime?: string; + + @doc("The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.") + sourceDBClusterIdentifier?: string; + + @doc("The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. This setting doesn't apply to RDS Custom.") + sourceDBInstanceAutomatedBackupsArn?: string; + + @doc("If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.") + sourceDBInstanceIdentifier?: string; + + @doc("The resource ID of the source DB instance from which to restore.") + sourceDbiResourceId?: string; + + @doc("The ID of the region that contains the source DB instance for the read replica.") + sourceRegion?: string; + + @doc("A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster.") + storageEncrypted?: boolean; + + @doc("Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.") + storageThroughput?: int32; + + @doc("The storage type to associate with the DB instance. If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``.") + storageType?: string; + + @doc("An optional array of key-value pairs to apply to this DB instance.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property tdeCredentialArn") + tdeCredentialArn?: string; + + @doc("Property tdeCredentialPassword") + tdeCredentialPassword?: string; + + @doc("The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone).") + timezone?: string; + + @doc("Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances.") + useDefaultProcessorFeatures?: boolean; + + @doc("Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided.") + useLatestRestorableTime?: boolean; + + @doc("A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. *Amazon Aurora* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.") + @extension("x-ms-identifiers", []) + vpcSecurityGroups?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DBInstanceRole") +model DBInstanceRole { + @doc("The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*.") + featureName?: string; + + @doc("The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.") + roleArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CertificateDetails") +model CertificateDetails { + @doc("The CA identifier of the CA certificate used for the DB instance's server certificate.") + caIdentifier?: string; + + @doc("The expiration date of the DB instance’s server certificate.") + validTill?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Endpoint") +model Endpoint { + @doc("Specifies the DNS address of the DB instance.") + address?: string; + + @doc("Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.") + hostedZoneId?: string; + + @doc("Specifies the port that the database engine is listening on.") + port?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MasterUserSecret") +model MasterUserSecret { + @doc("The AWS KMS key identifier that is used to encrypt the secret.") + kmsKeyId?: string; + + @doc("The Amazon Resource Name (ARN) of the secret.") + secretArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProcessorFeature") +model ProcessorFeature { + @doc("The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.") + name?: ProcessorFeatureName; + + @doc("The value of a processor feature name.") + value?: string; +} + +@doc("ProcessorFeatureName enum") +union ProcessorFeatureName { + @doc("ProcessorFeatureName enum coreCount") + coreCount: "coreCount", + + @doc("ProcessorFeatureName enum threadsPerCore") + threadsPerCore: "threadsPerCore", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$').") + key?: string; + + @doc("A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$').") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsDBInstances { + get is ArmResourceRead<RdsDBInstance>; + @doc("Create a RdsDBInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsDBInstance>; + update is ArmCustomPatchAsync< + RdsDBInstance, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsDBInstance> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsDBInstance>; + listByResourceGroup is ArmResourceListByParent<RdsDBInstance>; + listBySubscription is ArmListBySubscription<RdsDBInstance>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::RDS::DBInstance +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsDBInstance.Management/tspconfig.yaml b/specification/awsconnector/RdsDBInstance.Management/tspconfig.yaml new file mode 100644 index 000000000000..891c4d1a1c0c --- /dev/null +++ b/specification/awsconnector/RdsDBInstance.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsDBInstance.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_CreateOrReplace.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_CreateOrReplace.json new file mode 100644 index 000000000000..cf61b2b490f5 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_CreateOrReplace.json @@ -0,0 +1,238 @@ +{ + "title": "RdsDbSnapshots_CreateOrReplace", + "operationId": "RdsDbSnapshots_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + } + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Delete.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Delete.json new file mode 100644 index 000000000000..ee21d0f43922 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbSnapshots_Delete", + "operationId": "RdsDbSnapshots_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Get.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Get.json new file mode 100644 index 000000000000..4861776d1720 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Get.json @@ -0,0 +1,91 @@ +{ + "title": "RdsDbSnapshots_Get", + "operationId": "RdsDbSnapshots_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListByResourceGroup.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListByResourceGroup.json new file mode 100644 index 000000000000..1f832d46e1b5 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "title": "RdsDbSnapshots_ListByResourceGroup", + "operationId": "RdsDbSnapshots_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListBySubscription.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListBySubscription.json new file mode 100644 index 000000000000..a35ee4baff71 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_ListBySubscription.json @@ -0,0 +1,94 @@ +{ + "title": "RdsDbSnapshots_ListBySubscription", + "operationId": "RdsDbSnapshots_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Update.json b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Update.json new file mode 100644 index 000000000000..f284e88b390b --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/examples/2024-12-01/RdsDbSnapshots_Update.json @@ -0,0 +1,101 @@ +{ + "title": "RdsDbSnapshots_Update", + "operationId": "RdsDbSnapshots_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4303": "igefqj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshot.Management/main.tsp b/specification/awsconnector/RdsDBSnapshot.Management/main.tsp new file mode 100644 index 000000000000..add040ff9944 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/main.tsp @@ -0,0 +1,237 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsDBSnapshots ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS DBSnapshot", + plural: "RDS DBSnapshots", + }, + keywords: ["Microsoft.AwsConnector", "RDS", "DBSnapshot"], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsDBSnapshot is TrackedResource<RdsDBSnapshotProperties> { + @doc("Name of RdsDBSnapshot") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsDBSnapshots") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsDBSnapshot") +model RdsDBSnapshotProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsDBSnapshotProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsDBSnapshot") +model AwsRdsDBSnapshotProperties { + @doc("<p>Specifies the allocated storage size in gibibytes (GiB).</p>") + allocatedStorage?: int32; + + @doc("<p>Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.</p>") + availabilityZone?: string; + + @doc("<p>Specifies the DB instance identifier of the DB instance this DB snapshot was created from.</p>") + dbInstanceIdentifier?: string; + + @doc("<p>The Amazon Resource Name (ARN) for the DB snapshot.</p>") + dbSnapshotArn?: string; + + @doc("<p>Specifies the identifier for the DB snapshot.</p>") + dbSnapshotIdentifier?: string; + + @doc("<p>The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.</p>") + dbSystemId?: string; + + @doc("<p>The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.</p>") + dbiResourceId?: string; + + @doc("<p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>") + dedicatedLogVolume?: boolean; + + @doc("<p>Indicates whether the DB snapshot is encrypted.</p>") + encrypted?: boolean; + + @doc("<p>Specifies the name of the database engine.</p>") + engine?: string; + + @doc("<p>Specifies the version of the database engine.</p>") + engineVersion?: string; + + @doc("<p>Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.</p>") + iamDatabaseAuthenticationEnabled?: boolean; + + @doc("<p>Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.</p>") + instanceCreateTime?: utcDateTime; + + @doc("<p>Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.</p>") + iops?: int32; + + @doc("<p>If <code>Encrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>") + kmsKeyId?: string; + + @doc("<p>License model information for the restored DB instance.</p>") + licenseModel?: string; + + @doc("<p>Provides the master username for the DB snapshot.</p>") + masterUsername?: string; + + @doc("<p>Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).</p>") + multiTenant?: boolean; + + @doc("<p>Provides the option group name for the DB snapshot.</p>") + optionGroupName?: string; + + @doc("<p>Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.</p>") + originalSnapshotCreateTime?: utcDateTime; + + @doc("<p>The percentage of the estimated data that has been transferred.</p>") + percentProgress?: int32; + + @doc("<p>Specifies the port that the database engine was listening on at the time of the snapshot.</p>") + port?: int32; + + @doc("<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.</p>") + @extension("x-ms-identifiers", []) + processorFeatures?: ProcessorFeature[]; + + @doc("<p>Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.</p>") + snapshotCreateTime?: utcDateTime; + + @doc("<p>The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.</p> <p>If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.</p>") + snapshotDatabaseTime?: utcDateTime; + + @doc("<p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>") + snapshotTarget?: string; + + @doc("<p>Provides the type of the DB snapshot.</p>") + snapshotType?: string; + + @doc("<p>The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.</p>") + sourceDBSnapshotIdentifier?: string; + + @doc("<p>The Amazon Web Services Region that the DB snapshot was created in or copied from.</p>") + sourceRegion?: string; + + @doc("<p>Specifies the status of this DB snapshot.</p>") + status?: string; + + @doc("<p>Specifies the storage throughput for the DB snapshot.</p>") + storageThroughput?: int32; + + @doc("<p>Specifies the storage type associated with DB snapshot.</p>") + storageType?: string; + + @doc("Property tagList") + @extension("x-ms-identifiers", []) + tagList?: Tag[]; + + @doc("<p>The ARN from the key store with which to associate the instance for TDE encryption.</p>") + tdeCredentialArn?: string; + + @doc("<p>The time zone of the DB snapshot. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.</p>") + timezone?: string; + + @doc("<p>Provides the VPC ID associated with the DB snapshot.</p>") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProcessorFeature") +model ProcessorFeature { + @doc("<p>The name of the processor feature. Valid names are <code>coreCount</code> and <code>threadsPerCore</code>.</p>") + name?: string; + + @doc("<p>The value of a processor feature name.</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$').</p>") + key?: string; + + @doc("<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$').</p>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsDBSnapshots { + get is ArmResourceRead<RdsDBSnapshot>; + @doc("Create a RdsDBSnapshot. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsDBSnapshot>; + update is ArmCustomPatchAsync< + RdsDBSnapshot, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsDBSnapshot> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsDBSnapshot>; + listByResourceGroup is ArmResourceListByParent<RdsDBSnapshot>; + listBySubscription is ArmListBySubscription<RdsDBSnapshot>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\rds\rds-2014-10-31.normal.json +// AWS Shape: DBSnapshot +// +// Related information for backend service: +// AWS Servcie : RDS +// Product Version : 3.7.798.0 +// SDK Version : 3.7.312.0 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsDBSnapshot.Management/tspconfig.yaml b/specification/awsconnector/RdsDBSnapshot.Management/tspconfig.yaml new file mode 100644 index 000000000000..7f2fa29fa532 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshot.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsDBSnapshot.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_CreateOrReplace.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_CreateOrReplace.json new file mode 100644 index 000000000000..96dfc2c3ee3c --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_CreateOrReplace.json @@ -0,0 +1,127 @@ +{ + "title": "RdsDbSnapshotAttributesResults_CreateOrReplace", + "operationId": "RdsDbSnapshotAttributesResults_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + } + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Delete.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Delete.json new file mode 100644 index 000000000000..adf4d755461e --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Delete", + "operationId": "RdsDbSnapshotAttributesResults_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Get.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Get.json new file mode 100644 index 000000000000..0da2baef31ce --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Get.json @@ -0,0 +1,54 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Get", + "operationId": "RdsDbSnapshotAttributesResults_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListByResourceGroup.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListByResourceGroup.json new file mode 100644 index 000000000000..dfc7dd9740a4 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListByResourceGroup.json @@ -0,0 +1,58 @@ +{ + "title": "RdsDbSnapshotAttributesResults_ListByResourceGroup", + "operationId": "RdsDbSnapshotAttributesResults_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListBySubscription.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListBySubscription.json new file mode 100644 index 000000000000..aa2fe70b1df4 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_ListBySubscription.json @@ -0,0 +1,57 @@ +{ + "title": "RdsDbSnapshotAttributesResults_ListBySubscription", + "operationId": "RdsDbSnapshotAttributesResults_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Update.json b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Update.json new file mode 100644 index 000000000000..4fd7c1e8757d --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/examples/2024-12-01/RdsDbSnapshotAttributesResults_Update.json @@ -0,0 +1,64 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Update", + "operationId": "RdsDbSnapshotAttributesResults_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7927": "s" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/main.tsp b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/main.tsp new file mode 100644 index 000000000000..3ea64d54ec70 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/main.tsp @@ -0,0 +1,129 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsDBSnapshotAttributesResults ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS DBSnapshot Attributes Result", + plural: "RDS DBSnapshot Attributes Results", + }, + keywords: [ + "Microsoft.AwsConnector", + "RDS", + "DBSnapshot", + "Attributes", + "Result" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsDBSnapshotAttributesResult + is TrackedResource<RdsDBSnapshotAttributesResultProperties> { + @doc("Name of RdsDBSnapshotAttributesResult") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsDBSnapshotAttributesResults") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsDBSnapshotAttributesResult") +model RdsDBSnapshotAttributesResultProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsDBSnapshotAttributesResultProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsDBSnapshotAttributesResult") +model AwsRdsDBSnapshotAttributesResultProperties { + @doc("<p>The list of attributes and values for the manual DB snapshot.</p>") + @extension("x-ms-identifiers", []) + dbSnapshotAttributes?: DBSnapshotAttribute[]; + + @doc("<p>The identifier of the manual DB snapshot that the attributes apply to.</p>") + dbSnapshotIdentifier?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DBSnapshotAttribute") +model DBSnapshotAttribute { + @doc("<p>The name of the manual DB snapshot attribute.</p> <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code> API action.</p>") + attributeName?: string; + + @doc("<p>The value or values for the manual DB snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.</p>") + @extension("x-ms-identifiers", []) + attributeValues?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsDBSnapshotAttributesResults { + get is ArmResourceRead<RdsDBSnapshotAttributesResult>; + @doc("Create a RdsDBSnapshotAttributesResult. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsDBSnapshotAttributesResult>; + update is ArmCustomPatchAsync< + RdsDBSnapshotAttributesResult, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsDBSnapshotAttributesResult> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsDBSnapshotAttributesResult>; + listByResourceGroup is ArmResourceListByParent<RdsDBSnapshotAttributesResult>; + listBySubscription is ArmListBySubscription<RdsDBSnapshotAttributesResult>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\rds\rds-2014-10-31.normal.json +// AWS Shape: DBSnapshotAttributesResult +// +// Related information for backend service: +// AWS Servcie : RDS +// Product Version : 3.7.798.0 +// SDK Version : 3.7.312.0 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/tspconfig.yaml b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/tspconfig.yaml new file mode 100644 index 000000000000..7e356995d171 --- /dev/null +++ b/specification/awsconnector/RdsDBSnapshotAttributesResult.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsDBSnapshotAttributesResult.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_CreateOrReplace.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_CreateOrReplace.json new file mode 100644 index 000000000000..b1140484e85b --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "RdsEventSubscriptions_CreateOrReplace", + "operationId": "RdsEventSubscriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + } + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Delete.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Delete.json new file mode 100644 index 000000000000..34d7dec158cc --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsEventSubscriptions_Delete", + "operationId": "RdsEventSubscriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Get.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Get.json new file mode 100644 index 000000000000..8248c5efa2cc --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Get.json @@ -0,0 +1,61 @@ +{ + "title": "RdsEventSubscriptions_Get", + "operationId": "RdsEventSubscriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListByResourceGroup.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..23df6425b124 --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "RdsEventSubscriptions_ListByResourceGroup", + "operationId": "RdsEventSubscriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListBySubscription.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListBySubscription.json new file mode 100644 index 000000000000..1658f206798a --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "RdsEventSubscriptions_ListBySubscription", + "operationId": "RdsEventSubscriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Update.json b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Update.json new file mode 100644 index 000000000000..c1c153bd816b --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/examples/2024-12-01/RdsEventSubscriptions_Update.json @@ -0,0 +1,71 @@ +{ + "title": "RdsEventSubscriptions_Update", + "operationId": "RdsEventSubscriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3694": "ceskyfrlxhgbminxalfyipftsqqn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsEventSubscription.Management/main.tsp b/specification/awsconnector/RdsEventSubscription.Management/main.tsp new file mode 100644 index 000000000000..4a890e637238 --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/main.tsp @@ -0,0 +1,132 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsEventSubscriptions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS Event Subscription", + plural: "RDS Event Subscriptions", + }, + keywords: ["Microsoft.AwsConnector", "RDS", "Event", "Subscription"], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsEventSubscription is TrackedResource<RdsEventSubscriptionProperties> { + @doc("Name of RdsEventSubscription") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsEventSubscriptions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsEventSubscription") +model RdsEventSubscriptionProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsEventSubscriptionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsEventSubscription") +model AwsRdsEventSubscriptionProperties { + @doc("A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.") + enabled?: boolean = true; + + @doc("A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.") + @extension("x-ms-identifiers", []) + eventCategories?: string[]; + + @doc("The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.") + snsTopicArn?: string; + + @doc("The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.") + @extension("x-ms-identifiers", []) + sourceIds?: string[]; + + @doc("The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.") + sourceType?: string; + + @doc("The name of the subscription.") + subscriptionName?: string; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsEventSubscriptions { + get is ArmResourceRead<RdsEventSubscription>; + @doc("Create a RdsEventSubscription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsEventSubscription>; + update is ArmCustomPatchAsync< + RdsEventSubscription, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsEventSubscription> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsEventSubscription>; + listByResourceGroup is ArmResourceListByParent<RdsEventSubscription>; + listBySubscription is ArmListBySubscription<RdsEventSubscription>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::RDS::EventSubscription +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsEventSubscription.Management/tspconfig.yaml b/specification/awsconnector/RdsEventSubscription.Management/tspconfig.yaml new file mode 100644 index 000000000000..d236a5f4aec7 --- /dev/null +++ b/specification/awsconnector/RdsEventSubscription.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsEventSubscription.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_CreateOrReplace.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_CreateOrReplace.json new file mode 100644 index 000000000000..33b07025c7a3 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_CreateOrReplace.json @@ -0,0 +1,160 @@ +{ + "title": "RdsExportTasks_CreateOrReplace", + "operationId": "RdsExportTasks_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + } + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Delete.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Delete.json new file mode 100644 index 000000000000..0b0d5c812f02 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsExportTasks_Delete", + "operationId": "RdsExportTasks_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Get.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Get.json new file mode 100644 index 000000000000..942bd6b9b4e9 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Get.json @@ -0,0 +1,65 @@ +{ + "title": "RdsExportTasks_Get", + "operationId": "RdsExportTasks_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + } + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListByResourceGroup.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListByResourceGroup.json new file mode 100644 index 000000000000..22929b934ebd --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListByResourceGroup.json @@ -0,0 +1,69 @@ +{ + "title": "RdsExportTasks_ListByResourceGroup", + "operationId": "RdsExportTasks_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListBySubscription.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListBySubscription.json new file mode 100644 index 000000000000..63c1c2d5d705 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_ListBySubscription.json @@ -0,0 +1,68 @@ +{ + "title": "RdsExportTasks_ListBySubscription", + "operationId": "RdsExportTasks_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Update.json b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Update.json new file mode 100644 index 000000000000..08bd03697fa7 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/examples/2024-12-01/RdsExportTasks_Update.json @@ -0,0 +1,75 @@ +{ + "title": "RdsExportTasks_Update", + "operationId": "RdsExportTasks_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8327": "fublgdavougwxwbj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RdsExportTask.Management/main.tsp b/specification/awsconnector/RdsExportTask.Management/main.tsp new file mode 100644 index 000000000000..1ca873c93876 --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/main.tsp @@ -0,0 +1,171 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RdsExportTasks ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "RDS Export Task", + plural: "RDS Export Tasks", + }, + keywords: ["Microsoft.AwsConnector", "RDS", "Export", "Task"], +}) +@doc("A Microsoft.AwsConnector resource") +model RdsExportTask is TrackedResource<RdsExportTaskProperties> { + @doc("Name of RdsExportTask") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("rdsExportTasks") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RdsExportTask") +model RdsExportTaskProperties { + @doc("AWS Properties") + awsProperties?: AwsRdsExportTaskProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRdsExportTask") +model AwsRdsExportTaskProperties { + @doc("<p>The data exported from the snapshot or cluster.</p> <p>Valid Values:</p> <ul> <li> <p> <code>database</code> - Export all the data from a specified database.</p> </li> <li> <p> <code>database.table</code> <i>table-name</i> - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p> </li> <li> <p> <code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li> <li> <p> <code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li> </ul>") + @extension("x-ms-identifiers", []) + exportOnly?: string[]; + + @doc("<p>A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.</p>") + exportTaskIdentifier?: string; + + @doc("<p>The reason the export failed, if it failed.</p>") + failureCause?: string; + + @doc("<p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.</p>") + iamRoleArn?: string; + + @doc("<p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.</p>") + kmsKeyId?: string; + + @doc("<p>The progress of the snapshot or cluster export task as a percentage.</p>") + percentProgress?: int32; + + @doc("<p>The Amazon S3 bucket where the snapshot or cluster is exported to.</p>") + s3Bucket?: string; + + @doc("<p>The Amazon S3 bucket prefix that is the file name and path of the exported data.</p>") + s3Prefix?: string; + + @doc("<p>The time when the snapshot was created.</p>") + snapshotTime?: utcDateTime; + + @doc("<p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>") + sourceArn?: string; + + @doc("<p>The type of source for the export.</p>") + sourceType?: ExportSourceTypeEnumValue; + + @doc("<p>The progress status of the export task. The status can be one of the following:</p> <ul> <li> <p> <code>CANCELED</code> </p> </li> <li> <p> <code>CANCELING</code> </p> </li> <li> <p> <code>COMPLETE</code> </p> </li> <li> <p> <code>FAILED</code> </p> </li> <li> <p> <code>IN_PROGRESS</code> </p> </li> <li> <p> <code>STARTING</code> </p> </li> </ul>") + status?: string; + + @doc("<p>The time when the snapshot or cluster export task ended.</p>") + taskEndTime?: utcDateTime; + + @doc("<p>The time when the snapshot or cluster export task started.</p>") + taskStartTime?: utcDateTime; + + @doc("<p>The total amount of data exported, in gigabytes.</p>") + totalExtractedDataInGB?: int32; + + @doc("<p>A warning about the snapshot or cluster export task.</p>") + warningMessage?: string; +} + +@doc("ExportSourceType enum") +union ExportSourceType { + @doc("ExportSourceType enum CLUSTER") + CLUSTER: "CLUSTER", + + @doc("ExportSourceType enum SNAPSHOT") + SNAPSHOT: "SNAPSHOT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ExportSourceTypeEnumValue") +model ExportSourceTypeEnumValue { + @doc("Property value") + value?: ExportSourceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RdsExportTasks { + get is ArmResourceRead<RdsExportTask>; + @doc("Create a RdsExportTask. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RdsExportTask>; + update is ArmCustomPatchAsync< + RdsExportTask, + Azure.ResourceManager.Foundations.TagsUpdateModel<RdsExportTask> + >; + delete is ArmResourceDeleteWithoutOkAsync<RdsExportTask>; + listByResourceGroup is ArmResourceListByParent<RdsExportTask>; + listBySubscription is ArmListBySubscription<RdsExportTask>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\rds\rds-2014-10-31.normal.json +// AWS Shape: ExportTask +// +// Related information for backend service: +// AWS Servcie : RDS +// Product Version : 3.7.798.0 +// SDK Version : 3.7.312.0 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RdsExportTask.Management/tspconfig.yaml b/specification/awsconnector/RdsExportTask.Management/tspconfig.yaml new file mode 100644 index 000000000000..47abe0fb78ae --- /dev/null +++ b/specification/awsconnector/RdsExportTask.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/rdsExportTask.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_CreateOrReplace.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_CreateOrReplace.json new file mode 100644 index 000000000000..5695fbe6a3d8 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_CreateOrReplace.json @@ -0,0 +1,313 @@ +{ + "title": "RedshiftClusters_CreateOrReplace", + "operationId": "RedshiftClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + } + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + } + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Delete.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Delete.json new file mode 100644 index 000000000000..c692e7f75ff1 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RedshiftClusters_Delete", + "operationId": "RedshiftClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Get.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Get.json new file mode 100644 index 000000000000..34aa95242029 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Get.json @@ -0,0 +1,116 @@ +{ + "title": "RedshiftClusters_Get", + "operationId": "RedshiftClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + } + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListByResourceGroup.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..1ad8df1d3b79 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListByResourceGroup.json @@ -0,0 +1,120 @@ +{ + "title": "RedshiftClusters_ListByResourceGroup", + "operationId": "RedshiftClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListBySubscription.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListBySubscription.json new file mode 100644 index 000000000000..b5707f4128ab --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_ListBySubscription.json @@ -0,0 +1,119 @@ +{ + "title": "RedshiftClusters_ListBySubscription", + "operationId": "RedshiftClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Update.json b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Update.json new file mode 100644 index 000000000000..7475ee08e4b2 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/examples/2024-12-01/RedshiftClusters_Update.json @@ -0,0 +1,126 @@ +{ + "title": "RedshiftClusters_Update", + "operationId": "RedshiftClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9218": "mhocleqdpv" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RedshiftCluster.Management/main.tsp b/specification/awsconnector/RedshiftCluster.Management/main.tsp new file mode 100644 index 000000000000..a5533fb5a1a2 --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/main.tsp @@ -0,0 +1,303 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RedshiftClusters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Redshift Cluster", + plural: "Redshift Clusters", + }, + keywords: ["Microsoft.AwsConnector", "Redshift", "Cluster"], +}) +@doc("A Microsoft.AwsConnector resource") +model RedshiftCluster is TrackedResource<RedshiftClusterProperties> { + @doc("Name of RedshiftCluster") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("redshiftClusters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RedshiftCluster") +model RedshiftClusterProperties { + @doc("AWS Properties") + awsProperties?: AwsRedshiftClusterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRedshiftCluster") +model AwsRedshiftClusterProperties { + @doc("Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True") + allowVersionUpgrade?: boolean; + + @doc("The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.disabled - Don't use AQUA.auto - Amazon Redshift determines whether to use AQUA.") + aquaConfigurationStatus?: string; + + @doc("The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1") + automatedSnapshotRetentionPeriod?: int32; + + @doc("The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint") + availabilityZone?: string; + + @doc("The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.") + availabilityZoneRelocation?: boolean; + + @doc("The availability zone relocation status of the cluster") + availabilityZoneRelocationStatus?: string; + + @doc("A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.") + classic?: boolean; + + @doc("A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account") + clusterIdentifier?: string; + + @doc("The Amazon Resource Name (ARN) of the cluster namespace.") + clusterNamespaceArn?: string; + + @doc("The name of the parameter group to be associated with this cluster.") + clusterParameterGroupName?: string; + + @doc("A list of security groups to be associated with this cluster.") + @extension("x-ms-identifiers", []) + clusterSecurityGroups?: string[]; + + @doc("The name of a cluster subnet group to be associated with this cluster.") + clusterSubnetGroupName?: string; + + @doc("The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required") + clusterType?: string; + + @doc("The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster.") + clusterVersion?: string; + + @doc("The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database.") + dbName?: string; + + @doc("A boolean indicating whether to enable the deferred maintenance window.") + deferMaintenance?: boolean; + + @doc("An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.") + deferMaintenanceDuration?: int32; + + @doc("A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.") + deferMaintenanceEndTime?: string; + + @doc("A unique identifier for the deferred maintenance window.") + deferMaintenanceIdentifier?: string; + + @doc("A timestamp indicating the start time for the deferred maintenance window.") + deferMaintenanceStartTime?: string; + + @doc("The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference") + destinationRegion?: string; + + @doc("The Elastic IP (EIP) address for the cluster.") + elasticIp?: string; + + @doc("If true, the data in the cluster is encrypted at rest.") + encrypted?: boolean; + + @doc("Property endpoint") + endpoint?: Endpoint; + + @doc("An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.If this option is true , enhanced VPC routing is enabled.Default: false") + enhancedVpcRouting?: boolean; + + @doc("Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM") + hsmClientCertificateIdentifier?: string; + + @doc("Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.") + hsmConfigurationIdentifier?: string; + + @doc("A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request") + @extension("x-ms-identifiers", []) + iamRoles?: string[]; + + @doc("The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.") + kmsKeyId?: string; + + @doc("Property loggingProperties") + loggingProperties?: LoggingProperties; + + @doc("The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.") + maintenanceTrackName?: string; + + @doc("A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.") + manageMasterPassword?: boolean; + + @doc("The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653.") + manualSnapshotRetentionPeriod?: int32; + + @doc("The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.") + masterPasswordSecretArn?: string; + + @doc("The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret.") + masterPasswordSecretKmsKeyId?: string; + + @doc("The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character.") + masterUserPassword?: string; + + @doc("The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter.") + masterUsername?: string; + + @doc("A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az.") + multiAZ?: boolean; + + @doc("The namespace resource policy document that will be attached to a Redshift cluster.") + namespaceResourcePolicy?: unknown; + + @doc("The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge") + nodeType?: string; + + @doc("The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.") + numberOfNodes?: int32; + + @doc("Property ownerAccount") + ownerAccount?: string; + + @doc("The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings") + port?: int32; + + @doc("The weekly time range (in UTC) during which automated cluster maintenance can occur.") + preferredMaintenanceWindow?: string; + + @doc("If true, the cluster can be accessed from a public network.") + publiclyAccessible?: boolean; + + @doc("The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs") + resourceAction?: string; + + @doc("The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.") + revisionTarget?: string; + + @doc("A boolean indicating if we want to rotate Encryption Keys.") + rotateEncryptionKey?: boolean; + + @doc("The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.") + snapshotClusterIdentifier?: string; + + @doc("The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.") + snapshotCopyGrantName?: string; + + @doc("Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.") + snapshotCopyManual?: boolean; + + @doc("The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35.") + snapshotCopyRetentionPeriod?: int32; + + @doc("The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.") + snapshotIdentifier?: string; + + @doc("The list of tags for the cluster parameter group.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.") + @extension("x-ms-identifiers", []) + vpcSecurityGroupIds?: string[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Endpoint") +model Endpoint { + @doc("Property address") + address?: string; + + @doc("Property port") + port?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoggingProperties") +model LoggingProperties { + @doc("Property bucketName") + bucketName?: string; + + @doc("Property s3KeyPrefix") + s3KeyPrefix?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RedshiftClusters { + get is ArmResourceRead<RedshiftCluster>; + @doc("Create a RedshiftCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RedshiftCluster>; + update is ArmCustomPatchAsync< + RedshiftCluster, + Azure.ResourceManager.Foundations.TagsUpdateModel<RedshiftCluster> + >; + delete is ArmResourceDeleteWithoutOkAsync<RedshiftCluster>; + listByResourceGroup is ArmResourceListByParent<RedshiftCluster>; + listBySubscription is ArmListBySubscription<RedshiftCluster>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Redshift::Cluster +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RedshiftCluster.Management/tspconfig.yaml b/specification/awsconnector/RedshiftCluster.Management/tspconfig.yaml new file mode 100644 index 000000000000..6a52312fd46e --- /dev/null +++ b/specification/awsconnector/RedshiftCluster.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/redshiftCluster.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_CreateOrReplace.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_CreateOrReplace.json new file mode 100644 index 000000000000..7a7b40ddf8cd --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_CreateOrReplace.json @@ -0,0 +1,145 @@ +{ + "title": "RedshiftClusterParameterGroups_CreateOrReplace", + "operationId": "RedshiftClusterParameterGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + } + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + } + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Delete.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Delete.json new file mode 100644 index 000000000000..b253b88568ee --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RedshiftClusterParameterGroups_Delete", + "operationId": "RedshiftClusterParameterGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Get.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Get.json new file mode 100644 index 000000000000..74dca67461aa --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Get.json @@ -0,0 +1,60 @@ +{ + "title": "RedshiftClusterParameterGroups_Get", + "operationId": "RedshiftClusterParameterGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + } + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListByResourceGroup.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..f70804014029 --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "RedshiftClusterParameterGroups_ListByResourceGroup", + "operationId": "RedshiftClusterParameterGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListBySubscription.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListBySubscription.json new file mode 100644 index 000000000000..4372f055dda3 --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "RedshiftClusterParameterGroups_ListBySubscription", + "operationId": "RedshiftClusterParameterGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Update.json b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Update.json new file mode 100644 index 000000000000..6546304489c3 --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/examples/2024-12-01/RedshiftClusterParameterGroups_Update.json @@ -0,0 +1,70 @@ +{ + "title": "RedshiftClusterParameterGroups_Update", + "operationId": "RedshiftClusterParameterGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key900": "ivgflws" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/main.tsp b/specification/awsconnector/RedshiftClusterParameterGroup.Management/main.tsp new file mode 100644 index 000000000000..74f8a3fdca73 --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/main.tsp @@ -0,0 +1,145 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- RedshiftClusterParameterGroups ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Redshift Cluster Parameter Group", + plural: "Redshift Cluster Parameter Groups", + }, + keywords: [ + "Microsoft.AwsConnector", + "Redshift", + "Cluster", + "Parameter", + "Group" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model RedshiftClusterParameterGroup + is TrackedResource<RedshiftClusterParameterGroupProperties> { + @doc("Name of RedshiftClusterParameterGroup") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("redshiftClusterParameterGroups") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RedshiftClusterParameterGroup") +model RedshiftClusterParameterGroupProperties { + @doc("AWS Properties") + awsProperties?: AwsRedshiftClusterParameterGroupProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRedshiftClusterParameterGroup") +model AwsRedshiftClusterParameterGroupProperties { + @doc("A description of the parameter group.") + description?: string; + + @doc("The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.") + parameterGroupFamily?: string; + + @doc("The name of the cluster parameter group.") + parameterGroupName?: string; + + @doc("An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.") + @extension("x-ms-identifiers", []) + parameters?: Parameter[]; + + @doc("An array of key-value pairs to apply to this resource.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Parameter") +model Parameter { + @doc("The name of the parameter.") + parameterName?: string; + + @doc("The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters.") + parameterValue?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface RedshiftClusterParameterGroups { + get is ArmResourceRead<RedshiftClusterParameterGroup>; + @doc("Create a RedshiftClusterParameterGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<RedshiftClusterParameterGroup>; + update is ArmCustomPatchAsync< + RedshiftClusterParameterGroup, + Azure.ResourceManager.Foundations.TagsUpdateModel<RedshiftClusterParameterGroup> + >; + delete is ArmResourceDeleteWithoutOkAsync<RedshiftClusterParameterGroup>; + listByResourceGroup is ArmResourceListByParent<RedshiftClusterParameterGroup>; + listBySubscription is ArmListBySubscription<RedshiftClusterParameterGroup>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Redshift::ClusterParameterGroup +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/RedshiftClusterParameterGroup.Management/tspconfig.yaml b/specification/awsconnector/RedshiftClusterParameterGroup.Management/tspconfig.yaml new file mode 100644 index 000000000000..18b76b908149 --- /dev/null +++ b/specification/awsconnector/RedshiftClusterParameterGroup.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/redshiftClusterParameterGroup.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_CreateOrReplace.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..de1b91fb4998 --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "Route53DomainsDomainSummaries_CreateOrReplace", + "operationId": "Route53DomainsDomainSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + } + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Delete.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Delete.json new file mode 100644 index 000000000000..11ed9089ba3f --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53DomainsDomainSummaries_Delete", + "operationId": "Route53DomainsDomainSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Get.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Get.json new file mode 100644 index 000000000000..927d4dd1dbd8 --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Route53DomainsDomainSummaries_Get", + "operationId": "Route53DomainsDomainSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListByResourceGroup.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..3d92f8ddd4b9 --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "Route53DomainsDomainSummaries_ListByResourceGroup", + "operationId": "Route53DomainsDomainSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + ], + "nextLink": "https://microsoft.com/acktixge" + } + } + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListBySubscription.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListBySubscription.json new file mode 100644 index 000000000000..5079eb3ad5bc --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "Route53DomainsDomainSummaries_ListBySubscription", + "operationId": "Route53DomainsDomainSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + ], + "nextLink": "https://microsoft.com/acktixge" + } + } + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Update.json b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Update.json new file mode 100644 index 000000000000..05dd773afd9e --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/examples/2024-12-01/Route53DomainsDomainSummaries_Update.json @@ -0,0 +1,59 @@ +{ + "title": "Route53DomainsDomainSummaries_Update", + "operationId": "Route53DomainsDomainSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8975": "iofguxotyhapdccidejuibcxjpit" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/main.tsp b/specification/awsconnector/Route53DomainsDomainSummary.Management/main.tsp new file mode 100644 index 000000000000..016c901a0494 --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/main.tsp @@ -0,0 +1,120 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Route53DomainsDomainSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Route 53 Domains Domain Summary", + plural: "Route 53 Domains Domain Summaries", + }, + keywords: [ + "Microsoft.AwsConnector", + "Route 53 ", + "Domains", + "Domain", + "Summary" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model Route53DomainsDomainSummary + is TrackedResource<Route53DomainsDomainSummaryProperties> { + @doc("Name of Route53DomainsDomainSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("route53DomainsDomainSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Route53DomainsDomainSummary") +model Route53DomainsDomainSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsRoute53DomainsDomainSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRoute53DomainsDomainSummary") +model AwsRoute53DomainsDomainSummaryProperties { + @doc("<p>Indicates whether the domain is automatically renewed upon expiration.</p>") + autoRenew?: boolean; + + @doc("<p>The name of the domain that the summary information applies to.</p>") + domainName?: string; + + @doc("<p>Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).</p>") + expiry?: utcDateTime; + + @doc("<p>Indicates whether a domain is locked from unauthorized transfer to another party.</p>") + transferLock?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Route53DomainsDomainSummaries { + get is ArmResourceRead<Route53DomainsDomainSummary>; + @doc("Create a Route53DomainsDomainSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Route53DomainsDomainSummary>; + update is ArmCustomPatchAsync< + Route53DomainsDomainSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<Route53DomainsDomainSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<Route53DomainsDomainSummary>; + listByResourceGroup is ArmResourceListByParent<Route53DomainsDomainSummary>; + listBySubscription is ArmListBySubscription<Route53DomainsDomainSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\route53domains\route53domains-2014-05-15.normal.json +// AWS Shape: DomainSummary +// +// Related information for backend service: +// AWS Servcie : Route 53 Domains +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.35 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Route53DomainsDomainSummary.Management/tspconfig.yaml b/specification/awsconnector/Route53DomainsDomainSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..432fddc1a6d2 --- /dev/null +++ b/specification/awsconnector/Route53DomainsDomainSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/route53DomainsDomainSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_CreateOrReplace.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_CreateOrReplace.json new file mode 100644 index 000000000000..a945963b4b04 --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "Route53HostedZones_CreateOrReplace", + "operationId": "Route53HostedZones_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + } + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Delete.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Delete.json new file mode 100644 index 000000000000..4551446506bf --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53HostedZones_Delete", + "operationId": "Route53HostedZones_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Get.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Get.json new file mode 100644 index 000000000000..23a5db8a500b --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Get.json @@ -0,0 +1,68 @@ +{ + "title": "Route53HostedZones_Get", + "operationId": "Route53HostedZones_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListByResourceGroup.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListByResourceGroup.json new file mode 100644 index 000000000000..6c29e67f9284 --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "Route53HostedZones_ListByResourceGroup", + "operationId": "Route53HostedZones_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListBySubscription.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListBySubscription.json new file mode 100644 index 000000000000..5ec5101c7f72 --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "Route53HostedZones_ListBySubscription", + "operationId": "Route53HostedZones_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Update.json b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Update.json new file mode 100644 index 000000000000..baa576a5b00c --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/examples/2024-12-01/Route53HostedZones_Update.json @@ -0,0 +1,78 @@ +{ + "title": "Route53HostedZones_Update", + "operationId": "Route53HostedZones_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8195": "oaps" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Route53HostedZone.Management/main.tsp b/specification/awsconnector/Route53HostedZone.Management/main.tsp new file mode 100644 index 000000000000..c1afc9ce4a60 --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/main.tsp @@ -0,0 +1,165 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Route53HostedZones ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Route53 Hosted Zone", + plural: "Route53 Hosted Zones", + }, + keywords: ["Microsoft.AwsConnector", "Route53", "Hosted", "Zone"], +}) +@doc("A Microsoft.AwsConnector resource") +model Route53HostedZone is TrackedResource<Route53HostedZoneProperties> { + @doc("Name of Route53HostedZone") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("route53HostedZones") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Route53HostedZone") +model Route53HostedZoneProperties { + @doc("AWS Properties") + awsProperties?: AwsRoute53HostedZoneProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRoute53HostedZone") +model AwsRoute53HostedZoneProperties { + @doc("A complex type that contains an optional comment. If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements.") + hostedZoneConfig?: HostedZoneConfig; + + @doc("Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.") + @extension("x-ms-identifiers", []) + hostedZoneTags?: HostedZoneTag[]; + + @doc("Property id") + id?: string; + + @doc("The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function.") + name?: string; + + @doc("Property nameServers") + @extension("x-ms-identifiers", []) + nameServers?: string[]; + + @doc("Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + Route 53 edge location that responded to the DNS query + Domain or subdomain that was requested + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see 'The Route 53 Global Network' on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. A complex type that contains information about a configuration for DNS query logging.") + queryLoggingConfig?: QueryLoggingConfig; + + @doc("*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.") + @extension("x-ms-identifiers", []) + vpCs?: VPC[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HostedZoneConfig") +model HostedZoneConfig { + @doc("Any comments that you want to include about the hosted zone.") + comment?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of HostedZoneTag") +model HostedZoneTag { + @doc("The value of ``Key`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + *Delete a key*: ``Key`` is the name of the tag you want to remove. + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check.") + key?: string; + + @doc("The value of ``Value`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + *Edit a tag*: ``Value`` is the new value that you want to assign the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of QueryLoggingConfig") +model QueryLoggingConfig { + @doc("The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.") + cloudWatchLogsLogGroupArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VPC") +model VPC { + @doc("*Private hosted zones only:* The ID of an Amazon VPC. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.") + vpcId?: string; + + @doc("*Private hosted zones only:* The region that an Amazon VPC was created in. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.") + vpcRegion?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Route53HostedZones { + get is ArmResourceRead<Route53HostedZone>; + @doc("Create a Route53HostedZone. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Route53HostedZone>; + update is ArmCustomPatchAsync< + Route53HostedZone, + Azure.ResourceManager.Foundations.TagsUpdateModel<Route53HostedZone> + >; + delete is ArmResourceDeleteWithoutOkAsync<Route53HostedZone>; + listByResourceGroup is ArmResourceListByParent<Route53HostedZone>; + listBySubscription is ArmListBySubscription<Route53HostedZone>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::Route53::HostedZone +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Route53HostedZone.Management/tspconfig.yaml b/specification/awsconnector/Route53HostedZone.Management/tspconfig.yaml new file mode 100644 index 000000000000..a47c5cbd9ae5 --- /dev/null +++ b/specification/awsconnector/Route53HostedZone.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/route53HostedZone.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_CreateOrReplace.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_CreateOrReplace.json new file mode 100644 index 000000000000..4735e2fb7c8c --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "Route53ResourceRecordSets_CreateOrReplace", + "operationId": "Route53ResourceRecordSets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + } + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Delete.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Delete.json new file mode 100644 index 000000000000..85d01d88272b --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53ResourceRecordSets_Delete", + "operationId": "Route53ResourceRecordSets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Get.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Get.json new file mode 100644 index 000000000000..8915f9b46ea9 --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Get.json @@ -0,0 +1,89 @@ +{ + "title": "Route53ResourceRecordSets_Get", + "operationId": "Route53ResourceRecordSets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + } + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListByResourceGroup.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListByResourceGroup.json new file mode 100644 index 000000000000..bf222cd6a57f --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "Route53ResourceRecordSets_ListByResourceGroup", + "operationId": "Route53ResourceRecordSets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListBySubscription.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListBySubscription.json new file mode 100644 index 000000000000..97ce6636178f --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "Route53ResourceRecordSets_ListBySubscription", + "operationId": "Route53ResourceRecordSets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Update.json b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Update.json new file mode 100644 index 000000000000..474704e40363 --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/examples/2024-12-01/Route53ResourceRecordSets_Update.json @@ -0,0 +1,99 @@ +{ + "title": "Route53ResourceRecordSets_Update", + "operationId": "Route53ResourceRecordSets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3023": "qnpghnqmyen" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/main.tsp b/specification/awsconnector/Route53ResourceRecordSet.Management/main.tsp new file mode 100644 index 000000000000..c47bca675595 --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/main.tsp @@ -0,0 +1,418 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Route53ResourceRecordSets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Route 53 Resource Record Set", + plural: "Route 53 Resource Record Sets", + }, + keywords: ["Microsoft.AwsConnector", "Route 53", "Resource", "Record", "Set"], +}) +@doc("A Microsoft.AwsConnector resource") +model Route53ResourceRecordSet + is TrackedResource<Route53ResourceRecordSetProperties> { + @doc("Name of Route53ResourceRecordSet") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("route53ResourceRecordSets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Route53ResourceRecordSet") +model Route53ResourceRecordSetProperties { + @doc("AWS Properties") + awsProperties?: AwsRoute53ResourceRecordSetProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsRoute53ResourceRecordSet") +model AwsRoute53ResourceRecordSetProperties { + @doc("<p> <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. </p> <p>If you're creating resource records sets for a private hosted zone, note the following:</p> <ul> <li> <p>You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.</p> </li> <li> <p>For information about creating failover resource record sets in a private hosted zone, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </li> </ul>") + aliasTarget?: AliasTarget; + + @doc("Property cidrRoutingConfig") + cidrRoutingConfig?: CidrRoutingConfig; + + @doc("<p> <i>Failover resource record sets only:</i> To configure failover, you add the <code>Failover</code> element to two resource record sets. For one resource record set, you specify <code>PRIMARY</code> as the value for <code>Failover</code>; for the other resource record set, you specify <code>SECONDARY</code>. In addition, you include the <code>HealthCheckId</code> element and specify the health check that you want Amazon Route 53 to perform for each resource record set.</p> <p>Except where noted, the following failover behaviors assume that you have included the <code>HealthCheckId</code> element in both resource record sets:</p> <ul> <li> <p>When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.</p> </li> <li> <p>When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.</p> </li> <li> <p>When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.</p> </li> <li> <p>If you omit the <code>HealthCheckId</code> element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.</p> </li> </ul> <p>You can't create non-failover resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as failover resource record sets.</p> <p>For failover alias resource record sets, you must also include the <code>EvaluateTargetHealth</code> element and set the value to true.</p> <p>For more information about configuring failover for Route 53, see the following topics in the <i>Amazon Route 53 Developer Guide</i>: </p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Route 53 Health Checks and DNS Failover</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> </p> </li> </ul>") + failover?: ResourceRecordSetFailoverEnumValue; + + @doc("<p> <i>Geolocation resource record sets only:</i> A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of <code>192.0.2.111</code>, create a resource record set with a <code>Type</code> of <code>A</code> and a <code>ContinentCode</code> of <code>AF</code>.</p> <p>If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.</p> <p>You can't create two geolocation resource record sets that specify the same geographic location.</p> <p>The value <code>*</code> in the <code>CountryCode</code> element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements.</p> <important> <p>Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of <code>CountryCode</code> is <code>*</code>. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a <code>*</code> resource record set, Route 53 returns a 'no answer' response for queries from those locations.</p> </important> <p>You can't create non-geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as geolocation resource record sets.</p>") + geoLocation?: GeoLocation; + + @doc("<p> <i> GeoproximityLocation resource record sets only:</i> A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. </p>") + geoProximityLocation?: GeoProximityLocation; + + @doc("<p>If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the <code>HealthCheckId</code> element and specify the ID of the applicable health check.</p> <p>Route 53 determines whether a resource record set is healthy based on one of the following:</p> <ul> <li> <p>By periodically sending a request to the endpoint that is specified in the health check</p> </li> <li> <p>By aggregating the status of a specified group of health checks (calculated health checks)</p> </li> <li> <p>By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)</p> </li> </ul> <important> <p>Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the <code>Value</code> element. When you add a <code>HealthCheckId</code> element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. </p> </important> <p>For more information, see the following topics in the <i>Amazon Route 53 Developer Guide</i>:</p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html'>How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Route 53 Health Checks and DNS Failover</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> </p> </li> </ul> <p> <b>When to Specify HealthCheckId</b> </p> <p>Specifying a value for <code>HealthCheckId</code> is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:</p> <ul> <li> <p> <b>Non-alias resource record sets</b>: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. </p> <p>If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.</p> <p>If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.</p> <p>If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. </p> </li> <li> <p> <b>Alias resource record sets</b>: You specify the following settings:</p> <ul> <li> <p>You set <code>EvaluateTargetHealth</code> to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). </p> </li> <li> <p>You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.</p> </li> <li> <p>You specify a health check ID for the non-alias resource record set. </p> </li> </ul> <p>If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.</p> <p>If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.</p> <note> <p>The alias resource record set can also route traffic to a <i>group</i> of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.</p> </note> </li> </ul> <p> <b>Geolocation Routing</b> </p> <p>For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has <code>*</code> for <code>CountryCode</code> is <code>*</code>, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:</p> <ul> <li> <p>The United States</p> </li> <li> <p>North America</p> </li> <li> <p>The default resource record set</p> </li> </ul> <p> <b>Specifying the Health Check Endpoint by Domain Name</b> </p> <p>If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each <code>HTTP</code> server that is serving content for <code>www.example.com</code>. For the value of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such as <code>us-east-2-www.example.com</code>), not the name of the resource record sets (<code>www.example.com</code>).</p> <important> <p>Health check results will be unpredictable if you do the following:</p> <ul> <li> <p>Create a health check that has the same value for <code>FullyQualifiedDomainName</code> as the name of a resource record set.</p> </li> <li> <p>Associate that health check with the resource record set.</p> </li> </ul> </important>") + healthCheckId?: string; + + @doc("<p> <i>Multivalue answer resource record sets only</i>: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify <code>true</code> for <code>MultiValueAnswer</code>. Note the following:</p> <ul> <li> <p>If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.</p> </li> <li> <p>If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.</p> </li> <li> <p>Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.</p> </li> <li> <p>If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.</p> </li> <li> <p>When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.</p> </li> <li> <p>If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.</p> </li> </ul> <p>You can't create multivalue answer alias records.</p>") + multiValueAnswer?: boolean; + + @doc("<p>For <code>ChangeResourceRecordSets</code> requests, the name of the record that you want to create, update, or delete. For <code>ListResourceRecordSets</code> responses, the name of a record in the specified hosted zone.</p> <p> <b>ChangeResourceRecordSets Only</b> </p> <p>Enter a fully qualified domain name, for example, <code>www.example.com</code>. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats <code>www.example.com</code> (without a trailing dot) and <code>www.example.com.</code> (with a trailing dot) as identical.</p> <p>For information about how to specify characters other than <code>a-z</code>, <code>0-9</code>, and <code>-</code> (hyphen) and how to specify internationalized domain names, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html'>DNS Domain Name Format</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, <code>*.example.com</code>. Note the following:</p> <ul> <li> <p>The * must replace the entire label. For example, you can't specify <code>*prod.example.com</code> or <code>prod*.example.com</code>.</p> </li> <li> <p>The * can't replace any of the middle labels, for example, marketing.*.example.com.</p> </li> <li> <p>If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.</p> <important> <p>You can't use the * wildcard for resource records sets that have a type of NS.</p> </important> </li> </ul>") + name?: string; + + @doc("<p> <i>Latency-based resource record sets only:</i> The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.</p> <p>When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.</p> <p>Note the following:</p> <ul> <li> <p>You can only specify one <code>ResourceRecord</code> per latency resource record set.</p> </li> <li> <p>You can only create one latency resource record set for each Amazon EC2 Region.</p> </li> <li> <p>You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.</p> </li> <li> <p>You can't create non-latency resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as latency resource record sets.</p> </li> </ul>") + region?: ResourceRecordSetRegionEnumValue; + + @doc("<p>Information about the resource records to act upon.</p> <note> <p>If you're creating an alias resource record set, omit <code>ResourceRecords</code>.</p> </note>") + @extension("x-ms-identifiers", []) + resourceRecords?: ResourceRecord[]; + + @doc("<p> <i>Resource record sets that have a routing policy other than simple:</i> An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of <code>SetIdentifier</code> must be unique for each resource record set. </p> <p>For information about routing policies, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html'>Choosing a Routing Policy</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>") + setIdentifier?: string; + + @doc("<p>The resource record cache time to live (TTL), in seconds. Note the following:</p> <ul> <li> <p>If you're creating or updating an alias resource record set, omit <code>TTL</code>. Amazon Route 53 uses the value of <code>TTL</code> for the alias target. </p> </li> <li> <p>If you're associating this resource record set with a health check (if you're adding a <code>HealthCheckId</code> element), we recommend that you specify a <code>TTL</code> of 60 seconds or less so clients respond quickly to changes in health status.</p> </li> <li> <p>All of the resource record sets in a group of weighted resource record sets must have the same value for <code>TTL</code>.</p> </li> <li> <p>If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a <code>TTL</code> of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for <code>Weight</code>.</p> </li> </ul>") + ttl?: int64; + + @doc("<p>When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. <code>TrafficPolicyInstanceId</code> is the ID of the traffic policy instance that Route 53 created this resource record set for.</p> <important> <p>To delete the resource record set that is associated with a traffic policy instance, use <code>DeleteTrafficPolicyInstance</code>. Route 53 will delete the resource record set automatically. If you delete the resource record set by using <code>ChangeResourceRecordSets</code>, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. </p> </important>") + trafficPolicyInstanceId?: string; + + @doc("<p>The DNS record type. For information about different record types and how data is encoded for them, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'>Supported DNS Resource Record Types</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>Valid values for basic resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>DS</code> |<code>MX</code> | <code>NAPTR</code> | <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> </p> <p>Values for weighted, latency, geolocation, and failover resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code>. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.</p> <p>Valid values for multivalue answer resource record sets: <code>A</code> | <code>AAAA</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> </p> <note> <p>SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of <code>Type</code> is <code>SPF</code>. RFC 7208, <i>Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1</i>, has been updated to say, '...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.' In RFC 7208, see section 14.1, <a href='http://tools.ietf.org/html/rfc7208#section-14.1'>The SPF DNS Record Type</a>.</p> </note> <p>Values for alias resource record sets:</p> <ul> <li> <p> <b>Amazon API Gateway custom regional APIs and edge-optimized APIs:</b> <code>A</code> </p> </li> <li> <p> <b>CloudFront distributions:</b> <code>A</code> </p> <p>If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of <code>A</code> and one with a value of <code>AAAA</code>. </p> </li> <li> <p> <b>Amazon API Gateway environment that has a regionalized subdomain</b>: <code>A</code> </p> </li> <li> <p> <b>ELB load balancers:</b> <code>A</code> | <code>AAAA</code> </p> </li> <li> <p> <b>Amazon S3 buckets:</b> <code>A</code> </p> </li> <li> <p> <b>Amazon Virtual Private Cloud interface VPC endpoints</b> <code>A</code> </p> </li> <li> <p> <b>Another resource record set in this hosted zone:</b> Specify the type of the resource record set that you're creating the alias for. All values are supported except <code>NS</code> and <code>SOA</code>.</p> <note> <p>If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of <code>Type</code> is <code>CNAME</code>. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.</p> </note> </li> </ul>") + type?: RRTypeEnumValue; + + @doc("<p> <i>Weighted resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:</p> <ul> <li> <p>You must specify a value for the <code>Weight</code> element for every weighted resource record set.</p> </li> <li> <p>You can only specify one <code>ResourceRecord</code> per weighted resource record set.</p> </li> <li> <p>You can't create latency, failover, or geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as weighted resource record sets.</p> </li> <li> <p>You can create a maximum of 100 weighted resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements.</p> </li> <li> <p>For weighted (but not weighted alias) resource record sets, if you set <code>Weight</code> to <code>0</code> for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set <code>Weight</code> to <code>0</code> for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.</p> <p>The effect of setting <code>Weight</code> to <code>0</code> is different when you associate health checks with weighted resource record sets. For more information, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html'>Options for Configuring Route 53 Active-Active and Active-Passive Failover</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </li> </ul>") + weight?: int64; +} + +@doc("ResourceRecordSetFailover enum") +union ResourceRecordSetFailover { + @doc("ResourceRecordSetFailover enum PRIMARY") + PRIMARY: "PRIMARY", + + @doc("ResourceRecordSetFailover enum SECONDARY") + SECONDARY: "SECONDARY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceRecordSetFailoverEnumValue") +model ResourceRecordSetFailoverEnumValue { + @doc("Property value") + value?: ResourceRecordSetFailover; +} + +@doc("RRType enum") +union RRType { + @doc("RRType enum A") + A: "A", + + @doc("RRType enum AAAA") + AAAA: "AAAA", + + @doc("RRType enum CAA") + CAA: "CAA", + + @doc("RRType enum CNAME") + CNAME: "CNAME", + + @doc("RRType enum DS") + DS: "DS", + + @doc("RRType enum MX") + MX: "MX", + + @doc("RRType enum NAPTR") + NAPTR: "NAPTR", + + @doc("RRType enum NS") + NS: "NS", + + @doc("RRType enum PTR") + PTR: "PTR", + + @doc("RRType enum SOA") + SOA: "SOA", + + @doc("RRType enum SPF") + SPF: "SPF", + + @doc("RRType enum SRV") + SRV: "SRV", + + @doc("RRType enum TXT") + TXT: "TXT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RRTypeEnumValue") +model RRTypeEnumValue { + @doc("Property value") + value?: RRType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AliasTarget") +model AliasTarget { + @doc("<p> <i>Alias resource record sets only:</i> The value that you specify depends on where you want to route queries:</p> <dl> <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> <dd> <p>Specify the applicable domain name for your API. You can get the applicable value using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'>get-domain-names</a>:</p> <ul> <li> <p>For regional APIs, specify the value of <code>regionalDomainName</code>.</p> </li> <li> <p>For edge-optimized APIs, specify the value of <code>distributionDomainName</code>. This is the name of the associated CloudFront distribution, such as <code>da1b2c3d4e5.cloudfront.net</code>.</p> </li> </ul> <note> <p>The name of the record that you're creating must match a custom domain name for your API, such as <code>api.example.com</code>.</p> </note> </dd> <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> <dd> <p>Enter the API endpoint for the interface endpoint, such as <code>vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com</code>. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of <code>DnsName</code> using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'>describe-vpc-endpoints</a>.</p> </dd> <dt>CloudFront distribution</dt> <dd> <p>Specify the domain name that CloudFront assigned when you created your distribution.</p> <p>Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is <i>acme.example.com</i>, your CloudFront distribution must include <i>acme.example.com</i> as one of the alternate domain names. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html'>Using Alternate Domain Names (CNAMEs)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.</p> <note> <p>For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. </p> </note> </dd> <dt>Elastic Beanstalk environment</dt> <dd> <p>If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name <code>my-environment.<i>us-west-2</i>.elasticbeanstalk.com</code> is a regionalized domain name. </p> <important> <p>For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.</p> </important> <p>For Elastic Beanstalk environments that have regionalized subdomains, specify the <code>CNAME</code> attribute for the environment. You can use the following methods to get the value of the CNAME attribute:</p> <ul> <li> <p> <i>Amazon Web Services Management Console</i>: For information about how to get the value by using the console, see <a href='https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html'>Using Custom Domains with Elastic Beanstalk</a> in the <i>Elastic Beanstalk Developer Guide</i>.</p> </li> <li> <p> <i>Elastic Beanstalk API</i>: Use the <code>DescribeEnvironments</code> action to get the value of the <code>CNAME</code> attribute. For more information, see <a href='https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html'>DescribeEnvironments</a> in the <i>Elastic Beanstalk API Reference</i>.</p> </li> <li> <p> <i>CLI</i>: Use the <code>describe-environments</code> command to get the value of the <code>CNAME</code> attribute. For more information, see <a href='https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html'>describe-environments</a> in the <i>CLI Command Reference</i>.</p> </li> </ul> </dd> <dt>ELB load balancer</dt> <dd> <p>Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. </p> <ul> <li> <p> <b>Amazon Web Services Management Console</b>: Go to the EC2 page, choose <b>Load Balancers</b> in the navigation pane, choose the load balancer, choose the <b>Description</b> tab, and get the value of the <b>DNS name</b> field. </p> <p>If you're routing traffic to a Classic Load Balancer, get the value that begins with <b>dualstack</b>. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.</p> </li> <li> <p> <b>Elastic Load Balancing API</b>: Use <code>DescribeLoadBalancers</code> to get the value of <code>DNSName</code>. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: <a href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> </p> </li> <li> <p>Application and Network Load Balancers: <a href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> </p> </li> </ul> </li> <li> <p> <b>CLI</b>: Use <code>describe-load-balancers</code> to get the value of <code>DNSName</code>. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: <a href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'>describe-load-balancers</a> </p> </li> <li> <p>Application and Network Load Balancers: <a href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'>describe-load-balancers</a> </p> </li> </ul> </li> </ul> </dd> <dt>Global Accelerator accelerator</dt> <dd> <p>Specify the DNS name for your accelerator:</p> <ul> <li> <p> <b>Global Accelerator API:</b> To get the DNS name, use <a href='https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html'>DescribeAccelerator</a>.</p> </li> <li> <p> <b>CLI:</b> To get the DNS name, use <a href='https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html'>describe-accelerator</a>.</p> </li> </ul> </dd> <dt>Amazon S3 bucket that is configured as a static website</dt> <dd> <p>Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, <code>s3-website.us-east-2.amazonaws.com</code>. For more information about valid values, see the table <a href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'>Amazon S3 Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>. For more information about using S3 buckets for websites, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html'>Getting Started with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide.</i> </p> </dd> <dt>Another Route 53 resource record set</dt> <dd> <p>Specify the value of the <code>Name</code> element for a resource record set in the current hosted zone.</p> <note> <p>If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of <code>Type</code> is <code>CNAME</code>. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.</p> </note> </dd> </dl>") + dnsName?: string; + + @doc("<p> <i>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:</i> When <code>EvaluateTargetHealth</code> is <code>true</code>, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.</p> <p>Note the following:</p> <dl> <dt>CloudFront distributions</dt> <dd> <p>You can't set <code>EvaluateTargetHealth</code> to <code>true</code> when the alias target is a CloudFront distribution.</p> </dd> <dt>Elastic Beanstalk environments that have regionalized subdomains</dt> <dd> <p>If you specify an Elastic Beanstalk environment in <code>DNSName</code> and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set <code>EvaluateTargetHealth</code> to <code>true</code> and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. </p> <p>If the environment contains a single Amazon EC2 instance, there are no special requirements.</p> </dd> <dt>ELB load balancers</dt> <dd> <p>Health checking behavior depends on the type of load balancer:</p> <ul> <li> <p> <b>Classic Load Balancers</b>: If you specify an ELB Classic Load Balancer in <code>DNSName</code>, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set <code>EvaluateTargetHealth</code> to <code>true</code> and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.</p> </li> <li> <p> <b>Application and Network Load Balancers</b>: If you specify an ELB Application or Network Load Balancer and you set <code>EvaluateTargetHealth</code> to <code>true</code>, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:</p> <ul> <li> <p>For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.</p> </li> <li> <p>A target group that has no registered targets is considered unhealthy.</p> </li> </ul> </li> </ul> <note> <p>When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. </p> </note> </dd> <dt>S3 buckets</dt> <dd> <p>There are no special requirements for setting <code>EvaluateTargetHealth</code> to <code>true</code> when the alias target is an S3 bucket.</p> </dd> <dt>Other records in the same hosted zone</dt> <dd> <p>If the Amazon Web Services resource that you specify in <code>DNSName</code> is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting'>What Happens When You Omit Health Checks?</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> </dl> <p>For more information and examples, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Amazon Route 53 Health Checks and DNS Failover</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>") + evaluateTargetHealth?: boolean; + + @doc("<p> <i>Alias resource records sets only</i>: The value used depends on where you want to route traffic:</p> <dl> <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> <dd> <p>Specify the hosted zone ID for your API. You can get the applicable value using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'>get-domain-names</a>:</p> <ul> <li> <p>For regional APIs, specify the value of <code>regionalHostedZoneId</code>.</p> </li> <li> <p>For edge-optimized APIs, specify the value of <code>distributionHostedZoneId</code>.</p> </li> </ul> </dd> <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> <dd> <p>Specify the hosted zone ID for your interface endpoint. You can get the value of <code>HostedZoneId</code> using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'>describe-vpc-endpoints</a>.</p> </dd> <dt>CloudFront distribution</dt> <dd> <p>Specify <code>Z2FDTNDATAQYW2</code>.</p> <note> <p>Alias resource record sets for CloudFront can't be created in a private zone.</p> </note> </dd> <dt>Elastic Beanstalk environment</dt> <dd> <p>Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see <a href='https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html'>Elastic Beanstalk endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> </dd> <dt>ELB load balancer</dt> <dd> <p>Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:</p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/general/latest/gr/elb.html'>Elastic Load Balancing endpoints and quotas</a> topic in the <i>Amazon Web Services General Reference</i>: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.</p> </li> <li> <p> <b>Amazon Web Services Management Console</b>: Go to the Amazon EC2 page, choose <b>Load Balancers</b> in the navigation pane, select the load balancer, and get the value of the <b>Hosted zone</b> field on the <b>Description</b> tab.</p> </li> <li> <p> <b>Elastic Load Balancing API</b>: Use <code>DescribeLoadBalancers</code> to get the applicable value. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: Use <a href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> to get the value of <code>CanonicalHostedZoneNameId</code>.</p> </li> <li> <p>Application and Network Load Balancers: Use <a href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> to get the value of <code>CanonicalHostedZoneId</code>.</p> </li> </ul> </li> <li> <p> <b>CLI</b>: Use <code>describe-load-balancers</code> to get the applicable value. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: Use <a href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'>describe-load-balancers</a> to get the value of <code>CanonicalHostedZoneNameId</code>.</p> </li> <li> <p>Application and Network Load Balancers: Use <a href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'>describe-load-balancers</a> to get the value of <code>CanonicalHostedZoneId</code>.</p> </li> </ul> </li> </ul> </dd> <dt>Global Accelerator accelerator</dt> <dd> <p>Specify <code>Z2BJ6XQ5FK7U4H</code>.</p> </dd> <dt>An Amazon S3 bucket configured as a static website</dt> <dd> <p>Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table <a href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'>Amazon S3 Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> </dd> <dt>Another Route 53 resource record set in your hosted zone</dt> <dd> <p>Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)</p> </dd> </dl>") + hostedZoneId?: string; +} + +@doc("ResourceRecordSetRegion enum") +union ResourceRecordSetRegion { + @doc("ResourceRecordSetRegion enum af-south-1") + AfSouth1: "af-south-1", + + @doc("ResourceRecordSetRegion enum ap-east-1") + ApEast1: "ap-east-1", + + @doc("ResourceRecordSetRegion enum ap-northeast-1") + ApNortheast1: "ap-northeast-1", + + @doc("ResourceRecordSetRegion enum ap-northeast-2") + ApNortheast2: "ap-northeast-2", + + @doc("ResourceRecordSetRegion enum ap-northeast-3") + ApNortheast3: "ap-northeast-3", + + @doc("ResourceRecordSetRegion enum ap-south-1") + ApSouth1: "ap-south-1", + + @doc("ResourceRecordSetRegion enum ap-south-2") + ApSouth2: "ap-south-2", + + @doc("ResourceRecordSetRegion enum ap-southeast-1") + ApSoutheast1: "ap-southeast-1", + + @doc("ResourceRecordSetRegion enum ap-southeast-2") + ApSoutheast2: "ap-southeast-2", + + @doc("ResourceRecordSetRegion enum ap-southeast-3") + ApSoutheast3: "ap-southeast-3", + + @doc("ResourceRecordSetRegion enum ap-southeast-4") + ApSoutheast4: "ap-southeast-4", + + @doc("ResourceRecordSetRegion enum ca-central-1") + CaCentral1: "ca-central-1", + + @doc("ResourceRecordSetRegion enum ca-west-1") + CaWest1: "ca-west-1", + + @doc("ResourceRecordSetRegion enum cn-north-1") + CnNorth1: "cn-north-1", + + @doc("ResourceRecordSetRegion enum cn-northwest-1") + CnNorthwest1: "cn-northwest-1", + + @doc("ResourceRecordSetRegion enum eu-central-1") + EuCentral1: "eu-central-1", + + @doc("ResourceRecordSetRegion enum eu-central-2") + EuCentral2: "eu-central-2", + + @doc("ResourceRecordSetRegion enum eu-north-1") + EuNorth1: "eu-north-1", + + @doc("ResourceRecordSetRegion enum eu-south-1") + EuSouth1: "eu-south-1", + + @doc("ResourceRecordSetRegion enum eu-south-2") + EuSouth2: "eu-south-2", + + @doc("ResourceRecordSetRegion enum eu-west-1") + EuWest1: "eu-west-1", + + @doc("ResourceRecordSetRegion enum eu-west-2") + EuWest2: "eu-west-2", + + @doc("ResourceRecordSetRegion enum eu-west-3") + EuWest3: "eu-west-3", + + @doc("ResourceRecordSetRegion enum il-central-1") + IlCentral1: "il-central-1", + + @doc("ResourceRecordSetRegion enum me-central-1") + MeCentral1: "me-central-1", + + @doc("ResourceRecordSetRegion enum me-south-1") + MeSouth1: "me-south-1", + + @doc("ResourceRecordSetRegion enum sa-east-1") + SaEast1: "sa-east-1", + + @doc("ResourceRecordSetRegion enum us-east-1") + UsEast1: "us-east-1", + + @doc("ResourceRecordSetRegion enum us-east-2") + UsEast2: "us-east-2", + + @doc("ResourceRecordSetRegion enum us-west-1") + UsWest1: "us-west-1", + + @doc("ResourceRecordSetRegion enum us-west-2") + UsWest2: "us-west-2", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceRecordSetRegionEnumValue") +model ResourceRecordSetRegionEnumValue { + @doc("Property value") + value?: ResourceRecordSetRegion; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CidrRoutingConfig") +model CidrRoutingConfig { + @doc("<p>The CIDR collection ID.</p>") + collectionId?: string; + + @doc("<p>The CIDR collection location name.</p>") + locationName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GeoLocation") +model GeoLocation { + @doc("<p>The two-letter code for the continent.</p> <p>Amazon Route 53 supports the following continent codes:</p> <ul> <li> <p> <b>AF</b>: Africa</p> </li> <li> <p> <b>AN</b>: Antarctica</p> </li> <li> <p> <b>AS</b>: Asia</p> </li> <li> <p> <b>EU</b>: Europe</p> </li> <li> <p> <b>OC</b>: Oceania</p> </li> <li> <p> <b>NA</b>: North America</p> </li> <li> <p> <b>SA</b>: South America</p> </li> </ul> <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <code>InvalidInput</code> error.</p>") + continentCode?: string; + + @doc("<p>For geolocation resource record sets, the two-letter code for a country.</p> <p>Amazon Route 53 uses the two-letter country codes that are specified in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO standard 3166-1 alpha-2</a>.</p> <p>Route 53 also supports the country code <b>UA</b> for Ukraine.</p>") + countryCode?: string; + + @doc("<p>For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for <code>SubdivisionCode</code>. For a list of state abbreviations, see <a href='https://pe.usps.com/text/pub28/28apb.htm'>Appendix B: Two–Letter State and Possession Abbreviations</a> on the United States Postal Service website. </p> <p>If you specify <code>subdivisioncode</code>, you must also specify <code>US</code> for <code>CountryCode</code>. </p>") + subdivisionCode?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GeoProximityLocation") +model GeoProximityLocation { + @doc("<p> The Amazon Web Services Region the resource you are directing DNS traffic to, is in. </p>") + awsRegion?: string; + + @doc("<p> The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. </p> <p>To use <code>Bias</code> to change the size of the geographic region, specify the applicable value for the bias:</p> <ul> <li> <p>To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. </p> </li> <li> <p>To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. </p> </li> </ul>") + bias?: int32; + + @doc("<p> Contains the longitude and latitude for a geographic region. </p>") + coordinates?: Coordinates; + + @doc("<p> Specifies an Amazon Web Services Local Zone Group. </p> <p>A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is <code>us-east-1-bue-1a</code> the Local Zone Group is <code>us-east-1-bue-1</code>.</p> <p>You can identify the Local Zones Group for a specific Local Zone by using the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html'>describe-availability-zones</a> CLI command:</p> <p>This command returns: <code>'GroupName': 'us-west-2-den-1'</code>, specifying that the Local Zone <code>us-west-2-den-1a</code> belongs to the Local Zone Group <code>us-west-2-den-1</code>.</p>") + localZoneGroup?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceRecord") +model ResourceRecord { + @doc("<p>The current or new DNS record value, not to exceed 4,000 characters. In the case of a <code>DELETE</code> action, if the current value does not match the actual value, an error is returned. For descriptions about how to format <code>Value</code> for different record types, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'>Supported DNS Resource Record Types</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>You can specify more than one value for all record types except <code>CNAME</code> and <code>SOA</code>. </p> <note> <p>If you're creating an alias resource record set, omit <code>Value</code>.</p> </note>") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Coordinates") +model Coordinates { + @doc("<p> Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). </p>") + latitude?: string; + + @doc("<p> Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). </p>") + longitude?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Route53ResourceRecordSets { + get is ArmResourceRead<Route53ResourceRecordSet>; + @doc("Create a Route53ResourceRecordSet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Route53ResourceRecordSet>; + update is ArmCustomPatchAsync< + Route53ResourceRecordSet, + Azure.ResourceManager.Foundations.TagsUpdateModel<Route53ResourceRecordSet> + >; + delete is ArmResourceDeleteWithoutOkAsync<Route53ResourceRecordSet>; + listByResourceGroup is ArmResourceListByParent<Route53ResourceRecordSet>; + listBySubscription is ArmListBySubscription<Route53ResourceRecordSet>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\route53\route53-2013-04-01.normal.json +// AWS Shape: ResourceRecordSet +// +// Related information for backend service: +// AWS Servcie : Route 53 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.302.50 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Route53ResourceRecordSet.Management/tspconfig.yaml b/specification/awsconnector/Route53ResourceRecordSet.Management/tspconfig.yaml new file mode 100644 index 000000000000..e86f037af4f8 --- /dev/null +++ b/specification/awsconnector/Route53ResourceRecordSet.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/route53ResourceRecordSet.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_CreateOrReplace.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_CreateOrReplace.json new file mode 100644 index 000000000000..ff84c07b97ac --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_CreateOrReplace.json @@ -0,0 +1,145 @@ +{ + "title": "S3AccessPoints_CreateOrReplace", + "operationId": "S3AccessPoints_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + } + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Delete.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Delete.json new file mode 100644 index 000000000000..bee2e5ee5540 --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3AccessPoints_Delete", + "operationId": "S3AccessPoints_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Get.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Get.json new file mode 100644 index 000000000000..87e1df256057 --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Get.json @@ -0,0 +1,60 @@ +{ + "title": "S3AccessPoints_Get", + "operationId": "S3AccessPoints_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListByResourceGroup.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListByResourceGroup.json new file mode 100644 index 000000000000..cbac656e7ff8 --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "S3AccessPoints_ListByResourceGroup", + "operationId": "S3AccessPoints_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListBySubscription.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListBySubscription.json new file mode 100644 index 000000000000..1c64144ab22e --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "S3AccessPoints_ListBySubscription", + "operationId": "S3AccessPoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Update.json b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Update.json new file mode 100644 index 000000000000..8ff3a88103d6 --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/examples/2024-12-01/S3AccessPoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "S3AccessPoints_Update", + "operationId": "S3AccessPoints_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1063": "rbjyjsazucwucmhwgswsdmleucnafx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/S3AccessPoint.Management/main.tsp b/specification/awsconnector/S3AccessPoint.Management/main.tsp new file mode 100644 index 000000000000..918ee31a44c5 --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/main.tsp @@ -0,0 +1,162 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- S3AccessPoints ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "S3 Access Point", + plural: "S3 Access Points", + }, + keywords: ["Microsoft.AwsConnector", "S3", "Access", "Point"], +}) +@doc("A Microsoft.AwsConnector resource") +model S3AccessPoint is TrackedResource<S3AccessPointProperties> { + @doc("Name of S3AccessPoint") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("s3AccessPoints") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3AccessPoint") +model S3AccessPointProperties { + @doc("AWS Properties") + awsProperties?: AwsS3AccessPointProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsS3AccessPoint") +model AwsS3AccessPointProperties { + @doc("The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.") + `alias`?: string; + + @doc("The Amazon Resource Name (ARN) of the specified accesspoint. the Amazon Resource Name (ARN) of the specified accesspoint.") + arn?: string; + + @doc("The name of the bucket that you want to associate this Access Point with.") + bucket?: string; + + @doc("The AWS account ID associated with the S3 bucket associated with this access point.") + bucketAccountId?: string; + + @doc("The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.") + name?: string; + + @doc("Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.") + networkOrigin?: NetworkOrigin; + + @doc("The Access Point Policy you want to apply to this access point.") + policy?: unknown; + + @doc("The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.") + publicAccessBlockConfiguration?: PublicAccessBlockConfiguration; + + @doc("If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). The Virtual Private Cloud (VPC) configuration for a bucket access point.") + vpcConfiguration?: VpcConfiguration; +} + +@doc("NetworkOrigin enum") +union NetworkOrigin { + @doc("NetworkOrigin enum Internet") + Internet: "Internet", + + @doc("NetworkOrigin enum VPC") + VPC: "VPC", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PublicAccessBlockConfiguration") +model PublicAccessBlockConfiguration { + @doc("Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. - PUT Object calls fail if the request includes a public ACL.. - PUT Bucket calls fail if the request includes a public ACL.Enabling this setting doesn't affect existing policies or ACLs.") + blockPublicAcls?: boolean; + + @doc("Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.") + blockPublicPolicy?: boolean; + + @doc("Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.") + ignorePublicAcls?: boolean; + + @doc("Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.") + restrictPublicBuckets?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VpcConfiguration") +model VpcConfiguration { + @doc("If this field is specified, this access point will only allow connections from the specified VPC ID.") + vpcId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface S3AccessPoints { + get is ArmResourceRead<S3AccessPoint>; + @doc("Create a S3AccessPoint. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<S3AccessPoint>; + update is ArmCustomPatchAsync< + S3AccessPoint, + Azure.ResourceManager.Foundations.TagsUpdateModel<S3AccessPoint> + >; + delete is ArmResourceDeleteWithoutOkAsync<S3AccessPoint>; + listByResourceGroup is ArmResourceListByParent<S3AccessPoint>; + listBySubscription is ArmListBySubscription<S3AccessPoint>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::S3::AccessPoint +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/S3AccessPoint.Management/tspconfig.yaml b/specification/awsconnector/S3AccessPoint.Management/tspconfig.yaml new file mode 100644 index 000000000000..5f00b5adda6e --- /dev/null +++ b/specification/awsconnector/S3AccessPoint.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/s3AccessPoint.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_CreateOrReplace.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_CreateOrReplace.json new file mode 100644 index 000000000000..8b79c50d5a21 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_CreateOrReplace.json @@ -0,0 +1,1135 @@ +{ + "title": "S3Buckets_CreateOrReplace", + "operationId": "S3Buckets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + } + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Delete.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Delete.json new file mode 100644 index 000000000000..87782300d038 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3Buckets_Delete", + "operationId": "S3Buckets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Get.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Get.json new file mode 100644 index 000000000000..d3a09631c8b0 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Get.json @@ -0,0 +1,390 @@ +{ + "title": "S3Buckets_Get", + "operationId": "S3Buckets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListByResourceGroup.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListByResourceGroup.json new file mode 100644 index 000000000000..043ecf6018c7 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListByResourceGroup.json @@ -0,0 +1,394 @@ +{ + "title": "S3Buckets_ListByResourceGroup", + "operationId": "S3Buckets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListBySubscription.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListBySubscription.json new file mode 100644 index 000000000000..a389daee9478 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_ListBySubscription.json @@ -0,0 +1,393 @@ +{ + "title": "S3Buckets_ListBySubscription", + "operationId": "S3Buckets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Update.json b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Update.json new file mode 100644 index 000000000000..20794117e3f1 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/examples/2024-12-01/S3Buckets_Update.json @@ -0,0 +1,400 @@ +{ + "title": "S3Buckets_Update", + "operationId": "S3Buckets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6199": "aiwjzitzgmjyezz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/S3Bucket.Management/main.tsp b/specification/awsconnector/S3Bucket.Management/main.tsp new file mode 100644 index 000000000000..1e2460c5bef9 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/main.tsp @@ -0,0 +1,1488 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- S3Buckets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "S3 Bucket", + plural: "S3 Buckets", + }, + keywords: ["Microsoft.AwsConnector", "S3", "Bucket"], +}) +@doc("A Microsoft.AwsConnector resource") +model S3Bucket is TrackedResource<S3BucketProperties> { + @doc("Name of S3Bucket") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("s3Buckets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3Bucket") +model S3BucketProperties { + @doc("AWS Properties") + awsProperties?: AwsS3BucketProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsS3Bucket") +model AwsS3BucketProperties { + @doc("Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*.") + accelerateConfiguration?: AccelerateConfiguration; + + @doc("This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.") + accessControl?: AccessControl; + + @doc("Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.") + @extension("x-ms-identifiers", []) + analyticsConfigurations?: AnalyticsConfiguration[]; + + @doc("the Amazon Resource Name (ARN) of the specified bucket.") + arn?: string; + + @doc("Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*.") + bucketEncryption?: BucketEncryption; + + @doc("A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.") + bucketName?: string; + + @doc("Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*.") + corsConfiguration?: CorsConfiguration; + + @doc("Property domainName") + domainName?: string; + + @doc("Property dualStackDomainName") + dualStackDomainName?: string; + + @doc("Defines how Amazon S3 handles Intelligent-Tiering storage.") + @extension("x-ms-identifiers", []) + intelligentTieringConfigurations?: IntelligentTieringConfiguration[]; + + @doc("Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.") + @extension("x-ms-identifiers", []) + inventoryConfigurations?: InventoryConfiguration[]; + + @doc("Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*.") + lifecycleConfiguration?: LifecycleConfiguration; + + @doc("Settings that define where logs are stored. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*. To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions.") + loggingConfiguration?: LoggingConfiguration; + + @doc("Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).") + @extension("x-ms-identifiers", []) + metricsConfigurations?: MetricsConfiguration[]; + + @doc("Configuration that defines how Amazon S3 handles bucket notifications. Describes the notification configuration for an Amazon S3 bucket. If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3).") + notificationConfiguration?: NotificationConfiguration; + + @doc("This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).") + objectLockConfiguration?: ObjectLockConfiguration; + + @doc("Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.") + objectLockEnabled?: boolean; + + @doc("Configuration that defines how Amazon S3 handles Object Ownership rules. Specifies the container element for Object Ownership rules. S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*.") + ownershipControls?: OwnershipControls; + + @doc("Configuration that defines how Amazon S3 handles public access. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of 'Public'](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*.") + publicAccessBlockConfiguration?: PublicAccessBlockConfiguration; + + @doc("Property regionalDomainName") + regionalDomainName?: string; + + @doc("Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*.") + replicationConfiguration?: ReplicationConfiguration; + + @doc("An arbitrary set of tags (key-value pairs) for this S3 bucket.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*.") + versioningConfiguration?: VersioningConfiguration; + + @doc("Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Specifies website configuration parameters for an Amazon S3 bucket.") + websiteConfiguration?: WebsiteConfiguration; + + @doc("Property websiteURL") + websiteURL?: string; +} + +@doc("AccessControl enum") +union AccessControl { + @doc("AccessControl enum AuthenticatedRead") + AuthenticatedRead: "AuthenticatedRead", + + @doc("AccessControl enum AwsExecRead") + AwsExecRead: "AwsExecRead", + + @doc("AccessControl enum BucketOwnerFullControl") + BucketOwnerFullControl: "BucketOwnerFullControl", + + @doc("AccessControl enum BucketOwnerRead") + BucketOwnerRead: "BucketOwnerRead", + + @doc("AccessControl enum LogDeliveryWrite") + LogDeliveryWrite: "LogDeliveryWrite", + + @doc("AccessControl enum Private") + Private: "Private", + + @doc("AccessControl enum PublicRead") + PublicRead: "PublicRead", + + @doc("AccessControl enum PublicReadWrite") + PublicReadWrite: "PublicReadWrite", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccelerateConfiguration") +model AccelerateConfiguration { + @doc("Specifies the transfer acceleration status of the bucket.") + accelerationStatus?: AccelerateConfigurationAccelerationStatus; +} + +@doc("AccelerateConfigurationAccelerationStatus enum") +union AccelerateConfigurationAccelerationStatus { + @doc("AccelerateConfigurationAccelerationStatus enum Enabled") + Enabled: "Enabled", + + @doc("AccelerateConfigurationAccelerationStatus enum Suspended") + Suspended: "Suspended", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AnalyticsConfiguration") +model AnalyticsConfiguration { + @doc("The ID that identifies the analytics configuration.") + id?: string; + + @doc("The prefix that an object must have to be included in the analytics results.") + prefix?: string; + + @doc("Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.") + storageClassAnalysis?: StorageClassAnalysis; + + @doc("The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.") + @extension("x-ms-identifiers", []) + tagFilters?: TagFilter[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of BucketEncryption") +model BucketEncryption { + @doc("Specifies the default server-side-encryption configuration.") + @extension("x-ms-identifiers", []) + serverSideEncryptionConfiguration?: ServerSideEncryptionRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CorsConfiguration") +model CorsConfiguration { + @doc("A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.") + @extension("x-ms-identifiers", []) + corsRules?: CorsRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of IntelligentTieringConfiguration") +model IntelligentTieringConfiguration { + @doc("The ID used to identify the S3 Intelligent-Tiering configuration.") + id?: string; + + @doc("An object key name prefix that identifies the subset of objects to which the rule applies.") + prefix?: string; + + @doc("Specifies the status of the configuration.") + status?: IntelligentTieringConfigurationStatus; + + @doc("A container for a key-value pair.") + @extension("x-ms-identifiers", []) + tagFilters?: TagFilter[]; + + @doc("Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.") + @extension("x-ms-identifiers", []) + tierings?: Tiering[]; +} + +@doc("IntelligentTieringConfigurationStatus enum") +union IntelligentTieringConfigurationStatus { + @doc("IntelligentTieringConfigurationStatus enum Disabled") + Disabled: "Disabled", + + @doc("IntelligentTieringConfigurationStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InventoryConfiguration") +model InventoryConfiguration { + @doc("Contains information about where to publish the inventory results. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.") + destination?: Destination; + + @doc("Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated.") + enabled?: boolean; + + @doc("The ID used to identify the inventory configuration.") + id?: string; + + @doc("Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.") + includedObjectVersions?: InventoryConfigurationIncludedObjectVersions; + + @doc("Contains the optional fields that are included in the inventory results.") + @extension("x-ms-identifiers", []) + optionalFields?: InventoryConfigurationOptionalFields[]; + + @doc("Specifies the inventory filter prefix.") + prefix?: string; + + @doc("Specifies the schedule for generating inventory results.") + scheduleFrequency?: InventoryConfigurationScheduleFrequency; +} + +@doc("InventoryConfigurationIncludedObjectVersions enum") +union InventoryConfigurationIncludedObjectVersions { + @doc("InventoryConfigurationIncludedObjectVersions enum All") + All: "All", + + @doc("InventoryConfigurationIncludedObjectVersions enum Current") + Current: "Current", + + string, +} + +@doc("InventoryConfigurationScheduleFrequency enum") +union InventoryConfigurationScheduleFrequency { + @doc("InventoryConfigurationScheduleFrequency enum Daily") + Daily: "Daily", + + @doc("InventoryConfigurationScheduleFrequency enum Weekly") + Weekly: "Weekly", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LifecycleConfiguration") +model LifecycleConfiguration { + @doc("A lifecycle rule for individual objects in an Amazon S3 bucket.") + @extension("x-ms-identifiers", []) + rules?: Rule[]; +} + +@doc("InventoryConfigurationOptionalFields enum") +union InventoryConfigurationOptionalFields { + @doc("InventoryConfigurationOptionalFields enum BucketKeyStatus") + BucketKeyStatus: "BucketKeyStatus", + + @doc("InventoryConfigurationOptionalFields enum ChecksumAlgorithm") + ChecksumAlgorithm: "ChecksumAlgorithm", + + @doc("InventoryConfigurationOptionalFields enum ETag") + ETag: "ETag", + + @doc("InventoryConfigurationOptionalFields enum EncryptionStatus") + EncryptionStatus: "EncryptionStatus", + + @doc("InventoryConfigurationOptionalFields enum IntelligentTieringAccessTier") + IntelligentTieringAccessTier: "IntelligentTieringAccessTier", + + @doc("InventoryConfigurationOptionalFields enum IsMultipartUploaded") + IsMultipartUploaded: "IsMultipartUploaded", + + @doc("InventoryConfigurationOptionalFields enum LastModifiedDate") + LastModifiedDate: "LastModifiedDate", + + @doc("InventoryConfigurationOptionalFields enum ObjectAccessControlList") + ObjectAccessControlList: "ObjectAccessControlList", + + @doc("InventoryConfigurationOptionalFields enum ObjectLockLegalHoldStatus") + ObjectLockLegalHoldStatus: "ObjectLockLegalHoldStatus", + + @doc("InventoryConfigurationOptionalFields enum ObjectLockMode") + ObjectLockMode: "ObjectLockMode", + + @doc("InventoryConfigurationOptionalFields enum ObjectLockRetainUntilDate") + ObjectLockRetainUntilDate: "ObjectLockRetainUntilDate", + + @doc("InventoryConfigurationOptionalFields enum ObjectOwner") + ObjectOwner: "ObjectOwner", + + @doc("InventoryConfigurationOptionalFields enum ReplicationStatus") + ReplicationStatus: "ReplicationStatus", + + @doc("InventoryConfigurationOptionalFields enum Size") + Size: "Size", + + @doc("InventoryConfigurationOptionalFields enum StorageClass") + StorageClass: "StorageClass", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoggingConfiguration") +model LoggingConfiguration { + @doc("The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined.") + destinationBucketName?: string; + + @doc("A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.") + logFilePrefix?: string; + + @doc("Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix.") + targetObjectKeyFormat?: TargetObjectKeyFormat; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of MetricsConfiguration") +model MetricsConfiguration { + @doc("The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.") + accessPointArn?: string; + + @doc("The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration.") + id?: string; + + @doc("The prefix that an object must have to be included in the metrics results.") + prefix?: string; + + @doc("Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.") + @extension("x-ms-identifiers", []) + tagFilters?: TagFilter[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NotificationConfiguration") +model NotificationConfiguration { + @doc("Enables delivery of events to Amazon EventBridge. Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*. Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*") + eventBridgeConfiguration?: EventBridgeConfiguration; + + @doc("Describes the LAMlong functions to invoke and the events for which to invoke them.") + @extension("x-ms-identifiers", []) + lambdaConfigurations?: LambdaConfiguration[]; + + @doc("The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.") + @extension("x-ms-identifiers", []) + queueConfigurations?: QueueConfiguration[]; + + @doc("The topic to which notifications are sent and the events for which notifications are generated.") + @extension("x-ms-identifiers", []) + topicConfigurations?: TopicConfiguration[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ObjectLockConfiguration") +model ObjectLockConfiguration { + @doc("Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket.") + objectLockEnabled?: string; + + @doc("Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket.") + rule?: ObjectLockRule; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OwnershipControls") +model OwnershipControls { + @doc("Specifies the container element for Object Ownership rules.") + @extension("x-ms-identifiers", []) + rules?: OwnershipControlsRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PublicAccessBlockConfiguration") +model PublicAccessBlockConfiguration { + @doc("Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.") + blockPublicAcls?: boolean; + + @doc("Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.") + blockPublicPolicy?: boolean; + + @doc("Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.") + ignorePublicAcls?: boolean; + + @doc("Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.") + restrictPublicBuckets?: boolean; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationConfiguration") +model ReplicationConfiguration { + @doc("The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*.") + role?: string; + + @doc("A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.") + @extension("x-ms-identifiers", []) + rules?: ReplicationRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Name of the object key.") + key?: string; + + @doc("Value of the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of VersioningConfiguration") +model VersioningConfiguration { + @doc("The versioning state of the bucket.") + status?: VersioningConfigurationStatus = "Suspended"; +} + +@doc("VersioningConfigurationStatus enum") +union VersioningConfigurationStatus { + @doc("VersioningConfigurationStatus enum Enabled") + Enabled: "Enabled", + + @doc("VersioningConfigurationStatus enum Suspended") + Suspended: "Suspended", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WebsiteConfiguration") +model WebsiteConfiguration { + @doc("The name of the error document for the website.") + errorDocument?: string; + + @doc("The name of the index document for the website.") + indexDocument?: string; + + @doc("The redirect behavior for every request to this bucket's website endpoint. If you specify this property, you can't specify any other property. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.") + redirectAllRequestsTo?: RedirectAllRequestsTo; + + @doc("Rules that define when a redirect is applied and the redirect behavior.") + @extension("x-ms-identifiers", []) + routingRules?: RoutingRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of StorageClassAnalysis") +model StorageClassAnalysis { + @doc("Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.") + dataExport?: DataExport; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TagFilter") +model TagFilter { + @doc("The tag key.") + key?: string; + + @doc("The tag value.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServerSideEncryptionRule") +model ServerSideEncryptionRule { + @doc("Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*.") + bucketKeyEnabled?: boolean; + + @doc("Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*.") + serverSideEncryptionByDefault?: ServerSideEncryptionByDefault; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CorsRule") +model CorsRule { + @doc("Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.") + @extension("x-ms-identifiers", []) + allowedHeaders?: string[]; + + @doc("An HTTP method that you allow the origin to run. *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``") + @extension("x-ms-identifiers", []) + allowedMethods?: CorsRuleAllowedMethods[]; + + @doc("One or more origins you want customers to be able to access the bucket from.") + @extension("x-ms-identifiers", []) + allowedOrigins?: string[]; + + @doc("One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).") + @extension("x-ms-identifiers", []) + exposedHeaders?: string[]; + + @doc("A unique identifier for this rule. The value must be no more than 255 characters.") + id?: string; + + @doc("The time in seconds that your browser is to cache the preflight response for the specified resource.") + maxAge?: int32; +} + +@doc("CorsRuleAllowedMethods enum") +union CorsRuleAllowedMethods { + @doc("CorsRuleAllowedMethods enum DELETE") + DELETE: "DELETE", + + @doc("CorsRuleAllowedMethods enum GET") + GET: "GET", + + @doc("CorsRuleAllowedMethods enum HEAD") + HEAD: "HEAD", + + @doc("CorsRuleAllowedMethods enum POST") + POST: "POST", + + @doc("CorsRuleAllowedMethods enum PUT") + PUT: "PUT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tiering") +model Tiering { + @doc("S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class.") + accessTier?: TieringAccessTier; + + @doc("The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).") + days?: int32; +} + +@doc("TieringAccessTier enum") +union TieringAccessTier { + @doc("TieringAccessTier enum ARCHIVE_ACCESS") + ARCHIVE_ACCESS: "ARCHIVE_ACCESS", + + @doc("TieringAccessTier enum DEEP_ARCHIVE_ACCESS") + DEEP_ARCHIVE_ACCESS: "DEEP_ARCHIVE_ACCESS", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Destination") +model Destination { + @doc("The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.") + bucketAccountId?: string; + + @doc("The Amazon Resource Name (ARN) of the bucket to which data is exported.") + bucketArn?: string; + + @doc("Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``") + format?: DestinationFormat; + + @doc("The prefix to use when exporting data. The prefix is prepended to all results.") + prefix?: string; +} + +@doc("DestinationFormat enum") +union DestinationFormat { + @doc("DestinationFormat enum CSV") + CSV: "CSV", + + @doc("DestinationFormat enum ORC") + ORC: "ORC", + + @doc("DestinationFormat enum Parquet") + Parquet: "Parquet", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Rule") +model Rule { + @doc("Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*.") + abortIncompleteMultipartUpload?: AbortIncompleteMultipartUpload; + + @doc("Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)") + expirationDate?: string; + + @doc("Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time.") + expirationInDays?: int32; + + @doc("Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``.") + expiredObjectDeleteMarker?: boolean; + + @doc("Unique identifier for the rule. The value can't be longer than 255 characters.") + id?: string; + + @doc("Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html).") + noncurrentVersionExpiration?: NoncurrentVersionExpiration; + + @doc("(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time.") + noncurrentVersionExpirationInDays?: int32; + + @doc("(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property.") + noncurrentVersionTransition?: NoncurrentVersionTransition; + + @doc("For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.") + @extension("x-ms-identifiers", []) + noncurrentVersionTransitions?: NoncurrentVersionTransition[]; + + @doc("Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.") + objectSizeGreaterThan?: string; + + @doc("Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*.") + objectSizeLessThan?: string; + + @doc("Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).") + prefix?: string; + + @doc("If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.") + status?: RuleStatus; + + @doc("Tags to use to identify a subset of objects to which the lifecycle rule applies.") + @extension("x-ms-identifiers", []) + tagFilters?: TagFilter[]; + + @doc("(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*.") + transition?: Transition; + + @doc("One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.") + @extension("x-ms-identifiers", []) + transitions?: Transition[]; +} + +@doc("RuleStatus enum") +union RuleStatus { + @doc("RuleStatus enum Disabled") + Disabled: "Disabled", + + @doc("RuleStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TargetObjectKeyFormat") +model TargetObjectKeyFormat { + @doc("This format defaults the prefix to the given log file prefix for delivering server access log file.") + simplePrefix?: unknown; + + @doc("Amazon S3 keys for log objects are partitioned in the following format: ``[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`` PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.") + partitionedPrefix?: PartitionedPrefix; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EventBridgeConfiguration") +model EventBridgeConfiguration { + @doc("Enables delivery of events to Amazon EventBridge.") + eventBridgeEnabled?: boolean = true; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LambdaConfiguration") +model LambdaConfiguration { + @doc("The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.") + event?: string; + + @doc("The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.") + filter?: NotificationFilter; + + @doc("The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs.") + function?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of QueueConfiguration") +model QueueConfiguration { + @doc("The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.") + event?: string; + + @doc("The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.") + filter?: NotificationFilter; + + @doc("The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination.") + queue?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of TopicConfiguration") +model TopicConfiguration { + @doc("The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.") + event?: string; + + @doc("The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*.") + filter?: NotificationFilter; + + @doc("The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.") + topic?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ObjectLockRule") +model ObjectLockRule { + @doc("The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time.") + defaultRetention?: DefaultRetention; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of OwnershipControlsRule") +model OwnershipControlsRule { + @doc("Specifies an object ownership rule.") + objectOwnership?: OwnershipControlsRuleObjectOwnership; +} + +@doc("OwnershipControlsRuleObjectOwnership enum") +union OwnershipControlsRuleObjectOwnership { + @doc("OwnershipControlsRuleObjectOwnership enum BucketOwnerEnforced") + BucketOwnerEnforced: "BucketOwnerEnforced", + + @doc("OwnershipControlsRuleObjectOwnership enum BucketOwnerPreferred") + BucketOwnerPreferred: "BucketOwnerPreferred", + + @doc("OwnershipControlsRuleObjectOwnership enum ObjectWriter") + ObjectWriter: "ObjectWriter", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationRule") +model ReplicationRule { + @doc("Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).") + deleteMarkerReplication?: DeleteMarkerReplication; + + @doc("A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).") + destination?: ReplicationDestination; + + @doc("A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element.") + filter?: ReplicationRuleFilter; + + @doc("A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as 'ID'.") + id?: string; + + @doc("An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).") + prefix?: string; + + @doc("The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*.") + priority?: int32; + + @doc("A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects.") + sourceSelectionCriteria?: SourceSelectionCriteria; + + @doc("Specifies whether the rule is enabled.") + status?: ReplicationRuleStatus; +} + +@doc("ReplicationRuleStatus enum") +union ReplicationRuleStatus { + @doc("ReplicationRuleStatus enum Disabled") + Disabled: "Disabled", + + @doc("ReplicationRuleStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RedirectAllRequestsTo") +model RedirectAllRequestsTo { + @doc("Name of the host where requests are redirected.") + hostName?: string; + + @doc("Protocol to use when redirecting requests. The default is the protocol that is used in the original request.") + protocol?: RedirectAllRequestsToProtocol; +} + +@doc("RedirectAllRequestsToProtocol enum") +union RedirectAllRequestsToProtocol { + @doc("RedirectAllRequestsToProtocol enum http") + http: "http", + + @doc("RedirectAllRequestsToProtocol enum https") + https: "https", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RoutingRule") +model RoutingRule { + @doc("Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.") + redirectRule?: RedirectRule; + + @doc("A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.") + routingRuleCondition?: RoutingRuleCondition; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DataExport") +model DataExport { + @doc("The place to store the data for an analysis. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.") + destination?: Destination; + + @doc("The version of the output schema to use when exporting data. Must be ``V_1``.") + outputSchemaVersion?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ServerSideEncryptionByDefault") +model ServerSideEncryptionByDefault { + @doc("AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + Key Alias: ``alias/alias-name`` If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.") + kmsMasterKeyID?: string; + + @doc("Server-side encryption algorithm to use for the default encryption.") + sseAlgorithm?: ServerSideEncryptionByDefaultSSEAlgorithm; +} + +@doc("ServerSideEncryptionByDefaultSSEAlgorithm enum") +union ServerSideEncryptionByDefaultSSEAlgorithm { + @doc("ServerSideEncryptionByDefaultSSEAlgorithm enum AES256") + AES256: "AES256", + + @doc("ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms") + AwsKms: "aws:kms", + + @doc("ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms:dsse") + AwsKmsDsse: "aws:kms:dsse", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AbortIncompleteMultipartUpload") +model AbortIncompleteMultipartUpload { + @doc("Specifies the number of days after which Amazon S3 stops an incomplete multipart upload.") + daysAfterInitiation?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NoncurrentVersionExpiration") +model NoncurrentVersionExpiration { + @doc("Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.") + newerNoncurrentVersions?: int32; + + @doc("Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.") + noncurrentDays?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NoncurrentVersionTransition") +model NoncurrentVersionTransition { + @doc("Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*.") + newerNoncurrentVersions?: int32; + + @doc("The class of storage used to store the object.") + storageClass?: NoncurrentVersionTransitionStorageClass; + + @doc("Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*.") + transitionInDays?: int32; +} + +@doc("NoncurrentVersionTransitionStorageClass enum") +union NoncurrentVersionTransitionStorageClass { + @doc("NoncurrentVersionTransitionStorageClass enum DEEP_ARCHIVE") + DEEP_ARCHIVE: "DEEP_ARCHIVE", + + @doc("NoncurrentVersionTransitionStorageClass enum GLACIER") + GLACIER: "GLACIER", + + @doc("NoncurrentVersionTransitionStorageClass enum GLACIER_IR") + GLACIER_IR: "GLACIER_IR", + + @doc("NoncurrentVersionTransitionStorageClass enum INTELLIGENT_TIERING") + INTELLIGENT_TIERING: "INTELLIGENT_TIERING", + + @doc("NoncurrentVersionTransitionStorageClass enum ONEZONE_IA") + ONEZONE_IA: "ONEZONE_IA", + + @doc("NoncurrentVersionTransitionStorageClass enum STANDARD_IA") + STANDARD_IA: "STANDARD_IA", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Transition") +model Transition { + @doc("The storage class to which you want the object to transition.") + storageClass?: TransitionStorageClass; + + @doc("Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)") + transitionDate?: string; + + @doc("Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.") + transitionInDays?: int32; +} + +@doc("TransitionStorageClass enum") +union TransitionStorageClass { + @doc("TransitionStorageClass enum DEEP_ARCHIVE") + DEEP_ARCHIVE: "DEEP_ARCHIVE", + + @doc("TransitionStorageClass enum GLACIER") + GLACIER: "GLACIER", + + @doc("TransitionStorageClass enum GLACIER_IR") + GLACIER_IR: "GLACIER_IR", + + @doc("TransitionStorageClass enum INTELLIGENT_TIERING") + INTELLIGENT_TIERING: "INTELLIGENT_TIERING", + + @doc("TransitionStorageClass enum ONEZONE_IA") + ONEZONE_IA: "ONEZONE_IA", + + @doc("TransitionStorageClass enum STANDARD_IA") + STANDARD_IA: "STANDARD_IA", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PartitionedPrefix") +model PartitionedPrefix { + @doc("Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.") + partitionDateSource?: PartitionedPrefixPartitionDateSource; +} + +@doc("PartitionedPrefixPartitionDateSource enum") +union PartitionedPrefixPartitionDateSource { + @doc("PartitionedPrefixPartitionDateSource enum DeliveryTime") + DeliveryTime: "DeliveryTime", + + @doc("PartitionedPrefixPartitionDateSource enum EventTime") + EventTime: "EventTime", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NotificationFilter") +model NotificationFilter { + @doc("A container for object key name prefix and suffix filtering rules. A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules.") + s3Key?: S3KeyFilter; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DefaultRetention") +model DefaultRetention { + @doc("The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.") + days?: int32; + + @doc("The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.") + mode?: DefaultRetentionMode; + + @doc("The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.") + years?: int32; +} + +@doc("DefaultRetentionMode enum") +union DefaultRetentionMode { + @doc("DefaultRetentionMode enum COMPLIANCE") + COMPLIANCE: "COMPLIANCE", + + @doc("DefaultRetentionMode enum GOVERNANCE") + GOVERNANCE: "GOVERNANCE", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of DeleteMarkerReplication") +model DeleteMarkerReplication { + @doc("Indicates whether to replicate delete markers. Disabled by default.") + status?: DeleteMarkerReplicationStatus; +} + +@doc("DeleteMarkerReplicationStatus enum") +union DeleteMarkerReplicationStatus { + @doc("DeleteMarkerReplicationStatus enum Disabled") + Disabled: "Disabled", + + @doc("DeleteMarkerReplicationStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationDestination") +model ReplicationDestination { + @doc("Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object.") + accessControlTranslation?: AccessControlTranslation; + + @doc("Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required.") + account?: string; + + @doc("The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.") + bucket?: string; + + @doc("Specifies encryption-related information. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.") + encryptionConfiguration?: EncryptionConfiguration; + + @doc("A container specifying replication metrics-related settings enabling replication metrics and events. A container specifying replication metrics-related settings enabling replication metrics and events.") + metrics?: Metrics; + + @doc("A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block.") + replicationTime?: ReplicationTime; + + @doc("The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.") + storageClass?: ReplicationDestinationStorageClass; +} + +@doc("ReplicationDestinationStorageClass enum") +union ReplicationDestinationStorageClass { + @doc("ReplicationDestinationStorageClass enum DEEP_ARCHIVE") + DEEP_ARCHIVE: "DEEP_ARCHIVE", + + @doc("ReplicationDestinationStorageClass enum GLACIER") + GLACIER: "GLACIER", + + @doc("ReplicationDestinationStorageClass enum GLACIER_IR") + GLACIER_IR: "GLACIER_IR", + + @doc("ReplicationDestinationStorageClass enum INTELLIGENT_TIERING") + INTELLIGENT_TIERING: "INTELLIGENT_TIERING", + + @doc("ReplicationDestinationStorageClass enum ONEZONE_IA") + ONEZONE_IA: "ONEZONE_IA", + + @doc("ReplicationDestinationStorageClass enum REDUCED_REDUNDANCY") + REDUCED_REDUNDANCY: "REDUCED_REDUNDANCY", + + @doc("ReplicationDestinationStorageClass enum STANDARD") + STANDARD: "STANDARD", + + @doc("ReplicationDestinationStorageClass enum STANDARD_IA") + STANDARD_IA: "STANDARD_IA", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationRuleFilter") +model ReplicationRuleFilter { + @doc("A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag") + and?: ReplicationRuleAndOperator; + + @doc("An object key name prefix that identifies the subset of objects to which the rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).") + prefix?: string; + + @doc("A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket.") + tagFilter?: TagFilter; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceSelectionCriteria") +model SourceSelectionCriteria { + @doc("A filter that you can specify for selection for modifications on replicas. A filter that you can specify for selection for modifications on replicas.") + replicaModifications?: ReplicaModifications; + + @doc("A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. A container for filter information for the selection of S3 objects encrypted with AWS KMS.") + sseKmsEncryptedObjects?: SseKmsEncryptedObjects; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RedirectRule") +model RedirectRule { + @doc("The host name to use in the redirect request.") + hostName?: string; + + @doc("The HTTP redirect code to use on the response. Not required if one of the siblings is present.") + httpRedirectCode?: string; + + @doc("Protocol to use when redirecting requests. The default is the protocol that is used in the original request.") + protocol?: RedirectRuleProtocol; + + @doc("The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).") + replaceKeyPrefixWith?: string; + + @doc("The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints).") + replaceKeyWith?: string; +} + +@doc("RedirectRuleProtocol enum") +union RedirectRuleProtocol { + @doc("RedirectRuleProtocol enum http") + http: "http", + + @doc("RedirectRuleProtocol enum https") + https: "https", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of RoutingRuleCondition") +model RoutingRuleCondition { + @doc("The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied.") + httpErrorCodeReturnedEquals?: string; + + @doc("The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied.") + keyPrefixEquals?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3KeyFilter") +model S3KeyFilter { + @doc("A list of containers for the key-value pair that defines the criteria for the filter rule.") + @extension("x-ms-identifiers", []) + rules?: FilterRule[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of AccessControlTranslation") +model AccessControlTranslation { + @doc("Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*.") + owner?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EncryptionConfiguration") +model EncryptionConfiguration { + @doc("Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*.") + replicaKmsKeyID?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Metrics") +model Metrics { + @doc("A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``.") + eventThreshold?: ReplicationTimeValue; + + @doc("Specifies whether the replication metrics are enabled.") + status?: MetricsStatus; +} + +@doc("MetricsStatus enum") +union MetricsStatus { + @doc("MetricsStatus enum Disabled") + Disabled: "Disabled", + + @doc("MetricsStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationTime") +model ReplicationTime { + @doc("Specifies whether the replication time is enabled.") + status?: ReplicationTimeStatus; + + @doc("A container specifying the time by which replication should be complete for all objects and operations on objects. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``.") + time?: ReplicationTimeValue; +} + +@doc("ReplicationTimeStatus enum") +union ReplicationTimeStatus { + @doc("ReplicationTimeStatus enum Disabled") + Disabled: "Disabled", + + @doc("ReplicationTimeStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationRuleAndOperator") +model ReplicationRuleAndOperator { + @doc("An object key name prefix that identifies the subset of objects to which the rule applies.") + prefix?: string; + + @doc("An array of tags containing key and value pairs.") + @extension("x-ms-identifiers", []) + tagFilters?: TagFilter[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicaModifications") +model ReplicaModifications { + @doc("Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled``") + status?: ReplicaModificationsStatus; +} + +@doc("ReplicaModificationsStatus enum") +union ReplicaModificationsStatus { + @doc("ReplicaModificationsStatus enum Disabled") + Disabled: "Disabled", + + @doc("ReplicaModificationsStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SseKmsEncryptedObjects") +model SseKmsEncryptedObjects { + @doc("Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.") + status?: SseKmsEncryptedObjectsStatus; +} + +@doc("SseKmsEncryptedObjectsStatus enum") +union SseKmsEncryptedObjectsStatus { + @doc("SseKmsEncryptedObjectsStatus enum Disabled") + Disabled: "Disabled", + + @doc("SseKmsEncryptedObjectsStatus enum Enabled") + Enabled: "Enabled", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FilterRule") +model FilterRule { + @doc("The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*.") + name?: string; + + @doc("The value that the filter searches for in object key names.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicationTimeValue") +model ReplicationTimeValue { + @doc("Contains an integer specifying time in minutes. Valid value: 15") + minutes?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface S3Buckets { + get is ArmResourceRead<S3Bucket>; + @doc("Create a S3Bucket. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<S3Bucket>; + update is ArmCustomPatchAsync< + S3Bucket, + Azure.ResourceManager.Foundations.TagsUpdateModel<S3Bucket> + >; + delete is ArmResourceDeleteWithoutOkAsync<S3Bucket>; + listByResourceGroup is ArmResourceListByParent<S3Bucket>; + listBySubscription is ArmListBySubscription<S3Bucket>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::S3::Bucket +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/S3Bucket.Management/tspconfig.yaml b/specification/awsconnector/S3Bucket.Management/tspconfig.yaml new file mode 100644 index 000000000000..836f5bc4c3b6 --- /dev/null +++ b/specification/awsconnector/S3Bucket.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/s3Bucket.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_CreateOrReplace.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..5f65fe877f9e --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_CreateOrReplace.json @@ -0,0 +1,103 @@ +{ + "title": "S3BucketPolicies_CreateOrReplace", + "operationId": "S3BucketPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + } + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Delete.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Delete.json new file mode 100644 index 000000000000..8eddb97090c3 --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3BucketPolicies_Delete", + "operationId": "S3BucketPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Get.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Get.json new file mode 100644 index 000000000000..94ac0c53ae81 --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Get.json @@ -0,0 +1,46 @@ +{ + "title": "S3BucketPolicies_Get", + "operationId": "S3BucketPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListByResourceGroup.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..a01c54aa0293 --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "S3BucketPolicies_ListByResourceGroup", + "operationId": "S3BucketPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListBySubscription.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListBySubscription.json new file mode 100644 index 000000000000..dd7e1717296e --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "S3BucketPolicies_ListBySubscription", + "operationId": "S3BucketPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Update.json b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Update.json new file mode 100644 index 000000000000..606d5554630e --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/examples/2024-12-01/S3BucketPolicies_Update.json @@ -0,0 +1,56 @@ +{ + "title": "S3BucketPolicies_Update", + "operationId": "S3BucketPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3408": "opgnsffamzhe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/S3BucketPolicy.Management/main.tsp b/specification/awsconnector/S3BucketPolicy.Management/main.tsp new file mode 100644 index 000000000000..eecadc6e196b --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/main.tsp @@ -0,0 +1,111 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- S3BucketPolicies ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "S3 Get Bucket Policy Output", + plural: "S3 Bucket Policies", + }, + keywords: [ + "Microsoft.AwsConnector", + "S3", + "Get", + "Bucket", + "Policy", + "Output" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model S3BucketPolicy is TrackedResource<S3BucketPolicyProperties> { + @doc("Name of S3BucketPolicy") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("s3BucketPolicies") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3BucketPolicy") +model S3BucketPolicyProperties { + @doc("AWS Properties") + awsProperties?: AwsS3BucketPolicyProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsS3BucketPolicy") +model AwsS3BucketPolicyProperties { + @doc("<p>The bucket policy as a JSON document.</p>") + policy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface S3BucketPolicies { + get is ArmResourceRead<S3BucketPolicy>; + @doc("Create a S3BucketPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<S3BucketPolicy>; + update is ArmCustomPatchAsync< + S3BucketPolicy, + Azure.ResourceManager.Foundations.TagsUpdateModel<S3BucketPolicy> + >; + delete is ArmResourceDeleteWithoutOkAsync<S3BucketPolicy>; + listByResourceGroup is ArmResourceListByParent<S3BucketPolicy>; + listBySubscription is ArmListBySubscription<S3BucketPolicy>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\s3\s3-2006-03-01.normal.json +// AWS Shape: GetBucketPolicyOutput +// +// Related information for backend service: +// AWS Servcie : S3 +// Product Version : 3.7.798.0 +// SDK Version : 3.7.307.24 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/S3BucketPolicy.Management/tspconfig.yaml b/specification/awsconnector/S3BucketPolicy.Management/tspconfig.yaml new file mode 100644 index 000000000000..7b66550affbd --- /dev/null +++ b/specification/awsconnector/S3BucketPolicy.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/s3BucketPolicy.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json new file mode 100644 index 000000000000..0467ffb634e5 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + } + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json new file mode 100644 index 000000000000..d4090b261e03 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Delete", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json new file mode 100644 index 000000000000..302e75e4da0c --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json @@ -0,0 +1,51 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Get", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + } + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json new file mode 100644 index 000000000000..a46b20e36a56 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json new file mode 100644 index 000000000000..8ebf11293525 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json new file mode 100644 index 000000000000..523fa45a52d4 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/examples/2024-12-01/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json @@ -0,0 +1,61 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Update", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9280": "fjdgxmttvenfe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/main.tsp b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/main.tsp new file mode 100644 index 000000000000..f9cf768ff86f --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/main.tsp @@ -0,0 +1,138 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- S3ControlMultiRegionAccessPointPolicyDocuments ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "S3 Control Multi Region Access Point Policy Document", + plural: "S3 Control Multi Region Access Point Policy Documents", + }, + keywords: [ + "Microsoft.AwsConnector", + "S3 ", + "Control", + "Multi", + "Region", + "Access", + "Point", + "Policy", + "Document" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model S3ControlMultiRegionAccessPointPolicyDocument + is TrackedResource<S3ControlMultiRegionAccessPointPolicyDocumentProperties> { + @doc("Name of S3ControlMultiRegionAccessPointPolicyDocument") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("s3ControlMultiRegionAccessPointPolicyDocuments") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of S3ControlMultiRegionAccessPointPolicyDocument") +model S3ControlMultiRegionAccessPointPolicyDocumentProperties { + @doc("AWS Properties") + awsProperties?: AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsS3ControlMultiRegionAccessPointPolicyDocument") +model AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties { + @doc("<p>The last established policy for the Multi-Region Access Point.</p>") + established?: EstablishedMultiRegionAccessPointPolicy; + + @doc("<p>The proposed policy for the Multi-Region Access Point.</p>") + proposed?: ProposedMultiRegionAccessPointPolicy; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of EstablishedMultiRegionAccessPointPolicy") +model EstablishedMultiRegionAccessPointPolicy { + @doc("<p>The details of the last established policy.</p>") + policy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ProposedMultiRegionAccessPointPolicy") +model ProposedMultiRegionAccessPointPolicy { + @doc("<p>The details of the proposed policy.</p>") + policy?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface S3ControlMultiRegionAccessPointPolicyDocuments { + get is ArmResourceRead<S3ControlMultiRegionAccessPointPolicyDocument>; + @doc("Create a S3ControlMultiRegionAccessPointPolicyDocument. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<S3ControlMultiRegionAccessPointPolicyDocument>; + update is ArmCustomPatchAsync< + S3ControlMultiRegionAccessPointPolicyDocument, + Azure.ResourceManager.Foundations.TagsUpdateModel<S3ControlMultiRegionAccessPointPolicyDocument> + >; + delete is ArmResourceDeleteWithoutOkAsync<S3ControlMultiRegionAccessPointPolicyDocument>; + listByResourceGroup is ArmResourceListByParent<S3ControlMultiRegionAccessPointPolicyDocument>; + listBySubscription is ArmListBySubscription<S3ControlMultiRegionAccessPointPolicyDocument>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\s3control\s3control-2018-08-20.normal.json +// AWS Shape: MultiRegionAccessPointPolicyDocument +// +// Related information for backend service: +// AWS Servcie : S3 Control +// Product Version : 3.7.798.0 +// SDK Version : 3.7.305.48 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/tspconfig.yaml b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/tspconfig.yaml new file mode 100644 index 000000000000..858c25908697 --- /dev/null +++ b/specification/awsconnector/S3ControlMultiRegionAccessPointPolicyDocument.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/s3ControlMultiRegionAccessPointPolicyDocument.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_CreateOrReplace.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_CreateOrReplace.json new file mode 100644 index 000000000000..598a64d551f8 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "SageMakerApps_CreateOrReplace", + "operationId": "SageMakerApps_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + } + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + } + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Delete.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Delete.json new file mode 100644 index 000000000000..52d6265a36e9 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SageMakerApps_Delete", + "operationId": "SageMakerApps_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Get.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Get.json new file mode 100644 index 000000000000..9fd5406aac91 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Get.json @@ -0,0 +1,61 @@ +{ + "title": "SageMakerApps_Get", + "operationId": "SageMakerApps_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + } + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListByResourceGroup.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListByResourceGroup.json new file mode 100644 index 000000000000..5a1d0c4a4b13 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "SageMakerApps_ListByResourceGroup", + "operationId": "SageMakerApps_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + ], + "nextLink": "https://microsoft.com/aqj" + } + } + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListBySubscription.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListBySubscription.json new file mode 100644 index 000000000000..0e311d944ce7 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "SageMakerApps_ListBySubscription", + "operationId": "SageMakerApps_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + ], + "nextLink": "https://microsoft.com/aqj" + } + } + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Update.json b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Update.json new file mode 100644 index 000000000000..0bb6db37e891 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/examples/2024-12-01/SageMakerApps_Update.json @@ -0,0 +1,71 @@ +{ + "title": "SageMakerApps_Update", + "operationId": "SageMakerApps_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key854": "ycoocbs" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SageMakerApp.Management/main.tsp b/specification/awsconnector/SageMakerApp.Management/main.tsp new file mode 100644 index 000000000000..bf33e9a77a91 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/main.tsp @@ -0,0 +1,360 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SageMakerApps ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Sage Maker App", + plural: "Sage Maker Apps", + }, + keywords: ["Microsoft.AwsConnector", "Sage", "Maker", "App"], +}) +@doc("A Microsoft.AwsConnector resource") +model SageMakerApp is TrackedResource<SageMakerAppProperties> { + @doc("Name of SageMakerApp") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("sageMakerApps") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SageMakerApp") +model SageMakerAppProperties { + @doc("AWS Properties") + awsProperties?: AwsSageMakerAppProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSageMakerApp") +model AwsSageMakerAppProperties { + @doc("The Amazon Resource Name (ARN) of the app.") + appArn?: string; + + @doc("The name of the app.") + appName?: string; + + @doc("The type of app.") + appType?: AppType; + + @doc("The domain ID.") + domainId?: string; + + @doc("The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.") + resourceSpec?: ResourceSpec; + + @doc("A list of tags to apply to the app.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The user profile name.") + userProfileName?: string; +} + +@doc("AppType enum") +union AppType { + @doc("AppType enum Canvas") + Canvas: "Canvas", + + @doc("AppType enum JupyterServer") + JupyterServer: "JupyterServer", + + @doc("AppType enum KernelGateway") + KernelGateway: "KernelGateway", + + @doc("AppType enum RSessionGateway") + RSessionGateway: "RSessionGateway", + + @doc("AppType enum RStudioServerPro") + RStudioServerPro: "RStudioServerPro", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceSpec") +model ResourceSpec { + @doc("The instance type that the image version runs on.") + instanceType?: ResourceSpecInstanceType; + + @doc("The ARN of the SageMaker image that the image version belongs to.") + sageMakerImageArn?: string; + + @doc("The ARN of the image version created on the instance.") + sageMakerImageVersionArn?: string; +} + +@doc("ResourceSpecInstanceType enum") +union ResourceSpecInstanceType { + @doc("ResourceSpecInstanceType enum ml.c5.12xlarge") + MlC512xlarge: "ml.c5.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.18xlarge") + MlC518xlarge: "ml.c5.18xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.24xlarge") + MlC524xlarge: "ml.c5.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.2xlarge") + MlC52xlarge: "ml.c5.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.4xlarge") + MlC54xlarge: "ml.c5.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.9xlarge") + MlC59xlarge: "ml.c5.9xlarge", + + @doc("ResourceSpecInstanceType enum ml.c5.large") + MlC5Large: "ml.c5.large", + + @doc("ResourceSpecInstanceType enum ml.c5.xlarge") + MlC5Xlarge: "ml.c5.xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.12xlarge") + MlG4dn12xlarge: "ml.g4dn.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.16xlarge") + MlG4dn16xlarge: "ml.g4dn.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.2xlarge") + MlG4dn2xlarge: "ml.g4dn.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.4xlarge") + MlG4dn4xlarge: "ml.g4dn.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.8xlarge") + MlG4dn8xlarge: "ml.g4dn.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.g4dn.xlarge") + MlG4dnXlarge: "ml.g4dn.xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.12xlarge") + MlG512xlarge: "ml.g5.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.16xlarge") + MlG516xlarge: "ml.g5.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.24xlarge") + MlG524xlarge: "ml.g5.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.2xlarge") + MlG52xlarge: "ml.g5.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.48xlarge") + MlG548xlarge: "ml.g5.48xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.4xlarge") + MlG54xlarge: "ml.g5.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.8xlarge") + MlG58xlarge: "ml.g5.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.g5.xlarge") + MlG5Xlarge: "ml.g5.xlarge", + + @doc("ResourceSpecInstanceType enum ml.geospatial.interactive") + MlGeospatialInteractive: "ml.geospatial.interactive", + + @doc("ResourceSpecInstanceType enum ml.m5.12xlarge") + MlM512xlarge: "ml.m5.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.16xlarge") + MlM516xlarge: "ml.m5.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.24xlarge") + MlM524xlarge: "ml.m5.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.2xlarge") + MlM52xlarge: "ml.m5.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.4xlarge") + MlM54xlarge: "ml.m5.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.8xlarge") + MlM58xlarge: "ml.m5.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5.large") + MlM5Large: "ml.m5.large", + + @doc("ResourceSpecInstanceType enum ml.m5.xlarge") + MlM5Xlarge: "ml.m5.xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.12xlarge") + MlM5d12xlarge: "ml.m5d.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.16xlarge") + MlM5d16xlarge: "ml.m5d.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.24xlarge") + MlM5d24xlarge: "ml.m5d.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.2xlarge") + MlM5d2xlarge: "ml.m5d.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.4xlarge") + MlM5d4xlarge: "ml.m5d.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.8xlarge") + MlM5d8xlarge: "ml.m5d.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.m5d.large") + MlM5dLarge: "ml.m5d.large", + + @doc("ResourceSpecInstanceType enum ml.m5d.xlarge") + MlM5dXlarge: "ml.m5d.xlarge", + + @doc("ResourceSpecInstanceType enum ml.p3.16xlarge") + MlP316xlarge: "ml.p3.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.p3.2xlarge") + MlP32xlarge: "ml.p3.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.p3.8xlarge") + MlP38xlarge: "ml.p3.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.p3dn.24xlarge") + MlP3dn24xlarge: "ml.p3dn.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.p4d.24xlarge") + MlP4d24xlarge: "ml.p4d.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.p4de.24xlarge") + MlP4de24xlarge: "ml.p4de.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.12xlarge") + MlR512xlarge: "ml.r5.12xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.16xlarge") + MlR516xlarge: "ml.r5.16xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.24xlarge") + MlR524xlarge: "ml.r5.24xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.2xlarge") + MlR52xlarge: "ml.r5.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.4xlarge") + MlR54xlarge: "ml.r5.4xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.8xlarge") + MlR58xlarge: "ml.r5.8xlarge", + + @doc("ResourceSpecInstanceType enum ml.r5.large") + MlR5Large: "ml.r5.large", + + @doc("ResourceSpecInstanceType enum ml.r5.xlarge") + MlR5Xlarge: "ml.r5.xlarge", + + @doc("ResourceSpecInstanceType enum ml.t3.2xlarge") + MlT32xlarge: "ml.t3.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.t3.large") + MlT3Large: "ml.t3.large", + + @doc("ResourceSpecInstanceType enum ml.t3.medium") + MlT3Medium: "ml.t3.medium", + + @doc("ResourceSpecInstanceType enum ml.t3.micro") + MlT3Micro: "ml.t3.micro", + + @doc("ResourceSpecInstanceType enum ml.t3.small") + MlT3Small: "ml.t3.small", + + @doc("ResourceSpecInstanceType enum ml.t3.xlarge") + MlT3Xlarge: "ml.t3.xlarge", + + @doc("ResourceSpecInstanceType enum ml.trn1.2xlarge") + MlTrn12xlarge: "ml.trn1.2xlarge", + + @doc("ResourceSpecInstanceType enum ml.trn1.32xlarge") + MlTrn132xlarge: "ml.trn1.32xlarge", + + @doc("ResourceSpecInstanceType enum ml.trn1n.32xlarge") + MlTrn1n32xlarge: "ml.trn1n.32xlarge", + + @doc("ResourceSpecInstanceType enum system") + system: "system", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("Property key") + key?: string; + + @doc("Property value") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SageMakerApps { + get is ArmResourceRead<SageMakerApp>; + @doc("Create a SageMakerApp. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SageMakerApp>; + update is ArmCustomPatchAsync< + SageMakerApp, + Azure.ResourceManager.Foundations.TagsUpdateModel<SageMakerApp> + >; + delete is ArmResourceDeleteWithoutOkAsync<SageMakerApp>; + listByResourceGroup is ArmResourceListByParent<SageMakerApp>; + listBySubscription is ArmListBySubscription<SageMakerApp>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SageMaker::App +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SageMakerApp.Management/tspconfig.yaml b/specification/awsconnector/SageMakerApp.Management/tspconfig.yaml new file mode 100644 index 000000000000..4f5c6ad0ccb7 --- /dev/null +++ b/specification/awsconnector/SageMakerApp.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/sageMakerApp.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_CreateOrReplace.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..7842e0147e17 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_CreateOrReplace", + "operationId": "SageMakerNotebookInstanceSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + } + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + } + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Delete.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Delete.json new file mode 100644 index 000000000000..d2aab117c12b --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Delete", + "operationId": "SageMakerNotebookInstanceSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Get.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Get.json new file mode 100644 index 000000000000..9f11a3741d8e --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Get.json @@ -0,0 +1,61 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Get", + "operationId": "SageMakerNotebookInstanceSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + } + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..f2043ad76453 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_ListByResourceGroup", + "operationId": "SageMakerNotebookInstanceSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + ], + "nextLink": "https://microsoft.com/anlnxs" + } + } + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListBySubscription.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListBySubscription.json new file mode 100644 index 000000000000..00f1298f42c8 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_ListBySubscription", + "operationId": "SageMakerNotebookInstanceSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + ], + "nextLink": "https://microsoft.com/anlnxs" + } + } + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Update.json b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Update.json new file mode 100644 index 000000000000..9bede76ae0c9 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/examples/2024-12-01/SageMakerNotebookInstanceSummaries_Update.json @@ -0,0 +1,71 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Update", + "operationId": "SageMakerNotebookInstanceSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9780": "fgjlfvqaeiizxtdrk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/main.tsp b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/main.tsp new file mode 100644 index 000000000000..0c887d8f1e35 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/main.tsp @@ -0,0 +1,662 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SageMakerNotebookInstanceSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Sage Maker Notebook Instance Summary", + plural: "Sage Maker Notebook Instance Summaries", + }, + keywords: [ + "Microsoft.AwsConnector", + "Sage", + "Maker", + "Notebook", + "Instance", + "Summary" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model SageMakerNotebookInstanceSummary + is TrackedResource<SageMakerNotebookInstanceSummaryProperties> { + @doc("Name of SageMakerNotebookInstanceSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("sageMakerNotebookInstanceSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SageMakerNotebookInstanceSummary") +model SageMakerNotebookInstanceSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsSageMakerNotebookInstanceSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSageMakerNotebookInstanceSummary") +model AwsSageMakerNotebookInstanceSummaryProperties { + @doc("<p>An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'>Amazon Web Services CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'>Associating Git Repositories with SageMaker Notebook Instances</a>.</p>") + @extension("x-ms-identifiers", []) + additionalCodeRepositories?: string[]; + + @doc("<p>A timestamp that shows when the notebook instance was created.</p>") + creationTime?: utcDateTime; + + @doc("<p>The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'>Amazon Web Services CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'>Associating Git Repositories with SageMaker Notebook Instances</a>.</p>") + defaultCodeRepository?: string; + + @doc("<p>The type of ML compute instance that the notebook instance is running on.</p>") + instanceType?: InstanceTypeEnumValue; + + @doc("<p>A timestamp that shows when the notebook instance was last modified.</p>") + lastModifiedTime?: utcDateTime; + + @doc("<p>The Amazon Resource Name (ARN) of the notebook instance.</p>") + notebookInstanceArn?: string; + + @doc("<p>The name of a notebook instance lifecycle configuration associated with this notebook instance.</p> <p>For information about notebook instance lifestyle configurations, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html'>Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>") + notebookInstanceLifecycleConfigName?: string; + + @doc("<p>The name of the notebook instance that you want a summary for.</p>") + notebookInstanceName?: string; + + @doc("<p>The status of the notebook instance.</p>") + notebookInstanceStatus?: NotebookInstanceStatusEnumValue; + + @doc("<p>The URL that you use to connect to the Jupyter notebook running in your notebook instance. </p>") + url?: string; +} + +@doc("InstanceType enum") +union InstanceType { + @doc("InstanceType enum ml.c4.2xlarge") + MlC42xlarge: "ml.c4.2xlarge", + + @doc("InstanceType enum ml.c4.4xlarge") + MlC44xlarge: "ml.c4.4xlarge", + + @doc("InstanceType enum ml.c4.8xlarge") + MlC48xlarge: "ml.c4.8xlarge", + + @doc("InstanceType enum ml.c4.xlarge") + MlC4Xlarge: "ml.c4.xlarge", + + @doc("InstanceType enum ml.c5.18xlarge") + MlC518xlarge: "ml.c5.18xlarge", + + @doc("InstanceType enum ml.c5.2xlarge") + MlC52xlarge: "ml.c5.2xlarge", + + @doc("InstanceType enum ml.c5.4xlarge") + MlC54xlarge: "ml.c5.4xlarge", + + @doc("InstanceType enum ml.c5.9xlarge") + MlC59xlarge: "ml.c5.9xlarge", + + @doc("InstanceType enum ml.c5.xlarge") + MlC5Xlarge: "ml.c5.xlarge", + + @doc("InstanceType enum ml.c5d.18xlarge") + MlC5d18xlarge: "ml.c5d.18xlarge", + + @doc("InstanceType enum ml.c5d.2xlarge") + MlC5d2xlarge: "ml.c5d.2xlarge", + + @doc("InstanceType enum ml.c5d.4xlarge") + MlC5d4xlarge: "ml.c5d.4xlarge", + + @doc("InstanceType enum ml.c5d.9xlarge") + MlC5d9xlarge: "ml.c5d.9xlarge", + + @doc("InstanceType enum ml.c5d.xlarge") + MlC5dXlarge: "ml.c5d.xlarge", + + @doc("InstanceType enum ml.c6i.12xlarge") + MlC6i12xlarge: "ml.c6i.12xlarge", + + @doc("InstanceType enum ml.c6i.16xlarge") + MlC6i16xlarge: "ml.c6i.16xlarge", + + @doc("InstanceType enum ml.c6i.24xlarge") + MlC6i24xlarge: "ml.c6i.24xlarge", + + @doc("InstanceType enum ml.c6i.2xlarge") + MlC6i2xlarge: "ml.c6i.2xlarge", + + @doc("InstanceType enum ml.c6i.32xlarge") + MlC6i32xlarge: "ml.c6i.32xlarge", + + @doc("InstanceType enum ml.c6i.4xlarge") + MlC6i4xlarge: "ml.c6i.4xlarge", + + @doc("InstanceType enum ml.c6i.8xlarge") + MlC6i8xlarge: "ml.c6i.8xlarge", + + @doc("InstanceType enum ml.c6i.large") + MlC6iLarge: "ml.c6i.large", + + @doc("InstanceType enum ml.c6i.xlarge") + MlC6iXlarge: "ml.c6i.xlarge", + + @doc("InstanceType enum ml.c6id.12xlarge") + MlC6id12xlarge: "ml.c6id.12xlarge", + + @doc("InstanceType enum ml.c6id.16xlarge") + MlC6id16xlarge: "ml.c6id.16xlarge", + + @doc("InstanceType enum ml.c6id.24xlarge") + MlC6id24xlarge: "ml.c6id.24xlarge", + + @doc("InstanceType enum ml.c6id.2xlarge") + MlC6id2xlarge: "ml.c6id.2xlarge", + + @doc("InstanceType enum ml.c6id.32xlarge") + MlC6id32xlarge: "ml.c6id.32xlarge", + + @doc("InstanceType enum ml.c6id.4xlarge") + MlC6id4xlarge: "ml.c6id.4xlarge", + + @doc("InstanceType enum ml.c6id.8xlarge") + MlC6id8xlarge: "ml.c6id.8xlarge", + + @doc("InstanceType enum ml.c6id.large") + MlC6idLarge: "ml.c6id.large", + + @doc("InstanceType enum ml.c6id.xlarge") + MlC6idXlarge: "ml.c6id.xlarge", + + @doc("InstanceType enum ml.c7i.12xlarge") + MlC7i12xlarge: "ml.c7i.12xlarge", + + @doc("InstanceType enum ml.c7i.16xlarge") + MlC7i16xlarge: "ml.c7i.16xlarge", + + @doc("InstanceType enum ml.c7i.24xlarge") + MlC7i24xlarge: "ml.c7i.24xlarge", + + @doc("InstanceType enum ml.c7i.2xlarge") + MlC7i2xlarge: "ml.c7i.2xlarge", + + @doc("InstanceType enum ml.c7i.48xlarge") + MlC7i48xlarge: "ml.c7i.48xlarge", + + @doc("InstanceType enum ml.c7i.4xlarge") + MlC7i4xlarge: "ml.c7i.4xlarge", + + @doc("InstanceType enum ml.c7i.8xlarge") + MlC7i8xlarge: "ml.c7i.8xlarge", + + @doc("InstanceType enum ml.c7i.large") + MlC7iLarge: "ml.c7i.large", + + @doc("InstanceType enum ml.c7i.xlarge") + MlC7iXlarge: "ml.c7i.xlarge", + + @doc("InstanceType enum ml.g4dn.12xlarge") + MlG4dn12xlarge: "ml.g4dn.12xlarge", + + @doc("InstanceType enum ml.g4dn.16xlarge") + MlG4dn16xlarge: "ml.g4dn.16xlarge", + + @doc("InstanceType enum ml.g4dn.2xlarge") + MlG4dn2xlarge: "ml.g4dn.2xlarge", + + @doc("InstanceType enum ml.g4dn.4xlarge") + MlG4dn4xlarge: "ml.g4dn.4xlarge", + + @doc("InstanceType enum ml.g4dn.8xlarge") + MlG4dn8xlarge: "ml.g4dn.8xlarge", + + @doc("InstanceType enum ml.g4dn.xlarge") + MlG4dnXlarge: "ml.g4dn.xlarge", + + @doc("InstanceType enum ml.g5.12xlarge") + MlG512xlarge: "ml.g5.12xlarge", + + @doc("InstanceType enum ml.g5.16xlarge") + MlG516xlarge: "ml.g5.16xlarge", + + @doc("InstanceType enum ml.g5.24xlarge") + MlG524xlarge: "ml.g5.24xlarge", + + @doc("InstanceType enum ml.g5.2xlarge") + MlG52xlarge: "ml.g5.2xlarge", + + @doc("InstanceType enum ml.g5.48xlarge") + MlG548xlarge: "ml.g5.48xlarge", + + @doc("InstanceType enum ml.g5.4xlarge") + MlG54xlarge: "ml.g5.4xlarge", + + @doc("InstanceType enum ml.g5.8xlarge") + MlG58xlarge: "ml.g5.8xlarge", + + @doc("InstanceType enum ml.g5.xlarge") + MlG5Xlarge: "ml.g5.xlarge", + + @doc("InstanceType enum ml.inf1.24xlarge") + MlInf124xlarge: "ml.inf1.24xlarge", + + @doc("InstanceType enum ml.inf1.2xlarge") + MlInf12xlarge: "ml.inf1.2xlarge", + + @doc("InstanceType enum ml.inf1.6xlarge") + MlInf16xlarge: "ml.inf1.6xlarge", + + @doc("InstanceType enum ml.inf1.xlarge") + MlInf1Xlarge: "ml.inf1.xlarge", + + @doc("InstanceType enum ml.m4.10xlarge") + MlM410xlarge: "ml.m4.10xlarge", + + @doc("InstanceType enum ml.m4.16xlarge") + MlM416xlarge: "ml.m4.16xlarge", + + @doc("InstanceType enum ml.m4.2xlarge") + MlM42xlarge: "ml.m4.2xlarge", + + @doc("InstanceType enum ml.m4.4xlarge") + MlM44xlarge: "ml.m4.4xlarge", + + @doc("InstanceType enum ml.m4.xlarge") + MlM4Xlarge: "ml.m4.xlarge", + + @doc("InstanceType enum ml.m5.12xlarge") + MlM512xlarge: "ml.m5.12xlarge", + + @doc("InstanceType enum ml.m5.24xlarge") + MlM524xlarge: "ml.m5.24xlarge", + + @doc("InstanceType enum ml.m5.2xlarge") + MlM52xlarge: "ml.m5.2xlarge", + + @doc("InstanceType enum ml.m5.4xlarge") + MlM54xlarge: "ml.m5.4xlarge", + + @doc("InstanceType enum ml.m5.xlarge") + MlM5Xlarge: "ml.m5.xlarge", + + @doc("InstanceType enum ml.m5d.12xlarge") + MlM5d12xlarge: "ml.m5d.12xlarge", + + @doc("InstanceType enum ml.m5d.16xlarge") + MlM5d16xlarge: "ml.m5d.16xlarge", + + @doc("InstanceType enum ml.m5d.24xlarge") + MlM5d24xlarge: "ml.m5d.24xlarge", + + @doc("InstanceType enum ml.m5d.2xlarge") + MlM5d2xlarge: "ml.m5d.2xlarge", + + @doc("InstanceType enum ml.m5d.4xlarge") + MlM5d4xlarge: "ml.m5d.4xlarge", + + @doc("InstanceType enum ml.m5d.8xlarge") + MlM5d8xlarge: "ml.m5d.8xlarge", + + @doc("InstanceType enum ml.m5d.large") + MlM5dLarge: "ml.m5d.large", + + @doc("InstanceType enum ml.m5d.xlarge") + MlM5dXlarge: "ml.m5d.xlarge", + + @doc("InstanceType enum ml.m6i.12xlarge") + MlM6i12xlarge: "ml.m6i.12xlarge", + + @doc("InstanceType enum ml.m6i.16xlarge") + MlM6i16xlarge: "ml.m6i.16xlarge", + + @doc("InstanceType enum ml.m6i.24xlarge") + MlM6i24xlarge: "ml.m6i.24xlarge", + + @doc("InstanceType enum ml.m6i.2xlarge") + MlM6i2xlarge: "ml.m6i.2xlarge", + + @doc("InstanceType enum ml.m6i.32xlarge") + MlM6i32xlarge: "ml.m6i.32xlarge", + + @doc("InstanceType enum ml.m6i.4xlarge") + MlM6i4xlarge: "ml.m6i.4xlarge", + + @doc("InstanceType enum ml.m6i.8xlarge") + MlM6i8xlarge: "ml.m6i.8xlarge", + + @doc("InstanceType enum ml.m6i.large") + MlM6iLarge: "ml.m6i.large", + + @doc("InstanceType enum ml.m6i.xlarge") + MlM6iXlarge: "ml.m6i.xlarge", + + @doc("InstanceType enum ml.m6id.12xlarge") + MlM6id12xlarge: "ml.m6id.12xlarge", + + @doc("InstanceType enum ml.m6id.16xlarge") + MlM6id16xlarge: "ml.m6id.16xlarge", + + @doc("InstanceType enum ml.m6id.24xlarge") + MlM6id24xlarge: "ml.m6id.24xlarge", + + @doc("InstanceType enum ml.m6id.2xlarge") + MlM6id2xlarge: "ml.m6id.2xlarge", + + @doc("InstanceType enum ml.m6id.32xlarge") + MlM6id32xlarge: "ml.m6id.32xlarge", + + @doc("InstanceType enum ml.m6id.4xlarge") + MlM6id4xlarge: "ml.m6id.4xlarge", + + @doc("InstanceType enum ml.m6id.8xlarge") + MlM6id8xlarge: "ml.m6id.8xlarge", + + @doc("InstanceType enum ml.m6id.large") + MlM6idLarge: "ml.m6id.large", + + @doc("InstanceType enum ml.m6id.xlarge") + MlM6idXlarge: "ml.m6id.xlarge", + + @doc("InstanceType enum ml.m7i.12xlarge") + MlM7i12xlarge: "ml.m7i.12xlarge", + + @doc("InstanceType enum ml.m7i.16xlarge") + MlM7i16xlarge: "ml.m7i.16xlarge", + + @doc("InstanceType enum ml.m7i.24xlarge") + MlM7i24xlarge: "ml.m7i.24xlarge", + + @doc("InstanceType enum ml.m7i.2xlarge") + MlM7i2xlarge: "ml.m7i.2xlarge", + + @doc("InstanceType enum ml.m7i.48xlarge") + MlM7i48xlarge: "ml.m7i.48xlarge", + + @doc("InstanceType enum ml.m7i.4xlarge") + MlM7i4xlarge: "ml.m7i.4xlarge", + + @doc("InstanceType enum ml.m7i.8xlarge") + MlM7i8xlarge: "ml.m7i.8xlarge", + + @doc("InstanceType enum ml.m7i.large") + MlM7iLarge: "ml.m7i.large", + + @doc("InstanceType enum ml.m7i.xlarge") + MlM7iXlarge: "ml.m7i.xlarge", + + @doc("InstanceType enum ml.p2.16xlarge") + MlP216xlarge: "ml.p2.16xlarge", + + @doc("InstanceType enum ml.p2.8xlarge") + MlP28xlarge: "ml.p2.8xlarge", + + @doc("InstanceType enum ml.p2.xlarge") + MlP2Xlarge: "ml.p2.xlarge", + + @doc("InstanceType enum ml.p3.16xlarge") + MlP316xlarge: "ml.p3.16xlarge", + + @doc("InstanceType enum ml.p3.2xlarge") + MlP32xlarge: "ml.p3.2xlarge", + + @doc("InstanceType enum ml.p3.8xlarge") + MlP38xlarge: "ml.p3.8xlarge", + + @doc("InstanceType enum ml.p3dn.24xlarge") + MlP3dn24xlarge: "ml.p3dn.24xlarge", + + @doc("InstanceType enum ml.p4d.24xlarge") + MlP4d24xlarge: "ml.p4d.24xlarge", + + @doc("InstanceType enum ml.p4de.24xlarge") + MlP4de24xlarge: "ml.p4de.24xlarge", + + @doc("InstanceType enum ml.p5.48xlarge") + MlP548xlarge: "ml.p5.48xlarge", + + @doc("InstanceType enum ml.r5.12xlarge") + MlR512xlarge: "ml.r5.12xlarge", + + @doc("InstanceType enum ml.r5.16xlarge") + MlR516xlarge: "ml.r5.16xlarge", + + @doc("InstanceType enum ml.r5.24xlarge") + MlR524xlarge: "ml.r5.24xlarge", + + @doc("InstanceType enum ml.r5.2xlarge") + MlR52xlarge: "ml.r5.2xlarge", + + @doc("InstanceType enum ml.r5.4xlarge") + MlR54xlarge: "ml.r5.4xlarge", + + @doc("InstanceType enum ml.r5.8xlarge") + MlR58xlarge: "ml.r5.8xlarge", + + @doc("InstanceType enum ml.r5.large") + MlR5Large: "ml.r5.large", + + @doc("InstanceType enum ml.r5.xlarge") + MlR5Xlarge: "ml.r5.xlarge", + + @doc("InstanceType enum ml.r6i.12xlarge") + MlR6i12xlarge: "ml.r6i.12xlarge", + + @doc("InstanceType enum ml.r6i.16xlarge") + MlR6i16xlarge: "ml.r6i.16xlarge", + + @doc("InstanceType enum ml.r6i.24xlarge") + MlR6i24xlarge: "ml.r6i.24xlarge", + + @doc("InstanceType enum ml.r6i.2xlarge") + MlR6i2xlarge: "ml.r6i.2xlarge", + + @doc("InstanceType enum ml.r6i.32xlarge") + MlR6i32xlarge: "ml.r6i.32xlarge", + + @doc("InstanceType enum ml.r6i.4xlarge") + MlR6i4xlarge: "ml.r6i.4xlarge", + + @doc("InstanceType enum ml.r6i.8xlarge") + MlR6i8xlarge: "ml.r6i.8xlarge", + + @doc("InstanceType enum ml.r6i.large") + MlR6iLarge: "ml.r6i.large", + + @doc("InstanceType enum ml.r6i.xlarge") + MlR6iXlarge: "ml.r6i.xlarge", + + @doc("InstanceType enum ml.r6id.12xlarge") + MlR6id12xlarge: "ml.r6id.12xlarge", + + @doc("InstanceType enum ml.r6id.16xlarge") + MlR6id16xlarge: "ml.r6id.16xlarge", + + @doc("InstanceType enum ml.r6id.24xlarge") + MlR6id24xlarge: "ml.r6id.24xlarge", + + @doc("InstanceType enum ml.r6id.2xlarge") + MlR6id2xlarge: "ml.r6id.2xlarge", + + @doc("InstanceType enum ml.r6id.32xlarge") + MlR6id32xlarge: "ml.r6id.32xlarge", + + @doc("InstanceType enum ml.r6id.4xlarge") + MlR6id4xlarge: "ml.r6id.4xlarge", + + @doc("InstanceType enum ml.r6id.8xlarge") + MlR6id8xlarge: "ml.r6id.8xlarge", + + @doc("InstanceType enum ml.r6id.large") + MlR6idLarge: "ml.r6id.large", + + @doc("InstanceType enum ml.r6id.xlarge") + MlR6idXlarge: "ml.r6id.xlarge", + + @doc("InstanceType enum ml.r7i.12xlarge") + MlR7i12xlarge: "ml.r7i.12xlarge", + + @doc("InstanceType enum ml.r7i.16xlarge") + MlR7i16xlarge: "ml.r7i.16xlarge", + + @doc("InstanceType enum ml.r7i.24xlarge") + MlR7i24xlarge: "ml.r7i.24xlarge", + + @doc("InstanceType enum ml.r7i.2xlarge") + MlR7i2xlarge: "ml.r7i.2xlarge", + + @doc("InstanceType enum ml.r7i.48xlarge") + MlR7i48xlarge: "ml.r7i.48xlarge", + + @doc("InstanceType enum ml.r7i.4xlarge") + MlR7i4xlarge: "ml.r7i.4xlarge", + + @doc("InstanceType enum ml.r7i.8xlarge") + MlR7i8xlarge: "ml.r7i.8xlarge", + + @doc("InstanceType enum ml.r7i.large") + MlR7iLarge: "ml.r7i.large", + + @doc("InstanceType enum ml.r7i.xlarge") + MlR7iXlarge: "ml.r7i.xlarge", + + @doc("InstanceType enum ml.t2.2xlarge") + MlT22xlarge: "ml.t2.2xlarge", + + @doc("InstanceType enum ml.t2.large") + MlT2Large: "ml.t2.large", + + @doc("InstanceType enum ml.t2.medium") + MlT2Medium: "ml.t2.medium", + + @doc("InstanceType enum ml.t2.xlarge") + MlT2Xlarge: "ml.t2.xlarge", + + @doc("InstanceType enum ml.t3.2xlarge") + MlT32xlarge: "ml.t3.2xlarge", + + @doc("InstanceType enum ml.t3.large") + MlT3Large: "ml.t3.large", + + @doc("InstanceType enum ml.t3.medium") + MlT3Medium: "ml.t3.medium", + + @doc("InstanceType enum ml.t3.xlarge") + MlT3Xlarge: "ml.t3.xlarge", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceTypeEnumValue") +model InstanceTypeEnumValue { + @doc("Property value") + value?: InstanceType; +} + +@doc("NotebookInstanceStatus enum") +union NotebookInstanceStatus { + @doc("NotebookInstanceStatus enum Deleting") + Deleting: "Deleting", + + @doc("NotebookInstanceStatus enum Failed") + Failed: "Failed", + + @doc("NotebookInstanceStatus enum InService") + InService: "InService", + + @doc("NotebookInstanceStatus enum Pending") + Pending: "Pending", + + @doc("NotebookInstanceStatus enum Stopped") + Stopped: "Stopped", + + @doc("NotebookInstanceStatus enum Stopping") + Stopping: "Stopping", + + @doc("NotebookInstanceStatus enum Updating") + Updating: "Updating", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NotebookInstanceStatusEnumValue") +model NotebookInstanceStatusEnumValue { + @doc("Property value") + value?: NotebookInstanceStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SageMakerNotebookInstanceSummaries { + get is ArmResourceRead<SageMakerNotebookInstanceSummary>; + @doc("Create a SageMakerNotebookInstanceSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SageMakerNotebookInstanceSummary>; + update is ArmCustomPatchAsync< + SageMakerNotebookInstanceSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<SageMakerNotebookInstanceSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<SageMakerNotebookInstanceSummary>; + listByResourceGroup is ArmResourceListByParent<SageMakerNotebookInstanceSummary>; + listBySubscription is ArmListBySubscription<SageMakerNotebookInstanceSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\sagemaker\sagemaker-2017-07-24.normal.json +// AWS Shape: NotebookInstanceSummary +// +// Related information for backend service: +// AWS Servcie : SageMaker +// Product Version : 3.7.798.0 +// SDK Version : 3.7.319.4 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/tspconfig.yaml b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..3df18b81ddb5 --- /dev/null +++ b/specification/awsconnector/SageMakerNotebookInstanceSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/sageMakerNotebookInstanceSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_CreateOrReplace.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_CreateOrReplace.json new file mode 100644 index 000000000000..018225eb1526 --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "SecretsManagerResourcePolicies_CreateOrReplace", + "operationId": "SecretsManagerResourcePolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + } + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Delete.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Delete.json new file mode 100644 index 000000000000..cab4cad0df1b --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SecretsManagerResourcePolicies_Delete", + "operationId": "SecretsManagerResourcePolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Get.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Get.json new file mode 100644 index 000000000000..96f2b00efb5a --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Get.json @@ -0,0 +1,48 @@ +{ + "title": "SecretsManagerResourcePolicies_Get", + "operationId": "SecretsManagerResourcePolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListByResourceGroup.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..0ec4ed6376f2 --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "SecretsManagerResourcePolicies_ListByResourceGroup", + "operationId": "SecretsManagerResourcePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListBySubscription.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListBySubscription.json new file mode 100644 index 000000000000..fa4bd732843d --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "SecretsManagerResourcePolicies_ListBySubscription", + "operationId": "SecretsManagerResourcePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Update.json b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Update.json new file mode 100644 index 000000000000..7ad92cc6c9e3 --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/examples/2024-12-01/SecretsManagerResourcePolicies_Update.json @@ -0,0 +1,58 @@ +{ + "title": "SecretsManagerResourcePolicies_Update", + "operationId": "SecretsManagerResourcePolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8052": "yqnqzumytacsjood" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/main.tsp b/specification/awsconnector/SecretsManagerResourcePolicy.Management/main.tsp new file mode 100644 index 000000000000..ca63d117abb1 --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/main.tsp @@ -0,0 +1,114 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SecretsManagerResourcePolicies ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Secrets Manager Resource Policy", + plural: "Secrets Manager Resource Policies", + }, + keywords: [ + "Microsoft.AwsConnector", + "Secrets", + "Manager", + "Resource", + "Policy" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model SecretsManagerResourcePolicy + is TrackedResource<SecretsManagerResourcePolicyProperties> { + @doc("Name of SecretsManagerResourcePolicy") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("secretsManagerResourcePolicies") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SecretsManagerResourcePolicy") +model SecretsManagerResourcePolicyProperties { + @doc("AWS Properties") + awsProperties?: AwsSecretsManagerResourcePolicyProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSecretsManagerResourcePolicy") +model AwsSecretsManagerResourcePolicyProperties { + @doc("Property blockPublicPolicy") + blockPublicPolicy?: boolean; + + @doc("Property id") + id?: string; + + @doc("Property resourcePolicy") + resourcePolicy?: unknown; + + @doc("Property secretId") + secretId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SecretsManagerResourcePolicies { + get is ArmResourceRead<SecretsManagerResourcePolicy>; + @doc("Create a SecretsManagerResourcePolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SecretsManagerResourcePolicy>; + update is ArmCustomPatchAsync< + SecretsManagerResourcePolicy, + Azure.ResourceManager.Foundations.TagsUpdateModel<SecretsManagerResourcePolicy> + >; + delete is ArmResourceDeleteWithoutOkAsync<SecretsManagerResourcePolicy>; + listByResourceGroup is ArmResourceListByParent<SecretsManagerResourcePolicy>; + listBySubscription is ArmListBySubscription<SecretsManagerResourcePolicy>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SecretsManager::ResourcePolicy +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SecretsManagerResourcePolicy.Management/tspconfig.yaml b/specification/awsconnector/SecretsManagerResourcePolicy.Management/tspconfig.yaml new file mode 100644 index 000000000000..5be05c814cf1 --- /dev/null +++ b/specification/awsconnector/SecretsManagerResourcePolicy.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/secretsManagerResourcePolicy.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_CreateOrReplace.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_CreateOrReplace.json new file mode 100644 index 000000000000..2a20cffd2ad3 --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "SecretsManagerSecrets_CreateOrReplace", + "operationId": "SecretsManagerSecrets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + } + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Delete.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Delete.json new file mode 100644 index 000000000000..b51e5cdec948 --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SecretsManagerSecrets_Delete", + "operationId": "SecretsManagerSecrets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Get.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Get.json new file mode 100644 index 000000000000..e9031bd17883 --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Get.json @@ -0,0 +1,74 @@ +{ + "title": "SecretsManagerSecrets_Get", + "operationId": "SecretsManagerSecrets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListByResourceGroup.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListByResourceGroup.json new file mode 100644 index 000000000000..d856c1e98c32 --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "SecretsManagerSecrets_ListByResourceGroup", + "operationId": "SecretsManagerSecrets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListBySubscription.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListBySubscription.json new file mode 100644 index 000000000000..f480344781dc --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "SecretsManagerSecrets_ListBySubscription", + "operationId": "SecretsManagerSecrets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Update.json b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Update.json new file mode 100644 index 000000000000..06611b50365c --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/examples/2024-12-01/SecretsManagerSecrets_Update.json @@ -0,0 +1,84 @@ +{ + "title": "SecretsManagerSecrets_Update", + "operationId": "SecretsManagerSecrets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5629": "chydwjrnihjopetcefprwqjpc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SecretsManagerSecret.Management/main.tsp b/specification/awsconnector/SecretsManagerSecret.Management/main.tsp new file mode 100644 index 000000000000..ac272a558f5a --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/main.tsp @@ -0,0 +1,184 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SecretsManagerSecrets ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "Secrets Manager Secret", + plural: "Secrets Manager Secrets", + }, + keywords: ["Microsoft.AwsConnector", "Secrets", "Manager", "Secret"], +}) +@doc("A Microsoft.AwsConnector resource") +model SecretsManagerSecret is TrackedResource<SecretsManagerSecretProperties> { + @doc("Name of SecretsManagerSecret") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("secretsManagerSecrets") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SecretsManagerSecret") +model SecretsManagerSecretProperties { + @doc("AWS Properties") + awsProperties?: AwsSecretsManagerSecretProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSecretsManagerSecret") +model AwsSecretsManagerSecretProperties { + @doc("The description of the secret.") + description?: string; + + @doc("A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html).") + generateSecretString?: GenerateSecretString; + + @doc("Property id") + id?: string; + + @doc("The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key.") + kmsKeyId?: string; + + @doc("The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.") + name?: string; + + @doc("A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.") + @extension("x-ms-identifiers", []) + replicaRegions?: ReplicaRegion[]; + + @doc("The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.") + secretString?: string; + + @doc("A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: ``[{'Key':'CostCenter','Value':'12345'},{'Key':'environment','Value':'production'}]`` Secrets Manager tag key names are case sensitive. A tag with the key 'ABC' is a different tag from one with key 'abc'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: + Maximum number of tags per secret: 50 + Maximum key length: 127 Unicode characters in UTF-8 + Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of GenerateSecretString") +model GenerateSecretString { + @doc("A string of the characters that you don't want in the password.") + excludeCharacters?: string; + + @doc("Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.") + excludeLowercase?: boolean; + + @doc("Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.") + excludeNumbers?: boolean; + + @doc("Specifies whether to exclude the following punctuation characters from the password: ``! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation.") + excludePunctuation?: boolean; + + @doc("Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.") + excludeUppercase?: boolean; + + @doc("The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``.") + generateStringKey?: string; + + @doc("Specifies whether to include the space character. If you include this switch, the password can contain space characters.") + includeSpace?: boolean; + + @doc("The length of the password. If you don't include this parameter, the default length is 32 characters.") + passwordLength?: int32; + + @doc("Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.") + requireEachIncludedType?: boolean; + + @doc("A template that the generated string must match. When you make a change to this property, a new secret version is created.") + secretStringTemplate?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ReplicaRegion") +model ReplicaRegion { + @doc("The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``.") + kmsKeyId?: string; + + @doc("A string that represents a ``Region``, for example 'us-east-1'.") + region?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key identifier, or name, of the tag.") + key?: string; + + @doc("The string value associated with the key of the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SecretsManagerSecrets { + get is ArmResourceRead<SecretsManagerSecret>; + @doc("Create a SecretsManagerSecret. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SecretsManagerSecret>; + update is ArmCustomPatchAsync< + SecretsManagerSecret, + Azure.ResourceManager.Foundations.TagsUpdateModel<SecretsManagerSecret> + >; + delete is ArmResourceDeleteWithoutOkAsync<SecretsManagerSecret>; + listByResourceGroup is ArmResourceListByParent<SecretsManagerSecret>; + listBySubscription is ArmListBySubscription<SecretsManagerSecret>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SecretsManager::Secret +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SecretsManagerSecret.Management/tspconfig.yaml b/specification/awsconnector/SecretsManagerSecret.Management/tspconfig.yaml new file mode 100644 index 000000000000..ebab23c78a71 --- /dev/null +++ b/specification/awsconnector/SecretsManagerSecret.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/secretsManagerSecret.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_CreateOrReplace.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_CreateOrReplace.json new file mode 100644 index 000000000000..624ea4c7c956 --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_CreateOrReplace.json @@ -0,0 +1,115 @@ +{ + "title": "SnsSubscriptions_CreateOrReplace", + "operationId": "SnsSubscriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + } + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + } + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Delete.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Delete.json new file mode 100644 index 000000000000..4866fb47ed7b --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SnsSubscriptions_Delete", + "operationId": "SnsSubscriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Get.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Get.json new file mode 100644 index 000000000000..927681e4663e --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Get.json @@ -0,0 +1,50 @@ +{ + "title": "SnsSubscriptions_Get", + "operationId": "SnsSubscriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + } + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListByResourceGroup.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..a45b8a03059e --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "SnsSubscriptions_ListByResourceGroup", + "operationId": "SnsSubscriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListBySubscription.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListBySubscription.json new file mode 100644 index 000000000000..253659b1f8b6 --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "SnsSubscriptions_ListBySubscription", + "operationId": "SnsSubscriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Update.json b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Update.json new file mode 100644 index 000000000000..6b1e4cd512fc --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/examples/2024-12-01/SnsSubscriptions_Update.json @@ -0,0 +1,60 @@ +{ + "title": "SnsSubscriptions_Update", + "operationId": "SnsSubscriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2758": "qctjkmfavrarktvb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SnsSubscription.Management/main.tsp b/specification/awsconnector/SnsSubscription.Management/main.tsp new file mode 100644 index 000000000000..0069c4fe9e7e --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/main.tsp @@ -0,0 +1,116 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SnsSubscriptions ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SNS Subscription", + plural: "SNS Subscriptions", + }, + keywords: ["Microsoft.AwsConnector", "SNS", "Subscription"], +}) +@doc("A Microsoft.AwsConnector resource") +model SnsSubscription is TrackedResource<SnsSubscriptionProperties> { + @doc("Name of SnsSubscription") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("snsSubscriptions") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnsSubscription") +model SnsSubscriptionProperties { + @doc("AWS Properties") + awsProperties?: AwsSnsSubscriptionProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSnsSubscription") +model AwsSnsSubscriptionProperties { + @doc("<p>The subscription's endpoint (format depends on the protocol).</p>") + endpoint?: string; + + @doc("<p>The subscription's owner.</p>") + owner?: string; + + @doc("<p>The subscription's protocol.</p>") + protocol?: string; + + @doc("<p>The subscription's ARN.</p>") + subscriptionArn?: string; + + @doc("<p>The ARN of the subscription's topic.</p>") + topicArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SnsSubscriptions { + get is ArmResourceRead<SnsSubscription>; + @doc("Create a SnsSubscription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SnsSubscription>; + update is ArmCustomPatchAsync< + SnsSubscription, + Azure.ResourceManager.Foundations.TagsUpdateModel<SnsSubscription> + >; + delete is ArmResourceDeleteWithoutOkAsync<SnsSubscription>; + listByResourceGroup is ArmResourceListByParent<SnsSubscription>; + listBySubscription is ArmListBySubscription<SnsSubscription>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\sns\sns-2010-03-31.normal.json +// AWS Shape: Subscription +// +// Related information for backend service: +// AWS Servcie : SNS +// Product Version : 3.7.798.0 +// SDK Version : 3.7.301.31 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SnsSubscription.Management/tspconfig.yaml b/specification/awsconnector/SnsSubscription.Management/tspconfig.yaml new file mode 100644 index 000000000000..f00be8ac1263 --- /dev/null +++ b/specification/awsconnector/SnsSubscription.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/snsSubscription.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_CreateOrReplace.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_CreateOrReplace.json new file mode 100644 index 000000000000..6a67f6edd128 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_CreateOrReplace.json @@ -0,0 +1,184 @@ +{ + "title": "SnsTopics_CreateOrReplace", + "operationId": "SnsTopics_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + } + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + } + } +} diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Delete.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Delete.json new file mode 100644 index 000000000000..efb986560a6e --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SnsTopics_Delete", + "operationId": "SnsTopics_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Get.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Get.json new file mode 100644 index 000000000000..1e6ebf5d7ac2 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Get.json @@ -0,0 +1,73 @@ +{ + "title": "SnsTopics_Get", + "operationId": "SnsTopics_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + } + } +} diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListByResourceGroup.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListByResourceGroup.json new file mode 100644 index 000000000000..7560b639bd81 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "title": "SnsTopics_ListByResourceGroup", + "operationId": "SnsTopics_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListBySubscription.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListBySubscription.json new file mode 100644 index 000000000000..6070c4de39f4 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "title": "SnsTopics_ListBySubscription", + "operationId": "SnsTopics_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Update.json b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Update.json new file mode 100644 index 000000000000..067f5741f499 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/examples/2024-12-01/SnsTopics_Update.json @@ -0,0 +1,83 @@ +{ + "title": "SnsTopics_Update", + "operationId": "SnsTopics_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key169": "dsposctohebgkwktzjwwgfftpmhq" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SnsTopic.Management/main.tsp b/specification/awsconnector/SnsTopic.Management/main.tsp new file mode 100644 index 000000000000..02ab59657e47 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/main.tsp @@ -0,0 +1,202 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SnsTopics ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SNS Topic", + plural: "SNS Topics", + }, + keywords: ["Microsoft.AwsConnector", "SNS", "Topic"], +}) +@doc("A Microsoft.AwsConnector resource") +model SnsTopic is TrackedResource<SnsTopicProperties> { + @doc("Name of SnsTopic") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("snsTopics") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SnsTopic") +model SnsTopicProperties { + @doc("AWS Properties") + awsProperties?: AwsSnsTopicProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSnsTopic") +model AwsSnsTopicProperties { + @doc("The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days.") + archivePolicy?: unknown; + + @doc("Enables content-based deduplication for FIFO topics. + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action.") + contentBasedDeduplication?: boolean; + + @doc("The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720.") + dataProtectionPolicy?: unknown; + + @doc("Property deliveryStatusLogging") + @extension("x-ms-identifiers", []) + deliveryStatusLogging?: LoggingConfig[]; + + @doc("The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.") + displayName?: string; + + @doc("Set to true to create a FIFO topic.") + fifoTopic?: boolean; + + @doc("The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html).") + kmsMasterKeyId?: string; + + @doc("The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``.") + signatureVersion?: string; + + @doc("The SNS subscriptions (endpoints) for this topic. If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.") + @extension("x-ms-identifiers", []) + subscription?: Subscription[]; + + @doc("The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("Property topicArn") + topicArn?: string; + + @doc("The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + topicName?: string; + + @doc("Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true.") + tracingConfig?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoggingConfig") +model LoggingConfig { + @doc("Property failureFeedbackRoleArn") + failureFeedbackRoleArn?: string; + + @doc("Property protocol") + protocol?: LoggingConfigProtocol; + + @doc("Property successFeedbackRoleArn") + successFeedbackRoleArn?: string; + + @doc("Property successFeedbackSampleRate") + successFeedbackSampleRate?: string; +} + +@doc("LoggingConfigProtocol enum") +union LoggingConfigProtocol { + @doc("LoggingConfigProtocol enum application") + application: "application", + + @doc("LoggingConfigProtocol enum firehose") + firehose: "firehose", + + @doc("LoggingConfigProtocol enum http/s") + HttpS: "http/s", + + @doc("LoggingConfigProtocol enum lambda") + lambda: "lambda", + + @doc("LoggingConfigProtocol enum sqs") + sqs: "sqs", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Subscription") +model Subscription { + @doc("The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*.") + endpoint?: string; + + @doc("The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*.") + protocol?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The required key portion of the tag.") + key?: string; + + @doc("The optional value portion of the tag.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SnsTopics { + get is ArmResourceRead<SnsTopic>; + @doc("Create a SnsTopic. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SnsTopic>; + update is ArmCustomPatchAsync< + SnsTopic, + Azure.ResourceManager.Foundations.TagsUpdateModel<SnsTopic> + >; + delete is ArmResourceDeleteWithoutOkAsync<SnsTopic>; + listByResourceGroup is ArmResourceListByParent<SnsTopic>; + listBySubscription is ArmListBySubscription<SnsTopic>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SNS::Topic +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SnsTopic.Management/tspconfig.yaml b/specification/awsconnector/SnsTopic.Management/tspconfig.yaml new file mode 100644 index 000000000000..b99aeeb1ab23 --- /dev/null +++ b/specification/awsconnector/SnsTopic.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/snsTopic.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_CreateOrReplace.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_CreateOrReplace.json new file mode 100644 index 000000000000..0ea269064951 --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "SqsQueues_CreateOrReplace", + "operationId": "SqsQueues_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + } + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + } + } +} diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Delete.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Delete.json new file mode 100644 index 000000000000..44988124755c --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SqsQueues_Delete", + "operationId": "SqsQueues_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Get.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Get.json new file mode 100644 index 000000000000..b00c9fc179a5 --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Get.json @@ -0,0 +1,68 @@ +{ + "title": "SqsQueues_Get", + "operationId": "SqsQueues_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + } + } +} diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListByResourceGroup.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListByResourceGroup.json new file mode 100644 index 000000000000..74e8c7d99190 --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "SqsQueues_ListByResourceGroup", + "operationId": "SqsQueues_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListBySubscription.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListBySubscription.json new file mode 100644 index 000000000000..bec33851173c --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "SqsQueues_ListBySubscription", + "operationId": "SqsQueues_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Update.json b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Update.json new file mode 100644 index 000000000000..65a858b1a96a --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/examples/2024-12-01/SqsQueues_Update.json @@ -0,0 +1,78 @@ +{ + "title": "SqsQueues_Update", + "operationId": "SqsQueues_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7679": "tfoda" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SqsQueue.Management/main.tsp b/specification/awsconnector/SqsQueue.Management/main.tsp new file mode 100644 index 000000000000..4812e84f633a --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/main.tsp @@ -0,0 +1,163 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SqsQueues ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SQS Queue", + plural: "SQS Queues", + }, + keywords: ["Microsoft.AwsConnector", "SQS", "Queue"], +}) +@doc("A Microsoft.AwsConnector resource") +model SqsQueue is TrackedResource<SqsQueueProperties> { + @doc("Name of SqsQueue") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("sqsQueues") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SqsQueue") +model SqsQueueProperties { + @doc("AWS Properties") + awsProperties?: AwsSqsQueueProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSqsQueue") +model AwsSqsQueueProperties { + @doc("Property arn") + arn?: string; + + @doc("For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*.") + contentBasedDeduplication?: boolean; + + @doc("For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.") + deduplicationScope?: string; + + @doc("The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``.") + delaySeconds?: int32; + + @doc("If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*.") + fifoQueue?: boolean; + + @doc("For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*.") + fifoThroughputLimit?: string; + + @doc("The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*.") + kmsDataKeyReusePeriodSeconds?: int32; + + @doc("The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper") + kmsMasterKeyId?: string; + + @doc("The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB).") + maximumMessageSize?: int32; + + @doc("The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days).") + messageRetentionPeriod?: int32; + + @doc("A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.") + queueName?: string; + + @doc("Property queueUrl") + queueUrl?: string; + + @doc("Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*.") + receiveMessageWaitTimeSeconds?: int32; + + @doc("The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.") + redriveAllowPolicy?: Record<unknown>; + + @doc("The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* ``{ 'deadLetterTargetArn' : String, 'maxReceiveCount' : Integer }`` *YAML* ``deadLetterTargetArn : String`` ``maxReceiveCount : Integer``") + redrivePolicy?: Record<unknown>; + + @doc("Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default.") + sqsManagedSseEnabled?: boolean; + + @doc("The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.") + @extension("x-ms-identifiers", []) + tags?: Tag[]; + + @doc("The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*.") + visibilityTimeout?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Tag") +model Tag { + @doc("The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + key?: string; + + @doc("The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.") + value?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SqsQueues { + get is ArmResourceRead<SqsQueue>; + @doc("Create a SqsQueue. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SqsQueue>; + update is ArmCustomPatchAsync< + SqsQueue, + Azure.ResourceManager.Foundations.TagsUpdateModel<SqsQueue> + >; + delete is ArmResourceDeleteWithoutOkAsync<SqsQueue>; + listByResourceGroup is ArmResourceListByParent<SqsQueue>; + listBySubscription is ArmListBySubscription<SqsQueue>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SQS::Queue +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SqsQueue.Management/tspconfig.yaml b/specification/awsconnector/SqsQueue.Management/tspconfig.yaml new file mode 100644 index 000000000000..15fd3edecba2 --- /dev/null +++ b/specification/awsconnector/SqsQueue.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/sqsQueue.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_CreateOrReplace.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_CreateOrReplace.json new file mode 100644 index 000000000000..7aaa8068304c --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_CreateOrReplace.json @@ -0,0 +1,202 @@ +{ + "title": "SsmInstanceInformations_CreateOrReplace", + "operationId": "SsmInstanceInformations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + } + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Delete.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Delete.json new file mode 100644 index 000000000000..daccc17b73da --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmInstanceInformations_Delete", + "operationId": "SsmInstanceInformations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Get.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Get.json new file mode 100644 index 000000000000..a06761b19b53 --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Get.json @@ -0,0 +1,79 @@ +{ + "title": "SsmInstanceInformations_Get", + "operationId": "SsmInstanceInformations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListByResourceGroup.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListByResourceGroup.json new file mode 100644 index 000000000000..6adf2802216a --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "title": "SsmInstanceInformations_ListByResourceGroup", + "operationId": "SsmInstanceInformations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListBySubscription.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListBySubscription.json new file mode 100644 index 000000000000..a99dd8a2707c --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_ListBySubscription.json @@ -0,0 +1,82 @@ +{ + "title": "SsmInstanceInformations_ListBySubscription", + "operationId": "SsmInstanceInformations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Update.json b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Update.json new file mode 100644 index 000000000000..6fa0beb8995c --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/examples/2024-12-01/SsmInstanceInformations_Update.json @@ -0,0 +1,89 @@ +{ + "title": "SsmInstanceInformations_Update", + "operationId": "SsmInstanceInformations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2080": "kbpsd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SsmInstanceInformation.Management/main.tsp b/specification/awsconnector/SsmInstanceInformation.Management/main.tsp new file mode 100644 index 000000000000..87d925762a89 --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/main.tsp @@ -0,0 +1,271 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SsmInstanceInformations ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SSM Instance Information", + plural: "SSM Instance Informations", + }, + keywords: ["Microsoft.AwsConnector", "SSM", "Instance", "Information"], +}) +@doc("A Microsoft.AwsConnector resource") +model SsmInstanceInformation + is TrackedResource<SsmInstanceInformationProperties> { + @doc("Name of SsmInstanceInformation") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ssmInstanceInformations") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SsmInstanceInformation") +model SsmInstanceInformationProperties { + @doc("AWS Properties") + awsProperties?: AwsSsmInstanceInformationProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSsmInstanceInformation") +model AwsSsmInstanceInformationProperties { + @doc("<p>The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.</p>") + activationId?: string; + + @doc("<p>The version of SSM Agent running on your Linux managed node. </p>") + agentVersion?: string; + + @doc("<p>Information about the association.</p>") + associationOverview?: InstanceAggregatedAssociationOverview; + + @doc("<p>The status of the association.</p>") + associationStatus?: string; + + @doc("<p>The fully qualified host name of the managed node.</p>") + computerName?: string; + + @doc("<p>The IP address of the managed node.</p>") + ipAddress?: string; + + @doc("<p>The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'>DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'>describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>") + iamRole?: string; + + @doc("<p>The managed node ID. </p>") + instanceId?: string; + + @doc("<p>Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.</p>") + isLatestVersion?: boolean; + + @doc("<p>The date the association was last run.</p>") + lastAssociationExecutionDate?: utcDateTime; + + @doc("<p>The date and time when the agent last pinged the Systems Manager service. </p>") + lastPingDateTime?: utcDateTime; + + @doc("<p>The last date the association was successfully run.</p>") + lastSuccessfulAssociationExecutionDate?: utcDateTime; + + @doc("<p>The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the <code>DefaultInstanceName</code> property using the <a>CreateActivation</a> command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in <a href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html'>Install SSM Agent for a hybrid and multicloud environment (Linux)</a> and <a href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html'>Install SSM Agent for a hybrid and multicloud environment (Windows)</a>. To retrieve the <code>Name</code> tag of an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'>DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'>describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>") + name?: string; + + @doc("<p>Connection status of SSM Agent. </p> <note> <p>The status <code>Inactive</code> has been deprecated and is no longer in use.</p> </note>") + pingStatus?: PingStatusEnumValue; + + @doc("<p>The name of the operating system platform running on your managed node. </p>") + platformName?: string; + + @doc("<p>The operating system platform type. </p>") + platformType?: PlatformTypeEnumValue; + + @doc("<p>The version of the OS platform running on your managed node. </p>") + platformVersion?: string; + + @doc("<p>The date the server or VM was registered with Amazon Web Services as a managed node.</p>") + registrationDate?: utcDateTime; + + @doc("<p>The type of instance. Instances are either EC2 instances or managed instances. </p>") + resourceType?: ResourceTypeEnumValue; + + @doc("<p>The ID of the source resource. For IoT Greengrass devices, <code>SourceId</code> is the Thing name. </p>") + sourceId?: string; + + @doc("<p>The type of the source resource. For IoT Greengrass devices, <code>SourceType</code> is <code>AWS::IoT::Thing</code>. </p>") + sourceType?: SourceTypeEnumValue; +} + +@doc("PingStatus enum") +union PingStatus { + @doc("PingStatus enum ConnectionLost") + ConnectionLost: "ConnectionLost", + + @doc("PingStatus enum Inactive") + Inactive: "Inactive", + + @doc("PingStatus enum Online") + Online: "Online", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PingStatusEnumValue") +model PingStatusEnumValue { + @doc("Property value") + value?: PingStatus; +} + +@doc("ResourceType enum") +union ResourceType { + @doc("ResourceType enum EC2Instance") + EC2Instance: "EC2Instance", + + @doc("ResourceType enum ManagedInstance") + ManagedInstance: "ManagedInstance", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ResourceTypeEnumValue") +model ResourceTypeEnumValue { + @doc("Property value") + value?: ResourceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of InstanceAggregatedAssociationOverview") +model InstanceAggregatedAssociationOverview { + @doc("<p>Detailed status information about the aggregated associations.</p>") + detailedStatus?: string; + + @doc("<p>The number of associations for the managed nodes.</p>") + instanceAssociationStatusAggregatedCount?: Record<int32>; +} + +@doc("PlatformType enum") +union PlatformType { + @doc("PlatformType enum Linux") + Linux: "Linux", + + @doc("PlatformType enum MacOS") + MacOS: "MacOS", + + @doc("PlatformType enum Windows") + Windows: "Windows", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of PlatformTypeEnumValue") +model PlatformTypeEnumValue { + @doc("Property value") + value?: PlatformType; +} + +@doc("SourceType enum") +union SourceType { + @doc("SourceType enum AWS::EC2::Instance") + AWSEC2Instance: "AWS::EC2::Instance", + + @doc("SourceType enum AWS::IoT::Thing") + AWSIoTThing: "AWS::IoT::Thing", + + @doc("SourceType enum AWS::SSM::ManagedInstance") + AWSSSMManagedInstance: "AWS::SSM::ManagedInstance", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SourceTypeEnumValue") +model SourceTypeEnumValue { + @doc("Property value") + value?: SourceType; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SsmInstanceInformations { + get is ArmResourceRead<SsmInstanceInformation>; + @doc("Create a SsmInstanceInformation. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SsmInstanceInformation>; + update is ArmCustomPatchAsync< + SsmInstanceInformation, + Azure.ResourceManager.Foundations.TagsUpdateModel<SsmInstanceInformation> + >; + delete is ArmResourceDeleteWithoutOkAsync<SsmInstanceInformation>; + listByResourceGroup is ArmResourceListByParent<SsmInstanceInformation>; + listBySubscription is ArmListBySubscription<SsmInstanceInformation>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ssm\ssm-2014-11-06.normal.json +// AWS Shape: InstanceInformation +// +// Related information for backend service: +// AWS Servcie : SSM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.304.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SsmInstanceInformation.Management/tspconfig.yaml b/specification/awsconnector/SsmInstanceInformation.Management/tspconfig.yaml new file mode 100644 index 000000000000..0c6e2447ff58 --- /dev/null +++ b/specification/awsconnector/SsmInstanceInformation.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ssmInstanceInformation.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_CreateOrReplace.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_CreateOrReplace.json new file mode 100644 index 000000000000..e854b1dfc02f --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "SsmParameters_CreateOrReplace", + "operationId": "SsmParameters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + } + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Delete.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Delete.json new file mode 100644 index 000000000000..209e0a3a7c97 --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmParameters_Delete", + "operationId": "SsmParameters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Get.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Get.json new file mode 100644 index 000000000000..e27854ab362e --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Get.json @@ -0,0 +1,53 @@ +{ + "title": "SsmParameters_Get", + "operationId": "SsmParameters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListByResourceGroup.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListByResourceGroup.json new file mode 100644 index 000000000000..468d17dc0eaa --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "SsmParameters_ListByResourceGroup", + "operationId": "SsmParameters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListBySubscription.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListBySubscription.json new file mode 100644 index 000000000000..55632ef60d34 --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "SsmParameters_ListBySubscription", + "operationId": "SsmParameters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Update.json b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Update.json new file mode 100644 index 000000000000..0c042aa92b99 --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/examples/2024-12-01/SsmParameters_Update.json @@ -0,0 +1,63 @@ +{ + "title": "SsmParameters_Update", + "operationId": "SsmParameters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4464": "tgnzhbcrpdvteprriogksebwisvqxm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SsmParameter.Management/main.tsp b/specification/awsconnector/SsmParameter.Management/main.tsp new file mode 100644 index 000000000000..08844c9365a5 --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/main.tsp @@ -0,0 +1,158 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SsmParameters ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SSM Parameter", + plural: "SSM Parameters", + }, + keywords: ["Microsoft.AwsConnector", "SSM", "Parameter"], +}) +@doc("A Microsoft.AwsConnector resource") +model SsmParameter is TrackedResource<SsmParameterProperties> { + @doc("Name of SsmParameter") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ssmParameters") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SsmParameter") +model SsmParameterProperties { + @doc("AWS Properties") + awsProperties?: AwsSsmParameterProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSsmParameter") +model AwsSsmParameterProperties { + @doc("A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``") + allowedPattern?: string; + + @doc("The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.") + dataType?: DataType; + + @doc("Information about the parameter.") + description?: string; + + @doc("The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``") + name?: string; + + @doc("Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*.") + policies?: string; + + @doc("Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.") + tags?: unknown; + + @doc("The parameter tier.") + tier?: Tier; + + @doc("The type of parameter.") + type?: Type; + + @doc("The parameter value. If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field.") + value?: string; +} + +@doc("DataType enum") +union DataType { + @doc("DataType enum aws:ec2:image") + AwsEc2Image: "aws:ec2:image", + + @doc("DataType enum text") + text: "text", + + string, +} + +@doc("Type enum") +union Type { + @doc("Type enum String") + String: "String", + + @doc("Type enum StringList") + StringList: "StringList", + + string, +} + +@doc("Tier enum") +union Tier { + @doc("Tier enum Advanced") + Advanced: "Advanced", + + @doc("Tier enum Intelligent-Tiering") + IntelligentTiering: "Intelligent-Tiering", + + @doc("Tier enum Standard") + Standard: "Standard", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SsmParameters { + get is ArmResourceRead<SsmParameter>; + @doc("Create a SsmParameter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SsmParameter>; + update is ArmCustomPatchAsync< + SsmParameter, + Azure.ResourceManager.Foundations.TagsUpdateModel<SsmParameter> + >; + delete is ArmResourceDeleteWithoutOkAsync<SsmParameter>; + listByResourceGroup is ArmResourceListByParent<SsmParameter>; + listBySubscription is ArmListBySubscription<SsmParameter>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::SSM::Parameter +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SsmParameter.Management/tspconfig.yaml b/specification/awsconnector/SsmParameter.Management/tspconfig.yaml new file mode 100644 index 000000000000..578450fedb58 --- /dev/null +++ b/specification/awsconnector/SsmParameter.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ssmParameter.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_CreateOrReplace.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_CreateOrReplace.json new file mode 100644 index 000000000000..2f1b3e8838ef --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "SsmResourceComplianceSummaryItems_CreateOrReplace", + "operationId": "SsmResourceComplianceSummaryItems_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + } + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Delete.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Delete.json new file mode 100644 index 000000000000..68b30ecd4a6e --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Delete", + "operationId": "SsmResourceComplianceSummaryItems_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Get.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Get.json new file mode 100644 index 000000000000..b8abf1d08e37 --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Get.json @@ -0,0 +1,81 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Get", + "operationId": "SsmResourceComplianceSummaryItems_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + } + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListByResourceGroup.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListByResourceGroup.json new file mode 100644 index 000000000000..797e18101283 --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "SsmResourceComplianceSummaryItems_ListByResourceGroup", + "operationId": "SsmResourceComplianceSummaryItems_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListBySubscription.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListBySubscription.json new file mode 100644 index 000000000000..6a481af4da43 --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "SsmResourceComplianceSummaryItems_ListBySubscription", + "operationId": "SsmResourceComplianceSummaryItems_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Update.json b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Update.json new file mode 100644 index 000000000000..867a6b563865 --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/examples/2024-12-01/SsmResourceComplianceSummaryItems_Update.json @@ -0,0 +1,91 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Update", + "operationId": "SsmResourceComplianceSummaryItems_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7866": "uwutk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/main.tsp b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/main.tsp new file mode 100644 index 000000000000..38cfe6ddd4a2 --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/main.tsp @@ -0,0 +1,254 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- SsmResourceComplianceSummaryItems ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "SSM Resource Compliance Summary Item", + plural: "SSM Resource Compliance Summary Items", + }, + keywords: [ + "Microsoft.AwsConnector", + "SSM", + "Resource", + "Compliance", + "Summary", + "Item" + ], +}) +@doc("A Microsoft.AwsConnector resource") +model SsmResourceComplianceSummaryItem + is TrackedResource<SsmResourceComplianceSummaryItemProperties> { + @doc("Name of SsmResourceComplianceSummaryItem") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("ssmResourceComplianceSummaryItems") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SsmResourceComplianceSummaryItem") +model SsmResourceComplianceSummaryItemProperties { + @doc("AWS Properties") + awsProperties?: AwsSsmResourceComplianceSummaryItemProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsSsmResourceComplianceSummaryItem") +model AwsSsmResourceComplianceSummaryItemProperties { + @doc("<p>The compliance type.</p>") + complianceType?: string; + + @doc("<p>A list of items that are compliant for the resource.</p>") + compliantSummary?: CompliantSummary; + + @doc("<p>Information about the execution.</p>") + executionSummary?: ComplianceExecutionSummary; + + @doc("<p>A list of items that aren't compliant for the resource.</p>") + nonCompliantSummary?: NonCompliantSummary; + + @doc("<p>The highest severity item found for the resource. The resource is compliant for this item.</p>") + overallSeverity?: ComplianceSeverityEnumValue; + + @doc("<p>The resource ID.</p>") + resourceId?: string; + + @doc("<p>The resource type.</p>") + resourceType?: string; + + @doc("<p>The compliance status for the resource.</p>") + status?: ComplianceStatusEnumValue; +} + +@doc("ComplianceSeverity enum") +union ComplianceSeverity { + @doc("ComplianceSeverity enum CRITICAL") + CRITICAL: "CRITICAL", + + @doc("ComplianceSeverity enum HIGH") + HIGH: "HIGH", + + @doc("ComplianceSeverity enum INFORMATIONAL") + INFORMATIONAL: "INFORMATIONAL", + + @doc("ComplianceSeverity enum LOW") + LOW: "LOW", + + @doc("ComplianceSeverity enum MEDIUM") + MEDIUM: "MEDIUM", + + @doc("ComplianceSeverity enum UNSPECIFIED") + UNSPECIFIED: "UNSPECIFIED", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ComplianceSeverityEnumValue") +model ComplianceSeverityEnumValue { + @doc("Property value") + value?: ComplianceSeverity; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of CompliantSummary") +model CompliantSummary { + @doc("<p>The total number of resources that are compliant.</p>") + compliantCount?: int32; + + @doc("<p>A summary of the compliance severity by compliance type.</p>") + severitySummary?: SeveritySummary; +} + +@doc("ComplianceStatus enum") +union ComplianceStatus { + @doc("ComplianceStatus enum COMPLIANT") + COMPLIANT: "COMPLIANT", + + @doc("ComplianceStatus enum NON_COMPLIANT") + NON_COMPLIANT: "NON_COMPLIANT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ComplianceStatusEnumValue") +model ComplianceStatusEnumValue { + @doc("Property value") + value?: ComplianceStatus; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ComplianceExecutionSummary") +model ComplianceExecutionSummary { + @doc("<p>An ID created by the system when <code>PutComplianceItems</code> was called. For example, <code>CommandID</code> is a valid execution ID. You can use this ID in subsequent calls.</p>") + executionId?: string; + + @doc("<p>The time the execution ran as a datetime object that is saved in the following format: <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code> </p>") + executionTime?: utcDateTime; + + @doc("<p>The type of execution. For example, <code>Command</code> is a valid execution type.</p>") + executionType?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of NonCompliantSummary") +model NonCompliantSummary { + @doc("<p>The total number of compliance items that aren't compliant.</p>") + nonCompliantCount?: int32; + + @doc("<p>A summary of the non-compliance severity by compliance type</p>") + severitySummary?: SeveritySummary; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SeveritySummary") +model SeveritySummary { + @doc("<p>The total number of resources or compliance items that have a severity level of <code>Critical</code>. Critical severity is determined by the organization that published the compliance items.</p>") + criticalCount?: int32; + + @doc("<p>The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.</p>") + highCount?: int32; + + @doc("<p>The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.</p>") + informationalCount?: int32; + + @doc("<p>The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.</p>") + lowCount?: int32; + + @doc("<p>The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.</p>") + mediumCount?: int32; + + @doc("<p>The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.</p>") + unspecifiedCount?: int32; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface SsmResourceComplianceSummaryItems { + get is ArmResourceRead<SsmResourceComplianceSummaryItem>; + @doc("Create a SsmResourceComplianceSummaryItem. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<SsmResourceComplianceSummaryItem>; + update is ArmCustomPatchAsync< + SsmResourceComplianceSummaryItem, + Azure.ResourceManager.Foundations.TagsUpdateModel<SsmResourceComplianceSummaryItem> + >; + delete is ArmResourceDeleteWithoutOkAsync<SsmResourceComplianceSummaryItem>; + listByResourceGroup is ArmResourceListByParent<SsmResourceComplianceSummaryItem>; + listBySubscription is ArmListBySubscription<SsmResourceComplianceSummaryItem>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\ssm\ssm-2014-11-06.normal.json +// AWS Shape: ResourceComplianceSummaryItem +// +// Related information for backend service: +// AWS Servcie : SSM +// Product Version : 3.7.798.0 +// SDK Version : 3.7.304.2 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/tspconfig.yaml b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/tspconfig.yaml new file mode 100644 index 000000000000..0f16518d1c5b --- /dev/null +++ b/specification/awsconnector/SsmResourceComplianceSummaryItem.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/ssmResourceComplianceSummaryItem.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_CreateOrReplace.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..2b3ef5237506 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "WafWebAclSummaries_CreateOrReplace", + "operationId": "WafWebAclSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + } + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + } + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Delete.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Delete.json new file mode 100644 index 000000000000..cc5c1b30a6a4 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "WafWebAclSummaries_Delete", + "operationId": "WafWebAclSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Get.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Get.json new file mode 100644 index 000000000000..78d8c9dfd8a8 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Get.json @@ -0,0 +1,47 @@ +{ + "title": "WafWebAclSummaries_Get", + "operationId": "WafWebAclSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + } + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListByResourceGroup.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..d361dd9ca3a6 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "WafWebAclSummaries_ListByResourceGroup", + "operationId": "WafWebAclSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListBySubscription.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListBySubscription.json new file mode 100644 index 000000000000..5e1b4df61420 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "WafWebAclSummaries_ListBySubscription", + "operationId": "WafWebAclSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Update.json b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Update.json new file mode 100644 index 000000000000..ea257a58bda3 --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/examples/2024-12-01/WafWebAclSummaries_Update.json @@ -0,0 +1,57 @@ +{ + "title": "WafWebAclSummaries_Update", + "operationId": "WafWebAclSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7911": "djgsj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/WafWebACLSummary.Management/main.tsp b/specification/awsconnector/WafWebACLSummary.Management/main.tsp new file mode 100644 index 000000000000..c2cfef70008e --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/main.tsp @@ -0,0 +1,107 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- WafWebACLSummaries ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "WAF Web ACLSummary", + plural: "WAF Web ACLSummaries", + }, + keywords: ["Microsoft.AwsConnector", "WAF", "Web", "ACLSummary"], +}) +@doc("A Microsoft.AwsConnector resource") +model WafWebACLSummary is TrackedResource<WafWebACLSummaryProperties> { + @doc("Name of WafWebACLSummary") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("wafWebACLSummaries") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of WafWebACLSummary") +model WafWebACLSummaryProperties { + @doc("AWS Properties") + awsProperties?: AwsWafWebACLSummaryProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsWafWebACLSummary") +model AwsWafWebACLSummaryProperties { + @doc("<p>A friendly name or description of the <a>WebACL</a>. You can't change the name of a <code>WebACL</code> after you create it.</p>") + name?: string; + + @doc("<p>A unique identifier for a <code>WebACL</code>. You use <code>WebACLId</code> to get information about a <code>WebACL</code> (see <a>GetWebACL</a>), update a <code>WebACL</code> (see <a>UpdateWebACL</a>), and delete a <code>WebACL</code> from AWS WAF (see <a>DeleteWebACL</a>).</p> <p> <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</p>") + webACLId?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface WafWebACLSummaries { + get is ArmResourceRead<WafWebACLSummary>; + @doc("Create a WafWebACLSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<WafWebACLSummary>; + update is ArmCustomPatchAsync< + WafWebACLSummary, + Azure.ResourceManager.Foundations.TagsUpdateModel<WafWebACLSummary> + >; + delete is ArmResourceDeleteWithoutOkAsync<WafWebACLSummary>; + listByResourceGroup is ArmResourceListByParent<WafWebACLSummary>; + listBySubscription is ArmListBySubscription<WafWebACLSummary>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// AWS Service Model: generator\ServiceModels\waf\waf-2015-08-24.normal.json +// AWS Shape: WebACLSummary +// +// Related information for backend service: +// AWS Servcie : WAF +// Product Version : 3.7.798.0 +// SDK Version : 3.7.300.83 +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/WafWebACLSummary.Management/tspconfig.yaml b/specification/awsconnector/WafWebACLSummary.Management/tspconfig.yaml new file mode 100644 index 000000000000..5c7bfc1c94aa --- /dev/null +++ b/specification/awsconnector/WafWebACLSummary.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/wafWebACLSummary.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_CreateOrReplace.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_CreateOrReplace.json new file mode 100644 index 000000000000..f8a73e86a6fc --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_CreateOrReplace.json @@ -0,0 +1,193 @@ +{ + "title": "Wafv2LoggingConfigurations_CreateOrReplace", + "operationId": "Wafv2LoggingConfigurations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + } + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + } + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Delete.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Delete.json new file mode 100644 index 000000000000..4e94f3733733 --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Wafv2LoggingConfigurations_Delete", + "operationId": "Wafv2LoggingConfigurations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Get.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Get.json new file mode 100644 index 000000000000..d16e2536ae6d --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Get.json @@ -0,0 +1,76 @@ +{ + "title": "Wafv2LoggingConfigurations_Get", + "operationId": "Wafv2LoggingConfigurations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + } + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListByResourceGroup.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListByResourceGroup.json new file mode 100644 index 000000000000..1ec24b29e7ea --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "Wafv2LoggingConfigurations_ListByResourceGroup", + "operationId": "Wafv2LoggingConfigurations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListBySubscription.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListBySubscription.json new file mode 100644 index 000000000000..61f84d67aaa3 --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "Wafv2LoggingConfigurations_ListBySubscription", + "operationId": "Wafv2LoggingConfigurations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Update.json b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Update.json new file mode 100644 index 000000000000..01838de9cc1f --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/examples/2024-12-01/Wafv2LoggingConfigurations_Update.json @@ -0,0 +1,86 @@ +{ + "title": "Wafv2LoggingConfigurations_Update", + "operationId": "Wafv2LoggingConfigurations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6151": "lkrorfwghfb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/main.tsp b/specification/awsconnector/Wafv2LoggingConfiguration.Management/main.tsp new file mode 100644 index 000000000000..b01e70eca777 --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/main.tsp @@ -0,0 +1,262 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/openapi"; +import "@azure-tools/typespec-azure-portal-core"; +import "../shared/main.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using OpenAPI; +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; +using Azure.Portal; + +#suppress "@azure-tools/typespec-azure-resource-manager/missing-operations-endpoint" "Supress missing operations endpoint as the same is defined ../operations/main.tsp." +@armProviderNamespace +@service({ + title: "Microsoft.AwsConnector", +}) +@doc("Microsoft.AwsConnector Resource Provider management API.") +@versioned(Versions) +@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) +namespace Microsoft.AwsConnector; + +/** Api versions */ +enum Versions { + /** 2024-12-01 api version */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + `2024-12-01`, +} + +//---------------------------------------------- Wafv2LoggingConfigurations ---------------------------------------------- +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@about({ + displayNames: { + singular: "WAFv2 Logging Configuration", + plural: "WAFv2 Logging Configurations", + }, + keywords: ["Microsoft.AwsConnector", "WAFv2", "Logging", "Configuration"], +}) +@doc("A Microsoft.AwsConnector resource") +model Wafv2LoggingConfiguration + is TrackedResource<Wafv2LoggingConfigurationProperties> { + @doc("Name of Wafv2LoggingConfiguration") + @pattern("^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])") + @key("name") + @path + @segment("wafv2LoggingConfigurations") + name: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Wafv2LoggingConfiguration") +model Wafv2LoggingConfigurationProperties { + @doc("AWS Properties") + awsProperties?: AwsWafv2LoggingConfigurationProperties; + + ...AwsCommonProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of awsWafv2LoggingConfiguration") +model AwsWafv2LoggingConfigurationProperties { + @doc("The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.") + @extension("x-ms-identifiers", []) + logDestinationConfigs?: string[]; + + @doc("Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.") + loggingFilter?: LoggingFilterModelProperties; + + @doc("Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.") + managedByFirewallManager?: boolean; + + @doc("The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.") + @extension("x-ms-identifiers", []) + redactedFields?: FieldToMatch[]; + + @doc("The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.") + resourceArn?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LoggingFilterModelProperties") +model LoggingFilterModelProperties { + @doc("Default handling for logs that don't match any of the specified filtering conditions.") + defaultBehavior?: DefaultBehavior; + + @doc("The filters that you want to apply to the logs.") + @extension("x-ms-identifiers", []) + filters?: Filter[]; +} + +@doc("DefaultBehavior enum") +union DefaultBehavior { + @doc("DefaultBehavior enum DROP") + DROP: "DROP", + + @doc("DefaultBehavior enum KEEP") + KEEP: "KEEP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of FieldToMatch") +model FieldToMatch { + @doc("Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.") + method?: unknown; + + @doc("Inspect the query string. This is the part of a URL that appears after a ? character, if any.") + queryString?: unknown; + + @doc("Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.") + singleHeader?: SingleHeaderModelProperties; + + @doc("Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.") + uriPath?: unknown; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Filter") +model Filter { + @doc("How to handle logs that satisfy the filter's conditions and requirement.") + behavior?: FilterBehavior; + + @doc("Match conditions for the filter.") + @extension("x-ms-identifiers", []) + conditions?: Condition[]; + + @doc("Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.") + requirement?: FilterRequirement; +} + +@doc("FilterBehavior enum") +union FilterBehavior { + @doc("FilterBehavior enum DROP") + DROP: "DROP", + + @doc("FilterBehavior enum KEEP") + KEEP: "KEEP", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of SingleHeaderModelProperties") +model SingleHeaderModelProperties { + @doc("The name of the query header to inspect.") + name?: string; +} + +@doc("FilterRequirement enum") +union FilterRequirement { + @doc("FilterRequirement enum MEETS_ALL") + MEETS_ALL: "MEETS_ALL", + + @doc("FilterRequirement enum MEETS_ANY") + MEETS_ANY: "MEETS_ANY", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of Condition") +model Condition { + @doc("A single action condition.") + actionCondition?: ActionConditionModelProperties; + + @doc("A single label name condition.") + labelNameCondition?: LabelNameConditionModelProperties; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of ActionConditionModelProperties") +model ActionConditionModelProperties { + @doc("Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.") + action?: Action; +} + +@doc("Action enum") +union Action { + @doc("Action enum ALLOW") + ALLOW: "ALLOW", + + @doc("Action enum BLOCK") + BLOCK: "BLOCK", + + @doc("Action enum CAPTCHA") + CAPTCHA: "CAPTCHA", + + @doc("Action enum CHALLENGE") + CHALLENGE: "CHALLENGE", + + @doc("Action enum COUNT") + COUNT: "COUNT", + + @doc("Action enum EXCLUDED_AS_COUNT") + EXCLUDED_AS_COUNT: "EXCLUDED_AS_COUNT", + + string, +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." +#suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +#suppress "@azure-tools/typespec-azure-core/property-name-conflict" "AWSConnector will not generate SDK. So, supressing this error" +@doc("Definition of LabelNameConditionModelProperties") +model LabelNameConditionModelProperties { + @doc("The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.") + labelName?: string; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the name is defined in aws." +@armResourceOperations +interface Wafv2LoggingConfigurations { + get is ArmResourceRead<Wafv2LoggingConfiguration>; + @doc("Create a Wafv2LoggingConfiguration. Please note that end user resource creation is currently restricted, but it will be enabled in the future.") + createOrReplace is ArmResourceCreateOrReplaceAsync<Wafv2LoggingConfiguration>; + update is ArmCustomPatchAsync< + Wafv2LoggingConfiguration, + Azure.ResourceManager.Foundations.TagsUpdateModel<Wafv2LoggingConfiguration> + >; + delete is ArmResourceDeleteWithoutOkAsync<Wafv2LoggingConfiguration>; + listByResourceGroup is ArmResourceListByParent<Wafv2LoggingConfiguration>; + listBySubscription is ArmListBySubscription<Wafv2LoggingConfiguration>; +} + +//-------------------------------------------------------------------------------------------- +// This TypeSpec was auto genrated by aws2SwaggerMain.js tool +// +// Input used to generate TypeSpec: +// Cloud Control API Type: AWS::WAFv2::LoggingConfiguration +//-------------------------------------------------------------------------------------------- diff --git a/specification/awsconnector/Wafv2LoggingConfiguration.Management/tspconfig.yaml b/specification/awsconnector/Wafv2LoggingConfiguration.Management/tspconfig.yaml new file mode 100644 index 000000000000..8f0e1ee07f4b --- /dev/null +++ b/specification/awsconnector/Wafv2LoggingConfiguration.Management/tspconfig.yaml @@ -0,0 +1,13 @@ +output-dir: "{project-root}/../" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + azure-resource-provider-folder: "./resource-manager" + emitter-output-dir: "{output-dir}" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/wafv2LoggingConfiguration.json" + examples-dir: "{project-root}/examples" + use-read-only-status-schema: true +linter: + extends: + - "@azure-tools/typespec-azure-rulesets/resource-manager" diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/accessAnalyzerAnalyzer.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/accessAnalyzerAnalyzer.json new file mode 100644 index 000000000000..5cee7a5bf28a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/accessAnalyzerAnalyzer.json @@ -0,0 +1,655 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "AccessAnalyzerAnalyzers" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers": { + "get": { + "operationId": "AccessAnalyzerAnalyzers_ListBySubscription", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "List AccessAnalyzerAnalyzer resources 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/AccessAnalyzerAnalyzerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessAnalyzerAnalyzers_ListBySubscription": { + "$ref": "./examples/AccessAnalyzerAnalyzers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers": { + "get": { + "operationId": "AccessAnalyzerAnalyzers_ListByResourceGroup", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "List AccessAnalyzerAnalyzer resources 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/AccessAnalyzerAnalyzerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessAnalyzerAnalyzers_ListByResourceGroup": { + "$ref": "./examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/accessAnalyzerAnalyzers/{name}": { + "get": { + "operationId": "AccessAnalyzerAnalyzers_Get", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "Get a AccessAnalyzerAnalyzer", + "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": "name", + "in": "path", + "description": "Name of AccessAnalyzerAnalyzer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessAnalyzerAnalyzers_Get": { + "$ref": "./examples/AccessAnalyzerAnalyzers_Get.json" + } + } + }, + "put": { + "operationId": "AccessAnalyzerAnalyzers_CreateOrReplace", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "Create a AccessAnalyzerAnalyzer. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of AccessAnalyzerAnalyzer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AccessAnalyzerAnalyzer' update operation succeeded", + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + } + }, + "201": { + "description": "Resource 'AccessAnalyzerAnalyzer' create operation succeeded", + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "AccessAnalyzerAnalyzers_CreateOrReplace": { + "$ref": "./examples/AccessAnalyzerAnalyzers_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AccessAnalyzerAnalyzers_Update", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "Update a AccessAnalyzerAnalyzer", + "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": "name", + "in": "path", + "description": "Name of AccessAnalyzerAnalyzer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AccessAnalyzerAnalyzers_Update": { + "$ref": "./examples/AccessAnalyzerAnalyzers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AccessAnalyzerAnalyzers_Delete", + "tags": [ + "AccessAnalyzerAnalyzers" + ], + "description": "Delete a AccessAnalyzerAnalyzer", + "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": "name", + "in": "path", + "description": "Name of AccessAnalyzerAnalyzer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "AccessAnalyzerAnalyzers_Delete": { + "$ref": "./examples/AccessAnalyzerAnalyzers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessAnalyzerAnalyzer": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/AccessAnalyzerAnalyzerProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AccessAnalyzerAnalyzerListResult": { + "type": "object", + "description": "The response of a AccessAnalyzerAnalyzer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AccessAnalyzerAnalyzer items on this page", + "items": { + "$ref": "#/definitions/AccessAnalyzerAnalyzer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AccessAnalyzerAnalyzerProperties": { + "type": "object", + "description": "Definition of AccessAnalyzerAnalyzer", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsAccessAnalyzerAnalyzerProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AccessAnalyzerAnalyzerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AccessAnalyzerAnalyzer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ArchiveRule": { + "type": "object", + "description": "Definition of ArchiveRule", + "properties": { + "filter": { + "type": "array", + "description": "Property filter", + "items": { + "$ref": "#/definitions/Filter" + }, + "x-ms-identifiers": [] + }, + "ruleName": { + "type": "string", + "description": "The archive rule name" + } + } + }, + "AwsAccessAnalyzerAnalyzerProperties": { + "type": "object", + "description": "Definition of awsAccessAnalyzerAnalyzer", + "properties": { + "analyzerConfiguration": { + "$ref": "#/definitions/UnusedAccessConfiguration", + "description": "The configuration for the analyzer" + }, + "analyzerName": { + "type": "string", + "description": "Analyzer name" + }, + "archiveRules": { + "type": "array", + "description": "Property archiveRules", + "items": { + "$ref": "#/definitions/ArchiveRule" + }, + "x-ms-identifiers": [] + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN) of the analyzer" + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "type": { + "type": "string", + "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS" + } + } + }, + "Filter": { + "type": "object", + "description": "Definition of Filter", + "properties": { + "contains": { + "type": "array", + "description": "Property contains", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "eq": { + "type": "array", + "description": "Property eq", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "exists": { + "type": "boolean", + "description": "Property exists" + }, + "neq": { + "type": "array", + "description": "Property neq", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "property": { + "type": "string", + "description": "Property property" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + }, + "UnusedAccessConfiguration": { + "type": "object", + "description": "Definition of UnusedAccessConfiguration", + "properties": { + "unusedAccessAge": { + "type": "integer", + "format": "int32", + "description": "The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/acmCertificateSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/acmCertificateSummary.json new file mode 100644 index 000000000000..cfaa636b4792 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/acmCertificateSummary.json @@ -0,0 +1,1016 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "AcmCertificateSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/acmCertificateSummaries": { + "get": { + "operationId": "AcmCertificateSummaries_ListBySubscription", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "List AcmCertificateSummary resources 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/AcmCertificateSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcmCertificateSummaries_ListBySubscription": { + "$ref": "./examples/AcmCertificateSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/acmCertificateSummaries": { + "get": { + "operationId": "AcmCertificateSummaries_ListByResourceGroup", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "List AcmCertificateSummary resources 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/AcmCertificateSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcmCertificateSummaries_ListByResourceGroup": { + "$ref": "./examples/AcmCertificateSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/acmCertificateSummaries/{name}": { + "get": { + "operationId": "AcmCertificateSummaries_Get", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "Get a AcmCertificateSummary", + "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": "name", + "in": "path", + "description": "Name of AcmCertificateSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AcmCertificateSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcmCertificateSummaries_Get": { + "$ref": "./examples/AcmCertificateSummaries_Get.json" + } + } + }, + "put": { + "operationId": "AcmCertificateSummaries_CreateOrReplace", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "Create a AcmCertificateSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of AcmCertificateSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AcmCertificateSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AcmCertificateSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/AcmCertificateSummary" + } + }, + "201": { + "description": "Resource 'AcmCertificateSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/AcmCertificateSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "AcmCertificateSummaries_CreateOrReplace": { + "$ref": "./examples/AcmCertificateSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AcmCertificateSummaries_Update", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "Update a AcmCertificateSummary", + "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": "name", + "in": "path", + "description": "Name of AcmCertificateSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AcmCertificateSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AcmCertificateSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AcmCertificateSummaries_Update": { + "$ref": "./examples/AcmCertificateSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AcmCertificateSummaries_Delete", + "tags": [ + "AcmCertificateSummaries" + ], + "description": "Delete a AcmCertificateSummary", + "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": "name", + "in": "path", + "description": "Name of AcmCertificateSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "AcmCertificateSummaries_Delete": { + "$ref": "./examples/AcmCertificateSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AcmCertificateSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/AcmCertificateSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AcmCertificateSummaryListResult": { + "type": "object", + "description": "The response of a AcmCertificateSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AcmCertificateSummary items on this page", + "items": { + "$ref": "#/definitions/AcmCertificateSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AcmCertificateSummaryProperties": { + "type": "object", + "description": "Definition of AcmCertificateSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsAcmCertificateSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AcmCertificateSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AcmCertificateSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AwsAcmCertificateSummaryProperties": { + "type": "object", + "description": "Definition of awsAcmCertificateSummary", + "properties": { + "certificateArn": { + "type": "string", + "description": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href='https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html'>Amazon Resource Names (ARNs)</a>.</p>" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "<p>The time at which the certificate was requested.</p>" + }, + "domainName": { + "type": "string", + "description": "<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>" + }, + "exported": { + "type": "boolean", + "description": "<p>Indicates whether the certificate has been exported. This value exists only when the certificate type is <code>PRIVATE</code>.</p>" + }, + "extendedKeyUsages": { + "type": "array", + "description": "<p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>", + "items": { + "$ref": "#/definitions/ExtendedKeyUsageName" + }, + "x-ms-identifiers": [] + }, + "hasAdditionalSubjectAlternativeNames": { + "type": "boolean", + "description": "<p>When called by <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'>ListCertificates</a>, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'>DescribeCertificate</a>.</p>" + }, + "importedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>" + }, + "inUse": { + "type": "boolean", + "description": "<p>Indicates whether the certificate is currently in use by any Amazon Web Services resources.</p>" + }, + "issuedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>" + }, + "keyAlgorithm": { + "$ref": "#/definitions/KeyAlgorithmEnumValue", + "description": "<p>The algorithm that was used to generate the public-private key pair.</p>" + }, + "keyUsages": { + "type": "array", + "description": "<p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>", + "items": { + "$ref": "#/definitions/KeyUsageName" + }, + "x-ms-identifiers": [] + }, + "notAfter": { + "type": "string", + "format": "date-time", + "description": "<p>The time after which the certificate is not valid.</p>" + }, + "notBefore": { + "type": "string", + "format": "date-time", + "description": "<p>The time before which the certificate is not valid.</p>" + }, + "renewalEligibility": { + "$ref": "#/definitions/RenewalEligibilityEnumValue", + "description": "<p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>" + }, + "revokedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>" + }, + "status": { + "$ref": "#/definitions/CertificateStatusEnumValue", + "description": "<p>The status of the certificate.</p> <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic <a href='https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html'>Certificate request fails</a>. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with <a href='https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html'>DNS validation</a> or <a href='https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html'>Email validation</a>, and try again. If validation succeeds, the certificate enters status ISSUED. </p>" + }, + "subjectAlternativeNameSummaries": { + "type": "array", + "description": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p> <p>When called by <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'>ListCertificates</a>, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use <a href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'>DescribeCertificate</a>.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "type": { + "$ref": "#/definitions/CertificateTypeEnumValue", + "description": "<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href='https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html'>managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href='https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html'>Importing Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>" + } + } + }, + "CertificateStatus": { + "type": "string", + "description": "CertificateStatus enum", + "enum": [ + "EXPIRED", + "FAILED", + "INACTIVE", + "ISSUED", + "PENDING_VALIDATION", + "REVOKED", + "VALIDATION_TIMED_OUT" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "EXPIRED", + "value": "EXPIRED", + "description": "CertificateStatus enum EXPIRED" + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "CertificateStatus enum FAILED" + }, + { + "name": "INACTIVE", + "value": "INACTIVE", + "description": "CertificateStatus enum INACTIVE" + }, + { + "name": "ISSUED", + "value": "ISSUED", + "description": "CertificateStatus enum ISSUED" + }, + { + "name": "PENDING_VALIDATION", + "value": "PENDING_VALIDATION", + "description": "CertificateStatus enum PENDING_VALIDATION" + }, + { + "name": "REVOKED", + "value": "REVOKED", + "description": "CertificateStatus enum REVOKED" + }, + { + "name": "VALIDATION_TIMED_OUT", + "value": "VALIDATION_TIMED_OUT", + "description": "CertificateStatus enum VALIDATION_TIMED_OUT" + } + ] + } + }, + "CertificateStatusEnumValue": { + "type": "object", + "description": "Definition of CertificateStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CertificateStatus", + "description": "Property value" + } + } + }, + "CertificateType": { + "type": "string", + "description": "CertificateType enum", + "enum": [ + "AMAZON_ISSUED", + "IMPORTED", + "PRIVATE" + ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true, + "values": [ + { + "name": "AMAZON_ISSUED", + "value": "AMAZON_ISSUED", + "description": "CertificateType enum AMAZON_ISSUED" + }, + { + "name": "IMPORTED", + "value": "IMPORTED", + "description": "CertificateType enum IMPORTED" + }, + { + "name": "PRIVATE", + "value": "PRIVATE", + "description": "CertificateType enum PRIVATE" + } + ] + } + }, + "CertificateTypeEnumValue": { + "type": "object", + "description": "Definition of CertificateTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CertificateType", + "description": "Property value" + } + } + }, + "ExtendedKeyUsageName": { + "type": "string", + "description": "ExtendedKeyUsageName enum", + "enum": [ + "ANY", + "CODE_SIGNING", + "CUSTOM", + "EMAIL_PROTECTION", + "IPSEC_END_SYSTEM", + "IPSEC_TUNNEL", + "IPSEC_USER", + "NONE", + "OCSP_SIGNING", + "TIME_STAMPING", + "TLS_WEB_CLIENT_AUTHENTICATION", + "TLS_WEB_SERVER_AUTHENTICATION" + ], + "x-ms-enum": { + "name": "ExtendedKeyUsageName", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "ExtendedKeyUsageName enum ANY" + }, + { + "name": "CODE_SIGNING", + "value": "CODE_SIGNING", + "description": "ExtendedKeyUsageName enum CODE_SIGNING" + }, + { + "name": "CUSTOM", + "value": "CUSTOM", + "description": "ExtendedKeyUsageName enum CUSTOM" + }, + { + "name": "EMAIL_PROTECTION", + "value": "EMAIL_PROTECTION", + "description": "ExtendedKeyUsageName enum EMAIL_PROTECTION" + }, + { + "name": "IPSEC_END_SYSTEM", + "value": "IPSEC_END_SYSTEM", + "description": "ExtendedKeyUsageName enum IPSEC_END_SYSTEM" + }, + { + "name": "IPSEC_TUNNEL", + "value": "IPSEC_TUNNEL", + "description": "ExtendedKeyUsageName enum IPSEC_TUNNEL" + }, + { + "name": "IPSEC_USER", + "value": "IPSEC_USER", + "description": "ExtendedKeyUsageName enum IPSEC_USER" + }, + { + "name": "NONE", + "value": "NONE", + "description": "ExtendedKeyUsageName enum NONE" + }, + { + "name": "OCSP_SIGNING", + "value": "OCSP_SIGNING", + "description": "ExtendedKeyUsageName enum OCSP_SIGNING" + }, + { + "name": "TIME_STAMPING", + "value": "TIME_STAMPING", + "description": "ExtendedKeyUsageName enum TIME_STAMPING" + }, + { + "name": "TLS_WEB_CLIENT_AUTHENTICATION", + "value": "TLS_WEB_CLIENT_AUTHENTICATION", + "description": "ExtendedKeyUsageName enum TLS_WEB_CLIENT_AUTHENTICATION" + }, + { + "name": "TLS_WEB_SERVER_AUTHENTICATION", + "value": "TLS_WEB_SERVER_AUTHENTICATION", + "description": "ExtendedKeyUsageName enum TLS_WEB_SERVER_AUTHENTICATION" + } + ] + } + }, + "ExtendedKeyUsageNameEnumValue": { + "type": "object", + "description": "Definition of ExtendedKeyUsageNameEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ExtendedKeyUsageName", + "description": "Property value" + } + } + }, + "KeyAlgorithm": { + "type": "string", + "description": "KeyAlgorithm enum", + "enum": [ + "EC_prime256v1", + "EC_secp384r1", + "EC_secp521r1", + "RSA_1024", + "RSA_2048", + "RSA_3072", + "RSA_4096" + ], + "x-ms-enum": { + "name": "KeyAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "EC_prime256v1", + "value": "EC_prime256v1", + "description": "KeyAlgorithm enum EC_prime256v1" + }, + { + "name": "EC_secp384r1", + "value": "EC_secp384r1", + "description": "KeyAlgorithm enum EC_secp384r1" + }, + { + "name": "EC_secp521r1", + "value": "EC_secp521r1", + "description": "KeyAlgorithm enum EC_secp521r1" + }, + { + "name": "RSA_1024", + "value": "RSA_1024", + "description": "KeyAlgorithm enum RSA_1024" + }, + { + "name": "RSA_2048", + "value": "RSA_2048", + "description": "KeyAlgorithm enum RSA_2048" + }, + { + "name": "RSA_3072", + "value": "RSA_3072", + "description": "KeyAlgorithm enum RSA_3072" + }, + { + "name": "RSA_4096", + "value": "RSA_4096", + "description": "KeyAlgorithm enum RSA_4096" + } + ] + } + }, + "KeyAlgorithmEnumValue": { + "type": "object", + "description": "Definition of KeyAlgorithmEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/KeyAlgorithm", + "description": "Property value" + } + } + }, + "KeyUsageName": { + "type": "string", + "description": "KeyUsageName enum", + "enum": [ + "ANY", + "CERTIFICATE_SIGNING", + "CRL_SIGNING", + "CUSTOM", + "DATA_ENCIPHERMENT", + "DECIPHER_ONLY", + "DIGITAL_SIGNATURE", + "ENCIPHER_ONLY", + "KEY_AGREEMENT", + "KEY_ENCIPHERMENT", + "NON_REPUDIATION" + ], + "x-ms-enum": { + "name": "KeyUsageName", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "KeyUsageName enum ANY" + }, + { + "name": "CERTIFICATE_SIGNING", + "value": "CERTIFICATE_SIGNING", + "description": "KeyUsageName enum CERTIFICATE_SIGNING" + }, + { + "name": "CRL_SIGNING", + "value": "CRL_SIGNING", + "description": "KeyUsageName enum CRL_SIGNING" + }, + { + "name": "CUSTOM", + "value": "CUSTOM", + "description": "KeyUsageName enum CUSTOM" + }, + { + "name": "DATA_ENCIPHERMENT", + "value": "DATA_ENCIPHERMENT", + "description": "KeyUsageName enum DATA_ENCIPHERMENT" + }, + { + "name": "DECIPHER_ONLY", + "value": "DECIPHER_ONLY", + "description": "KeyUsageName enum DECIPHER_ONLY" + }, + { + "name": "DIGITAL_SIGNATURE", + "value": "DIGITAL_SIGNATURE", + "description": "KeyUsageName enum DIGITAL_SIGNATURE" + }, + { + "name": "ENCIPHER_ONLY", + "value": "ENCIPHER_ONLY", + "description": "KeyUsageName enum ENCIPHER_ONLY" + }, + { + "name": "KEY_AGREEMENT", + "value": "KEY_AGREEMENT", + "description": "KeyUsageName enum KEY_AGREEMENT" + }, + { + "name": "KEY_ENCIPHERMENT", + "value": "KEY_ENCIPHERMENT", + "description": "KeyUsageName enum KEY_ENCIPHERMENT" + }, + { + "name": "NON_REPUDIATION", + "value": "NON_REPUDIATION", + "description": "KeyUsageName enum NON_REPUDIATION" + } + ] + } + }, + "KeyUsageNameEnumValue": { + "type": "object", + "description": "Definition of KeyUsageNameEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/KeyUsageName", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RenewalEligibility": { + "type": "string", + "description": "RenewalEligibility enum", + "enum": [ + "ELIGIBLE", + "INELIGIBLE" + ], + "x-ms-enum": { + "name": "RenewalEligibility", + "modelAsString": true, + "values": [ + { + "name": "ELIGIBLE", + "value": "ELIGIBLE", + "description": "RenewalEligibility enum ELIGIBLE" + }, + { + "name": "INELIGIBLE", + "value": "INELIGIBLE", + "description": "RenewalEligibility enum INELIGIBLE" + } + ] + } + }, + "RenewalEligibilityEnumValue": { + "type": "object", + "description": "Definition of RenewalEligibilityEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RenewalEligibility", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayRestApi.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayRestApi.json new file mode 100644 index 000000000000..a44fb90b1e52 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayRestApi.json @@ -0,0 +1,681 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ApiGatewayRestApis" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/apiGatewayRestApis": { + "get": { + "operationId": "ApiGatewayRestApis_ListBySubscription", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "List ApiGatewayRestApi resources 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/ApiGatewayRestApiListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayRestApis_ListBySubscription": { + "$ref": "./examples/ApiGatewayRestApis_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/apiGatewayRestApis": { + "get": { + "operationId": "ApiGatewayRestApis_ListByResourceGroup", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "List ApiGatewayRestApi resources 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/ApiGatewayRestApiListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayRestApis_ListByResourceGroup": { + "$ref": "./examples/ApiGatewayRestApis_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/apiGatewayRestApis/{name}": { + "get": { + "operationId": "ApiGatewayRestApis_Get", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "Get a ApiGatewayRestApi", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayRestApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiGatewayRestApi" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayRestApis_Get": { + "$ref": "./examples/ApiGatewayRestApis_Get.json" + } + } + }, + "put": { + "operationId": "ApiGatewayRestApis_CreateOrReplace", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "Create a ApiGatewayRestApi. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayRestApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiGatewayRestApi" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiGatewayRestApi' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiGatewayRestApi" + } + }, + "201": { + "description": "Resource 'ApiGatewayRestApi' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiGatewayRestApi" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ApiGatewayRestApis_CreateOrReplace": { + "$ref": "./examples/ApiGatewayRestApis_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ApiGatewayRestApis_Update", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "Update a ApiGatewayRestApi", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayRestApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiGatewayRestApiTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiGatewayRestApi" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayRestApis_Update": { + "$ref": "./examples/ApiGatewayRestApis_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiGatewayRestApis_Delete", + "tags": [ + "ApiGatewayRestApis" + ], + "description": "Delete a ApiGatewayRestApi", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayRestApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ApiGatewayRestApis_Delete": { + "$ref": "./examples/ApiGatewayRestApis_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApiGatewayRestApi": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ApiGatewayRestApiProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ApiGatewayRestApiListResult": { + "type": "object", + "description": "The response of a ApiGatewayRestApi list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiGatewayRestApi items on this page", + "items": { + "$ref": "#/definitions/ApiGatewayRestApi" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApiGatewayRestApiProperties": { + "type": "object", + "description": "Definition of ApiGatewayRestApi", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsApiGatewayRestApiProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ApiGatewayRestApiTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ApiGatewayRestApi resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AwsApiGatewayRestApiProperties": { + "type": "object", + "description": "Definition of awsApiGatewayRestApi", + "properties": { + "apiKeySourceType": { + "type": "string", + "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer." + }, + "binaryMediaTypes": { + "type": "array", + "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "body": { + "type": "object", + "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.", + "additionalProperties": {} + }, + "bodyS3Location": { + "$ref": "#/definitions/S3Location", + "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/), becoming the foundation of the OpenAPI Specification." + }, + "cloneFrom": { + "type": "string", + "description": "The ID of the RestApi that you want to clone from." + }, + "description": { + "type": "string", + "description": "The description of the RestApi." + }, + "disableExecuteApiEndpoint": { + "type": "boolean", + "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint" + }, + "endpointConfiguration": { + "$ref": "#/definitions/EndpointConfiguration", + "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource." + }, + "failOnWarnings": { + "type": "boolean", + "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``." + }, + "minimumCompressionSize": { + "type": "integer", + "format": "int32", + "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size." + }, + "mode": { + "type": "string", + "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties." + }, + "name": { + "type": "string", + "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification." + }, + "parameters": { + "type": "object", + "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``.", + "additionalProperties": { + "type": "string" + } + }, + "policy": { + "type": "string", + "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``''`` as delimiter and values of ``'execute-api:/'`` and ``'*'``." + }, + "restApiId": { + "type": "string", + "description": "Property restApiId" + }, + "rootResourceId": { + "type": "string", + "description": "Property rootResourceId" + }, + "tags": { + "type": "array", + "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "EndpointConfiguration": { + "type": "object", + "description": "Definition of EndpointConfiguration", + "properties": { + "types": { + "type": "array", + "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``'EDGE'``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcEndpointIds": { + "type": "array", + "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "S3Location": { + "type": "object", + "description": "Definition of S3Location", + "properties": { + "bucket": { + "type": "string", + "description": "The name of the S3 bucket where the OpenAPI file is stored." + }, + "eTag": { + "type": "string", + "description": "The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file." + }, + "key": { + "type": "string", + "description": "The file name of the OpenAPI file (Amazon S3 object name)." + }, + "version": { + "type": "string", + "description": "For versioning-enabled buckets, a specific version of the OpenAPI file." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayStage.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayStage.json new file mode 100644 index 000000000000..e8f2c52d9dc4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/apiGatewayStage.json @@ -0,0 +1,712 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ApiGatewayStages" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/apiGatewayStages": { + "get": { + "operationId": "ApiGatewayStages_ListBySubscription", + "tags": [ + "ApiGatewayStages" + ], + "description": "List ApiGatewayStage resources 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/ApiGatewayStageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayStages_ListBySubscription": { + "$ref": "./examples/ApiGatewayStages_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/apiGatewayStages": { + "get": { + "operationId": "ApiGatewayStages_ListByResourceGroup", + "tags": [ + "ApiGatewayStages" + ], + "description": "List ApiGatewayStage resources 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/ApiGatewayStageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayStages_ListByResourceGroup": { + "$ref": "./examples/ApiGatewayStages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/apiGatewayStages/{name}": { + "get": { + "operationId": "ApiGatewayStages_Get", + "tags": [ + "ApiGatewayStages" + ], + "description": "Get a ApiGatewayStage", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayStage", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiGatewayStage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayStages_Get": { + "$ref": "./examples/ApiGatewayStages_Get.json" + } + } + }, + "put": { + "operationId": "ApiGatewayStages_CreateOrReplace", + "tags": [ + "ApiGatewayStages" + ], + "description": "Create a ApiGatewayStage. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayStage", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiGatewayStage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ApiGatewayStage' update operation succeeded", + "schema": { + "$ref": "#/definitions/ApiGatewayStage" + } + }, + "201": { + "description": "Resource 'ApiGatewayStage' create operation succeeded", + "schema": { + "$ref": "#/definitions/ApiGatewayStage" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ApiGatewayStages_CreateOrReplace": { + "$ref": "./examples/ApiGatewayStages_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ApiGatewayStages_Update", + "tags": [ + "ApiGatewayStages" + ], + "description": "Update a ApiGatewayStage", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayStage", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ApiGatewayStageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApiGatewayStage" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ApiGatewayStages_Update": { + "$ref": "./examples/ApiGatewayStages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ApiGatewayStages_Delete", + "tags": [ + "ApiGatewayStages" + ], + "description": "Delete a ApiGatewayStage", + "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": "name", + "in": "path", + "description": "Name of ApiGatewayStage", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ApiGatewayStages_Delete": { + "$ref": "./examples/ApiGatewayStages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessLogSetting": { + "type": "object", + "description": "Definition of AccessLogSetting", + "properties": { + "destinationArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging." + }, + "format": { + "type": "string", + "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging." + } + } + }, + "ApiGatewayStage": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ApiGatewayStageProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ApiGatewayStageListResult": { + "type": "object", + "description": "The response of a ApiGatewayStage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ApiGatewayStage items on this page", + "items": { + "$ref": "#/definitions/ApiGatewayStage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ApiGatewayStageProperties": { + "type": "object", + "description": "Definition of ApiGatewayStage", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsApiGatewayStageProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ApiGatewayStageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ApiGatewayStage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AwsApiGatewayStageProperties": { + "type": "object", + "description": "Definition of awsApiGatewayStage", + "properties": { + "accessLogSetting": { + "$ref": "#/definitions/AccessLogSetting", + "description": "Access log settings, including the access log format and access log destination ARN. The ``AccessLogSetting`` property type specifies settings for logging access in this stage. ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource." + }, + "cacheClusterEnabled": { + "type": "boolean", + "description": "Specifies whether a cache cluster is enabled for the stage." + }, + "cacheClusterSize": { + "type": "string", + "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)." + }, + "canarySetting": { + "$ref": "#/definitions/CanarySetting", + "description": "Settings for the canary deployment in this stage. Configuration settings of a canary deployment." + }, + "clientCertificateId": { + "type": "string", + "description": "The identifier of a client certificate for an API stage." + }, + "deploymentId": { + "type": "string", + "description": "The identifier of the Deployment that the stage points to." + }, + "description": { + "type": "string", + "description": "The stage's description." + }, + "documentationVersion": { + "type": "string", + "description": "The version of the associated API documentation." + }, + "methodSettings": { + "type": "array", + "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage.", + "items": { + "$ref": "#/definitions/MethodSetting" + }, + "x-ms-identifiers": [] + }, + "restApiId": { + "type": "string", + "description": "The string identifier of the associated RestApi." + }, + "stageName": { + "type": "string", + "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters." + }, + "tags": { + "type": "array", + "description": "The collection of tags. Each tag element is associated with a given resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tracingEnabled": { + "type": "boolean", + "description": "Specifies whether active tracing with X-ray is enabled for the Stage." + }, + "variables": { + "type": "object", + "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CanarySetting": { + "type": "object", + "description": "Definition of CanarySetting", + "properties": { + "deploymentId": { + "type": "string", + "description": "The ID of the canary deployment." + }, + "percentTraffic": { + "type": "integer", + "format": "int32", + "description": "The percent (0-100) of traffic diverted to a canary deployment." + }, + "stageVariableOverrides": { + "type": "object", + "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.", + "additionalProperties": { + "type": "string" + } + }, + "useStageCache": { + "type": "boolean", + "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." + } + } + }, + "MethodSetting": { + "type": "object", + "description": "Definition of MethodSetting", + "properties": { + "cacheDataEncrypted": { + "type": "boolean", + "description": "Specifies whether the cached responses are encrypted." + }, + "cacheTtlInSeconds": { + "type": "integer", + "format": "int32", + "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached." + }, + "cachingEnabled": { + "type": "boolean", + "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached." + }, + "dataTraceEnabled": { + "type": "boolean", + "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs." + }, + "httpMethod": { + "type": "string", + "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." + }, + "loggingLevel": { + "type": "string", + "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events." + }, + "metricsEnabled": { + "type": "boolean", + "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method." + }, + "resourcePath": { + "type": "string", + "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." + }, + "throttlingBurstLimit": { + "type": "integer", + "format": "int32", + "description": "Specifies the throttling burst limit." + }, + "throttlingRateLimit": { + "type": "integer", + "format": "int32", + "description": "Specifies the throttling rate limit." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/appSyncGraphqlApi.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/appSyncGraphqlApi.json new file mode 100644 index 000000000000..5e0d54e3111a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/appSyncGraphqlApi.json @@ -0,0 +1,1120 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "AppSyncGraphqlApis" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/appSyncGraphqlApis": { + "get": { + "operationId": "AppSyncGraphqlApis_ListBySubscription", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "List AppSyncGraphqlApi resources 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/AppSyncGraphqlApiListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppSyncGraphqlApis_ListBySubscription": { + "$ref": "./examples/AppSyncGraphqlApis_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/appSyncGraphqlApis": { + "get": { + "operationId": "AppSyncGraphqlApis_ListByResourceGroup", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "List AppSyncGraphqlApi resources 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/AppSyncGraphqlApiListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppSyncGraphqlApis_ListByResourceGroup": { + "$ref": "./examples/AppSyncGraphqlApis_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/appSyncGraphqlApis/{name}": { + "get": { + "operationId": "AppSyncGraphqlApis_Get", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "Get a AppSyncGraphqlApi", + "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": "name", + "in": "path", + "description": "Name of AppSyncGraphqlApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApi" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppSyncGraphqlApis_Get": { + "$ref": "./examples/AppSyncGraphqlApis_Get.json" + } + } + }, + "put": { + "operationId": "AppSyncGraphqlApis_CreateOrReplace", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "Create a AppSyncGraphqlApi. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of AppSyncGraphqlApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApi" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AppSyncGraphqlApi' update operation succeeded", + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApi" + } + }, + "201": { + "description": "Resource 'AppSyncGraphqlApi' create operation succeeded", + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApi" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "AppSyncGraphqlApis_CreateOrReplace": { + "$ref": "./examples/AppSyncGraphqlApis_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AppSyncGraphqlApis_Update", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "Update a AppSyncGraphqlApi", + "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": "name", + "in": "path", + "description": "Name of AppSyncGraphqlApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApiTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AppSyncGraphqlApi" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AppSyncGraphqlApis_Update": { + "$ref": "./examples/AppSyncGraphqlApis_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AppSyncGraphqlApis_Delete", + "tags": [ + "AppSyncGraphqlApis" + ], + "description": "Delete a AppSyncGraphqlApi", + "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": "name", + "in": "path", + "description": "Name of AppSyncGraphqlApi", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "AppSyncGraphqlApis_Delete": { + "$ref": "./examples/AppSyncGraphqlApis_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdditionalAuthenticationProvider": { + "type": "object", + "description": "Definition of AdditionalAuthenticationProvider", + "properties": { + "authenticationType": { + "$ref": "#/definitions/AuthenticationTypeEnumValue", + "description": "<p>The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.</p>" + }, + "lambdaAuthorizerConfig": { + "$ref": "#/definitions/LambdaAuthorizerConfig", + "description": "<p>Configuration for Lambda function authorization.</p>" + }, + "openIDConnectConfig": { + "$ref": "#/definitions/OpenIDConnectConfig", + "description": "<p>The OIDC configuration.</p>" + }, + "userPoolConfig": { + "$ref": "#/definitions/CognitoUserPoolConfig", + "description": "<p>The Amazon Cognito user pool configuration.</p>" + } + } + }, + "AppSyncGraphqlApi": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/AppSyncGraphqlApiProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AppSyncGraphqlApiListResult": { + "type": "object", + "description": "The response of a AppSyncGraphqlApi list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AppSyncGraphqlApi items on this page", + "items": { + "$ref": "#/definitions/AppSyncGraphqlApi" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AppSyncGraphqlApiProperties": { + "type": "object", + "description": "Definition of AppSyncGraphqlApi", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsAppSyncGraphqlApiProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AppSyncGraphqlApiTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AppSyncGraphqlApi resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AuthenticationType": { + "type": "string", + "description": "AuthenticationType enum", + "enum": [ + "AMAZON_COGNITO_USER_POOLS", + "API_KEY", + "AWS_IAM", + "AWS_LAMBDA", + "OPENID_CONNECT" + ], + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true, + "values": [ + { + "name": "AMAZON_COGNITO_USER_POOLS", + "value": "AMAZON_COGNITO_USER_POOLS", + "description": "AuthenticationType enum AMAZON_COGNITO_USER_POOLS" + }, + { + "name": "API_KEY", + "value": "API_KEY", + "description": "AuthenticationType enum API_KEY" + }, + { + "name": "AWS_IAM", + "value": "AWS_IAM", + "description": "AuthenticationType enum AWS_IAM" + }, + { + "name": "AWS_LAMBDA", + "value": "AWS_LAMBDA", + "description": "AuthenticationType enum AWS_LAMBDA" + }, + { + "name": "OPENID_CONNECT", + "value": "OPENID_CONNECT", + "description": "AuthenticationType enum OPENID_CONNECT" + } + ] + } + }, + "AuthenticationTypeEnumValue": { + "type": "object", + "description": "Definition of AuthenticationTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AuthenticationType", + "description": "Property value" + } + } + }, + "AwsAppSyncGraphqlApiProperties": { + "type": "object", + "description": "Definition of awsAppSyncGraphqlApi", + "properties": { + "additionalAuthenticationProviders": { + "type": "array", + "description": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>", + "items": { + "$ref": "#/definitions/AdditionalAuthenticationProvider" + }, + "x-ms-identifiers": [] + }, + "apiId": { + "type": "string", + "description": "<p>The API ID.</p>" + }, + "apiType": { + "$ref": "#/definitions/GraphQLApiTypeEnumValue", + "description": "<p>The value that indicates whether the GraphQL API is a standard API (<code>GRAPHQL</code>) or merged API (<code>MERGED</code>).</p>" + }, + "arn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN).</p>" + }, + "authenticationType": { + "$ref": "#/definitions/AuthenticationTypeEnumValue", + "description": "<p>The authentication type.</p>" + }, + "dns": { + "type": "object", + "description": "<p>The DNS records for the API.</p>", + "additionalProperties": { + "type": "string" + } + }, + "enhancedMetricsConfig": { + "$ref": "#/definitions/EnhancedMetricsConfig", + "description": "<p>The <code>enhancedMetricsConfig</code> object.</p>" + }, + "introspectionConfig": { + "$ref": "#/definitions/GraphQLApiIntrospectionConfigEnumValue", + "description": "<p>Sets the value of the GraphQL API to enable (<code>ENABLED</code>) or disable (<code>DISABLED</code>) introspection. If no value is provided, the introspection configuration will be set to <code>ENABLED</code> by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.</p> <p>For more information about introspection, see <a href='https://graphql.org/learn/introspection/'>GraphQL introspection</a>.</p>" + }, + "lambdaAuthorizerConfig": { + "$ref": "#/definitions/LambdaAuthorizerConfig", + "description": "<p>Configuration for Lambda function authorization.</p>" + }, + "logConfig": { + "$ref": "#/definitions/LogConfig", + "description": "<p>The Amazon CloudWatch Logs configuration.</p>" + }, + "mergedApiExecutionRoleArn": { + "type": "string", + "description": "<p>The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the <code>AUTO_MERGE</code> to update the merged API endpoint with the source API changes automatically.</p>" + }, + "name": { + "type": "string", + "description": "<p>The API name.</p>" + }, + "openIDConnectConfig": { + "$ref": "#/definitions/OpenIDConnectConfig", + "description": "<p>The OpenID Connect configuration.</p>" + }, + "owner": { + "type": "string", + "description": "<p>The account owner of the GraphQL API.</p>" + }, + "ownerContact": { + "type": "string", + "description": "<p>The owner contact information for an API resource.</p> <p>This field accepts any string input with a length of 0 - 256 characters.</p>" + }, + "queryDepthLimit": { + "type": "integer", + "format": "int32", + "description": "<p>The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is <code>0</code> (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between <code>1</code> and <code>75</code> nested levels. This field will produce a limit error if the operation falls out of bounds.</p> <p>Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.</p>" + }, + "resolverCountLimit": { + "type": "integer", + "format": "int32", + "description": "<p>The maximum number of resolvers that can be invoked in a single request. The default value is <code>0</code> (or unspecified), which will set the limit to <code>10000</code>. When specified, the limit value can be between <code>1</code> and <code>10000</code>. This field will produce a limit error if the operation falls out of bounds.</p>" + }, + "tags": { + "type": "object", + "description": "<p>The tags.</p>", + "additionalProperties": { + "type": "string" + } + }, + "uris": { + "type": "object", + "description": "<p>The URIs.</p>", + "additionalProperties": { + "type": "string" + } + }, + "userPoolConfig": { + "$ref": "#/definitions/UserPoolConfig", + "description": "<p>The Amazon Cognito user pool configuration.</p>" + }, + "visibility": { + "$ref": "#/definitions/GraphQLApiVisibilityEnumValue", + "description": "<p>Sets the value of the GraphQL API to public (<code>GLOBAL</code>) or private (<code>PRIVATE</code>). If no value is provided, the visibility will be set to <code>GLOBAL</code> by default. This value cannot be changed once the API has been created.</p>" + }, + "wafWebAclArn": { + "type": "string", + "description": "<p>The ARN of the WAF access control list (ACL) associated with this <code>GraphqlApi</code>, if one exists.</p>" + }, + "xrayEnabled": { + "type": "boolean", + "description": "<p>A flag indicating whether to use X-Ray tracing for this <code>GraphqlApi</code>.</p>" + } + } + }, + "CognitoUserPoolConfig": { + "type": "object", + "description": "Definition of CognitoUserPoolConfig", + "properties": { + "appIdClientRegex": { + "type": "string", + "description": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.</p>" + }, + "awsRegion": { + "type": "string", + "description": "<p>The Amazon Web Services Region in which the user pool was created.</p>" + }, + "userPoolId": { + "type": "string", + "description": "<p>The user pool ID.</p>" + } + } + }, + "DataSourceLevelMetricsBehavior": { + "type": "string", + "description": "DataSourceLevelMetricsBehavior enum", + "enum": [ + "FULL_REQUEST_DATA_SOURCE_METRICS", + "PER_DATA_SOURCE_METRICS" + ], + "x-ms-enum": { + "name": "DataSourceLevelMetricsBehavior", + "modelAsString": true, + "values": [ + { + "name": "FULL_REQUEST_DATA_SOURCE_METRICS", + "value": "FULL_REQUEST_DATA_SOURCE_METRICS", + "description": "DataSourceLevelMetricsBehavior enum FULL_REQUEST_DATA_SOURCE_METRICS" + }, + { + "name": "PER_DATA_SOURCE_METRICS", + "value": "PER_DATA_SOURCE_METRICS", + "description": "DataSourceLevelMetricsBehavior enum PER_DATA_SOURCE_METRICS" + } + ] + } + }, + "DataSourceLevelMetricsBehaviorEnumValue": { + "type": "object", + "description": "Definition of DataSourceLevelMetricsBehaviorEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DataSourceLevelMetricsBehavior", + "description": "Property value" + } + } + }, + "DefaultAction": { + "type": "string", + "description": "DefaultAction enum", + "enum": [ + "ALLOW", + "DENY" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true, + "values": [ + { + "name": "ALLOW", + "value": "ALLOW", + "description": "DefaultAction enum ALLOW" + }, + { + "name": "DENY", + "value": "DENY", + "description": "DefaultAction enum DENY" + } + ] + } + }, + "DefaultActionEnumValue": { + "type": "object", + "description": "Definition of DefaultActionEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DefaultAction", + "description": "Property value" + } + } + }, + "EnhancedMetricsConfig": { + "type": "object", + "description": "Definition of EnhancedMetricsConfig", + "properties": { + "dataSourceLevelMetricsBehavior": { + "$ref": "#/definitions/DataSourceLevelMetricsBehaviorEnumValue", + "description": "<p>Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:</p> <ul> <li> <p>Requests: The number of invocations that occured during a request.</p> </li> <li> <p>Latency: The time to complete a data source invocation.</p> </li> <li> <p>Errors: The number of errors that occurred during a data source invocation.</p> </li> </ul> <p>These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. <code>dataSourceLevelMetricsBehavior</code> accepts one of these values at a time:</p> <ul> <li> <p> <code>FULL_REQUEST_DATA_SOURCE_METRICS</code>: Records and emits metric data for all data sources in the request.</p> </li> <li> <p> <code>PER_DATA_SOURCE_METRICS</code>: Records and emits metric data for data sources that have the <code>metricsConfig</code> value set to <code>ENABLED</code>.</p> </li> </ul>" + }, + "operationLevelMetricsConfig": { + "$ref": "#/definitions/OperationLevelMetricsConfigEnumValue", + "description": "<p> Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:</p> <ul> <li> <p>Requests: The number of times a specified GraphQL operation was called.</p> </li> <li> <p>GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.</p> </li> </ul> <p>Metrics will be recorded by API ID and operation name. You can set the value to <code>ENABLED</code> or <code>DISABLED</code>.</p>" + }, + "resolverLevelMetricsBehavior": { + "$ref": "#/definitions/ResolverLevelMetricsBehaviorEnumValue", + "description": "<p>Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:</p> <ul> <li> <p>GraphQL errors: The number of GraphQL errors that occurred.</p> </li> <li> <p>Requests: The number of invocations that occurred during a request. </p> </li> <li> <p>Latency: The time to complete a resolver invocation.</p> </li> <li> <p>Cache hits: The number of cache hits during a request.</p> </li> <li> <p>Cache misses: The number of cache misses during a request.</p> </li> </ul> <p>These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. <code>resolverLevelMetricsBehavior</code> accepts one of these values at a time:</p> <ul> <li> <p> <code>FULL_REQUEST_RESOLVER_METRICS</code>: Records and emits metric data for all resolvers in the request.</p> </li> <li> <p> <code>PER_RESOLVER_METRICS</code>: Records and emits metric data for resolvers that have the <code>metricsConfig</code> value set to <code>ENABLED</code>.</p> </li> </ul>" + } + } + }, + "FieldLogLevel": { + "type": "string", + "description": "FieldLogLevel enum", + "enum": [ + "ALL", + "ERROR", + "NONE" + ], + "x-ms-enum": { + "name": "FieldLogLevel", + "modelAsString": true, + "values": [ + { + "name": "ALL", + "value": "ALL", + "description": "FieldLogLevel enum ALL" + }, + { + "name": "ERROR", + "value": "ERROR", + "description": "FieldLogLevel enum ERROR" + }, + { + "name": "NONE", + "value": "NONE", + "description": "FieldLogLevel enum NONE" + } + ] + } + }, + "FieldLogLevelEnumValue": { + "type": "object", + "description": "Definition of FieldLogLevelEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/FieldLogLevel", + "description": "Property value" + } + } + }, + "GraphQLApiIntrospectionConfig": { + "type": "string", + "description": "GraphQLApiIntrospectionConfig enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "GraphQLApiIntrospectionConfig", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "GraphQLApiIntrospectionConfig enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "GraphQLApiIntrospectionConfig enum ENABLED" + } + ] + } + }, + "GraphQLApiIntrospectionConfigEnumValue": { + "type": "object", + "description": "Definition of GraphQLApiIntrospectionConfigEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/GraphQLApiIntrospectionConfig", + "description": "Property value" + } + } + }, + "GraphQLApiType": { + "type": "string", + "description": "GraphQLApiType enum", + "enum": [ + "GRAPHQL", + "MERGED" + ], + "x-ms-enum": { + "name": "GraphQLApiType", + "modelAsString": true, + "values": [ + { + "name": "GRAPHQL", + "value": "GRAPHQL", + "description": "GraphQLApiType enum GRAPHQL" + }, + { + "name": "MERGED", + "value": "MERGED", + "description": "GraphQLApiType enum MERGED" + } + ] + } + }, + "GraphQLApiTypeEnumValue": { + "type": "object", + "description": "Definition of GraphQLApiTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/GraphQLApiType", + "description": "Property value" + } + } + }, + "GraphQLApiVisibility": { + "type": "string", + "description": "GraphQLApiVisibility enum", + "enum": [ + "GLOBAL", + "PRIVATE" + ], + "x-ms-enum": { + "name": "GraphQLApiVisibility", + "modelAsString": true, + "values": [ + { + "name": "GLOBAL", + "value": "GLOBAL", + "description": "GraphQLApiVisibility enum GLOBAL" + }, + { + "name": "PRIVATE", + "value": "PRIVATE", + "description": "GraphQLApiVisibility enum PRIVATE" + } + ] + } + }, + "GraphQLApiVisibilityEnumValue": { + "type": "object", + "description": "Definition of GraphQLApiVisibilityEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/GraphQLApiVisibility", + "description": "Property value" + } + } + }, + "LambdaAuthorizerConfig": { + "type": "object", + "description": "Definition of LambdaAuthorizerConfig", + "properties": { + "authorizerResultTtlInSeconds": { + "type": "integer", + "format": "int32", + "description": "<p>The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for <code>authorizerResultTtlInSeconds</code>, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a <code>ttlOverride</code> key in its response.</p>" + }, + "authorizerUri": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (<code>.../v3</code>), or an alias ARN. </p> <p> <b>Note</b>: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:</p> <p> <code>aws lambda add-permission --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction</code> </p>" + }, + "identityValidationExpression": { + "type": "string", + "description": "<p>A regular expression for validation of tokens before the Lambda function is called.</p>" + } + } + }, + "LogConfig": { + "type": "object", + "description": "Definition of LogConfig", + "properties": { + "cloudWatchLogsRoleArn": { + "type": "string", + "description": "<p>The service role that AppSync assumes to publish to CloudWatch logs in your account.</p>" + }, + "excludeVerboseContent": { + "type": "boolean", + "description": "<p>Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.</p>" + }, + "fieldLogLevel": { + "$ref": "#/definitions/FieldLogLevelEnumValue", + "description": "<p>The field logging level. Values can be NONE, ERROR, or ALL.</p> <ul> <li> <p> <b>NONE</b>: No field-level logs are captured.</p> </li> <li> <p> <b>ERROR</b>: Logs the following information only for the fields that are in error:</p> <ul> <li> <p>The error section in the server response.</p> </li> <li> <p>Field-level errors.</p> </li> <li> <p>The generated request/response functions that got resolved for error fields.</p> </li> </ul> </li> <li> <p> <b>ALL</b>: The following information is logged for all fields in the query:</p> <ul> <li> <p>Field-level tracing information.</p> </li> <li> <p>The generated request/response functions that got resolved for each field.</p> </li> </ul> </li> </ul>" + } + } + }, + "OpenIDConnectConfig": { + "type": "object", + "description": "Definition of OpenIDConnectConfig", + "properties": { + "authTTL": { + "type": "integer", + "format": "int64", + "description": "<p>The number of milliseconds that a token is valid after being authenticated.</p>" + }, + "clientId": { + "type": "string", + "description": "<p>The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.</p>" + }, + "iatTTL": { + "type": "integer", + "format": "int64", + "description": "<p>The number of milliseconds that a token is valid after it's issued to a user.</p>" + }, + "issuer": { + "type": "string", + "description": "<p>The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of <code>iss</code> in the ID token.</p>" + } + } + }, + "OperationLevelMetricsConfig": { + "type": "string", + "description": "OperationLevelMetricsConfig enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "OperationLevelMetricsConfig", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "OperationLevelMetricsConfig enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "OperationLevelMetricsConfig enum ENABLED" + } + ] + } + }, + "OperationLevelMetricsConfigEnumValue": { + "type": "object", + "description": "Definition of OperationLevelMetricsConfigEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/OperationLevelMetricsConfig", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ResolverLevelMetricsBehavior": { + "type": "string", + "description": "ResolverLevelMetricsBehavior enum", + "enum": [ + "FULL_REQUEST_RESOLVER_METRICS", + "PER_RESOLVER_METRICS" + ], + "x-ms-enum": { + "name": "ResolverLevelMetricsBehavior", + "modelAsString": true, + "values": [ + { + "name": "FULL_REQUEST_RESOLVER_METRICS", + "value": "FULL_REQUEST_RESOLVER_METRICS", + "description": "ResolverLevelMetricsBehavior enum FULL_REQUEST_RESOLVER_METRICS" + }, + { + "name": "PER_RESOLVER_METRICS", + "value": "PER_RESOLVER_METRICS", + "description": "ResolverLevelMetricsBehavior enum PER_RESOLVER_METRICS" + } + ] + } + }, + "ResolverLevelMetricsBehaviorEnumValue": { + "type": "object", + "description": "Definition of ResolverLevelMetricsBehaviorEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ResolverLevelMetricsBehavior", + "description": "Property value" + } + } + }, + "UserPoolConfig": { + "type": "object", + "description": "Definition of UserPoolConfig", + "properties": { + "appIdClientRegex": { + "type": "string", + "description": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.</p>" + }, + "awsRegion": { + "type": "string", + "description": "<p>The Amazon Web Services Region in which the user pool was created.</p>" + }, + "defaultAction": { + "$ref": "#/definitions/DefaultActionEnumValue", + "description": "<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.</p>" + }, + "userPoolId": { + "type": "string", + "description": "<p>The user pool ID.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/autoScalingAutoScalingGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/autoScalingAutoScalingGroup.json new file mode 100644 index 000000000000..3c3121b450b9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/autoScalingAutoScalingGroup.json @@ -0,0 +1,1192 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "AutoScalingAutoScalingGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/autoScalingAutoScalingGroups": { + "get": { + "operationId": "AutoScalingAutoScalingGroups_ListBySubscription", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "List AutoScalingAutoScalingGroup resources 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/AutoScalingAutoScalingGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutoScalingAutoScalingGroups_ListBySubscription": { + "$ref": "./examples/AutoScalingAutoScalingGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/autoScalingAutoScalingGroups": { + "get": { + "operationId": "AutoScalingAutoScalingGroups_ListByResourceGroup", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "List AutoScalingAutoScalingGroup resources 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/AutoScalingAutoScalingGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutoScalingAutoScalingGroups_ListByResourceGroup": { + "$ref": "./examples/AutoScalingAutoScalingGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/autoScalingAutoScalingGroups/{name}": { + "get": { + "operationId": "AutoScalingAutoScalingGroups_Get", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "Get a AutoScalingAutoScalingGroup", + "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": "name", + "in": "path", + "description": "Name of AutoScalingAutoScalingGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutoScalingAutoScalingGroups_Get": { + "$ref": "./examples/AutoScalingAutoScalingGroups_Get.json" + } + } + }, + "put": { + "operationId": "AutoScalingAutoScalingGroups_CreateOrReplace", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "Create a AutoScalingAutoScalingGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of AutoScalingAutoScalingGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'AutoScalingAutoScalingGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + } + }, + "201": { + "description": "Resource 'AutoScalingAutoScalingGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "AutoScalingAutoScalingGroups_CreateOrReplace": { + "$ref": "./examples/AutoScalingAutoScalingGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "AutoScalingAutoScalingGroups_Update", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "Update a AutoScalingAutoScalingGroup", + "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": "name", + "in": "path", + "description": "Name of AutoScalingAutoScalingGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "AutoScalingAutoScalingGroups_Update": { + "$ref": "./examples/AutoScalingAutoScalingGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "AutoScalingAutoScalingGroups_Delete", + "tags": [ + "AutoScalingAutoScalingGroups" + ], + "description": "Delete a AutoScalingAutoScalingGroup", + "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": "name", + "in": "path", + "description": "Name of AutoScalingAutoScalingGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "AutoScalingAutoScalingGroups_Delete": { + "$ref": "./examples/AutoScalingAutoScalingGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AcceleratorCountRequest": { + "type": "object", + "description": "Definition of AcceleratorCountRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum value." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum value." + } + } + }, + "AcceleratorTotalMemoryMiBRequest": { + "type": "object", + "description": "Definition of AcceleratorTotalMemoryMiBRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The memory maximum in MiB." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The memory minimum in MiB." + } + } + }, + "AutoScalingAutoScalingGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/AutoScalingAutoScalingGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "AutoScalingAutoScalingGroupListResult": { + "type": "object", + "description": "The response of a AutoScalingAutoScalingGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The AutoScalingAutoScalingGroup items on this page", + "items": { + "$ref": "#/definitions/AutoScalingAutoScalingGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "AutoScalingAutoScalingGroupProperties": { + "type": "object", + "description": "Definition of AutoScalingAutoScalingGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsAutoScalingAutoScalingGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "AutoScalingAutoScalingGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in AutoScalingAutoScalingGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AwsAutoScalingAutoScalingGroupProperties": { + "type": "object", + "description": "Definition of awsAutoScalingAutoScalingGroup", + "properties": { + "autoScalingGroupName": { + "type": "string", + "description": "The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name." + }, + "availabilityZones": { + "type": "array", + "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "capacityRebalance": { + "type": "boolean", + "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*." + }, + "context": { + "type": "string", + "description": "Reserved." + }, + "cooldown": { + "type": "string", + "description": "*Only needed if you use simple scaling policies.* The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds" + }, + "defaultInstanceWarmup": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None" + }, + "desiredCapacity": { + "type": "string", + "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price." + }, + "desiredCapacityType": { + "type": "string", + "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib``" + }, + "healthCheckGracePeriod": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``0`` seconds" + }, + "healthCheckType": { + "type": "string", + "description": "A comma-separated value string of one or more health check types. The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set." + }, + "instanceId": { + "type": "string", + "description": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``." + }, + "instanceMaintenancePolicy": { + "$ref": "#/definitions/InstanceMaintenancePolicy", + "description": "An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "launchConfigurationName": { + "type": "string", + "description": "The name of the launch configuration to use to launch instances. Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``." + }, + "launchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." + }, + "lifecycleHookSpecificationList": { + "type": "array", + "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.", + "items": { + "$ref": "#/definitions/LifecycleHookSpecification" + }, + "x-ms-identifiers": [] + }, + "loadBalancerNames": { + "type": "array", + "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "maxInstanceLifetime": { + "type": "integer", + "format": "int32", + "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "maxSize": { + "type": "string", + "description": "The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group)." + }, + "metricsCollection": { + "type": "array", + "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.", + "items": { + "$ref": "#/definitions/MetricsCollection" + }, + "x-ms-identifiers": [] + }, + "minSize": { + "type": "string", + "description": "The minimum size of the group." + }, + "mixedInstancesPolicy": { + "$ref": "#/definitions/MixedInstancesPolicy", + "description": "An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. There are key differences between Spot Instances and On-Demand Instances: + The price for Spot Instances varies based on demand + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource." + }, + "newInstancesProtectedFromScaleIn": { + "type": "boolean", + "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "notificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration", + "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "notificationConfigurations": { + "type": "array", + "description": "Configures an Auto Scaling group to send notifications when specified events take place.", + "items": { + "$ref": "#/definitions/NotificationConfiguration" + }, + "x-ms-identifiers": [] + }, + "placementGroup": { + "type": "string", + "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group." + }, + "serviceLinkedRoleARN": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*." + }, + "tags": { + "type": "array", + "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "items": { + "$ref": "#/definitions/TagProperty" + }, + "x-ms-identifiers": [] + }, + "targetGroupARNs": { + "type": "array", + "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "terminationPolicies": { + "type": "array", + "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcZoneIdentifier": { + "type": "array", + "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "BaselineEbsBandwidthMbpsRequest": { + "type": "object", + "description": "Definition of BaselineEbsBandwidthMbpsRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum value in Mbps." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum value in Mbps." + } + } + }, + "InstanceMaintenancePolicy": { + "type": "object", + "description": "Definition of InstanceMaintenancePolicy", + "properties": { + "maxHealthyPercentage": { + "type": "integer", + "format": "int32", + "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time." + }, + "minHealthyPercentage": { + "type": "integer", + "format": "int32", + "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``." + } + } + }, + "InstanceRequirements": { + "type": "object", + "description": "Definition of InstanceRequirements", + "properties": { + "acceleratorCount": { + "$ref": "#/definitions/AcceleratorCountRequest", + "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type." + }, + "acceleratorManufacturers": { + "type": "array", + "description": "Indicates whether instance types must have accelerators by specific manufacturers. + For instance types with NVIDIA devices, specify ``nvidia``. + For instance types with AMD devices, specify ``amd``. + For instance types with AWS devices, specify ``amazon-web-services``. + For instance types with Xilinx devices, specify ``xilinx``. Default: Any manufacturer", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "acceleratorNames": { + "type": "array", + "description": "Lists the accelerators that must be on an instance type. + For instance types with NVIDIA A100 GPUs, specify ``a100``. + For instance types with NVIDIA V100 GPUs, specify ``v100``. + For instance types with NVIDIA K80 GPUs, specify ``k80``. + For instance types with NVIDIA T4 GPUs, specify ``t4``. + For instance types with NVIDIA M60 GPUs, specify ``m60``. + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. Default: Any accelerator", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "acceleratorTotalMemoryMiB": { + "$ref": "#/definitions/AcceleratorTotalMemoryMiBRequest", + "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB." + }, + "acceleratorTypes": { + "type": "array", + "description": "Lists the accelerator types that must be on an instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "allowedInstanceTypes": { + "type": "array", + "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. Default: All instance types", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "bareMetal": { + "type": "string", + "description": "Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded``" + }, + "baselineEbsBandwidthMbps": { + "$ref": "#/definitions/BaselineEbsBandwidthMbpsRequest", + "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: No minimum or maximum limits ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps." + }, + "burstablePerformance": { + "type": "string", + "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``excluded``" + }, + "cpuManufacturers": { + "type": "array", + "description": "Lists which specific CPU manufacturers to include. + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "excludedInstanceTypes": { + "type": "array", + "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. Default: No excluded instance types", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "instanceGenerations": { + "type": "array", + "description": "Indicates whether current or previous generation instance types are included. + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + For previous generation instance types, specify ``previous``. Default: Any current or previous generation", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "localStorage": { + "type": "string", + "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``included``" + }, + "localStorageTypes": { + "type": "array", + "description": "Indicates the type of local storage that is required. + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + For instance types with solid state drive (SSD) storage, specify ``ssd``. Default: Any local storage type", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { + "type": "integer", + "format": "int32", + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``." + }, + "memoryGiBPerVCpu": { + "$ref": "#/definitions/MemoryGiBPerVCpuRequest", + "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB." + }, + "memoryMiB": { + "$ref": "#/definitions/MemoryMiBRequest", + "description": "The minimum and maximum instance memory size for an instance type, in MiB. ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB." + }, + "networkBandwidthGbps": { + "$ref": "#/definitions/NetworkBandwidthGbpsRequest", + "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*." + }, + "networkInterfaceCount": { + "$ref": "#/definitions/NetworkInterfaceCountRequest", + "description": "The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type." + }, + "onDemandMaxPricePercentageOverLowestPrice": { + "type": "integer", + "format": "int32", + "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default: ``20``" + }, + "requireHibernateSupport": { + "type": "boolean", + "description": "Indicates whether instance types must provide On-Demand Instance hibernation support. Default: ``false``" + }, + "spotMaxPricePercentageOverLowestPrice": { + "type": "integer", + "format": "int32", + "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. Default: ``100``" + }, + "totalLocalStorageGB": { + "$ref": "#/definitions/TotalLocalStorageGBRequest", + "description": "The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB." + }, + "vCpuCount": { + "$ref": "#/definitions/VCpuCountRequest", + "description": "The minimum and maximum number of vCPUs for an instance type. ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type." + } + } + }, + "InstancesDistribution": { + "type": "object", + "description": "Definition of InstancesDistribution", + "properties": { + "onDemandAllocationStrategy": { + "type": "string", + "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do." + }, + "onDemandBaseCapacity": { + "type": "integer", + "format": "int32", + "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. Default: 0 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." + }, + "onDemandPercentageAboveBaseCapacity": { + "type": "integer", + "format": "int32", + "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. Default: 100 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." + }, + "spotAllocationStrategy": { + "type": "string", + "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price." + }, + "spotInstancePools": { + "type": "integer", + "format": "int32", + "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. Default: 2" + }, + "spotMaxPrice": { + "type": "string", + "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ('') for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001" + } + } + }, + "LaunchTemplate": { + "type": "object", + "description": "Definition of LaunchTemplate", + "properties": { + "launchTemplateSpecification": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "The launch template. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." + }, + "overrides": { + "type": "array", + "description": "Any properties that you specify override the same properties in the launch template.", + "items": { + "$ref": "#/definitions/LaunchTemplateOverrides" + }, + "x-ms-identifiers": [] + } + } + }, + "LaunchTemplateOverrides": { + "type": "object", + "description": "Definition of LaunchTemplateOverrides", + "properties": { + "instanceRequirements": { + "$ref": "#/definitions/InstanceRequirements", + "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type." + }, + "instanceType": { + "type": "string", + "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. You can specify up to 40 instance types per Auto Scaling group." + }, + "launchTemplateSpecification": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." + }, + "weightedCapacity": { + "type": "string", + "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances." + } + } + }, + "LaunchTemplateSpecification": { + "type": "object", + "description": "Definition of LaunchTemplateSpecification", + "properties": { + "launchTemplateId": { + "type": "string", + "description": "The ID of the launch template. You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both." + }, + "launchTemplateName": { + "type": "string", + "description": "The name of the launch template. You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both." + }, + "version": { + "type": "string", + "description": "The version number of the launch template. Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource." + } + } + }, + "LifecycleHookSpecification": { + "type": "object", + "description": "Definition of LifecycleHookSpecification", + "properties": { + "defaultResult": { + "type": "string", + "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. Valid values: ``CONTINUE`` | ``ABANDON``" + }, + "heartbeatTimeout": { + "type": "integer", + "format": "int32", + "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour)." + }, + "lifecycleHookName": { + "type": "string", + "description": "The name of the lifecycle hook." + }, + "lifecycleTransition": { + "type": "string", + "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``." + }, + "notificationMetadata": { + "type": "string", + "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target." + }, + "notificationTargetARN": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue." + }, + "roleARN": { + "type": "string", + "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue." + } + } + }, + "MemoryGiBPerVCpuRequest": { + "type": "object", + "description": "Definition of MemoryGiBPerVCpuRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The memory maximum in GiB." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The memory minimum in GiB." + } + } + }, + "MemoryMiBRequest": { + "type": "object", + "description": "Definition of MemoryMiBRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The memory maximum in MiB." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The memory minimum in MiB." + } + } + }, + "MetricsCollection": { + "type": "object", + "description": "Definition of MetricsCollection", + "properties": { + "granularity": { + "type": "string", + "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``." + }, + "metrics": { + "type": "array", + "description": "Identifies the metrics to enable. You can specify one or more of the following metrics: + ``GroupMinSize`` + ``GroupMaxSize`` + ``GroupDesiredCapacity`` + ``GroupInServiceInstances`` + ``GroupPendingInstances`` + ``GroupStandbyInstances`` + ``GroupTerminatingInstances`` + ``GroupTotalInstances`` + ``GroupInServiceCapacity`` + ``GroupPendingCapacity`` + ``GroupStandbyCapacity`` + ``GroupTerminatingCapacity`` + ``GroupTotalCapacity`` + ``WarmPoolDesiredCapacity`` + ``WarmPoolWarmedCapacity`` + ``WarmPoolPendingCapacity`` + ``WarmPoolTerminatingCapacity`` + ``WarmPoolTotalCapacity`` + ``GroupAndWarmPoolDesiredCapacity`` + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "MixedInstancesPolicy": { + "type": "object", + "description": "Definition of MixedInstancesPolicy", + "properties": { + "instancesDistribution": { + "$ref": "#/definitions/InstancesDistribution", + "description": "The instances distribution. Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." + }, + "launchTemplate": { + "$ref": "#/definitions/LaunchTemplate", + "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." + } + } + }, + "NetworkBandwidthGbpsRequest": { + "type": "object", + "description": "Definition of NetworkBandwidthGbpsRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps)." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps)." + } + } + }, + "NetworkInterfaceCountRequest": { + "type": "object", + "description": "Definition of NetworkInterfaceCountRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of network interfaces." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of network interfaces." + } + } + }, + "NotificationConfiguration": { + "type": "object", + "description": "Definition of NotificationConfiguration", + "properties": { + "notificationTypes": { + "type": "array", + "description": "A list of event types that send a notification. Event types can include any of the following types. *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + ``autoscaling:TEST_NOTIFICATION``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "topicARN": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "TagProperty": { + "type": "object", + "description": "Definition of TagProperty", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "propagateAtLaunch": { + "type": "boolean", + "description": "Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + }, + "TotalLocalStorageGBRequest": { + "type": "object", + "description": "Definition of TotalLocalStorageGBRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The storage maximum in GB." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The storage minimum in GB." + } + } + }, + "VCpuCountRequest": { + "type": "object", + "description": "Definition of VCpuCountRequest", + "properties": { + "max": { + "type": "integer", + "format": "int32", + "description": "The maximum number of vCPUs." + }, + "min": { + "type": "integer", + "format": "int32", + "description": "The minimum number of vCPUs." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStack.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStack.json new file mode 100644 index 000000000000..9940b35c818f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStack.json @@ -0,0 +1,868 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CloudFormationStacks" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/cloudFormationStacks": { + "get": { + "operationId": "CloudFormationStacks_ListBySubscription", + "tags": [ + "CloudFormationStacks" + ], + "description": "List CloudFormationStack resources 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/CloudFormationStackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStacks_ListBySubscription": { + "$ref": "./examples/CloudFormationStacks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFormationStacks": { + "get": { + "operationId": "CloudFormationStacks_ListByResourceGroup", + "tags": [ + "CloudFormationStacks" + ], + "description": "List CloudFormationStack resources 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/CloudFormationStackListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStacks_ListByResourceGroup": { + "$ref": "./examples/CloudFormationStacks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFormationStacks/{name}": { + "get": { + "operationId": "CloudFormationStacks_Get", + "tags": [ + "CloudFormationStacks" + ], + "description": "Get a CloudFormationStack", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStack", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFormationStack" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStacks_Get": { + "$ref": "./examples/CloudFormationStacks_Get.json" + } + } + }, + "put": { + "operationId": "CloudFormationStacks_CreateOrReplace", + "tags": [ + "CloudFormationStacks" + ], + "description": "Create a CloudFormationStack. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStack", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFormationStack" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudFormationStack' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFormationStack" + } + }, + "201": { + "description": "Resource 'CloudFormationStack' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFormationStack" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CloudFormationStacks_CreateOrReplace": { + "$ref": "./examples/CloudFormationStacks_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudFormationStacks_Update", + "tags": [ + "CloudFormationStacks" + ], + "description": "Update a CloudFormationStack", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStack", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFormationStackTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFormationStack" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStacks_Update": { + "$ref": "./examples/CloudFormationStacks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudFormationStacks_Delete", + "tags": [ + "CloudFormationStacks" + ], + "description": "Delete a CloudFormationStack", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStack", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CloudFormationStacks_Delete": { + "$ref": "./examples/CloudFormationStacks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsCloudFormationStackProperties": { + "type": "object", + "description": "Definition of awsCloudFormationStack", + "properties": { + "capabilities": { + "type": "array", + "description": "Property capabilities", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "x-ms-identifiers": [] + }, + "changeSetId": { + "type": "string", + "description": "Property changeSetId" + }, + "creationTime": { + "type": "string", + "description": "Property creationTime" + }, + "description": { + "type": "string", + "description": "Property description" + }, + "disableRollback": { + "type": "boolean", + "description": "Property disableRollback" + }, + "enableTerminationProtection": { + "type": "boolean", + "description": "Property enableTerminationProtection" + }, + "lastUpdateTime": { + "type": "string", + "description": "Property lastUpdateTime" + }, + "notificationARNs": { + "type": "array", + "description": "Property notificationARNs", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "outputs": { + "type": "array", + "description": "Property outputs", + "items": { + "$ref": "#/definitions/Output" + }, + "x-ms-identifiers": [] + }, + "parameters": { + "type": "object", + "description": "Property parameters", + "additionalProperties": { + "type": "string" + } + }, + "parentId": { + "type": "string", + "description": "Property parentId" + }, + "roleARN": { + "type": "string", + "description": "Property roleARN" + }, + "rootId": { + "type": "string", + "description": "Property rootId" + }, + "stackId": { + "type": "string", + "description": "Property stackId" + }, + "stackName": { + "type": "string", + "description": "Property stackName" + }, + "stackPolicyBody": { + "description": "Property stackPolicyBody" + }, + "stackPolicyURL": { + "type": "string", + "description": "Property stackPolicyURL" + }, + "stackStatus": { + "$ref": "#/definitions/StackStatus", + "description": "Property stackStatus" + }, + "stackStatusReason": { + "type": "string", + "description": "Property stackStatusReason" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "templateBody": { + "description": "Property templateBody" + }, + "templateURL": { + "type": "string", + "description": "Property templateURL" + }, + "timeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "Property timeoutInMinutes" + } + } + }, + "Capabilities": { + "type": "string", + "description": "Capabilities enum", + "enum": [ + "CAPABILITY_AUTO_EXPAND", + "CAPABILITY_IAM", + "CAPABILITY_NAMED_IAM" + ], + "x-ms-enum": { + "name": "Capabilities", + "modelAsString": true, + "values": [ + { + "name": "CAPABILITY_AUTO_EXPAND", + "value": "CAPABILITY_AUTO_EXPAND", + "description": "Capabilities enum CAPABILITY_AUTO_EXPAND" + }, + { + "name": "CAPABILITY_IAM", + "value": "CAPABILITY_IAM", + "description": "Capabilities enum CAPABILITY_IAM" + }, + { + "name": "CAPABILITY_NAMED_IAM", + "value": "CAPABILITY_NAMED_IAM", + "description": "Capabilities enum CAPABILITY_NAMED_IAM" + } + ] + } + }, + "CloudFormationStack": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudFormationStackProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudFormationStackListResult": { + "type": "object", + "description": "The response of a CloudFormationStack list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudFormationStack items on this page", + "items": { + "$ref": "#/definitions/CloudFormationStack" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudFormationStackProperties": { + "type": "object", + "description": "Definition of CloudFormationStack", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCloudFormationStackProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CloudFormationStackTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CloudFormationStack resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Output": { + "type": "object", + "description": "Definition of Output", + "properties": { + "description": { + "type": "string", + "description": "Property description" + }, + "exportName": { + "type": "string", + "description": "Property exportName" + }, + "outputKey": { + "type": "string", + "description": "Property outputKey" + }, + "outputValue": { + "type": "string", + "description": "Property outputValue" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StackStatus": { + "type": "string", + "description": "StackStatus enum", + "enum": [ + "CREATE_COMPLETE", + "CREATE_FAILED", + "CREATE_IN_PROGRESS", + "DELETE_COMPLETE", + "DELETE_FAILED", + "DELETE_IN_PROGRESS", + "IMPORT_COMPLETE", + "IMPORT_IN_PROGRESS", + "IMPORT_ROLLBACK_COMPLETE", + "IMPORT_ROLLBACK_FAILED", + "IMPORT_ROLLBACK_IN_PROGRESS", + "REVIEW_IN_PROGRESS", + "ROLLBACK_COMPLETE", + "ROLLBACK_FAILED", + "ROLLBACK_IN_PROGRESS", + "UPDATE_COMPLETE", + "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_FAILED", + "UPDATE_IN_PROGRESS", + "UPDATE_ROLLBACK_COMPLETE", + "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_IN_PROGRESS" + ], + "x-ms-enum": { + "name": "StackStatus", + "modelAsString": true, + "values": [ + { + "name": "CREATE_COMPLETE", + "value": "CREATE_COMPLETE", + "description": "StackStatus enum CREATE_COMPLETE" + }, + { + "name": "CREATE_FAILED", + "value": "CREATE_FAILED", + "description": "StackStatus enum CREATE_FAILED" + }, + { + "name": "CREATE_IN_PROGRESS", + "value": "CREATE_IN_PROGRESS", + "description": "StackStatus enum CREATE_IN_PROGRESS" + }, + { + "name": "DELETE_COMPLETE", + "value": "DELETE_COMPLETE", + "description": "StackStatus enum DELETE_COMPLETE" + }, + { + "name": "DELETE_FAILED", + "value": "DELETE_FAILED", + "description": "StackStatus enum DELETE_FAILED" + }, + { + "name": "DELETE_IN_PROGRESS", + "value": "DELETE_IN_PROGRESS", + "description": "StackStatus enum DELETE_IN_PROGRESS" + }, + { + "name": "IMPORT_COMPLETE", + "value": "IMPORT_COMPLETE", + "description": "StackStatus enum IMPORT_COMPLETE" + }, + { + "name": "IMPORT_IN_PROGRESS", + "value": "IMPORT_IN_PROGRESS", + "description": "StackStatus enum IMPORT_IN_PROGRESS" + }, + { + "name": "IMPORT_ROLLBACK_COMPLETE", + "value": "IMPORT_ROLLBACK_COMPLETE", + "description": "StackStatus enum IMPORT_ROLLBACK_COMPLETE" + }, + { + "name": "IMPORT_ROLLBACK_FAILED", + "value": "IMPORT_ROLLBACK_FAILED", + "description": "StackStatus enum IMPORT_ROLLBACK_FAILED" + }, + { + "name": "IMPORT_ROLLBACK_IN_PROGRESS", + "value": "IMPORT_ROLLBACK_IN_PROGRESS", + "description": "StackStatus enum IMPORT_ROLLBACK_IN_PROGRESS" + }, + { + "name": "REVIEW_IN_PROGRESS", + "value": "REVIEW_IN_PROGRESS", + "description": "StackStatus enum REVIEW_IN_PROGRESS" + }, + { + "name": "ROLLBACK_COMPLETE", + "value": "ROLLBACK_COMPLETE", + "description": "StackStatus enum ROLLBACK_COMPLETE" + }, + { + "name": "ROLLBACK_FAILED", + "value": "ROLLBACK_FAILED", + "description": "StackStatus enum ROLLBACK_FAILED" + }, + { + "name": "ROLLBACK_IN_PROGRESS", + "value": "ROLLBACK_IN_PROGRESS", + "description": "StackStatus enum ROLLBACK_IN_PROGRESS" + }, + { + "name": "UPDATE_COMPLETE", + "value": "UPDATE_COMPLETE", + "description": "StackStatus enum UPDATE_COMPLETE" + }, + { + "name": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "value": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "description": "StackStatus enum UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" + }, + { + "name": "UPDATE_FAILED", + "value": "UPDATE_FAILED", + "description": "StackStatus enum UPDATE_FAILED" + }, + { + "name": "UPDATE_IN_PROGRESS", + "value": "UPDATE_IN_PROGRESS", + "description": "StackStatus enum UPDATE_IN_PROGRESS" + }, + { + "name": "UPDATE_ROLLBACK_COMPLETE", + "value": "UPDATE_ROLLBACK_COMPLETE", + "description": "StackStatus enum UPDATE_ROLLBACK_COMPLETE" + }, + { + "name": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "value": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "description": "StackStatus enum UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" + }, + { + "name": "UPDATE_ROLLBACK_FAILED", + "value": "UPDATE_ROLLBACK_FAILED", + "description": "StackStatus enum UPDATE_ROLLBACK_FAILED" + }, + { + "name": "UPDATE_ROLLBACK_IN_PROGRESS", + "value": "UPDATE_ROLLBACK_IN_PROGRESS", + "description": "StackStatus enum UPDATE_ROLLBACK_IN_PROGRESS" + } + ] + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStackSet.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStackSet.json new file mode 100644 index 000000000000..bea51d3b3aca --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStackSet.json @@ -0,0 +1,876 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CloudFormationStackSets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/cloudFormationStackSets": { + "get": { + "operationId": "CloudFormationStackSets_ListBySubscription", + "tags": [ + "CloudFormationStackSets" + ], + "description": "List CloudFormationStackSet resources 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/CloudFormationStackSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStackSets_ListBySubscription": { + "$ref": "./examples/CloudFormationStackSets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFormationStackSets": { + "get": { + "operationId": "CloudFormationStackSets_ListByResourceGroup", + "tags": [ + "CloudFormationStackSets" + ], + "description": "List CloudFormationStackSet resources 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/CloudFormationStackSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStackSets_ListByResourceGroup": { + "$ref": "./examples/CloudFormationStackSets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFormationStackSets/{name}": { + "get": { + "operationId": "CloudFormationStackSets_Get", + "tags": [ + "CloudFormationStackSets" + ], + "description": "Get a CloudFormationStackSet", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStackSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFormationStackSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStackSets_Get": { + "$ref": "./examples/CloudFormationStackSets_Get.json" + } + } + }, + "put": { + "operationId": "CloudFormationStackSets_CreateOrReplace", + "tags": [ + "CloudFormationStackSets" + ], + "description": "Create a CloudFormationStackSet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStackSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFormationStackSet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudFormationStackSet' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFormationStackSet" + } + }, + "201": { + "description": "Resource 'CloudFormationStackSet' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFormationStackSet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CloudFormationStackSets_CreateOrReplace": { + "$ref": "./examples/CloudFormationStackSets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudFormationStackSets_Update", + "tags": [ + "CloudFormationStackSets" + ], + "description": "Update a CloudFormationStackSet", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStackSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFormationStackSetTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFormationStackSet" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFormationStackSets_Update": { + "$ref": "./examples/CloudFormationStackSets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudFormationStackSets_Delete", + "tags": [ + "CloudFormationStackSets" + ], + "description": "Delete a CloudFormationStackSet", + "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": "name", + "in": "path", + "description": "Name of CloudFormationStackSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CloudFormationStackSets_Delete": { + "$ref": "./examples/CloudFormationStackSets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActiveModel": { + "type": "object", + "description": "Definition of Active", + "properties": { + "active": { + "type": "boolean", + "description": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order." + } + } + }, + "AutoDeployment": { + "type": "object", + "description": "Definition of AutoDeployment", + "properties": { + "enabled": { + "type": "boolean", + "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions." + }, + "retainStacksOnAccountRemoval": { + "type": "boolean", + "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True." + } + } + }, + "AwsCloudFormationStackSetProperties": { + "type": "object", + "description": "Definition of awsCloudFormationStackSet", + "properties": { + "administrationRoleARN": { + "type": "string", + "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account." + }, + "autoDeployment": { + "$ref": "#/definitions/AutoDeployment", + "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." + }, + "callAs": { + "$ref": "#/definitions/CallAs", + "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN." + }, + "capabilities": { + "type": "array", + "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "description": { + "type": "string", + "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information." + }, + "executionRoleName": { + "type": "string", + "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation." + }, + "managedExecution": { + "$ref": "#/definitions/ActiveModel", + "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." + }, + "operationPreferences": { + "$ref": "#/definitions/OperationPreferences", + "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation." + }, + "parameters": { + "type": "array", + "description": "The input parameters for the stack set template.", + "items": { + "$ref": "#/definitions/Parameter" + }, + "x-ms-identifiers": [] + }, + "permissionModel": { + "$ref": "#/definitions/PermissionModel", + "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified." + }, + "stackInstancesGroup": { + "type": "array", + "description": "A group of stack instances with parameters in some specific accounts and regions.", + "items": { + "$ref": "#/definitions/StackInstances" + }, + "x-ms-identifiers": [] + }, + "stackSetId": { + "type": "string", + "description": "The ID of the stack set that you're creating." + }, + "stackSetName": { + "type": "string", + "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set." + }, + "tags": { + "type": "array", + "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "templateBody": { + "type": "string", + "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." + }, + "templateURL": { + "type": "string", + "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket." + } + } + }, + "CallAs": { + "type": "string", + "description": "CallAs enum", + "enum": [ + "DELEGATED_ADMIN", + "SELF" + ], + "x-ms-enum": { + "name": "CallAs", + "modelAsString": true, + "values": [ + { + "name": "DELEGATED_ADMIN", + "value": "DELEGATED_ADMIN", + "description": "CallAs enum DELEGATED_ADMIN" + }, + { + "name": "SELF", + "value": "SELF", + "description": "CallAs enum SELF" + } + ] + } + }, + "CloudFormationStackSet": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudFormationStackSetProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudFormationStackSetListResult": { + "type": "object", + "description": "The response of a CloudFormationStackSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudFormationStackSet items on this page", + "items": { + "$ref": "#/definitions/CloudFormationStackSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudFormationStackSetProperties": { + "type": "object", + "description": "Definition of CloudFormationStackSet", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCloudFormationStackSetProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CloudFormationStackSetTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CloudFormationStackSet resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DeploymentTargets": { + "type": "object", + "description": "Definition of DeploymentTargets", + "properties": { + "accountFilterType": { + "$ref": "#/definitions/DeploymentTargetsAccountFilterType", + "description": "The filter type you want to apply on organizational units and accounts." + }, + "accounts": { + "type": "array", + "description": "AWS accounts that you want to create stack instances in the specified Region(s) for.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "accountsUrl": { + "type": "string", + "description": "Returns the value of the AccountsUrl property." + }, + "organizationalUnitIds": { + "type": "array", + "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DeploymentTargetsAccountFilterType": { + "type": "string", + "description": "DeploymentTargetsAccountFilterType enum", + "enum": [ + "DIFFERENCE", + "INTERSECTION", + "NONE", + "UNION" + ], + "x-ms-enum": { + "name": "DeploymentTargetsAccountFilterType", + "modelAsString": true, + "values": [ + { + "name": "DIFFERENCE", + "value": "DIFFERENCE", + "description": "DeploymentTargetsAccountFilterType enum DIFFERENCE" + }, + { + "name": "INTERSECTION", + "value": "INTERSECTION", + "description": "DeploymentTargetsAccountFilterType enum INTERSECTION" + }, + { + "name": "NONE", + "value": "NONE", + "description": "DeploymentTargetsAccountFilterType enum NONE" + }, + { + "name": "UNION", + "value": "UNION", + "description": "DeploymentTargetsAccountFilterType enum UNION" + } + ] + } + }, + "OperationPreferences": { + "type": "object", + "description": "Definition of OperationPreferences", + "properties": { + "failureToleranceCount": { + "type": "integer", + "format": "int32", + "description": "Property failureToleranceCount" + }, + "failureTolerancePercentage": { + "type": "integer", + "format": "int32", + "description": "Property failureTolerancePercentage" + }, + "maxConcurrentCount": { + "type": "integer", + "format": "int32", + "description": "Property maxConcurrentCount" + }, + "maxConcurrentPercentage": { + "type": "integer", + "format": "int32", + "description": "Property maxConcurrentPercentage" + }, + "regionConcurrencyType": { + "$ref": "#/definitions/OperationPreferencesRegionConcurrencyType", + "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time" + }, + "regionOrder": { + "type": "array", + "description": "Property regionOrder", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "OperationPreferencesRegionConcurrencyType": { + "type": "string", + "description": "OperationPreferencesRegionConcurrencyType enum", + "enum": [ + "PARALLEL", + "SEQUENTIAL" + ], + "x-ms-enum": { + "name": "OperationPreferencesRegionConcurrencyType", + "modelAsString": true, + "values": [ + { + "name": "PARALLEL", + "value": "PARALLEL", + "description": "OperationPreferencesRegionConcurrencyType enum PARALLEL" + }, + { + "name": "SEQUENTIAL", + "value": "SEQUENTIAL", + "description": "OperationPreferencesRegionConcurrencyType enum SEQUENTIAL" + } + ] + } + }, + "Parameter": { + "type": "object", + "description": "Definition of Parameter", + "properties": { + "parameterKey": { + "type": "string", + "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template." + }, + "parameterValue": { + "type": "string", + "description": "The input value associated with the parameter." + } + } + }, + "PermissionModel": { + "type": "string", + "description": "PermissionModel enum", + "enum": [ + "SELF_MANAGED", + "SERVICE_MANAGED" + ], + "x-ms-enum": { + "name": "PermissionModel", + "modelAsString": true, + "values": [ + { + "name": "SELF_MANAGED", + "value": "SELF_MANAGED", + "description": "PermissionModel enum SELF_MANAGED" + }, + { + "name": "SERVICE_MANAGED", + "value": "SERVICE_MANAGED", + "description": "PermissionModel enum SERVICE_MANAGED" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StackInstances": { + "type": "object", + "description": "Definition of StackInstances", + "properties": { + "deploymentTargets": { + "$ref": "#/definitions/DeploymentTargets", + "description": "The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions." + }, + "parameterOverrides": { + "type": "array", + "description": "A list of stack set parameters whose values you want to override in the selected stack instances.", + "items": { + "$ref": "#/definitions/Parameter" + }, + "x-ms-identifiers": [] + }, + "regions": { + "type": "array", + "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "A string used to identify this tag. You can specify a maximum of 127 characters for a tag key." + }, + "value": { + "type": "string", + "description": "A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFrontDistribution.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFrontDistribution.json new file mode 100644 index 000000000000..48bf399501da --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudFrontDistribution.json @@ -0,0 +1,1368 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CloudFrontDistributions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/cloudFrontDistributions": { + "get": { + "operationId": "CloudFrontDistributions_ListBySubscription", + "tags": [ + "CloudFrontDistributions" + ], + "description": "List CloudFrontDistribution resources 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/CloudFrontDistributionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFrontDistributions_ListBySubscription": { + "$ref": "./examples/CloudFrontDistributions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFrontDistributions": { + "get": { + "operationId": "CloudFrontDistributions_ListByResourceGroup", + "tags": [ + "CloudFrontDistributions" + ], + "description": "List CloudFrontDistribution resources 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/CloudFrontDistributionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFrontDistributions_ListByResourceGroup": { + "$ref": "./examples/CloudFrontDistributions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudFrontDistributions/{name}": { + "get": { + "operationId": "CloudFrontDistributions_Get", + "tags": [ + "CloudFrontDistributions" + ], + "description": "Get a CloudFrontDistribution", + "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": "name", + "in": "path", + "description": "Name of CloudFrontDistribution", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFrontDistribution" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFrontDistributions_Get": { + "$ref": "./examples/CloudFrontDistributions_Get.json" + } + } + }, + "put": { + "operationId": "CloudFrontDistributions_CreateOrReplace", + "tags": [ + "CloudFrontDistributions" + ], + "description": "Create a CloudFrontDistribution. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CloudFrontDistribution", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFrontDistribution" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudFrontDistribution' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFrontDistribution" + } + }, + "201": { + "description": "Resource 'CloudFrontDistribution' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudFrontDistribution" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CloudFrontDistributions_CreateOrReplace": { + "$ref": "./examples/CloudFrontDistributions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudFrontDistributions_Update", + "tags": [ + "CloudFrontDistributions" + ], + "description": "Update a CloudFrontDistribution", + "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": "name", + "in": "path", + "description": "Name of CloudFrontDistribution", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudFrontDistributionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudFrontDistribution" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudFrontDistributions_Update": { + "$ref": "./examples/CloudFrontDistributions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudFrontDistributions_Delete", + "tags": [ + "CloudFrontDistributions" + ], + "description": "Delete a CloudFrontDistribution", + "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": "name", + "in": "path", + "description": "Name of CloudFrontDistribution", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CloudFrontDistributions_Delete": { + "$ref": "./examples/CloudFrontDistributions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsCloudFrontDistributionProperties": { + "type": "object", + "description": "Definition of awsCloudFrontDistribution", + "properties": { + "distributionConfig": { + "$ref": "#/definitions/DistributionConfig", + "description": "The distribution's configuration. A distribution configuration." + }, + "domainName": { + "type": "string", + "description": "Property domainName" + }, + "id": { + "type": "string", + "description": "Property id" + }, + "tags": { + "type": "array", + "description": "A complex type that contains zero or more ``Tag`` elements.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "CacheBehavior": { + "type": "object", + "description": "Definition of CacheBehavior", + "properties": { + "allowedMethods": { + "type": "array", + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cachePolicyId": { + "type": "string", + "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." + }, + "cachedMethods": { + "type": "array", + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "compress": { + "type": "boolean", + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." + }, + "defaultTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "default": 86400 + }, + "fieldLevelEncryptionId": { + "type": "string", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior." + }, + "forwardedValues": { + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "functionAssociations": { + "type": "array", + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", + "items": { + "$ref": "#/definitions/FunctionAssociation" + }, + "x-ms-identifiers": [] + }, + "lambdaFunctionAssociations": { + "type": "array", + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", + "items": { + "$ref": "#/definitions/LambdaFunctionAssociation" + }, + "x-ms-identifiers": [] + }, + "maxTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "default": 31536000 + }, + "minTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." + }, + "originRequestPolicyId": { + "type": "string", + "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." + }, + "pathPattern": { + "type": "string", + "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*." + }, + "realtimeLogConfigArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." + }, + "responseHeadersPolicyId": { + "type": "string", + "description": "The identifier for a response headers policy." + }, + "smoothStreaming": { + "type": "boolean", + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." + }, + "targetOriginId": { + "type": "string", + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior." + }, + "trustedKeyGroups": { + "type": "array", + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "trustedSigners": { + "type": "array", + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "viewerProtocolPolicy": { + "type": "string", + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + "CloudFrontDistribution": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudFrontDistributionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudFrontDistributionListResult": { + "type": "object", + "description": "The response of a CloudFrontDistribution list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudFrontDistribution items on this page", + "items": { + "$ref": "#/definitions/CloudFrontDistribution" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudFrontDistributionProperties": { + "type": "object", + "description": "Definition of CloudFrontDistribution", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCloudFrontDistributionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CloudFrontDistributionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CloudFrontDistribution resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Cookies": { + "type": "object", + "description": "Definition of Cookies", + "properties": { + "forward": { + "type": "string", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element." + }, + "whitelistedNames": { + "type": "array", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "CustomErrorResponse": { + "type": "object", + "description": "Definition of CustomErrorResponse", + "properties": { + "errorCachingMinTTL": { + "type": "integer", + "format": "int32", + "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", + "default": 300 + }, + "errorCode": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration." + }, + "responseCode": { + "type": "integer", + "format": "int32", + "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``." + }, + "responsePagePath": { + "type": "string", + "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable." + } + } + }, + "CustomOriginConfig": { + "type": "object", + "description": "Definition of CustomOriginConfig", + "properties": { + "httpPort": { + "type": "integer", + "format": "int32", + "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.", + "default": 80 + }, + "httpsPort": { + "type": "integer", + "format": "int32", + "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.", + "default": 443 + }, + "originKeepaliveTimeout": { + "type": "integer", + "format": "int32", + "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.", + "default": 5 + }, + "originProtocolPolicy": { + "type": "string", + "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: + ``http-only`` – CloudFront always uses HTTP to connect to the origin. + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + ``https-only`` – CloudFront always uses HTTPS to connect to the origin." + }, + "originReadTimeout": { + "type": "integer", + "format": "int32", + "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.", + "default": 30 + }, + "originSSLProtocols": { + "type": "array", + "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DefaultCacheBehavior": { + "type": "object", + "description": "Definition of DefaultCacheBehavior", + "properties": { + "allowedMethods": { + "type": "array", + "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cachePolicyId": { + "type": "string", + "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." + }, + "cachedMethods": { + "type": "array", + "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "compress": { + "type": "boolean", + "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." + }, + "defaultTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "default": 86400 + }, + "fieldLevelEncryptionId": { + "type": "string", + "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior." + }, + "forwardedValues": { + "$ref": "#/definitions/ForwardedValues", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." + }, + "functionAssociations": { + "type": "array", + "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior.", + "items": { + "$ref": "#/definitions/FunctionAssociation" + }, + "x-ms-identifiers": [] + }, + "lambdaFunctionAssociations": { + "type": "array", + "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior.", + "items": { + "$ref": "#/definitions/LambdaFunctionAssociation" + }, + "x-ms-identifiers": [] + }, + "maxTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", + "default": 31536000 + }, + "minTTL": { + "type": "integer", + "format": "int32", + "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." + }, + "originRequestPolicyId": { + "type": "string", + "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." + }, + "realtimeLogConfigArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." + }, + "responseHeadersPolicyId": { + "type": "string", + "description": "The identifier for a response headers policy." + }, + "smoothStreaming": { + "type": "boolean", + "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." + }, + "targetOriginId": { + "type": "string", + "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior." + }, + "trustedKeyGroups": { + "type": "array", + "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "trustedSigners": { + "type": "array", + "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "viewerProtocolPolicy": { + "type": "string", + "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + "DistributionConfig": { + "type": "object", + "description": "Definition of DistributionConfig", + "properties": { + "aliases": { + "type": "array", + "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cnamEs": { + "type": "array", + "description": "Property cnamEs", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cacheBehaviors": { + "type": "array", + "description": "A complex type that contains zero or more ``CacheBehavior`` elements.", + "items": { + "$ref": "#/definitions/CacheBehavior" + }, + "x-ms-identifiers": [] + }, + "comment": { + "type": "string", + "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters." + }, + "continuousDeploymentPolicyId": { + "type": "string", + "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``." + }, + "customErrorResponses": { + "type": "array", + "description": "A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "$ref": "#/definitions/CustomErrorResponse" + }, + "x-ms-identifiers": [] + }, + "customOrigin": { + "$ref": "#/definitions/LegacyCustomOrigin", + "description": "Property customOrigin" + }, + "defaultCacheBehavior": { + "$ref": "#/definitions/DefaultCacheBehavior", + "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." + }, + "defaultRootObject": { + "type": "string", + "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*." + }, + "enabled": { + "type": "boolean", + "description": "From this field, you can enable or disable the selected distribution." + }, + "httpVersion": { + "type": "string", + "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://docs.aws.amazon.com/https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", + "default": "http1.1" + }, + "ipV6Enabled": { + "type": "boolean", + "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request." + }, + "logging": { + "$ref": "#/definitions/Logging", + "description": "A complex type that controls whether access logs are written for the distribution. For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. A complex type that controls whether access logs are written for the distribution." + }, + "originGroups": { + "$ref": "#/definitions/OriginGroups", + "description": "A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution." + }, + "origins": { + "type": "array", + "description": "A complex type that contains information about origins for this distribution.", + "items": { + "$ref": "#/definitions/Origin" + }, + "x-ms-identifiers": [] + }, + "priceClass": { + "type": "string", + "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://docs.aws.amazon.com/cloudfront/pricing/).", + "default": "PriceClass_All" + }, + "restrictions": { + "$ref": "#/definitions/Restrictions", + "description": "A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "s3Origin": { + "$ref": "#/definitions/LegacyS3Origin", + "description": "Property s3Origin" + }, + "staging": { + "type": "boolean", + "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution." + }, + "viewerCertificate": { + "$ref": "#/definitions/ViewerCertificate", + "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*." + }, + "webACLId": { + "type": "string", + "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)." + } + } + }, + "ForwardedValues": { + "type": "object", + "description": "Definition of ForwardedValues", + "properties": { + "cookies": { + "$ref": "#/definitions/Cookies", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." + }, + "headers": { + "type": "array", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "queryString": { + "type": "boolean", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*." + }, + "queryStringCacheKeys": { + "type": "array", + "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "FunctionAssociation": { + "type": "object", + "description": "Definition of FunctionAssociation", + "properties": { + "eventType": { + "type": "string", + "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function." + }, + "functionARN": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the function." + } + } + }, + "GeoRestriction": { + "type": "object", + "description": "Definition of GeoRestriction", + "properties": { + "locations": { + "type": "array", + "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content or not distribute your content.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "restrictionType": { + "type": "string", + "description": "The method that you want to use to restrict distribution of your content by country." + } + } + }, + "LambdaFunctionAssociation": { + "type": "object", + "description": "Definition of LambdaFunctionAssociation", + "properties": { + "eventType": { + "type": "string", + "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute." + }, + "includeBody": { + "type": "boolean", + "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide." + }, + "lambdaFunctionARN": { + "type": "string", + "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST." + } + } + }, + "LegacyCustomOrigin": { + "type": "object", + "description": "Definition of LegacyCustomOrigin", + "properties": { + "dnsName": { + "type": "string", + "description": "Property dnsName" + }, + "httpPort": { + "type": "integer", + "format": "int32", + "description": "Property httpPort", + "default": 80 + }, + "httpsPort": { + "type": "integer", + "format": "int32", + "description": "Property httpsPort", + "default": 443 + }, + "originProtocolPolicy": { + "type": "string", + "description": "Property originProtocolPolicy" + }, + "originSSLProtocols": { + "type": "array", + "description": "Property originSSLProtocols", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "LegacyS3Origin": { + "type": "object", + "description": "Definition of LegacyS3Origin", + "properties": { + "dnsName": { + "type": "string", + "description": "Property dnsName" + }, + "originAccessIdentity": { + "type": "string", + "description": "Property originAccessIdentity" + } + } + }, + "Logging": { + "type": "object", + "description": "Definition of Logging", + "properties": { + "bucket": { + "type": "string", + "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``." + }, + "includeCookies": { + "type": "boolean", + "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``." + }, + "prefix": { + "type": "string", + "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element." + } + } + }, + "Origin": { + "type": "object", + "description": "Definition of Origin", + "properties": { + "connectionAttempts": { + "type": "integer", + "format": "int32", + "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*." + }, + "connectionTimeout": { + "type": "integer", + "format": "int32", + "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*." + }, + "customOriginConfig": { + "$ref": "#/definitions/CustomOriginConfig", + "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin." + }, + "domainName": { + "type": "string", + "description": "The domain name for the origin. For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*." + }, + "id": { + "type": "string", + "description": "A unique identifier for the origin. This value must be unique within the distribution. Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``." + }, + "originAccessControlId": { + "type": "string", + "description": "The unique identifier of an origin access control for this origin. For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*." + }, + "originCustomHeaders": { + "type": "array", + "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*.", + "items": { + "$ref": "#/definitions/OriginCustomHeader" + }, + "x-ms-identifiers": [] + }, + "originPath": { + "type": "string", + "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*." + }, + "originShield": { + "$ref": "#/definitions/OriginShield", + "description": "CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*." + }, + "s3OriginConfig": { + "$ref": "#/definitions/S3OriginConfig", + "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead." + } + } + }, + "OriginCustomHeader": { + "type": "object", + "description": "Definition of OriginCustomHeader", + "properties": { + "headerName": { + "type": "string", + "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*." + }, + "headerValue": { + "type": "string", + "description": "The value for the header that you specified in the ``HeaderName`` field." + } + } + }, + "OriginGroup": { + "type": "object", + "description": "Definition of OriginGroup", + "properties": { + "failoverCriteria": { + "$ref": "#/definitions/OriginGroupFailoverCriteria", + "description": "A complex type that contains information about the failover criteria for an origin group. A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin." + }, + "id": { + "type": "string", + "description": "The origin group's ID." + }, + "members": { + "$ref": "#/definitions/OriginGroupMembers", + "description": "A complex type that contains information about the origins in an origin group. A complex data type for the origins included in an origin group." + } + } + }, + "OriginGroupFailoverCriteria": { + "type": "object", + "description": "Definition of OriginGroupFailoverCriteria", + "properties": { + "statusCodes": { + "$ref": "#/definitions/StatusCodes", + "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin." + } + } + }, + "OriginGroupMember": { + "type": "object", + "description": "Definition of OriginGroupMember", + "properties": { + "originId": { + "type": "string", + "description": "The ID for an origin in an origin group." + } + } + }, + "OriginGroupMembers": { + "type": "object", + "description": "Definition of OriginGroupMembers", + "properties": { + "items": { + "type": "array", + "description": "Items (origins) in an origin group.", + "items": { + "$ref": "#/definitions/OriginGroupMember" + }, + "x-ms-identifiers": [] + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The number of origins in an origin group." + } + } + }, + "OriginGroups": { + "type": "object", + "description": "Definition of OriginGroups", + "properties": { + "items": { + "type": "array", + "description": "The items (origin groups) in a distribution.", + "items": { + "$ref": "#/definitions/OriginGroup" + }, + "x-ms-identifiers": [] + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The number of origin groups." + } + } + }, + "OriginShield": { + "type": "object", + "description": "Definition of OriginShield", + "properties": { + "enabled": { + "type": "boolean", + "description": "A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches." + }, + "originShieldRegion": { + "type": "string", + "description": "The AWS-Region for Origin Shield. Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Restrictions": { + "type": "object", + "description": "Definition of Restrictions", + "properties": { + "geoRestriction": { + "$ref": "#/definitions/GeoRestriction", + "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." + } + } + }, + "S3OriginConfig": { + "type": "object", + "description": "Definition of S3OriginConfig", + "properties": { + "originAccessIdentity": { + "type": "string", + "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: origin-access-identity/cloudfront/*ID-of-origin-access-identity* where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." + } + } + }, + "StatusCodes": { + "type": "object", + "description": "Definition of StatusCodes", + "properties": { + "items": { + "type": "array", + "description": "The items (status codes) for an origin group.", + "items": { + "type": "integer", + "format": "int32" + }, + "x-ms-identifiers": [] + }, + "quantity": { + "type": "integer", + "format": "int32", + "description": "The number of status codes." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "A string that contains ``Tag`` key. The string length should be between 1 and 128 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``." + }, + "value": { + "type": "string", + "description": "A string that contains an optional ``Tag`` value. The string length should be between 0 and 256 characters. Valid characters include ``a-z``, ``A-Z``, ``0-9``, space, and the special characters ``_ - . : / = + @``." + } + } + }, + "ViewerCertificate": { + "type": "object", + "description": "Definition of ViewerCertificate", + "properties": { + "acmCertificateArn": { + "type": "string", + "description": "In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``). If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)" + }, + "cloudFrontDefaultCertificate": { + "type": "boolean", + "description": "If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields: + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + ``MinimumProtocolVersion`` + ``SslSupportMethod``" + }, + "iamCertificateId": { + "type": "string", + "description": "In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.)" + }, + "minimumProtocolVersion": { + "type": "string", + "description": "If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings: + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. + The ciphers that CloudFront can use to encrypt the content that it returns to viewers. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*. On the CloudFront console, this setting is called *Security Policy*. When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here." + }, + "sslSupportMethod": { + "type": "string", + "description": "In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from. + ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. + ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://docs.aws.amazon.com/support/home). If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudTrailTrail.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudTrailTrail.json new file mode 100644 index 000000000000..960ef264e9c0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudTrailTrail.json @@ -0,0 +1,808 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CloudTrailTrails" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/cloudTrailTrails": { + "get": { + "operationId": "CloudTrailTrails_ListBySubscription", + "tags": [ + "CloudTrailTrails" + ], + "description": "List CloudTrailTrail resources 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/CloudTrailTrailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudTrailTrails_ListBySubscription": { + "$ref": "./examples/CloudTrailTrails_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudTrailTrails": { + "get": { + "operationId": "CloudTrailTrails_ListByResourceGroup", + "tags": [ + "CloudTrailTrails" + ], + "description": "List CloudTrailTrail resources 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/CloudTrailTrailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudTrailTrails_ListByResourceGroup": { + "$ref": "./examples/CloudTrailTrails_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudTrailTrails/{name}": { + "get": { + "operationId": "CloudTrailTrails_Get", + "tags": [ + "CloudTrailTrails" + ], + "description": "Get a CloudTrailTrail", + "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": "name", + "in": "path", + "description": "Name of CloudTrailTrail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudTrailTrail" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudTrailTrails_Get": { + "$ref": "./examples/CloudTrailTrails_Get.json" + } + } + }, + "put": { + "operationId": "CloudTrailTrails_CreateOrReplace", + "tags": [ + "CloudTrailTrails" + ], + "description": "Create a CloudTrailTrail. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CloudTrailTrail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudTrailTrail" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudTrailTrail' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudTrailTrail" + } + }, + "201": { + "description": "Resource 'CloudTrailTrail' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudTrailTrail" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CloudTrailTrails_CreateOrReplace": { + "$ref": "./examples/CloudTrailTrails_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudTrailTrails_Update", + "tags": [ + "CloudTrailTrails" + ], + "description": "Update a CloudTrailTrail", + "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": "name", + "in": "path", + "description": "Name of CloudTrailTrail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudTrailTrailTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudTrailTrail" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudTrailTrails_Update": { + "$ref": "./examples/CloudTrailTrails_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudTrailTrails_Delete", + "tags": [ + "CloudTrailTrails" + ], + "description": "Delete a CloudTrailTrail", + "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": "name", + "in": "path", + "description": "Name of CloudTrailTrail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CloudTrailTrails_Delete": { + "$ref": "./examples/CloudTrailTrails_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdvancedEventSelector": { + "type": "object", + "description": "Definition of AdvancedEventSelector", + "properties": { + "fieldSelectors": { + "type": "array", + "description": "Contains all selector statements in an advanced event selector.", + "items": { + "$ref": "#/definitions/AdvancedFieldSelector" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "An optional, descriptive name for an advanced event selector, such as 'Log data events for only two S3 buckets'." + } + } + }, + "AdvancedFieldSelector": { + "type": "object", + "description": "Definition of AdvancedFieldSelector", + "properties": { + "endsWith": { + "type": "array", + "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "equals": { + "type": "array", + "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "field": { + "type": "string", + "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN." + }, + "notEndsWith": { + "type": "array", + "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "notEquals": { + "type": "array", + "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "notStartsWith": { + "type": "array", + "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "startsWith": { + "type": "array", + "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "AwsCloudTrailTrailProperties": { + "type": "object", + "description": "Definition of awsCloudTrailTrail", + "properties": { + "advancedEventSelectors": { + "type": "array", + "description": "The advanced event selectors that were used to select events for the data store.", + "items": { + "$ref": "#/definitions/AdvancedEventSelector" + }, + "x-ms-identifiers": [] + }, + "arn": { + "type": "string", + "description": "Property arn" + }, + "cloudWatchLogsLogGroupArn": { + "type": "string", + "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn." + }, + "cloudWatchLogsRoleArn": { + "type": "string", + "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group." + }, + "enableLogFileValidation": { + "type": "boolean", + "description": "Specifies whether log file validation is enabled. The default is false." + }, + "eventSelectors": { + "type": "array", + "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail.", + "items": { + "$ref": "#/definitions/EventSelector" + }, + "x-ms-identifiers": [] + }, + "includeGlobalServiceEvents": { + "type": "boolean", + "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files." + }, + "insightSelectors": { + "type": "array", + "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail.", + "items": { + "$ref": "#/definitions/InsightSelector" + }, + "x-ms-identifiers": [] + }, + "isLogging": { + "type": "boolean", + "description": "Whether the CloudTrail is currently logging AWS API calls." + }, + "isMultiRegionTrail": { + "type": "boolean", + "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions." + }, + "isOrganizationTrail": { + "type": "boolean", + "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations." + }, + "kmsKeyId": { + "type": "string", + "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier." + }, + "s3BucketName": { + "type": "string", + "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements." + }, + "s3KeyPrefix": { + "type": "string", + "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters." + }, + "snsTopicArn": { + "type": "string", + "description": "Property snsTopicArn" + }, + "snsTopicName": { + "type": "string", + "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters." + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "trailName": { + "type": "string", + "description": "Property trailName" + } + } + }, + "CloudTrailTrail": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudTrailTrailProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudTrailTrailListResult": { + "type": "object", + "description": "The response of a CloudTrailTrail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudTrailTrail items on this page", + "items": { + "$ref": "#/definitions/CloudTrailTrail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudTrailTrailProperties": { + "type": "object", + "description": "Definition of CloudTrailTrail", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCloudTrailTrailProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CloudTrailTrailTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CloudTrailTrail resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DataResource": { + "type": "object", + "description": "Definition of DataResource", + "properties": { + "type": { + "type": "string", + "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources." + }, + "values": { + "type": "array", + "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "EventSelector": { + "type": "object", + "description": "Definition of EventSelector", + "properties": { + "dataResources": { + "type": "array", + "description": "Property dataResources", + "items": { + "$ref": "#/definitions/DataResource" + }, + "x-ms-identifiers": [] + }, + "excludeManagementEventSources": { + "type": "array", + "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing 'kms.amazonaws.com'. By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "includeManagementEvents": { + "type": "boolean", + "description": "Specify if you want your event selector to include management events for your trail." + }, + "readWriteType": { + "$ref": "#/definitions/EventSelectorReadWriteType", + "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation." + } + } + }, + "EventSelectorReadWriteType": { + "type": "string", + "description": "EventSelectorReadWriteType enum", + "enum": [ + "All", + "ReadOnly", + "WriteOnly" + ], + "x-ms-enum": { + "name": "EventSelectorReadWriteType", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "EventSelectorReadWriteType enum All" + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "EventSelectorReadWriteType enum ReadOnly" + }, + { + "name": "WriteOnly", + "value": "WriteOnly", + "description": "EventSelectorReadWriteType enum WriteOnly" + } + ] + } + }, + "InsightSelector": { + "type": "object", + "description": "Definition of InsightSelector", + "properties": { + "insightType": { + "type": "string", + "description": "The type of insight to log on a trail." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudWatchAlarm.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudWatchAlarm.json new file mode 100644 index 000000000000..1458b8b49783 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/cloudWatchAlarm.json @@ -0,0 +1,771 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CloudWatchAlarms" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/cloudWatchAlarms": { + "get": { + "operationId": "CloudWatchAlarms_ListBySubscription", + "tags": [ + "CloudWatchAlarms" + ], + "description": "List CloudWatchAlarm resources 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/CloudWatchAlarmListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudWatchAlarms_ListBySubscription": { + "$ref": "./examples/CloudWatchAlarms_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudWatchAlarms": { + "get": { + "operationId": "CloudWatchAlarms_ListByResourceGroup", + "tags": [ + "CloudWatchAlarms" + ], + "description": "List CloudWatchAlarm resources 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/CloudWatchAlarmListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudWatchAlarms_ListByResourceGroup": { + "$ref": "./examples/CloudWatchAlarms_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/cloudWatchAlarms/{name}": { + "get": { + "operationId": "CloudWatchAlarms_Get", + "tags": [ + "CloudWatchAlarms" + ], + "description": "Get a CloudWatchAlarm", + "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": "name", + "in": "path", + "description": "Name of CloudWatchAlarm", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudWatchAlarm" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudWatchAlarms_Get": { + "$ref": "./examples/CloudWatchAlarms_Get.json" + } + } + }, + "put": { + "operationId": "CloudWatchAlarms_CreateOrReplace", + "tags": [ + "CloudWatchAlarms" + ], + "description": "Create a CloudWatchAlarm. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CloudWatchAlarm", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudWatchAlarm" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CloudWatchAlarm' update operation succeeded", + "schema": { + "$ref": "#/definitions/CloudWatchAlarm" + } + }, + "201": { + "description": "Resource 'CloudWatchAlarm' create operation succeeded", + "schema": { + "$ref": "#/definitions/CloudWatchAlarm" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CloudWatchAlarms_CreateOrReplace": { + "$ref": "./examples/CloudWatchAlarms_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CloudWatchAlarms_Update", + "tags": [ + "CloudWatchAlarms" + ], + "description": "Update a CloudWatchAlarm", + "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": "name", + "in": "path", + "description": "Name of CloudWatchAlarm", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudWatchAlarmTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CloudWatchAlarm" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CloudWatchAlarms_Update": { + "$ref": "./examples/CloudWatchAlarms_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CloudWatchAlarms_Delete", + "tags": [ + "CloudWatchAlarms" + ], + "description": "Delete a CloudWatchAlarm", + "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": "name", + "in": "path", + "description": "Name of CloudWatchAlarm", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CloudWatchAlarms_Delete": { + "$ref": "./examples/CloudWatchAlarms_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsCloudWatchAlarmProperties": { + "type": "object", + "description": "Definition of awsCloudWatchAlarm", + "properties": { + "actionsEnabled": { + "type": "boolean", + "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", + "default": true + }, + "alarmActions": { + "type": "array", + "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "alarmDescription": { + "type": "string", + "description": "The description of the alarm." + }, + "alarmName": { + "type": "string", + "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "arn": { + "type": "string", + "description": "Property arn" + }, + "comparisonOperator": { + "type": "string", + "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand." + }, + "datapointsToAlarm": { + "type": "integer", + "format": "int32", + "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an 'M out of N' alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching." + }, + "dimensions": { + "type": "array", + "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``.", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [] + }, + "evaluateLowSampleCountPercentile": { + "type": "string", + "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available." + }, + "evaluationPeriods": { + "type": "integer", + "format": "int32", + "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an 'M out of N' alarm, this value is the N, and ``DatapointsToAlarm`` is the M. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*." + }, + "extendedStatistic": { + "type": "string", + "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``." + }, + "insufficientDataActions": { + "type": "array", + "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "metricName": { + "type": "string", + "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``." + }, + "metrics": { + "type": "array", + "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``.", + "items": { + "$ref": "#/definitions/MetricDataQuery" + }, + "x-ms-identifiers": [] + }, + "namespace": { + "type": "string", + "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)" + }, + "okActions": { + "type": "array", + "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "period": { + "type": "integer", + "format": "int32", + "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. *Minimum:* 10" + }, + "statistic": { + "type": "string", + "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``." + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "threshold": { + "type": "number", + "format": "float", + "description": "The value to compare with the specified statistic." + }, + "thresholdMetricId": { + "type": "string", + "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm." + }, + "treatMissingData": { + "type": "string", + "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. If you omit this parameter, the default behavior of ``missing`` is used." + }, + "unit": { + "type": "string", + "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." + } + } + }, + "CloudWatchAlarm": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CloudWatchAlarmProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CloudWatchAlarmListResult": { + "type": "object", + "description": "The response of a CloudWatchAlarm list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CloudWatchAlarm items on this page", + "items": { + "$ref": "#/definitions/CloudWatchAlarm" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CloudWatchAlarmProperties": { + "type": "object", + "description": "Definition of CloudWatchAlarm", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCloudWatchAlarmProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CloudWatchAlarmTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CloudWatchAlarm resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Dimension": { + "type": "object", + "description": "Definition of Dimension", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published." + }, + "value": { + "type": "string", + "description": "The value for the dimension, from 1–255 characters in length." + } + } + }, + "Metric": { + "type": "object", + "description": "Definition of Metric", + "properties": { + "dimensions": { + "type": "array", + "description": "The metric dimensions that you want to be used for the metric that the alarm will watch.", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [] + }, + "metricName": { + "type": "string", + "description": "The name of the metric that you want the alarm to watch. This is a required field." + }, + "namespace": { + "type": "string", + "description": "The namespace of the metric that the alarm will watch." + } + } + }, + "MetricDataQuery": { + "type": "object", + "description": "Definition of MetricDataQuery", + "properties": { + "accountId": { + "type": "string", + "description": "The ID of the account where the metrics are located, if this is a cross-account alarm." + }, + "expression": { + "type": "string", + "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." + }, + "id": { + "type": "string", + "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter." + }, + "label": { + "type": "string", + "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default." + }, + "metricStat": { + "$ref": "#/definitions/MetricStat", + "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. This structure defines the metric to be returned, along with the statistics, period, and units. ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type." + }, + "period": { + "type": "integer", + "format": "int32", + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``." + }, + "returnData": { + "type": "boolean", + "description": "This option indicates whether to return the timestamps and raw data values of this metric. When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. This field is required." + } + } + }, + "MetricStat": { + "type": "object", + "description": "Definition of MetricStat", + "properties": { + "metric": { + "$ref": "#/definitions/Metric", + "description": "The metric to return, including the metric name, namespace, and dimensions. The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type." + }, + "period": { + "type": "integer", + "format": "int32", + "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour)." + }, + "stat": { + "type": "string", + "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*." + }, + "unit": { + "type": "string", + "description": "The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "A unique identifier for the tag. The combination of tag keys and values can help you organize and categorize your resources." + }, + "value": { + "type": "string", + "description": "The value for the specified tag key." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildProject.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildProject.json new file mode 100644 index 000000000000..d553b16724d0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildProject.json @@ -0,0 +1,2007 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CodeBuildProjects" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/codeBuildProjects": { + "get": { + "operationId": "CodeBuildProjects_ListBySubscription", + "tags": [ + "CodeBuildProjects" + ], + "description": "List CodeBuildProject resources 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/CodeBuildProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildProjects_ListBySubscription": { + "$ref": "./examples/CodeBuildProjects_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildProjects": { + "get": { + "operationId": "CodeBuildProjects_ListByResourceGroup", + "tags": [ + "CodeBuildProjects" + ], + "description": "List CodeBuildProject resources 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/CodeBuildProjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildProjects_ListByResourceGroup": { + "$ref": "./examples/CodeBuildProjects_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildProjects/{name}": { + "get": { + "operationId": "CodeBuildProjects_Get", + "tags": [ + "CodeBuildProjects" + ], + "description": "Get a CodeBuildProject", + "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": "name", + "in": "path", + "description": "Name of CodeBuildProject", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeBuildProject" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildProjects_Get": { + "$ref": "./examples/CodeBuildProjects_Get.json" + } + } + }, + "put": { + "operationId": "CodeBuildProjects_CreateOrReplace", + "tags": [ + "CodeBuildProjects" + ], + "description": "Create a CodeBuildProject. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CodeBuildProject", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBuildProject" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CodeBuildProject' update operation succeeded", + "schema": { + "$ref": "#/definitions/CodeBuildProject" + } + }, + "201": { + "description": "Resource 'CodeBuildProject' create operation succeeded", + "schema": { + "$ref": "#/definitions/CodeBuildProject" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CodeBuildProjects_CreateOrReplace": { + "$ref": "./examples/CodeBuildProjects_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CodeBuildProjects_Update", + "tags": [ + "CodeBuildProjects" + ], + "description": "Update a CodeBuildProject", + "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": "name", + "in": "path", + "description": "Name of CodeBuildProject", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBuildProjectTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeBuildProject" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildProjects_Update": { + "$ref": "./examples/CodeBuildProjects_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CodeBuildProjects_Delete", + "tags": [ + "CodeBuildProjects" + ], + "description": "Delete a CodeBuildProject", + "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": "name", + "in": "path", + "description": "Name of CodeBuildProject", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CodeBuildProjects_Delete": { + "$ref": "./examples/CodeBuildProjects_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ArtifactNamespace": { + "type": "string", + "description": "ArtifactNamespace enum", + "enum": [ + "BUILD_ID", + "NONE" + ], + "x-ms-enum": { + "name": "ArtifactNamespace", + "modelAsString": true, + "values": [ + { + "name": "BUILD_ID", + "value": "BUILD_ID", + "description": "ArtifactNamespace enum BUILD_ID" + }, + { + "name": "NONE", + "value": "NONE", + "description": "ArtifactNamespace enum NONE" + } + ] + } + }, + "ArtifactNamespaceEnumValue": { + "type": "object", + "description": "Definition of ArtifactNamespaceEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ArtifactNamespace", + "description": "Property value" + } + } + }, + "ArtifactPackaging": { + "type": "string", + "description": "ArtifactPackaging enum", + "enum": [ + "NONE", + "ZIP" + ], + "x-ms-enum": { + "name": "ArtifactPackaging", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "ArtifactPackaging enum NONE" + }, + { + "name": "ZIP", + "value": "ZIP", + "description": "ArtifactPackaging enum ZIP" + } + ] + } + }, + "ArtifactPackagingEnumValue": { + "type": "object", + "description": "Definition of ArtifactPackagingEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ArtifactPackaging", + "description": "Property value" + } + } + }, + "ArtifactsType": { + "type": "string", + "description": "ArtifactsType enum", + "enum": [ + "CODEPIPELINE", + "NO_ARTIFACTS", + "S3" + ], + "x-ms-enum": { + "name": "ArtifactsType", + "modelAsString": true, + "values": [ + { + "name": "CODEPIPELINE", + "value": "CODEPIPELINE", + "description": "ArtifactsType enum CODEPIPELINE" + }, + { + "name": "NO_ARTIFACTS", + "value": "NO_ARTIFACTS", + "description": "ArtifactsType enum NO_ARTIFACTS" + }, + { + "name": "S3", + "value": "S3", + "description": "ArtifactsType enum S3" + } + ] + } + }, + "ArtifactsTypeEnumValue": { + "type": "object", + "description": "Definition of ArtifactsTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ArtifactsType", + "description": "Property value" + } + } + }, + "AwsCodeBuildProjectProperties": { + "type": "object", + "description": "Definition of awsCodeBuildProject", + "properties": { + "arn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the build project.</p>" + }, + "artifacts": { + "$ref": "#/definitions/ProjectArtifacts", + "description": "<p>Information about the build output artifacts for the build project.</p>" + }, + "badge": { + "$ref": "#/definitions/ProjectBadge", + "description": "<p>Information about the build badge for the build project.</p>" + }, + "buildBatchConfig": { + "$ref": "#/definitions/ProjectBuildBatchConfig", + "description": "<p>A <a>ProjectBuildBatchConfig</a> object that defines the batch build options for the project.</p>" + }, + "cache": { + "$ref": "#/definitions/ProjectCache", + "description": "<p>Information about the cache for the build project.</p>" + }, + "concurrentBuildLimit": { + "type": "integer", + "format": "int32", + "description": "<p>The maximum number of concurrent builds that are allowed for this project.</p> <p>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</p>" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "<p>When the build project was created, expressed in Unix time format.</p>" + }, + "description": { + "type": "string", + "description": "<p>A description that makes the build project easy to identify.</p>" + }, + "encryptionKey": { + "type": "string", + "description": "<p>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). </p>" + }, + "environment": { + "$ref": "#/definitions/ProjectEnvironment", + "description": "<p>Information about the build environment for this build project.</p>" + }, + "fileSystemLocations": { + "type": "array", + "description": "<p> An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </p>", + "items": { + "$ref": "#/definitions/ProjectFileSystemLocation" + }, + "x-ms-identifiers": [] + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "<p>When the build project's settings were last modified, expressed in Unix time format.</p>" + }, + "logsConfig": { + "$ref": "#/definitions/LogsConfig", + "description": "<p>Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. </p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the build project.</p>" + }, + "projectVisibility": { + "$ref": "#/definitions/ProjectVisibilityTypeEnumValue", + "description": "Property projectVisibility" + }, + "publicProjectAlias": { + "type": "string", + "description": "<p>Contains the project identifier used with the public build APIs. </p>" + }, + "queuedTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "<p>The number of minutes a build is allowed to be queued before it times out. </p>" + }, + "resourceAccessRole": { + "type": "string", + "description": "<p>The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.</p>" + }, + "secondaryArtifacts": { + "type": "array", + "description": "<p>An array of <code>ProjectArtifacts</code> objects. </p>", + "items": { + "$ref": "#/definitions/ProjectArtifacts" + }, + "x-ms-identifiers": [] + }, + "secondarySourceVersions": { + "type": "array", + "description": "<p>An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). </p>", + "items": { + "$ref": "#/definitions/ProjectSourceVersion" + }, + "x-ms-identifiers": [] + }, + "secondarySources": { + "type": "array", + "description": "<p>An array of <code>ProjectSource</code> objects. </p>", + "items": { + "$ref": "#/definitions/ProjectSource" + }, + "x-ms-identifiers": [] + }, + "serviceRole": { + "type": "string", + "description": "<p>The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.</p>" + }, + "source": { + "$ref": "#/definitions/ProjectSource", + "description": "<p>Information about the build input source code for this build project.</p>" + }, + "sourceVersion": { + "type": "string", + "description": "<p>A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p>If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </p> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'>Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>" + }, + "tags": { + "type": "array", + "description": "<p>A list of tag key and value pairs associated with this build project.</p> <p>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "timeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "<p>How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.</p>" + }, + "vpcConfig": { + "$ref": "#/definitions/VpcConfig", + "description": "<p>Information about the VPC configuration that CodeBuild accesses.</p>" + }, + "webhook": { + "$ref": "#/definitions/Webhook", + "description": "<p>Information about a webhook that connects repository events to a build project in CodeBuild.</p>" + } + } + }, + "BatchReportModeType": { + "type": "string", + "description": "BatchReportModeType enum", + "enum": [ + "REPORT_AGGREGATED_BATCH", + "REPORT_INDIVIDUAL_BUILDS" + ], + "x-ms-enum": { + "name": "BatchReportModeType", + "modelAsString": true, + "values": [ + { + "name": "REPORT_AGGREGATED_BATCH", + "value": "REPORT_AGGREGATED_BATCH", + "description": "BatchReportModeType enum REPORT_AGGREGATED_BATCH" + }, + { + "name": "REPORT_INDIVIDUAL_BUILDS", + "value": "REPORT_INDIVIDUAL_BUILDS", + "description": "BatchReportModeType enum REPORT_INDIVIDUAL_BUILDS" + } + ] + } + }, + "BatchReportModeTypeEnumValue": { + "type": "object", + "description": "Definition of BatchReportModeTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/BatchReportModeType", + "description": "Property value" + } + } + }, + "BatchRestrictions": { + "type": "object", + "description": "Definition of BatchRestrictions", + "properties": { + "computeTypesAllowed": { + "type": "array", + "description": "<p>An array of strings that specify the compute types that are allowed for the batch build. See <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build environment compute types</a> in the <i>CodeBuild User Guide</i> for these values. </p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "maximumBuildsAllowed": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the maximum number of builds allowed.</p>" + } + } + }, + "BucketOwnerAccess": { + "type": "string", + "description": "BucketOwnerAccess enum", + "enum": [ + "FULL", + "NONE", + "READ_ONLY" + ], + "x-ms-enum": { + "name": "BucketOwnerAccess", + "modelAsString": true, + "values": [ + { + "name": "FULL", + "value": "FULL", + "description": "BucketOwnerAccess enum FULL" + }, + { + "name": "NONE", + "value": "NONE", + "description": "BucketOwnerAccess enum NONE" + }, + { + "name": "READ_ONLY", + "value": "READ_ONLY", + "description": "BucketOwnerAccess enum READ_ONLY" + } + ] + } + }, + "BucketOwnerAccessEnumValue": { + "type": "object", + "description": "Definition of BucketOwnerAccessEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/BucketOwnerAccess", + "description": "Property value" + } + } + }, + "BuildStatusConfig": { + "type": "object", + "description": "Definition of BuildStatusConfig", + "properties": { + "context": { + "type": "string", + "description": "<p>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'>build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'>Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>" + }, + "targetUrl": { + "type": "string", + "description": "<p>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</p> <dl> <dt>Bitbucket</dt> <dd> <p>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'>build</a> in the Bitbucket API documentation.</p> </dd> <dt>GitHub/GitHub Enterprise Server</dt> <dd> <p>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'>Create a commit status</a> in the GitHub developer guide.</p> </dd> </dl>" + } + } + }, + "CacheMode": { + "type": "string", + "description": "CacheMode enum", + "enum": [ + "LOCAL_CUSTOM_CACHE", + "LOCAL_DOCKER_LAYER_CACHE", + "LOCAL_SOURCE_CACHE" + ], + "x-ms-enum": { + "name": "CacheMode", + "modelAsString": true, + "values": [ + { + "name": "LOCAL_CUSTOM_CACHE", + "value": "LOCAL_CUSTOM_CACHE", + "description": "CacheMode enum LOCAL_CUSTOM_CACHE" + }, + { + "name": "LOCAL_DOCKER_LAYER_CACHE", + "value": "LOCAL_DOCKER_LAYER_CACHE", + "description": "CacheMode enum LOCAL_DOCKER_LAYER_CACHE" + }, + { + "name": "LOCAL_SOURCE_CACHE", + "value": "LOCAL_SOURCE_CACHE", + "description": "CacheMode enum LOCAL_SOURCE_CACHE" + } + ] + } + }, + "CacheModeEnumValue": { + "type": "object", + "description": "Definition of CacheModeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CacheMode", + "description": "Property value" + } + } + }, + "CacheType": { + "type": "string", + "description": "CacheType enum", + "enum": [ + "LOCAL", + "NO_CACHE", + "S3" + ], + "x-ms-enum": { + "name": "CacheType", + "modelAsString": true, + "values": [ + { + "name": "LOCAL", + "value": "LOCAL", + "description": "CacheType enum LOCAL" + }, + { + "name": "NO_CACHE", + "value": "NO_CACHE", + "description": "CacheType enum NO_CACHE" + }, + { + "name": "S3", + "value": "S3", + "description": "CacheType enum S3" + } + ] + } + }, + "CacheTypeEnumValue": { + "type": "object", + "description": "Definition of CacheTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CacheType", + "description": "Property value" + } + } + }, + "CloudWatchLogsConfig": { + "type": "object", + "description": "Definition of CloudWatchLogsConfig", + "properties": { + "groupName": { + "type": "string", + "description": "<p> The group name of the logs in CloudWatch Logs. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'>Working with Log Groups and Log Streams</a>. </p>" + }, + "status": { + "$ref": "#/definitions/LogsConfigStatusTypeEnumValue", + "description": "<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>" + }, + "streamName": { + "type": "string", + "description": "<p> The prefix of the stream name of the CloudWatch Logs. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'>Working with Log Groups and Log Streams</a>. </p>" + } + } + }, + "CodeBuildProject": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CodeBuildProjectProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CodeBuildProjectListResult": { + "type": "object", + "description": "The response of a CodeBuildProject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CodeBuildProject items on this page", + "items": { + "$ref": "#/definitions/CodeBuildProject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CodeBuildProjectProperties": { + "type": "object", + "description": "Definition of CodeBuildProject", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCodeBuildProjectProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CodeBuildProjectTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CodeBuildProject resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ComputeType": { + "type": "string", + "description": "ComputeType enum", + "enum": [ + "BUILD_GENERAL1_2XLARGE", + "BUILD_GENERAL1_LARGE", + "BUILD_GENERAL1_MEDIUM", + "BUILD_GENERAL1_SMALL", + "BUILD_GENERAL1_XLARGE", + "BUILD_LAMBDA_10GB", + "BUILD_LAMBDA_1GB", + "BUILD_LAMBDA_2GB", + "BUILD_LAMBDA_4GB", + "BUILD_LAMBDA_8GB" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true, + "values": [ + { + "name": "BUILD_GENERAL1_2XLARGE", + "value": "BUILD_GENERAL1_2XLARGE", + "description": "ComputeType enum BUILD_GENERAL1_2XLARGE" + }, + { + "name": "BUILD_GENERAL1_LARGE", + "value": "BUILD_GENERAL1_LARGE", + "description": "ComputeType enum BUILD_GENERAL1_LARGE" + }, + { + "name": "BUILD_GENERAL1_MEDIUM", + "value": "BUILD_GENERAL1_MEDIUM", + "description": "ComputeType enum BUILD_GENERAL1_MEDIUM" + }, + { + "name": "BUILD_GENERAL1_SMALL", + "value": "BUILD_GENERAL1_SMALL", + "description": "ComputeType enum BUILD_GENERAL1_SMALL" + }, + { + "name": "BUILD_GENERAL1_XLARGE", + "value": "BUILD_GENERAL1_XLARGE", + "description": "ComputeType enum BUILD_GENERAL1_XLARGE" + }, + { + "name": "BUILD_LAMBDA_10GB", + "value": "BUILD_LAMBDA_10GB", + "description": "ComputeType enum BUILD_LAMBDA_10GB" + }, + { + "name": "BUILD_LAMBDA_1GB", + "value": "BUILD_LAMBDA_1GB", + "description": "ComputeType enum BUILD_LAMBDA_1GB" + }, + { + "name": "BUILD_LAMBDA_2GB", + "value": "BUILD_LAMBDA_2GB", + "description": "ComputeType enum BUILD_LAMBDA_2GB" + }, + { + "name": "BUILD_LAMBDA_4GB", + "value": "BUILD_LAMBDA_4GB", + "description": "ComputeType enum BUILD_LAMBDA_4GB" + }, + { + "name": "BUILD_LAMBDA_8GB", + "value": "BUILD_LAMBDA_8GB", + "description": "ComputeType enum BUILD_LAMBDA_8GB" + } + ] + } + }, + "ComputeTypeEnumValue": { + "type": "object", + "description": "Definition of ComputeTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ComputeType", + "description": "Property value" + } + } + }, + "CredentialProviderType": { + "type": "string", + "description": "CredentialProviderType enum", + "enum": [ + "SECRETS_MANAGER" + ], + "x-ms-enum": { + "name": "CredentialProviderType", + "modelAsString": true, + "values": [ + { + "name": "SECRETS_MANAGER", + "value": "SECRETS_MANAGER", + "description": "CredentialProviderType enum SECRETS_MANAGER" + } + ] + } + }, + "CredentialProviderTypeEnumValue": { + "type": "object", + "description": "Definition of CredentialProviderTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CredentialProviderType", + "description": "Property value" + } + } + }, + "EnvironmentType": { + "type": "string", + "description": "EnvironmentType enum", + "enum": [ + "ARM_CONTAINER", + "ARM_LAMBDA_CONTAINER", + "LINUX_CONTAINER", + "LINUX_GPU_CONTAINER", + "LINUX_LAMBDA_CONTAINER", + "WINDOWS_CONTAINER", + "WINDOWS_SERVER_2019_CONTAINER" + ], + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true, + "values": [ + { + "name": "ARM_CONTAINER", + "value": "ARM_CONTAINER", + "description": "EnvironmentType enum ARM_CONTAINER" + }, + { + "name": "ARM_LAMBDA_CONTAINER", + "value": "ARM_LAMBDA_CONTAINER", + "description": "EnvironmentType enum ARM_LAMBDA_CONTAINER" + }, + { + "name": "LINUX_CONTAINER", + "value": "LINUX_CONTAINER", + "description": "EnvironmentType enum LINUX_CONTAINER" + }, + { + "name": "LINUX_GPU_CONTAINER", + "value": "LINUX_GPU_CONTAINER", + "description": "EnvironmentType enum LINUX_GPU_CONTAINER" + }, + { + "name": "LINUX_LAMBDA_CONTAINER", + "value": "LINUX_LAMBDA_CONTAINER", + "description": "EnvironmentType enum LINUX_LAMBDA_CONTAINER" + }, + { + "name": "WINDOWS_CONTAINER", + "value": "WINDOWS_CONTAINER", + "description": "EnvironmentType enum WINDOWS_CONTAINER" + }, + { + "name": "WINDOWS_SERVER_2019_CONTAINER", + "value": "WINDOWS_SERVER_2019_CONTAINER", + "description": "EnvironmentType enum WINDOWS_SERVER_2019_CONTAINER" + } + ] + } + }, + "EnvironmentTypeEnumValue": { + "type": "object", + "description": "Definition of EnvironmentTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/EnvironmentType", + "description": "Property value" + } + } + }, + "EnvironmentVariable": { + "type": "object", + "description": "Definition of EnvironmentVariable", + "properties": { + "name": { + "type": "string", + "description": "<p>The name or key of the environment variable.</p>" + }, + "type": { + "$ref": "#/definitions/EnvironmentVariableTypeEnumValue", + "description": "<p>The type of environment variable. Valid values include:</p> <ul> <li> <p> <code>PARAMETER_STORE</code>: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the <code>value</code> of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store'>env/parameter-store</a> in the <i>CodeBuild User Guide</i>.</p> </li> <li> <p> <code>PLAINTEXT</code>: An environment variable in plain text format. This is the default value.</p> </li> <li> <p> <code>SECRETS_MANAGER</code>: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the <code>value</code> of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager'>env/secrets-manager</a> in the <i>CodeBuild User Guide</i>.</p> </li> </ul>" + }, + "value": { + "type": "string", + "description": "<p>The value of the environment variable.</p> <important> <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to store sensitive values, especially Amazon Web Services secret key IDs. <code>PLAINTEXT</code> environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type <code>PARAMETER_STORE</code> or <code>SECRETS_MANAGER</code>. </p> </important>" + } + } + }, + "EnvironmentVariableType": { + "type": "string", + "description": "EnvironmentVariableType enum", + "enum": [ + "PARAMETER_STORE", + "PLAINTEXT", + "SECRETS_MANAGER" + ], + "x-ms-enum": { + "name": "EnvironmentVariableType", + "modelAsString": true, + "values": [ + { + "name": "PARAMETER_STORE", + "value": "PARAMETER_STORE", + "description": "EnvironmentVariableType enum PARAMETER_STORE" + }, + { + "name": "PLAINTEXT", + "value": "PLAINTEXT", + "description": "EnvironmentVariableType enum PLAINTEXT" + }, + { + "name": "SECRETS_MANAGER", + "value": "SECRETS_MANAGER", + "description": "EnvironmentVariableType enum SECRETS_MANAGER" + } + ] + } + }, + "EnvironmentVariableTypeEnumValue": { + "type": "object", + "description": "Definition of EnvironmentVariableTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/EnvironmentVariableType", + "description": "Property value" + } + } + }, + "FileSystemType": { + "type": "string", + "description": "FileSystemType enum", + "enum": [ + "EFS" + ], + "x-ms-enum": { + "name": "FileSystemType", + "modelAsString": true, + "values": [ + { + "name": "EFS", + "value": "EFS", + "description": "FileSystemType enum EFS" + } + ] + } + }, + "FileSystemTypeEnumValue": { + "type": "object", + "description": "Definition of FileSystemTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/FileSystemType", + "description": "Property value" + } + } + }, + "FilterGroup": { + "type": "object", + "description": "Definition of FilterGroup", + "properties": { + "webhookFilter": { + "$ref": "#/definitions/WebhookFilter", + "description": "Property webhookFilter" + } + } + }, + "GitSubmodulesConfig": { + "type": "object", + "description": "Definition of GitSubmodulesConfig", + "properties": { + "fetchSubmodules": { + "type": "boolean", + "description": "<p> Set to true to fetch Git submodules for your CodeBuild build project. </p>" + } + } + }, + "ImagePullCredentialsType": { + "type": "string", + "description": "ImagePullCredentialsType enum", + "enum": [ + "CODEBUILD", + "SERVICE_ROLE" + ], + "x-ms-enum": { + "name": "ImagePullCredentialsType", + "modelAsString": true, + "values": [ + { + "name": "CODEBUILD", + "value": "CODEBUILD", + "description": "ImagePullCredentialsType enum CODEBUILD" + }, + { + "name": "SERVICE_ROLE", + "value": "SERVICE_ROLE", + "description": "ImagePullCredentialsType enum SERVICE_ROLE" + } + ] + } + }, + "ImagePullCredentialsTypeEnumValue": { + "type": "object", + "description": "Definition of ImagePullCredentialsTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ImagePullCredentialsType", + "description": "Property value" + } + } + }, + "LogsConfig": { + "type": "object", + "description": "Definition of LogsConfig", + "properties": { + "cloudWatchLogs": { + "$ref": "#/definitions/CloudWatchLogsConfig", + "description": "<p> Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. </p>" + }, + "s3Logs": { + "$ref": "#/definitions/S3LogsConfig", + "description": "<p> Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. </p>" + } + } + }, + "LogsConfigStatusType": { + "type": "string", + "description": "LogsConfigStatusType enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "LogsConfigStatusType", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "LogsConfigStatusType enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "LogsConfigStatusType enum ENABLED" + } + ] + } + }, + "LogsConfigStatusTypeEnumValue": { + "type": "object", + "description": "Definition of LogsConfigStatusTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/LogsConfigStatusType", + "description": "Property value" + } + } + }, + "ProjectArtifacts": { + "type": "object", + "description": "Definition of ProjectArtifacts", + "properties": { + "artifactIdentifier": { + "type": "string", + "description": "<p> An identifier for this artifact definition. </p>" + }, + "bucketOwnerAccess": { + "$ref": "#/definitions/BucketOwnerAccessEnumValue", + "description": "Property bucketOwnerAccess" + }, + "encryptionDisabled": { + "type": "boolean", + "description": "<p> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </p>" + }, + "location": { + "type": "string", + "description": "<p>Information about the build output artifact location:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>" + }, + "name": { + "type": "string", + "description": "<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash ('/'), the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to '<code>/</code>', the output artifact is stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to '<code>/</code>', the output artifact is stored in <code>MyArtifacts/<build-ID></code>. </p> </li> </ul>" + }, + "namespaceType": { + "$ref": "#/definitions/ArtifactNamespaceEnumValue", + "description": "<p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>" + }, + "overrideArtifactName": { + "type": "boolean", + "description": "<p> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </p>" + }, + "packaging": { + "$ref": "#/definitions/ArtifactPackagingEnumValue", + "description": "<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>" + }, + "path": { + "type": "string", + "description": "<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>" + }, + "type": { + "$ref": "#/definitions/ArtifactsTypeEnumValue", + "description": "<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>" + } + } + }, + "ProjectBadge": { + "type": "object", + "description": "Definition of ProjectBadge", + "properties": { + "badgeEnabled": { + "type": "boolean", + "description": "<p>Set this to true to generate a publicly accessible URL for your project's build badge.</p>" + }, + "badgeRequestUrl": { + "type": "string", + "description": "<p>The publicly-accessible URL through which you can access the build badge for your project. </p>" + } + } + }, + "ProjectBuildBatchConfig": { + "type": "object", + "description": "Definition of ProjectBuildBatchConfig", + "properties": { + "batchReportMode": { + "$ref": "#/definitions/BatchReportModeTypeEnumValue", + "description": "<p>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</p> <dl> <dt>REPORT_AGGREGATED_BATCH</dt> <dd> <p>(Default) Aggregate all of the build statuses into a single status report.</p> </dd> <dt>REPORT_INDIVIDUAL_BUILDS</dt> <dd> <p>Send a separate status report for each individual build.</p> </dd> </dl>" + }, + "combineArtifacts": { + "type": "boolean", + "description": "<p>Specifies if the build artifacts for the batch build should be combined into a single artifact location.</p>" + }, + "restrictions": { + "$ref": "#/definitions/BatchRestrictions", + "description": "<p>A <code>BatchRestrictions</code> object that specifies the restrictions for the batch build.</p>" + }, + "serviceRole": { + "type": "string", + "description": "<p>Specifies the service role ARN for the batch build project.</p>" + }, + "timeoutInMins": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</p>" + } + } + }, + "ProjectCache": { + "type": "object", + "description": "Definition of ProjectCache", + "properties": { + "location": { + "type": "string", + "description": "<p>Information about the cache location: </p> <ul> <li> <p> <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>" + }, + "modes": { + "type": "array", + "description": "<p>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</p> <p>Possible values are:</p> <dl> <dt>LOCAL_SOURCE_CACHE</dt> <dd> <p>Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </p> </dd> <dt>LOCAL_DOCKER_LAYER_CACHE</dt> <dd> <p>Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </p> <note> <ul> <li> <p>You can use a Docker layer cache in the Linux environment only. </p> </li> <li> <p>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </p> </li> <li> <p>You should consider the security implications before you use a Docker layer cache. </p> </li> </ul> </note> </dd> <dt>LOCAL_CUSTOM_CACHE</dt> <dd> <p>Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </p> <ul> <li> <p>Only directories can be specified for caching. You cannot specify individual files. </p> </li> <li> <p>Symlinks are used to reference cached directories. </p> </li> <li> <p>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </p> </li> </ul> </dd> </dl>", + "items": { + "$ref": "#/definitions/CacheMode" + }, + "x-ms-identifiers": [] + }, + "type": { + "$ref": "#/definitions/CacheTypeEnumValue", + "description": "<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project does not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project reads and writes from and to S3.</p> </li> <li> <p> <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</p> </li> </ul>" + } + } + }, + "ProjectEnvironment": { + "type": "object", + "description": "Definition of ProjectEnvironment", + "properties": { + "certificate": { + "type": "string", + "description": "<p>The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate'>certificate</a> in the <i>CodeBuild User Guide</i>.</p>" + }, + "computeType": { + "$ref": "#/definitions/ComputeTypeEnumValue", + "description": "<p>Information about the compute resources the build project uses. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_XLARGE</code>: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.</p> </li> <li> <p> <code>BUILD_LAMBDA_1GB</code>: Use up to 1 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_2GB</code>: Use up to 2 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_4GB</code>: Use up to 4 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_8GB</code>: Use up to 8 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> <li> <p> <code>BUILD_LAMBDA_10GB</code>: Use up to 10 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_SMALL</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 3 GB memory and 2 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</p> </li> </ul> <note> <p>If you're using compute fleets during project creation, <code>computeType</code> will be ignored.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build Environment Compute Types</a> in the <i>CodeBuild User Guide.</i> </p>" + }, + "environmentVariables": { + "type": "array", + "description": "<p>A set of environment variables to make available to builds for this build project.</p>", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + }, + "x-ms-identifiers": [] + }, + "fleet": { + "$ref": "#/definitions/ProjectFleet", + "description": "<p>A ProjectFleet object to use for this build project.</p>" + }, + "image": { + "type": "string", + "description": "<p>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code><registry>/<repository>@<digest></code>. For example, to specify an image with the digest 'sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,' use <code><registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html'>Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</p>" + }, + "imagePullCredentialsType": { + "$ref": "#/definitions/ImagePullCredentialsTypeEnumValue", + "description": "<p> The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </p> <ul> <li> <p> <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </p>" + }, + "privilegedMode": { + "type": "boolean", + "description": "<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is <code>false</code>.</p> <p>You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code> </p> <p> <code>- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'</code> </p>" + }, + "registryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "<p> The credentials for access to a private registry.</p>" + }, + "type": { + "$ref": "#/definitions/EnvironmentTypeEnumValue", + "description": "<p>The type of build environment to use for related builds.</p> <ul> <li> <p>The environment type <code>ARM_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).</p> </li> <li> <p>The environment type <code>LINUX_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> </li> <li> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> </li> </ul> <ul> <li> <p>The environment types <code>ARM_LAMBDA_CONTAINER</code> and <code>LINUX_LAMBDA_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).</p> </li> </ul> <ul> <li> <p>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</p> </li> </ul> <note> <p>If you're using compute fleets during project creation, <code>type</code> will be ignored.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'>Build environment compute types</a> in the <i>CodeBuild user guide</i>.</p>" + } + } + }, + "ProjectFileSystemLocation": { + "type": "object", + "description": "Definition of ProjectFileSystemLocation", + "properties": { + "identifier": { + "type": "string", + "description": "<p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>" + }, + "location": { + "type": "string", + "description": "<p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>" + }, + "mountOptions": { + "type": "string", + "description": "<p> The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href='https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html'>Recommended NFS Mount Options</a>. </p>" + }, + "mountPoint": { + "type": "string", + "description": "<p>The location in the container where you mount the file system. </p>" + }, + "type": { + "$ref": "#/definitions/FileSystemTypeEnumValue", + "description": "<p> The type of the file system. The one supported type is <code>EFS</code>. </p>" + } + } + }, + "ProjectFleet": { + "type": "object", + "description": "Definition of ProjectFleet", + "properties": { + "fleetArn": { + "type": "string", + "description": "<p>Specifies the compute fleet ARN for the build project.</p>" + } + } + }, + "ProjectSource": { + "type": "object", + "description": "Definition of ProjectSource", + "properties": { + "auth": { + "$ref": "#/definitions/SourceAuth", + "description": "<p>Information about the authorization settings for CodeBuild to access the source code to be built.</p> <p>This information is for the CodeBuild console's use only. Your code should not get or set this information directly.</p>" + }, + "buildStatusConfig": { + "$ref": "#/definitions/BuildStatusConfig", + "description": "<p>Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.</p>" + }, + "buildspec": { + "type": "string", + "description": "<p>The buildspec file declaration to use for the builds in this build project.</p> <p> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage'>Buildspec File Name and Storage Location</a>. </p>" + }, + "gitCloneDepth": { + "type": "integer", + "format": "int32", + "description": "<p>Information about the Git clone depth for the build project.</p>" + }, + "gitSubmodulesConfig": { + "$ref": "#/definitions/GitSubmodulesConfig", + "description": "<p> Information about the Git submodules configuration for the build project. </p>" + }, + "insecureSsl": { + "type": "boolean", + "description": "<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>" + }, + "location": { + "type": "string", + "description": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name></code>).</p> </li> <li> <p>For source code in an Amazon S3 input bucket, one of the following. </p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code><bucket-name>/<path>/<object-name>.zip</code>). </p> </li> <li> <p>The path to the folder that contains the source code (for example, <code><bucket-name>/<path-to-source-code>/<folder>/</code>). </p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections <b>Authorize application</b> page, choose <b>Authorize</b>. Then on the CodeConnections <b>Create GitLab connection</b> page, choose <b>Connect to GitLab</b>. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the <code>auth</code> object's <code>type</code> value to <code>CODECONNECTIONS</code> in the <code>source</code> object.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul> <p> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </p>" + }, + "reportBuildStatus": { + "type": "boolean", + "description": "<p> Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html'>Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> <p>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</p>" + }, + "sourceIdentifier": { + "type": "string", + "description": "<p>An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </p>" + }, + "type": { + "$ref": "#/definitions/SourceTypeEnumValue", + "description": "<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</p> </li> <li> <p> <code>GITLAB</code>: The source code is in a GitLab repository.</p> </li> <li> <p> <code>GITLAB_SELF_MANAGED</code>: The source code is in a self-managed GitLab repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon S3 bucket.</p> </li> </ul>" + } + } + }, + "ProjectSourceVersion": { + "type": "object", + "description": "Definition of ProjectSourceVersion", + "properties": { + "sourceIdentifier": { + "type": "string", + "description": "<p>An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </p>" + }, + "sourceVersion": { + "type": "string", + "description": "<p>The source version for the corresponding source identifier. If specified, must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub or GitLab: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p> For more information, see <a href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'>Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>" + } + } + }, + "ProjectVisibilityType": { + "type": "string", + "description": "ProjectVisibilityType enum", + "enum": [ + "PRIVATE", + "PUBLIC_READ" + ], + "x-ms-enum": { + "name": "ProjectVisibilityType", + "modelAsString": true, + "values": [ + { + "name": "PRIVATE", + "value": "PRIVATE", + "description": "ProjectVisibilityType enum PRIVATE" + }, + { + "name": "PUBLIC_READ", + "value": "PUBLIC_READ", + "description": "ProjectVisibilityType enum PUBLIC_READ" + } + ] + } + }, + "ProjectVisibilityTypeEnumValue": { + "type": "object", + "description": "Definition of ProjectVisibilityTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ProjectVisibilityType", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RegistryCredential": { + "type": "object", + "description": "Definition of RegistryCredential", + "properties": { + "credential": { + "type": "string", + "description": "<p> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </p> <note> <p> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </p> </note>" + }, + "credentialProvider": { + "$ref": "#/definitions/CredentialProviderTypeEnumValue", + "description": "<p> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </p>" + } + } + }, + "S3LogsConfig": { + "type": "object", + "description": "Definition of S3LogsConfig", + "properties": { + "bucketOwnerAccess": { + "$ref": "#/definitions/BucketOwnerAccessEnumValue", + "description": "Property bucketOwnerAccess" + }, + "encryptionDisabled": { + "type": "boolean", + "description": "<p> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </p>" + }, + "location": { + "type": "string", + "description": "<p> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </p>" + }, + "status": { + "$ref": "#/definitions/LogsConfigStatusTypeEnumValue", + "description": "<p>The current status of the S3 build logs. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: S3 build logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: S3 build logs are not enabled for this build project.</p> </li> </ul>" + } + } + }, + "SourceAuth": { + "type": "object", + "description": "Definition of SourceAuth", + "properties": { + "resource": { + "type": "string", + "description": "<p>The resource value that applies to the specified authorization type.</p>" + }, + "type": { + "$ref": "#/definitions/SourceAuthTypeEnumValue", + "description": "<p>The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.</p>" + } + } + }, + "SourceAuthType": { + "type": "string", + "description": "SourceAuthType enum", + "enum": [ + "CODECONNECTIONS", + "OAUTH" + ], + "x-ms-enum": { + "name": "SourceAuthType", + "modelAsString": true, + "values": [ + { + "name": "CODECONNECTIONS", + "value": "CODECONNECTIONS", + "description": "SourceAuthType enum CODECONNECTIONS" + }, + { + "name": "OAUTH", + "value": "OAUTH", + "description": "SourceAuthType enum OAUTH" + } + ] + } + }, + "SourceAuthTypeEnumValue": { + "type": "object", + "description": "Definition of SourceAuthTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SourceAuthType", + "description": "Property value" + } + } + }, + "SourceType": { + "type": "string", + "description": "SourceType enum", + "enum": [ + "BITBUCKET", + "CODECOMMIT", + "CODEPIPELINE", + "GITHUB", + "GITHUB_ENTERPRISE", + "GITLAB", + "GITLAB_SELF_MANAGED", + "NO_SOURCE", + "S3" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "BITBUCKET", + "value": "BITBUCKET", + "description": "SourceType enum BITBUCKET" + }, + { + "name": "CODECOMMIT", + "value": "CODECOMMIT", + "description": "SourceType enum CODECOMMIT" + }, + { + "name": "CODEPIPELINE", + "value": "CODEPIPELINE", + "description": "SourceType enum CODEPIPELINE" + }, + { + "name": "GITHUB", + "value": "GITHUB", + "description": "SourceType enum GITHUB" + }, + { + "name": "GITHUB_ENTERPRISE", + "value": "GITHUB_ENTERPRISE", + "description": "SourceType enum GITHUB_ENTERPRISE" + }, + { + "name": "GITLAB", + "value": "GITLAB", + "description": "SourceType enum GITLAB" + }, + { + "name": "GITLAB_SELF_MANAGED", + "value": "GITLAB_SELF_MANAGED", + "description": "SourceType enum GITLAB_SELF_MANAGED" + }, + { + "name": "NO_SOURCE", + "value": "NO_SOURCE", + "description": "SourceType enum NO_SOURCE" + }, + { + "name": "S3", + "value": "S3", + "description": "SourceType enum S3" + } + ] + } + }, + "SourceTypeEnumValue": { + "type": "object", + "description": "Definition of SourceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SourceType", + "description": "Property value" + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The tag's key.</p>" + }, + "value": { + "type": "string", + "description": "<p>The tag's value.</p>" + } + } + }, + "VpcConfig": { + "type": "object", + "description": "Definition of VpcConfig", + "properties": { + "securityGroupIds": { + "type": "array", + "description": "<p>A list of one or more security groups IDs in your Amazon VPC.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "<p>A list of one or more subnet IDs in your Amazon VPC.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the Amazon VPC.</p>" + } + } + }, + "Webhook": { + "type": "object", + "description": "Definition of Webhook", + "properties": { + "branchFilter": { + "type": "string", + "description": "<p>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built.</p> <note> <p>It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </p> </note>" + }, + "buildType": { + "$ref": "#/definitions/WebhookBuildTypeEnumValue", + "description": "<p>Specifies the type of build this webhook will trigger.</p>" + }, + "filterGroups": { + "type": "array", + "description": "<p>An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. </p> <p>For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </p>", + "items": { + "$ref": "#/definitions/FilterGroup" + }, + "x-ms-identifiers": [] + }, + "lastModifiedSecret": { + "type": "string", + "format": "date-time", + "description": "<p>A timestamp that indicates the last time a repository's secret token was modified. </p>" + }, + "payloadUrl": { + "type": "string", + "description": "<p>The CodeBuild endpoint where webhook events are sent.</p>" + }, + "secret": { + "type": "string", + "description": "<p>The secret token of the associated repository. </p> <note> <p>A Bitbucket webhook does not support <code>secret</code>. </p> </note>" + }, + "url": { + "type": "string", + "description": "<p>The URL to the webhook.</p>" + } + } + }, + "WebhookBuildType": { + "type": "string", + "description": "WebhookBuildType enum", + "enum": [ + "BUILD", + "BUILD_BATCH" + ], + "x-ms-enum": { + "name": "WebhookBuildType", + "modelAsString": true, + "values": [ + { + "name": "BUILD", + "value": "BUILD", + "description": "WebhookBuildType enum BUILD" + }, + { + "name": "BUILD_BATCH", + "value": "BUILD_BATCH", + "description": "WebhookBuildType enum BUILD_BATCH" + } + ] + } + }, + "WebhookBuildTypeEnumValue": { + "type": "object", + "description": "Definition of WebhookBuildTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/WebhookBuildType", + "description": "Property value" + } + } + }, + "WebhookFilter": { + "type": "object", + "description": "Definition of WebhookFilter", + "properties": { + "excludeMatchedPattern": { + "type": "boolean", + "description": "<p> Used to indicate that the <code>pattern</code> determines which webhook events do not trigger a build. If true, then a webhook event that does not match the <code>pattern</code> triggers a build. If false, then a webhook event that matches the <code>pattern</code> triggers a build. </p>" + }, + "pattern": { + "type": "string", + "description": "<p> For a <code>WebHookFilter</code> that uses <code>EVENT</code> type, a comma-separated string that specifies one or more events. For example, the webhook filter <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> allows all push, pull request created, and pull request updated events to trigger a build. </p> <p> For a <code>WebHookFilter</code> that uses any of the other filter types, a regular expression pattern. For example, a <code>WebHookFilter</code> that uses <code>HEAD_REF</code> for its <code>type</code> and the pattern <code>^refs/heads/</code> triggers a build when the head reference is a branch with a reference name <code>refs/heads/branch-name</code>. </p>" + }, + "type": { + "$ref": "#/definitions/WebhookFilterTypeEnumValue", + "description": "<p> The type of webhook filter. There are nine webhook filter types: <code>EVENT</code>, <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>, <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, <code>RELEASE_NAME</code>, and <code>WORKFLOW_NAME</code>. </p> <ul> <li> <p> EVENT </p> <ul> <li> <p> A webhook event triggers a build when the provided <code>pattern</code> matches one of nine event types: <code>PUSH</code>, <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>, <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code>. The <code>EVENT</code> patterns are specified as a comma-separated string. For example, <code>PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull request created, and pull request updated events. </p> <note> <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub Enterprise only. The <code>RELEASED</code>, <code>PRERELEASED</code>, and <code>WORKFLOW_JOB_QUEUED</code> work with GitHub only.</p> </note> </li> </ul> </li> <li> <p>ACTOR_ACCOUNT_ID</p> <ul> <li> <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression <code>pattern</code>. </p> </li> </ul> </li> <li> <p>HEAD_REF</p> <ul> <li> <p> A webhook event triggers a build when the head reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p> <note> <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p> </note> </li> </ul> </li> <li> <p>BASE_REF</p> <ul> <li> <p> A webhook event triggers a build when the base reference matches the regular expression <code>pattern</code>. For example, <code>refs/heads/branch-name</code>. </p> <note> <p> Works with pull request events only. </p> </note> </li> </ul> </li> <li> <p>FILE_PATH</p> <ul> <li> <p> A webhook triggers a build when the path of a changed file matches the regular expression <code>pattern</code>. </p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>COMMIT_MESSAGE</p> <ul> <li> <p>A webhook triggers a build when the head commit message matches the regular expression <code>pattern</code>.</p> <note> <p> Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events. </p> </note> </li> </ul> </li> <li> <p>TAG_NAME</p> <ul> <li> <p>A webhook triggers a build when the tag name of the release matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>RELEASE_NAME</p> <ul> <li> <p>A webhook triggers a build when the release name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p> </note> </li> </ul> </li> <li> <p>WORKFLOW_NAME</p> <ul> <li> <p>A webhook triggers a build when the workflow name matches the regular expression <code>pattern</code>.</p> <note> <p> Works with <code>WORKFLOW_JOB_QUEUED</code> events only. </p> </note> </li> </ul> </li> </ul>" + } + } + }, + "WebhookFilterType": { + "type": "string", + "description": "WebhookFilterType enum", + "enum": [ + "ACTOR_ACCOUNT_ID", + "BASE_REF", + "COMMIT_MESSAGE", + "EVENT", + "FILE_PATH", + "HEAD_REF", + "RELEASE_NAME", + "TAG_NAME", + "WORKFLOW_NAME" + ], + "x-ms-enum": { + "name": "WebhookFilterType", + "modelAsString": true, + "values": [ + { + "name": "ACTOR_ACCOUNT_ID", + "value": "ACTOR_ACCOUNT_ID", + "description": "WebhookFilterType enum ACTOR_ACCOUNT_ID" + }, + { + "name": "BASE_REF", + "value": "BASE_REF", + "description": "WebhookFilterType enum BASE_REF" + }, + { + "name": "COMMIT_MESSAGE", + "value": "COMMIT_MESSAGE", + "description": "WebhookFilterType enum COMMIT_MESSAGE" + }, + { + "name": "EVENT", + "value": "EVENT", + "description": "WebhookFilterType enum EVENT" + }, + { + "name": "FILE_PATH", + "value": "FILE_PATH", + "description": "WebhookFilterType enum FILE_PATH" + }, + { + "name": "HEAD_REF", + "value": "HEAD_REF", + "description": "WebhookFilterType enum HEAD_REF" + }, + { + "name": "RELEASE_NAME", + "value": "RELEASE_NAME", + "description": "WebhookFilterType enum RELEASE_NAME" + }, + { + "name": "TAG_NAME", + "value": "TAG_NAME", + "description": "WebhookFilterType enum TAG_NAME" + }, + { + "name": "WORKFLOW_NAME", + "value": "WORKFLOW_NAME", + "description": "WebhookFilterType enum WORKFLOW_NAME" + } + ] + } + }, + "WebhookFilterTypeEnumValue": { + "type": "object", + "description": "Definition of WebhookFilterTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/WebhookFilterType", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildSourceCredentialsInfo.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildSourceCredentialsInfo.json new file mode 100644 index 000000000000..48b90a643747 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/codeBuildSourceCredentialsInfo.json @@ -0,0 +1,656 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "CodeBuildSourceCredentialsInfos" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/codeBuildSourceCredentialsInfos": { + "get": { + "operationId": "CodeBuildSourceCredentialsInfos_ListBySubscription", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "List CodeBuildSourceCredentialsInfo resources 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/CodeBuildSourceCredentialsInfoListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildSourceCredentialsInfos_ListBySubscription": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildSourceCredentialsInfos": { + "get": { + "operationId": "CodeBuildSourceCredentialsInfos_ListByResourceGroup", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "List CodeBuildSourceCredentialsInfo resources 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/CodeBuildSourceCredentialsInfoListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildSourceCredentialsInfos_ListByResourceGroup": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/codeBuildSourceCredentialsInfos/{name}": { + "get": { + "operationId": "CodeBuildSourceCredentialsInfos_Get", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "Get a CodeBuildSourceCredentialsInfo", + "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": "name", + "in": "path", + "description": "Name of CodeBuildSourceCredentialsInfo", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildSourceCredentialsInfos_Get": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_Get.json" + } + } + }, + "put": { + "operationId": "CodeBuildSourceCredentialsInfos_CreateOrReplace", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "Create a CodeBuildSourceCredentialsInfo. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of CodeBuildSourceCredentialsInfo", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + } + } + ], + "responses": { + "200": { + "description": "Resource 'CodeBuildSourceCredentialsInfo' update operation succeeded", + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + } + }, + "201": { + "description": "Resource 'CodeBuildSourceCredentialsInfo' create operation succeeded", + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "CodeBuildSourceCredentialsInfos_CreateOrReplace": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "CodeBuildSourceCredentialsInfos_Update", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "Update a CodeBuildSourceCredentialsInfo", + "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": "name", + "in": "path", + "description": "Name of CodeBuildSourceCredentialsInfo", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfoTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CodeBuildSourceCredentialsInfos_Update": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "CodeBuildSourceCredentialsInfos_Delete", + "tags": [ + "CodeBuildSourceCredentialsInfos" + ], + "description": "Delete a CodeBuildSourceCredentialsInfo", + "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": "name", + "in": "path", + "description": "Name of CodeBuildSourceCredentialsInfo", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "CodeBuildSourceCredentialsInfos_Delete": { + "$ref": "./examples/CodeBuildSourceCredentialsInfos_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AuthType": { + "type": "string", + "description": "AuthType enum", + "enum": [ + "BASIC_AUTH", + "CODECONNECTIONS", + "OAUTH", + "PERSONAL_ACCESS_TOKEN" + ], + "x-ms-enum": { + "name": "AuthType", + "modelAsString": true, + "values": [ + { + "name": "BASIC_AUTH", + "value": "BASIC_AUTH", + "description": "AuthType enum BASIC_AUTH" + }, + { + "name": "CODECONNECTIONS", + "value": "CODECONNECTIONS", + "description": "AuthType enum CODECONNECTIONS" + }, + { + "name": "OAUTH", + "value": "OAUTH", + "description": "AuthType enum OAUTH" + }, + { + "name": "PERSONAL_ACCESS_TOKEN", + "value": "PERSONAL_ACCESS_TOKEN", + "description": "AuthType enum PERSONAL_ACCESS_TOKEN" + } + ] + } + }, + "AuthTypeEnumValue": { + "type": "object", + "description": "Definition of AuthTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AuthType", + "description": "Property value" + } + } + }, + "AwsCodeBuildSourceCredentialsInfoProperties": { + "type": "object", + "description": "Definition of awsCodeBuildSourceCredentialsInfo", + "properties": { + "arn": { + "type": "string", + "description": "<p> The Amazon Resource Name (ARN) of the token. </p>" + }, + "authType": { + "$ref": "#/definitions/AuthTypeEnumValue", + "description": "<p> The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS. </p>" + }, + "resource": { + "type": "string", + "description": "<p>The connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.</p>" + }, + "serverType": { + "$ref": "#/definitions/ServerTypeEnumValue", + "description": "<p> The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET. </p>" + } + } + }, + "CodeBuildSourceCredentialsInfo": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfoProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "CodeBuildSourceCredentialsInfoListResult": { + "type": "object", + "description": "The response of a CodeBuildSourceCredentialsInfo list operation.", + "properties": { + "value": { + "type": "array", + "description": "The CodeBuildSourceCredentialsInfo items on this page", + "items": { + "$ref": "#/definitions/CodeBuildSourceCredentialsInfo" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CodeBuildSourceCredentialsInfoProperties": { + "type": "object", + "description": "Definition of CodeBuildSourceCredentialsInfo", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsCodeBuildSourceCredentialsInfoProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CodeBuildSourceCredentialsInfoTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in CodeBuildSourceCredentialsInfo resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ServerType": { + "type": "string", + "description": "ServerType enum", + "enum": [ + "BITBUCKET", + "GITHUB", + "GITHUB_ENTERPRISE", + "GITLAB", + "GITLAB_SELF_MANAGED" + ], + "x-ms-enum": { + "name": "ServerType", + "modelAsString": true, + "values": [ + { + "name": "BITBUCKET", + "value": "BITBUCKET", + "description": "ServerType enum BITBUCKET" + }, + { + "name": "GITHUB", + "value": "GITHUB", + "description": "ServerType enum GITHUB" + }, + { + "name": "GITHUB_ENTERPRISE", + "value": "GITHUB_ENTERPRISE", + "description": "ServerType enum GITHUB_ENTERPRISE" + }, + { + "name": "GITLAB", + "value": "GITLAB", + "description": "ServerType enum GITLAB" + }, + { + "name": "GITLAB_SELF_MANAGED", + "value": "GITLAB_SELF_MANAGED", + "description": "ServerType enum GITLAB_SELF_MANAGED" + } + ] + } + }, + "ServerTypeEnumValue": { + "type": "object", + "description": "Definition of ServerTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ServerType", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorder.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorder.json new file mode 100644 index 000000000000..5e25c9ecbb57 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorder.json @@ -0,0 +1,3190 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ConfigServiceConfigurationRecorders" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorders": { + "get": { + "operationId": "ConfigServiceConfigurationRecorders_ListBySubscription", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "List ConfigServiceConfigurationRecorder resources 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/ConfigServiceConfigurationRecorderListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorders_ListBySubscription": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorders": { + "get": { + "operationId": "ConfigServiceConfigurationRecorders_ListByResourceGroup", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "List ConfigServiceConfigurationRecorder resources 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/ConfigServiceConfigurationRecorderListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorders_ListByResourceGroup": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorders/{name}": { + "get": { + "operationId": "ConfigServiceConfigurationRecorders_Get", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "Get a ConfigServiceConfigurationRecorder", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorder", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorders_Get": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_Get.json" + } + } + }, + "put": { + "operationId": "ConfigServiceConfigurationRecorders_CreateOrReplace", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "Create a ConfigServiceConfigurationRecorder. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorder", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ConfigServiceConfigurationRecorder' update operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + } + }, + "201": { + "description": "Resource 'ConfigServiceConfigurationRecorder' create operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ConfigServiceConfigurationRecorders_CreateOrReplace": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ConfigServiceConfigurationRecorders_Update", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "Update a ConfigServiceConfigurationRecorder", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorder", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorders_Update": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConfigServiceConfigurationRecorders_Delete", + "tags": [ + "ConfigServiceConfigurationRecorders" + ], + "description": "Delete a ConfigServiceConfigurationRecorder", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorder", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ConfigServiceConfigurationRecorders_Delete": { + "$ref": "./examples/ConfigServiceConfigurationRecorders_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsConfigServiceConfigurationRecorderProperties": { + "type": "object", + "description": "Definition of awsConfigServiceConfigurationRecorder", + "properties": { + "name": { + "type": "string", + "description": "<p>The name of the configuration recorder. Config automatically assigns the name of 'default' when creating the configuration recorder.</p> <note> <p>You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. </p> </note>" + }, + "recordingGroup": { + "$ref": "#/definitions/RecordingGroup", + "description": "<p>Specifies which resource types Config records for configuration changes.</p> <note> <p> <b> High Number of Config Evaluations</b> </p> <p>You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.</p> <p>If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An <i>ephemeral workload</i> is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.</p> </note>" + }, + "recordingMode": { + "$ref": "#/definitions/RecordingMode", + "description": "<p>Specifies the default recording frequency that Config uses to record configuration changes. Config supports <i>Continuous recording</i> and <i>Daily recording</i>.</p> <ul> <li> <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p> </li> <li> <p>Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. </p> </li> </ul> <note> <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.</p> </note> <p>You can also override the recording frequency for specific resource types.</p>" + }, + "roleARN": { + "type": "string", + "description": "<p>Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.</p> <note> <p>While the API model does not require this field, the server will reject a request without a defined <code>roleARN</code> for the configuration recorder.</p> </note> <note> <p> <b>Pre-existing Config role</b> </p> <p>If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected. </p> <p>For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html'> <b>Identity and Access Management for Config</b> </a> in the <i>Config Developer Guide</i>. </p> </note>" + } + } + }, + "ConfigServiceConfigurationRecorder": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ConfigServiceConfigurationRecorderListResult": { + "type": "object", + "description": "The response of a ConfigServiceConfigurationRecorder list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ConfigServiceConfigurationRecorder items on this page", + "items": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorder" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ConfigServiceConfigurationRecorderProperties": { + "type": "object", + "description": "Definition of ConfigServiceConfigurationRecorder", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsConfigServiceConfigurationRecorderProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ConfigServiceConfigurationRecorderTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ConfigServiceConfigurationRecorder resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ExclusionByResourceTypes": { + "type": "object", + "description": "Definition of ExclusionByResourceTypes", + "properties": { + "resourceTypes": { + "type": "array", + "description": "<p>A comma-separated list of resource types to exclude from recording by the configuration recorder.</p>", + "items": { + "$ref": "#/definitions/ResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RecordingFrequency": { + "type": "string", + "description": "RecordingFrequency enum", + "enum": [ + "CONTINUOUS", + "DAILY" + ], + "x-ms-enum": { + "name": "RecordingFrequency", + "modelAsString": true, + "values": [ + { + "name": "CONTINUOUS", + "value": "CONTINUOUS", + "description": "RecordingFrequency enum CONTINUOUS" + }, + { + "name": "DAILY", + "value": "DAILY", + "description": "RecordingFrequency enum DAILY" + } + ] + } + }, + "RecordingFrequencyEnumValue": { + "type": "object", + "description": "Definition of RecordingFrequencyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RecordingFrequency", + "description": "Property value" + } + } + }, + "RecordingGroup": { + "type": "object", + "description": "Definition of RecordingGroup", + "properties": { + "allSupported": { + "type": "boolean", + "description": "<p>Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.</p> <p>If you set this field to <code>true</code>, when Config adds support for a new resource type, Config starts recording resources of that type automatically.</p> <p>If you set this field to <code>true</code>, you cannot enumerate specific resource types to record in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>, or to exclude in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> <note> <p> <b>Region availability</b> </p> <p>Check <a href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'>Resource Coverage by Region Availability</a> to see if a resource type is supported in the Amazon Web Services Region where you set up Config.</p> </note>" + }, + "exclusionByResourceTypes": { + "$ref": "#/definitions/ExclusionByResourceTypes", + "description": "<p>An object that specifies how Config excludes resource types from being recorded by the configuration recorder.</p> <note> <p> <b>Required fields</b> </p> <p>To use this option, you must set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>.</p> </note>" + }, + "includeGlobalResourceTypes": { + "type": "boolean", + "description": "<p>This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> <important> <p> <b>Aurora global clusters are recorded in all enabled Regions</b> </p> <p>The <code>AWS::RDS::GlobalCluster</code> resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if <code>includeGlobalResourceTypes</code> is set<code>false</code>. The <code>includeGlobalResourceTypes</code> option is a bundle which only applies to IAM users, groups, roles, and customer managed policies. </p> <p>If you do not want to record <code>AWS::RDS::GlobalCluster</code> in all enabled Regions, use one of the following recording strategies:</p> <ol> <li> <p> <b>Record all current and future resource types with exclusions</b> (<code>EXCLUSION_BY_RESOURCE_TYPES</code>), or</p> </li> <li> <p> <b>Record specific resource types</b> (<code>INCLUSION_BY_RESOURCE_TYPES</code>).</p> </li> </ol> <p>For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all'>Selecting Which Resources are Recorded</a> in the <i>Config developer guide</i>.</p> </important> <important> <p> <b>includeGlobalResourceTypes and the exclusion recording strategy</b> </p> <p>The <code>includeGlobalResourceTypes</code> field has no impact on the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for <code>exclusionByResourceTypes</code> when <code>includeGlobalResourceTypes</code> is set to <code>false</code>.</p> <p>The <code>includeGlobalResourceTypes</code> field should only be used to modify the <code>AllSupported</code> field, as the default for the <code>AllSupported</code> field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when <code>AllSupported</code> is set to <code>true</code>, make sure to set <code>includeGlobalResourceTypes</code> to <code>true</code>.</p> <p>To exclude the global IAM resource types for the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, you need to manually add them to the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </important> <note> <p> <b>Required and optional fields</b> </p> <p>Before you set this field to <code>true</code>, set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. Optionally, you can set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you set this field to <code>false</code> but list global IAM resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>, Config will still record configuration changes for those specified resource types <i>regardless</i> of if you set the <code>includeGlobalResourceTypes</code> field to false.</p> <p>If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the <code>resourceTypes</code> field in addition to setting the <code>includeGlobalResourceTypes</code> field to false.</p> </note>" + }, + "recordingStrategy": { + "$ref": "#/definitions/RecordingStrategy", + "description": "<p>An object that specifies the recording strategy for the configuration recorder.</p> <ul> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. When Config adds support for a new resource type, Config automatically starts recording resources of that type.</p> </li> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for only the resource types you specify in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> </li> <li> <p>If you set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </li> </ul> <note> <p> <b>Required and optional fields</b> </p> <p>The <code>recordingStrategy</code> field is optional when you set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>.</p> <p>The <code>recordingStrategy</code> field is optional when you list resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p> <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </note> <note> <p> <b>Global resources types and the resource exclusion recording strategy</b> </p> <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.</p> <p>Unless specifically listed as exclusions, <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p> <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> </note>" + }, + "resourceTypes": { + "type": "array", + "description": "<p>A comma-separated list that specifies which resource types Config records.</p> <p>For a list of valid <code>resourceTypes</code> values, see the <b>Resource Type Value</b> column in <a href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'>Supported Amazon Web Services resource Types</a> in the <i>Config developer guide</i>.</p> <note> <p> <b>Required and optional fields</b> </p> <p>Optionally, you can set the <code>useOnly</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'>RecordingStrategy</a> to <code>INCLUSION_BY_RESOURCE_TYPES</code>.</p> <p>To record all configuration changes, set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>, and either omit this field or don't specify any resource types in this field. If you set the <code>allSupported</code> field to <code>false</code> and specify values for <code>resourceTypes</code>, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.</p> </note> <note> <p> <b>Region availability</b> </p> <p>Before specifying a resource type for Config to track, check <a href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'>Resource Coverage by Region Availability</a> to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.</p> </note>", + "items": { + "$ref": "#/definitions/ResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "RecordingMode": { + "type": "object", + "description": "Definition of RecordingMode", + "properties": { + "recordingFrequency": { + "$ref": "#/definitions/RecordingFrequencyEnumValue", + "description": "<p>The default recording frequency that Config uses to record configuration changes.</p> <important> <p>Daily recording is not supported for the following resource types:</p> <ul> <li> <p> <code>AWS::Config::ResourceCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConformancePackCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConfigurationRecorder</code> </p> </li> </ul> <p>For the <b>allSupported</b> (<code>ALL_SUPPORTED_RESOURCE_TYPES</code>) recording strategy, these resource types will be set to Continuous recording.</p> </important>" + }, + "recordingModeOverrides": { + "type": "array", + "description": "<p>An array of <code>recordingModeOverride</code> objects for you to specify your overrides for the recording mode. The <code>recordingModeOverride</code> object in the <code>recordingModeOverrides</code> array consists of three fields: a <code>description</code>, the new <code>recordingFrequency</code>, and an array of <code>resourceTypes</code> to override.</p>", + "items": { + "$ref": "#/definitions/RecordingModeOverride" + }, + "x-ms-identifiers": [] + } + } + }, + "RecordingModeOverride": { + "type": "object", + "description": "Definition of RecordingModeOverride", + "properties": { + "description": { + "type": "string", + "description": "<p>A description that you provide for the override.</p>" + }, + "recordingFrequency": { + "$ref": "#/definitions/RecordingFrequencyEnumValue", + "description": "<p>The recording frequency that will be applied to all the resource types specified in the override.</p> <ul> <li> <p>Continuous recording allows you to record configuration changes continuously whenever a change occurs.</p> </li> <li> <p>Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. </p> </li> </ul> <note> <p>Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.</p> </note>" + }, + "resourceTypes": { + "type": "array", + "description": "<p>A comma-separated list that specifies which resource types Config includes in the override.</p> <important> <p>Daily recording is not supported for the following resource types:</p> <ul> <li> <p> <code>AWS::Config::ResourceCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConformancePackCompliance</code> </p> </li> <li> <p> <code>AWS::Config::ConfigurationRecorder</code> </p> </li> </ul> </important>", + "items": { + "$ref": "#/definitions/ResourceType" + }, + "x-ms-identifiers": [] + } + } + }, + "RecordingStrategy": { + "type": "object", + "description": "Definition of RecordingStrategy", + "properties": { + "useOnly": { + "$ref": "#/definitions/RecordingStrategyTypeEnumValue", + "description": "<p>The recording strategy for the configuration recorder.</p> <ul> <li> <p>If you set this option to <code>ALL_SUPPORTED_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'>Supported Resource Types</a> in the <i>Config developer guide</i>.</p> </li> <li> <p>If you set this option to <code>INCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for only the resource types that you specify in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> </li> <li> <p>If you set this option to <code>EXCLUSION_BY_RESOURCE_TYPES</code>, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </li> </ul> <note> <p> <b>Required and optional fields</b> </p> <p>The <code>recordingStrategy</code> field is optional when you set the <code>allSupported</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a> to <code>true</code>.</p> <p>The <code>recordingStrategy</code> field is optional when you list resource types in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'>RecordingGroup</a>.</p> <p>The <code>recordingStrategy</code> field is required if you list resource types to exclude from recording in the <code>resourceTypes</code> field of <a href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'>ExclusionByResourceTypes</a>.</p> </note> <note> <p> <b>Overriding fields</b> </p> <p>If you choose <code>EXCLUSION_BY_RESOURCE_TYPES</code> for the recording strategy, the <code>exclusionByResourceTypes</code> field will override other properties in the request.</p> <p>For example, even if you set <code>includeGlobalResourceTypes</code> to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the <code>resourceTypes</code> field of <code>exclusionByResourceTypes</code>.</p> </note> <note> <p> <b>Global resource types and the exclusion recording strategy</b> </p> <p>By default, if you choose the <code>EXCLUSION_BY_RESOURCE_TYPES</code> recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.</p> <p>Unless specifically listed as exclusions, <code>AWS::RDS::GlobalCluster</code> will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.</p> <p>IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:</p> <ul> <li> <p>Asia Pacific (Hyderabad)</p> </li> <li> <p>Asia Pacific (Melbourne)</p> </li> <li> <p>Canada West (Calgary)</p> </li> <li> <p>Europe (Spain)</p> </li> <li> <p>Europe (Zurich)</p> </li> <li> <p>Israel (Tel Aviv)</p> </li> <li> <p>Middle East (UAE)</p> </li> </ul> </note>" + } + } + }, + "RecordingStrategyType": { + "type": "string", + "description": "RecordingStrategyType enum", + "enum": [ + "ALL_SUPPORTED_RESOURCE_TYPES", + "EXCLUSION_BY_RESOURCE_TYPES", + "INCLUSION_BY_RESOURCE_TYPES" + ], + "x-ms-enum": { + "name": "RecordingStrategyType", + "modelAsString": true, + "values": [ + { + "name": "ALL_SUPPORTED_RESOURCE_TYPES", + "value": "ALL_SUPPORTED_RESOURCE_TYPES", + "description": "RecordingStrategyType enum ALL_SUPPORTED_RESOURCE_TYPES" + }, + { + "name": "EXCLUSION_BY_RESOURCE_TYPES", + "value": "EXCLUSION_BY_RESOURCE_TYPES", + "description": "RecordingStrategyType enum EXCLUSION_BY_RESOURCE_TYPES" + }, + { + "name": "INCLUSION_BY_RESOURCE_TYPES", + "value": "INCLUSION_BY_RESOURCE_TYPES", + "description": "RecordingStrategyType enum INCLUSION_BY_RESOURCE_TYPES" + } + ] + } + }, + "RecordingStrategyTypeEnumValue": { + "type": "object", + "description": "Definition of RecordingStrategyTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RecordingStrategyType", + "description": "Property value" + } + } + }, + "ResourceType": { + "type": "string", + "description": "ResourceType enum", + "enum": [ + "AWS::ACM::Certificate", + "AWS::ACMPCA::CertificateAuthority", + "AWS::ACMPCA::CertificateAuthorityActivation", + "AWS::APS::RuleGroupsNamespace", + "AWS::AccessAnalyzer::Analyzer", + "AWS::AmazonMQ::Broker", + "AWS::Amplify::App", + "AWS::Amplify::Branch", + "AWS::ApiGateway::RestApi", + "AWS::ApiGateway::Stage", + "AWS::ApiGatewayV2::Api", + "AWS::ApiGatewayV2::Stage", + "AWS::AppConfig::Application", + "AWS::AppConfig::ConfigurationProfile", + "AWS::AppConfig::DeploymentStrategy", + "AWS::AppConfig::Environment", + "AWS::AppConfig::HostedConfigurationVersion", + "AWS::AppFlow::Flow", + "AWS::AppIntegrations::EventIntegration", + "AWS::AppMesh::GatewayRoute", + "AWS::AppMesh::Mesh", + "AWS::AppMesh::Route", + "AWS::AppMesh::VirtualGateway", + "AWS::AppMesh::VirtualNode", + "AWS::AppMesh::VirtualRouter", + "AWS::AppMesh::VirtualService", + "AWS::AppRunner::Service", + "AWS::AppRunner::VpcConnector", + "AWS::AppStream::Application", + "AWS::AppStream::DirectoryConfig", + "AWS::AppStream::Fleet", + "AWS::AppStream::Stack", + "AWS::AppSync::GraphQLApi", + "AWS::Athena::DataCatalog", + "AWS::Athena::PreparedStatement", + "AWS::Athena::WorkGroup", + "AWS::AuditManager::Assessment", + "AWS::AutoScaling::AutoScalingGroup", + "AWS::AutoScaling::LaunchConfiguration", + "AWS::AutoScaling::ScalingPolicy", + "AWS::AutoScaling::ScheduledAction", + "AWS::AutoScaling::WarmPool", + "AWS::Backup::BackupPlan", + "AWS::Backup::BackupSelection", + "AWS::Backup::BackupVault", + "AWS::Backup::RecoveryPoint", + "AWS::Backup::ReportPlan", + "AWS::Batch::ComputeEnvironment", + "AWS::Batch::JobQueue", + "AWS::Batch::SchedulingPolicy", + "AWS::Budgets::BudgetsAction", + "AWS::Cassandra::Keyspace", + "AWS::Cloud9::EnvironmentEC2", + "AWS::CloudFormation::Stack", + "AWS::CloudFront::Distribution", + "AWS::CloudFront::StreamingDistribution", + "AWS::CloudTrail::Trail", + "AWS::CloudWatch::Alarm", + "AWS::CloudWatch::MetricStream", + "AWS::CodeArtifact::Repository", + "AWS::CodeBuild::Project", + "AWS::CodeBuild::ReportGroup", + "AWS::CodeDeploy::Application", + "AWS::CodeDeploy::DeploymentConfig", + "AWS::CodeDeploy::DeploymentGroup", + "AWS::CodeGuruProfiler::ProfilingGroup", + "AWS::CodeGuruReviewer::RepositoryAssociation", + "AWS::CodePipeline::Pipeline", + "AWS::Cognito::UserPool", + "AWS::Cognito::UserPoolClient", + "AWS::Cognito::UserPoolGroup", + "AWS::Config::ConformancePackCompliance", + "AWS::Config::ResourceCompliance", + "AWS::Connect::Instance", + "AWS::Connect::PhoneNumber", + "AWS::Connect::QuickConnect", + "AWS::CustomerProfiles::Domain", + "AWS::CustomerProfiles::ObjectType", + "AWS::DMS::Certificate", + "AWS::DMS::Endpoint", + "AWS::DMS::EventSubscription", + "AWS::DMS::ReplicationSubnetGroup", + "AWS::DataSync::LocationEFS", + "AWS::DataSync::LocationFSxLustre", + "AWS::DataSync::LocationFSxWindows", + "AWS::DataSync::LocationHDFS", + "AWS::DataSync::LocationNFS", + "AWS::DataSync::LocationObjectStorage", + "AWS::DataSync::LocationS3", + "AWS::DataSync::LocationSMB", + "AWS::DataSync::Task", + "AWS::Detective::Graph", + "AWS::DeviceFarm::InstanceProfile", + "AWS::DeviceFarm::Project", + "AWS::DeviceFarm::TestGridProject", + "AWS::DynamoDB::Table", + "AWS::EC2::CapacityReservation", + "AWS::EC2::CarrierGateway", + "AWS::EC2::ClientVpnEndpoint", + "AWS::EC2::CustomerGateway", + "AWS::EC2::DHCPOptions", + "AWS::EC2::EC2Fleet", + "AWS::EC2::EIP", + "AWS::EC2::EgressOnlyInternetGateway", + "AWS::EC2::FlowLog", + "AWS::EC2::Host", + "AWS::EC2::IPAM", + "AWS::EC2::IPAMPool", + "AWS::EC2::IPAMScope", + "AWS::EC2::Instance", + "AWS::EC2::InternetGateway", + "AWS::EC2::LaunchTemplate", + "AWS::EC2::NatGateway", + "AWS::EC2::NetworkAcl", + "AWS::EC2::NetworkInsightsAccessScope", + "AWS::EC2::NetworkInsightsAccessScopeAnalysis", + "AWS::EC2::NetworkInsightsAnalysis", + "AWS::EC2::NetworkInsightsPath", + "AWS::EC2::NetworkInterface", + "AWS::EC2::PrefixList", + "AWS::EC2::RegisteredHAInstance", + "AWS::EC2::RouteTable", + "AWS::EC2::SecurityGroup", + "AWS::EC2::SpotFleet", + "AWS::EC2::Subnet", + "AWS::EC2::SubnetRouteTableAssociation", + "AWS::EC2::TrafficMirrorFilter", + "AWS::EC2::TrafficMirrorSession", + "AWS::EC2::TrafficMirrorTarget", + "AWS::EC2::TransitGateway", + "AWS::EC2::TransitGatewayAttachment", + "AWS::EC2::TransitGatewayConnect", + "AWS::EC2::TransitGatewayMulticastDomain", + "AWS::EC2::TransitGatewayRouteTable", + "AWS::EC2::VPC", + "AWS::EC2::VPCEndpoint", + "AWS::EC2::VPCEndpointService", + "AWS::EC2::VPCPeeringConnection", + "AWS::EC2::VPNConnection", + "AWS::EC2::VPNGateway", + "AWS::EC2::Volume", + "AWS::ECR::PublicRepository", + "AWS::ECR::PullThroughCacheRule", + "AWS::ECR::RegistryPolicy", + "AWS::ECR::Repository", + "AWS::ECS::CapacityProvider", + "AWS::ECS::Cluster", + "AWS::ECS::Service", + "AWS::ECS::TaskDefinition", + "AWS::ECS::TaskSet", + "AWS::EFS::AccessPoint", + "AWS::EFS::FileSystem", + "AWS::EKS::Addon", + "AWS::EKS::Cluster", + "AWS::EKS::FargateProfile", + "AWS::EKS::IdentityProviderConfig", + "AWS::EMR::SecurityConfiguration", + "AWS::ElasticBeanstalk::Application", + "AWS::ElasticBeanstalk::ApplicationVersion", + "AWS::ElasticBeanstalk::Environment", + "AWS::ElasticLoadBalancing::LoadBalancer", + "AWS::ElasticLoadBalancingV2::Listener", + "AWS::ElasticLoadBalancingV2::LoadBalancer", + "AWS::Elasticsearch::Domain", + "AWS::EventSchemas::Discoverer", + "AWS::EventSchemas::Registry", + "AWS::EventSchemas::RegistryPolicy", + "AWS::EventSchemas::Schema", + "AWS::Events::ApiDestination", + "AWS::Events::Archive", + "AWS::Events::Connection", + "AWS::Events::Endpoint", + "AWS::Events::EventBus", + "AWS::Events::Rule", + "AWS::Evidently::Launch", + "AWS::Evidently::Project", + "AWS::FIS::ExperimentTemplate", + "AWS::Forecast::Dataset", + "AWS::Forecast::DatasetGroup", + "AWS::FraudDetector::EntityType", + "AWS::FraudDetector::Label", + "AWS::FraudDetector::Outcome", + "AWS::FraudDetector::Variable", + "AWS::GlobalAccelerator::Accelerator", + "AWS::GlobalAccelerator::EndpointGroup", + "AWS::GlobalAccelerator::Listener", + "AWS::Glue::Classifier", + "AWS::Glue::Job", + "AWS::Glue::MLTransform", + "AWS::Grafana::Workspace", + "AWS::GreengrassV2::ComponentVersion", + "AWS::GroundStation::Config", + "AWS::GroundStation::DataflowEndpointGroup", + "AWS::GroundStation::MissionProfile", + "AWS::GuardDuty::Detector", + "AWS::GuardDuty::Filter", + "AWS::GuardDuty::IPSet", + "AWS::GuardDuty::ThreatIntelSet", + "AWS::HealthLake::FHIRDatastore", + "AWS::IAM::Group", + "AWS::IAM::InstanceProfile", + "AWS::IAM::Policy", + "AWS::IAM::Role", + "AWS::IAM::SAMLProvider", + "AWS::IAM::ServerCertificate", + "AWS::IAM::User", + "AWS::IVS::Channel", + "AWS::IVS::PlaybackKeyPair", + "AWS::IVS::RecordingConfiguration", + "AWS::ImageBuilder::ContainerRecipe", + "AWS::ImageBuilder::DistributionConfiguration", + "AWS::ImageBuilder::ImagePipeline", + "AWS::ImageBuilder::ImageRecipe", + "AWS::ImageBuilder::InfrastructureConfiguration", + "AWS::InspectorV2::Filter", + "AWS::IoT::AccountAuditConfiguration", + "AWS::IoT::Authorizer", + "AWS::IoT::CACertificate", + "AWS::IoT::CustomMetric", + "AWS::IoT::Dimension", + "AWS::IoT::FleetMetric", + "AWS::IoT::JobTemplate", + "AWS::IoT::MitigationAction", + "AWS::IoT::Policy", + "AWS::IoT::ProvisioningTemplate", + "AWS::IoT::RoleAlias", + "AWS::IoT::ScheduledAudit", + "AWS::IoT::SecurityProfile", + "AWS::IoTAnalytics::Channel", + "AWS::IoTAnalytics::Dataset", + "AWS::IoTAnalytics::Datastore", + "AWS::IoTAnalytics::Pipeline", + "AWS::IoTEvents::AlarmModel", + "AWS::IoTEvents::DetectorModel", + "AWS::IoTEvents::Input", + "AWS::IoTSiteWise::AssetModel", + "AWS::IoTSiteWise::Dashboard", + "AWS::IoTSiteWise::Gateway", + "AWS::IoTSiteWise::Portal", + "AWS::IoTSiteWise::Project", + "AWS::IoTTwinMaker::ComponentType", + "AWS::IoTTwinMaker::Entity", + "AWS::IoTTwinMaker::Scene", + "AWS::IoTTwinMaker::SyncJob", + "AWS::IoTTwinMaker::Workspace", + "AWS::IoTWireless::FuotaTask", + "AWS::IoTWireless::MulticastGroup", + "AWS::IoTWireless::ServiceProfile", + "AWS::KMS::Alias", + "AWS::KMS::Key", + "AWS::KafkaConnect::Connector", + "AWS::Kendra::Index", + "AWS::Kinesis::Stream", + "AWS::Kinesis::StreamConsumer", + "AWS::KinesisAnalyticsV2::Application", + "AWS::KinesisFirehose::DeliveryStream", + "AWS::KinesisVideo::SignalingChannel", + "AWS::KinesisVideo::Stream", + "AWS::Lambda::CodeSigningConfig", + "AWS::Lambda::Function", + "AWS::Lex::Bot", + "AWS::Lex::BotAlias", + "AWS::Lightsail::Bucket", + "AWS::Lightsail::Certificate", + "AWS::Lightsail::Disk", + "AWS::Lightsail::StaticIp", + "AWS::Logs::Destination", + "AWS::LookoutMetrics::Alert", + "AWS::LookoutVision::Project", + "AWS::M2::Environment", + "AWS::MSK::BatchScramSecret", + "AWS::MSK::Cluster", + "AWS::MSK::Configuration", + "AWS::MediaConnect::FlowEntitlement", + "AWS::MediaConnect::FlowSource", + "AWS::MediaConnect::FlowVpcInterface", + "AWS::MediaPackage::PackagingConfiguration", + "AWS::MediaPackage::PackagingGroup", + "AWS::MediaTailor::PlaybackConfiguration", + "AWS::NetworkFirewall::Firewall", + "AWS::NetworkFirewall::FirewallPolicy", + "AWS::NetworkFirewall::RuleGroup", + "AWS::NetworkManager::ConnectPeer", + "AWS::NetworkManager::CustomerGatewayAssociation", + "AWS::NetworkManager::Device", + "AWS::NetworkManager::GlobalNetwork", + "AWS::NetworkManager::Link", + "AWS::NetworkManager::LinkAssociation", + "AWS::NetworkManager::Site", + "AWS::NetworkManager::TransitGatewayRegistration", + "AWS::OpenSearch::Domain", + "AWS::Panorama::Package", + "AWS::Personalize::Dataset", + "AWS::Personalize::DatasetGroup", + "AWS::Personalize::Schema", + "AWS::Personalize::Solution", + "AWS::Pinpoint::App", + "AWS::Pinpoint::ApplicationSettings", + "AWS::Pinpoint::Campaign", + "AWS::Pinpoint::EmailChannel", + "AWS::Pinpoint::EmailTemplate", + "AWS::Pinpoint::EventStream", + "AWS::Pinpoint::InAppTemplate", + "AWS::Pinpoint::Segment", + "AWS::QLDB::Ledger", + "AWS::QuickSight::DataSource", + "AWS::QuickSight::Template", + "AWS::QuickSight::Theme", + "AWS::RDS::DBCluster", + "AWS::RDS::DBClusterSnapshot", + "AWS::RDS::DBInstance", + "AWS::RDS::DBSecurityGroup", + "AWS::RDS::DBSnapshot", + "AWS::RDS::DBSubnetGroup", + "AWS::RDS::EventSubscription", + "AWS::RDS::GlobalCluster", + "AWS::RDS::OptionGroup", + "AWS::RUM::AppMonitor", + "AWS::Redshift::Cluster", + "AWS::Redshift::ClusterParameterGroup", + "AWS::Redshift::ClusterSecurityGroup", + "AWS::Redshift::ClusterSnapshot", + "AWS::Redshift::ClusterSubnetGroup", + "AWS::Redshift::EndpointAccess", + "AWS::Redshift::EventSubscription", + "AWS::Redshift::ScheduledAction", + "AWS::ResilienceHub::App", + "AWS::ResilienceHub::ResiliencyPolicy", + "AWS::ResourceExplorer2::Index", + "AWS::RoboMaker::RobotApplication", + "AWS::RoboMaker::RobotApplicationVersion", + "AWS::RoboMaker::SimulationApplication", + "AWS::Route53::HostedZone", + "AWS::Route53RecoveryControl::Cluster", + "AWS::Route53RecoveryControl::ControlPanel", + "AWS::Route53RecoveryControl::RoutingControl", + "AWS::Route53RecoveryControl::SafetyRule", + "AWS::Route53RecoveryReadiness::Cell", + "AWS::Route53RecoveryReadiness::ReadinessCheck", + "AWS::Route53RecoveryReadiness::RecoveryGroup", + "AWS::Route53RecoveryReadiness::ResourceSet", + "AWS::Route53Resolver::FirewallDomainList", + "AWS::Route53Resolver::FirewallRuleGroup", + "AWS::Route53Resolver::FirewallRuleGroupAssociation", + "AWS::Route53Resolver::ResolverEndpoint", + "AWS::Route53Resolver::ResolverQueryLoggingConfig", + "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation", + "AWS::Route53Resolver::ResolverRule", + "AWS::Route53Resolver::ResolverRuleAssociation", + "AWS::S3::AccessPoint", + "AWS::S3::AccountPublicAccessBlock", + "AWS::S3::Bucket", + "AWS::S3::MultiRegionAccessPoint", + "AWS::S3::StorageLens", + "AWS::SES::ConfigurationSet", + "AWS::SES::ContactList", + "AWS::SES::ReceiptFilter", + "AWS::SES::ReceiptRuleSet", + "AWS::SES::Template", + "AWS::SNS::Topic", + "AWS::SQS::Queue", + "AWS::SSM::AssociationCompliance", + "AWS::SSM::Document", + "AWS::SSM::FileData", + "AWS::SSM::ManagedInstanceInventory", + "AWS::SSM::PatchCompliance", + "AWS::SageMaker::AppImageConfig", + "AWS::SageMaker::CodeRepository", + "AWS::SageMaker::Domain", + "AWS::SageMaker::FeatureGroup", + "AWS::SageMaker::Image", + "AWS::SageMaker::Model", + "AWS::SageMaker::NotebookInstanceLifecycleConfig", + "AWS::SageMaker::Workteam", + "AWS::SecretsManager::Secret", + "AWS::ServiceCatalog::CloudFormationProduct", + "AWS::ServiceCatalog::CloudFormationProvisionedProduct", + "AWS::ServiceCatalog::Portfolio", + "AWS::ServiceDiscovery::HttpNamespace", + "AWS::ServiceDiscovery::Instance", + "AWS::ServiceDiscovery::PublicDnsNamespace", + "AWS::ServiceDiscovery::Service", + "AWS::Shield::Protection", + "AWS::ShieldRegional::Protection", + "AWS::Signer::SigningProfile", + "AWS::StepFunctions::Activity", + "AWS::StepFunctions::StateMachine", + "AWS::Transfer::Agreement", + "AWS::Transfer::Certificate", + "AWS::Transfer::Connector", + "AWS::Transfer::Workflow", + "AWS::WAF::RateBasedRule", + "AWS::WAF::Rule", + "AWS::WAF::RuleGroup", + "AWS::WAF::WebACL", + "AWS::WAFRegional::RateBasedRule", + "AWS::WAFRegional::Rule", + "AWS::WAFRegional::RuleGroup", + "AWS::WAFRegional::WebACL", + "AWS::WAFv2::IPSet", + "AWS::WAFv2::ManagedRuleSet", + "AWS::WAFv2::RegexPatternSet", + "AWS::WAFv2::RuleGroup", + "AWS::WAFv2::WebACL", + "AWS::WorkSpaces::ConnectionAlias", + "AWS::WorkSpaces::Workspace", + "AWS::XRay::EncryptionConfig" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true, + "values": [ + { + "name": "AWSACMCertificate", + "value": "AWS::ACM::Certificate", + "description": "ResourceType enum AWS::ACM::Certificate" + }, + { + "name": "AWSACMPCACertificateAuthority", + "value": "AWS::ACMPCA::CertificateAuthority", + "description": "ResourceType enum AWS::ACMPCA::CertificateAuthority" + }, + { + "name": "AWSACMPCACertificateAuthorityActivation", + "value": "AWS::ACMPCA::CertificateAuthorityActivation", + "description": "ResourceType enum AWS::ACMPCA::CertificateAuthorityActivation" + }, + { + "name": "AWSAPSRuleGroupsNamespace", + "value": "AWS::APS::RuleGroupsNamespace", + "description": "ResourceType enum AWS::APS::RuleGroupsNamespace" + }, + { + "name": "AWSAccessAnalyzerAnalyzer", + "value": "AWS::AccessAnalyzer::Analyzer", + "description": "ResourceType enum AWS::AccessAnalyzer::Analyzer" + }, + { + "name": "AWSAmazonMQBroker", + "value": "AWS::AmazonMQ::Broker", + "description": "ResourceType enum AWS::AmazonMQ::Broker" + }, + { + "name": "AWSAmplifyApp", + "value": "AWS::Amplify::App", + "description": "ResourceType enum AWS::Amplify::App" + }, + { + "name": "AWSAmplifyBranch", + "value": "AWS::Amplify::Branch", + "description": "ResourceType enum AWS::Amplify::Branch" + }, + { + "name": "AWSApiGatewayRestApi", + "value": "AWS::ApiGateway::RestApi", + "description": "ResourceType enum AWS::ApiGateway::RestApi" + }, + { + "name": "AWSApiGatewayStage", + "value": "AWS::ApiGateway::Stage", + "description": "ResourceType enum AWS::ApiGateway::Stage" + }, + { + "name": "AWSApiGatewayV2Api", + "value": "AWS::ApiGatewayV2::Api", + "description": "ResourceType enum AWS::ApiGatewayV2::Api" + }, + { + "name": "AWSApiGatewayV2Stage", + "value": "AWS::ApiGatewayV2::Stage", + "description": "ResourceType enum AWS::ApiGatewayV2::Stage" + }, + { + "name": "AWSAppConfigApplication", + "value": "AWS::AppConfig::Application", + "description": "ResourceType enum AWS::AppConfig::Application" + }, + { + "name": "AWSAppConfigConfigurationProfile", + "value": "AWS::AppConfig::ConfigurationProfile", + "description": "ResourceType enum AWS::AppConfig::ConfigurationProfile" + }, + { + "name": "AWSAppConfigDeploymentStrategy", + "value": "AWS::AppConfig::DeploymentStrategy", + "description": "ResourceType enum AWS::AppConfig::DeploymentStrategy" + }, + { + "name": "AWSAppConfigEnvironment", + "value": "AWS::AppConfig::Environment", + "description": "ResourceType enum AWS::AppConfig::Environment" + }, + { + "name": "AWSAppConfigHostedConfigurationVersion", + "value": "AWS::AppConfig::HostedConfigurationVersion", + "description": "ResourceType enum AWS::AppConfig::HostedConfigurationVersion" + }, + { + "name": "AWSAppFlowFlow", + "value": "AWS::AppFlow::Flow", + "description": "ResourceType enum AWS::AppFlow::Flow" + }, + { + "name": "AWSAppIntegrationsEventIntegration", + "value": "AWS::AppIntegrations::EventIntegration", + "description": "ResourceType enum AWS::AppIntegrations::EventIntegration" + }, + { + "name": "AWSAppMeshGatewayRoute", + "value": "AWS::AppMesh::GatewayRoute", + "description": "ResourceType enum AWS::AppMesh::GatewayRoute" + }, + { + "name": "AWSAppMeshMesh", + "value": "AWS::AppMesh::Mesh", + "description": "ResourceType enum AWS::AppMesh::Mesh" + }, + { + "name": "AWSAppMeshRoute", + "value": "AWS::AppMesh::Route", + "description": "ResourceType enum AWS::AppMesh::Route" + }, + { + "name": "AWSAppMeshVirtualGateway", + "value": "AWS::AppMesh::VirtualGateway", + "description": "ResourceType enum AWS::AppMesh::VirtualGateway" + }, + { + "name": "AWSAppMeshVirtualNode", + "value": "AWS::AppMesh::VirtualNode", + "description": "ResourceType enum AWS::AppMesh::VirtualNode" + }, + { + "name": "AWSAppMeshVirtualRouter", + "value": "AWS::AppMesh::VirtualRouter", + "description": "ResourceType enum AWS::AppMesh::VirtualRouter" + }, + { + "name": "AWSAppMeshVirtualService", + "value": "AWS::AppMesh::VirtualService", + "description": "ResourceType enum AWS::AppMesh::VirtualService" + }, + { + "name": "AWSAppRunnerService", + "value": "AWS::AppRunner::Service", + "description": "ResourceType enum AWS::AppRunner::Service" + }, + { + "name": "AWSAppRunnerVpcConnector", + "value": "AWS::AppRunner::VpcConnector", + "description": "ResourceType enum AWS::AppRunner::VpcConnector" + }, + { + "name": "AWSAppStreamApplication", + "value": "AWS::AppStream::Application", + "description": "ResourceType enum AWS::AppStream::Application" + }, + { + "name": "AWSAppStreamDirectoryConfig", + "value": "AWS::AppStream::DirectoryConfig", + "description": "ResourceType enum AWS::AppStream::DirectoryConfig" + }, + { + "name": "AWSAppStreamFleet", + "value": "AWS::AppStream::Fleet", + "description": "ResourceType enum AWS::AppStream::Fleet" + }, + { + "name": "AWSAppStreamStack", + "value": "AWS::AppStream::Stack", + "description": "ResourceType enum AWS::AppStream::Stack" + }, + { + "name": "AWSAppSyncGraphQLApi", + "value": "AWS::AppSync::GraphQLApi", + "description": "ResourceType enum AWS::AppSync::GraphQLApi" + }, + { + "name": "AWSAthenaDataCatalog", + "value": "AWS::Athena::DataCatalog", + "description": "ResourceType enum AWS::Athena::DataCatalog" + }, + { + "name": "AWSAthenaPreparedStatement", + "value": "AWS::Athena::PreparedStatement", + "description": "ResourceType enum AWS::Athena::PreparedStatement" + }, + { + "name": "AWSAthenaWorkGroup", + "value": "AWS::Athena::WorkGroup", + "description": "ResourceType enum AWS::Athena::WorkGroup" + }, + { + "name": "AWSAuditManagerAssessment", + "value": "AWS::AuditManager::Assessment", + "description": "ResourceType enum AWS::AuditManager::Assessment" + }, + { + "name": "AWSAutoScalingAutoScalingGroup", + "value": "AWS::AutoScaling::AutoScalingGroup", + "description": "ResourceType enum AWS::AutoScaling::AutoScalingGroup" + }, + { + "name": "AWSAutoScalingLaunchConfiguration", + "value": "AWS::AutoScaling::LaunchConfiguration", + "description": "ResourceType enum AWS::AutoScaling::LaunchConfiguration" + }, + { + "name": "AWSAutoScalingScalingPolicy", + "value": "AWS::AutoScaling::ScalingPolicy", + "description": "ResourceType enum AWS::AutoScaling::ScalingPolicy" + }, + { + "name": "AWSAutoScalingScheduledAction", + "value": "AWS::AutoScaling::ScheduledAction", + "description": "ResourceType enum AWS::AutoScaling::ScheduledAction" + }, + { + "name": "AWSAutoScalingWarmPool", + "value": "AWS::AutoScaling::WarmPool", + "description": "ResourceType enum AWS::AutoScaling::WarmPool" + }, + { + "name": "AWSBackupBackupPlan", + "value": "AWS::Backup::BackupPlan", + "description": "ResourceType enum AWS::Backup::BackupPlan" + }, + { + "name": "AWSBackupBackupSelection", + "value": "AWS::Backup::BackupSelection", + "description": "ResourceType enum AWS::Backup::BackupSelection" + }, + { + "name": "AWSBackupBackupVault", + "value": "AWS::Backup::BackupVault", + "description": "ResourceType enum AWS::Backup::BackupVault" + }, + { + "name": "AWSBackupRecoveryPoint", + "value": "AWS::Backup::RecoveryPoint", + "description": "ResourceType enum AWS::Backup::RecoveryPoint" + }, + { + "name": "AWSBackupReportPlan", + "value": "AWS::Backup::ReportPlan", + "description": "ResourceType enum AWS::Backup::ReportPlan" + }, + { + "name": "AWSBatchComputeEnvironment", + "value": "AWS::Batch::ComputeEnvironment", + "description": "ResourceType enum AWS::Batch::ComputeEnvironment" + }, + { + "name": "AWSBatchJobQueue", + "value": "AWS::Batch::JobQueue", + "description": "ResourceType enum AWS::Batch::JobQueue" + }, + { + "name": "AWSBatchSchedulingPolicy", + "value": "AWS::Batch::SchedulingPolicy", + "description": "ResourceType enum AWS::Batch::SchedulingPolicy" + }, + { + "name": "AWSBudgetsBudgetsAction", + "value": "AWS::Budgets::BudgetsAction", + "description": "ResourceType enum AWS::Budgets::BudgetsAction" + }, + { + "name": "AWSCassandraKeyspace", + "value": "AWS::Cassandra::Keyspace", + "description": "ResourceType enum AWS::Cassandra::Keyspace" + }, + { + "name": "AWSCloud9EnvironmentEC2", + "value": "AWS::Cloud9::EnvironmentEC2", + "description": "ResourceType enum AWS::Cloud9::EnvironmentEC2" + }, + { + "name": "AWSCloudFormationStack", + "value": "AWS::CloudFormation::Stack", + "description": "ResourceType enum AWS::CloudFormation::Stack" + }, + { + "name": "AWSCloudFrontDistribution", + "value": "AWS::CloudFront::Distribution", + "description": "ResourceType enum AWS::CloudFront::Distribution" + }, + { + "name": "AWSCloudFrontStreamingDistribution", + "value": "AWS::CloudFront::StreamingDistribution", + "description": "ResourceType enum AWS::CloudFront::StreamingDistribution" + }, + { + "name": "AWSCloudTrailTrail", + "value": "AWS::CloudTrail::Trail", + "description": "ResourceType enum AWS::CloudTrail::Trail" + }, + { + "name": "AWSCloudWatchAlarm", + "value": "AWS::CloudWatch::Alarm", + "description": "ResourceType enum AWS::CloudWatch::Alarm" + }, + { + "name": "AWSCloudWatchMetricStream", + "value": "AWS::CloudWatch::MetricStream", + "description": "ResourceType enum AWS::CloudWatch::MetricStream" + }, + { + "name": "AWSCodeArtifactRepository", + "value": "AWS::CodeArtifact::Repository", + "description": "ResourceType enum AWS::CodeArtifact::Repository" + }, + { + "name": "AWSCodeBuildProject", + "value": "AWS::CodeBuild::Project", + "description": "ResourceType enum AWS::CodeBuild::Project" + }, + { + "name": "AWSCodeBuildReportGroup", + "value": "AWS::CodeBuild::ReportGroup", + "description": "ResourceType enum AWS::CodeBuild::ReportGroup" + }, + { + "name": "AWSCodeDeployApplication", + "value": "AWS::CodeDeploy::Application", + "description": "ResourceType enum AWS::CodeDeploy::Application" + }, + { + "name": "AWSCodeDeployDeploymentConfig", + "value": "AWS::CodeDeploy::DeploymentConfig", + "description": "ResourceType enum AWS::CodeDeploy::DeploymentConfig" + }, + { + "name": "AWSCodeDeployDeploymentGroup", + "value": "AWS::CodeDeploy::DeploymentGroup", + "description": "ResourceType enum AWS::CodeDeploy::DeploymentGroup" + }, + { + "name": "AWSCodeGuruProfilerProfilingGroup", + "value": "AWS::CodeGuruProfiler::ProfilingGroup", + "description": "ResourceType enum AWS::CodeGuruProfiler::ProfilingGroup" + }, + { + "name": "AWSCodeGuruReviewerRepositoryAssociation", + "value": "AWS::CodeGuruReviewer::RepositoryAssociation", + "description": "ResourceType enum AWS::CodeGuruReviewer::RepositoryAssociation" + }, + { + "name": "AWSCodePipelinePipeline", + "value": "AWS::CodePipeline::Pipeline", + "description": "ResourceType enum AWS::CodePipeline::Pipeline" + }, + { + "name": "AWSCognitoUserPool", + "value": "AWS::Cognito::UserPool", + "description": "ResourceType enum AWS::Cognito::UserPool" + }, + { + "name": "AWSCognitoUserPoolClient", + "value": "AWS::Cognito::UserPoolClient", + "description": "ResourceType enum AWS::Cognito::UserPoolClient" + }, + { + "name": "AWSCognitoUserPoolGroup", + "value": "AWS::Cognito::UserPoolGroup", + "description": "ResourceType enum AWS::Cognito::UserPoolGroup" + }, + { + "name": "AWSConfigConformancePackCompliance", + "value": "AWS::Config::ConformancePackCompliance", + "description": "ResourceType enum AWS::Config::ConformancePackCompliance" + }, + { + "name": "AWSConfigResourceCompliance", + "value": "AWS::Config::ResourceCompliance", + "description": "ResourceType enum AWS::Config::ResourceCompliance" + }, + { + "name": "AWSConnectInstance", + "value": "AWS::Connect::Instance", + "description": "ResourceType enum AWS::Connect::Instance" + }, + { + "name": "AWSConnectPhoneNumber", + "value": "AWS::Connect::PhoneNumber", + "description": "ResourceType enum AWS::Connect::PhoneNumber" + }, + { + "name": "AWSConnectQuickConnect", + "value": "AWS::Connect::QuickConnect", + "description": "ResourceType enum AWS::Connect::QuickConnect" + }, + { + "name": "AWSCustomerProfilesDomain", + "value": "AWS::CustomerProfiles::Domain", + "description": "ResourceType enum AWS::CustomerProfiles::Domain" + }, + { + "name": "AWSCustomerProfilesObjectType", + "value": "AWS::CustomerProfiles::ObjectType", + "description": "ResourceType enum AWS::CustomerProfiles::ObjectType" + }, + { + "name": "AWSDMSCertificate", + "value": "AWS::DMS::Certificate", + "description": "ResourceType enum AWS::DMS::Certificate" + }, + { + "name": "AWSDMSEndpoint", + "value": "AWS::DMS::Endpoint", + "description": "ResourceType enum AWS::DMS::Endpoint" + }, + { + "name": "AWSDMSEventSubscription", + "value": "AWS::DMS::EventSubscription", + "description": "ResourceType enum AWS::DMS::EventSubscription" + }, + { + "name": "AWSDMSReplicationSubnetGroup", + "value": "AWS::DMS::ReplicationSubnetGroup", + "description": "ResourceType enum AWS::DMS::ReplicationSubnetGroup" + }, + { + "name": "AWSDataSyncLocationEFS", + "value": "AWS::DataSync::LocationEFS", + "description": "ResourceType enum AWS::DataSync::LocationEFS" + }, + { + "name": "AWSDataSyncLocationFSxLustre", + "value": "AWS::DataSync::LocationFSxLustre", + "description": "ResourceType enum AWS::DataSync::LocationFSxLustre" + }, + { + "name": "AWSDataSyncLocationFSxWindows", + "value": "AWS::DataSync::LocationFSxWindows", + "description": "ResourceType enum AWS::DataSync::LocationFSxWindows" + }, + { + "name": "AWSDataSyncLocationHDFS", + "value": "AWS::DataSync::LocationHDFS", + "description": "ResourceType enum AWS::DataSync::LocationHDFS" + }, + { + "name": "AWSDataSyncLocationNFS", + "value": "AWS::DataSync::LocationNFS", + "description": "ResourceType enum AWS::DataSync::LocationNFS" + }, + { + "name": "AWSDataSyncLocationObjectStorage", + "value": "AWS::DataSync::LocationObjectStorage", + "description": "ResourceType enum AWS::DataSync::LocationObjectStorage" + }, + { + "name": "AWSDataSyncLocationS3", + "value": "AWS::DataSync::LocationS3", + "description": "ResourceType enum AWS::DataSync::LocationS3" + }, + { + "name": "AWSDataSyncLocationSMB", + "value": "AWS::DataSync::LocationSMB", + "description": "ResourceType enum AWS::DataSync::LocationSMB" + }, + { + "name": "AWSDataSyncTask", + "value": "AWS::DataSync::Task", + "description": "ResourceType enum AWS::DataSync::Task" + }, + { + "name": "AWSDetectiveGraph", + "value": "AWS::Detective::Graph", + "description": "ResourceType enum AWS::Detective::Graph" + }, + { + "name": "AWSDeviceFarmInstanceProfile", + "value": "AWS::DeviceFarm::InstanceProfile", + "description": "ResourceType enum AWS::DeviceFarm::InstanceProfile" + }, + { + "name": "AWSDeviceFarmProject", + "value": "AWS::DeviceFarm::Project", + "description": "ResourceType enum AWS::DeviceFarm::Project" + }, + { + "name": "AWSDeviceFarmTestGridProject", + "value": "AWS::DeviceFarm::TestGridProject", + "description": "ResourceType enum AWS::DeviceFarm::TestGridProject" + }, + { + "name": "AWSDynamoDBTable", + "value": "AWS::DynamoDB::Table", + "description": "ResourceType enum AWS::DynamoDB::Table" + }, + { + "name": "AWSEC2CapacityReservation", + "value": "AWS::EC2::CapacityReservation", + "description": "ResourceType enum AWS::EC2::CapacityReservation" + }, + { + "name": "AWSEC2CarrierGateway", + "value": "AWS::EC2::CarrierGateway", + "description": "ResourceType enum AWS::EC2::CarrierGateway" + }, + { + "name": "AWSEC2ClientVpnEndpoint", + "value": "AWS::EC2::ClientVpnEndpoint", + "description": "ResourceType enum AWS::EC2::ClientVpnEndpoint" + }, + { + "name": "AWSEC2CustomerGateway", + "value": "AWS::EC2::CustomerGateway", + "description": "ResourceType enum AWS::EC2::CustomerGateway" + }, + { + "name": "AWSEC2DHCPOptions", + "value": "AWS::EC2::DHCPOptions", + "description": "ResourceType enum AWS::EC2::DHCPOptions" + }, + { + "name": "AWSEC2EC2Fleet", + "value": "AWS::EC2::EC2Fleet", + "description": "ResourceType enum AWS::EC2::EC2Fleet" + }, + { + "name": "AWSEC2EIP", + "value": "AWS::EC2::EIP", + "description": "ResourceType enum AWS::EC2::EIP" + }, + { + "name": "AWSEC2EgressOnlyInternetGateway", + "value": "AWS::EC2::EgressOnlyInternetGateway", + "description": "ResourceType enum AWS::EC2::EgressOnlyInternetGateway" + }, + { + "name": "AWSEC2FlowLog", + "value": "AWS::EC2::FlowLog", + "description": "ResourceType enum AWS::EC2::FlowLog" + }, + { + "name": "AWSEC2Host", + "value": "AWS::EC2::Host", + "description": "ResourceType enum AWS::EC2::Host" + }, + { + "name": "AWSEC2IPAM", + "value": "AWS::EC2::IPAM", + "description": "ResourceType enum AWS::EC2::IPAM" + }, + { + "name": "AWSEC2IPAMPool", + "value": "AWS::EC2::IPAMPool", + "description": "ResourceType enum AWS::EC2::IPAMPool" + }, + { + "name": "AWSEC2IPAMScope", + "value": "AWS::EC2::IPAMScope", + "description": "ResourceType enum AWS::EC2::IPAMScope" + }, + { + "name": "AWSEC2Instance", + "value": "AWS::EC2::Instance", + "description": "ResourceType enum AWS::EC2::Instance" + }, + { + "name": "AWSEC2InternetGateway", + "value": "AWS::EC2::InternetGateway", + "description": "ResourceType enum AWS::EC2::InternetGateway" + }, + { + "name": "AWSEC2LaunchTemplate", + "value": "AWS::EC2::LaunchTemplate", + "description": "ResourceType enum AWS::EC2::LaunchTemplate" + }, + { + "name": "AWSEC2NatGateway", + "value": "AWS::EC2::NatGateway", + "description": "ResourceType enum AWS::EC2::NatGateway" + }, + { + "name": "AWSEC2NetworkAcl", + "value": "AWS::EC2::NetworkAcl", + "description": "ResourceType enum AWS::EC2::NetworkAcl" + }, + { + "name": "AWSEC2NetworkInsightsAccessScope", + "value": "AWS::EC2::NetworkInsightsAccessScope", + "description": "ResourceType enum AWS::EC2::NetworkInsightsAccessScope" + }, + { + "name": "AWSEC2NetworkInsightsAccessScopeAnalysis", + "value": "AWS::EC2::NetworkInsightsAccessScopeAnalysis", + "description": "ResourceType enum AWS::EC2::NetworkInsightsAccessScopeAnalysis" + }, + { + "name": "AWSEC2NetworkInsightsAnalysis", + "value": "AWS::EC2::NetworkInsightsAnalysis", + "description": "ResourceType enum AWS::EC2::NetworkInsightsAnalysis" + }, + { + "name": "AWSEC2NetworkInsightsPath", + "value": "AWS::EC2::NetworkInsightsPath", + "description": "ResourceType enum AWS::EC2::NetworkInsightsPath" + }, + { + "name": "AWSEC2NetworkInterface", + "value": "AWS::EC2::NetworkInterface", + "description": "ResourceType enum AWS::EC2::NetworkInterface" + }, + { + "name": "AWSEC2PrefixList", + "value": "AWS::EC2::PrefixList", + "description": "ResourceType enum AWS::EC2::PrefixList" + }, + { + "name": "AWSEC2RegisteredHAInstance", + "value": "AWS::EC2::RegisteredHAInstance", + "description": "ResourceType enum AWS::EC2::RegisteredHAInstance" + }, + { + "name": "AWSEC2RouteTable", + "value": "AWS::EC2::RouteTable", + "description": "ResourceType enum AWS::EC2::RouteTable" + }, + { + "name": "AWSEC2SecurityGroup", + "value": "AWS::EC2::SecurityGroup", + "description": "ResourceType enum AWS::EC2::SecurityGroup" + }, + { + "name": "AWSEC2SpotFleet", + "value": "AWS::EC2::SpotFleet", + "description": "ResourceType enum AWS::EC2::SpotFleet" + }, + { + "name": "AWSEC2Subnet", + "value": "AWS::EC2::Subnet", + "description": "ResourceType enum AWS::EC2::Subnet" + }, + { + "name": "AWSEC2SubnetRouteTableAssociation", + "value": "AWS::EC2::SubnetRouteTableAssociation", + "description": "ResourceType enum AWS::EC2::SubnetRouteTableAssociation" + }, + { + "name": "AWSEC2TrafficMirrorFilter", + "value": "AWS::EC2::TrafficMirrorFilter", + "description": "ResourceType enum AWS::EC2::TrafficMirrorFilter" + }, + { + "name": "AWSEC2TrafficMirrorSession", + "value": "AWS::EC2::TrafficMirrorSession", + "description": "ResourceType enum AWS::EC2::TrafficMirrorSession" + }, + { + "name": "AWSEC2TrafficMirrorTarget", + "value": "AWS::EC2::TrafficMirrorTarget", + "description": "ResourceType enum AWS::EC2::TrafficMirrorTarget" + }, + { + "name": "AWSEC2TransitGateway", + "value": "AWS::EC2::TransitGateway", + "description": "ResourceType enum AWS::EC2::TransitGateway" + }, + { + "name": "AWSEC2TransitGatewayAttachment", + "value": "AWS::EC2::TransitGatewayAttachment", + "description": "ResourceType enum AWS::EC2::TransitGatewayAttachment" + }, + { + "name": "AWSEC2TransitGatewayConnect", + "value": "AWS::EC2::TransitGatewayConnect", + "description": "ResourceType enum AWS::EC2::TransitGatewayConnect" + }, + { + "name": "AWSEC2TransitGatewayMulticastDomain", + "value": "AWS::EC2::TransitGatewayMulticastDomain", + "description": "ResourceType enum AWS::EC2::TransitGatewayMulticastDomain" + }, + { + "name": "AWSEC2TransitGatewayRouteTable", + "value": "AWS::EC2::TransitGatewayRouteTable", + "description": "ResourceType enum AWS::EC2::TransitGatewayRouteTable" + }, + { + "name": "AWSEC2VPC", + "value": "AWS::EC2::VPC", + "description": "ResourceType enum AWS::EC2::VPC" + }, + { + "name": "AWSEC2VPCEndpoint", + "value": "AWS::EC2::VPCEndpoint", + "description": "ResourceType enum AWS::EC2::VPCEndpoint" + }, + { + "name": "AWSEC2VPCEndpointService", + "value": "AWS::EC2::VPCEndpointService", + "description": "ResourceType enum AWS::EC2::VPCEndpointService" + }, + { + "name": "AWSEC2VPCPeeringConnection", + "value": "AWS::EC2::VPCPeeringConnection", + "description": "ResourceType enum AWS::EC2::VPCPeeringConnection" + }, + { + "name": "AWSEC2VPNConnection", + "value": "AWS::EC2::VPNConnection", + "description": "ResourceType enum AWS::EC2::VPNConnection" + }, + { + "name": "AWSEC2VPNGateway", + "value": "AWS::EC2::VPNGateway", + "description": "ResourceType enum AWS::EC2::VPNGateway" + }, + { + "name": "AWSEC2Volume", + "value": "AWS::EC2::Volume", + "description": "ResourceType enum AWS::EC2::Volume" + }, + { + "name": "AWSECRPublicRepository", + "value": "AWS::ECR::PublicRepository", + "description": "ResourceType enum AWS::ECR::PublicRepository" + }, + { + "name": "AWSECRPullThroughCacheRule", + "value": "AWS::ECR::PullThroughCacheRule", + "description": "ResourceType enum AWS::ECR::PullThroughCacheRule" + }, + { + "name": "AWSECRRegistryPolicy", + "value": "AWS::ECR::RegistryPolicy", + "description": "ResourceType enum AWS::ECR::RegistryPolicy" + }, + { + "name": "AWSECRRepository", + "value": "AWS::ECR::Repository", + "description": "ResourceType enum AWS::ECR::Repository" + }, + { + "name": "AWSECSCapacityProvider", + "value": "AWS::ECS::CapacityProvider", + "description": "ResourceType enum AWS::ECS::CapacityProvider" + }, + { + "name": "AWSECSCluster", + "value": "AWS::ECS::Cluster", + "description": "ResourceType enum AWS::ECS::Cluster" + }, + { + "name": "AWSECSService", + "value": "AWS::ECS::Service", + "description": "ResourceType enum AWS::ECS::Service" + }, + { + "name": "AWSECSTaskDefinition", + "value": "AWS::ECS::TaskDefinition", + "description": "ResourceType enum AWS::ECS::TaskDefinition" + }, + { + "name": "AWSECSTaskSet", + "value": "AWS::ECS::TaskSet", + "description": "ResourceType enum AWS::ECS::TaskSet" + }, + { + "name": "AWSEFSAccessPoint", + "value": "AWS::EFS::AccessPoint", + "description": "ResourceType enum AWS::EFS::AccessPoint" + }, + { + "name": "AWSEFSFileSystem", + "value": "AWS::EFS::FileSystem", + "description": "ResourceType enum AWS::EFS::FileSystem" + }, + { + "name": "AWSEKSAddon", + "value": "AWS::EKS::Addon", + "description": "ResourceType enum AWS::EKS::Addon" + }, + { + "name": "AWSEKSCluster", + "value": "AWS::EKS::Cluster", + "description": "ResourceType enum AWS::EKS::Cluster" + }, + { + "name": "AWSEKSFargateProfile", + "value": "AWS::EKS::FargateProfile", + "description": "ResourceType enum AWS::EKS::FargateProfile" + }, + { + "name": "AWSEKSIdentityProviderConfig", + "value": "AWS::EKS::IdentityProviderConfig", + "description": "ResourceType enum AWS::EKS::IdentityProviderConfig" + }, + { + "name": "AWSEMRSecurityConfiguration", + "value": "AWS::EMR::SecurityConfiguration", + "description": "ResourceType enum AWS::EMR::SecurityConfiguration" + }, + { + "name": "AWSElasticBeanstalkApplication", + "value": "AWS::ElasticBeanstalk::Application", + "description": "ResourceType enum AWS::ElasticBeanstalk::Application" + }, + { + "name": "AWSElasticBeanstalkApplicationVersion", + "value": "AWS::ElasticBeanstalk::ApplicationVersion", + "description": "ResourceType enum AWS::ElasticBeanstalk::ApplicationVersion" + }, + { + "name": "AWSElasticBeanstalkEnvironment", + "value": "AWS::ElasticBeanstalk::Environment", + "description": "ResourceType enum AWS::ElasticBeanstalk::Environment" + }, + { + "name": "AWSElasticLoadBalancingLoadBalancer", + "value": "AWS::ElasticLoadBalancing::LoadBalancer", + "description": "ResourceType enum AWS::ElasticLoadBalancing::LoadBalancer" + }, + { + "name": "AWSElasticLoadBalancingV2Listener", + "value": "AWS::ElasticLoadBalancingV2::Listener", + "description": "ResourceType enum AWS::ElasticLoadBalancingV2::Listener" + }, + { + "name": "AWSElasticLoadBalancingV2LoadBalancer", + "value": "AWS::ElasticLoadBalancingV2::LoadBalancer", + "description": "ResourceType enum AWS::ElasticLoadBalancingV2::LoadBalancer" + }, + { + "name": "AWSElasticsearchDomain", + "value": "AWS::Elasticsearch::Domain", + "description": "ResourceType enum AWS::Elasticsearch::Domain" + }, + { + "name": "AWSEventSchemasDiscoverer", + "value": "AWS::EventSchemas::Discoverer", + "description": "ResourceType enum AWS::EventSchemas::Discoverer" + }, + { + "name": "AWSEventSchemasRegistry", + "value": "AWS::EventSchemas::Registry", + "description": "ResourceType enum AWS::EventSchemas::Registry" + }, + { + "name": "AWSEventSchemasRegistryPolicy", + "value": "AWS::EventSchemas::RegistryPolicy", + "description": "ResourceType enum AWS::EventSchemas::RegistryPolicy" + }, + { + "name": "AWSEventSchemasSchema", + "value": "AWS::EventSchemas::Schema", + "description": "ResourceType enum AWS::EventSchemas::Schema" + }, + { + "name": "AWSEventsApiDestination", + "value": "AWS::Events::ApiDestination", + "description": "ResourceType enum AWS::Events::ApiDestination" + }, + { + "name": "AWSEventsArchive", + "value": "AWS::Events::Archive", + "description": "ResourceType enum AWS::Events::Archive" + }, + { + "name": "AWSEventsConnection", + "value": "AWS::Events::Connection", + "description": "ResourceType enum AWS::Events::Connection" + }, + { + "name": "AWSEventsEndpoint", + "value": "AWS::Events::Endpoint", + "description": "ResourceType enum AWS::Events::Endpoint" + }, + { + "name": "AWSEventsEventBus", + "value": "AWS::Events::EventBus", + "description": "ResourceType enum AWS::Events::EventBus" + }, + { + "name": "AWSEventsRule", + "value": "AWS::Events::Rule", + "description": "ResourceType enum AWS::Events::Rule" + }, + { + "name": "AWSEvidentlyLaunch", + "value": "AWS::Evidently::Launch", + "description": "ResourceType enum AWS::Evidently::Launch" + }, + { + "name": "AWSEvidentlyProject", + "value": "AWS::Evidently::Project", + "description": "ResourceType enum AWS::Evidently::Project" + }, + { + "name": "AWSFISExperimentTemplate", + "value": "AWS::FIS::ExperimentTemplate", + "description": "ResourceType enum AWS::FIS::ExperimentTemplate" + }, + { + "name": "AWSForecastDataset", + "value": "AWS::Forecast::Dataset", + "description": "ResourceType enum AWS::Forecast::Dataset" + }, + { + "name": "AWSForecastDatasetGroup", + "value": "AWS::Forecast::DatasetGroup", + "description": "ResourceType enum AWS::Forecast::DatasetGroup" + }, + { + "name": "AWSFraudDetectorEntityType", + "value": "AWS::FraudDetector::EntityType", + "description": "ResourceType enum AWS::FraudDetector::EntityType" + }, + { + "name": "AWSFraudDetectorLabel", + "value": "AWS::FraudDetector::Label", + "description": "ResourceType enum AWS::FraudDetector::Label" + }, + { + "name": "AWSFraudDetectorOutcome", + "value": "AWS::FraudDetector::Outcome", + "description": "ResourceType enum AWS::FraudDetector::Outcome" + }, + { + "name": "AWSFraudDetectorVariable", + "value": "AWS::FraudDetector::Variable", + "description": "ResourceType enum AWS::FraudDetector::Variable" + }, + { + "name": "AWSGlobalAcceleratorAccelerator", + "value": "AWS::GlobalAccelerator::Accelerator", + "description": "ResourceType enum AWS::GlobalAccelerator::Accelerator" + }, + { + "name": "AWSGlobalAcceleratorEndpointGroup", + "value": "AWS::GlobalAccelerator::EndpointGroup", + "description": "ResourceType enum AWS::GlobalAccelerator::EndpointGroup" + }, + { + "name": "AWSGlobalAcceleratorListener", + "value": "AWS::GlobalAccelerator::Listener", + "description": "ResourceType enum AWS::GlobalAccelerator::Listener" + }, + { + "name": "AWSGlueClassifier", + "value": "AWS::Glue::Classifier", + "description": "ResourceType enum AWS::Glue::Classifier" + }, + { + "name": "AWSGlueJob", + "value": "AWS::Glue::Job", + "description": "ResourceType enum AWS::Glue::Job" + }, + { + "name": "AWSGlueMLTransform", + "value": "AWS::Glue::MLTransform", + "description": "ResourceType enum AWS::Glue::MLTransform" + }, + { + "name": "AWSGrafanaWorkspace", + "value": "AWS::Grafana::Workspace", + "description": "ResourceType enum AWS::Grafana::Workspace" + }, + { + "name": "AWSGreengrassV2ComponentVersion", + "value": "AWS::GreengrassV2::ComponentVersion", + "description": "ResourceType enum AWS::GreengrassV2::ComponentVersion" + }, + { + "name": "AWSGroundStationConfig", + "value": "AWS::GroundStation::Config", + "description": "ResourceType enum AWS::GroundStation::Config" + }, + { + "name": "AWSGroundStationDataflowEndpointGroup", + "value": "AWS::GroundStation::DataflowEndpointGroup", + "description": "ResourceType enum AWS::GroundStation::DataflowEndpointGroup" + }, + { + "name": "AWSGroundStationMissionProfile", + "value": "AWS::GroundStation::MissionProfile", + "description": "ResourceType enum AWS::GroundStation::MissionProfile" + }, + { + "name": "AWSGuardDutyDetector", + "value": "AWS::GuardDuty::Detector", + "description": "ResourceType enum AWS::GuardDuty::Detector" + }, + { + "name": "AWSGuardDutyFilter", + "value": "AWS::GuardDuty::Filter", + "description": "ResourceType enum AWS::GuardDuty::Filter" + }, + { + "name": "AWSGuardDutyIPSet", + "value": "AWS::GuardDuty::IPSet", + "description": "ResourceType enum AWS::GuardDuty::IPSet" + }, + { + "name": "AWSGuardDutyThreatIntelSet", + "value": "AWS::GuardDuty::ThreatIntelSet", + "description": "ResourceType enum AWS::GuardDuty::ThreatIntelSet" + }, + { + "name": "AWSHealthLakeFHIRDatastore", + "value": "AWS::HealthLake::FHIRDatastore", + "description": "ResourceType enum AWS::HealthLake::FHIRDatastore" + }, + { + "name": "AWSIAMGroup", + "value": "AWS::IAM::Group", + "description": "ResourceType enum AWS::IAM::Group" + }, + { + "name": "AWSIAMInstanceProfile", + "value": "AWS::IAM::InstanceProfile", + "description": "ResourceType enum AWS::IAM::InstanceProfile" + }, + { + "name": "AWSIAMPolicy", + "value": "AWS::IAM::Policy", + "description": "ResourceType enum AWS::IAM::Policy" + }, + { + "name": "AWSIAMRole", + "value": "AWS::IAM::Role", + "description": "ResourceType enum AWS::IAM::Role" + }, + { + "name": "AWSIAMSAMLProvider", + "value": "AWS::IAM::SAMLProvider", + "description": "ResourceType enum AWS::IAM::SAMLProvider" + }, + { + "name": "AWSIAMServerCertificate", + "value": "AWS::IAM::ServerCertificate", + "description": "ResourceType enum AWS::IAM::ServerCertificate" + }, + { + "name": "AWSIAMUser", + "value": "AWS::IAM::User", + "description": "ResourceType enum AWS::IAM::User" + }, + { + "name": "AWSIVSChannel", + "value": "AWS::IVS::Channel", + "description": "ResourceType enum AWS::IVS::Channel" + }, + { + "name": "AWSIVSPlaybackKeyPair", + "value": "AWS::IVS::PlaybackKeyPair", + "description": "ResourceType enum AWS::IVS::PlaybackKeyPair" + }, + { + "name": "AWSIVSRecordingConfiguration", + "value": "AWS::IVS::RecordingConfiguration", + "description": "ResourceType enum AWS::IVS::RecordingConfiguration" + }, + { + "name": "AWSImageBuilderContainerRecipe", + "value": "AWS::ImageBuilder::ContainerRecipe", + "description": "ResourceType enum AWS::ImageBuilder::ContainerRecipe" + }, + { + "name": "AWSImageBuilderDistributionConfiguration", + "value": "AWS::ImageBuilder::DistributionConfiguration", + "description": "ResourceType enum AWS::ImageBuilder::DistributionConfiguration" + }, + { + "name": "AWSImageBuilderImagePipeline", + "value": "AWS::ImageBuilder::ImagePipeline", + "description": "ResourceType enum AWS::ImageBuilder::ImagePipeline" + }, + { + "name": "AWSImageBuilderImageRecipe", + "value": "AWS::ImageBuilder::ImageRecipe", + "description": "ResourceType enum AWS::ImageBuilder::ImageRecipe" + }, + { + "name": "AWSImageBuilderInfrastructureConfiguration", + "value": "AWS::ImageBuilder::InfrastructureConfiguration", + "description": "ResourceType enum AWS::ImageBuilder::InfrastructureConfiguration" + }, + { + "name": "AWSInspectorV2Filter", + "value": "AWS::InspectorV2::Filter", + "description": "ResourceType enum AWS::InspectorV2::Filter" + }, + { + "name": "AWSIoTAccountAuditConfiguration", + "value": "AWS::IoT::AccountAuditConfiguration", + "description": "ResourceType enum AWS::IoT::AccountAuditConfiguration" + }, + { + "name": "AWSIoTAuthorizer", + "value": "AWS::IoT::Authorizer", + "description": "ResourceType enum AWS::IoT::Authorizer" + }, + { + "name": "AWSIoTCACertificate", + "value": "AWS::IoT::CACertificate", + "description": "ResourceType enum AWS::IoT::CACertificate" + }, + { + "name": "AWSIoTCustomMetric", + "value": "AWS::IoT::CustomMetric", + "description": "ResourceType enum AWS::IoT::CustomMetric" + }, + { + "name": "AWSIoTDimension", + "value": "AWS::IoT::Dimension", + "description": "ResourceType enum AWS::IoT::Dimension" + }, + { + "name": "AWSIoTFleetMetric", + "value": "AWS::IoT::FleetMetric", + "description": "ResourceType enum AWS::IoT::FleetMetric" + }, + { + "name": "AWSIoTJobTemplate", + "value": "AWS::IoT::JobTemplate", + "description": "ResourceType enum AWS::IoT::JobTemplate" + }, + { + "name": "AWSIoTMitigationAction", + "value": "AWS::IoT::MitigationAction", + "description": "ResourceType enum AWS::IoT::MitigationAction" + }, + { + "name": "AWSIoTPolicy", + "value": "AWS::IoT::Policy", + "description": "ResourceType enum AWS::IoT::Policy" + }, + { + "name": "AWSIoTProvisioningTemplate", + "value": "AWS::IoT::ProvisioningTemplate", + "description": "ResourceType enum AWS::IoT::ProvisioningTemplate" + }, + { + "name": "AWSIoTRoleAlias", + "value": "AWS::IoT::RoleAlias", + "description": "ResourceType enum AWS::IoT::RoleAlias" + }, + { + "name": "AWSIoTScheduledAudit", + "value": "AWS::IoT::ScheduledAudit", + "description": "ResourceType enum AWS::IoT::ScheduledAudit" + }, + { + "name": "AWSIoTSecurityProfile", + "value": "AWS::IoT::SecurityProfile", + "description": "ResourceType enum AWS::IoT::SecurityProfile" + }, + { + "name": "AWSIoTAnalyticsChannel", + "value": "AWS::IoTAnalytics::Channel", + "description": "ResourceType enum AWS::IoTAnalytics::Channel" + }, + { + "name": "AWSIoTAnalyticsDataset", + "value": "AWS::IoTAnalytics::Dataset", + "description": "ResourceType enum AWS::IoTAnalytics::Dataset" + }, + { + "name": "AWSIoTAnalyticsDatastore", + "value": "AWS::IoTAnalytics::Datastore", + "description": "ResourceType enum AWS::IoTAnalytics::Datastore" + }, + { + "name": "AWSIoTAnalyticsPipeline", + "value": "AWS::IoTAnalytics::Pipeline", + "description": "ResourceType enum AWS::IoTAnalytics::Pipeline" + }, + { + "name": "AWSIoTEventsAlarmModel", + "value": "AWS::IoTEvents::AlarmModel", + "description": "ResourceType enum AWS::IoTEvents::AlarmModel" + }, + { + "name": "AWSIoTEventsDetectorModel", + "value": "AWS::IoTEvents::DetectorModel", + "description": "ResourceType enum AWS::IoTEvents::DetectorModel" + }, + { + "name": "AWSIoTEventsInput", + "value": "AWS::IoTEvents::Input", + "description": "ResourceType enum AWS::IoTEvents::Input" + }, + { + "name": "AWSIoTSiteWiseAssetModel", + "value": "AWS::IoTSiteWise::AssetModel", + "description": "ResourceType enum AWS::IoTSiteWise::AssetModel" + }, + { + "name": "AWSIoTSiteWiseDashboard", + "value": "AWS::IoTSiteWise::Dashboard", + "description": "ResourceType enum AWS::IoTSiteWise::Dashboard" + }, + { + "name": "AWSIoTSiteWiseGateway", + "value": "AWS::IoTSiteWise::Gateway", + "description": "ResourceType enum AWS::IoTSiteWise::Gateway" + }, + { + "name": "AWSIoTSiteWisePortal", + "value": "AWS::IoTSiteWise::Portal", + "description": "ResourceType enum AWS::IoTSiteWise::Portal" + }, + { + "name": "AWSIoTSiteWiseProject", + "value": "AWS::IoTSiteWise::Project", + "description": "ResourceType enum AWS::IoTSiteWise::Project" + }, + { + "name": "AWSIoTTwinMakerComponentType", + "value": "AWS::IoTTwinMaker::ComponentType", + "description": "ResourceType enum AWS::IoTTwinMaker::ComponentType" + }, + { + "name": "AWSIoTTwinMakerEntity", + "value": "AWS::IoTTwinMaker::Entity", + "description": "ResourceType enum AWS::IoTTwinMaker::Entity" + }, + { + "name": "AWSIoTTwinMakerScene", + "value": "AWS::IoTTwinMaker::Scene", + "description": "ResourceType enum AWS::IoTTwinMaker::Scene" + }, + { + "name": "AWSIoTTwinMakerSyncJob", + "value": "AWS::IoTTwinMaker::SyncJob", + "description": "ResourceType enum AWS::IoTTwinMaker::SyncJob" + }, + { + "name": "AWSIoTTwinMakerWorkspace", + "value": "AWS::IoTTwinMaker::Workspace", + "description": "ResourceType enum AWS::IoTTwinMaker::Workspace" + }, + { + "name": "AWSIoTWirelessFuotaTask", + "value": "AWS::IoTWireless::FuotaTask", + "description": "ResourceType enum AWS::IoTWireless::FuotaTask" + }, + { + "name": "AWSIoTWirelessMulticastGroup", + "value": "AWS::IoTWireless::MulticastGroup", + "description": "ResourceType enum AWS::IoTWireless::MulticastGroup" + }, + { + "name": "AWSIoTWirelessServiceProfile", + "value": "AWS::IoTWireless::ServiceProfile", + "description": "ResourceType enum AWS::IoTWireless::ServiceProfile" + }, + { + "name": "AWSKMSAlias", + "value": "AWS::KMS::Alias", + "description": "ResourceType enum AWS::KMS::Alias" + }, + { + "name": "AWSKMSKey", + "value": "AWS::KMS::Key", + "description": "ResourceType enum AWS::KMS::Key" + }, + { + "name": "AWSKafkaConnectConnector", + "value": "AWS::KafkaConnect::Connector", + "description": "ResourceType enum AWS::KafkaConnect::Connector" + }, + { + "name": "AWSKendraIndex", + "value": "AWS::Kendra::Index", + "description": "ResourceType enum AWS::Kendra::Index" + }, + { + "name": "AWSKinesisStream", + "value": "AWS::Kinesis::Stream", + "description": "ResourceType enum AWS::Kinesis::Stream" + }, + { + "name": "AWSKinesisStreamConsumer", + "value": "AWS::Kinesis::StreamConsumer", + "description": "ResourceType enum AWS::Kinesis::StreamConsumer" + }, + { + "name": "AWSKinesisAnalyticsV2Application", + "value": "AWS::KinesisAnalyticsV2::Application", + "description": "ResourceType enum AWS::KinesisAnalyticsV2::Application" + }, + { + "name": "AWSKinesisFirehoseDeliveryStream", + "value": "AWS::KinesisFirehose::DeliveryStream", + "description": "ResourceType enum AWS::KinesisFirehose::DeliveryStream" + }, + { + "name": "AWSKinesisVideoSignalingChannel", + "value": "AWS::KinesisVideo::SignalingChannel", + "description": "ResourceType enum AWS::KinesisVideo::SignalingChannel" + }, + { + "name": "AWSKinesisVideoStream", + "value": "AWS::KinesisVideo::Stream", + "description": "ResourceType enum AWS::KinesisVideo::Stream" + }, + { + "name": "AWSLambdaCodeSigningConfig", + "value": "AWS::Lambda::CodeSigningConfig", + "description": "ResourceType enum AWS::Lambda::CodeSigningConfig" + }, + { + "name": "AWSLambdaFunction", + "value": "AWS::Lambda::Function", + "description": "ResourceType enum AWS::Lambda::Function" + }, + { + "name": "AWSLexBot", + "value": "AWS::Lex::Bot", + "description": "ResourceType enum AWS::Lex::Bot" + }, + { + "name": "AWSLexBotAlias", + "value": "AWS::Lex::BotAlias", + "description": "ResourceType enum AWS::Lex::BotAlias" + }, + { + "name": "AWSLightsailBucket", + "value": "AWS::Lightsail::Bucket", + "description": "ResourceType enum AWS::Lightsail::Bucket" + }, + { + "name": "AWSLightsailCertificate", + "value": "AWS::Lightsail::Certificate", + "description": "ResourceType enum AWS::Lightsail::Certificate" + }, + { + "name": "AWSLightsailDisk", + "value": "AWS::Lightsail::Disk", + "description": "ResourceType enum AWS::Lightsail::Disk" + }, + { + "name": "AWSLightsailStaticIp", + "value": "AWS::Lightsail::StaticIp", + "description": "ResourceType enum AWS::Lightsail::StaticIp" + }, + { + "name": "AWSLogsDestination", + "value": "AWS::Logs::Destination", + "description": "ResourceType enum AWS::Logs::Destination" + }, + { + "name": "AWSLookoutMetricsAlert", + "value": "AWS::LookoutMetrics::Alert", + "description": "ResourceType enum AWS::LookoutMetrics::Alert" + }, + { + "name": "AWSLookoutVisionProject", + "value": "AWS::LookoutVision::Project", + "description": "ResourceType enum AWS::LookoutVision::Project" + }, + { + "name": "AWSM2Environment", + "value": "AWS::M2::Environment", + "description": "ResourceType enum AWS::M2::Environment" + }, + { + "name": "AWSMSKBatchScramSecret", + "value": "AWS::MSK::BatchScramSecret", + "description": "ResourceType enum AWS::MSK::BatchScramSecret" + }, + { + "name": "AWSMSKCluster", + "value": "AWS::MSK::Cluster", + "description": "ResourceType enum AWS::MSK::Cluster" + }, + { + "name": "AWSMSKConfiguration", + "value": "AWS::MSK::Configuration", + "description": "ResourceType enum AWS::MSK::Configuration" + }, + { + "name": "AWSMediaConnectFlowEntitlement", + "value": "AWS::MediaConnect::FlowEntitlement", + "description": "ResourceType enum AWS::MediaConnect::FlowEntitlement" + }, + { + "name": "AWSMediaConnectFlowSource", + "value": "AWS::MediaConnect::FlowSource", + "description": "ResourceType enum AWS::MediaConnect::FlowSource" + }, + { + "name": "AWSMediaConnectFlowVpcInterface", + "value": "AWS::MediaConnect::FlowVpcInterface", + "description": "ResourceType enum AWS::MediaConnect::FlowVpcInterface" + }, + { + "name": "AWSMediaPackagePackagingConfiguration", + "value": "AWS::MediaPackage::PackagingConfiguration", + "description": "ResourceType enum AWS::MediaPackage::PackagingConfiguration" + }, + { + "name": "AWSMediaPackagePackagingGroup", + "value": "AWS::MediaPackage::PackagingGroup", + "description": "ResourceType enum AWS::MediaPackage::PackagingGroup" + }, + { + "name": "AWSMediaTailorPlaybackConfiguration", + "value": "AWS::MediaTailor::PlaybackConfiguration", + "description": "ResourceType enum AWS::MediaTailor::PlaybackConfiguration" + }, + { + "name": "AWSNetworkFirewallFirewall", + "value": "AWS::NetworkFirewall::Firewall", + "description": "ResourceType enum AWS::NetworkFirewall::Firewall" + }, + { + "name": "AWSNetworkFirewallFirewallPolicy", + "value": "AWS::NetworkFirewall::FirewallPolicy", + "description": "ResourceType enum AWS::NetworkFirewall::FirewallPolicy" + }, + { + "name": "AWSNetworkFirewallRuleGroup", + "value": "AWS::NetworkFirewall::RuleGroup", + "description": "ResourceType enum AWS::NetworkFirewall::RuleGroup" + }, + { + "name": "AWSNetworkManagerConnectPeer", + "value": "AWS::NetworkManager::ConnectPeer", + "description": "ResourceType enum AWS::NetworkManager::ConnectPeer" + }, + { + "name": "AWSNetworkManagerCustomerGatewayAssociation", + "value": "AWS::NetworkManager::CustomerGatewayAssociation", + "description": "ResourceType enum AWS::NetworkManager::CustomerGatewayAssociation" + }, + { + "name": "AWSNetworkManagerDevice", + "value": "AWS::NetworkManager::Device", + "description": "ResourceType enum AWS::NetworkManager::Device" + }, + { + "name": "AWSNetworkManagerGlobalNetwork", + "value": "AWS::NetworkManager::GlobalNetwork", + "description": "ResourceType enum AWS::NetworkManager::GlobalNetwork" + }, + { + "name": "AWSNetworkManagerLink", + "value": "AWS::NetworkManager::Link", + "description": "ResourceType enum AWS::NetworkManager::Link" + }, + { + "name": "AWSNetworkManagerLinkAssociation", + "value": "AWS::NetworkManager::LinkAssociation", + "description": "ResourceType enum AWS::NetworkManager::LinkAssociation" + }, + { + "name": "AWSNetworkManagerSite", + "value": "AWS::NetworkManager::Site", + "description": "ResourceType enum AWS::NetworkManager::Site" + }, + { + "name": "AWSNetworkManagerTransitGatewayRegistration", + "value": "AWS::NetworkManager::TransitGatewayRegistration", + "description": "ResourceType enum AWS::NetworkManager::TransitGatewayRegistration" + }, + { + "name": "AWSOpenSearchDomain", + "value": "AWS::OpenSearch::Domain", + "description": "ResourceType enum AWS::OpenSearch::Domain" + }, + { + "name": "AWSPanoramaPackage", + "value": "AWS::Panorama::Package", + "description": "ResourceType enum AWS::Panorama::Package" + }, + { + "name": "AWSPersonalizeDataset", + "value": "AWS::Personalize::Dataset", + "description": "ResourceType enum AWS::Personalize::Dataset" + }, + { + "name": "AWSPersonalizeDatasetGroup", + "value": "AWS::Personalize::DatasetGroup", + "description": "ResourceType enum AWS::Personalize::DatasetGroup" + }, + { + "name": "AWSPersonalizeSchema", + "value": "AWS::Personalize::Schema", + "description": "ResourceType enum AWS::Personalize::Schema" + }, + { + "name": "AWSPersonalizeSolution", + "value": "AWS::Personalize::Solution", + "description": "ResourceType enum AWS::Personalize::Solution" + }, + { + "name": "AWSPinpointApp", + "value": "AWS::Pinpoint::App", + "description": "ResourceType enum AWS::Pinpoint::App" + }, + { + "name": "AWSPinpointApplicationSettings", + "value": "AWS::Pinpoint::ApplicationSettings", + "description": "ResourceType enum AWS::Pinpoint::ApplicationSettings" + }, + { + "name": "AWSPinpointCampaign", + "value": "AWS::Pinpoint::Campaign", + "description": "ResourceType enum AWS::Pinpoint::Campaign" + }, + { + "name": "AWSPinpointEmailChannel", + "value": "AWS::Pinpoint::EmailChannel", + "description": "ResourceType enum AWS::Pinpoint::EmailChannel" + }, + { + "name": "AWSPinpointEmailTemplate", + "value": "AWS::Pinpoint::EmailTemplate", + "description": "ResourceType enum AWS::Pinpoint::EmailTemplate" + }, + { + "name": "AWSPinpointEventStream", + "value": "AWS::Pinpoint::EventStream", + "description": "ResourceType enum AWS::Pinpoint::EventStream" + }, + { + "name": "AWSPinpointInAppTemplate", + "value": "AWS::Pinpoint::InAppTemplate", + "description": "ResourceType enum AWS::Pinpoint::InAppTemplate" + }, + { + "name": "AWSPinpointSegment", + "value": "AWS::Pinpoint::Segment", + "description": "ResourceType enum AWS::Pinpoint::Segment" + }, + { + "name": "AWSQLDBLedger", + "value": "AWS::QLDB::Ledger", + "description": "ResourceType enum AWS::QLDB::Ledger" + }, + { + "name": "AWSQuickSightDataSource", + "value": "AWS::QuickSight::DataSource", + "description": "ResourceType enum AWS::QuickSight::DataSource" + }, + { + "name": "AWSQuickSightTemplate", + "value": "AWS::QuickSight::Template", + "description": "ResourceType enum AWS::QuickSight::Template" + }, + { + "name": "AWSQuickSightTheme", + "value": "AWS::QuickSight::Theme", + "description": "ResourceType enum AWS::QuickSight::Theme" + }, + { + "name": "AWSRDSDBCluster", + "value": "AWS::RDS::DBCluster", + "description": "ResourceType enum AWS::RDS::DBCluster" + }, + { + "name": "AWSRDSDBClusterSnapshot", + "value": "AWS::RDS::DBClusterSnapshot", + "description": "ResourceType enum AWS::RDS::DBClusterSnapshot" + }, + { + "name": "AWSRDSDBInstance", + "value": "AWS::RDS::DBInstance", + "description": "ResourceType enum AWS::RDS::DBInstance" + }, + { + "name": "AWSRDSDBSecurityGroup", + "value": "AWS::RDS::DBSecurityGroup", + "description": "ResourceType enum AWS::RDS::DBSecurityGroup" + }, + { + "name": "AWSRDSDBSnapshot", + "value": "AWS::RDS::DBSnapshot", + "description": "ResourceType enum AWS::RDS::DBSnapshot" + }, + { + "name": "AWSRDSDBSubnetGroup", + "value": "AWS::RDS::DBSubnetGroup", + "description": "ResourceType enum AWS::RDS::DBSubnetGroup" + }, + { + "name": "AWSRDSEventSubscription", + "value": "AWS::RDS::EventSubscription", + "description": "ResourceType enum AWS::RDS::EventSubscription" + }, + { + "name": "AWSRDSGlobalCluster", + "value": "AWS::RDS::GlobalCluster", + "description": "ResourceType enum AWS::RDS::GlobalCluster" + }, + { + "name": "AWSRDSOptionGroup", + "value": "AWS::RDS::OptionGroup", + "description": "ResourceType enum AWS::RDS::OptionGroup" + }, + { + "name": "AWSRUMAppMonitor", + "value": "AWS::RUM::AppMonitor", + "description": "ResourceType enum AWS::RUM::AppMonitor" + }, + { + "name": "AWSRedshiftCluster", + "value": "AWS::Redshift::Cluster", + "description": "ResourceType enum AWS::Redshift::Cluster" + }, + { + "name": "AWSRedshiftClusterParameterGroup", + "value": "AWS::Redshift::ClusterParameterGroup", + "description": "ResourceType enum AWS::Redshift::ClusterParameterGroup" + }, + { + "name": "AWSRedshiftClusterSecurityGroup", + "value": "AWS::Redshift::ClusterSecurityGroup", + "description": "ResourceType enum AWS::Redshift::ClusterSecurityGroup" + }, + { + "name": "AWSRedshiftClusterSnapshot", + "value": "AWS::Redshift::ClusterSnapshot", + "description": "ResourceType enum AWS::Redshift::ClusterSnapshot" + }, + { + "name": "AWSRedshiftClusterSubnetGroup", + "value": "AWS::Redshift::ClusterSubnetGroup", + "description": "ResourceType enum AWS::Redshift::ClusterSubnetGroup" + }, + { + "name": "AWSRedshiftEndpointAccess", + "value": "AWS::Redshift::EndpointAccess", + "description": "ResourceType enum AWS::Redshift::EndpointAccess" + }, + { + "name": "AWSRedshiftEventSubscription", + "value": "AWS::Redshift::EventSubscription", + "description": "ResourceType enum AWS::Redshift::EventSubscription" + }, + { + "name": "AWSRedshiftScheduledAction", + "value": "AWS::Redshift::ScheduledAction", + "description": "ResourceType enum AWS::Redshift::ScheduledAction" + }, + { + "name": "AWSResilienceHubApp", + "value": "AWS::ResilienceHub::App", + "description": "ResourceType enum AWS::ResilienceHub::App" + }, + { + "name": "AWSResilienceHubResiliencyPolicy", + "value": "AWS::ResilienceHub::ResiliencyPolicy", + "description": "ResourceType enum AWS::ResilienceHub::ResiliencyPolicy" + }, + { + "name": "AWSResourceExplorer2Index", + "value": "AWS::ResourceExplorer2::Index", + "description": "ResourceType enum AWS::ResourceExplorer2::Index" + }, + { + "name": "AWSRoboMakerRobotApplication", + "value": "AWS::RoboMaker::RobotApplication", + "description": "ResourceType enum AWS::RoboMaker::RobotApplication" + }, + { + "name": "AWSRoboMakerRobotApplicationVersion", + "value": "AWS::RoboMaker::RobotApplicationVersion", + "description": "ResourceType enum AWS::RoboMaker::RobotApplicationVersion" + }, + { + "name": "AWSRoboMakerSimulationApplication", + "value": "AWS::RoboMaker::SimulationApplication", + "description": "ResourceType enum AWS::RoboMaker::SimulationApplication" + }, + { + "name": "AWSRoute53HostedZone", + "value": "AWS::Route53::HostedZone", + "description": "ResourceType enum AWS::Route53::HostedZone" + }, + { + "name": "AWSRoute53RecoveryControlCluster", + "value": "AWS::Route53RecoveryControl::Cluster", + "description": "ResourceType enum AWS::Route53RecoveryControl::Cluster" + }, + { + "name": "AWSRoute53RecoveryControlControlPanel", + "value": "AWS::Route53RecoveryControl::ControlPanel", + "description": "ResourceType enum AWS::Route53RecoveryControl::ControlPanel" + }, + { + "name": "AWSRoute53RecoveryControlRoutingControl", + "value": "AWS::Route53RecoveryControl::RoutingControl", + "description": "ResourceType enum AWS::Route53RecoveryControl::RoutingControl" + }, + { + "name": "AWSRoute53RecoveryControlSafetyRule", + "value": "AWS::Route53RecoveryControl::SafetyRule", + "description": "ResourceType enum AWS::Route53RecoveryControl::SafetyRule" + }, + { + "name": "AWSRoute53RecoveryReadinessCell", + "value": "AWS::Route53RecoveryReadiness::Cell", + "description": "ResourceType enum AWS::Route53RecoveryReadiness::Cell" + }, + { + "name": "AWSRoute53RecoveryReadinessReadinessCheck", + "value": "AWS::Route53RecoveryReadiness::ReadinessCheck", + "description": "ResourceType enum AWS::Route53RecoveryReadiness::ReadinessCheck" + }, + { + "name": "AWSRoute53RecoveryReadinessRecoveryGroup", + "value": "AWS::Route53RecoveryReadiness::RecoveryGroup", + "description": "ResourceType enum AWS::Route53RecoveryReadiness::RecoveryGroup" + }, + { + "name": "AWSRoute53RecoveryReadinessResourceSet", + "value": "AWS::Route53RecoveryReadiness::ResourceSet", + "description": "ResourceType enum AWS::Route53RecoveryReadiness::ResourceSet" + }, + { + "name": "AWSRoute53ResolverFirewallDomainList", + "value": "AWS::Route53Resolver::FirewallDomainList", + "description": "ResourceType enum AWS::Route53Resolver::FirewallDomainList" + }, + { + "name": "AWSRoute53ResolverFirewallRuleGroup", + "value": "AWS::Route53Resolver::FirewallRuleGroup", + "description": "ResourceType enum AWS::Route53Resolver::FirewallRuleGroup" + }, + { + "name": "AWSRoute53ResolverFirewallRuleGroupAssociation", + "value": "AWS::Route53Resolver::FirewallRuleGroupAssociation", + "description": "ResourceType enum AWS::Route53Resolver::FirewallRuleGroupAssociation" + }, + { + "name": "AWSRoute53ResolverResolverEndpoint", + "value": "AWS::Route53Resolver::ResolverEndpoint", + "description": "ResourceType enum AWS::Route53Resolver::ResolverEndpoint" + }, + { + "name": "AWSRoute53ResolverResolverQueryLoggingConfig", + "value": "AWS::Route53Resolver::ResolverQueryLoggingConfig", + "description": "ResourceType enum AWS::Route53Resolver::ResolverQueryLoggingConfig" + }, + { + "name": "AWSRoute53ResolverResolverQueryLoggingConfigAssociation", + "value": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation", + "description": "ResourceType enum AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" + }, + { + "name": "AWSRoute53ResolverResolverRule", + "value": "AWS::Route53Resolver::ResolverRule", + "description": "ResourceType enum AWS::Route53Resolver::ResolverRule" + }, + { + "name": "AWSRoute53ResolverResolverRuleAssociation", + "value": "AWS::Route53Resolver::ResolverRuleAssociation", + "description": "ResourceType enum AWS::Route53Resolver::ResolverRuleAssociation" + }, + { + "name": "AWSS3AccessPoint", + "value": "AWS::S3::AccessPoint", + "description": "ResourceType enum AWS::S3::AccessPoint" + }, + { + "name": "AWSS3AccountPublicAccessBlock", + "value": "AWS::S3::AccountPublicAccessBlock", + "description": "ResourceType enum AWS::S3::AccountPublicAccessBlock" + }, + { + "name": "AWSS3Bucket", + "value": "AWS::S3::Bucket", + "description": "ResourceType enum AWS::S3::Bucket" + }, + { + "name": "AWSS3MultiRegionAccessPoint", + "value": "AWS::S3::MultiRegionAccessPoint", + "description": "ResourceType enum AWS::S3::MultiRegionAccessPoint" + }, + { + "name": "AWSS3StorageLens", + "value": "AWS::S3::StorageLens", + "description": "ResourceType enum AWS::S3::StorageLens" + }, + { + "name": "AWSSESConfigurationSet", + "value": "AWS::SES::ConfigurationSet", + "description": "ResourceType enum AWS::SES::ConfigurationSet" + }, + { + "name": "AWSSESContactList", + "value": "AWS::SES::ContactList", + "description": "ResourceType enum AWS::SES::ContactList" + }, + { + "name": "AWSSESReceiptFilter", + "value": "AWS::SES::ReceiptFilter", + "description": "ResourceType enum AWS::SES::ReceiptFilter" + }, + { + "name": "AWSSESReceiptRuleSet", + "value": "AWS::SES::ReceiptRuleSet", + "description": "ResourceType enum AWS::SES::ReceiptRuleSet" + }, + { + "name": "AWSSESTemplate", + "value": "AWS::SES::Template", + "description": "ResourceType enum AWS::SES::Template" + }, + { + "name": "AWSSNSTopic", + "value": "AWS::SNS::Topic", + "description": "ResourceType enum AWS::SNS::Topic" + }, + { + "name": "AWSSQSQueue", + "value": "AWS::SQS::Queue", + "description": "ResourceType enum AWS::SQS::Queue" + }, + { + "name": "AWSSSMAssociationCompliance", + "value": "AWS::SSM::AssociationCompliance", + "description": "ResourceType enum AWS::SSM::AssociationCompliance" + }, + { + "name": "AWSSSMDocument", + "value": "AWS::SSM::Document", + "description": "ResourceType enum AWS::SSM::Document" + }, + { + "name": "AWSSSMFileData", + "value": "AWS::SSM::FileData", + "description": "ResourceType enum AWS::SSM::FileData" + }, + { + "name": "AWSSSMManagedInstanceInventory", + "value": "AWS::SSM::ManagedInstanceInventory", + "description": "ResourceType enum AWS::SSM::ManagedInstanceInventory" + }, + { + "name": "AWSSSMPatchCompliance", + "value": "AWS::SSM::PatchCompliance", + "description": "ResourceType enum AWS::SSM::PatchCompliance" + }, + { + "name": "AWSSageMakerAppImageConfig", + "value": "AWS::SageMaker::AppImageConfig", + "description": "ResourceType enum AWS::SageMaker::AppImageConfig" + }, + { + "name": "AWSSageMakerCodeRepository", + "value": "AWS::SageMaker::CodeRepository", + "description": "ResourceType enum AWS::SageMaker::CodeRepository" + }, + { + "name": "AWSSageMakerDomain", + "value": "AWS::SageMaker::Domain", + "description": "ResourceType enum AWS::SageMaker::Domain" + }, + { + "name": "AWSSageMakerFeatureGroup", + "value": "AWS::SageMaker::FeatureGroup", + "description": "ResourceType enum AWS::SageMaker::FeatureGroup" + }, + { + "name": "AWSSageMakerImage", + "value": "AWS::SageMaker::Image", + "description": "ResourceType enum AWS::SageMaker::Image" + }, + { + "name": "AWSSageMakerModel", + "value": "AWS::SageMaker::Model", + "description": "ResourceType enum AWS::SageMaker::Model" + }, + { + "name": "AWSSageMakerNotebookInstanceLifecycleConfig", + "value": "AWS::SageMaker::NotebookInstanceLifecycleConfig", + "description": "ResourceType enum AWS::SageMaker::NotebookInstanceLifecycleConfig" + }, + { + "name": "AWSSageMakerWorkteam", + "value": "AWS::SageMaker::Workteam", + "description": "ResourceType enum AWS::SageMaker::Workteam" + }, + { + "name": "AWSSecretsManagerSecret", + "value": "AWS::SecretsManager::Secret", + "description": "ResourceType enum AWS::SecretsManager::Secret" + }, + { + "name": "AWSServiceCatalogCloudFormationProduct", + "value": "AWS::ServiceCatalog::CloudFormationProduct", + "description": "ResourceType enum AWS::ServiceCatalog::CloudFormationProduct" + }, + { + "name": "AWSServiceCatalogCloudFormationProvisionedProduct", + "value": "AWS::ServiceCatalog::CloudFormationProvisionedProduct", + "description": "ResourceType enum AWS::ServiceCatalog::CloudFormationProvisionedProduct" + }, + { + "name": "AWSServiceCatalogPortfolio", + "value": "AWS::ServiceCatalog::Portfolio", + "description": "ResourceType enum AWS::ServiceCatalog::Portfolio" + }, + { + "name": "AWSServiceDiscoveryHttpNamespace", + "value": "AWS::ServiceDiscovery::HttpNamespace", + "description": "ResourceType enum AWS::ServiceDiscovery::HttpNamespace" + }, + { + "name": "AWSServiceDiscoveryInstance", + "value": "AWS::ServiceDiscovery::Instance", + "description": "ResourceType enum AWS::ServiceDiscovery::Instance" + }, + { + "name": "AWSServiceDiscoveryPublicDnsNamespace", + "value": "AWS::ServiceDiscovery::PublicDnsNamespace", + "description": "ResourceType enum AWS::ServiceDiscovery::PublicDnsNamespace" + }, + { + "name": "AWSServiceDiscoveryService", + "value": "AWS::ServiceDiscovery::Service", + "description": "ResourceType enum AWS::ServiceDiscovery::Service" + }, + { + "name": "AWSShieldProtection", + "value": "AWS::Shield::Protection", + "description": "ResourceType enum AWS::Shield::Protection" + }, + { + "name": "AWSShieldRegionalProtection", + "value": "AWS::ShieldRegional::Protection", + "description": "ResourceType enum AWS::ShieldRegional::Protection" + }, + { + "name": "AWSSignerSigningProfile", + "value": "AWS::Signer::SigningProfile", + "description": "ResourceType enum AWS::Signer::SigningProfile" + }, + { + "name": "AWSStepFunctionsActivity", + "value": "AWS::StepFunctions::Activity", + "description": "ResourceType enum AWS::StepFunctions::Activity" + }, + { + "name": "AWSStepFunctionsStateMachine", + "value": "AWS::StepFunctions::StateMachine", + "description": "ResourceType enum AWS::StepFunctions::StateMachine" + }, + { + "name": "AWSTransferAgreement", + "value": "AWS::Transfer::Agreement", + "description": "ResourceType enum AWS::Transfer::Agreement" + }, + { + "name": "AWSTransferCertificate", + "value": "AWS::Transfer::Certificate", + "description": "ResourceType enum AWS::Transfer::Certificate" + }, + { + "name": "AWSTransferConnector", + "value": "AWS::Transfer::Connector", + "description": "ResourceType enum AWS::Transfer::Connector" + }, + { + "name": "AWSTransferWorkflow", + "value": "AWS::Transfer::Workflow", + "description": "ResourceType enum AWS::Transfer::Workflow" + }, + { + "name": "AWSWAFRateBasedRule", + "value": "AWS::WAF::RateBasedRule", + "description": "ResourceType enum AWS::WAF::RateBasedRule" + }, + { + "name": "AWSWAFRule", + "value": "AWS::WAF::Rule", + "description": "ResourceType enum AWS::WAF::Rule" + }, + { + "name": "AWSWAFRuleGroup", + "value": "AWS::WAF::RuleGroup", + "description": "ResourceType enum AWS::WAF::RuleGroup" + }, + { + "name": "AWSWAFWebACL", + "value": "AWS::WAF::WebACL", + "description": "ResourceType enum AWS::WAF::WebACL" + }, + { + "name": "AWSWAFRegionalRateBasedRule", + "value": "AWS::WAFRegional::RateBasedRule", + "description": "ResourceType enum AWS::WAFRegional::RateBasedRule" + }, + { + "name": "AWSWAFRegionalRule", + "value": "AWS::WAFRegional::Rule", + "description": "ResourceType enum AWS::WAFRegional::Rule" + }, + { + "name": "AWSWAFRegionalRuleGroup", + "value": "AWS::WAFRegional::RuleGroup", + "description": "ResourceType enum AWS::WAFRegional::RuleGroup" + }, + { + "name": "AWSWAFRegionalWebACL", + "value": "AWS::WAFRegional::WebACL", + "description": "ResourceType enum AWS::WAFRegional::WebACL" + }, + { + "name": "AWSWAFv2IPSet", + "value": "AWS::WAFv2::IPSet", + "description": "ResourceType enum AWS::WAFv2::IPSet" + }, + { + "name": "AWSWAFv2ManagedRuleSet", + "value": "AWS::WAFv2::ManagedRuleSet", + "description": "ResourceType enum AWS::WAFv2::ManagedRuleSet" + }, + { + "name": "AWSWAFv2RegexPatternSet", + "value": "AWS::WAFv2::RegexPatternSet", + "description": "ResourceType enum AWS::WAFv2::RegexPatternSet" + }, + { + "name": "AWSWAFv2RuleGroup", + "value": "AWS::WAFv2::RuleGroup", + "description": "ResourceType enum AWS::WAFv2::RuleGroup" + }, + { + "name": "AWSWAFv2WebACL", + "value": "AWS::WAFv2::WebACL", + "description": "ResourceType enum AWS::WAFv2::WebACL" + }, + { + "name": "AWSWorkSpacesConnectionAlias", + "value": "AWS::WorkSpaces::ConnectionAlias", + "description": "ResourceType enum AWS::WorkSpaces::ConnectionAlias" + }, + { + "name": "AWSWorkSpacesWorkspace", + "value": "AWS::WorkSpaces::Workspace", + "description": "ResourceType enum AWS::WorkSpaces::Workspace" + }, + { + "name": "AWSXRayEncryptionConfig", + "value": "AWS::XRay::EncryptionConfig", + "description": "ResourceType enum AWS::XRay::EncryptionConfig" + } + ] + } + }, + "ResourceTypeEnumValue": { + "type": "object", + "description": "Definition of ResourceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ResourceType", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorderStatus.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorderStatus.json new file mode 100644 index 000000000000..0385bfaf69ae --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorderStatus.json @@ -0,0 +1,617 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ConfigServiceConfigurationRecorderStatuses" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorderStatuses": { + "get": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListBySubscription", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "List ConfigServiceConfigurationRecorderStatus resources 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/ConfigServiceConfigurationRecorderStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorderStatuses_ListBySubscription": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorderStatuses": { + "get": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "List ConfigServiceConfigurationRecorderStatus resources 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/ConfigServiceConfigurationRecorderStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceConfigurationRecorderStatuses/{name}": { + "get": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_Get", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "Get a ConfigServiceConfigurationRecorderStatus", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorderStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorderStatuses_Get": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_Get.json" + } + } + }, + "put": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "Create a ConfigServiceConfigurationRecorderStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorderStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ConfigServiceConfigurationRecorderStatus' update operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + } + }, + "201": { + "description": "Resource 'ConfigServiceConfigurationRecorderStatus' create operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_Update", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "Update a ConfigServiceConfigurationRecorderStatus", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorderStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatusTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceConfigurationRecorderStatuses_Update": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConfigServiceConfigurationRecorderStatuses_Delete", + "tags": [ + "ConfigServiceConfigurationRecorderStatuses" + ], + "description": "Delete a ConfigServiceConfigurationRecorderStatus", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceConfigurationRecorderStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ConfigServiceConfigurationRecorderStatuses_Delete": { + "$ref": "./examples/ConfigServiceConfigurationRecorderStatuses_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsConfigServiceConfigurationRecorderStatusProperties": { + "type": "object", + "description": "Definition of awsConfigServiceConfigurationRecorderStatus", + "properties": { + "lastErrorCode": { + "type": "string", + "description": "<p>The latest error code from when the recorder last failed.</p>" + }, + "lastErrorMessage": { + "type": "string", + "description": "<p>The latest error message from when the recorder last failed.</p>" + }, + "lastStartTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time the recorder was last started.</p>" + }, + "lastStatus": { + "$ref": "#/definitions/RecorderStatusEnumValue", + "description": "<p>The status of the latest recording event processed by the recorder.</p>" + }, + "lastStatusChangeTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time of the latest change in status of an recording event processed by the recorder.</p>" + }, + "lastStopTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time the recorder was last stopped.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the configuration recorder.</p>" + }, + "recording": { + "type": "boolean", + "description": "<p>Specifies whether or not the recorder is currently recording.</p>" + } + } + }, + "ConfigServiceConfigurationRecorderStatus": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatusProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ConfigServiceConfigurationRecorderStatusListResult": { + "type": "object", + "description": "The response of a ConfigServiceConfigurationRecorderStatus list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ConfigServiceConfigurationRecorderStatus items on this page", + "items": { + "$ref": "#/definitions/ConfigServiceConfigurationRecorderStatus" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ConfigServiceConfigurationRecorderStatusProperties": { + "type": "object", + "description": "Definition of ConfigServiceConfigurationRecorderStatus", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsConfigServiceConfigurationRecorderStatusProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ConfigServiceConfigurationRecorderStatusTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ConfigServiceConfigurationRecorderStatus resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RecorderStatus": { + "type": "string", + "description": "RecorderStatus enum", + "enum": [ + "Failure", + "Pending", + "Success" + ], + "x-ms-enum": { + "name": "RecorderStatus", + "modelAsString": true, + "values": [ + { + "name": "Failure", + "value": "Failure", + "description": "RecorderStatus enum Failure" + }, + { + "name": "Pending", + "value": "Pending", + "description": "RecorderStatus enum Pending" + }, + { + "name": "Success", + "value": "Success", + "description": "RecorderStatus enum Success" + } + ] + } + }, + "RecorderStatusEnumValue": { + "type": "object", + "description": "Definition of RecorderStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RecorderStatus", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceDeliveryChannel.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceDeliveryChannel.json new file mode 100644 index 000000000000..0c32663b801f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/configServiceDeliveryChannel.json @@ -0,0 +1,628 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ConfigServiceDeliveryChannels" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/configServiceDeliveryChannels": { + "get": { + "operationId": "ConfigServiceDeliveryChannels_ListBySubscription", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "List ConfigServiceDeliveryChannel resources 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/ConfigServiceDeliveryChannelListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceDeliveryChannels_ListBySubscription": { + "$ref": "./examples/ConfigServiceDeliveryChannels_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceDeliveryChannels": { + "get": { + "operationId": "ConfigServiceDeliveryChannels_ListByResourceGroup", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "List ConfigServiceDeliveryChannel resources 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/ConfigServiceDeliveryChannelListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceDeliveryChannels_ListByResourceGroup": { + "$ref": "./examples/ConfigServiceDeliveryChannels_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/configServiceDeliveryChannels/{name}": { + "get": { + "operationId": "ConfigServiceDeliveryChannels_Get", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "Get a ConfigServiceDeliveryChannel", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceDeliveryChannel", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceDeliveryChannels_Get": { + "$ref": "./examples/ConfigServiceDeliveryChannels_Get.json" + } + } + }, + "put": { + "operationId": "ConfigServiceDeliveryChannels_CreateOrReplace", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "Create a ConfigServiceDeliveryChannel. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceDeliveryChannel", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ConfigServiceDeliveryChannel' update operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + } + }, + "201": { + "description": "Resource 'ConfigServiceDeliveryChannel' create operation succeeded", + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ConfigServiceDeliveryChannels_CreateOrReplace": { + "$ref": "./examples/ConfigServiceDeliveryChannels_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ConfigServiceDeliveryChannels_Update", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "Update a ConfigServiceDeliveryChannel", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceDeliveryChannel", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannelTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ConfigServiceDeliveryChannels_Update": { + "$ref": "./examples/ConfigServiceDeliveryChannels_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ConfigServiceDeliveryChannels_Delete", + "tags": [ + "ConfigServiceDeliveryChannels" + ], + "description": "Delete a ConfigServiceDeliveryChannel", + "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": "name", + "in": "path", + "description": "Name of ConfigServiceDeliveryChannel", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ConfigServiceDeliveryChannels_Delete": { + "$ref": "./examples/ConfigServiceDeliveryChannels_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsConfigServiceDeliveryChannelProperties": { + "type": "object", + "description": "Definition of awsConfigServiceDeliveryChannel", + "properties": { + "configSnapshotDeliveryProperties": { + "$ref": "#/definitions/ConfigSnapshotDeliveryProperties", + "description": "<p>The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the delivery channel. By default, Config assigns the name 'default' when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.</p>" + }, + "s3BucketName": { + "type": "string", + "description": "<p>The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.</p> <p>If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html'>Permissions for the Amazon S3 Bucket</a> in the <i>Config Developer Guide</i>.</p>" + }, + "s3KeyPrefix": { + "type": "string", + "description": "<p>The prefix for the specified Amazon S3 bucket.</p>" + }, + "s3KmsKeyArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.</p>" + }, + "snsTopicARN": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.</p> <p>If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see <a href='https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html'>Permissions for the Amazon SNS Topic</a> in the <i>Config Developer Guide</i>.</p>" + } + } + }, + "ConfigServiceDeliveryChannel": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigServiceDeliveryChannelProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ConfigServiceDeliveryChannelListResult": { + "type": "object", + "description": "The response of a ConfigServiceDeliveryChannel list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ConfigServiceDeliveryChannel items on this page", + "items": { + "$ref": "#/definitions/ConfigServiceDeliveryChannel" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ConfigServiceDeliveryChannelProperties": { + "type": "object", + "description": "Definition of ConfigServiceDeliveryChannel", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsConfigServiceDeliveryChannelProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ConfigServiceDeliveryChannelTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ConfigServiceDeliveryChannel resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConfigSnapshotDeliveryProperties": { + "type": "object", + "description": "Definition of ConfigSnapshotDeliveryProperties", + "properties": { + "deliveryFrequency": { + "$ref": "#/definitions/MaximumExecutionFrequencyEnumValue", + "description": "<p>The frequency with which Config delivers configuration snapshots.</p>" + } + } + }, + "MaximumExecutionFrequency": { + "type": "string", + "description": "MaximumExecutionFrequency enum", + "enum": [ + "One_Hour", + "Six_Hours", + "Three_Hours", + "Twelve_Hours", + "TwentyFour_Hours" + ], + "x-ms-enum": { + "name": "MaximumExecutionFrequency", + "modelAsString": true, + "values": [ + { + "name": "One_Hour", + "value": "One_Hour", + "description": "MaximumExecutionFrequency enum One_Hour" + }, + { + "name": "Six_Hours", + "value": "Six_Hours", + "description": "MaximumExecutionFrequency enum Six_Hours" + }, + { + "name": "Three_Hours", + "value": "Three_Hours", + "description": "MaximumExecutionFrequency enum Three_Hours" + }, + { + "name": "Twelve_Hours", + "value": "Twelve_Hours", + "description": "MaximumExecutionFrequency enum Twelve_Hours" + }, + { + "name": "TwentyFour_Hours", + "value": "TwentyFour_Hours", + "description": "MaximumExecutionFrequency enum TwentyFour_Hours" + } + ] + } + }, + "MaximumExecutionFrequencyEnumValue": { + "type": "object", + "description": "Definition of MaximumExecutionFrequencyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/MaximumExecutionFrequency", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/databaseMigrationServiceReplicationInstance.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/databaseMigrationServiceReplicationInstance.json new file mode 100644 index 000000000000..49a07f60b8d5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/databaseMigrationServiceReplicationInstance.json @@ -0,0 +1,768 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "DatabaseMigrationServiceReplicationInstances" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances": { + "get": { + "operationId": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "List DatabaseMigrationServiceReplicationInstance resources 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/DatabaseMigrationServiceReplicationInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DatabaseMigrationServiceReplicationInstances_ListBySubscription": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances": { + "get": { + "operationId": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "List DatabaseMigrationServiceReplicationInstance resources 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/DatabaseMigrationServiceReplicationInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/databaseMigrationServiceReplicationInstances/{name}": { + "get": { + "operationId": "DatabaseMigrationServiceReplicationInstances_Get", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "Get a DatabaseMigrationServiceReplicationInstance", + "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": "name", + "in": "path", + "description": "Name of DatabaseMigrationServiceReplicationInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DatabaseMigrationServiceReplicationInstances_Get": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Get.json" + } + } + }, + "put": { + "operationId": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "Create a DatabaseMigrationServiceReplicationInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of DatabaseMigrationServiceReplicationInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DatabaseMigrationServiceReplicationInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + } + }, + "201": { + "description": "Resource 'DatabaseMigrationServiceReplicationInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DatabaseMigrationServiceReplicationInstances_CreateOrReplace": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DatabaseMigrationServiceReplicationInstances_Update", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "Update a DatabaseMigrationServiceReplicationInstance", + "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": "name", + "in": "path", + "description": "Name of DatabaseMigrationServiceReplicationInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DatabaseMigrationServiceReplicationInstances_Update": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DatabaseMigrationServiceReplicationInstances_Delete", + "tags": [ + "DatabaseMigrationServiceReplicationInstances" + ], + "description": "Delete a DatabaseMigrationServiceReplicationInstance", + "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": "name", + "in": "path", + "description": "Name of DatabaseMigrationServiceReplicationInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "DatabaseMigrationServiceReplicationInstances_Delete": { + "$ref": "./examples/DatabaseMigrationServiceReplicationInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AvailabilityZone": { + "type": "object", + "description": "Definition of AvailabilityZone", + "properties": { + "name": { + "type": "string", + "description": "<p>The name of the Availability Zone.</p>" + } + } + }, + "AwsDatabaseMigrationServiceReplicationInstanceProperties": { + "type": "object", + "description": "Definition of awsDatabaseMigrationServiceReplicationInstance", + "properties": { + "allocatedStorage": { + "type": "integer", + "format": "int32", + "description": "<p>The amount of storage (in gigabytes) that is allocated for the replication instance.</p>" + }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "<p>Boolean value indicating if minor version upgrades will be automatically applied to the instance.</p>" + }, + "availabilityZone": { + "type": "string", + "description": "<p>The Availability Zone for the instance.</p>" + }, + "dnsNameServers": { + "type": "string", + "description": "<p>The DNS name servers supported for the replication instance to access your on-premise source or target database.</p>" + }, + "engineVersion": { + "type": "string", + "description": "<p>The engine version number of the replication instance.</p> <p>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>" + }, + "freeUntil": { + "type": "string", + "format": "date-time", + "description": "<p> The expiration date of the free replication instance that is part of the Free DMS program. </p>" + }, + "instanceCreateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time the replication instance was created.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>" + }, + "multiAZ": { + "type": "boolean", + "description": "<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>" + }, + "networkType": { + "type": "string", + "description": "<p>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>" + }, + "pendingModifiedValues": { + "$ref": "#/definitions/ReplicationPendingModifiedValues", + "description": "<p>The pending modification values.</p>" + }, + "preferredMaintenanceWindow": { + "type": "string", + "description": "<p>The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.</p>" + }, + "publiclyAccessible": { + "type": "boolean", + "description": "<p> Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>. </p>" + }, + "replicationInstanceArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>" + }, + "replicationInstanceClass": { + "type": "string", + "description": "<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'> Selecting the right DMS replication instance for your migration</a>. </p>" + }, + "replicationInstanceIdentifier": { + "type": "string", + "description": "<p>The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>" + }, + "replicationInstanceIpv6Addresses": { + "type": "array", + "description": "<p>One or more IPv6 addresses for the replication instance.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "replicationInstancePrivateIpAddress": { + "type": "string", + "description": "<p>The private IP address of the replication instance.</p>" + }, + "replicationInstancePrivateIpAddresses": { + "type": "array", + "description": "<p>One or more private IP addresses for the replication instance.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "replicationInstancePublicIpAddress": { + "type": "string", + "description": "<p>The public IP address of the replication instance.</p>" + }, + "replicationInstancePublicIpAddresses": { + "type": "array", + "description": "<p>One or more public IP addresses for the replication instance.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "replicationInstanceStatus": { + "type": "string", + "description": "<p>The status of the replication instance. The possible return values include:</p> <ul> <li> <p> <code>'available'</code> </p> </li> <li> <p> <code>'creating'</code> </p> </li> <li> <p> <code>'deleted'</code> </p> </li> <li> <p> <code>'deleting'</code> </p> </li> <li> <p> <code>'failed'</code> </p> </li> <li> <p> <code>'modifying'</code> </p> </li> <li> <p> <code>'upgrading'</code> </p> </li> <li> <p> <code>'rebooting'</code> </p> </li> <li> <p> <code>'resetting-master-credentials'</code> </p> </li> <li> <p> <code>'storage-full'</code> </p> </li> <li> <p> <code>'incompatible-credentials'</code> </p> </li> <li> <p> <code>'incompatible-network'</code> </p> </li> <li> <p> <code>'maintenance'</code> </p> </li> </ul>" + }, + "replicationSubnetGroup": { + "$ref": "#/definitions/ReplicationSubnetGroup", + "description": "<p>The subnet group for the replication instance.</p>" + }, + "secondaryAvailabilityZone": { + "type": "string", + "description": "<p>The Availability Zone of the standby replication instance in a Multi-AZ deployment.</p>" + }, + "vpcSecurityGroups": { + "type": "array", + "description": "<p>The VPC security group for the instance.</p>", + "items": { + "$ref": "#/definitions/VpcSecurityGroupMembership" + }, + "x-ms-identifiers": [] + } + } + }, + "DatabaseMigrationServiceReplicationInstance": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstanceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DatabaseMigrationServiceReplicationInstanceListResult": { + "type": "object", + "description": "The response of a DatabaseMigrationServiceReplicationInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DatabaseMigrationServiceReplicationInstance items on this page", + "items": { + "$ref": "#/definitions/DatabaseMigrationServiceReplicationInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DatabaseMigrationServiceReplicationInstanceProperties": { + "type": "object", + "description": "Definition of DatabaseMigrationServiceReplicationInstance", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsDatabaseMigrationServiceReplicationInstanceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DatabaseMigrationServiceReplicationInstanceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in DatabaseMigrationServiceReplicationInstance resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ReplicationPendingModifiedValues": { + "type": "object", + "description": "Definition of ReplicationPendingModifiedValues", + "properties": { + "allocatedStorage": { + "type": "integer", + "format": "int32", + "description": "<p>The amount of storage (in gigabytes) that is allocated for the replication instance.</p>" + }, + "engineVersion": { + "type": "string", + "description": "<p>The engine version number of the replication instance.</p>" + }, + "multiAZ": { + "type": "boolean", + "description": "<p> Specifies whether the replication instance is a Multi-AZ deployment. You can't set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>" + }, + "networkType": { + "type": "string", + "description": "<p>The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>" + }, + "replicationInstanceClass": { + "type": "string", + "description": "<p>The compute and memory capacity of the replication instance as defined for the specified replication instance class.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'> Selecting the right DMS replication instance for your migration</a>. </p>" + } + } + }, + "ReplicationSubnetGroup": { + "type": "object", + "description": "Definition of ReplicationSubnetGroup", + "properties": { + "replicationSubnetGroupDescription": { + "type": "string", + "description": "<p>A description for the replication subnet group.</p>" + }, + "replicationSubnetGroupIdentifier": { + "type": "string", + "description": "<p>The identifier of the replication instance subnet group.</p>" + }, + "subnetGroupStatus": { + "type": "string", + "description": "<p>The status of the subnet group.</p>" + }, + "subnets": { + "type": "array", + "description": "<p>The subnets that are in the subnet group.</p>", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [] + }, + "supportedNetworkTypes": { + "type": "array", + "description": "<p>The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the VPC.</p>" + } + } + }, + "Subnet": { + "type": "object", + "description": "Definition of Subnet", + "properties": { + "subnetAvailabilityZone": { + "$ref": "#/definitions/AvailabilityZone", + "description": "<p>The Availability Zone of the subnet.</p>" + }, + "subnetIdentifier": { + "type": "string", + "description": "<p>The subnet identifier.</p>" + }, + "subnetStatus": { + "type": "string", + "description": "<p>The status of the subnet.</p>" + } + } + }, + "VpcSecurityGroupMembership": { + "type": "object", + "description": "Definition of VpcSecurityGroupMembership", + "properties": { + "status": { + "type": "string", + "description": "<p>The status of the VPC security group.</p>" + }, + "vpcSecurityGroupId": { + "type": "string", + "description": "<p>The VPC security group ID.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/daxCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/daxCluster.json new file mode 100644 index 000000000000..8700a9fff7ea --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/daxCluster.json @@ -0,0 +1,818 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "DaxClusters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/daxClusters": { + "get": { + "operationId": "DaxClusters_ListBySubscription", + "tags": [ + "DaxClusters" + ], + "description": "List DaxCluster resources 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/DaxClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DaxClusters_ListBySubscription": { + "$ref": "./examples/DaxClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/daxClusters": { + "get": { + "operationId": "DaxClusters_ListByResourceGroup", + "tags": [ + "DaxClusters" + ], + "description": "List DaxCluster resources 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/DaxClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DaxClusters_ListByResourceGroup": { + "$ref": "./examples/DaxClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/daxClusters/{name}": { + "get": { + "operationId": "DaxClusters_Get", + "tags": [ + "DaxClusters" + ], + "description": "Get a DaxCluster", + "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": "name", + "in": "path", + "description": "Name of DaxCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DaxCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DaxClusters_Get": { + "$ref": "./examples/DaxClusters_Get.json" + } + } + }, + "put": { + "operationId": "DaxClusters_CreateOrReplace", + "tags": [ + "DaxClusters" + ], + "description": "Create a DaxCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of DaxCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DaxCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DaxCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/DaxCluster" + } + }, + "201": { + "description": "Resource 'DaxCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/DaxCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DaxClusters_CreateOrReplace": { + "$ref": "./examples/DaxClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DaxClusters_Update", + "tags": [ + "DaxClusters" + ], + "description": "Update a DaxCluster", + "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": "name", + "in": "path", + "description": "Name of DaxCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DaxClusterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DaxCluster" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DaxClusters_Update": { + "$ref": "./examples/DaxClusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DaxClusters_Delete", + "tags": [ + "DaxClusters" + ], + "description": "Delete a DaxCluster", + "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": "name", + "in": "path", + "description": "Name of DaxCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "DaxClusters_Delete": { + "$ref": "./examples/DaxClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsDaxClusterProperties": { + "type": "object", + "description": "Definition of awsDaxCluster", + "properties": { + "activeNodes": { + "type": "integer", + "format": "int32", + "description": "<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p>" + }, + "clusterArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p>" + }, + "clusterDiscoveryEndpoint": { + "$ref": "#/definitions/Endpoint", + "description": "<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p>" + }, + "clusterEndpointEncryptionType": { + "$ref": "#/definitions/ClusterEndpointEncryptionTypeEnumValue", + "description": "<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul>" + }, + "clusterName": { + "type": "string", + "description": "<p>The name of the DAX cluster.</p>" + }, + "description": { + "type": "string", + "description": "<p>The description of the cluster.</p>" + }, + "iamRoleArn": { + "type": "string", + "description": "<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p>" + }, + "nodeIdsToRemove": { + "type": "array", + "description": "<p>A list of nodes to be removed from the cluster.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "nodeType": { + "type": "string", + "description": "<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p>" + }, + "nodes": { + "type": "array", + "description": "<p>A list of nodes that are currently in the cluster.</p>", + "items": { + "$ref": "#/definitions/Node" + }, + "x-ms-identifiers": [] + }, + "notificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration", + "description": "<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p>" + }, + "parameterGroup": { + "$ref": "#/definitions/ParameterGroupStatus", + "description": "<p>The parameter group being used by nodes in the cluster.</p>" + }, + "preferredMaintenanceWindow": { + "type": "string", + "description": "<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p>" + }, + "sseDescription": { + "$ref": "#/definitions/SSEDescription", + "description": "<p>The description of the server-side encryption status on the specified DAX cluster.</p>" + }, + "securityGroups": { + "type": "array", + "description": "<p>A list of security groups, and the status of each, for the nodes in the cluster.</p>", + "items": { + "$ref": "#/definitions/SecurityGroupMembership" + }, + "x-ms-identifiers": [] + }, + "status": { + "type": "string", + "description": "<p>The current status of the cluster.</p>" + }, + "subnetGroup": { + "type": "string", + "description": "<p>The subnet group where the DAX cluster is running.</p>" + }, + "totalNodes": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of nodes in the cluster.</p>" + } + } + }, + "ClusterEndpointEncryptionType": { + "type": "string", + "description": "ClusterEndpointEncryptionType enum", + "enum": [ + "NONE", + "TLS" + ], + "x-ms-enum": { + "name": "ClusterEndpointEncryptionType", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "ClusterEndpointEncryptionType enum NONE" + }, + { + "name": "TLS", + "value": "TLS", + "description": "ClusterEndpointEncryptionType enum TLS" + } + ] + } + }, + "ClusterEndpointEncryptionTypeEnumValue": { + "type": "object", + "description": "Definition of ClusterEndpointEncryptionTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterEndpointEncryptionType", + "description": "Property value" + } + } + }, + "DaxCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/DaxClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DaxClusterListResult": { + "type": "object", + "description": "The response of a DaxCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DaxCluster items on this page", + "items": { + "$ref": "#/definitions/DaxCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DaxClusterProperties": { + "type": "object", + "description": "Definition of DaxCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsDaxClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DaxClusterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in DaxCluster resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Endpoint": { + "type": "object", + "description": "Definition of Endpoint", + "properties": { + "address": { + "type": "string", + "description": "<p>The DNS hostname of the endpoint.</p>" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "<p>The port number that applications should use to connect to the endpoint.</p>" + }, + "url": { + "type": "string", + "description": "<p>The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.</p>" + } + } + }, + "Node": { + "type": "object", + "description": "Definition of Node", + "properties": { + "availabilityZone": { + "type": "string", + "description": "<p>The Availability Zone (AZ) in which the node has been deployed.</p>" + }, + "endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p>" + }, + "nodeCreateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time (in UNIX epoch format) when the node was launched.</p>" + }, + "nodeId": { + "type": "string", + "description": "<p>A system-generated identifier for the node.</p>" + }, + "nodeStatus": { + "type": "string", + "description": "<p>The current status of the node. For example: <code>available</code>.</p>" + }, + "parameterGroupStatus": { + "type": "string", + "description": "<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p>" + } + } + }, + "NotificationConfiguration": { + "type": "object", + "description": "Definition of NotificationConfiguration", + "properties": { + "topicArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) that identifies the topic. </p>" + }, + "topicStatus": { + "type": "string", + "description": "<p>The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.</p>" + } + } + }, + "ParameterGroupStatus": { + "type": "object", + "description": "Definition of ParameterGroupStatus", + "properties": { + "nodeIdsToReboot": { + "type": "array", + "description": "<p>The node IDs of one or more nodes to be rebooted.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "parameterApplyStatus": { + "type": "string", + "description": "<p>The status of parameter updates. </p>" + }, + "parameterGroupName": { + "type": "string", + "description": "<p>The name of the parameter group.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SSEDescription": { + "type": "object", + "description": "Definition of SSEDescription", + "properties": { + "status": { + "$ref": "#/definitions/SSEStatusEnumValue", + "description": "<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>" + } + } + }, + "SSEStatus": { + "type": "string", + "description": "SSEStatus enum", + "enum": [ + "DISABLED", + "DISABLING", + "ENABLED", + "ENABLING" + ], + "x-ms-enum": { + "name": "SSEStatus", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "SSEStatus enum DISABLED" + }, + { + "name": "DISABLING", + "value": "DISABLING", + "description": "SSEStatus enum DISABLING" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "SSEStatus enum ENABLED" + }, + { + "name": "ENABLING", + "value": "ENABLING", + "description": "SSEStatus enum ENABLING" + } + ] + } + }, + "SSEStatusEnumValue": { + "type": "object", + "description": "Definition of SSEStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SSEStatus", + "description": "Property value" + } + } + }, + "SecurityGroupMembership": { + "type": "object", + "description": "Definition of SecurityGroupMembership", + "properties": { + "securityGroupIdentifier": { + "type": "string", + "description": "<p>The unique ID for this security group.</p>" + }, + "status": { + "type": "string", + "description": "<p>The status of this security group.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBContinuousBackupsDescription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBContinuousBackupsDescription.json new file mode 100644 index 000000000000..48c1504eae03 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBContinuousBackupsDescription.json @@ -0,0 +1,638 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "DynamoDBContinuousBackupsDescriptions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/dynamoDBContinuousBackupsDescriptions": { + "get": { + "operationId": "DynamoDbContinuousBackupsDescriptions_ListBySubscription", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "List DynamoDBContinuousBackupsDescription resources 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/DynamoDBContinuousBackupsDescriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbContinuousBackupsDescriptions_ListBySubscription": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/dynamoDBContinuousBackupsDescriptions": { + "get": { + "operationId": "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "List DynamoDBContinuousBackupsDescription resources 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/DynamoDBContinuousBackupsDescriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/dynamoDBContinuousBackupsDescriptions/{name}": { + "get": { + "operationId": "DynamoDbContinuousBackupsDescriptions_Get", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "Get a DynamoDBContinuousBackupsDescription", + "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": "name", + "in": "path", + "description": "Name of DynamoDBContinuousBackupsDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbContinuousBackupsDescriptions_Get": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_Get.json" + } + } + }, + "put": { + "operationId": "DynamoDbContinuousBackupsDescriptions_CreateOrReplace", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "Create a DynamoDBContinuousBackupsDescription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of DynamoDBContinuousBackupsDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DynamoDBContinuousBackupsDescription' update operation succeeded", + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + } + }, + "201": { + "description": "Resource 'DynamoDBContinuousBackupsDescription' create operation succeeded", + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DynamoDbContinuousBackupsDescriptions_CreateOrReplace": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DynamoDbContinuousBackupsDescriptions_Update", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "Update a DynamoDBContinuousBackupsDescription", + "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": "name", + "in": "path", + "description": "Name of DynamoDBContinuousBackupsDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescriptionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbContinuousBackupsDescriptions_Update": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DynamoDbContinuousBackupsDescriptions_Delete", + "tags": [ + "DynamoDBContinuousBackupsDescriptions" + ], + "description": "Delete a DynamoDBContinuousBackupsDescription", + "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": "name", + "in": "path", + "description": "Name of DynamoDBContinuousBackupsDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "DynamoDbContinuousBackupsDescriptions_Delete": { + "$ref": "./examples/DynamoDbContinuousBackupsDescriptions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsDynamoDBContinuousBackupsDescriptionProperties": { + "type": "object", + "description": "Definition of awsDynamoDBContinuousBackupsDescription", + "properties": { + "continuousBackupsStatus": { + "$ref": "#/definitions/ContinuousBackupsStatusEnumValue", + "description": "<p> <code>ContinuousBackupsStatus</code> can be one of the following states: ENABLED, DISABLED</p>" + }, + "pointInTimeRecoveryDescription": { + "$ref": "#/definitions/PointInTimeRecoveryDescription", + "description": "<p>The description of the point in time recovery settings applied to the table.</p>" + } + } + }, + "ContinuousBackupsStatus": { + "type": "string", + "description": "ContinuousBackupsStatus enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "ContinuousBackupsStatus", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "ContinuousBackupsStatus enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "ContinuousBackupsStatus enum ENABLED" + } + ] + } + }, + "ContinuousBackupsStatusEnumValue": { + "type": "object", + "description": "Definition of ContinuousBackupsStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ContinuousBackupsStatus", + "description": "Property value" + } + } + }, + "DynamoDBContinuousBackupsDescription": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescriptionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DynamoDBContinuousBackupsDescriptionListResult": { + "type": "object", + "description": "The response of a DynamoDBContinuousBackupsDescription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DynamoDBContinuousBackupsDescription items on this page", + "items": { + "$ref": "#/definitions/DynamoDBContinuousBackupsDescription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DynamoDBContinuousBackupsDescriptionProperties": { + "type": "object", + "description": "Definition of DynamoDBContinuousBackupsDescription", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsDynamoDBContinuousBackupsDescriptionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DynamoDBContinuousBackupsDescriptionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in DynamoDBContinuousBackupsDescription resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PointInTimeRecoveryDescription": { + "type": "object", + "description": "Definition of PointInTimeRecoveryDescription", + "properties": { + "earliestRestorableDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days. </p>" + }, + "latestRestorableDateTime": { + "type": "string", + "format": "date-time", + "description": "<p> <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. </p>" + }, + "pointInTimeRecoveryStatus": { + "$ref": "#/definitions/PointInTimeRecoveryStatusEnumValue", + "description": "<p>The current state of point in time recovery:</p> <ul> <li> <p> <code>ENABLED</code> - Point in time recovery is enabled.</p> </li> <li> <p> <code>DISABLED</code> - Point in time recovery is disabled.</p> </li> </ul>" + } + } + }, + "PointInTimeRecoveryStatus": { + "type": "string", + "description": "PointInTimeRecoveryStatus enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "PointInTimeRecoveryStatus", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "PointInTimeRecoveryStatus enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "PointInTimeRecoveryStatus enum ENABLED" + } + ] + } + }, + "PointInTimeRecoveryStatusEnumValue": { + "type": "object", + "description": "Definition of PointInTimeRecoveryStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PointInTimeRecoveryStatus", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBTable.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBTable.json new file mode 100644 index 000000000000..1bdbeb1e7e5a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/dynamoDBTable.json @@ -0,0 +1,951 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "DynamoDBTables" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/dynamoDBTables": { + "get": { + "operationId": "DynamoDbTables_ListBySubscription", + "tags": [ + "DynamoDBTables" + ], + "description": "List DynamoDBTable resources 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/DynamoDBTableListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbTables_ListBySubscription": { + "$ref": "./examples/DynamoDbTables_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/dynamoDBTables": { + "get": { + "operationId": "DynamoDbTables_ListByResourceGroup", + "tags": [ + "DynamoDBTables" + ], + "description": "List DynamoDBTable resources 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/DynamoDBTableListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbTables_ListByResourceGroup": { + "$ref": "./examples/DynamoDbTables_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/dynamoDBTables/{name}": { + "get": { + "operationId": "DynamoDbTables_Get", + "tags": [ + "DynamoDBTables" + ], + "description": "Get a DynamoDBTable", + "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": "name", + "in": "path", + "description": "Name of DynamoDBTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynamoDBTable" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbTables_Get": { + "$ref": "./examples/DynamoDbTables_Get.json" + } + } + }, + "put": { + "operationId": "DynamoDbTables_CreateOrReplace", + "tags": [ + "DynamoDBTables" + ], + "description": "Create a DynamoDBTable. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of DynamoDBTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DynamoDBTable" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DynamoDBTable' update operation succeeded", + "schema": { + "$ref": "#/definitions/DynamoDBTable" + } + }, + "201": { + "description": "Resource 'DynamoDBTable' create operation succeeded", + "schema": { + "$ref": "#/definitions/DynamoDBTable" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DynamoDbTables_CreateOrReplace": { + "$ref": "./examples/DynamoDbTables_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DynamoDbTables_Update", + "tags": [ + "DynamoDBTables" + ], + "description": "Update a DynamoDBTable", + "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": "name", + "in": "path", + "description": "Name of DynamoDBTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DynamoDBTableTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DynamoDBTable" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DynamoDbTables_Update": { + "$ref": "./examples/DynamoDbTables_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DynamoDbTables_Delete", + "tags": [ + "DynamoDBTables" + ], + "description": "Delete a DynamoDBTable", + "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": "name", + "in": "path", + "description": "Name of DynamoDBTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "DynamoDbTables_Delete": { + "$ref": "./examples/DynamoDbTables_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttributeDefinition": { + "type": "object", + "description": "Definition of AttributeDefinition", + "properties": { + "attributeName": { + "type": "string", + "description": "A name for the attribute." + }, + "attributeType": { + "type": "string", + "description": "The data type for the attribute, where: + ``S`` - the attribute is of type String + ``N`` - the attribute is of type Number + ``B`` - the attribute is of type Binary" + } + } + }, + "AwsDynamoDBTableProperties": { + "type": "object", + "description": "Definition of awsDynamoDBTable", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "attributeDefinitions": { + "type": "array", + "description": "A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition.", + "items": { + "$ref": "#/definitions/AttributeDefinition" + }, + "x-ms-identifiers": [] + }, + "billingMode": { + "type": "string", + "description": "Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). If not specified, the default is ``PROVISIONED``." + }, + "contributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights." + }, + "deletionProtectionEnabled": { + "type": "boolean", + "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*." + }, + "globalSecondaryIndexes": { + "type": "array", + "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.", + "items": { + "$ref": "#/definitions/GlobalSecondaryIndex" + }, + "x-ms-identifiers": [] + }, + "importSourceSpecification": { + "$ref": "#/definitions/ImportSourceSpecification", + "description": "Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. Specifies the properties of data being imported from the S3 bucket source to the table." + }, + "keySchema": { + "type": "array", + "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property.", + "items": { + "$ref": "#/definitions/KeySchema" + }, + "x-ms-identifiers": [] + }, + "kinesisStreamSpecification": { + "$ref": "#/definitions/KinesisStreamSpecification", + "description": "The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table." + }, + "localSecondaryIndexes": { + "type": "array", + "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.", + "items": { + "$ref": "#/definitions/LocalSecondaryIndex" + }, + "x-ms-identifiers": [] + }, + "pointInTimeRecoverySpecification": { + "$ref": "#/definitions/PointInTimeRecoverySpecification", + "description": "The settings used to enable point in time recovery. The settings used to enable point in time recovery." + }, + "provisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." + }, + "resourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." + }, + "sseSpecification": { + "$ref": "#/definitions/SSESpecification", + "description": "Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption." + }, + "streamArn": { + "type": "string", + "description": "Property streamArn" + }, + "streamSpecification": { + "$ref": "#/definitions/StreamSpecification", + "description": "The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB." + }, + "tableClass": { + "type": "string", + "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``." + }, + "tableName": { + "type": "string", + "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "timeToLiveSpecification": { + "$ref": "#/definitions/TimeToLiveSpecification", + "description": "Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table." + } + } + }, + "ContributorInsightsSpecification": { + "type": "object", + "description": "Definition of ContributorInsightsSpecification", + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)." + } + } + }, + "Csv": { + "type": "object", + "description": "Definition of Csv", + "properties": { + "delimiter": { + "type": "string", + "description": "The delimiter used for separating items in the CSV file being imported." + }, + "headerList": { + "type": "array", + "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DynamoDBTable": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/DynamoDBTableProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DynamoDBTableListResult": { + "type": "object", + "description": "The response of a DynamoDBTable list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DynamoDBTable items on this page", + "items": { + "$ref": "#/definitions/DynamoDBTable" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DynamoDBTableProperties": { + "type": "object", + "description": "Definition of DynamoDBTable", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsDynamoDBTableProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DynamoDBTableTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in DynamoDBTable resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GlobalSecondaryIndex": { + "type": "object", + "description": "Definition of GlobalSecondaryIndex", + "properties": { + "contributorInsightsSpecification": { + "$ref": "#/definitions/ContributorInsightsSpecification", + "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights." + }, + "indexName": { + "type": "string", + "description": "The name of the global secondary index. The name must be unique among all other indexes on this table." + }, + "keySchema": { + "type": "array", + "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", + "items": { + "$ref": "#/definitions/KeySchema" + }, + "x-ms-identifiers": [] + }, + "projection": { + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + }, + "provisionedThroughput": { + "$ref": "#/definitions/ProvisionedThroughput", + "description": "Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." + } + } + }, + "ImportSourceSpecification": { + "type": "object", + "description": "Definition of ImportSourceSpecification", + "properties": { + "inputCompressionType": { + "type": "string", + "description": "Type of compression to be used on the input coming from the imported table." + }, + "inputFormat": { + "type": "string", + "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``." + }, + "inputFormatOptions": { + "$ref": "#/definitions/InputFormatOptions", + "description": "Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption." + }, + "s3BucketSource": { + "$ref": "#/definitions/S3BucketSource", + "description": "The S3 bucket that provides the source for the import. The S3 bucket that is being imported from." + } + } + }, + "InputFormatOptions": { + "type": "object", + "description": "Definition of InputFormatOptions", + "properties": { + "csv": { + "$ref": "#/definitions/Csv", + "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList." + } + } + }, + "KeySchema": { + "type": "object", + "description": "Definition of KeySchema", + "properties": { + "attributeName": { + "type": "string", + "description": "The name of a key attribute." + }, + "keyType": { + "type": "string", + "description": "The role that this key attribute will assume: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." + } + } + }, + "KinesisStreamSpecification": { + "type": "object", + "description": "Definition of KinesisStreamSpecification", + "properties": { + "approximateCreationDateTimePrecision": { + "$ref": "#/definitions/KinesisStreamSpecificationApproximateCreationDateTimePrecision", + "description": "The precision for the time and date that the stream was created." + }, + "streamArn": { + "type": "string", + "description": "The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024." + } + } + }, + "KinesisStreamSpecificationApproximateCreationDateTimePrecision": { + "type": "string", + "description": "KinesisStreamSpecificationApproximateCreationDateTimePrecision enum", + "enum": [ + "MICROSECOND", + "MILLISECOND" + ], + "x-ms-enum": { + "name": "KinesisStreamSpecificationApproximateCreationDateTimePrecision", + "modelAsString": true, + "values": [ + { + "name": "MICROSECOND", + "value": "MICROSECOND", + "description": "KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MICROSECOND" + }, + { + "name": "MILLISECOND", + "value": "MILLISECOND", + "description": "KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MILLISECOND" + } + ] + } + }, + "LocalSecondaryIndex": { + "type": "object", + "description": "Definition of LocalSecondaryIndex", + "properties": { + "indexName": { + "type": "string", + "description": "The name of the local secondary index. The name must be unique among all other indexes on this table." + }, + "keySchema": { + "type": "array", + "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.", + "items": { + "$ref": "#/definitions/KeySchema" + }, + "x-ms-identifiers": [] + }, + "projection": { + "$ref": "#/definitions/Projection", + "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." + } + } + }, + "PointInTimeRecoverySpecification": { + "type": "object", + "description": "Definition of PointInTimeRecoverySpecification", + "properties": { + "pointInTimeRecoveryEnabled": { + "type": "boolean", + "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table." + } + } + }, + "Projection": { + "type": "object", + "description": "Definition of Projection", + "properties": { + "nonKeyAttributes": { + "type": "array", + "description": "Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "projectionType": { + "type": "string", + "description": "The set of attributes that are projected into the index: + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default." + } + } + }, + "ProvisionedThroughput": { + "type": "object", + "description": "Definition of ProvisionedThroughput", + "properties": { + "readCapacityUnits": { + "type": "integer", + "format": "int32", + "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." + }, + "writeCapacityUnits": { + "type": "integer", + "format": "int32", + "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ResourcePolicy": { + "type": "object", + "description": "Definition of ResourcePolicy", + "properties": { + "policyDocument": { + "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." + } + } + }, + "S3BucketSource": { + "type": "object", + "description": "Definition of S3BucketSource", + "properties": { + "s3Bucket": { + "type": "string", + "description": "The S3 bucket that is being imported from." + }, + "s3BucketOwner": { + "type": "string", + "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional." + }, + "s3KeyPrefix": { + "type": "string", + "description": "The key prefix shared by all S3 Objects that are being imported." + } + } + }, + "SSESpecification": { + "type": "object", + "description": "Definition of SSESpecification", + "properties": { + "kmsMasterKeyId": { + "type": "string", + "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``." + }, + "sseEnabled": { + "type": "boolean", + "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key." + }, + "sseType": { + "type": "string", + "description": "Server-side encryption type. The only supported value is: + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply)." + } + } + }, + "StreamSpecification": { + "type": "object", + "description": "Definition of StreamSpecification", + "properties": { + "resourcePolicy": { + "$ref": "#/definitions/ResourcePolicy", + "description": "Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." + }, + "streamViewType": { + "type": "string", + "description": "When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value." + }, + "value": { + "type": "string", + "description": "The value of the tag. Tag values are case-sensitive and can be null." + } + } + }, + "TimeToLiveSpecification": { + "type": "object", + "description": "Definition of TimeToLiveSpecification", + "properties": { + "attributeName": { + "type": "string", + "description": "The name of the TTL attribute used to store the expiration time for items in the table. + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name." + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether TTL is to be enabled (true) or disabled (false) on the table." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2AccountAttribute.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2AccountAttribute.json new file mode 100644 index 000000000000..14b21f3e8395 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2AccountAttribute.json @@ -0,0 +1,564 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2AccountAttributes" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2AccountAttributes": { + "get": { + "operationId": "Ec2AccountAttributes_ListBySubscription", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "List Ec2AccountAttribute resources 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/Ec2AccountAttributeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2AccountAttributes_ListBySubscription": { + "$ref": "./examples/Ec2AccountAttributes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2AccountAttributes": { + "get": { + "operationId": "Ec2AccountAttributes_ListByResourceGroup", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "List Ec2AccountAttribute resources 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/Ec2AccountAttributeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2AccountAttributes_ListByResourceGroup": { + "$ref": "./examples/Ec2AccountAttributes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2AccountAttributes/{name}": { + "get": { + "operationId": "Ec2AccountAttributes_Get", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "Get a Ec2AccountAttribute", + "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": "name", + "in": "path", + "description": "Name of Ec2AccountAttribute", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2AccountAttribute" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2AccountAttributes_Get": { + "$ref": "./examples/Ec2AccountAttributes_Get.json" + } + } + }, + "put": { + "operationId": "Ec2AccountAttributes_CreateOrReplace", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "Create a Ec2AccountAttribute. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2AccountAttribute", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2AccountAttribute" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2AccountAttribute' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2AccountAttribute" + } + }, + "201": { + "description": "Resource 'Ec2AccountAttribute' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2AccountAttribute" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2AccountAttributes_CreateOrReplace": { + "$ref": "./examples/Ec2AccountAttributes_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2AccountAttributes_Update", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "Update a Ec2AccountAttribute", + "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": "name", + "in": "path", + "description": "Name of Ec2AccountAttribute", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2AccountAttributeTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2AccountAttribute" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2AccountAttributes_Update": { + "$ref": "./examples/Ec2AccountAttributes_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2AccountAttributes_Delete", + "tags": [ + "Ec2AccountAttributes" + ], + "description": "Delete a Ec2AccountAttribute", + "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": "name", + "in": "path", + "description": "Name of Ec2AccountAttribute", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2AccountAttributes_Delete": { + "$ref": "./examples/Ec2AccountAttributes_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccountAttributeValue": { + "type": "object", + "description": "Definition of AccountAttributeValue", + "properties": { + "attributeValue": { + "type": "string", + "description": "<p>The value of the attribute.</p>" + } + } + }, + "AwsEc2AccountAttributeProperties": { + "type": "object", + "description": "Definition of awsEc2AccountAttribute", + "properties": { + "attributeName": { + "type": "string", + "description": "<p>The name of the account attribute.</p>" + }, + "attributeValues": { + "type": "array", + "description": "<p>The values for the account attribute.</p>", + "items": { + "$ref": "#/definitions/AccountAttributeValue" + }, + "x-ms-identifiers": [] + } + } + }, + "Ec2AccountAttribute": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2AccountAttributeProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2AccountAttributeListResult": { + "type": "object", + "description": "The response of a Ec2AccountAttribute list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2AccountAttribute items on this page", + "items": { + "$ref": "#/definitions/Ec2AccountAttribute" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2AccountAttributeProperties": { + "type": "object", + "description": "Definition of Ec2AccountAttribute", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2AccountAttributeProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2AccountAttributeTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2AccountAttribute resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Address.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Address.json new file mode 100644 index 000000000000..a655c696454e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Address.json @@ -0,0 +1,650 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Addresses" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Addresses": { + "get": { + "operationId": "Ec2Addresses_ListBySubscription", + "tags": [ + "Ec2Addresses" + ], + "description": "List Ec2Address resources 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/Ec2AddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Addresses_ListBySubscription": { + "$ref": "./examples/Ec2Addresses_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Addresses": { + "get": { + "operationId": "Ec2Addresses_ListByResourceGroup", + "tags": [ + "Ec2Addresses" + ], + "description": "List Ec2Address resources 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/Ec2AddressListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Addresses_ListByResourceGroup": { + "$ref": "./examples/Ec2Addresses_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Addresses/{name}": { + "get": { + "operationId": "Ec2Addresses_Get", + "tags": [ + "Ec2Addresses" + ], + "description": "Get a Ec2Address", + "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": "name", + "in": "path", + "description": "Name of Ec2Address", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Address" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Addresses_Get": { + "$ref": "./examples/Ec2Addresses_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Addresses_CreateOrReplace", + "tags": [ + "Ec2Addresses" + ], + "description": "Create a Ec2Address. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Address", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Address" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Address' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Address" + } + }, + "201": { + "description": "Resource 'Ec2Address' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Address" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Addresses_CreateOrReplace": { + "$ref": "./examples/Ec2Addresses_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Addresses_Update", + "tags": [ + "Ec2Addresses" + ], + "description": "Update a Ec2Address", + "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": "name", + "in": "path", + "description": "Name of Ec2Address", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2AddressTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Address" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Addresses_Update": { + "$ref": "./examples/Ec2Addresses_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Addresses_Delete", + "tags": [ + "Ec2Addresses" + ], + "description": "Delete a Ec2Address", + "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": "name", + "in": "path", + "description": "Name of Ec2Address", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Addresses_Delete": { + "$ref": "./examples/Ec2Addresses_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2AddressProperties": { + "type": "object", + "description": "Definition of awsEc2Address", + "properties": { + "allocationId": { + "type": "string", + "description": "<p>The ID representing the allocation of the address.</p>" + }, + "associationId": { + "type": "string", + "description": "<p>The ID representing the association of the address with an instance.</p>" + }, + "carrierIp": { + "type": "string", + "description": "<p>The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). </p>" + }, + "customerOwnedIp": { + "type": "string", + "description": "<p>The customer-owned IP address.</p>" + }, + "customerOwnedIpv4Pool": { + "type": "string", + "description": "<p>The ID of the customer-owned address pool.</p>" + }, + "domain": { + "$ref": "#/definitions/DomainTypeEnumValue", + "description": "<p>The network (<code>vpc</code>).</p>" + }, + "instanceId": { + "type": "string", + "description": "<p>The ID of the instance that the address is associated with (if any).</p>" + }, + "networkBorderGroup": { + "type": "string", + "description": "<p>The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.</p>" + }, + "networkInterfaceId": { + "type": "string", + "description": "<p>The ID of the network interface.</p>" + }, + "networkInterfaceOwnerId": { + "type": "string", + "description": "<p>The ID of the Amazon Web Services account that owns the network interface.</p>" + }, + "privateIpAddress": { + "type": "string", + "description": "<p>The private IP address associated with the Elastic IP address.</p>" + }, + "publicIp": { + "type": "string", + "description": "<p>The Elastic IP address.</p>" + }, + "publicIpv4Pool": { + "type": "string", + "description": "<p>The ID of an address pool.</p>" + }, + "tags": { + "type": "array", + "description": "<p>Any tags assigned to the Elastic IP address.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "DomainType": { + "type": "string", + "description": "DomainType enum", + "enum": [ + "standard", + "vpc" + ], + "x-ms-enum": { + "name": "DomainType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "standard", + "description": "DomainType enum standard" + }, + { + "name": "Vpc", + "value": "vpc", + "description": "DomainType enum vpc" + } + ] + } + }, + "DomainTypeEnumValue": { + "type": "object", + "description": "Definition of DomainTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DomainType", + "description": "Property value" + } + } + }, + "Ec2Address": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2AddressProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2AddressListResult": { + "type": "object", + "description": "The response of a Ec2Address list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Address items on this page", + "items": { + "$ref": "#/definitions/Ec2Address" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2AddressProperties": { + "type": "object", + "description": "Definition of Ec2Address", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2AddressProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2AddressTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Address resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2FlowLog.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2FlowLog.json new file mode 100644 index 000000000000..fbd7b129bbb7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2FlowLog.json @@ -0,0 +1,757 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2FlowLogs" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2FlowLogs": { + "get": { + "operationId": "Ec2FlowLogs_ListBySubscription", + "tags": [ + "Ec2FlowLogs" + ], + "description": "List Ec2FlowLog resources 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/Ec2FlowLogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2FlowLogs_ListBySubscription": { + "$ref": "./examples/Ec2FlowLogs_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2FlowLogs": { + "get": { + "operationId": "Ec2FlowLogs_ListByResourceGroup", + "tags": [ + "Ec2FlowLogs" + ], + "description": "List Ec2FlowLog resources 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/Ec2FlowLogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2FlowLogs_ListByResourceGroup": { + "$ref": "./examples/Ec2FlowLogs_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2FlowLogs/{name}": { + "get": { + "operationId": "Ec2FlowLogs_Get", + "tags": [ + "Ec2FlowLogs" + ], + "description": "Get a Ec2FlowLog", + "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": "name", + "in": "path", + "description": "Name of Ec2FlowLog", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2FlowLog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2FlowLogs_Get": { + "$ref": "./examples/Ec2FlowLogs_Get.json" + } + } + }, + "put": { + "operationId": "Ec2FlowLogs_CreateOrReplace", + "tags": [ + "Ec2FlowLogs" + ], + "description": "Create a Ec2FlowLog. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2FlowLog", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2FlowLog" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2FlowLog' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2FlowLog" + } + }, + "201": { + "description": "Resource 'Ec2FlowLog' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2FlowLog" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2FlowLogs_CreateOrReplace": { + "$ref": "./examples/Ec2FlowLogs_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2FlowLogs_Update", + "tags": [ + "Ec2FlowLogs" + ], + "description": "Update a Ec2FlowLog", + "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": "name", + "in": "path", + "description": "Name of Ec2FlowLog", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2FlowLogTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2FlowLog" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2FlowLogs_Update": { + "$ref": "./examples/Ec2FlowLogs_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2FlowLogs_Delete", + "tags": [ + "Ec2FlowLogs" + ], + "description": "Delete a Ec2FlowLog", + "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": "name", + "in": "path", + "description": "Name of Ec2FlowLog", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2FlowLogs_Delete": { + "$ref": "./examples/Ec2FlowLogs_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2FlowLogProperties": { + "type": "object", + "description": "Definition of awsEc2FlowLog", + "properties": { + "deliverCrossAccountRole": { + "type": "string", + "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts." + }, + "deliverLogsPermissionArn": { + "type": "string", + "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." + }, + "destinationOptions": { + "$ref": "#/definitions/DestinationOptionsModelProperties", + "description": "Property destinationOptions" + }, + "id": { + "type": "string", + "description": "The Flow Log ID" + }, + "logDestination": { + "type": "string", + "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType." + }, + "logDestinationType": { + "$ref": "#/definitions/LogDestinationType", + "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3." + }, + "logFormat": { + "type": "string", + "description": "The fields to include in the flow log record, in the order in which they should appear." + }, + "logGroupName": { + "type": "string", + "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." + }, + "maxAggregationInterval": { + "type": "integer", + "format": "int32", + "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes)." + }, + "resourceId": { + "type": "string", + "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log." + }, + "resourceType": { + "$ref": "#/definitions/ResourceType", + "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property." + }, + "tags": { + "type": "array", + "description": "The tags to apply to the flow logs.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "trafficType": { + "$ref": "#/definitions/TrafficType", + "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic." + } + } + }, + "DestinationOptionsModelProperties": { + "type": "object", + "description": "Definition of DestinationOptionsModelProperties", + "properties": { + "fileFormat": { + "$ref": "#/definitions/FileFormat", + "description": "Property fileFormat" + }, + "hiveCompatiblePartitions": { + "type": "boolean", + "description": "Property hiveCompatiblePartitions" + }, + "perHourPartition": { + "type": "boolean", + "description": "Property perHourPartition" + } + } + }, + "Ec2FlowLog": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2FlowLogProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2FlowLogListResult": { + "type": "object", + "description": "The response of a Ec2FlowLog list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2FlowLog items on this page", + "items": { + "$ref": "#/definitions/Ec2FlowLog" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2FlowLogProperties": { + "type": "object", + "description": "Definition of Ec2FlowLog", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2FlowLogProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2FlowLogTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2FlowLog resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FileFormat": { + "type": "string", + "description": "FileFormat enum", + "enum": [ + "parquet", + "plain-text" + ], + "x-ms-enum": { + "name": "FileFormat", + "modelAsString": true, + "values": [ + { + "name": "parquet", + "value": "parquet", + "description": "FileFormat enum parquet" + }, + { + "name": "PlainText", + "value": "plain-text", + "description": "FileFormat enum plain-text" + } + ] + } + }, + "LogDestinationType": { + "type": "string", + "description": "LogDestinationType enum", + "enum": [ + "cloud-watch-logs", + "kinesis-data-firehose", + "s3" + ], + "x-ms-enum": { + "name": "LogDestinationType", + "modelAsString": true, + "values": [ + { + "name": "CloudWatchLogs", + "value": "cloud-watch-logs", + "description": "LogDestinationType enum cloud-watch-logs" + }, + { + "name": "KinesisDataFirehose", + "value": "kinesis-data-firehose", + "description": "LogDestinationType enum kinesis-data-firehose" + }, + { + "name": "s3", + "value": "s3", + "description": "LogDestinationType enum s3" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ResourceType": { + "type": "string", + "description": "ResourceType enum", + "enum": [ + "NetworkInterface", + "Subnet", + "TransitGateway", + "TransitGatewayAttachment", + "VPC" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true, + "values": [ + { + "name": "NetworkInterface", + "value": "NetworkInterface", + "description": "ResourceType enum NetworkInterface" + }, + { + "name": "Subnet", + "value": "Subnet", + "description": "ResourceType enum Subnet" + }, + { + "name": "TransitGateway", + "value": "TransitGateway", + "description": "ResourceType enum TransitGateway" + }, + { + "name": "TransitGatewayAttachment", + "value": "TransitGatewayAttachment", + "description": "ResourceType enum TransitGatewayAttachment" + }, + { + "name": "VPC", + "value": "VPC", + "description": "ResourceType enum VPC" + } + ] + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "TrafficType": { + "type": "string", + "description": "TrafficType enum", + "enum": [ + "ACCEPT", + "ALL", + "REJECT" + ], + "x-ms-enum": { + "name": "TrafficType", + "modelAsString": true, + "values": [ + { + "name": "ACCEPT", + "value": "ACCEPT", + "description": "TrafficType enum ACCEPT" + }, + { + "name": "ALL", + "value": "ALL", + "description": "TrafficType enum ALL" + }, + { + "name": "REJECT", + "value": "REJECT", + "description": "TrafficType enum REJECT" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Image.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Image.json new file mode 100644 index 000000000000..3f928a3cba26 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Image.json @@ -0,0 +1,1281 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Images" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Images": { + "get": { + "operationId": "Ec2Images_ListBySubscription", + "tags": [ + "Ec2Images" + ], + "description": "List Ec2Image resources 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/Ec2ImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Images_ListBySubscription": { + "$ref": "./examples/Ec2Images_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Images": { + "get": { + "operationId": "Ec2Images_ListByResourceGroup", + "tags": [ + "Ec2Images" + ], + "description": "List Ec2Image resources 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/Ec2ImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Images_ListByResourceGroup": { + "$ref": "./examples/Ec2Images_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Images/{name}": { + "get": { + "operationId": "Ec2Images_Get", + "tags": [ + "Ec2Images" + ], + "description": "Get a Ec2Image", + "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": "name", + "in": "path", + "description": "Name of Ec2Image", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Image" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Images_Get": { + "$ref": "./examples/Ec2Images_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Images_CreateOrReplace", + "tags": [ + "Ec2Images" + ], + "description": "Create a Ec2Image. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Image", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Image" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Image' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Image" + } + }, + "201": { + "description": "Resource 'Ec2Image' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Image" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Images_CreateOrReplace": { + "$ref": "./examples/Ec2Images_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Images_Update", + "tags": [ + "Ec2Images" + ], + "description": "Update a Ec2Image", + "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": "name", + "in": "path", + "description": "Name of Ec2Image", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2ImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Image" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Images_Update": { + "$ref": "./examples/Ec2Images_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Images_Delete", + "tags": [ + "Ec2Images" + ], + "description": "Delete a Ec2Image", + "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": "name", + "in": "path", + "description": "Name of Ec2Image", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Images_Delete": { + "$ref": "./examples/Ec2Images_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ArchitectureValues": { + "type": "string", + "description": "ArchitectureValues enum", + "enum": [ + "arm64", + "arm64_mac", + "i386", + "x86_64", + "x86_64_mac" + ], + "x-ms-enum": { + "name": "ArchitectureValues", + "modelAsString": true, + "values": [ + { + "name": "Arm64", + "value": "arm64", + "description": "ArchitectureValues enum arm64" + }, + { + "name": "Arm64_mac", + "value": "arm64_mac", + "description": "ArchitectureValues enum arm64_mac" + }, + { + "name": "I386", + "value": "i386", + "description": "ArchitectureValues enum i386" + }, + { + "name": "X86_64", + "value": "x86_64", + "description": "ArchitectureValues enum x86_64" + }, + { + "name": "X86_64_mac", + "value": "x86_64_mac", + "description": "ArchitectureValues enum x86_64_mac" + } + ] + } + }, + "ArchitectureValuesEnumValue": { + "type": "object", + "description": "Definition of ArchitectureValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ArchitectureValues", + "description": "Property value" + } + } + }, + "AwsEc2ImageProperties": { + "type": "object", + "description": "Definition of awsEc2Image", + "properties": { + "architecture": { + "$ref": "#/definitions/ArchitectureValuesEnumValue", + "description": "<p>The architecture of the image.</p>" + }, + "blockDeviceMappings": { + "type": "array", + "description": "<p>Any block device mapping entries.</p>", + "items": { + "$ref": "#/definitions/BlockDeviceMapping" + }, + "x-ms-identifiers": [] + }, + "bootMode": { + "$ref": "#/definitions/BootModeValuesEnumValue", + "description": "<p>The boot mode of the image. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "creationDate": { + "type": "string", + "description": "<p>The date and time the image was created.</p>" + }, + "deprecationTime": { + "type": "string", + "description": "<p>The date and time to deprecate the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.</p>" + }, + "deregistrationProtection": { + "type": "string", + "description": "<p>Indicates whether deregistration protection is enabled for the AMI.</p>" + }, + "description": { + "type": "string", + "description": "<p>The description of the AMI that was provided during image creation.</p>" + }, + "enaSupport": { + "type": "boolean", + "description": "<p>Specifies whether enhanced networking with ENA is enabled.</p>" + }, + "hypervisor": { + "$ref": "#/definitions/HypervisorTypeEnumValue", + "description": "<p>The hypervisor type of the image. Only <code>xen</code> is supported. <code>ovm</code> is not supported.</p>" + }, + "imageId": { + "type": "string", + "description": "<p>The ID of the AMI.</p>" + }, + "imageLocation": { + "type": "string", + "description": "<p>The location of the AMI.</p>" + }, + "imageOwnerAlias": { + "type": "string", + "description": "<p>The owner alias (<code>amazon</code> | <code>aws-marketplace</code>).</p>" + }, + "imageType": { + "$ref": "#/definitions/ImageTypeValuesEnumValue", + "description": "<p>The type of image.</p>" + }, + "imdsSupport": { + "$ref": "#/definitions/ImdsSupportValuesEnumValue", + "description": "<p>If <code>v2.0</code>, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have <code>HttpTokens</code> automatically set to <code>required</code> so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, <code>HttpPutResponseHopLimit</code> is set to <code>2</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'>Configure the AMI</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "kernelId": { + "type": "string", + "description": "<p>The kernel associated with the image, if any. Only applicable for machine images.</p>" + }, + "lastLaunchedTime": { + "type": "string", + "description": "<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.</p> <note> <p> <code>lastLaunchedTime</code> data is available starting April 2017.</p> </note>" + }, + "name": { + "type": "string", + "description": "<p>The name of the AMI that was provided during image creation.</p>" + }, + "ownerId": { + "type": "string", + "description": "<p>The ID of the Amazon Web Services account that owns the image.</p>" + }, + "platform": { + "$ref": "#/definitions/PlatformValuesEnumValue", + "description": "<p>This value is set to <code>windows</code> for Windows AMIs; otherwise, it is blank.</p>" + }, + "platformDetails": { + "type": "string", + "description": "<p>The platform details associated with the billing code of the AMI. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'>Understand AMI billing information</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "productCodes": { + "type": "array", + "description": "<p>Any product codes associated with the AMI.</p>", + "items": { + "$ref": "#/definitions/ProductCode" + }, + "x-ms-identifiers": [] + }, + "public": { + "type": "boolean", + "description": "<p>Indicates whether the image has public launch permissions. The value is <code>true</code> if this image has public launch permissions or <code>false</code> if it has only implicit and explicit launch permissions.</p>" + }, + "ramdiskId": { + "type": "string", + "description": "<p>The RAM disk associated with the image, if any. Only applicable for machine images.</p>" + }, + "rootDeviceName": { + "type": "string", + "description": "<p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>" + }, + "rootDeviceType": { + "$ref": "#/definitions/DeviceTypeEnumValue", + "description": "<p>The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.</p>" + }, + "sourceInstanceId": { + "type": "string", + "description": "<p>The ID of the instance that the AMI was created from if the AMI was created using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>. This field only appears if the AMI was created using CreateImage.</p>" + }, + "sriovNetSupport": { + "type": "string", + "description": "<p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>" + }, + "state": { + "$ref": "#/definitions/ImageStateEnumValue", + "description": "<p>The current state of the AMI. If the state is <code>available</code>, the image is successfully registered and can be used to launch an instance.</p>" + }, + "stateReason": { + "$ref": "#/definitions/StateReason", + "description": "<p>The reason for the state change.</p>" + }, + "tags": { + "type": "array", + "description": "<p>Any tags assigned to the image.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tpmSupport": { + "$ref": "#/definitions/TpmSupportValuesEnumValue", + "description": "<p>If the image is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "usageOperation": { + "type": "string", + "description": "<p>The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. <code>usageOperation</code> corresponds to the <a href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'>lineitem/Operation</a> column on your Amazon Web Services Cost and Usage Report and in the <a href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'>Amazon Web Services Price List API</a>. You can view these fields on the <b>Instances</b> or <b>AMIs</b> pages in the Amazon EC2 console, or in the responses that are returned by the <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'>DescribeImages</a> command in the Amazon EC2 API, or the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'>describe-images</a> command in the CLI.</p>" + }, + "virtualizationType": { + "$ref": "#/definitions/VirtualizationTypeEnumValue", + "description": "<p>The type of virtualization of the AMI.</p>" + } + } + }, + "BlockDeviceMapping": { + "type": "object", + "description": "Definition of BlockDeviceMapping", + "properties": { + "deviceName": { + "type": "string", + "description": "<p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>" + }, + "ebs": { + "$ref": "#/definitions/EbsBlockDevice", + "description": "<p>Parameters used to automatically set up EBS volumes when the instance is launched.</p>" + }, + "noDevice": { + "type": "string", + "description": "<p>To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.</p>" + }, + "virtualName": { + "type": "string", + "description": "<p>The virtual device name (<code>ephemeral</code>N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for <code>ephemeral0</code> and <code>ephemeral1</code>. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.</p> <p>NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.</p> <p>Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.</p>" + } + } + }, + "BootModeValues": { + "type": "string", + "description": "BootModeValues enum", + "enum": [ + "legacy-bios", + "uefi", + "uefi-preferred" + ], + "x-ms-enum": { + "name": "BootModeValues", + "modelAsString": true, + "values": [ + { + "name": "LegacyBios", + "value": "legacy-bios", + "description": "BootModeValues enum legacy-bios" + }, + { + "name": "Uefi", + "value": "uefi", + "description": "BootModeValues enum uefi" + }, + { + "name": "UefiPreferred", + "value": "uefi-preferred", + "description": "BootModeValues enum uefi-preferred" + } + ] + } + }, + "BootModeValuesEnumValue": { + "type": "object", + "description": "Definition of BootModeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/BootModeValues", + "description": "Property value" + } + } + }, + "DeviceType": { + "type": "string", + "description": "DeviceType enum", + "enum": [ + "ebs", + "instance-store" + ], + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true, + "values": [ + { + "name": "Ebs", + "value": "ebs", + "description": "DeviceType enum ebs" + }, + { + "name": "InstanceStore", + "value": "instance-store", + "description": "DeviceType enum instance-store" + } + ] + } + }, + "DeviceTypeEnumValue": { + "type": "object", + "description": "Definition of DeviceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DeviceType", + "description": "Property value" + } + } + }, + "EbsBlockDevice": { + "type": "object", + "description": "Definition of EbsBlockDevice", + "properties": { + "deleteOnTermination": { + "type": "boolean", + "description": "<p>Indicates whether the EBS volume is deleted on instance termination. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'>Preserving Amazon EBS volumes on instance termination</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "encrypted": { + "type": "boolean", + "description": "<p>Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to <code>true</code> depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'>Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p> <p>In no case can you remove encryption from an encrypted volume.</p> <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'>Supported instance types</a>.</p> <p>This parameter is not returned by <a>DescribeImageAttribute</a>.</p> <p>For <a>CreateImage</a> and <a>RegisterImage</a>, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.</p> <ul> <li> <p>If you are creating a block device mapping for a <b>new (empty) volume</b>, you can include this parameter, and specify either <code>true</code> for an encrypted volume, or <code>false</code> for an unencrypted volume. If you omit this parameter, it defaults to <code>false</code> (unencrypted).</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted or unencrypted snapshot</b>, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing unencrypted volume</b>, you can include this parameter, but you must specify <code>false</code>. If you specify <code>true</code>, the request will fail. In this case, we recommend that you omit the parameter.</p> </li> <li> <p>If you are creating a block device mapping from an <b>existing encrypted volume</b>, you can include this parameter, and specify either <code>true</code> or <code>false</code>. However, if you specify <code>false</code>, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.</p> </li> </ul>" + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "<p>The number of I/O operations per second (IOPS). For <code>gp3</code>, <code>io1</code>, and <code>io2</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.</p> <p>The following are the supported values for each volume type:</p> <ul> <li> <p> <code>gp3</code>: 3,000 - 16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100 - 64,000 IOPS</p> </li> <li> <p> <code>io2</code>: 100 - 256,000 IOPS</p> </li> </ul> <p>For <code>io2</code> volumes, you can achieve up to 256,000 IOPS on <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'>instances built on the Nitro System</a>. On other instances, you can achieve performance up to 32,000 IOPS.</p> <p>This parameter is required for <code>io1</code> and <code>io2</code> volumes. The default for <code>gp3</code> volumes is 3,000 IOPS.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.</p> <p>This parameter is only supported on <code>BlockDeviceMapping</code> objects called by <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>, <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'>RequestSpotFleet</a>, and <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'>RequestSpotInstances</a>.</p>" + }, + "outpostArn": { + "type": "string", + "description": "<p>The ARN of the Outpost on which the snapshot is stored.</p> <p>This parameter is not supported when using <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'>CreateImage</a>.</p>" + }, + "snapshotId": { + "type": "string", + "description": "<p>The ID of the snapshot.</p>" + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "<p>The throughput that the volume supports, in MiB/s.</p> <p>This parameter is valid only for <code>gp3</code> volumes.</p> <p>Valid Range: Minimum value of 125. Maximum value of 1000.</p>" + }, + "volumeSize": { + "type": "integer", + "format": "int32", + "description": "<p>The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.</p> <p>The following are the supported sizes for each volume type:</p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1 - 16,384 GiB</p> </li> <li> <p> <code>io1</code>: 4 - 16,384 GiB</p> </li> <li> <p> <code>io2</code>: 4 - 65,536 GiB</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125 - 16,384 GiB</p> </li> <li> <p> <code>standard</code>: 1 - 1024 GiB</p> </li> </ul>" + }, + "volumeType": { + "$ref": "#/definitions/VolumeTypeEnumValue", + "description": "<p>The volume type. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'>Amazon EBS volume types</a> in the <i>Amazon EBS User Guide</i>.</p>" + } + } + }, + "Ec2Image": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2ImageProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2ImageListResult": { + "type": "object", + "description": "The response of a Ec2Image list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Image items on this page", + "items": { + "$ref": "#/definitions/Ec2Image" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2ImageProperties": { + "type": "object", + "description": "Definition of Ec2Image", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2ImageProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2ImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Image resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "HypervisorType": { + "type": "string", + "description": "HypervisorType enum", + "enum": [ + "ovm", + "xen" + ], + "x-ms-enum": { + "name": "HypervisorType", + "modelAsString": true, + "values": [ + { + "name": "Ovm", + "value": "ovm", + "description": "HypervisorType enum ovm" + }, + { + "name": "Xen", + "value": "xen", + "description": "HypervisorType enum xen" + } + ] + } + }, + "HypervisorTypeEnumValue": { + "type": "object", + "description": "Definition of HypervisorTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/HypervisorType", + "description": "Property value" + } + } + }, + "ImageState": { + "type": "string", + "description": "ImageState enum", + "enum": [ + "available", + "deregistered", + "disabled", + "error", + "failed", + "invalid", + "pending", + "transient" + ], + "x-ms-enum": { + "name": "ImageState", + "modelAsString": true, + "values": [ + { + "name": "Available", + "value": "available", + "description": "ImageState enum available" + }, + { + "name": "Deregistered", + "value": "deregistered", + "description": "ImageState enum deregistered" + }, + { + "name": "Disabled", + "value": "disabled", + "description": "ImageState enum disabled" + }, + { + "name": "Error", + "value": "error", + "description": "ImageState enum error" + }, + { + "name": "Failed", + "value": "failed", + "description": "ImageState enum failed" + }, + { + "name": "Invalid", + "value": "invalid", + "description": "ImageState enum invalid" + }, + { + "name": "Pending", + "value": "pending", + "description": "ImageState enum pending" + }, + { + "name": "Transient", + "value": "transient", + "description": "ImageState enum transient" + } + ] + } + }, + "ImageStateEnumValue": { + "type": "object", + "description": "Definition of ImageStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ImageState", + "description": "Property value" + } + } + }, + "ImageTypeValues": { + "type": "string", + "description": "ImageTypeValues enum", + "enum": [ + "kernel", + "machine", + "ramdisk" + ], + "x-ms-enum": { + "name": "ImageTypeValues", + "modelAsString": true, + "values": [ + { + "name": "Kernel", + "value": "kernel", + "description": "ImageTypeValues enum kernel" + }, + { + "name": "Machine", + "value": "machine", + "description": "ImageTypeValues enum machine" + }, + { + "name": "Ramdisk", + "value": "ramdisk", + "description": "ImageTypeValues enum ramdisk" + } + ] + } + }, + "ImageTypeValuesEnumValue": { + "type": "object", + "description": "Definition of ImageTypeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ImageTypeValues", + "description": "Property value" + } + } + }, + "ImdsSupportValues": { + "type": "string", + "description": "ImdsSupportValues enum", + "enum": [ + "v2.0" + ], + "x-ms-enum": { + "name": "ImdsSupportValues", + "modelAsString": true, + "values": [ + { + "name": "V20", + "value": "v2.0", + "description": "ImdsSupportValues enum v2.0" + } + ] + } + }, + "ImdsSupportValuesEnumValue": { + "type": "object", + "description": "Definition of ImdsSupportValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ImdsSupportValues", + "description": "Property value" + } + } + }, + "PlatformValues": { + "type": "string", + "description": "PlatformValues enum", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "PlatformValues", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "PlatformValues enum Windows" + } + ] + } + }, + "PlatformValuesEnumValue": { + "type": "object", + "description": "Definition of PlatformValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PlatformValues", + "description": "Property value" + } + } + }, + "ProductCode": { + "type": "object", + "description": "Definition of ProductCode", + "properties": { + "productCodeId": { + "type": "string", + "description": "<p>The product code.</p>" + }, + "productCodeType": { + "$ref": "#/definitions/ProductCodeValuesEnumValue", + "description": "<p>The type of product code.</p>" + } + } + }, + "ProductCodeValues": { + "type": "string", + "description": "ProductCodeValues enum", + "enum": [ + "devpay", + "marketplace" + ], + "x-ms-enum": { + "name": "ProductCodeValues", + "modelAsString": true, + "values": [ + { + "name": "Devpay", + "value": "devpay", + "description": "ProductCodeValues enum devpay" + }, + { + "name": "Marketplace", + "value": "marketplace", + "description": "ProductCodeValues enum marketplace" + } + ] + } + }, + "ProductCodeValuesEnumValue": { + "type": "object", + "description": "Definition of ProductCodeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ProductCodeValues", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StateReason": { + "type": "object", + "description": "Definition of StateReason", + "properties": { + "code": { + "type": "string", + "description": "<p>The reason code for the state change.</p>" + }, + "message": { + "type": "string", + "description": "<p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul>" + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + }, + "TpmSupportValues": { + "type": "string", + "description": "TpmSupportValues enum", + "enum": [ + "v2.0" + ], + "x-ms-enum": { + "name": "TpmSupportValues", + "modelAsString": true, + "values": [ + { + "name": "V20", + "value": "v2.0", + "description": "TpmSupportValues enum v2.0" + } + ] + } + }, + "TpmSupportValuesEnumValue": { + "type": "object", + "description": "Definition of TpmSupportValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/TpmSupportValues", + "description": "Property value" + } + } + }, + "VirtualizationType": { + "type": "string", + "description": "VirtualizationType enum", + "enum": [ + "hvm", + "paravirtual" + ], + "x-ms-enum": { + "name": "VirtualizationType", + "modelAsString": true, + "values": [ + { + "name": "Hvm", + "value": "hvm", + "description": "VirtualizationType enum hvm" + }, + { + "name": "Paravirtual", + "value": "paravirtual", + "description": "VirtualizationType enum paravirtual" + } + ] + } + }, + "VirtualizationTypeEnumValue": { + "type": "object", + "description": "Definition of VirtualizationTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/VirtualizationType", + "description": "Property value" + } + } + }, + "VolumeType": { + "type": "string", + "description": "VolumeType enum", + "enum": [ + "gp2", + "gp3", + "io1", + "io2", + "sc1", + "st1", + "standard" + ], + "x-ms-enum": { + "name": "VolumeType", + "modelAsString": true, + "values": [ + { + "name": "Gp2", + "value": "gp2", + "description": "VolumeType enum gp2" + }, + { + "name": "Gp3", + "value": "gp3", + "description": "VolumeType enum gp3" + }, + { + "name": "Io1", + "value": "io1", + "description": "VolumeType enum io1" + }, + { + "name": "Io2", + "value": "io2", + "description": "VolumeType enum io2" + }, + { + "name": "Sc1", + "value": "sc1", + "description": "VolumeType enum sc1" + }, + { + "name": "St1", + "value": "st1", + "description": "VolumeType enum st1" + }, + { + "name": "Standard", + "value": "standard", + "description": "VolumeType enum standard" + } + ] + } + }, + "VolumeTypeEnumValue": { + "type": "object", + "description": "Definition of VolumeTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/VolumeType", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Instance.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Instance.json new file mode 100644 index 000000000000..15a824ed7eb6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Instance.json @@ -0,0 +1,7119 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Instances" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AwsConnector/ec2Instances": { + "get": { + "operationId": "Ec2Instances_List", + "tags": [ + "Ec2Instances" + ], + "description": "List Ec2Instance resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2InstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Instances_List": { + "$ref": "./examples/Ec2Instances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AwsConnector/ec2Instances/default": { + "get": { + "operationId": "Ec2Instances_Get", + "tags": [ + "Ec2Instances" + ], + "description": "Get a Ec2Instance", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Instance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Instances_Get": { + "$ref": "./examples/Ec2Instances_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Instances_CreateOrReplace", + "tags": [ + "Ec2Instances" + ], + "description": "Create a Ec2Instance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Instance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Instance' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Instance" + } + }, + "201": { + "description": "Resource 'Ec2Instance' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Instance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Instances_CreateOrReplace": { + "$ref": "./examples/Ec2Instances_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Instances_Delete", + "tags": [ + "Ec2Instances" + ], + "description": "Delete a Ec2Instance", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "Ec2Instances_Delete": { + "$ref": "./examples/Ec2Instances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AwsConnector/ec2Instances/default/start": { + "post": { + "operationId": "Ec2Instances_Start", + "tags": [ + "Ec2Instances" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Instances_Start": { + "$ref": "./examples/Ec2Instances_Start.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AwsConnector/ec2Instances/default/stop": { + "post": { + "operationId": "Ec2Instances_Stop", + "tags": [ + "Ec2Instances" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/StopEc2InstanceOptions" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationStatusResult" + } + }, + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Instances_Stop": { + "$ref": "./examples/Ec2Instances_Stop.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AmdSevSnpSpecification": { + "type": "string", + "description": "AmdSevSnpSpecification enum", + "enum": [ + "disabled", + "enabled" + ], + "x-ms-enum": { + "name": "AmdSevSnpSpecification", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "AmdSevSnpSpecification enum disabled" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "AmdSevSnpSpecification enum enabled" + } + ] + } + }, + "AmdSevSnpSpecificationEnumValue": { + "type": "object", + "description": "Definition of AmdSevSnpSpecificationEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AmdSevSnpSpecification", + "description": "Property value" + } + } + }, + "ArchitectureValues": { + "type": "string", + "description": "ArchitectureValues enum", + "enum": [ + "arm64", + "arm64_mac", + "i386", + "x86_64", + "x86_64_mac" + ], + "x-ms-enum": { + "name": "ArchitectureValues", + "modelAsString": true, + "values": [ + { + "name": "Arm64", + "value": "arm64", + "description": "ArchitectureValues enum arm64" + }, + { + "name": "Arm64_mac", + "value": "arm64_mac", + "description": "ArchitectureValues enum arm64_mac" + }, + { + "name": "I386", + "value": "i386", + "description": "ArchitectureValues enum i386" + }, + { + "name": "X86_64", + "value": "x86_64", + "description": "ArchitectureValues enum x86_64" + }, + { + "name": "X86_64_mac", + "value": "x86_64_mac", + "description": "ArchitectureValues enum x86_64_mac" + } + ] + } + }, + "ArchitectureValuesEnumValue": { + "type": "object", + "description": "Definition of ArchitectureValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ArchitectureValues", + "description": "Property value" + } + } + }, + "AttachmentStatus": { + "type": "string", + "description": "AttachmentStatus enum", + "enum": [ + "attached", + "attaching", + "detached", + "detaching" + ], + "x-ms-enum": { + "name": "AttachmentStatus", + "modelAsString": true, + "values": [ + { + "name": "Attached", + "value": "attached", + "description": "AttachmentStatus enum attached" + }, + { + "name": "Attaching", + "value": "attaching", + "description": "AttachmentStatus enum attaching" + }, + { + "name": "Detached", + "value": "detached", + "description": "AttachmentStatus enum detached" + }, + { + "name": "Detaching", + "value": "detaching", + "description": "AttachmentStatus enum detaching" + } + ] + } + }, + "AttachmentStatusEnumValue": { + "type": "object", + "description": "Definition of AttachmentStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AttachmentStatus", + "description": "Property value" + } + } + }, + "AwsEc2InstanceProperties": { + "type": "object", + "description": "Definition of awsEc2Instance", + "properties": { + "amiLaunchIndex": { + "type": "integer", + "format": "int32", + "description": "<p>The AMI launch index, which can be used to find this instance in the launch group.</p>" + }, + "architecture": { + "$ref": "#/definitions/ArchitectureValuesEnumValue", + "description": "<p>The architecture of the image.</p>" + }, + "blockDeviceMappings": { + "type": "array", + "description": "<p>Any block device mapping entries for the instance.</p>", + "items": { + "$ref": "#/definitions/InstanceBlockDeviceMapping" + }, + "x-ms-identifiers": [] + }, + "bootMode": { + "$ref": "#/definitions/BootModeValuesEnumValue", + "description": "<p>The boot mode that was specified by the AMI. If the value is <code>uefi-preferred</code>, the AMI supports both UEFI and Legacy BIOS. The <code>currentInstanceBootMode</code> parameter is the boot mode that is used to boot the instance at launch or start.</p> <note> <p>The operating system contained in the AMI must be configured to support the specified boot mode.</p> </note> <p>For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "capacityReservationId": { + "type": "string", + "description": "<p>The ID of the Capacity Reservation.</p>" + }, + "capacityReservationSpecification": { + "$ref": "#/definitions/CapacityReservationSpecificationResponse", + "description": "<p>Information about the Capacity Reservation targeting option.</p>" + }, + "clientToken": { + "type": "string", + "description": "<p>The idempotency token you provided when you launched the instance, if applicable.</p>" + }, + "cpuOptions": { + "$ref": "#/definitions/CpuOptions", + "description": "<p>The CPU options for the instance.</p>" + }, + "currentInstanceBootMode": { + "$ref": "#/definitions/InstanceBootModeValuesEnumValue", + "description": "<p>The boot mode that is used to boot the instance at launch or start. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'>Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "ebsOptimized": { + "type": "boolean", + "description": "<p>Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.</p>" + }, + "elasticGpuAssociations": { + "type": "array", + "description": "<p>Deprecated.</p> <note> <p>Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.</p> </note>", + "items": { + "$ref": "#/definitions/ElasticGpuAssociation" + }, + "x-ms-identifiers": [] + }, + "elasticInferenceAcceleratorAssociations": { + "type": "array", + "description": "<p>The elastic inference accelerator associated with the instance.</p>", + "items": { + "$ref": "#/definitions/ElasticInferenceAcceleratorAssociation" + }, + "x-ms-identifiers": [] + }, + "enaSupport": { + "type": "boolean", + "description": "<p>Specifies whether enhanced networking with ENA is enabled.</p>" + }, + "enclaveOptions": { + "$ref": "#/definitions/EnclaveOptions", + "description": "<p>Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.</p>" + }, + "hibernationOptions": { + "$ref": "#/definitions/HibernationOptions", + "description": "<p>Indicates whether the instance is enabled for hibernation.</p>" + }, + "hypervisor": { + "$ref": "#/definitions/HypervisorTypeEnumValue", + "description": "<p>The hypervisor type of the instance. The value <code>xen</code> is used for both Xen and Nitro hypervisors.</p>" + }, + "iamInstanceProfile": { + "$ref": "#/definitions/IamInstanceProfile", + "description": "<p>The IAM instance profile associated with the instance, if applicable.</p>" + }, + "imageId": { + "type": "string", + "description": "<p>The ID of the AMI used to launch the instance.</p>" + }, + "instanceId": { + "type": "string", + "description": "<p>The ID of the instance.</p>" + }, + "instanceLifecycle": { + "$ref": "#/definitions/InstanceLifecycleTypeEnumValue", + "description": "<p>Indicates whether this is a Spot Instance or a Scheduled Instance.</p>" + }, + "instanceType": { + "$ref": "#/definitions/InstanceTypeEnumValue", + "description": "<p>The instance type.</p>" + }, + "ipv6Address": { + "type": "string", + "description": "<p>The IPv6 address assigned to the instance.</p>" + }, + "kernelId": { + "type": "string", + "description": "<p>The kernel associated with this instance, if applicable.</p>" + }, + "keyName": { + "type": "string", + "description": "<p>The name of the key pair, if this instance was launched with an associated key pair.</p>" + }, + "launchTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time the instance was launched.</p>" + }, + "licenses": { + "type": "array", + "description": "<p>The license configurations for the instance.</p>", + "items": { + "$ref": "#/definitions/LicenseConfiguration" + }, + "x-ms-identifiers": [] + }, + "maintenanceOptions": { + "$ref": "#/definitions/InstanceMaintenanceOptions", + "description": "<p>Provides information on the recovery and maintenance options of your instance.</p>" + }, + "metadataOptions": { + "$ref": "#/definitions/InstanceMetadataOptionsResponse", + "description": "<p>The metadata options for the instance.</p>" + }, + "monitoring": { + "$ref": "#/definitions/Monitoring", + "description": "<p>The monitoring for the instance.</p>" + }, + "networkInterfaces": { + "type": "array", + "description": "<p>The network interfaces for the instance.</p>", + "items": { + "$ref": "#/definitions/InstanceNetworkInterface" + }, + "x-ms-identifiers": [] + }, + "outpostArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Outpost.</p>" + }, + "placement": { + "$ref": "#/definitions/Placement", + "description": "<p>The location where the instance launched, if applicable.</p>" + }, + "platform": { + "$ref": "#/definitions/PlatformValuesEnumValue", + "description": "<p>The platform. This value is <code>windows</code> for Windows instances; otherwise, it is empty.</p>" + }, + "platformDetails": { + "type": "string", + "description": "<p>The platform details value for the instance. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'>AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "privateDnsName": { + "type": "string", + "description": "<p>[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the <code>running</code> state. </p> <p>The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.</p>" + }, + "privateDnsNameOptions": { + "$ref": "#/definitions/PrivateDnsNameOptionsResponse", + "description": "<p>The options for the instance hostname.</p>" + }, + "privateIpAddress": { + "type": "string", + "description": "<p>The private IPv4 address assigned to the instance.</p>" + }, + "productCodes": { + "type": "array", + "description": "<p>The product codes attached to this instance, if applicable.</p>", + "items": { + "$ref": "#/definitions/ProductCode" + }, + "x-ms-identifiers": [] + }, + "publicDnsName": { + "type": "string", + "description": "<p>[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. This name is only available if you've enabled DNS hostnames for your VPC.</p>" + }, + "publicIpAddress": { + "type": "string", + "description": "<p>The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.</p> <p>A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.</p>" + }, + "ramdiskId": { + "type": "string", + "description": "<p>The RAM disk associated with this instance, if applicable.</p>" + }, + "rootDeviceName": { + "type": "string", + "description": "<p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>" + }, + "rootDeviceType": { + "$ref": "#/definitions/DeviceTypeEnumValue", + "description": "<p>The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.</p>" + }, + "securityGroups": { + "type": "array", + "description": "<p>The security groups for the instance.</p>", + "items": { + "$ref": "#/definitions/GroupIdentifier" + }, + "x-ms-identifiers": [] + }, + "sourceDestCheck": { + "type": "boolean", + "description": "<p>Indicates whether source/destination checking is enabled.</p>" + }, + "spotInstanceRequestId": { + "type": "string", + "description": "<p>If the request is a Spot Instance request, the ID of the request.</p>" + }, + "sriovNetSupport": { + "type": "string", + "description": "<p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>" + }, + "state": { + "$ref": "#/definitions/InstanceState", + "description": "<p>The current state of the instance.</p>" + }, + "stateReason": { + "$ref": "#/definitions/StateReason", + "description": "<p>The reason for the most recent state transition.</p>" + }, + "stateTransitionReason": { + "type": "string", + "description": "<p>The reason for the most recent state transition. This might be an empty string.</p>" + }, + "subnetId": { + "type": "string", + "description": "<p>The ID of the subnet in which the instance is running.</p>" + }, + "tags": { + "type": "array", + "description": "<p>Any tags assigned to the instance.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tpmSupport": { + "type": "string", + "description": "<p>If the instance is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'>NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "usageOperation": { + "type": "string", + "description": "<p>The usage operation value for the instance. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'>AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>" + }, + "usageOperationUpdateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time that the usage operation was last updated.</p>" + }, + "virtualizationType": { + "$ref": "#/definitions/VirtualizationTypeEnumValue", + "description": "<p>The virtualization type of the instance.</p>" + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the VPC in which the instance is running.</p>" + } + } + }, + "BootModeValues": { + "type": "string", + "description": "BootModeValues enum", + "enum": [ + "legacy-bios", + "uefi", + "uefi-preferred" + ], + "x-ms-enum": { + "name": "BootModeValues", + "modelAsString": true, + "values": [ + { + "name": "LegacyBios", + "value": "legacy-bios", + "description": "BootModeValues enum legacy-bios" + }, + { + "name": "Uefi", + "value": "uefi", + "description": "BootModeValues enum uefi" + }, + { + "name": "UefiPreferred", + "value": "uefi-preferred", + "description": "BootModeValues enum uefi-preferred" + } + ] + } + }, + "BootModeValuesEnumValue": { + "type": "object", + "description": "Definition of BootModeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/BootModeValues", + "description": "Property value" + } + } + }, + "CapacityReservationPreference": { + "type": "string", + "description": "CapacityReservationPreference enum", + "enum": [ + "none", + "open" + ], + "x-ms-enum": { + "name": "CapacityReservationPreference", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "none", + "description": "CapacityReservationPreference enum none" + }, + { + "name": "Open", + "value": "open", + "description": "CapacityReservationPreference enum open" + } + ] + } + }, + "CapacityReservationPreferenceEnumValue": { + "type": "object", + "description": "Definition of CapacityReservationPreferenceEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/CapacityReservationPreference", + "description": "Property value" + } + } + }, + "CapacityReservationSpecificationResponse": { + "type": "object", + "description": "Definition of CapacityReservationSpecificationResponse", + "properties": { + "capacityReservationPreference": { + "$ref": "#/definitions/CapacityReservationPreferenceEnumValue", + "description": "<p>Describes the instance's Capacity Reservation preferences. Possible preferences include:</p> <ul> <li> <p> <code>open</code> - The instance can run in any <code>open</code> Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).</p> </li> <li> <p> <code>none</code> - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.</p> </li> </ul>" + }, + "capacityReservationTarget": { + "$ref": "#/definitions/CapacityReservationTargetResponse", + "description": "<p>Information about the targeted Capacity Reservation or Capacity Reservation group.</p>" + } + } + }, + "CapacityReservationTargetResponse": { + "type": "object", + "description": "Definition of CapacityReservationTargetResponse", + "properties": { + "capacityReservationId": { + "type": "string", + "description": "<p>The ID of the targeted Capacity Reservation.</p>" + }, + "capacityReservationResourceGroupArn": { + "type": "string", + "description": "<p>The ARN of the targeted Capacity Reservation group.</p>" + } + } + }, + "ConnectionTrackingSpecificationResponse": { + "type": "object", + "description": "Definition of ConnectionTrackingSpecificationResponse", + "properties": { + "tcpEstablishedTimeout": { + "type": "integer", + "format": "int32", + "description": "<p>Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.</p>", + "default": 432000 + }, + "udpStreamTimeout": { + "type": "integer", + "format": "int32", + "description": "<p>Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.</p>", + "default": 180 + }, + "udpTimeout": { + "type": "integer", + "format": "int32", + "description": "<p>Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.</p>", + "default": 30 + } + } + }, + "CpuOptions": { + "type": "object", + "description": "Definition of CpuOptions", + "properties": { + "amdSevSnp": { + "$ref": "#/definitions/AmdSevSnpSpecificationEnumValue", + "description": "<p>Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html'>AMD SEV-SNP</a>.</p>" + }, + "coreCount": { + "type": "integer", + "format": "int32", + "description": "<p>The number of CPU cores for the instance.</p>" + }, + "threadsPerCore": { + "type": "integer", + "format": "int32", + "description": "<p>The number of threads per CPU core.</p>" + } + } + }, + "DeviceType": { + "type": "string", + "description": "DeviceType enum", + "enum": [ + "ebs", + "instance-store" + ], + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true, + "values": [ + { + "name": "Ebs", + "value": "ebs", + "description": "DeviceType enum ebs" + }, + { + "name": "InstanceStore", + "value": "instance-store", + "description": "DeviceType enum instance-store" + } + ] + } + }, + "DeviceTypeEnumValue": { + "type": "object", + "description": "Definition of DeviceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DeviceType", + "description": "Property value" + } + } + }, + "EbsInstanceBlockDevice": { + "type": "object", + "description": "Definition of EbsInstanceBlockDevice", + "properties": { + "associatedResource": { + "type": "string", + "description": "<p>The ARN of the Amazon ECS or Fargate task to which the volume is attached.</p>" + }, + "attachTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time stamp when the attachment initiated.</p>" + }, + "deleteOnTermination": { + "type": "boolean", + "description": "<p>Indicates whether the volume is deleted on instance termination.</p>" + }, + "status": { + "$ref": "#/definitions/AttachmentStatusEnumValue", + "description": "<p>The attachment state.</p>" + }, + "volumeId": { + "type": "string", + "description": "<p>The ID of the EBS volume.</p>" + }, + "volumeOwnerId": { + "type": "string", + "description": "<p>The ID of the Amazon Web Services account that owns the volume.</p> <p>This parameter is returned only for volumes that are attached to Fargate tasks.</p>" + } + } + }, + "Ec2Instance": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2InstanceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "Ec2InstanceListResult": { + "type": "object", + "description": "The response of a Ec2Instance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Instance items on this page", + "items": { + "$ref": "#/definitions/Ec2Instance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2InstanceProperties": { + "type": "object", + "description": "Definition of Ec2Instance", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2InstanceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticGpuAssociation": { + "type": "object", + "description": "Definition of ElasticGpuAssociation", + "properties": { + "elasticGpuAssociationId": { + "type": "string", + "description": "<p>The ID of the association.</p>" + }, + "elasticGpuAssociationState": { + "type": "string", + "description": "<p>The state of the association between the instance and the Elastic Graphics accelerator.</p>" + }, + "elasticGpuAssociationTime": { + "type": "string", + "description": "<p>The time the Elastic Graphics accelerator was associated with the instance.</p>" + }, + "elasticGpuId": { + "type": "string", + "description": "<p>The ID of the Elastic Graphics accelerator.</p>" + } + } + }, + "ElasticInferenceAcceleratorAssociation": { + "type": "object", + "description": "Definition of ElasticInferenceAcceleratorAssociation", + "properties": { + "elasticInferenceAcceleratorArn": { + "type": "string", + "description": "<p> The Amazon Resource Name (ARN) of the elastic inference accelerator. </p>" + }, + "elasticInferenceAcceleratorAssociationId": { + "type": "string", + "description": "<p> The ID of the association. </p>" + }, + "elasticInferenceAcceleratorAssociationState": { + "type": "string", + "description": "<p> The state of the elastic inference accelerator. </p>" + }, + "elasticInferenceAcceleratorAssociationTime": { + "type": "string", + "format": "date-time", + "description": "<p> The time at which the elastic inference accelerator is associated with an instance. </p>" + } + } + }, + "EnclaveOptions": { + "type": "object", + "description": "Definition of EnclaveOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>If this parameter is set to <code>true</code>, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.</p>" + } + } + }, + "GroupIdentifier": { + "type": "object", + "description": "Definition of GroupIdentifier", + "properties": { + "groupId": { + "type": "string", + "description": "<p>The ID of the security group.</p>" + }, + "groupName": { + "type": "string", + "description": "<p>The name of the security group.</p>" + } + } + }, + "HibernationOptions": { + "type": "object", + "description": "Definition of HibernationOptions", + "properties": { + "configured": { + "type": "boolean", + "description": "<p>If <code>true</code>, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.</p>" + } + } + }, + "HostnameType": { + "type": "string", + "description": "HostnameType enum", + "enum": [ + "ip-name", + "resource-name" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": true, + "values": [ + { + "name": "IpName", + "value": "ip-name", + "description": "HostnameType enum ip-name" + }, + { + "name": "ResourceName", + "value": "resource-name", + "description": "HostnameType enum resource-name" + } + ] + } + }, + "HostnameTypeEnumValue": { + "type": "object", + "description": "Definition of HostnameTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/HostnameType", + "description": "Property value" + } + } + }, + "HttpTokensState": { + "type": "string", + "description": "HttpTokensState enum", + "enum": [ + "optional", + "required" + ], + "x-ms-enum": { + "name": "HttpTokensState", + "modelAsString": true, + "values": [ + { + "name": "Optional", + "value": "optional", + "description": "HttpTokensState enum optional" + }, + { + "name": "Required", + "value": "required", + "description": "HttpTokensState enum required" + } + ] + } + }, + "HttpTokensStateEnumValue": { + "type": "object", + "description": "Definition of HttpTokensStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/HttpTokensState", + "description": "Property value" + } + } + }, + "HypervisorType": { + "type": "string", + "description": "HypervisorType enum", + "enum": [ + "ovm", + "xen" + ], + "x-ms-enum": { + "name": "HypervisorType", + "modelAsString": true, + "values": [ + { + "name": "Ovm", + "value": "ovm", + "description": "HypervisorType enum ovm" + }, + { + "name": "Xen", + "value": "xen", + "description": "HypervisorType enum xen" + } + ] + } + }, + "HypervisorTypeEnumValue": { + "type": "object", + "description": "Definition of HypervisorTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/HypervisorType", + "description": "Property value" + } + } + }, + "IamInstanceProfile": { + "type": "object", + "description": "Definition of IamInstanceProfile", + "properties": { + "arn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>" + }, + "id": { + "type": "string", + "description": "<p>The ID of the instance profile.</p>" + } + } + }, + "InstanceAttachmentEnaSrdSpecification": { + "type": "object", + "description": "Definition of InstanceAttachmentEnaSrdSpecification", + "properties": { + "enaSrdEnabled": { + "type": "boolean", + "description": "<p>Indicates whether ENA Express is enabled for the network interface.</p>" + }, + "enaSrdUdpSpecification": { + "$ref": "#/definitions/InstanceAttachmentEnaSrdUdpSpecification", + "description": "<p>Configures ENA Express for UDP network traffic.</p>" + } + } + }, + "InstanceAttachmentEnaSrdUdpSpecification": { + "type": "object", + "description": "Definition of InstanceAttachmentEnaSrdUdpSpecification", + "properties": { + "enaSrdUdpEnabled": { + "type": "boolean", + "description": "<p>Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.</p>" + } + } + }, + "InstanceAutoRecoveryState": { + "type": "string", + "description": "InstanceAutoRecoveryState enum", + "enum": [ + "default", + "disabled" + ], + "x-ms-enum": { + "name": "InstanceAutoRecoveryState", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "default", + "description": "InstanceAutoRecoveryState enum default" + }, + { + "name": "Disabled", + "value": "disabled", + "description": "InstanceAutoRecoveryState enum disabled" + } + ] + } + }, + "InstanceAutoRecoveryStateEnumValue": { + "type": "object", + "description": "Definition of InstanceAutoRecoveryStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceAutoRecoveryState", + "description": "Property value" + } + } + }, + "InstanceBlockDeviceMapping": { + "type": "object", + "description": "Definition of InstanceBlockDeviceMapping", + "properties": { + "deviceName": { + "type": "string", + "description": "<p>The device name (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>" + }, + "ebs": { + "$ref": "#/definitions/EbsInstanceBlockDevice", + "description": "<p>Parameters used to automatically set up EBS volumes when the instance is launched.</p>" + } + } + }, + "InstanceBootModeValues": { + "type": "string", + "description": "InstanceBootModeValues enum", + "enum": [ + "legacy-bios", + "uefi" + ], + "x-ms-enum": { + "name": "InstanceBootModeValues", + "modelAsString": true, + "values": [ + { + "name": "LegacyBios", + "value": "legacy-bios", + "description": "InstanceBootModeValues enum legacy-bios" + }, + { + "name": "Uefi", + "value": "uefi", + "description": "InstanceBootModeValues enum uefi" + } + ] + } + }, + "InstanceBootModeValuesEnumValue": { + "type": "object", + "description": "Definition of InstanceBootModeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceBootModeValues", + "description": "Property value" + } + } + }, + "InstanceIpv4Prefix": { + "type": "object", + "description": "Definition of InstanceIpv4Prefix", + "properties": { + "ipv4Prefix": { + "type": "string", + "description": "<p>One or more IPv4 prefixes assigned to the network interface.</p>" + } + } + }, + "InstanceIpv6Address": { + "type": "object", + "description": "Definition of InstanceIpv6Address", + "properties": { + "ipv6Address": { + "type": "string", + "description": "<p>The IPv6 address.</p>" + }, + "isPrimaryIpv6": { + "type": "boolean", + "description": "<p>Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'>RunInstances</a>.</p>" + } + } + }, + "InstanceIpv6Prefix": { + "type": "object", + "description": "Definition of InstanceIpv6Prefix", + "properties": { + "ipv6Prefix": { + "type": "string", + "description": "<p>One or more IPv6 prefixes assigned to the network interface.</p>" + } + } + }, + "InstanceLifecycleType": { + "type": "string", + "description": "InstanceLifecycleType enum", + "enum": [ + "capacity-block", + "scheduled", + "spot" + ], + "x-ms-enum": { + "name": "InstanceLifecycleType", + "modelAsString": true, + "values": [ + { + "name": "CapacityBlock", + "value": "capacity-block", + "description": "InstanceLifecycleType enum capacity-block" + }, + { + "name": "Scheduled", + "value": "scheduled", + "description": "InstanceLifecycleType enum scheduled" + }, + { + "name": "Spot", + "value": "spot", + "description": "InstanceLifecycleType enum spot" + } + ] + } + }, + "InstanceLifecycleTypeEnumValue": { + "type": "object", + "description": "Definition of InstanceLifecycleTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceLifecycleType", + "description": "Property value" + } + } + }, + "InstanceMaintenanceOptions": { + "type": "object", + "description": "Definition of InstanceMaintenanceOptions", + "properties": { + "autoRecovery": { + "$ref": "#/definitions/InstanceAutoRecoveryStateEnumValue", + "description": "<p>Provides information on the current automatic recovery behavior of your instance.</p>" + } + } + }, + "InstanceMetadataEndpointState": { + "type": "string", + "description": "InstanceMetadataEndpointState enum", + "enum": [ + "disabled", + "enabled" + ], + "x-ms-enum": { + "name": "InstanceMetadataEndpointState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "InstanceMetadataEndpointState enum disabled" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "InstanceMetadataEndpointState enum enabled" + } + ] + } + }, + "InstanceMetadataEndpointStateEnumValue": { + "type": "object", + "description": "Definition of InstanceMetadataEndpointStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceMetadataEndpointState", + "description": "Property value" + } + } + }, + "InstanceMetadataOptionsResponse": { + "type": "object", + "description": "Definition of InstanceMetadataOptionsResponse", + "properties": { + "httpEndpoint": { + "$ref": "#/definitions/InstanceMetadataEndpointStateEnumValue", + "description": "<p>Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.</p> <p>If the value is <code>disabled</code>, you cannot access your instance metadata.</p>" + }, + "httpProtocolIpv6": { + "$ref": "#/definitions/InstanceMetadataProtocolStateEnumValue", + "description": "<p>Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.</p> <p>Default: <code>disabled</code> </p>" + }, + "httpPutResponseHopLimit": { + "type": "integer", + "format": "int32", + "description": "<p>The maximum number of hops that the metadata token can travel.</p> <p>Possible values: Integers from <code>1</code> to <code>64</code> </p>" + }, + "httpTokens": { + "$ref": "#/definitions/HttpTokensStateEnumValue", + "description": "<p>Indicates whether IMDSv2 is required.</p> <ul> <li> <p> <code>optional</code> - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.</p> </li> <li> <p> <code>required</code> - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.</p> </li> </ul>" + }, + "instanceMetadataTags": { + "$ref": "#/definitions/InstanceMetadataTagsStateEnumValue", + "description": "<p>Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS'>Work with instance tags using the instance metadata</a>.</p>" + }, + "state": { + "$ref": "#/definitions/InstanceMetadataOptionsStateEnumValue", + "description": "<p>The state of the metadata option changes.</p> <p> <code>pending</code> - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.</p> <p> <code>applied</code> - The metadata options have been successfully applied on the instance.</p>" + } + } + }, + "InstanceMetadataOptionsState": { + "type": "string", + "description": "InstanceMetadataOptionsState enum", + "enum": [ + "applied", + "pending" + ], + "x-ms-enum": { + "name": "InstanceMetadataOptionsState", + "modelAsString": true, + "values": [ + { + "name": "Applied", + "value": "applied", + "description": "InstanceMetadataOptionsState enum applied" + }, + { + "name": "Pending", + "value": "pending", + "description": "InstanceMetadataOptionsState enum pending" + } + ] + } + }, + "InstanceMetadataOptionsStateEnumValue": { + "type": "object", + "description": "Definition of InstanceMetadataOptionsStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceMetadataOptionsState", + "description": "Property value" + } + } + }, + "InstanceMetadataProtocolState": { + "type": "string", + "description": "InstanceMetadataProtocolState enum", + "enum": [ + "disabled", + "enabled" + ], + "x-ms-enum": { + "name": "InstanceMetadataProtocolState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "InstanceMetadataProtocolState enum disabled" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "InstanceMetadataProtocolState enum enabled" + } + ] + } + }, + "InstanceMetadataProtocolStateEnumValue": { + "type": "object", + "description": "Definition of InstanceMetadataProtocolStateEnumValue", + "properties": { + "value": { + "type": "string", + "description": "Property value", + "default": "disabled", + "enum": [ + "disabled", + "enabled" + ], + "x-ms-enum": { + "name": "InstanceMetadataProtocolState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "InstanceMetadataProtocolState enum disabled" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "InstanceMetadataProtocolState enum enabled" + } + ] + } + } + } + }, + "InstanceMetadataTagsState": { + "type": "string", + "description": "InstanceMetadataTagsState enum", + "enum": [ + "disabled", + "enabled" + ], + "x-ms-enum": { + "name": "InstanceMetadataTagsState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "InstanceMetadataTagsState enum disabled" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "InstanceMetadataTagsState enum enabled" + } + ] + } + }, + "InstanceMetadataTagsStateEnumValue": { + "type": "object", + "description": "Definition of InstanceMetadataTagsStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceMetadataTagsState", + "description": "Property value" + } + } + }, + "InstanceNetworkInterface": { + "type": "object", + "description": "Definition of InstanceNetworkInterface", + "properties": { + "association": { + "$ref": "#/definitions/InstanceNetworkInterfaceAssociation", + "description": "<p>The association information for an Elastic IPv4 associated with the network interface.</p>" + }, + "attachment": { + "$ref": "#/definitions/InstanceNetworkInterfaceAttachment", + "description": "<p>The network interface attachment.</p>" + }, + "connectionTrackingConfiguration": { + "$ref": "#/definitions/ConnectionTrackingSpecificationResponse", + "description": "<p>A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts'>Connection tracking timeouts</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>" + }, + "description": { + "type": "string", + "description": "<p>The description.</p>" + }, + "groups": { + "type": "array", + "description": "<p>The security groups.</p>", + "items": { + "$ref": "#/definitions/GroupIdentifier" + }, + "x-ms-identifiers": [] + }, + "interfaceType": { + "type": "string", + "description": "<p>The type of network interface.</p> <p>Valid values: <code>interface</code> | <code>efa</code> | <code>trunk</code> </p>" + }, + "ipv4Prefixes": { + "type": "array", + "description": "<p>The IPv4 delegated prefixes that are assigned to the network interface.</p>", + "items": { + "$ref": "#/definitions/InstanceIpv4Prefix" + }, + "x-ms-identifiers": [] + }, + "ipv6Addresses": { + "type": "array", + "description": "<p>The IPv6 addresses associated with the network interface.</p>", + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "x-ms-identifiers": [] + }, + "ipv6Prefixes": { + "type": "array", + "description": "<p>The IPv6 delegated prefixes that are assigned to the network interface.</p>", + "items": { + "$ref": "#/definitions/InstanceIpv6Prefix" + }, + "x-ms-identifiers": [] + }, + "macAddress": { + "type": "string", + "description": "<p>The MAC address.</p>" + }, + "networkInterfaceId": { + "type": "string", + "description": "<p>The ID of the network interface.</p>" + }, + "ownerId": { + "type": "string", + "description": "<p>The ID of the Amazon Web Services account that created the network interface.</p>" + }, + "privateDnsName": { + "type": "string", + "description": "<p>The private DNS name.</p>" + }, + "privateIpAddress": { + "type": "string", + "description": "<p>The IPv4 address of the network interface within the subnet.</p>" + }, + "privateIpAddresses": { + "type": "array", + "description": "<p>The private IPv4 addresses associated with the network interface.</p>", + "items": { + "$ref": "#/definitions/InstancePrivateIpAddress" + }, + "x-ms-identifiers": [] + }, + "sourceDestCheck": { + "type": "boolean", + "description": "<p>Indicates whether source/destination checking is enabled.</p>" + }, + "status": { + "$ref": "#/definitions/NetworkInterfaceStatusEnumValue", + "description": "<p>The status of the network interface.</p>" + }, + "subnetId": { + "type": "string", + "description": "<p>The ID of the subnet.</p>" + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the VPC.</p>" + } + } + }, + "InstanceNetworkInterfaceAssociation": { + "type": "object", + "description": "Definition of InstanceNetworkInterfaceAssociation", + "properties": { + "carrierIp": { + "type": "string", + "description": "<p>The carrier IP address associated with the network interface.</p>" + }, + "customerOwnedIp": { + "type": "string", + "description": "<p>The customer-owned IP address associated with the network interface.</p>" + }, + "ipOwnerId": { + "type": "string", + "description": "<p>The ID of the owner of the Elastic IP address.</p>" + }, + "publicDnsName": { + "type": "string", + "description": "<p>The public DNS name.</p>" + }, + "publicIp": { + "type": "string", + "description": "<p>The public IP address or Elastic IP address bound to the network interface.</p>" + } + } + }, + "InstanceNetworkInterfaceAttachment": { + "type": "object", + "description": "Definition of InstanceNetworkInterfaceAttachment", + "properties": { + "attachTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time stamp when the attachment initiated.</p>" + }, + "attachmentId": { + "type": "string", + "description": "<p>The ID of the network interface attachment.</p>" + }, + "deleteOnTermination": { + "type": "boolean", + "description": "<p>Indicates whether the network interface is deleted when the instance is terminated.</p>" + }, + "deviceIndex": { + "type": "integer", + "format": "int32", + "description": "<p>The index of the device on the instance for the network interface attachment.</p>" + }, + "enaSrdSpecification": { + "$ref": "#/definitions/InstanceAttachmentEnaSrdSpecification", + "description": "<p>Contains the ENA Express settings for the network interface that's attached to the instance.</p>" + }, + "networkCardIndex": { + "type": "integer", + "format": "int32", + "description": "<p>The index of the network card.</p>" + }, + "status": { + "$ref": "#/definitions/AttachmentStatusEnumValue", + "description": "<p>The attachment state.</p>" + } + } + }, + "InstancePrivateIpAddress": { + "type": "object", + "description": "Definition of InstancePrivateIpAddress", + "properties": { + "association": { + "$ref": "#/definitions/InstanceNetworkInterfaceAssociation", + "description": "<p>The association information for an Elastic IP address for the network interface.</p>" + }, + "primary": { + "type": "boolean", + "description": "<p>Indicates whether this IPv4 address is the primary private IP address of the network interface.</p>" + }, + "privateDnsName": { + "type": "string", + "description": "<p>The private IPv4 DNS name.</p>" + }, + "privateIpAddress": { + "type": "string", + "description": "<p>The private IPv4 address of the network interface.</p>" + } + } + }, + "InstanceState": { + "type": "object", + "description": "Definition of InstanceState", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "<p>The state of the instance as a 16-bit unsigned integer. </p> <p>The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.</p> <p>The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. </p> <p>The valid values for instance-state-code will all be in the range of the low byte and they are:</p> <ul> <li> <p> <code>0</code> : <code>pending</code> </p> </li> <li> <p> <code>16</code> : <code>running</code> </p> </li> <li> <p> <code>32</code> : <code>shutting-down</code> </p> </li> <li> <p> <code>48</code> : <code>terminated</code> </p> </li> <li> <p> <code>64</code> : <code>stopping</code> </p> </li> <li> <p> <code>80</code> : <code>stopped</code> </p> </li> </ul> <p>You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.</p>" + }, + "name": { + "$ref": "#/definitions/InstanceStateNameEnumValue", + "description": "<p>The current state of the instance.</p>" + } + } + }, + "InstanceStateName": { + "type": "string", + "description": "InstanceStateName enum", + "enum": [ + "pending", + "running", + "shutting-down", + "stopped", + "stopping", + "terminated" + ], + "x-ms-enum": { + "name": "InstanceStateName", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "InstanceStateName enum pending" + }, + { + "name": "Running", + "value": "running", + "description": "InstanceStateName enum running" + }, + { + "name": "ShuttingDown", + "value": "shutting-down", + "description": "InstanceStateName enum shutting-down" + }, + { + "name": "Stopped", + "value": "stopped", + "description": "InstanceStateName enum stopped" + }, + { + "name": "Stopping", + "value": "stopping", + "description": "InstanceStateName enum stopping" + }, + { + "name": "Terminated", + "value": "terminated", + "description": "InstanceStateName enum terminated" + } + ] + } + }, + "InstanceStateNameEnumValue": { + "type": "object", + "description": "Definition of InstanceStateNameEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceStateName", + "description": "Property value" + } + } + }, + "InstanceType": { + "type": "string", + "description": "InstanceType enum", + "enum": [ + "a1.2xlarge", + "a1.4xlarge", + "a1.large", + "a1.medium", + "a1.metal", + "a1.xlarge", + "c1.medium", + "c1.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c3.large", + "c3.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "c4.large", + "c4.xlarge", + "c5.12xlarge", + "c5.18xlarge", + "c5.24xlarge", + "c5.2xlarge", + "c5.4xlarge", + "c5.9xlarge", + "c5.large", + "c5.metal", + "c5.xlarge", + "c5a.12xlarge", + "c5a.16xlarge", + "c5a.24xlarge", + "c5a.2xlarge", + "c5a.4xlarge", + "c5a.8xlarge", + "c5a.large", + "c5a.xlarge", + "c5ad.12xlarge", + "c5ad.16xlarge", + "c5ad.24xlarge", + "c5ad.2xlarge", + "c5ad.4xlarge", + "c5ad.8xlarge", + "c5ad.large", + "c5ad.xlarge", + "c5d.12xlarge", + "c5d.18xlarge", + "c5d.24xlarge", + "c5d.2xlarge", + "c5d.4xlarge", + "c5d.9xlarge", + "c5d.large", + "c5d.metal", + "c5d.xlarge", + "c5n.18xlarge", + "c5n.2xlarge", + "c5n.4xlarge", + "c5n.9xlarge", + "c5n.large", + "c5n.metal", + "c5n.xlarge", + "c6a.12xlarge", + "c6a.16xlarge", + "c6a.24xlarge", + "c6a.2xlarge", + "c6a.32xlarge", + "c6a.48xlarge", + "c6a.4xlarge", + "c6a.8xlarge", + "c6a.large", + "c6a.metal", + "c6a.xlarge", + "c6g.12xlarge", + "c6g.16xlarge", + "c6g.2xlarge", + "c6g.4xlarge", + "c6g.8xlarge", + "c6g.large", + "c6g.medium", + "c6g.metal", + "c6g.xlarge", + "c6gd.12xlarge", + "c6gd.16xlarge", + "c6gd.2xlarge", + "c6gd.4xlarge", + "c6gd.8xlarge", + "c6gd.large", + "c6gd.medium", + "c6gd.metal", + "c6gd.xlarge", + "c6gn.12xlarge", + "c6gn.16xlarge", + "c6gn.2xlarge", + "c6gn.4xlarge", + "c6gn.8xlarge", + "c6gn.large", + "c6gn.medium", + "c6gn.xlarge", + "c6i.12xlarge", + "c6i.16xlarge", + "c6i.24xlarge", + "c6i.2xlarge", + "c6i.32xlarge", + "c6i.4xlarge", + "c6i.8xlarge", + "c6i.large", + "c6i.metal", + "c6i.xlarge", + "c6id.12xlarge", + "c6id.16xlarge", + "c6id.24xlarge", + "c6id.2xlarge", + "c6id.32xlarge", + "c6id.4xlarge", + "c6id.8xlarge", + "c6id.large", + "c6id.metal", + "c6id.xlarge", + "c6in.12xlarge", + "c6in.16xlarge", + "c6in.24xlarge", + "c6in.2xlarge", + "c6in.32xlarge", + "c6in.4xlarge", + "c6in.8xlarge", + "c6in.large", + "c6in.metal", + "c6in.xlarge", + "c7a.12xlarge", + "c7a.16xlarge", + "c7a.24xlarge", + "c7a.2xlarge", + "c7a.32xlarge", + "c7a.48xlarge", + "c7a.4xlarge", + "c7a.8xlarge", + "c7a.large", + "c7a.medium", + "c7a.metal-48xl", + "c7a.xlarge", + "c7g.12xlarge", + "c7g.16xlarge", + "c7g.2xlarge", + "c7g.4xlarge", + "c7g.8xlarge", + "c7g.large", + "c7g.medium", + "c7g.metal", + "c7g.xlarge", + "c7gd.12xlarge", + "c7gd.16xlarge", + "c7gd.2xlarge", + "c7gd.4xlarge", + "c7gd.8xlarge", + "c7gd.large", + "c7gd.medium", + "c7gd.metal", + "c7gd.xlarge", + "c7gn.12xlarge", + "c7gn.16xlarge", + "c7gn.2xlarge", + "c7gn.4xlarge", + "c7gn.8xlarge", + "c7gn.large", + "c7gn.medium", + "c7gn.xlarge", + "c7i.12xlarge", + "c7i.16xlarge", + "c7i.24xlarge", + "c7i.2xlarge", + "c7i.48xlarge", + "c7i.4xlarge", + "c7i.8xlarge", + "c7i.large", + "c7i.metal-24xl", + "c7i.metal-48xl", + "c7i.xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "cg1.4xlarge", + "cr1.8xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge", + "d2.xlarge", + "d3.2xlarge", + "d3.4xlarge", + "d3.8xlarge", + "d3.xlarge", + "d3en.12xlarge", + "d3en.2xlarge", + "d3en.4xlarge", + "d3en.6xlarge", + "d3en.8xlarge", + "d3en.xlarge", + "dl1.24xlarge", + "dl2q.24xlarge", + "f1.16xlarge", + "f1.2xlarge", + "f1.4xlarge", + "g2.2xlarge", + "g2.8xlarge", + "g3.16xlarge", + "g3.4xlarge", + "g3.8xlarge", + "g3s.xlarge", + "g4ad.16xlarge", + "g4ad.2xlarge", + "g4ad.4xlarge", + "g4ad.8xlarge", + "g4ad.xlarge", + "g4dn.12xlarge", + "g4dn.16xlarge", + "g4dn.2xlarge", + "g4dn.4xlarge", + "g4dn.8xlarge", + "g4dn.metal", + "g4dn.xlarge", + "g5.12xlarge", + "g5.16xlarge", + "g5.24xlarge", + "g5.2xlarge", + "g5.48xlarge", + "g5.4xlarge", + "g5.8xlarge", + "g5.xlarge", + "g5g.16xlarge", + "g5g.2xlarge", + "g5g.4xlarge", + "g5g.8xlarge", + "g5g.metal", + "g5g.xlarge", + "g6.12xlarge", + "g6.16xlarge", + "g6.24xlarge", + "g6.2xlarge", + "g6.48xlarge", + "g6.4xlarge", + "g6.8xlarge", + "g6.xlarge", + "gr6.4xlarge", + "gr6.8xlarge", + "h1.16xlarge", + "h1.2xlarge", + "h1.4xlarge", + "h1.8xlarge", + "hi1.4xlarge", + "hpc6a.48xlarge", + "hpc6id.32xlarge", + "hpc7a.12xlarge", + "hpc7a.24xlarge", + "hpc7a.48xlarge", + "hpc7a.96xlarge", + "hpc7g.16xlarge", + "hpc7g.4xlarge", + "hpc7g.8xlarge", + "hs1.8xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "i2.xlarge", + "i3.16xlarge", + "i3.2xlarge", + "i3.4xlarge", + "i3.8xlarge", + "i3.large", + "i3.metal", + "i3.xlarge", + "i3en.12xlarge", + "i3en.24xlarge", + "i3en.2xlarge", + "i3en.3xlarge", + "i3en.6xlarge", + "i3en.large", + "i3en.metal", + "i3en.xlarge", + "i4g.16xlarge", + "i4g.2xlarge", + "i4g.4xlarge", + "i4g.8xlarge", + "i4g.large", + "i4g.xlarge", + "i4i.12xlarge", + "i4i.16xlarge", + "i4i.24xlarge", + "i4i.2xlarge", + "i4i.32xlarge", + "i4i.4xlarge", + "i4i.8xlarge", + "i4i.large", + "i4i.metal", + "i4i.xlarge", + "im4gn.16xlarge", + "im4gn.2xlarge", + "im4gn.4xlarge", + "im4gn.8xlarge", + "im4gn.large", + "im4gn.xlarge", + "inf1.24xlarge", + "inf1.2xlarge", + "inf1.6xlarge", + "inf1.xlarge", + "inf2.24xlarge", + "inf2.48xlarge", + "inf2.8xlarge", + "inf2.xlarge", + "is4gen.2xlarge", + "is4gen.4xlarge", + "is4gen.8xlarge", + "is4gen.large", + "is4gen.medium", + "is4gen.xlarge", + "m1.large", + "m1.medium", + "m1.small", + "m1.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "m2.xlarge", + "m3.2xlarge", + "m3.large", + "m3.medium", + "m3.xlarge", + "m4.10xlarge", + "m4.16xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.large", + "m4.xlarge", + "m5.12xlarge", + "m5.16xlarge", + "m5.24xlarge", + "m5.2xlarge", + "m5.4xlarge", + "m5.8xlarge", + "m5.large", + "m5.metal", + "m5.xlarge", + "m5a.12xlarge", + "m5a.16xlarge", + "m5a.24xlarge", + "m5a.2xlarge", + "m5a.4xlarge", + "m5a.8xlarge", + "m5a.large", + "m5a.xlarge", + "m5ad.12xlarge", + "m5ad.16xlarge", + "m5ad.24xlarge", + "m5ad.2xlarge", + "m5ad.4xlarge", + "m5ad.8xlarge", + "m5ad.large", + "m5ad.xlarge", + "m5d.12xlarge", + "m5d.16xlarge", + "m5d.24xlarge", + "m5d.2xlarge", + "m5d.4xlarge", + "m5d.8xlarge", + "m5d.large", + "m5d.metal", + "m5d.xlarge", + "m5dn.12xlarge", + "m5dn.16xlarge", + "m5dn.24xlarge", + "m5dn.2xlarge", + "m5dn.4xlarge", + "m5dn.8xlarge", + "m5dn.large", + "m5dn.metal", + "m5dn.xlarge", + "m5n.12xlarge", + "m5n.16xlarge", + "m5n.24xlarge", + "m5n.2xlarge", + "m5n.4xlarge", + "m5n.8xlarge", + "m5n.large", + "m5n.metal", + "m5n.xlarge", + "m5zn.12xlarge", + "m5zn.2xlarge", + "m5zn.3xlarge", + "m5zn.6xlarge", + "m5zn.large", + "m5zn.metal", + "m5zn.xlarge", + "m6a.12xlarge", + "m6a.16xlarge", + "m6a.24xlarge", + "m6a.2xlarge", + "m6a.32xlarge", + "m6a.48xlarge", + "m6a.4xlarge", + "m6a.8xlarge", + "m6a.large", + "m6a.metal", + "m6a.xlarge", + "m6g.12xlarge", + "m6g.16xlarge", + "m6g.2xlarge", + "m6g.4xlarge", + "m6g.8xlarge", + "m6g.large", + "m6g.medium", + "m6g.metal", + "m6g.xlarge", + "m6gd.12xlarge", + "m6gd.16xlarge", + "m6gd.2xlarge", + "m6gd.4xlarge", + "m6gd.8xlarge", + "m6gd.large", + "m6gd.medium", + "m6gd.metal", + "m6gd.xlarge", + "m6i.12xlarge", + "m6i.16xlarge", + "m6i.24xlarge", + "m6i.2xlarge", + "m6i.32xlarge", + "m6i.4xlarge", + "m6i.8xlarge", + "m6i.large", + "m6i.metal", + "m6i.xlarge", + "m6id.12xlarge", + "m6id.16xlarge", + "m6id.24xlarge", + "m6id.2xlarge", + "m6id.32xlarge", + "m6id.4xlarge", + "m6id.8xlarge", + "m6id.large", + "m6id.metal", + "m6id.xlarge", + "m6idn.12xlarge", + "m6idn.16xlarge", + "m6idn.24xlarge", + "m6idn.2xlarge", + "m6idn.32xlarge", + "m6idn.4xlarge", + "m6idn.8xlarge", + "m6idn.large", + "m6idn.metal", + "m6idn.xlarge", + "m6in.12xlarge", + "m6in.16xlarge", + "m6in.24xlarge", + "m6in.2xlarge", + "m6in.32xlarge", + "m6in.4xlarge", + "m6in.8xlarge", + "m6in.large", + "m6in.metal", + "m6in.xlarge", + "m7a.12xlarge", + "m7a.16xlarge", + "m7a.24xlarge", + "m7a.2xlarge", + "m7a.32xlarge", + "m7a.48xlarge", + "m7a.4xlarge", + "m7a.8xlarge", + "m7a.large", + "m7a.medium", + "m7a.metal-48xl", + "m7a.xlarge", + "m7g.12xlarge", + "m7g.16xlarge", + "m7g.2xlarge", + "m7g.4xlarge", + "m7g.8xlarge", + "m7g.large", + "m7g.medium", + "m7g.metal", + "m7g.xlarge", + "m7gd.12xlarge", + "m7gd.16xlarge", + "m7gd.2xlarge", + "m7gd.4xlarge", + "m7gd.8xlarge", + "m7gd.large", + "m7gd.medium", + "m7gd.metal", + "m7gd.xlarge", + "m7i-flex.2xlarge", + "m7i-flex.4xlarge", + "m7i-flex.8xlarge", + "m7i-flex.large", + "m7i-flex.xlarge", + "m7i.12xlarge", + "m7i.16xlarge", + "m7i.24xlarge", + "m7i.2xlarge", + "m7i.48xlarge", + "m7i.4xlarge", + "m7i.8xlarge", + "m7i.large", + "m7i.metal-24xl", + "m7i.metal-48xl", + "m7i.xlarge", + "mac1.metal", + "mac2-m2.metal", + "mac2-m2pro.metal", + "mac2.metal", + "p2.16xlarge", + "p2.8xlarge", + "p2.xlarge", + "p3.16xlarge", + "p3.2xlarge", + "p3.8xlarge", + "p3dn.24xlarge", + "p4d.24xlarge", + "p4de.24xlarge", + "p5.48xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "r3.large", + "r3.xlarge", + "r4.16xlarge", + "r4.2xlarge", + "r4.4xlarge", + "r4.8xlarge", + "r4.large", + "r4.xlarge", + "r5.12xlarge", + "r5.16xlarge", + "r5.24xlarge", + "r5.2xlarge", + "r5.4xlarge", + "r5.8xlarge", + "r5.large", + "r5.metal", + "r5.xlarge", + "r5a.12xlarge", + "r5a.16xlarge", + "r5a.24xlarge", + "r5a.2xlarge", + "r5a.4xlarge", + "r5a.8xlarge", + "r5a.large", + "r5a.xlarge", + "r5ad.12xlarge", + "r5ad.16xlarge", + "r5ad.24xlarge", + "r5ad.2xlarge", + "r5ad.4xlarge", + "r5ad.8xlarge", + "r5ad.large", + "r5ad.xlarge", + "r5b.12xlarge", + "r5b.16xlarge", + "r5b.24xlarge", + "r5b.2xlarge", + "r5b.4xlarge", + "r5b.8xlarge", + "r5b.large", + "r5b.metal", + "r5b.xlarge", + "r5d.12xlarge", + "r5d.16xlarge", + "r5d.24xlarge", + "r5d.2xlarge", + "r5d.4xlarge", + "r5d.8xlarge", + "r5d.large", + "r5d.metal", + "r5d.xlarge", + "r5dn.12xlarge", + "r5dn.16xlarge", + "r5dn.24xlarge", + "r5dn.2xlarge", + "r5dn.4xlarge", + "r5dn.8xlarge", + "r5dn.large", + "r5dn.metal", + "r5dn.xlarge", + "r5n.12xlarge", + "r5n.16xlarge", + "r5n.24xlarge", + "r5n.2xlarge", + "r5n.4xlarge", + "r5n.8xlarge", + "r5n.large", + "r5n.metal", + "r5n.xlarge", + "r6a.12xlarge", + "r6a.16xlarge", + "r6a.24xlarge", + "r6a.2xlarge", + "r6a.32xlarge", + "r6a.48xlarge", + "r6a.4xlarge", + "r6a.8xlarge", + "r6a.large", + "r6a.metal", + "r6a.xlarge", + "r6g.12xlarge", + "r6g.16xlarge", + "r6g.2xlarge", + "r6g.4xlarge", + "r6g.8xlarge", + "r6g.large", + "r6g.medium", + "r6g.metal", + "r6g.xlarge", + "r6gd.12xlarge", + "r6gd.16xlarge", + "r6gd.2xlarge", + "r6gd.4xlarge", + "r6gd.8xlarge", + "r6gd.large", + "r6gd.medium", + "r6gd.metal", + "r6gd.xlarge", + "r6i.12xlarge", + "r6i.16xlarge", + "r6i.24xlarge", + "r6i.2xlarge", + "r6i.32xlarge", + "r6i.4xlarge", + "r6i.8xlarge", + "r6i.large", + "r6i.metal", + "r6i.xlarge", + "r6id.12xlarge", + "r6id.16xlarge", + "r6id.24xlarge", + "r6id.2xlarge", + "r6id.32xlarge", + "r6id.4xlarge", + "r6id.8xlarge", + "r6id.large", + "r6id.metal", + "r6id.xlarge", + "r6idn.12xlarge", + "r6idn.16xlarge", + "r6idn.24xlarge", + "r6idn.2xlarge", + "r6idn.32xlarge", + "r6idn.4xlarge", + "r6idn.8xlarge", + "r6idn.large", + "r6idn.metal", + "r6idn.xlarge", + "r6in.12xlarge", + "r6in.16xlarge", + "r6in.24xlarge", + "r6in.2xlarge", + "r6in.32xlarge", + "r6in.4xlarge", + "r6in.8xlarge", + "r6in.large", + "r6in.metal", + "r6in.xlarge", + "r7a.12xlarge", + "r7a.16xlarge", + "r7a.24xlarge", + "r7a.2xlarge", + "r7a.32xlarge", + "r7a.48xlarge", + "r7a.4xlarge", + "r7a.8xlarge", + "r7a.large", + "r7a.medium", + "r7a.metal-48xl", + "r7a.xlarge", + "r7g.12xlarge", + "r7g.16xlarge", + "r7g.2xlarge", + "r7g.4xlarge", + "r7g.8xlarge", + "r7g.large", + "r7g.medium", + "r7g.metal", + "r7g.xlarge", + "r7gd.12xlarge", + "r7gd.16xlarge", + "r7gd.2xlarge", + "r7gd.4xlarge", + "r7gd.8xlarge", + "r7gd.large", + "r7gd.medium", + "r7gd.metal", + "r7gd.xlarge", + "r7i.12xlarge", + "r7i.16xlarge", + "r7i.24xlarge", + "r7i.2xlarge", + "r7i.48xlarge", + "r7i.4xlarge", + "r7i.8xlarge", + "r7i.large", + "r7i.metal-24xl", + "r7i.metal-48xl", + "r7i.xlarge", + "r7iz.12xlarge", + "r7iz.16xlarge", + "r7iz.2xlarge", + "r7iz.32xlarge", + "r7iz.4xlarge", + "r7iz.8xlarge", + "r7iz.large", + "r7iz.metal-16xl", + "r7iz.metal-32xl", + "r7iz.xlarge", + "t1.micro", + "t2.2xlarge", + "t2.large", + "t2.medium", + "t2.micro", + "t2.nano", + "t2.small", + "t2.xlarge", + "t3.2xlarge", + "t3.large", + "t3.medium", + "t3.micro", + "t3.nano", + "t3.small", + "t3.xlarge", + "t3a.2xlarge", + "t3a.large", + "t3a.medium", + "t3a.micro", + "t3a.nano", + "t3a.small", + "t3a.xlarge", + "t4g.2xlarge", + "t4g.large", + "t4g.medium", + "t4g.micro", + "t4g.nano", + "t4g.small", + "t4g.xlarge", + "trn1.2xlarge", + "trn1.32xlarge", + "trn1n.32xlarge", + "u-12tb1.112xlarge", + "u-12tb1.metal", + "u-18tb1.112xlarge", + "u-18tb1.metal", + "u-24tb1.112xlarge", + "u-24tb1.metal", + "u-3tb1.56xlarge", + "u-6tb1.112xlarge", + "u-6tb1.56xlarge", + "u-6tb1.metal", + "u-9tb1.112xlarge", + "u-9tb1.metal", + "vt1.24xlarge", + "vt1.3xlarge", + "vt1.6xlarge", + "x1.16xlarge", + "x1.32xlarge", + "x1e.16xlarge", + "x1e.2xlarge", + "x1e.32xlarge", + "x1e.4xlarge", + "x1e.8xlarge", + "x1e.xlarge", + "x2gd.12xlarge", + "x2gd.16xlarge", + "x2gd.2xlarge", + "x2gd.4xlarge", + "x2gd.8xlarge", + "x2gd.large", + "x2gd.medium", + "x2gd.metal", + "x2gd.xlarge", + "x2idn.16xlarge", + "x2idn.24xlarge", + "x2idn.32xlarge", + "x2idn.metal", + "x2iedn.16xlarge", + "x2iedn.24xlarge", + "x2iedn.2xlarge", + "x2iedn.32xlarge", + "x2iedn.4xlarge", + "x2iedn.8xlarge", + "x2iedn.metal", + "x2iedn.xlarge", + "x2iezn.12xlarge", + "x2iezn.2xlarge", + "x2iezn.4xlarge", + "x2iezn.6xlarge", + "x2iezn.8xlarge", + "x2iezn.metal", + "z1d.12xlarge", + "z1d.2xlarge", + "z1d.3xlarge", + "z1d.6xlarge", + "z1d.large", + "z1d.metal", + "z1d.xlarge" + ], + "x-ms-enum": { + "name": "InstanceType", + "modelAsString": true, + "values": [ + { + "name": "A12xlarge", + "value": "a1.2xlarge", + "description": "InstanceType enum a1.2xlarge" + }, + { + "name": "A14xlarge", + "value": "a1.4xlarge", + "description": "InstanceType enum a1.4xlarge" + }, + { + "name": "A1Large", + "value": "a1.large", + "description": "InstanceType enum a1.large" + }, + { + "name": "A1Medium", + "value": "a1.medium", + "description": "InstanceType enum a1.medium" + }, + { + "name": "A1Metal", + "value": "a1.metal", + "description": "InstanceType enum a1.metal" + }, + { + "name": "A1Xlarge", + "value": "a1.xlarge", + "description": "InstanceType enum a1.xlarge" + }, + { + "name": "C1Medium", + "value": "c1.medium", + "description": "InstanceType enum c1.medium" + }, + { + "name": "C1Xlarge", + "value": "c1.xlarge", + "description": "InstanceType enum c1.xlarge" + }, + { + "name": "C32xlarge", + "value": "c3.2xlarge", + "description": "InstanceType enum c3.2xlarge" + }, + { + "name": "C34xlarge", + "value": "c3.4xlarge", + "description": "InstanceType enum c3.4xlarge" + }, + { + "name": "C38xlarge", + "value": "c3.8xlarge", + "description": "InstanceType enum c3.8xlarge" + }, + { + "name": "C3Large", + "value": "c3.large", + "description": "InstanceType enum c3.large" + }, + { + "name": "C3Xlarge", + "value": "c3.xlarge", + "description": "InstanceType enum c3.xlarge" + }, + { + "name": "C42xlarge", + "value": "c4.2xlarge", + "description": "InstanceType enum c4.2xlarge" + }, + { + "name": "C44xlarge", + "value": "c4.4xlarge", + "description": "InstanceType enum c4.4xlarge" + }, + { + "name": "C48xlarge", + "value": "c4.8xlarge", + "description": "InstanceType enum c4.8xlarge" + }, + { + "name": "C4Large", + "value": "c4.large", + "description": "InstanceType enum c4.large" + }, + { + "name": "C4Xlarge", + "value": "c4.xlarge", + "description": "InstanceType enum c4.xlarge" + }, + { + "name": "C512xlarge", + "value": "c5.12xlarge", + "description": "InstanceType enum c5.12xlarge" + }, + { + "name": "C518xlarge", + "value": "c5.18xlarge", + "description": "InstanceType enum c5.18xlarge" + }, + { + "name": "C524xlarge", + "value": "c5.24xlarge", + "description": "InstanceType enum c5.24xlarge" + }, + { + "name": "C52xlarge", + "value": "c5.2xlarge", + "description": "InstanceType enum c5.2xlarge" + }, + { + "name": "C54xlarge", + "value": "c5.4xlarge", + "description": "InstanceType enum c5.4xlarge" + }, + { + "name": "C59xlarge", + "value": "c5.9xlarge", + "description": "InstanceType enum c5.9xlarge" + }, + { + "name": "C5Large", + "value": "c5.large", + "description": "InstanceType enum c5.large" + }, + { + "name": "C5Metal", + "value": "c5.metal", + "description": "InstanceType enum c5.metal" + }, + { + "name": "C5Xlarge", + "value": "c5.xlarge", + "description": "InstanceType enum c5.xlarge" + }, + { + "name": "C5a12xlarge", + "value": "c5a.12xlarge", + "description": "InstanceType enum c5a.12xlarge" + }, + { + "name": "C5a16xlarge", + "value": "c5a.16xlarge", + "description": "InstanceType enum c5a.16xlarge" + }, + { + "name": "C5a24xlarge", + "value": "c5a.24xlarge", + "description": "InstanceType enum c5a.24xlarge" + }, + { + "name": "C5a2xlarge", + "value": "c5a.2xlarge", + "description": "InstanceType enum c5a.2xlarge" + }, + { + "name": "C5a4xlarge", + "value": "c5a.4xlarge", + "description": "InstanceType enum c5a.4xlarge" + }, + { + "name": "C5a8xlarge", + "value": "c5a.8xlarge", + "description": "InstanceType enum c5a.8xlarge" + }, + { + "name": "C5aLarge", + "value": "c5a.large", + "description": "InstanceType enum c5a.large" + }, + { + "name": "C5aXlarge", + "value": "c5a.xlarge", + "description": "InstanceType enum c5a.xlarge" + }, + { + "name": "C5ad12xlarge", + "value": "c5ad.12xlarge", + "description": "InstanceType enum c5ad.12xlarge" + }, + { + "name": "C5ad16xlarge", + "value": "c5ad.16xlarge", + "description": "InstanceType enum c5ad.16xlarge" + }, + { + "name": "C5ad24xlarge", + "value": "c5ad.24xlarge", + "description": "InstanceType enum c5ad.24xlarge" + }, + { + "name": "C5ad2xlarge", + "value": "c5ad.2xlarge", + "description": "InstanceType enum c5ad.2xlarge" + }, + { + "name": "C5ad4xlarge", + "value": "c5ad.4xlarge", + "description": "InstanceType enum c5ad.4xlarge" + }, + { + "name": "C5ad8xlarge", + "value": "c5ad.8xlarge", + "description": "InstanceType enum c5ad.8xlarge" + }, + { + "name": "C5adLarge", + "value": "c5ad.large", + "description": "InstanceType enum c5ad.large" + }, + { + "name": "C5adXlarge", + "value": "c5ad.xlarge", + "description": "InstanceType enum c5ad.xlarge" + }, + { + "name": "C5d12xlarge", + "value": "c5d.12xlarge", + "description": "InstanceType enum c5d.12xlarge" + }, + { + "name": "C5d18xlarge", + "value": "c5d.18xlarge", + "description": "InstanceType enum c5d.18xlarge" + }, + { + "name": "C5d24xlarge", + "value": "c5d.24xlarge", + "description": "InstanceType enum c5d.24xlarge" + }, + { + "name": "C5d2xlarge", + "value": "c5d.2xlarge", + "description": "InstanceType enum c5d.2xlarge" + }, + { + "name": "C5d4xlarge", + "value": "c5d.4xlarge", + "description": "InstanceType enum c5d.4xlarge" + }, + { + "name": "C5d9xlarge", + "value": "c5d.9xlarge", + "description": "InstanceType enum c5d.9xlarge" + }, + { + "name": "C5dLarge", + "value": "c5d.large", + "description": "InstanceType enum c5d.large" + }, + { + "name": "C5dMetal", + "value": "c5d.metal", + "description": "InstanceType enum c5d.metal" + }, + { + "name": "C5dXlarge", + "value": "c5d.xlarge", + "description": "InstanceType enum c5d.xlarge" + }, + { + "name": "C5n18xlarge", + "value": "c5n.18xlarge", + "description": "InstanceType enum c5n.18xlarge" + }, + { + "name": "C5n2xlarge", + "value": "c5n.2xlarge", + "description": "InstanceType enum c5n.2xlarge" + }, + { + "name": "C5n4xlarge", + "value": "c5n.4xlarge", + "description": "InstanceType enum c5n.4xlarge" + }, + { + "name": "C5n9xlarge", + "value": "c5n.9xlarge", + "description": "InstanceType enum c5n.9xlarge" + }, + { + "name": "C5nLarge", + "value": "c5n.large", + "description": "InstanceType enum c5n.large" + }, + { + "name": "C5nMetal", + "value": "c5n.metal", + "description": "InstanceType enum c5n.metal" + }, + { + "name": "C5nXlarge", + "value": "c5n.xlarge", + "description": "InstanceType enum c5n.xlarge" + }, + { + "name": "C6a12xlarge", + "value": "c6a.12xlarge", + "description": "InstanceType enum c6a.12xlarge" + }, + { + "name": "C6a16xlarge", + "value": "c6a.16xlarge", + "description": "InstanceType enum c6a.16xlarge" + }, + { + "name": "C6a24xlarge", + "value": "c6a.24xlarge", + "description": "InstanceType enum c6a.24xlarge" + }, + { + "name": "C6a2xlarge", + "value": "c6a.2xlarge", + "description": "InstanceType enum c6a.2xlarge" + }, + { + "name": "C6a32xlarge", + "value": "c6a.32xlarge", + "description": "InstanceType enum c6a.32xlarge" + }, + { + "name": "C6a48xlarge", + "value": "c6a.48xlarge", + "description": "InstanceType enum c6a.48xlarge" + }, + { + "name": "C6a4xlarge", + "value": "c6a.4xlarge", + "description": "InstanceType enum c6a.4xlarge" + }, + { + "name": "C6a8xlarge", + "value": "c6a.8xlarge", + "description": "InstanceType enum c6a.8xlarge" + }, + { + "name": "C6aLarge", + "value": "c6a.large", + "description": "InstanceType enum c6a.large" + }, + { + "name": "C6aMetal", + "value": "c6a.metal", + "description": "InstanceType enum c6a.metal" + }, + { + "name": "C6aXlarge", + "value": "c6a.xlarge", + "description": "InstanceType enum c6a.xlarge" + }, + { + "name": "C6g12xlarge", + "value": "c6g.12xlarge", + "description": "InstanceType enum c6g.12xlarge" + }, + { + "name": "C6g16xlarge", + "value": "c6g.16xlarge", + "description": "InstanceType enum c6g.16xlarge" + }, + { + "name": "C6g2xlarge", + "value": "c6g.2xlarge", + "description": "InstanceType enum c6g.2xlarge" + }, + { + "name": "C6g4xlarge", + "value": "c6g.4xlarge", + "description": "InstanceType enum c6g.4xlarge" + }, + { + "name": "C6g8xlarge", + "value": "c6g.8xlarge", + "description": "InstanceType enum c6g.8xlarge" + }, + { + "name": "C6gLarge", + "value": "c6g.large", + "description": "InstanceType enum c6g.large" + }, + { + "name": "C6gMedium", + "value": "c6g.medium", + "description": "InstanceType enum c6g.medium" + }, + { + "name": "C6gMetal", + "value": "c6g.metal", + "description": "InstanceType enum c6g.metal" + }, + { + "name": "C6gXlarge", + "value": "c6g.xlarge", + "description": "InstanceType enum c6g.xlarge" + }, + { + "name": "C6gd12xlarge", + "value": "c6gd.12xlarge", + "description": "InstanceType enum c6gd.12xlarge" + }, + { + "name": "C6gd16xlarge", + "value": "c6gd.16xlarge", + "description": "InstanceType enum c6gd.16xlarge" + }, + { + "name": "C6gd2xlarge", + "value": "c6gd.2xlarge", + "description": "InstanceType enum c6gd.2xlarge" + }, + { + "name": "C6gd4xlarge", + "value": "c6gd.4xlarge", + "description": "InstanceType enum c6gd.4xlarge" + }, + { + "name": "C6gd8xlarge", + "value": "c6gd.8xlarge", + "description": "InstanceType enum c6gd.8xlarge" + }, + { + "name": "C6gdLarge", + "value": "c6gd.large", + "description": "InstanceType enum c6gd.large" + }, + { + "name": "C6gdMedium", + "value": "c6gd.medium", + "description": "InstanceType enum c6gd.medium" + }, + { + "name": "C6gdMetal", + "value": "c6gd.metal", + "description": "InstanceType enum c6gd.metal" + }, + { + "name": "C6gdXlarge", + "value": "c6gd.xlarge", + "description": "InstanceType enum c6gd.xlarge" + }, + { + "name": "C6gn12xlarge", + "value": "c6gn.12xlarge", + "description": "InstanceType enum c6gn.12xlarge" + }, + { + "name": "C6gn16xlarge", + "value": "c6gn.16xlarge", + "description": "InstanceType enum c6gn.16xlarge" + }, + { + "name": "C6gn2xlarge", + "value": "c6gn.2xlarge", + "description": "InstanceType enum c6gn.2xlarge" + }, + { + "name": "C6gn4xlarge", + "value": "c6gn.4xlarge", + "description": "InstanceType enum c6gn.4xlarge" + }, + { + "name": "C6gn8xlarge", + "value": "c6gn.8xlarge", + "description": "InstanceType enum c6gn.8xlarge" + }, + { + "name": "C6gnLarge", + "value": "c6gn.large", + "description": "InstanceType enum c6gn.large" + }, + { + "name": "C6gnMedium", + "value": "c6gn.medium", + "description": "InstanceType enum c6gn.medium" + }, + { + "name": "C6gnXlarge", + "value": "c6gn.xlarge", + "description": "InstanceType enum c6gn.xlarge" + }, + { + "name": "C6i12xlarge", + "value": "c6i.12xlarge", + "description": "InstanceType enum c6i.12xlarge" + }, + { + "name": "C6i16xlarge", + "value": "c6i.16xlarge", + "description": "InstanceType enum c6i.16xlarge" + }, + { + "name": "C6i24xlarge", + "value": "c6i.24xlarge", + "description": "InstanceType enum c6i.24xlarge" + }, + { + "name": "C6i2xlarge", + "value": "c6i.2xlarge", + "description": "InstanceType enum c6i.2xlarge" + }, + { + "name": "C6i32xlarge", + "value": "c6i.32xlarge", + "description": "InstanceType enum c6i.32xlarge" + }, + { + "name": "C6i4xlarge", + "value": "c6i.4xlarge", + "description": "InstanceType enum c6i.4xlarge" + }, + { + "name": "C6i8xlarge", + "value": "c6i.8xlarge", + "description": "InstanceType enum c6i.8xlarge" + }, + { + "name": "C6iLarge", + "value": "c6i.large", + "description": "InstanceType enum c6i.large" + }, + { + "name": "C6iMetal", + "value": "c6i.metal", + "description": "InstanceType enum c6i.metal" + }, + { + "name": "C6iXlarge", + "value": "c6i.xlarge", + "description": "InstanceType enum c6i.xlarge" + }, + { + "name": "C6id12xlarge", + "value": "c6id.12xlarge", + "description": "InstanceType enum c6id.12xlarge" + }, + { + "name": "C6id16xlarge", + "value": "c6id.16xlarge", + "description": "InstanceType enum c6id.16xlarge" + }, + { + "name": "C6id24xlarge", + "value": "c6id.24xlarge", + "description": "InstanceType enum c6id.24xlarge" + }, + { + "name": "C6id2xlarge", + "value": "c6id.2xlarge", + "description": "InstanceType enum c6id.2xlarge" + }, + { + "name": "C6id32xlarge", + "value": "c6id.32xlarge", + "description": "InstanceType enum c6id.32xlarge" + }, + { + "name": "C6id4xlarge", + "value": "c6id.4xlarge", + "description": "InstanceType enum c6id.4xlarge" + }, + { + "name": "C6id8xlarge", + "value": "c6id.8xlarge", + "description": "InstanceType enum c6id.8xlarge" + }, + { + "name": "C6idLarge", + "value": "c6id.large", + "description": "InstanceType enum c6id.large" + }, + { + "name": "C6idMetal", + "value": "c6id.metal", + "description": "InstanceType enum c6id.metal" + }, + { + "name": "C6idXlarge", + "value": "c6id.xlarge", + "description": "InstanceType enum c6id.xlarge" + }, + { + "name": "C6in12xlarge", + "value": "c6in.12xlarge", + "description": "InstanceType enum c6in.12xlarge" + }, + { + "name": "C6in16xlarge", + "value": "c6in.16xlarge", + "description": "InstanceType enum c6in.16xlarge" + }, + { + "name": "C6in24xlarge", + "value": "c6in.24xlarge", + "description": "InstanceType enum c6in.24xlarge" + }, + { + "name": "C6in2xlarge", + "value": "c6in.2xlarge", + "description": "InstanceType enum c6in.2xlarge" + }, + { + "name": "C6in32xlarge", + "value": "c6in.32xlarge", + "description": "InstanceType enum c6in.32xlarge" + }, + { + "name": "C6in4xlarge", + "value": "c6in.4xlarge", + "description": "InstanceType enum c6in.4xlarge" + }, + { + "name": "C6in8xlarge", + "value": "c6in.8xlarge", + "description": "InstanceType enum c6in.8xlarge" + }, + { + "name": "C6inLarge", + "value": "c6in.large", + "description": "InstanceType enum c6in.large" + }, + { + "name": "C6inMetal", + "value": "c6in.metal", + "description": "InstanceType enum c6in.metal" + }, + { + "name": "C6inXlarge", + "value": "c6in.xlarge", + "description": "InstanceType enum c6in.xlarge" + }, + { + "name": "C7a12xlarge", + "value": "c7a.12xlarge", + "description": "InstanceType enum c7a.12xlarge" + }, + { + "name": "C7a16xlarge", + "value": "c7a.16xlarge", + "description": "InstanceType enum c7a.16xlarge" + }, + { + "name": "C7a24xlarge", + "value": "c7a.24xlarge", + "description": "InstanceType enum c7a.24xlarge" + }, + { + "name": "C7a2xlarge", + "value": "c7a.2xlarge", + "description": "InstanceType enum c7a.2xlarge" + }, + { + "name": "C7a32xlarge", + "value": "c7a.32xlarge", + "description": "InstanceType enum c7a.32xlarge" + }, + { + "name": "C7a48xlarge", + "value": "c7a.48xlarge", + "description": "InstanceType enum c7a.48xlarge" + }, + { + "name": "C7a4xlarge", + "value": "c7a.4xlarge", + "description": "InstanceType enum c7a.4xlarge" + }, + { + "name": "C7a8xlarge", + "value": "c7a.8xlarge", + "description": "InstanceType enum c7a.8xlarge" + }, + { + "name": "C7aLarge", + "value": "c7a.large", + "description": "InstanceType enum c7a.large" + }, + { + "name": "C7aMedium", + "value": "c7a.medium", + "description": "InstanceType enum c7a.medium" + }, + { + "name": "C7aMetal48xl", + "value": "c7a.metal-48xl", + "description": "InstanceType enum c7a.metal-48xl" + }, + { + "name": "C7aXlarge", + "value": "c7a.xlarge", + "description": "InstanceType enum c7a.xlarge" + }, + { + "name": "C7g12xlarge", + "value": "c7g.12xlarge", + "description": "InstanceType enum c7g.12xlarge" + }, + { + "name": "C7g16xlarge", + "value": "c7g.16xlarge", + "description": "InstanceType enum c7g.16xlarge" + }, + { + "name": "C7g2xlarge", + "value": "c7g.2xlarge", + "description": "InstanceType enum c7g.2xlarge" + }, + { + "name": "C7g4xlarge", + "value": "c7g.4xlarge", + "description": "InstanceType enum c7g.4xlarge" + }, + { + "name": "C7g8xlarge", + "value": "c7g.8xlarge", + "description": "InstanceType enum c7g.8xlarge" + }, + { + "name": "C7gLarge", + "value": "c7g.large", + "description": "InstanceType enum c7g.large" + }, + { + "name": "C7gMedium", + "value": "c7g.medium", + "description": "InstanceType enum c7g.medium" + }, + { + "name": "C7gMetal", + "value": "c7g.metal", + "description": "InstanceType enum c7g.metal" + }, + { + "name": "C7gXlarge", + "value": "c7g.xlarge", + "description": "InstanceType enum c7g.xlarge" + }, + { + "name": "C7gd12xlarge", + "value": "c7gd.12xlarge", + "description": "InstanceType enum c7gd.12xlarge" + }, + { + "name": "C7gd16xlarge", + "value": "c7gd.16xlarge", + "description": "InstanceType enum c7gd.16xlarge" + }, + { + "name": "C7gd2xlarge", + "value": "c7gd.2xlarge", + "description": "InstanceType enum c7gd.2xlarge" + }, + { + "name": "C7gd4xlarge", + "value": "c7gd.4xlarge", + "description": "InstanceType enum c7gd.4xlarge" + }, + { + "name": "C7gd8xlarge", + "value": "c7gd.8xlarge", + "description": "InstanceType enum c7gd.8xlarge" + }, + { + "name": "C7gdLarge", + "value": "c7gd.large", + "description": "InstanceType enum c7gd.large" + }, + { + "name": "C7gdMedium", + "value": "c7gd.medium", + "description": "InstanceType enum c7gd.medium" + }, + { + "name": "C7gdMetal", + "value": "c7gd.metal", + "description": "InstanceType enum c7gd.metal" + }, + { + "name": "C7gdXlarge", + "value": "c7gd.xlarge", + "description": "InstanceType enum c7gd.xlarge" + }, + { + "name": "C7gn12xlarge", + "value": "c7gn.12xlarge", + "description": "InstanceType enum c7gn.12xlarge" + }, + { + "name": "C7gn16xlarge", + "value": "c7gn.16xlarge", + "description": "InstanceType enum c7gn.16xlarge" + }, + { + "name": "C7gn2xlarge", + "value": "c7gn.2xlarge", + "description": "InstanceType enum c7gn.2xlarge" + }, + { + "name": "C7gn4xlarge", + "value": "c7gn.4xlarge", + "description": "InstanceType enum c7gn.4xlarge" + }, + { + "name": "C7gn8xlarge", + "value": "c7gn.8xlarge", + "description": "InstanceType enum c7gn.8xlarge" + }, + { + "name": "C7gnLarge", + "value": "c7gn.large", + "description": "InstanceType enum c7gn.large" + }, + { + "name": "C7gnMedium", + "value": "c7gn.medium", + "description": "InstanceType enum c7gn.medium" + }, + { + "name": "C7gnXlarge", + "value": "c7gn.xlarge", + "description": "InstanceType enum c7gn.xlarge" + }, + { + "name": "C7i12xlarge", + "value": "c7i.12xlarge", + "description": "InstanceType enum c7i.12xlarge" + }, + { + "name": "C7i16xlarge", + "value": "c7i.16xlarge", + "description": "InstanceType enum c7i.16xlarge" + }, + { + "name": "C7i24xlarge", + "value": "c7i.24xlarge", + "description": "InstanceType enum c7i.24xlarge" + }, + { + "name": "C7i2xlarge", + "value": "c7i.2xlarge", + "description": "InstanceType enum c7i.2xlarge" + }, + { + "name": "C7i48xlarge", + "value": "c7i.48xlarge", + "description": "InstanceType enum c7i.48xlarge" + }, + { + "name": "C7i4xlarge", + "value": "c7i.4xlarge", + "description": "InstanceType enum c7i.4xlarge" + }, + { + "name": "C7i8xlarge", + "value": "c7i.8xlarge", + "description": "InstanceType enum c7i.8xlarge" + }, + { + "name": "C7iLarge", + "value": "c7i.large", + "description": "InstanceType enum c7i.large" + }, + { + "name": "C7iMetal24xl", + "value": "c7i.metal-24xl", + "description": "InstanceType enum c7i.metal-24xl" + }, + { + "name": "C7iMetal48xl", + "value": "c7i.metal-48xl", + "description": "InstanceType enum c7i.metal-48xl" + }, + { + "name": "C7iXlarge", + "value": "c7i.xlarge", + "description": "InstanceType enum c7i.xlarge" + }, + { + "name": "Cc14xlarge", + "value": "cc1.4xlarge", + "description": "InstanceType enum cc1.4xlarge" + }, + { + "name": "Cc28xlarge", + "value": "cc2.8xlarge", + "description": "InstanceType enum cc2.8xlarge" + }, + { + "name": "Cg14xlarge", + "value": "cg1.4xlarge", + "description": "InstanceType enum cg1.4xlarge" + }, + { + "name": "Cr18xlarge", + "value": "cr1.8xlarge", + "description": "InstanceType enum cr1.8xlarge" + }, + { + "name": "D22xlarge", + "value": "d2.2xlarge", + "description": "InstanceType enum d2.2xlarge" + }, + { + "name": "D24xlarge", + "value": "d2.4xlarge", + "description": "InstanceType enum d2.4xlarge" + }, + { + "name": "D28xlarge", + "value": "d2.8xlarge", + "description": "InstanceType enum d2.8xlarge" + }, + { + "name": "D2Xlarge", + "value": "d2.xlarge", + "description": "InstanceType enum d2.xlarge" + }, + { + "name": "D32xlarge", + "value": "d3.2xlarge", + "description": "InstanceType enum d3.2xlarge" + }, + { + "name": "D34xlarge", + "value": "d3.4xlarge", + "description": "InstanceType enum d3.4xlarge" + }, + { + "name": "D38xlarge", + "value": "d3.8xlarge", + "description": "InstanceType enum d3.8xlarge" + }, + { + "name": "D3Xlarge", + "value": "d3.xlarge", + "description": "InstanceType enum d3.xlarge" + }, + { + "name": "D3en12xlarge", + "value": "d3en.12xlarge", + "description": "InstanceType enum d3en.12xlarge" + }, + { + "name": "D3en2xlarge", + "value": "d3en.2xlarge", + "description": "InstanceType enum d3en.2xlarge" + }, + { + "name": "D3en4xlarge", + "value": "d3en.4xlarge", + "description": "InstanceType enum d3en.4xlarge" + }, + { + "name": "D3en6xlarge", + "value": "d3en.6xlarge", + "description": "InstanceType enum d3en.6xlarge" + }, + { + "name": "D3en8xlarge", + "value": "d3en.8xlarge", + "description": "InstanceType enum d3en.8xlarge" + }, + { + "name": "D3enXlarge", + "value": "d3en.xlarge", + "description": "InstanceType enum d3en.xlarge" + }, + { + "name": "Dl124xlarge", + "value": "dl1.24xlarge", + "description": "InstanceType enum dl1.24xlarge" + }, + { + "name": "Dl2q24xlarge", + "value": "dl2q.24xlarge", + "description": "InstanceType enum dl2q.24xlarge" + }, + { + "name": "F116xlarge", + "value": "f1.16xlarge", + "description": "InstanceType enum f1.16xlarge" + }, + { + "name": "F12xlarge", + "value": "f1.2xlarge", + "description": "InstanceType enum f1.2xlarge" + }, + { + "name": "F14xlarge", + "value": "f1.4xlarge", + "description": "InstanceType enum f1.4xlarge" + }, + { + "name": "G22xlarge", + "value": "g2.2xlarge", + "description": "InstanceType enum g2.2xlarge" + }, + { + "name": "G28xlarge", + "value": "g2.8xlarge", + "description": "InstanceType enum g2.8xlarge" + }, + { + "name": "G316xlarge", + "value": "g3.16xlarge", + "description": "InstanceType enum g3.16xlarge" + }, + { + "name": "G34xlarge", + "value": "g3.4xlarge", + "description": "InstanceType enum g3.4xlarge" + }, + { + "name": "G38xlarge", + "value": "g3.8xlarge", + "description": "InstanceType enum g3.8xlarge" + }, + { + "name": "G3sXlarge", + "value": "g3s.xlarge", + "description": "InstanceType enum g3s.xlarge" + }, + { + "name": "G4ad16xlarge", + "value": "g4ad.16xlarge", + "description": "InstanceType enum g4ad.16xlarge" + }, + { + "name": "G4ad2xlarge", + "value": "g4ad.2xlarge", + "description": "InstanceType enum g4ad.2xlarge" + }, + { + "name": "G4ad4xlarge", + "value": "g4ad.4xlarge", + "description": "InstanceType enum g4ad.4xlarge" + }, + { + "name": "G4ad8xlarge", + "value": "g4ad.8xlarge", + "description": "InstanceType enum g4ad.8xlarge" + }, + { + "name": "G4adXlarge", + "value": "g4ad.xlarge", + "description": "InstanceType enum g4ad.xlarge" + }, + { + "name": "G4dn12xlarge", + "value": "g4dn.12xlarge", + "description": "InstanceType enum g4dn.12xlarge" + }, + { + "name": "G4dn16xlarge", + "value": "g4dn.16xlarge", + "description": "InstanceType enum g4dn.16xlarge" + }, + { + "name": "G4dn2xlarge", + "value": "g4dn.2xlarge", + "description": "InstanceType enum g4dn.2xlarge" + }, + { + "name": "G4dn4xlarge", + "value": "g4dn.4xlarge", + "description": "InstanceType enum g4dn.4xlarge" + }, + { + "name": "G4dn8xlarge", + "value": "g4dn.8xlarge", + "description": "InstanceType enum g4dn.8xlarge" + }, + { + "name": "G4dnMetal", + "value": "g4dn.metal", + "description": "InstanceType enum g4dn.metal" + }, + { + "name": "G4dnXlarge", + "value": "g4dn.xlarge", + "description": "InstanceType enum g4dn.xlarge" + }, + { + "name": "G512xlarge", + "value": "g5.12xlarge", + "description": "InstanceType enum g5.12xlarge" + }, + { + "name": "G516xlarge", + "value": "g5.16xlarge", + "description": "InstanceType enum g5.16xlarge" + }, + { + "name": "G524xlarge", + "value": "g5.24xlarge", + "description": "InstanceType enum g5.24xlarge" + }, + { + "name": "G52xlarge", + "value": "g5.2xlarge", + "description": "InstanceType enum g5.2xlarge" + }, + { + "name": "G548xlarge", + "value": "g5.48xlarge", + "description": "InstanceType enum g5.48xlarge" + }, + { + "name": "G54xlarge", + "value": "g5.4xlarge", + "description": "InstanceType enum g5.4xlarge" + }, + { + "name": "G58xlarge", + "value": "g5.8xlarge", + "description": "InstanceType enum g5.8xlarge" + }, + { + "name": "G5Xlarge", + "value": "g5.xlarge", + "description": "InstanceType enum g5.xlarge" + }, + { + "name": "G5g16xlarge", + "value": "g5g.16xlarge", + "description": "InstanceType enum g5g.16xlarge" + }, + { + "name": "G5g2xlarge", + "value": "g5g.2xlarge", + "description": "InstanceType enum g5g.2xlarge" + }, + { + "name": "G5g4xlarge", + "value": "g5g.4xlarge", + "description": "InstanceType enum g5g.4xlarge" + }, + { + "name": "G5g8xlarge", + "value": "g5g.8xlarge", + "description": "InstanceType enum g5g.8xlarge" + }, + { + "name": "G5gMetal", + "value": "g5g.metal", + "description": "InstanceType enum g5g.metal" + }, + { + "name": "G5gXlarge", + "value": "g5g.xlarge", + "description": "InstanceType enum g5g.xlarge" + }, + { + "name": "G612xlarge", + "value": "g6.12xlarge", + "description": "InstanceType enum g6.12xlarge" + }, + { + "name": "G616xlarge", + "value": "g6.16xlarge", + "description": "InstanceType enum g6.16xlarge" + }, + { + "name": "G624xlarge", + "value": "g6.24xlarge", + "description": "InstanceType enum g6.24xlarge" + }, + { + "name": "G62xlarge", + "value": "g6.2xlarge", + "description": "InstanceType enum g6.2xlarge" + }, + { + "name": "G648xlarge", + "value": "g6.48xlarge", + "description": "InstanceType enum g6.48xlarge" + }, + { + "name": "G64xlarge", + "value": "g6.4xlarge", + "description": "InstanceType enum g6.4xlarge" + }, + { + "name": "G68xlarge", + "value": "g6.8xlarge", + "description": "InstanceType enum g6.8xlarge" + }, + { + "name": "G6Xlarge", + "value": "g6.xlarge", + "description": "InstanceType enum g6.xlarge" + }, + { + "name": "Gr64xlarge", + "value": "gr6.4xlarge", + "description": "InstanceType enum gr6.4xlarge" + }, + { + "name": "Gr68xlarge", + "value": "gr6.8xlarge", + "description": "InstanceType enum gr6.8xlarge" + }, + { + "name": "H116xlarge", + "value": "h1.16xlarge", + "description": "InstanceType enum h1.16xlarge" + }, + { + "name": "H12xlarge", + "value": "h1.2xlarge", + "description": "InstanceType enum h1.2xlarge" + }, + { + "name": "H14xlarge", + "value": "h1.4xlarge", + "description": "InstanceType enum h1.4xlarge" + }, + { + "name": "H18xlarge", + "value": "h1.8xlarge", + "description": "InstanceType enum h1.8xlarge" + }, + { + "name": "Hi14xlarge", + "value": "hi1.4xlarge", + "description": "InstanceType enum hi1.4xlarge" + }, + { + "name": "Hpc6a48xlarge", + "value": "hpc6a.48xlarge", + "description": "InstanceType enum hpc6a.48xlarge" + }, + { + "name": "Hpc6id32xlarge", + "value": "hpc6id.32xlarge", + "description": "InstanceType enum hpc6id.32xlarge" + }, + { + "name": "Hpc7a12xlarge", + "value": "hpc7a.12xlarge", + "description": "InstanceType enum hpc7a.12xlarge" + }, + { + "name": "Hpc7a24xlarge", + "value": "hpc7a.24xlarge", + "description": "InstanceType enum hpc7a.24xlarge" + }, + { + "name": "Hpc7a48xlarge", + "value": "hpc7a.48xlarge", + "description": "InstanceType enum hpc7a.48xlarge" + }, + { + "name": "Hpc7a96xlarge", + "value": "hpc7a.96xlarge", + "description": "InstanceType enum hpc7a.96xlarge" + }, + { + "name": "Hpc7g16xlarge", + "value": "hpc7g.16xlarge", + "description": "InstanceType enum hpc7g.16xlarge" + }, + { + "name": "Hpc7g4xlarge", + "value": "hpc7g.4xlarge", + "description": "InstanceType enum hpc7g.4xlarge" + }, + { + "name": "Hpc7g8xlarge", + "value": "hpc7g.8xlarge", + "description": "InstanceType enum hpc7g.8xlarge" + }, + { + "name": "Hs18xlarge", + "value": "hs1.8xlarge", + "description": "InstanceType enum hs1.8xlarge" + }, + { + "name": "I22xlarge", + "value": "i2.2xlarge", + "description": "InstanceType enum i2.2xlarge" + }, + { + "name": "I24xlarge", + "value": "i2.4xlarge", + "description": "InstanceType enum i2.4xlarge" + }, + { + "name": "I28xlarge", + "value": "i2.8xlarge", + "description": "InstanceType enum i2.8xlarge" + }, + { + "name": "I2Xlarge", + "value": "i2.xlarge", + "description": "InstanceType enum i2.xlarge" + }, + { + "name": "I316xlarge", + "value": "i3.16xlarge", + "description": "InstanceType enum i3.16xlarge" + }, + { + "name": "I32xlarge", + "value": "i3.2xlarge", + "description": "InstanceType enum i3.2xlarge" + }, + { + "name": "I34xlarge", + "value": "i3.4xlarge", + "description": "InstanceType enum i3.4xlarge" + }, + { + "name": "I38xlarge", + "value": "i3.8xlarge", + "description": "InstanceType enum i3.8xlarge" + }, + { + "name": "I3Large", + "value": "i3.large", + "description": "InstanceType enum i3.large" + }, + { + "name": "I3Metal", + "value": "i3.metal", + "description": "InstanceType enum i3.metal" + }, + { + "name": "I3Xlarge", + "value": "i3.xlarge", + "description": "InstanceType enum i3.xlarge" + }, + { + "name": "I3en12xlarge", + "value": "i3en.12xlarge", + "description": "InstanceType enum i3en.12xlarge" + }, + { + "name": "I3en24xlarge", + "value": "i3en.24xlarge", + "description": "InstanceType enum i3en.24xlarge" + }, + { + "name": "I3en2xlarge", + "value": "i3en.2xlarge", + "description": "InstanceType enum i3en.2xlarge" + }, + { + "name": "I3en3xlarge", + "value": "i3en.3xlarge", + "description": "InstanceType enum i3en.3xlarge" + }, + { + "name": "I3en6xlarge", + "value": "i3en.6xlarge", + "description": "InstanceType enum i3en.6xlarge" + }, + { + "name": "I3enLarge", + "value": "i3en.large", + "description": "InstanceType enum i3en.large" + }, + { + "name": "I3enMetal", + "value": "i3en.metal", + "description": "InstanceType enum i3en.metal" + }, + { + "name": "I3enXlarge", + "value": "i3en.xlarge", + "description": "InstanceType enum i3en.xlarge" + }, + { + "name": "I4g16xlarge", + "value": "i4g.16xlarge", + "description": "InstanceType enum i4g.16xlarge" + }, + { + "name": "I4g2xlarge", + "value": "i4g.2xlarge", + "description": "InstanceType enum i4g.2xlarge" + }, + { + "name": "I4g4xlarge", + "value": "i4g.4xlarge", + "description": "InstanceType enum i4g.4xlarge" + }, + { + "name": "I4g8xlarge", + "value": "i4g.8xlarge", + "description": "InstanceType enum i4g.8xlarge" + }, + { + "name": "I4gLarge", + "value": "i4g.large", + "description": "InstanceType enum i4g.large" + }, + { + "name": "I4gXlarge", + "value": "i4g.xlarge", + "description": "InstanceType enum i4g.xlarge" + }, + { + "name": "I4i12xlarge", + "value": "i4i.12xlarge", + "description": "InstanceType enum i4i.12xlarge" + }, + { + "name": "I4i16xlarge", + "value": "i4i.16xlarge", + "description": "InstanceType enum i4i.16xlarge" + }, + { + "name": "I4i24xlarge", + "value": "i4i.24xlarge", + "description": "InstanceType enum i4i.24xlarge" + }, + { + "name": "I4i2xlarge", + "value": "i4i.2xlarge", + "description": "InstanceType enum i4i.2xlarge" + }, + { + "name": "I4i32xlarge", + "value": "i4i.32xlarge", + "description": "InstanceType enum i4i.32xlarge" + }, + { + "name": "I4i4xlarge", + "value": "i4i.4xlarge", + "description": "InstanceType enum i4i.4xlarge" + }, + { + "name": "I4i8xlarge", + "value": "i4i.8xlarge", + "description": "InstanceType enum i4i.8xlarge" + }, + { + "name": "I4iLarge", + "value": "i4i.large", + "description": "InstanceType enum i4i.large" + }, + { + "name": "I4iMetal", + "value": "i4i.metal", + "description": "InstanceType enum i4i.metal" + }, + { + "name": "I4iXlarge", + "value": "i4i.xlarge", + "description": "InstanceType enum i4i.xlarge" + }, + { + "name": "Im4gn16xlarge", + "value": "im4gn.16xlarge", + "description": "InstanceType enum im4gn.16xlarge" + }, + { + "name": "Im4gn2xlarge", + "value": "im4gn.2xlarge", + "description": "InstanceType enum im4gn.2xlarge" + }, + { + "name": "Im4gn4xlarge", + "value": "im4gn.4xlarge", + "description": "InstanceType enum im4gn.4xlarge" + }, + { + "name": "Im4gn8xlarge", + "value": "im4gn.8xlarge", + "description": "InstanceType enum im4gn.8xlarge" + }, + { + "name": "Im4gnLarge", + "value": "im4gn.large", + "description": "InstanceType enum im4gn.large" + }, + { + "name": "Im4gnXlarge", + "value": "im4gn.xlarge", + "description": "InstanceType enum im4gn.xlarge" + }, + { + "name": "Inf124xlarge", + "value": "inf1.24xlarge", + "description": "InstanceType enum inf1.24xlarge" + }, + { + "name": "Inf12xlarge", + "value": "inf1.2xlarge", + "description": "InstanceType enum inf1.2xlarge" + }, + { + "name": "Inf16xlarge", + "value": "inf1.6xlarge", + "description": "InstanceType enum inf1.6xlarge" + }, + { + "name": "Inf1Xlarge", + "value": "inf1.xlarge", + "description": "InstanceType enum inf1.xlarge" + }, + { + "name": "Inf224xlarge", + "value": "inf2.24xlarge", + "description": "InstanceType enum inf2.24xlarge" + }, + { + "name": "Inf248xlarge", + "value": "inf2.48xlarge", + "description": "InstanceType enum inf2.48xlarge" + }, + { + "name": "Inf28xlarge", + "value": "inf2.8xlarge", + "description": "InstanceType enum inf2.8xlarge" + }, + { + "name": "Inf2Xlarge", + "value": "inf2.xlarge", + "description": "InstanceType enum inf2.xlarge" + }, + { + "name": "Is4gen2xlarge", + "value": "is4gen.2xlarge", + "description": "InstanceType enum is4gen.2xlarge" + }, + { + "name": "Is4gen4xlarge", + "value": "is4gen.4xlarge", + "description": "InstanceType enum is4gen.4xlarge" + }, + { + "name": "Is4gen8xlarge", + "value": "is4gen.8xlarge", + "description": "InstanceType enum is4gen.8xlarge" + }, + { + "name": "Is4genLarge", + "value": "is4gen.large", + "description": "InstanceType enum is4gen.large" + }, + { + "name": "Is4genMedium", + "value": "is4gen.medium", + "description": "InstanceType enum is4gen.medium" + }, + { + "name": "Is4genXlarge", + "value": "is4gen.xlarge", + "description": "InstanceType enum is4gen.xlarge" + }, + { + "name": "M1Large", + "value": "m1.large", + "description": "InstanceType enum m1.large" + }, + { + "name": "M1Medium", + "value": "m1.medium", + "description": "InstanceType enum m1.medium" + }, + { + "name": "M1Small", + "value": "m1.small", + "description": "InstanceType enum m1.small" + }, + { + "name": "M1Xlarge", + "value": "m1.xlarge", + "description": "InstanceType enum m1.xlarge" + }, + { + "name": "M22xlarge", + "value": "m2.2xlarge", + "description": "InstanceType enum m2.2xlarge" + }, + { + "name": "M24xlarge", + "value": "m2.4xlarge", + "description": "InstanceType enum m2.4xlarge" + }, + { + "name": "M2Xlarge", + "value": "m2.xlarge", + "description": "InstanceType enum m2.xlarge" + }, + { + "name": "M32xlarge", + "value": "m3.2xlarge", + "description": "InstanceType enum m3.2xlarge" + }, + { + "name": "M3Large", + "value": "m3.large", + "description": "InstanceType enum m3.large" + }, + { + "name": "M3Medium", + "value": "m3.medium", + "description": "InstanceType enum m3.medium" + }, + { + "name": "M3Xlarge", + "value": "m3.xlarge", + "description": "InstanceType enum m3.xlarge" + }, + { + "name": "M410xlarge", + "value": "m4.10xlarge", + "description": "InstanceType enum m4.10xlarge" + }, + { + "name": "M416xlarge", + "value": "m4.16xlarge", + "description": "InstanceType enum m4.16xlarge" + }, + { + "name": "M42xlarge", + "value": "m4.2xlarge", + "description": "InstanceType enum m4.2xlarge" + }, + { + "name": "M44xlarge", + "value": "m4.4xlarge", + "description": "InstanceType enum m4.4xlarge" + }, + { + "name": "M4Large", + "value": "m4.large", + "description": "InstanceType enum m4.large" + }, + { + "name": "M4Xlarge", + "value": "m4.xlarge", + "description": "InstanceType enum m4.xlarge" + }, + { + "name": "M512xlarge", + "value": "m5.12xlarge", + "description": "InstanceType enum m5.12xlarge" + }, + { + "name": "M516xlarge", + "value": "m5.16xlarge", + "description": "InstanceType enum m5.16xlarge" + }, + { + "name": "M524xlarge", + "value": "m5.24xlarge", + "description": "InstanceType enum m5.24xlarge" + }, + { + "name": "M52xlarge", + "value": "m5.2xlarge", + "description": "InstanceType enum m5.2xlarge" + }, + { + "name": "M54xlarge", + "value": "m5.4xlarge", + "description": "InstanceType enum m5.4xlarge" + }, + { + "name": "M58xlarge", + "value": "m5.8xlarge", + "description": "InstanceType enum m5.8xlarge" + }, + { + "name": "M5Large", + "value": "m5.large", + "description": "InstanceType enum m5.large" + }, + { + "name": "M5Metal", + "value": "m5.metal", + "description": "InstanceType enum m5.metal" + }, + { + "name": "M5Xlarge", + "value": "m5.xlarge", + "description": "InstanceType enum m5.xlarge" + }, + { + "name": "M5a12xlarge", + "value": "m5a.12xlarge", + "description": "InstanceType enum m5a.12xlarge" + }, + { + "name": "M5a16xlarge", + "value": "m5a.16xlarge", + "description": "InstanceType enum m5a.16xlarge" + }, + { + "name": "M5a24xlarge", + "value": "m5a.24xlarge", + "description": "InstanceType enum m5a.24xlarge" + }, + { + "name": "M5a2xlarge", + "value": "m5a.2xlarge", + "description": "InstanceType enum m5a.2xlarge" + }, + { + "name": "M5a4xlarge", + "value": "m5a.4xlarge", + "description": "InstanceType enum m5a.4xlarge" + }, + { + "name": "M5a8xlarge", + "value": "m5a.8xlarge", + "description": "InstanceType enum m5a.8xlarge" + }, + { + "name": "M5aLarge", + "value": "m5a.large", + "description": "InstanceType enum m5a.large" + }, + { + "name": "M5aXlarge", + "value": "m5a.xlarge", + "description": "InstanceType enum m5a.xlarge" + }, + { + "name": "M5ad12xlarge", + "value": "m5ad.12xlarge", + "description": "InstanceType enum m5ad.12xlarge" + }, + { + "name": "M5ad16xlarge", + "value": "m5ad.16xlarge", + "description": "InstanceType enum m5ad.16xlarge" + }, + { + "name": "M5ad24xlarge", + "value": "m5ad.24xlarge", + "description": "InstanceType enum m5ad.24xlarge" + }, + { + "name": "M5ad2xlarge", + "value": "m5ad.2xlarge", + "description": "InstanceType enum m5ad.2xlarge" + }, + { + "name": "M5ad4xlarge", + "value": "m5ad.4xlarge", + "description": "InstanceType enum m5ad.4xlarge" + }, + { + "name": "M5ad8xlarge", + "value": "m5ad.8xlarge", + "description": "InstanceType enum m5ad.8xlarge" + }, + { + "name": "M5adLarge", + "value": "m5ad.large", + "description": "InstanceType enum m5ad.large" + }, + { + "name": "M5adXlarge", + "value": "m5ad.xlarge", + "description": "InstanceType enum m5ad.xlarge" + }, + { + "name": "M5d12xlarge", + "value": "m5d.12xlarge", + "description": "InstanceType enum m5d.12xlarge" + }, + { + "name": "M5d16xlarge", + "value": "m5d.16xlarge", + "description": "InstanceType enum m5d.16xlarge" + }, + { + "name": "M5d24xlarge", + "value": "m5d.24xlarge", + "description": "InstanceType enum m5d.24xlarge" + }, + { + "name": "M5d2xlarge", + "value": "m5d.2xlarge", + "description": "InstanceType enum m5d.2xlarge" + }, + { + "name": "M5d4xlarge", + "value": "m5d.4xlarge", + "description": "InstanceType enum m5d.4xlarge" + }, + { + "name": "M5d8xlarge", + "value": "m5d.8xlarge", + "description": "InstanceType enum m5d.8xlarge" + }, + { + "name": "M5dLarge", + "value": "m5d.large", + "description": "InstanceType enum m5d.large" + }, + { + "name": "M5dMetal", + "value": "m5d.metal", + "description": "InstanceType enum m5d.metal" + }, + { + "name": "M5dXlarge", + "value": "m5d.xlarge", + "description": "InstanceType enum m5d.xlarge" + }, + { + "name": "M5dn12xlarge", + "value": "m5dn.12xlarge", + "description": "InstanceType enum m5dn.12xlarge" + }, + { + "name": "M5dn16xlarge", + "value": "m5dn.16xlarge", + "description": "InstanceType enum m5dn.16xlarge" + }, + { + "name": "M5dn24xlarge", + "value": "m5dn.24xlarge", + "description": "InstanceType enum m5dn.24xlarge" + }, + { + "name": "M5dn2xlarge", + "value": "m5dn.2xlarge", + "description": "InstanceType enum m5dn.2xlarge" + }, + { + "name": "M5dn4xlarge", + "value": "m5dn.4xlarge", + "description": "InstanceType enum m5dn.4xlarge" + }, + { + "name": "M5dn8xlarge", + "value": "m5dn.8xlarge", + "description": "InstanceType enum m5dn.8xlarge" + }, + { + "name": "M5dnLarge", + "value": "m5dn.large", + "description": "InstanceType enum m5dn.large" + }, + { + "name": "M5dnMetal", + "value": "m5dn.metal", + "description": "InstanceType enum m5dn.metal" + }, + { + "name": "M5dnXlarge", + "value": "m5dn.xlarge", + "description": "InstanceType enum m5dn.xlarge" + }, + { + "name": "M5n12xlarge", + "value": "m5n.12xlarge", + "description": "InstanceType enum m5n.12xlarge" + }, + { + "name": "M5n16xlarge", + "value": "m5n.16xlarge", + "description": "InstanceType enum m5n.16xlarge" + }, + { + "name": "M5n24xlarge", + "value": "m5n.24xlarge", + "description": "InstanceType enum m5n.24xlarge" + }, + { + "name": "M5n2xlarge", + "value": "m5n.2xlarge", + "description": "InstanceType enum m5n.2xlarge" + }, + { + "name": "M5n4xlarge", + "value": "m5n.4xlarge", + "description": "InstanceType enum m5n.4xlarge" + }, + { + "name": "M5n8xlarge", + "value": "m5n.8xlarge", + "description": "InstanceType enum m5n.8xlarge" + }, + { + "name": "M5nLarge", + "value": "m5n.large", + "description": "InstanceType enum m5n.large" + }, + { + "name": "M5nMetal", + "value": "m5n.metal", + "description": "InstanceType enum m5n.metal" + }, + { + "name": "M5nXlarge", + "value": "m5n.xlarge", + "description": "InstanceType enum m5n.xlarge" + }, + { + "name": "M5zn12xlarge", + "value": "m5zn.12xlarge", + "description": "InstanceType enum m5zn.12xlarge" + }, + { + "name": "M5zn2xlarge", + "value": "m5zn.2xlarge", + "description": "InstanceType enum m5zn.2xlarge" + }, + { + "name": "M5zn3xlarge", + "value": "m5zn.3xlarge", + "description": "InstanceType enum m5zn.3xlarge" + }, + { + "name": "M5zn6xlarge", + "value": "m5zn.6xlarge", + "description": "InstanceType enum m5zn.6xlarge" + }, + { + "name": "M5znLarge", + "value": "m5zn.large", + "description": "InstanceType enum m5zn.large" + }, + { + "name": "M5znMetal", + "value": "m5zn.metal", + "description": "InstanceType enum m5zn.metal" + }, + { + "name": "M5znXlarge", + "value": "m5zn.xlarge", + "description": "InstanceType enum m5zn.xlarge" + }, + { + "name": "M6a12xlarge", + "value": "m6a.12xlarge", + "description": "InstanceType enum m6a.12xlarge" + }, + { + "name": "M6a16xlarge", + "value": "m6a.16xlarge", + "description": "InstanceType enum m6a.16xlarge" + }, + { + "name": "M6a24xlarge", + "value": "m6a.24xlarge", + "description": "InstanceType enum m6a.24xlarge" + }, + { + "name": "M6a2xlarge", + "value": "m6a.2xlarge", + "description": "InstanceType enum m6a.2xlarge" + }, + { + "name": "M6a32xlarge", + "value": "m6a.32xlarge", + "description": "InstanceType enum m6a.32xlarge" + }, + { + "name": "M6a48xlarge", + "value": "m6a.48xlarge", + "description": "InstanceType enum m6a.48xlarge" + }, + { + "name": "M6a4xlarge", + "value": "m6a.4xlarge", + "description": "InstanceType enum m6a.4xlarge" + }, + { + "name": "M6a8xlarge", + "value": "m6a.8xlarge", + "description": "InstanceType enum m6a.8xlarge" + }, + { + "name": "M6aLarge", + "value": "m6a.large", + "description": "InstanceType enum m6a.large" + }, + { + "name": "M6aMetal", + "value": "m6a.metal", + "description": "InstanceType enum m6a.metal" + }, + { + "name": "M6aXlarge", + "value": "m6a.xlarge", + "description": "InstanceType enum m6a.xlarge" + }, + { + "name": "M6g12xlarge", + "value": "m6g.12xlarge", + "description": "InstanceType enum m6g.12xlarge" + }, + { + "name": "M6g16xlarge", + "value": "m6g.16xlarge", + "description": "InstanceType enum m6g.16xlarge" + }, + { + "name": "M6g2xlarge", + "value": "m6g.2xlarge", + "description": "InstanceType enum m6g.2xlarge" + }, + { + "name": "M6g4xlarge", + "value": "m6g.4xlarge", + "description": "InstanceType enum m6g.4xlarge" + }, + { + "name": "M6g8xlarge", + "value": "m6g.8xlarge", + "description": "InstanceType enum m6g.8xlarge" + }, + { + "name": "M6gLarge", + "value": "m6g.large", + "description": "InstanceType enum m6g.large" + }, + { + "name": "M6gMedium", + "value": "m6g.medium", + "description": "InstanceType enum m6g.medium" + }, + { + "name": "M6gMetal", + "value": "m6g.metal", + "description": "InstanceType enum m6g.metal" + }, + { + "name": "M6gXlarge", + "value": "m6g.xlarge", + "description": "InstanceType enum m6g.xlarge" + }, + { + "name": "M6gd12xlarge", + "value": "m6gd.12xlarge", + "description": "InstanceType enum m6gd.12xlarge" + }, + { + "name": "M6gd16xlarge", + "value": "m6gd.16xlarge", + "description": "InstanceType enum m6gd.16xlarge" + }, + { + "name": "M6gd2xlarge", + "value": "m6gd.2xlarge", + "description": "InstanceType enum m6gd.2xlarge" + }, + { + "name": "M6gd4xlarge", + "value": "m6gd.4xlarge", + "description": "InstanceType enum m6gd.4xlarge" + }, + { + "name": "M6gd8xlarge", + "value": "m6gd.8xlarge", + "description": "InstanceType enum m6gd.8xlarge" + }, + { + "name": "M6gdLarge", + "value": "m6gd.large", + "description": "InstanceType enum m6gd.large" + }, + { + "name": "M6gdMedium", + "value": "m6gd.medium", + "description": "InstanceType enum m6gd.medium" + }, + { + "name": "M6gdMetal", + "value": "m6gd.metal", + "description": "InstanceType enum m6gd.metal" + }, + { + "name": "M6gdXlarge", + "value": "m6gd.xlarge", + "description": "InstanceType enum m6gd.xlarge" + }, + { + "name": "M6i12xlarge", + "value": "m6i.12xlarge", + "description": "InstanceType enum m6i.12xlarge" + }, + { + "name": "M6i16xlarge", + "value": "m6i.16xlarge", + "description": "InstanceType enum m6i.16xlarge" + }, + { + "name": "M6i24xlarge", + "value": "m6i.24xlarge", + "description": "InstanceType enum m6i.24xlarge" + }, + { + "name": "M6i2xlarge", + "value": "m6i.2xlarge", + "description": "InstanceType enum m6i.2xlarge" + }, + { + "name": "M6i32xlarge", + "value": "m6i.32xlarge", + "description": "InstanceType enum m6i.32xlarge" + }, + { + "name": "M6i4xlarge", + "value": "m6i.4xlarge", + "description": "InstanceType enum m6i.4xlarge" + }, + { + "name": "M6i8xlarge", + "value": "m6i.8xlarge", + "description": "InstanceType enum m6i.8xlarge" + }, + { + "name": "M6iLarge", + "value": "m6i.large", + "description": "InstanceType enum m6i.large" + }, + { + "name": "M6iMetal", + "value": "m6i.metal", + "description": "InstanceType enum m6i.metal" + }, + { + "name": "M6iXlarge", + "value": "m6i.xlarge", + "description": "InstanceType enum m6i.xlarge" + }, + { + "name": "M6id12xlarge", + "value": "m6id.12xlarge", + "description": "InstanceType enum m6id.12xlarge" + }, + { + "name": "M6id16xlarge", + "value": "m6id.16xlarge", + "description": "InstanceType enum m6id.16xlarge" + }, + { + "name": "M6id24xlarge", + "value": "m6id.24xlarge", + "description": "InstanceType enum m6id.24xlarge" + }, + { + "name": "M6id2xlarge", + "value": "m6id.2xlarge", + "description": "InstanceType enum m6id.2xlarge" + }, + { + "name": "M6id32xlarge", + "value": "m6id.32xlarge", + "description": "InstanceType enum m6id.32xlarge" + }, + { + "name": "M6id4xlarge", + "value": "m6id.4xlarge", + "description": "InstanceType enum m6id.4xlarge" + }, + { + "name": "M6id8xlarge", + "value": "m6id.8xlarge", + "description": "InstanceType enum m6id.8xlarge" + }, + { + "name": "M6idLarge", + "value": "m6id.large", + "description": "InstanceType enum m6id.large" + }, + { + "name": "M6idMetal", + "value": "m6id.metal", + "description": "InstanceType enum m6id.metal" + }, + { + "name": "M6idXlarge", + "value": "m6id.xlarge", + "description": "InstanceType enum m6id.xlarge" + }, + { + "name": "M6idn12xlarge", + "value": "m6idn.12xlarge", + "description": "InstanceType enum m6idn.12xlarge" + }, + { + "name": "M6idn16xlarge", + "value": "m6idn.16xlarge", + "description": "InstanceType enum m6idn.16xlarge" + }, + { + "name": "M6idn24xlarge", + "value": "m6idn.24xlarge", + "description": "InstanceType enum m6idn.24xlarge" + }, + { + "name": "M6idn2xlarge", + "value": "m6idn.2xlarge", + "description": "InstanceType enum m6idn.2xlarge" + }, + { + "name": "M6idn32xlarge", + "value": "m6idn.32xlarge", + "description": "InstanceType enum m6idn.32xlarge" + }, + { + "name": "M6idn4xlarge", + "value": "m6idn.4xlarge", + "description": "InstanceType enum m6idn.4xlarge" + }, + { + "name": "M6idn8xlarge", + "value": "m6idn.8xlarge", + "description": "InstanceType enum m6idn.8xlarge" + }, + { + "name": "M6idnLarge", + "value": "m6idn.large", + "description": "InstanceType enum m6idn.large" + }, + { + "name": "M6idnMetal", + "value": "m6idn.metal", + "description": "InstanceType enum m6idn.metal" + }, + { + "name": "M6idnXlarge", + "value": "m6idn.xlarge", + "description": "InstanceType enum m6idn.xlarge" + }, + { + "name": "M6in12xlarge", + "value": "m6in.12xlarge", + "description": "InstanceType enum m6in.12xlarge" + }, + { + "name": "M6in16xlarge", + "value": "m6in.16xlarge", + "description": "InstanceType enum m6in.16xlarge" + }, + { + "name": "M6in24xlarge", + "value": "m6in.24xlarge", + "description": "InstanceType enum m6in.24xlarge" + }, + { + "name": "M6in2xlarge", + "value": "m6in.2xlarge", + "description": "InstanceType enum m6in.2xlarge" + }, + { + "name": "M6in32xlarge", + "value": "m6in.32xlarge", + "description": "InstanceType enum m6in.32xlarge" + }, + { + "name": "M6in4xlarge", + "value": "m6in.4xlarge", + "description": "InstanceType enum m6in.4xlarge" + }, + { + "name": "M6in8xlarge", + "value": "m6in.8xlarge", + "description": "InstanceType enum m6in.8xlarge" + }, + { + "name": "M6inLarge", + "value": "m6in.large", + "description": "InstanceType enum m6in.large" + }, + { + "name": "M6inMetal", + "value": "m6in.metal", + "description": "InstanceType enum m6in.metal" + }, + { + "name": "M6inXlarge", + "value": "m6in.xlarge", + "description": "InstanceType enum m6in.xlarge" + }, + { + "name": "M7a12xlarge", + "value": "m7a.12xlarge", + "description": "InstanceType enum m7a.12xlarge" + }, + { + "name": "M7a16xlarge", + "value": "m7a.16xlarge", + "description": "InstanceType enum m7a.16xlarge" + }, + { + "name": "M7a24xlarge", + "value": "m7a.24xlarge", + "description": "InstanceType enum m7a.24xlarge" + }, + { + "name": "M7a2xlarge", + "value": "m7a.2xlarge", + "description": "InstanceType enum m7a.2xlarge" + }, + { + "name": "M7a32xlarge", + "value": "m7a.32xlarge", + "description": "InstanceType enum m7a.32xlarge" + }, + { + "name": "M7a48xlarge", + "value": "m7a.48xlarge", + "description": "InstanceType enum m7a.48xlarge" + }, + { + "name": "M7a4xlarge", + "value": "m7a.4xlarge", + "description": "InstanceType enum m7a.4xlarge" + }, + { + "name": "M7a8xlarge", + "value": "m7a.8xlarge", + "description": "InstanceType enum m7a.8xlarge" + }, + { + "name": "M7aLarge", + "value": "m7a.large", + "description": "InstanceType enum m7a.large" + }, + { + "name": "M7aMedium", + "value": "m7a.medium", + "description": "InstanceType enum m7a.medium" + }, + { + "name": "M7aMetal48xl", + "value": "m7a.metal-48xl", + "description": "InstanceType enum m7a.metal-48xl" + }, + { + "name": "M7aXlarge", + "value": "m7a.xlarge", + "description": "InstanceType enum m7a.xlarge" + }, + { + "name": "M7g12xlarge", + "value": "m7g.12xlarge", + "description": "InstanceType enum m7g.12xlarge" + }, + { + "name": "M7g16xlarge", + "value": "m7g.16xlarge", + "description": "InstanceType enum m7g.16xlarge" + }, + { + "name": "M7g2xlarge", + "value": "m7g.2xlarge", + "description": "InstanceType enum m7g.2xlarge" + }, + { + "name": "M7g4xlarge", + "value": "m7g.4xlarge", + "description": "InstanceType enum m7g.4xlarge" + }, + { + "name": "M7g8xlarge", + "value": "m7g.8xlarge", + "description": "InstanceType enum m7g.8xlarge" + }, + { + "name": "M7gLarge", + "value": "m7g.large", + "description": "InstanceType enum m7g.large" + }, + { + "name": "M7gMedium", + "value": "m7g.medium", + "description": "InstanceType enum m7g.medium" + }, + { + "name": "M7gMetal", + "value": "m7g.metal", + "description": "InstanceType enum m7g.metal" + }, + { + "name": "M7gXlarge", + "value": "m7g.xlarge", + "description": "InstanceType enum m7g.xlarge" + }, + { + "name": "M7gd12xlarge", + "value": "m7gd.12xlarge", + "description": "InstanceType enum m7gd.12xlarge" + }, + { + "name": "M7gd16xlarge", + "value": "m7gd.16xlarge", + "description": "InstanceType enum m7gd.16xlarge" + }, + { + "name": "M7gd2xlarge", + "value": "m7gd.2xlarge", + "description": "InstanceType enum m7gd.2xlarge" + }, + { + "name": "M7gd4xlarge", + "value": "m7gd.4xlarge", + "description": "InstanceType enum m7gd.4xlarge" + }, + { + "name": "M7gd8xlarge", + "value": "m7gd.8xlarge", + "description": "InstanceType enum m7gd.8xlarge" + }, + { + "name": "M7gdLarge", + "value": "m7gd.large", + "description": "InstanceType enum m7gd.large" + }, + { + "name": "M7gdMedium", + "value": "m7gd.medium", + "description": "InstanceType enum m7gd.medium" + }, + { + "name": "M7gdMetal", + "value": "m7gd.metal", + "description": "InstanceType enum m7gd.metal" + }, + { + "name": "M7gdXlarge", + "value": "m7gd.xlarge", + "description": "InstanceType enum m7gd.xlarge" + }, + { + "name": "M7iFlex2xlarge", + "value": "m7i-flex.2xlarge", + "description": "InstanceType enum m7i-flex.2xlarge" + }, + { + "name": "M7iFlex4xlarge", + "value": "m7i-flex.4xlarge", + "description": "InstanceType enum m7i-flex.4xlarge" + }, + { + "name": "M7iFlex8xlarge", + "value": "m7i-flex.8xlarge", + "description": "InstanceType enum m7i-flex.8xlarge" + }, + { + "name": "M7iFlexLarge", + "value": "m7i-flex.large", + "description": "InstanceType enum m7i-flex.large" + }, + { + "name": "M7iFlexXlarge", + "value": "m7i-flex.xlarge", + "description": "InstanceType enum m7i-flex.xlarge" + }, + { + "name": "M7i12xlarge", + "value": "m7i.12xlarge", + "description": "InstanceType enum m7i.12xlarge" + }, + { + "name": "M7i16xlarge", + "value": "m7i.16xlarge", + "description": "InstanceType enum m7i.16xlarge" + }, + { + "name": "M7i24xlarge", + "value": "m7i.24xlarge", + "description": "InstanceType enum m7i.24xlarge" + }, + { + "name": "M7i2xlarge", + "value": "m7i.2xlarge", + "description": "InstanceType enum m7i.2xlarge" + }, + { + "name": "M7i48xlarge", + "value": "m7i.48xlarge", + "description": "InstanceType enum m7i.48xlarge" + }, + { + "name": "M7i4xlarge", + "value": "m7i.4xlarge", + "description": "InstanceType enum m7i.4xlarge" + }, + { + "name": "M7i8xlarge", + "value": "m7i.8xlarge", + "description": "InstanceType enum m7i.8xlarge" + }, + { + "name": "M7iLarge", + "value": "m7i.large", + "description": "InstanceType enum m7i.large" + }, + { + "name": "M7iMetal24xl", + "value": "m7i.metal-24xl", + "description": "InstanceType enum m7i.metal-24xl" + }, + { + "name": "M7iMetal48xl", + "value": "m7i.metal-48xl", + "description": "InstanceType enum m7i.metal-48xl" + }, + { + "name": "M7iXlarge", + "value": "m7i.xlarge", + "description": "InstanceType enum m7i.xlarge" + }, + { + "name": "Mac1Metal", + "value": "mac1.metal", + "description": "InstanceType enum mac1.metal" + }, + { + "name": "Mac2M2Metal", + "value": "mac2-m2.metal", + "description": "InstanceType enum mac2-m2.metal" + }, + { + "name": "Mac2M2proMetal", + "value": "mac2-m2pro.metal", + "description": "InstanceType enum mac2-m2pro.metal" + }, + { + "name": "Mac2Metal", + "value": "mac2.metal", + "description": "InstanceType enum mac2.metal" + }, + { + "name": "P216xlarge", + "value": "p2.16xlarge", + "description": "InstanceType enum p2.16xlarge" + }, + { + "name": "P28xlarge", + "value": "p2.8xlarge", + "description": "InstanceType enum p2.8xlarge" + }, + { + "name": "P2Xlarge", + "value": "p2.xlarge", + "description": "InstanceType enum p2.xlarge" + }, + { + "name": "P316xlarge", + "value": "p3.16xlarge", + "description": "InstanceType enum p3.16xlarge" + }, + { + "name": "P32xlarge", + "value": "p3.2xlarge", + "description": "InstanceType enum p3.2xlarge" + }, + { + "name": "P38xlarge", + "value": "p3.8xlarge", + "description": "InstanceType enum p3.8xlarge" + }, + { + "name": "P3dn24xlarge", + "value": "p3dn.24xlarge", + "description": "InstanceType enum p3dn.24xlarge" + }, + { + "name": "P4d24xlarge", + "value": "p4d.24xlarge", + "description": "InstanceType enum p4d.24xlarge" + }, + { + "name": "P4de24xlarge", + "value": "p4de.24xlarge", + "description": "InstanceType enum p4de.24xlarge" + }, + { + "name": "P548xlarge", + "value": "p5.48xlarge", + "description": "InstanceType enum p5.48xlarge" + }, + { + "name": "R32xlarge", + "value": "r3.2xlarge", + "description": "InstanceType enum r3.2xlarge" + }, + { + "name": "R34xlarge", + "value": "r3.4xlarge", + "description": "InstanceType enum r3.4xlarge" + }, + { + "name": "R38xlarge", + "value": "r3.8xlarge", + "description": "InstanceType enum r3.8xlarge" + }, + { + "name": "R3Large", + "value": "r3.large", + "description": "InstanceType enum r3.large" + }, + { + "name": "R3Xlarge", + "value": "r3.xlarge", + "description": "InstanceType enum r3.xlarge" + }, + { + "name": "R416xlarge", + "value": "r4.16xlarge", + "description": "InstanceType enum r4.16xlarge" + }, + { + "name": "R42xlarge", + "value": "r4.2xlarge", + "description": "InstanceType enum r4.2xlarge" + }, + { + "name": "R44xlarge", + "value": "r4.4xlarge", + "description": "InstanceType enum r4.4xlarge" + }, + { + "name": "R48xlarge", + "value": "r4.8xlarge", + "description": "InstanceType enum r4.8xlarge" + }, + { + "name": "R4Large", + "value": "r4.large", + "description": "InstanceType enum r4.large" + }, + { + "name": "R4Xlarge", + "value": "r4.xlarge", + "description": "InstanceType enum r4.xlarge" + }, + { + "name": "R512xlarge", + "value": "r5.12xlarge", + "description": "InstanceType enum r5.12xlarge" + }, + { + "name": "R516xlarge", + "value": "r5.16xlarge", + "description": "InstanceType enum r5.16xlarge" + }, + { + "name": "R524xlarge", + "value": "r5.24xlarge", + "description": "InstanceType enum r5.24xlarge" + }, + { + "name": "R52xlarge", + "value": "r5.2xlarge", + "description": "InstanceType enum r5.2xlarge" + }, + { + "name": "R54xlarge", + "value": "r5.4xlarge", + "description": "InstanceType enum r5.4xlarge" + }, + { + "name": "R58xlarge", + "value": "r5.8xlarge", + "description": "InstanceType enum r5.8xlarge" + }, + { + "name": "R5Large", + "value": "r5.large", + "description": "InstanceType enum r5.large" + }, + { + "name": "R5Metal", + "value": "r5.metal", + "description": "InstanceType enum r5.metal" + }, + { + "name": "R5Xlarge", + "value": "r5.xlarge", + "description": "InstanceType enum r5.xlarge" + }, + { + "name": "R5a12xlarge", + "value": "r5a.12xlarge", + "description": "InstanceType enum r5a.12xlarge" + }, + { + "name": "R5a16xlarge", + "value": "r5a.16xlarge", + "description": "InstanceType enum r5a.16xlarge" + }, + { + "name": "R5a24xlarge", + "value": "r5a.24xlarge", + "description": "InstanceType enum r5a.24xlarge" + }, + { + "name": "R5a2xlarge", + "value": "r5a.2xlarge", + "description": "InstanceType enum r5a.2xlarge" + }, + { + "name": "R5a4xlarge", + "value": "r5a.4xlarge", + "description": "InstanceType enum r5a.4xlarge" + }, + { + "name": "R5a8xlarge", + "value": "r5a.8xlarge", + "description": "InstanceType enum r5a.8xlarge" + }, + { + "name": "R5aLarge", + "value": "r5a.large", + "description": "InstanceType enum r5a.large" + }, + { + "name": "R5aXlarge", + "value": "r5a.xlarge", + "description": "InstanceType enum r5a.xlarge" + }, + { + "name": "R5ad12xlarge", + "value": "r5ad.12xlarge", + "description": "InstanceType enum r5ad.12xlarge" + }, + { + "name": "R5ad16xlarge", + "value": "r5ad.16xlarge", + "description": "InstanceType enum r5ad.16xlarge" + }, + { + "name": "R5ad24xlarge", + "value": "r5ad.24xlarge", + "description": "InstanceType enum r5ad.24xlarge" + }, + { + "name": "R5ad2xlarge", + "value": "r5ad.2xlarge", + "description": "InstanceType enum r5ad.2xlarge" + }, + { + "name": "R5ad4xlarge", + "value": "r5ad.4xlarge", + "description": "InstanceType enum r5ad.4xlarge" + }, + { + "name": "R5ad8xlarge", + "value": "r5ad.8xlarge", + "description": "InstanceType enum r5ad.8xlarge" + }, + { + "name": "R5adLarge", + "value": "r5ad.large", + "description": "InstanceType enum r5ad.large" + }, + { + "name": "R5adXlarge", + "value": "r5ad.xlarge", + "description": "InstanceType enum r5ad.xlarge" + }, + { + "name": "R5b12xlarge", + "value": "r5b.12xlarge", + "description": "InstanceType enum r5b.12xlarge" + }, + { + "name": "R5b16xlarge", + "value": "r5b.16xlarge", + "description": "InstanceType enum r5b.16xlarge" + }, + { + "name": "R5b24xlarge", + "value": "r5b.24xlarge", + "description": "InstanceType enum r5b.24xlarge" + }, + { + "name": "R5b2xlarge", + "value": "r5b.2xlarge", + "description": "InstanceType enum r5b.2xlarge" + }, + { + "name": "R5b4xlarge", + "value": "r5b.4xlarge", + "description": "InstanceType enum r5b.4xlarge" + }, + { + "name": "R5b8xlarge", + "value": "r5b.8xlarge", + "description": "InstanceType enum r5b.8xlarge" + }, + { + "name": "R5bLarge", + "value": "r5b.large", + "description": "InstanceType enum r5b.large" + }, + { + "name": "R5bMetal", + "value": "r5b.metal", + "description": "InstanceType enum r5b.metal" + }, + { + "name": "R5bXlarge", + "value": "r5b.xlarge", + "description": "InstanceType enum r5b.xlarge" + }, + { + "name": "R5d12xlarge", + "value": "r5d.12xlarge", + "description": "InstanceType enum r5d.12xlarge" + }, + { + "name": "R5d16xlarge", + "value": "r5d.16xlarge", + "description": "InstanceType enum r5d.16xlarge" + }, + { + "name": "R5d24xlarge", + "value": "r5d.24xlarge", + "description": "InstanceType enum r5d.24xlarge" + }, + { + "name": "R5d2xlarge", + "value": "r5d.2xlarge", + "description": "InstanceType enum r5d.2xlarge" + }, + { + "name": "R5d4xlarge", + "value": "r5d.4xlarge", + "description": "InstanceType enum r5d.4xlarge" + }, + { + "name": "R5d8xlarge", + "value": "r5d.8xlarge", + "description": "InstanceType enum r5d.8xlarge" + }, + { + "name": "R5dLarge", + "value": "r5d.large", + "description": "InstanceType enum r5d.large" + }, + { + "name": "R5dMetal", + "value": "r5d.metal", + "description": "InstanceType enum r5d.metal" + }, + { + "name": "R5dXlarge", + "value": "r5d.xlarge", + "description": "InstanceType enum r5d.xlarge" + }, + { + "name": "R5dn12xlarge", + "value": "r5dn.12xlarge", + "description": "InstanceType enum r5dn.12xlarge" + }, + { + "name": "R5dn16xlarge", + "value": "r5dn.16xlarge", + "description": "InstanceType enum r5dn.16xlarge" + }, + { + "name": "R5dn24xlarge", + "value": "r5dn.24xlarge", + "description": "InstanceType enum r5dn.24xlarge" + }, + { + "name": "R5dn2xlarge", + "value": "r5dn.2xlarge", + "description": "InstanceType enum r5dn.2xlarge" + }, + { + "name": "R5dn4xlarge", + "value": "r5dn.4xlarge", + "description": "InstanceType enum r5dn.4xlarge" + }, + { + "name": "R5dn8xlarge", + "value": "r5dn.8xlarge", + "description": "InstanceType enum r5dn.8xlarge" + }, + { + "name": "R5dnLarge", + "value": "r5dn.large", + "description": "InstanceType enum r5dn.large" + }, + { + "name": "R5dnMetal", + "value": "r5dn.metal", + "description": "InstanceType enum r5dn.metal" + }, + { + "name": "R5dnXlarge", + "value": "r5dn.xlarge", + "description": "InstanceType enum r5dn.xlarge" + }, + { + "name": "R5n12xlarge", + "value": "r5n.12xlarge", + "description": "InstanceType enum r5n.12xlarge" + }, + { + "name": "R5n16xlarge", + "value": "r5n.16xlarge", + "description": "InstanceType enum r5n.16xlarge" + }, + { + "name": "R5n24xlarge", + "value": "r5n.24xlarge", + "description": "InstanceType enum r5n.24xlarge" + }, + { + "name": "R5n2xlarge", + "value": "r5n.2xlarge", + "description": "InstanceType enum r5n.2xlarge" + }, + { + "name": "R5n4xlarge", + "value": "r5n.4xlarge", + "description": "InstanceType enum r5n.4xlarge" + }, + { + "name": "R5n8xlarge", + "value": "r5n.8xlarge", + "description": "InstanceType enum r5n.8xlarge" + }, + { + "name": "R5nLarge", + "value": "r5n.large", + "description": "InstanceType enum r5n.large" + }, + { + "name": "R5nMetal", + "value": "r5n.metal", + "description": "InstanceType enum r5n.metal" + }, + { + "name": "R5nXlarge", + "value": "r5n.xlarge", + "description": "InstanceType enum r5n.xlarge" + }, + { + "name": "R6a12xlarge", + "value": "r6a.12xlarge", + "description": "InstanceType enum r6a.12xlarge" + }, + { + "name": "R6a16xlarge", + "value": "r6a.16xlarge", + "description": "InstanceType enum r6a.16xlarge" + }, + { + "name": "R6a24xlarge", + "value": "r6a.24xlarge", + "description": "InstanceType enum r6a.24xlarge" + }, + { + "name": "R6a2xlarge", + "value": "r6a.2xlarge", + "description": "InstanceType enum r6a.2xlarge" + }, + { + "name": "R6a32xlarge", + "value": "r6a.32xlarge", + "description": "InstanceType enum r6a.32xlarge" + }, + { + "name": "R6a48xlarge", + "value": "r6a.48xlarge", + "description": "InstanceType enum r6a.48xlarge" + }, + { + "name": "R6a4xlarge", + "value": "r6a.4xlarge", + "description": "InstanceType enum r6a.4xlarge" + }, + { + "name": "R6a8xlarge", + "value": "r6a.8xlarge", + "description": "InstanceType enum r6a.8xlarge" + }, + { + "name": "R6aLarge", + "value": "r6a.large", + "description": "InstanceType enum r6a.large" + }, + { + "name": "R6aMetal", + "value": "r6a.metal", + "description": "InstanceType enum r6a.metal" + }, + { + "name": "R6aXlarge", + "value": "r6a.xlarge", + "description": "InstanceType enum r6a.xlarge" + }, + { + "name": "R6g12xlarge", + "value": "r6g.12xlarge", + "description": "InstanceType enum r6g.12xlarge" + }, + { + "name": "R6g16xlarge", + "value": "r6g.16xlarge", + "description": "InstanceType enum r6g.16xlarge" + }, + { + "name": "R6g2xlarge", + "value": "r6g.2xlarge", + "description": "InstanceType enum r6g.2xlarge" + }, + { + "name": "R6g4xlarge", + "value": "r6g.4xlarge", + "description": "InstanceType enum r6g.4xlarge" + }, + { + "name": "R6g8xlarge", + "value": "r6g.8xlarge", + "description": "InstanceType enum r6g.8xlarge" + }, + { + "name": "R6gLarge", + "value": "r6g.large", + "description": "InstanceType enum r6g.large" + }, + { + "name": "R6gMedium", + "value": "r6g.medium", + "description": "InstanceType enum r6g.medium" + }, + { + "name": "R6gMetal", + "value": "r6g.metal", + "description": "InstanceType enum r6g.metal" + }, + { + "name": "R6gXlarge", + "value": "r6g.xlarge", + "description": "InstanceType enum r6g.xlarge" + }, + { + "name": "R6gd12xlarge", + "value": "r6gd.12xlarge", + "description": "InstanceType enum r6gd.12xlarge" + }, + { + "name": "R6gd16xlarge", + "value": "r6gd.16xlarge", + "description": "InstanceType enum r6gd.16xlarge" + }, + { + "name": "R6gd2xlarge", + "value": "r6gd.2xlarge", + "description": "InstanceType enum r6gd.2xlarge" + }, + { + "name": "R6gd4xlarge", + "value": "r6gd.4xlarge", + "description": "InstanceType enum r6gd.4xlarge" + }, + { + "name": "R6gd8xlarge", + "value": "r6gd.8xlarge", + "description": "InstanceType enum r6gd.8xlarge" + }, + { + "name": "R6gdLarge", + "value": "r6gd.large", + "description": "InstanceType enum r6gd.large" + }, + { + "name": "R6gdMedium", + "value": "r6gd.medium", + "description": "InstanceType enum r6gd.medium" + }, + { + "name": "R6gdMetal", + "value": "r6gd.metal", + "description": "InstanceType enum r6gd.metal" + }, + { + "name": "R6gdXlarge", + "value": "r6gd.xlarge", + "description": "InstanceType enum r6gd.xlarge" + }, + { + "name": "R6i12xlarge", + "value": "r6i.12xlarge", + "description": "InstanceType enum r6i.12xlarge" + }, + { + "name": "R6i16xlarge", + "value": "r6i.16xlarge", + "description": "InstanceType enum r6i.16xlarge" + }, + { + "name": "R6i24xlarge", + "value": "r6i.24xlarge", + "description": "InstanceType enum r6i.24xlarge" + }, + { + "name": "R6i2xlarge", + "value": "r6i.2xlarge", + "description": "InstanceType enum r6i.2xlarge" + }, + { + "name": "R6i32xlarge", + "value": "r6i.32xlarge", + "description": "InstanceType enum r6i.32xlarge" + }, + { + "name": "R6i4xlarge", + "value": "r6i.4xlarge", + "description": "InstanceType enum r6i.4xlarge" + }, + { + "name": "R6i8xlarge", + "value": "r6i.8xlarge", + "description": "InstanceType enum r6i.8xlarge" + }, + { + "name": "R6iLarge", + "value": "r6i.large", + "description": "InstanceType enum r6i.large" + }, + { + "name": "R6iMetal", + "value": "r6i.metal", + "description": "InstanceType enum r6i.metal" + }, + { + "name": "R6iXlarge", + "value": "r6i.xlarge", + "description": "InstanceType enum r6i.xlarge" + }, + { + "name": "R6id12xlarge", + "value": "r6id.12xlarge", + "description": "InstanceType enum r6id.12xlarge" + }, + { + "name": "R6id16xlarge", + "value": "r6id.16xlarge", + "description": "InstanceType enum r6id.16xlarge" + }, + { + "name": "R6id24xlarge", + "value": "r6id.24xlarge", + "description": "InstanceType enum r6id.24xlarge" + }, + { + "name": "R6id2xlarge", + "value": "r6id.2xlarge", + "description": "InstanceType enum r6id.2xlarge" + }, + { + "name": "R6id32xlarge", + "value": "r6id.32xlarge", + "description": "InstanceType enum r6id.32xlarge" + }, + { + "name": "R6id4xlarge", + "value": "r6id.4xlarge", + "description": "InstanceType enum r6id.4xlarge" + }, + { + "name": "R6id8xlarge", + "value": "r6id.8xlarge", + "description": "InstanceType enum r6id.8xlarge" + }, + { + "name": "R6idLarge", + "value": "r6id.large", + "description": "InstanceType enum r6id.large" + }, + { + "name": "R6idMetal", + "value": "r6id.metal", + "description": "InstanceType enum r6id.metal" + }, + { + "name": "R6idXlarge", + "value": "r6id.xlarge", + "description": "InstanceType enum r6id.xlarge" + }, + { + "name": "R6idn12xlarge", + "value": "r6idn.12xlarge", + "description": "InstanceType enum r6idn.12xlarge" + }, + { + "name": "R6idn16xlarge", + "value": "r6idn.16xlarge", + "description": "InstanceType enum r6idn.16xlarge" + }, + { + "name": "R6idn24xlarge", + "value": "r6idn.24xlarge", + "description": "InstanceType enum r6idn.24xlarge" + }, + { + "name": "R6idn2xlarge", + "value": "r6idn.2xlarge", + "description": "InstanceType enum r6idn.2xlarge" + }, + { + "name": "R6idn32xlarge", + "value": "r6idn.32xlarge", + "description": "InstanceType enum r6idn.32xlarge" + }, + { + "name": "R6idn4xlarge", + "value": "r6idn.4xlarge", + "description": "InstanceType enum r6idn.4xlarge" + }, + { + "name": "R6idn8xlarge", + "value": "r6idn.8xlarge", + "description": "InstanceType enum r6idn.8xlarge" + }, + { + "name": "R6idnLarge", + "value": "r6idn.large", + "description": "InstanceType enum r6idn.large" + }, + { + "name": "R6idnMetal", + "value": "r6idn.metal", + "description": "InstanceType enum r6idn.metal" + }, + { + "name": "R6idnXlarge", + "value": "r6idn.xlarge", + "description": "InstanceType enum r6idn.xlarge" + }, + { + "name": "R6in12xlarge", + "value": "r6in.12xlarge", + "description": "InstanceType enum r6in.12xlarge" + }, + { + "name": "R6in16xlarge", + "value": "r6in.16xlarge", + "description": "InstanceType enum r6in.16xlarge" + }, + { + "name": "R6in24xlarge", + "value": "r6in.24xlarge", + "description": "InstanceType enum r6in.24xlarge" + }, + { + "name": "R6in2xlarge", + "value": "r6in.2xlarge", + "description": "InstanceType enum r6in.2xlarge" + }, + { + "name": "R6in32xlarge", + "value": "r6in.32xlarge", + "description": "InstanceType enum r6in.32xlarge" + }, + { + "name": "R6in4xlarge", + "value": "r6in.4xlarge", + "description": "InstanceType enum r6in.4xlarge" + }, + { + "name": "R6in8xlarge", + "value": "r6in.8xlarge", + "description": "InstanceType enum r6in.8xlarge" + }, + { + "name": "R6inLarge", + "value": "r6in.large", + "description": "InstanceType enum r6in.large" + }, + { + "name": "R6inMetal", + "value": "r6in.metal", + "description": "InstanceType enum r6in.metal" + }, + { + "name": "R6inXlarge", + "value": "r6in.xlarge", + "description": "InstanceType enum r6in.xlarge" + }, + { + "name": "R7a12xlarge", + "value": "r7a.12xlarge", + "description": "InstanceType enum r7a.12xlarge" + }, + { + "name": "R7a16xlarge", + "value": "r7a.16xlarge", + "description": "InstanceType enum r7a.16xlarge" + }, + { + "name": "R7a24xlarge", + "value": "r7a.24xlarge", + "description": "InstanceType enum r7a.24xlarge" + }, + { + "name": "R7a2xlarge", + "value": "r7a.2xlarge", + "description": "InstanceType enum r7a.2xlarge" + }, + { + "name": "R7a32xlarge", + "value": "r7a.32xlarge", + "description": "InstanceType enum r7a.32xlarge" + }, + { + "name": "R7a48xlarge", + "value": "r7a.48xlarge", + "description": "InstanceType enum r7a.48xlarge" + }, + { + "name": "R7a4xlarge", + "value": "r7a.4xlarge", + "description": "InstanceType enum r7a.4xlarge" + }, + { + "name": "R7a8xlarge", + "value": "r7a.8xlarge", + "description": "InstanceType enum r7a.8xlarge" + }, + { + "name": "R7aLarge", + "value": "r7a.large", + "description": "InstanceType enum r7a.large" + }, + { + "name": "R7aMedium", + "value": "r7a.medium", + "description": "InstanceType enum r7a.medium" + }, + { + "name": "R7aMetal48xl", + "value": "r7a.metal-48xl", + "description": "InstanceType enum r7a.metal-48xl" + }, + { + "name": "R7aXlarge", + "value": "r7a.xlarge", + "description": "InstanceType enum r7a.xlarge" + }, + { + "name": "R7g12xlarge", + "value": "r7g.12xlarge", + "description": "InstanceType enum r7g.12xlarge" + }, + { + "name": "R7g16xlarge", + "value": "r7g.16xlarge", + "description": "InstanceType enum r7g.16xlarge" + }, + { + "name": "R7g2xlarge", + "value": "r7g.2xlarge", + "description": "InstanceType enum r7g.2xlarge" + }, + { + "name": "R7g4xlarge", + "value": "r7g.4xlarge", + "description": "InstanceType enum r7g.4xlarge" + }, + { + "name": "R7g8xlarge", + "value": "r7g.8xlarge", + "description": "InstanceType enum r7g.8xlarge" + }, + { + "name": "R7gLarge", + "value": "r7g.large", + "description": "InstanceType enum r7g.large" + }, + { + "name": "R7gMedium", + "value": "r7g.medium", + "description": "InstanceType enum r7g.medium" + }, + { + "name": "R7gMetal", + "value": "r7g.metal", + "description": "InstanceType enum r7g.metal" + }, + { + "name": "R7gXlarge", + "value": "r7g.xlarge", + "description": "InstanceType enum r7g.xlarge" + }, + { + "name": "R7gd12xlarge", + "value": "r7gd.12xlarge", + "description": "InstanceType enum r7gd.12xlarge" + }, + { + "name": "R7gd16xlarge", + "value": "r7gd.16xlarge", + "description": "InstanceType enum r7gd.16xlarge" + }, + { + "name": "R7gd2xlarge", + "value": "r7gd.2xlarge", + "description": "InstanceType enum r7gd.2xlarge" + }, + { + "name": "R7gd4xlarge", + "value": "r7gd.4xlarge", + "description": "InstanceType enum r7gd.4xlarge" + }, + { + "name": "R7gd8xlarge", + "value": "r7gd.8xlarge", + "description": "InstanceType enum r7gd.8xlarge" + }, + { + "name": "R7gdLarge", + "value": "r7gd.large", + "description": "InstanceType enum r7gd.large" + }, + { + "name": "R7gdMedium", + "value": "r7gd.medium", + "description": "InstanceType enum r7gd.medium" + }, + { + "name": "R7gdMetal", + "value": "r7gd.metal", + "description": "InstanceType enum r7gd.metal" + }, + { + "name": "R7gdXlarge", + "value": "r7gd.xlarge", + "description": "InstanceType enum r7gd.xlarge" + }, + { + "name": "R7i12xlarge", + "value": "r7i.12xlarge", + "description": "InstanceType enum r7i.12xlarge" + }, + { + "name": "R7i16xlarge", + "value": "r7i.16xlarge", + "description": "InstanceType enum r7i.16xlarge" + }, + { + "name": "R7i24xlarge", + "value": "r7i.24xlarge", + "description": "InstanceType enum r7i.24xlarge" + }, + { + "name": "R7i2xlarge", + "value": "r7i.2xlarge", + "description": "InstanceType enum r7i.2xlarge" + }, + { + "name": "R7i48xlarge", + "value": "r7i.48xlarge", + "description": "InstanceType enum r7i.48xlarge" + }, + { + "name": "R7i4xlarge", + "value": "r7i.4xlarge", + "description": "InstanceType enum r7i.4xlarge" + }, + { + "name": "R7i8xlarge", + "value": "r7i.8xlarge", + "description": "InstanceType enum r7i.8xlarge" + }, + { + "name": "R7iLarge", + "value": "r7i.large", + "description": "InstanceType enum r7i.large" + }, + { + "name": "R7iMetal24xl", + "value": "r7i.metal-24xl", + "description": "InstanceType enum r7i.metal-24xl" + }, + { + "name": "R7iMetal48xl", + "value": "r7i.metal-48xl", + "description": "InstanceType enum r7i.metal-48xl" + }, + { + "name": "R7iXlarge", + "value": "r7i.xlarge", + "description": "InstanceType enum r7i.xlarge" + }, + { + "name": "R7iz12xlarge", + "value": "r7iz.12xlarge", + "description": "InstanceType enum r7iz.12xlarge" + }, + { + "name": "R7iz16xlarge", + "value": "r7iz.16xlarge", + "description": "InstanceType enum r7iz.16xlarge" + }, + { + "name": "R7iz2xlarge", + "value": "r7iz.2xlarge", + "description": "InstanceType enum r7iz.2xlarge" + }, + { + "name": "R7iz32xlarge", + "value": "r7iz.32xlarge", + "description": "InstanceType enum r7iz.32xlarge" + }, + { + "name": "R7iz4xlarge", + "value": "r7iz.4xlarge", + "description": "InstanceType enum r7iz.4xlarge" + }, + { + "name": "R7iz8xlarge", + "value": "r7iz.8xlarge", + "description": "InstanceType enum r7iz.8xlarge" + }, + { + "name": "R7izLarge", + "value": "r7iz.large", + "description": "InstanceType enum r7iz.large" + }, + { + "name": "R7izMetal16xl", + "value": "r7iz.metal-16xl", + "description": "InstanceType enum r7iz.metal-16xl" + }, + { + "name": "R7izMetal32xl", + "value": "r7iz.metal-32xl", + "description": "InstanceType enum r7iz.metal-32xl" + }, + { + "name": "R7izXlarge", + "value": "r7iz.xlarge", + "description": "InstanceType enum r7iz.xlarge" + }, + { + "name": "T1Micro", + "value": "t1.micro", + "description": "InstanceType enum t1.micro" + }, + { + "name": "T22xlarge", + "value": "t2.2xlarge", + "description": "InstanceType enum t2.2xlarge" + }, + { + "name": "T2Large", + "value": "t2.large", + "description": "InstanceType enum t2.large" + }, + { + "name": "T2Medium", + "value": "t2.medium", + "description": "InstanceType enum t2.medium" + }, + { + "name": "T2Micro", + "value": "t2.micro", + "description": "InstanceType enum t2.micro" + }, + { + "name": "T2Nano", + "value": "t2.nano", + "description": "InstanceType enum t2.nano" + }, + { + "name": "T2Small", + "value": "t2.small", + "description": "InstanceType enum t2.small" + }, + { + "name": "T2Xlarge", + "value": "t2.xlarge", + "description": "InstanceType enum t2.xlarge" + }, + { + "name": "T32xlarge", + "value": "t3.2xlarge", + "description": "InstanceType enum t3.2xlarge" + }, + { + "name": "T3Large", + "value": "t3.large", + "description": "InstanceType enum t3.large" + }, + { + "name": "T3Medium", + "value": "t3.medium", + "description": "InstanceType enum t3.medium" + }, + { + "name": "T3Micro", + "value": "t3.micro", + "description": "InstanceType enum t3.micro" + }, + { + "name": "T3Nano", + "value": "t3.nano", + "description": "InstanceType enum t3.nano" + }, + { + "name": "T3Small", + "value": "t3.small", + "description": "InstanceType enum t3.small" + }, + { + "name": "T3Xlarge", + "value": "t3.xlarge", + "description": "InstanceType enum t3.xlarge" + }, + { + "name": "T3a2xlarge", + "value": "t3a.2xlarge", + "description": "InstanceType enum t3a.2xlarge" + }, + { + "name": "T3aLarge", + "value": "t3a.large", + "description": "InstanceType enum t3a.large" + }, + { + "name": "T3aMedium", + "value": "t3a.medium", + "description": "InstanceType enum t3a.medium" + }, + { + "name": "T3aMicro", + "value": "t3a.micro", + "description": "InstanceType enum t3a.micro" + }, + { + "name": "T3aNano", + "value": "t3a.nano", + "description": "InstanceType enum t3a.nano" + }, + { + "name": "T3aSmall", + "value": "t3a.small", + "description": "InstanceType enum t3a.small" + }, + { + "name": "T3aXlarge", + "value": "t3a.xlarge", + "description": "InstanceType enum t3a.xlarge" + }, + { + "name": "T4g2xlarge", + "value": "t4g.2xlarge", + "description": "InstanceType enum t4g.2xlarge" + }, + { + "name": "T4gLarge", + "value": "t4g.large", + "description": "InstanceType enum t4g.large" + }, + { + "name": "T4gMedium", + "value": "t4g.medium", + "description": "InstanceType enum t4g.medium" + }, + { + "name": "T4gMicro", + "value": "t4g.micro", + "description": "InstanceType enum t4g.micro" + }, + { + "name": "T4gNano", + "value": "t4g.nano", + "description": "InstanceType enum t4g.nano" + }, + { + "name": "T4gSmall", + "value": "t4g.small", + "description": "InstanceType enum t4g.small" + }, + { + "name": "T4gXlarge", + "value": "t4g.xlarge", + "description": "InstanceType enum t4g.xlarge" + }, + { + "name": "Trn12xlarge", + "value": "trn1.2xlarge", + "description": "InstanceType enum trn1.2xlarge" + }, + { + "name": "Trn132xlarge", + "value": "trn1.32xlarge", + "description": "InstanceType enum trn1.32xlarge" + }, + { + "name": "Trn1n32xlarge", + "value": "trn1n.32xlarge", + "description": "InstanceType enum trn1n.32xlarge" + }, + { + "name": "U12tb1112xlarge", + "value": "u-12tb1.112xlarge", + "description": "InstanceType enum u-12tb1.112xlarge" + }, + { + "name": "U12tb1Metal", + "value": "u-12tb1.metal", + "description": "InstanceType enum u-12tb1.metal" + }, + { + "name": "U18tb1112xlarge", + "value": "u-18tb1.112xlarge", + "description": "InstanceType enum u-18tb1.112xlarge" + }, + { + "name": "U18tb1Metal", + "value": "u-18tb1.metal", + "description": "InstanceType enum u-18tb1.metal" + }, + { + "name": "U24tb1112xlarge", + "value": "u-24tb1.112xlarge", + "description": "InstanceType enum u-24tb1.112xlarge" + }, + { + "name": "U24tb1Metal", + "value": "u-24tb1.metal", + "description": "InstanceType enum u-24tb1.metal" + }, + { + "name": "U3tb156xlarge", + "value": "u-3tb1.56xlarge", + "description": "InstanceType enum u-3tb1.56xlarge" + }, + { + "name": "U6tb1112xlarge", + "value": "u-6tb1.112xlarge", + "description": "InstanceType enum u-6tb1.112xlarge" + }, + { + "name": "U6tb156xlarge", + "value": "u-6tb1.56xlarge", + "description": "InstanceType enum u-6tb1.56xlarge" + }, + { + "name": "U6tb1Metal", + "value": "u-6tb1.metal", + "description": "InstanceType enum u-6tb1.metal" + }, + { + "name": "U9tb1112xlarge", + "value": "u-9tb1.112xlarge", + "description": "InstanceType enum u-9tb1.112xlarge" + }, + { + "name": "U9tb1Metal", + "value": "u-9tb1.metal", + "description": "InstanceType enum u-9tb1.metal" + }, + { + "name": "Vt124xlarge", + "value": "vt1.24xlarge", + "description": "InstanceType enum vt1.24xlarge" + }, + { + "name": "Vt13xlarge", + "value": "vt1.3xlarge", + "description": "InstanceType enum vt1.3xlarge" + }, + { + "name": "Vt16xlarge", + "value": "vt1.6xlarge", + "description": "InstanceType enum vt1.6xlarge" + }, + { + "name": "X116xlarge", + "value": "x1.16xlarge", + "description": "InstanceType enum x1.16xlarge" + }, + { + "name": "X132xlarge", + "value": "x1.32xlarge", + "description": "InstanceType enum x1.32xlarge" + }, + { + "name": "X1e16xlarge", + "value": "x1e.16xlarge", + "description": "InstanceType enum x1e.16xlarge" + }, + { + "name": "X1e2xlarge", + "value": "x1e.2xlarge", + "description": "InstanceType enum x1e.2xlarge" + }, + { + "name": "X1e32xlarge", + "value": "x1e.32xlarge", + "description": "InstanceType enum x1e.32xlarge" + }, + { + "name": "X1e4xlarge", + "value": "x1e.4xlarge", + "description": "InstanceType enum x1e.4xlarge" + }, + { + "name": "X1e8xlarge", + "value": "x1e.8xlarge", + "description": "InstanceType enum x1e.8xlarge" + }, + { + "name": "X1eXlarge", + "value": "x1e.xlarge", + "description": "InstanceType enum x1e.xlarge" + }, + { + "name": "X2gd12xlarge", + "value": "x2gd.12xlarge", + "description": "InstanceType enum x2gd.12xlarge" + }, + { + "name": "X2gd16xlarge", + "value": "x2gd.16xlarge", + "description": "InstanceType enum x2gd.16xlarge" + }, + { + "name": "X2gd2xlarge", + "value": "x2gd.2xlarge", + "description": "InstanceType enum x2gd.2xlarge" + }, + { + "name": "X2gd4xlarge", + "value": "x2gd.4xlarge", + "description": "InstanceType enum x2gd.4xlarge" + }, + { + "name": "X2gd8xlarge", + "value": "x2gd.8xlarge", + "description": "InstanceType enum x2gd.8xlarge" + }, + { + "name": "X2gdLarge", + "value": "x2gd.large", + "description": "InstanceType enum x2gd.large" + }, + { + "name": "X2gdMedium", + "value": "x2gd.medium", + "description": "InstanceType enum x2gd.medium" + }, + { + "name": "X2gdMetal", + "value": "x2gd.metal", + "description": "InstanceType enum x2gd.metal" + }, + { + "name": "X2gdXlarge", + "value": "x2gd.xlarge", + "description": "InstanceType enum x2gd.xlarge" + }, + { + "name": "X2idn16xlarge", + "value": "x2idn.16xlarge", + "description": "InstanceType enum x2idn.16xlarge" + }, + { + "name": "X2idn24xlarge", + "value": "x2idn.24xlarge", + "description": "InstanceType enum x2idn.24xlarge" + }, + { + "name": "X2idn32xlarge", + "value": "x2idn.32xlarge", + "description": "InstanceType enum x2idn.32xlarge" + }, + { + "name": "X2idnMetal", + "value": "x2idn.metal", + "description": "InstanceType enum x2idn.metal" + }, + { + "name": "X2iedn16xlarge", + "value": "x2iedn.16xlarge", + "description": "InstanceType enum x2iedn.16xlarge" + }, + { + "name": "X2iedn24xlarge", + "value": "x2iedn.24xlarge", + "description": "InstanceType enum x2iedn.24xlarge" + }, + { + "name": "X2iedn2xlarge", + "value": "x2iedn.2xlarge", + "description": "InstanceType enum x2iedn.2xlarge" + }, + { + "name": "X2iedn32xlarge", + "value": "x2iedn.32xlarge", + "description": "InstanceType enum x2iedn.32xlarge" + }, + { + "name": "X2iedn4xlarge", + "value": "x2iedn.4xlarge", + "description": "InstanceType enum x2iedn.4xlarge" + }, + { + "name": "X2iedn8xlarge", + "value": "x2iedn.8xlarge", + "description": "InstanceType enum x2iedn.8xlarge" + }, + { + "name": "X2iednMetal", + "value": "x2iedn.metal", + "description": "InstanceType enum x2iedn.metal" + }, + { + "name": "X2iednXlarge", + "value": "x2iedn.xlarge", + "description": "InstanceType enum x2iedn.xlarge" + }, + { + "name": "X2iezn12xlarge", + "value": "x2iezn.12xlarge", + "description": "InstanceType enum x2iezn.12xlarge" + }, + { + "name": "X2iezn2xlarge", + "value": "x2iezn.2xlarge", + "description": "InstanceType enum x2iezn.2xlarge" + }, + { + "name": "X2iezn4xlarge", + "value": "x2iezn.4xlarge", + "description": "InstanceType enum x2iezn.4xlarge" + }, + { + "name": "X2iezn6xlarge", + "value": "x2iezn.6xlarge", + "description": "InstanceType enum x2iezn.6xlarge" + }, + { + "name": "X2iezn8xlarge", + "value": "x2iezn.8xlarge", + "description": "InstanceType enum x2iezn.8xlarge" + }, + { + "name": "X2ieznMetal", + "value": "x2iezn.metal", + "description": "InstanceType enum x2iezn.metal" + }, + { + "name": "Z1d12xlarge", + "value": "z1d.12xlarge", + "description": "InstanceType enum z1d.12xlarge" + }, + { + "name": "Z1d2xlarge", + "value": "z1d.2xlarge", + "description": "InstanceType enum z1d.2xlarge" + }, + { + "name": "Z1d3xlarge", + "value": "z1d.3xlarge", + "description": "InstanceType enum z1d.3xlarge" + }, + { + "name": "Z1d6xlarge", + "value": "z1d.6xlarge", + "description": "InstanceType enum z1d.6xlarge" + }, + { + "name": "Z1dLarge", + "value": "z1d.large", + "description": "InstanceType enum z1d.large" + }, + { + "name": "Z1dMetal", + "value": "z1d.metal", + "description": "InstanceType enum z1d.metal" + }, + { + "name": "Z1dXlarge", + "value": "z1d.xlarge", + "description": "InstanceType enum z1d.xlarge" + } + ] + } + }, + "InstanceTypeEnumValue": { + "type": "object", + "description": "Definition of InstanceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceType", + "description": "Property value" + } + } + }, + "LicenseConfiguration": { + "type": "object", + "description": "Definition of LicenseConfiguration", + "properties": { + "licenseConfigurationArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the license configuration.</p>" + } + } + }, + "Monitoring": { + "type": "object", + "description": "Definition of Monitoring", + "properties": { + "state": { + "$ref": "#/definitions/MonitoringStateEnumValue", + "description": "<p>Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.</p>" + } + } + }, + "MonitoringState": { + "type": "string", + "description": "MonitoringState enum", + "enum": [ + "disabled", + "disabling", + "enabled", + "pending" + ], + "x-ms-enum": { + "name": "MonitoringState", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "disabled", + "description": "MonitoringState enum disabled" + }, + { + "name": "Disabling", + "value": "disabling", + "description": "MonitoringState enum disabling" + }, + { + "name": "Enabled", + "value": "enabled", + "description": "MonitoringState enum enabled" + }, + { + "name": "Pending", + "value": "pending", + "description": "MonitoringState enum pending" + } + ] + } + }, + "MonitoringStateEnumValue": { + "type": "object", + "description": "Definition of MonitoringStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/MonitoringState", + "description": "Property value" + } + } + }, + "NetworkInterfaceStatus": { + "type": "string", + "description": "NetworkInterfaceStatus enum", + "enum": [ + "associated", + "attaching", + "available", + "detaching", + "in-use" + ], + "x-ms-enum": { + "name": "NetworkInterfaceStatus", + "modelAsString": true, + "values": [ + { + "name": "Associated", + "value": "associated", + "description": "NetworkInterfaceStatus enum associated" + }, + { + "name": "Attaching", + "value": "attaching", + "description": "NetworkInterfaceStatus enum attaching" + }, + { + "name": "Available", + "value": "available", + "description": "NetworkInterfaceStatus enum available" + }, + { + "name": "Detaching", + "value": "detaching", + "description": "NetworkInterfaceStatus enum detaching" + }, + { + "name": "InUse", + "value": "in-use", + "description": "NetworkInterfaceStatus enum in-use" + } + ] + } + }, + "NetworkInterfaceStatusEnumValue": { + "type": "object", + "description": "Definition of NetworkInterfaceStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/NetworkInterfaceStatus", + "description": "Property value" + } + } + }, + "Placement": { + "type": "object", + "description": "Definition of Placement", + "properties": { + "affinity": { + "type": "string", + "description": "<p>The affinity setting for the instance on the Dedicated Host.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a> or <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a>.</p>" + }, + "availabilityZone": { + "type": "string", + "description": "<p>The Availability Zone of the instance.</p> <p>If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>" + }, + "groupId": { + "type": "string", + "description": "<p>The ID of the placement group that the instance is in. If you specify <code>GroupId</code>, you can't specify <code>GroupName</code>.</p>" + }, + "groupName": { + "type": "string", + "description": "<p>The name of the placement group that the instance is in. If you specify <code>GroupName</code>, you can't specify <code>GroupId</code>.</p>" + }, + "hostId": { + "type": "string", + "description": "<p>The ID of the Dedicated Host on which the instance resides.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a> or <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a>.</p>" + }, + "hostResourceGroupArn": { + "type": "string", + "description": "<p>The ARN of the host resource group in which to launch the instances.</p> <p>If you specify this parameter, either omit the <b>Tenancy</b> parameter or set it to <code>host</code>.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>" + }, + "partitionNumber": { + "type": "integer", + "format": "int32", + "description": "<p>The number of the partition that the instance is in. Valid only if the placement group strategy is set to <code>partition</code>.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>.</p>" + }, + "spreadDomain": { + "type": "string", + "description": "<p>Reserved for future use.</p>" + }, + "tenancy": { + "$ref": "#/definitions/TenancyEnumValue", + "description": "<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware.</p> <p>This parameter is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'>CreateFleet</a>. The <code>host</code> tenancy is not supported for <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'>ImportInstance</a> or for T3 instances that are configured for the <code>unlimited</code> CPU credit option.</p>" + } + } + }, + "PlatformValues": { + "type": "string", + "description": "PlatformValues enum", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "PlatformValues", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "PlatformValues enum Windows" + } + ] + } + }, + "PlatformValuesEnumValue": { + "type": "object", + "description": "Definition of PlatformValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PlatformValues", + "description": "Property value" + } + } + }, + "PrivateDnsNameOptionsResponse": { + "type": "object", + "description": "Definition of PrivateDnsNameOptionsResponse", + "properties": { + "enableResourceNameDnsAAAARecord": { + "type": "boolean", + "description": "<p>Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.</p>" + }, + "enableResourceNameDnsARecord": { + "type": "boolean", + "description": "<p>Indicates whether to respond to DNS queries for instance hostnames with DNS A records.</p>" + }, + "hostnameType": { + "$ref": "#/definitions/HostnameTypeEnumValue", + "description": "<p>The type of hostname to assign to an instance.</p>" + } + } + }, + "ProductCode": { + "type": "object", + "description": "Definition of ProductCode", + "properties": { + "productCodeId": { + "type": "string", + "description": "<p>The product code.</p>" + }, + "productCodeType": { + "$ref": "#/definitions/ProductCodeValuesEnumValue", + "description": "<p>The type of product code.</p>" + } + } + }, + "ProductCodeValues": { + "type": "string", + "description": "ProductCodeValues enum", + "enum": [ + "devpay", + "marketplace" + ], + "x-ms-enum": { + "name": "ProductCodeValues", + "modelAsString": true, + "values": [ + { + "name": "Devpay", + "value": "devpay", + "description": "ProductCodeValues enum devpay" + }, + { + "name": "Marketplace", + "value": "marketplace", + "description": "ProductCodeValues enum marketplace" + } + ] + } + }, + "ProductCodeValuesEnumValue": { + "type": "object", + "description": "Definition of ProductCodeValuesEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ProductCodeValues", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StateReason": { + "type": "object", + "description": "Definition of StateReason", + "properties": { + "code": { + "type": "string", + "description": "<p>The reason code for the state change.</p>" + }, + "message": { + "type": "string", + "description": "<p>The message for the state change.</p> <ul> <li> <p> <code>Server.InsufficientInstanceCapacity</code>: There was insufficient capacity available to satisfy the launch request.</p> </li> <li> <p> <code>Server.InternalError</code>: An internal error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Server.ScheduledStop</code>: The instance was stopped due to a scheduled retirement.</p> </li> <li> <p> <code>Server.SpotInstanceShutdown</code>: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Server.SpotInstanceTermination</code>: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.</p> </li> <li> <p> <code>Client.InstanceInitiatedShutdown</code>: The instance was shut down from the operating system of the instance.</p> </li> <li> <p> <code>Client.InstanceTerminated</code>: The instance was terminated or rebooted during AMI creation.</p> </li> <li> <p> <code>Client.InternalError</code>: A client error caused the instance to terminate during launch.</p> </li> <li> <p> <code>Client.InvalidSnapshot.NotFound</code>: The specified snapshot was not found.</p> </li> <li> <p> <code>Client.UserInitiatedHibernate</code>: Hibernation was initiated on the instance.</p> </li> <li> <p> <code>Client.UserInitiatedShutdown</code>: The instance was shut down using the Amazon EC2 API.</p> </li> <li> <p> <code>Client.VolumeLimitExceeded</code>: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.</p> </li> </ul>" + } + } + }, + "StopEc2InstanceOptions": { + "type": "object", + "description": "Defines the stop action properties.", + "properties": { + "force": { + "type": "boolean", + "description": "Forces the instance to stop. The instance does not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. Defaults to false.", + "default": false + }, + "hibernate": { + "type": "boolean", + "description": "Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. Defaults to false.", + "default": false + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + }, + "Tenancy": { + "type": "string", + "description": "Tenancy enum", + "enum": [ + "dedicated", + "default", + "host" + ], + "x-ms-enum": { + "name": "Tenancy", + "modelAsString": true, + "values": [ + { + "name": "Dedicated", + "value": "dedicated", + "description": "Tenancy enum dedicated" + }, + { + "name": "Default", + "value": "default", + "description": "Tenancy enum default" + }, + { + "name": "Host", + "value": "host", + "description": "Tenancy enum host" + } + ] + } + }, + "TenancyEnumValue": { + "type": "object", + "description": "Definition of TenancyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/Tenancy", + "description": "Property value" + } + } + }, + "VirtualizationType": { + "type": "string", + "description": "VirtualizationType enum", + "enum": [ + "hvm", + "paravirtual" + ], + "x-ms-enum": { + "name": "VirtualizationType", + "modelAsString": true, + "values": [ + { + "name": "Hvm", + "value": "hvm", + "description": "VirtualizationType enum hvm" + }, + { + "name": "Paravirtual", + "value": "paravirtual", + "description": "VirtualizationType enum paravirtual" + } + ] + } + }, + "VirtualizationTypeEnumValue": { + "type": "object", + "description": "Definition of VirtualizationTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/VirtualizationType", + "description": "Property value" + } + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2InstanceStatus.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2InstanceStatus.json new file mode 100644 index 000000000000..10029dd05662 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2InstanceStatus.json @@ -0,0 +1,895 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2InstanceStatuses" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2InstanceStatuses": { + "get": { + "operationId": "Ec2InstanceStatuses_ListBySubscription", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "List Ec2InstanceStatus resources 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/Ec2InstanceStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2InstanceStatuses_ListBySubscription": { + "$ref": "./examples/Ec2InstanceStatuses_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2InstanceStatuses": { + "get": { + "operationId": "Ec2InstanceStatuses_ListByResourceGroup", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "List Ec2InstanceStatus resources 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/Ec2InstanceStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2InstanceStatuses_ListByResourceGroup": { + "$ref": "./examples/Ec2InstanceStatuses_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2InstanceStatuses/{name}": { + "get": { + "operationId": "Ec2InstanceStatuses_Get", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "Get a Ec2InstanceStatus", + "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": "name", + "in": "path", + "description": "Name of Ec2InstanceStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2InstanceStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2InstanceStatuses_Get": { + "$ref": "./examples/Ec2InstanceStatuses_Get.json" + } + } + }, + "put": { + "operationId": "Ec2InstanceStatuses_CreateOrReplace", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "Create a Ec2InstanceStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2InstanceStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2InstanceStatus" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2InstanceStatus' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2InstanceStatus" + } + }, + "201": { + "description": "Resource 'Ec2InstanceStatus' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2InstanceStatus" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2InstanceStatuses_CreateOrReplace": { + "$ref": "./examples/Ec2InstanceStatuses_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2InstanceStatuses_Update", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "Update a Ec2InstanceStatus", + "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": "name", + "in": "path", + "description": "Name of Ec2InstanceStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2InstanceStatusTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2InstanceStatus" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2InstanceStatuses_Update": { + "$ref": "./examples/Ec2InstanceStatuses_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2InstanceStatuses_Delete", + "tags": [ + "Ec2InstanceStatuses" + ], + "description": "Delete a Ec2InstanceStatus", + "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": "name", + "in": "path", + "description": "Name of Ec2InstanceStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2InstanceStatuses_Delete": { + "$ref": "./examples/Ec2InstanceStatuses_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2InstanceStatusProperties": { + "type": "object", + "description": "Definition of awsEc2InstanceStatus", + "properties": { + "availabilityZone": { + "type": "string", + "description": "<p>The Availability Zone of the instance.</p>" + }, + "events": { + "type": "array", + "description": "<p>Any scheduled events associated with the instance.</p>", + "items": { + "$ref": "#/definitions/InstanceStatusEvent" + }, + "x-ms-identifiers": [] + }, + "instanceId": { + "type": "string", + "description": "<p>The ID of the instance.</p>" + }, + "instanceState": { + "$ref": "#/definitions/InstanceState", + "description": "<p>The intended state of the instance. <a>DescribeInstanceStatus</a> requires that an instance be in the <code>running</code> state.</p>" + }, + "instanceStatus": { + "$ref": "#/definitions/InstanceStatusSummary", + "description": "<p>Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.</p>" + }, + "outpostArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Outpost.</p>" + }, + "systemStatus": { + "$ref": "#/definitions/InstanceStatusSummary", + "description": "<p>Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.</p>" + } + } + }, + "Ec2InstanceStatus": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2InstanceStatusProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2InstanceStatusListResult": { + "type": "object", + "description": "The response of a Ec2InstanceStatus list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2InstanceStatus items on this page", + "items": { + "$ref": "#/definitions/Ec2InstanceStatus" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2InstanceStatusProperties": { + "type": "object", + "description": "Definition of Ec2InstanceStatus", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2InstanceStatusProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2InstanceStatusTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2InstanceStatus resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EventCode": { + "type": "string", + "description": "EventCode enum", + "enum": [ + "instance-reboot", + "instance-retirement", + "instance-stop", + "system-maintenance", + "system-reboot" + ], + "x-ms-enum": { + "name": "EventCode", + "modelAsString": true, + "values": [ + { + "name": "InstanceReboot", + "value": "instance-reboot", + "description": "EventCode enum instance-reboot" + }, + { + "name": "InstanceRetirement", + "value": "instance-retirement", + "description": "EventCode enum instance-retirement" + }, + { + "name": "InstanceStop", + "value": "instance-stop", + "description": "EventCode enum instance-stop" + }, + { + "name": "SystemMaintenance", + "value": "system-maintenance", + "description": "EventCode enum system-maintenance" + }, + { + "name": "SystemReboot", + "value": "system-reboot", + "description": "EventCode enum system-reboot" + } + ] + } + }, + "EventCodeEnumValue": { + "type": "object", + "description": "Definition of EventCodeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/EventCode", + "description": "Property value" + } + } + }, + "InstanceState": { + "type": "object", + "description": "Definition of InstanceState", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "<p>The state of the instance as a 16-bit unsigned integer. </p> <p>The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.</p> <p>The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. </p> <p>The valid values for instance-state-code will all be in the range of the low byte and they are:</p> <ul> <li> <p> <code>0</code> : <code>pending</code> </p> </li> <li> <p> <code>16</code> : <code>running</code> </p> </li> <li> <p> <code>32</code> : <code>shutting-down</code> </p> </li> <li> <p> <code>48</code> : <code>terminated</code> </p> </li> <li> <p> <code>64</code> : <code>stopping</code> </p> </li> <li> <p> <code>80</code> : <code>stopped</code> </p> </li> </ul> <p>You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.</p>" + }, + "name": { + "$ref": "#/definitions/InstanceStateNameEnumValue", + "description": "<p>The current state of the instance.</p>" + } + } + }, + "InstanceStateName": { + "type": "string", + "description": "InstanceStateName enum", + "enum": [ + "pending", + "running", + "shutting-down", + "stopped", + "stopping", + "terminated" + ], + "x-ms-enum": { + "name": "InstanceStateName", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "pending", + "description": "InstanceStateName enum pending" + }, + { + "name": "Running", + "value": "running", + "description": "InstanceStateName enum running" + }, + { + "name": "ShuttingDown", + "value": "shutting-down", + "description": "InstanceStateName enum shutting-down" + }, + { + "name": "Stopped", + "value": "stopped", + "description": "InstanceStateName enum stopped" + }, + { + "name": "Stopping", + "value": "stopping", + "description": "InstanceStateName enum stopping" + }, + { + "name": "Terminated", + "value": "terminated", + "description": "InstanceStateName enum terminated" + } + ] + } + }, + "InstanceStateNameEnumValue": { + "type": "object", + "description": "Definition of InstanceStateNameEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceStateName", + "description": "Property value" + } + } + }, + "InstanceStatusDetails": { + "type": "object", + "description": "Definition of InstanceStatusDetails", + "properties": { + "impairedSince": { + "type": "string", + "format": "date-time", + "description": "<p>The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.</p>" + }, + "name": { + "$ref": "#/definitions/StatusNameEnumValue", + "description": "<p>The type of instance status.</p>" + }, + "status": { + "$ref": "#/definitions/StatusTypeEnumValue", + "description": "<p>The status.</p>" + } + } + }, + "InstanceStatusEvent": { + "type": "object", + "description": "Definition of InstanceStatusEvent", + "properties": { + "code": { + "$ref": "#/definitions/EventCodeEnumValue", + "description": "<p>The event code.</p>" + }, + "description": { + "type": "string", + "description": "<p>A description of the event.</p> <p>After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].</p>" + }, + "instanceEventId": { + "type": "string", + "description": "<p>The ID of the event.</p>" + }, + "notAfter": { + "type": "string", + "format": "date-time", + "description": "<p>The latest scheduled end time for the event.</p>" + }, + "notBefore": { + "type": "string", + "format": "date-time", + "description": "<p>The earliest scheduled start time for the event.</p>" + }, + "notBeforeDeadline": { + "type": "string", + "format": "date-time", + "description": "<p>The deadline for starting the event.</p>" + } + } + }, + "InstanceStatusSummary": { + "type": "object", + "description": "Definition of InstanceStatusSummary", + "properties": { + "details": { + "type": "array", + "description": "<p>The system instance health or application instance health.</p>", + "items": { + "$ref": "#/definitions/InstanceStatusDetails" + }, + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/SummaryStatusEnumValue", + "description": "<p>The status.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StatusName": { + "type": "string", + "description": "StatusName enum", + "enum": [ + "reachability" + ], + "x-ms-enum": { + "name": "StatusName", + "modelAsString": true, + "values": [ + { + "name": "Reachability", + "value": "reachability", + "description": "StatusName enum reachability" + } + ] + } + }, + "StatusNameEnumValue": { + "type": "object", + "description": "Definition of StatusNameEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/StatusName", + "description": "Property value" + } + } + }, + "StatusType": { + "type": "string", + "description": "StatusType enum", + "enum": [ + "failed", + "initializing", + "insufficient-data", + "passed" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true, + "values": [ + { + "name": "Failed", + "value": "failed", + "description": "StatusType enum failed" + }, + { + "name": "Initializing", + "value": "initializing", + "description": "StatusType enum initializing" + }, + { + "name": "InsufficientData", + "value": "insufficient-data", + "description": "StatusType enum insufficient-data" + }, + { + "name": "Passed", + "value": "passed", + "description": "StatusType enum passed" + } + ] + } + }, + "StatusTypeEnumValue": { + "type": "object", + "description": "Definition of StatusTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/StatusType", + "description": "Property value" + } + } + }, + "SummaryStatus": { + "type": "string", + "description": "SummaryStatus enum", + "enum": [ + "impaired", + "initializing", + "insufficient-data", + "not-applicable", + "ok" + ], + "x-ms-enum": { + "name": "SummaryStatus", + "modelAsString": true, + "values": [ + { + "name": "Impaired", + "value": "impaired", + "description": "SummaryStatus enum impaired" + }, + { + "name": "Initializing", + "value": "initializing", + "description": "SummaryStatus enum initializing" + }, + { + "name": "InsufficientData", + "value": "insufficient-data", + "description": "SummaryStatus enum insufficient-data" + }, + { + "name": "NotApplicable", + "value": "not-applicable", + "description": "SummaryStatus enum not-applicable" + }, + { + "name": "Ok", + "value": "ok", + "description": "SummaryStatus enum ok" + } + ] + } + }, + "SummaryStatusEnumValue": { + "type": "object", + "description": "Definition of SummaryStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SummaryStatus", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Ipam.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Ipam.json new file mode 100644 index 000000000000..10dab6f76ba1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Ipam.json @@ -0,0 +1,768 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Ipams" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Ipams": { + "get": { + "operationId": "Ec2Ipams_ListBySubscription", + "tags": [ + "Ec2Ipams" + ], + "description": "List Ec2Ipam resources 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/Ec2IpamListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Ipams_ListBySubscription": { + "$ref": "./examples/Ec2Ipams_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Ipams": { + "get": { + "operationId": "Ec2Ipams_ListByResourceGroup", + "tags": [ + "Ec2Ipams" + ], + "description": "List Ec2Ipam resources 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/Ec2IpamListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Ipams_ListByResourceGroup": { + "$ref": "./examples/Ec2Ipams_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Ipams/{name}": { + "get": { + "operationId": "Ec2Ipams_Get", + "tags": [ + "Ec2Ipams" + ], + "description": "Get a Ec2Ipam", + "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": "name", + "in": "path", + "description": "Name of Ec2Ipam", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Ipam" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Ipams_Get": { + "$ref": "./examples/Ec2Ipams_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Ipams_CreateOrReplace", + "tags": [ + "Ec2Ipams" + ], + "description": "Create a Ec2Ipam. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Ipam", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Ipam" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Ipam' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Ipam" + } + }, + "201": { + "description": "Resource 'Ec2Ipam' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Ipam" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Ipams_CreateOrReplace": { + "$ref": "./examples/Ec2Ipams_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Ipams_Update", + "tags": [ + "Ec2Ipams" + ], + "description": "Update a Ec2Ipam", + "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": "name", + "in": "path", + "description": "Name of Ec2Ipam", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2IpamTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Ipam" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Ipams_Update": { + "$ref": "./examples/Ec2Ipams_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Ipams_Delete", + "tags": [ + "Ec2Ipams" + ], + "description": "Delete a Ec2Ipam", + "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": "name", + "in": "path", + "description": "Name of Ec2Ipam", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Ipams_Delete": { + "$ref": "./examples/Ec2Ipams_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2IpamProperties": { + "type": "object", + "description": "Definition of awsEc2Ipam", + "properties": { + "defaultResourceDiscoveryAssociationId": { + "type": "string", + "description": "<p>The IPAM's default resource discovery association ID.</p>" + }, + "defaultResourceDiscoveryId": { + "type": "string", + "description": "<p>The IPAM's default resource discovery ID.</p>" + }, + "description": { + "type": "string", + "description": "<p>The description for the IPAM.</p>" + }, + "ipamArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the IPAM.</p>" + }, + "ipamId": { + "type": "string", + "description": "<p>The ID of the IPAM.</p>" + }, + "ipamRegion": { + "type": "string", + "description": "<p>The Amazon Web Services Region of the IPAM.</p>" + }, + "operatingRegions": { + "type": "array", + "description": "<p>The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.</p> <p>For more information about operating Regions, see <a href='https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html'>Create an IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>", + "items": { + "$ref": "#/definitions/IpamOperatingRegion" + }, + "x-ms-identifiers": [] + }, + "ownerId": { + "type": "string", + "description": "<p>The Amazon Web Services account ID of the owner of the IPAM.</p>" + }, + "privateDefaultScopeId": { + "type": "string", + "description": "<p>The ID of the IPAM's default private scope.</p>" + }, + "publicDefaultScopeId": { + "type": "string", + "description": "<p>The ID of the IPAM's default public scope.</p>" + }, + "resourceDiscoveryAssociationCount": { + "type": "integer", + "format": "int32", + "description": "<p>The IPAM's resource discovery association count.</p>" + }, + "scopeCount": { + "type": "integer", + "format": "int32", + "description": "<p>The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see <a href='https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html'>Quotas in IPAM</a> in the <i>Amazon VPC IPAM User Guide</i>. </p>" + }, + "state": { + "$ref": "#/definitions/IpamStateEnumValue", + "description": "<p>The state of the IPAM.</p>" + }, + "stateMessage": { + "type": "string", + "description": "<p>The state message.</p>" + }, + "tags": { + "type": "array", + "description": "<p>The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tier": { + "$ref": "#/definitions/IpamTierEnumValue", + "description": "<p>IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see <a href='http://aws.amazon.com/vpc/pricing/'>Amazon VPC pricing > IPAM tab</a>.</p>" + } + } + }, + "Ec2Ipam": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2IpamProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2IpamListResult": { + "type": "object", + "description": "The response of a Ec2Ipam list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Ipam items on this page", + "items": { + "$ref": "#/definitions/Ec2Ipam" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2IpamProperties": { + "type": "object", + "description": "Definition of Ec2Ipam", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2IpamProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2IpamTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Ipam resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IpamOperatingRegion": { + "type": "object", + "description": "Definition of IpamOperatingRegion", + "properties": { + "regionName": { + "type": "string", + "description": "<p>The name of the operating Region.</p>" + } + } + }, + "IpamState": { + "type": "string", + "description": "IpamState enum", + "enum": [ + "create-complete", + "create-failed", + "create-in-progress", + "delete-complete", + "delete-failed", + "delete-in-progress", + "isolate-complete", + "isolate-in-progress", + "modify-complete", + "modify-failed", + "modify-in-progress", + "restore-in-progress" + ], + "x-ms-enum": { + "name": "IpamState", + "modelAsString": true, + "values": [ + { + "name": "CreateComplete", + "value": "create-complete", + "description": "IpamState enum create-complete" + }, + { + "name": "CreateFailed", + "value": "create-failed", + "description": "IpamState enum create-failed" + }, + { + "name": "CreateInProgress", + "value": "create-in-progress", + "description": "IpamState enum create-in-progress" + }, + { + "name": "DeleteComplete", + "value": "delete-complete", + "description": "IpamState enum delete-complete" + }, + { + "name": "DeleteFailed", + "value": "delete-failed", + "description": "IpamState enum delete-failed" + }, + { + "name": "DeleteInProgress", + "value": "delete-in-progress", + "description": "IpamState enum delete-in-progress" + }, + { + "name": "IsolateComplete", + "value": "isolate-complete", + "description": "IpamState enum isolate-complete" + }, + { + "name": "IsolateInProgress", + "value": "isolate-in-progress", + "description": "IpamState enum isolate-in-progress" + }, + { + "name": "ModifyComplete", + "value": "modify-complete", + "description": "IpamState enum modify-complete" + }, + { + "name": "ModifyFailed", + "value": "modify-failed", + "description": "IpamState enum modify-failed" + }, + { + "name": "ModifyInProgress", + "value": "modify-in-progress", + "description": "IpamState enum modify-in-progress" + }, + { + "name": "RestoreInProgress", + "value": "restore-in-progress", + "description": "IpamState enum restore-in-progress" + } + ] + } + }, + "IpamStateEnumValue": { + "type": "object", + "description": "Definition of IpamStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/IpamState", + "description": "Property value" + } + } + }, + "IpamTier": { + "type": "string", + "description": "IpamTier enum", + "enum": [ + "advanced", + "free" + ], + "x-ms-enum": { + "name": "IpamTier", + "modelAsString": true, + "values": [ + { + "name": "Advanced", + "value": "advanced", + "description": "IpamTier enum advanced" + }, + { + "name": "Free", + "value": "free", + "description": "IpamTier enum free" + } + ] + } + }, + "IpamTierEnumValue": { + "type": "object", + "description": "Definition of IpamTierEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/IpamTier", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2KeyPair.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2KeyPair.json new file mode 100644 index 000000000000..d0ea0eb7ce86 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2KeyPair.json @@ -0,0 +1,678 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2KeyPairs" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2KeyPairs": { + "get": { + "operationId": "Ec2KeyPairs_ListBySubscription", + "tags": [ + "Ec2KeyPairs" + ], + "description": "List Ec2KeyPair resources 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/Ec2KeyPairListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2KeyPairs_ListBySubscription": { + "$ref": "./examples/Ec2KeyPairs_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2KeyPairs": { + "get": { + "operationId": "Ec2KeyPairs_ListByResourceGroup", + "tags": [ + "Ec2KeyPairs" + ], + "description": "List Ec2KeyPair resources 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/Ec2KeyPairListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2KeyPairs_ListByResourceGroup": { + "$ref": "./examples/Ec2KeyPairs_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2KeyPairs/{name}": { + "get": { + "operationId": "Ec2KeyPairs_Get", + "tags": [ + "Ec2KeyPairs" + ], + "description": "Get a Ec2KeyPair", + "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": "name", + "in": "path", + "description": "Name of Ec2KeyPair", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2KeyPair" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2KeyPairs_Get": { + "$ref": "./examples/Ec2KeyPairs_Get.json" + } + } + }, + "put": { + "operationId": "Ec2KeyPairs_CreateOrReplace", + "tags": [ + "Ec2KeyPairs" + ], + "description": "Create a Ec2KeyPair. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2KeyPair", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2KeyPair" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2KeyPair' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2KeyPair" + } + }, + "201": { + "description": "Resource 'Ec2KeyPair' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2KeyPair" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2KeyPairs_CreateOrReplace": { + "$ref": "./examples/Ec2KeyPairs_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2KeyPairs_Update", + "tags": [ + "Ec2KeyPairs" + ], + "description": "Update a Ec2KeyPair", + "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": "name", + "in": "path", + "description": "Name of Ec2KeyPair", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2KeyPairTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2KeyPair" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2KeyPairs_Update": { + "$ref": "./examples/Ec2KeyPairs_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2KeyPairs_Delete", + "tags": [ + "Ec2KeyPairs" + ], + "description": "Delete a Ec2KeyPair", + "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": "name", + "in": "path", + "description": "Name of Ec2KeyPair", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2KeyPairs_Delete": { + "$ref": "./examples/Ec2KeyPairs_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2KeyPairProperties": { + "type": "object", + "description": "Definition of awsEc2KeyPair", + "properties": { + "keyFingerprint": { + "type": "string", + "description": "Property keyFingerprint" + }, + "keyFormat": { + "type": "string", + "description": "The format of the key pair. Default: ``pem``", + "default": "pem", + "enum": [ + "pem", + "ppk" + ], + "x-ms-enum": { + "name": "KeyFormat", + "modelAsString": true, + "values": [ + { + "name": "pem", + "value": "pem", + "description": "KeyFormat enum pem" + }, + { + "name": "ppk", + "value": "ppk", + "description": "KeyFormat enum ppk" + } + ] + } + }, + "keyName": { + "type": "string", + "description": "A unique name for the key pair. Constraints: Up to 255 ASCII characters" + }, + "keyPairId": { + "type": "string", + "description": "Property keyPairId" + }, + "keyType": { + "type": "string", + "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa``", + "default": "rsa", + "enum": [ + "ed25519", + "rsa" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "name": "ed25519", + "value": "ed25519", + "description": "KeyType enum ed25519" + }, + { + "name": "rsa", + "value": "rsa", + "description": "KeyType enum rsa" + } + ] + } + }, + "publicKeyMaterial": { + "type": "string", + "description": "The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created." + }, + "tags": { + "type": "array", + "description": "The tags to apply to the key pair.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "Ec2KeyPair": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2KeyPairProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2KeyPairListResult": { + "type": "object", + "description": "The response of a Ec2KeyPair list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2KeyPair items on this page", + "items": { + "$ref": "#/definitions/Ec2KeyPair" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2KeyPairProperties": { + "type": "object", + "description": "Definition of Ec2KeyPair", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2KeyPairProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2KeyPairTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2KeyPair resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "KeyFormat": { + "type": "string", + "description": "KeyFormat enum", + "enum": [ + "pem", + "ppk" + ], + "x-ms-enum": { + "name": "KeyFormat", + "modelAsString": true, + "values": [ + { + "name": "pem", + "value": "pem", + "description": "KeyFormat enum pem" + }, + { + "name": "ppk", + "value": "ppk", + "description": "KeyFormat enum ppk" + } + ] + } + }, + "KeyType": { + "type": "string", + "description": "KeyType enum", + "enum": [ + "ed25519", + "rsa" + ], + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true, + "values": [ + { + "name": "ed25519", + "value": "ed25519", + "description": "KeyType enum ed25519" + }, + { + "name": "rsa", + "value": "rsa", + "description": "KeyType enum rsa" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkAcl.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkAcl.json new file mode 100644 index 000000000000..9dd9ac422e19 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkAcl.json @@ -0,0 +1,572 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2NetworkAcls" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2NetworkAcls": { + "get": { + "operationId": "Ec2NetworkAcls_ListBySubscription", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "List Ec2NetworkAcl resources 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/Ec2NetworkAclListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkAcls_ListBySubscription": { + "$ref": "./examples/Ec2NetworkAcls_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2NetworkAcls": { + "get": { + "operationId": "Ec2NetworkAcls_ListByResourceGroup", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "List Ec2NetworkAcl resources 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/Ec2NetworkAclListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkAcls_ListByResourceGroup": { + "$ref": "./examples/Ec2NetworkAcls_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2NetworkAcls/{name}": { + "get": { + "operationId": "Ec2NetworkAcls_Get", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "Get a Ec2NetworkAcl", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkAcl", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2NetworkAcl" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkAcls_Get": { + "$ref": "./examples/Ec2NetworkAcls_Get.json" + } + } + }, + "put": { + "operationId": "Ec2NetworkAcls_CreateOrReplace", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "Create a Ec2NetworkAcl. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkAcl", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2NetworkAcl" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2NetworkAcl' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2NetworkAcl" + } + }, + "201": { + "description": "Resource 'Ec2NetworkAcl' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2NetworkAcl" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2NetworkAcls_CreateOrReplace": { + "$ref": "./examples/Ec2NetworkAcls_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2NetworkAcls_Update", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "Update a Ec2NetworkAcl", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkAcl", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2NetworkAclTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2NetworkAcl" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkAcls_Update": { + "$ref": "./examples/Ec2NetworkAcls_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2NetworkAcls_Delete", + "tags": [ + "Ec2NetworkAcls" + ], + "description": "Delete a Ec2NetworkAcl", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkAcl", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2NetworkAcls_Delete": { + "$ref": "./examples/Ec2NetworkAcls_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2NetworkAclProperties": { + "type": "object", + "description": "Definition of awsEc2NetworkAcl", + "properties": { + "id": { + "type": "string", + "description": "Property id" + }, + "tags": { + "type": "array", + "description": "The tags for the network ACL.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC for the network ACL." + } + } + }, + "Ec2NetworkAcl": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2NetworkAclProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2NetworkAclListResult": { + "type": "object", + "description": "The response of a Ec2NetworkAcl list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2NetworkAcl items on this page", + "items": { + "$ref": "#/definitions/Ec2NetworkAcl" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2NetworkAclProperties": { + "type": "object", + "description": "Definition of Ec2NetworkAcl", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2NetworkAclProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2NetworkAclTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2NetworkAcl resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkInterface.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkInterface.json new file mode 100644 index 000000000000..dfec167b55bf --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkInterface.json @@ -0,0 +1,741 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2NetworkInterfaces" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2NetworkInterfaces": { + "get": { + "operationId": "Ec2NetworkInterfaces_ListBySubscription", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "List Ec2NetworkInterface resources 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/Ec2NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkInterfaces_ListBySubscription": { + "$ref": "./examples/Ec2NetworkInterfaces_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2NetworkInterfaces": { + "get": { + "operationId": "Ec2NetworkInterfaces_ListByResourceGroup", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "List Ec2NetworkInterface resources 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/Ec2NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkInterfaces_ListByResourceGroup": { + "$ref": "./examples/Ec2NetworkInterfaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2NetworkInterfaces/{name}": { + "get": { + "operationId": "Ec2NetworkInterfaces_Get", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "Get a Ec2NetworkInterface", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkInterface", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkInterfaces_Get": { + "$ref": "./examples/Ec2NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "Ec2NetworkInterfaces_CreateOrReplace", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "Create a Ec2NetworkInterface. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkInterface", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2NetworkInterface" + } + }, + "201": { + "description": "Resource 'Ec2NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2NetworkInterface" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2NetworkInterfaces_CreateOrReplace": { + "$ref": "./examples/Ec2NetworkInterfaces_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2NetworkInterfaces_Update", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "Update a Ec2NetworkInterface", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkInterface", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2NetworkInterfaceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2NetworkInterface" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2NetworkInterfaces_Update": { + "$ref": "./examples/Ec2NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2NetworkInterfaces_Delete", + "tags": [ + "Ec2NetworkInterfaces" + ], + "description": "Delete a Ec2NetworkInterface", + "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": "name", + "in": "path", + "description": "Name of Ec2NetworkInterface", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2NetworkInterfaces_Delete": { + "$ref": "./examples/Ec2NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2NetworkInterfaceProperties": { + "type": "object", + "description": "Definition of awsEc2NetworkInterface", + "properties": { + "connectionTrackingSpecification": { + "$ref": "#/definitions/ConnectionTrackingSpecification", + "description": "Property connectionTrackingSpecification" + }, + "description": { + "type": "string", + "description": "A description for the network interface." + }, + "enablePrimaryIpv6": { + "type": "boolean", + "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address." + }, + "groupSet": { + "type": "array", + "description": "A list of security group IDs associated with this network interface.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "id": { + "type": "string", + "description": "Network interface id." + }, + "interfaceType": { + "type": "string", + "description": "Indicates the type of network interface." + }, + "ipv4PrefixCount": { + "type": "integer", + "format": "int32", + "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses." + }, + "ipv4Prefixes": { + "type": "array", + "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.", + "items": { + "$ref": "#/definitions/Ipv4PrefixSpecification" + }, + "x-ms-identifiers": [] + }, + "ipv6AddressCount": { + "type": "integer", + "format": "int32", + "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property." + }, + "ipv6Addresses": { + "type": "array", + "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property.", + "items": { + "$ref": "#/definitions/InstanceIpv6Address" + }, + "x-ms-identifiers": [] + }, + "ipv6PrefixCount": { + "type": "integer", + "format": "int32", + "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." + }, + "ipv6Prefixes": { + "type": "array", + "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.", + "items": { + "$ref": "#/definitions/Ipv6PrefixSpecification" + }, + "x-ms-identifiers": [] + }, + "primaryIpv6Address": { + "type": "string", + "description": "The primary IPv6 address" + }, + "primaryPrivateIpAddress": { + "type": "string", + "description": "Returns the primary private IP address of the network interface." + }, + "privateIpAddress": { + "type": "string", + "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property." + }, + "privateIpAddresses": { + "type": "array", + "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property.", + "items": { + "$ref": "#/definitions/PrivateIpAddressSpecification" + }, + "x-ms-identifiers": [] + }, + "secondaryPrivateIpAddressCount": { + "type": "integer", + "format": "int32", + "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses" + }, + "secondaryPrivateIpAddresses": { + "type": "array", + "description": "Returns the secondary private IP addresses of the network interface.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "sourceDestCheck": { + "type": "boolean", + "description": "Indicates whether traffic to or from the instance is validated." + }, + "subnetId": { + "type": "string", + "description": "The ID of the subnet to associate with the network interface." + }, + "tags": { + "type": "array", + "description": "An arbitrary set of tags (key-value pairs) for this network interface.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC" + } + } + }, + "ConnectionTrackingSpecification": { + "type": "object", + "description": "Definition of ConnectionTrackingSpecification", + "properties": { + "tcpEstablishedTimeout": { + "type": "integer", + "format": "int32", + "description": "Property tcpEstablishedTimeout" + }, + "udpStreamTimeout": { + "type": "integer", + "format": "int32", + "description": "Property udpStreamTimeout" + }, + "udpTimeout": { + "type": "integer", + "format": "int32", + "description": "Property udpTimeout" + } + } + }, + "Ec2NetworkInterface": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2NetworkInterfaceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a Ec2NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/Ec2NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2NetworkInterfaceProperties": { + "type": "object", + "description": "Definition of Ec2NetworkInterface", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2NetworkInterfaceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2NetworkInterfaceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2NetworkInterface resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "InstanceIpv6Address": { + "type": "object", + "description": "Definition of InstanceIpv6Address", + "properties": { + "ipv6Address": { + "type": "string", + "description": "Property ipv6Address" + } + } + }, + "Ipv4PrefixSpecification": { + "type": "object", + "description": "Definition of Ipv4PrefixSpecification", + "properties": { + "ipv4Prefix": { + "type": "string", + "description": "Property ipv4Prefix" + } + } + }, + "Ipv6PrefixSpecification": { + "type": "object", + "description": "Definition of Ipv6PrefixSpecification", + "properties": { + "ipv6Prefix": { + "type": "string", + "description": "Property ipv6Prefix" + } + } + }, + "PrivateIpAddressSpecification": { + "type": "object", + "description": "Definition of PrivateIpAddressSpecification", + "properties": { + "primary": { + "type": "boolean", + "description": "Property primary" + }, + "privateIpAddress": { + "type": "string", + "description": "Property privateIpAddress" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2RouteTable.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2RouteTable.json new file mode 100644 index 000000000000..b5a55b5c4e74 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2RouteTable.json @@ -0,0 +1,572 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2RouteTables" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2RouteTables": { + "get": { + "operationId": "Ec2RouteTables_ListBySubscription", + "tags": [ + "Ec2RouteTables" + ], + "description": "List Ec2RouteTable resources 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/Ec2RouteTableListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2RouteTables_ListBySubscription": { + "$ref": "./examples/Ec2RouteTables_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2RouteTables": { + "get": { + "operationId": "Ec2RouteTables_ListByResourceGroup", + "tags": [ + "Ec2RouteTables" + ], + "description": "List Ec2RouteTable resources 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/Ec2RouteTableListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2RouteTables_ListByResourceGroup": { + "$ref": "./examples/Ec2RouteTables_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2RouteTables/{name}": { + "get": { + "operationId": "Ec2RouteTables_Get", + "tags": [ + "Ec2RouteTables" + ], + "description": "Get a Ec2RouteTable", + "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": "name", + "in": "path", + "description": "Name of Ec2RouteTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2RouteTable" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2RouteTables_Get": { + "$ref": "./examples/Ec2RouteTables_Get.json" + } + } + }, + "put": { + "operationId": "Ec2RouteTables_CreateOrReplace", + "tags": [ + "Ec2RouteTables" + ], + "description": "Create a Ec2RouteTable. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2RouteTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2RouteTable" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2RouteTable' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2RouteTable" + } + }, + "201": { + "description": "Resource 'Ec2RouteTable' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2RouteTable" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2RouteTables_CreateOrReplace": { + "$ref": "./examples/Ec2RouteTables_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2RouteTables_Update", + "tags": [ + "Ec2RouteTables" + ], + "description": "Update a Ec2RouteTable", + "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": "name", + "in": "path", + "description": "Name of Ec2RouteTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2RouteTableTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2RouteTable" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2RouteTables_Update": { + "$ref": "./examples/Ec2RouteTables_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2RouteTables_Delete", + "tags": [ + "Ec2RouteTables" + ], + "description": "Delete a Ec2RouteTable", + "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": "name", + "in": "path", + "description": "Name of Ec2RouteTable", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2RouteTables_Delete": { + "$ref": "./examples/Ec2RouteTables_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2RouteTableProperties": { + "type": "object", + "description": "Definition of awsEc2RouteTable", + "properties": { + "routeTableId": { + "type": "string", + "description": "Property routeTableId" + }, + "tags": { + "type": "array", + "description": "Any tags assigned to the route table.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC." + } + } + }, + "Ec2RouteTable": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2RouteTableProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2RouteTableListResult": { + "type": "object", + "description": "The response of a Ec2RouteTable list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2RouteTable items on this page", + "items": { + "$ref": "#/definitions/Ec2RouteTable" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2RouteTableProperties": { + "type": "object", + "description": "Definition of Ec2RouteTable", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2RouteTableProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2RouteTableTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2RouteTable resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2SecurityGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2SecurityGroup.json new file mode 100644 index 000000000000..6b8a1c514a67 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2SecurityGroup.json @@ -0,0 +1,728 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2SecurityGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2SecurityGroups": { + "get": { + "operationId": "Ec2SecurityGroups_ListBySubscription", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "List Ec2SecurityGroup resources 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/Ec2SecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2SecurityGroups_ListBySubscription": { + "$ref": "./examples/Ec2SecurityGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2SecurityGroups": { + "get": { + "operationId": "Ec2SecurityGroups_ListByResourceGroup", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "List Ec2SecurityGroup resources 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/Ec2SecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2SecurityGroups_ListByResourceGroup": { + "$ref": "./examples/Ec2SecurityGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2SecurityGroups/{name}": { + "get": { + "operationId": "Ec2SecurityGroups_Get", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "Get a Ec2SecurityGroup", + "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": "name", + "in": "path", + "description": "Name of Ec2SecurityGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2SecurityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2SecurityGroups_Get": { + "$ref": "./examples/Ec2SecurityGroups_Get.json" + } + } + }, + "put": { + "operationId": "Ec2SecurityGroups_CreateOrReplace", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "Create a Ec2SecurityGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2SecurityGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2SecurityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2SecurityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2SecurityGroup" + } + }, + "201": { + "description": "Resource 'Ec2SecurityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2SecurityGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2SecurityGroups_CreateOrReplace": { + "$ref": "./examples/Ec2SecurityGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2SecurityGroups_Update", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "Update a Ec2SecurityGroup", + "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": "name", + "in": "path", + "description": "Name of Ec2SecurityGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2SecurityGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2SecurityGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2SecurityGroups_Update": { + "$ref": "./examples/Ec2SecurityGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2SecurityGroups_Delete", + "tags": [ + "Ec2SecurityGroups" + ], + "description": "Delete a Ec2SecurityGroup", + "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": "name", + "in": "path", + "description": "Name of Ec2SecurityGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2SecurityGroups_Delete": { + "$ref": "./examples/Ec2SecurityGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2SecurityGroupProperties": { + "type": "object", + "description": "Definition of awsEc2SecurityGroup", + "properties": { + "description": { + "type": "string", + "description": "<p>A description of the security group.</p>" + }, + "groupId": { + "type": "string", + "description": "<p>The ID of the security group.</p>" + }, + "groupName": { + "type": "string", + "description": "<p>The name of the security group.</p>" + }, + "ipPermissions": { + "type": "array", + "description": "<p>The inbound rules associated with the security group.</p>", + "items": { + "$ref": "#/definitions/IpPermission" + }, + "x-ms-identifiers": [] + }, + "ipPermissionsEgress": { + "type": "array", + "description": "<p>The outbound rules associated with the security group.</p>", + "items": { + "$ref": "#/definitions/IpPermission" + }, + "x-ms-identifiers": [] + }, + "ownerId": { + "type": "string", + "description": "<p>The Amazon Web Services account ID of the owner of the security group.</p>" + }, + "tags": { + "type": "array", + "description": "<p>Any tags assigned to the security group.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the VPC for the security group.</p>" + } + } + }, + "Ec2SecurityGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2SecurityGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2SecurityGroupListResult": { + "type": "object", + "description": "The response of a Ec2SecurityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2SecurityGroup items on this page", + "items": { + "$ref": "#/definitions/Ec2SecurityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2SecurityGroupProperties": { + "type": "object", + "description": "Definition of Ec2SecurityGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2SecurityGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2SecurityGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2SecurityGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IpPermission": { + "type": "object", + "description": "Definition of IpPermission", + "properties": { + "fromPort": { + "type": "integer", + "format": "int32", + "description": "<p>If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).</p>" + }, + "ipProtocol": { + "type": "string", + "description": "<p>The IP protocol name (<code>tcp</code>, <code>udp</code>, <code>icmp</code>, <code>icmpv6</code>) or number (see <a href='http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml'>Protocol Numbers</a>).</p> <p>Use <code>-1</code> to specify all protocols. When authorizing security group rules, specifying <code>-1</code> or a protocol number other than <code>tcp</code>, <code>udp</code>, <code>icmp</code>, or <code>icmpv6</code> allows traffic on all ports, regardless of any port range you specify. For <code>tcp</code>, <code>udp</code>, and <code>icmp</code>, you must specify a port range. For <code>icmpv6</code>, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.</p>" + }, + "ipRanges": { + "type": "array", + "description": "<p>The IPv4 address ranges.</p>", + "items": { + "$ref": "#/definitions/IpRange" + }, + "x-ms-identifiers": [] + }, + "ipv6Ranges": { + "type": "array", + "description": "<p>The IPv6 address ranges.</p>", + "items": { + "$ref": "#/definitions/Ipv6Range" + }, + "x-ms-identifiers": [] + }, + "prefixListIds": { + "type": "array", + "description": "<p>The prefix list IDs.</p>", + "items": { + "$ref": "#/definitions/PrefixListId" + }, + "x-ms-identifiers": [] + }, + "toPort": { + "type": "integer", + "format": "int32", + "description": "<p>If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).</p>" + }, + "userIdGroupPairs": { + "type": "array", + "description": "<p>The security group and Amazon Web Services account ID pairs.</p>", + "items": { + "$ref": "#/definitions/UserIdGroupPair" + }, + "x-ms-identifiers": [] + } + } + }, + "IpRange": { + "type": "object", + "description": "Definition of IpRange", + "properties": { + "cidrIp": { + "type": "string", + "description": "<p>The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.</p>" + }, + "description": { + "type": "string", + "description": "<p>A description for the security group rule that references this IPv4 address range.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</p>" + } + } + }, + "Ipv6Range": { + "type": "object", + "description": "Definition of Ipv6Range", + "properties": { + "cidrIpv6": { + "type": "string", + "description": "<p>The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.</p>" + }, + "description": { + "type": "string", + "description": "<p>A description for the security group rule that references this IPv6 address range.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*</p>" + } + } + }, + "PrefixListId": { + "type": "object", + "description": "Definition of PrefixListId", + "properties": { + "description": { + "type": "string", + "description": "<p>A description for the security group rule that references this prefix list ID.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*</p>" + }, + "prefixListId": { + "type": "string", + "description": "<p>The ID of the prefix.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + }, + "UserIdGroupPair": { + "type": "object", + "description": "Definition of UserIdGroupPair", + "properties": { + "description": { + "type": "string", + "description": "<p>A description for the security group rule that references this user ID group pair.</p> <p>Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*</p>" + }, + "groupId": { + "type": "string", + "description": "<p>The ID of the security group.</p>" + }, + "groupName": { + "type": "string", + "description": "<p>[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID. </p> <p>For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.</p>" + }, + "peeringStatus": { + "type": "string", + "description": "<p>The status of a VPC peering connection, if applicable.</p>" + }, + "userId": { + "type": "string", + "description": "<p>The ID of an Amazon Web Services account.</p> <p>For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.</p>" + }, + "vpcId": { + "type": "string", + "description": "<p>The ID of the VPC for the referenced security group, if applicable.</p>" + }, + "vpcPeeringConnectionId": { + "type": "string", + "description": "<p>The ID of the VPC peering connection, if applicable.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Snapshot.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Snapshot.json new file mode 100644 index 000000000000..4b69dd244301 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Snapshot.json @@ -0,0 +1,761 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Snapshots" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Snapshots": { + "get": { + "operationId": "Ec2Snapshots_ListBySubscription", + "tags": [ + "Ec2Snapshots" + ], + "description": "List Ec2Snapshot resources 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/Ec2SnapshotListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Snapshots_ListBySubscription": { + "$ref": "./examples/Ec2Snapshots_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Snapshots": { + "get": { + "operationId": "Ec2Snapshots_ListByResourceGroup", + "tags": [ + "Ec2Snapshots" + ], + "description": "List Ec2Snapshot resources 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/Ec2SnapshotListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Snapshots_ListByResourceGroup": { + "$ref": "./examples/Ec2Snapshots_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Snapshots/{name}": { + "get": { + "operationId": "Ec2Snapshots_Get", + "tags": [ + "Ec2Snapshots" + ], + "description": "Get a Ec2Snapshot", + "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": "name", + "in": "path", + "description": "Name of Ec2Snapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Snapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Snapshots_Get": { + "$ref": "./examples/Ec2Snapshots_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Snapshots_CreateOrReplace", + "tags": [ + "Ec2Snapshots" + ], + "description": "Create a Ec2Snapshot. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Snapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Snapshot" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Snapshot' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Snapshot" + } + }, + "201": { + "description": "Resource 'Ec2Snapshot' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Snapshot" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Snapshots_CreateOrReplace": { + "$ref": "./examples/Ec2Snapshots_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Snapshots_Update", + "tags": [ + "Ec2Snapshots" + ], + "description": "Update a Ec2Snapshot", + "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": "name", + "in": "path", + "description": "Name of Ec2Snapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2SnapshotTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Snapshot" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Snapshots_Update": { + "$ref": "./examples/Ec2Snapshots_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Snapshots_Delete", + "tags": [ + "Ec2Snapshots" + ], + "description": "Delete a Ec2Snapshot", + "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": "name", + "in": "path", + "description": "Name of Ec2Snapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Snapshots_Delete": { + "$ref": "./examples/Ec2Snapshots_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2SnapshotProperties": { + "type": "object", + "description": "Definition of awsEc2Snapshot", + "properties": { + "dataEncryptionKeyId": { + "type": "string", + "description": "<p>The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by <a>DescribeSnapshots</a>.</p>" + }, + "description": { + "type": "string", + "description": "<p>The description for the snapshot.</p>" + }, + "encrypted": { + "type": "boolean", + "description": "<p>Indicates whether the snapshot is encrypted.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.</p>" + }, + "outpostArn": { + "type": "string", + "description": "<p>The ARN of the Outpost on which the snapshot is stored. For more information, see <a href='https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html'>Amazon EBS local snapshots on Outposts</a> in the <i>Amazon EBS User Guide</i>.</p>" + }, + "ownerAlias": { + "type": "string", + "description": "<p>The Amazon Web Services owner alias, from an Amazon-maintained list (<code>amazon</code>). This is not the user-configured Amazon Web Services account alias set using the IAM console.</p>" + }, + "ownerId": { + "type": "string", + "description": "<p>The ID of the Amazon Web Services account that owns the EBS snapshot.</p>" + }, + "progress": { + "type": "string", + "description": "<p>The progress of the snapshot, as a percentage.</p>" + }, + "restoreExpiryTime": { + "type": "string", + "format": "date-time", + "description": "<p>Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.</p>" + }, + "snapshotId": { + "type": "string", + "description": "<p>The ID of the snapshot. Each snapshot receives a unique identifier when it is created.</p>" + }, + "sseType": { + "$ref": "#/definitions/SSETypeEnumValue", + "description": "<p>Reserved for future use.</p>" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time stamp when the snapshot was initiated.</p>" + }, + "state": { + "$ref": "#/definitions/SnapshotStateEnumValue", + "description": "<p>The snapshot state.</p>" + }, + "stateMessage": { + "type": "string", + "description": "<p>Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by <a>DescribeSnapshots</a>.</p>" + }, + "storageTier": { + "$ref": "#/definitions/StorageTierEnumValue", + "description": "<p>The storage tier in which the snapshot is stored. <code>standard</code> indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. <code>archive</code> indicates that the snapshot is currently archived and that it must be restored before it can be used.</p>" + }, + "tags": { + "type": "array", + "description": "<p>Any tags assigned to the snapshot.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "volumeId": { + "type": "string", + "description": "<p>The ID of the volume that was used to create the snapshot. Snapshots created by the <a>CopySnapshot</a> action have an arbitrary volume ID that should not be used for any purpose.</p>" + }, + "volumeSize": { + "type": "integer", + "format": "int32", + "description": "<p>The size of the volume, in GiB.</p>" + } + } + }, + "Ec2Snapshot": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2SnapshotProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2SnapshotListResult": { + "type": "object", + "description": "The response of a Ec2Snapshot list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Snapshot items on this page", + "items": { + "$ref": "#/definitions/Ec2Snapshot" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2SnapshotProperties": { + "type": "object", + "description": "Definition of Ec2Snapshot", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2SnapshotProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2SnapshotTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Snapshot resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SSEType": { + "type": "string", + "description": "SSEType enum", + "enum": [ + "none", + "sse-ebs", + "sse-kms" + ], + "x-ms-enum": { + "name": "SSEType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "none", + "description": "SSEType enum none" + }, + { + "name": "SseEbs", + "value": "sse-ebs", + "description": "SSEType enum sse-ebs" + }, + { + "name": "SseKms", + "value": "sse-kms", + "description": "SSEType enum sse-kms" + } + ] + } + }, + "SSETypeEnumValue": { + "type": "object", + "description": "Definition of SSETypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SSEType", + "description": "Property value" + } + } + }, + "SnapshotState": { + "type": "string", + "description": "SnapshotState enum", + "enum": [ + "completed", + "error", + "pending", + "recoverable", + "recovering" + ], + "x-ms-enum": { + "name": "SnapshotState", + "modelAsString": true, + "values": [ + { + "name": "Completed", + "value": "completed", + "description": "SnapshotState enum completed" + }, + { + "name": "Error", + "value": "error", + "description": "SnapshotState enum error" + }, + { + "name": "Pending", + "value": "pending", + "description": "SnapshotState enum pending" + }, + { + "name": "Recoverable", + "value": "recoverable", + "description": "SnapshotState enum recoverable" + }, + { + "name": "Recovering", + "value": "recovering", + "description": "SnapshotState enum recovering" + } + ] + } + }, + "SnapshotStateEnumValue": { + "type": "object", + "description": "Definition of SnapshotStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SnapshotState", + "description": "Property value" + } + } + }, + "StorageTier": { + "type": "string", + "description": "StorageTier enum", + "enum": [ + "archive", + "standard" + ], + "x-ms-enum": { + "name": "StorageTier", + "modelAsString": true, + "values": [ + { + "name": "Archive", + "value": "archive", + "description": "StorageTier enum archive" + }, + { + "name": "Standard", + "value": "standard", + "description": "StorageTier enum standard" + } + ] + } + }, + "StorageTierEnumValue": { + "type": "object", + "description": "Definition of StorageTierEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/StorageTier", + "description": "Property value" + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>The key of the tag.</p> <p>Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with <code>aws:</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of the tag.</p> <p>Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Subnet.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Subnet.json new file mode 100644 index 000000000000..5f8d69d4917e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Subnet.json @@ -0,0 +1,665 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Subnets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Subnets": { + "get": { + "operationId": "Ec2Subnets_ListBySubscription", + "tags": [ + "Ec2Subnets" + ], + "description": "List Ec2Subnet resources 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/Ec2SubnetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Subnets_ListBySubscription": { + "$ref": "./examples/Ec2Subnets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Subnets": { + "get": { + "operationId": "Ec2Subnets_ListByResourceGroup", + "tags": [ + "Ec2Subnets" + ], + "description": "List Ec2Subnet resources 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/Ec2SubnetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Subnets_ListByResourceGroup": { + "$ref": "./examples/Ec2Subnets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Subnets/{name}": { + "get": { + "operationId": "Ec2Subnets_Get", + "tags": [ + "Ec2Subnets" + ], + "description": "Get a Ec2Subnet", + "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": "name", + "in": "path", + "description": "Name of Ec2Subnet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Subnet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Subnets_Get": { + "$ref": "./examples/Ec2Subnets_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Subnets_CreateOrReplace", + "tags": [ + "Ec2Subnets" + ], + "description": "Create a Ec2Subnet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Subnet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Subnet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Subnet' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Subnet" + } + }, + "201": { + "description": "Resource 'Ec2Subnet' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Subnet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Subnets_CreateOrReplace": { + "$ref": "./examples/Ec2Subnets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Subnets_Update", + "tags": [ + "Ec2Subnets" + ], + "description": "Update a Ec2Subnet", + "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": "name", + "in": "path", + "description": "Name of Ec2Subnet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2SubnetTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Subnet" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Subnets_Update": { + "$ref": "./examples/Ec2Subnets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Subnets_Delete", + "tags": [ + "Ec2Subnets" + ], + "description": "Delete a Ec2Subnet", + "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": "name", + "in": "path", + "description": "Name of Ec2Subnet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Subnets_Delete": { + "$ref": "./examples/Ec2Subnets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2SubnetProperties": { + "type": "object", + "description": "Definition of awsEc2Subnet", + "properties": { + "assignIpv6AddressOnCreation": { + "type": "boolean", + "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." + }, + "availabilityZone": { + "type": "string", + "description": "The Availability Zone of the subnet. If you update this property, you must also update the ``CidrBlock`` property." + }, + "availabilityZoneId": { + "type": "string", + "description": "The AZ ID of the subnet." + }, + "cidrBlock": { + "type": "string", + "description": "The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one." + }, + "enableDns64": { + "type": "boolean", + "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*." + }, + "enableLniAtDeviceIndex": { + "type": "integer", + "format": "int32", + "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1)." + }, + "ipv4IpamPoolId": { + "type": "string", + "description": "An IPv4 IPAM pool ID for the subnet." + }, + "ipv4NetmaskLength": { + "type": "integer", + "format": "int32", + "description": "An IPv4 netmask length for the subnet." + }, + "ipv6CidrBlock": { + "type": "string", + "description": "The IPv6 CIDR block. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." + }, + "ipv6CidrBlocks": { + "type": "array", + "description": "The IPv6 network ranges for the subnet, in CIDR notation.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "ipv6IpamPoolId": { + "type": "string", + "description": "An IPv6 IPAM pool ID for the subnet." + }, + "ipv6Native": { + "type": "boolean", + "description": "Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*." + }, + "ipv6NetmaskLength": { + "type": "integer", + "format": "int32", + "description": "An IPv6 netmask length for the subnet." + }, + "mapPublicIpOnLaunch": { + "type": "boolean", + "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://docs.aws.amazon.com/vpc/pricing/)." + }, + "networkAclAssociationId": { + "type": "string", + "description": "Property networkAclAssociationId" + }, + "outpostArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Outpost." + }, + "privateDnsNameOptionsOnLaunch": { + "$ref": "#/definitions/PrivateDnsNameOptionsOnLaunchModelProperties", + "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. Available options: + EnableResourceNameDnsAAAARecord (true | false) + EnableResourceNameDnsARecord (true | false) + HostnameType (ip-name | resource-name)" + }, + "subnetId": { + "type": "string", + "description": "Property subnetId" + }, + "tags": { + "type": "array", + "description": "Any tags assigned to the subnet.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC the subnet is in. If you update this property, you must also update the ``CidrBlock`` property." + } + } + }, + "Ec2Subnet": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2SubnetProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2SubnetListResult": { + "type": "object", + "description": "The response of a Ec2Subnet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Subnet items on this page", + "items": { + "$ref": "#/definitions/Ec2Subnet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2SubnetProperties": { + "type": "object", + "description": "Definition of Ec2Subnet", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2SubnetProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2SubnetTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Subnet resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PrivateDnsNameOptionsOnLaunchModelProperties": { + "type": "object", + "description": "Definition of PrivateDnsNameOptionsOnLaunchModelProperties", + "properties": { + "enableResourceNameDnsAAAARecord": { + "type": "boolean", + "description": "Property enableResourceNameDnsAAAARecord" + }, + "enableResourceNameDnsARecord": { + "type": "boolean", + "description": "Property enableResourceNameDnsARecord" + }, + "hostnameType": { + "type": "string", + "description": "Property hostnameType" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCEndpoint.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCEndpoint.json new file mode 100644 index 000000000000..2e44f929779a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCEndpoint.json @@ -0,0 +1,641 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2VPCEndpoints" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2VPCEndpoints": { + "get": { + "operationId": "Ec2VpcEndpoints_ListBySubscription", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "List Ec2VPCEndpoint resources 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/Ec2VPCEndpointListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcEndpoints_ListBySubscription": { + "$ref": "./examples/Ec2VpcEndpoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2VPCEndpoints": { + "get": { + "operationId": "Ec2VpcEndpoints_ListByResourceGroup", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "List Ec2VPCEndpoint resources 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/Ec2VPCEndpointListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcEndpoints_ListByResourceGroup": { + "$ref": "./examples/Ec2VpcEndpoints_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2VPCEndpoints/{name}": { + "get": { + "operationId": "Ec2VpcEndpoints_Get", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "Get a Ec2VPCEndpoint", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCEndpoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2VPCEndpoint" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcEndpoints_Get": { + "$ref": "./examples/Ec2VpcEndpoints_Get.json" + } + } + }, + "put": { + "operationId": "Ec2VpcEndpoints_CreateOrReplace", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "Create a Ec2VPCEndpoint. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCEndpoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VPCEndpoint" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2VPCEndpoint' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2VPCEndpoint" + } + }, + "201": { + "description": "Resource 'Ec2VPCEndpoint' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2VPCEndpoint" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2VpcEndpoints_CreateOrReplace": { + "$ref": "./examples/Ec2VpcEndpoints_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2VpcEndpoints_Update", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "Update a Ec2VPCEndpoint", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCEndpoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VPCEndpointTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2VPCEndpoint" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcEndpoints_Update": { + "$ref": "./examples/Ec2VpcEndpoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2VpcEndpoints_Delete", + "tags": [ + "Ec2VPCEndpoints" + ], + "description": "Delete a Ec2VPCEndpoint", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCEndpoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2VpcEndpoints_Delete": { + "$ref": "./examples/Ec2VpcEndpoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2VPCEndpointProperties": { + "type": "object", + "description": "Definition of awsEc2VPCEndpoint", + "properties": { + "creationTimestamp": { + "type": "string", + "description": "Property creationTimestamp" + }, + "dnsEntries": { + "type": "array", + "description": "Property dnsEntries", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "id": { + "type": "string", + "description": "Property id" + }, + "networkInterfaceIds": { + "type": "array", + "description": "Property networkInterfaceIds", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "policyDocument": { + "type": "object", + "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint.", + "additionalProperties": {} + }, + "privateDnsEnabled": { + "type": "boolean", + "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. This property is supported only for interface endpoints. Default: ``false``" + }, + "routeTableIds": { + "type": "array", + "description": "The IDs of the route tables. Routing is supported only for gateway endpoints.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "securityGroupIds": { + "type": "array", + "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "serviceName": { + "type": "string", + "description": "The name of the endpoint service." + }, + "subnetIds": { + "type": "array", + "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcEndpointType": { + "$ref": "#/definitions/VpcEndpointType", + "description": "The type of endpoint. Default: Gateway" + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC." + } + } + }, + "Ec2VPCEndpoint": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2VPCEndpointProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2VPCEndpointListResult": { + "type": "object", + "description": "The response of a Ec2VPCEndpoint list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2VPCEndpoint items on this page", + "items": { + "$ref": "#/definitions/Ec2VPCEndpoint" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2VPCEndpointProperties": { + "type": "object", + "description": "Definition of Ec2VPCEndpoint", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2VPCEndpointProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2VPCEndpointTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2VPCEndpoint resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "VpcEndpointType": { + "type": "string", + "description": "VpcEndpointType enum", + "enum": [ + "Gateway", + "GatewayLoadBalancer", + "Interface" + ], + "x-ms-enum": { + "name": "VpcEndpointType", + "modelAsString": true, + "values": [ + { + "name": "Gateway", + "value": "Gateway", + "description": "VpcEndpointType enum Gateway" + }, + { + "name": "GatewayLoadBalancer", + "value": "GatewayLoadBalancer", + "description": "VpcEndpointType enum GatewayLoadBalancer" + }, + { + "name": "Interface", + "value": "Interface", + "description": "VpcEndpointType enum Interface" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCPeeringConnection.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCPeeringConnection.json new file mode 100644 index 000000000000..335e3403636e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2VPCPeeringConnection.json @@ -0,0 +1,588 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2VPCPeeringConnections" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2VPCPeeringConnections": { + "get": { + "operationId": "Ec2VpcPeeringConnections_ListBySubscription", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "List Ec2VPCPeeringConnection resources 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/Ec2VPCPeeringConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcPeeringConnections_ListBySubscription": { + "$ref": "./examples/Ec2VpcPeeringConnections_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2VPCPeeringConnections": { + "get": { + "operationId": "Ec2VpcPeeringConnections_ListByResourceGroup", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "List Ec2VPCPeeringConnection resources 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/Ec2VPCPeeringConnectionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcPeeringConnections_ListByResourceGroup": { + "$ref": "./examples/Ec2VpcPeeringConnections_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2VPCPeeringConnections/{name}": { + "get": { + "operationId": "Ec2VpcPeeringConnections_Get", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "Get a Ec2VPCPeeringConnection", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCPeeringConnection", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcPeeringConnections_Get": { + "$ref": "./examples/Ec2VpcPeeringConnections_Get.json" + } + } + }, + "put": { + "operationId": "Ec2VpcPeeringConnections_CreateOrReplace", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "Create a Ec2VPCPeeringConnection. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCPeeringConnection", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2VPCPeeringConnection' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + } + }, + "201": { + "description": "Resource 'Ec2VPCPeeringConnection' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2VpcPeeringConnections_CreateOrReplace": { + "$ref": "./examples/Ec2VpcPeeringConnections_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2VpcPeeringConnections_Update", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "Update a Ec2VPCPeeringConnection", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCPeeringConnection", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnectionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2VpcPeeringConnections_Update": { + "$ref": "./examples/Ec2VpcPeeringConnections_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2VpcPeeringConnections_Delete", + "tags": [ + "Ec2VPCPeeringConnections" + ], + "description": "Delete a Ec2VPCPeeringConnection", + "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": "name", + "in": "path", + "description": "Name of Ec2VPCPeeringConnection", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2VpcPeeringConnections_Delete": { + "$ref": "./examples/Ec2VpcPeeringConnections_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2VPCPeeringConnectionProperties": { + "type": "object", + "description": "Definition of awsEc2VPCPeeringConnection", + "properties": { + "id": { + "type": "string", + "description": "Property id" + }, + "peerOwnerId": { + "type": "string", + "description": "The AWS account ID of the owner of the accepter VPC." + }, + "peerRegion": { + "type": "string", + "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request." + }, + "peerRoleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account." + }, + "peerVpcId": { + "type": "string", + "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request." + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "The ID of the VPC." + } + } + }, + "Ec2VPCPeeringConnection": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2VPCPeeringConnectionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2VPCPeeringConnectionListResult": { + "type": "object", + "description": "The response of a Ec2VPCPeeringConnection list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2VPCPeeringConnection items on this page", + "items": { + "$ref": "#/definitions/Ec2VPCPeeringConnection" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2VPCPeeringConnectionProperties": { + "type": "object", + "description": "Definition of Ec2VPCPeeringConnection", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2VPCPeeringConnectionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2VPCPeeringConnectionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2VPCPeeringConnection resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Volume.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Volume.json new file mode 100644 index 000000000000..01e234c20d5d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Volume.json @@ -0,0 +1,615 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Volumes" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Volumes": { + "get": { + "operationId": "Ec2Volumes_ListBySubscription", + "tags": [ + "Ec2Volumes" + ], + "description": "List Ec2Volume resources 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/Ec2VolumeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Volumes_ListBySubscription": { + "$ref": "./examples/Ec2Volumes_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Volumes": { + "get": { + "operationId": "Ec2Volumes_ListByResourceGroup", + "tags": [ + "Ec2Volumes" + ], + "description": "List Ec2Volume resources 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/Ec2VolumeListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Volumes_ListByResourceGroup": { + "$ref": "./examples/Ec2Volumes_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Volumes/{name}": { + "get": { + "operationId": "Ec2Volumes_Get", + "tags": [ + "Ec2Volumes" + ], + "description": "Get a Ec2Volume", + "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": "name", + "in": "path", + "description": "Name of Ec2Volume", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Volume" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Volumes_Get": { + "$ref": "./examples/Ec2Volumes_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Volumes_CreateOrReplace", + "tags": [ + "Ec2Volumes" + ], + "description": "Create a Ec2Volume. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Volume", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Volume" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Volume' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Volume" + } + }, + "201": { + "description": "Resource 'Ec2Volume' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Volume" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Volumes_CreateOrReplace": { + "$ref": "./examples/Ec2Volumes_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Volumes_Update", + "tags": [ + "Ec2Volumes" + ], + "description": "Update a Ec2Volume", + "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": "name", + "in": "path", + "description": "Name of Ec2Volume", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VolumeTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Volume" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Volumes_Update": { + "$ref": "./examples/Ec2Volumes_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Volumes_Delete", + "tags": [ + "Ec2Volumes" + ], + "description": "Delete a Ec2Volume", + "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": "name", + "in": "path", + "description": "Name of Ec2Volume", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Volumes_Delete": { + "$ref": "./examples/Ec2Volumes_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2VolumeProperties": { + "type": "object", + "description": "Definition of awsEc2Volume", + "properties": { + "autoEnableIO": { + "type": "boolean", + "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O." + }, + "availabilityZone": { + "type": "string", + "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``." + }, + "encrypted": { + "type": "boolean", + "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances)." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes." + }, + "kmsKeyId": { + "type": "string", + "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias." + }, + "multiAttachEnabled": { + "type": "boolean", + "description": "Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume." + }, + "outpostArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Outpost." + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + ``gp2`` and ``gp3``: 1 - 16,384 GiB + ``io1``: 4 - 16,384 GiB + ``io2``: 4 - 65,536 GiB + ``st1`` and ``sc1``: 125 - 16,384 GiB + ``standard``: 1 - 1024 GiB" + }, + "snapshotId": { + "type": "string", + "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size." + }, + "tags": { + "type": "array", + "description": "The tags to apply to the volume during creation.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000." + }, + "volumeId": { + "type": "string", + "description": "Property volumeId" + }, + "volumeType": { + "type": "string", + "description": "The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. Default: ``gp2``" + } + } + }, + "Ec2Volume": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2VolumeProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2VolumeListResult": { + "type": "object", + "description": "The response of a Ec2Volume list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Volume items on this page", + "items": { + "$ref": "#/definitions/Ec2Volume" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2VolumeProperties": { + "type": "object", + "description": "Definition of Ec2Volume", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2VolumeProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2VolumeTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Volume resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Vpc.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Vpc.json new file mode 100644 index 000000000000..8977a83d2a5a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ec2Vpc.json @@ -0,0 +1,617 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Ec2Vpcs" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ec2Vpcs": { + "get": { + "operationId": "Ec2Vpcs_ListBySubscription", + "tags": [ + "Ec2Vpcs" + ], + "description": "List Ec2Vpc resources 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/Ec2VpcListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Vpcs_ListBySubscription": { + "$ref": "./examples/Ec2Vpcs_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Vpcs": { + "get": { + "operationId": "Ec2Vpcs_ListByResourceGroup", + "tags": [ + "Ec2Vpcs" + ], + "description": "List Ec2Vpc resources 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/Ec2VpcListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Vpcs_ListByResourceGroup": { + "$ref": "./examples/Ec2Vpcs_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ec2Vpcs/{name}": { + "get": { + "operationId": "Ec2Vpcs_Get", + "tags": [ + "Ec2Vpcs" + ], + "description": "Get a Ec2Vpc", + "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": "name", + "in": "path", + "description": "Name of Ec2Vpc", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Vpc" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Vpcs_Get": { + "$ref": "./examples/Ec2Vpcs_Get.json" + } + } + }, + "put": { + "operationId": "Ec2Vpcs_CreateOrReplace", + "tags": [ + "Ec2Vpcs" + ], + "description": "Create a Ec2Vpc. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Ec2Vpc", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2Vpc" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Ec2Vpc' update operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Vpc" + } + }, + "201": { + "description": "Resource 'Ec2Vpc' create operation succeeded", + "schema": { + "$ref": "#/definitions/Ec2Vpc" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Ec2Vpcs_CreateOrReplace": { + "$ref": "./examples/Ec2Vpcs_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Ec2Vpcs_Update", + "tags": [ + "Ec2Vpcs" + ], + "description": "Update a Ec2Vpc", + "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": "name", + "in": "path", + "description": "Name of Ec2Vpc", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Ec2VpcTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Ec2Vpc" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ec2Vpcs_Update": { + "$ref": "./examples/Ec2Vpcs_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Ec2Vpcs_Delete", + "tags": [ + "Ec2Vpcs" + ], + "description": "Delete a Ec2Vpc", + "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": "name", + "in": "path", + "description": "Name of Ec2Vpc", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Ec2Vpcs_Delete": { + "$ref": "./examples/Ec2Vpcs_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEc2VpcProperties": { + "type": "object", + "description": "Definition of awsEc2Vpc", + "properties": { + "cidrBlock": { + "type": "string", + "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." + }, + "cidrBlockAssociations": { + "type": "array", + "description": "Property cidrBlockAssociations", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "defaultNetworkAcl": { + "type": "string", + "description": "Property defaultNetworkAcl" + }, + "defaultSecurityGroup": { + "type": "string", + "description": "Property defaultSecurityGroup" + }, + "enableDnsHostnames": { + "type": "boolean", + "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). You can only enable DNS hostnames if you've enabled DNS support." + }, + "enableDnsSupport": { + "type": "boolean", + "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range 'plus two' succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support)." + }, + "instanceTenancy": { + "type": "string", + "description": "The allowed tenancy of instances launched into the VPC. + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement." + }, + "ipv4IpamPoolId": { + "type": "string", + "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." + }, + "ipv4NetmaskLength": { + "type": "integer", + "format": "int32", + "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*." + }, + "ipv6CidrBlocks": { + "type": "array", + "description": "Property ipv6CidrBlocks", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "The tags for the VPC.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "Property vpcId" + } + } + }, + "Ec2Vpc": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Ec2VpcProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Ec2VpcListResult": { + "type": "object", + "description": "The response of a Ec2Vpc list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Ec2Vpc items on this page", + "items": { + "$ref": "#/definitions/Ec2Vpc" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Ec2VpcProperties": { + "type": "object", + "description": "Definition of Ec2Vpc", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEc2VpcProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Ec2VpcTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Ec2Vpc resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrImageDetail.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrImageDetail.json new file mode 100644 index 000000000000..95a2a55dde67 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrImageDetail.json @@ -0,0 +1,701 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EcrImageDetails" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ecrImageDetails": { + "get": { + "operationId": "EcrImageDetails_ListBySubscription", + "tags": [ + "EcrImageDetails" + ], + "description": "List EcrImageDetail resources 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/EcrImageDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrImageDetails_ListBySubscription": { + "$ref": "./examples/EcrImageDetails_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecrImageDetails": { + "get": { + "operationId": "EcrImageDetails_ListByResourceGroup", + "tags": [ + "EcrImageDetails" + ], + "description": "List EcrImageDetail resources 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/EcrImageDetailListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrImageDetails_ListByResourceGroup": { + "$ref": "./examples/EcrImageDetails_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecrImageDetails/{name}": { + "get": { + "operationId": "EcrImageDetails_Get", + "tags": [ + "EcrImageDetails" + ], + "description": "Get a EcrImageDetail", + "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": "name", + "in": "path", + "description": "Name of EcrImageDetail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcrImageDetail" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrImageDetails_Get": { + "$ref": "./examples/EcrImageDetails_Get.json" + } + } + }, + "put": { + "operationId": "EcrImageDetails_CreateOrReplace", + "tags": [ + "EcrImageDetails" + ], + "description": "Create a EcrImageDetail. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EcrImageDetail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EcrImageDetail" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EcrImageDetail' update operation succeeded", + "schema": { + "$ref": "#/definitions/EcrImageDetail" + } + }, + "201": { + "description": "Resource 'EcrImageDetail' create operation succeeded", + "schema": { + "$ref": "#/definitions/EcrImageDetail" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EcrImageDetails_CreateOrReplace": { + "$ref": "./examples/EcrImageDetails_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EcrImageDetails_Update", + "tags": [ + "EcrImageDetails" + ], + "description": "Update a EcrImageDetail", + "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": "name", + "in": "path", + "description": "Name of EcrImageDetail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EcrImageDetailTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcrImageDetail" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrImageDetails_Update": { + "$ref": "./examples/EcrImageDetails_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EcrImageDetails_Delete", + "tags": [ + "EcrImageDetails" + ], + "description": "Delete a EcrImageDetail", + "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": "name", + "in": "path", + "description": "Name of EcrImageDetail", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EcrImageDetails_Delete": { + "$ref": "./examples/EcrImageDetails_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEcrImageDetailProperties": { + "type": "object", + "description": "Definition of awsEcrImageDetail", + "properties": { + "artifactMediaType": { + "type": "string", + "description": "<p>The artifact media type of the image.</p>" + }, + "imageDigest": { + "type": "string", + "description": "<p>The <code>sha256</code> digest of the image manifest.</p>" + }, + "imageManifestMediaType": { + "type": "string", + "description": "<p>The media type of the image manifest.</p>" + }, + "imagePushedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. </p>" + }, + "imageScanFindingsSummary": { + "$ref": "#/definitions/ImageScanFindingsSummary", + "description": "<p>A summary of the last completed image scan.</p>" + }, + "imageScanStatus": { + "$ref": "#/definitions/ImageScanStatus", + "description": "<p>The current state of the scan.</p>" + }, + "imageSizeInBytes": { + "type": "integer", + "format": "int64", + "description": "<p>The size, in bytes, of the image in the repository.</p> <p>If the image is a manifest list, this will be the max size of all manifests in the list.</p> <note> <p>Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the <code>docker images</code> command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by <a>DescribeImages</a>.</p> </note>" + }, + "imageTags": { + "type": "array", + "description": "<p>The list of tags associated with this image.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "lastRecordedPullTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.</p> <note> <p>Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the <code>lastRecordedPullTime</code> timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the <code>lastRecordedPullTime</code> timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.</p> </note>" + }, + "registryId": { + "type": "string", + "description": "<p>The Amazon Web Services account ID associated with the registry to which this image belongs.</p>" + }, + "repositoryName": { + "type": "string", + "description": "<p>The name of the repository to which this image belongs.</p>" + } + } + }, + "EcrImageDetail": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EcrImageDetailProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EcrImageDetailListResult": { + "type": "object", + "description": "The response of a EcrImageDetail list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EcrImageDetail items on this page", + "items": { + "$ref": "#/definitions/EcrImageDetail" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EcrImageDetailProperties": { + "type": "object", + "description": "Definition of EcrImageDetail", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEcrImageDetailProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EcrImageDetailTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EcrImageDetail resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ImageScanFindingsSummary": { + "type": "object", + "description": "Definition of ImageScanFindingsSummary", + "properties": { + "findingSeverityCounts": { + "type": "object", + "description": "<p>The image vulnerability counts, sorted by severity.</p>", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + }, + "imageScanCompletedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The time of the last completed image scan.</p>" + }, + "vulnerabilitySourceUpdatedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The time when the vulnerability data was last scanned.</p>" + } + } + }, + "ImageScanStatus": { + "type": "object", + "description": "Definition of ImageScanStatus", + "properties": { + "description": { + "type": "string", + "description": "<p>The description of the image scan status.</p>" + }, + "status": { + "$ref": "#/definitions/ScanStatusEnumValue", + "description": "<p>The current state of an image scan.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ScanStatus": { + "type": "string", + "description": "ScanStatus enum", + "enum": [ + "ACTIVE", + "COMPLETE", + "FAILED", + "FINDINGS_UNAVAILABLE", + "IN_PROGRESS", + "PENDING", + "SCAN_ELIGIBILITY_EXPIRED", + "UNSUPPORTED_IMAGE" + ], + "x-ms-enum": { + "name": "ScanStatus", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "ScanStatus enum ACTIVE" + }, + { + "name": "COMPLETE", + "value": "COMPLETE", + "description": "ScanStatus enum COMPLETE" + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "ScanStatus enum FAILED" + }, + { + "name": "FINDINGS_UNAVAILABLE", + "value": "FINDINGS_UNAVAILABLE", + "description": "ScanStatus enum FINDINGS_UNAVAILABLE" + }, + { + "name": "IN_PROGRESS", + "value": "IN_PROGRESS", + "description": "ScanStatus enum IN_PROGRESS" + }, + { + "name": "PENDING", + "value": "PENDING", + "description": "ScanStatus enum PENDING" + }, + { + "name": "SCAN_ELIGIBILITY_EXPIRED", + "value": "SCAN_ELIGIBILITY_EXPIRED", + "description": "ScanStatus enum SCAN_ELIGIBILITY_EXPIRED" + }, + { + "name": "UNSUPPORTED_IMAGE", + "value": "UNSUPPORTED_IMAGE", + "description": "ScanStatus enum UNSUPPORTED_IMAGE" + } + ] + } + }, + "ScanStatusEnumValue": { + "type": "object", + "description": "Definition of ScanStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ScanStatus", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrRepository.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrRepository.json new file mode 100644 index 000000000000..4acd74bd7d72 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecrRepository.json @@ -0,0 +1,687 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EcrRepositories" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ecrRepositories": { + "get": { + "operationId": "EcrRepositories_ListBySubscription", + "tags": [ + "EcrRepositories" + ], + "description": "List EcrRepository resources 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/EcrRepositoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrRepositories_ListBySubscription": { + "$ref": "./examples/EcrRepositories_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecrRepositories": { + "get": { + "operationId": "EcrRepositories_ListByResourceGroup", + "tags": [ + "EcrRepositories" + ], + "description": "List EcrRepository resources 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/EcrRepositoryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrRepositories_ListByResourceGroup": { + "$ref": "./examples/EcrRepositories_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecrRepositories/{name}": { + "get": { + "operationId": "EcrRepositories_Get", + "tags": [ + "EcrRepositories" + ], + "description": "Get a EcrRepository", + "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": "name", + "in": "path", + "description": "Name of EcrRepository", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcrRepository" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrRepositories_Get": { + "$ref": "./examples/EcrRepositories_Get.json" + } + } + }, + "put": { + "operationId": "EcrRepositories_CreateOrReplace", + "tags": [ + "EcrRepositories" + ], + "description": "Create a EcrRepository. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EcrRepository", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EcrRepository" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EcrRepository' update operation succeeded", + "schema": { + "$ref": "#/definitions/EcrRepository" + } + }, + "201": { + "description": "Resource 'EcrRepository' create operation succeeded", + "schema": { + "$ref": "#/definitions/EcrRepository" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EcrRepositories_CreateOrReplace": { + "$ref": "./examples/EcrRepositories_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EcrRepositories_Update", + "tags": [ + "EcrRepositories" + ], + "description": "Update a EcrRepository", + "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": "name", + "in": "path", + "description": "Name of EcrRepository", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EcrRepositoryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcrRepository" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcrRepositories_Update": { + "$ref": "./examples/EcrRepositories_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EcrRepositories_Delete", + "tags": [ + "EcrRepositories" + ], + "description": "Delete a EcrRepository", + "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": "name", + "in": "path", + "description": "Name of EcrRepository", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EcrRepositories_Delete": { + "$ref": "./examples/EcrRepositories_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEcrRepositoryProperties": { + "type": "object", + "description": "Definition of awsEcrRepository", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "emptyOnDelete": { + "type": "boolean", + "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories." + }, + "encryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration", + "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*." + }, + "imageScanningConfiguration": { + "$ref": "#/definitions/ImageScanningConfiguration", + "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. The image scanning configuration for a repository." + }, + "imageTagMutability": { + "$ref": "#/definitions/ImageTagMutability", + "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten." + }, + "lifecyclePolicy": { + "$ref": "#/definitions/LifecyclePolicy", + "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*." + }, + "repositoryName": { + "type": "string", + "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "repositoryPolicyText": { + "type": "object", + "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*.", + "additionalProperties": {} + }, + "repositoryUri": { + "type": "string", + "description": "Property repositoryUri" + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "EcrRepository": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EcrRepositoryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EcrRepositoryListResult": { + "type": "object", + "description": "The response of a EcrRepository list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EcrRepository items on this page", + "items": { + "$ref": "#/definitions/EcrRepository" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EcrRepositoryProperties": { + "type": "object", + "description": "Definition of EcrRepository", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEcrRepositoryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EcrRepositoryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EcrRepository resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EncryptionConfiguration": { + "type": "object", + "description": "Definition of EncryptionConfiguration", + "properties": { + "encryptionType": { + "$ref": "#/definitions/EncryptionConfigurationEncryptionType", + "description": "The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use." + }, + "kmsKey": { + "type": "string", + "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used." + } + } + }, + "EncryptionConfigurationEncryptionType": { + "type": "string", + "description": "EncryptionConfigurationEncryptionType enum", + "enum": [ + "AES256", + "KMS" + ], + "x-ms-enum": { + "name": "EncryptionConfigurationEncryptionType", + "modelAsString": true, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "EncryptionConfigurationEncryptionType enum AES256" + }, + { + "name": "KMS", + "value": "KMS", + "description": "EncryptionConfigurationEncryptionType enum KMS" + } + ] + } + }, + "ImageScanningConfiguration": { + "type": "object", + "description": "Definition of ImageScanningConfiguration", + "properties": { + "scanOnPush": { + "type": "boolean", + "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. The setting that determines whether images are scanned after being pushed to a repository." + } + } + }, + "ImageTagMutability": { + "type": "string", + "description": "ImageTagMutability enum", + "enum": [ + "IMMUTABLE", + "MUTABLE" + ], + "x-ms-enum": { + "name": "ImageTagMutability", + "modelAsString": true, + "values": [ + { + "name": "IMMUTABLE", + "value": "IMMUTABLE", + "description": "ImageTagMutability enum IMMUTABLE" + }, + { + "name": "MUTABLE", + "value": "MUTABLE", + "description": "ImageTagMutability enum MUTABLE" + } + ] + } + }, + "LifecyclePolicy": { + "type": "object", + "description": "Definition of LifecyclePolicy", + "properties": { + "lifecyclePolicyText": { + "type": "string", + "description": "The JSON repository policy text to apply to the repository. The JSON repository policy text to apply to the repository." + }, + "registryId": { + "type": "string", + "description": "The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed. The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "value": { + "type": "string", + "description": "A ``value`` acts as a descriptor within a tag category (key)." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsCluster.json new file mode 100644 index 000000000000..eee0aa9f572e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsCluster.json @@ -0,0 +1,702 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EcsClusters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ecsClusters": { + "get": { + "operationId": "EcsClusters_ListBySubscription", + "tags": [ + "EcsClusters" + ], + "description": "List EcsCluster resources 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/EcsClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsClusters_ListBySubscription": { + "$ref": "./examples/EcsClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsClusters": { + "get": { + "operationId": "EcsClusters_ListByResourceGroup", + "tags": [ + "EcsClusters" + ], + "description": "List EcsCluster resources 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/EcsClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsClusters_ListByResourceGroup": { + "$ref": "./examples/EcsClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsClusters/{name}": { + "get": { + "operationId": "EcsClusters_Get", + "tags": [ + "EcsClusters" + ], + "description": "Get a EcsCluster", + "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": "name", + "in": "path", + "description": "Name of EcsCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsClusters_Get": { + "$ref": "./examples/EcsClusters_Get.json" + } + } + }, + "put": { + "operationId": "EcsClusters_CreateOrReplace", + "tags": [ + "EcsClusters" + ], + "description": "Create a EcsCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EcsCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EcsCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/EcsCluster" + } + }, + "201": { + "description": "Resource 'EcsCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/EcsCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EcsClusters_CreateOrReplace": { + "$ref": "./examples/EcsClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EcsClusters_Update", + "tags": [ + "EcsClusters" + ], + "description": "Update a EcsCluster", + "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": "name", + "in": "path", + "description": "Name of EcsCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsClusterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsCluster" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsClusters_Update": { + "$ref": "./examples/EcsClusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EcsClusters_Delete", + "tags": [ + "EcsClusters" + ], + "description": "Delete a EcsCluster", + "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": "name", + "in": "path", + "description": "Name of EcsCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EcsClusters_Delete": { + "$ref": "./examples/EcsClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEcsClusterProperties": { + "type": "object", + "description": "Definition of awsEcsCluster", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "capacityProviders": { + "type": "array", + "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "clusterName": { + "type": "string", + "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name." + }, + "clusterSettings": { + "type": "array", + "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.", + "items": { + "$ref": "#/definitions/ClusterSettings" + }, + "x-ms-identifiers": [] + }, + "configuration": { + "$ref": "#/definitions/ClusterConfiguration", + "description": "The execute command configuration for the cluster. The execute command configuration for the cluster." + }, + "defaultCapacityProviderStrategy": { + "type": "array", + "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.", + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "x-ms-identifiers": [] + }, + "serviceConnectDefaults": { + "$ref": "#/definitions/ServiceConnectDefaults", + "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "tags": { + "type": "array", + "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "CapacityProviderStrategyItem": { + "type": "object", + "description": "Definition of CapacityProviderStrategyItem", + "properties": { + "base": { + "type": "integer", + "format": "int32", + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." + }, + "capacityProvider": { + "type": "string", + "description": "The short name of the capacity provider." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." + } + } + }, + "ClusterConfiguration": { + "type": "object", + "description": "Definition of ClusterConfiguration", + "properties": { + "executeCommandConfiguration": { + "$ref": "#/definitions/ExecuteCommandConfiguration", + "description": "The details of the execute command configuration. The details of the execute command configuration." + } + } + }, + "ClusterSettings": { + "type": "object", + "description": "Definition of ClusterSettings", + "properties": { + "name": { + "type": "string", + "description": "The name of the cluster setting. The value is ``containerInsights`` ." + }, + "value": { + "type": "string", + "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)." + } + } + }, + "EcsCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EcsClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EcsClusterListResult": { + "type": "object", + "description": "The response of a EcsCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EcsCluster items on this page", + "items": { + "$ref": "#/definitions/EcsCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EcsClusterProperties": { + "type": "object", + "description": "Definition of EcsCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEcsClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EcsClusterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EcsCluster resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ExecuteCommandConfiguration": { + "type": "object", + "description": "Definition of ExecuteCommandConfiguration", + "properties": { + "kmsKeyId": { + "type": "string", + "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container." + }, + "logConfiguration": { + "$ref": "#/definitions/ExecuteCommandLogConfiguration", + "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket." + }, + "logging": { + "type": "string", + "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available. + ``NONE``: The execute command session is not logged. + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required." + } + } + }, + "ExecuteCommandLogConfiguration": { + "type": "object", + "description": "Definition of ExecuteCommandLogConfiguration", + "properties": { + "cloudWatchEncryptionEnabled": { + "type": "boolean", + "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off." + }, + "cloudWatchLogGroupName": { + "type": "string", + "description": "The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created." + }, + "s3BucketName": { + "type": "string", + "description": "The name of the S3 bucket to send logs to. The S3 bucket must already be created." + }, + "s3EncryptionEnabled": { + "type": "boolean", + "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used." + }, + "s3KeyPrefix": { + "type": "string", + "description": "An optional folder in the S3 bucket to place logs in." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ServiceConnectDefaults": { + "type": "object", + "description": "Definition of ServiceConnectDefaults", + "properties": { + "namespace": { + "type": "string", + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the 'API calls' method of instance discovery only. This instance discovery method is the 'HTTP' namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. If you update the cluster with an empty string ``''`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "value": { + "type": "string", + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsService.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsService.json new file mode 100644 index 000000000000..e81ff5a90b27 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsService.json @@ -0,0 +1,1342 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EcsServices" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ecsServices": { + "get": { + "operationId": "EcsServices_ListBySubscription", + "tags": [ + "EcsServices" + ], + "description": "List EcsService resources 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/EcsServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsServices_ListBySubscription": { + "$ref": "./examples/EcsServices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsServices": { + "get": { + "operationId": "EcsServices_ListByResourceGroup", + "tags": [ + "EcsServices" + ], + "description": "List EcsService resources 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/EcsServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsServices_ListByResourceGroup": { + "$ref": "./examples/EcsServices_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsServices/{name}": { + "get": { + "operationId": "EcsServices_Get", + "tags": [ + "EcsServices" + ], + "description": "Get a EcsService", + "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": "name", + "in": "path", + "description": "Name of EcsService", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsService" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsServices_Get": { + "$ref": "./examples/EcsServices_Get.json" + } + } + }, + "put": { + "operationId": "EcsServices_CreateOrReplace", + "tags": [ + "EcsServices" + ], + "description": "Create a EcsService. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EcsService", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsService" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EcsService' update operation succeeded", + "schema": { + "$ref": "#/definitions/EcsService" + } + }, + "201": { + "description": "Resource 'EcsService' create operation succeeded", + "schema": { + "$ref": "#/definitions/EcsService" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EcsServices_CreateOrReplace": { + "$ref": "./examples/EcsServices_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EcsServices_Update", + "tags": [ + "EcsServices" + ], + "description": "Update a EcsService", + "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": "name", + "in": "path", + "description": "Name of EcsService", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsServiceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsService" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsServices_Update": { + "$ref": "./examples/EcsServices_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EcsServices_Delete", + "tags": [ + "EcsServices" + ], + "description": "Delete a EcsService", + "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": "name", + "in": "path", + "description": "Name of EcsService", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EcsServices_Delete": { + "$ref": "./examples/EcsServices_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEcsServiceProperties": { + "type": "object", + "description": "Definition of awsEcsService", + "properties": { + "capacityProviderStrategy": { + "type": "array", + "description": "The capacity provider strategy to use for the service. If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers.", + "items": { + "$ref": "#/definitions/CapacityProviderStrategyItem" + }, + "x-ms-identifiers": [] + }, + "cluster": { + "type": "string", + "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." + }, + "deploymentController": { + "$ref": "#/definitions/DeploymentController", + "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "desiredCount": { + "type": "integer", + "format": "int32", + "description": "The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation." + }, + "enableECSManagedTags": { + "type": "boolean", + "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter." + }, + "enableExecuteCommand": { + "type": "boolean", + "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service." + }, + "healthCheckGracePeriodSeconds": { + "type": "integer", + "format": "int32", + "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up." + }, + "launchType": { + "$ref": "#/definitions/LaunchType", + "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "loadBalancers": { + "type": "array", + "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "Property name" + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service." + }, + "placementConstraints": { + "type": "array", + "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.", + "items": { + "$ref": "#/definitions/PlacementConstraint" + }, + "x-ms-identifiers": [] + }, + "placementStrategies": { + "type": "array", + "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.", + "items": { + "$ref": "#/definitions/PlacementStrategy" + }, + "x-ms-identifiers": [] + }, + "platformVersion": { + "type": "string", + "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", + "default": "LATEST" + }, + "propagateTags": { + "$ref": "#/definitions/PropagateTags", + "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``." + }, + "role": { + "type": "string", + "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*." + }, + "schedulingStrategy": { + "$ref": "#/definitions/SchedulingStrategy", + "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy." + }, + "serviceArn": { + "type": "string", + "description": "Property serviceArn" + }, + "serviceConnectConfiguration": { + "$ref": "#/definitions/ServiceConnectConfiguration", + "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "serviceName": { + "type": "string", + "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster." + }, + "serviceRegistries": { + "type": "array", + "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries for each service isn't supported.", + "items": { + "$ref": "#/definitions/ServiceRegistry" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "taskDefinition": { + "type": "string", + "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)." + }, + "volumeConfigurations": { + "type": "array", + "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.", + "items": { + "$ref": "#/definitions/ServiceVolumeConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "AwsVpcConfiguration": { + "type": "object", + "description": "Definition of AwsVpcConfiguration", + "properties": { + "assignPublicIp": { + "$ref": "#/definitions/AwsVpcConfigurationAssignPublicIp", + "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``." + }, + "securityGroups": { + "type": "array", + "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. All specified security groups must be from the same VPC.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. All specified subnets must be from the same VPC.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "AwsVpcConfigurationAssignPublicIp": { + "type": "string", + "description": "AwsVpcConfigurationAssignPublicIp enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "AwsVpcConfigurationAssignPublicIp", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "AwsVpcConfigurationAssignPublicIp enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "AwsVpcConfigurationAssignPublicIp enum ENABLED" + } + ] + } + }, + "CapacityProviderStrategyItem": { + "type": "object", + "description": "Definition of CapacityProviderStrategyItem", + "properties": { + "base": { + "type": "integer", + "format": "int32", + "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." + }, + "capacityProvider": { + "type": "string", + "description": "The short name of the capacity provider." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." + } + } + }, + "DeploymentAlarms": { + "type": "object", + "description": "Definition of DeploymentAlarms", + "properties": { + "alarmNames": { + "type": "array", + "description": "One or more CloudWatch alarm names. Use a ',' to separate the alarms.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "enable": { + "type": "boolean", + "description": "Determines whether to use the CloudWatch alarm option in the service deployment process." + }, + "rollback": { + "type": "boolean", + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." + } + } + }, + "DeploymentCircuitBreaker": { + "type": "object", + "description": "Definition of DeploymentCircuitBreaker", + "properties": { + "enable": { + "type": "boolean", + "description": "Determines whether to use the deployment circuit breaker logic for the service." + }, + "rollback": { + "type": "boolean", + "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." + } + } + }, + "DeploymentConfiguration": { + "type": "object", + "description": "Definition of DeploymentConfiguration", + "properties": { + "alarms": { + "$ref": "#/definitions/DeploymentAlarms", + "description": "Information about the CloudWatch alarms. One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update). For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "deploymentCircuitBreaker": { + "$ref": "#/definitions/DeploymentCircuitBreaker", + "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "maximumPercent": { + "type": "integer", + "format": "int32", + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service." + }, + "minimumHealthyPercent": { + "type": "integer", + "format": "int32", + "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that *do not* use a load balancer, the following should be noted: + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services that *do* use a load balancer, the following should be noted: + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service." + } + } + }, + "DeploymentController": { + "type": "object", + "description": "Definition of DeploymentController", + "properties": { + "type": { + "$ref": "#/definitions/DeploymentControllerType", + "description": "The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service." + } + } + }, + "DeploymentControllerType": { + "type": "string", + "description": "DeploymentControllerType enum", + "enum": [ + "CODE_DEPLOY", + "ECS", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "DeploymentControllerType", + "modelAsString": true, + "values": [ + { + "name": "CODE_DEPLOY", + "value": "CODE_DEPLOY", + "description": "DeploymentControllerType enum CODE_DEPLOY" + }, + { + "name": "ECS", + "value": "ECS", + "description": "DeploymentControllerType enum ECS" + }, + { + "name": "EXTERNAL", + "value": "EXTERNAL", + "description": "DeploymentControllerType enum EXTERNAL" + } + ] + } + }, + "EBSTagSpecification": { + "type": "object", + "description": "Definition of EBSTagSpecification", + "properties": { + "propagateTags": { + "$ref": "#/definitions/EBSTagSpecificationPropagateTags", + "description": "Determines whether to propagate the tags from the task definition to 
the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in 
``ServiceVolumeConfiguration``. If no value is specified, the tags aren't 
propagated." + }, + "resourceType": { + "type": "string", + "description": "The type of volume resource." + }, + "tags": { + "type": "array", + "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "EBSTagSpecificationPropagateTags": { + "type": "string", + "description": "EBSTagSpecificationPropagateTags enum", + "enum": [ + "SERVICE", + "TASK_DEFINITION" + ], + "x-ms-enum": { + "name": "EBSTagSpecificationPropagateTags", + "modelAsString": true, + "values": [ + { + "name": "SERVICE", + "value": "SERVICE", + "description": "EBSTagSpecificationPropagateTags enum SERVICE" + }, + { + "name": "TASK_DEFINITION", + "value": "TASK_DEFINITION", + "description": "EBSTagSpecificationPropagateTags enum TASK_DEFINITION" + } + ] + } + }, + "EcsService": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EcsServiceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EcsServiceListResult": { + "type": "object", + "description": "The response of a EcsService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EcsService items on this page", + "items": { + "$ref": "#/definitions/EcsService" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EcsServiceProperties": { + "type": "object", + "description": "Definition of EcsService", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEcsServiceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EcsServiceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EcsService resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "LaunchType": { + "type": "string", + "description": "LaunchType enum", + "enum": [ + "EC2", + "EXTERNAL", + "FARGATE" + ], + "x-ms-enum": { + "name": "LaunchType", + "modelAsString": true, + "values": [ + { + "name": "EC2", + "value": "EC2", + "description": "LaunchType enum EC2" + }, + { + "name": "EXTERNAL", + "value": "EXTERNAL", + "description": "LaunchType enum EXTERNAL" + }, + { + "name": "FARGATE", + "value": "FARGATE", + "description": "LaunchType enum FARGATE" + } + ] + } + }, + "LoadBalancer": { + "type": "object", + "description": "Definition of LoadBalancer", + "properties": { + "containerName": { + "type": "string", + "description": "The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer." + }, + "containerPort": { + "type": "integer", + "format": "int32", + "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping." + }, + "loadBalancerName": { + "type": "string", + "description": "The name of the load balancer to associate with the Amazon ECS service or task set. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted." + }, + "targetGroupArn": { + "type": "string", + "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type." + } + } + }, + "LogConfiguration": { + "type": "object", + "description": "Definition of LogConfiguration", + "properties": { + "logDriver": { + "type": "string", + "description": "The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." + }, + "options": { + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "secretOptions": { + "type": "array", + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/Secret" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkConfiguration": { + "type": "object", + "description": "Definition of NetworkConfiguration", + "properties": { + "awsvpcConfiguration": { + "$ref": "#/definitions/AwsVpcConfiguration", + "description": "The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC. An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=['subnet-12344321'],securityGroups=['sg-12344321']}``" + } + } + }, + "PlacementConstraint": { + "type": "object", + "description": "Definition of PlacementConstraint", + "properties": { + "expression": { + "type": "string", + "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "type": { + "$ref": "#/definitions/PlacementConstraintType", + "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates." + } + } + }, + "PlacementConstraintType": { + "type": "string", + "description": "PlacementConstraintType enum", + "enum": [ + "distinctInstance", + "memberOf" + ], + "x-ms-enum": { + "name": "PlacementConstraintType", + "modelAsString": true, + "values": [ + { + "name": "distinctInstance", + "value": "distinctInstance", + "description": "PlacementConstraintType enum distinctInstance" + }, + { + "name": "memberOf", + "value": "memberOf", + "description": "PlacementConstraintType enum memberOf" + } + ] + } + }, + "PlacementStrategy": { + "type": "object", + "description": "Definition of PlacementStrategy", + "properties": { + "field": { + "type": "string", + "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used." + }, + "type": { + "$ref": "#/definitions/PlacementStrategyType", + "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task." + } + } + }, + "PlacementStrategyType": { + "type": "string", + "description": "PlacementStrategyType enum", + "enum": [ + "binpack", + "random", + "spread" + ], + "x-ms-enum": { + "name": "PlacementStrategyType", + "modelAsString": true, + "values": [ + { + "name": "binpack", + "value": "binpack", + "description": "PlacementStrategyType enum binpack" + }, + { + "name": "random", + "value": "random", + "description": "PlacementStrategyType enum random" + }, + { + "name": "spread", + "value": "spread", + "description": "PlacementStrategyType enum spread" + } + ] + } + }, + "PropagateTags": { + "type": "string", + "description": "PropagateTags enum", + "enum": [ + "SERVICE", + "TASK_DEFINITION" + ], + "x-ms-enum": { + "name": "PropagateTags", + "modelAsString": true, + "values": [ + { + "name": "SERVICE", + "value": "SERVICE", + "description": "PropagateTags enum SERVICE" + }, + { + "name": "TASK_DEFINITION", + "value": "TASK_DEFINITION", + "description": "PropagateTags enum TASK_DEFINITION" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SchedulingStrategy": { + "type": "string", + "description": "SchedulingStrategy enum", + "enum": [ + "DAEMON", + "REPLICA" + ], + "x-ms-enum": { + "name": "SchedulingStrategy", + "modelAsString": true, + "values": [ + { + "name": "DAEMON", + "value": "DAEMON", + "description": "SchedulingStrategy enum DAEMON" + }, + { + "name": "REPLICA", + "value": "REPLICA", + "description": "SchedulingStrategy enum REPLICA" + } + ] + } + }, + "Secret": { + "type": "object", + "description": "Definition of Secret", + "properties": { + "name": { + "type": "string", + "description": "The name of the secret." + }, + "valueFrom": { + "type": "string", + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." + } + } + }, + "ServiceConnectClientAlias": { + "type": "object", + "description": "Definition of ServiceConnectClientAlias", + "properties": { + "dnsName": { + "type": "string", + "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + "ServiceConnectConfiguration": { + "type": "object", + "description": "Definition of ServiceConnectConfiguration", + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether to use Service Connect with this service." + }, + "logConfiguration": { + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." + }, + "namespace": { + "type": "string", + "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." + }, + "services": { + "type": "array", + "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a 'client' Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service.", + "items": { + "$ref": "#/definitions/ServiceConnectService" + }, + "x-ms-identifiers": [] + } + } + }, + "ServiceConnectService": { + "type": "object", + "description": "Definition of ServiceConnectService", + "properties": { + "clientAliases": { + "type": "array", + "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias ('endpoint') is a fully-qualified name and port number that other Amazon ECS tasks ('clients') can use to connect to this service. Each name and port mapping must be unique within the namespace. For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``.", + "items": { + "$ref": "#/definitions/ServiceConnectClientAlias" + }, + "x-ms-identifiers": [] + }, + "discoveryName": { + "type": "string", + "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``." + }, + "ingressPortOverride": { + "type": "integer", + "format": "int32", + "description": "The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy." + }, + "portName": { + "type": "string", + "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service." + }, + "timeout": { + "$ref": "#/definitions/TimeoutConfiguration", + "description": "A reference to an object that represents the configured timeouts for Service Connect. An object that represents the timeout configurations for Service Connect. If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``." + }, + "tls": { + "$ref": "#/definitions/ServiceConnectTlsConfiguration", + "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration. An object that represents the configuration for Service Connect TLS." + } + } + }, + "ServiceConnectTlsCertificateAuthority": { + "type": "object", + "description": "Definition of ServiceConnectTlsCertificateAuthority", + "properties": { + "awsPcaAuthorityArn": { + "type": "string", + "description": "The ARN of the AWS Private Certificate Authority certificate." + } + } + }, + "ServiceConnectTlsConfiguration": { + "type": "object", + "description": "Definition of ServiceConnectTlsConfiguration", + "properties": { + "issuerCertificateAuthority": { + "$ref": "#/definitions/ServiceConnectTlsCertificateAuthority", + "description": "The signer certificate authority. An object that represents the AWS Private Certificate Authority certificate." + }, + "kmsKey": { + "type": "string", + "description": "The AWS Key Management Service key." + }, + "roleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS." + } + } + }, + "ServiceManagedEBSVolumeConfiguration": { + "type": "object", + "description": "Definition of ServiceManagedEBSVolumeConfiguration", + "properties": { + "encrypted": { + "type": "boolean", + "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "filesystemType": { + "type": "string", + "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types are
 ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "kmsKeyId": { + "type": "string", + "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails." + }, + "roleArn": { + "type": "string", + "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*." + }, + "sizeInGiB": { + "type": "integer", + "format": "int32", + "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. The following are the supported volume size values for each volume type. + ``gp2`` and ``gp3``: 1-16,384 + ``io1`` and ``io2``: 4-16,384 + ``st1`` and ``sc1``: 125-16,384 + ``standard``: 1-1,024" + }, + "snapshotId": { + "type": "string", + "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." + }, + "tagSpecifications": { + "type": "array", + "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.", + "items": { + "$ref": "#/definitions/EBSTagSpecification" + }, + "x-ms-identifiers": [] + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. This parameter is only supported for the ``gp3`` volume type." + }, + "volumeType": { + "type": "string", + "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. The following are the supported volume types. + General Purpose SSD: ``gp2``|``gp3`` + Provisioned IOPS SSD: ``io1``|``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` The magnetic volume type is not supported on Fargate." + } + } + }, + "ServiceRegistry": { + "type": "object", + "description": "Definition of ServiceRegistry", + "properties": { + "containerName": { + "type": "string", + "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." + }, + "containerPort": { + "type": "integer", + "format": "int32", + "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used." + }, + "registryArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)." + } + } + }, + "ServiceVolumeConfiguration": { + "type": "object", + "description": "Definition of ServiceVolumeConfiguration", + "properties": { + "managedEBSVolume": { + "$ref": "#/definitions/ServiceManagedEBSVolumeConfiguration", + "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters." + }, + "name": { + "type": "string", + "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "value": { + "type": "string", + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + "TimeoutConfiguration": { + "type": "object", + "description": "Definition of TimeoutConfiguration", + "properties": { + "idleTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``. The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes. The ``idleTimeout`` default for ``TCP`` is 1 hour." + }, + "perRequestTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsTaskDefinition.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsTaskDefinition.json new file mode 100644 index 000000000000..e36a6d13a546 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ecsTaskDefinition.json @@ -0,0 +1,1556 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EcsTaskDefinitions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ecsTaskDefinitions": { + "get": { + "operationId": "EcsTaskDefinitions_ListBySubscription", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "List EcsTaskDefinition resources 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/EcsTaskDefinitionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsTaskDefinitions_ListBySubscription": { + "$ref": "./examples/EcsTaskDefinitions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsTaskDefinitions": { + "get": { + "operationId": "EcsTaskDefinitions_ListByResourceGroup", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "List EcsTaskDefinition resources 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/EcsTaskDefinitionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsTaskDefinitions_ListByResourceGroup": { + "$ref": "./examples/EcsTaskDefinitions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ecsTaskDefinitions/{name}": { + "get": { + "operationId": "EcsTaskDefinitions_Get", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "Get a EcsTaskDefinition", + "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": "name", + "in": "path", + "description": "Name of EcsTaskDefinition", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsTaskDefinition" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsTaskDefinitions_Get": { + "$ref": "./examples/EcsTaskDefinitions_Get.json" + } + } + }, + "put": { + "operationId": "EcsTaskDefinitions_CreateOrReplace", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "Create a EcsTaskDefinition. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EcsTaskDefinition", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsTaskDefinition" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EcsTaskDefinition' update operation succeeded", + "schema": { + "$ref": "#/definitions/EcsTaskDefinition" + } + }, + "201": { + "description": "Resource 'EcsTaskDefinition' create operation succeeded", + "schema": { + "$ref": "#/definitions/EcsTaskDefinition" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EcsTaskDefinitions_CreateOrReplace": { + "$ref": "./examples/EcsTaskDefinitions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EcsTaskDefinitions_Update", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "Update a EcsTaskDefinition", + "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": "name", + "in": "path", + "description": "Name of EcsTaskDefinition", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EcsTaskDefinitionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EcsTaskDefinition" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EcsTaskDefinitions_Update": { + "$ref": "./examples/EcsTaskDefinitions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EcsTaskDefinitions_Delete", + "tags": [ + "EcsTaskDefinitions" + ], + "description": "Delete a EcsTaskDefinition", + "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": "name", + "in": "path", + "description": "Name of EcsTaskDefinition", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EcsTaskDefinitions_Delete": { + "$ref": "./examples/EcsTaskDefinitions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AuthorizationConfig": { + "type": "object", + "description": "Definition of AuthorizationConfig", + "properties": { + "accessPointId": { + "type": "string", + "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*." + }, + "iam": { + "$ref": "#/definitions/AuthorizationConfigIAM", + "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*." + } + } + }, + "AuthorizationConfigIAM": { + "type": "string", + "description": "AuthorizationConfigIAM enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "AuthorizationConfigIAM", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "AuthorizationConfigIAM enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "AuthorizationConfigIAM enum ENABLED" + } + ] + } + }, + "AwsEcsTaskDefinitionProperties": { + "type": "object", + "description": "Definition of awsEcsTaskDefinition", + "properties": { + "containerDefinitions": { + "type": "array", + "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/ContainerDefinition" + }, + "x-ms-identifiers": [] + }, + "cpu": { + "type": "string", + "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later." + }, + "ephemeralStorage": { + "$ref": "#/definitions/EphemeralStorage", + "description": "The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version ``1.4.0`` or later. + Windows platform version ``1.0.0`` or later." + }, + "executionRoleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "family": { + "type": "string", + "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it." + }, + "inferenceAccelerators": { + "type": "array", + "description": "The Elastic Inference accelerators to use for the containers in the task.", + "items": { + "$ref": "#/definitions/InferenceAccelerator" + }, + "x-ms-identifiers": [] + }, + "ipcMode": { + "type": "string", + "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong." + }, + "memory": { + "type": "string", + "description": "The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) This option requires Linux platform ``1.4.0`` or later. + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) This option requires Linux platform ``1.4.0`` or later." + }, + "networkMode": { + "type": "string", + "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``<default>`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. For more information, see [Network settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*." + }, + "pidMode": { + "type": "string", + "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.aws.amazon.com/https://docs.docker.com/engine/security/security/). This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate." + }, + "placementConstraints": { + "type": "array", + "description": "An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong.", + "items": { + "$ref": "#/definitions/TaskDefinitionPlacementConstraint" + }, + "x-ms-identifiers": [] + }, + "proxyConfiguration": { + "$ref": "#/definitions/ProxyConfiguration", + "description": "The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)" + }, + "requiresCompatibilities": { + "type": "array", + "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "runtimePlatform": { + "$ref": "#/definitions/RuntimePlatform", + "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. Information about the platform for the Amazon ECS service or task. For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*." + }, + "tags": { + "type": "array", + "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "taskDefinitionArn": { + "type": "string", + "description": "Property taskDefinitionArn" + }, + "taskRoleArn": { + "type": "string", + "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "volumes": { + "type": "array", + "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong.", + "items": { + "$ref": "#/definitions/Volume" + }, + "x-ms-identifiers": [] + } + } + }, + "ContainerDefinition": { + "type": "object", + "description": "Definition of ContainerDefinition", + "properties": { + "command": { + "type": "array", + "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``COMMAND`` parameter to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cpu": { + "type": "integer", + "format": "int32", + "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cpu-shares`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://docs.aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU." + }, + "credentialSpecs": { + "type": "array", + "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dependsOn": { + "type": "array", + "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://docs.aws.amazon.com/https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website.", + "items": { + "$ref": "#/definitions/ContainerDependency" + }, + "x-ms-identifiers": [] + }, + "disableNetworking": { + "type": "boolean", + "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/). This parameter is not supported for Windows containers." + }, + "dnsSearchDomains": { + "type": "array", + "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns-search`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dnsServers": { + "type": "array", + "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--dns`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dockerLabels": { + "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--label`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "dockerSecurityOptions": { + "type": "array", + "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--security-opt`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about valid values, see [Docker Run Security Configuration](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath'", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "entryPoint": { + "type": "array", + "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--entrypoint`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/builder/#entrypoint).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "environment": { + "type": "array", + "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--env`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). We don't recommend that you use plaintext environment variables for sensitive information, such as credential data.", + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "x-ms-identifiers": [] + }, + "environmentFiles": { + "type": "array", + "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.aws.amazon.com/https://docs.docker.com/compose/env-file/). If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/EnvironmentFile" + }, + "x-ms-identifiers": [] + }, + "essential": { + "type": "boolean", + "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "extraHosts": { + "type": "array", + "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--add-host`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode.", + "items": { + "$ref": "#/definitions/HostEntry" + }, + "x-ms-identifiers": [] + }, + "firelensConfiguration": { + "$ref": "#/definitions/FirelensConfiguration", + "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "healthCheck": { + "$ref": "#/definitions/HealthCheck", + "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer." + }, + "hostname": { + "type": "string", + "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--hostname`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode." + }, + "image": { + "type": "string", + "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``IMAGE`` parameter of [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest`` or ``012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``)." + }, + "interactive": { + "type": "boolean", + "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--interactive`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "links": { + "type": "array", + "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.aws.amazon.com/https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--link`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "linuxParameters": { + "$ref": "#/definitions/LinuxParameters", + "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html)." + }, + "logConfiguration": { + "$ref": "#/definitions/LogConfiguration", + "description": "The log configuration specification for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--log-driver`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container." + }, + "memory": { + "type": "integer", + "format": "int32", + "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers." + }, + "memoryReservation": { + "type": "integer", + "format": "int32", + "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--memory-reservation`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers." + }, + "mountPoints": { + "type": "array", + "description": "The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volume`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives.", + "items": { + "$ref": "#/definitions/MountPoint" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--name`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "portMappings": { + "type": "array", + "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to ``PortBindings`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--publish`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses.", + "items": { + "$ref": "#/definitions/PortMapping" + }, + "x-ms-identifiers": [] + }, + "privileged": { + "type": "boolean", + "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--privileged`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers or tasks run on FARGATElong." + }, + "pseudoTerminal": { + "type": "boolean", + "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--tty`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + }, + "readonlyRootFilesystem": { + "type": "boolean", + "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--read-only`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." + }, + "repositoryCredentials": { + "$ref": "#/definitions/RepositoryCredentials", + "description": "The private repository authentication credentials to use. The repository credentials for private registry authentication." + }, + "resourceRequirements": { + "type": "array", + "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU.", + "items": { + "$ref": "#/definitions/ResourceRequirement" + }, + "x-ms-identifiers": [] + }, + "secrets": { + "type": "array", + "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/Secret" + }, + "x-ms-identifiers": [] + }, + "startTimeout": { + "type": "integer", + "format": "int32", + "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." + }, + "stopTimeout": { + "type": "integer", + "format": "int32", + "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." + }, + "systemControls": { + "type": "array", + "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--sysctl`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections.", + "items": { + "$ref": "#/definitions/SystemControl" + }, + "x-ms-identifiers": [] + }, + "ulimits": { + "type": "array", + "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--ulimit`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers.", + "items": { + "$ref": "#/definitions/Ulimit" + }, + "x-ms-identifiers": [] + }, + "user": { + "type": "string", + "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--user`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + ``user`` + ``user:group`` + ``uid`` + ``uid:gid`` + ``user:gid`` + ``uid:group`` This parameter is not supported for Windows containers." + }, + "volumesFrom": { + "type": "array", + "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--volumes-from`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration).", + "items": { + "$ref": "#/definitions/VolumeFrom" + }, + "x-ms-identifiers": [] + }, + "workingDirectory": { + "type": "string", + "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--workdir`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration)." + } + } + }, + "ContainerDependency": { + "type": "object", + "description": "Definition of ContainerDependency", + "properties": { + "condition": { + "type": "string", + "description": "The dependency condition of the container. The following are the available conditions and their behavior: + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup." + }, + "containerName": { + "type": "string", + "description": "The name of a container." + } + } + }, + "Device": { + "type": "object", + "description": "Definition of Device", + "properties": { + "containerPath": { + "type": "string", + "description": "The path inside the container at which to expose the host device." + }, + "hostPath": { + "type": "string", + "description": "The path for the device on the host container instance." + }, + "permissions": { + "type": "array", + "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DockerVolumeConfiguration": { + "type": "object", + "description": "Definition of DockerVolumeConfiguration", + "properties": { + "autoprovision": { + "type": "boolean", + "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist. This field is only used if the ``scope`` is ``shared``." + }, + "driver": { + "type": "string", + "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.aws.amazon.com/https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxdriver`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "driverOpts": { + "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxopt`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "labels": { + "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``xxlabel`` option to [docker volume create](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/commandline/volume_create/)." + }, + "scope": { + "type": "string", + "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops." + } + } + }, + "EFSVolumeConfiguration": { + "type": "object", + "description": "Definition of EFSVolumeConfiguration", + "properties": { + "authorizationConfig": { + "$ref": "#/definitions/AuthorizationConfig", + "description": "The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system." + }, + "filesystemId": { + "type": "string", + "description": "The Amazon EFS file system ID to use." + }, + "rootDirectory": { + "type": "string", + "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point." + }, + "transitEncryption": { + "$ref": "#/definitions/EFSVolumeConfigurationTransitEncryption", + "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*." + }, + "transitEncryptionPort": { + "type": "integer", + "format": "int32", + "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*." + } + } + }, + "EFSVolumeConfigurationTransitEncryption": { + "type": "string", + "description": "EFSVolumeConfigurationTransitEncryption enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "EFSVolumeConfigurationTransitEncryption", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "EFSVolumeConfigurationTransitEncryption enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "EFSVolumeConfigurationTransitEncryption enum ENABLED" + } + ] + } + }, + "EcsTaskDefinition": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EcsTaskDefinitionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EcsTaskDefinitionListResult": { + "type": "object", + "description": "The response of a EcsTaskDefinition list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EcsTaskDefinition items on this page", + "items": { + "$ref": "#/definitions/EcsTaskDefinition" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EcsTaskDefinitionProperties": { + "type": "object", + "description": "Definition of EcsTaskDefinition", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEcsTaskDefinitionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EcsTaskDefinitionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EcsTaskDefinition resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EnvironmentFile": { + "type": "object", + "description": "Definition of EnvironmentFile", + "properties": { + "type": { + "type": "string", + "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``." + }, + "value": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file." + } + } + }, + "EphemeralStorage": { + "type": "object", + "description": "Definition of EphemeralStorage", + "properties": { + "sizeInGiB": { + "type": "integer", + "format": "int32", + "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB." + } + } + }, + "FSxAuthorizationConfig": { + "type": "object", + "description": "Definition of FSxAuthorizationConfig", + "properties": { + "credentialsParameter": { + "type": "string", + "description": "Property credentialsParameter" + }, + "domain": { + "type": "string", + "description": "Property domain" + } + } + }, + "FSxWindowsFileServerVolumeConfiguration": { + "type": "object", + "description": "Definition of FSxWindowsFileServerVolumeConfiguration", + "properties": { + "authorizationConfig": { + "$ref": "#/definitions/FSxAuthorizationConfig", + "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." + }, + "fileSystemId": { + "type": "string", + "description": "The Amazon FSx for Windows File Server file system ID to use." + }, + "rootDirectory": { + "type": "string", + "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host." + } + } + }, + "FirelensConfiguration": { + "type": "object", + "description": "Definition of FirelensConfiguration", + "properties": { + "options": { + "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + ``config-file-type``, which can be ``s3`` or ``file`` + ``config-file-value``, which is either an S3 ARN or a file path" + }, + "type": { + "type": "string", + "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``." + } + } + }, + "HealthCheck": { + "type": "object", + "description": "Definition of HealthCheck", + "properties": { + "command": { + "type": "array", + "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. ``[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds." + }, + "retries": { + "type": "integer", + "format": "int32", + "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3." + }, + "startPeriod": { + "type": "integer", + "format": "int32", + "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5." + } + } + }, + "HostEntry": { + "type": "object", + "description": "Definition of HostEntry", + "properties": { + "hostname": { + "type": "string", + "description": "The hostname to use in the ``/etc/hosts`` entry." + }, + "ipAddress": { + "type": "string", + "description": "The IP address to use in the ``/etc/hosts`` entry." + } + } + }, + "HostVolumeProperties": { + "type": "object", + "description": "Definition of HostVolumeProperties", + "properties": { + "sourcePath": { + "type": "string", + "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported." + } + } + }, + "InferenceAccelerator": { + "type": "object", + "description": "Definition of InferenceAccelerator", + "properties": { + "deviceName": { + "type": "string", + "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html)." + }, + "deviceType": { + "type": "string", + "description": "The Elastic Inference accelerator type to use." + } + } + }, + "KernelCapabilities": { + "type": "object", + "description": "Definition of KernelCapabilities", + "properties": { + "add": { + "type": "array", + "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-add`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "drop": { + "type": "array", + "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--cap-drop`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "KeyValuePair": { + "type": "object", + "description": "Definition of KeyValuePair", + "properties": { + "name": { + "type": "string", + "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable." + } + } + }, + "LinuxParameters": { + "type": "object", + "description": "Definition of LinuxParameters", + "properties": { + "capabilities": { + "$ref": "#/definitions/KernelCapabilities", + "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page." + }, + "devices": { + "type": "array", + "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) section of the [Docker Remote API](https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/) and the ``--device`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported.", + "items": { + "$ref": "#/definitions/Device" + }, + "x-ms-identifiers": [] + }, + "initProcessEnabled": { + "type": "boolean", + "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "maxSwap": { + "type": "integer", + "format": "int32", + "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." + }, + "sharedMemorySize": { + "type": "integer", + "format": "int32", + "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported." + }, + "swappiness": { + "type": "integer", + "format": "int32", + "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." + }, + "tmpfs": { + "type": "array", + "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported.", + "items": { + "$ref": "#/definitions/Tmpfs" + }, + "x-ms-identifiers": [] + } + } + }, + "LogConfiguration": { + "type": "object", + "description": "Definition of LogConfiguration", + "properties": { + "logDriver": { + "type": "string", + "description": "The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://docs.aws.amazon.com/https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." + }, + "options": { + "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" + }, + "secretOptions": { + "type": "array", + "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*.", + "items": { + "$ref": "#/definitions/Secret" + }, + "x-ms-identifiers": [] + } + } + }, + "MountPoint": { + "type": "object", + "description": "Definition of MountPoint", + "properties": { + "containerPath": { + "type": "string", + "description": "The path on the container to mount the host volume at." + }, + "readOnly": { + "type": "boolean", + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." + }, + "sourceVolume": { + "type": "string", + "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``." + } + } + }, + "PortMapping": { + "type": "object", + "description": "Definition of PortMapping", + "properties": { + "appProtocol": { + "$ref": "#/definitions/PortMappingAppProtocol", + "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "containerPort": { + "type": "integer", + "format": "int32", + "description": "The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance." + }, + "containerPortRange": { + "type": "string", + "description": "The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + The ``containerPortRange`` valid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see [Issue #11185](https://docs.aws.amazon.com/https://github.com/moby/moby/issues/11185) on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports." + }, + "hostPort": { + "type": "integer", + "format": "int32", + "description": "The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota." + }, + "name": { + "type": "string", + "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "protocol": { + "type": "string", + "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment." + } + } + }, + "PortMappingAppProtocol": { + "type": "string", + "description": "PortMappingAppProtocol enum", + "enum": [ + "grpc", + "http", + "http2" + ], + "x-ms-enum": { + "name": "PortMappingAppProtocol", + "modelAsString": true, + "values": [ + { + "name": "grpc", + "value": "grpc", + "description": "PortMappingAppProtocol enum grpc" + }, + { + "name": "http", + "value": "http", + "description": "PortMappingAppProtocol enum http" + }, + { + "name": "http2", + "value": "http2", + "description": "PortMappingAppProtocol enum http2" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ProxyConfiguration": { + "type": "object", + "description": "Definition of ProxyConfiguration", + "properties": { + "containerName": { + "type": "string", + "description": "The name of the container that will serve as the App Mesh proxy." + }, + "proxyConfigurationProperties": { + "type": "array", + "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list.", + "items": { + "$ref": "#/definitions/KeyValuePair" + }, + "x-ms-identifiers": [] + }, + "type": { + "type": "string", + "description": "The proxy type. The only supported value is ``APPMESH``." + } + } + }, + "RepositoryCredentials": { + "type": "object", + "description": "Definition of RepositoryCredentials", + "properties": { + "credentialsParameter": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret." + } + } + }, + "ResourceRequirement": { + "type": "object", + "description": "Definition of ResourceRequirement", + "properties": { + "type": { + "type": "string", + "description": "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." + }, + "value": { + "type": "string", + "description": "The value for the specified resource type. If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." + } + } + }, + "RuntimePlatform": { + "type": "object", + "description": "Definition of RuntimePlatform", + "properties": { + "cpuArchitecture": { + "type": "string", + "description": "The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate." + }, + "operatingSystemFamily": { + "type": "string", + "description": "The operating system." + } + } + }, + "Secret": { + "type": "object", + "description": "Definition of Secret", + "properties": { + "name": { + "type": "string", + "description": "The name of the secret." + }, + "valueFrom": { + "type": "string", + "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." + } + } + }, + "SystemControl": { + "type": "object", + "description": "Definition of SystemControl", + "properties": { + "namespace": { + "type": "string", + "description": "The namespaced kernel parameter to set a ``value`` for." + }, + "value": { + "type": "string", + "description": "The namespaced kernel parameter to set a ``value`` for. Valid IPC namespace values: ``'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced'``, and ``Sysctls`` that start with ``'fs.mqueue.*'`` Valid network namespace values: ``Sysctls`` that start with ``'net.*'`` All of these values are supported by Fargate." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "One part of a key-value pair that make up a tag. A ``key`` is a general label that acts like a category for more specific tag values." + }, + "value": { + "type": "string", + "description": "The optional part of a key-value pair that make up a tag. A ``value`` acts as a descriptor within a tag category (key)." + } + } + }, + "TaskDefinitionPlacementConstraint": { + "type": "object", + "description": "Definition of TaskDefinitionPlacementConstraint", + "properties": { + "expression": { + "type": "string", + "description": "A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "type": { + "type": "string", + "description": "The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates." + } + } + }, + "Tmpfs": { + "type": "object", + "description": "Definition of Tmpfs", + "properties": { + "containerPath": { + "type": "string", + "description": "The absolute file path where the tmpfs volume is to be mounted." + }, + "mountOptions": { + "type": "array", + "description": "The list of tmpfs volume mount options.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "size": { + "type": "integer", + "format": "int32", + "description": "The maximum size (in MiB) of the tmpfs volume." + } + } + }, + "Ulimit": { + "type": "object", + "description": "Definition of Ulimit", + "properties": { + "hardLimit": { + "type": "integer", + "format": "int32", + "description": "The hard limit for the ``ulimit`` type." + }, + "name": { + "type": "string", + "description": "The ``type`` of the ``ulimit``." + }, + "softLimit": { + "type": "integer", + "format": "int32", + "description": "The soft limit for the ``ulimit`` type." + } + } + }, + "Volume": { + "type": "object", + "description": "Definition of Volume", + "properties": { + "configuredAtLaunch": { + "type": "boolean", + "description": "Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs." + }, + "dockerVolumeConfiguration": { + "$ref": "#/definitions/DockerVolumeConfiguration", + "description": "This parameter is specified when you use Docker volumes. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead. Docker volumes aren't supported by tasks run on FARGATElong. The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead." + }, + "efsVolumeConfiguration": { + "$ref": "#/definitions/EFSVolumeConfiguration", + "description": "This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "fSxWindowsFileServerVolumeConfiguration": { + "$ref": "#/definitions/FSxWindowsFileServerVolumeConfiguration", + "description": "This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*." + }, + "host": { + "$ref": "#/definitions/HostVolumeProperties", + "description": "This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\\my\\path:C:\\my\\path`` and ``D:\\:D:\\``, but not ``D:\\my\\path:C:\\my\\path`` or ``D:\\:C:\\my\\path``. The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume." + }, + "name": { + "type": "string", + "description": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task. For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition. When a volume is using the ``efsVolumeConfiguration``, the name is required." + } + } + }, + "VolumeFrom": { + "type": "object", + "description": "Definition of VolumeFrom", + "properties": { + "readOnly": { + "type": "boolean", + "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." + }, + "sourceContainer": { + "type": "string", + "description": "The name of another container within the same task definition to mount volumes from." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsFileSystem.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsFileSystem.json new file mode 100644 index 000000000000..d47381505bfc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsFileSystem.json @@ -0,0 +1,746 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EfsFileSystems" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/efsFileSystems": { + "get": { + "operationId": "EfsFileSystems_ListBySubscription", + "tags": [ + "EfsFileSystems" + ], + "description": "List EfsFileSystem resources 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/EfsFileSystemListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsFileSystems_ListBySubscription": { + "$ref": "./examples/EfsFileSystems_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/efsFileSystems": { + "get": { + "operationId": "EfsFileSystems_ListByResourceGroup", + "tags": [ + "EfsFileSystems" + ], + "description": "List EfsFileSystem resources 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/EfsFileSystemListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsFileSystems_ListByResourceGroup": { + "$ref": "./examples/EfsFileSystems_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/efsFileSystems/{name}": { + "get": { + "operationId": "EfsFileSystems_Get", + "tags": [ + "EfsFileSystems" + ], + "description": "Get a EfsFileSystem", + "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": "name", + "in": "path", + "description": "Name of EfsFileSystem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EfsFileSystem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsFileSystems_Get": { + "$ref": "./examples/EfsFileSystems_Get.json" + } + } + }, + "put": { + "operationId": "EfsFileSystems_CreateOrReplace", + "tags": [ + "EfsFileSystems" + ], + "description": "Create a EfsFileSystem. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EfsFileSystem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EfsFileSystem" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EfsFileSystem' update operation succeeded", + "schema": { + "$ref": "#/definitions/EfsFileSystem" + } + }, + "201": { + "description": "Resource 'EfsFileSystem' create operation succeeded", + "schema": { + "$ref": "#/definitions/EfsFileSystem" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EfsFileSystems_CreateOrReplace": { + "$ref": "./examples/EfsFileSystems_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EfsFileSystems_Update", + "tags": [ + "EfsFileSystems" + ], + "description": "Update a EfsFileSystem", + "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": "name", + "in": "path", + "description": "Name of EfsFileSystem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EfsFileSystemTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EfsFileSystem" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsFileSystems_Update": { + "$ref": "./examples/EfsFileSystems_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EfsFileSystems_Delete", + "tags": [ + "EfsFileSystems" + ], + "description": "Delete a EfsFileSystem", + "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": "name", + "in": "path", + "description": "Name of EfsFileSystem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EfsFileSystems_Delete": { + "$ref": "./examples/EfsFileSystems_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEfsFileSystemProperties": { + "type": "object", + "description": "Definition of awsEfsFileSystem", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "availabilityZoneName": { + "type": "string", + "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available." + }, + "backupPolicy": { + "$ref": "#/definitions/BackupPolicy", + "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. The backup policy turns automatic backups for the file system on or off." + }, + "bypassPolicyLockoutSafetyCheck": { + "type": "boolean", + "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``." + }, + "encrypted": { + "type": "boolean", + "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system." + }, + "fileSystemId": { + "type": "string", + "description": "Property fileSystemId" + }, + "fileSystemPolicy": { + "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*." + }, + "fileSystemProtection": { + "$ref": "#/definitions/FileSystemProtection", + "description": "Describes the protection on the file system. Describes the protection on the file system." + }, + "fileSystemTags": { + "type": "array", + "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``'Key':'Name','Value':'{value}'`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.", + "items": { + "$ref": "#/definitions/ElasticFileSystemTag" + }, + "x-ms-identifiers": [] + }, + "kmsKeyId": { + "type": "string", + "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true." + }, + "lifecyclePolicies": { + "type": "array", + "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. + When to move files in the file system from primary storage or IA storage to Archive storage. + When to move files that are in IA or Archive storage to primary storage. EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.", + "items": { + "$ref": "#/definitions/LifecyclePolicy" + }, + "x-ms-identifiers": [] + }, + "performanceMode": { + "type": "string", + "description": "The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``." + }, + "provisionedThroughputInMibps": { + "type": "integer", + "format": "int32", + "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*." + }, + "replicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration", + "description": "Describes the replication configuration for a specific file system. Describes the replication configuration for a specific file system." + }, + "throughputMode": { + "type": "string", + "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. Default is ``bursting``." + } + } + }, + "BackupPolicy": { + "type": "object", + "description": "Definition of BackupPolicy", + "properties": { + "status": { + "$ref": "#/definitions/BackupPolicyStatus", + "description": "Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system." + } + } + }, + "BackupPolicyStatus": { + "type": "string", + "description": "BackupPolicyStatus enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "BackupPolicyStatus", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "BackupPolicyStatus enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "BackupPolicyStatus enum ENABLED" + } + ] + } + }, + "EfsFileSystem": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EfsFileSystemProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EfsFileSystemListResult": { + "type": "object", + "description": "The response of a EfsFileSystem list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EfsFileSystem items on this page", + "items": { + "$ref": "#/definitions/EfsFileSystem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EfsFileSystemProperties": { + "type": "object", + "description": "Definition of EfsFileSystem", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEfsFileSystemProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EfsFileSystemTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EfsFileSystem resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ElasticFileSystemTag": { + "type": "object", + "description": "Definition of ElasticFileSystemTag", + "properties": { + "key": { + "type": "string", + "description": "The tag key (String). The key can't start with ``aws:``." + }, + "value": { + "type": "string", + "description": "The value of the tag key." + } + } + }, + "FileSystemProtection": { + "type": "object", + "description": "Definition of FileSystemProtection", + "properties": { + "replicationOverwriteProtection": { + "$ref": "#/definitions/FileSystemProtectionReplicationOverwriteProtection", + "description": "The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable." + } + } + }, + "FileSystemProtectionReplicationOverwriteProtection": { + "type": "string", + "description": "FileSystemProtectionReplicationOverwriteProtection enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "FileSystemProtectionReplicationOverwriteProtection", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "FileSystemProtectionReplicationOverwriteProtection enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "FileSystemProtectionReplicationOverwriteProtection enum ENABLED" + } + ] + } + }, + "LifecyclePolicy": { + "type": "object", + "description": "Definition of LifecyclePolicy", + "properties": { + "transitionToArchive": { + "type": "string", + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." + }, + "transitionToIA": { + "type": "string", + "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events." + }, + "transitionToPrimaryStorageClass": { + "type": "string", + "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ReplicationConfiguration": { + "type": "object", + "description": "Definition of ReplicationConfiguration", + "properties": { + "destinations": { + "type": "array", + "description": "An array of destination objects. Only one destination object is supported.", + "items": { + "$ref": "#/definitions/ReplicationDestination" + }, + "x-ms-identifiers": [] + } + } + }, + "ReplicationDestination": { + "type": "object", + "description": "Definition of ReplicationDestination", + "properties": { + "availabilityZoneName": { + "type": "string", + "description": "The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available." + }, + "fileSystemId": { + "type": "string", + "description": "The ID of the destination Amazon EFS file system." + }, + "kmsKeyId": { + "type": "string", + "description": "The ID of an kms-key-long used to protect the encrypted file system." + }, + "region": { + "type": "string", + "description": "The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsMountTarget.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsMountTarget.json new file mode 100644 index 000000000000..6ebe82a4dd21 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/efsMountTarget.json @@ -0,0 +1,566 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EfsMountTargets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/efsMountTargets": { + "get": { + "operationId": "EfsMountTargets_ListBySubscription", + "tags": [ + "EfsMountTargets" + ], + "description": "List EfsMountTarget resources 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/EfsMountTargetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsMountTargets_ListBySubscription": { + "$ref": "./examples/EfsMountTargets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/efsMountTargets": { + "get": { + "operationId": "EfsMountTargets_ListByResourceGroup", + "tags": [ + "EfsMountTargets" + ], + "description": "List EfsMountTarget resources 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/EfsMountTargetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsMountTargets_ListByResourceGroup": { + "$ref": "./examples/EfsMountTargets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/efsMountTargets/{name}": { + "get": { + "operationId": "EfsMountTargets_Get", + "tags": [ + "EfsMountTargets" + ], + "description": "Get a EfsMountTarget", + "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": "name", + "in": "path", + "description": "Name of EfsMountTarget", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EfsMountTarget" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsMountTargets_Get": { + "$ref": "./examples/EfsMountTargets_Get.json" + } + } + }, + "put": { + "operationId": "EfsMountTargets_CreateOrReplace", + "tags": [ + "EfsMountTargets" + ], + "description": "Create a EfsMountTarget. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EfsMountTarget", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EfsMountTarget" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EfsMountTarget' update operation succeeded", + "schema": { + "$ref": "#/definitions/EfsMountTarget" + } + }, + "201": { + "description": "Resource 'EfsMountTarget' create operation succeeded", + "schema": { + "$ref": "#/definitions/EfsMountTarget" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EfsMountTargets_CreateOrReplace": { + "$ref": "./examples/EfsMountTargets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EfsMountTargets_Update", + "tags": [ + "EfsMountTargets" + ], + "description": "Update a EfsMountTarget", + "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": "name", + "in": "path", + "description": "Name of EfsMountTarget", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EfsMountTargetTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EfsMountTarget" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EfsMountTargets_Update": { + "$ref": "./examples/EfsMountTargets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EfsMountTargets_Delete", + "tags": [ + "EfsMountTargets" + ], + "description": "Delete a EfsMountTarget", + "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": "name", + "in": "path", + "description": "Name of EfsMountTarget", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EfsMountTargets_Delete": { + "$ref": "./examples/EfsMountTargets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEfsMountTargetProperties": { + "type": "object", + "description": "Definition of awsEfsMountTarget", + "properties": { + "fileSystemId": { + "type": "string", + "description": "The ID of the file system for which to create the mount target." + }, + "id": { + "type": "string", + "description": "Property id" + }, + "ipAddress": { + "type": "string", + "description": "Valid IPv4 address within the address range of the specified subnet." + }, + "securityGroups": { + "type": "array", + "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnetId": { + "type": "string", + "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone." + } + } + }, + "EfsMountTarget": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EfsMountTargetProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EfsMountTargetListResult": { + "type": "object", + "description": "The response of a EfsMountTarget list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EfsMountTarget items on this page", + "items": { + "$ref": "#/definitions/EfsMountTarget" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EfsMountTargetProperties": { + "type": "object", + "description": "Definition of EfsMountTarget", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEfsMountTargetProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EfsMountTargetTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EfsMountTarget resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksCluster.json new file mode 100644 index 000000000000..7c69d6837ce7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksCluster.json @@ -0,0 +1,1067 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EksClusters" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AwsConnector/eksClusters": { + "get": { + "operationId": "EksClusters_List", + "tags": [ + "EksClusters" + ], + "description": "List EksCluster resources by parent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EksClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksClusters_List": { + "$ref": "./examples/EksClusters_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AwsConnector/eksClusters/default": { + "get": { + "operationId": "EksClusters_Get", + "tags": [ + "EksClusters" + ], + "description": "Get a EksCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EksCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksClusters_Get": { + "$ref": "./examples/EksClusters_Get.json" + } + } + }, + "put": { + "operationId": "EksClusters_CreateOrReplace", + "tags": [ + "EksClusters" + ], + "description": "Create a EksCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EksCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EksCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/EksCluster" + } + }, + "201": { + "description": "Resource 'EksCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/EksCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EksClusters_CreateOrReplace": { + "$ref": "./examples/EksClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EksClusters_Delete", + "tags": [ + "EksClusters" + ], + "description": "Delete a EksCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "EksClusters_Delete": { + "$ref": "./examples/EksClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessConfigResponse": { + "type": "object", + "description": "Definition of AccessConfigResponse", + "properties": { + "authenticationMode": { + "$ref": "#/definitions/AuthenticationModeEnumValue", + "description": "<p>The current authentication mode of the cluster.</p>" + }, + "bootstrapClusterCreatorAdminPermissions": { + "type": "boolean", + "description": "<p>Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.</p>" + } + } + }, + "AuthenticationMode": { + "type": "string", + "description": "AuthenticationMode enum", + "enum": [ + "API", + "API_AND_CONFIG_MAP", + "CONFIG_MAP" + ], + "x-ms-enum": { + "name": "AuthenticationMode", + "modelAsString": true, + "values": [ + { + "name": "API", + "value": "API", + "description": "AuthenticationMode enum API" + }, + { + "name": "API_AND_CONFIG_MAP", + "value": "API_AND_CONFIG_MAP", + "description": "AuthenticationMode enum API_AND_CONFIG_MAP" + }, + { + "name": "CONFIG_MAP", + "value": "CONFIG_MAP", + "description": "AuthenticationMode enum CONFIG_MAP" + } + ] + } + }, + "AuthenticationModeEnumValue": { + "type": "object", + "description": "Definition of AuthenticationModeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AuthenticationMode", + "description": "Property value" + } + } + }, + "AwsEksClusterProperties": { + "type": "object", + "description": "Definition of awsEksCluster", + "properties": { + "accessConfig": { + "$ref": "#/definitions/AccessConfigResponse", + "description": "<p>The access configuration for the cluster.</p>" + }, + "arn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the cluster.</p>" + }, + "certificateAuthority": { + "$ref": "#/definitions/Certificate", + "description": "<p>The <code>certificate-authority-data</code> for your cluster.</p>" + }, + "clientRequestToken": { + "type": "string", + "description": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" + }, + "connectorConfig": { + "$ref": "#/definitions/ConnectorConfigResponse", + "description": "<p>The configuration used to connect to a cluster for registration.</p>" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "<p>The Unix epoch timestamp at object creation.</p>" + }, + "encryptionConfig": { + "type": "array", + "description": "<p>The encryption configuration for the cluster.</p>", + "items": { + "$ref": "#/definitions/EncryptionConfig" + }, + "x-ms-identifiers": [] + }, + "endpoint": { + "type": "string", + "description": "<p>The endpoint for your Kubernetes API server.</p>" + }, + "health": { + "$ref": "#/definitions/ClusterHealth", + "description": "<p>An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>" + }, + "id": { + "type": "string", + "description": "<p>The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.</p>" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "<p>The identity provider information for the cluster.</p>" + }, + "kubernetesNetworkConfig": { + "$ref": "#/definitions/KubernetesNetworkConfigResponse", + "description": "<p>The Kubernetes network configuration for the cluster.</p>" + }, + "logging": { + "$ref": "#/definitions/Logging", + "description": "<p>The logging configuration for your cluster.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of your cluster.</p>" + }, + "outpostConfig": { + "$ref": "#/definitions/OutpostConfigResponse", + "description": "<p>An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.</p>" + }, + "platformVersion": { + "type": "string", + "description": "<p>The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html'>Platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>. For more information about local clusters deployed on an Outpost, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html'>Amazon EKS local cluster platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>" + }, + "resourcesVpcConfig": { + "$ref": "#/definitions/VpcConfigResponse", + "description": "<p>The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html'>Cluster VPC considerations</a> and <a href='https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html'>Cluster security group considerations</a> in the <i>Amazon EKS User Guide</i>.</p>" + }, + "roleArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.</p>" + }, + "status": { + "$ref": "#/definitions/ClusterStatusEnumValue", + "description": "<p>The current status of the cluster.</p>" + }, + "tags": { + "type": "object", + "description": "<p>Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.</p>", + "additionalProperties": { + "type": "string" + } + }, + "version": { + "type": "string", + "description": "<p>The Kubernetes server version for the cluster.</p>" + } + } + }, + "Certificate": { + "type": "object", + "description": "Definition of Certificate", + "properties": { + "data": { + "type": "string", + "description": "<p>The Base64-encoded certificate data required to communicate with your cluster. Add this to the <code>certificate-authority-data</code> section of the <code>kubeconfig</code> file for your cluster.</p>" + } + } + }, + "ClusterHealth": { + "type": "object", + "description": "Definition of ClusterHealth", + "properties": { + "issues": { + "type": "array", + "description": "<p>An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.</p>", + "items": { + "$ref": "#/definitions/ClusterIssue" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterIssue": { + "type": "object", + "description": "Definition of ClusterIssue", + "properties": { + "code": { + "$ref": "#/definitions/ClusterIssueCodeEnumValue", + "description": "<p>The error code of the issue.</p>" + }, + "message": { + "type": "string", + "description": "<p>A description of the issue.</p>" + }, + "resourceIds": { + "type": "array", + "description": "<p>The resource IDs that the issue relates to.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterIssueCode": { + "type": "string", + "description": "ClusterIssueCode enum", + "enum": [ + "AccessDenied", + "ClusterUnreachable", + "ConfigurationConflict", + "Ec2SecurityGroupNotFound", + "Ec2ServiceNotSubscribed", + "Ec2SubnetNotFound", + "IamRoleNotFound", + "InsufficientFreeAddresses", + "InternalFailure", + "KmsGrantRevoked", + "KmsKeyDisabled", + "KmsKeyMarkedForDeletion", + "KmsKeyNotFound", + "Other", + "ResourceLimitExceeded", + "ResourceNotFound", + "StsRegionalEndpointDisabled", + "UnsupportedVersion", + "VpcNotFound" + ], + "x-ms-enum": { + "name": "ClusterIssueCode", + "modelAsString": true, + "values": [ + { + "name": "AccessDenied", + "value": "AccessDenied", + "description": "ClusterIssueCode enum AccessDenied" + }, + { + "name": "ClusterUnreachable", + "value": "ClusterUnreachable", + "description": "ClusterIssueCode enum ClusterUnreachable" + }, + { + "name": "ConfigurationConflict", + "value": "ConfigurationConflict", + "description": "ClusterIssueCode enum ConfigurationConflict" + }, + { + "name": "Ec2SecurityGroupNotFound", + "value": "Ec2SecurityGroupNotFound", + "description": "ClusterIssueCode enum Ec2SecurityGroupNotFound" + }, + { + "name": "Ec2ServiceNotSubscribed", + "value": "Ec2ServiceNotSubscribed", + "description": "ClusterIssueCode enum Ec2ServiceNotSubscribed" + }, + { + "name": "Ec2SubnetNotFound", + "value": "Ec2SubnetNotFound", + "description": "ClusterIssueCode enum Ec2SubnetNotFound" + }, + { + "name": "IamRoleNotFound", + "value": "IamRoleNotFound", + "description": "ClusterIssueCode enum IamRoleNotFound" + }, + { + "name": "InsufficientFreeAddresses", + "value": "InsufficientFreeAddresses", + "description": "ClusterIssueCode enum InsufficientFreeAddresses" + }, + { + "name": "InternalFailure", + "value": "InternalFailure", + "description": "ClusterIssueCode enum InternalFailure" + }, + { + "name": "KmsGrantRevoked", + "value": "KmsGrantRevoked", + "description": "ClusterIssueCode enum KmsGrantRevoked" + }, + { + "name": "KmsKeyDisabled", + "value": "KmsKeyDisabled", + "description": "ClusterIssueCode enum KmsKeyDisabled" + }, + { + "name": "KmsKeyMarkedForDeletion", + "value": "KmsKeyMarkedForDeletion", + "description": "ClusterIssueCode enum KmsKeyMarkedForDeletion" + }, + { + "name": "KmsKeyNotFound", + "value": "KmsKeyNotFound", + "description": "ClusterIssueCode enum KmsKeyNotFound" + }, + { + "name": "Other", + "value": "Other", + "description": "ClusterIssueCode enum Other" + }, + { + "name": "ResourceLimitExceeded", + "value": "ResourceLimitExceeded", + "description": "ClusterIssueCode enum ResourceLimitExceeded" + }, + { + "name": "ResourceNotFound", + "value": "ResourceNotFound", + "description": "ClusterIssueCode enum ResourceNotFound" + }, + { + "name": "StsRegionalEndpointDisabled", + "value": "StsRegionalEndpointDisabled", + "description": "ClusterIssueCode enum StsRegionalEndpointDisabled" + }, + { + "name": "UnsupportedVersion", + "value": "UnsupportedVersion", + "description": "ClusterIssueCode enum UnsupportedVersion" + }, + { + "name": "VpcNotFound", + "value": "VpcNotFound", + "description": "ClusterIssueCode enum VpcNotFound" + } + ] + } + }, + "ClusterIssueCodeEnumValue": { + "type": "object", + "description": "Definition of ClusterIssueCodeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterIssueCode", + "description": "Property value" + } + } + }, + "ClusterStatus": { + "type": "string", + "description": "ClusterStatus enum", + "enum": [ + "ACTIVE", + "CREATING", + "DELETING", + "FAILED", + "PENDING", + "UPDATING" + ], + "x-ms-enum": { + "name": "ClusterStatus", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "ClusterStatus enum ACTIVE" + }, + { + "name": "CREATING", + "value": "CREATING", + "description": "ClusterStatus enum CREATING" + }, + { + "name": "DELETING", + "value": "DELETING", + "description": "ClusterStatus enum DELETING" + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "ClusterStatus enum FAILED" + }, + { + "name": "PENDING", + "value": "PENDING", + "description": "ClusterStatus enum PENDING" + }, + { + "name": "UPDATING", + "value": "UPDATING", + "description": "ClusterStatus enum UPDATING" + } + ] + } + }, + "ClusterStatusEnumValue": { + "type": "object", + "description": "Definition of ClusterStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterStatus", + "description": "Property value" + } + } + }, + "ConnectorConfigResponse": { + "type": "object", + "description": "Definition of ConnectorConfigResponse", + "properties": { + "activationCode": { + "type": "string", + "description": "<p>A unique code associated with the cluster for registration purposes.</p>" + }, + "activationExpiry": { + "type": "string", + "format": "date-time", + "description": "<p>The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.</p>" + }, + "activationId": { + "type": "string", + "description": "<p>A unique ID associated with the cluster for registration purposes.</p>" + }, + "provider": { + "type": "string", + "description": "<p>The cluster's cloud service provider.</p>" + }, + "roleArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.</p>" + } + } + }, + "ControlPlanePlacementResponse": { + "type": "object", + "description": "Definition of ControlPlanePlacementResponse", + "properties": { + "groupName": { + "type": "string", + "description": "<p>The name of the placement group for the Kubernetes control plane instances.</p>" + } + } + }, + "EksCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EksClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EksClusterListResult": { + "type": "object", + "description": "The response of a EksCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EksCluster items on this page", + "items": { + "$ref": "#/definitions/EksCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EksClusterProperties": { + "type": "object", + "description": "Definition of EksCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEksClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EncryptionConfig": { + "type": "object", + "description": "Definition of EncryptionConfig", + "properties": { + "provider": { + "$ref": "#/definitions/Provider", + "description": "<p>Key Management Service (KMS) key. Either the ARN or the alias can be used.</p>" + }, + "resources": { + "type": "array", + "description": "<p>Specifies the resources to be encrypted. The only supported value is <code>secrets</code>.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Identity": { + "type": "object", + "description": "Definition of Identity", + "properties": { + "oidc": { + "$ref": "#/definitions/OIDC", + "description": "<p>An object representing the <a href='https://openid.net/connect/'>OpenID Connect</a> identity provider information.</p>" + } + } + }, + "IpFamily": { + "type": "string", + "description": "IpFamily enum", + "enum": [ + "ipv4", + "ipv6" + ], + "x-ms-enum": { + "name": "IpFamily", + "modelAsString": true, + "values": [ + { + "name": "Ipv4", + "value": "ipv4", + "description": "IpFamily enum ipv4" + }, + { + "name": "Ipv6", + "value": "ipv6", + "description": "IpFamily enum ipv6" + } + ] + } + }, + "IpFamilyEnumValue": { + "type": "object", + "description": "Definition of IpFamilyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/IpFamily", + "description": "Property value" + } + } + }, + "KubernetesNetworkConfigResponse": { + "type": "object", + "description": "Definition of KubernetesNetworkConfigResponse", + "properties": { + "ipFamily": { + "$ref": "#/definitions/IpFamilyEnumValue", + "description": "<p>The IP family used to assign Kubernetes <code>Pod</code> and <code>Service</code> objects IP addresses. The IP family is always <code>ipv4</code>, unless you have a <code>1.21</code> or later cluster running version <code>1.10.1</code> or later of the Amazon VPC CNI plugin for Kubernetes and specified <code>ipv6</code> when you created the cluster. </p>" + }, + "serviceIpv4Cidr": { + "type": "string", + "description": "<p>The CIDR block that Kubernetes <code>Pod</code> and <code>Service</code> object IP addresses are assigned from. Kubernetes assigns addresses from an <code>IPv4</code> CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the <code>10.100.0.0/16</code> or <code>172.20.0.0/16</code> CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.</p>" + }, + "serviceIpv6Cidr": { + "type": "string", + "description": "<p>The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified <code>ipv6</code> for <b>ipFamily</b> when you created the cluster. Kubernetes assigns service addresses from the unique local address range (<code>fc00::/7</code>) because you can't specify a custom IPv6 CIDR block when you create the cluster.</p>" + } + } + }, + "LogSetup": { + "type": "object", + "description": "Definition of LogSetup", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.</p>" + }, + "types": { + "type": "array", + "description": "<p>The available cluster control plane log types.</p>", + "items": { + "$ref": "#/definitions/LogType" + }, + "x-ms-identifiers": [] + } + } + }, + "LogType": { + "type": "string", + "description": "LogType enum", + "enum": [ + "api", + "audit", + "authenticator", + "controllerManager", + "scheduler" + ], + "x-ms-enum": { + "name": "LogType", + "modelAsString": true, + "values": [ + { + "name": "Api", + "value": "api", + "description": "LogType enum api" + }, + { + "name": "Audit", + "value": "audit", + "description": "LogType enum audit" + }, + { + "name": "Authenticator", + "value": "authenticator", + "description": "LogType enum authenticator" + }, + { + "name": "ControllerManager", + "value": "controllerManager", + "description": "LogType enum controllerManager" + }, + { + "name": "Scheduler", + "value": "scheduler", + "description": "LogType enum scheduler" + } + ] + } + }, + "LogTypeEnumValue": { + "type": "object", + "description": "Definition of LogTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/LogType", + "description": "Property value" + } + } + }, + "Logging": { + "type": "object", + "description": "Definition of Logging", + "properties": { + "clusterLogging": { + "type": "array", + "description": "<p>The cluster control plane logging configuration for your cluster.</p>", + "items": { + "$ref": "#/definitions/LogSetup" + }, + "x-ms-identifiers": [] + } + } + }, + "OIDC": { + "type": "object", + "description": "Definition of OIDC", + "properties": { + "issuer": { + "type": "string", + "description": "<p>The issuer URL for the OIDC identity provider.</p>" + } + } + }, + "OutpostConfigResponse": { + "type": "object", + "description": "Definition of OutpostConfigResponse", + "properties": { + "controlPlaneInstanceType": { + "type": "string", + "description": "<p>The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.</p>" + }, + "controlPlanePlacement": { + "$ref": "#/definitions/ControlPlanePlacementResponse", + "description": "<p>An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html'>Capacity considerations</a> in the <i>Amazon EKS User Guide</i>.</p>" + }, + "outpostArns": { + "type": "array", + "description": "<p>The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Provider": { + "type": "object", + "description": "Definition of Provider", + "properties": { + "keyArn": { + "type": "string", + "description": "<p>Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the <a href='https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html'>IAM principal</a> must have access to the KMS key. For more information, see <a href='https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html'>Allowing users in other accounts to use a KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "VpcConfigResponse": { + "type": "object", + "description": "Definition of VpcConfigResponse", + "properties": { + "clusterSecurityGroupId": { + "type": "string", + "description": "<p>The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.</p>" + }, + "endpointPrivateAccess": { + "type": "boolean", + "description": "<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see <a href='https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html'>Amazon EKS cluster endpoint access control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>" + }, + "endpointPublicAccess": { + "type": "boolean", + "description": "<p>Whether the public API server endpoint is enabled.</p>" + }, + "publicAccessCidrs": { + "type": "array", + "description": "<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "securityGroupIds": { + "type": "array", + "description": "<p>The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnetIds": { + "type": "array", + "description": "<p>The subnets associated with your cluster.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "<p>The VPC associated with your cluster.</p>" + } + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksNodegroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksNodegroup.json new file mode 100644 index 000000000000..a8bf201f40ff --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/eksNodegroup.json @@ -0,0 +1,732 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EksNodegroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/eksNodegroups": { + "get": { + "operationId": "EksNodegroups_ListBySubscription", + "tags": [ + "EksNodegroups" + ], + "description": "List EksNodegroup resources 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/EksNodegroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksNodegroups_ListBySubscription": { + "$ref": "./examples/EksNodegroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/eksNodegroups": { + "get": { + "operationId": "EksNodegroups_ListByResourceGroup", + "tags": [ + "EksNodegroups" + ], + "description": "List EksNodegroup resources 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/EksNodegroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksNodegroups_ListByResourceGroup": { + "$ref": "./examples/EksNodegroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/eksNodegroups/{name}": { + "get": { + "operationId": "EksNodegroups_Get", + "tags": [ + "EksNodegroups" + ], + "description": "Get a EksNodegroup", + "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": "name", + "in": "path", + "description": "Name of EksNodegroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EksNodegroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksNodegroups_Get": { + "$ref": "./examples/EksNodegroups_Get.json" + } + } + }, + "put": { + "operationId": "EksNodegroups_CreateOrReplace", + "tags": [ + "EksNodegroups" + ], + "description": "Create a EksNodegroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EksNodegroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EksNodegroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EksNodegroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/EksNodegroup" + } + }, + "201": { + "description": "Resource 'EksNodegroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/EksNodegroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EksNodegroups_CreateOrReplace": { + "$ref": "./examples/EksNodegroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EksNodegroups_Update", + "tags": [ + "EksNodegroups" + ], + "description": "Update a EksNodegroup", + "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": "name", + "in": "path", + "description": "Name of EksNodegroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EksNodegroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EksNodegroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EksNodegroups_Update": { + "$ref": "./examples/EksNodegroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EksNodegroups_Delete", + "tags": [ + "EksNodegroups" + ], + "description": "Delete a EksNodegroup", + "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": "name", + "in": "path", + "description": "Name of EksNodegroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EksNodegroups_Delete": { + "$ref": "./examples/EksNodegroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEksNodegroupProperties": { + "type": "object", + "description": "Definition of awsEksNodegroup", + "properties": { + "amiType": { + "type": "string", + "description": "The AMI type for your node group." + }, + "arn": { + "type": "string", + "description": "Property arn" + }, + "capacityType": { + "type": "string", + "description": "The capacity type of your managed node group." + }, + "clusterName": { + "type": "string", + "description": "Name of the cluster to create the node group in." + }, + "diskSize": { + "type": "integer", + "format": "int32", + "description": "The root device disk size (in GiB) for your node group instances." + }, + "forceUpdateEnabled": { + "type": "boolean", + "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue." + }, + "id": { + "type": "string", + "description": "Property id" + }, + "instanceTypes": { + "type": "array", + "description": "Specify the instance types for a node group.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "labels": { + "type": "object", + "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created.", + "additionalProperties": { + "type": "string" + } + }, + "launchTemplate": { + "$ref": "#/definitions/LaunchTemplateSpecification", + "description": "An object representing a node group's launch template specification. An object representing a launch template specification for AWS EKS Nodegroup." + }, + "nodeRole": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group." + }, + "nodegroupName": { + "type": "string", + "description": "The unique name to give your node group." + }, + "releaseVersion": { + "type": "string", + "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group." + }, + "remoteAccess": { + "$ref": "#/definitions/RemoteAccess", + "description": "The remote access (SSH) configuration to use with your node group. An object representing a remote access configuration specification for AWS EKS Nodegroup." + }, + "scalingConfig": { + "$ref": "#/definitions/ScalingConfig", + "description": "The scaling configuration details for the Auto Scaling group that is created for your node group. An object representing a auto scaling group specification for AWS EKS Nodegroup." + }, + "subnets": { + "type": "array", + "description": "The subnets to use for the Auto Scaling group that is created for your node group.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "object", + "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency.", + "additionalProperties": { + "type": "string" + } + }, + "taints": { + "type": "array", + "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created.", + "items": { + "$ref": "#/definitions/Taint" + }, + "x-ms-identifiers": [] + }, + "updateConfig": { + "$ref": "#/definitions/UpdateConfig", + "description": "The node group update configuration. The node group update configuration." + }, + "version": { + "type": "string", + "description": "The Kubernetes version to use for your managed nodes." + } + } + }, + "EksNodegroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EksNodegroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EksNodegroupListResult": { + "type": "object", + "description": "The response of a EksNodegroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EksNodegroup items on this page", + "items": { + "$ref": "#/definitions/EksNodegroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EksNodegroupProperties": { + "type": "object", + "description": "Definition of EksNodegroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEksNodegroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EksNodegroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EksNodegroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "LaunchTemplateSpecification": { + "type": "object", + "description": "Definition of LaunchTemplateSpecification", + "properties": { + "id": { + "type": "string", + "description": "Property id" + }, + "name": { + "type": "string", + "description": "Property name" + }, + "version": { + "type": "string", + "description": "Property version" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RemoteAccess": { + "type": "object", + "description": "Definition of RemoteAccess", + "properties": { + "ec2SshKey": { + "type": "string", + "description": "Property ec2SshKey" + }, + "sourceSecurityGroups": { + "type": "array", + "description": "Property sourceSecurityGroups", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ScalingConfig": { + "type": "object", + "description": "Definition of ScalingConfig", + "properties": { + "desiredSize": { + "type": "integer", + "format": "int32", + "description": "Property desiredSize" + }, + "maxSize": { + "type": "integer", + "format": "int32", + "description": "Property maxSize" + }, + "minSize": { + "type": "integer", + "format": "int32", + "description": "Property minSize" + } + } + }, + "Taint": { + "type": "object", + "description": "Definition of Taint", + "properties": { + "effect": { + "type": "string", + "description": "Property effect" + }, + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "UpdateConfig": { + "type": "object", + "description": "Definition of UpdateConfig", + "properties": { + "maxUnavailable": { + "type": "integer", + "format": "int32", + "description": "The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100." + }, + "maxUnavailablePercentage": { + "type": "integer", + "format": "int32", + "description": "The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkApplication.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkApplication.json new file mode 100644 index 000000000000..7560d3c59032 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkApplication.json @@ -0,0 +1,620 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticBeanstalkApplications" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticBeanstalkApplications": { + "get": { + "operationId": "ElasticBeanstalkApplications_ListBySubscription", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "List ElasticBeanstalkApplication resources 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/ElasticBeanstalkApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkApplications_ListBySubscription": { + "$ref": "./examples/ElasticBeanstalkApplications_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkApplications": { + "get": { + "operationId": "ElasticBeanstalkApplications_ListByResourceGroup", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "List ElasticBeanstalkApplication resources 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/ElasticBeanstalkApplicationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkApplications_ListByResourceGroup": { + "$ref": "./examples/ElasticBeanstalkApplications_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkApplications/{name}": { + "get": { + "operationId": "ElasticBeanstalkApplications_Get", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "Get a ElasticBeanstalkApplication", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkApplication", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkApplications_Get": { + "$ref": "./examples/ElasticBeanstalkApplications_Get.json" + } + } + }, + "put": { + "operationId": "ElasticBeanstalkApplications_CreateOrReplace", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "Create a ElasticBeanstalkApplication. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkApplication", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticBeanstalkApplication' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + } + }, + "201": { + "description": "Resource 'ElasticBeanstalkApplication' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticBeanstalkApplications_CreateOrReplace": { + "$ref": "./examples/ElasticBeanstalkApplications_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticBeanstalkApplications_Update", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "Update a ElasticBeanstalkApplication", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkApplication", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplicationTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkApplications_Update": { + "$ref": "./examples/ElasticBeanstalkApplications_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticBeanstalkApplications_Delete", + "tags": [ + "ElasticBeanstalkApplications" + ], + "description": "Delete a ElasticBeanstalkApplication", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkApplication", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticBeanstalkApplications_Delete": { + "$ref": "./examples/ElasticBeanstalkApplications_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicationResourceLifecycleConfig": { + "type": "object", + "description": "Definition of ApplicationResourceLifecycleConfig", + "properties": { + "serviceRole": { + "type": "string", + "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value." + }, + "versionLifecycleConfig": { + "$ref": "#/definitions/ApplicationVersionLifecycleConfig", + "description": "Defines lifecycle settings for application versions." + } + } + }, + "ApplicationVersionLifecycleConfig": { + "type": "object", + "description": "Definition of ApplicationVersionLifecycleConfig", + "properties": { + "maxAgeRule": { + "$ref": "#/definitions/MaxAgeRule", + "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." + }, + "maxCountRule": { + "$ref": "#/definitions/MaxCountRule", + "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." + } + } + }, + "AwsElasticBeanstalkApplicationProperties": { + "type": "object", + "description": "Definition of awsElasticBeanstalkApplication", + "properties": { + "applicationName": { + "type": "string", + "description": "A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name." + }, + "description": { + "type": "string", + "description": "Your description of the application." + }, + "resourceLifecycleConfig": { + "$ref": "#/definitions/ApplicationResourceLifecycleConfig", + "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." + } + } + }, + "ElasticBeanstalkApplication": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticBeanstalkApplicationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticBeanstalkApplicationListResult": { + "type": "object", + "description": "The response of a ElasticBeanstalkApplication list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticBeanstalkApplication items on this page", + "items": { + "$ref": "#/definitions/ElasticBeanstalkApplication" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticBeanstalkApplicationProperties": { + "type": "object", + "description": "Definition of ElasticBeanstalkApplication", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticBeanstalkApplicationProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticBeanstalkApplicationTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticBeanstalkApplication resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MaxAgeRule": { + "type": "object", + "description": "Definition of MaxAgeRule", + "properties": { + "deleteSourceFromS3": { + "type": "boolean", + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." + }, + "enabled": { + "type": "boolean", + "description": "Specify true to apply the rule, or false to disable it." + }, + "maxAgeInDays": { + "type": "integer", + "format": "int32", + "description": "Specify the number of days to retain an application versions." + } + } + }, + "MaxCountRule": { + "type": "object", + "description": "Definition of MaxCountRule", + "properties": { + "deleteSourceFromS3": { + "type": "boolean", + "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." + }, + "enabled": { + "type": "boolean", + "description": "Specify true to apply the rule, or false to disable it." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Specify the maximum number of application versions to retain." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkConfigurationTemplate.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkConfigurationTemplate.json new file mode 100644 index 000000000000..bb02f7f36fff --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkConfigurationTemplate.json @@ -0,0 +1,614 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticBeanstalkConfigurationTemplates" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates": { + "get": { + "operationId": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "List ElasticBeanstalkConfigurationTemplate resources 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/ElasticBeanstalkConfigurationTemplateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkConfigurationTemplates_ListBySubscription": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates": { + "get": { + "operationId": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "List ElasticBeanstalkConfigurationTemplate resources 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/ElasticBeanstalkConfigurationTemplateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkConfigurationTemplates/{name}": { + "get": { + "operationId": "ElasticBeanstalkConfigurationTemplates_Get", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "Get a ElasticBeanstalkConfigurationTemplate", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkConfigurationTemplate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkConfigurationTemplates_Get": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Get.json" + } + } + }, + "put": { + "operationId": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "Create a ElasticBeanstalkConfigurationTemplate. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkConfigurationTemplate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticBeanstalkConfigurationTemplate' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + } + }, + "201": { + "description": "Resource 'ElasticBeanstalkConfigurationTemplate' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticBeanstalkConfigurationTemplates_CreateOrReplace": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticBeanstalkConfigurationTemplates_Update", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "Update a ElasticBeanstalkConfigurationTemplate", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkConfigurationTemplate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplateTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkConfigurationTemplates_Update": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticBeanstalkConfigurationTemplates_Delete", + "tags": [ + "ElasticBeanstalkConfigurationTemplates" + ], + "description": "Delete a ElasticBeanstalkConfigurationTemplate", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkConfigurationTemplate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticBeanstalkConfigurationTemplates_Delete": { + "$ref": "./examples/ElasticBeanstalkConfigurationTemplates_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsElasticBeanstalkConfigurationTemplateProperties": { + "type": "object", + "description": "Definition of awsElasticBeanstalkConfigurationTemplate", + "properties": { + "applicationName": { + "type": "string", + "description": "The name of the Elastic Beanstalk application to associate with this configuration template." + }, + "description": { + "type": "string", + "description": "An optional description for this configuration." + }, + "environmentId": { + "type": "string", + "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration." + }, + "optionSettings": { + "type": "array", + "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide.", + "items": { + "$ref": "#/definitions/ConfigurationOptionSetting" + }, + "x-ms-identifiers": [] + }, + "platformArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide." + }, + "solutionStackName": { + "type": "string", + "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks." + }, + "sourceConfiguration": { + "$ref": "#/definitions/SourceConfiguration", + "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name." + }, + "templateName": { + "type": "string", + "description": "The name of the configuration template" + } + } + }, + "ConfigurationOptionSetting": { + "type": "object", + "description": "Definition of ConfigurationOptionSetting", + "properties": { + "namespace": { + "type": "string", + "description": "A unique namespace that identifies the option's associated AWS resource." + }, + "optionName": { + "type": "string", + "description": "The name of the configuration option." + }, + "resourceName": { + "type": "string", + "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." + }, + "value": { + "type": "string", + "description": "The current value for the configuration option." + } + } + }, + "ElasticBeanstalkConfigurationTemplate": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplateProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticBeanstalkConfigurationTemplateListResult": { + "type": "object", + "description": "The response of a ElasticBeanstalkConfigurationTemplate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticBeanstalkConfigurationTemplate items on this page", + "items": { + "$ref": "#/definitions/ElasticBeanstalkConfigurationTemplate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticBeanstalkConfigurationTemplateProperties": { + "type": "object", + "description": "Definition of ElasticBeanstalkConfigurationTemplate", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticBeanstalkConfigurationTemplateProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticBeanstalkConfigurationTemplateTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticBeanstalkConfigurationTemplate resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SourceConfiguration": { + "type": "object", + "description": "Definition of SourceConfiguration", + "properties": { + "applicationName": { + "type": "string", + "description": "The name of the application associated with the configuration." + }, + "templateName": { + "type": "string", + "description": "The name of the configuration template." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkEnvironment.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkEnvironment.json new file mode 100644 index 000000000000..e2f3c95da0db --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkEnvironment.json @@ -0,0 +1,656 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticBeanstalkEnvironments" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticBeanstalkEnvironments": { + "get": { + "operationId": "ElasticBeanstalkEnvironments_ListBySubscription", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "List ElasticBeanstalkEnvironment resources 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/ElasticBeanstalkEnvironmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkEnvironments_ListBySubscription": { + "$ref": "./examples/ElasticBeanstalkEnvironments_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkEnvironments": { + "get": { + "operationId": "ElasticBeanstalkEnvironments_ListByResourceGroup", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "List ElasticBeanstalkEnvironment resources 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/ElasticBeanstalkEnvironmentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkEnvironments_ListByResourceGroup": { + "$ref": "./examples/ElasticBeanstalkEnvironments_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticBeanstalkEnvironments/{name}": { + "get": { + "operationId": "ElasticBeanstalkEnvironments_Get", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "Get a ElasticBeanstalkEnvironment", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkEnvironment", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkEnvironments_Get": { + "$ref": "./examples/ElasticBeanstalkEnvironments_Get.json" + } + } + }, + "put": { + "operationId": "ElasticBeanstalkEnvironments_CreateOrReplace", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "Create a ElasticBeanstalkEnvironment. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkEnvironment", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticBeanstalkEnvironment' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + } + }, + "201": { + "description": "Resource 'ElasticBeanstalkEnvironment' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticBeanstalkEnvironments_CreateOrReplace": { + "$ref": "./examples/ElasticBeanstalkEnvironments_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticBeanstalkEnvironments_Update", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "Update a ElasticBeanstalkEnvironment", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkEnvironment", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironmentTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticBeanstalkEnvironments_Update": { + "$ref": "./examples/ElasticBeanstalkEnvironments_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticBeanstalkEnvironments_Delete", + "tags": [ + "ElasticBeanstalkEnvironments" + ], + "description": "Delete a ElasticBeanstalkEnvironment", + "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": "name", + "in": "path", + "description": "Name of ElasticBeanstalkEnvironment", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticBeanstalkEnvironments_Delete": { + "$ref": "./examples/ElasticBeanstalkEnvironments_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsElasticBeanstalkEnvironmentProperties": { + "type": "object", + "description": "Definition of awsElasticBeanstalkEnvironment", + "properties": { + "applicationName": { + "type": "string", + "description": "The name of the application that is associated with this environment." + }, + "cnamePrefix": { + "type": "string", + "description": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name." + }, + "description": { + "type": "string", + "description": "Your description for this environment." + }, + "endpointURL": { + "type": "string", + "description": "Property endpointURL" + }, + "environmentName": { + "type": "string", + "description": "A unique name for the environment." + }, + "operationsRole": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role." + }, + "optionSettings": { + "type": "array", + "description": "Key-value pairs defining configuration options for this environment, such as the instance type.", + "items": { + "$ref": "#/definitions/OptionSetting" + }, + "x-ms-identifiers": [] + }, + "platformArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment." + }, + "solutionStackName": { + "type": "string", + "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment." + }, + "tags": { + "type": "array", + "description": "Specifies the tags applied to resources in the environment.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "templateName": { + "type": "string", + "description": "The name of the Elastic Beanstalk configuration template to use with the environment." + }, + "tier": { + "$ref": "#/definitions/Tier", + "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." + }, + "versionLabel": { + "type": "string", + "description": "The name of the application version to deploy." + } + } + }, + "ElasticBeanstalkEnvironment": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticBeanstalkEnvironmentProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticBeanstalkEnvironmentListResult": { + "type": "object", + "description": "The response of a ElasticBeanstalkEnvironment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticBeanstalkEnvironment items on this page", + "items": { + "$ref": "#/definitions/ElasticBeanstalkEnvironment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticBeanstalkEnvironmentProperties": { + "type": "object", + "description": "Definition of ElasticBeanstalkEnvironment", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticBeanstalkEnvironmentProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticBeanstalkEnvironmentTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticBeanstalkEnvironment resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OptionSetting": { + "type": "object", + "description": "Definition of OptionSetting", + "properties": { + "namespace": { + "type": "string", + "description": "A unique namespace that identifies the option's associated AWS resource." + }, + "optionName": { + "type": "string", + "description": "The name of the configuration option." + }, + "resourceName": { + "type": "string", + "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." + }, + "value": { + "type": "string", + "description": "The current value for the configuration option." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag." + }, + "value": { + "type": "string", + "description": "The value for the tag." + } + } + }, + "Tier": { + "type": "object", + "description": "Definition of Tier", + "properties": { + "name": { + "type": "string", + "description": "The name of this environment tier." + }, + "type": { + "type": "string", + "description": "The type of this environment tier." + }, + "version": { + "type": "string", + "description": "The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2Listener.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2Listener.json new file mode 100644 index 000000000000..39fc6820e308 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2Listener.json @@ -0,0 +1,852 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticLoadBalancingV2Listeners" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2Listeners": { + "get": { + "operationId": "ElasticLoadBalancingV2Listeners_ListBySubscription", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "List ElasticLoadBalancingV2Listener resources 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/ElasticLoadBalancingV2ListenerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2Listeners_ListBySubscription": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2Listeners": { + "get": { + "operationId": "ElasticLoadBalancingV2Listeners_ListByResourceGroup", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "List ElasticLoadBalancingV2Listener resources 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/ElasticLoadBalancingV2ListenerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2Listeners_ListByResourceGroup": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2Listeners/{name}": { + "get": { + "operationId": "ElasticLoadBalancingV2Listeners_Get", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "Get a ElasticLoadBalancingV2Listener", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2Listener", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2Listeners_Get": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_Get.json" + } + } + }, + "put": { + "operationId": "ElasticLoadBalancingV2Listeners_CreateOrReplace", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "Create a ElasticLoadBalancingV2Listener. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2Listener", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticLoadBalancingV2Listener' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + } + }, + "201": { + "description": "Resource 'ElasticLoadBalancingV2Listener' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticLoadBalancingV2Listeners_CreateOrReplace": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticLoadBalancingV2Listeners_Update", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "Update a ElasticLoadBalancingV2Listener", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2Listener", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2ListenerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2Listeners_Update": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticLoadBalancingV2Listeners_Delete", + "tags": [ + "ElasticLoadBalancingV2Listeners" + ], + "description": "Delete a ElasticLoadBalancingV2Listener", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2Listener", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticLoadBalancingV2Listeners_Delete": { + "$ref": "./examples/ElasticLoadBalancingV2Listeners_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Action": { + "type": "object", + "description": "Definition of Action", + "properties": { + "authenticateCognitoConfig": { + "$ref": "#/definitions/AuthenticateCognitoConfig", + "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. Specifies information required when integrating with Amazon Cognito to authenticate users." + }, + "authenticateOidcConfig": { + "$ref": "#/definitions/AuthenticateOidcConfig", + "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users." + }, + "fixedResponseConfig": { + "$ref": "#/definitions/FixedResponseConfig", + "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. Specifies information required when returning a custom HTTP response." + }, + "forwardConfig": { + "$ref": "#/definitions/ForwardConfig", + "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." + }, + "order": { + "type": "integer", + "format": "int32", + "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first." + }, + "redirectConfig": { + "$ref": "#/definitions/RedirectConfig", + "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading '/' is removed) + #{query} For example, you can change the path to '/new/#{path}', the hostname to 'example.#{host}', or the query to '#{query}&value=xyz'." + }, + "targetGroupArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead." + }, + "type": { + "type": "string", + "description": "The type of action." + } + } + }, + "AuthenticateCognitoConfig": { + "type": "object", + "description": "Definition of AuthenticateCognitoConfig", + "properties": { + "authenticationRequestExtraParams": { + "type": "object", + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "additionalProperties": { + "type": "string" + } + }, + "onUnauthenticatedRequest": { + "type": "string", + "description": "The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "scope": { + "type": "string", + "description": "The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "sessionCookieName": { + "type": "string", + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "sessionTimeout": { + "type": "string", + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "userPoolArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool." + }, + "userPoolClientId": { + "type": "string", + "description": "The ID of the Amazon Cognito user pool client." + }, + "userPoolDomain": { + "type": "string", + "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool." + } + } + }, + "AuthenticateOidcConfig": { + "type": "object", + "description": "Definition of AuthenticateOidcConfig", + "properties": { + "authenticationRequestExtraParams": { + "type": "object", + "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.", + "additionalProperties": { + "type": "string" + } + }, + "authorizationEndpoint": { + "type": "string", + "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "clientId": { + "type": "string", + "description": "The OAuth 2.0 client identifier." + }, + "clientSecret": { + "type": "string", + "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true." + }, + "issuer": { + "type": "string", + "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "onUnauthenticatedRequest": { + "type": "string", + "description": "The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." + }, + "scope": { + "type": "string", + "description": "The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." + }, + "sessionCookieName": { + "type": "string", + "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." + }, + "sessionTimeout": { + "type": "string", + "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." + }, + "tokenEndpoint": { + "type": "string", + "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + }, + "useExistingClientSecret": { + "type": "boolean", + "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false." + }, + "userInfoEndpoint": { + "type": "string", + "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." + } + } + }, + "AwsElasticLoadBalancingV2ListenerProperties": { + "type": "object", + "description": "Definition of awsElasticLoadBalancingV2Listener", + "properties": { + "alpnPolicy": { + "type": "array", + "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "certificates": { + "type": "array", + "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html).", + "items": { + "$ref": "#/definitions/Certificate" + }, + "x-ms-identifiers": [] + }, + "defaultActions": { + "type": "array", + "description": "The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html).", + "items": { + "$ref": "#/definitions/Action" + }, + "x-ms-identifiers": [] + }, + "listenerArn": { + "type": "string", + "description": "Property listenerArn" + }, + "loadBalancerArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the load balancer." + }, + "mutualAuthentication": { + "$ref": "#/definitions/MutualAuthentication", + "description": "The mutual authentication configuration information. Specifies the configuration information for mutual authentication." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer." + }, + "protocol": { + "type": "string", + "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer." + }, + "sslPolicy": { + "type": "string", + "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*." + } + } + }, + "Certificate": { + "type": "object", + "description": "Definition of Certificate", + "properties": { + "certificateArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the certificate." + } + } + }, + "ElasticLoadBalancingV2Listener": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticLoadBalancingV2ListenerProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticLoadBalancingV2ListenerListResult": { + "type": "object", + "description": "The response of a ElasticLoadBalancingV2Listener list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticLoadBalancingV2Listener items on this page", + "items": { + "$ref": "#/definitions/ElasticLoadBalancingV2Listener" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticLoadBalancingV2ListenerProperties": { + "type": "object", + "description": "Definition of ElasticLoadBalancingV2Listener", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticLoadBalancingV2ListenerProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticLoadBalancingV2ListenerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticLoadBalancingV2Listener resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FixedResponseConfig": { + "type": "object", + "description": "Definition of FixedResponseConfig", + "properties": { + "contentType": { + "type": "string", + "description": "The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json" + }, + "messageBody": { + "type": "string", + "description": "The message." + }, + "statusCode": { + "type": "string", + "description": "The HTTP response code (2XX, 4XX, or 5XX)." + } + } + }, + "ForwardConfig": { + "type": "object", + "description": "Definition of ForwardConfig", + "properties": { + "targetGroupStickinessConfig": { + "$ref": "#/definitions/TargetGroupStickinessConfig", + "description": "Information about the target group stickiness for a rule. Information about the target group stickiness for a rule." + }, + "targetGroups": { + "type": "array", + "description": "Information about how traffic will be distributed between multiple target groups in a forward rule.", + "items": { + "$ref": "#/definitions/TargetGroupTuple" + }, + "x-ms-identifiers": [] + } + } + }, + "MutualAuthentication": { + "type": "object", + "description": "Definition of MutualAuthentication", + "properties": { + "ignoreClientCertificateExpiry": { + "type": "boolean", + "description": "Indicates whether expired client certificates are ignored." + }, + "mode": { + "type": "string", + "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``." + }, + "trustStoreArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the trust store." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RedirectConfig": { + "type": "object", + "description": "Definition of RedirectConfig", + "properties": { + "host": { + "type": "string", + "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}." + }, + "path": { + "type": "string", + "description": "The absolute path, starting with the leading '/'. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}." + }, + "port": { + "type": "string", + "description": "The port. You can specify a value from 1 to 65535 or #{port}." + }, + "protocol": { + "type": "string", + "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP." + }, + "query": { + "type": "string", + "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading '?', as it is automatically added. You can specify any of the reserved keywords." + }, + "statusCode": { + "type": "string", + "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)." + } + } + }, + "TargetGroupStickinessConfig": { + "type": "object", + "description": "Definition of TargetGroupStickinessConfig", + "properties": { + "durationSeconds": { + "type": "integer", + "format": "int32", + "description": "The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days)." + }, + "enabled": { + "type": "boolean", + "description": "Indicates whether target group stickiness is enabled." + } + } + }, + "TargetGroupTuple": { + "type": "object", + "description": "Definition of TargetGroupTuple", + "properties": { + "targetGroupArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the target group." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "The weight. The range is 0 to 999." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2LoadBalancer.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2LoadBalancer.json new file mode 100644 index 000000000000..c928e0d007b2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2LoadBalancer.json @@ -0,0 +1,672 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticLoadBalancingV2LoadBalancers" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers": { + "get": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListBySubscription", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "List ElasticLoadBalancingV2LoadBalancer resources 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/ElasticLoadBalancingV2LoadBalancerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2LoadBalancers_ListBySubscription": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers": { + "get": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "List ElasticLoadBalancingV2LoadBalancer resources 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/ElasticLoadBalancingV2LoadBalancerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2LoadBalancers/{name}": { + "get": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_Get", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "Get a ElasticLoadBalancingV2LoadBalancer", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2LoadBalancer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2LoadBalancers_Get": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_Get.json" + } + } + }, + "put": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "Create a ElasticLoadBalancingV2LoadBalancer. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2LoadBalancer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticLoadBalancingV2LoadBalancer' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + } + }, + "201": { + "description": "Resource 'ElasticLoadBalancingV2LoadBalancer' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_Update", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "Update a ElasticLoadBalancingV2LoadBalancer", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2LoadBalancer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2LoadBalancers_Update": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticLoadBalancingV2LoadBalancers_Delete", + "tags": [ + "ElasticLoadBalancingV2LoadBalancers" + ], + "description": "Delete a ElasticLoadBalancingV2LoadBalancer", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2LoadBalancer", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticLoadBalancingV2LoadBalancers_Delete": { + "$ref": "./examples/ElasticLoadBalancingV2LoadBalancers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsElasticLoadBalancingV2LoadBalancerProperties": { + "type": "object", + "description": "Definition of awsElasticLoadBalancingV2LoadBalancer", + "properties": { + "canonicalHostedZoneID": { + "type": "string", + "description": "Property canonicalHostedZoneID" + }, + "dnsName": { + "type": "string", + "description": "Property dnsName" + }, + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { + "type": "string", + "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink." + }, + "ipAddressType": { + "type": "string", + "description": "The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener." + }, + "loadBalancerArn": { + "type": "string", + "description": "Property loadBalancerArn" + }, + "loadBalancerAttributes": { + "type": "array", + "description": "The load balancer attributes.", + "items": { + "$ref": "#/definitions/LoadBalancerAttribute" + }, + "x-ms-identifiers": [] + }, + "loadBalancerFullName": { + "type": "string", + "description": "Property loadBalancerFullName" + }, + "loadBalancerName": { + "type": "string", + "description": "Property loadBalancerName" + }, + "name": { + "type": "string", + "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name." + }, + "scheme": { + "type": "string", + "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer." + }, + "securityGroups": { + "type": "array", + "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnetMappings": { + "type": "array", + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.", + "items": { + "$ref": "#/definitions/SubnetMapping" + }, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "The tags to assign to the load balancer.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "type": { + "type": "string", + "description": "The type of load balancer. The default is ``application``." + } + } + }, + "ElasticLoadBalancingV2LoadBalancer": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancerProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticLoadBalancingV2LoadBalancerListResult": { + "type": "object", + "description": "The response of a ElasticLoadBalancingV2LoadBalancer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticLoadBalancingV2LoadBalancer items on this page", + "items": { + "$ref": "#/definitions/ElasticLoadBalancingV2LoadBalancer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticLoadBalancingV2LoadBalancerProperties": { + "type": "object", + "description": "Definition of ElasticLoadBalancingV2LoadBalancer", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticLoadBalancingV2LoadBalancerProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticLoadBalancingV2LoadBalancerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticLoadBalancingV2LoadBalancer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "LoadBalancerAttribute": { + "type": "object", + "description": "Definition of LoadBalancerAttribute", + "properties": { + "key": { + "type": "string", + "description": "The name of the attribute. The following attributes are supported by all load balancers: + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. The following attributes are supported by only Network Load Balancers: + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity." + }, + "value": { + "type": "string", + "description": "The value of the attribute." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SubnetMapping": { + "type": "object", + "description": "Definition of SubnetMapping", + "properties": { + "allocationId": { + "type": "string", + "description": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer." + }, + "iPv6Address": { + "type": "string", + "description": "[Network Load Balancers] The IPv6 address." + }, + "privateIPv4Address": { + "type": "string", + "description": "[Network Load Balancers] The private IPv4 address for an internal load balancer." + }, + "subnetId": { + "type": "string", + "description": "The ID of the subnet." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key of the tag." + }, + "value": { + "type": "string", + "description": "The value of the tag." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetGroup.json new file mode 100644 index 000000000000..adf013f0e140 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetGroup.json @@ -0,0 +1,716 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticLoadBalancingV2TargetGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetGroups": { + "get": { + "operationId": "ElasticLoadBalancingV2TargetGroups_ListBySubscription", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "List ElasticLoadBalancingV2TargetGroup resources 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/ElasticLoadBalancingV2TargetGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2TargetGroups_ListBySubscription": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetGroups": { + "get": { + "operationId": "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "List ElasticLoadBalancingV2TargetGroup resources 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/ElasticLoadBalancingV2TargetGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetGroups/{name}": { + "get": { + "operationId": "ElasticLoadBalancingV2TargetGroups_Get", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "Get a ElasticLoadBalancingV2TargetGroup", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2TargetGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2TargetGroups_Get": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_Get.json" + } + } + }, + "put": { + "operationId": "ElasticLoadBalancingV2TargetGroups_CreateOrReplace", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "Create a ElasticLoadBalancingV2TargetGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2TargetGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticLoadBalancingV2TargetGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + } + }, + "201": { + "description": "Resource 'ElasticLoadBalancingV2TargetGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticLoadBalancingV2TargetGroups_CreateOrReplace": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticLoadBalancingV2TargetGroups_Update", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "Update a ElasticLoadBalancingV2TargetGroup", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2TargetGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingV2TargetGroups_Update": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticLoadBalancingV2TargetGroups_Delete", + "tags": [ + "ElasticLoadBalancingV2TargetGroups" + ], + "description": "Delete a ElasticLoadBalancingV2TargetGroup", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingV2TargetGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticLoadBalancingV2TargetGroups_Delete": { + "$ref": "./examples/ElasticLoadBalancingV2TargetGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsElasticLoadBalancingV2TargetGroupProperties": { + "type": "object", + "description": "Definition of awsElasticLoadBalancingV2TargetGroup", + "properties": { + "healthCheckEnabled": { + "type": "boolean", + "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled." + }, + "healthCheckIntervalSeconds": { + "type": "integer", + "format": "int32", + "description": "The approximate amount of time, in seconds, between health checks of an individual target." + }, + "healthCheckPath": { + "type": "string", + "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck." + }, + "healthCheckPort": { + "type": "string", + "description": "The port the load balancer uses when performing health checks on targets." + }, + "healthCheckProtocol": { + "type": "string", + "description": "The protocol the load balancer uses when performing health checks on targets." + }, + "healthCheckTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, during which no response from a target means a failed health check." + }, + "healthyThresholdCount": { + "type": "integer", + "format": "int32", + "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy." + }, + "ipAddressType": { + "type": "string", + "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6." + }, + "loadBalancerArns": { + "type": "array", + "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "matcher": { + "$ref": "#/definitions/Matcher", + "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." + }, + "name": { + "type": "string", + "description": "The name of the target group." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081." + }, + "protocol": { + "type": "string", + "description": "The protocol to use for routing traffic to the targets." + }, + "protocolVersion": { + "type": "string", + "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2." + }, + "tags": { + "type": "array", + "description": "The tags.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "targetGroupArn": { + "type": "string", + "description": "The ARN of the Target Group" + }, + "targetGroupAttributes": { + "type": "array", + "description": "The attributes.", + "items": { + "$ref": "#/definitions/TargetGroupAttribute" + }, + "x-ms-identifiers": [] + }, + "targetGroupFullName": { + "type": "string", + "description": "The full name of the target group." + }, + "targetGroupName": { + "type": "string", + "description": "The name of the target group." + }, + "targetType": { + "type": "string", + "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type." + }, + "targets": { + "type": "array", + "description": "The targets.", + "items": { + "$ref": "#/definitions/TargetDescription" + }, + "x-ms-identifiers": [] + }, + "unhealthyThresholdCount": { + "type": "integer", + "format": "int32", + "description": "The number of consecutive health check failures required before considering a target unhealthy." + }, + "vpcId": { + "type": "string", + "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply." + } + } + }, + "ElasticLoadBalancingV2TargetGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticLoadBalancingV2TargetGroupListResult": { + "type": "object", + "description": "The response of a ElasticLoadBalancingV2TargetGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticLoadBalancingV2TargetGroup items on this page", + "items": { + "$ref": "#/definitions/ElasticLoadBalancingV2TargetGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticLoadBalancingV2TargetGroupProperties": { + "type": "object", + "description": "Definition of ElasticLoadBalancingV2TargetGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticLoadBalancingV2TargetGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticLoadBalancingV2TargetGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticLoadBalancingV2TargetGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Matcher": { + "type": "object", + "description": "Definition of Matcher", + "properties": { + "grpcCode": { + "type": "string", + "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12." + }, + "httpCode": { + "type": "string", + "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The value for the tag." + }, + "value": { + "type": "string", + "description": "The key name of the tag." + } + } + }, + "TargetDescription": { + "type": "object", + "description": "Definition of TargetDescription", + "properties": { + "availabilityZone": { + "type": "string", + "description": "An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer." + }, + "id": { + "type": "string", + "description": "The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function." + } + } + }, + "TargetGroupAttribute": { + "type": "object", + "description": "Definition of TargetGroupAttribute", + "properties": { + "key": { + "type": "string", + "description": "The value of the attribute." + }, + "value": { + "type": "string", + "description": "The name of the attribute." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetHealthDescription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetHealthDescription.json new file mode 100644 index 000000000000..fb6b7dc3a572 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetHealthDescription.json @@ -0,0 +1,835 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "ElasticLoadBalancingv2TargetHealthDescriptions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetHealthDescriptions": { + "get": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "List ElasticLoadBalancingv2TargetHealthDescription resources 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/ElasticLoadBalancingv2TargetHealthDescriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetHealthDescriptions": { + "get": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "List ElasticLoadBalancingv2TargetHealthDescription resources 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/ElasticLoadBalancingv2TargetHealthDescriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/elasticLoadBalancingV2TargetHealthDescriptions/{name}": { + "get": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Get", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "Get a ElasticLoadBalancingv2TargetHealthDescription", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingv2TargetHealthDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingv2TargetHealthDescriptions_Get": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json" + } + } + }, + "put": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "Create a ElasticLoadBalancingv2TargetHealthDescription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingv2TargetHealthDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'ElasticLoadBalancingv2TargetHealthDescription' update operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + } + }, + "201": { + "description": "Resource 'ElasticLoadBalancingv2TargetHealthDescription' create operation succeeded", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Update", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "Update a ElasticLoadBalancingv2TargetHealthDescription", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingv2TargetHealthDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescriptionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ElasticLoadBalancingv2TargetHealthDescriptions_Update": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Delete", + "tags": [ + "ElasticLoadBalancingv2TargetHealthDescriptions" + ], + "description": "Delete a ElasticLoadBalancingv2TargetHealthDescription", + "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": "name", + "in": "path", + "description": "Name of ElasticLoadBalancingv2TargetHealthDescription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "ElasticLoadBalancingv2TargetHealthDescriptions_Delete": { + "$ref": "./examples/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AnomalyDetection": { + "type": "object", + "description": "Definition of AnomalyDetection", + "properties": { + "mitigationInEffect": { + "$ref": "#/definitions/MitigationInEffectEnumEnumValue", + "description": "<p>Indicates whether anomaly mitigation is in progress.</p>" + }, + "result": { + "$ref": "#/definitions/AnomalyResultEnumEnumValue", + "description": "<p>The latest anomaly detection result.</p>" + } + } + }, + "AnomalyResultEnum": { + "type": "string", + "description": "AnomalyResultEnum enum", + "enum": [ + "anomalous", + "normal" + ], + "x-ms-enum": { + "name": "AnomalyResultEnum", + "modelAsString": true, + "values": [ + { + "name": "Anomalous", + "value": "anomalous", + "description": "AnomalyResultEnum enum anomalous" + }, + { + "name": "Normal", + "value": "normal", + "description": "AnomalyResultEnum enum normal" + } + ] + } + }, + "AnomalyResultEnumEnumValue": { + "type": "object", + "description": "Definition of AnomalyResultEnumEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AnomalyResultEnum", + "description": "Property value" + } + } + }, + "AwsElasticLoadBalancingv2TargetHealthDescriptionProperties": { + "type": "object", + "description": "Definition of awsElasticLoadBalancingv2TargetHealthDescription", + "properties": { + "anomalyDetection": { + "$ref": "#/definitions/AnomalyDetection", + "description": "<p>The anomaly detection result for the target.</p> <p>If no anomalies were detected, the result is <code>normal</code>.</p> <p>If anomalies were detected, the result is <code>anomalous</code>.</p>" + }, + "healthCheckPort": { + "type": "string", + "description": "<p>The port to use to connect with the target.</p>" + }, + "target": { + "$ref": "#/definitions/TargetDescription", + "description": "<p>The description of the target.</p>" + }, + "targetHealth": { + "$ref": "#/definitions/TargetHealth", + "description": "<p>The health information for the target.</p>" + } + } + }, + "ElasticLoadBalancingv2TargetHealthDescription": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescriptionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "ElasticLoadBalancingv2TargetHealthDescriptionListResult": { + "type": "object", + "description": "The response of a ElasticLoadBalancingv2TargetHealthDescription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ElasticLoadBalancingv2TargetHealthDescription items on this page", + "items": { + "$ref": "#/definitions/ElasticLoadBalancingv2TargetHealthDescription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ElasticLoadBalancingv2TargetHealthDescriptionProperties": { + "type": "object", + "description": "Definition of ElasticLoadBalancingv2TargetHealthDescription", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsElasticLoadBalancingv2TargetHealthDescriptionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ElasticLoadBalancingv2TargetHealthDescriptionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in ElasticLoadBalancingv2TargetHealthDescription resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MitigationInEffectEnum": { + "type": "string", + "description": "MitigationInEffectEnum enum", + "enum": [ + "no", + "yes" + ], + "x-ms-enum": { + "name": "MitigationInEffectEnum", + "modelAsString": true, + "values": [ + { + "name": "No", + "value": "no", + "description": "MitigationInEffectEnum enum no" + }, + { + "name": "Yes", + "value": "yes", + "description": "MitigationInEffectEnum enum yes" + } + ] + } + }, + "MitigationInEffectEnumEnumValue": { + "type": "object", + "description": "Definition of MitigationInEffectEnumEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/MitigationInEffectEnum", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "TargetDescription": { + "type": "object", + "description": "Definition of TargetDescription", + "properties": { + "availabilityZone": { + "type": "string", + "description": "<p>An Availability Zone or <code>all</code>. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.</p> <p>For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as <code>all</code>.</p> <p>This parameter is not supported if the target type of the target group is <code>instance</code> or <code>alb</code>.</p> <p>If the target type is <code>ip</code> and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.</p> <p>For Application Load Balancer target groups with cross-zone load balancing off, if the target type is <code>ip</code> and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.</p> <p>If the target type is <code>lambda</code>, this parameter is optional and the only supported value is <code>all</code>.</p>" + }, + "id": { + "type": "string", + "description": "<p>The ID of the target. If the target type of the target group is <code>instance</code>, specify an instance ID. If the target type is <code>ip</code>, specify an IP address. If the target type is <code>lambda</code>, specify the ARN of the Lambda function. If the target type is <code>alb</code>, specify the ARN of the Application Load Balancer target. </p>" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "<p>The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is <code>alb</code>, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.</p>" + } + } + }, + "TargetHealth": { + "type": "object", + "description": "Definition of TargetHealth", + "properties": { + "description": { + "type": "string", + "description": "<p>A description of the target health that provides additional details. If the state is <code>healthy</code>, a description is not provided.</p>" + }, + "reason": { + "$ref": "#/definitions/TargetHealthReasonEnumEnumValue", + "description": "<p>The reason code.</p> <p>If the target state is <code>healthy</code>, a reason code is not provided.</p> <p>If the target state is <code>initial</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Elb.RegistrationInProgress</code> - The target is in the process of being registered with the load balancer.</p> </li> <li> <p> <code>Elb.InitialHealthChecking</code> - The load balancer is still sending the target the minimum number of health checks required to determine its health status.</p> </li> </ul> <p>If the target state is <code>unhealthy</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.ResponseCodeMismatch</code> - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.</p> </li> <li> <p> <code>Target.Timeout</code> - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.</p> </li> <li> <p> <code>Target.FailedHealthChecks</code> - The load balancer received an error while establishing a connection to the target or the target response was malformed.</p> </li> <li> <p> <code>Elb.InternalError</code> - The health checks failed due to an internal error. Applies only to Application Load Balancers.</p> </li> </ul> <p>If the target state is <code>unused</code>, the reason code can be one of the following values:</p> <ul> <li> <p> <code>Target.NotRegistered</code> - The target is not registered with the target group.</p> </li> <li> <p> <code>Target.NotInUse</code> - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.</p> </li> <li> <p> <code>Target.InvalidState</code> - The target is in the stopped or terminated state.</p> </li> <li> <p> <code>Target.IpUnusable</code> - The target IP address is reserved for use by a load balancer.</p> </li> </ul> <p>If the target state is <code>draining</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.DeregistrationInProgress</code> - The target is in the process of being deregistered and the deregistration delay period has not expired.</p> </li> </ul> <p>If the target state is <code>unavailable</code>, the reason code can be the following value:</p> <ul> <li> <p> <code>Target.HealthCheckDisabled</code> - Health checks are disabled for the target group. Applies only to Application Load Balancers.</p> </li> <li> <p> <code>Elb.InternalError</code> - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.</p> </li> </ul>" + }, + "state": { + "$ref": "#/definitions/TargetHealthStateEnumEnumValue", + "description": "<p>The state of the target.</p>" + } + } + }, + "TargetHealthReasonEnum": { + "type": "string", + "description": "TargetHealthReasonEnum enum", + "enum": [ + "Elb.InitialHealthChecking", + "Elb.InternalError", + "Elb.RegistrationInProgress", + "Target.DeregistrationInProgress", + "Target.FailedHealthChecks", + "Target.HealthCheckDisabled", + "Target.InvalidState", + "Target.IpUnusable", + "Target.NotInUse", + "Target.NotRegistered", + "Target.ResponseCodeMismatch", + "Target.Timeout" + ], + "x-ms-enum": { + "name": "TargetHealthReasonEnum", + "modelAsString": true, + "values": [ + { + "name": "ElbInitialHealthChecking", + "value": "Elb.InitialHealthChecking", + "description": "TargetHealthReasonEnum enum Elb.InitialHealthChecking" + }, + { + "name": "ElbInternalError", + "value": "Elb.InternalError", + "description": "TargetHealthReasonEnum enum Elb.InternalError" + }, + { + "name": "ElbRegistrationInProgress", + "value": "Elb.RegistrationInProgress", + "description": "TargetHealthReasonEnum enum Elb.RegistrationInProgress" + }, + { + "name": "TargetDeregistrationInProgress", + "value": "Target.DeregistrationInProgress", + "description": "TargetHealthReasonEnum enum Target.DeregistrationInProgress" + }, + { + "name": "TargetFailedHealthChecks", + "value": "Target.FailedHealthChecks", + "description": "TargetHealthReasonEnum enum Target.FailedHealthChecks" + }, + { + "name": "TargetHealthCheckDisabled", + "value": "Target.HealthCheckDisabled", + "description": "TargetHealthReasonEnum enum Target.HealthCheckDisabled" + }, + { + "name": "TargetInvalidState", + "value": "Target.InvalidState", + "description": "TargetHealthReasonEnum enum Target.InvalidState" + }, + { + "name": "TargetIpUnusable", + "value": "Target.IpUnusable", + "description": "TargetHealthReasonEnum enum Target.IpUnusable" + }, + { + "name": "TargetNotInUse", + "value": "Target.NotInUse", + "description": "TargetHealthReasonEnum enum Target.NotInUse" + }, + { + "name": "TargetNotRegistered", + "value": "Target.NotRegistered", + "description": "TargetHealthReasonEnum enum Target.NotRegistered" + }, + { + "name": "TargetResponseCodeMismatch", + "value": "Target.ResponseCodeMismatch", + "description": "TargetHealthReasonEnum enum Target.ResponseCodeMismatch" + }, + { + "name": "TargetTimeout", + "value": "Target.Timeout", + "description": "TargetHealthReasonEnum enum Target.Timeout" + } + ] + } + }, + "TargetHealthReasonEnumEnumValue": { + "type": "object", + "description": "Definition of TargetHealthReasonEnumEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/TargetHealthReasonEnum", + "description": "Property value" + } + } + }, + "TargetHealthStateEnum": { + "type": "string", + "description": "TargetHealthStateEnum enum", + "enum": [ + "draining", + "healthy", + "initial", + "unavailable", + "unhealthy", + "unhealthy.draining", + "unused" + ], + "x-ms-enum": { + "name": "TargetHealthStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Draining", + "value": "draining", + "description": "TargetHealthStateEnum enum draining" + }, + { + "name": "Healthy", + "value": "healthy", + "description": "TargetHealthStateEnum enum healthy" + }, + { + "name": "Initial", + "value": "initial", + "description": "TargetHealthStateEnum enum initial" + }, + { + "name": "Unavailable", + "value": "unavailable", + "description": "TargetHealthStateEnum enum unavailable" + }, + { + "name": "Unhealthy", + "value": "unhealthy", + "description": "TargetHealthStateEnum enum unhealthy" + }, + { + "name": "UnhealthyDraining", + "value": "unhealthy.draining", + "description": "TargetHealthStateEnum enum unhealthy.draining" + }, + { + "name": "Unused", + "value": "unused", + "description": "TargetHealthStateEnum enum unused" + } + ] + } + }, + "TargetHealthStateEnumEnumValue": { + "type": "object", + "description": "Definition of TargetHealthStateEnumEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/TargetHealthStateEnum", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrCluster.json new file mode 100644 index 000000000000..528328b9653c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrCluster.json @@ -0,0 +1,1282 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EmrClusters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/emrClusters": { + "get": { + "operationId": "EmrClusters_ListBySubscription", + "tags": [ + "EmrClusters" + ], + "description": "List EmrCluster resources 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/EmrClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusters_ListBySubscription": { + "$ref": "./examples/EmrClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/emrClusters": { + "get": { + "operationId": "EmrClusters_ListByResourceGroup", + "tags": [ + "EmrClusters" + ], + "description": "List EmrCluster resources 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/EmrClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusters_ListByResourceGroup": { + "$ref": "./examples/EmrClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/emrClusters/{name}": { + "get": { + "operationId": "EmrClusters_Get", + "tags": [ + "EmrClusters" + ], + "description": "Get a EmrCluster", + "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": "name", + "in": "path", + "description": "Name of EmrCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EmrCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusters_Get": { + "$ref": "./examples/EmrClusters_Get.json" + } + } + }, + "put": { + "operationId": "EmrClusters_CreateOrReplace", + "tags": [ + "EmrClusters" + ], + "description": "Create a EmrCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EmrCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EmrCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EmrCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/EmrCluster" + } + }, + "201": { + "description": "Resource 'EmrCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/EmrCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EmrClusters_CreateOrReplace": { + "$ref": "./examples/EmrClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EmrClusters_Update", + "tags": [ + "EmrClusters" + ], + "description": "Update a EmrCluster", + "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": "name", + "in": "path", + "description": "Name of EmrCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EmrClusterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EmrCluster" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusters_Update": { + "$ref": "./examples/EmrClusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EmrClusters_Delete", + "tags": [ + "EmrClusters" + ], + "description": "Delete a EmrCluster", + "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": "name", + "in": "path", + "description": "Name of EmrCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EmrClusters_Delete": { + "$ref": "./examples/EmrClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Application": { + "type": "object", + "description": "Definition of Application", + "properties": { + "additionalInfo": { + "type": "object", + "description": "<p>This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.</p>", + "additionalProperties": { + "type": "string" + } + }, + "args": { + "type": "array", + "description": "<p>Arguments for Amazon EMR to pass to the application.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "<p>The name of the application.</p>" + }, + "version": { + "type": "string", + "description": "<p>The version of the application.</p>" + } + } + }, + "AwsEmrClusterProperties": { + "type": "object", + "description": "Definition of awsEmrCluster", + "properties": { + "applications": { + "type": "array", + "description": "<p>The applications installed on this cluster.</p>", + "items": { + "$ref": "#/definitions/Application" + }, + "x-ms-identifiers": [] + }, + "autoScalingRole": { + "type": "string", + "description": "<p>An IAM role for automatic scaling policies. The default role is <code>EMR_AutoScaling_DefaultRole</code>. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.</p>" + }, + "autoTerminate": { + "type": "boolean", + "description": "<p>Specifies whether the cluster should terminate after completing all steps.</p>" + }, + "clusterArn": { + "type": "string", + "description": "<p>The Amazon Resource Name of the cluster.</p>" + }, + "configurations": { + "type": "array", + "description": "<p>Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.</p>", + "items": { + "$ref": "#/definitions/Configuration" + }, + "x-ms-identifiers": [] + }, + "customAmiId": { + "type": "string", + "description": "<p>Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.</p>" + }, + "ebsRootVolumeIops": { + "type": "integer", + "format": "int32", + "description": "<p>The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.</p>" + }, + "ebsRootVolumeSize": { + "type": "integer", + "format": "int32", + "description": "<p>The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.</p>" + }, + "ebsRootVolumeThroughput": { + "type": "integer", + "format": "int32", + "description": "<p>The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.</p>" + }, + "ec2InstanceAttributes": { + "$ref": "#/definitions/Ec2InstanceAttributes", + "description": "<p>Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.</p>" + }, + "id": { + "type": "string", + "description": "<p>The unique identifier for the cluster.</p>" + }, + "instanceCollectionType": { + "$ref": "#/definitions/InstanceCollectionTypeEnumValue", + "description": "<note> <p>The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.</p> </note> <p>The instance group configuration of the cluster. A value of <code>INSTANCE_GROUP</code> indicates a uniform instance group configuration. A value of <code>INSTANCE_FLEET</code> indicates an instance fleets configuration.</p>" + }, + "kerberosAttributes": { + "$ref": "#/definitions/KerberosAttributes", + "description": "<p>Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html'>Use Kerberos Authentication</a> in the <i>Amazon EMR Management Guide</i>.</p>" + }, + "logEncryptionKmsKeyId": { + "type": "string", + "description": "<p> The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. </p>" + }, + "logUri": { + "type": "string", + "description": "<p>The path to the Amazon S3 location where logs for this cluster are stored.</p>" + }, + "masterPublicDnsName": { + "type": "string", + "description": "<p>The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the cluster. This parameter can't contain the characters <, >, $, |, or ` (backtick).</p>" + }, + "normalizedInstanceHours": { + "type": "integer", + "format": "int32", + "description": "<p>An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.</p>" + }, + "osReleaseLabel": { + "type": "string", + "description": "<p>The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.</p>" + }, + "outpostArn": { + "type": "string", + "description": "<p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>" + }, + "placementGroups": { + "type": "array", + "description": "<p>Placement group configured for an Amazon EMR cluster.</p>", + "items": { + "$ref": "#/definitions/PlacementGroupConfig" + }, + "x-ms-identifiers": [] + }, + "releaseLabel": { + "type": "string", + "description": "<p>The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form <code>emr-x.x.x</code>, where x.x.x is an Amazon EMR release version such as <code>emr-5.14.0</code>. For more information about Amazon EMR release versions and included application versions and features, see <a href='https://docs.aws.amazon.com/emr/latest/ReleaseGuide/'>https://docs.aws.amazon.com/emr/latest/ReleaseGuide/</a>. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use <code>AmiVersion</code>.</p>" + }, + "repoUpgradeOnBoot": { + "$ref": "#/definitions/RepoUpgradeOnBootEnumValue", + "description": "<p>Applies only when <code>CustomAmiID</code> is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.</p>" + }, + "requestedAmiVersion": { + "type": "string", + "description": "<p>The AMI version requested for this cluster.</p>" + }, + "runningAmiVersion": { + "type": "string", + "description": "<p>The AMI version running on this cluster.</p>" + }, + "scaleDownBehavior": { + "$ref": "#/definitions/ScaleDownBehaviorEnumValue", + "description": "<p>The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. <code>TERMINATE_AT_INSTANCE_HOUR</code> indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. <code>TERMINATE_AT_TASK_COMPLETION</code> indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. <code>TERMINATE_AT_TASK_COMPLETION</code> is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.</p>" + }, + "securityConfiguration": { + "type": "string", + "description": "<p>The name of the security configuration applied to the cluster.</p>" + }, + "serviceRole": { + "type": "string", + "description": "<p>The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.</p>" + }, + "status": { + "$ref": "#/definitions/ClusterStatus", + "description": "<p>The current status details about the cluster.</p>" + }, + "stepConcurrencyLevel": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the number of steps that can be executed concurrently.</p>" + }, + "tags": { + "type": "array", + "description": "<p>A list of tags associated with a cluster.</p>", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "terminationProtected": { + "type": "boolean", + "description": "<p>Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.</p>" + }, + "unhealthyNodeReplacement": { + "type": "boolean", + "description": "<p>Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.</p>" + }, + "visibleToAllUsers": { + "type": "boolean", + "description": "<p>Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When <code>true</code>, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When <code>false</code>, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.</p> <p>The default value is <code>true</code> if a value is not provided when creating a cluster using the Amazon EMR API <a>RunJobFlow</a> command, the CLI <a href='https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html'>create-cluster</a> command, or the Amazon Web Services Management Console.</p>" + } + } + }, + "ClusterState": { + "type": "string", + "description": "ClusterState enum", + "enum": [ + "BOOTSTRAPPING", + "RUNNING", + "STARTING", + "TERMINATED", + "TERMINATED_WITH_ERRORS", + "TERMINATING", + "WAITING" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "name": "BOOTSTRAPPING", + "value": "BOOTSTRAPPING", + "description": "ClusterState enum BOOTSTRAPPING" + }, + { + "name": "RUNNING", + "value": "RUNNING", + "description": "ClusterState enum RUNNING" + }, + { + "name": "STARTING", + "value": "STARTING", + "description": "ClusterState enum STARTING" + }, + { + "name": "TERMINATED", + "value": "TERMINATED", + "description": "ClusterState enum TERMINATED" + }, + { + "name": "TERMINATED_WITH_ERRORS", + "value": "TERMINATED_WITH_ERRORS", + "description": "ClusterState enum TERMINATED_WITH_ERRORS" + }, + { + "name": "TERMINATING", + "value": "TERMINATING", + "description": "ClusterState enum TERMINATING" + }, + { + "name": "WAITING", + "value": "WAITING", + "description": "ClusterState enum WAITING" + } + ] + } + }, + "ClusterStateChangeReason": { + "type": "object", + "description": "Definition of ClusterStateChangeReason", + "properties": { + "code": { + "$ref": "#/definitions/ClusterStateChangeReasonCodeEnumValue", + "description": "<p>The programmatic code for the state change reason.</p>" + }, + "message": { + "type": "string", + "description": "<p>The descriptive message for the state change reason.</p>" + } + } + }, + "ClusterStateChangeReasonCode": { + "type": "string", + "description": "ClusterStateChangeReasonCode enum", + "enum": [ + "ALL_STEPS_COMPLETED", + "BOOTSTRAP_FAILURE", + "INSTANCE_FAILURE", + "INSTANCE_FLEET_TIMEOUT", + "INTERNAL_ERROR", + "STEP_FAILURE", + "USER_REQUEST", + "VALIDATION_ERROR" + ], + "x-ms-enum": { + "name": "ClusterStateChangeReasonCode", + "modelAsString": true, + "values": [ + { + "name": "ALL_STEPS_COMPLETED", + "value": "ALL_STEPS_COMPLETED", + "description": "ClusterStateChangeReasonCode enum ALL_STEPS_COMPLETED" + }, + { + "name": "BOOTSTRAP_FAILURE", + "value": "BOOTSTRAP_FAILURE", + "description": "ClusterStateChangeReasonCode enum BOOTSTRAP_FAILURE" + }, + { + "name": "INSTANCE_FAILURE", + "value": "INSTANCE_FAILURE", + "description": "ClusterStateChangeReasonCode enum INSTANCE_FAILURE" + }, + { + "name": "INSTANCE_FLEET_TIMEOUT", + "value": "INSTANCE_FLEET_TIMEOUT", + "description": "ClusterStateChangeReasonCode enum INSTANCE_FLEET_TIMEOUT" + }, + { + "name": "INTERNAL_ERROR", + "value": "INTERNAL_ERROR", + "description": "ClusterStateChangeReasonCode enum INTERNAL_ERROR" + }, + { + "name": "STEP_FAILURE", + "value": "STEP_FAILURE", + "description": "ClusterStateChangeReasonCode enum STEP_FAILURE" + }, + { + "name": "USER_REQUEST", + "value": "USER_REQUEST", + "description": "ClusterStateChangeReasonCode enum USER_REQUEST" + }, + { + "name": "VALIDATION_ERROR", + "value": "VALIDATION_ERROR", + "description": "ClusterStateChangeReasonCode enum VALIDATION_ERROR" + } + ] + } + }, + "ClusterStateChangeReasonCodeEnumValue": { + "type": "object", + "description": "Definition of ClusterStateChangeReasonCodeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterStateChangeReasonCode", + "description": "Property value" + } + } + }, + "ClusterStateEnumValue": { + "type": "object", + "description": "Definition of ClusterStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterState", + "description": "Property value" + } + } + }, + "ClusterStatus": { + "type": "object", + "description": "Definition of ClusterStatus", + "properties": { + "errorDetails": { + "type": "array", + "description": "<p>A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different <code>ErrorDetail</code> tuples.</p>", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [] + }, + "state": { + "$ref": "#/definitions/ClusterStateEnumValue", + "description": "<p>The current state of the cluster.</p>" + }, + "stateChangeReason": { + "$ref": "#/definitions/ClusterStateChangeReason", + "description": "<p>The reason for the cluster status change.</p>" + }, + "timeline": { + "$ref": "#/definitions/ClusterTimeline", + "description": "<p>A timeline that represents the status of a cluster over the lifetime of the cluster.</p>" + } + } + }, + "ClusterTimeline": { + "type": "object", + "description": "Definition of ClusterTimeline", + "properties": { + "creationDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The creation date and time of the cluster.</p>" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the cluster was terminated.</p>" + }, + "readyDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the cluster was ready to run steps.</p>" + } + } + }, + "Configuration": { + "type": "object", + "description": "Definition of Configuration", + "properties": { + "classification": { + "type": "string", + "description": "<p>The classification within a configuration.</p>" + }, + "configurations": { + "type": "array", + "description": "<p>A list of additional configurations to apply within a configuration object.</p>", + "items": { + "$ref": "#/definitions/Configuration" + }, + "x-ms-identifiers": [] + }, + "properties": { + "type": "object", + "description": "<p>A set of properties specified within a configuration classification.</p>", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Ec2InstanceAttributes": { + "type": "object", + "description": "Definition of Ec2InstanceAttributes", + "properties": { + "additionalMasterSecurityGroups": { + "type": "array", + "description": "<p>A list of additional Amazon EC2 security group IDs for the master node.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "additionalSlaveSecurityGroups": { + "type": "array", + "description": "<p>A list of additional Amazon EC2 security group IDs for the core and task nodes.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "ec2AvailabilityZone": { + "type": "string", + "description": "<p>The Availability Zone in which the cluster will run. </p>" + }, + "ec2KeyName": { + "type": "string", + "description": "<p>The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named 'hadoop'.</p>" + }, + "ec2SubnetId": { + "type": "string", + "description": "<p>Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.</p>" + }, + "emrManagedMasterSecurityGroup": { + "type": "string", + "description": "<p>The identifier of the Amazon EC2 security group for the master node.</p>" + }, + "emrManagedSlaveSecurityGroup": { + "type": "string", + "description": "<p>The identifier of the Amazon EC2 security group for the core and task nodes.</p>" + }, + "iamInstanceProfile": { + "type": "string", + "description": "<p>The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.</p>" + }, + "requestedEc2AvailabilityZones": { + "type": "array", + "description": "<p>Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of <code>RequestedEc2AvailabilityZones</code>, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "requestedEc2SubnetIds": { + "type": "array", + "description": "<p>Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of <code>RequestedEc2SubnetIds</code>, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses <code>RequestedEc2AvailabilityZones</code> instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. <code>RequestedEc2SubnetIDs</code> and <code>RequestedEc2AvailabilityZones</code> cannot be specified together.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "serviceAccessSecurityGroup": { + "type": "string", + "description": "<p>The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.</p>" + } + } + }, + "EmrCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EmrClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EmrClusterListResult": { + "type": "object", + "description": "The response of a EmrCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EmrCluster items on this page", + "items": { + "$ref": "#/definitions/EmrCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EmrClusterProperties": { + "type": "object", + "description": "Definition of EmrCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEmrClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EmrClusterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EmrCluster resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Definition of ErrorDetail", + "properties": { + "errorCode": { + "type": "string", + "description": "<p>The name or code associated with the error.</p>" + }, + "errorData": { + "type": "array", + "description": "<p>A list of key value pairs that provides contextual information about why an error occured.</p>", + "items": { + "$ref": "#/definitions/StringMap" + }, + "x-ms-identifiers": [] + }, + "errorMessage": { + "type": "string", + "description": "<p>A message that describes the error.</p>" + } + } + }, + "InstanceCollectionType": { + "type": "string", + "description": "InstanceCollectionType enum", + "enum": [ + "INSTANCE_FLEET", + "INSTANCE_GROUP" + ], + "x-ms-enum": { + "name": "InstanceCollectionType", + "modelAsString": true, + "values": [ + { + "name": "INSTANCE_FLEET", + "value": "INSTANCE_FLEET", + "description": "InstanceCollectionType enum INSTANCE_FLEET" + }, + { + "name": "INSTANCE_GROUP", + "value": "INSTANCE_GROUP", + "description": "InstanceCollectionType enum INSTANCE_GROUP" + } + ] + } + }, + "InstanceCollectionTypeEnumValue": { + "type": "object", + "description": "Definition of InstanceCollectionTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceCollectionType", + "description": "Property value" + } + } + }, + "InstanceRoleType": { + "type": "string", + "description": "InstanceRoleType enum", + "enum": [ + "CORE", + "MASTER", + "TASK" + ], + "x-ms-enum": { + "name": "InstanceRoleType", + "modelAsString": true, + "values": [ + { + "name": "CORE", + "value": "CORE", + "description": "InstanceRoleType enum CORE" + }, + { + "name": "MASTER", + "value": "MASTER", + "description": "InstanceRoleType enum MASTER" + }, + { + "name": "TASK", + "value": "TASK", + "description": "InstanceRoleType enum TASK" + } + ] + } + }, + "InstanceRoleTypeEnumValue": { + "type": "object", + "description": "Definition of InstanceRoleTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceRoleType", + "description": "Property value" + } + } + }, + "KerberosAttributes": { + "type": "object", + "description": "Definition of KerberosAttributes", + "properties": { + "adDomainJoinPassword": { + "type": "string", + "description": "<p>The Active Directory password for <code>ADDomainJoinUser</code>.</p>" + }, + "adDomainJoinUser": { + "type": "string", + "description": "<p>Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.</p>" + }, + "crossRealmTrustPrincipalPassword": { + "type": "string", + "description": "<p>Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.</p>" + }, + "kdcAdminPassword": { + "type": "string", + "description": "<p>The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.</p>" + }, + "realm": { + "type": "string", + "description": "<p>The name of the Kerberos realm to which all nodes in a cluster belong. For example, <code>EC2.INTERNAL</code>. </p>" + } + } + }, + "PlacementGroupConfig": { + "type": "object", + "description": "Definition of PlacementGroupConfig", + "properties": { + "instanceRole": { + "$ref": "#/definitions/InstanceRoleTypeEnumValue", + "description": "<p>Role of the instance in the cluster.</p> <p>Starting with Amazon EMR release 5.23.0, the only supported instance role is <code>MASTER</code>.</p>" + }, + "placementStrategy": { + "$ref": "#/definitions/PlacementGroupStrategyEnumValue", + "description": "<p>Amazon EC2 Placement Group strategy associated with instance role.</p> <p>Starting with Amazon EMR release 5.23.0, the only supported placement strategy is <code>SPREAD</code> for the <code>MASTER</code> instance role.</p>" + } + } + }, + "PlacementGroupStrategy": { + "type": "string", + "description": "PlacementGroupStrategy enum", + "enum": [ + "CLUSTER", + "NONE", + "PARTITION", + "SPREAD" + ], + "x-ms-enum": { + "name": "PlacementGroupStrategy", + "modelAsString": true, + "values": [ + { + "name": "CLUSTER", + "value": "CLUSTER", + "description": "PlacementGroupStrategy enum CLUSTER" + }, + { + "name": "NONE", + "value": "NONE", + "description": "PlacementGroupStrategy enum NONE" + }, + { + "name": "PARTITION", + "value": "PARTITION", + "description": "PlacementGroupStrategy enum PARTITION" + }, + { + "name": "SPREAD", + "value": "SPREAD", + "description": "PlacementGroupStrategy enum SPREAD" + } + ] + } + }, + "PlacementGroupStrategyEnumValue": { + "type": "object", + "description": "Definition of PlacementGroupStrategyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PlacementGroupStrategy", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RepoUpgradeOnBoot": { + "type": "string", + "description": "RepoUpgradeOnBoot enum", + "enum": [ + "NONE", + "SECURITY" + ], + "x-ms-enum": { + "name": "RepoUpgradeOnBoot", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "RepoUpgradeOnBoot enum NONE" + }, + { + "name": "SECURITY", + "value": "SECURITY", + "description": "RepoUpgradeOnBoot enum SECURITY" + } + ] + } + }, + "RepoUpgradeOnBootEnumValue": { + "type": "object", + "description": "Definition of RepoUpgradeOnBootEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RepoUpgradeOnBoot", + "description": "Property value" + } + } + }, + "ScaleDownBehavior": { + "type": "string", + "description": "ScaleDownBehavior enum", + "enum": [ + "TERMINATE_AT_INSTANCE_HOUR", + "TERMINATE_AT_TASK_COMPLETION" + ], + "x-ms-enum": { + "name": "ScaleDownBehavior", + "modelAsString": true, + "values": [ + { + "name": "TERMINATE_AT_INSTANCE_HOUR", + "value": "TERMINATE_AT_INSTANCE_HOUR", + "description": "ScaleDownBehavior enum TERMINATE_AT_INSTANCE_HOUR" + }, + { + "name": "TERMINATE_AT_TASK_COMPLETION", + "value": "TERMINATE_AT_TASK_COMPLETION", + "description": "ScaleDownBehavior enum TERMINATE_AT_TASK_COMPLETION" + } + ] + } + }, + "ScaleDownBehaviorEnumValue": { + "type": "object", + "description": "Definition of ScaleDownBehaviorEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ScaleDownBehavior", + "description": "Property value" + } + } + }, + "StringMap": { + "type": "object", + "description": "Definition of StringMap" + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>A user-defined key, which is the minimum required information for a valid tag. For more information, see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html'>Tag</a>. </p>" + }, + "value": { + "type": "string", + "description": "<p>A user-defined value, which is optional in a tag. For more information, see <a href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-tags.html'>Tag Clusters</a>. </p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrClusterSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrClusterSummary.json new file mode 100644 index 000000000000..ac578fd1c7e4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/emrClusterSummary.json @@ -0,0 +1,788 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EmrClusterSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/emrClusterSummaries": { + "get": { + "operationId": "EmrClusterSummaries_ListBySubscription", + "tags": [ + "EmrClusterSummaries" + ], + "description": "List EmrClusterSummary resources 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/EmrClusterSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusterSummaries_ListBySubscription": { + "$ref": "./examples/EmrClusterSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/emrClusterSummaries": { + "get": { + "operationId": "EmrClusterSummaries_ListByResourceGroup", + "tags": [ + "EmrClusterSummaries" + ], + "description": "List EmrClusterSummary resources 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/EmrClusterSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusterSummaries_ListByResourceGroup": { + "$ref": "./examples/EmrClusterSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/emrClusterSummaries/{name}": { + "get": { + "operationId": "EmrClusterSummaries_Get", + "tags": [ + "EmrClusterSummaries" + ], + "description": "Get a EmrClusterSummary", + "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": "name", + "in": "path", + "description": "Name of EmrClusterSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EmrClusterSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusterSummaries_Get": { + "$ref": "./examples/EmrClusterSummaries_Get.json" + } + } + }, + "put": { + "operationId": "EmrClusterSummaries_CreateOrReplace", + "tags": [ + "EmrClusterSummaries" + ], + "description": "Create a EmrClusterSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of EmrClusterSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EmrClusterSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EmrClusterSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/EmrClusterSummary" + } + }, + "201": { + "description": "Resource 'EmrClusterSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/EmrClusterSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EmrClusterSummaries_CreateOrReplace": { + "$ref": "./examples/EmrClusterSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "EmrClusterSummaries_Update", + "tags": [ + "EmrClusterSummaries" + ], + "description": "Update a EmrClusterSummary", + "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": "name", + "in": "path", + "description": "Name of EmrClusterSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/EmrClusterSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EmrClusterSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EmrClusterSummaries_Update": { + "$ref": "./examples/EmrClusterSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EmrClusterSummaries_Delete", + "tags": [ + "EmrClusterSummaries" + ], + "description": "Delete a EmrClusterSummary", + "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": "name", + "in": "path", + "description": "Name of EmrClusterSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "EmrClusterSummaries_Delete": { + "$ref": "./examples/EmrClusterSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsEmrClusterSummaryProperties": { + "type": "object", + "description": "Definition of awsEmrClusterSummary", + "properties": { + "clusterArn": { + "type": "string", + "description": "<p>The Amazon Resource Name of the cluster.</p>" + }, + "id": { + "type": "string", + "description": "<p>The unique identifier for the cluster.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the cluster.</p>" + }, + "normalizedInstanceHours": { + "type": "integer", + "format": "int32", + "description": "<p>An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.</p>" + }, + "outpostArn": { + "type": "string", + "description": "<p> The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. </p>" + }, + "status": { + "$ref": "#/definitions/ClusterStatus", + "description": "<p>The details about the current status of the cluster.</p>" + } + } + }, + "ClusterState": { + "type": "string", + "description": "ClusterState enum", + "enum": [ + "BOOTSTRAPPING", + "RUNNING", + "STARTING", + "TERMINATED", + "TERMINATED_WITH_ERRORS", + "TERMINATING", + "WAITING" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "name": "BOOTSTRAPPING", + "value": "BOOTSTRAPPING", + "description": "ClusterState enum BOOTSTRAPPING" + }, + { + "name": "RUNNING", + "value": "RUNNING", + "description": "ClusterState enum RUNNING" + }, + { + "name": "STARTING", + "value": "STARTING", + "description": "ClusterState enum STARTING" + }, + { + "name": "TERMINATED", + "value": "TERMINATED", + "description": "ClusterState enum TERMINATED" + }, + { + "name": "TERMINATED_WITH_ERRORS", + "value": "TERMINATED_WITH_ERRORS", + "description": "ClusterState enum TERMINATED_WITH_ERRORS" + }, + { + "name": "TERMINATING", + "value": "TERMINATING", + "description": "ClusterState enum TERMINATING" + }, + { + "name": "WAITING", + "value": "WAITING", + "description": "ClusterState enum WAITING" + } + ] + } + }, + "ClusterStateChangeReason": { + "type": "object", + "description": "Definition of ClusterStateChangeReason", + "properties": { + "code": { + "$ref": "#/definitions/ClusterStateChangeReasonCodeEnumValue", + "description": "<p>The programmatic code for the state change reason.</p>" + }, + "message": { + "type": "string", + "description": "<p>The descriptive message for the state change reason.</p>" + } + } + }, + "ClusterStateChangeReasonCode": { + "type": "string", + "description": "ClusterStateChangeReasonCode enum", + "enum": [ + "ALL_STEPS_COMPLETED", + "BOOTSTRAP_FAILURE", + "INSTANCE_FAILURE", + "INSTANCE_FLEET_TIMEOUT", + "INTERNAL_ERROR", + "STEP_FAILURE", + "USER_REQUEST", + "VALIDATION_ERROR" + ], + "x-ms-enum": { + "name": "ClusterStateChangeReasonCode", + "modelAsString": true, + "values": [ + { + "name": "ALL_STEPS_COMPLETED", + "value": "ALL_STEPS_COMPLETED", + "description": "ClusterStateChangeReasonCode enum ALL_STEPS_COMPLETED" + }, + { + "name": "BOOTSTRAP_FAILURE", + "value": "BOOTSTRAP_FAILURE", + "description": "ClusterStateChangeReasonCode enum BOOTSTRAP_FAILURE" + }, + { + "name": "INSTANCE_FAILURE", + "value": "INSTANCE_FAILURE", + "description": "ClusterStateChangeReasonCode enum INSTANCE_FAILURE" + }, + { + "name": "INSTANCE_FLEET_TIMEOUT", + "value": "INSTANCE_FLEET_TIMEOUT", + "description": "ClusterStateChangeReasonCode enum INSTANCE_FLEET_TIMEOUT" + }, + { + "name": "INTERNAL_ERROR", + "value": "INTERNAL_ERROR", + "description": "ClusterStateChangeReasonCode enum INTERNAL_ERROR" + }, + { + "name": "STEP_FAILURE", + "value": "STEP_FAILURE", + "description": "ClusterStateChangeReasonCode enum STEP_FAILURE" + }, + { + "name": "USER_REQUEST", + "value": "USER_REQUEST", + "description": "ClusterStateChangeReasonCode enum USER_REQUEST" + }, + { + "name": "VALIDATION_ERROR", + "value": "VALIDATION_ERROR", + "description": "ClusterStateChangeReasonCode enum VALIDATION_ERROR" + } + ] + } + }, + "ClusterStateChangeReasonCodeEnumValue": { + "type": "object", + "description": "Definition of ClusterStateChangeReasonCodeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterStateChangeReasonCode", + "description": "Property value" + } + } + }, + "ClusterStateEnumValue": { + "type": "object", + "description": "Definition of ClusterStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ClusterState", + "description": "Property value" + } + } + }, + "ClusterStatus": { + "type": "object", + "description": "Definition of ClusterStatus", + "properties": { + "errorDetails": { + "type": "array", + "description": "<p>A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different <code>ErrorDetail</code> tuples.</p>", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [] + }, + "state": { + "$ref": "#/definitions/ClusterStateEnumValue", + "description": "<p>The current state of the cluster.</p>" + }, + "stateChangeReason": { + "$ref": "#/definitions/ClusterStateChangeReason", + "description": "<p>The reason for the cluster status change.</p>" + }, + "timeline": { + "$ref": "#/definitions/ClusterTimeline", + "description": "<p>A timeline that represents the status of a cluster over the lifetime of the cluster.</p>" + } + } + }, + "ClusterTimeline": { + "type": "object", + "description": "Definition of ClusterTimeline", + "properties": { + "creationDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The creation date and time of the cluster.</p>" + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the cluster was terminated.</p>" + }, + "readyDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the cluster was ready to run steps.</p>" + } + } + }, + "EmrClusterSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/EmrClusterSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "EmrClusterSummaryListResult": { + "type": "object", + "description": "The response of a EmrClusterSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EmrClusterSummary items on this page", + "items": { + "$ref": "#/definitions/EmrClusterSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EmrClusterSummaryProperties": { + "type": "object", + "description": "Definition of EmrClusterSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsEmrClusterSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "EmrClusterSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in EmrClusterSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Definition of ErrorDetail", + "properties": { + "errorCode": { + "type": "string", + "description": "<p>The name or code associated with the error.</p>" + }, + "errorData": { + "type": "array", + "description": "<p>A list of key value pairs that provides contextual information about why an error occured.</p>", + "items": { + "$ref": "#/definitions/StringMap" + }, + "x-ms-identifiers": [] + }, + "errorMessage": { + "type": "string", + "description": "<p>A message that describes the error.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "StringMap": { + "type": "object", + "description": "Definition of StringMap" + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_CreateOrReplace.json new file mode 100644 index 000000000000..7df378f571fb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_CreateOrReplace.json @@ -0,0 +1,196 @@ +{ + "title": "AccessAnalyzerAnalyzers_CreateOrReplace", + "operationId": "AccessAnalyzerAnalyzers_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + } + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Delete.json new file mode 100644 index 000000000000..8927311ebc49 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AccessAnalyzerAnalyzers_Delete", + "operationId": "AccessAnalyzerAnalyzers_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Get.json new file mode 100644 index 000000000000..62c2f082be31 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Get.json @@ -0,0 +1,77 @@ +{ + "title": "AccessAnalyzerAnalyzers_Get", + "operationId": "AccessAnalyzerAnalyzers_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json new file mode 100644 index 000000000000..dffcd2fbfe71 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListByResourceGroup.json @@ -0,0 +1,81 @@ +{ + "title": "AccessAnalyzerAnalyzers_ListByResourceGroup", + "operationId": "AccessAnalyzerAnalyzers_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListBySubscription.json new file mode 100644 index 000000000000..559d289adb65 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_ListBySubscription.json @@ -0,0 +1,80 @@ +{ + "title": "AccessAnalyzerAnalyzers_ListBySubscription", + "operationId": "AccessAnalyzerAnalyzers_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Update.json new file mode 100644 index 000000000000..702449a00623 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AccessAnalyzerAnalyzers_Update.json @@ -0,0 +1,87 @@ +{ + "title": "AccessAnalyzerAnalyzers_Update", + "operationId": "AccessAnalyzerAnalyzers_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "57BDF31C-32EA-4CA1-BC01-873DFDAA6D20", + "resourceGroupName": "rgaccessAnalyzerAnalyzer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1003": "qwlcozyqjeulbpmknq" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "analyzerConfiguration": { + "unusedAccessAge": 29 + }, + "analyzerName": "owom", + "archiveRules": [ + { + "filter": [ + { + "contains": [ + "hpzoliradchznu" + ], + "eq": [ + "vlrqwrfkkwxvyxmqpbmwkxig" + ], + "exists": true, + "neq": [ + "ro" + ], + "property": "pzndukmteempygtvmsrcrjulphe" + } + ], + "ruleName": "hvfnklcbuefkibrtayx" + } + ], + "arn": "bmt", + "tags": [ + { + "key": "xeapsjw", + "value": "mtcjrbabaynnrmqttjf" + } + ], + "type": "vswmvhmkyxepqkvvksbglssmrgg" + }, + "publicCloudConnectorsResourceId": "qfefhuzrkvg", + "awsAccountId": "pvsawejgihtmvcjqnob", + "arn": "dgzbebaorvepu", + "publicCloudResourceName": "euuddejz", + "awsSourceSchema": "ur", + "awsRegion": "edosnsqdwcvgl", + "awsTags": { + "key746": "ux" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5531": "fkyuwvyhzd" + }, + "location": "jpcbvhsspnqhnreartkjyr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AccessAnalyzerAnalyzers/{resourceName}", + "name": "ufpyfqqujqkhoaysswb", + "type": "m", + "systemData": { + "createdBy": "vzqirajjsggwxeqgpujcyxlqpkaa", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:19.488Z", + "lastModifiedBy": "hjqbaxqnotrbjbwcwvcrg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:19.489Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..d434a5d8d233 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_CreateOrReplace.json @@ -0,0 +1,196 @@ +{ + "title": "AcmCertificateSummaries_CreateOrReplace", + "operationId": "AcmCertificateSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + } + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Delete.json new file mode 100644 index 000000000000..be7591ee60f5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AcmCertificateSummaries_Delete", + "operationId": "AcmCertificateSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Get.json new file mode 100644 index 000000000000..2a81bc86b829 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Get.json @@ -0,0 +1,77 @@ +{ + "title": "AcmCertificateSummaries_Get", + "operationId": "AcmCertificateSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..27a8f5108708 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListByResourceGroup.json @@ -0,0 +1,81 @@ +{ + "title": "AcmCertificateSummaries_ListByResourceGroup", + "operationId": "AcmCertificateSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListBySubscription.json new file mode 100644 index 000000000000..ac9237c67192 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_ListBySubscription.json @@ -0,0 +1,80 @@ +{ + "title": "AcmCertificateSummaries_ListBySubscription", + "operationId": "AcmCertificateSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Update.json new file mode 100644 index 000000000000..0e1fce25965c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AcmCertificateSummaries_Update.json @@ -0,0 +1,87 @@ +{ + "title": "AcmCertificateSummaries_Update", + "operationId": "AcmCertificateSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DF357373-5282-40C9-90CA-453C9B4172DD", + "resourceGroupName": "rgacmCertificateSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3895": "kebzsfrojxzzoumlemmuisxjnshoch" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "certificateArn": "vhqvrajxbcvstwiktrdilktqiwnsij", + "createdAt": "2024-10-08T03:50:37.721Z", + "domainName": "fiqx", + "exported": true, + "extendedKeyUsages": [ + "ANY" + ], + "hasAdditionalSubjectAlternativeNames": true, + "importedAt": "2024-10-08T03:50:37.721Z", + "inUse": true, + "issuedAt": "2024-10-08T03:50:37.721Z", + "keyAlgorithm": { + "value": "EC_prime256v1" + }, + "keyUsages": [ + "ANY" + ], + "notAfter": "2024-10-08T03:50:37.721Z", + "notBefore": "2024-10-08T03:50:37.721Z", + "renewalEligibility": { + "value": "ELIGIBLE" + }, + "revokedAt": "2024-10-08T03:50:37.722Z", + "status": { + "value": "EXPIRED" + }, + "subjectAlternativeNameSummaries": [ + "oqoukflpt" + ], + "type": { + "value": "AMAZON_ISSUED" + } + }, + "publicCloudConnectorsResourceId": "xljncqoovqhqla", + "awsAccountId": "mmihqxcdhmlvxmnbgspuxddg", + "arn": "smalkenxqfohwtuwomvsiijg", + "publicCloudResourceName": "qdwfldkrmzyifdlfjpxducgue", + "awsSourceSchema": "llzijlhflcpnbwpp", + "awsRegion": "vkxrwhsmzwvxzraytkujjlrzxdpbz", + "awsTags": { + "key6233": "kvfcopflgcuaqebawlfvxdozicsaj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9243": "wylumurgyvmplwt" + }, + "location": "eqfgreyihqzkrcyaxvy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AcmCertificateSummaries/{resourceName}", + "name": "elwkuxydufjmppqyyrr", + "type": "katdodtaf", + "systemData": { + "createdBy": "upe", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:37.724Z", + "lastModifiedBy": "pprebpbszmrbbjxtltbbpzxgu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:37.724Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_CreateOrReplace.json new file mode 100644 index 000000000000..0c2029eef305 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_CreateOrReplace.json @@ -0,0 +1,214 @@ +{ + "title": "ApiGatewayRestApis_CreateOrReplace", + "operationId": "ApiGatewayRestApis_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + } + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Delete.json new file mode 100644 index 000000000000..06f36879e989 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ApiGatewayRestApis_Delete", + "operationId": "ApiGatewayRestApis_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Get.json new file mode 100644 index 000000000000..5e9dc554036c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Get.json @@ -0,0 +1,83 @@ +{ + "title": "ApiGatewayRestApis_Get", + "operationId": "ApiGatewayRestApis_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListByResourceGroup.json new file mode 100644 index 000000000000..09fda07831e9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "title": "ApiGatewayRestApis_ListByResourceGroup", + "operationId": "ApiGatewayRestApis_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListBySubscription.json new file mode 100644 index 000000000000..6fe6baf45280 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_ListBySubscription.json @@ -0,0 +1,86 @@ +{ + "title": "ApiGatewayRestApis_ListBySubscription", + "operationId": "ApiGatewayRestApis_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Update.json new file mode 100644 index 000000000000..02507dfa7b4d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayRestApis_Update.json @@ -0,0 +1,93 @@ +{ + "title": "ApiGatewayRestApis_Update", + "operationId": "ApiGatewayRestApis_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B8DAFD48-EC43-4B58-B6F1-C2670622A330", + "resourceGroupName": "rgapiGatewayRestApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2677": "xut" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "apiKeySourceType": "f", + "binaryMediaTypes": [ + "ahebgkheozatj" + ], + "body": {}, + "bodyS3Location": { + "bucket": "oyosqpl", + "eTag": "uuzlkbqlua", + "key": "nsks", + "version": "lxbmxdrsftqwazmgxlokuvf" + }, + "cloneFrom": "boxfqilij", + "description": "ngqhnoniiohuwofr", + "disableExecuteApiEndpoint": true, + "endpointConfiguration": { + "types": [ + "dfhdcsvbasfadeuneaz" + ], + "vpcEndpointIds": [ + "evzbafcpdpklwppge" + ] + }, + "failOnWarnings": true, + "minimumCompressionSize": 11, + "mode": "odjmjlcgkmskasrasoegyxnuqr", + "name": "ioyxag", + "parameters": { + "key9886": "kwxjcmpsfptfkdeajrzqt" + }, + "policy": "jefpbspvgtinulqfyjxuxcunzkpgvw", + "restApiId": "hlyfcdcgknhbjezdxgbg", + "rootResourceId": "jfmgp", + "tags": [ + { + "key": "zvkbvzxmbhtugr", + "value": "uozcrgrc" + } + ] + }, + "publicCloudConnectorsResourceId": "diszsfnljduoshvzzgcyypsjnxs", + "awsAccountId": "qjcvyhdegwhvzsiuqjwnvdqs", + "arn": "mjkvrfpgenxbfozh", + "publicCloudResourceName": "tvtpphxonsvnvtmccbpcsvvvslbxxc", + "awsSourceSchema": "oagqktjiz", + "awsRegion": "bzj", + "awsTags": { + "key5478": "g" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4163": "gqwufsfmbcznfkcfnjsejmna" + }, + "location": "lvqczthlir", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayRestApis/{resourceName}", + "name": "fkngxaddvxbddxbt", + "type": "iahmdequaswkthuydkoyrr", + "systemData": { + "createdBy": "toydxnktimfnejyziqesfxjmctkmfs", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:29.224Z", + "lastModifiedBy": "ijtkymweknmonlyrmhiic", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:29.224Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_CreateOrReplace.json new file mode 100644 index 000000000000..a2db84b89df5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "ApiGatewayStages_CreateOrReplace", + "operationId": "ApiGatewayStages_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + } + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Delete.json new file mode 100644 index 000000000000..7083d9efbb91 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ApiGatewayStages_Delete", + "operationId": "ApiGatewayStages_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Get.json new file mode 100644 index 000000000000..a217d729e484 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Get.json @@ -0,0 +1,89 @@ +{ + "title": "ApiGatewayStages_Get", + "operationId": "ApiGatewayStages_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListByResourceGroup.json new file mode 100644 index 000000000000..a9d38201d101 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "ApiGatewayStages_ListByResourceGroup", + "operationId": "ApiGatewayStages_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListBySubscription.json new file mode 100644 index 000000000000..2f080c824549 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "ApiGatewayStages_ListBySubscription", + "operationId": "ApiGatewayStages_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Update.json new file mode 100644 index 000000000000..39b014205f8d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ApiGatewayStages_Update.json @@ -0,0 +1,99 @@ +{ + "title": "ApiGatewayStages_Update", + "operationId": "ApiGatewayStages_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D1773520-B417-499A-880D-B554B9B85B45", + "resourceGroupName": "rgapiGatewayStage", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key149": "wpmvxfqmbbskeejljljiimipwn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessLogSetting": { + "destinationArn": "bjnehkhrjvy", + "format": "jyhhqidjew" + }, + "cacheClusterEnabled": true, + "cacheClusterSize": "tqpsxptkwagykhry", + "canarySetting": { + "deploymentId": "jgfflpjviovk", + "percentTraffic": 30, + "stageVariableOverrides": { + "key989": "zalwrlwgjwqn" + }, + "useStageCache": true + }, + "clientCertificateId": "lcqbeactfdarpess", + "deploymentId": "muwatddsfb", + "description": "dmxblpsncciutbbmfihkloqaxuab", + "documentationVersion": "fltvrg", + "methodSettings": [ + { + "cacheDataEncrypted": true, + "cacheTtlInSeconds": 15, + "cachingEnabled": true, + "dataTraceEnabled": true, + "httpMethod": "wojjxwrlnmnertmfkstofcoekjxd", + "loggingLevel": "cezcwkojlmp", + "metricsEnabled": true, + "resourcePath": "fsaykfuxsfvultpnnpjjbak", + "throttlingBurstLimit": 3, + "throttlingRateLimit": 28 + } + ], + "restApiId": "cycztypxndrdmstjwi", + "stageName": "iukgreicaikhlooycykkql", + "tags": [ + { + "key": "hnoncuskljmyehkhfaytophcz", + "value": "x" + } + ], + "tracingEnabled": true, + "variables": { + "key3007": "vhgivtbzor" + } + }, + "publicCloudConnectorsResourceId": "mvvltlx", + "awsAccountId": "umvnhbnjqbgppgipyiuxvyt", + "arn": "aitrzss", + "publicCloudResourceName": "hxgdpqw", + "awsSourceSchema": "ttwdzidmknfow", + "awsRegion": "qkjxqupbneeuooyrfnblmwlrpmjsiu", + "awsTags": { + "key1607": "vmmmhuuxrrjul" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key72": "pkvum" + }, + "location": "ixsfvcwygoceaaydsgkvubn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ApiGatewayStages/{resourceName}", + "name": "ldforro", + "type": "kxnkwdpoyeeodesercidpnhpohp", + "systemData": { + "createdBy": "nxjlyuilzuxteffdcvk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:13.996Z", + "lastModifiedBy": "opamjpqahedxxsftwpmzoiyhpn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:13.997Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_CreateOrReplace.json new file mode 100644 index 000000000000..60e2d1689306 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_CreateOrReplace.json @@ -0,0 +1,373 @@ +{ + "title": "AppSyncGraphqlApis_CreateOrReplace", + "operationId": "AppSyncGraphqlApis_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + } + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Delete.json new file mode 100644 index 000000000000..c35a8f273b3a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AppSyncGraphqlApis_Delete", + "operationId": "AppSyncGraphqlApis_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Get.json new file mode 100644 index 000000000000..c391e93ee2aa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Get.json @@ -0,0 +1,136 @@ +{ + "title": "AppSyncGraphqlApis_Get", + "operationId": "AppSyncGraphqlApis_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListByResourceGroup.json new file mode 100644 index 000000000000..19b91a18ad71 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListByResourceGroup.json @@ -0,0 +1,140 @@ +{ + "title": "AppSyncGraphqlApis_ListByResourceGroup", + "operationId": "AppSyncGraphqlApis_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListBySubscription.json new file mode 100644 index 000000000000..72f432ee7c42 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_ListBySubscription.json @@ -0,0 +1,139 @@ +{ + "title": "AppSyncGraphqlApis_ListBySubscription", + "operationId": "AppSyncGraphqlApis_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Update.json new file mode 100644 index 000000000000..e3e757764418 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AppSyncGraphqlApis_Update.json @@ -0,0 +1,146 @@ +{ + "title": "AppSyncGraphqlApis_Update", + "operationId": "AppSyncGraphqlApis_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3594130-C856-4C3E-B884-AA418589122A", + "resourceGroupName": "rgappSyncGraphqlApi", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3768": "kvlymhymfpmbabwtapgkdngrmsbyd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalAuthenticationProviders": [ + { + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "userPoolConfig": { + "appIdClientRegex": "qpfpcfsunn", + "awsRegion": "nmpxe", + "userPoolId": "jelygyotigqdtvomkxwllisaodzpme" + } + } + ], + "apiId": "czvdzpkqmu", + "apiType": { + "value": "GRAPHQL" + }, + "arn": "oasogwqjupaovgjaimqwyvcevu", + "authenticationType": { + "value": "AMAZON_COGNITO_USER_POOLS" + }, + "dns": { + "key7870": "hisezyodgicqjjumufmqumigd" + }, + "enhancedMetricsConfig": { + "dataSourceLevelMetricsBehavior": { + "value": "FULL_REQUEST_DATA_SOURCE_METRICS" + }, + "operationLevelMetricsConfig": { + "value": "DISABLED" + }, + "resolverLevelMetricsBehavior": { + "value": "FULL_REQUEST_RESOLVER_METRICS" + } + }, + "introspectionConfig": { + "value": "DISABLED" + }, + "lambdaAuthorizerConfig": { + "authorizerResultTtlInSeconds": 30, + "authorizerUri": "hupypfpuanzvftlniinspu", + "identityValidationExpression": "hspldtc" + }, + "logConfig": { + "cloudWatchLogsRoleArn": "gsfpxvghd", + "excludeVerboseContent": true, + "fieldLogLevel": { + "value": "ALL" + } + }, + "mergedApiExecutionRoleArn": "ehtdxecdhgxhmtqhpneaqzgdtivz", + "name": "ahvfu", + "openIDConnectConfig": { + "authTTL": 22, + "clientId": "luiqpcaoupuxlkhifmjmssaujivibq", + "iatTTL": 12, + "issuer": "gxglhkdfnvrrtsalksedpcukpk" + }, + "owner": "pdudimkqozuoczxvlgmj", + "ownerContact": "qkvw", + "queryDepthLimit": 14, + "resolverCountLimit": 15, + "tags": { + "key7170": "zsxndmftgxkxmbkaxswugk" + }, + "uris": { + "key6507": "kuadtmwcpmobgsxpxkfgfkd" + }, + "userPoolConfig": { + "appIdClientRegex": "kjfgmmyyzmsywex", + "awsRegion": "knaq", + "defaultAction": { + "value": "ALLOW" + }, + "userPoolId": "tbbntrreowxutvnasgmcdupsaxoooz" + }, + "visibility": { + "value": "GLOBAL" + }, + "wafWebAclArn": "fpy", + "xrayEnabled": true + }, + "publicCloudConnectorsResourceId": "ljxfphaevwpkqtymdowsbhw", + "awsAccountId": "cbznxz", + "arn": "yozrofizgppbrqqingfk", + "publicCloudResourceName": "xqnxjggrhseymoklvqpreiucveuev", + "awsSourceSchema": "hldvwyk", + "awsRegion": "ponyxnfudopabngrux", + "awsTags": { + "key8377": "aajkrvqksnrfkuhdmoh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1836": "msiwfkilmgweevppndbrh" + }, + "location": "fgdkdvbltlygm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AppSyncGraphqlApis/{resourceName}", + "name": "gngempvejdbwaftx", + "type": "ujqxydzeybtzuychvn", + "systemData": { + "createdBy": "xwwhfkq", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:01.446Z", + "lastModifiedBy": "dkadnyrelkaknynjh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:01.447Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_CreateOrReplace.json new file mode 100644 index 000000000000..f49b2fe94b4e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_CreateOrReplace.json @@ -0,0 +1,634 @@ +{ + "title": "AutoScalingAutoScalingGroups_CreateOrReplace", + "operationId": "AutoScalingAutoScalingGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + } + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Delete.json new file mode 100644 index 000000000000..fc1317166c5b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "AutoScalingAutoScalingGroups_Delete", + "operationId": "AutoScalingAutoScalingGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Get.json new file mode 100644 index 000000000000..824651aa6398 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Get.json @@ -0,0 +1,223 @@ +{ + "title": "AutoScalingAutoScalingGroups_Get", + "operationId": "AutoScalingAutoScalingGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..095eec3a2081 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListByResourceGroup.json @@ -0,0 +1,227 @@ +{ + "title": "AutoScalingAutoScalingGroups_ListByResourceGroup", + "operationId": "AutoScalingAutoScalingGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListBySubscription.json new file mode 100644 index 000000000000..94ea9340c6a5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_ListBySubscription.json @@ -0,0 +1,226 @@ +{ + "title": "AutoScalingAutoScalingGroups_ListBySubscription", + "operationId": "AutoScalingAutoScalingGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Update.json new file mode 100644 index 000000000000..e42e89567703 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/AutoScalingAutoScalingGroups_Update.json @@ -0,0 +1,233 @@ +{ + "title": "AutoScalingAutoScalingGroups_Update", + "operationId": "AutoScalingAutoScalingGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B6B7E7E8-9C54-4C82-9661-89C61B42F721", + "resourceGroupName": "rgautoScalingAutoScalingGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9673": "yqeoapxnqtawdycgpvk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoScalingGroupName": "zvp", + "availabilityZones": [ + "bvcnltgekeqrzklsnfieubhugr" + ], + "capacityRebalance": true, + "context": "dnmovg", + "cooldown": "r", + "defaultInstanceWarmup": 24, + "desiredCapacity": "xtu", + "desiredCapacityType": "wncmimbdveox", + "healthCheckGracePeriod": 9, + "healthCheckType": "ustkoarefpvnhxrtqua", + "instanceId": "noghdbfliygsadtjosovasxq", + "instanceMaintenancePolicy": { + "maxHealthyPercentage": 23, + "minHealthyPercentage": 6 + }, + "launchConfigurationName": "rgadwyrtzaxbfkbsbjaygujtc", + "launchTemplate": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "lifecycleHookSpecificationList": [ + { + "defaultResult": "qbeojpqbpnhst", + "heartbeatTimeout": 14, + "lifecycleHookName": "xeqfmdmthyzrdxjbmdkyy", + "lifecycleTransition": "xsufodhykhlutvc", + "notificationMetadata": "bknbkafxdozjlnprrlkrqstgwchxl", + "notificationTargetARN": "dkeqhlwuifyfamkufdryfiybxnle", + "roleARN": "bhenujqtabiiryjgl" + } + ], + "loadBalancerNames": [ + "qsgaefmtltksmmwswpdfmnlwvovi" + ], + "maxInstanceLifetime": 25, + "maxSize": "vqxfpkdyusfijwc", + "metricsCollection": [ + { + "granularity": "ygxetadl", + "metrics": [ + "hwukwnkctznjelut" + ] + } + ], + "minSize": "rfdwflldttnzph", + "mixedInstancesPolicy": { + "instancesDistribution": { + "onDemandAllocationStrategy": "s", + "onDemandBaseCapacity": 11, + "onDemandPercentageAboveBaseCapacity": 13, + "spotAllocationStrategy": "mdqoylvmdfgnktujkkgcargpzgejts", + "spotInstancePools": 21, + "spotMaxPrice": "civdjpljorkrvqganofneu" + }, + "launchTemplate": { + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "overrides": [ + { + "instanceRequirements": { + "acceleratorCount": { + "max": 22, + "min": 12 + }, + "acceleratorManufacturers": [ + "yrnnynorjjxvzppzrgpahymhm" + ], + "acceleratorNames": [ + "iqmentbrnypcxv" + ], + "acceleratorTotalMemoryMiB": { + "max": 7, + "min": 29 + }, + "acceleratorTypes": [ + "kmvwibkxxklqitqxqqlpvfifvo" + ], + "allowedInstanceTypes": [ + "tzrxlaofwygbqglbwdxnqjy" + ], + "bareMetal": "kugjpzsjreywlvvzkebv", + "baselineEbsBandwidthMbps": { + "max": 2, + "min": 19 + }, + "burstablePerformance": "jpwudasuoonf", + "cpuManufacturers": [ + "scbxthzijnmur" + ], + "excludedInstanceTypes": [ + "edadlo" + ], + "instanceGenerations": [ + "f" + ], + "localStorage": "wglfmvquwice", + "localStorageTypes": [ + "talnjrldmventgtzlwpaxfcenp" + ], + "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": 15, + "memoryGiBPerVCpu": { + "max": 23, + "min": 29 + }, + "memoryMiB": { + "max": 27, + "min": 27 + }, + "networkBandwidthGbps": { + "max": 18, + "min": 29 + }, + "networkInterfaceCount": { + "max": 14, + "min": 26 + }, + "onDemandMaxPricePercentageOverLowestPrice": 8, + "requireHibernateSupport": true, + "spotMaxPricePercentageOverLowestPrice": 9, + "totalLocalStorageGB": { + "max": 19, + "min": 7 + }, + "vCpuCount": { + "max": 9, + "min": 26 + } + }, + "instanceType": "phudgcnbis", + "launchTemplateSpecification": { + "launchTemplateId": "zpcgiqsftmwjzwqifodopjuvfoxed", + "launchTemplateName": "jq", + "version": "kdlpart" + }, + "weightedCapacity": "iqa" + } + ] + } + }, + "newInstancesProtectedFromScaleIn": true, + "notificationConfiguration": { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + }, + "notificationConfigurations": [ + { + "notificationTypes": [ + "jzepnjbwtsw" + ], + "topicARN": "hndjrwrlqssgciezop" + } + ], + "placementGroup": "pmanetwktlujhykhxtcekv", + "serviceLinkedRoleARN": "ffqtfkdv", + "tags": [ + { + "key": "vtmmpdwnenzwsmxgf", + "propagateAtLaunch": true, + "value": "xoncdkvjanxdfklvixodkyg" + } + ], + "targetGroupARNs": [ + "ttxjwgboopxrdiqxyqjdujw" + ], + "terminationPolicies": [ + "jvwpdujegrgjbdrxbvcjgs" + ], + "vpcZoneIdentifier": [ + "fmqvstmohqtmjslrnsiuodevi" + ] + }, + "publicCloudConnectorsResourceId": "q", + "awsAccountId": "eogdcteuaaazi", + "arn": "gsso", + "publicCloudResourceName": "blomfowfltqwzdghycehvvdnr", + "awsSourceSchema": "koleijkwf", + "awsRegion": "cfqguizvjpckdsvetalwo", + "awsTags": { + "key6990": "lmywyo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2337": "scybnvsqelp" + }, + "location": "vfitxfllzgknmbaqgpsv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/AutoScalingAutoScalingGroups/{resourceName}", + "name": "vlngqusydiqjbfra", + "type": "lcldxbgqohrjaxmbxgmi", + "systemData": { + "createdBy": "lcnvgxszw", + "createdByType": "User", + "createdAt": "2024-10-08T03:47:21.936Z", + "lastModifiedBy": "vwyj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:47:21.936Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_CreateOrReplace.json new file mode 100644 index 000000000000..56224e7b0853 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_CreateOrReplace.json @@ -0,0 +1,292 @@ +{ + "title": "CloudFormationStackSets_CreateOrReplace", + "operationId": "CloudFormationStackSets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + } + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Delete.json new file mode 100644 index 000000000000..bbea0ff2cece --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFormationStackSets_Delete", + "operationId": "CloudFormationStackSets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Get.json new file mode 100644 index 000000000000..fb999cf12e13 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Get.json @@ -0,0 +1,109 @@ +{ + "title": "CloudFormationStackSets_Get", + "operationId": "CloudFormationStackSets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListByResourceGroup.json new file mode 100644 index 000000000000..89263cf199be --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListByResourceGroup.json @@ -0,0 +1,113 @@ +{ + "title": "CloudFormationStackSets_ListByResourceGroup", + "operationId": "CloudFormationStackSets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListBySubscription.json new file mode 100644 index 000000000000..66afeecb8dec --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_ListBySubscription.json @@ -0,0 +1,112 @@ +{ + "title": "CloudFormationStackSets_ListBySubscription", + "operationId": "CloudFormationStackSets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Update.json new file mode 100644 index 000000000000..224bc75fcca0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStackSets_Update.json @@ -0,0 +1,119 @@ +{ + "title": "CloudFormationStackSets_Update", + "operationId": "CloudFormationStackSets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "122E8597-F9F9-4AC0-86F2-ED87E7DC8159", + "resourceGroupName": "rgcloudFormationStackSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6480": "nmdqcvijhytk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "administrationRoleARN": "ybtuoky", + "autoDeployment": { + "enabled": true, + "retainStacksOnAccountRemoval": true + }, + "callAs": "DELEGATED_ADMIN", + "capabilities": [ + "begwecrhvitloplqjhhydjwhve" + ], + "description": "czkasvectlrpghrjojr", + "executionRoleName": "fclmt", + "managedExecution": { + "active": true + }, + "operationPreferences": { + "failureToleranceCount": 30, + "failureTolerancePercentage": 16, + "maxConcurrentCount": 11, + "maxConcurrentPercentage": 15, + "regionConcurrencyType": "PARALLEL", + "regionOrder": [ + "gwaceriunclgehhoue" + ] + }, + "parameters": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "permissionModel": "SELF_MANAGED", + "stackInstancesGroup": [ + { + "deploymentTargets": { + "accountFilterType": "DIFFERENCE", + "accounts": [ + "xc" + ], + "accountsUrl": "nvixaunvovhintyelj", + "organizationalUnitIds": [ + "gnnzuj" + ] + }, + "parameterOverrides": [ + { + "parameterKey": "akfjkpykscisdhjmmlmsqsokk", + "parameterValue": "lldiqsjfqukysjecb" + } + ], + "regions": [ + "eyondljwt" + ] + } + ], + "stackSetId": "ypfkcclgbgzikkjqfeiq", + "stackSetName": "bkfqkuqedspfb", + "tags": [ + { + "key": "rhuz", + "value": "ntm" + } + ], + "templateBody": "no", + "templateURL": "icoki" + }, + "publicCloudConnectorsResourceId": "eqapackzslaofkx", + "awsAccountId": "jtdycoxjyvqvrxyy", + "arn": "sldueqvlzdilykrozxapbb", + "publicCloudResourceName": "dyaxkuzcwhqspayuipml", + "awsSourceSchema": "wpvatxlrosokkyqsq", + "awsRegion": "drpqdznyarlwjnjslcrmvm", + "awsTags": { + "key7598": "zigarduulhgfhujfaxwpu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key307": "edjq" + }, + "location": "oubo", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStackSets/{resourceName}", + "name": "gkzgnjmgm", + "type": "c", + "systemData": { + "createdBy": "oxs", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.714Z", + "lastModifiedBy": "zgytjxfggugfuqmmorfzr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.714Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_CreateOrReplace.json new file mode 100644 index 000000000000..7851f7de800c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_CreateOrReplace.json @@ -0,0 +1,217 @@ +{ + "title": "CloudFormationStacks_CreateOrReplace", + "operationId": "CloudFormationStacks_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + } + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Delete.json new file mode 100644 index 000000000000..2d1774c12cbc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFormationStacks_Delete", + "operationId": "CloudFormationStacks_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Get.json new file mode 100644 index 000000000000..5405fff719f3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Get.json @@ -0,0 +1,84 @@ +{ + "title": "CloudFormationStacks_Get", + "operationId": "CloudFormationStacks_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListByResourceGroup.json new file mode 100644 index 000000000000..d4d45a07999d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListByResourceGroup.json @@ -0,0 +1,88 @@ +{ + "title": "CloudFormationStacks_ListByResourceGroup", + "operationId": "CloudFormationStacks_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListBySubscription.json new file mode 100644 index 000000000000..74c0716d8801 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_ListBySubscription.json @@ -0,0 +1,87 @@ +{ + "title": "CloudFormationStacks_ListBySubscription", + "operationId": "CloudFormationStacks_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Update.json new file mode 100644 index 000000000000..9b37437fcc05 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFormationStacks_Update.json @@ -0,0 +1,94 @@ +{ + "title": "CloudFormationStacks_Update", + "operationId": "CloudFormationStacks_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A8D0A3BB-C549-4FC5-9F69-C295468016EB", + "resourceGroupName": "rgcloudFormationStack", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4726": "kdjkjuleajxhzwpjfvyivjrislx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capabilities": [ + "CAPABILITY_AUTO_EXPAND" + ], + "changeSetId": "diebgdscxgdrjl", + "creationTime": "rbzmujrpza", + "description": "qgthunuomcbskx", + "disableRollback": true, + "enableTerminationProtection": true, + "lastUpdateTime": "ziwluvridlkgt", + "notificationARNs": [ + "hiumjcobumu" + ], + "outputs": [ + { + "description": "yr", + "exportName": "inzgbtgxtlkmbsthsiqyaownydl", + "outputKey": "oxvigtrakftzifxp", + "outputValue": "xrkebm" + } + ], + "parameters": { + "key3924": "g" + }, + "parentId": "spfnpubjgnn", + "roleARN": "chneost", + "rootId": "dm", + "stackId": "pfdvktglgjlp", + "stackName": "kcpmjgjmtil", + "stackPolicyURL": "azff", + "stackStatus": "CREATE_COMPLETE", + "stackStatusReason": "oashauqgm", + "tags": [ + { + "key": "xjabhkryhrdgshmztidyvkbzqw", + "value": "xapmapwprakmhlboq" + } + ], + "templateURL": "prpgfhggbaglqposmnlkc", + "timeoutInMinutes": 21 + }, + "publicCloudConnectorsResourceId": "ccuizanjtbypcrcdmoelfyjkx", + "awsAccountId": "yuzdhawgkrzzmppqjebmyzrqzsxbgh", + "arn": "wnbcxhzurwtzqcoirs", + "publicCloudResourceName": "vjnhdxpreaebeaxeqmrhfuro", + "awsSourceSchema": "ascbhyeewelekovixg", + "awsRegion": "ovumxnjlsoffpzxyegazwgujni", + "awsTags": { + "key6002": "lkyagteqeoafj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8740": "gebtpejhvwgd" + }, + "location": "igidmxpchpipflxgxqkge", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFormationStacks/{resourceName}", + "name": "fkrujbsksjubfb", + "type": "sxeavofzxyjsqptdvcbmj", + "systemData": { + "createdBy": "ufvnp", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:06.905Z", + "lastModifiedBy": "fxzfndtyadvurwbdcooclkqbstad", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:06.905Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_CreateOrReplace.json new file mode 100644 index 000000000000..5f9804aad87b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_CreateOrReplace.json @@ -0,0 +1,802 @@ +{ + "title": "CloudFrontDistributions_CreateOrReplace", + "operationId": "CloudFrontDistributions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + } + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Delete.json new file mode 100644 index 000000000000..67f1f455ec47 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudFrontDistributions_Delete", + "operationId": "CloudFrontDistributions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Get.json new file mode 100644 index 000000000000..a9266f72fdd9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Get.json @@ -0,0 +1,279 @@ +{ + "title": "CloudFrontDistributions_Get", + "operationId": "CloudFrontDistributions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListByResourceGroup.json new file mode 100644 index 000000000000..9e483267b6ed --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListByResourceGroup.json @@ -0,0 +1,283 @@ +{ + "title": "CloudFrontDistributions_ListByResourceGroup", + "operationId": "CloudFrontDistributions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListBySubscription.json new file mode 100644 index 000000000000..6e10e9577396 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_ListBySubscription.json @@ -0,0 +1,282 @@ +{ + "title": "CloudFrontDistributions_ListBySubscription", + "operationId": "CloudFrontDistributions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Update.json new file mode 100644 index 000000000000..7645351c4329 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudFrontDistributions_Update.json @@ -0,0 +1,289 @@ +{ + "title": "CloudFrontDistributions_Update", + "operationId": "CloudFrontDistributions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "8B620C74-456B-43B1-9BDA-B73392E996BD", + "resourceGroupName": "rgcloudFrontDistribution", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3727": "xzqjsgia" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "distributionConfig": { + "aliases": [ + "gibhsrynakjqasnexklzyr" + ], + "cnamEs": [ + "qczbolddtyqh" + ], + "cacheBehaviors": [ + { + "allowedMethods": [ + "mgilninyxzl" + ], + "cachePolicyId": "jgthzlgddcq", + "cachedMethods": [ + "mocyvkoubxnhxggwiguxclll" + ], + "compress": true, + "defaultTTL": 12, + "fieldLevelEncryptionId": "egdaxlmmafenvmeeiyendhzfgb", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 22, + "minTTL": 14, + "originRequestPolicyId": "mmggy", + "pathPattern": "dblpru", + "realtimeLogConfigArn": "hlpmy", + "responseHeadersPolicyId": "mexazovhbvttjpndsx", + "smoothStreaming": true, + "targetOriginId": "muilt", + "trustedKeyGroups": [ + "rtoknopsknpyux" + ], + "trustedSigners": [ + "dqxymkhclbsojvcwgczgtw" + ], + "viewerProtocolPolicy": "tadcgla" + } + ], + "comment": "eqgjcikzog", + "continuousDeploymentPolicyId": "jpzap", + "customErrorResponses": [ + { + "errorCachingMinTTL": 16, + "errorCode": 14, + "responseCode": 26, + "responsePagePath": "fgjymf" + } + ], + "customOrigin": { + "dnsName": "dijgqalflftbtatmydfk", + "httpPort": 3, + "httpsPort": 26, + "originProtocolPolicy": "unrjgcwzebjixqsjmmzdwm", + "originSSLProtocols": [ + "clriolammhrzrrhmyovvmbxowayz" + ] + }, + "defaultCacheBehavior": { + "allowedMethods": [ + "gtvgkaxaocaozvybswnfgud" + ], + "cachePolicyId": "txppezvfdbpaewlehepeycrdj", + "cachedMethods": [ + "bpptfnqcsypifnydxpkjxaek" + ], + "compress": true, + "defaultTTL": 16, + "fieldLevelEncryptionId": "adpzriyfhcj", + "forwardedValues": { + "cookies": { + "forward": "vgdw", + "whitelistedNames": [ + "dyyppccyzusjttwxsvtauzikzpcic" + ] + }, + "headers": [ + "wthyef" + ], + "queryString": true, + "queryStringCacheKeys": [ + "ovsbbyypovwzfd" + ] + }, + "functionAssociations": [ + { + "eventType": "rabilo", + "functionARN": "xqjivwlwegwmcpxpbdxlxwfkkoy" + } + ], + "lambdaFunctionAssociations": [ + { + "eventType": "adgevfqgfrqxotodrywqn", + "includeBody": true, + "lambdaFunctionARN": "ofaqozmfhyrnzijzqjc" + } + ], + "maxTTL": 11, + "minTTL": 22, + "originRequestPolicyId": "vfi", + "realtimeLogConfigArn": "gdfhajmumlspefunqlznktqzn", + "responseHeadersPolicyId": "xnvjmk", + "smoothStreaming": true, + "targetOriginId": "satcfgygtio", + "trustedKeyGroups": [ + "glzecp" + ], + "trustedSigners": [ + "yeheiezaavurjdn" + ], + "viewerProtocolPolicy": "vmvahgz" + }, + "defaultRootObject": "qqacdjhmnrgxzg", + "enabled": true, + "httpVersion": "jujxztvywwzj", + "ipV6Enabled": true, + "logging": { + "bucket": "staluexfxdlonreqbr", + "includeCookies": true, + "prefix": "mzugdqzcjqfkxbyxwaho" + }, + "originGroups": { + "items": [ + { + "failoverCriteria": { + "statusCodes": { + "items": [ + 24 + ], + "quantity": 13 + } + }, + "id": "cppcwh", + "members": { + "items": [ + { + "originId": "ju" + } + ], + "quantity": 19 + } + } + ], + "quantity": 15 + }, + "origins": [ + { + "connectionAttempts": 17, + "connectionTimeout": 13, + "customOriginConfig": { + "httpPort": 6, + "httpsPort": 10, + "originKeepaliveTimeout": 29, + "originProtocolPolicy": "utekqcjzgxdogmvyfxxzehzpcbhgu", + "originReadTimeout": 11, + "originSSLProtocols": [ + "lplnjynxpyxbrbyq" + ] + }, + "domainName": "tdvwmcxajsiushniomugxjkroqih", + "id": "jsvocvlfluxmig", + "originAccessControlId": "uwoxzymxpzbiohjphusuywrbri", + "originCustomHeaders": [ + { + "headerName": "kdbkguzvgqpjinhenlsw", + "headerValue": "glzvvmflrrab" + } + ], + "originPath": "qhkjzdzxipwguohspfmkqtmp", + "originShield": { + "enabled": true, + "originShieldRegion": "ubhpk" + }, + "s3OriginConfig": { + "originAccessIdentity": "sexllpdop" + } + } + ], + "priceClass": "wltams", + "restrictions": { + "geoRestriction": { + "locations": [ + "qfbhxln" + ], + "restrictionType": "ry" + } + }, + "s3Origin": { + "dnsName": "bgxohpxhcml", + "originAccessIdentity": "itatexxuwwvgnusaleemttplfhx" + }, + "staging": true, + "viewerCertificate": { + "acmCertificateArn": "oooavlkhe", + "cloudFrontDefaultCertificate": true, + "iamCertificateId": "orcqmznytymzmiqg", + "minimumProtocolVersion": "fjodeffknxcdqfz", + "sslSupportMethod": "ceibl" + }, + "webACLId": "oycfjrylckkuampmezlerj" + }, + "domainName": "cwbirqnkovujza", + "id": "ud", + "tags": [ + { + "key": "blcefgrraqztqru", + "value": "eelgljsxedmzhdwwp" + } + ] + }, + "publicCloudConnectorsResourceId": "quzwvcijedi", + "awsAccountId": "npsedngekfchphqo", + "arn": "mlluf", + "publicCloudResourceName": "uquecem", + "awsSourceSchema": "nuhdditribzbvzfnixuibhjwyo", + "awsRegion": "gumvgalmzjsgtlvv", + "awsTags": { + "key3003": "fpdvxidbizjowkod" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6544": "zlnrveizqgqtwstugmehvlblbv" + }, + "location": "nprgvufyhs", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudFrontDistributions/{resourceName}", + "name": "lnrbtgon", + "type": "jxlypyouxrgcmynncjjbmztudxtor", + "systemData": { + "createdBy": "eixbjnpuknzxpasc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:52.713Z", + "lastModifiedBy": "qk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:52.714Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_CreateOrReplace.json new file mode 100644 index 000000000000..d1c83cb20a68 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_CreateOrReplace.json @@ -0,0 +1,310 @@ +{ + "title": "CloudTrailTrails_CreateOrReplace", + "operationId": "CloudTrailTrails_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + } + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Delete.json new file mode 100644 index 000000000000..1641e4e719a2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudTrailTrails_Delete", + "operationId": "CloudTrailTrails_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Get.json new file mode 100644 index 000000000000..0efd16b516f9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Get.json @@ -0,0 +1,115 @@ +{ + "title": "CloudTrailTrails_Get", + "operationId": "CloudTrailTrails_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListByResourceGroup.json new file mode 100644 index 000000000000..abc04a196a83 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListByResourceGroup.json @@ -0,0 +1,119 @@ +{ + "title": "CloudTrailTrails_ListByResourceGroup", + "operationId": "CloudTrailTrails_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + ], + "nextLink": "https://microsoft.com/almmmg" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListBySubscription.json new file mode 100644 index 000000000000..e4652dfe9dde --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_ListBySubscription.json @@ -0,0 +1,118 @@ +{ + "title": "CloudTrailTrails_ListBySubscription", + "operationId": "CloudTrailTrails_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + ], + "nextLink": "https://microsoft.com/almmmg" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Update.json new file mode 100644 index 000000000000..d5c3bf2f2780 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudTrailTrails_Update.json @@ -0,0 +1,125 @@ +{ + "title": "CloudTrailTrails_Update", + "operationId": "CloudTrailTrails_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "51CAA9E2-06EF-4DCB-BE9C-1E929AC74E8C", + "resourceGroupName": "rgcloudTrailTrail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1706": "ukvxmoyptghknfzltnxpz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "advancedEventSelectors": [ + { + "fieldSelectors": [ + { + "endsWith": [ + "xvhm" + ], + "equals": [ + "wxznrgvwsjlxdvssmmse" + ], + "field": "mq", + "notEndsWith": [ + "x" + ], + "notEquals": [ + "vglmmoivfeqg" + ], + "notStartsWith": [ + "pojptcfcw" + ], + "startsWith": [ + "fvldfltesnmpieljtehsvxudvxdujk" + ] + } + ], + "name": "ee" + } + ], + "arn": "gbcn", + "cloudWatchLogsLogGroupArn": "nznfnuyxarmdmdtgjiougqgq", + "cloudWatchLogsRoleArn": "umhmpx", + "enableLogFileValidation": true, + "eventSelectors": [ + { + "dataResources": [ + { + "type": "txxrjncwohiohorurqdxzabre", + "values": [ + "xhlnkujkbtpptbwchhh" + ] + } + ], + "excludeManagementEventSources": [ + "r" + ], + "includeManagementEvents": true, + "readWriteType": "All" + } + ], + "includeGlobalServiceEvents": true, + "insightSelectors": [ + { + "insightType": "brwlpasadlbwolsysta" + } + ], + "isLogging": true, + "isMultiRegionTrail": true, + "isOrganizationTrail": true, + "kmsKeyId": "myqwqkkcuyltblpdsbgestqmjs", + "s3BucketName": "iknyfgvujttyxsralujehxb", + "s3KeyPrefix": "tzkelsqjqfspyoppsbhewvbenpwll", + "snsTopicArn": "owdxqmsrqylekull", + "snsTopicName": "goknthoxfekdccclolilvnyacvcop", + "tags": [ + { + "key": "sytikpggzq", + "value": "vnsgm" + } + ], + "trailName": "oawneexezdnuouxdykllsflq" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "mynelopf", + "arn": "jlwqroammottlyguyzu", + "publicCloudResourceName": "aidwpmbkjspiucpvmzgg", + "awsSourceSchema": "tvnaxpvricaiyoucpeauofeibwrk", + "awsRegion": "dfvobbnupacpqsgexblxjlw", + "awsTags": { + "key5810": "tfepsytqwqilahaumarsjj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8112": "rxvuvmalioxplkvujldcyntebbsmuh" + }, + "location": "lectoohspiqh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudTrailTrails/{resourceName}", + "name": "edilbyzlahavvhncoa", + "type": "vtxrqazfaoded", + "systemData": { + "createdBy": "lyiygszmbzwlsyvczkbhcsmsnpkvee", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:56.240Z", + "lastModifiedBy": "ygmjlkqzulvdhnnd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:56.240Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_CreateOrReplace.json new file mode 100644 index 000000000000..957422acf55d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_CreateOrReplace.json @@ -0,0 +1,289 @@ +{ + "title": "CloudWatchAlarms_CreateOrReplace", + "operationId": "CloudWatchAlarms_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + } + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Delete.json new file mode 100644 index 000000000000..97e845093217 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CloudWatchAlarms_Delete", + "operationId": "CloudWatchAlarms_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Get.json new file mode 100644 index 000000000000..5fa00f46e3cd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Get.json @@ -0,0 +1,108 @@ +{ + "title": "CloudWatchAlarms_Get", + "operationId": "CloudWatchAlarms_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListByResourceGroup.json new file mode 100644 index 000000000000..79ec6fb57ba4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListByResourceGroup.json @@ -0,0 +1,112 @@ +{ + "title": "CloudWatchAlarms_ListByResourceGroup", + "operationId": "CloudWatchAlarms_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListBySubscription.json new file mode 100644 index 000000000000..bc2b1bb5634a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_ListBySubscription.json @@ -0,0 +1,111 @@ +{ + "title": "CloudWatchAlarms_ListBySubscription", + "operationId": "CloudWatchAlarms_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Update.json new file mode 100644 index 000000000000..aef84cc71f4c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CloudWatchAlarms_Update.json @@ -0,0 +1,118 @@ +{ + "title": "CloudWatchAlarms_Update", + "operationId": "CloudWatchAlarms_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F7E54797-7297-4B27-AF83-ECF02B70D317", + "resourceGroupName": "rgcloudWatchAlarm", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5472": "xkr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "actionsEnabled": true, + "alarmActions": [ + "ydnvbaggrnyxwzika" + ], + "alarmDescription": "idvyiwmbllvlfvjcibommfbp", + "alarmName": "ooriavzb", + "arn": "twsifnftkdrfzflvvsuka", + "comparisonOperator": "qo", + "datapointsToAlarm": 30, + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "evaluateLowSampleCountPercentile": "oihpnjstsw", + "evaluationPeriods": 15, + "extendedStatistic": "czkqsxjyzryvvkzoshk", + "insufficientDataActions": [ + "dfkb" + ], + "metricName": "bkdkskukix", + "metrics": [ + { + "accountId": "rbtogpxgrissdcvqupcuhqqesz", + "expression": "hhxrpieqtbvafrujybxxa", + "id": "zcevmcxhujphx", + "label": "jmeaobrgk", + "metricStat": { + "metric": { + "dimensions": [ + { + "name": "bfnmnqiewf", + "value": "lnphxdrevivdil" + } + ], + "metricName": "mabmwxjydr", + "namespace": "wwoppcactqawdnkpxvjlo" + }, + "period": 22, + "stat": "znmppqcobugvvlzccemylhxzsfsg", + "unit": "vu" + }, + "period": 27, + "returnData": true + } + ], + "namespace": "ptrnxovqoagxfepnjkpewbbusjkkzr", + "okActions": [ + "afskbnaohvdlb" + ], + "period": 5, + "statistic": "yrrnvsfpyvhnzlmw", + "tags": [ + { + "key": "mdkzoktp", + "value": "zswuuw" + } + ], + "threshold": 17, + "thresholdMetricId": "sqtfzityufokpxbthucjitcljvo", + "treatMissingData": "iqrbyvljxufjwybtkjc", + "unit": "vbjipwqqaobwlyebv" + }, + "publicCloudConnectorsResourceId": "upovlpslvvatbmxiuwhvj", + "awsAccountId": "qcoqhrkbfdowqmkzarqbtwcprj", + "arn": "uhqszqzfmdpnmiwu", + "publicCloudResourceName": "sjxcsoycs", + "awsSourceSchema": "drehzmurfidpdlcf", + "awsRegion": "afpgkhpukllavze", + "awsTags": { + "key6400": "ivxpvjindvijzvpazekctf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7594": "abbryoyexzxxwsdyfpvtliccd" + }, + "location": "nbymldrgacokglzmyglynjohhnj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CloudWatchAlarms/{resourceName}", + "name": "ilbblftqsxtuikyupkiwbiaybdej", + "type": "bd", + "systemData": { + "createdBy": "lh", + "createdByType": "User", + "createdAt": "2024-10-09T06:52:51.380Z", + "lastModifiedBy": "ugpdkxsetqjrvuavszgccyf", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T06:52:51.380Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_CreateOrReplace.json new file mode 100644 index 000000000000..4947d1a6ea12 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_CreateOrReplace.json @@ -0,0 +1,817 @@ +{ + "title": "CodeBuildProjects_CreateOrReplace", + "operationId": "CodeBuildProjects_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + } + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Delete.json new file mode 100644 index 000000000000..9787fb1ab4ab --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CodeBuildProjects_Delete", + "operationId": "CodeBuildProjects_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Get.json new file mode 100644 index 000000000000..dab865044732 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Get.json @@ -0,0 +1,284 @@ +{ + "title": "CodeBuildProjects_Get", + "operationId": "CodeBuildProjects_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListByResourceGroup.json new file mode 100644 index 000000000000..9199623cd9af --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListByResourceGroup.json @@ -0,0 +1,288 @@ +{ + "title": "CodeBuildProjects_ListByResourceGroup", + "operationId": "CodeBuildProjects_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListBySubscription.json new file mode 100644 index 000000000000..4d3221002282 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_ListBySubscription.json @@ -0,0 +1,287 @@ +{ + "title": "CodeBuildProjects_ListBySubscription", + "operationId": "CodeBuildProjects_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Update.json new file mode 100644 index 000000000000..6b605168c1ee --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildProjects_Update.json @@ -0,0 +1,294 @@ +{ + "title": "CodeBuildProjects_Update", + "operationId": "CodeBuildProjects_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A0141395-EAF7-4CD0-A2BC-67419369202A", + "resourceGroupName": "rgcodeBuildProject", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2639": "icrtpvdmqclauovfcehwm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "wwhfeljvmnwnqcgxusgnvoq", + "artifacts": { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + }, + "badge": { + "badgeEnabled": true, + "badgeRequestUrl": "ulpdsdbgtwm" + }, + "buildBatchConfig": { + "batchReportMode": { + "value": "REPORT_AGGREGATED_BATCH" + }, + "combineArtifacts": true, + "restrictions": { + "computeTypesAllowed": [ + "ievoltoldfrhkpv" + ], + "maximumBuildsAllowed": 15 + }, + "serviceRole": "lceqjutffrykpuzjxvijbzpames", + "timeoutInMins": 3 + }, + "cache": { + "location": "wgmqyjzlxsazecszvdkfr", + "modes": [ + "LOCAL_CUSTOM_CACHE" + ], + "type": { + "value": "LOCAL" + } + }, + "concurrentBuildLimit": 19, + "created": "2024-10-08T03:48:48.570Z", + "description": "adnfxoh", + "encryptionKey": "upseoicsvrwjjachlewnltupswc", + "environment": { + "certificate": "olzbdlydjqzkzlflzxcdjjjv", + "computeType": { + "value": "BUILD_GENERAL1_2XLARGE" + }, + "environmentVariables": [ + { + "name": "bmzlnmjzuxrxeemxfutykrlvemt", + "type": { + "value": "PARAMETER_STORE" + }, + "value": "eakfsmirkkwnizotyqqgmgjthn" + } + ], + "fleet": { + "fleetArn": "brslcsjgupcpeistg" + }, + "image": "kkmioknmuhxurahmnjg", + "imagePullCredentialsType": { + "value": "CODEBUILD" + }, + "privilegedMode": true, + "registryCredential": { + "credential": "rpnzfjdjuamclquyzquwicenfpefx", + "credentialProvider": { + "value": "SECRETS_MANAGER" + } + }, + "type": { + "value": "ARM_CONTAINER" + } + }, + "fileSystemLocations": [ + { + "identifier": "tdquc", + "location": "yeaotrzuhjtdtbfrlpvmlmaoqyioin", + "mountOptions": "tocdlorjekugjotphpxuyebjj", + "mountPoint": "fctmorvlmplsmeqvmavw", + "type": { + "value": "EFS" + } + } + ], + "lastModified": "2024-10-08T03:48:48.571Z", + "logsConfig": { + "cloudWatchLogs": { + "groupName": "t", + "status": { + "value": "DISABLED" + }, + "streamName": "rrqzbaaicbiblat" + }, + "s3Logs": { + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zuepwokmlymlvsvzjawzxe", + "status": { + "value": "DISABLED" + } + } + }, + "name": "budzhvktdvhxxy", + "projectVisibility": { + "value": "PRIVATE" + }, + "publicProjectAlias": "vstmzamjxtasdipcehcuwvfef", + "queuedTimeoutInMinutes": 30, + "resourceAccessRole": "st", + "secondaryArtifacts": [ + { + "artifactIdentifier": "hcfdqzwleorpe", + "bucketOwnerAccess": { + "value": "FULL" + }, + "encryptionDisabled": true, + "location": "zvhsfl", + "name": "dsqyinskfvabyktgjbszny", + "namespaceType": { + "value": "BUILD_ID" + }, + "overrideArtifactName": true, + "packaging": { + "value": "NONE" + }, + "path": "zbsfhzkoet", + "type": { + "value": "CODEPIPELINE" + } + } + ], + "secondarySourceVersions": [ + { + "sourceIdentifier": "kiyezlaophakaslamcsxpkzggoj", + "sourceVersion": "zy" + } + ], + "secondarySources": [ + { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + } + ], + "serviceRole": "pydzdifzkz", + "source": { + "auth": { + "resource": "oyfwquyzyjklbxlyjyddpmhmjgsgk", + "type": { + "value": "CODECONNECTIONS" + } + }, + "buildStatusConfig": { + "context": "zoghbponrxfhugrjzdheibkada", + "targetUrl": "ooonrchy" + }, + "buildspec": "xxcoigvstisdhlfkfiblrgqhbtoqd", + "gitCloneDepth": 9, + "gitSubmodulesConfig": { + "fetchSubmodules": true + }, + "insecureSsl": true, + "location": "owijjqkiwwegfcrynqcypho", + "reportBuildStatus": true, + "sourceIdentifier": "lnhelescdeif", + "type": { + "value": "BITBUCKET" + } + }, + "sourceVersion": "idpngofzedxghp", + "tags": [ + { + "key": "jcnahvslmrynzn", + "value": "iqwximmqwgsjlwdgv" + } + ], + "timeoutInMinutes": 7, + "vpcConfig": { + "securityGroupIds": [ + "gcsqntkatjbigzj" + ], + "subnets": [ + "vxxzlquh" + ], + "vpcId": "dhjvrtrqgdb" + }, + "webhook": { + "branchFilter": "fpfnqs", + "buildType": { + "value": "BUILD" + }, + "filterGroups": [ + { + "webhookFilter": { + "excludeMatchedPattern": true, + "pattern": "ozqghxeblvksllu", + "type": { + "value": "ACTOR_ACCOUNT_ID" + } + } + } + ], + "lastModifiedSecret": "2024-10-08T03:48:48.574Z", + "payloadUrl": "wzalmmzopccsfbgwhxjneakxazu", + "secret": "mvic", + "url": "lwkywiwhmmdrirvajnxo" + } + }, + "publicCloudConnectorsResourceId": "azzcclgcodhtl", + "awsAccountId": "caiac", + "arn": "ae", + "publicCloudResourceName": "tzylnhhjwtzngucgrkvklav", + "awsSourceSchema": "ujnztglujzqehsvvd", + "awsRegion": "rakioiwqsjhpjqekyjft", + "awsTags": { + "key9822": "ryzmieviyiycjaaenwj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4761": "sranhogw" + }, + "location": "fpjpnhlms", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildProjects/{resourceName}", + "name": "vxycsdfuepsiumuwerkphioygel", + "type": "mmsszjferhntexy", + "systemData": { + "createdBy": "ahpql", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:48.574Z", + "lastModifiedBy": "tidwzkqisxvqki", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:48.574Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_CreateOrReplace.json new file mode 100644 index 000000000000..dae255bfc868 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_CreateOrReplace", + "operationId": "CodeBuildSourceCredentialsInfos_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + } + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Delete.json new file mode 100644 index 000000000000..87cabdec5b1a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Delete", + "operationId": "CodeBuildSourceCredentialsInfos_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Get.json new file mode 100644 index 000000000000..f1952a16ec43 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Get.json @@ -0,0 +1,53 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Get", + "operationId": "CodeBuildSourceCredentialsInfos_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json new file mode 100644 index 000000000000..d750aa88fd4f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_ListByResourceGroup", + "operationId": "CodeBuildSourceCredentialsInfos_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + ], + "nextLink": "https://microsoft.com/axwdn" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListBySubscription.json new file mode 100644 index 000000000000..ab5df27c0c58 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_ListBySubscription", + "operationId": "CodeBuildSourceCredentialsInfos_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + ], + "nextLink": "https://microsoft.com/axwdn" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Update.json new file mode 100644 index 000000000000..cd658a993030 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/CodeBuildSourceCredentialsInfos_Update.json @@ -0,0 +1,63 @@ +{ + "title": "CodeBuildSourceCredentialsInfos_Update", + "operationId": "CodeBuildSourceCredentialsInfos_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A89915F1-2C06-4953-8DE0-0F2C959D0464", + "resourceGroupName": "rgcodeBuildSourceCredentialsInfo", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7809": "woid" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ewe", + "authType": { + "value": "BASIC_AUTH" + }, + "resource": "cnzfvgfcneqgffgfclggx", + "serverType": { + "value": "BITBUCKET" + } + }, + "publicCloudConnectorsResourceId": "cidijgvkoos", + "awsAccountId": "bgwhzakphzjipkxqwy", + "arn": "wdxdkxuukdnrlpqgkmmvfagzrwom", + "publicCloudResourceName": "uazcojlwlavznbfsrjzbtthat", + "awsSourceSchema": "rhibtnvrfkidnqhyynub", + "awsRegion": "vywlxfetnso", + "awsTags": { + "key3224": "eky" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9473": "osnuolokdgmmhzpdajuqnguse" + }, + "location": "ckmgfv", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/CodeBuildSourceCredentialsInfos/{resourceName}", + "name": "abybajjjrfhfmlcj", + "type": "nzsyughizbal", + "systemData": { + "createdBy": "pudw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:50.613Z", + "lastModifiedBy": "mvoimejvinffy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:50.613Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..e2c91a50aa59 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace", + "operationId": "ConfigServiceConfigurationRecorderStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + } + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Delete.json new file mode 100644 index 000000000000..d22ad0b53bf8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Delete", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Get.json new file mode 100644 index 000000000000..da2160dc18c4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Get.json @@ -0,0 +1,55 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Get", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..d01f8e1a3336 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup", + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json new file mode 100644 index 000000000000..7a0b1b20e4a0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_ListBySubscription", + "operationId": "ConfigServiceConfigurationRecorderStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Update.json new file mode 100644 index 000000000000..e060a85a36f3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorderStatuses_Update.json @@ -0,0 +1,65 @@ +{ + "title": "ConfigServiceConfigurationRecorderStatuses_Update", + "operationId": "ConfigServiceConfigurationRecorderStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CBAB3E38-1BCD-4320-B087-177601C81A71", + "resourceGroupName": "rgconfigServiceConfigurationRecorderStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4598": "hgelyjfovofeafmyrvss" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastErrorCode": "zvduytuuzcdxiwmlqur", + "lastErrorMessage": "qcopqdjuuwuwdvdjmupwgrnxux", + "lastStartTime": "2024-10-08T03:54:51.026Z", + "lastStatus": { + "value": "Failure" + }, + "lastStatusChangeTime": "2024-10-08T03:54:51.038Z", + "lastStopTime": "2024-10-08T03:54:51.038Z", + "name": "mvnralcjhhrhhczxctukeumhnhhsvs", + "recording": true + }, + "publicCloudConnectorsResourceId": "fzembqicafznmnrvzudikggimnls", + "awsAccountId": "dnnbcuuhaxys", + "arn": "iwxslgken", + "publicCloudResourceName": "stvqbbbupeyrxdfrdlslkxbi", + "awsSourceSchema": "qprhkzdetwvsaznwugwruaned", + "awsRegion": "pffplccggyknjkyebtjepdzwbim", + "awsTags": { + "key2618": "igrrsqtvduurjhwftennerlrcmamr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key333": "yypbuvwbxpiokolnuiiq" + }, + "location": "aanagogcqgqikndwcsiwpf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorderStatuses/{resourceName}", + "name": "eeydwxjrofsusc", + "type": "g", + "systemData": { + "createdBy": "ylqtv", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.123Z", + "lastModifiedBy": "cdwsjrri", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.123Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_CreateOrReplace.json new file mode 100644 index 000000000000..b656543c61d1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_CreateOrReplace.json @@ -0,0 +1,205 @@ +{ + "title": "ConfigServiceConfigurationRecorders_CreateOrReplace", + "operationId": "ConfigServiceConfigurationRecorders_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + } + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Delete.json new file mode 100644 index 000000000000..0db75e6cf334 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Delete", + "operationId": "ConfigServiceConfigurationRecorders_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Get.json new file mode 100644 index 000000000000..3ddcdfcf347f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Get.json @@ -0,0 +1,80 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Get", + "operationId": "ConfigServiceConfigurationRecorders_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListByResourceGroup.json new file mode 100644 index 000000000000..61e269e00e06 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListByResourceGroup.json @@ -0,0 +1,84 @@ +{ + "title": "ConfigServiceConfigurationRecorders_ListByResourceGroup", + "operationId": "ConfigServiceConfigurationRecorders_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListBySubscription.json new file mode 100644 index 000000000000..15997e14fa58 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_ListBySubscription.json @@ -0,0 +1,83 @@ +{ + "title": "ConfigServiceConfigurationRecorders_ListBySubscription", + "operationId": "ConfigServiceConfigurationRecorders_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Update.json new file mode 100644 index 000000000000..6abf8635e109 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceConfigurationRecorders_Update.json @@ -0,0 +1,90 @@ +{ + "title": "ConfigServiceConfigurationRecorders_Update", + "operationId": "ConfigServiceConfigurationRecorders_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "185D623C-5F3B-42EC-82AA-E5DF96835116", + "resourceGroupName": "rgconfigServiceConfigurationRecorder", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key455": "tocjreejshcvi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "umkcdjmciwgorjwxtm", + "recordingGroup": { + "allSupported": true, + "exclusionByResourceTypes": { + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "includeGlobalResourceTypes": true, + "recordingStrategy": { + "useOnly": { + "value": "ALL_SUPPORTED_RESOURCE_TYPES" + } + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + }, + "recordingMode": { + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "recordingModeOverrides": [ + { + "description": "fxclcxlsumaur", + "recordingFrequency": { + "value": "CONTINUOUS" + }, + "resourceTypes": [ + "AWS::ACM::Certificate" + ] + } + ] + }, + "roleARN": "alfppyafyrtgacngfxckcioci" + }, + "publicCloudConnectorsResourceId": "ofuen", + "awsAccountId": "pxxfgnveimxacjnvjtionuq", + "arn": "jdsihdzklcqjurvrxp", + "publicCloudResourceName": "sieljn", + "awsSourceSchema": "eolodykekuepfruwphifvo", + "awsRegion": "xvzbwkxfmww", + "awsTags": { + "key7810": "iwpldfrgnzxhqb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1719": "adugjzkmxmgtjz" + }, + "location": "uhzzvapzjrmbzxfxdqyczgmcq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceConfigurationRecorders/{resourceName}", + "name": "ppfewmfyzkwdrh", + "type": "jbkhlyjifthnelzjnpcdomws", + "systemData": { + "createdBy": "xxrlnysazzcjjfyreauuu", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:28.411Z", + "lastModifiedBy": "vajgcctyyhoqoclj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:28.412Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_CreateOrReplace.json new file mode 100644 index 000000000000..17bafce66d3a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "ConfigServiceDeliveryChannels_CreateOrReplace", + "operationId": "ConfigServiceDeliveryChannels_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + } + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Delete.json new file mode 100644 index 000000000000..38eb40a966ba --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ConfigServiceDeliveryChannels_Delete", + "operationId": "ConfigServiceDeliveryChannels_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Get.json new file mode 100644 index 000000000000..d7ef897bd3f8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Get.json @@ -0,0 +1,55 @@ +{ + "title": "ConfigServiceDeliveryChannels_Get", + "operationId": "ConfigServiceDeliveryChannels_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListByResourceGroup.json new file mode 100644 index 000000000000..2aaf344b6fa4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "ConfigServiceDeliveryChannels_ListByResourceGroup", + "operationId": "ConfigServiceDeliveryChannels_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListBySubscription.json new file mode 100644 index 000000000000..7a2f159eaff1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "ConfigServiceDeliveryChannels_ListBySubscription", + "operationId": "ConfigServiceDeliveryChannels_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Update.json new file mode 100644 index 000000000000..bd41285e7c0b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ConfigServiceDeliveryChannels_Update.json @@ -0,0 +1,65 @@ +{ + "title": "ConfigServiceDeliveryChannels_Update", + "operationId": "ConfigServiceDeliveryChannels_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "39ACFFBB-B453-46EE-BB05-49D715E54E1E", + "resourceGroupName": "rgconfigServiceDeliveryChannel", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7397": "invrdhnkjivqigdyp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "configSnapshotDeliveryProperties": { + "deliveryFrequency": { + "value": "One_Hour" + } + }, + "name": "pfdwjyiaypjjedltuphpz", + "s3BucketName": "kcgtpxhibekwygxkybv", + "s3KeyPrefix": "eqgzb", + "s3KmsKeyArn": "vlnkltfo", + "snsTopicARN": "qsxejnowkzljayrlhzyyppaya" + }, + "publicCloudConnectorsResourceId": "kzdkfyjjgkoolslydcmbms", + "awsAccountId": "xiyydxsyykydvymn", + "arn": "eevsmaokvzzbqwpfm", + "publicCloudResourceName": "idxxguxjmvrzjnruzz", + "awsSourceSchema": "ged", + "awsRegion": "kngfw", + "awsTags": { + "key5086": "cnyyij" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6889": "bimlpmolvvbwmp" + }, + "location": "djcnfaicagptxk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ConfigServiceDeliveryChannels/{resourceName}", + "name": "nygnhqucwqufwbbhwstvjwf", + "type": "xqptovz", + "systemData": { + "createdBy": "fyzyombewv", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:01.160Z", + "lastModifiedBy": "amhktlm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:01.162Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json new file mode 100644 index 000000000000..5ef08fd52c52 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_CreateOrReplace.json @@ -0,0 +1,277 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", + "operationId": "DatabaseMigrationServiceReplicationInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + } + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Delete.json new file mode 100644 index 000000000000..5879bd50dbb4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Delete", + "operationId": "DatabaseMigrationServiceReplicationInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Get.json new file mode 100644 index 000000000000..e400ae964715 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Get.json @@ -0,0 +1,104 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Get", + "operationId": "DatabaseMigrationServiceReplicationInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..b22ef6926cb1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListByResourceGroup.json @@ -0,0 +1,108 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", + "operationId": "DatabaseMigrationServiceReplicationInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json new file mode 100644 index 000000000000..53383e2fa53f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_ListBySubscription.json @@ -0,0 +1,107 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", + "operationId": "DatabaseMigrationServiceReplicationInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Update.json new file mode 100644 index 000000000000..d5a926d7499a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DatabaseMigrationServiceReplicationInstances_Update.json @@ -0,0 +1,114 @@ +{ + "title": "DatabaseMigrationServiceReplicationInstances_Update", + "operationId": "DatabaseMigrationServiceReplicationInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9A9F6A1D-C0FE-43ED-8309-403E49257595", + "resourceGroupName": "rgdatabaseMigrationServiceReplicationInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4401": "wvciimt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 15, + "autoMinorVersionUpgrade": true, + "availabilityZone": "ufwkddqfhigljgpouncfjtwjhcm", + "dnsNameServers": "gjlforgdkkjubyetzafznct", + "engineVersion": "ugfhxgag", + "freeUntil": "2024-10-08T03:53:04.775Z", + "instanceCreateTime": "2024-10-08T03:53:04.776Z", + "kmsKeyId": "kxrelekeobexuugdjmttnolzsntu", + "multiAZ": true, + "networkType": "ognalkhwgr", + "pendingModifiedValues": { + "allocatedStorage": 24, + "engineVersion": "ljjlnnkamqo", + "multiAZ": true, + "networkType": "xgynwurnwuqfirccmedvhphptwx", + "replicationInstanceClass": "nah" + }, + "preferredMaintenanceWindow": "cjhj", + "publiclyAccessible": true, + "replicationInstanceArn": "kkuagugx", + "replicationInstanceClass": "nrejgjvmp", + "replicationInstanceIdentifier": "kmkhuvkgshmfnqrkh", + "replicationInstanceIpv6Addresses": [ + "chankbhtkfgmmql" + ], + "replicationInstancePrivateIpAddress": "kzpeupvtv", + "replicationInstancePrivateIpAddresses": [ + "wpvurjepdvyqsut" + ], + "replicationInstancePublicIpAddress": "cgolgdimqmrtbs", + "replicationInstancePublicIpAddresses": [ + "laguuyhnutmqr" + ], + "replicationInstanceStatus": "prkwehbwglimljckrujss", + "replicationSubnetGroup": { + "replicationSubnetGroupDescription": "octprj", + "replicationSubnetGroupIdentifier": "lp", + "subnetGroupStatus": "u", + "subnets": [ + { + "subnetAvailabilityZone": { + "name": "zkqyndrxrxjgvbcwycfd" + }, + "subnetIdentifier": "bbjyuchlt", + "subnetStatus": "pzsp" + } + ], + "supportedNetworkTypes": [ + "flrojgbtzlv" + ], + "vpcId": "zsg" + }, + "secondaryAvailabilityZone": "gfricycigffhmqcwzxxzwevrwf", + "vpcSecurityGroups": [ + { + "status": "tioerjd", + "vpcSecurityGroupId": "szupfofnwyrfpcpwi" + } + ] + }, + "publicCloudConnectorsResourceId": "oafkmlxerdytgq", + "awsAccountId": "zkpbtrjskcsejrxvaulidr", + "arn": "hgieneplknqcgzbvoj", + "publicCloudResourceName": "ajrdejnsykvcfzomaktse", + "awsSourceSchema": "aj", + "awsRegion": "xflnvjqertqoawntyvmyorzemmx", + "awsTags": { + "key1826": "hcitjgulaiuhknjncqdri" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2694": "vgcrgktfjprhiqwtucfsqt" + }, + "location": "pkvlgucpnkkigflvahztr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DatabaseMigrationServiceReplicationInstances/{resourceName}", + "name": "jiexnixxixjsyxn", + "type": "czltql", + "systemData": { + "createdBy": "geznwnexyri", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.798Z", + "lastModifiedBy": "ejmzpfceyizgpdgazottkodsy", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.798Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_CreateOrReplace.json new file mode 100644 index 000000000000..bf8abbf11d18 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_CreateOrReplace.json @@ -0,0 +1,271 @@ +{ + "title": "DaxClusters_CreateOrReplace", + "operationId": "DaxClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + } + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Delete.json new file mode 100644 index 000000000000..204f98e668f5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DaxClusters_Delete", + "operationId": "DaxClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Get.json new file mode 100644 index 000000000000..9ed848473df6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Get.json @@ -0,0 +1,102 @@ +{ + "title": "DaxClusters_Get", + "operationId": "DaxClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..fde01ef3574b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListByResourceGroup.json @@ -0,0 +1,106 @@ +{ + "title": "DaxClusters_ListByResourceGroup", + "operationId": "DaxClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListBySubscription.json new file mode 100644 index 000000000000..ea68600bd8dd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_ListBySubscription.json @@ -0,0 +1,105 @@ +{ + "title": "DaxClusters_ListBySubscription", + "operationId": "DaxClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Update.json new file mode 100644 index 000000000000..f955396ef599 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DaxClusters_Update.json @@ -0,0 +1,112 @@ +{ + "title": "DaxClusters_Update", + "operationId": "DaxClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93685BF1-7891-4BE3-BF8A-AF9CC3311660", + "resourceGroupName": "rgdaxCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3464": "umdxculs" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activeNodes": 18, + "clusterArn": "drxcjkivmlrtslbwoykkohay", + "clusterDiscoveryEndpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "clusterEndpointEncryptionType": { + "value": "NONE" + }, + "clusterName": "zobzejccpfjaqcvzutazmzjbl", + "description": "q", + "iamRoleArn": "epmvlmhygrgjvx", + "nodeIdsToRemove": [ + "uzzbmymlnrssuuqf" + ], + "nodeType": "vwyypkakaevefciygrniikfpyul", + "nodes": [ + { + "availabilityZone": "j", + "endpoint": { + "address": "piabfnkoscysceufovcpffxl", + "port": 13, + "url": "bcwzfeebgdzlvoafvyddknwzaih" + }, + "nodeCreateTime": "2024-10-08T03:51:45.186Z", + "nodeId": "stfvsn", + "nodeStatus": "cvxigvbkflormrnhzzjp", + "parameterGroupStatus": "ywehlocxyzqprjzljpwluyd" + } + ], + "notificationConfiguration": { + "topicArn": "phhrllxlsvtkodsyamltvoypqoj", + "topicStatus": "dfjjkb" + }, + "parameterGroup": { + "nodeIdsToReboot": [ + "idyqnyv" + ], + "parameterApplyStatus": "jrxbdxqellqqtknz", + "parameterGroupName": "ezciyomlrtvgjq" + }, + "preferredMaintenanceWindow": "gnqllhurfpmhsujlnznvuhtnacwfe", + "sseDescription": { + "status": { + "value": "DISABLED" + } + }, + "securityGroups": [ + { + "securityGroupIdentifier": "ehbvorabecsniiea", + "status": "ymc" + } + ], + "status": "mpwpseuoxrzbpamqwtibhochip", + "subnetGroup": "tzsrvhfugpjrwm", + "totalNodes": 26 + }, + "publicCloudConnectorsResourceId": "jzzs", + "awsAccountId": "xgeehpujhnyfhspdaqcugx", + "arn": "eqibkrig", + "publicCloudResourceName": "rdpgjpjzbwahajy", + "awsSourceSchema": "ukv", + "awsRegion": "kyjdudcmqspnbb", + "awsTags": { + "key1821": "aewrtrhvlcbtyjtdep" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1674": "xjulycgcyyd" + }, + "location": "vmw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DaxClusters/{resourceName}", + "name": "sjqsmwkcdacfzcmciafezgodtlragm", + "type": "lvahpkxzgyvxwnpt", + "systemData": { + "createdBy": "jotcnqxqpernrcvq", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:45.188Z", + "lastModifiedBy": "epnshcnwrpxocosr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:45.188Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json new file mode 100644 index 000000000000..005131b6dfb2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_CreateOrReplace", + "operationId": "DynamoDbContinuousBackupsDescriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + } + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Delete.json new file mode 100644 index 000000000000..493e82f3b22c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Delete", + "operationId": "DynamoDbContinuousBackupsDescriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Get.json new file mode 100644 index 000000000000..f7f108c75a01 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Get.json @@ -0,0 +1,55 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Get", + "operationId": "DynamoDbContinuousBackupsDescriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..cbaa3af0ee71 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup", + "operationId": "DynamoDbContinuousBackupsDescriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json new file mode 100644 index 000000000000..c4a7d2823b53 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_ListBySubscription", + "operationId": "DynamoDbContinuousBackupsDescriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Update.json new file mode 100644 index 000000000000..45105a1d3bc3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbContinuousBackupsDescriptions_Update.json @@ -0,0 +1,65 @@ +{ + "title": "DynamoDbContinuousBackupsDescriptions_Update", + "operationId": "DynamoDbContinuousBackupsDescriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21E01202-94CC-4645-BC9B-607A3CC7DB33", + "resourceGroupName": "rgdynamoDBContinuousBackupsDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5810": "lxzzovaxoagbrbvsf" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "continuousBackupsStatus": { + "value": "DISABLED" + }, + "pointInTimeRecoveryDescription": { + "earliestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "latestRestorableDateTime": "2024-10-08T03:52:00.281Z", + "pointInTimeRecoveryStatus": { + "value": "DISABLED" + } + } + }, + "publicCloudConnectorsResourceId": "cmxfprcuzlfsuapudqgzmyrz", + "awsAccountId": "mf", + "arn": "ftscqdgahea", + "publicCloudResourceName": "y", + "awsSourceSchema": "qdkzzibfkzzsphoguehj", + "awsRegion": "vvdgggbbnkqfqlawtbkkxhtn", + "awsTags": { + "key4982": "etujkpssxnluswfrmpfxwbkvvrbrj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6182": "vfhpsiualsgltchem" + }, + "location": "zlepfxe", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBContinuousBackupsDescriptions/{resourceName}", + "name": "ybhxjyoab", + "type": "mwnhozqisgupuntcdt", + "systemData": { + "createdBy": "fvfgiwfjml", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:00.283Z", + "lastModifiedBy": "pkveyxncsoprd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:00.283Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_CreateOrReplace.json new file mode 100644 index 000000000000..8de5997b48ab --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_CreateOrReplace.json @@ -0,0 +1,430 @@ +{ + "title": "DynamoDbTables_CreateOrReplace", + "operationId": "DynamoDbTables_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + } + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Delete.json new file mode 100644 index 000000000000..ff065f650b5a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "DynamoDbTables_Delete", + "operationId": "DynamoDbTables_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Get.json new file mode 100644 index 000000000000..d0dc64beba16 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Get.json @@ -0,0 +1,155 @@ +{ + "title": "DynamoDbTables_Get", + "operationId": "DynamoDbTables_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListByResourceGroup.json new file mode 100644 index 000000000000..71da58ddec14 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListByResourceGroup.json @@ -0,0 +1,159 @@ +{ + "title": "DynamoDbTables_ListByResourceGroup", + "operationId": "DynamoDbTables_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListBySubscription.json new file mode 100644 index 000000000000..aee8cf381953 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_ListBySubscription.json @@ -0,0 +1,158 @@ +{ + "title": "DynamoDbTables_ListBySubscription", + "operationId": "DynamoDbTables_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Update.json new file mode 100644 index 000000000000..dd2fb464ac2e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/DynamoDbTables_Update.json @@ -0,0 +1,165 @@ +{ + "title": "DynamoDbTables_Update", + "operationId": "DynamoDbTables_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "02C4AA05-916C-48EC-87C2-A70EB1EA2E38", + "resourceGroupName": "rgdynamoDBTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6429": "nawwkfqhaidvxvsiy" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qbvqgymuxfzuwybdspdhcuvfouwnet", + "attributeDefinitions": [ + { + "attributeName": "caryhpofnkqtoc", + "attributeType": "bcmjgzaljcemcrswr" + } + ], + "billingMode": "pwxrsjcybdcidejuhvrckvxyxad", + "contributorInsightsSpecification": { + "enabled": true + }, + "deletionProtectionEnabled": true, + "globalSecondaryIndexes": [ + { + "contributorInsightsSpecification": { + "enabled": true + }, + "indexName": "uqlzacnvsvayrvirrwwttb", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + } + } + ], + "importSourceSpecification": { + "inputCompressionType": "bjswmnwxleqmcth", + "inputFormat": "grnhhysgejvbnecrqoynjomz", + "inputFormatOptions": { + "csv": { + "delimiter": "qzowvvpwwhptthlgvrtnpyjszetrt", + "headerList": [ + "gminuylhgebpjx" + ] + } + }, + "s3BucketSource": { + "s3Bucket": "exulhkspgmo", + "s3BucketOwner": "pyawhaxbwqhgarz", + "s3KeyPrefix": "ogjgqdsvu" + } + }, + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "kinesisStreamSpecification": { + "approximateCreationDateTimePrecision": "MICROSECOND", + "streamArn": "qldltl" + }, + "localSecondaryIndexes": [ + { + "indexName": "gintyosxvkjqpe", + "keySchema": [ + { + "attributeName": "wisgqkyoouaxivtrtay", + "keyType": "kwkqgbxrwnoklpgmoypovxe" + } + ], + "projection": { + "nonKeyAttributes": [ + "loqmvohtjsscueegam" + ], + "projectionType": "atbzepkydpgudoaqi" + } + } + ], + "pointInTimeRecoverySpecification": { + "pointInTimeRecoveryEnabled": true + }, + "provisionedThroughput": { + "readCapacityUnits": 10, + "writeCapacityUnits": 28 + }, + "resourcePolicy": {}, + "sseSpecification": { + "kmsMasterKeyId": "rvwuejohzknzrntkvprgxt", + "sseEnabled": true, + "sseType": "osjalywculjbrystezvjojxe" + }, + "streamArn": "xvkrzs", + "streamSpecification": { + "resourcePolicy": {}, + "streamViewType": "wemod" + }, + "tableClass": "tmbfrfbppwhjpm", + "tableName": "mqvlcdboopn", + "tags": [ + { + "key": "txipennfw", + "value": "dkgweupnz" + } + ], + "timeToLiveSpecification": { + "attributeName": "sxbfejubturdtyusqywguqni", + "enabled": true + } + }, + "publicCloudConnectorsResourceId": "nugnoqcknmrrminwvfvloqsporjd", + "awsAccountId": "dejqcxb", + "arn": "gimtbcfiznraniycjyalnwrfstm", + "publicCloudResourceName": "lkbwyvnzooydbnembmykhmw", + "awsSourceSchema": "sqkkuxwamzevkp", + "awsRegion": "rdzrhtbydhmaxzuwe", + "awsTags": { + "key3791": "iikafuvbjkvnbogujm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2178": "lyeternduvkobwvqhpicnxel" + }, + "location": "fmkjilswdjyisfuwxuj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/DynamoDBTables/{resourceName}", + "name": "wjhshaxtpxprmkvirlnkg", + "type": "umwtmbybylwhva", + "systemData": { + "createdBy": "xcpeunamznqsrhfcxbzfhdmlwfuz", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:43.389Z", + "lastModifiedBy": "oymokxbjupq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:43.390Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_CreateOrReplace.json new file mode 100644 index 000000000000..5dd056a54243 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "Ec2AccountAttributes_CreateOrReplace", + "operationId": "Ec2AccountAttributes_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + } + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Delete.json new file mode 100644 index 000000000000..21cd80d93ab8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2AccountAttributes_Delete", + "operationId": "Ec2AccountAttributes_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Get.json new file mode 100644 index 000000000000..dfc5f4ad856a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Get.json @@ -0,0 +1,51 @@ +{ + "title": "Ec2AccountAttributes_Get", + "operationId": "Ec2AccountAttributes_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListByResourceGroup.json new file mode 100644 index 000000000000..294386c99005 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "Ec2AccountAttributes_ListByResourceGroup", + "operationId": "Ec2AccountAttributes_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListBySubscription.json new file mode 100644 index 000000000000..a39f3cff7259 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "Ec2AccountAttributes_ListBySubscription", + "operationId": "Ec2AccountAttributes_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Update.json new file mode 100644 index 000000000000..676aa3b2ced7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2AccountAttributes_Update.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2AccountAttributes_Update", + "operationId": "Ec2AccountAttributes_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FABCEE93-93A3-408E-BCC1-58AE496DA32E", + "resourceGroupName": "rgec2AccountAttribute", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key675": "dcdcpzbhvgkomzutrzgdjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "attributeName": "vsrccnoksnxyyisrlfzkuj", + "attributeValues": [ + { + "attributeValue": "lvlyhjnivtpgkbt" + } + ] + }, + "publicCloudConnectorsResourceId": "rmmqxjdxoe", + "awsAccountId": "jzeepmbcwiwakwsvqakkaz", + "arn": "ttwi", + "publicCloudResourceName": "lhdzqjxtfagnhbdjev", + "awsSourceSchema": "njukzwmmwgmvurer", + "awsRegion": "ojtquhkurhjtoocjpjyibb", + "awsTags": { + "key2779": "qzjyzsygumaykisfigqlypvu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6022": "psppjmksguimpyjugsfgrp" + }, + "location": "mxywielgbokfdxxwuudnbwzjcf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2AccountAttributes/{resourceName}", + "name": "gwbo", + "type": "cdaqysx", + "systemData": { + "createdBy": "oin", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:07.943Z", + "lastModifiedBy": "zkhtrvkwmsstvzaovmgsbveunpyfwz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:07.943Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_CreateOrReplace.json new file mode 100644 index 000000000000..2517f0a0f5fd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_CreateOrReplace.json @@ -0,0 +1,163 @@ +{ + "title": "Ec2Addresses_CreateOrReplace", + "operationId": "Ec2Addresses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + } + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Delete.json new file mode 100644 index 000000000000..3b9570e77ee0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Addresses_Delete", + "operationId": "Ec2Addresses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Get.json new file mode 100644 index 000000000000..33a664243aa2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Get.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Addresses_Get", + "operationId": "Ec2Addresses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListByResourceGroup.json new file mode 100644 index 000000000000..3be9d076b894 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2Addresses_ListByResourceGroup", + "operationId": "Ec2Addresses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListBySubscription.json new file mode 100644 index 000000000000..f9d593d33eb7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "title": "Ec2Addresses_ListBySubscription", + "operationId": "Ec2Addresses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Update.json new file mode 100644 index 000000000000..a1b726af51e0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Addresses_Update.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Addresses_Update", + "operationId": "Ec2Addresses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "3EE44915-3FD0-4021-83E9-2F9A12498E0D", + "resourceGroupName": "rgec2Address", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key976": "okhsskkdfuoqrebdxesgrmpcsif" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocationId": "lakfpwuipmqvwqzpiojxgxjrh", + "associationId": "wwgugzolrxtpvpaxafaqi", + "carrierIp": "tpwlxdfmqhkr", + "customerOwnedIp": "qpvlzqkbksm", + "customerOwnedIpv4Pool": "sbzgaydiiwsnarhj", + "domain": { + "value": "standard" + }, + "instanceId": "lcw", + "networkBorderGroup": "cvmuzymwrwriouiziwwhybkwv", + "networkInterfaceId": "pundetxxybkvjkwhenmdlxzoji", + "networkInterfaceOwnerId": "mxcypkkbqs", + "privateIpAddress": "syfgrbvaucqkmkakjhez", + "publicIp": "uzkzeonfghtefuulqaev", + "publicIpv4Pool": "dlv", + "tags": [ + { + "key": "acaotlyww", + "value": "tcahesrhkpnaonjnhbfsmiyhypjmw" + } + ] + }, + "publicCloudConnectorsResourceId": "eytnpsrqhczygcelqjky", + "awsAccountId": "nfzczrgklte", + "arn": "kgqnwrdoqeqjraczlznfiu", + "publicCloudResourceName": "xongligvmdxe", + "awsSourceSchema": "uachsjdkxtczamkh", + "awsRegion": "qocfydee", + "awsTags": { + "key6276": "nolpfwzekiehxektjfku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key991": "zgudcnhfnizgcnyjetbfss" + }, + "location": "uwbmdjhaqaqz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Addresses/{resourceName}", + "name": "xnduh", + "type": "diyosv", + "systemData": { + "createdBy": "yjtmvitayyidrlgxurjukaw", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.761Z", + "lastModifiedBy": "xjfrawhpaohxtuot", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.761Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_CreateOrReplace.json new file mode 100644 index 000000000000..56a82e86c3fa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "Ec2FlowLogs_CreateOrReplace", + "operationId": "Ec2FlowLogs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + } + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Delete.json new file mode 100644 index 000000000000..21c4ddde163b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2FlowLogs_Delete", + "operationId": "Ec2FlowLogs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Get.json new file mode 100644 index 000000000000..a9170f864f1e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Get.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2FlowLogs_Get", + "operationId": "Ec2FlowLogs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListByResourceGroup.json new file mode 100644 index 000000000000..11e021fa1017 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "Ec2FlowLogs_ListByResourceGroup", + "operationId": "Ec2FlowLogs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListBySubscription.json new file mode 100644 index 000000000000..aa50d956dd96 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2FlowLogs_ListBySubscription", + "operationId": "Ec2FlowLogs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Update.json new file mode 100644 index 000000000000..3d3ee8a7f1d5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2FlowLogs_Update.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2FlowLogs_Update", + "operationId": "Ec2FlowLogs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0E3C1AF7-2285-47DA-B831-FD4A83154E65", + "resourceGroupName": "rgec2FlowLog", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6176": "oqawryfimbztptk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deliverCrossAccountRole": "upu", + "deliverLogsPermissionArn": "sfhmarwniuptmkaegsplmsozsmc", + "destinationOptions": { + "fileFormat": "parquet", + "hiveCompatiblePartitions": true, + "perHourPartition": true + }, + "id": "idflwxdxpu", + "logDestination": "ztqhcrirplxmgncvubutyzqefvd", + "logDestinationType": "cloud-watch-logs", + "logFormat": "miqwrkvqyq", + "logGroupName": "gptervjekilsbzqokcmrbumaie", + "maxAggregationInterval": 15, + "resourceId": "mokmavuqvq", + "resourceType": "NetworkInterface", + "tags": [ + { + "key": "hpdlgqvamjjtqreaoxergrowvu", + "value": "qdqsngozfinennzbilnzeemjzilpb" + } + ], + "trafficType": "ACCEPT" + }, + "publicCloudConnectorsResourceId": "djh", + "awsAccountId": "shsomlkgpjnxnonvrv", + "arn": "ilajcrcqxitnhyhorqitssmvsfwen", + "publicCloudResourceName": "ymv", + "awsSourceSchema": "pnjgqxqhnwhcs", + "awsRegion": "stazvnpsmrpkoxyyzngdkkuif", + "awsTags": { + "key3000": "acmzumzbkwgpabbmyshaigqlt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8783": "hbgkwojrzrpoaac" + }, + "location": "iheortzyczwfplyjuuqwhdtpscn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2FlowLogs/{resourceName}", + "name": "tpcivqsrlbvmapaplm", + "type": "r", + "systemData": { + "createdBy": "wflsxyugsgygu", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:16.953Z", + "lastModifiedBy": "ugltxttsqqmccunysidyzof", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:16.954Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_CreateOrReplace.json new file mode 100644 index 000000000000..d799c600a5eb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_CreateOrReplace.json @@ -0,0 +1,361 @@ +{ + "title": "Ec2Images_CreateOrReplace", + "operationId": "Ec2Images_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + } + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Delete.json new file mode 100644 index 000000000000..aa414e5f36dd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Images_Delete", + "operationId": "Ec2Images_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Get.json new file mode 100644 index 000000000000..f7bd2279a66c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Get.json @@ -0,0 +1,132 @@ +{ + "title": "Ec2Images_Get", + "operationId": "Ec2Images_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListByResourceGroup.json new file mode 100644 index 000000000000..d6aa67e04588 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListByResourceGroup.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2Images_ListByResourceGroup", + "operationId": "Ec2Images_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListBySubscription.json new file mode 100644 index 000000000000..d9105a595f70 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_ListBySubscription.json @@ -0,0 +1,135 @@ +{ + "title": "Ec2Images_ListBySubscription", + "operationId": "Ec2Images_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Update.json new file mode 100644 index 000000000000..bd65f0094f8a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Images_Update.json @@ -0,0 +1,142 @@ +{ + "title": "Ec2Images_Update", + "operationId": "Ec2Images_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "489A021E-F8AA-4824-8519-7BC885087674", + "resourceGroupName": "rgec2Image", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1684": "vawzenjlufhqre" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "foqeiqkjrwirhz", + "ebs": { + "deleteOnTermination": true, + "encrypted": true, + "iops": 6, + "kmsKeyId": "ilegn", + "outpostArn": "yzyqckzzbmbeimvwrvckybpdil", + "snapshotId": "yjsctqicabclgsmtr", + "throughput": 29, + "volumeSize": 15, + "volumeType": { + "value": "gp2" + } + }, + "noDevice": "rs", + "virtualName": "lgrpmrjfdvrwmfghttgcdgqsfum" + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "creationDate": "iri", + "deprecationTime": "rjbfczermuljog", + "deregistrationProtection": "qgzillhrsaoasehpuum", + "description": "xcucajel", + "enaSupport": true, + "hypervisor": { + "value": "ovm" + }, + "imageId": "abwaglkivomqynfncjesal", + "imageLocation": "pgjapgkiakctxcpfpmvk", + "imageOwnerAlias": "sqvaqlxrlzhlzbczv", + "imageType": { + "value": "kernel" + }, + "imdsSupport": { + "value": "v2.0" + }, + "kernelId": "mfsmykrvrtbosarfpfuwahchz", + "lastLaunchedTime": "syfznkavvtio", + "name": "secemuogxgahtxnpthro", + "ownerId": "nhuhifhzxvkdxxvaiaibzihkyvbrwh", + "platform": { + "value": "Windows" + }, + "platformDetails": "lisborjwdvhfnwsziqhfnxiqdmdynp", + "productCodes": [ + { + "productCodeId": "gkdidapdrunawxoaa", + "productCodeType": { + "value": "devpay" + } + } + ], + "public": true, + "ramdiskId": "xrcwfszijxclkazpcletlaoca", + "rootDeviceName": "jjgzjpjxtlhvqyvdrnqelzasdmn", + "rootDeviceType": { + "value": "ebs" + }, + "sourceInstanceId": "g", + "sriovNetSupport": "sbnokjesjjkngdixqtiijn", + "state": { + "value": "available" + }, + "stateReason": { + "code": "xyfxvbpxwvorfincngvphetvrkhajy", + "message": "qgjrouiqrxyqi" + }, + "tags": [ + { + "key": "mcszeusqtxavdhmwinblzyofkns", + "value": "ehismpwetbakkwkjtngdrofhipjlko" + } + ], + "tpmSupport": { + "value": "v2.0" + }, + "usageOperation": "gdlrmqiw", + "virtualizationType": { + "value": "hvm" + } + }, + "publicCloudConnectorsResourceId": "dth", + "awsAccountId": "yvwtilsspffh", + "arn": "qaahwnaabcqlufiiwhkwhv", + "publicCloudResourceName": "iwvkviywiipsmvxpemnivpyqwnp", + "awsSourceSchema": "zpslskfplbejouiomrfkp", + "awsRegion": "chnagdbgxpnwsklnknirzcmbyhif", + "awsTags": { + "key3097": "osnwzuconxacmfwdhcxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key733": "rcinsnkdjolysslzbnmptbwfoxc" + }, + "location": "rskzngterhbdzpdgzthkwkfsim", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Images/{resourceName}", + "name": "pzwam", + "type": "ouqfeqzof", + "systemData": { + "createdBy": "rzknm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:43.342Z", + "lastModifiedBy": "bnpdahwlbrplycpkvvplmrgftx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:43.342Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..2ce8b4595a1c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_CreateOrReplace.json @@ -0,0 +1,259 @@ +{ + "title": "Ec2InstanceStatuses_CreateOrReplace", + "operationId": "Ec2InstanceStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + } + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Delete.json new file mode 100644 index 000000000000..e21a1b86c65a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2InstanceStatuses_Delete", + "operationId": "Ec2InstanceStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Get.json new file mode 100644 index 000000000000..4cd5fcf6fc0a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Get.json @@ -0,0 +1,98 @@ +{ + "title": "Ec2InstanceStatuses_Get", + "operationId": "Ec2InstanceStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..fe98c2b88652 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListByResourceGroup.json @@ -0,0 +1,102 @@ +{ + "title": "Ec2InstanceStatuses_ListByResourceGroup", + "operationId": "Ec2InstanceStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + ], + "nextLink": "https://microsoft.com/alckbe" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListBySubscription.json new file mode 100644 index 000000000000..d3aeabcd329d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_ListBySubscription.json @@ -0,0 +1,101 @@ +{ + "title": "Ec2InstanceStatuses_ListBySubscription", + "operationId": "Ec2InstanceStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + ], + "nextLink": "https://microsoft.com/alckbe" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Update.json new file mode 100644 index 000000000000..21272dc6fb69 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2InstanceStatuses_Update.json @@ -0,0 +1,108 @@ +{ + "title": "Ec2InstanceStatuses_Update", + "operationId": "Ec2InstanceStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A09628F1-DD00-4C1A-9923-61B57B37FF11", + "resourceGroupName": "rgec2InstanceStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3283": "pkbbgzmxkmwygqdlfzoz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "availabilityZone": "ytnhdkisucgzas", + "events": [ + { + "code": { + "value": "instance-reboot" + }, + "description": "hgvqagwss", + "instanceEventId": "rnbshnkjo", + "notAfter": "2024-10-08T03:53:26.681Z", + "notBefore": "2024-10-08T03:53:26.681Z", + "notBeforeDeadline": "2024-10-08T03:53:26.681Z" + } + ], + "instanceId": "aoffpxifvwnouuzzpkqc", + "instanceState": { + "code": 9, + "name": { + "value": "pending" + } + }, + "instanceStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + }, + "outpostArn": "pprqpuqeokryiz", + "systemStatus": { + "details": [ + { + "impairedSince": "2024-10-08T03:53:26.682Z", + "name": { + "value": "reachability" + }, + "status": { + "value": "failed" + } + } + ], + "status": { + "value": "impaired" + } + } + }, + "publicCloudConnectorsResourceId": "ouhnawwxmqjpfsmz", + "awsAccountId": "pjfvkzfpdqdiweudknutyey", + "arn": "nnkvtshcitbzvtrcwybizpxfznrsyg", + "publicCloudResourceName": "mqygrsmavjlivhliidvrmopovsba", + "awsSourceSchema": "zvcrlmc", + "awsRegion": "uxchexljsahdlvcecpckwevokhvd", + "awsTags": { + "key8745": "rebvfwuycmmclbkwmnnslwgaispvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1363": "rvbvinbkmuoftqnsbj" + }, + "location": "pgcnqdiaetxhtdrimhlcwthap", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2InstanceStatuses/{resourceName}", + "name": "fxielgkexujsnpbsv", + "type": "xkjkymhi", + "systemData": { + "createdBy": "qcj", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:26.683Z", + "lastModifiedBy": "atlvucovlgtcuvhakxponsumjv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:26.683Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_CreateOrReplace.json new file mode 100644 index 000000000000..f031639091fd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_CreateOrReplace.json @@ -0,0 +1,914 @@ +{ + "title": "Ec2Instances_CreateOrReplace", + "operationId": "Ec2Instances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c", + "resource": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Delete.json new file mode 100644 index 000000000000..e14f139cc921 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Delete.json @@ -0,0 +1,16 @@ +{ + "title": "Ec2Instances_Delete", + "operationId": "Ec2Instances_Delete", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Get.json new file mode 100644 index 000000000000..6826dc42085b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Get.json @@ -0,0 +1,315 @@ +{ + "title": "Ec2Instances_Get", + "operationId": "Ec2Instances_Get", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_List.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_List.json new file mode 100644 index 000000000000..b89a8a4e3cf8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_List.json @@ -0,0 +1,320 @@ +{ + "title": "Ec2Instances_List", + "operationId": "Ec2Instances_List", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiLaunchIndex": 27, + "architecture": { + "value": "arm64" + }, + "blockDeviceMappings": [ + { + "deviceName": "tfaglaaaklzilxzmk", + "ebs": { + "associatedResource": "pgkczdagxihtrkzzaiuzennp", + "attachTime": "2024-10-08T03:49:10.616Z", + "deleteOnTermination": true, + "status": { + "value": "attached" + }, + "volumeId": "ilihhdgfhpylwqnaglcmj", + "volumeOwnerId": "ruylzxnmlundujqdqkqocknldkttka" + } + } + ], + "bootMode": { + "value": "legacy-bios" + }, + "capacityReservationId": "rgxeywdieyjfmp", + "capacityReservationSpecification": { + "capacityReservationPreference": { + "value": "none" + }, + "capacityReservationTarget": { + "capacityReservationId": "dvdusvbgjrkkuqrelloyysinnzpjb", + "capacityReservationResourceGroupArn": "itnyqqrlujfkasgzbrvljlbh" + } + }, + "clientToken": "zgimjubyev", + "cpuOptions": { + "amdSevSnp": { + "value": "disabled" + }, + "coreCount": 27, + "threadsPerCore": 11 + }, + "currentInstanceBootMode": { + "value": "legacy-bios" + }, + "ebsOptimized": true, + "elasticGpuAssociations": [ + { + "elasticGpuAssociationId": "jmxqiqiyocefwrivbcumzx", + "elasticGpuAssociationState": "mkteimwlzs", + "elasticGpuAssociationTime": "sosasrnqg", + "elasticGpuId": "dnpmhib" + } + ], + "elasticInferenceAcceleratorAssociations": [ + { + "elasticInferenceAcceleratorArn": "pnbrdzuzjxuwrtpdc", + "elasticInferenceAcceleratorAssociationId": "uoout", + "elasticInferenceAcceleratorAssociationState": "bwbmjkusisjrxxdonwtxkbgbaxk", + "elasticInferenceAcceleratorAssociationTime": "2024-10-08T03:49:10.617Z" + } + ], + "enaSupport": true, + "enclaveOptions": { + "enabled": true + }, + "hibernationOptions": { + "configured": true + }, + "hypervisor": { + "value": "ovm" + }, + "iamInstanceProfile": { + "arn": "jvju", + "id": "kdzthqdiqjcknesajpbplmkynzokr" + }, + "imageId": "oemhjwhbzkbcwocprtn", + "instanceId": "czyyyovcqwce", + "instanceLifecycle": { + "value": "capacity-block" + }, + "instanceType": { + "value": "a1.2xlarge" + }, + "ipv6Address": "kuzwkpvttqtjxowkisga", + "kernelId": "qqehgoolsvuh", + "keyName": "bxxdzmyclfgrwqwnjajhs", + "launchTime": "2024-10-08T03:49:10.618Z", + "licenses": [ + { + "licenseConfigurationArn": "q" + } + ], + "maintenanceOptions": { + "autoRecovery": { + "value": "default" + } + }, + "metadataOptions": { + "httpEndpoint": { + "value": "disabled" + }, + "httpProtocolIpv6": { + "value": "disabled" + }, + "httpPutResponseHopLimit": 3, + "httpTokens": { + "value": "optional" + }, + "instanceMetadataTags": { + "value": "disabled" + }, + "state": { + "value": "applied" + } + }, + "monitoring": { + "state": { + "value": "disabled" + } + }, + "networkInterfaces": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "attachment": { + "attachTime": "2024-10-08T03:49:10.618Z", + "attachmentId": "lsqnlzd", + "deleteOnTermination": true, + "deviceIndex": 11, + "enaSrdSpecification": { + "enaSrdEnabled": true, + "enaSrdUdpSpecification": { + "enaSrdUdpEnabled": true + } + }, + "networkCardIndex": 9, + "status": { + "value": "attached" + } + }, + "connectionTrackingConfiguration": { + "tcpEstablishedTimeout": 23, + "udpStreamTimeout": 24, + "udpTimeout": 30 + }, + "description": "wcdguczvqhelvbuhnx", + "groups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "interfaceType": "mphomintds", + "ipv4Prefixes": [ + { + "ipv4Prefix": "ortyghjrffqjz" + } + ], + "ipv6Addresses": [ + { + "ipv6Address": "z", + "isPrimaryIpv6": true + } + ], + "ipv6Prefixes": [ + { + "ipv6Prefix": "cstrptdpvmberviuvuqfd" + } + ], + "macAddress": "k", + "networkInterfaceId": "qythf", + "ownerId": "fvjysbetbyrzccspcenkpvi", + "privateDnsName": "yvorusnuuigavdcqqdxecrkmjmhrf", + "privateIpAddress": "m", + "privateIpAddresses": [ + { + "association": { + "carrierIp": "gyqfkluecfuwebntnygczb", + "customerOwnedIp": "sw", + "ipOwnerId": "fbrkixipyqjnao", + "publicDnsName": "oivnzjavxqmctzvhgmsavgwesabny", + "publicIp": "tojjymqqjmschjp" + }, + "primary": true, + "privateDnsName": "bdezhkhwoerivtfwgqelrsyiphf", + "privateIpAddress": "xcqnyrs" + } + ], + "sourceDestCheck": true, + "status": { + "value": "associated" + }, + "subnetId": "euocsemlw", + "vpcId": "grahbrhjelkewder" + } + ], + "outpostArn": "godjddxeidxe", + "placement": { + "affinity": "xzseileq", + "availabilityZone": "vsfvyosolmnchbavxfvtizqptgmeg", + "groupId": "davwvkjoij", + "groupName": "txqgn", + "hostId": "mvbshbhxclztfwffsu", + "hostResourceGroupArn": "zl", + "partitionNumber": 24, + "spreadDomain": "t", + "tenancy": { + "value": "dedicated" + } + }, + "platform": { + "value": "Windows" + }, + "platformDetails": "rcwqyqgcruqjcvzcto", + "privateDnsName": "ieuhntvllhoojakokyt", + "privateDnsNameOptions": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": { + "value": "ip-name" + } + }, + "privateIpAddress": "uosximzwwopktgyzlathmorgqah", + "productCodes": [ + { + "productCodeId": "sexxutnmcfhkamhmvjrggoscatni", + "productCodeType": { + "value": "devpay" + } + } + ], + "publicDnsName": "qkucqmeldgiumuzribitahwft", + "publicIpAddress": "ialohsszgtpuycimtqi", + "ramdiskId": "ggkfkl", + "rootDeviceName": "dbfwarbazrbzcjnh", + "rootDeviceType": { + "value": "ebs" + }, + "securityGroups": [ + { + "groupId": "nwupmxpxrzdroizfewqupyddewi", + "groupName": "gvsaaqihzfcwdmeocclatfqm" + } + ], + "sourceDestCheck": true, + "spotInstanceRequestId": "qiylxsuuinwyq", + "sriovNetSupport": "kiffwvajczdtzwcfeefqespn", + "state": { + "code": 18, + "name": { + "value": "pending" + } + }, + "stateReason": { + "code": "kdnlidwcsckwbplroijtjciufgg", + "message": "dvgendvpuuzx" + }, + "stateTransitionReason": "arenmfmnvv", + "subnetId": "mgnibedayjllwaidbjh", + "tags": [ + { + "key": "pbvbjvyuqibbevydlslmfple", + "value": "zztbwjxzwgmnjqhegktznmdrqferd" + } + ], + "tpmSupport": "fvxtckturm", + "usageOperation": "xrctwrcgpcrhlfjzhdvhiovdlcqafq", + "usageOperationUpdateTime": "2024-10-08T03:49:10.619Z", + "virtualizationType": { + "value": "hvm" + }, + "vpcId": "g" + }, + "publicCloudConnectorsResourceId": "shnvqmmslrarjuzdpyhlnfxxp", + "awsAccountId": "hhrjjrfopsrebnklxmr", + "arn": "noxwkahrsrcnrpz", + "publicCloudResourceName": "sffqiavopmcwltotrpubudq", + "awsSourceSchema": "tncjfmwlkponefezhigbyno", + "awsRegion": "tcaqttnhykcej", + "awsTags": { + "key2934": "wyx" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Instances/{resourceName}", + "name": "jjhsvqaguzzovfqofv", + "type": "eekqhvdfthrzelnq", + "systemData": { + "createdBy": "ssygefhsohonpg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:10.619Z", + "lastModifiedBy": "ypwpsuoqomibzepfh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:10.619Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Start.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Start.json new file mode 100644 index 000000000000..b760f02d207f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Start.json @@ -0,0 +1,39 @@ +{ + "title": "Ec2Instances_Start", + "operationId": "Ec2Instances_Start", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "name": "vqjtjwjblwnsoworqkrls", + "status": "vrcsdllflyxcatvyvrwa", + "percentComplete": 96, + "startTime": "2024-10-08T16:46:17.519Z", + "endTime": "2024-10-08T16:46:17.519Z", + "operations": [], + "error": { + "code": "juzxifzmyic", + "message": "hqzuumjoqnagcxvrcooyuwrixjl", + "target": "grzkrahafxmciozivwqargn", + "details": [], + "additionalInfo": [ + { + "type": "pfubhxblfnkmfjqu", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Stop.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Stop.json new file mode 100644 index 000000000000..b6bc913af175 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Instances_Stop.json @@ -0,0 +1,43 @@ +{ + "title": "Ec2Instances_Stop", + "operationId": "Ec2Instances_Stop", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "c", + "body": { + "force": true, + "hibernate": true + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "resourceId": "/subscriptions/5ACC4579-DB34-4C2F-8F8C-25061168F342/providers/Microsoft.AwsConnector/Ec2Instances/esixipkbydb", + "name": "vqjtjwjblwnsoworqkrls", + "status": "vrcsdllflyxcatvyvrwa", + "percentComplete": 96, + "startTime": "2024-10-08T16:46:17.519Z", + "endTime": "2024-10-08T16:46:17.519Z", + "operations": [], + "error": { + "code": "juzxifzmyic", + "message": "hqzuumjoqnagcxvrcooyuwrixjl", + "target": "grzkrahafxmciozivwqargn", + "details": [], + "additionalInfo": [ + { + "type": "pfubhxblfnkmfjqu", + "info": {} + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_CreateOrReplace.json new file mode 100644 index 000000000000..1e5afc0ac99d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "Ec2Ipams_CreateOrReplace", + "operationId": "Ec2Ipams_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + } + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Delete.json new file mode 100644 index 000000000000..5d1f0a331e34 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Ipams_Delete", + "operationId": "Ec2Ipams_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Get.json new file mode 100644 index 000000000000..1a08a578d54e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Get.json @@ -0,0 +1,74 @@ +{ + "title": "Ec2Ipams_Get", + "operationId": "Ec2Ipams_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListByResourceGroup.json new file mode 100644 index 000000000000..effe5146e90d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "Ec2Ipams_ListByResourceGroup", + "operationId": "Ec2Ipams_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListBySubscription.json new file mode 100644 index 000000000000..a118782d52b9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2Ipams_ListBySubscription", + "operationId": "Ec2Ipams_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Update.json new file mode 100644 index 000000000000..8ca1823c50b5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Ipams_Update.json @@ -0,0 +1,84 @@ +{ + "title": "Ec2Ipams_Update", + "operationId": "Ec2Ipams_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D69B2284-3E7E-4B4F-805B-47F7A3694856", + "resourceGroupName": "rgec2Ipam", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1619": "cpquimegsosw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "defaultResourceDiscoveryAssociationId": "upvbhujajpxidvdneaxudp", + "defaultResourceDiscoveryId": "vmatfdwggwysxz", + "description": "suxncf", + "ipamArn": "ounjgxqwlmalbxgwqepaivhpqm", + "ipamId": "baiefjd", + "ipamRegion": "dfdcpbefpcajoep", + "operatingRegions": [ + { + "regionName": "racqmjs" + } + ], + "ownerId": "sbcvakmustluzumdv", + "privateDefaultScopeId": "sgytzjkrmsnzccmbos", + "publicDefaultScopeId": "uqxvzoqzwfiaerfqkufw", + "resourceDiscoveryAssociationCount": 28, + "scopeCount": 8, + "state": { + "value": "create-complete" + }, + "stateMessage": "wehaarwg", + "tags": [ + { + "key": "lldedstrwaskhlskwkk", + "value": "jnzubqdwmuxxyakaosx" + } + ], + "tier": { + "value": "advanced" + } + }, + "publicCloudConnectorsResourceId": "irfihvsxrgyhmubmuieufe", + "awsAccountId": "fyceaucatzscmtkaw", + "arn": "gcjcnzkmoauyi", + "publicCloudResourceName": "y", + "awsSourceSchema": "ivdglskrjwzg", + "awsRegion": "rvtevmqvjnnignaaojkgqgzrsi", + "awsTags": { + "key4146": "ujvngmugdyjjv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6845": "fmqqsfwgeauorxhhizhrca" + }, + "location": "lhjepajysvu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Ipams/{resourceName}", + "name": "qaeolhlu", + "type": "somujnpzb", + "systemData": { + "createdBy": "pupdrpwxuswcfgpwnpcaclm", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:55.287Z", + "lastModifiedBy": "idwyojfwtvqiqhyzfkpwmmpoiwe", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:55.287Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_CreateOrReplace.json new file mode 100644 index 000000000000..c5ee1aa5d088 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2KeyPairs_CreateOrReplace", + "operationId": "Ec2KeyPairs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + } + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Delete.json new file mode 100644 index 000000000000..6ba207e3d090 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2KeyPairs_Delete", + "operationId": "Ec2KeyPairs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Get.json new file mode 100644 index 000000000000..4c9c52a22cf6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Get.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2KeyPairs_Get", + "operationId": "Ec2KeyPairs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListByResourceGroup.json new file mode 100644 index 000000000000..19eb3bfbdfdf --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2KeyPairs_ListByResourceGroup", + "operationId": "Ec2KeyPairs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + ], + "nextLink": "https://microsoft.com/aejjm" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListBySubscription.json new file mode 100644 index 000000000000..4f8974c2e45e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "Ec2KeyPairs_ListBySubscription", + "operationId": "Ec2KeyPairs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + ], + "nextLink": "https://microsoft.com/aejjm" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Update.json new file mode 100644 index 000000000000..ec76bc9af358 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2KeyPairs_Update.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2KeyPairs_Update", + "operationId": "Ec2KeyPairs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "21A254FE-7D89-4943-9B30-A829ADBDE7C1", + "resourceGroupName": "rgec2KeyPair", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7068": "ocrsjoz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "keyFingerprint": "xamuanffyhal", + "keyFormat": "pem", + "keyName": "jsltsdchgdrtwidgfy", + "keyPairId": "tqtfcaqdmookxfgpvbzkyzzgstwqh", + "keyType": "ed25519", + "publicKeyMaterial": "wewhsgvwdbsygwbukotmsiu", + "tags": [ + { + "key": "tthjjmap", + "value": "fcqkvmxnvgkszsjglbmc" + } + ] + }, + "publicCloudConnectorsResourceId": "dtqfffijdvwrjascztihbhcjfo", + "awsAccountId": "iamyich", + "arn": "hbplblilwwscgwiaifygy", + "publicCloudResourceName": "nyywppatxodspls", + "awsSourceSchema": "qbl", + "awsRegion": "zkxhveyqnzcmihgmancphtwumisld", + "awsTags": { + "key6629": "qrszxqxtlbgttasepkymnkamqvw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7076": "hevuyqs" + }, + "location": "okgykmqgdqfktczzwnisgblxjor", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2KeyPairs/{resourceName}", + "name": "cu", + "type": "aztmoywijnkpimuzgrhfzidh", + "systemData": { + "createdBy": "zjcuoex", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:34.042Z", + "lastModifiedBy": "xgzdcvzeaj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:34.042Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_CreateOrReplace.json new file mode 100644 index 000000000000..e953bfaafff4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "Ec2NetworkAcls_CreateOrReplace", + "operationId": "Ec2NetworkAcls_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + } + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Delete.json new file mode 100644 index 000000000000..c8981c9a1dbc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2NetworkAcls_Delete", + "operationId": "Ec2NetworkAcls_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Get.json new file mode 100644 index 000000000000..c00619b4ae45 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Get.json @@ -0,0 +1,53 @@ +{ + "title": "Ec2NetworkAcls_Get", + "operationId": "Ec2NetworkAcls_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListByResourceGroup.json new file mode 100644 index 000000000000..26427da59228 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2NetworkAcls_ListByResourceGroup", + "operationId": "Ec2NetworkAcls_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + ], + "nextLink": "https://microsoft.com/alylrur" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListBySubscription.json new file mode 100644 index 000000000000..a7b6c618c6ef --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "Ec2NetworkAcls_ListBySubscription", + "operationId": "Ec2NetworkAcls_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + ], + "nextLink": "https://microsoft.com/alylrur" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Update.json new file mode 100644 index 000000000000..3ee3ff552a35 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkAcls_Update.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2NetworkAcls_Update", + "operationId": "Ec2NetworkAcls_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "14D69B09-2F64-4878-BD80-924BA15D634B", + "resourceGroupName": "rgec2NetworkAcl", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5032": "fvynstjrcxzoxpxzwnqrny" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "qgxcaonshnjzgtrwpbtgtnec", + "tags": [ + { + "key": "ybqfvnnjihkyssxqqynvpdtbdt", + "value": "szjckvzlsvasj" + } + ], + "vpcId": "wifperjiuulltgxcljqwnaeyscd" + }, + "publicCloudConnectorsResourceId": "thejbzeletryigazixejsz", + "awsAccountId": "nwnjrjumgvvtfndyaxyiwbugmdk", + "arn": "mwwchyidvtcm", + "publicCloudResourceName": "dniirwtrtuvjlcdcjq", + "awsSourceSchema": "hqiutsyaxzitfwtekhw", + "awsRegion": "zmntebskjciytwfcjyj", + "awsTags": { + "key8049": "yfihxfeqfujhxxqpzpttbewzztgdix" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7602": "dffxjegkksnmrmfplzhq" + }, + "location": "fshtit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkAcls/{resourceName}", + "name": "cvogwcrrjooylziw", + "type": "dqusvhczhirikbpwpjeydbdj", + "systemData": { + "createdBy": "nxkavvgoftpebqtvryigpjexyln", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:39.220Z", + "lastModifiedBy": "eb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:39.221Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_CreateOrReplace.json new file mode 100644 index 000000000000..c59dbf62998d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_CreateOrReplace.json @@ -0,0 +1,256 @@ +{ + "title": "Ec2NetworkInterfaces_CreateOrReplace", + "operationId": "Ec2NetworkInterfaces_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + } + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..732896803af0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2NetworkInterfaces_Delete", + "operationId": "Ec2NetworkInterfaces_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Get.json new file mode 100644 index 000000000000..548740f3f2f2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Get.json @@ -0,0 +1,97 @@ +{ + "title": "Ec2NetworkInterfaces_Get", + "operationId": "Ec2NetworkInterfaces_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..f8bbd18999d4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "title": "Ec2NetworkInterfaces_ListByResourceGroup", + "operationId": "Ec2NetworkInterfaces_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListBySubscription.json new file mode 100644 index 000000000000..52508041f84b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "title": "Ec2NetworkInterfaces_ListBySubscription", + "operationId": "Ec2NetworkInterfaces_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Update.json new file mode 100644 index 000000000000..bf6b2aa65e2d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2NetworkInterfaces_Update.json @@ -0,0 +1,107 @@ +{ + "title": "Ec2NetworkInterfaces_Update", + "operationId": "Ec2NetworkInterfaces_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E887166A-190D-41D6-9F55-FB3849674080", + "resourceGroupName": "rgec2NetworkInterface", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6326": "yfsrjdai" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "connectionTrackingSpecification": { + "tcpEstablishedTimeout": 17, + "udpStreamTimeout": 8, + "udpTimeout": 23 + }, + "description": "rjfmatpnlpzafpjsvdifepkeompzpz", + "enablePrimaryIpv6": true, + "groupSet": [ + "dqnxzfzzixpqqapipgobuepnptfi" + ], + "id": "djkpriel", + "interfaceType": "osohhzoujznxwq", + "ipv4PrefixCount": 18, + "ipv4Prefixes": [ + { + "ipv4Prefix": "gptczjajfvxavzpalq" + } + ], + "ipv6AddressCount": 21, + "ipv6Addresses": [ + { + "ipv6Address": "yltzjtkgfhbhokimzn" + } + ], + "ipv6PrefixCount": 1, + "ipv6Prefixes": [ + { + "ipv6Prefix": "srpldhvaafcozyarpechevrnxlf" + } + ], + "primaryIpv6Address": "uoblo", + "primaryPrivateIpAddress": "qyowqxftdeptwmjwfa", + "privateIpAddress": "qicwhumw", + "privateIpAddresses": [ + { + "primary": true, + "privateIpAddress": "mmkedmvsclcwfvlvx" + } + ], + "secondaryPrivateIpAddressCount": 9, + "secondaryPrivateIpAddresses": [ + "mkvwjalereuiy" + ], + "sourceDestCheck": true, + "subnetId": "wfyytldstgkdpoffxak", + "tags": [ + { + "key": "ecbkgvgrwffyykfpbghbipmg", + "value": "zlzzwcqgyuoe" + } + ], + "vpcId": "ykqkegxxhqsw" + }, + "publicCloudConnectorsResourceId": "ottcocnvajfifabmlw", + "awsAccountId": "gjylibjqfzkkx", + "arn": "nmgqcimbhzksweqtns", + "publicCloudResourceName": "pjjwxtuejzskysxlytlrcqegfkuydf", + "awsSourceSchema": "smaakwcpvp", + "awsRegion": "dpghaxzupmkfwbvir", + "awsTags": { + "key190": "coungxpxexmyovmnasvh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2520": "ui" + }, + "location": "lagtstrmaffl", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2NetworkInterfaces/{resourceName}", + "name": "huvphvhqg", + "type": "nk", + "systemData": { + "createdBy": "echmumeqmybhredkmgruwrzzxh", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:54.613Z", + "lastModifiedBy": "pevscdfyxbkowlfoiptmr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:54.614Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_CreateOrReplace.json new file mode 100644 index 000000000000..e98c4c447e8b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "Ec2RouteTables_CreateOrReplace", + "operationId": "Ec2RouteTables_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + } + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Delete.json new file mode 100644 index 000000000000..298eabe0f837 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2RouteTables_Delete", + "operationId": "Ec2RouteTables_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Get.json new file mode 100644 index 000000000000..95c8fa2a82cb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Get.json @@ -0,0 +1,53 @@ +{ + "title": "Ec2RouteTables_Get", + "operationId": "Ec2RouteTables_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListByResourceGroup.json new file mode 100644 index 000000000000..7ef01bb877e4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2RouteTables_ListByResourceGroup", + "operationId": "Ec2RouteTables_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + ], + "nextLink": "https://microsoft.com/ajb" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListBySubscription.json new file mode 100644 index 000000000000..13a6996e534b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "Ec2RouteTables_ListBySubscription", + "operationId": "Ec2RouteTables_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + ], + "nextLink": "https://microsoft.com/ajb" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Update.json new file mode 100644 index 000000000000..5d3b3aaaa476 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2RouteTables_Update.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2RouteTables_Update", + "operationId": "Ec2RouteTables_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DE2F55E6-08F8-416F-A948-BE411C35FCF5", + "resourceGroupName": "rgec2RouteTable", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9656": "qcdyodtyhafniokwmpyrtscnmlbu" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "routeTableId": "wjkircnwaktkmbnrmuglladvcdghmn", + "tags": [ + { + "key": "jeqm", + "value": "ywbmagghbowtrgxkmnquatuohxj" + } + ], + "vpcId": "ndnaspemjnmztnyriemuybzp" + }, + "publicCloudConnectorsResourceId": "kaqsj", + "awsAccountId": "xlalfcqnhp", + "arn": "eyazamslrmbbffijotyuugdepfsn", + "publicCloudResourceName": "ierypwmwselkslavwkgcmz", + "awsSourceSchema": "usgtqolcmcjynbdhavnneb", + "awsRegion": "tmqwjtpadpygxhke", + "awsTags": { + "key7743": "osantdzwyijo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8794": "fhmajayysunpshosadan" + }, + "location": "hovrzjhgmyvotekfhnhfmvlcak", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2RouteTables/{resourceName}", + "name": "dforujria", + "type": "scacnkiuzsjxotxguqmv", + "systemData": { + "createdBy": "wfpzjgjtndnvcweqtjajzppg", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:21.583Z", + "lastModifiedBy": "kmmifrgpgsfpthiav", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:21.583Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_CreateOrReplace.json new file mode 100644 index 000000000000..e7a16e7a79e0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_CreateOrReplace.json @@ -0,0 +1,349 @@ +{ + "title": "Ec2SecurityGroups_CreateOrReplace", + "operationId": "Ec2SecurityGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + } + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Delete.json new file mode 100644 index 000000000000..b49e35b31274 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2SecurityGroups_Delete", + "operationId": "Ec2SecurityGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Get.json new file mode 100644 index 000000000000..1228296a401a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Get.json @@ -0,0 +1,128 @@ +{ + "title": "Ec2SecurityGroups_Get", + "operationId": "Ec2SecurityGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..5c29b4070148 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "title": "Ec2SecurityGroups_ListByResourceGroup", + "operationId": "Ec2SecurityGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + ], + "nextLink": "https://microsoft.com/ak" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListBySubscription.json new file mode 100644 index 000000000000..ff4a02fca702 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_ListBySubscription.json @@ -0,0 +1,131 @@ +{ + "title": "Ec2SecurityGroups_ListBySubscription", + "operationId": "Ec2SecurityGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + ], + "nextLink": "https://microsoft.com/ak" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Update.json new file mode 100644 index 000000000000..a21444b12896 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2SecurityGroups_Update.json @@ -0,0 +1,138 @@ +{ + "title": "Ec2SecurityGroups_Update", + "operationId": "Ec2SecurityGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "BF087077-D63B-4728-A6EC-2CC4FF4CC1A5", + "resourceGroupName": "rgec2SecurityGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3161": "pirvmhaosavvjlkhaio" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "hrrgskumwbylhgekdhngxjvwdnwt", + "groupId": "ljankmjnfyn", + "groupName": "btdfjlqbavbhlssltk", + "ipPermissions": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ipPermissionsEgress": [ + { + "fromPort": 20, + "ipProtocol": "kgjdillfenc", + "ipRanges": [ + { + "cidrIp": "bvmbvmljqvxtixhffwasjzntbuc", + "description": "shzjegnqjhifwjai" + } + ], + "ipv6Ranges": [ + { + "cidrIpv6": "uxlvmqqyfplqdqzolxmmnclvmtd", + "description": "iqaupyjrvko" + } + ], + "prefixListIds": [ + { + "description": "chukmrsgeaica", + "prefixListId": "abvyhxeqhgiuwfmdproas" + } + ], + "toPort": 22, + "userIdGroupPairs": [ + { + "description": "ltskpjkztpi", + "groupId": "laktgsfwgfj", + "groupName": "rrnebynwgsv", + "peeringStatus": "t", + "userId": "chhl", + "vpcId": "jxcofqkxxcehakoymxojgpra", + "vpcPeeringConnectionId": "vdqrycsnfuwkgftprwierfwv" + } + ] + } + ], + "ownerId": "zjetpuydwcwvcujxzfp", + "tags": [ + { + "key": "qujkc", + "value": "jflpondfk" + } + ], + "vpcId": "prgpmjbyqcuinimbjrzfmpmme" + }, + "publicCloudConnectorsResourceId": "fuzo", + "awsAccountId": "opjbipitrztwvqiwhvypn", + "arn": "wmn", + "publicCloudResourceName": "laxwpziyjookzz", + "awsSourceSchema": "qdcuf", + "awsRegion": "hqrasnkghl", + "awsTags": { + "key5646": "rkutxmprvwlawcnhzsmyyujz" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9265": "ixznafanbltkovpv" + }, + "location": "vzuwiygrafixnatwfk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2SecurityGroups/{resourceName}", + "name": "oakxphunkdsdpxwzzb", + "type": "xxqourxfytrbasoasmwwszfqn", + "systemData": { + "createdBy": "qwqfhnottknvpvbvfbaulimsrfxtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:19.865Z", + "lastModifiedBy": "nrikt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:19.865Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_CreateOrReplace.json new file mode 100644 index 000000000000..80f5d96d4a62 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "Ec2Snapshots_CreateOrReplace", + "operationId": "Ec2Snapshots_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + } + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Delete.json new file mode 100644 index 000000000000..5941d3de6c31 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Snapshots_Delete", + "operationId": "Ec2Snapshots_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Get.json new file mode 100644 index 000000000000..aea7f7d5bf0c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Get.json @@ -0,0 +1,74 @@ +{ + "title": "Ec2Snapshots_Get", + "operationId": "Ec2Snapshots_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListByResourceGroup.json new file mode 100644 index 000000000000..1617e1fe7fb6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "Ec2Snapshots_ListByResourceGroup", + "operationId": "Ec2Snapshots_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListBySubscription.json new file mode 100644 index 000000000000..047d1a278eaa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2Snapshots_ListBySubscription", + "operationId": "Ec2Snapshots_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Update.json new file mode 100644 index 000000000000..641914bf9321 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Snapshots_Update.json @@ -0,0 +1,84 @@ +{ + "title": "Ec2Snapshots_Update", + "operationId": "Ec2Snapshots_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "6EDC0C94-8062-4712-B8B7-7F3532BA639A", + "resourceGroupName": "rgec2Snapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9290": "rhda" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataEncryptionKeyId": "mhxbzyyikypulohbdxtpoldzxm", + "description": "tsduasxksmdr", + "encrypted": true, + "kmsKeyId": "djnzahvxonsnocqhz", + "outpostArn": "vpqkamzadulbg", + "ownerAlias": "bmfwdqpzxg", + "ownerId": "xudlgprkedlmxatpupwvaknlkxfs", + "progress": "ecdblvtjkixoklgjh", + "restoreExpiryTime": "2024-10-08T03:53:51.251Z", + "snapshotId": "lpcr", + "sseType": { + "value": "none" + }, + "startTime": "2024-10-08T03:53:51.251Z", + "state": { + "value": "completed" + }, + "stateMessage": "nogwovxkgpjylsijzipkpqzxpvjh", + "storageTier": { + "value": "archive" + }, + "tags": [ + { + "key": "xjeeorwcwraovqjs", + "value": "vjhh" + } + ], + "volumeId": "rzepawgzsvqncqbpjxnijhwofbgc", + "volumeSize": 3 + }, + "publicCloudConnectorsResourceId": "bfcselosmakgrkibu", + "awsAccountId": "iizqmtavivxapbfqrqqrauezng", + "arn": "z", + "publicCloudResourceName": "eyltdaumfqmdgmnlwpgjhjlavikc", + "awsSourceSchema": "gmzpssyyjoqqnqjxwcluwnyrswywcv", + "awsRegion": "yylufbdgujuqmqwhscnglwsa", + "awsTags": { + "key9124": "okxaaygyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9392": "chbsxcwosjxo" + }, + "location": "kqbtvnmdasfajwylafmkah", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Snapshots/{resourceName}", + "name": "ewnypudielhizpefkqlexr", + "type": "tjppzo", + "systemData": { + "createdBy": "tvkgmrazgxgufbpuvjgecdpfk", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:51.252Z", + "lastModifiedBy": "yyjkselgwgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:51.252Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_CreateOrReplace.json new file mode 100644 index 000000000000..d0b3e7cc8b94 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_CreateOrReplace.json @@ -0,0 +1,193 @@ +{ + "title": "Ec2Subnets_CreateOrReplace", + "operationId": "Ec2Subnets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + } + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Delete.json new file mode 100644 index 000000000000..e54825235c1b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Subnets_Delete", + "operationId": "Ec2Subnets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Get.json new file mode 100644 index 000000000000..4353780f4b49 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Get.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Subnets_Get", + "operationId": "Ec2Subnets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListByResourceGroup.json new file mode 100644 index 000000000000..12da4001818f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "Ec2Subnets_ListByResourceGroup", + "operationId": "Ec2Subnets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListBySubscription.json new file mode 100644 index 000000000000..77d0c5320550 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "Ec2Subnets_ListBySubscription", + "operationId": "Ec2Subnets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Update.json new file mode 100644 index 000000000000..985afe0a4d0f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Subnets_Update.json @@ -0,0 +1,86 @@ +{ + "title": "Ec2Subnets_Update", + "operationId": "Ec2Subnets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A7B87543-3525-4160-A527-2ABF10C6EEB3", + "resourceGroupName": "rgec2Subnet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1062": "onsypwaxapyschj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "assignIpv6AddressOnCreation": true, + "availabilityZone": "forrknmiozum", + "availabilityZoneId": "gbjfdurjqxgejgwo", + "cidrBlock": "sisksglodnipqskrsfsvkpcrrcy", + "enableDns64": true, + "enableLniAtDeviceIndex": 1, + "ipv4IpamPoolId": "jdpbqiv", + "ipv4NetmaskLength": 18, + "ipv6CidrBlock": "ayzvyvftxekjogtumuln", + "ipv6CidrBlocks": [ + "amuwewdpaadfixhakcdaqrjzlskguz" + ], + "ipv6IpamPoolId": "lenenhwtwwet", + "ipv6Native": true, + "ipv6NetmaskLength": 16, + "mapPublicIpOnLaunch": true, + "networkAclAssociationId": "saevhbbbzksuojanmdoizrhyxo", + "outpostArn": "qzuvnwxqc", + "privateDnsNameOptionsOnLaunch": { + "enableResourceNameDnsAAAARecord": true, + "enableResourceNameDnsARecord": true, + "hostnameType": "cbuc" + }, + "subnetId": "vxxbkvimjzmcfoxur", + "tags": [ + { + "key": "sffepghmsdrubyiodc", + "value": "bfgzdnenxrviyueqzftrrvu" + } + ], + "vpcId": "aqqzsoyvmaxfyqddvthvxlhdti" + }, + "publicCloudConnectorsResourceId": "svkjfvphtfxopebxrcdvwyj", + "awsAccountId": "mmlzefobqbimxcbqwrkitlgfu", + "arn": "swrduvxfquidiycxlrijjixfbwb", + "publicCloudResourceName": "p", + "awsSourceSchema": "wyjdcprcwjbw", + "awsRegion": "huifdbndfvqyztfwfclpqlxupzib", + "awsTags": { + "key3667": "ydqfhlcswoexpb" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8525": "tpogejwctbas" + }, + "location": "zlyeymkfsbtninhfrnvrhxprr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Subnets/{resourceName}", + "name": "urmilmqjfvqbhtfltmnc", + "type": "rmyhqgvacnwlkdsqywjzxktnu", + "systemData": { + "createdBy": "ew", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:01.875Z", + "lastModifiedBy": "cohuh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:01.875Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_CreateOrReplace.json new file mode 100644 index 000000000000..2ab22ce4a2ae --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "Ec2Volumes_CreateOrReplace", + "operationId": "Ec2Volumes_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + } + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Delete.json new file mode 100644 index 000000000000..17d5842aeb0e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Volumes_Delete", + "operationId": "Ec2Volumes_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Get.json new file mode 100644 index 000000000000..122992bb74d8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Get.json @@ -0,0 +1,63 @@ +{ + "title": "Ec2Volumes_Get", + "operationId": "Ec2Volumes_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListByResourceGroup.json new file mode 100644 index 000000000000..ef4aff77b31b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2Volumes_ListByResourceGroup", + "operationId": "Ec2Volumes_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + ], + "nextLink": "https://microsoft.com/azolzog" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListBySubscription.json new file mode 100644 index 000000000000..c85a6e02202d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Volumes_ListBySubscription", + "operationId": "Ec2Volumes_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + ], + "nextLink": "https://microsoft.com/azolzog" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Update.json new file mode 100644 index 000000000000..a38fb88fb334 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Volumes_Update.json @@ -0,0 +1,73 @@ +{ + "title": "Ec2Volumes_Update", + "operationId": "Ec2Volumes_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "093B1075-6A97-47AC-9A34-58430572D6AC", + "resourceGroupName": "rgec2Volume", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2751": "bwfiobg" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoEnableIO": true, + "availabilityZone": "wtzdrwiuscqtvxwi", + "encrypted": true, + "iops": 3, + "kmsKeyId": "brtkdxsrwuxdzodllqlhzbrwpgkx", + "multiAttachEnabled": true, + "outpostArn": "umrirqwmsnmeeknbjkph", + "size": 2, + "snapshotId": "upwukogzrkqcaea", + "tags": [ + { + "key": "hizjca", + "value": "hnfhwndsnhbpnwfv" + } + ], + "throughput": 20, + "volumeId": "rdcojpg", + "volumeType": "otkmglqvqws" + }, + "publicCloudConnectorsResourceId": "fw", + "awsAccountId": "zoosbunhmv", + "arn": "evx", + "publicCloudResourceName": "xowgb", + "awsSourceSchema": "wlglq", + "awsRegion": "cw", + "awsTags": { + "key2425": "rgrfhhzzndrgf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key271": "ntenfvupathlqgnlukxvtzwzbmj" + }, + "location": "tvdnvkrfzxnahsvnguhrcancxusw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Volumes/{resourceName}", + "name": "fgfntrewk", + "type": "npytyqzj", + "systemData": { + "createdBy": "teshawjskiktjbrickhkttjmfwcrtu", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:49.388Z", + "lastModifiedBy": "iflhlzzfswcguhxqiyqj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:49.389Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_CreateOrReplace.json new file mode 100644 index 000000000000..f0c5c74cc07c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "Ec2VpcEndpoints_CreateOrReplace", + "operationId": "Ec2VpcEndpoints_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + } + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Delete.json new file mode 100644 index 000000000000..0652a0211166 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2VpcEndpoints_Delete", + "operationId": "Ec2VpcEndpoints_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Get.json new file mode 100644 index 000000000000..3450b7b5c825 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Get.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2VpcEndpoints_Get", + "operationId": "Ec2VpcEndpoints_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListByResourceGroup.json new file mode 100644 index 000000000000..477aba117454 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "Ec2VpcEndpoints_ListByResourceGroup", + "operationId": "Ec2VpcEndpoints_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListBySubscription.json new file mode 100644 index 000000000000..562bb3a38a0a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2VpcEndpoints_ListBySubscription", + "operationId": "Ec2VpcEndpoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Update.json new file mode 100644 index 000000000000..db55153bbef1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcEndpoints_Update.json @@ -0,0 +1,77 @@ +{ + "title": "Ec2VpcEndpoints_Update", + "operationId": "Ec2VpcEndpoints_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7B728B82-BFDB-450F-9629-73444492FAED", + "resourceGroupName": "rgec2VPCEndpoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7567": "dieflmamsskecyh" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "creationTimestamp": "wmawquyzuhbnkrveo", + "dnsEntries": [ + "kenhegadrd" + ], + "id": "xfylmv", + "networkInterfaceIds": [ + "uvzbeqj" + ], + "policyDocument": {}, + "privateDnsEnabled": true, + "routeTableIds": [ + "ybkagmpjwuixbpltpabcrwewbjgj" + ], + "securityGroupIds": [ + "swfhjyallivwkmzqdyqsgitfilel" + ], + "serviceName": "bltgximadajrfctijpznsmxgy", + "subnetIds": [ + "oyfzvlrnugigsjyadmdpjblsgpcxkr" + ], + "vpcEndpointType": "Gateway", + "vpcId": "ebbnplgbjkbqfifbmbrii" + }, + "publicCloudConnectorsResourceId": "lyxajxyfvrugpvxchbigrlulomftou", + "awsAccountId": "wtjkq", + "arn": "cxdwblbwakjiwxs", + "publicCloudResourceName": "zwgwsjbodssxgzq", + "awsSourceSchema": "mpgbtkugoucwqsqzzchrl", + "awsRegion": "hmnjtlhnkmnlwcuykbighvnvnjc", + "awsTags": { + "key7370": "ru" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8512": "flakqatnfqyuqukrwcy" + }, + "location": "kkohg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCEndpoints/{resourceName}", + "name": "gwdblodylojmzwamkvkhborn", + "type": "kpejamx", + "systemData": { + "createdBy": "lmf", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:41.067Z", + "lastModifiedBy": "clmbejvebbmuatqcmhm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:41.067Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_CreateOrReplace.json new file mode 100644 index 000000000000..05775c4a5303 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "Ec2VpcPeeringConnections_CreateOrReplace", + "operationId": "Ec2VpcPeeringConnections_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + } + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Delete.json new file mode 100644 index 000000000000..c321df60e88d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2VpcPeeringConnections_Delete", + "operationId": "Ec2VpcPeeringConnections_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Get.json new file mode 100644 index 000000000000..c051560f7656 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Get.json @@ -0,0 +1,57 @@ +{ + "title": "Ec2VpcPeeringConnections_Get", + "operationId": "Ec2VpcPeeringConnections_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..b90c39e5e6ee --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "Ec2VpcPeeringConnections_ListByResourceGroup", + "operationId": "Ec2VpcPeeringConnections_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListBySubscription.json new file mode 100644 index 000000000000..e8f0b19bec07 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "Ec2VpcPeeringConnections_ListBySubscription", + "operationId": "Ec2VpcPeeringConnections_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Update.json new file mode 100644 index 000000000000..50e5040afcf7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2VpcPeeringConnections_Update.json @@ -0,0 +1,67 @@ +{ + "title": "Ec2VpcPeeringConnections_Update", + "operationId": "Ec2VpcPeeringConnections_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0EBC94CA-4490-4649-84E1-595BD9213284", + "resourceGroupName": "rgec2VPCPeeringConnection", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4874": "wcyzrmbcyrznrbumoexbxplkl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "id": "emsfznbbfejdwouyracpg", + "peerOwnerId": "ddjymdvquwsrdt", + "peerRegion": "qcbhjmbddzbcs", + "peerRoleArn": "kaophgngiqxorpifcluz", + "peerVpcId": "ccurncyuawhicumwcxxnmuq", + "tags": [ + { + "key": "quljgbamnwrovfxsxjeyymnt", + "value": "xgzluroiobmj" + } + ], + "vpcId": "lkitywfkos" + }, + "publicCloudConnectorsResourceId": "jlenaffdnxswiytzyfvbfjfghuf", + "awsAccountId": "digeyffuemunjngxz", + "arn": "dxhchlgpyvhsexomfqaj", + "publicCloudResourceName": "ackzpztj", + "awsSourceSchema": "pfevychrftkuamvlorm", + "awsRegion": "qgrfrceaszbzvo", + "awsTags": { + "key8493": "juqefkwaorgfmwqzktgjos" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6160": "pgblenahxpyuppjtrhgaqsoabsr" + }, + "location": "lqfmwbb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2VPCPeeringConnections/{resourceName}", + "name": "iqnkjibwefldpplqrvzjt", + "type": "fwpnaartzj", + "systemData": { + "createdBy": "qhrwutkdzvevxrwoucetlkjlh", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:47.454Z", + "lastModifiedBy": "uokqsfzexex", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:47.454Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_CreateOrReplace.json new file mode 100644 index 000000000000..fc5c12ed0eb7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_CreateOrReplace.json @@ -0,0 +1,163 @@ +{ + "title": "Ec2Vpcs_CreateOrReplace", + "operationId": "Ec2Vpcs_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + } + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Delete.json new file mode 100644 index 000000000000..a824a84e0a82 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Ec2Vpcs_Delete", + "operationId": "Ec2Vpcs_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Get.json new file mode 100644 index 000000000000..787208753143 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Get.json @@ -0,0 +1,66 @@ +{ + "title": "Ec2Vpcs_Get", + "operationId": "Ec2Vpcs_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListByResourceGroup.json new file mode 100644 index 000000000000..0dcb3b4f6108 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "title": "Ec2Vpcs_ListByResourceGroup", + "operationId": "Ec2Vpcs_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListBySubscription.json new file mode 100644 index 000000000000..6c98c5b35eec --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_ListBySubscription.json @@ -0,0 +1,69 @@ +{ + "title": "Ec2Vpcs_ListBySubscription", + "operationId": "Ec2Vpcs_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Update.json new file mode 100644 index 000000000000..4afa0025a39e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Ec2Vpcs_Update.json @@ -0,0 +1,76 @@ +{ + "title": "Ec2Vpcs_Update", + "operationId": "Ec2Vpcs_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "96FD8C56-CEDB-4C44-A682-F267A69A64F6", + "resourceGroupName": "rgec2Vpc", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5864": "bqtbbunnw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "cidrBlock": "amstuguadqkmlmofdszmxhgssf", + "cidrBlockAssociations": [ + "ykwdexxzxjxowuuawym" + ], + "defaultNetworkAcl": "lhtepidfpfsyxksnvekueeyvw", + "defaultSecurityGroup": "qtqgizvsvzdqxmbwwpmtcnqlfuh", + "enableDnsHostnames": true, + "enableDnsSupport": true, + "instanceTenancy": "haqdsdkgbjmnwdgamqs", + "ipv4IpamPoolId": "ldzbfvpzpwudqtdyb", + "ipv4NetmaskLength": 21, + "ipv6CidrBlocks": [ + "q" + ], + "tags": [ + { + "key": "dn", + "value": "tqvkxdrwsaxvxwckrpqk" + } + ], + "vpcId": "wqqqqmtbgzmdfmkiaoyjdkavuzzzzw" + }, + "publicCloudConnectorsResourceId": "hpzdeuzmjfwatmynigq", + "awsAccountId": "vskthos", + "arn": "isskkecektndkosbruasgvkakzf", + "publicCloudResourceName": "qjwdilmlbbam", + "awsSourceSchema": "vnjplxwhapuaydjjdqiaqfvbfjam", + "awsRegion": "paraxj", + "awsTags": { + "key96": "hjcp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2430": "wsbwsruiakoihittdhcmmwrjmft" + }, + "location": "bcrtgodiyozdsiqbhdvsaaog", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Ec2Vpcs/{resourceName}", + "name": "dey", + "type": "brcqogpwehmgqcvukfmzbbcwcre", + "systemData": { + "createdBy": "mohifqfwaozwyqatpukprmthycndgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:55.759Z", + "lastModifiedBy": "rlryipquiok", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:55.760Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_CreateOrReplace.json new file mode 100644 index 000000000000..084b4195e0b2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_CreateOrReplace.json @@ -0,0 +1,172 @@ +{ + "title": "EcrImageDetails_CreateOrReplace", + "operationId": "EcrImageDetails_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + } + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Delete.json new file mode 100644 index 000000000000..b187c646b738 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcrImageDetails_Delete", + "operationId": "EcrImageDetails_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Get.json new file mode 100644 index 000000000000..6f015adfe997 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Get.json @@ -0,0 +1,69 @@ +{ + "title": "EcrImageDetails_Get", + "operationId": "EcrImageDetails_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListByResourceGroup.json new file mode 100644 index 000000000000..d25eadf96455 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "title": "EcrImageDetails_ListByResourceGroup", + "operationId": "EcrImageDetails_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListBySubscription.json new file mode 100644 index 000000000000..9109ff90378d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_ListBySubscription.json @@ -0,0 +1,72 @@ +{ + "title": "EcrImageDetails_ListBySubscription", + "operationId": "EcrImageDetails_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Update.json new file mode 100644 index 000000000000..4a27c8fab8a9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrImageDetails_Update.json @@ -0,0 +1,79 @@ +{ + "title": "EcrImageDetails_Update", + "operationId": "EcrImageDetails_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "58AD212A-6CE7-4C8C-8D84-481ADED9D9C1", + "resourceGroupName": "rgecrImageDetail", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5066": "opul" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "artifactMediaType": "ciuahpzw", + "imageDigest": "mfgr", + "imageManifestMediaType": "arzsyssziqvvryqc", + "imagePushedAt": "2024-10-08T03:51:24.487Z", + "imageScanFindingsSummary": { + "findingSeverityCounts": { + "key9764": 10 + }, + "imageScanCompletedAt": "2024-10-08T03:51:24.488Z", + "vulnerabilitySourceUpdatedAt": "2024-10-08T03:51:24.488Z" + }, + "imageScanStatus": { + "description": "kvsqwhxzrnciqybnl", + "status": { + "value": "ACTIVE" + } + }, + "imageSizeInBytes": 18, + "imageTags": [ + "bwikpoljnmaoewepiunoltcxlyxd" + ], + "lastRecordedPullTime": "2024-10-08T03:51:24.488Z", + "registryId": "xpxtbbeejeosvtcvq", + "repositoryName": "abftxvvazyfekkcpo" + }, + "publicCloudConnectorsResourceId": "glrdicxdaktwlkvgvxurgww", + "awsAccountId": "yqyxjsfibyscdhyofmyu", + "arn": "dhvgwgtedzuiqdvgc", + "publicCloudResourceName": "gijthpfhduauuus", + "awsSourceSchema": "ibsdsdpuiqcwsdxqfn", + "awsRegion": "atlamkemuqwaezwdsuavhaqo", + "awsTags": { + "key4659": "sgfdrvhgloyrvwyfqxyvzmhu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9132": "faznbwmprsja" + }, + "location": "mpxszpyclsniahaoqerqewrzxyzcdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrImageDetails/{resourceName}", + "name": "txgcvtvpadhbmhr", + "type": "xlji", + "systemData": { + "createdBy": "sfhejaqardlzdodjs", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:24.489Z", + "lastModifiedBy": "bvkgbxxtfxu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:24.489Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_CreateOrReplace.json new file mode 100644 index 000000000000..c2d29299e1b5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "EcrRepositories_CreateOrReplace", + "operationId": "EcrRepositories_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + } + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Delete.json new file mode 100644 index 000000000000..5efd618ef00c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcrRepositories_Delete", + "operationId": "EcrRepositories_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Get.json new file mode 100644 index 000000000000..f194249ec620 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Get.json @@ -0,0 +1,68 @@ +{ + "title": "EcrRepositories_Get", + "operationId": "EcrRepositories_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListByResourceGroup.json new file mode 100644 index 000000000000..9e3f870206be --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "EcrRepositories_ListByResourceGroup", + "operationId": "EcrRepositories_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListBySubscription.json new file mode 100644 index 000000000000..c5cd3f1cc365 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "EcrRepositories_ListBySubscription", + "operationId": "EcrRepositories_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Update.json new file mode 100644 index 000000000000..bc995bce1f9e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcrRepositories_Update.json @@ -0,0 +1,78 @@ +{ + "title": "EcrRepositories_Update", + "operationId": "EcrRepositories_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "467192B0-A80B-4D31-AF49-7AE7B808CAC3", + "resourceGroupName": "rgecrRepository", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2760": "sdwhuflvnahjhywxmi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "su", + "emptyOnDelete": true, + "encryptionConfiguration": { + "encryptionType": "AES256", + "kmsKey": "makuyxbheshwvqbxpzdimnbpgvmpj" + }, + "imageScanningConfiguration": { + "scanOnPush": true + }, + "imageTagMutability": "IMMUTABLE", + "lifecyclePolicy": { + "lifecyclePolicyText": "xvazgvi", + "registryId": "oluqsenexubjydpyaw" + }, + "repositoryName": "iuhxuyfxygvumphlcwhnsscudjez", + "repositoryPolicyText": {}, + "repositoryUri": "vmljyfyskxbyjczax", + "tags": [ + { + "key": "moogqsaqjqbgghbindkarxdgqqna", + "value": "qu" + } + ] + }, + "publicCloudConnectorsResourceId": "ohtcynikymmfceroreix", + "awsAccountId": "iuomdzpobqirucabbxz", + "arn": "djb", + "publicCloudResourceName": "bymfiroqkcgssnop", + "awsSourceSchema": "olwqyujnmxxhxwyp", + "awsRegion": "wliyvzjqcxbpwtgjae", + "awsTags": { + "key7950": "aybyysonysxvutpeysuxoeinx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2390": "rgv" + }, + "location": "uxqfbijfanljas", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcrRepositories/{resourceName}", + "name": "hroacoybjuvv", + "type": "dsvhk", + "systemData": { + "createdBy": "qnluwo", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.900Z", + "lastModifiedBy": "qkdtnmn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.900Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_CreateOrReplace.json new file mode 100644 index 000000000000..61ac34f34ad8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_CreateOrReplace.json @@ -0,0 +1,220 @@ +{ + "title": "EcsClusters_CreateOrReplace", + "operationId": "EcsClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + } + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Delete.json new file mode 100644 index 000000000000..b50d7f2493b7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsClusters_Delete", + "operationId": "EcsClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Get.json new file mode 100644 index 000000000000..1e2aaf57be3a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Get.json @@ -0,0 +1,85 @@ +{ + "title": "EcsClusters_Get", + "operationId": "EcsClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..c2b22bed25c1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListByResourceGroup.json @@ -0,0 +1,89 @@ +{ + "title": "EcsClusters_ListByResourceGroup", + "operationId": "EcsClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListBySubscription.json new file mode 100644 index 000000000000..8c3bab43a2cc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_ListBySubscription.json @@ -0,0 +1,88 @@ +{ + "title": "EcsClusters_ListBySubscription", + "operationId": "EcsClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Update.json new file mode 100644 index 000000000000..4dbdb5861fb4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsClusters_Update.json @@ -0,0 +1,95 @@ +{ + "title": "EcsClusters_Update", + "operationId": "EcsClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "17D6A687-78C8-4134-8C4B-8F09C88E9261", + "resourceGroupName": "rgecsCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key657": "dd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "mgzeckagdmmepybkhhylkhxzv", + "capacityProviders": [ + "rqrmclul" + ], + "clusterName": "eavbe", + "clusterSettings": [ + { + "name": "elsikbbzpkzaghwtqd", + "value": "gbnpceuced" + } + ], + "configuration": { + "executeCommandConfiguration": { + "kmsKeyId": "budbdglk", + "logConfiguration": { + "cloudWatchEncryptionEnabled": true, + "cloudWatchLogGroupName": "eiskop", + "s3BucketName": "sfcsij", + "s3EncryptionEnabled": true, + "s3KeyPrefix": "gfqnhjcnamxvhrllkzrzdbqzsnkj" + }, + "logging": "rspegmyokypfqdocdrothsgivaqf" + } + }, + "defaultCapacityProviderStrategy": [ + { + "base": 16, + "capacityProvider": "kttxptzsaauhguaygucxzzvrbriev", + "weight": 1 + } + ], + "serviceConnectDefaults": { + "namespace": "mwpjrqkazpcetkgyfplp" + }, + "tags": [ + { + "key": "pmgixnftvmfbxgjyulnrh", + "value": "dsvfiamfdrnwqretfcu" + } + ] + }, + "publicCloudConnectorsResourceId": "jbtlcmxmtlcgoxfktpqbi", + "awsAccountId": "emdtbelvualaeqexsrbhvczjsy", + "arn": "mpaxeywurctxasgtrtckgeoeqmeec", + "publicCloudResourceName": "nquaerebgaopkptxxbreyhr", + "awsSourceSchema": "dnbeeswitidsf", + "awsRegion": "qwurftmiaqdjvlbsxtmdosiauw", + "awsTags": { + "key3315": "bczizbtmiazzuhju" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1755": "o" + }, + "location": "jvggofkffzhlultqukgoqtb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsClusters/{resourceName}", + "name": "unezrtpygmickuuftycmdarakgw", + "type": "yzdiaxzb", + "systemData": { + "createdBy": "isn", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:43.264Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:43.264Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_CreateOrReplace.json new file mode 100644 index 000000000000..5ef25451b8c8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_CreateOrReplace.json @@ -0,0 +1,547 @@ +{ + "title": "EcsServices_CreateOrReplace", + "operationId": "EcsServices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + } + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Delete.json new file mode 100644 index 000000000000..4a7ed47db3d3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsServices_Delete", + "operationId": "EcsServices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Get.json new file mode 100644 index 000000000000..80feda57229a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Get.json @@ -0,0 +1,194 @@ +{ + "title": "EcsServices_Get", + "operationId": "EcsServices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListByResourceGroup.json new file mode 100644 index 000000000000..fa2d83f0d0c4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListByResourceGroup.json @@ -0,0 +1,198 @@ +{ + "title": "EcsServices_ListByResourceGroup", + "operationId": "EcsServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListBySubscription.json new file mode 100644 index 000000000000..2125444ad745 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_ListBySubscription.json @@ -0,0 +1,197 @@ +{ + "title": "EcsServices_ListBySubscription", + "operationId": "EcsServices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Update.json new file mode 100644 index 000000000000..18515f2c3e45 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsServices_Update.json @@ -0,0 +1,204 @@ +{ + "title": "EcsServices_Update", + "operationId": "EcsServices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B0F2EAB3-37AB-4B3B-A734-4E17D685A54C", + "resourceGroupName": "rgecsService", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8601": "aoipoqkrtxvtshttbllkc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacityProviderStrategy": [ + { + "base": 4, + "capacityProvider": "wlfpynlwozihqvkgynmdqqmojbs", + "weight": 28 + } + ], + "cluster": "rdbkmvsugiuvbwkuzagsnrx", + "deploymentConfiguration": { + "alarms": { + "alarmNames": [ + "cibbvixciizruhpdxhpkifpwsaq" + ], + "enable": true, + "rollback": true + }, + "deploymentCircuitBreaker": { + "enable": true, + "rollback": true + }, + "maximumPercent": 14, + "minimumHealthyPercent": 21 + }, + "deploymentController": { + "type": "CODE_DEPLOY" + }, + "desiredCount": 21, + "enableECSManagedTags": true, + "enableExecuteCommand": true, + "healthCheckGracePeriodSeconds": 1, + "launchType": "EC2", + "loadBalancers": [ + { + "containerName": "vjvntpnuzyftbm", + "containerPort": 17, + "loadBalancerName": "eryjxwmbfkms", + "targetGroupArn": "woxbyyccpmqyiy" + } + ], + "name": "vo", + "networkConfiguration": { + "awsvpcConfiguration": { + "assignPublicIp": "DISABLED", + "securityGroups": [ + "uoauevqyxylmvje" + ], + "subnets": [ + "gkqxeakxvyw" + ] + } + }, + "placementConstraints": [ + { + "expression": "hxzfzxbfmqqiwgbpgn", + "type": "distinctInstance" + } + ], + "placementStrategies": [ + { + "field": "tyrqdzgjrkwfhzwebvqld", + "type": "binpack" + } + ], + "platformVersion": "sfsqyvslsustugopfnnzssjli", + "propagateTags": "SERVICE", + "role": "te", + "schedulingStrategy": "DAEMON", + "serviceArn": "zuuoanjk", + "serviceConnectConfiguration": { + "enabled": true, + "logConfiguration": { + "logDriver": "xwshxwanyuqrfzboxwfv", + "secretOptions": [ + { + "name": "uxsxwquwbafmsmbyyivhsjrjmfpmim", + "valueFrom": "jnygsbiroyjlgrhs" + } + ] + }, + "namespace": "tlewpbulbuguuuvq", + "services": [ + { + "clientAliases": [ + { + "dnsName": "hnnavbjclqhbdebomjoqzo", + "port": 16 + } + ], + "discoveryName": "zuhijazofg", + "ingressPortOverride": 26, + "portName": "q", + "timeout": { + "idleTimeoutSeconds": 11, + "perRequestTimeoutSeconds": 22 + }, + "tls": { + "issuerCertificateAuthority": { + "awsPcaAuthorityArn": "fqrmk" + }, + "kmsKey": "jdjym", + "roleArn": "stdhwuiylmutipeonkolqjnbqelds" + } + } + ] + }, + "serviceName": "lyblywxxfszkgaaornuxliolfbft", + "serviceRegistries": [ + { + "containerName": "ppbxlxmpdbri", + "containerPort": 7, + "port": 6, + "registryArn": "qmfm" + } + ], + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ], + "taskDefinition": "fozrumijzejhpjxeqkmthsswwuden", + "volumeConfigurations": [ + { + "managedEBSVolume": { + "encrypted": true, + "filesystemType": "ugwxqcjnrqonyao", + "iops": 10, + "kmsKeyId": "oyuobklzhgpvg", + "roleArn": "gdudzczxymgopjjzqubzphgdi", + "sizeInGiB": 15, + "snapshotId": "yff", + "tagSpecifications": [ + { + "propagateTags": "SERVICE", + "resourceType": "tocxgkuiblcccawaenqv", + "tags": [ + { + "key": "dteknaijsygghfdplikegztgz", + "value": "qukd" + } + ] + } + ], + "throughput": 3, + "volumeType": "uwvjfmuzpksfpnfsukbunbuqcwxslx" + }, + "name": "zkqnipaoexthwwot" + } + ] + }, + "publicCloudConnectorsResourceId": "ghyukpeo", + "awsAccountId": "egkrtzylfud", + "arn": "advapj", + "publicCloudResourceName": "jumpzlzalckrkaqg", + "awsSourceSchema": "woodigpcfntomkursi", + "awsRegion": "pwmulwhqhosmbthwzammshywxzaxhi", + "awsTags": { + "key3094": "gxbzlhku" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8484": "nnsyti" + }, + "location": "xqpjwxermnqxbnitxykbnjhw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsServices/{resourceName}", + "name": "meuyovtzgqj", + "type": "hvhfvwnah", + "systemData": { + "createdBy": "bldpqsxjwdlstyohyf", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:12.309Z", + "lastModifiedBy": "szlretfmcxenzzfd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:12.310Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_CreateOrReplace.json new file mode 100644 index 000000000000..eb7bf605ff34 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_CreateOrReplace.json @@ -0,0 +1,844 @@ +{ + "title": "EcsTaskDefinitions_CreateOrReplace", + "operationId": "EcsTaskDefinitions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + } + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Delete.json new file mode 100644 index 000000000000..47e96480db14 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EcsTaskDefinitions_Delete", + "operationId": "EcsTaskDefinitions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Get.json new file mode 100644 index 000000000000..26038bbcf9df --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Get.json @@ -0,0 +1,293 @@ +{ + "title": "EcsTaskDefinitions_Get", + "operationId": "EcsTaskDefinitions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListByResourceGroup.json new file mode 100644 index 000000000000..1aea54f4f47a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListByResourceGroup.json @@ -0,0 +1,297 @@ +{ + "title": "EcsTaskDefinitions_ListByResourceGroup", + "operationId": "EcsTaskDefinitions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + ], + "nextLink": "https://microsoft.com/am" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListBySubscription.json new file mode 100644 index 000000000000..f2c29309d834 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_ListBySubscription.json @@ -0,0 +1,296 @@ +{ + "title": "EcsTaskDefinitions_ListBySubscription", + "operationId": "EcsTaskDefinitions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + ], + "nextLink": "https://microsoft.com/am" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Update.json new file mode 100644 index 000000000000..a08dc7cbcc44 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EcsTaskDefinitions_Update.json @@ -0,0 +1,303 @@ +{ + "title": "EcsTaskDefinitions_Update", + "operationId": "EcsTaskDefinitions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "619AF321-2D0A-4CAC-AD25-43FFAB35E97A", + "resourceGroupName": "rgecsTaskDefinition", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2531": "emmihvsstpbrxrsbykfncbdrvczwt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "containerDefinitions": [ + { + "command": [ + "jowixdtkttvhtvcluhzsqkcszit" + ], + "cpu": 17, + "credentialSpecs": [ + "ooravv" + ], + "dependsOn": [ + { + "condition": "xpmiwcexgnrimsrqyrdlvyyquiccp", + "containerName": "wzcyhuwwutzttwwaopqed" + } + ], + "disableNetworking": true, + "dnsSearchDomains": [ + "ggzzwoziotxloooklwdsveul" + ], + "dnsServers": [ + "ngggprelehukiysguto" + ], + "dockerSecurityOptions": [ + "famtfjusztdnyrdzupruqpxufhxp" + ], + "entryPoint": [ + "oaiompurpnjswlqkmvgraiaj" + ], + "environment": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "environmentFiles": [ + { + "type": "psgsoavpms", + "value": "ydkrwlbkbzqdm" + } + ], + "essential": true, + "extraHosts": [ + { + "hostname": "unpwutrc", + "ipAddress": "mcsjkhhqbwqesxwcpnnasbzamixath" + } + ], + "firelensConfiguration": { + "type": "uuwlwegjjeoorvbgtyzoaeeucp" + }, + "healthCheck": { + "command": [ + "ppgfrdhjiytbzqtwkumhmnpsk" + ], + "interval": 1, + "retries": 11, + "startPeriod": 21, + "timeout": 22 + }, + "hostname": "qjkxoayeojuesqmrhe", + "image": "lmgx", + "interactive": true, + "links": [ + "awgsbfcuoynoomjr" + ], + "linuxParameters": { + "capabilities": { + "add": [ + "xnobooaglhooafh" + ], + "drop": [ + "uscfx" + ] + }, + "devices": [ + { + "containerPath": "fveecgcpepimcqufoswgvjibavi", + "hostPath": "hvwxdqfcbt", + "permissions": [ + "yqev" + ] + } + ], + "initProcessEnabled": true, + "maxSwap": 24, + "sharedMemorySize": 1, + "swappiness": 27, + "tmpfs": [ + { + "containerPath": "kxvhyrbeu", + "mountOptions": [ + "lylxsszvvczykn" + ], + "size": 24 + } + ] + }, + "logConfiguration": { + "logDriver": "zgkgcxxggqdvrfngjbdapez", + "secretOptions": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ] + }, + "memory": 27, + "memoryReservation": 9, + "mountPoints": [ + { + "containerPath": "zjtchyyfjv", + "readOnly": true, + "sourceVolume": "mrimyrhpxx" + } + ], + "name": "tfseewfqlgwjqbkjikv", + "portMappings": [ + { + "appProtocol": "grpc", + "containerPort": 17, + "containerPortRange": "hwshvyttesxemvlis", + "hostPort": 13, + "name": "nbxxumpmur", + "protocol": "llczx" + } + ], + "privileged": true, + "pseudoTerminal": true, + "readonlyRootFilesystem": true, + "repositoryCredentials": { + "credentialsParameter": "pdwxhkhkkxjiwwcpkoiketthuw" + }, + "resourceRequirements": [ + { + "type": "yhtgxyeazgtpygnamvgtrt", + "value": "msamplxjlrq" + } + ], + "secrets": [ + { + "name": "knumytlyulndziptjvgvcpd", + "valueFrom": "z" + } + ], + "startTimeout": 10, + "stopTimeout": 24, + "systemControls": [ + { + "namespace": "hcwgpftfycwhenxygrbczcyqxh", + "value": "zzjkfgz" + } + ], + "ulimits": [ + { + "hardLimit": 16, + "name": "zswtamsvbvaxlueyfkklzaz", + "softLimit": 2 + } + ], + "user": "hosruyaojhjbh", + "volumesFrom": [ + { + "readOnly": true, + "sourceContainer": "ktlxxpz" + } + ], + "workingDirectory": "jpdgsckyvfez" + } + ], + "cpu": "hijyr", + "ephemeralStorage": { + "sizeInGiB": 17 + }, + "executionRoleArn": "qqqfakequmccjxadppbeamxuwsitta", + "family": "atzptqetfqeczglfyn", + "inferenceAccelerators": [ + { + "deviceName": "mh", + "deviceType": "zfkvyer" + } + ], + "ipcMode": "bynxyc", + "memory": "vwthlhlwlmwyoxowrumsld", + "networkMode": "vrvk", + "pidMode": "pthtbdouatcrybmke", + "placementConstraints": [ + { + "expression": "skxfvhirrtaegdaujr", + "type": "qnklizvyidxybjmtkgdzdls" + } + ], + "proxyConfiguration": { + "containerName": "tykmharv", + "proxyConfigurationProperties": [ + { + "name": "edrmixvb", + "value": "vdms" + } + ], + "type": "htnvhyjaffhosgiq" + }, + "requiresCompatibilities": [ + "lmugnbkpcgvmibqmoyeicudqghukxl" + ], + "runtimePlatform": { + "cpuArchitecture": "zcetkrsfadbflliirh", + "operatingSystemFamily": "topzpehesx" + }, + "tags": [ + { + "key": "sktncibpobzyad", + "value": "glazi" + } + ], + "taskDefinitionArn": "fpexhci", + "taskRoleArn": "vvebkfiglrktpmn", + "volumes": [ + { + "configuredAtLaunch": true, + "dockerVolumeConfiguration": { + "autoprovision": true, + "driver": "fdypjooligpeypyjkojhhnstigr", + "scope": "wourdwnfkwgitfhzywc" + }, + "efsVolumeConfiguration": { + "authorizationConfig": { + "accessPointId": "ipf", + "iam": "DISABLED" + }, + "filesystemId": "kyluffayszoviyute", + "rootDirectory": "vqogypwzwvlqikbwdhvy", + "transitEncryption": "DISABLED", + "transitEncryptionPort": 27 + }, + "fSxWindowsFileServerVolumeConfiguration": { + "authorizationConfig": { + "credentialsParameter": "ytxpomfevjkqfqrjp", + "domain": "igiaaxjfjdstgiwmurfycdsss" + }, + "fileSystemId": "gxcjekzhsm", + "rootDirectory": "bkbhxkwlfnslgnapevzhyvmfcdaup" + }, + "host": { + "sourcePath": "kgadnbxtebvbppaiqqkcmwcipqs" + }, + "name": "qslxsptvrywosrsnrdvo" + } + ] + }, + "publicCloudConnectorsResourceId": "zrnabgyobuzozcbzvgu", + "awsAccountId": "efgvyahxivjf", + "arn": "mkr", + "publicCloudResourceName": "mmhr", + "awsSourceSchema": "mvndrea", + "awsRegion": "vdwjcoqcepgcfqjeedexacghbqhz", + "awsTags": { + "key1568": "lbxzgpyhaleuetcbwtwotfxmsedkci" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6626": "nytjqmvhitrnxlmkyycses" + }, + "location": "hideafehihasfzxdxuqiqubhhzg", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EcsTaskDefinitions/{resourceName}", + "name": "j", + "type": "bt", + "systemData": { + "createdBy": "brilzguqfsdd", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:30.532Z", + "lastModifiedBy": "qsojsecg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:30.534Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_CreateOrReplace.json new file mode 100644 index 000000000000..fe0ec57de18f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_CreateOrReplace.json @@ -0,0 +1,214 @@ +{ + "title": "EfsFileSystems_CreateOrReplace", + "operationId": "EfsFileSystems_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + } + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Delete.json new file mode 100644 index 000000000000..2f69b26176ee --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EfsFileSystems_Delete", + "operationId": "EfsFileSystems_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Get.json new file mode 100644 index 000000000000..f04a01020ac1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Get.json @@ -0,0 +1,83 @@ +{ + "title": "EfsFileSystems_Get", + "operationId": "EfsFileSystems_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListByResourceGroup.json new file mode 100644 index 000000000000..cba4315ab760 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListByResourceGroup.json @@ -0,0 +1,87 @@ +{ + "title": "EfsFileSystems_ListByResourceGroup", + "operationId": "EfsFileSystems_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListBySubscription.json new file mode 100644 index 000000000000..f3cc17530477 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_ListBySubscription.json @@ -0,0 +1,86 @@ +{ + "title": "EfsFileSystems_ListBySubscription", + "operationId": "EfsFileSystems_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Update.json new file mode 100644 index 000000000000..d1c92904e859 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsFileSystems_Update.json @@ -0,0 +1,93 @@ +{ + "title": "EfsFileSystems_Update", + "operationId": "EfsFileSystems_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7E7D86A0-EE77-4A12-852B-81A2CDE2BB88", + "resourceGroupName": "rgefsFileSystem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5392": "lawsukb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "hptcgar", + "availabilityZoneName": "wnn", + "backupPolicy": { + "status": "DISABLED" + }, + "bypassPolicyLockoutSafetyCheck": true, + "encrypted": true, + "fileSystemId": "kublwmniiobukjozju", + "fileSystemProtection": { + "replicationOverwriteProtection": "DISABLED" + }, + "fileSystemTags": [ + { + "key": "glyisjhra", + "value": "gcz" + } + ], + "kmsKeyId": "qglx", + "lifecyclePolicies": [ + { + "transitionToArchive": "xsnpjovpiazmhefijlflijjycbugv", + "transitionToIA": "lslpvdwwgc", + "transitionToPrimaryStorageClass": "migoeoowupavauvyrljegu" + } + ], + "performanceMode": "gtcuhloqhqjvztxoqvnzhwejwqg", + "provisionedThroughputInMibps": 6, + "replicationConfiguration": { + "destinations": [ + { + "availabilityZoneName": "ymqufkisnklobowewikkugs", + "fileSystemId": "utzycscycyiunvfnsjwz", + "kmsKeyId": "afazkrebv", + "region": "bakyknetpfqoqpltuuxkauokslotb" + } + ] + }, + "throughputMode": "qiroscdbdjqkhezgxhfjiqd" + }, + "publicCloudConnectorsResourceId": "mhovamuukkqswmro", + "awsAccountId": "jkixa", + "arn": "pewusdrkpcuvxtmjhvzmakefatinq", + "publicCloudResourceName": "nhvnekfp", + "awsSourceSchema": "txcarqgbqzzvg", + "awsRegion": "quxdhbvdpdedfzbfp", + "awsTags": { + "key3062": "onkfpsohoske" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8058": "u" + }, + "location": "phxoujlvsqavkckotussgpnjgexvq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsFileSystems/{resourceName}", + "name": "kkynvzrhvzwbeiqixzxobskb", + "type": "wswhrcsmzbl", + "systemData": { + "createdBy": "m", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:43.979Z", + "lastModifiedBy": "yqansvjkapkdnxkwmvgugiehsoro", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:43.980Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_CreateOrReplace.json new file mode 100644 index 000000000000..24f8761a9757 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_CreateOrReplace.json @@ -0,0 +1,121 @@ +{ + "title": "EfsMountTargets_CreateOrReplace", + "operationId": "EfsMountTargets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + } + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Delete.json new file mode 100644 index 000000000000..8879153c57d0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EfsMountTargets_Delete", + "operationId": "EfsMountTargets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Get.json new file mode 100644 index 000000000000..247730ff8ce0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Get.json @@ -0,0 +1,52 @@ +{ + "title": "EfsMountTargets_Get", + "operationId": "EfsMountTargets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListByResourceGroup.json new file mode 100644 index 000000000000..c3c847ca8013 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "title": "EfsMountTargets_ListByResourceGroup", + "operationId": "EfsMountTargets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListBySubscription.json new file mode 100644 index 000000000000..81bb1f34bb45 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "title": "EfsMountTargets_ListBySubscription", + "operationId": "EfsMountTargets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Update.json new file mode 100644 index 000000000000..7d60bd811504 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EfsMountTargets_Update.json @@ -0,0 +1,62 @@ +{ + "title": "EfsMountTargets_Update", + "operationId": "EfsMountTargets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DEFAEFD7-72AD-49FD-BD05-7F8FBEE964B5", + "resourceGroupName": "rgefsMountTarget", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7998": "dgmfqhihmwujctuugirbw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "fileSystemId": "yyzhtbwsscfcaxuvdvmswchhxapky", + "id": "micgyhibjdexozpicbfsmpclu", + "ipAddress": "unspxdyqhrhlkstzmdrd", + "securityGroups": [ + "zxkzjhcwszqzfeogafiaub" + ], + "subnetId": "xbeontn" + }, + "publicCloudConnectorsResourceId": "rwszhgqustirkxkbk", + "awsAccountId": "iwvssztfldgfir", + "arn": "dtpqhenvexdxqcqscosxk", + "publicCloudResourceName": "bezmotdonashggkeobrc", + "awsSourceSchema": "gpkfqbbpywdedvyabzy", + "awsRegion": "lyvbqubwsgdvarrauygfhw", + "awsTags": { + "key5226": "lkjysnbiwwydewimdnpt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3687": "zubuxs" + }, + "location": "xaybj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EfsMountTargets/{resourceName}", + "name": "vnjlwafk", + "type": "rg", + "systemData": { + "createdBy": "ph", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:17.308Z", + "lastModifiedBy": "magczninhakvs", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:17.309Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_CreateOrReplace.json new file mode 100644 index 000000000000..66b7ff757fb0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_CreateOrReplace.json @@ -0,0 +1,386 @@ +{ + "title": "EksClusters_CreateOrReplace", + "operationId": "EksClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx", + "resource": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Delete.json new file mode 100644 index 000000000000..f342c4b0fcd6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Delete.json @@ -0,0 +1,16 @@ +{ + "title": "EksClusters_Delete", + "operationId": "EksClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Get.json new file mode 100644 index 000000000000..cc926b2d59b9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_Get.json @@ -0,0 +1,139 @@ +{ + "title": "EksClusters_Get", + "operationId": "EksClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_List.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_List.json new file mode 100644 index 000000000000..71a370f03d0b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksClusters_List.json @@ -0,0 +1,144 @@ +{ + "title": "EksClusters_List", + "operationId": "EksClusters_List", + "parameters": { + "api-version": "2024-12-01", + "resourceUri": "vutdhhavszx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessConfig": { + "authenticationMode": { + "value": "API" + }, + "bootstrapClusterCreatorAdminPermissions": true + }, + "arn": "hcepxlffwylmwulxcktedclqczlia", + "certificateAuthority": { + "data": "tlchvarrjfhilsdtsgqshctlli" + }, + "clientRequestToken": "zatyvyitnzgzpclfoxmzocvpc", + "connectorConfig": { + "activationCode": "pay", + "activationExpiry": "2024-10-08T03:50:52.459Z", + "activationId": "vmvmutvfuygzczgtsutkls", + "provider": "ngrakrrq", + "roleArn": "jcu" + }, + "createdAt": "2024-10-08T03:50:52.460Z", + "encryptionConfig": [ + { + "provider": { + "keyArn": "ynvyktdadcoepkg" + }, + "resources": [ + "luiywwdjzfsrozikidayeump" + ] + } + ], + "endpoint": "bvdvtunxiggcpmncdeflirifck", + "health": { + "issues": [ + { + "code": { + "value": "AccessDenied" + }, + "message": "mwtvogjihbqys", + "resourceIds": [ + "gnfkewljeibgooftzbraahnxysx" + ] + } + ] + }, + "id": "zmnyjrmqynglvrhpkkqkpazfyv", + "identity": { + "oidc": { + "issuer": "otiqmbvjucermteuonkxgdftf" + } + }, + "kubernetesNetworkConfig": { + "ipFamily": { + "value": "ipv4" + }, + "serviceIpv4Cidr": "llpoqidqkuhvzzwbkiynhrucvgglk", + "serviceIpv6Cidr": "nfdslge" + }, + "logging": { + "clusterLogging": [ + { + "enabled": true, + "types": [ + "api" + ] + } + ] + }, + "name": "fjvxhqvmvbshnltkuozc", + "outpostConfig": { + "controlPlaneInstanceType": "dbqfhwaxdzegqxqopkhaevcs", + "controlPlanePlacement": { + "groupName": "qrpyvhb" + }, + "outpostArns": [ + "lkvzvf" + ] + }, + "platformVersion": "ezmalzlqyiuhsxxdribckieg", + "resourcesVpcConfig": { + "clusterSecurityGroupId": "bkhbpbwyholvjxqzgxngfqvfim", + "endpointPrivateAccess": true, + "endpointPublicAccess": true, + "publicAccessCidrs": [ + "wjznm" + ], + "securityGroupIds": [ + "ljodkq" + ], + "subnetIds": [ + "pmazpgqowrfoi" + ], + "vpcId": "eoosrmen" + }, + "roleArn": "uvceqehkmdtkxgakuckm", + "status": { + "value": "ACTIVE" + }, + "tags": { + "key783": "hullzzbjeblerbopmncvydtkpcd" + }, + "version": "ngoffoetqqgv" + }, + "publicCloudConnectorsResourceId": "uadwidkemgzwde", + "awsAccountId": "sebsvgbgzb", + "arn": "xhoylvamhuqnvruh", + "publicCloudResourceName": "kqeiozkswbnhscn", + "awsSourceSchema": "gkfmtslfbglu", + "awsRegion": "urhi", + "awsTags": { + "key7789": "hxv" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksClusters/{resourceName}", + "name": "wlhloozwhakfmmafcdu", + "type": "ekkxmvooydeykaoy", + "systemData": { + "createdBy": "xlrei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:52.463Z", + "lastModifiedBy": "fydnbweljjnispg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:52.463Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_CreateOrReplace.json new file mode 100644 index 000000000000..40eb3501e40a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_CreateOrReplace.json @@ -0,0 +1,250 @@ +{ + "title": "EksNodegroups_CreateOrReplace", + "operationId": "EksNodegroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + } + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Delete.json new file mode 100644 index 000000000000..34bf7a269e34 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EksNodegroups_Delete", + "operationId": "EksNodegroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Get.json new file mode 100644 index 000000000000..b2901d0b47d9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Get.json @@ -0,0 +1,95 @@ +{ + "title": "EksNodegroups_Get", + "operationId": "EksNodegroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListByResourceGroup.json new file mode 100644 index 000000000000..daf38b990016 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListByResourceGroup.json @@ -0,0 +1,99 @@ +{ + "title": "EksNodegroups_ListByResourceGroup", + "operationId": "EksNodegroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListBySubscription.json new file mode 100644 index 000000000000..2e44d8b917b6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_ListBySubscription.json @@ -0,0 +1,98 @@ +{ + "title": "EksNodegroups_ListBySubscription", + "operationId": "EksNodegroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Update.json new file mode 100644 index 000000000000..232b1d317a9c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EksNodegroups_Update.json @@ -0,0 +1,105 @@ +{ + "title": "EksNodegroups_Update", + "operationId": "EksNodegroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "20B1BA4C-B0FE-4D65-A589-CE9F457FD840", + "resourceGroupName": "rgeksNodegroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2267": "ejnwsgjwwastrflkarwmrckdqi" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "amiType": "cupzyobvolczhkenpdfcfcqb", + "arn": "shesuqduavivrddwgrqtaukjv", + "capacityType": "pkzjnsykbn", + "clusterName": "qcbbidlhrczzbp", + "diskSize": 14, + "forceUpdateEnabled": true, + "id": "y", + "instanceTypes": [ + "gfy" + ], + "labels": { + "key8269": "ymdbjmylynhangafbya" + }, + "launchTemplate": { + "id": "si", + "name": "gdqcgfql", + "version": "lonea" + }, + "nodeRole": "rzscoljnrtiueunqg", + "nodegroupName": "wipo", + "releaseVersion": "wbgbpvjsrkscfxkcbuatuirn", + "remoteAccess": { + "ec2SshKey": "trwz", + "sourceSecurityGroups": [ + "jv" + ] + }, + "scalingConfig": { + "desiredSize": 2, + "maxSize": 22, + "minSize": 18 + }, + "subnets": [ + "jtzrxn" + ], + "tags": { + "key1070": "ptrhctidulykbaakuqqqqpwbjf" + }, + "taints": [ + { + "effect": "cqyaskimdnuadazzlnzdgwjbg", + "key": "msxlxqepxrvkybvjeshfybwsx", + "value": "hfdagmnrdomthxavrf" + } + ], + "updateConfig": { + "maxUnavailable": 24, + "maxUnavailablePercentage": 18 + }, + "version": "pzblimbasgkqgyknilzxktqx" + }, + "publicCloudConnectorsResourceId": "val", + "awsAccountId": "vfdqtwvbpgxbhqwrbowcnz", + "arn": "ckgekeh", + "publicCloudResourceName": "aybzphomshbbtslocleyyvgcfu", + "awsSourceSchema": "cizsekmbzwzgaklajexx", + "awsRegion": "glvfswwditueizhrpfvhiwm", + "awsTags": { + "key7151": "fcroma" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3889": "eznqfotstpbcylyajq" + }, + "location": "qfzxiflpnxiua", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EksNodegroups/{resourceName}", + "name": "ogznfdrmxkqrvhiqbjzd", + "type": "atygxqoiwpgzauy", + "systemData": { + "createdBy": "bizwrrwdcixtieklgneyd", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:41.127Z", + "lastModifiedBy": "kqddwpczakftondbj", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:41.127Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_CreateOrReplace.json new file mode 100644 index 000000000000..15294ba254e3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_CreateOrReplace.json @@ -0,0 +1,151 @@ +{ + "title": "ElasticBeanstalkApplications_CreateOrReplace", + "operationId": "ElasticBeanstalkApplications_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + } + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Delete.json new file mode 100644 index 000000000000..5ca1fceca6eb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkApplications_Delete", + "operationId": "ElasticBeanstalkApplications_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Get.json new file mode 100644 index 000000000000..2827c8cd38bd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Get.json @@ -0,0 +1,62 @@ +{ + "title": "ElasticBeanstalkApplications_Get", + "operationId": "ElasticBeanstalkApplications_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListByResourceGroup.json new file mode 100644 index 000000000000..0b49630f290e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "ElasticBeanstalkApplications_ListByResourceGroup", + "operationId": "ElasticBeanstalkApplications_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListBySubscription.json new file mode 100644 index 000000000000..3086564ff075 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "ElasticBeanstalkApplications_ListBySubscription", + "operationId": "ElasticBeanstalkApplications_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Update.json new file mode 100644 index 000000000000..e6b680779254 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkApplications_Update.json @@ -0,0 +1,72 @@ +{ + "title": "ElasticBeanstalkApplications_Update", + "operationId": "ElasticBeanstalkApplications_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "70ADCA02-5423-4A88-8E35-58DFB2506B4F", + "resourceGroupName": "rgelasticBeanstalkApplication", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key483": "ydsxoqpgkqbwfamrvfmrqswlaz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "lrxgvxoicfhhixebp", + "description": "a", + "resourceLifecycleConfig": { + "serviceRole": "buibidzp", + "versionLifecycleConfig": { + "maxAgeRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxAgeInDays": 5 + }, + "maxCountRule": { + "deleteSourceFromS3": true, + "enabled": true, + "maxCount": 14 + } + } + } + }, + "publicCloudConnectorsResourceId": "echppxwpbpqnasbem", + "awsAccountId": "xrjnzzimbdnoqnbzpppxas", + "arn": "yautrhxbrmk", + "publicCloudResourceName": "nkyqyjvezjhltbpdnnxr", + "awsSourceSchema": "or", + "awsRegion": "wxoiinzpqpanl", + "awsTags": { + "key4469": "wyj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8088": "wwicspxekbelocgqyxjqadlctp" + }, + "location": "iiedtydxzeyayiwanytnqwn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkApplications/{resourceName}", + "name": "zp", + "type": "ddhlqtbffdvmhc", + "systemData": { + "createdBy": "dqyqdxatejhyjvso", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:19.701Z", + "lastModifiedBy": "aefvzxyyhsndi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:19.701Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json new file mode 100644 index 000000000000..fdb8531c5cc4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", + "operationId": "ElasticBeanstalkConfigurationTemplates_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + } + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Delete.json new file mode 100644 index 000000000000..35b5eb779d59 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Delete", + "operationId": "ElasticBeanstalkConfigurationTemplates_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Get.json new file mode 100644 index 000000000000..da12b002a95c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Get.json @@ -0,0 +1,63 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Get", + "operationId": "ElasticBeanstalkConfigurationTemplates_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json new file mode 100644 index 000000000000..b6b3de422214 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", + "operationId": "ElasticBeanstalkConfigurationTemplates_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + ], + "nextLink": "https://microsoft.com/awfzeg" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json new file mode 100644 index 000000000000..b48c3090ca80 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", + "operationId": "ElasticBeanstalkConfigurationTemplates_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + ], + "nextLink": "https://microsoft.com/awfzeg" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Update.json new file mode 100644 index 000000000000..8f67ef04831a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkConfigurationTemplates_Update.json @@ -0,0 +1,73 @@ +{ + "title": "ElasticBeanstalkConfigurationTemplates_Update", + "operationId": "ElasticBeanstalkConfigurationTemplates_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EF4F2E45-F152-4C43-A5F8-28D980B9A7A6", + "resourceGroupName": "rgelasticBeanstalkConfigurationTemplate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5550": "peipqgaljpx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "cectxkagk", + "description": "f", + "environmentId": "irk", + "optionSettings": [ + { + "namespace": "wqnwnaqljiuphwrslzv", + "optionName": "jutnzi", + "resourceName": "cxxafxqqeda", + "value": "auojwoarknbok" + } + ], + "platformArn": "shxv", + "solutionStackName": "ytiftttvorpjlkspzoqxnv", + "sourceConfiguration": { + "applicationName": "gxvqqvuzcufyvzeguns", + "templateName": "eajnqnevlyqrtelgeur" + }, + "templateName": "fjixtzihey" + }, + "publicCloudConnectorsResourceId": "ezxdkcckcqzvdvfjkioqer", + "awsAccountId": "eedsjtwxrqaahfnsjwvrxnzerudq", + "arn": "jnsnkdqnxzjvxlitgjtzledfqpwd", + "publicCloudResourceName": "lgdolpeaabdfynczxxux", + "awsSourceSchema": "ehzbquzqlgoysykmpkmfu", + "awsRegion": "timidysdqvjb", + "awsTags": { + "key1871": "ndxlqvxztqkkkqewenirmqdtxweey" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9826": "pcgafzfic" + }, + "location": "zzrrrcfibirqbvvfobbhmdfw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkConfigurationTemplates/{resourceName}", + "name": "eirksxoglhtshdstawe", + "type": "ckeeprazbluvwfhjrgkvohvv", + "systemData": { + "createdBy": "mlocnglmbhpaffeowstjtewkssf", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:44.440Z", + "lastModifiedBy": "odxqbdnnupxcauklihlmqlbrgt", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:44.441Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_CreateOrReplace.json new file mode 100644 index 000000000000..26bdea3a6db8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "ElasticBeanstalkEnvironments_CreateOrReplace", + "operationId": "ElasticBeanstalkEnvironments_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + } + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Delete.json new file mode 100644 index 000000000000..bdc85f60cfa5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticBeanstalkEnvironments_Delete", + "operationId": "ElasticBeanstalkEnvironments_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Get.json new file mode 100644 index 000000000000..84c8c2f73c87 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Get.json @@ -0,0 +1,74 @@ +{ + "title": "ElasticBeanstalkEnvironments_Get", + "operationId": "ElasticBeanstalkEnvironments_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListByResourceGroup.json new file mode 100644 index 000000000000..a93bb6e089c9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticBeanstalkEnvironments_ListByResourceGroup", + "operationId": "ElasticBeanstalkEnvironments_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + ], + "nextLink": "https://microsoft.com/alne" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListBySubscription.json new file mode 100644 index 000000000000..2d641fb81ff6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "ElasticBeanstalkEnvironments_ListBySubscription", + "operationId": "ElasticBeanstalkEnvironments_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + ], + "nextLink": "https://microsoft.com/alne" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Update.json new file mode 100644 index 000000000000..70efa2be96a1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticBeanstalkEnvironments_Update.json @@ -0,0 +1,84 @@ +{ + "title": "ElasticBeanstalkEnvironments_Update", + "operationId": "ElasticBeanstalkEnvironments_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "47200500-687F-444F-BD76-8B298E62C08D", + "resourceGroupName": "rgelasticBeanstalkEnvironment", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4897": "jbyvhlrhylk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applicationName": "zymlvasjtynhgbrykr", + "cnamePrefix": "evct", + "description": "uofhhpwsesygrtmyfvurdgtuncytpq", + "endpointURL": "thvydn", + "environmentName": "kpogmhzunuicnzwhvcwybzmj", + "operationsRole": "awulopnqdubztsjuoqwcebjgf", + "optionSettings": [ + { + "namespace": "fvkbdiiopsoi", + "optionName": "nmgnqhutdmmirjbbbhdrgba", + "resourceName": "qobeconagmalvwfyfrnx", + "value": "ucdijfyhnuwhsuqo" + } + ], + "platformArn": "ectglmsyrgcycywivrpuxvm", + "solutionStackName": "gctjcbflipsc", + "tags": [ + { + "key": "raqljgihbr", + "value": "hhfcrfaprtppmnzutomhlsnyoxalm" + } + ], + "templateName": "fnmdsebgrdkpatpiic", + "tier": { + "name": "gxxmgofbfkkvxbrrxxuhnpqortbs", + "type": "qxjdncodnwucwrbgx", + "version": "viernervectbejorfdi" + }, + "versionLabel": "xkovoldnwteogliidadchizalspob" + }, + "publicCloudConnectorsResourceId": "ms", + "awsAccountId": "ckcntjjdjmmpwsiaecavfwo", + "arn": "zmjeppob", + "publicCloudResourceName": "dmmydqwtpsruhsd", + "awsSourceSchema": "jkxtmyhfrvbuoheuscaxhmlm", + "awsRegion": "mvc", + "awsTags": { + "key2939": "dwqyzzwhrhahouvjzuqwk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2096": "qdm" + }, + "location": "rcicwrhnehybtulvvctkoqfjwtknlq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticBeanstalkEnvironments/{resourceName}", + "name": "xytloifpzeomlsrzhmb", + "type": "hdqyqgbmpuxuelkobysyblfklazhdp", + "systemData": { + "createdBy": "kjeijfmwvstbdcskzdimwidrrcwc", + "createdByType": "User", + "createdAt": "2024-10-08T04:12:27.037Z", + "lastModifiedBy": "zertzgexowitghgppvv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:12:27.038Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_CreateOrReplace.json new file mode 100644 index 000000000000..a826f5cbff94 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_CreateOrReplace.json @@ -0,0 +1,334 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2Listeners_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + } + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Delete.json new file mode 100644 index 000000000000..80ecc49b02a0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Delete", + "operationId": "ElasticLoadBalancingV2Listeners_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Get.json new file mode 100644 index 000000000000..6476f42302ca --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Get.json @@ -0,0 +1,123 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Get", + "operationId": "ElasticLoadBalancingV2Listeners_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json new file mode 100644 index 000000000000..42318a51d149 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListByResourceGroup.json @@ -0,0 +1,127 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2Listeners_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListBySubscription.json new file mode 100644 index 000000000000..51e88db30f1b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_ListBySubscription.json @@ -0,0 +1,126 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_ListBySubscription", + "operationId": "ElasticLoadBalancingV2Listeners_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Update.json new file mode 100644 index 000000000000..3d4bc32af0fc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2Listeners_Update.json @@ -0,0 +1,133 @@ +{ + "title": "ElasticLoadBalancingV2Listeners_Update", + "operationId": "ElasticLoadBalancingV2Listeners_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "93808C4D-1110-48D8-B848-4BE11AFA1D8D", + "resourceGroupName": "rgelasticLoadBalancingV2Listener", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1036": "styywfjbytpruluzsccjxbrqukn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alpnPolicy": [ + "tznuapvprovrolljpcrptvkhjpl" + ], + "certificates": [ + { + "certificateArn": "mfdqcjinbzrxinpbkmpjj" + } + ], + "defaultActions": [ + { + "authenticateCognitoConfig": { + "authenticationRequestExtraParams": { + "key2864": "lfiwydvqaiihfxmtn" + }, + "onUnauthenticatedRequest": "ewqmcevolmfvchwcrm", + "scope": "wtpexcocbnkypesnfwkvyxetj", + "sessionCookieName": "whrieoypkjqsclmgqsiuohq", + "sessionTimeout": "ujvfjimalwitusxfyglnihdh", + "userPoolArn": "ilqdawi", + "userPoolClientId": "dmzhlfrfqmoa", + "userPoolDomain": "jkxwfnqp" + }, + "authenticateOidcConfig": { + "authenticationRequestExtraParams": { + "key4917": "qdakywifsjkxphxtrxzvm" + }, + "authorizationEndpoint": "qysvkpfi", + "clientId": "u", + "clientSecret": "fpwwikwbyropowu", + "issuer": "jkfpddkgzwiakaobaydiwrztixoef", + "onUnauthenticatedRequest": "yppxrruimvmjjajglsmxnwlif", + "scope": "loh", + "sessionCookieName": "tmhjastblgrrlqnxqeiccoez", + "sessionTimeout": "rkwdmahwrhgsxev", + "tokenEndpoint": "mrijxdgsbmsimci", + "useExistingClientSecret": true, + "userInfoEndpoint": "kbv" + }, + "fixedResponseConfig": { + "contentType": "xxmkkjulvromwbljdvzinagjmmvizg", + "messageBody": "u", + "statusCode": "qrvasqybebu" + }, + "forwardConfig": { + "targetGroupStickinessConfig": { + "durationSeconds": 25, + "enabled": true + }, + "targetGroups": [ + { + "targetGroupArn": "tqmikgktkjddfsirlrzderquhjmlsj", + "weight": 30 + } + ] + }, + "order": 1, + "redirectConfig": { + "host": "zbwhrrxamywhpcrcwnlftloenhgubz", + "path": "uifuyulnhelvgkkgzohuzn", + "port": "objmskuxfeanqv", + "protocol": "zmhfuhzhytveuveux", + "query": "kdbtsctjnajoummjgyigqnnuhnmjk", + "statusCode": "bcrp" + }, + "targetGroupArn": "sqtnjzhlqyavpkkxqky", + "type": "yqmcnd" + } + ], + "listenerArn": "nbgkbxgvqooycwaj", + "loadBalancerArn": "yktlh", + "mutualAuthentication": { + "ignoreClientCertificateExpiry": true, + "mode": "byoxnzjdbatjjyheiqtxy", + "trustStoreArn": "mxmhj" + }, + "port": 26, + "protocol": "vac", + "sslPolicy": "oqzcjbvjkvuleoixcyfexaam" + }, + "publicCloudConnectorsResourceId": "c", + "awsAccountId": "ikmnykytjq", + "arn": "cxn", + "publicCloudResourceName": "ukdphfdtbdvfyuswafgdhapeioe", + "awsSourceSchema": "fj", + "awsRegion": "uwrcdgkifqubmtwrzvuvfmeaaght", + "awsTags": { + "key9655": "qkezhcfmlrsydfxurabygylwegs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1120": "fsoksfa" + }, + "location": "ynyltffflqszrlkr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2Listeners/{resourceName}", + "name": "iohfximiossvuyckrysts", + "type": "cgodiivj", + "systemData": { + "createdBy": "celubmngrlvnfnenxkki", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:04.297Z", + "lastModifiedBy": "h", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:04.297Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json new file mode 100644 index 000000000000..ed177a8340f5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2LoadBalancers_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + } + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Delete.json new file mode 100644 index 000000000000..7c3551c9cac4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Delete", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Get.json new file mode 100644 index 000000000000..c6bd3ab753ac --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Get.json @@ -0,0 +1,81 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Get", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json new file mode 100644 index 000000000000..c8c7baa8c180 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json new file mode 100644 index 000000000000..79a71545b10c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_ListBySubscription", + "operationId": "ElasticLoadBalancingV2LoadBalancers_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Update.json new file mode 100644 index 000000000000..ecd9e5a2c1a8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2LoadBalancers_Update.json @@ -0,0 +1,91 @@ +{ + "title": "ElasticLoadBalancingV2LoadBalancers_Update", + "operationId": "ElasticLoadBalancingV2LoadBalancers_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CAD5240E-DEA7-4496-833F-B135D9DDCAC9", + "resourceGroupName": "rgelasticLoadBalancingV2LoadBalancer", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3447": "otmheephfjuagmhdycwlabgupbwrgo" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "canonicalHostedZoneID": "cpniwdbqzfxrbtnzkthjyohnbtq", + "dnsName": "mafoyhxa", + "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": "gsefdpgmvnyizvpidgxdedsusstsmi", + "ipAddressType": "ghelcjykqvyqrwtwydiwleni", + "loadBalancerArn": "tswueurcdm", + "loadBalancerAttributes": [ + { + "key": "jmpasivxkgcqvadmp", + "value": "cbsgvwtlyhuclvjpye" + } + ], + "loadBalancerFullName": "kmxzisdeike", + "loadBalancerName": "bdspilcwdpibhmnlbygrgaebhvbz", + "name": "erwqxzfowfkksnodfytvnnyefbdsc", + "scheme": "nqjwo", + "securityGroups": [ + "tavqrnlv" + ], + "subnetMappings": [ + { + "allocationId": "dkrqwrzo", + "iPv6Address": "mglejntagkkkioov", + "privateIPv4Address": "furnpiatzewmpnhapicnfy", + "subnetId": "igo" + } + ], + "subnets": [ + "xqblkoljy" + ], + "tags": [ + { + "key": "eaenshgcpimgwtmxvu", + "value": "vxqjrslimcsyqfkfmjiqjcht" + } + ], + "type": "ywggrkrojayvb" + }, + "publicCloudConnectorsResourceId": "udwcmojnxevoeyr", + "awsAccountId": "eopxqyapnygxz", + "arn": "kojgsx", + "publicCloudResourceName": "oicaxqhgvlybdl", + "awsSourceSchema": "lnmi", + "awsRegion": "dplxwlbvhvz", + "awsTags": { + "key1771": "wqbrpppfj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4383": "on" + }, + "location": "zrpnzixidbktdxtkovhvkklslaw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2LoadBalancers/{resourceName}", + "name": "elnktjtdysq", + "type": "hvniupr", + "systemData": { + "createdBy": "imjuajqachqygsbahsosutynhjsyk", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:02.125Z", + "lastModifiedBy": "xacvfwwmnovusnwsklzkfyc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:02.126Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json new file mode 100644 index 000000000000..39d5ef0319ed --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_CreateOrReplace", + "operationId": "ElasticLoadBalancingV2TargetGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + } + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Delete.json new file mode 100644 index 000000000000..aa3424591544 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Delete", + "operationId": "ElasticLoadBalancingV2TargetGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Get.json new file mode 100644 index 000000000000..d1f7ea6f2765 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Get.json @@ -0,0 +1,89 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Get", + "operationId": "ElasticLoadBalancingV2TargetGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..28aa45d660bb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup", + "operationId": "ElasticLoadBalancingV2TargetGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json new file mode 100644 index 000000000000..709559e1172e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_ListBySubscription", + "operationId": "ElasticLoadBalancingV2TargetGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Update.json new file mode 100644 index 000000000000..176a4488ff71 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingV2TargetGroups_Update.json @@ -0,0 +1,99 @@ +{ + "title": "ElasticLoadBalancingV2TargetGroups_Update", + "operationId": "ElasticLoadBalancingV2TargetGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "811F9656-0B3E-49FE-ABB1-4BDD5E117829", + "resourceGroupName": "rgelasticLoadBalancingV2TargetGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2200": "sfyiwfoulfuntkhqpphpfjfcnqqjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "healthCheckEnabled": true, + "healthCheckIntervalSeconds": 16, + "healthCheckPath": "exmwepsqjmnvppxuwwvineim", + "healthCheckPort": "cjuqka", + "healthCheckProtocol": "vkarvxh", + "healthCheckTimeoutSeconds": 13, + "healthyThresholdCount": 21, + "ipAddressType": "da", + "loadBalancerArns": [ + "tzafgmrxzoifkxbmzsivajwdwedjw" + ], + "matcher": { + "grpcCode": "tbnxw", + "httpCode": "pavevmyswjhnoptlankjaiieao" + }, + "name": "ruyunzpgs", + "port": 9, + "protocol": "cltdmqhlrmrhgdamynxpmnbshrth", + "protocolVersion": "rpqn", + "tags": [ + { + "key": "fkysin", + "value": "ivjhgawgxhfvwiyaeruurbpkyx" + } + ], + "targetGroupArn": "nlyfkpaomu", + "targetGroupAttributes": [ + { + "key": "edcafpxbnifvdfchilay", + "value": "fiffi" + } + ], + "targetGroupFullName": "xhghbskmnfhkswoncku", + "targetGroupName": "b", + "targetType": "eekpandbuoghdxtg", + "targets": [ + { + "availabilityZone": "degmktltnufhywqic", + "id": "dpaky", + "port": 13 + } + ], + "unhealthyThresholdCount": 14, + "vpcId": "leubklsppgcmljbowvzpwvwya" + }, + "publicCloudConnectorsResourceId": "agzteeghhpawmqbjrdkgduq", + "awsAccountId": "vjdgbgqisnvysonxlwjoczc", + "arn": "avccwbbipudnfjximva", + "publicCloudResourceName": "muortngxuegbngvcemmzovetqah", + "awsSourceSchema": "cljfeojrexeruhvjklisrmf", + "awsRegion": "qlfglghejmmlo", + "awsTags": { + "key5023": "tfayscxthf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6050": "pemhzyusesfpizecwecekae" + }, + "location": "uyngtpdaililbq", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingV2TargetGroups/{resourceName}", + "name": "vxovzlnkinigqarvabyfm", + "type": "rww", + "systemData": { + "createdBy": "akyubwnvbmqflhmgiwwpcmgr", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:34.400Z", + "lastModifiedBy": "xlsgwp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:34.400Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json new file mode 100644 index 000000000000..ec514952fa18 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + } + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json new file mode 100644 index 000000000000..94c3ea742b82 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Delete", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json new file mode 100644 index 000000000000..1250deb97c4d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Get.json @@ -0,0 +1,68 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Get", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..53d717f7f046 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json new file mode 100644 index 000000000000..f7c5299c3684 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json new file mode 100644 index 000000000000..2a8173f218cb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/ElasticLoadBalancingv2TargetHealthDescriptions_Update.json @@ -0,0 +1,78 @@ +{ + "title": "ElasticLoadBalancingv2TargetHealthDescriptions_Update", + "operationId": "ElasticLoadBalancingv2TargetHealthDescriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "86594B85-E730-461D-84F9-D27A6F8F7B25", + "resourceGroupName": "rgelasticLoadBalancingV2TargetHealthDescription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5261": "sfmsrb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "anomalyDetection": { + "mitigationInEffect": { + "value": "no" + }, + "result": { + "value": "anomalous" + } + }, + "healthCheckPort": "wncbdhbdrxjzdwg", + "target": { + "availabilityZone": "lopqxsnyhbsjjqaj", + "id": "wrhggxodbbktxivhn", + "port": 29 + }, + "targetHealth": { + "description": "v", + "reason": { + "value": "Elb.InitialHealthChecking" + }, + "state": { + "value": "draining" + } + } + }, + "publicCloudConnectorsResourceId": "zwes", + "awsAccountId": "nqhdoshumaulzimktuhfyzbokepnin", + "arn": "hwxzsqacyslkcfypjntjeecsgic", + "publicCloudResourceName": "dwtgooliytsuedlhhauisu", + "awsSourceSchema": "kqowwthevk", + "awsRegion": "jhbryqdcp", + "awsTags": { + "key1547": "ursadfghvwitmnfl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7243": "rnnjfbxaflvpmnutqzvg" + }, + "location": "fjdx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ElasticLoadBalancingv2TargetHealthDescriptions/{resourceName}", + "name": "jpetudmwrkfgbiihrhfwekiomcafmh", + "type": "lqdmzfrxkybajneyxmfd", + "systemData": { + "createdBy": "wkcdrjuawwnbosxrfrymcljer", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.355Z", + "lastModifiedBy": "njjldcqsq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.356Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..2b26aeeca733 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_CreateOrReplace.json @@ -0,0 +1,190 @@ +{ + "title": "EmrClusterSummaries_CreateOrReplace", + "operationId": "EmrClusterSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + } + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Delete.json new file mode 100644 index 000000000000..eec088dc07d8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EmrClusterSummaries_Delete", + "operationId": "EmrClusterSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Get.json new file mode 100644 index 000000000000..b6cb16398033 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Get.json @@ -0,0 +1,75 @@ +{ + "title": "EmrClusterSummaries_Get", + "operationId": "EmrClusterSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..902b984a2e32 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListByResourceGroup.json @@ -0,0 +1,79 @@ +{ + "title": "EmrClusterSummaries_ListByResourceGroup", + "operationId": "EmrClusterSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListBySubscription.json new file mode 100644 index 000000000000..60f8a68d0d17 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "title": "EmrClusterSummaries_ListBySubscription", + "operationId": "EmrClusterSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Update.json new file mode 100644 index 000000000000..e5276e931ce7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusterSummaries_Update.json @@ -0,0 +1,85 @@ +{ + "title": "EmrClusterSummaries_Update", + "operationId": "EmrClusterSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "709A8D53-5E24-4D41-A9B3-6B97C0F7C573", + "resourceGroupName": "rgemrClusterSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1151": "meekyuohznsay" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "clusterArn": "hcwmiaqea", + "id": "hfxlzvrbygylot", + "name": "nefubxfisrkqoalhovdvlsu", + "normalizedInstanceHours": 27, + "outpostArn": "sbsolrzktgrkmhwjfdmayp", + "status": { + "errorDetails": [ + { + "errorCode": "onv", + "errorData": [ + {} + ], + "errorMessage": "wqhugncreg" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "lapcxpryl" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:48:22.614Z", + "endDateTime": "2024-10-08T03:48:22.614Z", + "readyDateTime": "2024-10-08T03:48:22.614Z" + } + } + }, + "publicCloudConnectorsResourceId": "xkwvywwdhplifzryewofkfixmin", + "awsAccountId": "bgsinuonrubuushkssenel", + "arn": "ivrscnhxemak", + "publicCloudResourceName": "dirislun", + "awsSourceSchema": "ertwddsdgnkc", + "awsRegion": "zvqejnwqwbwclnslkhgteqamuvfdi", + "awsTags": { + "key1466": "benjlzndrdxofiemasxvbfoaqwbczm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7639": "nvqtvsaya" + }, + "location": "ph", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusterSummaries/{resourceName}", + "name": "ypy", + "type": "yavh", + "systemData": { + "createdBy": "onnbnpjafki", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:22.616Z", + "lastModifiedBy": "yfblshlvoiccykezbgakgwbx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:22.616Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_CreateOrReplace.json new file mode 100644 index 000000000000..42e13af6e0eb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_CreateOrReplace.json @@ -0,0 +1,469 @@ +{ + "title": "EmrClusters_CreateOrReplace", + "operationId": "EmrClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + } + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Delete.json new file mode 100644 index 000000000000..671accfe5c87 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EmrClusters_Delete", + "operationId": "EmrClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Get.json new file mode 100644 index 000000000000..ba87d34d476c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Get.json @@ -0,0 +1,168 @@ +{ + "title": "EmrClusters_Get", + "operationId": "EmrClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..ea7f8ce172f7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListByResourceGroup.json @@ -0,0 +1,172 @@ +{ + "title": "EmrClusters_ListByResourceGroup", + "operationId": "EmrClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListBySubscription.json new file mode 100644 index 000000000000..45b4a741b604 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_ListBySubscription.json @@ -0,0 +1,171 @@ +{ + "title": "EmrClusters_ListBySubscription", + "operationId": "EmrClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Update.json new file mode 100644 index 000000000000..573755cd4914 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/EmrClusters_Update.json @@ -0,0 +1,178 @@ +{ + "title": "EmrClusters_Update", + "operationId": "EmrClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76A5A7AB-C612-4396-8DC2-B855204085DB", + "resourceGroupName": "rgemrCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1560": "gzdvjynwqlvywjwutal" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "applications": [ + { + "additionalInfo": { + "key299": "utebwgfwrjdsmcdauxfdp" + }, + "args": [ + "sumnqhhlrszgzznshwr" + ], + "name": "kapcvpwdf", + "version": "yccwkryikpyu" + } + ], + "autoScalingRole": "yuplht", + "autoTerminate": true, + "clusterArn": "bwnxmqzwlykxvewsdujzovqs", + "configurations": [ + { + "classification": "ahweyaesthmgtdiv", + "configurations": [], + "properties": { + "key6744": "jfktwevmtaitzgjhgrxhcsyaf" + } + } + ], + "customAmiId": "iwlvorsznjsaunx", + "ebsRootVolumeIops": 28, + "ebsRootVolumeSize": 25, + "ebsRootVolumeThroughput": 17, + "ec2InstanceAttributes": { + "additionalMasterSecurityGroups": [ + "pzihpojfcoxrdcrosktssgf" + ], + "additionalSlaveSecurityGroups": [ + "rdaccocuctxwwzt" + ], + "ec2AvailabilityZone": "bwaaomtre", + "ec2KeyName": "jej", + "ec2SubnetId": "ykhysdwgksrwehd", + "emrManagedMasterSecurityGroup": "rjwslxsygj", + "emrManagedSlaveSecurityGroup": "hvmxzsjgkhxnimtofmzlpkf", + "iamInstanceProfile": "wxgp", + "requestedEc2AvailabilityZones": [ + "wjzsvq" + ], + "requestedEc2SubnetIds": [ + "nliztbuhuhkve" + ], + "serviceAccessSecurityGroup": "supzzejzwqetvnebvhefvwofww" + }, + "id": "usolewchtbnpfarqidjcaetetbbnww", + "instanceCollectionType": { + "value": "INSTANCE_FLEET" + }, + "kerberosAttributes": { + "adDomainJoinPassword": "nhrnfruuygxsvhumivr", + "adDomainJoinUser": "ezsezwfzesdunmtiegxbsomqqk", + "crossRealmTrustPrincipalPassword": "rpvurwogufbkyluimlirujvpwl", + "kdcAdminPassword": "yzsewywylqtqouxwulr", + "realm": "rraygrjruzeqrozds" + }, + "logEncryptionKmsKeyId": "p", + "logUri": "xrdeudkf", + "masterPublicDnsName": "ztuajioptfwewm", + "name": "bhkvffeitkj", + "normalizedInstanceHours": 16, + "osReleaseLabel": "huxdgdaqkknvleyvhgydjbidn", + "outpostArn": "wnoxdzcyqfbreqnkorlwtfvmzpcu", + "placementGroups": [ + { + "instanceRole": { + "value": "CORE" + }, + "placementStrategy": { + "value": "CLUSTER" + } + } + ], + "releaseLabel": "lpmpniehmkeuwyyh", + "repoUpgradeOnBoot": { + "value": "NONE" + }, + "requestedAmiVersion": "kwlohrrhuxcgnok", + "runningAmiVersion": "wd", + "scaleDownBehavior": { + "value": "TERMINATE_AT_INSTANCE_HOUR" + }, + "securityConfiguration": "njgb", + "serviceRole": "msbrnoepcyrbaazxsmwbhmqrzubm", + "status": { + "errorDetails": [ + { + "errorCode": "lklafbu", + "errorData": [ + {} + ], + "errorMessage": "hhoucsczmnnflofzyxt" + } + ], + "state": { + "value": "BOOTSTRAPPING" + }, + "stateChangeReason": { + "code": { + "value": "ALL_STEPS_COMPLETED" + }, + "message": "sxjkazmayqtbqnbaslxpxun" + }, + "timeline": { + "creationDateTime": "2024-10-08T03:51:42.281Z", + "endDateTime": "2024-10-08T03:51:42.281Z", + "readyDateTime": "2024-10-08T03:51:42.281Z" + } + }, + "stepConcurrencyLevel": 8, + "tags": [ + { + "key": "vfcae", + "value": "gibogfcbfiielvixdxeb" + } + ], + "terminationProtected": true, + "unhealthyNodeReplacement": true, + "visibleToAllUsers": true + }, + "publicCloudConnectorsResourceId": "gjirecopxmcdpdljkxexxoawwd", + "awsAccountId": "tsnkbdcacnozmtgvxjflzydxeu", + "arn": "hvhwzh", + "publicCloudResourceName": "aulznvgpxpjdvghbszbwxycew", + "awsSourceSchema": "sexomixwzozkllipdmi", + "awsRegion": "rbbkoztkjhvdu", + "awsTags": { + "key6409": "fsgzxbnbmfnv" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4944": "rpsyifovzprbxzcudooiqiqliub" + }, + "location": "gxjyaumpubnajcudsqwk", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/EmrClusters/{resourceName}", + "name": "kmdpxexhrplqjddfybxybrrb", + "type": "tpujwabpqziae", + "systemData": { + "createdBy": "yohdqso", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:42.282Z", + "lastModifiedBy": "fnwztoq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:42.282Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_CreateOrReplace.json new file mode 100644 index 000000000000..2b19b883fd53 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "GuardDutyDetectors_CreateOrReplace", + "operationId": "GuardDutyDetectors_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + } + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Delete.json new file mode 100644 index 000000000000..70070e7c4a2c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "GuardDutyDetectors_Delete", + "operationId": "GuardDutyDetectors_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Get.json new file mode 100644 index 000000000000..5faca73476cb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Get.json @@ -0,0 +1,81 @@ +{ + "title": "GuardDutyDetectors_Get", + "operationId": "GuardDutyDetectors_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListByResourceGroup.json new file mode 100644 index 000000000000..9531ce33fbca --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "GuardDutyDetectors_ListByResourceGroup", + "operationId": "GuardDutyDetectors_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + ], + "nextLink": "https://microsoft.com/aajhdrra" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListBySubscription.json new file mode 100644 index 000000000000..eab5560a4770 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "GuardDutyDetectors_ListBySubscription", + "operationId": "GuardDutyDetectors_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + ], + "nextLink": "https://microsoft.com/aajhdrra" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Update.json new file mode 100644 index 000000000000..3e6474690ace --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/GuardDutyDetectors_Update.json @@ -0,0 +1,91 @@ +{ + "title": "GuardDutyDetectors_Update", + "operationId": "GuardDutyDetectors_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "53C42B75-97D2-4399-AE17-AE828CDE5FA3", + "resourceGroupName": "rgguardDutyDetector", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2754": "wadidsugspeyhxziareediaqw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dataSources": { + "kubernetes": { + "auditLogs": { + "enable": true + } + }, + "malwareProtection": { + "scanEc2InstanceWithFindings": { + "ebsVolumes": true + } + }, + "s3Logs": { + "enable": true + } + }, + "enable": true, + "features": [ + { + "additionalConfiguration": [ + { + "name": "lkkifsmqcaujhderxjzcmezjh", + "status": "wbjikrlaxrtwpwiexknat" + } + ], + "name": "aoocmexbklfmzmglxopv", + "status": "DISABLED" + } + ], + "findingPublishingFrequency": "ed", + "id": "vakfpotktucclwwqxkczvzrw", + "tags": [ + { + "key": "fezaldlvzejdwknyannwfh", + "value": "edlendjmyszkw" + } + ] + }, + "publicCloudConnectorsResourceId": "infmmygcbbjb", + "awsAccountId": "lgyellrapjphgbfhni", + "arn": "bdql", + "publicCloudResourceName": "hkdypyaxoeszbx", + "awsSourceSchema": "coaitkvmjezenllwmaouhnwfmjjbxa", + "awsRegion": "wtiiifsewygmgbdcebhl", + "awsTags": { + "key6130": "qomcwrehzvdlpltzqhdzxu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3628": "pguiezvqu" + }, + "location": "sxpvpkjhhmcssseznufvqer", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/GuardDutyDetectors/{resourceName}", + "name": "iraqwqwlttjteccptbaifmzaiohbd", + "type": "njmzbkfrwdrxpjcwm", + "systemData": { + "createdBy": "z", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:28.156Z", + "lastModifiedBy": "wrekljmxrnkzq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:28.157Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_CreateOrReplace.json new file mode 100644 index 000000000000..52e282abf92a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "IamAccessKeyLastUseds_CreateOrReplace", + "operationId": "IamAccessKeyLastUseds_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + } + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Delete.json new file mode 100644 index 000000000000..b047d2483ebd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamAccessKeyLastUseds_Delete", + "operationId": "IamAccessKeyLastUseds_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Get.json new file mode 100644 index 000000000000..291f1e2bc559 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Get.json @@ -0,0 +1,48 @@ +{ + "title": "IamAccessKeyLastUseds_Get", + "operationId": "IamAccessKeyLastUseds_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListByResourceGroup.json new file mode 100644 index 000000000000..c224aa5719d1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "IamAccessKeyLastUseds_ListByResourceGroup", + "operationId": "IamAccessKeyLastUseds_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListBySubscription.json new file mode 100644 index 000000000000..ddb3d7128584 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "IamAccessKeyLastUseds_ListBySubscription", + "operationId": "IamAccessKeyLastUseds_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Update.json new file mode 100644 index 000000000000..a633147aa229 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyLastUseds_Update.json @@ -0,0 +1,58 @@ +{ + "title": "IamAccessKeyLastUseds_Update", + "operationId": "IamAccessKeyLastUseds_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E82F3EDA-200F-4F98-90FB-DEA2EE2A1B4A", + "resourceGroupName": "rgiamAccessKeyLastUsed", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2474": "rlwlhpzc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "lastUsedDate": "2024-10-08T03:48:57.755Z", + "region": "av", + "serviceName": "vhyurov" + }, + "publicCloudConnectorsResourceId": "rwbbz", + "awsAccountId": "lturmpd", + "arn": "xfaoulngosrepqegvmfzqcmenfiwv", + "publicCloudResourceName": "cttx", + "awsSourceSchema": "enepzx", + "awsRegion": "epaxtviqtrqqnghkgfkqhuqee", + "awsTags": { + "key9162": "xrhekznmreqitxxw" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2981": "xwkwghlklv" + }, + "location": "rdt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyLastUseds/{resourceName}", + "name": "wtidcpjujjyhczp", + "type": "npnvxls", + "systemData": { + "createdBy": "rtt", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:57.756Z", + "lastModifiedBy": "laanrsdhpwljzdpqaogpate", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:57.756Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_CreateOrReplace.json new file mode 100644 index 000000000000..7b6f7e430c69 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "IamAccessKeyMetadataInfo_CreateOrReplace", + "operationId": "IamAccessKeyMetadataInfo_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + } + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Delete.json new file mode 100644 index 000000000000..33c3401d1611 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamAccessKeyMetadataInfo_Delete", + "operationId": "IamAccessKeyMetadataInfo_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Get.json new file mode 100644 index 000000000000..f15ebf541917 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Get.json @@ -0,0 +1,51 @@ +{ + "title": "IamAccessKeyMetadataInfo_Get", + "operationId": "IamAccessKeyMetadataInfo_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListByResourceGroup.json new file mode 100644 index 000000000000..6329fd895440 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "IamAccessKeyMetadataInfo_ListByResourceGroup", + "operationId": "IamAccessKeyMetadataInfo_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListBySubscription.json new file mode 100644 index 000000000000..896df1b2425d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "IamAccessKeyMetadataInfo_ListBySubscription", + "operationId": "IamAccessKeyMetadataInfo_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Update.json new file mode 100644 index 000000000000..caa85892864b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamAccessKeyMetadataInfo_Update.json @@ -0,0 +1,61 @@ +{ + "title": "IamAccessKeyMetadataInfo_Update", + "operationId": "IamAccessKeyMetadataInfo_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "11FA9DE0-B2BE-4180-8AB0-0530A65B1C67", + "resourceGroupName": "rgiamAccessKeyMetadata", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2001": "hwqnseiqjeuyygxcahrf" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accessKeyId": "ybrtvadgwepioqesepjpoxemlvu", + "createDate": "2024-10-08T03:50:53.022Z", + "status": { + "value": "Active" + }, + "userName": "obogutgiddo" + }, + "publicCloudConnectorsResourceId": "iwcumigpcnebbhmwmaerblylcgdtt", + "awsAccountId": "i", + "arn": "gcbewovmmukvp", + "publicCloudResourceName": "ctvpxuzxqwzhmtivtftc", + "awsSourceSchema": "bcflc", + "awsRegion": "e", + "awsTags": { + "key5899": "nnfwyaxbohwiqqvlegvbeuwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4454": "phceybsnzjaxtgagqgovz" + }, + "location": "dqubptgcoomyzlodtswea", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamAccessKeyMetadataInfo/{resourceName}", + "name": "nzwilyzbgboyvjfhjmpqknqj", + "type": "tegrwvqtubwhkasbsjdoengycwsdsq", + "systemData": { + "createdBy": "zmsogdwqpjwwprbpei", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:53.024Z", + "lastModifiedBy": "glxirypokrrldzxfry", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:53.024Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_CreateOrReplace.json new file mode 100644 index 000000000000..316fd32ad661 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamGroups_CreateOrReplace", + "operationId": "IamGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + } + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Delete.json new file mode 100644 index 000000000000..f317e2f78324 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamGroups_Delete", + "operationId": "IamGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Get.json new file mode 100644 index 000000000000..54a3a10676b3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamGroups_Get", + "operationId": "IamGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..f163352a12dd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamGroups_ListByResourceGroup", + "operationId": "IamGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListBySubscription.json new file mode 100644 index 000000000000..ffb5d6f8dec8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamGroups_ListBySubscription", + "operationId": "IamGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Update.json new file mode 100644 index 000000000000..5c452becdc10 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamGroups_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamGroups_Update", + "operationId": "IamGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "76E3BEA3-CEBB-4F74-BF14-2270CAE457A9", + "resourceGroupName": "rgiamGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6243": "zwl" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qaymkzqiwzdilzpmfapwpudc", + "groupName": "zcmfl", + "managedPolicyArns": [ + "uqek" + ], + "path": "liuneeastp", + "policies": [ + { + "policyDocument": {}, + "policyName": "cokejufrpuszoopjjywwxopal" + } + ] + }, + "publicCloudConnectorsResourceId": "fjfneaczmcscofgdjnxw", + "awsAccountId": "obfwwcnhlgytlanolsfrdn", + "arn": "yvnnjydmrptjbytuyca", + "publicCloudResourceName": "hj", + "awsSourceSchema": "kprcuajdxtfckwviyxpajstzdjeb", + "awsRegion": "uqzi", + "awsTags": { + "key9078": "mpcfehsyuyqdbvmijur" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3844": "pzbfdnhacakyrfejqwafqqmbdjnpx" + }, + "location": "badqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamGroups/{resourceName}", + "name": "erqrekmdrzpjiicenaylpbsim", + "type": "ufxdogagbrfiwkanaorgfugkfhqd", + "systemData": { + "createdBy": "ekueth", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:55.348Z", + "lastModifiedBy": "djeenhuobswlcppbklzm", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:55.349Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_CreateOrUpdate.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_CreateOrUpdate.json new file mode 100644 index 000000000000..50f2a6f2153d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_CreateOrUpdate.json @@ -0,0 +1,118 @@ +{ + "title": "IamInstanceProfiles_CreateOrUpdate", + "operationId": "IamInstanceProfiles_CreateOrUpdate", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + } + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Delete.json new file mode 100644 index 000000000000..4673b68e5728 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamInstanceProfiles_Delete", + "operationId": "IamInstanceProfiles_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Get.json new file mode 100644 index 000000000000..29b00d8de17e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Get.json @@ -0,0 +1,51 @@ +{ + "title": "IamInstanceProfiles_Get", + "operationId": "IamInstanceProfiles_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListByResourceGroup.json new file mode 100644 index 000000000000..2179c4f23394 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "IamInstanceProfiles_ListByResourceGroup", + "operationId": "IamInstanceProfiles_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListBySubscription.json new file mode 100644 index 000000000000..fa4845b4835a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "IamInstanceProfiles_ListBySubscription", + "operationId": "IamInstanceProfiles_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Update.json new file mode 100644 index 000000000000..8a1df63b5eda --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamInstanceProfiles_Update.json @@ -0,0 +1,61 @@ +{ + "title": "IamInstanceProfiles_Update", + "operationId": "IamInstanceProfiles_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "43ABB946-D472-4F05-91AB-1042C127FD69", + "resourceGroupName": "rgiamInstanceProfile", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5002": "ueaanaxejudathtufe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xfilqplkerenzrkykjnnoj", + "instanceProfileName": "ccstflwsxmpatrvscwxoukagqblzt", + "path": "edfwubhvvye", + "roles": [ + "nrvsijvbwdodraufvsxmbcbnm" + ] + }, + "publicCloudConnectorsResourceId": "opbcrtwimfuirxph", + "awsAccountId": "zhhymhiivdmwoidycnqdtzarowwjm", + "arn": "djpzkfxattxqgrwdgl", + "publicCloudResourceName": "qbxqhspttfymekhofojyqu", + "awsSourceSchema": "vitibwpeaozvgjcibxrqodn", + "awsRegion": "dwnkitebqhhqjrkjjlhtjryvhsuz", + "awsTags": { + "key3394": "akkxrjgu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6049": "bwwujf" + }, + "location": "unn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamInstanceProfiles/{resourceName}", + "name": "ynmvegpjcmemaimgdnca", + "type": "pjyjsoewlivh", + "systemData": { + "createdBy": "htlafaruzhyinstvjjqj", + "createdByType": "User", + "createdAt": "2024-09-16T21:58:15.389Z", + "lastModifiedBy": "girsffzaejvzricvno", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-09-16T21:58:15.391Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_CreateOrReplace.json new file mode 100644 index 000000000000..e5dc490ec6b8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "IamMfaDevices_CreateOrReplace", + "operationId": "IamMfaDevices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + } + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Delete.json new file mode 100644 index 000000000000..b88988a6293d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamMfaDevices_Delete", + "operationId": "IamMfaDevices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Get.json new file mode 100644 index 000000000000..1c094afab0d5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Get.json @@ -0,0 +1,48 @@ +{ + "title": "IamMfaDevices_Get", + "operationId": "IamMfaDevices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..527d84092adf --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "IamMfaDevices_ListByResourceGroup", + "operationId": "IamMfaDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + ], + "nextLink": "https://microsoft.com/ag" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListBySubscription.json new file mode 100644 index 000000000000..90b752a3ec90 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "IamMfaDevices_ListBySubscription", + "operationId": "IamMfaDevices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + ], + "nextLink": "https://microsoft.com/ag" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Update.json new file mode 100644 index 000000000000..01c3effcf1f7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamMfaDevices_Update.json @@ -0,0 +1,58 @@ +{ + "title": "IamMfaDevices_Update", + "operationId": "IamMfaDevices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "42C73AA4-67D1-45F4-9987-40191A977FF9", + "resourceGroupName": "rgiamMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2615": "bqskxobjjgas" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enableDate": "2024-10-08T03:50:03.364Z", + "serialNumber": "ifphqcwiounuuootrnmxmm", + "userName": "jyjbnteckbccmmhbxjdk" + }, + "publicCloudConnectorsResourceId": "jmcknwcktcj", + "awsAccountId": "tdapkqeuuvrrasue", + "arn": "hbymjvsaxodse", + "publicCloudResourceName": "vexrvwqtzdijlzwecmljscwepj", + "awsSourceSchema": "ibnflrkwkaswdrsmaqtegtnky", + "awsRegion": "uwyckzldxxj", + "awsTags": { + "key581": "oqgcieddjmzl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9234": "eygqwhelmjvwcvgkzgfg" + }, + "location": "ytpxpjmmspx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamMFADevices/{resourceName}", + "name": "qaldgupkvxgpdkyumguetuizqtcgy", + "type": "dommwtxuegumclybci", + "systemData": { + "createdBy": "bwojhwknslva", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:03.365Z", + "lastModifiedBy": "ubhnw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:03.365Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..18bf4e16cadb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_CreateOrReplace.json @@ -0,0 +1,130 @@ +{ + "title": "IamPasswordPolicies_CreateOrReplace", + "operationId": "IamPasswordPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + } + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Delete.json new file mode 100644 index 000000000000..6ad598232a39 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamPasswordPolicies_Delete", + "operationId": "IamPasswordPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Get.json new file mode 100644 index 000000000000..74ec718eb7db --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Get.json @@ -0,0 +1,55 @@ +{ + "title": "IamPasswordPolicies_Get", + "operationId": "IamPasswordPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..2132932c950e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "title": "IamPasswordPolicies_ListByResourceGroup", + "operationId": "IamPasswordPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListBySubscription.json new file mode 100644 index 000000000000..7fcee86f092b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_ListBySubscription.json @@ -0,0 +1,58 @@ +{ + "title": "IamPasswordPolicies_ListBySubscription", + "operationId": "IamPasswordPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Update.json new file mode 100644 index 000000000000..0c874d953d93 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPasswordPolicies_Update.json @@ -0,0 +1,65 @@ +{ + "title": "IamPasswordPolicies_Update", + "operationId": "IamPasswordPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "2AB4A561-B6C7-46AE-8AA1-B6C7F766EC82", + "resourceGroupName": "rgiamPasswordPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6732": "jiafbj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowUsersToChangePassword": true, + "expirePasswords": true, + "hardExpiry": true, + "maxPasswordAge": 1, + "minimumPasswordLength": 17, + "passwordReusePrevention": 30, + "requireLowercaseCharacters": true, + "requireNumbers": true, + "requireSymbols": true, + "requireUppercaseCharacters": true + }, + "publicCloudConnectorsResourceId": "zsyi", + "awsAccountId": "iiripspbzbqibqazbnef", + "arn": "irgrdslydjpuoyb", + "publicCloudResourceName": "zuwprynvflpuik", + "awsSourceSchema": "gud", + "awsRegion": "mqpdjjdzdwew", + "awsTags": { + "key6748": "bdnkhafiylgulql" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5111": "zzliqszhvi" + }, + "location": "zirvnbwoooczkma", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPasswordPolicies/{resourceName}", + "name": "wlazqv", + "type": "tqjv", + "systemData": { + "createdBy": "wtfjoswgevmrcsjxlxwazcwzffxldz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:12.394Z", + "lastModifiedBy": "ejaqcqnswcpvtgarlcxjhoblcqrk", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:12.394Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_CreateOrReplace.json new file mode 100644 index 000000000000..56d679e07707 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "IamPolicyVersions_CreateOrReplace", + "operationId": "IamPolicyVersions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + } + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Delete.json new file mode 100644 index 000000000000..36abb6ab13b4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamPolicyVersions_Delete", + "operationId": "IamPolicyVersions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Get.json new file mode 100644 index 000000000000..ad0f7cb38c60 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Get.json @@ -0,0 +1,49 @@ +{ + "title": "IamPolicyVersions_Get", + "operationId": "IamPolicyVersions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListByResourceGroup.json new file mode 100644 index 000000000000..85b2b548364b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "IamPolicyVersions_ListByResourceGroup", + "operationId": "IamPolicyVersions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListBySubscription.json new file mode 100644 index 000000000000..bb5de80354a1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "IamPolicyVersions_ListBySubscription", + "operationId": "IamPolicyVersions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Update.json new file mode 100644 index 000000000000..1c1e111fb2e3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamPolicyVersions_Update.json @@ -0,0 +1,59 @@ +{ + "title": "IamPolicyVersions_Update", + "operationId": "IamPolicyVersions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "B22B3326-CB12-4B83-8449-760C825E538F", + "resourceGroupName": "rgiamPolicyVersion", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2276": "wpzrumrbucflp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "createDate": "2024-10-08T03:54:21.310Z", + "document": "bpzfzhilykgroobhu", + "isDefaultVersion": true, + "versionId": "mjxbhpksrctdbegeyhrsyveoyre" + }, + "publicCloudConnectorsResourceId": "hqotja", + "awsAccountId": "xiv", + "arn": "mszogqxtswvseqggugfxstkwivx", + "publicCloudResourceName": "mphznssuferlzunnbjbl", + "awsSourceSchema": "ljldtynekavvptoqhcvqdklc", + "awsRegion": "bhdamksbkmvjl", + "awsTags": { + "key2871": "ejkpbbvnwx" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6034": "pkrkyrharhnjqfubytfj" + }, + "location": "wtyx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamPolicyVersions/{resourceName}", + "name": "pxmszonagtyamfsohnjjijhi", + "type": "dbczkcwagergu", + "systemData": { + "createdBy": "mpjhznwqkdvktlwkkkqbikzgy", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.311Z", + "lastModifiedBy": "bihaqq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.311Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_CreateOrReplace.json new file mode 100644 index 000000000000..77d73768a0d9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "IamRoles_CreateOrReplace", + "operationId": "IamRoles_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + } + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Delete.json new file mode 100644 index 000000000000..07feb5972282 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamRoles_Delete", + "operationId": "IamRoles_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Get.json new file mode 100644 index 000000000000..60326be0e323 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Get.json @@ -0,0 +1,68 @@ +{ + "title": "IamRoles_Get", + "operationId": "IamRoles_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListByResourceGroup.json new file mode 100644 index 000000000000..33fb061a5268 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "IamRoles_ListByResourceGroup", + "operationId": "IamRoles_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListBySubscription.json new file mode 100644 index 000000000000..f2fcbff6c98b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "IamRoles_ListBySubscription", + "operationId": "IamRoles_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Update.json new file mode 100644 index 000000000000..8f60e645d276 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamRoles_Update.json @@ -0,0 +1,78 @@ +{ + "title": "IamRoles_Update", + "operationId": "IamRoles_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "275DE8AF-D10A-4117-88F1-79CDCD71DBF7", + "resourceGroupName": "rgiamRole", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3141": "cahhkifdlxcj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "iqe", + "assumeRolePolicyDocument": {}, + "description": "spayefp", + "managedPolicyArns": [ + "twfombcdqlzq" + ], + "maxSessionDuration": 16, + "path": "qxfdn", + "permissionsBoundary": "wofktscexalvotvxaxsq", + "policies": [ + { + "policyDocument": {}, + "policyName": "bpqsmdhzxaruuvctyddrcedbf" + } + ], + "roleId": "l", + "roleName": "vpczljoyhnvybvtyagxaxaraogzdyx", + "tags": [ + { + "key": "fppaonhdrxztfctritlgmqm", + "value": "jcpberdkjmspmjbzyewyhyd" + } + ] + }, + "publicCloudConnectorsResourceId": "cchmzoxsgytenwavdwoarear", + "awsAccountId": "qlndbvxbvf", + "arn": "cllfeatxzjqiqr", + "publicCloudResourceName": "qn", + "awsSourceSchema": "onnjxuscupomucwhpltcnogwhxllm", + "awsRegion": "yqtvmgzsvcgtehapncinnqvsql", + "awsTags": { + "key9018": "byqrewkofnjfomn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3308": "xn" + }, + "location": "vkzeblhpdgxwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamRoles/{resourceName}", + "name": "szbirdnasrkrwgmqfezjv", + "type": "essihlhnekwonqjnkvv", + "systemData": { + "createdBy": "znbfnvpkpnx", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:18.467Z", + "lastModifiedBy": "elbcmktuqdqceq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:18.467Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_CreateOrReplace.json new file mode 100644 index 000000000000..6a40f99d8261 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamServerCertificates_CreateOrReplace", + "operationId": "IamServerCertificates_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + } + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Delete.json new file mode 100644 index 000000000000..67acdb0ef7d2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamServerCertificates_Delete", + "operationId": "IamServerCertificates_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Get.json new file mode 100644 index 000000000000..d1ca8c645fdc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamServerCertificates_Get", + "operationId": "IamServerCertificates_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListByResourceGroup.json new file mode 100644 index 000000000000..24a82a1d0776 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamServerCertificates_ListByResourceGroup", + "operationId": "IamServerCertificates_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListBySubscription.json new file mode 100644 index 000000000000..5df165cb62e9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamServerCertificates_ListBySubscription", + "operationId": "IamServerCertificates_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Update.json new file mode 100644 index 000000000000..9069f2e58f8f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamServerCertificates_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamServerCertificates_Update", + "operationId": "IamServerCertificates_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "708857BB-95B9-45D7-A816-AB86EFA380A6", + "resourceGroupName": "rgiamServerCertificate", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4287": "vtxxwxtnykpliagzasaedqcb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "ahekoegi", + "certificateBody": "fagqepujrwsvkhdrvofvmkderig", + "certificateChain": "ozzjlnmjijy", + "path": "qvvxpzaoshpkkvncguxmv", + "privateKey": "ynoaydpaju", + "serverCertificateName": "yblyjjfteysombtxapaqjkrqo", + "tags": [ + { + "key": "ipoetrffzaxcntgqbdcuprhbn", + "value": "jstuopgodfwmzigjbb" + } + ] + }, + "publicCloudConnectorsResourceId": "iqnmafujozzlwfnhamvbhfjcuob", + "awsAccountId": "egfew", + "arn": "fkbemnwycxjjjxwievb", + "publicCloudResourceName": "g", + "awsSourceSchema": "hlvxmkdmh", + "awsRegion": "gflixuzdblwuy", + "awsTags": { + "key1989": "jwathlzongmwbilki" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6646": "iu" + }, + "location": "ddjdvyseqfbfufjoxr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamServerCertificates/{resourceName}", + "name": "o", + "type": "ssgtkkihrmrdowisly", + "systemData": { + "createdBy": "hdizqymjaj", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.588Z", + "lastModifiedBy": "dmlwoqalmiyunbetkpgwqu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.588Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_CreateOrReplace.json new file mode 100644 index 000000000000..11046a9fd293 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_CreateOrReplace.json @@ -0,0 +1,136 @@ +{ + "title": "IamVirtualMfaDevices_CreateOrReplace", + "operationId": "IamVirtualMfaDevices_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + } + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Delete.json new file mode 100644 index 000000000000..fa55e60f6795 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "IamVirtualMfaDevices_Delete", + "operationId": "IamVirtualMfaDevices_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Get.json new file mode 100644 index 000000000000..38e61f92568d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Get.json @@ -0,0 +1,57 @@ +{ + "title": "IamVirtualMfaDevices_Get", + "operationId": "IamVirtualMfaDevices_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListByResourceGroup.json new file mode 100644 index 000000000000..3ed24463f332 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "title": "IamVirtualMfaDevices_ListByResourceGroup", + "operationId": "IamVirtualMfaDevices_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListBySubscription.json new file mode 100644 index 000000000000..f733e98c170f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_ListBySubscription.json @@ -0,0 +1,60 @@ +{ + "title": "IamVirtualMfaDevices_ListBySubscription", + "operationId": "IamVirtualMfaDevices_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Update.json new file mode 100644 index 000000000000..3ebcabbee292 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/IamVirtualMfaDevices_Update.json @@ -0,0 +1,67 @@ +{ + "title": "IamVirtualMfaDevices_Update", + "operationId": "IamVirtualMfaDevices_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "7A7170F9-4C30-4964-A66E-699AF7EDB90E", + "resourceGroupName": "rgiamVirtualMFADevice", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1836": "hmiagognhtuiiokxcnouibgjadizrt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "path": "iuiajbhehzagt", + "serialNumber": "zbsulwrnmmhdwuelwbybavq", + "tags": [ + { + "key": "imskkztsfijhjvvp", + "value": "kpmtbersaovhycdipca" + } + ], + "users": [ + "pzktvxysprnhhivbnuuutllcomxp" + ], + "virtualMfaDeviceName": "m" + }, + "publicCloudConnectorsResourceId": "chegzvubkwsrhocspiedvdrzuhkjo", + "awsAccountId": "deoktff", + "arn": "soptozsivfaghgr", + "publicCloudResourceName": "uktgscbqvuprtkj", + "awsSourceSchema": "iotqvkkgxaoeewgxegimnri", + "awsRegion": "h", + "awsTags": { + "key1965": "rgngzs" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2474": "za" + }, + "location": "ixkqwzfnsthfshdlvsvh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/IamVirtualMFADevices/{resourceName}", + "name": "uceacdsk", + "type": "e", + "systemData": { + "createdBy": "fmkoreknlh", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:49.753Z", + "lastModifiedBy": "cfxsncu", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:49.754Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_CreateOrReplace.json new file mode 100644 index 000000000000..2271e7ee482c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "KmsAliases_CreateOrReplace", + "operationId": "KmsAliases_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + } + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Delete.json new file mode 100644 index 000000000000..5988c5aa74b1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "KmsAliases_Delete", + "operationId": "KmsAliases_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Get.json new file mode 100644 index 000000000000..7a5484cc91a4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Get.json @@ -0,0 +1,47 @@ +{ + "title": "KmsAliases_Get", + "operationId": "KmsAliases_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListByResourceGroup.json new file mode 100644 index 000000000000..a48076cccc32 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "KmsAliases_ListByResourceGroup", + "operationId": "KmsAliases_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListBySubscription.json new file mode 100644 index 000000000000..a7a6563537b8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "KmsAliases_ListBySubscription", + "operationId": "KmsAliases_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Update.json new file mode 100644 index 000000000000..b8fcdf12df94 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsAliases_Update.json @@ -0,0 +1,57 @@ +{ + "title": "KmsAliases_Update", + "operationId": "KmsAliases_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1740C463-183C-48C9-BC83-CE6ED70333F1", + "resourceGroupName": "rgkmsAlias", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4840": "vvbyxuqukn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasName": "qpqfyfsgzbqqqwohdqogpksketglb", + "targetKeyId": "fgiefgtmhdrvw" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "mi", + "arn": "seecdsob", + "publicCloudResourceName": "qrdvkbofzddttwvcfunr", + "awsSourceSchema": "iwkqjxnfjutfnhhocco", + "awsRegion": "zofqccwhxvtaeqhhtqwmruhcjkro", + "awsTags": { + "key6582": "wejhqyokgch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1437": "lfgpfgxqkrvrlhnpwtzafonw" + }, + "location": "zsrefx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsAliases/{resourceName}", + "name": "runvybddwo", + "type": "hdqcs", + "systemData": { + "createdBy": "itgqudbdwrypbsifu", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:05.263Z", + "lastModifiedBy": "tfseoffiuwdtixcuflxczkr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:05.264Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_CreateOrReplace.json new file mode 100644 index 000000000000..0efc967a758c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_CreateOrReplace.json @@ -0,0 +1,157 @@ +{ + "title": "KmsKeys_CreateOrReplace", + "operationId": "KmsKeys_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + } + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Delete.json new file mode 100644 index 000000000000..91d4ad573fa5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "KmsKeys_Delete", + "operationId": "KmsKeys_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Get.json new file mode 100644 index 000000000000..fe748ce17727 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Get.json @@ -0,0 +1,64 @@ +{ + "title": "KmsKeys_Get", + "operationId": "KmsKeys_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListByResourceGroup.json new file mode 100644 index 000000000000..ee8a3b4cb00a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListByResourceGroup.json @@ -0,0 +1,68 @@ +{ + "title": "KmsKeys_ListByResourceGroup", + "operationId": "KmsKeys_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListBySubscription.json new file mode 100644 index 000000000000..d00c32ff8352 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_ListBySubscription.json @@ -0,0 +1,67 @@ +{ + "title": "KmsKeys_ListBySubscription", + "operationId": "KmsKeys_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Update.json new file mode 100644 index 000000000000..6d3af64aa25a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/KmsKeys_Update.json @@ -0,0 +1,74 @@ +{ + "title": "KmsKeys_Update", + "operationId": "KmsKeys_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "741D5637-79E3-4D02-92EB-BA70DD022B84", + "resourceGroupName": "rgkmsKey", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2630": "ricxxxkbcqrtuipdpdxsutvqetomj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "qglsfyxssylnrh", + "bypassPolicyLockoutSafetyCheck": true, + "description": "mjtmquqbhnvjw", + "enableKeyRotation": true, + "enabled": true, + "keyId": "hgwon", + "keyPolicy": {}, + "keySpec": "ECC_NIST_P256", + "keyUsage": "ENCRYPT_DECRYPT", + "multiRegion": true, + "origin": "AWS_KMS", + "pendingWindowInDays": 7, + "rotationPeriodInDays": 4, + "tags": [ + { + "key": "eprsfobey", + "value": "lcaeaqxughlzgzhbbi" + } + ] + }, + "publicCloudConnectorsResourceId": "tsbeayhnreovxnkbtbrvnuielziq", + "awsAccountId": "rvkcvpmljvwdryvsugsuc", + "arn": "qszqxzva", + "publicCloudResourceName": "edkcxntzxplnpl", + "awsSourceSchema": "cvatoa", + "awsRegion": "hvyzzutginnqrhgkyyripyqhqkofm", + "awsTags": { + "key8656": "ctsbcnfhcvojqkiouaoyaetkdt" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3909": "dxto" + }, + "location": "qozbasr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/KmsKeys/{resourceName}", + "name": "dfo", + "type": "unpjbgwatmazyftqovtelh", + "systemData": { + "createdBy": "wxtwboy", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.210Z", + "lastModifiedBy": "tyceewhbirfdcrbjhq", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.211Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_CreateOrReplace.json new file mode 100644 index 000000000000..8e59ffb5a041 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "LambdaFunctionCodeLocations_CreateOrReplace", + "operationId": "LambdaFunctionCodeLocations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + } + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Delete.json new file mode 100644 index 000000000000..e1d4b8451143 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LambdaFunctionCodeLocations_Delete", + "operationId": "LambdaFunctionCodeLocations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Get.json new file mode 100644 index 000000000000..5fb3ec4809e4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Get.json @@ -0,0 +1,49 @@ +{ + "title": "LambdaFunctionCodeLocations_Get", + "operationId": "LambdaFunctionCodeLocations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListByResourceGroup.json new file mode 100644 index 000000000000..3a34f6241828 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "LambdaFunctionCodeLocations_ListByResourceGroup", + "operationId": "LambdaFunctionCodeLocations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListBySubscription.json new file mode 100644 index 000000000000..48769924f671 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "LambdaFunctionCodeLocations_ListBySubscription", + "operationId": "LambdaFunctionCodeLocations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Update.json new file mode 100644 index 000000000000..fe6d3ab6188d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctionCodeLocations_Update.json @@ -0,0 +1,59 @@ +{ + "title": "LambdaFunctionCodeLocations_Update", + "operationId": "LambdaFunctionCodeLocations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "06DA6700-F19F-4332-BEDB-50A7D3C23BC8", + "resourceGroupName": "rglambdaFunctionCodeLocation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2617": "iwaalayfaojfhxd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "imageUri": "vgxgdgxjcgxywrlgksntztsti", + "location": "wntythncasjf", + "repositoryType": "rokpwfiqhiulnmmyjxfwchgk", + "resolvedImageUri": "forzmeqdjmd" + }, + "publicCloudConnectorsResourceId": "hqutrljrwdofyqxdprvsolekoxh", + "awsAccountId": "kddvcdwz", + "arn": "cavnxpszexpsxi", + "publicCloudResourceName": "zqervnldc", + "awsSourceSchema": "dqmxkbgxzzurnbdbrodipprola", + "awsRegion": "gpffqddhhsxbkcblgd", + "awsTags": { + "key6065": "ghgubugjmthvonixbfyqrkyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5879": "ddtmzkfuznyfoikgo" + }, + "location": "qkuouoekvqfxgj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctionCodeLocations/{resourceName}", + "name": "qenfk", + "type": "bbvmvwnpsrkuorgjruuccdirlrzi", + "systemData": { + "createdBy": "vfos", + "createdByType": "User", + "createdAt": "2024-10-08T16:22:39.361Z", + "lastModifiedBy": "btnpfvanhspqh", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T16:22:39.362Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_CreateOrReplace.json new file mode 100644 index 000000000000..3be94f916d17 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_CreateOrReplace.json @@ -0,0 +1,358 @@ +{ + "title": "LambdaFunctions_CreateOrReplace", + "operationId": "LambdaFunctions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + } + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Delete.json new file mode 100644 index 000000000000..07d4b73e0f3f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LambdaFunctions_Delete", + "operationId": "LambdaFunctions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Get.json new file mode 100644 index 000000000000..2930c832171b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Get.json @@ -0,0 +1,131 @@ +{ + "title": "LambdaFunctions_Get", + "operationId": "LambdaFunctions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListByResourceGroup.json new file mode 100644 index 000000000000..656c20da255d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListByResourceGroup.json @@ -0,0 +1,135 @@ +{ + "title": "LambdaFunctions_ListByResourceGroup", + "operationId": "LambdaFunctions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + ], + "nextLink": "https://microsoft.com/afquez" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListBySubscription.json new file mode 100644 index 000000000000..bb76f009cc07 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_ListBySubscription.json @@ -0,0 +1,134 @@ +{ + "title": "LambdaFunctions_ListBySubscription", + "operationId": "LambdaFunctions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + ], + "nextLink": "https://microsoft.com/afquez" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Update.json new file mode 100644 index 000000000000..54e2d5c5d50c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LambdaFunctions_Update.json @@ -0,0 +1,141 @@ +{ + "title": "LambdaFunctions_Update", + "operationId": "LambdaFunctions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "62D0873B-AF66-4F24-93EC-7FCAE7F10D5C", + "resourceGroupName": "rglambdaFunction", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6434": "ezegqcosapc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "architectures": [ + "arm64" + ], + "arn": "stgpeog", + "code": { + "imageUri": "mumnivivaclgokdozsqygicoz", + "s3Bucket": "iqxcjanbelhti", + "s3Key": "c", + "s3ObjectVersion": "ixwkaazvqllwohxjwjtivxy", + "zipFile": "cashtgbjnebsmmyijmbuerim" + }, + "codeSigningConfigArn": "qutlevvo", + "deadLetterConfig": { + "targetArn": "yfmmazkodblnhgalpsnx" + }, + "description": "yvdoxaozwjzszqnt", + "environment": { + "variables": { + "key999": "knzbtalbwzajrfxietghzjqrewh" + } + }, + "ephemeralStorage": { + "size": 21 + }, + "fileSystemConfigs": [ + { + "arn": "lgaajhamrjhiw", + "localMountPath": "ctjvtoy" + } + ], + "functionName": "fkv", + "handler": "penuepcuxqvyjozfpxcxkujpeiib", + "imageConfig": { + "command": [ + "ypqwmituqujgxriqqe" + ], + "entryPoint": [ + "vfnpuvvmmxttsaolsfocwhrhvaycbd" + ], + "workingDirectory": "gnpkvohajxgtqcweloswwofgev" + }, + "kmsKeyArn": "nheruevkdkuk", + "layers": [ + "bwczxgdagr" + ], + "loggingConfig": { + "applicationLogLevel": "DEBUG", + "logFormat": "JSON", + "logGroup": "zrsmuig", + "systemLogLevel": "DEBUG" + }, + "memorySize": 21, + "packageType": "Image", + "reservedConcurrentExecutions": 28, + "role": "tuoem", + "runtime": "srxhlxqifkewuflrxzjauzdqqkoatl", + "runtimeManagementConfig": { + "runtimeVersionArn": "lqpuhdoaicnpryovplogsolsacxbk", + "updateRuntimeOn": "Auto" + }, + "snapStart": { + "applyOn": "None" + }, + "snapStartResponse": { + "applyOn": "None", + "optimizationStatus": "Off" + }, + "tags": [ + { + "key": "hweqw", + "value": "qctpnmjttccpi" + } + ], + "timeout": 28, + "tracingConfig": { + "mode": "Active" + }, + "vpcConfig": { + "ipv6AllowedForDualStack": true, + "securityGroupIds": [ + "ovxbygrfhfhno" + ], + "subnetIds": [ + "inqatpkusunkgccviubzkijhrgslec" + ] + } + }, + "publicCloudConnectorsResourceId": "izvoucedmqtsihfjz", + "awsAccountId": "jhircduhthqiztp", + "arn": "wksjbkhocigdctupfiheutlmloir", + "publicCloudResourceName": "odptbducplnqaqoeleidffnyqfcipg", + "awsSourceSchema": "joyfyjrulh", + "awsRegion": "nat", + "awsTags": { + "key4553": "qdudhyzvebfiewg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9520": "pnmk" + }, + "location": "pipiphijlvjolohsfpmym", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LambdaFunctions/{resourceName}", + "name": "qdak", + "type": "nvjnqmkk", + "systemData": { + "createdBy": "jdaipbsidjogzt", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:45.983Z", + "lastModifiedBy": "fbyeucjqelhntzvpkbhmhbync", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:45.984Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_CreateOrReplace.json new file mode 100644 index 000000000000..67571dfc1146 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_CreateOrReplace.json @@ -0,0 +1,166 @@ +{ + "title": "LightsailBuckets_CreateOrReplace", + "operationId": "LightsailBuckets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + } + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Delete.json new file mode 100644 index 000000000000..f1bb06c1a795 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LightsailBuckets_Delete", + "operationId": "LightsailBuckets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Get.json new file mode 100644 index 000000000000..29f0620b3ccd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Get.json @@ -0,0 +1,67 @@ +{ + "title": "LightsailBuckets_Get", + "operationId": "LightsailBuckets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListByResourceGroup.json new file mode 100644 index 000000000000..2af052fbe847 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListByResourceGroup.json @@ -0,0 +1,71 @@ +{ + "title": "LightsailBuckets_ListByResourceGroup", + "operationId": "LightsailBuckets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListBySubscription.json new file mode 100644 index 000000000000..32a2580d7770 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_ListBySubscription.json @@ -0,0 +1,70 @@ +{ + "title": "LightsailBuckets_ListBySubscription", + "operationId": "LightsailBuckets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Update.json new file mode 100644 index 000000000000..b31d46093bed --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailBuckets_Update.json @@ -0,0 +1,77 @@ +{ + "title": "LightsailBuckets_Update", + "operationId": "LightsailBuckets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D90ACA5C-B44D-4D18-8B7E-F7F7EE2B0DD1", + "resourceGroupName": "rglightsailBucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1875": "hdyasteghcrytmfrujlkng" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "ableToUpdateBundle": true, + "accessRules": { + "allowPublicOverrides": true, + "getObject": "rzsbxpoywnkypgcjndwgjxurwaggf" + }, + "bucketArn": "khrxjzjloawhlsscrupp", + "bucketName": "rbqqhyugkapyxigvfygdmmsig", + "bundleId": "s", + "objectVersioning": true, + "readOnlyAccessAccounts": [ + "yptmppbxsgfmbvcoourx" + ], + "resourcesReceivingAccess": [ + "abmltbmvfqgzha" + ], + "tags": [ + { + "key": "pllzblljxgv", + "value": "onksgozpshqfschbsuyhhui" + } + ], + "url": "dzofeppuoqkmehqcpzpezbmbvrvqbn" + }, + "publicCloudConnectorsResourceId": "vcenimpnlashmiz", + "awsAccountId": "wqlujalgyyyfgmedzj", + "arn": "uoyqkdsfok", + "publicCloudResourceName": "aqpayfdjm", + "awsSourceSchema": "kcjmzaxkkbztlm", + "awsRegion": "kozgryjoinum", + "awsTags": { + "key7074": "efcntnbhiifsphfneto" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4407": "iuaeevz" + }, + "location": "ctcjoqkhbmgwtqztn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailBuckets/{resourceName}", + "name": "rkporzdndsluhrdrkavuxzbdhl", + "type": "zypee", + "systemData": { + "createdBy": "htscft", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:37.492Z", + "lastModifiedBy": "eiiptp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:37.492Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_CreateOrReplace.json new file mode 100644 index 000000000000..b8e48b0e2b50 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_CreateOrReplace.json @@ -0,0 +1,331 @@ +{ + "title": "LightsailInstances_CreateOrReplace", + "operationId": "LightsailInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + } + }, + "tags": { + "key2601": "s" + }, + "location": "cry" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Delete.json new file mode 100644 index 000000000000..def4c4e15f32 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LightsailInstances_Delete", + "operationId": "LightsailInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Get.json new file mode 100644 index 000000000000..fc6a17718149 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Get.json @@ -0,0 +1,122 @@ +{ + "title": "LightsailInstances_Get", + "operationId": "LightsailInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..3f5c9269a5df --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListByResourceGroup.json @@ -0,0 +1,126 @@ +{ + "title": "LightsailInstances_ListByResourceGroup", + "operationId": "LightsailInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListBySubscription.json new file mode 100644 index 000000000000..54a15afad654 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_ListBySubscription.json @@ -0,0 +1,125 @@ +{ + "title": "LightsailInstances_ListBySubscription", + "operationId": "LightsailInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Update.json new file mode 100644 index 000000000000..3a41991c6250 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LightsailInstances_Update.json @@ -0,0 +1,132 @@ +{ + "title": "LightsailInstances_Update", + "operationId": "LightsailInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED3F07C8-BDC0-4DA2-A5FD-EFDD19F6F7C3", + "resourceGroupName": "rglightsailInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7201": "ueivrzjdihomqggzrzaissujr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "addOns": [ + { + "addOnType": "dk", + "autoSnapshotAddOnRequest": { + "snapshotTimeOfDay": "mnthrtsoittlqrvxnwvrbaxaazh" + }, + "status": "Disabled" + } + ], + "availabilityZone": "an", + "blueprintId": "fcezpmlwqhchkvmrdnywpr", + "bundleId": "yckqxqitrffsidmdxkrmaulfgmrj", + "hardware": { + "cpuCount": 30, + "disks": [ + { + "attachedTo": "qoievao", + "attachmentState": "ujinucmjcnzuosaqycrkndh", + "diskName": "tmfpjhluaytgmpxxqtccohpge", + "iops": 11, + "isSystemDisk": true, + "path": "urbubhyieizmbnyddjkyaadmod", + "sizeInGb": "vpd" + } + ], + "ramSizeInGb": 4 + }, + "instanceArn": "mnodcgqlejrhlctqngwxyoqewk", + "instanceName": "xfxnlievrppfrt", + "isStaticIp": true, + "keyPairName": "wtwjhokvviiafrsb", + "location": { + "availabilityZone": "t", + "regionName": "zgmew" + }, + "networking": { + "monthlyTransfer": { + "gbPerMonthAllocated": "dvbefi" + }, + "ports": [ + { + "accessDirection": "bybrpghkgcvx", + "accessFrom": "kslf", + "accessType": "dcqaucgpbxngw", + "cidrListAliases": [ + "btgxaahlpibcqefsgcghfd" + ], + "cidrs": [ + "lhmvhnh" + ], + "commonName": "t", + "fromPort": 23, + "ipv6Cidrs": [ + "qladlrdxfiad" + ], + "protocol": "bzikwazzeydyrukrjhsaogkkxua", + "toPort": 13 + } + ] + }, + "privateIpAddress": "ieeqsrklgnc", + "publicIpAddress": "vonneqx", + "resourceType": "obxjqk", + "sshKeyName": "vjifxmchpparahfut", + "state": { + "code": 29, + "name": "xdtssqcrsvaqphv" + }, + "supportCode": "nxvcadptkoljiizhffgqdqqzkc", + "tags": [ + { + "key": "oeyvtbbbaviazuesvytzykdrje", + "value": "vbybagbqynriyix" + } + ], + "userData": "f", + "userName": "rhivoaleeqwog" + }, + "publicCloudConnectorsResourceId": "vsgxzwhzepjvcjjoqj", + "awsAccountId": "bclcfxetkkugpyilojpvoypui", + "arn": "dcvwurrexherolt", + "publicCloudResourceName": "ibkgqwotzyy", + "awsSourceSchema": "zzcfeeoutptp", + "awsRegion": "zjxqlmimpqxec", + "awsTags": { + "key8646": "ilziiib" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2601": "s" + }, + "location": "cry", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LightsailInstances/{resourceName}", + "name": "cbectofyydqecqgockmputsryovezv", + "type": "hthvmhdklczrnygmke", + "systemData": { + "createdBy": "blsimlejtjargvahwsbht", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:08.537Z", + "lastModifiedBy": "lfswmoctjixl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:08.537Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_CreateOrReplace.json new file mode 100644 index 000000000000..87ccfd5f46c6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_CreateOrReplace.json @@ -0,0 +1,133 @@ +{ + "title": "LogsLogGroups_CreateOrReplace", + "operationId": "LogsLogGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + } + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Delete.json new file mode 100644 index 000000000000..6dd783152022 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsLogGroups_Delete", + "operationId": "LogsLogGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Get.json new file mode 100644 index 000000000000..0426fcd862e8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Get.json @@ -0,0 +1,56 @@ +{ + "title": "LogsLogGroups_Get", + "operationId": "LogsLogGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..89d756291eb7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "title": "LogsLogGroups_ListByResourceGroup", + "operationId": "LogsLogGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListBySubscription.json new file mode 100644 index 000000000000..5ed82370d081 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_ListBySubscription.json @@ -0,0 +1,59 @@ +{ + "title": "LogsLogGroups_ListBySubscription", + "operationId": "LogsLogGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Update.json new file mode 100644 index 000000000000..9dedde6971c8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogGroups_Update.json @@ -0,0 +1,66 @@ +{ + "title": "LogsLogGroups_Update", + "operationId": "LogsLogGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4A48F384-2C79-477A-9D4B-EDEA5BBBE616", + "resourceGroupName": "rglogsLogGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1200": "cwjw" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "nyrge", + "kmsKeyId": "gjzov", + "logGroupClass": "INFREQUENT_ACCESS", + "logGroupName": "ekbugjqparpxebzmfaykh", + "retentionInDays": 17, + "tags": [ + { + "key": "nxdfvdzxuh", + "value": "x" + } + ] + }, + "publicCloudConnectorsResourceId": "ascstrkrmxqtxw", + "awsAccountId": "jgnahcwppywqceisitgmjsw", + "arn": "seajw", + "publicCloudResourceName": "ldqwutaylcywem", + "awsSourceSchema": "ryhknij", + "awsRegion": "vejderqihcaeihktrpgsuizcp", + "awsTags": { + "key2050": "xjhmqjcueiq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9158": "iflnc" + }, + "location": "phnyiqu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogGroups/{resourceName}", + "name": "obzggsmladbgadzihofizlyf", + "type": "fqv", + "systemData": { + "createdBy": "rrwaofocdlktnjmzvpolc", + "createdByType": "User", + "createdAt": "2024-10-08T04:09:53.952Z", + "lastModifiedBy": "ilxlcusadxorgpgidweulmzbcon", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:09:53.952Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_CreateOrReplace.json new file mode 100644 index 000000000000..c9504c339d67 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "LogsLogStreams_CreateOrReplace", + "operationId": "LogsLogStreams_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + } + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Delete.json new file mode 100644 index 000000000000..994dc6e1d7f5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsLogStreams_Delete", + "operationId": "LogsLogStreams_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Get.json new file mode 100644 index 000000000000..717f3190e088 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Get.json @@ -0,0 +1,47 @@ +{ + "title": "LogsLogStreams_Get", + "operationId": "LogsLogStreams_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListByResourceGroup.json new file mode 100644 index 000000000000..8d1325a1afe0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "LogsLogStreams_ListByResourceGroup", + "operationId": "LogsLogStreams_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListBySubscription.json new file mode 100644 index 000000000000..c2bdca633c2e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "LogsLogStreams_ListBySubscription", + "operationId": "LogsLogStreams_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Update.json new file mode 100644 index 000000000000..581ec2c1b115 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsLogStreams_Update.json @@ -0,0 +1,57 @@ +{ + "title": "LogsLogStreams_Update", + "operationId": "LogsLogStreams_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9160168B-8A2D-469C-9369-81D8A5069FB0", + "resourceGroupName": "rglogsLogStream", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5713": "imsoeale" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logGroupName": "bfwnrdojlqlwrmih", + "logStreamName": "pbtlxfgftiixnduazjvqezmnpwbr" + }, + "publicCloudConnectorsResourceId": "lihllkk", + "awsAccountId": "wdatjpiqtspvmqdqquuhipephuthnh", + "arn": "lzfqztmbbgeu", + "publicCloudResourceName": "wftlmsgyanjghqoyfkzoqgqxrcdkq", + "awsSourceSchema": "ffgsbwzxveleoxawcyogkiigworq", + "awsRegion": "dzyiblunsedfhiq", + "awsTags": { + "key9843": "dbwvhopavlbkhbaofrgwznkwoj" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6354": "a" + }, + "location": "kptftndcymfuhgrknmxtkeqwlpjun", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsLogStreams/{resourceName}", + "name": "vgqiwnoslesmwgvckknr", + "type": "minueydyqyqx", + "systemData": { + "createdBy": "ptroxzievmgsnoeoalrfxdvhgtuho", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:25.163Z", + "lastModifiedBy": "zljqnfbdwpxbujwalz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:25.163Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_CreateOrReplace.json new file mode 100644 index 000000000000..0f77888380ac --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "LogsMetricFilters_CreateOrReplace", + "operationId": "LogsMetricFilters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + } + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Delete.json new file mode 100644 index 000000000000..4f14d28d920a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsMetricFilters_Delete", + "operationId": "LogsMetricFilters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Get.json new file mode 100644 index 000000000000..cae0b4dc1509 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Get.json @@ -0,0 +1,63 @@ +{ + "title": "LogsMetricFilters_Get", + "operationId": "LogsMetricFilters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListByResourceGroup.json new file mode 100644 index 000000000000..d8e95aa3e1e3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "LogsMetricFilters_ListByResourceGroup", + "operationId": "LogsMetricFilters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListBySubscription.json new file mode 100644 index 000000000000..af9eebda7845 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "LogsMetricFilters_ListBySubscription", + "operationId": "LogsMetricFilters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Update.json new file mode 100644 index 000000000000..b92b9a830e8a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsMetricFilters_Update.json @@ -0,0 +1,73 @@ +{ + "title": "LogsMetricFilters_Update", + "operationId": "LogsMetricFilters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1953C85F-55BF-4474-ABF1-AFD826040C23", + "resourceGroupName": "rglogsMetricFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key75": "kgh" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "filterName": "xexgsguaaqmkiteqgc", + "filterPattern": "xkejasx", + "logGroupName": "cugxyp", + "metricTransformations": [ + { + "defaultValue": 7, + "dimensions": [ + { + "key": "aevchjwu", + "value": "rosnaljwmrdesiticsc" + } + ], + "metricName": "oybfr", + "metricNamespace": "iabzdcxljvduduha", + "metricValue": "rpkrrqxywciyvedsvrlbujqjenrlpr", + "unit": "Bits" + } + ] + }, + "publicCloudConnectorsResourceId": "dabxbsdvufxltivnlbpft", + "awsAccountId": "z", + "arn": "cjjfhzeoyddkfmdmwsl", + "publicCloudResourceName": "ljjatut", + "awsSourceSchema": "tekgcey", + "awsRegion": "qjqubwwtlycfy", + "awsTags": { + "key5547": "bdcrhaondaponausevadhudvvfitd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5537": "lpylvddirnglehlucv" + }, + "location": "hvjoetfjcwqioibnqqj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsMetricFilters/{resourceName}", + "name": "dqrq", + "type": "tvosmcolzzivjzyjrhoq", + "systemData": { + "createdBy": "osecvnpfolmgqdwlcojyizoja", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:32.762Z", + "lastModifiedBy": "odnfxckyqjdubpqbpawsjmyi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:32.763Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_CreateOrReplace.json new file mode 100644 index 000000000000..472136effecd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "LogsSubscriptionFilters_CreateOrReplace", + "operationId": "LogsSubscriptionFilters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + } + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Delete.json new file mode 100644 index 000000000000..c4ba58bac994 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "LogsSubscriptionFilters_Delete", + "operationId": "LogsSubscriptionFilters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Get.json new file mode 100644 index 000000000000..54dd99e4387c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Get.json @@ -0,0 +1,51 @@ +{ + "title": "LogsSubscriptionFilters_Get", + "operationId": "LogsSubscriptionFilters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListByResourceGroup.json new file mode 100644 index 000000000000..77cde08d6f91 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "LogsSubscriptionFilters_ListByResourceGroup", + "operationId": "LogsSubscriptionFilters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListBySubscription.json new file mode 100644 index 000000000000..9daa1ccc1073 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "LogsSubscriptionFilters_ListBySubscription", + "operationId": "LogsSubscriptionFilters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Update.json new file mode 100644 index 000000000000..d426a87561c9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/LogsSubscriptionFilters_Update.json @@ -0,0 +1,61 @@ +{ + "title": "LogsSubscriptionFilters_Update", + "operationId": "LogsSubscriptionFilters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "1D64C70C-A85E-4BC8-BA19-130CCA2A2EED", + "resourceGroupName": "rglogsSubscriptionFilter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6314": "jqbixrisvuk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "destinationArn": "k", + "distribution": "ByLogStream", + "filterName": "tboamjix", + "filterPattern": "ui", + "logGroupName": "ku", + "roleArn": "qgjbnrzdeigsxsfrkkfiaf" + }, + "publicCloudConnectorsResourceId": "ywjmogqrbdroewncecotnxyijemqjz", + "awsAccountId": "fckvzypgfibfyknjwyrvmez", + "arn": "sbvdldikixyoalpxj", + "publicCloudResourceName": "gilkw", + "awsSourceSchema": "anvmszmmknfesvacxje", + "awsRegion": "oogmbpnzqlvdmcntbzbsi", + "awsTags": { + "key7628": "ipzrwulgfuznh" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9410": "ajuntrgfwfnfaobudwmc" + }, + "location": "chliijcrgqpxjf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/LogsSubscriptionFilters/{resourceName}", + "name": "absefomwvezvofheloadtrcpwldja", + "type": "qsxzobgmbqox", + "systemData": { + "createdBy": "tnftpzigysad", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.352Z", + "lastModifiedBy": "g", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.353Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..5ea477a2e539 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_CreateOrReplace.json @@ -0,0 +1,355 @@ +{ + "title": "Macie2JobSummaries_CreateOrReplace", + "operationId": "Macie2JobSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + } + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Delete.json new file mode 100644 index 000000000000..501cd4d8476e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Macie2JobSummaries_Delete", + "operationId": "Macie2JobSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Get.json new file mode 100644 index 000000000000..411307f8423a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Get.json @@ -0,0 +1,130 @@ +{ + "title": "Macie2JobSummaries_Get", + "operationId": "Macie2JobSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..53e03259d489 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListByResourceGroup.json @@ -0,0 +1,134 @@ +{ + "title": "Macie2JobSummaries_ListByResourceGroup", + "operationId": "Macie2JobSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListBySubscription.json new file mode 100644 index 000000000000..e1257c005e46 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_ListBySubscription.json @@ -0,0 +1,133 @@ +{ + "title": "Macie2JobSummaries_ListBySubscription", + "operationId": "Macie2JobSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Update.json new file mode 100644 index 000000000000..0c5d3362b11d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Macie2JobSummaries_Update.json @@ -0,0 +1,140 @@ +{ + "title": "Macie2JobSummaries_Update", + "operationId": "Macie2JobSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "ED946605-D8B4-4EFB-BCCF-6334E5A8CAB0", + "resourceGroupName": "rgmacie2JobSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4316": "ujowm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "bucketCriteria": { + "excludes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + }, + "includes": { + "and": [ + { + "simpleCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "key": { + "value": "ACCOUNT_ID" + }, + "values": [ + "jtymirlxjxhaohkasaozlwag" + ] + }, + "tagCriterion": { + "comparator": { + "value": "CONTAINS" + }, + "tagValues": [ + { + "key": "gygqhiagsveuxhrughhbddqpmufuwb", + "value": "yfiitptbkmgpsdnnhvfc" + } + ] + } + } + ] + } + }, + "bucketDefinitions": [ + { + "accountId": "eprxunabacgebqtyyff", + "buckets": [ + "nxnhxjevimwkagh" + ] + } + ], + "createdAt": "2024-10-08T03:51:31.106Z", + "jobId": "jtjrvg", + "jobStatus": { + "value": "CANCELLED" + }, + "jobType": { + "value": "ONE_TIME" + }, + "lastRunErrorStatus": { + "code": { + "value": "ERROR" + } + }, + "name": "hjsakzgyfymsxrppmgaqz", + "userPausedDetails": { + "jobExpiresAt": "2024-10-08T03:51:31.107Z", + "jobImminentExpirationHealthEventArn": "tildeulhgl", + "jobPausedAt": "2024-10-08T03:51:31.107Z" + } + }, + "publicCloudConnectorsResourceId": "pwacjrxitwye", + "awsAccountId": "foqcspfycfsvpqbfbcjutxvsaswla", + "arn": "gdmxefbzkonlgcinjivhec", + "publicCloudResourceName": "xxlvdlekmm", + "awsSourceSchema": "ucjahtqlqosuutn", + "awsRegion": "lvgptsi", + "awsTags": { + "key5346": "hygpr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7937": "ksoxoxkqu" + }, + "location": "sxbjamusvyf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Macie2JobSummaries/{resourceName}", + "name": "qudjxsijrxroghlueytcvgjxcqmz", + "type": "ecdy", + "systemData": { + "createdBy": "qlmurecdmqrwxtarqxabrfrybf", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:31.107Z", + "lastModifiedBy": "eyqyaurlont", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:31.107Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_CreateOrReplace.json new file mode 100644 index 000000000000..4d0c89514698 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_CreateOrReplace.json @@ -0,0 +1,154 @@ +{ + "title": "MacieAllowLists_CreateOrReplace", + "operationId": "MacieAllowLists_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + } + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Delete.json new file mode 100644 index 000000000000..5a6e3956bc75 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "MacieAllowLists_Delete", + "operationId": "MacieAllowLists_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Get.json new file mode 100644 index 000000000000..18caf5413c0d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Get.json @@ -0,0 +1,63 @@ +{ + "title": "MacieAllowLists_Get", + "operationId": "MacieAllowLists_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListByResourceGroup.json new file mode 100644 index 000000000000..7a112119e58d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "title": "MacieAllowLists_ListByResourceGroup", + "operationId": "MacieAllowLists_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListBySubscription.json new file mode 100644 index 000000000000..59d57811d463 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_ListBySubscription.json @@ -0,0 +1,66 @@ +{ + "title": "MacieAllowLists_ListBySubscription", + "operationId": "MacieAllowLists_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Update.json new file mode 100644 index 000000000000..7981355efb06 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/MacieAllowLists_Update.json @@ -0,0 +1,73 @@ +{ + "title": "MacieAllowLists_Update", + "operationId": "MacieAllowLists_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "99856A98-ABE1-4E25-92A6-8D8A50D967C0", + "resourceGroupName": "rgmacieAllowList", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3904": "gamym" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "xdvleyfipecptdivylwygmlsaua", + "criteria": { + "regex": "lixefi", + "s3WordsList": { + "bucketName": "nfztmnzebbxtnmqmrmyqnuho", + "objectKey": "pobipzkebqlgjxfwucoq" + } + }, + "description": "wvwzsjgqyvyjbb", + "id": "ssesuxsvbo", + "name": "nkimocnjypmzr", + "status": "OK", + "tags": [ + { + "key": "hjfhvyhpoebquxi", + "value": "hipfzph" + } + ] + }, + "publicCloudConnectorsResourceId": "rqoahjiblmrymixvgegzwfqdq", + "awsAccountId": "jf", + "arn": "iuotvbrnfqcexaumxdelcobenu", + "publicCloudResourceName": "ggubisvuvunhxrj", + "awsSourceSchema": "vviqkggctwa", + "awsRegion": "x", + "awsTags": { + "key6335": "ewozmljpzvhwyzkp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2466": "ptogkwqufoxaylatzvn" + }, + "location": "ljfzlbopfuubipqzi", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/MacieAllowLists/{resourceName}", + "name": "hvagfcfptxeifjf", + "type": "ssktygpznapsfmazabgfpgstp", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:30.080Z", + "lastModifiedBy": "dggwiqjlupwdzmhztxiuckspxytkpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:30.080Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..7c52bfeb0195 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_CreateOrReplace.json @@ -0,0 +1,292 @@ +{ + "title": "NetworkFirewallFirewallPolicies_CreateOrReplace", + "operationId": "NetworkFirewallFirewallPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + } + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Delete.json new file mode 100644 index 000000000000..76f971e09080 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Delete", + "operationId": "NetworkFirewallFirewallPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Get.json new file mode 100644 index 000000000000..807200cbaa77 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Get.json @@ -0,0 +1,109 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Get", + "operationId": "NetworkFirewallFirewallPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..13dd0d489995 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListByResourceGroup.json @@ -0,0 +1,113 @@ +{ + "title": "NetworkFirewallFirewallPolicies_ListByResourceGroup", + "operationId": "NetworkFirewallFirewallPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListBySubscription.json new file mode 100644 index 000000000000..a3347433de09 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_ListBySubscription.json @@ -0,0 +1,112 @@ +{ + "title": "NetworkFirewallFirewallPolicies_ListBySubscription", + "operationId": "NetworkFirewallFirewallPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Update.json new file mode 100644 index 000000000000..5d30ffe97094 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewallPolicies_Update.json @@ -0,0 +1,119 @@ +{ + "title": "NetworkFirewallFirewallPolicies_Update", + "operationId": "NetworkFirewallFirewallPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F9AB5664-617E-413B-A5CF-5C3EAFB2981D", + "resourceGroupName": "rgnetworkFirewallFirewallPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1616": "holwoveppqufirqaboze" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "lgkmdcxkddlt", + "firewallPolicy": { + "policyVariables": { + "ruleVariables": { + "key6441": { + "definition": [ + "nwcsmd" + ] + } + } + }, + "statefulDefaultActions": [ + "rhluwzzqiehteaka" + ], + "statefulEngineOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER", + "streamExceptionPolicy": "CONTINUE" + }, + "statefulRuleGroupReferences": [ + { + "override": { + "action": "DROP_TO_ALERT" + }, + "priority": 24, + "resourceArn": "mjmcihwfckvrmkqo" + } + ], + "statelessCustomActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "kpelhvywxyvfwbkxeepdvujwrlywy" + } + ] + } + }, + "actionName": "vzrqjgluyejlinwxxhuljye" + } + ], + "statelessDefaultActions": [ + "bhojbxqneam" + ], + "statelessFragmentDefaultActions": [ + "lnpufwfpveptbxocevsbt" + ], + "statelessRuleGroupReferences": [ + { + "priority": 11, + "resourceArn": "kjggnkcabwynhgqkoryqzbkwz" + } + ], + "tlsInspectionConfigurationArn": "qrdcssdykfcsxjdimv" + }, + "firewallPolicyArn": "xpoahy", + "firewallPolicyId": "ofrzbmefsngq", + "firewallPolicyName": "xasgbvm", + "tags": [ + { + "key": "njlfcpwz", + "value": "lrpynqejzy" + } + ] + }, + "publicCloudConnectorsResourceId": "jgglyugkzlbqyphcmiuchfpzd", + "awsAccountId": "fvglwybfwcjydvshvpaqacdtncc", + "arn": "rwqxtqealkkjplaoauziyt", + "publicCloudResourceName": "txlbnhchqhqamo", + "awsSourceSchema": "tupxubxwdvvlcxhmjn", + "awsRegion": "ujnhepy", + "awsTags": { + "key2264": "v" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2040": "rrw" + }, + "location": "jmirflesx", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewallPolicies/{resourceName}", + "name": "fqdrydmfxo", + "type": "bjuizwltaantx", + "systemData": { + "createdBy": "q", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:52.697Z", + "lastModifiedBy": "fagudhodaytb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:52.698Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_CreateOrReplace.json new file mode 100644 index 000000000000..c57de77c14f3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_CreateOrReplace.json @@ -0,0 +1,172 @@ +{ + "title": "NetworkFirewallFirewalls_CreateOrReplace", + "operationId": "NetworkFirewallFirewalls_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + } + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Delete.json new file mode 100644 index 000000000000..59a01bf3e9a5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallFirewalls_Delete", + "operationId": "NetworkFirewallFirewalls_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Get.json new file mode 100644 index 000000000000..f45480ca013c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Get.json @@ -0,0 +1,69 @@ +{ + "title": "NetworkFirewallFirewalls_Get", + "operationId": "NetworkFirewallFirewalls_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListByResourceGroup.json new file mode 100644 index 000000000000..334e659125ac --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "title": "NetworkFirewallFirewalls_ListByResourceGroup", + "operationId": "NetworkFirewallFirewalls_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + ], + "nextLink": "https://microsoft.com/aobno" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListBySubscription.json new file mode 100644 index 000000000000..c002b8406ed1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_ListBySubscription.json @@ -0,0 +1,72 @@ +{ + "title": "NetworkFirewallFirewalls_ListBySubscription", + "operationId": "NetworkFirewallFirewalls_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + ], + "nextLink": "https://microsoft.com/aobno" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Update.json new file mode 100644 index 000000000000..b39910237ea9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallFirewalls_Update.json @@ -0,0 +1,79 @@ +{ + "title": "NetworkFirewallFirewalls_Update", + "operationId": "NetworkFirewallFirewalls_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193F761D-95B2-4E2F-A8EE-432BC68DC5DB", + "resourceGroupName": "rgnetworkFirewallFirewall", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3088": "vjjgvfr" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "deleteProtection": true, + "description": "yjsjz", + "endpointIds": [ + "ivgfubgdwmucvasgqbxyoxs" + ], + "firewallArn": "eukqjtyapnpaslgpyrjsuuuvrja", + "firewallId": "ecwdwcfmctxuqrpliya", + "firewallName": "rbcjdcahhnsogdcoklk", + "firewallPolicyArn": "evdxwcayrnvbn", + "firewallPolicyChangeProtection": true, + "subnetChangeProtection": true, + "subnetMappings": [ + { + "ipAddressType": "gkcalzfxwkomabldynmunz", + "subnetId": "kmo" + } + ], + "tags": [ + { + "key": "kasiukxlhrjduzsis", + "value": "fnavszvtxyetugcmqvandzxjawuq" + } + ], + "vpcId": "cxrvqz" + }, + "publicCloudConnectorsResourceId": "qjo", + "awsAccountId": "tcfbgbhrgcpvphfftvjmhjqg", + "arn": "zc", + "publicCloudResourceName": "hloidqb", + "awsSourceSchema": "syydqlqovymaflzph", + "awsRegion": "ctyppkrhygaywzprynu", + "awsTags": { + "key9022": "plamuzuouuqwcslfbnicnejtvd" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1029": "evfw" + }, + "location": "shwlgihd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallFirewalls/{resourceName}", + "name": "ubxxjliwcbasgrmay", + "type": "brgakvgezzypfnrxfe", + "systemData": { + "createdBy": "a", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:12.682Z", + "lastModifiedBy": "gapcocbeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:12.683Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_CreateOrReplace.json new file mode 100644 index 000000000000..e121b17b7130 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_CreateOrReplace.json @@ -0,0 +1,508 @@ +{ + "title": "NetworkFirewallRuleGroups_CreateOrReplace", + "operationId": "NetworkFirewallRuleGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + } + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Delete.json new file mode 100644 index 000000000000..34286306ae15 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "NetworkFirewallRuleGroups_Delete", + "operationId": "NetworkFirewallRuleGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Get.json new file mode 100644 index 000000000000..3bed1067086a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Get.json @@ -0,0 +1,181 @@ +{ + "title": "NetworkFirewallRuleGroups_Get", + "operationId": "NetworkFirewallRuleGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..9b90cff840a6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListByResourceGroup.json @@ -0,0 +1,185 @@ +{ + "title": "NetworkFirewallRuleGroups_ListByResourceGroup", + "operationId": "NetworkFirewallRuleGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + ], + "nextLink": "https://microsoft.com/aggil" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListBySubscription.json new file mode 100644 index 000000000000..bfb3124edefc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_ListBySubscription.json @@ -0,0 +1,184 @@ +{ + "title": "NetworkFirewallRuleGroups_ListBySubscription", + "operationId": "NetworkFirewallRuleGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + ], + "nextLink": "https://microsoft.com/aggil" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Update.json new file mode 100644 index 000000000000..f7ee0b22ddf3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/NetworkFirewallRuleGroups_Update.json @@ -0,0 +1,191 @@ +{ + "title": "NetworkFirewallRuleGroups_Update", + "operationId": "NetworkFirewallRuleGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD7E6DEA-5FAD-4F87-A399-409D1421048F", + "resourceGroupName": "rgnetworkFirewallRuleGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6654": "hotlqlsbbihxanwfhmjmc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "capacity": 13, + "description": "zlkovsdkoamizsf", + "ruleGroup": { + "referenceSets": { + "ipSetReferences": { + "key2227": { + "referenceArn": "oytryvxnweahmshhucxpblpuc" + } + } + }, + "ruleVariables": { + "ipSets": { + "key2970": { + "definition": [ + "aizprahgi" + ] + } + }, + "portSets": { + "key1199": { + "definition": [ + "wwayyzoztulbvq" + ] + } + } + }, + "rulesSource": { + "rulesSourceList": { + "generatedRulesType": "ALLOWLIST", + "targetTypes": [ + "efuuy" + ], + "targets": [ + "pnecsfopd" + ] + }, + "rulesString": "xujqqtutwcprdqudsnalep", + "statefulRules": [ + { + "action": "ALERT", + "header": { + "destination": "monehvupaofeakgppr", + "destinationPort": "qlhyfsewpdlrpkxbdwfojdz", + "direction": "ANY", + "protocol": "DCERPC", + "source": "bmxmxcbelcmrkaigfwwbtbakerp", + "sourcePort": "ieimsyntk" + }, + "ruleOptions": [ + { + "keyword": "obxwkhfbshjufmmrpjtskldelzb", + "settings": [ + "xflxrtoyhczflnevdftw" + ] + } + ] + } + ], + "statelessRulesAndCustomActions": { + "customActions": [ + { + "actionDefinition": { + "publishMetricAction": { + "dimensions": [ + { + "value": "wninrpqzvmeovspprohpjge" + } + ] + } + }, + "actionName": "kcfqhtt" + } + ], + "statelessRules": [ + { + "priority": 11, + "ruleDefinition": { + "actions": [ + "ofwytyaxwaoxjuhfror" + ], + "matchAttributes": { + "destinationPorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "destinations": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "protocols": [ + 27 + ], + "sourcePorts": [ + { + "fromPort": 15, + "toPort": 3 + } + ], + "sources": [ + { + "addressDefinition": "upxiaznlcwpjgrahrg" + } + ], + "tcpFlags": [ + { + "flags": [ + "hc" + ], + "masks": [ + "yycdx" + ] + } + ] + } + } + } + ] + } + }, + "statefulRuleOptions": { + "ruleOrder": "DEFAULT_ACTION_ORDER" + } + }, + "ruleGroupArn": "ncyehiokafjeadkrhonngdvqgtmdm", + "ruleGroupId": "qfdxbisrqddn", + "ruleGroupName": "dypivpjvrdiecto", + "tags": [ + { + "key": "wuuykkzufgvvtcpdohiydsnqvutq", + "value": "pbppqwfrbdysivibwbk" + } + ], + "type": "STATEFUL" + }, + "publicCloudConnectorsResourceId": "zholufsqpqkxgirpxvvr", + "awsAccountId": "lbmcidte", + "arn": "uzwseilcphanlymsepokkjnzich", + "publicCloudResourceName": "gpndbetnqj", + "awsSourceSchema": "ymsi", + "awsRegion": "vnwwozbuhjsi", + "awsTags": { + "key4273": "swpshhbiotzowyypprwmbrjpyhyqbf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4955": "zqpelqnmwqzqrenv" + }, + "location": "npjhzlsmeqnuoj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/NetworkFirewallRuleGroups/{resourceName}", + "name": "uzcrmvzepwuehycywssojadsor", + "type": "epmgbkvsztlzffyxfhrs", + "systemData": { + "createdBy": "qbvtcdkywrtnbgl", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:59.093Z", + "lastModifiedBy": "pwnwr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:59.094Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_CreateOrReplace.json new file mode 100644 index 000000000000..421e3cc0d50b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_CreateOrReplace.json @@ -0,0 +1,604 @@ +{ + "title": "OpenSearchDomainStatuses_CreateOrReplace", + "operationId": "OpenSearchDomainStatuses_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + } + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Delete.json new file mode 100644 index 000000000000..ae173c53df92 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OpenSearchDomainStatuses_Delete", + "operationId": "OpenSearchDomainStatuses_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Get.json new file mode 100644 index 000000000000..98c6809d5b86 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Get.json @@ -0,0 +1,213 @@ +{ + "title": "OpenSearchDomainStatuses_Get", + "operationId": "OpenSearchDomainStatuses_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..596fdd8d791a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListByResourceGroup.json @@ -0,0 +1,217 @@ +{ + "title": "OpenSearchDomainStatuses_ListByResourceGroup", + "operationId": "OpenSearchDomainStatuses_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListBySubscription.json new file mode 100644 index 000000000000..95cefbefe79d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_ListBySubscription.json @@ -0,0 +1,216 @@ +{ + "title": "OpenSearchDomainStatuses_ListBySubscription", + "operationId": "OpenSearchDomainStatuses_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Update.json new file mode 100644 index 000000000000..bf48626aabc4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OpenSearchDomainStatuses_Update.json @@ -0,0 +1,223 @@ +{ + "title": "OpenSearchDomainStatuses_Update", + "operationId": "OpenSearchDomainStatuses_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "C2A73E1E-2679-40DC-BCCA-DFB54632EE9E", + "resourceGroupName": "rgopenSearchDomainStatus", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7395": "hktrfj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "svblrdkqxeghxc", + "accessPolicies": "zmizapetmvhfuhnuevg", + "advancedOptions": { + "key5855": "vqbdzcigjhn" + }, + "advancedSecurityOptions": { + "anonymousAuthDisableDate": "2024-10-08T03:49:18.317Z", + "anonymousAuthEnabled": true, + "enabled": true, + "internalUserDatabaseEnabled": true, + "samlOptions": { + "enabled": true, + "idp": { + "entityId": "ujb", + "metadataContent": "ncvlnvyvuwdkmspvvynhbjwzzerkl" + }, + "rolesKey": "pphcuihmcksjghguam", + "sessionTimeoutMinutes": 22, + "subjectKey": "pnnavlixxrzg" + } + }, + "autoTuneOptions": { + "errorMessage": "gdouqrr", + "state": { + "value": "DISABLED" + }, + "useOffPeakWindow": true + }, + "changeProgressDetails": { + "changeId": "acuqzpomrpdxccssgsjtftt", + "configChangeStatus": { + "value": "ApplyingChanges" + }, + "initiatedBy": { + "value": "CUSTOMER" + }, + "lastUpdatedTime": "2024-10-08T03:49:18.319Z", + "message": "netweglaakukislhan", + "startTime": "2024-10-08T03:49:18.319Z" + }, + "clusterConfig": { + "coldStorageOptions": { + "enabled": true + }, + "dedicatedMasterCount": 15, + "dedicatedMasterEnabled": true, + "dedicatedMasterType": { + "value": "c4.2xlarge.search" + }, + "instanceCount": 6, + "instanceType": { + "value": "c4.2xlarge.search" + }, + "multiAZWithStandbyEnabled": true, + "warmCount": 29, + "warmEnabled": true, + "warmType": { + "value": "ultrawarm1.large.search" + }, + "zoneAwarenessConfig": { + "availabilityZoneCount": 20 + }, + "zoneAwarenessEnabled": true + }, + "cognitoOptions": { + "enabled": true, + "identityPoolId": "dcpqrbpnpihpqvibpysnhi", + "roleArn": "wdpsbg", + "userPoolId": "oeiqtnpxt" + }, + "created": true, + "deleted": true, + "domainEndpointOptions": { + "customEndpoint": "pkalvbtpzxwdwtzlhet", + "customEndpointCertificateArn": "bmcnynq", + "customEndpointEnabled": true, + "enforceHTTPS": true, + "tlsSecurityPolicy": { + "value": "Policy-Min-TLS-1-0-2019-07" + } + }, + "domainId": "vdvjabmtsxndtepulmirzlkxjc", + "domainName": "zmweyexy", + "domainProcessingStatus": { + "value": "Active" + }, + "ebsOptions": { + "ebsEnabled": true, + "iops": 1, + "throughput": 6, + "volumeSize": 16, + "volumeType": { + "value": "gp2" + } + }, + "encryptionAtRestOptions": { + "enabled": true, + "kmsKeyId": "vfmtoghzhlyifmzgt" + }, + "endpoint": "y", + "endpointV2": "lnmdhcvptzovtjrggoqef", + "endpoints": { + "key7016": "mnbnwxhmvteoxgmcif" + }, + "engineVersion": "nafwkgnvpagjlvctspjtgg", + "ipAddressType": { + "value": "dualstack" + }, + "logPublishingOptions": { + "key1257": { + "cloudWatchLogsLogGroupArn": "yflaoiiuhbxlodpwh", + "enabled": true + } + }, + "modifyingProperties": [ + { + "activeValue": "igvntcixfgeammklivfvtjjxfka", + "name": "wbfqxsudlhdpidezy", + "pendingValue": "n", + "valueType": { + "value": "PLAIN_TEXT" + } + } + ], + "nodeToNodeEncryptionOptions": { + "enabled": true + }, + "offPeakWindowOptions": { + "enabled": true, + "offPeakWindow": { + "windowStartTime": { + "hours": 19, + "minutes": 7 + } + } + }, + "processing": true, + "serviceSoftwareOptions": { + "automatedUpdateDate": "2024-10-08T03:49:18.320Z", + "cancellable": true, + "currentVersion": "ugdoxim", + "description": "moodysfsdplowtykjopgnlgeodxt", + "newVersion": "awqdkyicwktzdn", + "optionalDeployment": true, + "updateAvailable": true, + "updateStatus": { + "value": "COMPLETED" + } + }, + "snapshotOptions": { + "automatedSnapshotStartHour": 9 + }, + "softwareUpdateOptions": { + "autoSoftwareUpdateEnabled": true + }, + "upgradeProcessing": true, + "vpcOptions": { + "availabilityZones": [ + "laxoeorkeojjhcnoji" + ], + "securityGroupIds": [ + "ap" + ], + "subnetIds": [ + "oric" + ], + "vpcId": "jffbtwxjojtqphtd" + } + }, + "publicCloudConnectorsResourceId": "g", + "awsAccountId": "l", + "arn": "xxoyruemlfezddeqgvpfvbvqrmmhzk", + "publicCloudResourceName": "sntfjznnaylmvehihglcoyqpcyacz", + "awsSourceSchema": "qrkamtxqjfb", + "awsRegion": "mpszpnxbznm", + "awsTags": { + "key5895": "bosxipjwti" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9493": "seimlf" + }, + "location": "cjnfjucekzuxbrhfzskptnxmy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OpenSearchDomainStatuses/{resourceName}", + "name": "yuwkzpllpffeycwynrymxayw", + "type": "tc", + "systemData": { + "createdBy": "xzfduaaku", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:18.321Z", + "lastModifiedBy": "vorja", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:18.321Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Operations_List.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Operations_List.json new file mode 100644 index 000000000000..e60a5541785e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Operations_List.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpwxgidstbncuictrf", + "isDataAction": true, + "display": { + "provider": "scgogcdp", + "resource": "uamuwbdfznlancdbyxn", + "operation": "rwlqmshjawphrvtzxrkxczvmglbt", + "description": "zd" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_CreateOrReplace.json new file mode 100644 index 000000000000..620c3e4e605f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_CreateOrReplace.json @@ -0,0 +1,151 @@ +{ + "title": "OrganizationsAccounts_CreateOrReplace", + "operationId": "OrganizationsAccounts_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + } + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Delete.json new file mode 100644 index 000000000000..de3453547214 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OrganizationsAccounts_Delete", + "operationId": "OrganizationsAccounts_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Get.json new file mode 100644 index 000000000000..ec8d031d637c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Get.json @@ -0,0 +1,62 @@ +{ + "title": "OrganizationsAccounts_Get", + "operationId": "OrganizationsAccounts_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListByResourceGroup.json new file mode 100644 index 000000000000..75a8f46fb714 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "title": "OrganizationsAccounts_ListByResourceGroup", + "operationId": "OrganizationsAccounts_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListBySubscription.json new file mode 100644 index 000000000000..2fe43622fc69 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_ListBySubscription.json @@ -0,0 +1,65 @@ +{ + "title": "OrganizationsAccounts_ListBySubscription", + "operationId": "OrganizationsAccounts_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Update.json new file mode 100644 index 000000000000..a1fc5ac8a8ad --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsAccounts_Update.json @@ -0,0 +1,72 @@ +{ + "title": "OrganizationsAccounts_Update", + "operationId": "OrganizationsAccounts_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "0BE8133B-E5E4-4D92-B151-E2B83FBD36BA", + "resourceGroupName": "rgorganizationsAccount", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8859": "bqumxpfvigc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accountId": "kkdjvhtsvtqybdxezywfojndmjpou", + "accountName": "vegcsgzymnbxry", + "arn": "ffkjxnnwpewiiudycadgtyrztehy", + "email": "bwriakvcvyhklvulzwvlddeevj", + "joinedMethod": "CREATED", + "joinedTimestamp": "xdxxffzfzxgewxyavjim", + "parentIds": [ + "xxzonolej" + ], + "roleName": "izpxv", + "status": "ACTIVE", + "tags": [ + { + "key": "jwuqulmpbiwqxudtqfgrtnvxtbyxcb", + "value": "esqhxwyrftlxbuab" + } + ] + }, + "publicCloudConnectorsResourceId": "zbgkie", + "awsAccountId": "ggnntqdpbcdtbjxaiabsgxxmtunblo", + "arn": "zdirlutwidghhfrufpjhexxbsrfxwl", + "publicCloudResourceName": "tmmwrgytiyucnzokuiq", + "awsSourceSchema": "emcozgsikaryx", + "awsRegion": "yvslwciyhnwwnxxrv", + "awsTags": { + "key907": "gwpsscwhgavtczmdnje" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9774": "vgzqosjmzoxfqujm" + }, + "location": "wyzamnearzlajcvzhj", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsAccounts/{resourceName}", + "name": "exyrlvjjmalphltdpztjlgart", + "type": "dmcfvzsn", + "systemData": { + "createdBy": "cteoecwtakqpkdpj", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:34.919Z", + "lastModifiedBy": "ihbhvwvgesr", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:34.920Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_CreateOrReplace.json new file mode 100644 index 000000000000..b10f1fc9d951 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_CreateOrReplace.json @@ -0,0 +1,121 @@ +{ + "title": "OrganizationsOrganizations_CreateOrReplace", + "operationId": "OrganizationsOrganizations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + } + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Delete.json new file mode 100644 index 000000000000..0613a02f307a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "OrganizationsOrganizations_Delete", + "operationId": "OrganizationsOrganizations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Get.json new file mode 100644 index 000000000000..1a6cced26ffa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Get.json @@ -0,0 +1,52 @@ +{ + "title": "OrganizationsOrganizations_Get", + "operationId": "OrganizationsOrganizations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListByResourceGroup.json new file mode 100644 index 000000000000..66e4a563c0ac --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "title": "OrganizationsOrganizations_ListByResourceGroup", + "operationId": "OrganizationsOrganizations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListBySubscription.json new file mode 100644 index 000000000000..ca8f58bc7793 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_ListBySubscription.json @@ -0,0 +1,55 @@ +{ + "title": "OrganizationsOrganizations_ListBySubscription", + "operationId": "OrganizationsOrganizations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Update.json new file mode 100644 index 000000000000..0e6b805afc2f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/OrganizationsOrganizations_Update.json @@ -0,0 +1,62 @@ +{ + "title": "OrganizationsOrganizations_Update", + "operationId": "OrganizationsOrganizations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DD37956E-455B-47F1-BADA-E0EC78902076", + "resourceGroupName": "rgorganizationsOrganization", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5330": "yjjrlmjwsholqusyzoosxblcjwppe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "fzkwsgtciqziilbltckzwq", + "featureSet": "ALL", + "id": "tqnrsqnzkqywpecutoxisdogfsu", + "managementAccountArn": "aobzot", + "managementAccountEmail": "vvcketnvinjxxhqabioa", + "managementAccountId": "bvkksaokvmucejmtqhlwqoiuluet", + "rootId": "jtmupzgyvqhoiag" + }, + "publicCloudConnectorsResourceId": "xdnn", + "awsAccountId": "jusgdaxywgsswam", + "arn": "zitrzzdipihyovymdibklklp", + "publicCloudResourceName": "vvwkbodgowhbhletjswxg", + "awsSourceSchema": "pdqllbj", + "awsRegion": "gogfumxcpzmqfcpynwlbjhjax", + "awsTags": { + "key8866": "zzxfaowxlvuuzuc" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6745": "seperqgwgodhrcsengozvpmpqcp" + }, + "location": "fnzfxrkfm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/OrganizationsOrganizations/{resourceName}", + "name": "ydamgdjqobm", + "type": "u", + "systemData": { + "createdBy": "ocjcmyzadx", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:17.350Z", + "lastModifiedBy": "gidskp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:17.350Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_CreateOrReplace.json new file mode 100644 index 000000000000..3de69e2e2ff2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_CreateOrReplace.json @@ -0,0 +1,379 @@ +{ + "title": "RdsDbClusters_CreateOrReplace", + "operationId": "RdsDbClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + } + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Delete.json new file mode 100644 index 000000000000..372c08b9a255 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbClusters_Delete", + "operationId": "RdsDbClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Get.json new file mode 100644 index 000000000000..123bf181e81a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Get.json @@ -0,0 +1,138 @@ +{ + "title": "RdsDbClusters_Get", + "operationId": "RdsDbClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..fb16be2e2640 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListByResourceGroup.json @@ -0,0 +1,142 @@ +{ + "title": "RdsDbClusters_ListByResourceGroup", + "operationId": "RdsDbClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListBySubscription.json new file mode 100644 index 000000000000..6b4a6846699b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_ListBySubscription.json @@ -0,0 +1,141 @@ +{ + "title": "RdsDbClusters_ListBySubscription", + "operationId": "RdsDbClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Update.json new file mode 100644 index 000000000000..456b06eb0a02 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbClusters_Update.json @@ -0,0 +1,148 @@ +{ + "title": "RdsDbClusters_Update", + "operationId": "RdsDbClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "DA6A975D-7713-4DCB-8896-2BA94E88DD9D", + "resourceGroupName": "rgrdsDBCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7248": "xdfiauzxmaizplcudjpyspzbyovzp" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 12, + "associatedRoles": [ + { + "featureName": "yupxlegnstbpoght", + "roleArn": "pcilcosyud" + } + ], + "autoMinorVersionUpgrade": true, + "availabilityZones": [ + "xbabqekpowoz" + ], + "backtrackWindow": 18, + "backupRetentionPeriod": 11, + "copyTagsToSnapshot": true, + "dbClusterArn": "zdohcaiqsymzj", + "dbClusterIdentifier": "euvcyppvvutbntragfptjnmzhg", + "dbClusterInstanceClass": "suufjmxymxlrberbqtknmsvzrsajw", + "dbClusterParameterGroupName": "sokiordelmtviobobxrdsw", + "dbClusterResourceId": "vnwlcfxokdrjitagoefxrsf", + "dbInstanceParameterGroupName": "cwhdxixjtyfziflvod", + "dbSubnetGroupName": "ajeipefwih", + "dbSystemId": "exockxknyjqihmhxjuin", + "databaseName": "ttn", + "deletionProtection": true, + "domain": "qzpcprovksxsiuithxqu", + "domainIAMRoleName": "psubmwhsowirjcnv", + "enableCloudwatchLogsExports": [ + "lytydxlnpduhnvmifkneiu" + ], + "enableGlobalWriteForwarding": true, + "enableHttpEndpoint": true, + "enableIAMDatabaseAuthentication": true, + "endpoint": { + "address": "pwliordavkhwfklfzwxic", + "port": "nagvki" + }, + "engine": "cehuc", + "engineMode": "iokki", + "engineVersion": "ziindzjpzdrbcmtougdffweh", + "globalClusterIdentifier": "jqoiwozrdbnumywlieglbpzzx", + "iops": 26, + "kmsKeyId": "vqllbldbdhvsyon", + "manageMasterUserPassword": true, + "masterUserPassword": "qscygehnqvqzynuuqqbehubstti", + "masterUserSecret": { + "kmsKeyId": "vsghhhqurh", + "secretArn": "ibmtek" + }, + "masterUsername": "lusozmpnihhahsioubedg", + "monitoringInterval": 17, + "monitoringRoleArn": "pqckluqmxqazvvi", + "networkType": "mnsuyqfkeqg", + "performanceInsightsEnabled": true, + "performanceInsightsKmsKeyId": "qr", + "performanceInsightsRetentionPeriod": 2, + "port": 23, + "preferredBackupWindow": "shjtwjtugyols", + "preferredMaintenanceWindow": "fuuieyvfhfcanzgutwcdbtbenk", + "publiclyAccessible": true, + "readEndpoint": { + "address": "ca" + }, + "replicationSourceIdentifier": "sdohltrpdqsszpptdh", + "restoreToTime": "srbuhavl", + "restoreType": "tnsdjgvzcnnsjxw", + "scalingConfiguration": { + "autoPause": true, + "maxCapacity": 3, + "minCapacity": 5, + "secondsBeforeTimeout": 28, + "secondsUntilAutoPause": 25, + "timeoutAction": "cqgyqshpkcyblfsqmujyxpfiyv" + }, + "serverlessV2ScalingConfiguration": { + "maxCapacity": 23, + "minCapacity": 16 + }, + "snapshotIdentifier": "vqowgxcqbclzjexvyigvdzlpcdluvv", + "sourceDBClusterIdentifier": "jtvnbddzyqf", + "sourceRegion": "vrzpezvwoszraxdi", + "storageEncrypted": true, + "storageThroughput": 6, + "storageType": "iiwkeunemifyewevpcvcrbs", + "tags": [ + { + "key": "lsvdhwafvfrtobfvrwigfodughve", + "value": "szbfittyghldzvnflsglc" + } + ], + "useLatestRestorableTime": true, + "vpcSecurityGroupIds": [ + "jdkxpjhsibvgvorizsuzta" + ] + }, + "publicCloudConnectorsResourceId": "pexhjqkygfiozfsvo", + "awsAccountId": "rpxoebfhnpwagqqgk", + "arn": "lllohvlgyg", + "publicCloudResourceName": "quyqfarecht", + "awsSourceSchema": "wrucexqlrnssoxvtczytcslheth", + "awsRegion": "fulsvqpnagyrsirhnuxdsppl", + "awsTags": { + "key4409": "weab" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1769": "winoruhwyphtmoskehihj" + }, + "location": "di", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBClusters/{resourceName}", + "name": "uxpivkrjpudwctxwmajudmdkztpyw", + "type": "ujx", + "systemData": { + "createdBy": "yjcoilgnorvxrtbonh", + "createdByType": "User", + "createdAt": "2024-10-09T18:22:15.914Z", + "lastModifiedBy": "ynefcvnn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-09T18:22:15.915Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_CreateOrReplace.json new file mode 100644 index 000000000000..c031804c07bd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_CreateOrReplace.json @@ -0,0 +1,439 @@ +{ + "title": "RdsDbInstances_CreateOrReplace", + "operationId": "RdsDbInstances_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + } + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Delete.json new file mode 100644 index 000000000000..e6f68e50cf55 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbInstances_Delete", + "operationId": "RdsDbInstances_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Get.json new file mode 100644 index 000000000000..e7146b4bd6bf --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Get.json @@ -0,0 +1,158 @@ +{ + "title": "RdsDbInstances_Get", + "operationId": "RdsDbInstances_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..aa9af7216cd9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListByResourceGroup.json @@ -0,0 +1,162 @@ +{ + "title": "RdsDbInstances_ListByResourceGroup", + "operationId": "RdsDbInstances_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListBySubscription.json new file mode 100644 index 000000000000..5df1017f8afa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_ListBySubscription.json @@ -0,0 +1,161 @@ +{ + "title": "RdsDbInstances_ListBySubscription", + "operationId": "RdsDbInstances_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Update.json new file mode 100644 index 000000000000..e0a075a5ca21 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbInstances_Update.json @@ -0,0 +1,168 @@ +{ + "title": "RdsDbInstances_Update", + "operationId": "RdsDbInstances_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9457588B-9E2E-4334-BEC8-1C9A8819ECAB", + "resourceGroupName": "rgrdsDBInstance", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9889": "dcsdkwhyjigrrwuu" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": "ryhixfujuvwifznymxbze", + "allowMajorVersionUpgrade": true, + "associatedRoles": [ + { + "featureName": "jyivqbpnmvg", + "roleArn": "jblmzpmkcvnkvsxkswtmfqlwttf" + } + ], + "autoMinorVersionUpgrade": true, + "automaticBackupReplicationKmsKeyId": "eqwqyzovzxcmragbjhqq", + "automaticBackupReplicationRegion": "h", + "availabilityZone": "ccdhbiqvvdxbszpuhcvsvpuqfrkosf", + "backupRetentionPeriod": 6, + "caCertificateIdentifier": "dp", + "certificateDetails": { + "caIdentifier": "jathtqegixcwxcwmnrlrsycxvyp", + "validTill": "nclrurexsnhed" + }, + "certificateRotationRestart": true, + "characterSetName": "bapraruogdpspvewmd", + "copyTagsToSnapshot": true, + "customIAMInstanceProfile": "ronoghiguflpqdlwef", + "dbClusterIdentifier": "mi", + "dbClusterSnapshotIdentifier": "biqdaekgjeyopntgrx", + "dbInstanceArn": "xxk", + "dbInstanceClass": "xvgbsmhvq", + "dbInstanceIdentifier": "svbefulaqhcsf", + "dbName": "yryxlwvdmghqcfdlhdyykzejtyep", + "dbParameterGroupName": "keuvtxklarpjmikkuwqqfanv", + "dbSecurityGroups": [ + "mgcichzarguqhevlwubzgbvs" + ], + "dbSnapshotIdentifier": "coykeofgbcwpjeihmmajttm", + "dbSubnetGroupName": "yxd", + "dbSystemId": "rlbhsqhwmezvevqsme", + "dbiResourceId": "nlqlrrljz", + "dedicatedLogVolume": true, + "deleteAutomatedBackups": true, + "deletionProtection": true, + "domain": "mkboglzqbejwwfplkhpiwsvndwphik", + "domainAuthSecretArn": "dmjcucptjkvsolzcwxwhv", + "domainDnsIps": [ + "celohfbruu" + ], + "domainFqdn": "txgpdsxlpqbasbbmpzzkdztlfphm", + "domainIAMRoleName": "ljnyfnuzyqodzawuu", + "domainOu": "yhtbsdxktvxrtweyoo", + "enableCloudwatchLogsExports": [ + "anqxngk" + ], + "enableIAMDatabaseAuthentication": true, + "enablePerformanceInsights": true, + "endpoint": { + "address": "rmsxn", + "hostedZoneId": "mvsioevf", + "port": "gfpslsfdtnmrahrfppdwaf" + }, + "engine": "jztlgxuyyhlwrjkgree", + "engineVersion": "fwmhfzboltipjkflr", + "iops": 6, + "kmsKeyId": "pbdblzy", + "licenseModel": "qcmsltdkpdsznfotmqdvnntnfor", + "manageMasterUserPassword": true, + "masterUserPassword": "strxifasjrrb", + "masterUserSecret": { + "kmsKeyId": "czgkafaksjqklj", + "secretArn": "nxpshhiulxttzwuifbqnamexd" + }, + "masterUsername": "lfitzeghwpzjhcbje", + "maxAllocatedStorage": 9, + "monitoringInterval": 17, + "monitoringRoleArn": "a", + "multiAZ": true, + "ncharCharacterSetName": "cc", + "networkType": "bccgoqncxrhuwvgwvwta", + "optionGroupName": "mftqhqogtwleqvlpjpbabps", + "performanceInsightsKMSKeyId": "jyhbotj", + "performanceInsightsRetentionPeriod": 27, + "port": "g", + "preferredBackupWindow": "wesxjihubbcfgwqebebkzmmfoipd", + "preferredMaintenanceWindow": "gtmzlucaagottcm", + "processorFeatures": [ + { + "name": "coreCount", + "value": "qhhoewgkcuvttcihy" + } + ], + "promotionTier": 12, + "publiclyAccessible": true, + "replicaMode": "poucyygmqhpztshwupms", + "restoreTime": "nokteyfkzzvhgjtpmiwxajseiavtbk", + "sourceDBClusterIdentifier": "gkdeeipcvhmgoabz", + "sourceDBInstanceAutomatedBackupsArn": "lisujvucnvopgkehpacmkjshk", + "sourceDBInstanceIdentifier": "ypufdzwdqxkygzmrp", + "sourceDbiResourceId": "btzodcuervx", + "sourceRegion": "ez", + "storageEncrypted": true, + "storageThroughput": 16, + "storageType": "ywcy", + "tags": [ + { + "key": "kilbegh", + "value": "rdhflka" + } + ], + "tdeCredentialArn": "twmu", + "tdeCredentialPassword": "fqedsuqphkwhafmptzeruepeqalyty", + "timezone": "euyueykvptytmbnfj", + "useDefaultProcessorFeatures": true, + "useLatestRestorableTime": true, + "vpcSecurityGroups": [ + "nxllphmorxutzaym" + ] + }, + "publicCloudConnectorsResourceId": "etsvehjovtdbgzuwnmgw", + "awsAccountId": "xjspz", + "arn": "ikxozbmzhxy", + "publicCloudResourceName": "bvkzujojjsvihxyajddbqxygffaqm", + "awsSourceSchema": "cjfztsurj", + "awsRegion": "dmudtaomgrfchc", + "awsTags": { + "key3142": "myscjjenjqhbmtoiyyjauxlu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7306": "yhvoznqrgbna" + }, + "location": "pktn", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBInstances/{resourceName}", + "name": "mlawrgduorvzcrxqyngpsq", + "type": "kwkppcfedecgrwxw", + "systemData": { + "createdBy": "hmfspwqxviuspvafhzqpwnzzmlhhm", + "createdByType": "User", + "createdAt": "2024-10-08T04:10:01.739Z", + "lastModifiedBy": "oazwztztysteog", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:10:01.740Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_CreateOrReplace.json new file mode 100644 index 000000000000..96dfc2c3ee3c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_CreateOrReplace.json @@ -0,0 +1,127 @@ +{ + "title": "RdsDbSnapshotAttributesResults_CreateOrReplace", + "operationId": "RdsDbSnapshotAttributesResults_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + } + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Delete.json new file mode 100644 index 000000000000..adf4d755461e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Delete", + "operationId": "RdsDbSnapshotAttributesResults_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Get.json new file mode 100644 index 000000000000..0da2baef31ce --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Get.json @@ -0,0 +1,54 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Get", + "operationId": "RdsDbSnapshotAttributesResults_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListByResourceGroup.json new file mode 100644 index 000000000000..dfc7dd9740a4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListByResourceGroup.json @@ -0,0 +1,58 @@ +{ + "title": "RdsDbSnapshotAttributesResults_ListByResourceGroup", + "operationId": "RdsDbSnapshotAttributesResults_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListBySubscription.json new file mode 100644 index 000000000000..aa2fe70b1df4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_ListBySubscription.json @@ -0,0 +1,57 @@ +{ + "title": "RdsDbSnapshotAttributesResults_ListBySubscription", + "operationId": "RdsDbSnapshotAttributesResults_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Update.json new file mode 100644 index 000000000000..4fd7c1e8757d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshotAttributesResults_Update.json @@ -0,0 +1,64 @@ +{ + "title": "RdsDbSnapshotAttributesResults_Update", + "operationId": "RdsDbSnapshotAttributesResults_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "35CC4E65-6C65-4C96-9530-BC167F4B9BF8", + "resourceGroupName": "rgrdsDBSnapshotAttributesResult", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7927": "s" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "dbSnapshotAttributes": [ + { + "attributeName": "yszcujemf", + "attributeValues": [ + "cffn" + ] + } + ], + "dbSnapshotIdentifier": "hgeztauvapideyaajrbafqyup" + }, + "publicCloudConnectorsResourceId": "bmzbcvocakxlkqxmewfdruhn", + "awsAccountId": "za", + "arn": "wctkioaluqun", + "publicCloudResourceName": "kuhhovfpzvgapi", + "awsSourceSchema": "w", + "awsRegion": "ndsijffpilnosnrldocuqrlxitjpv", + "awsTags": { + "key3566": "heyaatumbeog" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3873": "mmtaqjm" + }, + "location": "luzcqukssqazokzghltlzp", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshotAttributesResults/{resourceName}", + "name": "hlddyy", + "type": "mspfsnpbnkv", + "systemData": { + "createdBy": "gjuzobvlptivmmwsvyjreg", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:56.320Z", + "lastModifiedBy": "nnxrcktntoimrbpzn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:56.320Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_CreateOrReplace.json new file mode 100644 index 000000000000..cf61b2b490f5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_CreateOrReplace.json @@ -0,0 +1,238 @@ +{ + "title": "RdsDbSnapshots_CreateOrReplace", + "operationId": "RdsDbSnapshots_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + } + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Delete.json new file mode 100644 index 000000000000..ee21d0f43922 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsDbSnapshots_Delete", + "operationId": "RdsDbSnapshots_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Get.json new file mode 100644 index 000000000000..4861776d1720 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Get.json @@ -0,0 +1,91 @@ +{ + "title": "RdsDbSnapshots_Get", + "operationId": "RdsDbSnapshots_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListByResourceGroup.json new file mode 100644 index 000000000000..1f832d46e1b5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListByResourceGroup.json @@ -0,0 +1,95 @@ +{ + "title": "RdsDbSnapshots_ListByResourceGroup", + "operationId": "RdsDbSnapshots_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListBySubscription.json new file mode 100644 index 000000000000..a35ee4baff71 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_ListBySubscription.json @@ -0,0 +1,94 @@ +{ + "title": "RdsDbSnapshots_ListBySubscription", + "operationId": "RdsDbSnapshots_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Update.json new file mode 100644 index 000000000000..f284e88b390b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsDbSnapshots_Update.json @@ -0,0 +1,101 @@ +{ + "title": "RdsDbSnapshots_Update", + "operationId": "RdsDbSnapshots_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "193A42E2-B9B7-4E2C-A1BC-6AD260D123E4", + "resourceGroupName": "rgrdsDBSnapshot", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4303": "igefqj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allocatedStorage": 10, + "availabilityZone": "kayjlaciv", + "dbInstanceIdentifier": "sgszwrakxshyzice", + "dbSnapshotArn": "xdjclnyyjohzhbe", + "dbSnapshotIdentifier": "yeju", + "dbSystemId": "fzavlejrrugjcdxaetdvvhg", + "dbiResourceId": "jwxsvn", + "dedicatedLogVolume": true, + "encrypted": true, + "engine": "xkjeovmjwpoycteiloodhzsyly", + "engineVersion": "ycrrezzqweeassrgalnqmcuhnk", + "iamDatabaseAuthenticationEnabled": true, + "instanceCreateTime": "2024-10-08T03:49:38.588Z", + "iops": 7, + "kmsKeyId": "lblvrtpgcfkwhhylmefrzvf", + "licenseModel": "wbcqlk", + "masterUsername": "ahyhxkpctusl", + "multiTenant": true, + "optionGroupName": "zxrglvxvd", + "originalSnapshotCreateTime": "2024-10-08T03:49:38.589Z", + "percentProgress": 19, + "port": 11, + "processorFeatures": [ + { + "name": "sidrqdpoqaeon", + "value": "elyxiifmhltlaxelehotutvcfcmqii" + } + ], + "snapshotCreateTime": "2024-10-08T03:49:38.589Z", + "snapshotDatabaseTime": "2024-10-08T03:49:38.589Z", + "snapshotTarget": "uvkzzwcpvrfjw", + "snapshotType": "iiydwpezfwmejabymfqpelcifgzng", + "sourceDBSnapshotIdentifier": "awxakkqcvryuhqdbunoz", + "sourceRegion": "vrldyuopcfabthhgxvpnybgtfdi", + "status": "mwktzwjlfzywwkgrjhl", + "storageThroughput": 1, + "storageType": "i", + "tagList": [ + { + "key": "mzixrqjicfutjmwsvhfrku", + "value": "gbyocywzau" + } + ], + "tdeCredentialArn": "eyoddxncbnezesemvnxd", + "timezone": "coraguclwgryiiynjhpes", + "vpcId": "fpweamshtdzkrbhcqenn" + }, + "publicCloudConnectorsResourceId": "ptkmloddhzkiphtdnmdhlx", + "awsAccountId": "gimhekqewbnatvrjiewxszwd", + "arn": "nqbzizmcdbvsukdqhrdcg", + "publicCloudResourceName": "uoecdcxuxiu", + "awsSourceSchema": "sfaw", + "awsRegion": "qk", + "awsTags": { + "key7020": "vzcdzxrdsvgurfovupzzumr" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key752": "byquognttsccsvhrdhc" + }, + "location": "ojgfpymabvdpgvknjfvaecf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsDBSnapshots/{resourceName}", + "name": "h", + "type": "jy", + "systemData": { + "createdBy": "jzhrzihnqyp", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:38.590Z", + "lastModifiedBy": "elglvvdgfoemw", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:38.590Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_CreateOrReplace.json new file mode 100644 index 000000000000..b1140484e85b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "RdsEventSubscriptions_CreateOrReplace", + "operationId": "RdsEventSubscriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + } + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Delete.json new file mode 100644 index 000000000000..34d7dec158cc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsEventSubscriptions_Delete", + "operationId": "RdsEventSubscriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Get.json new file mode 100644 index 000000000000..8248c5efa2cc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Get.json @@ -0,0 +1,61 @@ +{ + "title": "RdsEventSubscriptions_Get", + "operationId": "RdsEventSubscriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..23df6425b124 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "RdsEventSubscriptions_ListByResourceGroup", + "operationId": "RdsEventSubscriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListBySubscription.json new file mode 100644 index 000000000000..1658f206798a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "RdsEventSubscriptions_ListBySubscription", + "operationId": "RdsEventSubscriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Update.json new file mode 100644 index 000000000000..c1c153bd816b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsEventSubscriptions_Update.json @@ -0,0 +1,71 @@ +{ + "title": "RdsEventSubscriptions_Update", + "operationId": "RdsEventSubscriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "26EF8637-16EF-416A-BAFF-B92B3989AB72", + "resourceGroupName": "rgrdsEventSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3694": "ceskyfrlxhgbminxalfyipftsqqn" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "enabled": true, + "eventCategories": [ + "lvuizykyfm" + ], + "snsTopicArn": "bztzoygofaokcwvheylcjtyhzumi", + "sourceIds": [ + "yhyohxasdyzulieniumz" + ], + "sourceType": "tvb", + "subscriptionName": "we", + "tags": [ + { + "key": "msbxnlvpqauwxmkadft", + "value": "mfwztutpnzzxe" + } + ] + }, + "publicCloudConnectorsResourceId": "iyeipvkxsknmro", + "awsAccountId": "zfsrgkfzsvgfonnvm", + "arn": "thfrxqrzoqkdimx", + "publicCloudResourceName": "shpjwd", + "awsSourceSchema": "ymnxhmzxhihjztmgswvngnhiuzw", + "awsRegion": "sxpprlqqhjuob", + "awsTags": { + "key3613": "dmf" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9661": "yqugcfnhgotantrltcjoz" + }, + "location": "zw", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsEventSubscriptions/{resourceName}", + "name": "zquqlxcpxxejxc", + "type": "pmt", + "systemData": { + "createdBy": "ahkstdpgsrdefghpvmxrlybsfamtm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:05.032Z", + "lastModifiedBy": "d", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:05.032Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_CreateOrReplace.json new file mode 100644 index 000000000000..33b07025c7a3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_CreateOrReplace.json @@ -0,0 +1,160 @@ +{ + "title": "RdsExportTasks_CreateOrReplace", + "operationId": "RdsExportTasks_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + } + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Delete.json new file mode 100644 index 000000000000..0b0d5c812f02 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RdsExportTasks_Delete", + "operationId": "RdsExportTasks_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Get.json new file mode 100644 index 000000000000..942bd6b9b4e9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Get.json @@ -0,0 +1,65 @@ +{ + "title": "RdsExportTasks_Get", + "operationId": "RdsExportTasks_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListByResourceGroup.json new file mode 100644 index 000000000000..22929b934ebd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListByResourceGroup.json @@ -0,0 +1,69 @@ +{ + "title": "RdsExportTasks_ListByResourceGroup", + "operationId": "RdsExportTasks_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListBySubscription.json new file mode 100644 index 000000000000..63c1c2d5d705 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_ListBySubscription.json @@ -0,0 +1,68 @@ +{ + "title": "RdsExportTasks_ListBySubscription", + "operationId": "RdsExportTasks_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Update.json new file mode 100644 index 000000000000..08bd03697fa7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RdsExportTasks_Update.json @@ -0,0 +1,75 @@ +{ + "title": "RdsExportTasks_Update", + "operationId": "RdsExportTasks_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A10F1A25-EBE7-4BDB-A76D-8BFEF3B8C801", + "resourceGroupName": "rgrdsExportTask", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8327": "fublgdavougwxwbj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "exportOnly": [ + "tgbwsfhgnayugsqipjaogglzrm" + ], + "exportTaskIdentifier": "miwmgyeweeibkjbwagqc", + "failureCause": "mnjjuzhtylheweav", + "iamRoleArn": "fexryvrii", + "kmsKeyId": "nzp", + "percentProgress": 5, + "s3Bucket": "zwwzvtjvoadrnmvvidwl", + "s3Prefix": "vgo", + "snapshotTime": "2024-10-08T03:51:37.230Z", + "sourceArn": "mojassuswxqincuqhoonftpslnqh", + "sourceType": { + "value": "CLUSTER" + }, + "status": "cjaqynzkqtyptrbwud", + "taskEndTime": "2024-10-08T03:51:37.231Z", + "taskStartTime": "2024-10-08T03:51:37.231Z", + "totalExtractedDataInGB": 7, + "warningMessage": "hugvgitctxgsxkvywhlldbqe" + }, + "publicCloudConnectorsResourceId": "xugphqsqnlgtlne", + "awsAccountId": "oaxdvv", + "arn": "baufqssokdhluztwcuatl", + "publicCloudResourceName": "exprhkzxutckvlwxawcqfy", + "awsSourceSchema": "eopblwzcihujlmoctzvwfoirhqkbx", + "awsRegion": "bnpl", + "awsTags": { + "key353": "mjctanldpnvzjlfsxl" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6517": "fgvwvrfxewegzvticmnntbypm" + }, + "location": "ijwmlpipjiyjjldyoytyluf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RdsExportTasks/{resourceName}", + "name": "ncgijmzpxvtk", + "type": "gyyjpmpnernbpwnxwaniprg", + "systemData": { + "createdBy": "bnuseyojgzfqwhcawyumx", + "createdByType": "User", + "createdAt": "2024-10-08T03:51:37.233Z", + "lastModifiedBy": "iryueuhyeqlpptabakhwnju", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:51:37.233Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_CreateOrReplace.json new file mode 100644 index 000000000000..7a7b40ddf8cd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_CreateOrReplace.json @@ -0,0 +1,145 @@ +{ + "title": "RedshiftClusterParameterGroups_CreateOrReplace", + "operationId": "RedshiftClusterParameterGroups_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + } + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Delete.json new file mode 100644 index 000000000000..b253b88568ee --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RedshiftClusterParameterGroups_Delete", + "operationId": "RedshiftClusterParameterGroups_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Get.json new file mode 100644 index 000000000000..74dca67461aa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Get.json @@ -0,0 +1,60 @@ +{ + "title": "RedshiftClusterParameterGroups_Get", + "operationId": "RedshiftClusterParameterGroups_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..f70804014029 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "RedshiftClusterParameterGroups_ListByResourceGroup", + "operationId": "RedshiftClusterParameterGroups_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListBySubscription.json new file mode 100644 index 000000000000..4372f055dda3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "RedshiftClusterParameterGroups_ListBySubscription", + "operationId": "RedshiftClusterParameterGroups_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Update.json new file mode 100644 index 000000000000..6546304489c3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusterParameterGroups_Update.json @@ -0,0 +1,70 @@ +{ + "title": "RedshiftClusterParameterGroups_Update", + "operationId": "RedshiftClusterParameterGroups_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D3AF2B91-531C-421E-853F-4AA271A750EF", + "resourceGroupName": "rgredshiftClusterParameterGroup", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key900": "ivgflws" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "gvl", + "parameterGroupFamily": "bbhnqerzrhqtinntphvuim", + "parameterGroupName": "tiqxhqigpmuckmnpgijvnpwzb", + "parameters": [ + { + "parameterName": "jxeucnajvjzv", + "parameterValue": "ubxmwmoxeslbruenu" + } + ], + "tags": [ + { + "key": "ucdvfenzatoxmpdicwhztuvgtnku", + "value": "qpznlj" + } + ] + }, + "publicCloudConnectorsResourceId": "nrs", + "awsAccountId": "fdljzalgig", + "arn": "whliokkrefhwytv", + "publicCloudResourceName": "xnrwtxesebdfzrqiamebczhoyjbqeq", + "awsSourceSchema": "nkdbqnqvsdnvogwatfxlubppr", + "awsRegion": "wrhyhrmwhdmlnjjbrl", + "awsTags": { + "key6090": "vaqtqamdjobsgwecpvyxeerjrrxac" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key4322": "zjgvmwcimdtqwxhy" + }, + "location": "gskgxjliwptm", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusterParameterGroups/{resourceName}", + "name": "jptweejzcgxaqbqtgwmij", + "type": "unqigioekfjbhrgxjvahgeguazxu", + "systemData": { + "createdBy": "lbunmflgnpuqnxekxeic", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:00.892Z", + "lastModifiedBy": "idntjajwapedyz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:00.892Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_CreateOrReplace.json new file mode 100644 index 000000000000..5695fbe6a3d8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_CreateOrReplace.json @@ -0,0 +1,313 @@ +{ + "title": "RedshiftClusters_CreateOrReplace", + "operationId": "RedshiftClusters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + } + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Delete.json new file mode 100644 index 000000000000..c692e7f75ff1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "RedshiftClusters_Delete", + "operationId": "RedshiftClusters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Get.json new file mode 100644 index 000000000000..34aa95242029 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Get.json @@ -0,0 +1,116 @@ +{ + "title": "RedshiftClusters_Get", + "operationId": "RedshiftClusters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListByResourceGroup.json new file mode 100644 index 000000000000..1ad8df1d3b79 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListByResourceGroup.json @@ -0,0 +1,120 @@ +{ + "title": "RedshiftClusters_ListByResourceGroup", + "operationId": "RedshiftClusters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListBySubscription.json new file mode 100644 index 000000000000..b5707f4128ab --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_ListBySubscription.json @@ -0,0 +1,119 @@ +{ + "title": "RedshiftClusters_ListBySubscription", + "operationId": "RedshiftClusters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Update.json new file mode 100644 index 000000000000..7475ee08e4b2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/RedshiftClusters_Update.json @@ -0,0 +1,126 @@ +{ + "title": "RedshiftClusters_Update", + "operationId": "RedshiftClusters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EE81A3BE-45B4-42BB-808E-F1779C8388C3", + "resourceGroupName": "rgredshiftCluster", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9218": "mhocleqdpv" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowVersionUpgrade": true, + "aquaConfigurationStatus": "tegpcduavwdyuubx", + "automatedSnapshotRetentionPeriod": 25, + "availabilityZone": "pltpsjmmvhfmsecqjjweuxgloitbor", + "availabilityZoneRelocation": true, + "availabilityZoneRelocationStatus": "kcuxuluzsnuoag", + "classic": true, + "clusterIdentifier": "cxlflpabmavbfbcvsew", + "clusterNamespaceArn": "vqeqeacmkdhmzgwd", + "clusterParameterGroupName": "whpcckoms", + "clusterSecurityGroups": [ + "q" + ], + "clusterSubnetGroupName": "abxmcpkzazgxtuoliedvam", + "clusterType": "nvbzlybkkhuyklhhywuofwczf", + "clusterVersion": "slmurdmhpiuakdwrqdthvlrpovqb", + "dbName": "jsbtuqgydkydraogl", + "deferMaintenance": true, + "deferMaintenanceDuration": 14, + "deferMaintenanceEndTime": "oluxv", + "deferMaintenanceIdentifier": "icu", + "deferMaintenanceStartTime": "muevcssxlqrrmwxvazpsrq", + "destinationRegion": "cnklawqwbweklmlrhr", + "elasticIp": "ljpfzxzciavjuxk", + "encrypted": true, + "endpoint": { + "address": "imgtktlniedocmgatpyzycge", + "port": "gm" + }, + "enhancedVpcRouting": true, + "hsmClientCertificateIdentifier": "uguhqzduujaf", + "hsmConfigurationIdentifier": "cznipmuxibdjvmteim", + "iamRoles": [ + "qmy" + ], + "kmsKeyId": "afzaldvlyzmotwzdmydry", + "loggingProperties": { + "bucketName": "mozpscmusdfzk", + "s3KeyPrefix": "lffsxgand" + }, + "maintenanceTrackName": "etjeimmqcipuyxiobrnsnd", + "manageMasterPassword": true, + "manualSnapshotRetentionPeriod": 15, + "masterPasswordSecretArn": "upomdaqltagvwlqpyojnlmtme", + "masterPasswordSecretKmsKeyId": "izpx", + "masterUserPassword": "mftjs", + "masterUsername": "wleeglygnhojusagxryuk", + "multiAZ": true, + "nodeType": "cudgc", + "numberOfNodes": 23, + "ownerAccount": "drvv", + "port": 8, + "preferredMaintenanceWindow": "xpuhqwidzbn", + "publiclyAccessible": true, + "resourceAction": "nyhkwgrtf", + "revisionTarget": "dreawjciiytkiuywtwttqyhojh", + "rotateEncryptionKey": true, + "snapshotClusterIdentifier": "gu", + "snapshotCopyGrantName": "mwuomnttvwhduluhwnfkiwkaeztbmd", + "snapshotCopyManual": true, + "snapshotCopyRetentionPeriod": 2, + "snapshotIdentifier": "viproibmlhehvlszhxkqbbgl", + "tags": [ + { + "key": "znz", + "value": "zawcpsgqfgrsjexrbo" + } + ], + "vpcSecurityGroupIds": [ + "grbkothiifmuwwrme" + ] + }, + "publicCloudConnectorsResourceId": "r", + "awsAccountId": "lnlhkk", + "arn": "egooffvtlbzyvp", + "publicCloudResourceName": "ck", + "awsSourceSchema": "zdadxraykcjparteiye", + "awsRegion": "lablaxpspbxzhnbsrqz", + "awsTags": { + "key9665": "eyxhhlvcfit" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5296": "hllwcfzqbninv" + }, + "location": "jvkejlkfwoynldopbqhnt", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/RedshiftClusters/{resourceName}", + "name": "sjjujbtiyilr", + "type": "ocggkhao", + "systemData": { + "createdBy": "ho", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:51.706Z", + "lastModifiedBy": "eyqnytcsi", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:51.706Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..de1b91fb4998 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_CreateOrReplace.json @@ -0,0 +1,112 @@ +{ + "title": "Route53DomainsDomainSummaries_CreateOrReplace", + "operationId": "Route53DomainsDomainSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + } + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Delete.json new file mode 100644 index 000000000000..11ed9089ba3f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53DomainsDomainSummaries_Delete", + "operationId": "Route53DomainsDomainSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Get.json new file mode 100644 index 000000000000..927d4dd1dbd8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Get.json @@ -0,0 +1,49 @@ +{ + "title": "Route53DomainsDomainSummaries_Get", + "operationId": "Route53DomainsDomainSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..3d92f8ddd4b9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "title": "Route53DomainsDomainSummaries_ListByResourceGroup", + "operationId": "Route53DomainsDomainSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + ], + "nextLink": "https://microsoft.com/acktixge" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListBySubscription.json new file mode 100644 index 000000000000..5079eb3ad5bc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_ListBySubscription.json @@ -0,0 +1,52 @@ +{ + "title": "Route53DomainsDomainSummaries_ListBySubscription", + "operationId": "Route53DomainsDomainSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + ], + "nextLink": "https://microsoft.com/acktixge" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Update.json new file mode 100644 index 000000000000..05dd773afd9e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53DomainsDomainSummaries_Update.json @@ -0,0 +1,59 @@ +{ + "title": "Route53DomainsDomainSummaries_Update", + "operationId": "Route53DomainsDomainSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "469E3760-3A42-4CB4-9153-B2733AEDE961", + "resourceGroupName": "rgroute53DomainsDomainSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8975": "iofguxotyhapdccidejuibcxjpit" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "autoRenew": true, + "domainName": "zvofrrcpsq", + "expiry": "2024-10-08T03:54:06.143Z", + "transferLock": true + }, + "publicCloudConnectorsResourceId": "xghzjqidhyawkmjgmcylp", + "awsAccountId": "vcuytljgzjlxqbqafyjyotrm", + "arn": "wrwdlajgtnvqtehqwjewdams", + "publicCloudResourceName": "l", + "awsSourceSchema": "tmisqqzyhunvwrvagqsndin", + "awsRegion": "kfqnxegwwlydcxbrps", + "awsTags": { + "key3432": "uypuabeq" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9394": "fo" + }, + "location": "yuzdde", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53DomainsDomainSummaries/{resourceName}", + "name": "koofgtnyevxtjghmvqxokuqxszg", + "type": "xxbzvlfgwsxqpoemnxgywispscyd", + "systemData": { + "createdBy": "scyhppovbynrryrpsecddqrvwja", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:06.335Z", + "lastModifiedBy": "jqhvnyqmaiefngonodispvhizabb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:06.336Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_CreateOrReplace.json new file mode 100644 index 000000000000..a945963b4b04 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "Route53HostedZones_CreateOrReplace", + "operationId": "Route53HostedZones_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + } + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Delete.json new file mode 100644 index 000000000000..4551446506bf --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53HostedZones_Delete", + "operationId": "Route53HostedZones_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Get.json new file mode 100644 index 000000000000..23a5db8a500b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Get.json @@ -0,0 +1,68 @@ +{ + "title": "Route53HostedZones_Get", + "operationId": "Route53HostedZones_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListByResourceGroup.json new file mode 100644 index 000000000000..6c29e67f9284 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "Route53HostedZones_ListByResourceGroup", + "operationId": "Route53HostedZones_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListBySubscription.json new file mode 100644 index 000000000000..5ec5101c7f72 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "Route53HostedZones_ListBySubscription", + "operationId": "Route53HostedZones_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Update.json new file mode 100644 index 000000000000..baa576a5b00c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53HostedZones_Update.json @@ -0,0 +1,78 @@ +{ + "title": "Route53HostedZones_Update", + "operationId": "Route53HostedZones_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "4D60D8E0-946D-4DF5-B09D-5BB14774BEBE", + "resourceGroupName": "rgroute53HostedZone", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8195": "oaps" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "hostedZoneConfig": { + "comment": "vanhfd" + }, + "hostedZoneTags": [ + { + "key": "zvuvccszzjwkmfojvfbtxuchpvxcy", + "value": "ptsrmgayfujrfvjwyxoi" + } + ], + "id": "dwezucqqxsyhynebuyflyc", + "name": "koqhelfps", + "nameServers": [ + "qizlbjltglpbdpxcsriu" + ], + "queryLoggingConfig": { + "cloudWatchLogsLogGroupArn": "magynetpgpdveymgnonjicfoxzxfp" + }, + "vpCs": [ + { + "vpcId": "nxfxsb", + "vpcRegion": "y" + } + ] + }, + "publicCloudConnectorsResourceId": "qugbrritrvssrcwtib", + "awsAccountId": "rcvmulzibfebvzgooms", + "arn": "vohjyzjtvd", + "publicCloudResourceName": "edufxpyvryjxbnwulifcrwuezu", + "awsSourceSchema": "a", + "awsRegion": "nthjzqxrrqsducmjudhrcdiqioy", + "awsTags": { + "key625": "we" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8226": "nxab" + }, + "location": "fohhkmxasqynkojwigmrzyhydfpdrd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53HostedZones/{resourceName}", + "name": "p", + "type": "hnblcouloonrguxogwsrrveemrgan", + "systemData": { + "createdBy": "xnkxgukpagftbd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:23.665Z", + "lastModifiedBy": "gdzxymbmlkqleymitahnozpp", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:23.665Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_CreateOrReplace.json new file mode 100644 index 000000000000..4735e2fb7c8c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_CreateOrReplace.json @@ -0,0 +1,232 @@ +{ + "title": "Route53ResourceRecordSets_CreateOrReplace", + "operationId": "Route53ResourceRecordSets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + } + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Delete.json new file mode 100644 index 000000000000..85d01d88272b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Route53ResourceRecordSets_Delete", + "operationId": "Route53ResourceRecordSets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Get.json new file mode 100644 index 000000000000..8915f9b46ea9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Get.json @@ -0,0 +1,89 @@ +{ + "title": "Route53ResourceRecordSets_Get", + "operationId": "Route53ResourceRecordSets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListByResourceGroup.json new file mode 100644 index 000000000000..bf222cd6a57f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "title": "Route53ResourceRecordSets_ListByResourceGroup", + "operationId": "Route53ResourceRecordSets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListBySubscription.json new file mode 100644 index 000000000000..97ce6636178f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_ListBySubscription.json @@ -0,0 +1,92 @@ +{ + "title": "Route53ResourceRecordSets_ListBySubscription", + "operationId": "Route53ResourceRecordSets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Update.json new file mode 100644 index 000000000000..474704e40363 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Route53ResourceRecordSets_Update.json @@ -0,0 +1,99 @@ +{ + "title": "Route53ResourceRecordSets_Update", + "operationId": "Route53ResourceRecordSets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "E37FDFFC-4890-414A-AA75-CE2BD8F24AD1", + "resourceGroupName": "rgroute53ResourceRecordSet", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3023": "qnpghnqmyen" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "aliasTarget": { + "dnsName": "waeiyiiaifbfgjkifiehgpvdssxp", + "evaluateTargetHealth": true, + "hostedZoneId": "hyjpvho" + }, + "cidrRoutingConfig": { + "collectionId": "yzvizqbgbmivdawr", + "locationName": "ajghwvabvx" + }, + "failover": { + "value": "PRIMARY" + }, + "geoLocation": { + "continentCode": "efuwaaipthjwgythmpiqonxjn", + "countryCode": "jsiftfskuw", + "subdivisionCode": "mteb" + }, + "geoProximityLocation": { + "awsRegion": "ughqvzy", + "bias": 15, + "coordinates": { + "latitude": "eijexao", + "longitude": "krewjxmtnbo" + }, + "localZoneGroup": "ksejwbcwmouldiasoybmm" + }, + "healthCheckId": "tz", + "multiValueAnswer": true, + "name": "tmjfllnntbaiyvbzzfivmhgyj", + "region": { + "value": "af-south-1" + }, + "resourceRecords": [ + { + "value": "joiqyrlrpntv" + } + ], + "setIdentifier": "rmgriiqkzi", + "ttl": 18, + "trafficPolicyInstanceId": "nttbthvurnpsjgshknlxpamzymcgno", + "type": { + "value": "A" + }, + "weight": 16 + }, + "publicCloudConnectorsResourceId": "xglniymkrzvonhdikhhxue", + "awsAccountId": "ktpknwetzcdkadwzokqsphnw", + "arn": "bvuvtjvkmzr", + "publicCloudResourceName": "xctgrwojlyvrzlx", + "awsSourceSchema": "w", + "awsRegion": "bccacstjducrajieglqbivvq", + "awsTags": { + "key1343": "zlwgpllmvhhghwjqjbpiwodxvyze" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3468": "uz" + }, + "location": "fjdvlwthtamvmempnqmew", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Route53ResourceRecordSets/{resourceName}", + "name": "ockpwyrugvmyyrwkuzbjqril", + "type": "cmgilkvhgqbr", + "systemData": { + "createdBy": "txraehil", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:42.347Z", + "lastModifiedBy": "yqwhprocnkjzahfwd", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:42.347Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_CreateOrReplace.json new file mode 100644 index 000000000000..ff84c07b97ac --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_CreateOrReplace.json @@ -0,0 +1,145 @@ +{ + "title": "S3AccessPoints_CreateOrReplace", + "operationId": "S3AccessPoints_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + } + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Delete.json new file mode 100644 index 000000000000..bee2e5ee5540 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3AccessPoints_Delete", + "operationId": "S3AccessPoints_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Get.json new file mode 100644 index 000000000000..87e1df256057 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Get.json @@ -0,0 +1,60 @@ +{ + "title": "S3AccessPoints_Get", + "operationId": "S3AccessPoints_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListByResourceGroup.json new file mode 100644 index 000000000000..cbac656e7ff8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "title": "S3AccessPoints_ListByResourceGroup", + "operationId": "S3AccessPoints_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListBySubscription.json new file mode 100644 index 000000000000..1c64144ab22e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_ListBySubscription.json @@ -0,0 +1,63 @@ +{ + "title": "S3AccessPoints_ListBySubscription", + "operationId": "S3AccessPoints_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Update.json new file mode 100644 index 000000000000..8ff3a88103d6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3AccessPoints_Update.json @@ -0,0 +1,70 @@ +{ + "title": "S3AccessPoints_Update", + "operationId": "S3AccessPoints_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "FB308F7F-069C-49D6-A967-503441CDDEB3", + "resourceGroupName": "rgs3AccessPoint", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key1063": "rbjyjsazucwucmhwgswsdmleucnafx" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "alias": "sv", + "arn": "sizkkllnnrgdfkaov", + "bucket": "hsqprhqjtcqrizzbhao", + "bucketAccountId": "bmjnxdssnshenybwnws", + "name": "ve", + "networkOrigin": "Internet", + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "vpcConfiguration": { + "vpcId": "hhzyvprnlxearagzmfsg" + } + }, + "publicCloudConnectorsResourceId": "ixhnqrsogifbzagpdzakwjxqlt", + "awsAccountId": "rqzqzkncomjg", + "arn": "dputejthukqrofpuygrkatazvamcge", + "publicCloudResourceName": "swojnpzcxwqfvhrikxhgu", + "awsSourceSchema": "utriogwvkzanqypvldgboyemujg", + "awsRegion": "elrkktihogsptpwwazywnyyzs", + "awsTags": { + "key2658": "bhytpvuo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2363": "vhrwgmqmjqdfyeutonv" + }, + "location": "azmnzomeh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3AccessPoints/{resourceName}", + "name": "zlyclqdkaecrmrt", + "type": "hpprdezrcedczonrwjqts", + "systemData": { + "createdBy": "wkrqspetnrqqientponmejyltfieta", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:50.843Z", + "lastModifiedBy": "w", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:50.844Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_CreateOrReplace.json new file mode 100644 index 000000000000..5f65fe877f9e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_CreateOrReplace.json @@ -0,0 +1,103 @@ +{ + "title": "S3BucketPolicies_CreateOrReplace", + "operationId": "S3BucketPolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + } + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Delete.json new file mode 100644 index 000000000000..8eddb97090c3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3BucketPolicies_Delete", + "operationId": "S3BucketPolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Get.json new file mode 100644 index 000000000000..94ac0c53ae81 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Get.json @@ -0,0 +1,46 @@ +{ + "title": "S3BucketPolicies_Get", + "operationId": "S3BucketPolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..a01c54aa0293 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListByResourceGroup.json @@ -0,0 +1,50 @@ +{ + "title": "S3BucketPolicies_ListByResourceGroup", + "operationId": "S3BucketPolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListBySubscription.json new file mode 100644 index 000000000000..dd7e1717296e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_ListBySubscription.json @@ -0,0 +1,49 @@ +{ + "title": "S3BucketPolicies_ListBySubscription", + "operationId": "S3BucketPolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Update.json new file mode 100644 index 000000000000..606d5554630e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3BucketPolicies_Update.json @@ -0,0 +1,56 @@ +{ + "title": "S3BucketPolicies_Update", + "operationId": "S3BucketPolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "360EDC8E-8A15-4D2A-9DDD-984568E660E1", + "resourceGroupName": "rgs3BucketPolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key3408": "opgnsffamzhe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "policy": "fifgvjoxnidoedtzm" + }, + "publicCloudConnectorsResourceId": "n", + "awsAccountId": "czyyfhht", + "arn": "ebpwjamccadznftkixikeutdjacadm", + "publicCloudResourceName": "suksqtvhtayjy", + "awsSourceSchema": "wdyfvmrsshlyadt", + "awsRegion": "mlepmxnkxjgtrqhtbaaoxuaj", + "awsTags": { + "key5637": "ympfubnqykwth" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9799": "kihjvhsun" + }, + "location": "hsbqwwdspecsoigxusdbqgilaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3BucketPolicies/{resourceName}", + "name": "dbjztqfpgz", + "type": "yltlvhxyvy", + "systemData": { + "createdBy": "tgzqohrurgwhqvappfrnxbios", + "createdByType": "User", + "createdAt": "2024-10-08T03:49:30.550Z", + "lastModifiedBy": "kjbxgikhvochpxjn", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:49:30.551Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_CreateOrReplace.json new file mode 100644 index 000000000000..8b79c50d5a21 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_CreateOrReplace.json @@ -0,0 +1,1135 @@ +{ + "title": "S3Buckets_CreateOrReplace", + "operationId": "S3Buckets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + } + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Delete.json new file mode 100644 index 000000000000..87782300d038 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3Buckets_Delete", + "operationId": "S3Buckets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Get.json new file mode 100644 index 000000000000..d3a09631c8b0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Get.json @@ -0,0 +1,390 @@ +{ + "title": "S3Buckets_Get", + "operationId": "S3Buckets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListByResourceGroup.json new file mode 100644 index 000000000000..043ecf6018c7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListByResourceGroup.json @@ -0,0 +1,394 @@ +{ + "title": "S3Buckets_ListByResourceGroup", + "operationId": "S3Buckets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListBySubscription.json new file mode 100644 index 000000000000..a389daee9478 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_ListBySubscription.json @@ -0,0 +1,393 @@ +{ + "title": "S3Buckets_ListBySubscription", + "operationId": "S3Buckets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Update.json new file mode 100644 index 000000000000..20794117e3f1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3Buckets_Update.json @@ -0,0 +1,400 @@ +{ + "title": "S3Buckets_Update", + "operationId": "S3Buckets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "464E46F0-0088-4F12-850D-0D67AD234626", + "resourceGroupName": "rgs3Bucket", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6199": "aiwjzitzgmjyezz" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "accelerateConfiguration": { + "accelerationStatus": "Enabled" + }, + "accessControl": "AuthenticatedRead", + "analyticsConfigurations": [ + { + "id": "ioxkjkuclx", + "prefix": "errquicjtmxuidndown", + "storageClassAnalysis": { + "dataExport": { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "outputSchemaVersion": "ojzzqnkekust" + } + }, + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "arn": "wdn", + "bucketEncryption": { + "serverSideEncryptionConfiguration": [ + { + "bucketKeyEnabled": true, + "serverSideEncryptionByDefault": { + "kmsMasterKeyID": "mledejya", + "sseAlgorithm": "AES256" + } + } + ] + }, + "bucketName": "qapantghvzujpa", + "corsConfiguration": { + "corsRules": [ + { + "allowedHeaders": [ + "zzooekoypz" + ], + "allowedMethods": [ + "DELETE" + ], + "allowedOrigins": [ + "tqldxbbws" + ], + "exposedHeaders": [ + "wjlikohhmisfgumcfzrnvg" + ], + "id": "zvasxfnbnbpftihvtosdnlmskv", + "maxAge": 9 + } + ] + }, + "domainName": "vbhotuxputambztq", + "dualStackDomainName": "sryuphsbzszrwamvrcsihe", + "intelligentTieringConfigurations": [ + { + "id": "dbqsgaw", + "prefix": "lhizynvczgfiqwaiyuqpvnd", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "tierings": [ + { + "accessTier": "ARCHIVE_ACCESS", + "days": 6 + } + ] + } + ], + "inventoryConfigurations": [ + { + "destination": { + "bucketAccountId": "sfgcxqtuacvejulm", + "bucketArn": "iuwuakbkkh", + "format": "CSV", + "prefix": "bnbqkueiiffpl" + }, + "enabled": true, + "id": "yqyorzlpsfzzycfeqmdgtsstdze", + "includedObjectVersions": "All", + "optionalFields": [ + "BucketKeyStatus" + ], + "prefix": "tuzwyujzrv", + "scheduleFrequency": "Daily" + } + ], + "lifecycleConfiguration": { + "rules": [ + { + "abortIncompleteMultipartUpload": { + "daysAfterInitiation": 20 + }, + "expirationDate": "ruijzosqnherfgwbgzbiwau", + "expirationInDays": 8, + "expiredObjectDeleteMarker": true, + "id": "aofbidgki", + "noncurrentVersionExpiration": { + "newerNoncurrentVersions": 4, + "noncurrentDays": 17 + }, + "noncurrentVersionExpirationInDays": 4, + "noncurrentVersionTransition": { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + }, + "noncurrentVersionTransitions": [ + { + "newerNoncurrentVersions": 6, + "storageClass": "DEEP_ARCHIVE", + "transitionInDays": 8 + } + ], + "objectSizeGreaterThan": "hfifjfbqvmtatza", + "objectSizeLessThan": "ew", + "prefix": "kbsmshvpardhxehfjgszomvekk", + "status": "Disabled", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ], + "transition": { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + }, + "transitions": [ + { + "storageClass": "DEEP_ARCHIVE", + "transitionDate": "cqdrkqznucygxbnccuvxqbtnm", + "transitionInDays": 14 + } + ] + } + ] + }, + "loggingConfiguration": { + "destinationBucketName": "aujj", + "logFilePrefix": "vdmmbfnvymowpvmhbsagekbokzvp", + "targetObjectKeyFormat": { + "partitionedPrefix": { + "partitionDateSource": "DeliveryTime" + } + } + }, + "metricsConfigurations": [ + { + "accessPointArn": "tkhjqpjfplj", + "id": "ggheleujxadbvbjogd", + "prefix": "zg", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + } + ], + "notificationConfiguration": { + "eventBridgeConfiguration": { + "eventBridgeEnabled": true + }, + "lambdaConfigurations": [ + { + "event": "zpvewswtoarduycggotzdneptucwix", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "function": "zmyzygfaojliiryslfyuyme" + } + ], + "queueConfigurations": [ + { + "event": "qgcdpcvmkvjivvpvmmaeqrictlznb", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "queue": "qwlbvlgmwiaegulyybqggopf" + } + ], + "topicConfigurations": [ + { + "event": "kxl", + "filter": { + "s3Key": { + "rules": [ + { + "name": "ohgjzuamjncbifvbkldogxjuxvhvz", + "value": "dauvnhzxpkpqutnrl" + } + ] + } + }, + "topic": "cj" + } + ] + }, + "objectLockConfiguration": { + "objectLockEnabled": "aiocf", + "rule": { + "defaultRetention": { + "days": 22, + "mode": "COMPLIANCE", + "years": 11 + } + } + }, + "objectLockEnabled": true, + "ownershipControls": { + "rules": [ + { + "objectOwnership": "BucketOwnerEnforced" + } + ] + }, + "publicAccessBlockConfiguration": { + "blockPublicAcls": true, + "blockPublicPolicy": true, + "ignorePublicAcls": true, + "restrictPublicBuckets": true + }, + "regionalDomainName": "xdbzcoemgixrqq", + "replicationConfiguration": { + "role": "rqafufwtmuflkqet", + "rules": [ + { + "deleteMarkerReplication": { + "status": "Disabled" + }, + "destination": { + "accessControlTranslation": { + "owner": "smyptov" + }, + "account": "hwqiekzz", + "bucket": "prjlsmdhkwrputvpdavgn", + "encryptionConfiguration": { + "replicaKmsKeyID": "uodgudyknqizofykjokpv" + }, + "metrics": { + "eventThreshold": { + "minutes": 18 + }, + "status": "Disabled" + }, + "replicationTime": { + "status": "Disabled", + "time": { + "minutes": 18 + } + }, + "storageClass": "DEEP_ARCHIVE" + }, + "filter": { + "and": { + "prefix": "rlralilpznxqfpcseysvvxmfaor", + "tagFilters": [ + { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + ] + }, + "prefix": "etzfeufdxmcvjzpvxbjmzikok", + "tagFilter": { + "key": "ffmzaifhmkmsljsm", + "value": "fsby" + } + }, + "id": "fjcfzahlddm", + "prefix": "agykvphwwnfevfucrxugxejv", + "priority": 20, + "sourceSelectionCriteria": { + "replicaModifications": { + "status": "Disabled" + }, + "sseKmsEncryptedObjects": { + "status": "Disabled" + } + }, + "status": "Disabled" + } + ] + }, + "tags": [ + { + "key": "dxpeasomkyhulmxegodswwuhn", + "value": "otwjdamxqdydqwujwyfh" + } + ], + "versioningConfiguration": { + "status": "Enabled" + }, + "websiteConfiguration": { + "errorDocument": "zxifnrlbyapkasrrhamdkdsqk", + "indexDocument": "umbhsxlihqldbh", + "redirectAllRequestsTo": { + "hostName": "sxmd", + "protocol": "http" + }, + "routingRules": [ + { + "redirectRule": { + "hostName": "odmugwc", + "httpRedirectCode": "vfvnluyewsuhlybwzwsc", + "protocol": "http", + "replaceKeyPrefixWith": "khrrcydzrtwzttnlqrlvdqdj", + "replaceKeyWith": "axcwbdxqktfrrivec" + }, + "routingRuleCondition": { + "httpErrorCodeReturnedEquals": "rajjyyktkunsenpficiiq", + "keyPrefixEquals": "tgzmwymptfxjolynmpwx" + } + } + ] + }, + "websiteURL": "vtlwozcgstjkkmgfywinjoreomvw" + }, + "publicCloudConnectorsResourceId": "i", + "awsAccountId": "rfckvyuni", + "arn": "qoufjwcexyvk", + "publicCloudResourceName": "fmugqeeykklaccblyqplo", + "awsSourceSchema": "kywnqkadqm", + "awsRegion": "kckriyydtrwdlelcuztzfeptvcbwj", + "awsTags": { + "key1337": "xopsufyohwwvrxsp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8605": "s" + }, + "location": "pesmjbocvf", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3Buckets/{resourceName}", + "name": "xbupettah", + "type": "h", + "systemData": { + "createdBy": "hradnouvujfsulfzjgp", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:47.220Z", + "lastModifiedBy": "z", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:47.221Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json new file mode 100644 index 000000000000..0467ffb634e5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json @@ -0,0 +1,118 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + } + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json new file mode 100644 index 000000000000..d4090b261e03 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Delete", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json new file mode 100644 index 000000000000..302e75e4da0c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json @@ -0,0 +1,51 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Get", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json new file mode 100644 index 000000000000..a46b20e36a56 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json new file mode 100644 index 000000000000..8ebf11293525 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json @@ -0,0 +1,54 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json new file mode 100644 index 000000000000..523fa45a52d4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json @@ -0,0 +1,61 @@ +{ + "title": "S3ControlMultiRegionAccessPointPolicyDocuments_Update", + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5DCBF3C2-CB73-4B01-BD4D-BBDD81E5A0B4", + "resourceGroupName": "rgs3ControlMultiRegionAccessPointPolicyDocument", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9280": "fjdgxmttvenfe" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "established": { + "policy": "amcyzzkmwbyuxnbqop" + }, + "proposed": { + "policy": "lbmaqmlw" + } + }, + "publicCloudConnectorsResourceId": "yyfwlodyfhgbzyfgsl", + "awsAccountId": "wotmizsy", + "arn": "ugqgpzuzhxnknuancpvpckccl", + "publicCloudResourceName": "ks", + "awsSourceSchema": "qntzhuq", + "awsRegion": "pshllexnortomzvgcjnsxeoo", + "awsTags": { + "key788": "kirikwibjuyrwctwbefmn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9846": "qdjukprfk" + }, + "location": "mfqwu", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/S3ControlMultiRegionAccessPointPolicyDocuments/{resourceName}", + "name": "kmf", + "type": "qadvmszqhmcdwhtbknilbzcys", + "systemData": { + "createdBy": "oaivcvvpdaxcbvspuzftzhjwppdls", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:12.584Z", + "lastModifiedBy": "zilngigdwfmtsnyrxijnjwai", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:12.585Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_CreateOrReplace.json new file mode 100644 index 000000000000..598a64d551f8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "SageMakerApps_CreateOrReplace", + "operationId": "SageMakerApps_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + } + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Delete.json new file mode 100644 index 000000000000..52d6265a36e9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SageMakerApps_Delete", + "operationId": "SageMakerApps_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Get.json new file mode 100644 index 000000000000..9fd5406aac91 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Get.json @@ -0,0 +1,61 @@ +{ + "title": "SageMakerApps_Get", + "operationId": "SageMakerApps_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListByResourceGroup.json new file mode 100644 index 000000000000..5a1d0c4a4b13 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "SageMakerApps_ListByResourceGroup", + "operationId": "SageMakerApps_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + ], + "nextLink": "https://microsoft.com/aqj" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListBySubscription.json new file mode 100644 index 000000000000..0e311d944ce7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "SageMakerApps_ListBySubscription", + "operationId": "SageMakerApps_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + ], + "nextLink": "https://microsoft.com/aqj" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Update.json new file mode 100644 index 000000000000..0bb6db37e891 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerApps_Update.json @@ -0,0 +1,71 @@ +{ + "title": "SageMakerApps_Update", + "operationId": "SageMakerApps_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "F8ED57CB-9AA1-4BD5-AF9C-348B9E84D635", + "resourceGroupName": "rgsageMakerApp", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key854": "ycoocbs" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "appArn": "gher", + "appName": "evzkcyynebo", + "appType": "Canvas", + "domainId": "dkqxukvimzaw", + "resourceSpec": { + "instanceType": "ml.c5.12xlarge", + "sageMakerImageArn": "pgukixbhpruaz", + "sageMakerImageVersionArn": "juqpu" + }, + "tags": [ + { + "key": "bwiejavqzxocieoyuhmayxvf", + "value": "oiirwwaoqv" + } + ], + "userProfileName": "hqjtakkgaetxvrmswgdzfbnna" + }, + "publicCloudConnectorsResourceId": "vaphifjjavrvy", + "awsAccountId": "lgqcehdauhqdqezactw", + "arn": "jlzaozimvtjn", + "publicCloudResourceName": "ptlnykuziapscweekj", + "awsSourceSchema": "xshoewjusdxuy", + "awsRegion": "tnogtlqasqlenkt", + "awsTags": { + "key2126": "vfltdeknkbeu" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3532": "z" + }, + "location": "wnlhgbkbelgwiwhnismoau", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerApps/{resourceName}", + "name": "bqmsonklppqgjvicxnpire", + "type": "dydtxjmbeodpyk", + "systemData": { + "createdBy": "ppzxszokw", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:44.703Z", + "lastModifiedBy": "mssijgauccculus", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:44.704Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..7842e0147e17 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_CreateOrReplace.json @@ -0,0 +1,148 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_CreateOrReplace", + "operationId": "SageMakerNotebookInstanceSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + } + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Delete.json new file mode 100644 index 000000000000..d2aab117c12b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Delete", + "operationId": "SageMakerNotebookInstanceSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Get.json new file mode 100644 index 000000000000..9f11a3741d8e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Get.json @@ -0,0 +1,61 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Get", + "operationId": "SageMakerNotebookInstanceSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..f2043ad76453 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_ListByResourceGroup", + "operationId": "SageMakerNotebookInstanceSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + ], + "nextLink": "https://microsoft.com/anlnxs" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListBySubscription.json new file mode 100644 index 000000000000..00f1298f42c8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_ListBySubscription.json @@ -0,0 +1,64 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_ListBySubscription", + "operationId": "SageMakerNotebookInstanceSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + ], + "nextLink": "https://microsoft.com/anlnxs" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Update.json new file mode 100644 index 000000000000..9bede76ae0c9 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SageMakerNotebookInstanceSummaries_Update.json @@ -0,0 +1,71 @@ +{ + "title": "SageMakerNotebookInstanceSummaries_Update", + "operationId": "SageMakerNotebookInstanceSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "CF11C6F5-2D77-4E51-B1D1-5F286AE57765", + "resourceGroupName": "rgsageMakerNotebookInstanceSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key9780": "fgjlfvqaeiizxtdrk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "additionalCodeRepositories": [ + "pkjwtq" + ], + "creationTime": "2024-10-08T03:50:00.672Z", + "defaultCodeRepository": "edbiryeqsbvjcqmwygujvl", + "instanceType": { + "value": "ml.c4.2xlarge" + }, + "lastModifiedTime": "2024-10-08T03:50:00.673Z", + "notebookInstanceArn": "wxrcvukcvvtd", + "notebookInstanceLifecycleConfigName": "t", + "notebookInstanceName": "nwemhcydnbtwmti", + "notebookInstanceStatus": { + "value": "Deleting" + }, + "url": "ricclxhpsojfujeolzbg" + }, + "publicCloudConnectorsResourceId": "khlyjmgts", + "awsAccountId": "ymlnxodvrwztwew", + "arn": "ncvgnrtwmjxungpgrodvsy", + "publicCloudResourceName": "ocd", + "awsSourceSchema": "gqddonfcsn", + "awsRegion": "oqykvfkrsmwkvszj", + "awsTags": { + "key4152": "dujjfkuxcm" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key9470": "aluoxfdglqvvkktxeg" + }, + "location": "khdjmafoabcvhksslfjtzlyh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SageMakerNotebookInstanceSummaries/{resourceName}", + "name": "aoqcxtngqqormdennckxrrafoeh", + "type": "fdotjrxnjulxjylpkbh", + "systemData": { + "createdBy": "fzuqzvzzclmlcz", + "createdByType": "User", + "createdAt": "2024-10-08T03:50:00.674Z", + "lastModifiedBy": "xswktya", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:50:00.674Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_CreateOrReplace.json new file mode 100644 index 000000000000..018225eb1526 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_CreateOrReplace.json @@ -0,0 +1,109 @@ +{ + "title": "SecretsManagerResourcePolicies_CreateOrReplace", + "operationId": "SecretsManagerResourcePolicies_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + } + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Delete.json new file mode 100644 index 000000000000..cab4cad0df1b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SecretsManagerResourcePolicies_Delete", + "operationId": "SecretsManagerResourcePolicies_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Get.json new file mode 100644 index 000000000000..96f2b00efb5a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Get.json @@ -0,0 +1,48 @@ +{ + "title": "SecretsManagerResourcePolicies_Get", + "operationId": "SecretsManagerResourcePolicies_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListByResourceGroup.json new file mode 100644 index 000000000000..0ec4ed6376f2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListByResourceGroup.json @@ -0,0 +1,52 @@ +{ + "title": "SecretsManagerResourcePolicies_ListByResourceGroup", + "operationId": "SecretsManagerResourcePolicies_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListBySubscription.json new file mode 100644 index 000000000000..fa4bd732843d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_ListBySubscription.json @@ -0,0 +1,51 @@ +{ + "title": "SecretsManagerResourcePolicies_ListBySubscription", + "operationId": "SecretsManagerResourcePolicies_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Update.json new file mode 100644 index 000000000000..7ad92cc6c9e3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerResourcePolicies_Update.json @@ -0,0 +1,58 @@ +{ + "title": "SecretsManagerResourcePolicies_Update", + "operationId": "SecretsManagerResourcePolicies_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29D4EFFF-82DF-40C3-815B-07C65E8CB789", + "resourceGroupName": "rgsecretsManagerResourcePolicy", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key8052": "yqnqzumytacsjood" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "blockPublicPolicy": true, + "id": "hrvehsjtj", + "secretId": "ibtyhnihzzcswaemsecd" + }, + "publicCloudConnectorsResourceId": "isvozhenarlkfvvrujywfu", + "awsAccountId": "bswnezmdsuirkrgzmxxjsjo", + "arn": "cvtearqpmshhlnuxxvmsejrzpqsekj", + "publicCloudResourceName": "vtrpmkekofucehtns", + "awsSourceSchema": "gkmussnnnguicaskcuprrkexb", + "awsRegion": "kpcxxfwomoxngnrmkpregcz", + "awsTags": { + "key958": "ls" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key6501": "cgxbtjhbnmjokxwbscjtws" + }, + "location": "znrmqmz", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerResourcePolicies/{resourceName}", + "name": "faic", + "type": "xmmdqjmjfzgjpyhonlcpjlsr", + "systemData": { + "createdBy": "yyxkzveeygkpvnqdfxzabhqgowm", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:40.486Z", + "lastModifiedBy": "wokgsuhtskitdtv", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:40.486Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_CreateOrReplace.json new file mode 100644 index 000000000000..2a20cffd2ad3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_CreateOrReplace.json @@ -0,0 +1,187 @@ +{ + "title": "SecretsManagerSecrets_CreateOrReplace", + "operationId": "SecretsManagerSecrets_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + } + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Delete.json new file mode 100644 index 000000000000..b51e5cdec948 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SecretsManagerSecrets_Delete", + "operationId": "SecretsManagerSecrets_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Get.json new file mode 100644 index 000000000000..e9031bd17883 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Get.json @@ -0,0 +1,74 @@ +{ + "title": "SecretsManagerSecrets_Get", + "operationId": "SecretsManagerSecrets_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListByResourceGroup.json new file mode 100644 index 000000000000..d856c1e98c32 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListByResourceGroup.json @@ -0,0 +1,78 @@ +{ + "title": "SecretsManagerSecrets_ListByResourceGroup", + "operationId": "SecretsManagerSecrets_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListBySubscription.json new file mode 100644 index 000000000000..f480344781dc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_ListBySubscription.json @@ -0,0 +1,77 @@ +{ + "title": "SecretsManagerSecrets_ListBySubscription", + "operationId": "SecretsManagerSecrets_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Update.json new file mode 100644 index 000000000000..06611b50365c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SecretsManagerSecrets_Update.json @@ -0,0 +1,84 @@ +{ + "title": "SecretsManagerSecrets_Update", + "operationId": "SecretsManagerSecrets_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "29501B41-2992-42C5-9DDF-9233F6DCA92D", + "resourceGroupName": "rgsecretsManagerSecret", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key5629": "chydwjrnihjopetcefprwqjpc" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "description": "esljjbmcrcqe", + "generateSecretString": { + "excludeCharacters": "hsixzpgawn", + "excludeLowercase": true, + "excludeNumbers": true, + "excludePunctuation": true, + "excludeUppercase": true, + "generateStringKey": "dxyswggnusnewllmvmoskwswk", + "includeSpace": true, + "passwordLength": 17, + "requireEachIncludedType": true, + "secretStringTemplate": "qgspiepreoyooekaprlglfjbvittue" + }, + "id": "vpnzmovjfbrltixnsgeml", + "kmsKeyId": "vunob", + "name": "jqmtr", + "replicaRegions": [ + { + "kmsKeyId": "bkyubkuxwbasjkguqm", + "region": "m" + } + ], + "secretString": "sbroa", + "tags": [ + { + "key": "ybodkythhxmehguhlrmodxhcduf", + "value": "wrci" + } + ] + }, + "publicCloudConnectorsResourceId": "osnofxgmgmrsc", + "awsAccountId": "wtxdsgybisrqopffdhreyacjrysd", + "arn": "qxrdtehsmibehk", + "publicCloudResourceName": "wj", + "awsSourceSchema": "whhfrjfzgejfasbcycqe", + "awsRegion": "mw", + "awsTags": { + "key4141": "jdlhnhoxtob" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key1461": "aqew" + }, + "location": "balqdxuifwdmtcinyxjit", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SecretsManagerSecrets/{resourceName}", + "name": "fhctmzwyqjl", + "type": "awpwjsibsrtjpr", + "systemData": { + "createdBy": "iioxgnvcjmyqeuoycjihcd", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:16.558Z", + "lastModifiedBy": "evhudclnzaecrwitsmgnevedcypftg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:16.559Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_CreateOrReplace.json new file mode 100644 index 000000000000..624ea4c7c956 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_CreateOrReplace.json @@ -0,0 +1,115 @@ +{ + "title": "SnsSubscriptions_CreateOrReplace", + "operationId": "SnsSubscriptions_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + } + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Delete.json new file mode 100644 index 000000000000..4866fb47ed7b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SnsSubscriptions_Delete", + "operationId": "SnsSubscriptions_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Get.json new file mode 100644 index 000000000000..927681e4663e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Get.json @@ -0,0 +1,50 @@ +{ + "title": "SnsSubscriptions_Get", + "operationId": "SnsSubscriptions_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListByResourceGroup.json new file mode 100644 index 000000000000..a45b8a03059e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListByResourceGroup.json @@ -0,0 +1,54 @@ +{ + "title": "SnsSubscriptions_ListByResourceGroup", + "operationId": "SnsSubscriptions_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListBySubscription.json new file mode 100644 index 000000000000..253659b1f8b6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_ListBySubscription.json @@ -0,0 +1,53 @@ +{ + "title": "SnsSubscriptions_ListBySubscription", + "operationId": "SnsSubscriptions_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Update.json new file mode 100644 index 000000000000..6b1e4cd512fc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsSubscriptions_Update.json @@ -0,0 +1,60 @@ +{ + "title": "SnsSubscriptions_Update", + "operationId": "SnsSubscriptions_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "A2925ADB-A86D-4F59-B63E-E80F244A06A6", + "resourceGroupName": "rgsnsSubscription", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2758": "qctjkmfavrarktvb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "endpoint": "ydbnfs", + "owner": "vhrbkplsbvszhibsvziz", + "protocol": "lcsebez", + "subscriptionArn": "bis", + "topicArn": "pdwndjemgtmwwnyvtjmveblsyq" + }, + "publicCloudConnectorsResourceId": "zokwlgincdzvjml", + "awsAccountId": "jehvmisbfwgnpihgfrkslaee", + "arn": "gnkqmddvoxalgskfwispx", + "publicCloudResourceName": "si", + "awsSourceSchema": "ikrkjsw", + "awsRegion": "bkkaopxcwtfmxemxuilfhllcsixga", + "awsTags": { + "key588": "kxpglwugby" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2041": "mkbmrvjtiukeqzysrvoebyiqojttw" + }, + "location": "rteaofwy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsSubscriptions/{resourceName}", + "name": "pltgggiqpp", + "type": "mbunkmktjwth", + "systemData": { + "createdBy": "zoftxqklpy", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:30.566Z", + "lastModifiedBy": "nlz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:30.567Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_CreateOrReplace.json new file mode 100644 index 000000000000..6a67f6edd128 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_CreateOrReplace.json @@ -0,0 +1,184 @@ +{ + "title": "SnsTopics_CreateOrReplace", + "operationId": "SnsTopics_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + } + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Delete.json new file mode 100644 index 000000000000..efb986560a6e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SnsTopics_Delete", + "operationId": "SnsTopics_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Get.json new file mode 100644 index 000000000000..1e6ebf5d7ac2 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Get.json @@ -0,0 +1,73 @@ +{ + "title": "SnsTopics_Get", + "operationId": "SnsTopics_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListByResourceGroup.json new file mode 100644 index 000000000000..7560b639bd81 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "title": "SnsTopics_ListByResourceGroup", + "operationId": "SnsTopics_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListBySubscription.json new file mode 100644 index 000000000000..6070c4de39f4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_ListBySubscription.json @@ -0,0 +1,76 @@ +{ + "title": "SnsTopics_ListBySubscription", + "operationId": "SnsTopics_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Update.json new file mode 100644 index 000000000000..067f5741f499 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SnsTopics_Update.json @@ -0,0 +1,83 @@ +{ + "title": "SnsTopics_Update", + "operationId": "SnsTopics_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "9BBF6FF6-04B9-49E7-81BF-E69B8ED51A2E", + "resourceGroupName": "rgsnsTopic", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key169": "dsposctohebgkwktzjwwgfftpmhq" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "contentBasedDeduplication": true, + "deliveryStatusLogging": [ + { + "failureFeedbackRoleArn": "ygtlmetldtzqhoasmdit", + "protocol": "application", + "successFeedbackRoleArn": "ersgnxrmfnrqhmyilsomcxxlza", + "successFeedbackSampleRate": "iudedzrjawqzroytyyonpydzjzzmlj" + } + ], + "displayName": "sanmplpvkvcorlhraijepxftlyeqwj", + "fifoTopic": true, + "kmsMasterKeyId": "nioyrfbmzmfdvakoenyodtjgzaxuw", + "signatureVersion": "lpfgizlw", + "subscription": [ + { + "endpoint": "yuvwciasnlpnswnynse", + "protocol": "zohpkxrrouufioztdmkw" + } + ], + "tags": [ + { + "key": "daicnimeizenloocglfwacmcp", + "value": "bxdamnevuybindqttmfvzotzqboj" + } + ], + "topicArn": "owersxkcdlhhnawxkmqlcjlzqlxtmj", + "topicName": "lijmdexuvnfby", + "tracingConfig": "yrpvxmefnaexobhqvtdrj" + }, + "publicCloudConnectorsResourceId": "didnyoylzwmnsjudmfwojgtjqsuypn", + "awsAccountId": "wndmunvvkmoyxlrbsnowo", + "arn": "jjhuxiyhej", + "publicCloudResourceName": "vwncs", + "awsSourceSchema": "sxholwzdshjzccfoioytctdmjrmlpo", + "awsRegion": "qbpwpfnzmmkh", + "awsTags": { + "key2577": "tygcrksvujusefiivyigtch" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key5456": "eqraeavtnbspitsdlpmv" + }, + "location": "vzzjtyjhqbty", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SnsTopics/{resourceName}", + "name": "hsdynqpvalkbhp", + "type": "kd", + "systemData": { + "createdBy": "zsgkusxwsyhxixnmrokrxjldavala", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:21.880Z", + "lastModifiedBy": "rfqfccvtdzzjvfov", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:21.881Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_CreateOrReplace.json new file mode 100644 index 000000000000..0ea269064951 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_CreateOrReplace.json @@ -0,0 +1,169 @@ +{ + "title": "SqsQueues_CreateOrReplace", + "operationId": "SqsQueues_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + } + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Delete.json new file mode 100644 index 000000000000..44988124755c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SqsQueues_Delete", + "operationId": "SqsQueues_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Get.json new file mode 100644 index 000000000000..b00c9fc179a5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Get.json @@ -0,0 +1,68 @@ +{ + "title": "SqsQueues_Get", + "operationId": "SqsQueues_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListByResourceGroup.json new file mode 100644 index 000000000000..74e8c7d99190 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "title": "SqsQueues_ListByResourceGroup", + "operationId": "SqsQueues_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListBySubscription.json new file mode 100644 index 000000000000..bec33851173c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_ListBySubscription.json @@ -0,0 +1,71 @@ +{ + "title": "SqsQueues_ListBySubscription", + "operationId": "SqsQueues_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Update.json new file mode 100644 index 000000000000..65a858b1a96a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SqsQueues_Update.json @@ -0,0 +1,78 @@ +{ + "title": "SqsQueues_Update", + "operationId": "SqsQueues_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "EBF8AE36-6270-41D2-B25D-F2D7086EF253", + "resourceGroupName": "rgsqsQueue", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7679": "tfoda" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "arn": "inbbhuaqgvjzwgepxaejncp", + "contentBasedDeduplication": true, + "deduplicationScope": "chijpjniyonhtrbqaojc", + "delaySeconds": 22, + "fifoQueue": true, + "fifoThroughputLimit": "vzanxuahrdoqizyblwtvse", + "kmsDataKeyReusePeriodSeconds": 1, + "kmsMasterKeyId": "qcjgqtmyhiqnbwaevgoeagy", + "maximumMessageSize": 19, + "messageRetentionPeriod": 29, + "queueName": "wfzhdsdzszyxfgptplvduwr", + "queueUrl": "drfgltnvn", + "receiveMessageWaitTimeSeconds": 4, + "redriveAllowPolicy": {}, + "redrivePolicy": {}, + "sqsManagedSseEnabled": true, + "tags": [ + { + "key": "xvchjfddrrmpbyizcjxdplxu", + "value": "nxjcfolrd" + } + ], + "visibilityTimeout": 2 + }, + "publicCloudConnectorsResourceId": "uvqyizhqjdsnemqktjsgfmjhyw", + "awsAccountId": "bzpgnzvrnsakbglgcvaalyaiocj", + "arn": "jalxzvcntv", + "publicCloudResourceName": "izckbeceljsvepm", + "awsSourceSchema": "jnthvapvjtoexig", + "awsRegion": "ffdlbwzdurjlolipnjsycrmeqsg", + "awsTags": { + "key9800": "dnaxwo" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key7215": "qvolsxokcslzpnq" + }, + "location": "fqdcgrb", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SqsQueues/{resourceName}", + "name": "itprn", + "type": "no", + "systemData": { + "createdBy": "y", + "createdByType": "User", + "createdAt": "2024-10-08T03:54:23.012Z", + "lastModifiedBy": "hicpux", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:54:23.012Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_CreateOrReplace.json new file mode 100644 index 000000000000..7aaa8068304c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_CreateOrReplace.json @@ -0,0 +1,202 @@ +{ + "title": "SsmInstanceInformations_CreateOrReplace", + "operationId": "SsmInstanceInformations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + } + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Delete.json new file mode 100644 index 000000000000..daccc17b73da --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmInstanceInformations_Delete", + "operationId": "SsmInstanceInformations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Get.json new file mode 100644 index 000000000000..a06761b19b53 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Get.json @@ -0,0 +1,79 @@ +{ + "title": "SsmInstanceInformations_Get", + "operationId": "SsmInstanceInformations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListByResourceGroup.json new file mode 100644 index 000000000000..6adf2802216a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListByResourceGroup.json @@ -0,0 +1,83 @@ +{ + "title": "SsmInstanceInformations_ListByResourceGroup", + "operationId": "SsmInstanceInformations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListBySubscription.json new file mode 100644 index 000000000000..a99dd8a2707c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_ListBySubscription.json @@ -0,0 +1,82 @@ +{ + "title": "SsmInstanceInformations_ListBySubscription", + "operationId": "SsmInstanceInformations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Update.json new file mode 100644 index 000000000000..6fa0beb8995c --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmInstanceInformations_Update.json @@ -0,0 +1,89 @@ +{ + "title": "SsmInstanceInformations_Update", + "operationId": "SsmInstanceInformations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "303C04C2-3E7D-475D-9BB1-91EC00D55340", + "resourceGroupName": "rgssmInstanceInformation", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key2080": "kbpsd" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "activationId": "wqzon", + "agentVersion": "bnfjsoeipnlc", + "associationOverview": { + "detailedStatus": "cbudhnfwcqmapsmzmdvjbnobfp", + "instanceAssociationStatusAggregatedCount": { + "key8401": 17 + } + }, + "associationStatus": "elhplvmlvhpwuyovunmrlynmhejdw", + "computerName": "wweceaymirkelywqbxapvxzr", + "ipAddress": "httjvosg", + "iamRole": "izwdzmlugehvtmnssak", + "instanceId": "iubqpfcejhxieuegbecgpkzanri", + "isLatestVersion": true, + "lastAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "lastPingDateTime": "2024-10-08T03:53:10.068Z", + "lastSuccessfulAssociationExecutionDate": "2024-10-08T03:53:10.068Z", + "name": "iubm", + "pingStatus": { + "value": "ConnectionLost" + }, + "platformName": "cbiheizlbfmmcdrsntrldk", + "platformType": { + "value": "Linux" + }, + "platformVersion": "eiopeklxdbhzvyxg", + "registrationDate": "2024-10-08T03:53:10.069Z", + "resourceType": { + "value": "EC2Instance" + }, + "sourceId": "mfupyczzkgmebrayfgrmxcdouve", + "sourceType": { + "value": "AWS::EC2::Instance" + } + }, + "publicCloudConnectorsResourceId": "hsdju", + "awsAccountId": "pjfy", + "arn": "oxfqehraraycsdhslhhkjdu", + "publicCloudResourceName": "nmnanlhecnocoemxsevyl", + "awsSourceSchema": "wetpdek", + "awsRegion": "mzethaciakqyywjomklr", + "awsTags": { + "key8309": "mwxaauusamykdmepqrzjjlpozpflmk" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key678": "gnrhg" + }, + "location": "ermywoyxbvekjsddbgxzdiqctiy", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmInstanceInformations/{resourceName}", + "name": "xuo", + "type": "sjpbs", + "systemData": { + "createdBy": "chr", + "createdByType": "User", + "createdAt": "2024-10-08T03:53:10.071Z", + "lastModifiedBy": "dgoyiaffumcuzcrxl", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:53:10.071Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_CreateOrReplace.json new file mode 100644 index 000000000000..e854b1dfc02f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_CreateOrReplace.json @@ -0,0 +1,124 @@ +{ + "title": "SsmParameters_CreateOrReplace", + "operationId": "SsmParameters_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + } + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Delete.json new file mode 100644 index 000000000000..209e0a3a7c97 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmParameters_Delete", + "operationId": "SsmParameters_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Get.json new file mode 100644 index 000000000000..e27854ab362e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Get.json @@ -0,0 +1,53 @@ +{ + "title": "SsmParameters_Get", + "operationId": "SsmParameters_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListByResourceGroup.json new file mode 100644 index 000000000000..468d17dc0eaa --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListByResourceGroup.json @@ -0,0 +1,57 @@ +{ + "title": "SsmParameters_ListByResourceGroup", + "operationId": "SsmParameters_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListBySubscription.json new file mode 100644 index 000000000000..55632ef60d34 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_ListBySubscription.json @@ -0,0 +1,56 @@ +{ + "title": "SsmParameters_ListBySubscription", + "operationId": "SsmParameters_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Update.json new file mode 100644 index 000000000000..0c042aa92b99 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmParameters_Update.json @@ -0,0 +1,63 @@ +{ + "title": "SsmParameters_Update", + "operationId": "SsmParameters_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "87A42E06-5E9B-41B1-A682-959F2CFC4E25", + "resourceGroupName": "rgssmParameter", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key4464": "tgnzhbcrpdvteprriogksebwisvqxm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "allowedPattern": "fzyaodp", + "dataType": "aws:ec2:image", + "description": "aygihzeaxvodxejsnmnkp", + "name": "wvvx", + "policies": "ahuep", + "tier": "Advanced", + "type": "String", + "value": "wecofehml" + }, + "publicCloudConnectorsResourceId": "mhesebimtvrlvvbkiswfalddqhilrp", + "awsAccountId": "kxxdlwjrdytmfznuxkd", + "arn": "rzxpagnscd", + "publicCloudResourceName": "sdtc", + "awsSourceSchema": "yuexfxhmpunhdtxzdrkz", + "awsRegion": "ujrrnxtayjeezffngymhkfhtrgjvpz", + "awsTags": { + "key8903": "buyg" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key8492": "wklhptyp" + }, + "location": "ymzdygzdzd", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmParameters/{resourceName}", + "name": "bmsrpoibrmixexpusksmj", + "type": "azpwmknpmdppobxjzjdqjtckaw", + "systemData": { + "createdBy": "uuuccxdxurztepiqnyng", + "createdByType": "User", + "createdAt": "2024-10-08T04:11:04.952Z", + "lastModifiedBy": "ts", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T04:11:04.952Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_CreateOrReplace.json new file mode 100644 index 000000000000..2f1b3e8838ef --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_CreateOrReplace.json @@ -0,0 +1,208 @@ +{ + "title": "SsmResourceComplianceSummaryItems_CreateOrReplace", + "operationId": "SsmResourceComplianceSummaryItems_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + } + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Delete.json new file mode 100644 index 000000000000..68b30ecd4a6e --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Delete", + "operationId": "SsmResourceComplianceSummaryItems_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Get.json new file mode 100644 index 000000000000..b8abf1d08e37 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Get.json @@ -0,0 +1,81 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Get", + "operationId": "SsmResourceComplianceSummaryItems_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListByResourceGroup.json new file mode 100644 index 000000000000..797e18101283 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListByResourceGroup.json @@ -0,0 +1,85 @@ +{ + "title": "SsmResourceComplianceSummaryItems_ListByResourceGroup", + "operationId": "SsmResourceComplianceSummaryItems_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListBySubscription.json new file mode 100644 index 000000000000..6a481af4da43 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_ListBySubscription.json @@ -0,0 +1,84 @@ +{ + "title": "SsmResourceComplianceSummaryItems_ListBySubscription", + "operationId": "SsmResourceComplianceSummaryItems_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Update.json new file mode 100644 index 000000000000..867a6b563865 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/SsmResourceComplianceSummaryItems_Update.json @@ -0,0 +1,91 @@ +{ + "title": "SsmResourceComplianceSummaryItems_Update", + "operationId": "SsmResourceComplianceSummaryItems_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "5CDFC70A-43CE-437F-BB00-7858F6FAA5A7", + "resourceGroupName": "rgssmResourceComplianceSummaryItem", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7866": "uwutk" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "complianceType": "fblmjhswva", + "compliantSummary": { + "compliantCount": 2, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "executionSummary": { + "executionId": "ngwakxvtdysew", + "executionTime": "2024-10-08T03:48:53.913Z", + "executionType": "wjneewwqlrtdntdsot" + }, + "nonCompliantSummary": { + "nonCompliantCount": 18, + "severitySummary": { + "criticalCount": 7, + "highCount": 18, + "informationalCount": 17, + "lowCount": 19, + "mediumCount": 20, + "unspecifiedCount": 11 + } + }, + "overallSeverity": { + "value": "CRITICAL" + }, + "resourceId": "muhsukivzcqvnlxiyrudvdymmii", + "resourceType": "rphjdvzvwasngsqoozoivduj", + "status": { + "value": "COMPLIANT" + } + }, + "publicCloudConnectorsResourceId": "lghqnauuu", + "awsAccountId": "taqkptjbkqarwksdmfumdyi", + "arn": "s", + "publicCloudResourceName": "qvohsbyuajd", + "awsSourceSchema": "ppxlpfsm", + "awsRegion": "hkemdhobdaxfwcvdjohvqtwpmjezu", + "awsTags": { + "key3567": "prmmwewyaitggucnntudddji" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key3147": "qdybk" + }, + "location": "kr", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/SsmResourceComplianceSummaryItems/{resourceName}", + "name": "fsrglygmhf", + "type": "oreqorhskmz", + "systemData": { + "createdBy": "dxwqhofvydxduvxmcjxneqtunkzwag", + "createdByType": "User", + "createdAt": "2024-10-08T03:48:53.914Z", + "lastModifiedBy": "ivuuhpcoprnfirnbfvxvawflmccttg", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:48:53.914Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_CreateOrReplace.json new file mode 100644 index 000000000000..2b3ef5237506 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_CreateOrReplace.json @@ -0,0 +1,106 @@ +{ + "title": "WafWebAclSummaries_CreateOrReplace", + "operationId": "WafWebAclSummaries_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + } + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Delete.json new file mode 100644 index 000000000000..cc5c1b30a6a4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "WafWebAclSummaries_Delete", + "operationId": "WafWebAclSummaries_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Get.json new file mode 100644 index 000000000000..78d8c9dfd8a8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Get.json @@ -0,0 +1,47 @@ +{ + "title": "WafWebAclSummaries_Get", + "operationId": "WafWebAclSummaries_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListByResourceGroup.json new file mode 100644 index 000000000000..d361dd9ca3a6 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListByResourceGroup.json @@ -0,0 +1,51 @@ +{ + "title": "WafWebAclSummaries_ListByResourceGroup", + "operationId": "WafWebAclSummaries_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListBySubscription.json new file mode 100644 index 000000000000..5e1b4df61420 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_ListBySubscription.json @@ -0,0 +1,50 @@ +{ + "title": "WafWebAclSummaries_ListBySubscription", + "operationId": "WafWebAclSummaries_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Update.json new file mode 100644 index 000000000000..ea257a58bda3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/WafWebAclSummaries_Update.json @@ -0,0 +1,57 @@ +{ + "title": "WafWebAclSummaries_Update", + "operationId": "WafWebAclSummaries_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5F60110-967A-4CDB-B73A-67595ADF3C24", + "resourceGroupName": "rgwafWebACLSummary", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key7911": "djgsj" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "name": "rrwaevjnkowkxlccaw", + "webACLId": "hh" + }, + "publicCloudConnectorsResourceId": "kzgpy", + "awsAccountId": "ovompqprisse", + "arn": "gorpeccxrhf", + "publicCloudResourceName": "lejvxofzybufrazktgotrowforlsrp", + "awsSourceSchema": "afgujkvjwspbbruhwbeji", + "awsRegion": "nnnmvzddsej", + "awsTags": { + "key8890": "fpvbbqxuwtqptqktmgp" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key2706": "mdnvnlajj" + }, + "location": "bpposymcoxqcolyqmtfpvoh", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/WafWebACLSummaries/{resourceName}", + "name": "mbdbeqqvxgemhnzmbstpqijqumpudg", + "type": "vfmpobxbjutfattmrlxey", + "systemData": { + "createdBy": "vwombysydgpuchyshcgluoc", + "createdByType": "User", + "createdAt": "2024-10-08T03:52:52.567Z", + "lastModifiedBy": "hgrwcjbnfwmrvgjfihgdeecnxocz", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:52:52.611Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_CreateOrReplace.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_CreateOrReplace.json new file mode 100644 index 000000000000..f8a73e86a6fc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_CreateOrReplace.json @@ -0,0 +1,193 @@ +{ + "title": "Wafv2LoggingConfigurations_CreateOrReplace", + "operationId": "Wafv2LoggingConfigurations_CreateOrReplace", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "resource": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + } + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Delete.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Delete.json new file mode 100644 index 000000000000..4e94f3733733 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "Wafv2LoggingConfigurations_Delete", + "operationId": "Wafv2LoggingConfigurations_Delete", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Get.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Get.json new file mode 100644 index 000000000000..d16e2536ae6d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Get.json @@ -0,0 +1,76 @@ +{ + "title": "Wafv2LoggingConfigurations_Get", + "operationId": "Wafv2LoggingConfigurations_Get", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])" + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListByResourceGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListByResourceGroup.json new file mode 100644 index 000000000000..1ec24b29e7ea --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListByResourceGroup.json @@ -0,0 +1,80 @@ +{ + "title": "Wafv2LoggingConfigurations_ListByResourceGroup", + "operationId": "Wafv2LoggingConfigurations_ListByResourceGroup", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListBySubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListBySubscription.json new file mode 100644 index 000000000000..61f84d67aaa3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_ListBySubscription.json @@ -0,0 +1,79 @@ +{ + "title": "Wafv2LoggingConfigurations_ListBySubscription", + "operationId": "Wafv2LoggingConfigurations_ListBySubscription", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Update.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Update.json new file mode 100644 index 000000000000..01838de9cc1f --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/examples/Wafv2LoggingConfigurations_Update.json @@ -0,0 +1,86 @@ +{ + "title": "Wafv2LoggingConfigurations_Update", + "operationId": "Wafv2LoggingConfigurations_Update", + "parameters": { + "api-version": "2024-12-01", + "subscriptionId": "D5203BCA-DDF4-4FDB-A670-110F8B47C659", + "resourceGroupName": "rgwafv2LoggingConfiguration", + "name": "Replace this value with a string matching RegExp ^(z=.{0,259}[^zs.]$)(z!.*[zzzzzzzz])", + "properties": { + "tags": { + "key6151": "lkrorfwghfb" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "awsProperties": { + "logDestinationConfigs": [ + "lyxpldjogdqpffwthdto" + ], + "loggingFilter": { + "defaultBehavior": "DROP", + "filters": [ + { + "behavior": "DROP", + "conditions": [ + { + "actionCondition": { + "action": "ALLOW" + }, + "labelNameCondition": { + "labelName": "oypkvstyighnjavknhfon" + } + } + ], + "requirement": "MEETS_ALL" + } + ] + }, + "managedByFirewallManager": true, + "redactedFields": [ + { + "singleHeader": { + "name": "bfqodp" + } + } + ], + "resourceArn": "bnozeamipjgc" + }, + "publicCloudConnectorsResourceId": "towziecfnbhswtodyqkkqrtatogbl", + "awsAccountId": "opcrasgtswrifmkonwy", + "arn": "vvamx", + "publicCloudResourceName": "eniprewwy", + "awsSourceSchema": "ywgazosjmcwothayguih", + "awsRegion": "kkwxoqqqiadksrmfpvopq", + "awsTags": { + "key5392": "qn" + }, + "provisioningState": "Succeeded" + }, + "tags": { + "key643": "cmguxikvqhszupgpbhlz" + }, + "location": "miqjaa", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/Wafv2LoggingConfigurations/{resourceName}", + "name": "fhprvqrekcufvebkfddaoyll", + "type": "oamtiw", + "systemData": { + "createdBy": "lwcpgolfn", + "createdByType": "User", + "createdAt": "2024-10-08T03:55:39.696Z", + "lastModifiedBy": "aehtrugbsbisndwmmufxiczbklc", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-10-08T03:55:39.696Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/guardDutyDetector.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/guardDutyDetector.json new file mode 100644 index 000000000000..22dd1126ed24 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/guardDutyDetector.json @@ -0,0 +1,716 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "GuardDutyDetectors" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/guardDutyDetectors": { + "get": { + "operationId": "GuardDutyDetectors_ListBySubscription", + "tags": [ + "GuardDutyDetectors" + ], + "description": "List GuardDutyDetector resources 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/GuardDutyDetectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuardDutyDetectors_ListBySubscription": { + "$ref": "./examples/GuardDutyDetectors_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/guardDutyDetectors": { + "get": { + "operationId": "GuardDutyDetectors_ListByResourceGroup", + "tags": [ + "GuardDutyDetectors" + ], + "description": "List GuardDutyDetector resources 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/GuardDutyDetectorListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuardDutyDetectors_ListByResourceGroup": { + "$ref": "./examples/GuardDutyDetectors_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/guardDutyDetectors/{name}": { + "get": { + "operationId": "GuardDutyDetectors_Get", + "tags": [ + "GuardDutyDetectors" + ], + "description": "Get a GuardDutyDetector", + "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": "name", + "in": "path", + "description": "Name of GuardDutyDetector", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuardDutyDetector" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuardDutyDetectors_Get": { + "$ref": "./examples/GuardDutyDetectors_Get.json" + } + } + }, + "put": { + "operationId": "GuardDutyDetectors_CreateOrReplace", + "tags": [ + "GuardDutyDetectors" + ], + "description": "Create a GuardDutyDetector. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of GuardDutyDetector", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuardDutyDetector" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuardDutyDetector' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuardDutyDetector" + } + }, + "201": { + "description": "Resource 'GuardDutyDetector' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuardDutyDetector" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "GuardDutyDetectors_CreateOrReplace": { + "$ref": "./examples/GuardDutyDetectors_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "GuardDutyDetectors_Update", + "tags": [ + "GuardDutyDetectors" + ], + "description": "Update a GuardDutyDetector", + "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": "name", + "in": "path", + "description": "Name of GuardDutyDetector", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/GuardDutyDetectorTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuardDutyDetector" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuardDutyDetectors_Update": { + "$ref": "./examples/GuardDutyDetectors_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuardDutyDetectors_Delete", + "tags": [ + "GuardDutyDetectors" + ], + "description": "Delete a GuardDutyDetector", + "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": "name", + "in": "path", + "description": "Name of GuardDutyDetector", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "GuardDutyDetectors_Delete": { + "$ref": "./examples/GuardDutyDetectors_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsGuardDutyDetectorProperties": { + "type": "object", + "description": "Definition of awsGuardDutyDetector", + "properties": { + "dataSources": { + "$ref": "#/definitions/CFNDataSourceConfigurations", + "description": "Property dataSources" + }, + "enable": { + "type": "boolean", + "description": "Property enable" + }, + "features": { + "type": "array", + "description": "Property features", + "items": { + "$ref": "#/definitions/CFNFeatureConfiguration" + }, + "x-ms-identifiers": [] + }, + "findingPublishingFrequency": { + "type": "string", + "description": "Property findingPublishingFrequency" + }, + "id": { + "type": "string", + "description": "Property id" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/TagItem" + }, + "x-ms-identifiers": [] + } + } + }, + "CFNDataSourceConfigurations": { + "type": "object", + "description": "Definition of CFNDataSourceConfigurations", + "properties": { + "kubernetes": { + "$ref": "#/definitions/CFNKubernetesConfiguration", + "description": "Property kubernetes" + }, + "malwareProtection": { + "$ref": "#/definitions/CFNMalwareProtectionConfiguration", + "description": "Property malwareProtection" + }, + "s3Logs": { + "$ref": "#/definitions/CFNS3LogsConfiguration", + "description": "Property s3Logs" + } + } + }, + "CFNFeatureAdditionalConfiguration": { + "type": "object", + "description": "Definition of CFNFeatureAdditionalConfiguration", + "properties": { + "name": { + "type": "string", + "description": "Property name" + }, + "status": { + "type": "string", + "description": "Property status" + } + } + }, + "CFNFeatureConfiguration": { + "type": "object", + "description": "Definition of CFNFeatureConfiguration", + "properties": { + "additionalConfiguration": { + "type": "array", + "description": "Property additionalConfiguration", + "items": { + "$ref": "#/definitions/CFNFeatureAdditionalConfiguration" + }, + "x-ms-identifiers": [] + }, + "name": { + "type": "string", + "description": "Property name" + }, + "status": { + "$ref": "#/definitions/CFNFeatureConfigurationStatus", + "description": "Property status" + } + } + }, + "CFNFeatureConfigurationStatus": { + "type": "string", + "description": "CFNFeatureConfigurationStatus enum", + "enum": [ + "DISABLED", + "ENABLED" + ], + "x-ms-enum": { + "name": "CFNFeatureConfigurationStatus", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "CFNFeatureConfigurationStatus enum DISABLED" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "CFNFeatureConfigurationStatus enum ENABLED" + } + ] + } + }, + "CFNKubernetesAuditLogsConfiguration": { + "type": "object", + "description": "Definition of CFNKubernetesAuditLogsConfiguration", + "properties": { + "enable": { + "type": "boolean", + "description": "Property enable" + } + } + }, + "CFNKubernetesConfiguration": { + "type": "object", + "description": "Definition of CFNKubernetesConfiguration", + "properties": { + "auditLogs": { + "$ref": "#/definitions/CFNKubernetesAuditLogsConfiguration", + "description": "Property auditLogs" + } + } + }, + "CFNMalwareProtectionConfiguration": { + "type": "object", + "description": "Definition of CFNMalwareProtectionConfiguration", + "properties": { + "scanEc2InstanceWithFindings": { + "$ref": "#/definitions/CFNScanEc2InstanceWithFindingsConfiguration", + "description": "Property scanEc2InstanceWithFindings" + } + } + }, + "CFNS3LogsConfiguration": { + "type": "object", + "description": "Definition of CFNS3LogsConfiguration", + "properties": { + "enable": { + "type": "boolean", + "description": "Property enable" + } + } + }, + "CFNScanEc2InstanceWithFindingsConfiguration": { + "type": "object", + "description": "Definition of CFNScanEc2InstanceWithFindingsConfiguration", + "properties": { + "ebsVolumes": { + "type": "boolean", + "description": "Property ebsVolumes" + } + } + }, + "GuardDutyDetector": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/GuardDutyDetectorProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "GuardDutyDetectorListResult": { + "type": "object", + "description": "The response of a GuardDutyDetector list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuardDutyDetector items on this page", + "items": { + "$ref": "#/definitions/GuardDutyDetector" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GuardDutyDetectorProperties": { + "type": "object", + "description": "Definition of GuardDutyDetector", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsGuardDutyDetectorProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "GuardDutyDetectorTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in GuardDutyDetector resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "TagItem": { + "type": "object", + "description": "Definition of TagItem", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyLastUsed.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyLastUsed.json new file mode 100644 index 000000000000..2cc2a38000cd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyLastUsed.json @@ -0,0 +1,555 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamAccessKeyLastUseds" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamAccessKeyLastUseds": { + "get": { + "operationId": "IamAccessKeyLastUseds_ListBySubscription", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "List IamAccessKeyLastUsed resources 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/IamAccessKeyLastUsedListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyLastUseds_ListBySubscription": { + "$ref": "./examples/IamAccessKeyLastUseds_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamAccessKeyLastUseds": { + "get": { + "operationId": "IamAccessKeyLastUseds_ListByResourceGroup", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "List IamAccessKeyLastUsed resources 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/IamAccessKeyLastUsedListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyLastUseds_ListByResourceGroup": { + "$ref": "./examples/IamAccessKeyLastUseds_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamAccessKeyLastUseds/{name}": { + "get": { + "operationId": "IamAccessKeyLastUseds_Get", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "Get a IamAccessKeyLastUsed", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyLastUsed", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyLastUseds_Get": { + "$ref": "./examples/IamAccessKeyLastUseds_Get.json" + } + } + }, + "put": { + "operationId": "IamAccessKeyLastUseds_CreateOrReplace", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "Create a IamAccessKeyLastUsed. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyLastUsed", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamAccessKeyLastUsed' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + } + }, + "201": { + "description": "Resource 'IamAccessKeyLastUsed' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamAccessKeyLastUseds_CreateOrReplace": { + "$ref": "./examples/IamAccessKeyLastUseds_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamAccessKeyLastUseds_Update", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "Update a IamAccessKeyLastUsed", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyLastUsed", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsedTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyLastUseds_Update": { + "$ref": "./examples/IamAccessKeyLastUseds_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamAccessKeyLastUseds_Delete", + "tags": [ + "IamAccessKeyLastUseds" + ], + "description": "Delete a IamAccessKeyLastUsed", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyLastUsed", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamAccessKeyLastUseds_Delete": { + "$ref": "./examples/IamAccessKeyLastUseds_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamAccessKeyLastUsedProperties": { + "type": "object", + "description": "Definition of awsIamAccessKeyLastUsed", + "properties": { + "lastUsedDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the access key was most recently used. This field is null in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM began tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul>" + }, + "region": { + "type": "string", + "description": "<p>The Amazon Web Services Region where this access key was most recently used. The value for this field is 'N/A' in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM began tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul> <p>For more information about Amazon Web Services Regions, see <a href='https://docs.aws.amazon.com/general/latest/gr/rande.html'>Regions and endpoints</a> in the Amazon Web Services General Reference.</p>" + }, + "serviceName": { + "type": "string", + "description": "<p>The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is 'N/A' in the following situations:</p> <ul> <li> <p>The user does not have an access key.</p> </li> <li> <p>An access key exists but has not been used since IAM started tracking this information.</p> </li> <li> <p>There is no sign-in data associated with the user.</p> </li> </ul>" + } + } + }, + "IamAccessKeyLastUsed": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamAccessKeyLastUsedProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamAccessKeyLastUsedListResult": { + "type": "object", + "description": "The response of a IamAccessKeyLastUsed list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamAccessKeyLastUsed items on this page", + "items": { + "$ref": "#/definitions/IamAccessKeyLastUsed" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamAccessKeyLastUsedProperties": { + "type": "object", + "description": "Definition of IamAccessKeyLastUsed", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamAccessKeyLastUsedProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamAccessKeyLastUsedTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamAccessKeyLastUsed resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyMetadata.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyMetadata.json new file mode 100644 index 000000000000..fb829363447d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyMetadata.json @@ -0,0 +1,593 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamAccessKeyMetadataInfo" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamAccessKeyMetadata": { + "get": { + "operationId": "IamAccessKeyMetadataInfo_ListBySubscription", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "List IamAccessKeyMetadata resources 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/IamAccessKeyMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyMetadataInfo_ListBySubscription": { + "$ref": "./examples/IamAccessKeyMetadataInfo_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamAccessKeyMetadata": { + "get": { + "operationId": "IamAccessKeyMetadataInfo_ListByResourceGroup", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "List IamAccessKeyMetadata resources 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/IamAccessKeyMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyMetadataInfo_ListByResourceGroup": { + "$ref": "./examples/IamAccessKeyMetadataInfo_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamAccessKeyMetadata/{name}": { + "get": { + "operationId": "IamAccessKeyMetadataInfo_Get", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "Get a IamAccessKeyMetadata", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyMetadata", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyMetadataInfo_Get": { + "$ref": "./examples/IamAccessKeyMetadataInfo_Get.json" + } + } + }, + "put": { + "operationId": "IamAccessKeyMetadataInfo_CreateOrReplace", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "Create a IamAccessKeyMetadata. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyMetadata", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadata" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamAccessKeyMetadata' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadata" + } + }, + "201": { + "description": "Resource 'IamAccessKeyMetadata' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadata" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamAccessKeyMetadataInfo_CreateOrReplace": { + "$ref": "./examples/IamAccessKeyMetadataInfo_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamAccessKeyMetadataInfo_Update", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "Update a IamAccessKeyMetadata", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyMetadata", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadataTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamAccessKeyMetadata" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamAccessKeyMetadataInfo_Update": { + "$ref": "./examples/IamAccessKeyMetadataInfo_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamAccessKeyMetadataInfo_Delete", + "tags": [ + "IamAccessKeyMetadataInfo" + ], + "description": "Delete a IamAccessKeyMetadata", + "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": "name", + "in": "path", + "description": "Name of IamAccessKeyMetadata", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamAccessKeyMetadataInfo_Delete": { + "$ref": "./examples/IamAccessKeyMetadataInfo_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamAccessKeyMetadataProperties": { + "type": "object", + "description": "Definition of awsIamAccessKeyMetadata", + "properties": { + "accessKeyId": { + "type": "string", + "description": "<p>The ID for this access key.</p>" + }, + "createDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date when the access key was created.</p>" + }, + "status": { + "$ref": "#/definitions/statusTypeEnumValue", + "description": "<p>The status of the access key. <code>Active</code> means that the key is valid for API calls; <code>Inactive</code> means it is not.</p>" + }, + "userName": { + "type": "string", + "description": "<p>The name of the IAM user that the key is associated with.</p>" + } + } + }, + "IamAccessKeyMetadata": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamAccessKeyMetadataProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamAccessKeyMetadataListResult": { + "type": "object", + "description": "The response of a IamAccessKeyMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamAccessKeyMetadata items on this page", + "items": { + "$ref": "#/definitions/IamAccessKeyMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamAccessKeyMetadataProperties": { + "type": "object", + "description": "Definition of IamAccessKeyMetadata", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamAccessKeyMetadataProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamAccessKeyMetadataTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamAccessKeyMetadata resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "statusType": { + "type": "string", + "description": "statusType enum", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "statusType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "statusType enum Active" + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "statusType enum Inactive" + } + ] + } + }, + "statusTypeEnumValue": { + "type": "object", + "description": "Definition of statusTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/statusType", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamGroup.json new file mode 100644 index 000000000000..21f982398aae --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamGroup.json @@ -0,0 +1,585 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamGroups": { + "get": { + "operationId": "IamGroups_ListBySubscription", + "tags": [ + "IamGroups" + ], + "description": "List IamGroup resources 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/IamGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamGroups_ListBySubscription": { + "$ref": "./examples/IamGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamGroups": { + "get": { + "operationId": "IamGroups_ListByResourceGroup", + "tags": [ + "IamGroups" + ], + "description": "List IamGroup resources 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/IamGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamGroups_ListByResourceGroup": { + "$ref": "./examples/IamGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamGroups/{name}": { + "get": { + "operationId": "IamGroups_Get", + "tags": [ + "IamGroups" + ], + "description": "Get a IamGroup", + "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": "name", + "in": "path", + "description": "Name of IamGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamGroups_Get": { + "$ref": "./examples/IamGroups_Get.json" + } + } + }, + "put": { + "operationId": "IamGroups_CreateOrReplace", + "tags": [ + "IamGroups" + ], + "description": "Create a IamGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamGroup" + } + }, + "201": { + "description": "Resource 'IamGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamGroups_CreateOrReplace": { + "$ref": "./examples/IamGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamGroups_Update", + "tags": [ + "IamGroups" + ], + "description": "Update a IamGroup", + "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": "name", + "in": "path", + "description": "Name of IamGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamGroups_Update": { + "$ref": "./examples/IamGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamGroups_Delete", + "tags": [ + "IamGroups" + ], + "description": "Delete a IamGroup", + "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": "name", + "in": "path", + "description": "Name of IamGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamGroups_Delete": { + "$ref": "./examples/IamGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamGroupProperties": { + "type": "object", + "description": "Definition of awsIamGroup", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "groupName": { + "type": "string", + "description": "The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both 'ADMINS' and 'admins'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{'Fn::Join': ['', [{'Ref': 'AWS::Region'}, {'Ref': 'MyResourceName'}]]}``." + }, + "managedPolicyArns": { + "type": "array", + "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "path": { + "type": "string", + "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "policies": { + "type": "array", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.", + "items": { + "$ref": "#/definitions/Policy" + }, + "x-ms-identifiers": [] + } + } + }, + "IamGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamGroupListResult": { + "type": "object", + "description": "The response of a IamGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamGroup items on this page", + "items": { + "$ref": "#/definitions/IamGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamGroupProperties": { + "type": "object", + "description": "Definition of IamGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Policy": { + "type": "object", + "description": "Definition of Policy", + "properties": { + "policyDocument": { + "type": "object", + "description": "The policy document.", + "additionalProperties": {} + }, + "policyName": { + "type": "string", + "description": "The friendly name (not ARN) identifying the policy." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamInstanceProfile.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamInstanceProfile.json new file mode 100644 index 000000000000..77d0ac0ed8cb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamInstanceProfile.json @@ -0,0 +1,562 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamInstanceProfiles" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamInstanceProfiles": { + "get": { + "operationId": "IamInstanceProfiles_ListBySubscription", + "tags": [ + "IamInstanceProfiles" + ], + "description": "List IamInstanceProfile resources 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/IamInstanceProfileListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamInstanceProfiles_ListBySubscription": { + "$ref": "./examples/IamInstanceProfiles_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamInstanceProfiles": { + "get": { + "operationId": "IamInstanceProfiles_ListByResourceGroup", + "tags": [ + "IamInstanceProfiles" + ], + "description": "List IamInstanceProfile resources 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/IamInstanceProfileListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamInstanceProfiles_ListByResourceGroup": { + "$ref": "./examples/IamInstanceProfiles_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamInstanceProfiles/{name}": { + "get": { + "operationId": "IamInstanceProfiles_Get", + "tags": [ + "IamInstanceProfiles" + ], + "description": "Get a IamInstanceProfile", + "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": "name", + "in": "path", + "description": "Name of IamInstanceProfile", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamInstanceProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamInstanceProfiles_Get": { + "$ref": "./examples/IamInstanceProfiles_Get.json" + } + } + }, + "put": { + "operationId": "IamInstanceProfiles_CreateOrUpdate", + "tags": [ + "IamInstanceProfiles" + ], + "description": "Create a IamInstanceProfile. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamInstanceProfile", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamInstanceProfile" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamInstanceProfile' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamInstanceProfile" + } + }, + "201": { + "description": "Resource 'IamInstanceProfile' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamInstanceProfile" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamInstanceProfiles_CreateOrUpdate": { + "$ref": "./examples/IamInstanceProfiles_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamInstanceProfiles_Update", + "tags": [ + "IamInstanceProfiles" + ], + "description": "Update a IamInstanceProfile", + "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": "name", + "in": "path", + "description": "Name of IamInstanceProfile", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamInstanceProfileTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamInstanceProfile" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamInstanceProfiles_Update": { + "$ref": "./examples/IamInstanceProfiles_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamInstanceProfiles_Delete", + "tags": [ + "IamInstanceProfiles" + ], + "description": "Delete a IamInstanceProfile", + "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": "name", + "in": "path", + "description": "Name of IamInstanceProfile", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamInstanceProfiles_Delete": { + "$ref": "./examples/IamInstanceProfiles_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamInstanceProfileProperties": { + "type": "object", + "description": "Definition of awsIamInstanceProfile", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "instanceProfileName": { + "type": "string", + "description": "The name of the instance profile to create. This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" + }, + "path": { + "type": "string", + "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." + }, + "roles": { + "type": "array", + "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "IamInstanceProfile": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamInstanceProfileProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamInstanceProfileListResult": { + "type": "object", + "description": "The response of a IamInstanceProfile list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamInstanceProfile items on this page", + "items": { + "$ref": "#/definitions/IamInstanceProfile" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamInstanceProfileProperties": { + "type": "object", + "description": "Definition of IamInstanceProfile", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamInstanceProfileProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamInstanceProfileTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamInstanceProfile resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamMFADevice.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamMFADevice.json new file mode 100644 index 000000000000..9305cc47a633 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamMFADevice.json @@ -0,0 +1,555 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamMFADevices" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamMFADevices": { + "get": { + "operationId": "IamMfaDevices_ListBySubscription", + "tags": [ + "IamMFADevices" + ], + "description": "List IamMFADevice resources 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/IamMFADeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamMfaDevices_ListBySubscription": { + "$ref": "./examples/IamMfaDevices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamMFADevices": { + "get": { + "operationId": "IamMfaDevices_ListByResourceGroup", + "tags": [ + "IamMFADevices" + ], + "description": "List IamMFADevice resources 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/IamMFADeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamMfaDevices_ListByResourceGroup": { + "$ref": "./examples/IamMfaDevices_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamMFADevices/{name}": { + "get": { + "operationId": "IamMfaDevices_Get", + "tags": [ + "IamMFADevices" + ], + "description": "Get a IamMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamMFADevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamMfaDevices_Get": { + "$ref": "./examples/IamMfaDevices_Get.json" + } + } + }, + "put": { + "operationId": "IamMfaDevices_CreateOrReplace", + "tags": [ + "IamMFADevices" + ], + "description": "Create a IamMFADevice. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamMFADevice" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamMFADevice' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamMFADevice" + } + }, + "201": { + "description": "Resource 'IamMFADevice' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamMFADevice" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamMfaDevices_CreateOrReplace": { + "$ref": "./examples/IamMfaDevices_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamMfaDevices_Update", + "tags": [ + "IamMFADevices" + ], + "description": "Update a IamMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamMFADeviceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamMFADevice" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamMfaDevices_Update": { + "$ref": "./examples/IamMfaDevices_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamMfaDevices_Delete", + "tags": [ + "IamMFADevices" + ], + "description": "Delete a IamMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamMfaDevices_Delete": { + "$ref": "./examples/IamMfaDevices_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamMFADeviceProperties": { + "type": "object", + "description": "Definition of awsIamMFADevice", + "properties": { + "enableDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date when the MFA device was enabled for the user.</p>" + }, + "serialNumber": { + "type": "string", + "description": "<p>The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.</p>" + }, + "userName": { + "type": "string", + "description": "<p>The user with whom the MFA device is associated.</p>" + } + } + }, + "IamMFADevice": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamMFADeviceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamMFADeviceListResult": { + "type": "object", + "description": "The response of a IamMFADevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamMFADevice items on this page", + "items": { + "$ref": "#/definitions/IamMFADevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamMFADeviceProperties": { + "type": "object", + "description": "Definition of IamMFADevice", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamMFADeviceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamMFADeviceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamMFADevice resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPasswordPolicy.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPasswordPolicy.json new file mode 100644 index 000000000000..ede59fcd7532 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPasswordPolicy.json @@ -0,0 +1,585 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamPasswordPolicies" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamPasswordPolicies": { + "get": { + "operationId": "IamPasswordPolicies_ListBySubscription", + "tags": [ + "IamPasswordPolicies" + ], + "description": "List IamPasswordPolicy resources 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/IamPasswordPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPasswordPolicies_ListBySubscription": { + "$ref": "./examples/IamPasswordPolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamPasswordPolicies": { + "get": { + "operationId": "IamPasswordPolicies_ListByResourceGroup", + "tags": [ + "IamPasswordPolicies" + ], + "description": "List IamPasswordPolicy resources 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/IamPasswordPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPasswordPolicies_ListByResourceGroup": { + "$ref": "./examples/IamPasswordPolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamPasswordPolicies/{name}": { + "get": { + "operationId": "IamPasswordPolicies_Get", + "tags": [ + "IamPasswordPolicies" + ], + "description": "Get a IamPasswordPolicy", + "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": "name", + "in": "path", + "description": "Name of IamPasswordPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamPasswordPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPasswordPolicies_Get": { + "$ref": "./examples/IamPasswordPolicies_Get.json" + } + } + }, + "put": { + "operationId": "IamPasswordPolicies_CreateOrReplace", + "tags": [ + "IamPasswordPolicies" + ], + "description": "Create a IamPasswordPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamPasswordPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamPasswordPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamPasswordPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamPasswordPolicy" + } + }, + "201": { + "description": "Resource 'IamPasswordPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamPasswordPolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamPasswordPolicies_CreateOrReplace": { + "$ref": "./examples/IamPasswordPolicies_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamPasswordPolicies_Update", + "tags": [ + "IamPasswordPolicies" + ], + "description": "Update a IamPasswordPolicy", + "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": "name", + "in": "path", + "description": "Name of IamPasswordPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamPasswordPolicyTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamPasswordPolicy" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPasswordPolicies_Update": { + "$ref": "./examples/IamPasswordPolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamPasswordPolicies_Delete", + "tags": [ + "IamPasswordPolicies" + ], + "description": "Delete a IamPasswordPolicy", + "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": "name", + "in": "path", + "description": "Name of IamPasswordPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamPasswordPolicies_Delete": { + "$ref": "./examples/IamPasswordPolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamPasswordPolicyProperties": { + "type": "object", + "description": "Definition of awsIamPasswordPolicy", + "properties": { + "allowUsersToChangePassword": { + "type": "boolean", + "description": "<p>Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to <code>iam:ChangePassword</code> for only their user and to the <code>iam:GetAccountPasswordPolicy</code> action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.</p>" + }, + "expirePasswords": { + "type": "boolean", + "description": "<p>Indicates whether passwords in the account expire. Returns true if <code>MaxPasswordAge</code> contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.</p>" + }, + "hardExpiry": { + "type": "boolean", + "description": "<p>Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with <code>iam:ChangePassword</code> permission and active access keys can reset their own expired console password using the CLI or API.</p>" + }, + "maxPasswordAge": { + "type": "integer", + "format": "int32", + "description": "<p>The number of days that an IAM user password is valid.</p>" + }, + "minimumPasswordLength": { + "type": "integer", + "format": "int32", + "description": "<p>Minimum length to require for IAM user passwords.</p>" + }, + "passwordReusePrevention": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the number of previous passwords that IAM users are prevented from reusing.</p>" + }, + "requireLowercaseCharacters": { + "type": "boolean", + "description": "<p>Specifies whether IAM user passwords must contain at least one lowercase character (a to z).</p>" + }, + "requireNumbers": { + "type": "boolean", + "description": "<p>Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).</p>" + }, + "requireSymbols": { + "type": "boolean", + "description": "<p>Specifies whether IAM user passwords must contain at least one of the following symbols:</p> <p>! @ # $ % ^ & * ( ) _ + - = [ ] { } | '</p>" + }, + "requireUppercaseCharacters": { + "type": "boolean", + "description": "<p>Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).</p>" + } + } + }, + "IamPasswordPolicy": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamPasswordPolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamPasswordPolicyListResult": { + "type": "object", + "description": "The response of a IamPasswordPolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamPasswordPolicy items on this page", + "items": { + "$ref": "#/definitions/IamPasswordPolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamPasswordPolicyProperties": { + "type": "object", + "description": "Definition of IamPasswordPolicy", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamPasswordPolicyProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamPasswordPolicyTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamPasswordPolicy resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPolicyVersion.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPolicyVersion.json new file mode 100644 index 000000000000..02d05f5814ba --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamPolicyVersion.json @@ -0,0 +1,559 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamPolicyVersions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamPolicyVersions": { + "get": { + "operationId": "IamPolicyVersions_ListBySubscription", + "tags": [ + "IamPolicyVersions" + ], + "description": "List IamPolicyVersion resources 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/IamPolicyVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPolicyVersions_ListBySubscription": { + "$ref": "./examples/IamPolicyVersions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamPolicyVersions": { + "get": { + "operationId": "IamPolicyVersions_ListByResourceGroup", + "tags": [ + "IamPolicyVersions" + ], + "description": "List IamPolicyVersion resources 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/IamPolicyVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPolicyVersions_ListByResourceGroup": { + "$ref": "./examples/IamPolicyVersions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamPolicyVersions/{name}": { + "get": { + "operationId": "IamPolicyVersions_Get", + "tags": [ + "IamPolicyVersions" + ], + "description": "Get a IamPolicyVersion", + "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": "name", + "in": "path", + "description": "Name of IamPolicyVersion", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamPolicyVersion" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPolicyVersions_Get": { + "$ref": "./examples/IamPolicyVersions_Get.json" + } + } + }, + "put": { + "operationId": "IamPolicyVersions_CreateOrReplace", + "tags": [ + "IamPolicyVersions" + ], + "description": "Create a IamPolicyVersion. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamPolicyVersion", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamPolicyVersion" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamPolicyVersion' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamPolicyVersion" + } + }, + "201": { + "description": "Resource 'IamPolicyVersion' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamPolicyVersion" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamPolicyVersions_CreateOrReplace": { + "$ref": "./examples/IamPolicyVersions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamPolicyVersions_Update", + "tags": [ + "IamPolicyVersions" + ], + "description": "Update a IamPolicyVersion", + "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": "name", + "in": "path", + "description": "Name of IamPolicyVersion", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamPolicyVersionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamPolicyVersion" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamPolicyVersions_Update": { + "$ref": "./examples/IamPolicyVersions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamPolicyVersions_Delete", + "tags": [ + "IamPolicyVersions" + ], + "description": "Delete a IamPolicyVersion", + "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": "name", + "in": "path", + "description": "Name of IamPolicyVersion", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamPolicyVersions_Delete": { + "$ref": "./examples/IamPolicyVersions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamPolicyVersionProperties": { + "type": "object", + "description": "Definition of awsIamPolicyVersion", + "properties": { + "createDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, in <a href='http://www.iso.org/iso/iso8601'>ISO 8601 date-time format</a>, when the policy version was created.</p>" + }, + "document": { + "type": "string", + "description": "<p>The policy document.</p> <p>The policy document is returned in the response to the <a>GetPolicyVersion</a> and <a>GetAccountAuthorizationDetails</a> operations. It is not returned in the response to the <a>CreatePolicyVersion</a> or <a>ListPolicyVersions</a> operations. </p> <p>The policy document returned in this structure is URL-encoded compliant with <a href='https://tools.ietf.org/html/rfc3986'>RFC 3986</a>. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the <code>decode</code> method of the <code>java.net.URLDecoder</code> utility class in the Java SDK. Other languages and SDKs provide similar functionality.</p>" + }, + "isDefaultVersion": { + "type": "boolean", + "description": "<p>Specifies whether the policy version is set as the policy's default version.</p>" + }, + "versionId": { + "type": "string", + "description": "<p>The identifier for the policy version.</p> <p>Policy version identifiers always begin with <code>v</code> (always lowercase). When a policy is created, the first policy version is <code>v1</code>. </p>" + } + } + }, + "IamPolicyVersion": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamPolicyVersionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamPolicyVersionListResult": { + "type": "object", + "description": "The response of a IamPolicyVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamPolicyVersion items on this page", + "items": { + "$ref": "#/definitions/IamPolicyVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamPolicyVersionProperties": { + "type": "object", + "description": "Definition of IamPolicyVersion", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamPolicyVersionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamPolicyVersionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamPolicyVersion resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamRole.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamRole.json new file mode 100644 index 000000000000..d6bd6b66e3cc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamRole.json @@ -0,0 +1,630 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamRoles" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamRoles": { + "get": { + "operationId": "IamRoles_ListBySubscription", + "tags": [ + "IamRoles" + ], + "description": "List IamRole resources 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/IamRoleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamRoles_ListBySubscription": { + "$ref": "./examples/IamRoles_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamRoles": { + "get": { + "operationId": "IamRoles_ListByResourceGroup", + "tags": [ + "IamRoles" + ], + "description": "List IamRole resources 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/IamRoleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamRoles_ListByResourceGroup": { + "$ref": "./examples/IamRoles_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamRoles/{name}": { + "get": { + "operationId": "IamRoles_Get", + "tags": [ + "IamRoles" + ], + "description": "Get a IamRole", + "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": "name", + "in": "path", + "description": "Name of IamRole", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamRole" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamRoles_Get": { + "$ref": "./examples/IamRoles_Get.json" + } + } + }, + "put": { + "operationId": "IamRoles_CreateOrReplace", + "tags": [ + "IamRoles" + ], + "description": "Create a IamRole. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamRole", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamRole" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamRole' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamRole" + } + }, + "201": { + "description": "Resource 'IamRole' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamRole" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamRoles_CreateOrReplace": { + "$ref": "./examples/IamRoles_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamRoles_Update", + "tags": [ + "IamRoles" + ], + "description": "Update a IamRole", + "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": "name", + "in": "path", + "description": "Name of IamRole", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamRoleTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamRole" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamRoles_Update": { + "$ref": "./examples/IamRoles_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamRoles_Delete", + "tags": [ + "IamRoles" + ], + "description": "Delete a IamRole", + "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": "name", + "in": "path", + "description": "Name of IamRole", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamRoles_Delete": { + "$ref": "./examples/IamRoles_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamRoleProperties": { + "type": "object", + "description": "Definition of awsIamRole", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "assumeRolePolicyDocument": { + "type": "object", + "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*.", + "additionalProperties": {} + }, + "description": { + "type": "string", + "description": "A description of the role that you provide." + }, + "managedPolicyArns": { + "type": "array", + "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "maxSessionDuration": { + "type": "integer", + "format": "int32", + "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*." + }, + "path": { + "type": "string", + "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", + "default": "/" + }, + "permissionsBoundary": { + "type": "string", + "description": "The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*." + }, + "policies": { + "type": "array", + "description": "Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. If an external policy (such as ``AWS::IAM::Policy`` or", + "items": { + "$ref": "#/definitions/Policy" + }, + "x-ms-identifiers": [] + }, + "roleId": { + "type": "string", + "description": "Property roleId" + }, + "roleName": { + "type": "string", + "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both 'Role1' and 'role1'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/Use" + }, + "tags": { + "type": "array", + "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "IamRole": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamRoleProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamRoleListResult": { + "type": "object", + "description": "The response of a IamRole list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamRole items on this page", + "items": { + "$ref": "#/definitions/IamRole" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamRoleProperties": { + "type": "object", + "description": "Definition of IamRole", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamRoleProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamRoleTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamRole resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Policy": { + "type": "object", + "description": "Definition of Policy", + "properties": { + "policyDocument": { + "type": "object", + "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).", + "additionalProperties": {} + }, + "policyName": { + "type": "string", + "description": "The friendly name (not ARN) identifying the policy." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices." + }, + "value": { + "type": "string", + "description": "The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values. AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamServerCertificate.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamServerCertificate.json new file mode 100644 index 000000000000..d2156b86bb88 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamServerCertificate.json @@ -0,0 +1,588 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamServerCertificates" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamServerCertificates": { + "get": { + "operationId": "IamServerCertificates_ListBySubscription", + "tags": [ + "IamServerCertificates" + ], + "description": "List IamServerCertificate resources 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/IamServerCertificateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamServerCertificates_ListBySubscription": { + "$ref": "./examples/IamServerCertificates_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamServerCertificates": { + "get": { + "operationId": "IamServerCertificates_ListByResourceGroup", + "tags": [ + "IamServerCertificates" + ], + "description": "List IamServerCertificate resources 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/IamServerCertificateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamServerCertificates_ListByResourceGroup": { + "$ref": "./examples/IamServerCertificates_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamServerCertificates/{name}": { + "get": { + "operationId": "IamServerCertificates_Get", + "tags": [ + "IamServerCertificates" + ], + "description": "Get a IamServerCertificate", + "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": "name", + "in": "path", + "description": "Name of IamServerCertificate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamServerCertificate" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamServerCertificates_Get": { + "$ref": "./examples/IamServerCertificates_Get.json" + } + } + }, + "put": { + "operationId": "IamServerCertificates_CreateOrReplace", + "tags": [ + "IamServerCertificates" + ], + "description": "Create a IamServerCertificate. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamServerCertificate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamServerCertificate" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamServerCertificate' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamServerCertificate" + } + }, + "201": { + "description": "Resource 'IamServerCertificate' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamServerCertificate" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamServerCertificates_CreateOrReplace": { + "$ref": "./examples/IamServerCertificates_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamServerCertificates_Update", + "tags": [ + "IamServerCertificates" + ], + "description": "Update a IamServerCertificate", + "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": "name", + "in": "path", + "description": "Name of IamServerCertificate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamServerCertificateTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamServerCertificate" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamServerCertificates_Update": { + "$ref": "./examples/IamServerCertificates_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamServerCertificates_Delete", + "tags": [ + "IamServerCertificates" + ], + "description": "Delete a IamServerCertificate", + "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": "name", + "in": "path", + "description": "Name of IamServerCertificate", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamServerCertificates_Delete": { + "$ref": "./examples/IamServerCertificates_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamServerCertificateProperties": { + "type": "object", + "description": "Definition of awsIamServerCertificate", + "properties": { + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN) of the server certificate" + }, + "certificateBody": { + "type": "string", + "description": "Property certificateBody" + }, + "certificateChain": { + "type": "string", + "description": "Property certificateChain" + }, + "path": { + "type": "string", + "description": "Property path" + }, + "privateKey": { + "type": "string", + "description": "Property privateKey" + }, + "serverCertificateName": { + "type": "string", + "description": "Property serverCertificateName" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "IamServerCertificate": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamServerCertificateProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamServerCertificateListResult": { + "type": "object", + "description": "The response of a IamServerCertificate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamServerCertificate items on this page", + "items": { + "$ref": "#/definitions/IamServerCertificate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamServerCertificateProperties": { + "type": "object", + "description": "Definition of IamServerCertificate", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamServerCertificateProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamServerCertificateTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamServerCertificate resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamVirtualMFADevice.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamVirtualMFADevice.json new file mode 100644 index 000000000000..263be835e1e4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/iamVirtualMFADevice.json @@ -0,0 +1,584 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "IamVirtualMFADevices" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/iamVirtualMFADevices": { + "get": { + "operationId": "IamVirtualMfaDevices_ListBySubscription", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "List IamVirtualMFADevice resources 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/IamVirtualMFADeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamVirtualMfaDevices_ListBySubscription": { + "$ref": "./examples/IamVirtualMfaDevices_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamVirtualMFADevices": { + "get": { + "operationId": "IamVirtualMfaDevices_ListByResourceGroup", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "List IamVirtualMFADevice resources 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/IamVirtualMFADeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamVirtualMfaDevices_ListByResourceGroup": { + "$ref": "./examples/IamVirtualMfaDevices_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/iamVirtualMFADevices/{name}": { + "get": { + "operationId": "IamVirtualMfaDevices_Get", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "Get a IamVirtualMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamVirtualMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamVirtualMFADevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamVirtualMfaDevices_Get": { + "$ref": "./examples/IamVirtualMfaDevices_Get.json" + } + } + }, + "put": { + "operationId": "IamVirtualMfaDevices_CreateOrReplace", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "Create a IamVirtualMFADevice. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of IamVirtualMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/IamVirtualMFADevice" + } + } + ], + "responses": { + "200": { + "description": "Resource 'IamVirtualMFADevice' update operation succeeded", + "schema": { + "$ref": "#/definitions/IamVirtualMFADevice" + } + }, + "201": { + "description": "Resource 'IamVirtualMFADevice' create operation succeeded", + "schema": { + "$ref": "#/definitions/IamVirtualMFADevice" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "IamVirtualMfaDevices_CreateOrReplace": { + "$ref": "./examples/IamVirtualMfaDevices_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "IamVirtualMfaDevices_Update", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "Update a IamVirtualMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamVirtualMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/IamVirtualMFADeviceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/IamVirtualMFADevice" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "IamVirtualMfaDevices_Update": { + "$ref": "./examples/IamVirtualMfaDevices_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "IamVirtualMfaDevices_Delete", + "tags": [ + "IamVirtualMFADevices" + ], + "description": "Delete a IamVirtualMFADevice", + "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": "name", + "in": "path", + "description": "Name of IamVirtualMFADevice", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "IamVirtualMfaDevices_Delete": { + "$ref": "./examples/IamVirtualMfaDevices_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsIamVirtualMFADeviceProperties": { + "type": "object", + "description": "Definition of awsIamVirtualMFADevice", + "properties": { + "path": { + "type": "string", + "description": "Property path" + }, + "serialNumber": { + "type": "string", + "description": "Property serialNumber" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "users": { + "type": "array", + "description": "Property users", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "virtualMfaDeviceName": { + "type": "string", + "description": "Property virtualMfaDeviceName" + } + } + }, + "IamVirtualMFADevice": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/IamVirtualMFADeviceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "IamVirtualMFADeviceListResult": { + "type": "object", + "description": "The response of a IamVirtualMFADevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The IamVirtualMFADevice items on this page", + "items": { + "$ref": "#/definitions/IamVirtualMFADevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "IamVirtualMFADeviceProperties": { + "type": "object", + "description": "Definition of IamVirtualMFADevice", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsIamVirtualMFADeviceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "IamVirtualMFADeviceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in IamVirtualMFADevice resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsAlias.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsAlias.json new file mode 100644 index 000000000000..e1e7d6f610ec --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsAlias.json @@ -0,0 +1,550 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "KmsAliases" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/kmsAliases": { + "get": { + "operationId": "KmsAliases_ListBySubscription", + "tags": [ + "KmsAliases" + ], + "description": "List KmsAlias resources 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/KmsAliasListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsAliases_ListBySubscription": { + "$ref": "./examples/KmsAliases_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/kmsAliases": { + "get": { + "operationId": "KmsAliases_ListByResourceGroup", + "tags": [ + "KmsAliases" + ], + "description": "List KmsAlias resources 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/KmsAliasListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsAliases_ListByResourceGroup": { + "$ref": "./examples/KmsAliases_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/kmsAliases/{name}": { + "get": { + "operationId": "KmsAliases_Get", + "tags": [ + "KmsAliases" + ], + "description": "Get a KmsAlias", + "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": "name", + "in": "path", + "description": "Name of KmsAlias", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/KmsAlias" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsAliases_Get": { + "$ref": "./examples/KmsAliases_Get.json" + } + } + }, + "put": { + "operationId": "KmsAliases_CreateOrReplace", + "tags": [ + "KmsAliases" + ], + "description": "Create a KmsAlias. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of KmsAlias", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/KmsAlias" + } + } + ], + "responses": { + "200": { + "description": "Resource 'KmsAlias' update operation succeeded", + "schema": { + "$ref": "#/definitions/KmsAlias" + } + }, + "201": { + "description": "Resource 'KmsAlias' create operation succeeded", + "schema": { + "$ref": "#/definitions/KmsAlias" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "KmsAliases_CreateOrReplace": { + "$ref": "./examples/KmsAliases_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "KmsAliases_Update", + "tags": [ + "KmsAliases" + ], + "description": "Update a KmsAlias", + "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": "name", + "in": "path", + "description": "Name of KmsAlias", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/KmsAliasTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/KmsAlias" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsAliases_Update": { + "$ref": "./examples/KmsAliases_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "KmsAliases_Delete", + "tags": [ + "KmsAliases" + ], + "description": "Delete a KmsAlias", + "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": "name", + "in": "path", + "description": "Name of KmsAlias", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "KmsAliases_Delete": { + "$ref": "./examples/KmsAliases_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsKmsAliasProperties": { + "type": "object", + "description": "Definition of awsKmsAlias", + "properties": { + "aliasName": { + "type": "string", + "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)." + }, + "targetKeyId": { + "type": "string", + "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)." + } + } + }, + "KmsAlias": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/KmsAliasProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "KmsAliasListResult": { + "type": "object", + "description": "The response of a KmsAlias list operation.", + "properties": { + "value": { + "type": "array", + "description": "The KmsAlias items on this page", + "items": { + "$ref": "#/definitions/KmsAlias" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "KmsAliasProperties": { + "type": "object", + "description": "Definition of KmsAlias", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsKmsAliasProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "KmsAliasTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in KmsAlias resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsKey.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsKey.json new file mode 100644 index 000000000000..9b940475673b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/kmsKey.json @@ -0,0 +1,899 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "KmsKeys" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/kmsKeys": { + "get": { + "operationId": "KmsKeys_ListBySubscription", + "tags": [ + "KmsKeys" + ], + "description": "List KmsKey resources 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/KmsKeyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsKeys_ListBySubscription": { + "$ref": "./examples/KmsKeys_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/kmsKeys": { + "get": { + "operationId": "KmsKeys_ListByResourceGroup", + "tags": [ + "KmsKeys" + ], + "description": "List KmsKey resources 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/KmsKeyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsKeys_ListByResourceGroup": { + "$ref": "./examples/KmsKeys_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/kmsKeys/{name}": { + "get": { + "operationId": "KmsKeys_Get", + "tags": [ + "KmsKeys" + ], + "description": "Get a KmsKey", + "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": "name", + "in": "path", + "description": "Name of KmsKey", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/KmsKey" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsKeys_Get": { + "$ref": "./examples/KmsKeys_Get.json" + } + } + }, + "put": { + "operationId": "KmsKeys_CreateOrReplace", + "tags": [ + "KmsKeys" + ], + "description": "Create a KmsKey. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of KmsKey", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/KmsKey" + } + } + ], + "responses": { + "200": { + "description": "Resource 'KmsKey' update operation succeeded", + "schema": { + "$ref": "#/definitions/KmsKey" + } + }, + "201": { + "description": "Resource 'KmsKey' create operation succeeded", + "schema": { + "$ref": "#/definitions/KmsKey" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "KmsKeys_CreateOrReplace": { + "$ref": "./examples/KmsKeys_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "KmsKeys_Update", + "tags": [ + "KmsKeys" + ], + "description": "Update a KmsKey", + "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": "name", + "in": "path", + "description": "Name of KmsKey", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/KmsKeyTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/KmsKey" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "KmsKeys_Update": { + "$ref": "./examples/KmsKeys_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "KmsKeys_Delete", + "tags": [ + "KmsKeys" + ], + "description": "Delete a KmsKey", + "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": "name", + "in": "path", + "description": "Name of KmsKey", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "KmsKeys_Delete": { + "$ref": "./examples/KmsKeys_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsKmsKeyProperties": { + "type": "object", + "description": "Definition of awsKmsKey", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "bypassPolicyLockoutSafetyCheck": { + "type": "boolean", + "description": "Skips ('bypasses') the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key." + }, + "description": { + "type": "string", + "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use." + }, + "enableKeyRotation": { + "type": "boolean", + "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*." + }, + "keyId": { + "type": "string", + "description": "Property keyId" + }, + "keyPolicy": { + "type": "object", + "description": "The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. A key policy document can include only the following characters: + Printable ASCII characters + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters *Minimum*: ``1`` *Maximum*: ``32768``", + "additionalProperties": {} + }, + "keySpec": { + "type": "string", + "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [services that are integrated with](https://docs.aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2``", + "default": "SYMMETRIC_DEFAULT", + "enum": [ + "ECC_NIST_P256", + "ECC_NIST_P384", + "ECC_NIST_P521", + "ECC_SECG_P256K1", + "HMAC_224", + "HMAC_256", + "HMAC_384", + "HMAC_512", + "RSA_2048", + "RSA_3072", + "RSA_4096", + "SM2", + "SYMMETRIC_DEFAULT" + ], + "x-ms-enum": { + "name": "KeySpec", + "modelAsString": true, + "values": [ + { + "name": "ECC_NIST_P256", + "value": "ECC_NIST_P256", + "description": "KeySpec enum ECC_NIST_P256" + }, + { + "name": "ECC_NIST_P384", + "value": "ECC_NIST_P384", + "description": "KeySpec enum ECC_NIST_P384" + }, + { + "name": "ECC_NIST_P521", + "value": "ECC_NIST_P521", + "description": "KeySpec enum ECC_NIST_P521" + }, + { + "name": "ECC_SECG_P256K1", + "value": "ECC_SECG_P256K1", + "description": "KeySpec enum ECC_SECG_P256K1" + }, + { + "name": "HMAC_224", + "value": "HMAC_224", + "description": "KeySpec enum HMAC_224" + }, + { + "name": "HMAC_256", + "value": "HMAC_256", + "description": "KeySpec enum HMAC_256" + }, + { + "name": "HMAC_384", + "value": "HMAC_384", + "description": "KeySpec enum HMAC_384" + }, + { + "name": "HMAC_512", + "value": "HMAC_512", + "description": "KeySpec enum HMAC_512" + }, + { + "name": "RSA_2048", + "value": "RSA_2048", + "description": "KeySpec enum RSA_2048" + }, + { + "name": "RSA_3072", + "value": "RSA_3072", + "description": "KeySpec enum RSA_3072" + }, + { + "name": "RSA_4096", + "value": "RSA_4096", + "description": "KeySpec enum RSA_4096" + }, + { + "name": "SM2", + "value": "SM2", + "description": "KeySpec enum SM2" + }, + { + "name": "SYMMETRIC_DEFAULT", + "value": "SYMMETRIC_DEFAULT", + "description": "KeySpec enum SYMMETRIC_DEFAULT" + } + ] + } + }, + "keyUsage": { + "type": "string", + "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", + "default": "ENCRYPT_DECRYPT", + "enum": [ + "ENCRYPT_DECRYPT", + "GENERATE_VERIFY_MAC", + "SIGN_VERIFY" + ], + "x-ms-enum": { + "name": "KeyUsage", + "modelAsString": true, + "values": [ + { + "name": "ENCRYPT_DECRYPT", + "value": "ENCRYPT_DECRYPT", + "description": "KeyUsage enum ENCRYPT_DECRYPT" + }, + { + "name": "GENERATE_VERIFY_MAC", + "value": "GENERATE_VERIFY_MAC", + "description": "KeyUsage enum GENERATE_VERIFY_MAC" + }, + { + "name": "SIGN_VERIFY", + "value": "SIGN_VERIFY", + "description": "KeyUsage enum SIGN_VERIFY" + } + ] + } + }, + "multiRegion": { + "type": "boolean", + "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key." + }, + "origin": { + "type": "string", + "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", + "default": "AWS_KMS", + "enum": [ + "AWS_KMS", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "AWS_KMS", + "value": "AWS_KMS", + "description": "Origin enum AWS_KMS" + }, + { + "name": "EXTERNAL", + "value": "EXTERNAL", + "description": "Origin enum EXTERNAL" + } + ] + } + }, + "pendingWindowInDays": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*." + }, + "rotationPeriodInDays": { + "type": "integer", + "format": "int32", + "description": "Property rotationPeriodInDays", + "default": 365 + }, + "tags": { + "type": "array", + "description": "Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "KeySpec": { + "type": "string", + "description": "KeySpec enum", + "enum": [ + "ECC_NIST_P256", + "ECC_NIST_P384", + "ECC_NIST_P521", + "ECC_SECG_P256K1", + "HMAC_224", + "HMAC_256", + "HMAC_384", + "HMAC_512", + "RSA_2048", + "RSA_3072", + "RSA_4096", + "SM2", + "SYMMETRIC_DEFAULT" + ], + "x-ms-enum": { + "name": "KeySpec", + "modelAsString": true, + "values": [ + { + "name": "ECC_NIST_P256", + "value": "ECC_NIST_P256", + "description": "KeySpec enum ECC_NIST_P256" + }, + { + "name": "ECC_NIST_P384", + "value": "ECC_NIST_P384", + "description": "KeySpec enum ECC_NIST_P384" + }, + { + "name": "ECC_NIST_P521", + "value": "ECC_NIST_P521", + "description": "KeySpec enum ECC_NIST_P521" + }, + { + "name": "ECC_SECG_P256K1", + "value": "ECC_SECG_P256K1", + "description": "KeySpec enum ECC_SECG_P256K1" + }, + { + "name": "HMAC_224", + "value": "HMAC_224", + "description": "KeySpec enum HMAC_224" + }, + { + "name": "HMAC_256", + "value": "HMAC_256", + "description": "KeySpec enum HMAC_256" + }, + { + "name": "HMAC_384", + "value": "HMAC_384", + "description": "KeySpec enum HMAC_384" + }, + { + "name": "HMAC_512", + "value": "HMAC_512", + "description": "KeySpec enum HMAC_512" + }, + { + "name": "RSA_2048", + "value": "RSA_2048", + "description": "KeySpec enum RSA_2048" + }, + { + "name": "RSA_3072", + "value": "RSA_3072", + "description": "KeySpec enum RSA_3072" + }, + { + "name": "RSA_4096", + "value": "RSA_4096", + "description": "KeySpec enum RSA_4096" + }, + { + "name": "SM2", + "value": "SM2", + "description": "KeySpec enum SM2" + }, + { + "name": "SYMMETRIC_DEFAULT", + "value": "SYMMETRIC_DEFAULT", + "description": "KeySpec enum SYMMETRIC_DEFAULT" + } + ] + } + }, + "KeyUsage": { + "type": "string", + "description": "KeyUsage enum", + "enum": [ + "ENCRYPT_DECRYPT", + "GENERATE_VERIFY_MAC", + "SIGN_VERIFY" + ], + "x-ms-enum": { + "name": "KeyUsage", + "modelAsString": true, + "values": [ + { + "name": "ENCRYPT_DECRYPT", + "value": "ENCRYPT_DECRYPT", + "description": "KeyUsage enum ENCRYPT_DECRYPT" + }, + { + "name": "GENERATE_VERIFY_MAC", + "value": "GENERATE_VERIFY_MAC", + "description": "KeyUsage enum GENERATE_VERIFY_MAC" + }, + { + "name": "SIGN_VERIFY", + "value": "SIGN_VERIFY", + "description": "KeyUsage enum SIGN_VERIFY" + } + ] + } + }, + "KmsKey": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/KmsKeyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "KmsKeyListResult": { + "type": "object", + "description": "The response of a KmsKey list operation.", + "properties": { + "value": { + "type": "array", + "description": "The KmsKey items on this page", + "items": { + "$ref": "#/definitions/KmsKey" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "KmsKeyProperties": { + "type": "object", + "description": "Definition of KmsKey", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsKmsKeyProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "KmsKeyTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in KmsKey resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Origin": { + "type": "string", + "description": "Origin enum", + "enum": [ + "AWS_KMS", + "EXTERNAL" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true, + "values": [ + { + "name": "AWS_KMS", + "value": "AWS_KMS", + "description": "Origin enum AWS_KMS" + }, + { + "name": "EXTERNAL", + "value": "EXTERNAL", + "description": "Origin enum EXTERNAL" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunction.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunction.json new file mode 100644 index 000000000000..01f5b8c5cb8b --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunction.json @@ -0,0 +1,1155 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LambdaFunctions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/lambdaFunctions": { + "get": { + "operationId": "LambdaFunctions_ListBySubscription", + "tags": [ + "LambdaFunctions" + ], + "description": "List LambdaFunction resources 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/LambdaFunctionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctions_ListBySubscription": { + "$ref": "./examples/LambdaFunctions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lambdaFunctions": { + "get": { + "operationId": "LambdaFunctions_ListByResourceGroup", + "tags": [ + "LambdaFunctions" + ], + "description": "List LambdaFunction resources 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/LambdaFunctionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctions_ListByResourceGroup": { + "$ref": "./examples/LambdaFunctions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lambdaFunctions/{name}": { + "get": { + "operationId": "LambdaFunctions_Get", + "tags": [ + "LambdaFunctions" + ], + "description": "Get a LambdaFunction", + "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": "name", + "in": "path", + "description": "Name of LambdaFunction", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LambdaFunction" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctions_Get": { + "$ref": "./examples/LambdaFunctions_Get.json" + } + } + }, + "put": { + "operationId": "LambdaFunctions_CreateOrReplace", + "tags": [ + "LambdaFunctions" + ], + "description": "Create a LambdaFunction. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LambdaFunction", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LambdaFunction" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LambdaFunction' update operation succeeded", + "schema": { + "$ref": "#/definitions/LambdaFunction" + } + }, + "201": { + "description": "Resource 'LambdaFunction' create operation succeeded", + "schema": { + "$ref": "#/definitions/LambdaFunction" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LambdaFunctions_CreateOrReplace": { + "$ref": "./examples/LambdaFunctions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LambdaFunctions_Update", + "tags": [ + "LambdaFunctions" + ], + "description": "Update a LambdaFunction", + "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": "name", + "in": "path", + "description": "Name of LambdaFunction", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LambdaFunctionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LambdaFunction" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctions_Update": { + "$ref": "./examples/LambdaFunctions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LambdaFunctions_Delete", + "tags": [ + "LambdaFunctions" + ], + "description": "Delete a LambdaFunction", + "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": "name", + "in": "path", + "description": "Name of LambdaFunction", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LambdaFunctions_Delete": { + "$ref": "./examples/LambdaFunctions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Architectures": { + "type": "string", + "description": "Architectures enum", + "enum": [ + "arm64", + "x86_64" + ], + "x-ms-enum": { + "name": "Architectures", + "modelAsString": true, + "values": [ + { + "name": "arm64", + "value": "arm64", + "description": "Architectures enum arm64" + }, + { + "name": "x86_64", + "value": "x86_64", + "description": "Architectures enum x86_64" + } + ] + } + }, + "AwsLambdaFunctionProperties": { + "type": "object", + "description": "Definition of awsLambdaFunction", + "properties": { + "architectures": { + "type": "array", + "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``.", + "items": { + "$ref": "#/definitions/Architectures" + }, + "x-ms-identifiers": [] + }, + "arn": { + "type": "string", + "description": "Property arn" + }, + "code": { + "$ref": "#/definitions/Code", + "description": "The code for the function. The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template." + }, + "codeSigningConfigArn": { + "type": "string", + "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function." + }, + "deadLetterConfig": { + "$ref": "#/definitions/DeadLetterConfig", + "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations." + }, + "description": { + "type": "string", + "description": "A description of the function." + }, + "environment": { + "$ref": "#/definitions/Environment", + "description": "Environment variables that are accessible from function code during execution. A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration." + }, + "ephemeralStorage": { + "$ref": "#/definitions/EphemeralStorage", + "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." + }, + "fileSystemConfigs": { + "type": "array", + "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html).", + "items": { + "$ref": "#/definitions/FileSystemConfig" + }, + "x-ms-identifiers": [] + }, + "functionName": { + "type": "string", + "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "handler": { + "type": "string", + "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html)." + }, + "imageConfig": { + "$ref": "#/definitions/ImageConfig", + "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." + }, + "kmsKeyArn": { + "type": "string", + "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key." + }, + "layers": { + "type": "array", + "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "loggingConfig": { + "$ref": "#/definitions/LoggingConfig", + "description": "The function's Amazon CloudWatch Logs configuration settings. The function's Amazon CloudWatch Logs configuration settings." + }, + "memorySize": { + "type": "integer", + "format": "int32", + "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase." + }, + "packageType": { + "$ref": "#/definitions/PackageType", + "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive." + }, + "reservedConcurrentExecutions": { + "type": "integer", + "format": "int32", + "description": "The number of simultaneous executions to reserve for the function." + }, + "role": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the function's execution role." + }, + "runtime": { + "type": "string", + "description": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." + }, + "runtimeManagementConfig": { + "$ref": "#/definitions/RuntimeManagementConfig", + "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." + }, + "snapStart": { + "$ref": "#/definitions/SnapStart", + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." + }, + "snapStartResponse": { + "$ref": "#/definitions/SnapStartResponse", + "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." + }, + "tags": { + "type": "array", + "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)." + }, + "tracingConfig": { + "$ref": "#/definitions/TracingConfig", + "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``." + }, + "vpcConfig": { + "$ref": "#/definitions/VpcConfig", + "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted." + } + } + }, + "Code": { + "type": "object", + "description": "Definition of Code", + "properties": { + "imageUri": { + "type": "string", + "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry." + }, + "s3Bucket": { + "type": "string", + "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account." + }, + "s3Key": { + "type": "string", + "description": "The Amazon S3 key of the deployment package." + }, + "s3ObjectVersion": { + "type": "string", + "description": "For versioned objects, the version of the deployment package object to use." + }, + "zipFile": { + "type": "string", + "description": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details." + } + } + }, + "DeadLetterConfig": { + "type": "object", + "description": "Definition of DeadLetterConfig", + "properties": { + "targetArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic." + } + } + }, + "Environment": { + "type": "object", + "description": "Definition of Environment", + "properties": { + "variables": { + "type": "object", + "description": "Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).", + "additionalProperties": { + "type": "string" + } + } + } + }, + "EphemeralStorage": { + "type": "object", + "description": "Definition of EphemeralStorage", + "properties": { + "size": { + "type": "integer", + "format": "int32", + "description": "The size of the function's ``/tmp`` directory." + } + } + }, + "FileSystemConfig": { + "type": "object", + "description": "Definition of FileSystemConfig", + "properties": { + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system." + }, + "localMountPath": { + "type": "string", + "description": "The path where the function can access the file system, starting with ``/mnt/``." + } + } + }, + "ImageConfig": { + "type": "object", + "description": "Definition of ImageConfig", + "properties": { + "command": { + "type": "array", + "description": "Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "entryPoint": { + "type": "array", + "description": "Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "workingDirectory": { + "type": "string", + "description": "Specifies the working directory. The length of the directory string cannot exceed 1,000 characters." + } + } + }, + "LambdaFunction": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LambdaFunctionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LambdaFunctionListResult": { + "type": "object", + "description": "The response of a LambdaFunction list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LambdaFunction items on this page", + "items": { + "$ref": "#/definitions/LambdaFunction" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LambdaFunctionProperties": { + "type": "object", + "description": "Definition of LambdaFunction", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLambdaFunctionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LambdaFunctionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LambdaFunction resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "LoggingConfig": { + "type": "object", + "description": "Definition of LoggingConfig", + "properties": { + "applicationLogLevel": { + "$ref": "#/definitions/LoggingConfigApplicationLogLevel", + "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest." + }, + "logFormat": { + "$ref": "#/definitions/LoggingConfigLogFormat", + "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON." + }, + "logGroup": { + "type": "string", + "description": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/<function name>``. To use a different log group, enter an existing log group or enter a new log group name." + }, + "systemLogLevel": { + "$ref": "#/definitions/LoggingConfigSystemLogLevel", + "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest." + } + } + }, + "LoggingConfigApplicationLogLevel": { + "type": "string", + "description": "LoggingConfigApplicationLogLevel enum", + "enum": [ + "DEBUG", + "ERROR", + "FATAL", + "INFO", + "TRACE", + "WARN" + ], + "x-ms-enum": { + "name": "LoggingConfigApplicationLogLevel", + "modelAsString": true, + "values": [ + { + "name": "DEBUG", + "value": "DEBUG", + "description": "LoggingConfigApplicationLogLevel enum DEBUG" + }, + { + "name": "ERROR", + "value": "ERROR", + "description": "LoggingConfigApplicationLogLevel enum ERROR" + }, + { + "name": "FATAL", + "value": "FATAL", + "description": "LoggingConfigApplicationLogLevel enum FATAL" + }, + { + "name": "INFO", + "value": "INFO", + "description": "LoggingConfigApplicationLogLevel enum INFO" + }, + { + "name": "TRACE", + "value": "TRACE", + "description": "LoggingConfigApplicationLogLevel enum TRACE" + }, + { + "name": "WARN", + "value": "WARN", + "description": "LoggingConfigApplicationLogLevel enum WARN" + } + ] + } + }, + "LoggingConfigLogFormat": { + "type": "string", + "description": "LoggingConfigLogFormat enum", + "enum": [ + "JSON", + "Text" + ], + "x-ms-enum": { + "name": "LoggingConfigLogFormat", + "modelAsString": true, + "values": [ + { + "name": "JSON", + "value": "JSON", + "description": "LoggingConfigLogFormat enum JSON" + }, + { + "name": "Text", + "value": "Text", + "description": "LoggingConfigLogFormat enum Text" + } + ] + } + }, + "LoggingConfigSystemLogLevel": { + "type": "string", + "description": "LoggingConfigSystemLogLevel enum", + "enum": [ + "DEBUG", + "INFO", + "WARN" + ], + "x-ms-enum": { + "name": "LoggingConfigSystemLogLevel", + "modelAsString": true, + "values": [ + { + "name": "DEBUG", + "value": "DEBUG", + "description": "LoggingConfigSystemLogLevel enum DEBUG" + }, + { + "name": "INFO", + "value": "INFO", + "description": "LoggingConfigSystemLogLevel enum INFO" + }, + { + "name": "WARN", + "value": "WARN", + "description": "LoggingConfigSystemLogLevel enum WARN" + } + ] + } + }, + "PackageType": { + "type": "string", + "description": "PackageType enum", + "enum": [ + "Image", + "Zip" + ], + "x-ms-enum": { + "name": "PackageType", + "modelAsString": true, + "values": [ + { + "name": "Image", + "value": "Image", + "description": "PackageType enum Image" + }, + { + "name": "Zip", + "value": "Zip", + "description": "PackageType enum Zip" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RuntimeManagementConfig": { + "type": "object", + "description": "Definition of RuntimeManagementConfig", + "properties": { + "runtimeVersionArn": { + "type": "string", + "description": "The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode." + }, + "updateRuntimeOn": { + "$ref": "#/definitions/RuntimeManagementConfigUpdateRuntimeOn", + "description": "Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``" + } + } + }, + "RuntimeManagementConfigUpdateRuntimeOn": { + "type": "string", + "description": "RuntimeManagementConfigUpdateRuntimeOn enum", + "enum": [ + "Auto", + "FunctionUpdate", + "Manual" + ], + "x-ms-enum": { + "name": "RuntimeManagementConfigUpdateRuntimeOn", + "modelAsString": true, + "values": [ + { + "name": "Auto", + "value": "Auto", + "description": "RuntimeManagementConfigUpdateRuntimeOn enum Auto" + }, + { + "name": "FunctionUpdate", + "value": "FunctionUpdate", + "description": "RuntimeManagementConfigUpdateRuntimeOn enum FunctionUpdate" + }, + { + "name": "Manual", + "value": "Manual", + "description": "RuntimeManagementConfigUpdateRuntimeOn enum Manual" + } + ] + } + }, + "SnapStart": { + "type": "object", + "description": "Definition of SnapStart", + "properties": { + "applyOn": { + "$ref": "#/definitions/SnapStartApplyOn", + "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version." + } + } + }, + "SnapStartApplyOn": { + "type": "string", + "description": "SnapStartApplyOn enum", + "enum": [ + "None", + "PublishedVersions" + ], + "x-ms-enum": { + "name": "SnapStartApplyOn", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "SnapStartApplyOn enum None" + }, + { + "name": "PublishedVersions", + "value": "PublishedVersions", + "description": "SnapStartApplyOn enum PublishedVersions" + } + ] + } + }, + "SnapStartResponse": { + "type": "object", + "description": "Definition of SnapStartResponse", + "properties": { + "applyOn": { + "$ref": "#/definitions/SnapStartResponseApplyOn", + "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version." + }, + "optimizationStatus": { + "$ref": "#/definitions/SnapStartResponseOptimizationStatus", + "description": "When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version." + } + } + }, + "SnapStartResponseApplyOn": { + "type": "string", + "description": "SnapStartResponseApplyOn enum", + "enum": [ + "None", + "PublishedVersions" + ], + "x-ms-enum": { + "name": "SnapStartResponseApplyOn", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "SnapStartResponseApplyOn enum None" + }, + { + "name": "PublishedVersions", + "value": "PublishedVersions", + "description": "SnapStartResponseApplyOn enum PublishedVersions" + } + ] + } + }, + "SnapStartResponseOptimizationStatus": { + "type": "string", + "description": "SnapStartResponseOptimizationStatus enum", + "enum": [ + "Off", + "On" + ], + "x-ms-enum": { + "name": "SnapStartResponseOptimizationStatus", + "modelAsString": true, + "values": [ + { + "name": "Off", + "value": "Off", + "description": "SnapStartResponseOptimizationStatus enum Off" + }, + { + "name": "On", + "value": "On", + "description": "SnapStartResponseOptimizationStatus enum On" + } + ] + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "TracingConfig": { + "type": "object", + "description": "Definition of TracingConfig", + "properties": { + "mode": { + "$ref": "#/definitions/TracingConfigMode", + "description": "The tracing mode." + } + } + }, + "TracingConfigMode": { + "type": "string", + "description": "TracingConfigMode enum", + "enum": [ + "Active", + "PassThrough" + ], + "x-ms-enum": { + "name": "TracingConfigMode", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "TracingConfigMode enum Active" + }, + { + "name": "PassThrough", + "value": "PassThrough", + "description": "TracingConfigMode enum PassThrough" + } + ] + } + }, + "VpcConfig": { + "type": "object", + "description": "Definition of VpcConfig", + "properties": { + "ipv6AllowedForDualStack": { + "type": "boolean", + "description": "Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets." + }, + "securityGroupIds": { + "type": "array", + "description": "A list of VPC security group IDs.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnetIds": { + "type": "array", + "description": "A list of VPC subnet IDs.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunctionCodeLocation.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunctionCodeLocation.json new file mode 100644 index 000000000000..ee1897c8a0b1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lambdaFunctionCodeLocation.json @@ -0,0 +1,558 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LambdaFunctionCodeLocations" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/lambdaFunctionCodeLocations": { + "get": { + "operationId": "LambdaFunctionCodeLocations_ListBySubscription", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "List LambdaFunctionCodeLocation resources 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/LambdaFunctionCodeLocationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctionCodeLocations_ListBySubscription": { + "$ref": "./examples/LambdaFunctionCodeLocations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lambdaFunctionCodeLocations": { + "get": { + "operationId": "LambdaFunctionCodeLocations_ListByResourceGroup", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "List LambdaFunctionCodeLocation resources 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/LambdaFunctionCodeLocationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctionCodeLocations_ListByResourceGroup": { + "$ref": "./examples/LambdaFunctionCodeLocations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lambdaFunctionCodeLocations/{name}": { + "get": { + "operationId": "LambdaFunctionCodeLocations_Get", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "Get a LambdaFunctionCodeLocation", + "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": "name", + "in": "path", + "description": "Name of LambdaFunctionCodeLocation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctionCodeLocations_Get": { + "$ref": "./examples/LambdaFunctionCodeLocations_Get.json" + } + } + }, + "put": { + "operationId": "LambdaFunctionCodeLocations_CreateOrReplace", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "Create a LambdaFunctionCodeLocation. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LambdaFunctionCodeLocation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LambdaFunctionCodeLocation' update operation succeeded", + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + } + }, + "201": { + "description": "Resource 'LambdaFunctionCodeLocation' create operation succeeded", + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LambdaFunctionCodeLocations_CreateOrReplace": { + "$ref": "./examples/LambdaFunctionCodeLocations_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LambdaFunctionCodeLocations_Update", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "Update a LambdaFunctionCodeLocation", + "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": "name", + "in": "path", + "description": "Name of LambdaFunctionCodeLocation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocationTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LambdaFunctionCodeLocations_Update": { + "$ref": "./examples/LambdaFunctionCodeLocations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LambdaFunctionCodeLocations_Delete", + "tags": [ + "LambdaFunctionCodeLocations" + ], + "description": "Delete a LambdaFunctionCodeLocation", + "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": "name", + "in": "path", + "description": "Name of LambdaFunctionCodeLocation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LambdaFunctionCodeLocations_Delete": { + "$ref": "./examples/LambdaFunctionCodeLocations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsLambdaFunctionCodeLocationProperties": { + "type": "object", + "description": "Definition of awsLambdaFunctionCodeLocation", + "properties": { + "imageUri": { + "type": "string", + "description": "<p>URI of a container image in the Amazon ECR registry.</p>" + }, + "location": { + "type": "string", + "description": "<p>A presigned URL that you can use to download the deployment package.</p>" + }, + "repositoryType": { + "type": "string", + "description": "<p>The service that's hosting the file.</p>" + }, + "resolvedImageUri": { + "type": "string", + "description": "<p>The resolved URI for the image.</p>" + } + } + }, + "LambdaFunctionCodeLocation": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LambdaFunctionCodeLocationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LambdaFunctionCodeLocationListResult": { + "type": "object", + "description": "The response of a LambdaFunctionCodeLocation list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LambdaFunctionCodeLocation items on this page", + "items": { + "$ref": "#/definitions/LambdaFunctionCodeLocation" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LambdaFunctionCodeLocationProperties": { + "type": "object", + "description": "Definition of LambdaFunctionCodeLocation", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLambdaFunctionCodeLocationProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LambdaFunctionCodeLocationTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LambdaFunctionCodeLocation resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailBucket.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailBucket.json new file mode 100644 index 000000000000..3dba81fbf6bd --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailBucket.json @@ -0,0 +1,622 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LightsailBuckets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/lightsailBuckets": { + "get": { + "operationId": "LightsailBuckets_ListBySubscription", + "tags": [ + "LightsailBuckets" + ], + "description": "List LightsailBucket resources 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/LightsailBucketListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailBuckets_ListBySubscription": { + "$ref": "./examples/LightsailBuckets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lightsailBuckets": { + "get": { + "operationId": "LightsailBuckets_ListByResourceGroup", + "tags": [ + "LightsailBuckets" + ], + "description": "List LightsailBucket resources 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/LightsailBucketListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailBuckets_ListByResourceGroup": { + "$ref": "./examples/LightsailBuckets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lightsailBuckets/{name}": { + "get": { + "operationId": "LightsailBuckets_Get", + "tags": [ + "LightsailBuckets" + ], + "description": "Get a LightsailBucket", + "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": "name", + "in": "path", + "description": "Name of LightsailBucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LightsailBucket" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailBuckets_Get": { + "$ref": "./examples/LightsailBuckets_Get.json" + } + } + }, + "put": { + "operationId": "LightsailBuckets_CreateOrReplace", + "tags": [ + "LightsailBuckets" + ], + "description": "Create a LightsailBucket. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LightsailBucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LightsailBucket" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LightsailBucket' update operation succeeded", + "schema": { + "$ref": "#/definitions/LightsailBucket" + } + }, + "201": { + "description": "Resource 'LightsailBucket' create operation succeeded", + "schema": { + "$ref": "#/definitions/LightsailBucket" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LightsailBuckets_CreateOrReplace": { + "$ref": "./examples/LightsailBuckets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LightsailBuckets_Update", + "tags": [ + "LightsailBuckets" + ], + "description": "Update a LightsailBucket", + "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": "name", + "in": "path", + "description": "Name of LightsailBucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LightsailBucketTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LightsailBucket" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailBuckets_Update": { + "$ref": "./examples/LightsailBuckets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LightsailBuckets_Delete", + "tags": [ + "LightsailBuckets" + ], + "description": "Delete a LightsailBucket", + "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": "name", + "in": "path", + "description": "Name of LightsailBucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LightsailBuckets_Delete": { + "$ref": "./examples/LightsailBuckets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AccessRules": { + "type": "object", + "description": "Definition of AccessRules", + "properties": { + "allowPublicOverrides": { + "type": "boolean", + "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified." + }, + "getObject": { + "type": "string", + "description": "Specifies the anonymous access to all objects in a bucket." + } + } + }, + "AwsLightsailBucketProperties": { + "type": "object", + "description": "Definition of awsLightsailBucket", + "properties": { + "ableToUpdateBundle": { + "type": "boolean", + "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle." + }, + "accessRules": { + "$ref": "#/definitions/AccessRules", + "description": "An object that sets the public accessibility of objects in the specified bucket." + }, + "bucketArn": { + "type": "string", + "description": "Property bucketArn" + }, + "bucketName": { + "type": "string", + "description": "The name for the bucket." + }, + "bundleId": { + "type": "string", + "description": "The ID of the bundle to use for the bucket." + }, + "objectVersioning": { + "type": "boolean", + "description": "Specifies whether to enable or disable versioning of objects in the bucket." + }, + "readOnlyAccessAccounts": { + "type": "array", + "description": "An array of strings to specify the AWS account IDs that can access the bucket.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "resourcesReceivingAccess": { + "type": "array", + "description": "The names of the Lightsail resources for which to set bucket access.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "url": { + "type": "string", + "description": "The URL of the bucket." + } + } + }, + "LightsailBucket": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LightsailBucketProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LightsailBucketListResult": { + "type": "object", + "description": "The response of a LightsailBucket list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LightsailBucket items on this page", + "items": { + "$ref": "#/definitions/LightsailBucket" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LightsailBucketProperties": { + "type": "object", + "description": "Definition of LightsailBucket", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLightsailBucketProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LightsailBucketTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LightsailBucket resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailInstance.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailInstance.json new file mode 100644 index 000000000000..e753283ec1ab --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/lightsailInstance.json @@ -0,0 +1,902 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LightsailInstances" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/lightsailInstances": { + "get": { + "operationId": "LightsailInstances_ListBySubscription", + "tags": [ + "LightsailInstances" + ], + "description": "List LightsailInstance resources 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/LightsailInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailInstances_ListBySubscription": { + "$ref": "./examples/LightsailInstances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lightsailInstances": { + "get": { + "operationId": "LightsailInstances_ListByResourceGroup", + "tags": [ + "LightsailInstances" + ], + "description": "List LightsailInstance resources 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/LightsailInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailInstances_ListByResourceGroup": { + "$ref": "./examples/LightsailInstances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/lightsailInstances/{name}": { + "get": { + "operationId": "LightsailInstances_Get", + "tags": [ + "LightsailInstances" + ], + "description": "Get a LightsailInstance", + "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": "name", + "in": "path", + "description": "Name of LightsailInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LightsailInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailInstances_Get": { + "$ref": "./examples/LightsailInstances_Get.json" + } + } + }, + "put": { + "operationId": "LightsailInstances_CreateOrReplace", + "tags": [ + "LightsailInstances" + ], + "description": "Create a LightsailInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LightsailInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LightsailInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LightsailInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/LightsailInstance" + } + }, + "201": { + "description": "Resource 'LightsailInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/LightsailInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LightsailInstances_CreateOrReplace": { + "$ref": "./examples/LightsailInstances_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LightsailInstances_Update", + "tags": [ + "LightsailInstances" + ], + "description": "Update a LightsailInstance", + "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": "name", + "in": "path", + "description": "Name of LightsailInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LightsailInstanceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LightsailInstance" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LightsailInstances_Update": { + "$ref": "./examples/LightsailInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LightsailInstances_Delete", + "tags": [ + "LightsailInstances" + ], + "description": "Delete a LightsailInstance", + "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": "name", + "in": "path", + "description": "Name of LightsailInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LightsailInstances_Delete": { + "$ref": "./examples/LightsailInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AddOn": { + "type": "object", + "description": "Definition of AddOn", + "properties": { + "addOnType": { + "type": "string", + "description": "The add-on type" + }, + "autoSnapshotAddOnRequest": { + "$ref": "#/definitions/AutoSnapshotAddOn", + "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on" + }, + "status": { + "$ref": "#/definitions/AddOnStatus", + "description": "Status of the Addon" + } + } + }, + "AddOnStatus": { + "type": "string", + "description": "AddOnStatus enum", + "enum": [ + "Disabled", + "Disabling", + "Enabled", + "Enabling", + "Failed", + "Terminated", + "Terminating" + ], + "x-ms-enum": { + "name": "AddOnStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "AddOnStatus enum Disabled" + }, + { + "name": "Disabling", + "value": "Disabling", + "description": "AddOnStatus enum Disabling" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "AddOnStatus enum Enabled" + }, + { + "name": "Enabling", + "value": "Enabling", + "description": "AddOnStatus enum Enabling" + }, + { + "name": "Failed", + "value": "Failed", + "description": "AddOnStatus enum Failed" + }, + { + "name": "Terminated", + "value": "Terminated", + "description": "AddOnStatus enum Terminated" + }, + { + "name": "Terminating", + "value": "Terminating", + "description": "AddOnStatus enum Terminating" + } + ] + } + }, + "AutoSnapshotAddOn": { + "type": "object", + "description": "Definition of AutoSnapshotAddOn", + "properties": { + "snapshotTimeOfDay": { + "type": "string", + "description": "The daily time when an automatic snapshot will be created." + } + } + }, + "AwsLightsailInstanceProperties": { + "type": "object", + "description": "Definition of awsLightsailInstance", + "properties": { + "addOns": { + "type": "array", + "description": "An array of objects representing the add-ons to enable for the new instance.", + "items": { + "$ref": "#/definitions/AddOn" + }, + "x-ms-identifiers": [] + }, + "availabilityZone": { + "type": "string", + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "blueprintId": { + "type": "string", + "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints )." + }, + "bundleId": { + "type": "string", + "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 )." + }, + "hardware": { + "$ref": "#/definitions/Hardware", + "description": "Hardware of the Instance." + }, + "instanceArn": { + "type": "string", + "description": "Property instanceArn" + }, + "instanceName": { + "type": "string", + "description": "The names to use for your new Lightsail instance." + }, + "isStaticIp": { + "type": "boolean", + "description": "Is the IP Address of the Instance is the static IP" + }, + "keyPairName": { + "type": "string", + "description": "The name of your key pair." + }, + "location": { + "$ref": "#/definitions/Location", + "description": "Location of a resource." + }, + "networking": { + "$ref": "#/definitions/Networking", + "description": "Networking of the Instance." + }, + "privateIpAddress": { + "type": "string", + "description": "Private IP Address of the Instance" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP Address of the Instance" + }, + "resourceType": { + "type": "string", + "description": "Resource type of Lightsail instance." + }, + "sshKeyName": { + "type": "string", + "description": "SSH Key Name of the Lightsail instance." + }, + "state": { + "$ref": "#/definitions/State", + "description": "Current State of the Instance." + }, + "supportCode": { + "type": "string", + "description": "Support code to help identify any issues" + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "userData": { + "type": "string", + "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update." + }, + "userName": { + "type": "string", + "description": "Username of the Lightsail instance." + } + } + }, + "Disk": { + "type": "object", + "description": "Definition of Disk", + "properties": { + "attachedTo": { + "type": "string", + "description": "Instance attached to the disk." + }, + "attachmentState": { + "type": "string", + "description": "Attachment state of the disk." + }, + "diskName": { + "type": "string", + "description": "The names to use for your new Lightsail disk." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "IOPS of disk." + }, + "isSystemDisk": { + "type": "boolean", + "description": "Is the Attached disk is the system disk of the Instance." + }, + "path": { + "type": "string", + "description": "Path of the disk attached to the instance." + }, + "sizeInGb": { + "type": "string", + "description": "Size of the disk attached to the Instance." + } + } + }, + "Hardware": { + "type": "object", + "description": "Definition of Hardware", + "properties": { + "cpuCount": { + "type": "integer", + "format": "int32", + "description": "CPU count of the Instance." + }, + "disks": { + "type": "array", + "description": "Disks attached to the Instance.", + "items": { + "$ref": "#/definitions/Disk" + }, + "x-ms-identifiers": [] + }, + "ramSizeInGb": { + "type": "integer", + "format": "int32", + "description": "RAM Size of the Instance." + } + } + }, + "LightsailInstance": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LightsailInstanceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LightsailInstanceListResult": { + "type": "object", + "description": "The response of a LightsailInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LightsailInstance items on this page", + "items": { + "$ref": "#/definitions/LightsailInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LightsailInstanceProperties": { + "type": "object", + "description": "Definition of LightsailInstance", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLightsailInstanceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LightsailInstanceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LightsailInstance resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Location": { + "type": "object", + "description": "Definition of Location", + "properties": { + "availabilityZone": { + "type": "string", + "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." + }, + "regionName": { + "type": "string", + "description": "The Region Name in which to create your instance." + } + } + }, + "MonthlyTransfer": { + "type": "object", + "description": "Definition of MonthlyTransfer", + "properties": { + "gbPerMonthAllocated": { + "type": "string", + "description": "GbPerMonthAllocated of the Instance." + } + } + }, + "Networking": { + "type": "object", + "description": "Definition of Networking", + "properties": { + "monthlyTransfer": { + "$ref": "#/definitions/MonthlyTransfer", + "description": "Monthly Transfer of the Instance." + }, + "ports": { + "type": "array", + "description": "Ports to the Instance.", + "items": { + "$ref": "#/definitions/Port" + }, + "x-ms-identifiers": [] + } + } + }, + "Port": { + "type": "object", + "description": "Definition of Port", + "properties": { + "accessDirection": { + "type": "string", + "description": "Access Direction for Protocol of the Instance(inbound/outbound)." + }, + "accessFrom": { + "type": "string", + "description": "Access From Protocol of the Instance." + }, + "accessType": { + "type": "string", + "description": "Access Type Protocol of the Instance." + }, + "cidrListAliases": { + "type": "array", + "description": "cidr List Aliases", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "cidrs": { + "type": "array", + "description": "Property cidrs", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "commonName": { + "type": "string", + "description": "CommonName for Protocol of the Instance." + }, + "fromPort": { + "type": "integer", + "format": "int32", + "description": "From Port of the Instance." + }, + "ipv6Cidrs": { + "type": "array", + "description": "IPv6 Cidrs", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "protocol": { + "type": "string", + "description": "Port Protocol of the Instance." + }, + "toPort": { + "type": "integer", + "format": "int32", + "description": "To Port of the Instance." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "State": { + "type": "object", + "description": "Definition of State", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "description": "Status code of the Instance." + }, + "name": { + "type": "string", + "description": "Status code of the Instance." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogGroup.json new file mode 100644 index 000000000000..f84acce82b64 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogGroup.json @@ -0,0 +1,633 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LogsLogGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/logsLogGroups": { + "get": { + "operationId": "LogsLogGroups_ListBySubscription", + "tags": [ + "LogsLogGroups" + ], + "description": "List LogsLogGroup resources 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/LogsLogGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogGroups_ListBySubscription": { + "$ref": "./examples/LogsLogGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsLogGroups": { + "get": { + "operationId": "LogsLogGroups_ListByResourceGroup", + "tags": [ + "LogsLogGroups" + ], + "description": "List LogsLogGroup resources 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/LogsLogGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogGroups_ListByResourceGroup": { + "$ref": "./examples/LogsLogGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsLogGroups/{name}": { + "get": { + "operationId": "LogsLogGroups_Get", + "tags": [ + "LogsLogGroups" + ], + "description": "Get a LogsLogGroup", + "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": "name", + "in": "path", + "description": "Name of LogsLogGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsLogGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogGroups_Get": { + "$ref": "./examples/LogsLogGroups_Get.json" + } + } + }, + "put": { + "operationId": "LogsLogGroups_CreateOrReplace", + "tags": [ + "LogsLogGroups" + ], + "description": "Create a LogsLogGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LogsLogGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsLogGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogsLogGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogsLogGroup" + } + }, + "201": { + "description": "Resource 'LogsLogGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogsLogGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LogsLogGroups_CreateOrReplace": { + "$ref": "./examples/LogsLogGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogsLogGroups_Update", + "tags": [ + "LogsLogGroups" + ], + "description": "Update a LogsLogGroup", + "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": "name", + "in": "path", + "description": "Name of LogsLogGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsLogGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsLogGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogGroups_Update": { + "$ref": "./examples/LogsLogGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogsLogGroups_Delete", + "tags": [ + "LogsLogGroups" + ], + "description": "Delete a LogsLogGroup", + "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": "name", + "in": "path", + "description": "Name of LogsLogGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LogsLogGroups_Delete": { + "$ref": "./examples/LogsLogGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsLogsLogGroupProperties": { + "type": "object", + "description": "Definition of awsLogsLogGroup", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "dataProtectionPolicy": { + "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)." + }, + "kmsKeyId": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)" + }, + "logGroupClass": { + "type": "string", + "description": "Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", + "default": "STANDARD", + "enum": [ + "INFREQUENT_ACCESS", + "STANDARD" + ], + "x-ms-enum": { + "name": "LogGroupClass", + "modelAsString": true, + "values": [ + { + "name": "INFREQUENT_ACCESS", + "value": "INFREQUENT_ACCESS", + "description": "LogGroupClass enum INFREQUENT_ACCESS" + }, + { + "name": "STANDARD", + "value": "STANDARD", + "description": "LogGroupClass enum STANDARD" + } + ] + } + }, + "logGroupName": { + "type": "string", + "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group." + }, + "retentionInDays": { + "type": "integer", + "format": "int32", + "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)." + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to the log group. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "LogGroupClass": { + "type": "string", + "description": "LogGroupClass enum", + "enum": [ + "INFREQUENT_ACCESS", + "STANDARD" + ], + "x-ms-enum": { + "name": "LogGroupClass", + "modelAsString": true, + "values": [ + { + "name": "INFREQUENT_ACCESS", + "value": "INFREQUENT_ACCESS", + "description": "LogGroupClass enum INFREQUENT_ACCESS" + }, + { + "name": "STANDARD", + "value": "STANDARD", + "description": "LogGroupClass enum STANDARD" + } + ] + } + }, + "LogsLogGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogsLogGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LogsLogGroupListResult": { + "type": "object", + "description": "The response of a LogsLogGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogsLogGroup items on this page", + "items": { + "$ref": "#/definitions/LogsLogGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogsLogGroupProperties": { + "type": "object", + "description": "Definition of LogsLogGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLogsLogGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LogsLogGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LogsLogGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogStream.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogStream.json new file mode 100644 index 000000000000..8b5e58ef93b1 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsLogStream.json @@ -0,0 +1,550 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LogsLogStreams" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/logsLogStreams": { + "get": { + "operationId": "LogsLogStreams_ListBySubscription", + "tags": [ + "LogsLogStreams" + ], + "description": "List LogsLogStream resources 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/LogsLogStreamListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogStreams_ListBySubscription": { + "$ref": "./examples/LogsLogStreams_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsLogStreams": { + "get": { + "operationId": "LogsLogStreams_ListByResourceGroup", + "tags": [ + "LogsLogStreams" + ], + "description": "List LogsLogStream resources 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/LogsLogStreamListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogStreams_ListByResourceGroup": { + "$ref": "./examples/LogsLogStreams_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsLogStreams/{name}": { + "get": { + "operationId": "LogsLogStreams_Get", + "tags": [ + "LogsLogStreams" + ], + "description": "Get a LogsLogStream", + "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": "name", + "in": "path", + "description": "Name of LogsLogStream", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsLogStream" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogStreams_Get": { + "$ref": "./examples/LogsLogStreams_Get.json" + } + } + }, + "put": { + "operationId": "LogsLogStreams_CreateOrReplace", + "tags": [ + "LogsLogStreams" + ], + "description": "Create a LogsLogStream. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LogsLogStream", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsLogStream" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogsLogStream' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogsLogStream" + } + }, + "201": { + "description": "Resource 'LogsLogStream' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogsLogStream" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LogsLogStreams_CreateOrReplace": { + "$ref": "./examples/LogsLogStreams_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogsLogStreams_Update", + "tags": [ + "LogsLogStreams" + ], + "description": "Update a LogsLogStream", + "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": "name", + "in": "path", + "description": "Name of LogsLogStream", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsLogStreamTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsLogStream" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsLogStreams_Update": { + "$ref": "./examples/LogsLogStreams_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogsLogStreams_Delete", + "tags": [ + "LogsLogStreams" + ], + "description": "Delete a LogsLogStream", + "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": "name", + "in": "path", + "description": "Name of LogsLogStream", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LogsLogStreams_Delete": { + "$ref": "./examples/LogsLogStreams_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsLogsLogStreamProperties": { + "type": "object", + "description": "Definition of awsLogsLogStream", + "properties": { + "logGroupName": { + "type": "string", + "description": "The name of the log group where the log stream is created." + }, + "logStreamName": { + "type": "string", + "description": "The name of the log stream. The name must be unique wihtin the log group." + } + } + }, + "LogsLogStream": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogsLogStreamProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LogsLogStreamListResult": { + "type": "object", + "description": "The response of a LogsLogStream list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogsLogStream items on this page", + "items": { + "$ref": "#/definitions/LogsLogStream" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogsLogStreamProperties": { + "type": "object", + "description": "Definition of LogsLogStream", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLogsLogStreamProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LogsLogStreamTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LogsLogStream resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsMetricFilter.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsMetricFilter.json new file mode 100644 index 000000000000..6a301df395eb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsMetricFilter.json @@ -0,0 +1,785 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LogsMetricFilters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/logsMetricFilters": { + "get": { + "operationId": "LogsMetricFilters_ListBySubscription", + "tags": [ + "LogsMetricFilters" + ], + "description": "List LogsMetricFilter resources 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/LogsMetricFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsMetricFilters_ListBySubscription": { + "$ref": "./examples/LogsMetricFilters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsMetricFilters": { + "get": { + "operationId": "LogsMetricFilters_ListByResourceGroup", + "tags": [ + "LogsMetricFilters" + ], + "description": "List LogsMetricFilter resources 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/LogsMetricFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsMetricFilters_ListByResourceGroup": { + "$ref": "./examples/LogsMetricFilters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsMetricFilters/{name}": { + "get": { + "operationId": "LogsMetricFilters_Get", + "tags": [ + "LogsMetricFilters" + ], + "description": "Get a LogsMetricFilter", + "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": "name", + "in": "path", + "description": "Name of LogsMetricFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsMetricFilter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsMetricFilters_Get": { + "$ref": "./examples/LogsMetricFilters_Get.json" + } + } + }, + "put": { + "operationId": "LogsMetricFilters_CreateOrReplace", + "tags": [ + "LogsMetricFilters" + ], + "description": "Create a LogsMetricFilter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LogsMetricFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsMetricFilter" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogsMetricFilter' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogsMetricFilter" + } + }, + "201": { + "description": "Resource 'LogsMetricFilter' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogsMetricFilter" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LogsMetricFilters_CreateOrReplace": { + "$ref": "./examples/LogsMetricFilters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogsMetricFilters_Update", + "tags": [ + "LogsMetricFilters" + ], + "description": "Update a LogsMetricFilter", + "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": "name", + "in": "path", + "description": "Name of LogsMetricFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsMetricFilterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsMetricFilter" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsMetricFilters_Update": { + "$ref": "./examples/LogsMetricFilters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogsMetricFilters_Delete", + "tags": [ + "LogsMetricFilters" + ], + "description": "Delete a LogsMetricFilter", + "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": "name", + "in": "path", + "description": "Name of LogsMetricFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LogsMetricFilters_Delete": { + "$ref": "./examples/LogsMetricFilters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsLogsMetricFilterProperties": { + "type": "object", + "description": "Definition of awsLogsMetricFilter", + "properties": { + "filterName": { + "type": "string", + "description": "The name of the metric filter." + }, + "filterPattern": { + "type": "string", + "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." + }, + "logGroupName": { + "type": "string", + "description": "The name of an existing log group that you want to associate with this metric filter." + }, + "metricTransformations": { + "type": "array", + "description": "The metric transformations.", + "items": { + "$ref": "#/definitions/MetricTransformation" + }, + "x-ms-identifiers": [] + } + } + }, + "Dimension": { + "type": "object", + "description": "Definition of Dimension", + "properties": { + "key": { + "type": "string", + "description": "The name for the CW metric dimension that the metric filter creates. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:)." + }, + "value": { + "type": "string", + "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events." + } + } + }, + "LogsMetricFilter": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogsMetricFilterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LogsMetricFilterListResult": { + "type": "object", + "description": "The response of a LogsMetricFilter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogsMetricFilter items on this page", + "items": { + "$ref": "#/definitions/LogsMetricFilter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogsMetricFilterProperties": { + "type": "object", + "description": "Definition of LogsMetricFilter", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLogsMetricFilterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LogsMetricFilterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LogsMetricFilter resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MetricTransformation": { + "type": "object", + "description": "Definition of MetricTransformation", + "properties": { + "defaultValue": { + "type": "integer", + "format": "int32", + "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null." + }, + "dimensions": { + "type": "array", + "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html).", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [] + }, + "metricName": { + "type": "string", + "description": "The name of the CloudWatch metric." + }, + "metricNamespace": { + "type": "string", + "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)." + }, + "metricValue": { + "type": "string", + "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``." + }, + "unit": { + "$ref": "#/definitions/MetricTransformationUnit", + "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``." + } + } + }, + "MetricTransformationUnit": { + "type": "string", + "description": "MetricTransformationUnit enum", + "enum": [ + "Bits", + "Bits/Second", + "Bytes", + "Bytes/Second", + "Count", + "Count/Second", + "Gigabits", + "Gigabits/Second", + "Gigabytes", + "Gigabytes/Second", + "Kilobits", + "Kilobits/Second", + "Kilobytes", + "Kilobytes/Second", + "Megabits", + "Megabits/Second", + "Megabytes", + "Megabytes/Second", + "Microseconds", + "Milliseconds", + "None", + "Percent", + "Seconds", + "Terabits", + "Terabits/Second", + "Terabytes", + "Terabytes/Second" + ], + "x-ms-enum": { + "name": "MetricTransformationUnit", + "modelAsString": true, + "values": [ + { + "name": "Bits", + "value": "Bits", + "description": "MetricTransformationUnit enum Bits" + }, + { + "name": "BitsSecond", + "value": "Bits/Second", + "description": "MetricTransformationUnit enum Bits/Second" + }, + { + "name": "Bytes", + "value": "Bytes", + "description": "MetricTransformationUnit enum Bytes" + }, + { + "name": "BytesSecond", + "value": "Bytes/Second", + "description": "MetricTransformationUnit enum Bytes/Second" + }, + { + "name": "Count", + "value": "Count", + "description": "MetricTransformationUnit enum Count" + }, + { + "name": "CountSecond", + "value": "Count/Second", + "description": "MetricTransformationUnit enum Count/Second" + }, + { + "name": "Gigabits", + "value": "Gigabits", + "description": "MetricTransformationUnit enum Gigabits" + }, + { + "name": "GigabitsSecond", + "value": "Gigabits/Second", + "description": "MetricTransformationUnit enum Gigabits/Second" + }, + { + "name": "Gigabytes", + "value": "Gigabytes", + "description": "MetricTransformationUnit enum Gigabytes" + }, + { + "name": "GigabytesSecond", + "value": "Gigabytes/Second", + "description": "MetricTransformationUnit enum Gigabytes/Second" + }, + { + "name": "Kilobits", + "value": "Kilobits", + "description": "MetricTransformationUnit enum Kilobits" + }, + { + "name": "KilobitsSecond", + "value": "Kilobits/Second", + "description": "MetricTransformationUnit enum Kilobits/Second" + }, + { + "name": "Kilobytes", + "value": "Kilobytes", + "description": "MetricTransformationUnit enum Kilobytes" + }, + { + "name": "KilobytesSecond", + "value": "Kilobytes/Second", + "description": "MetricTransformationUnit enum Kilobytes/Second" + }, + { + "name": "Megabits", + "value": "Megabits", + "description": "MetricTransformationUnit enum Megabits" + }, + { + "name": "MegabitsSecond", + "value": "Megabits/Second", + "description": "MetricTransformationUnit enum Megabits/Second" + }, + { + "name": "Megabytes", + "value": "Megabytes", + "description": "MetricTransformationUnit enum Megabytes" + }, + { + "name": "MegabytesSecond", + "value": "Megabytes/Second", + "description": "MetricTransformationUnit enum Megabytes/Second" + }, + { + "name": "Microseconds", + "value": "Microseconds", + "description": "MetricTransformationUnit enum Microseconds" + }, + { + "name": "Milliseconds", + "value": "Milliseconds", + "description": "MetricTransformationUnit enum Milliseconds" + }, + { + "name": "None", + "value": "None", + "description": "MetricTransformationUnit enum None" + }, + { + "name": "Percent", + "value": "Percent", + "description": "MetricTransformationUnit enum Percent" + }, + { + "name": "Seconds", + "value": "Seconds", + "description": "MetricTransformationUnit enum Seconds" + }, + { + "name": "Terabits", + "value": "Terabits", + "description": "MetricTransformationUnit enum Terabits" + }, + { + "name": "TerabitsSecond", + "value": "Terabits/Second", + "description": "MetricTransformationUnit enum Terabits/Second" + }, + { + "name": "Terabytes", + "value": "Terabytes", + "description": "MetricTransformationUnit enum Terabytes" + }, + { + "name": "TerabytesSecond", + "value": "Terabytes/Second", + "description": "MetricTransformationUnit enum Terabytes/Second" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsSubscriptionFilter.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsSubscriptionFilter.json new file mode 100644 index 000000000000..0003c799f917 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/logsSubscriptionFilter.json @@ -0,0 +1,590 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "LogsSubscriptionFilters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/logsSubscriptionFilters": { + "get": { + "operationId": "LogsSubscriptionFilters_ListBySubscription", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "List LogsSubscriptionFilter resources 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/LogsSubscriptionFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsSubscriptionFilters_ListBySubscription": { + "$ref": "./examples/LogsSubscriptionFilters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsSubscriptionFilters": { + "get": { + "operationId": "LogsSubscriptionFilters_ListByResourceGroup", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "List LogsSubscriptionFilter resources 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/LogsSubscriptionFilterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsSubscriptionFilters_ListByResourceGroup": { + "$ref": "./examples/LogsSubscriptionFilters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/logsSubscriptionFilters/{name}": { + "get": { + "operationId": "LogsSubscriptionFilters_Get", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "Get a LogsSubscriptionFilter", + "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": "name", + "in": "path", + "description": "Name of LogsSubscriptionFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsSubscriptionFilters_Get": { + "$ref": "./examples/LogsSubscriptionFilters_Get.json" + } + } + }, + "put": { + "operationId": "LogsSubscriptionFilters_CreateOrReplace", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "Create a LogsSubscriptionFilter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of LogsSubscriptionFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilter" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogsSubscriptionFilter' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilter" + } + }, + "201": { + "description": "Resource 'LogsSubscriptionFilter' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilter" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "LogsSubscriptionFilters_CreateOrReplace": { + "$ref": "./examples/LogsSubscriptionFilters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogsSubscriptionFilters_Update", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "Update a LogsSubscriptionFilter", + "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": "name", + "in": "path", + "description": "Name of LogsSubscriptionFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogsSubscriptionFilter" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "LogsSubscriptionFilters_Update": { + "$ref": "./examples/LogsSubscriptionFilters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogsSubscriptionFilters_Delete", + "tags": [ + "LogsSubscriptionFilters" + ], + "description": "Delete a LogsSubscriptionFilter", + "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": "name", + "in": "path", + "description": "Name of LogsSubscriptionFilter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "LogsSubscriptionFilters_Delete": { + "$ref": "./examples/LogsSubscriptionFilters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsLogsSubscriptionFilterProperties": { + "type": "object", + "description": "Definition of awsLogsSubscriptionFilter", + "properties": { + "destinationArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the destination." + }, + "distribution": { + "$ref": "#/definitions/Distribution", + "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream." + }, + "filterName": { + "type": "string", + "description": "The name of the subscription filter." + }, + "filterPattern": { + "type": "string", + "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." + }, + "logGroupName": { + "type": "string", + "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events." + }, + "roleArn": { + "type": "string", + "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery." + } + } + }, + "Distribution": { + "type": "string", + "description": "Distribution enum", + "enum": [ + "ByLogStream", + "Random" + ], + "x-ms-enum": { + "name": "Distribution", + "modelAsString": true, + "values": [ + { + "name": "ByLogStream", + "value": "ByLogStream", + "description": "Distribution enum ByLogStream" + }, + { + "name": "Random", + "value": "Random", + "description": "Distribution enum Random" + } + ] + } + }, + "LogsSubscriptionFilter": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/LogsSubscriptionFilterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "LogsSubscriptionFilterListResult": { + "type": "object", + "description": "The response of a LogsSubscriptionFilter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogsSubscriptionFilter items on this page", + "items": { + "$ref": "#/definitions/LogsSubscriptionFilter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogsSubscriptionFilterProperties": { + "type": "object", + "description": "Definition of LogsSubscriptionFilter", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsLogsSubscriptionFilterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "LogsSubscriptionFilterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in LogsSubscriptionFilter resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macie2JobSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macie2JobSummary.json new file mode 100644 index 000000000000..8957f9472c51 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macie2JobSummary.json @@ -0,0 +1,969 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Macie2JobSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/macie2JobSummaries": { + "get": { + "operationId": "Macie2JobSummaries_ListBySubscription", + "tags": [ + "Macie2JobSummaries" + ], + "description": "List Macie2JobSummary resources 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/Macie2JobSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Macie2JobSummaries_ListBySubscription": { + "$ref": "./examples/Macie2JobSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/macie2JobSummaries": { + "get": { + "operationId": "Macie2JobSummaries_ListByResourceGroup", + "tags": [ + "Macie2JobSummaries" + ], + "description": "List Macie2JobSummary resources 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/Macie2JobSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Macie2JobSummaries_ListByResourceGroup": { + "$ref": "./examples/Macie2JobSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/macie2JobSummaries/{name}": { + "get": { + "operationId": "Macie2JobSummaries_Get", + "tags": [ + "Macie2JobSummaries" + ], + "description": "Get a Macie2JobSummary", + "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": "name", + "in": "path", + "description": "Name of Macie2JobSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Macie2JobSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Macie2JobSummaries_Get": { + "$ref": "./examples/Macie2JobSummaries_Get.json" + } + } + }, + "put": { + "operationId": "Macie2JobSummaries_CreateOrReplace", + "tags": [ + "Macie2JobSummaries" + ], + "description": "Create a Macie2JobSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Macie2JobSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Macie2JobSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Macie2JobSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/Macie2JobSummary" + } + }, + "201": { + "description": "Resource 'Macie2JobSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/Macie2JobSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Macie2JobSummaries_CreateOrReplace": { + "$ref": "./examples/Macie2JobSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Macie2JobSummaries_Update", + "tags": [ + "Macie2JobSummaries" + ], + "description": "Update a Macie2JobSummary", + "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": "name", + "in": "path", + "description": "Name of Macie2JobSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Macie2JobSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Macie2JobSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Macie2JobSummaries_Update": { + "$ref": "./examples/Macie2JobSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Macie2JobSummaries_Delete", + "tags": [ + "Macie2JobSummaries" + ], + "description": "Delete a Macie2JobSummary", + "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": "name", + "in": "path", + "description": "Name of Macie2JobSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Macie2JobSummaries_Delete": { + "$ref": "./examples/Macie2JobSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsMacie2JobSummaryProperties": { + "type": "object", + "description": "Definition of awsMacie2JobSummary", + "properties": { + "bucketCriteria": { + "$ref": "#/definitions/S3BucketCriteriaForJob", + "description": "<p>The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.</p>" + }, + "bucketDefinitions": { + "type": "array", + "description": "<p>An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.</p>", + "items": { + "$ref": "#/definitions/S3BucketDefinitionForJob" + }, + "x-ms-identifiers": [] + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, in UTC and extended ISO 8601 format, when the job was created.</p>" + }, + "jobId": { + "type": "string", + "description": "<p>The unique identifier for the job.</p>" + }, + "jobStatus": { + "$ref": "#/definitions/JobStatusEnumValue", + "description": "<p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.</p></li> <li><p>COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.</p></li> <li><p>IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.</p></li> <li><p>PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.</p></li> <li><p>RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.</p></li> <li><p>USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>" + }, + "jobType": { + "$ref": "#/definitions/JobTypeEnumValue", + "description": "<p>The schedule for running the job. Possible values are:</p> <ul><li><p>ONE_TIME - The job runs only once.</p></li> <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly basis.</p></li></ul>" + }, + "lastRunErrorStatus": { + "$ref": "#/definitions/LastRunErrorStatus", + "description": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.</p>" + }, + "name": { + "type": "string", + "description": "<p>The custom name of the job.</p>" + }, + "userPausedDetails": { + "$ref": "#/definitions/UserPausedDetails", + "description": "<p>If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.</p>" + } + } + }, + "CriteriaBlockForJob": { + "type": "object", + "description": "Definition of CriteriaBlockForJob", + "properties": { + "and": { + "type": "array", + "description": "<p>An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.</p>", + "items": { + "$ref": "#/definitions/CriteriaForJob" + }, + "x-ms-identifiers": [] + } + } + }, + "CriteriaForJob": { + "type": "object", + "description": "Definition of CriteriaForJob", + "properties": { + "simpleCriterion": { + "$ref": "#/definitions/SimpleCriterionForJob", + "description": "<p>A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.</p>" + }, + "tagCriterion": { + "$ref": "#/definitions/TagCriterionForJob", + "description": "<p>A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.</p>" + } + } + }, + "JobComparator": { + "type": "string", + "description": "JobComparator enum", + "enum": [ + "CONTAINS", + "EQ", + "GT", + "GTE", + "LT", + "LTE", + "NE", + "STARTS_WITH" + ], + "x-ms-enum": { + "name": "JobComparator", + "modelAsString": true, + "values": [ + { + "name": "CONTAINS", + "value": "CONTAINS", + "description": "JobComparator enum CONTAINS" + }, + { + "name": "EQ", + "value": "EQ", + "description": "JobComparator enum EQ" + }, + { + "name": "GT", + "value": "GT", + "description": "JobComparator enum GT" + }, + { + "name": "GTE", + "value": "GTE", + "description": "JobComparator enum GTE" + }, + { + "name": "LT", + "value": "LT", + "description": "JobComparator enum LT" + }, + { + "name": "LTE", + "value": "LTE", + "description": "JobComparator enum LTE" + }, + { + "name": "NE", + "value": "NE", + "description": "JobComparator enum NE" + }, + { + "name": "STARTS_WITH", + "value": "STARTS_WITH", + "description": "JobComparator enum STARTS_WITH" + } + ] + } + }, + "JobComparatorEnumValue": { + "type": "object", + "description": "Definition of JobComparatorEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/JobComparator", + "description": "Property value" + } + } + }, + "JobStatus": { + "type": "string", + "description": "JobStatus enum", + "enum": [ + "CANCELLED", + "COMPLETE", + "IDLE", + "PAUSED", + "RUNNING", + "USER_PAUSED" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "JobStatus enum CANCELLED" + }, + { + "name": "COMPLETE", + "value": "COMPLETE", + "description": "JobStatus enum COMPLETE" + }, + { + "name": "IDLE", + "value": "IDLE", + "description": "JobStatus enum IDLE" + }, + { + "name": "PAUSED", + "value": "PAUSED", + "description": "JobStatus enum PAUSED" + }, + { + "name": "RUNNING", + "value": "RUNNING", + "description": "JobStatus enum RUNNING" + }, + { + "name": "USER_PAUSED", + "value": "USER_PAUSED", + "description": "JobStatus enum USER_PAUSED" + } + ] + } + }, + "JobStatusEnumValue": { + "type": "object", + "description": "Definition of JobStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/JobStatus", + "description": "Property value" + } + } + }, + "JobType": { + "type": "string", + "description": "JobType enum", + "enum": [ + "ONE_TIME", + "SCHEDULED" + ], + "x-ms-enum": { + "name": "JobType", + "modelAsString": true, + "values": [ + { + "name": "ONE_TIME", + "value": "ONE_TIME", + "description": "JobType enum ONE_TIME" + }, + { + "name": "SCHEDULED", + "value": "SCHEDULED", + "description": "JobType enum SCHEDULED" + } + ] + } + }, + "JobTypeEnumValue": { + "type": "object", + "description": "Definition of JobTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/JobType", + "description": "Property value" + } + } + }, + "LastRunErrorStatus": { + "type": "object", + "description": "Definition of LastRunErrorStatus", + "properties": { + "code": { + "$ref": "#/definitions/LastRunErrorStatusCodeEnumValue", + "description": "<p>Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:</p> <ul><li><p>ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.</p></li> <li><p>NONE - No errors occurred. Macie processed all the data specified for the job.</p></li></ul>" + } + } + }, + "LastRunErrorStatusCode": { + "type": "string", + "description": "LastRunErrorStatusCode enum", + "enum": [ + "ERROR", + "NONE" + ], + "x-ms-enum": { + "name": "LastRunErrorStatusCode", + "modelAsString": true, + "values": [ + { + "name": "ERROR", + "value": "ERROR", + "description": "LastRunErrorStatusCode enum ERROR" + }, + { + "name": "NONE", + "value": "NONE", + "description": "LastRunErrorStatusCode enum NONE" + } + ] + } + }, + "LastRunErrorStatusCodeEnumValue": { + "type": "object", + "description": "Definition of LastRunErrorStatusCodeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/LastRunErrorStatusCode", + "description": "Property value" + } + } + }, + "Macie2JobSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Macie2JobSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Macie2JobSummaryListResult": { + "type": "object", + "description": "The response of a Macie2JobSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Macie2JobSummary items on this page", + "items": { + "$ref": "#/definitions/Macie2JobSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Macie2JobSummaryProperties": { + "type": "object", + "description": "Definition of Macie2JobSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsMacie2JobSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Macie2JobSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Macie2JobSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "S3BucketCriteriaForJob": { + "type": "object", + "description": "Definition of S3BucketCriteriaForJob", + "properties": { + "excludes": { + "$ref": "#/definitions/CriteriaBlockForJob", + "description": "<p>The property- and tag-based conditions that determine which buckets to exclude from the job.</p>" + }, + "includes": { + "$ref": "#/definitions/CriteriaBlockForJob", + "description": "<p>The property- and tag-based conditions that determine which buckets to include in the job.</p>" + } + } + }, + "S3BucketDefinitionForJob": { + "type": "object", + "description": "Definition of S3BucketDefinitionForJob", + "properties": { + "accountId": { + "type": "string", + "description": "<p>The unique identifier for the Amazon Web Services account that owns the buckets.</p>" + }, + "buckets": { + "type": "array", + "description": "<p>An array that lists the names of the buckets.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "SimpleCriterionForJob": { + "type": "object", + "description": "Definition of SimpleCriterionForJob", + "properties": { + "comparator": { + "$ref": "#/definitions/JobComparatorEnumValue", + "description": "<p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>" + }, + "key": { + "$ref": "#/definitions/SimpleCriterionKeyForJobEnumValue", + "description": "<p>The property to use in the condition.</p>" + }, + "values": { + "type": "array", + "description": "<p>An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:</p> <ul><li><p>ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.</p></li> <li><p>S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the <a href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission'>BucketPublicAccess.effectivePermission</a> property of a bucket.</p></li> <li><p>S3_BUCKET_NAME - A string that represents the name of a bucket.</p></li> <li><p>S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the <a href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess'>BucketMetadata.sharedAccess</a> property of a bucket.</p></li></ul> <p>Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "SimpleCriterionKeyForJob": { + "type": "string", + "description": "SimpleCriterionKeyForJob enum", + "enum": [ + "ACCOUNT_ID", + "S3_BUCKET_EFFECTIVE_PERMISSION", + "S3_BUCKET_NAME", + "S3_BUCKET_SHARED_ACCESS" + ], + "x-ms-enum": { + "name": "SimpleCriterionKeyForJob", + "modelAsString": true, + "values": [ + { + "name": "ACCOUNT_ID", + "value": "ACCOUNT_ID", + "description": "SimpleCriterionKeyForJob enum ACCOUNT_ID" + }, + { + "name": "S3_BUCKET_EFFECTIVE_PERMISSION", + "value": "S3_BUCKET_EFFECTIVE_PERMISSION", + "description": "SimpleCriterionKeyForJob enum S3_BUCKET_EFFECTIVE_PERMISSION" + }, + { + "name": "S3_BUCKET_NAME", + "value": "S3_BUCKET_NAME", + "description": "SimpleCriterionKeyForJob enum S3_BUCKET_NAME" + }, + { + "name": "S3_BUCKET_SHARED_ACCESS", + "value": "S3_BUCKET_SHARED_ACCESS", + "description": "SimpleCriterionKeyForJob enum S3_BUCKET_SHARED_ACCESS" + } + ] + } + }, + "SimpleCriterionKeyForJobEnumValue": { + "type": "object", + "description": "Definition of SimpleCriterionKeyForJobEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SimpleCriterionKeyForJob", + "description": "Property value" + } + } + }, + "TagCriterionForJob": { + "type": "object", + "description": "Definition of TagCriterionForJob", + "properties": { + "comparator": { + "$ref": "#/definitions/JobComparatorEnumValue", + "description": "<p>The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).</p>" + }, + "tagValues": { + "type": "array", + "description": "<p>The tag keys, tag values, or tag key and value pairs to use in the condition.</p>", + "items": { + "$ref": "#/definitions/TagCriterionPairForJob" + }, + "x-ms-identifiers": [] + } + } + }, + "TagCriterionPairForJob": { + "type": "object", + "description": "Definition of TagCriterionPairForJob", + "properties": { + "key": { + "type": "string", + "description": "<p>The value for the tag key to use in the condition.</p>" + }, + "value": { + "type": "string", + "description": "<p>The tag value to use in the condition.</p>" + } + } + }, + "UserPausedDetails": { + "type": "object", + "description": "Definition of UserPausedDetails", + "properties": { + "jobExpiresAt": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.</p>" + }, + "jobImminentExpirationHealthEventArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.</p>" + }, + "jobPausedAt": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time, in UTC and extended ISO 8601 format, when you paused the job.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macieAllowList.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macieAllowList.json new file mode 100644 index 000000000000..2abd48f520bb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/macieAllowList.json @@ -0,0 +1,676 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "MacieAllowLists" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/macieAllowLists": { + "get": { + "operationId": "MacieAllowLists_ListBySubscription", + "tags": [ + "MacieAllowLists" + ], + "description": "List MacieAllowList resources 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/MacieAllowListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MacieAllowLists_ListBySubscription": { + "$ref": "./examples/MacieAllowLists_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/macieAllowLists": { + "get": { + "operationId": "MacieAllowLists_ListByResourceGroup", + "tags": [ + "MacieAllowLists" + ], + "description": "List MacieAllowList resources 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/MacieAllowListListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MacieAllowLists_ListByResourceGroup": { + "$ref": "./examples/MacieAllowLists_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/macieAllowLists/{name}": { + "get": { + "operationId": "MacieAllowLists_Get", + "tags": [ + "MacieAllowLists" + ], + "description": "Get a MacieAllowList", + "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": "name", + "in": "path", + "description": "Name of MacieAllowList", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MacieAllowList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MacieAllowLists_Get": { + "$ref": "./examples/MacieAllowLists_Get.json" + } + } + }, + "put": { + "operationId": "MacieAllowLists_CreateOrReplace", + "tags": [ + "MacieAllowLists" + ], + "description": "Create a MacieAllowList. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of MacieAllowList", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MacieAllowList" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MacieAllowList' update operation succeeded", + "schema": { + "$ref": "#/definitions/MacieAllowList" + } + }, + "201": { + "description": "Resource 'MacieAllowList' create operation succeeded", + "schema": { + "$ref": "#/definitions/MacieAllowList" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "MacieAllowLists_CreateOrReplace": { + "$ref": "./examples/MacieAllowLists_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MacieAllowLists_Update", + "tags": [ + "MacieAllowLists" + ], + "description": "Update a MacieAllowList", + "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": "name", + "in": "path", + "description": "Name of MacieAllowList", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MacieAllowListTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MacieAllowList" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "MacieAllowLists_Update": { + "$ref": "./examples/MacieAllowLists_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MacieAllowLists_Delete", + "tags": [ + "MacieAllowLists" + ], + "description": "Delete a MacieAllowList", + "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": "name", + "in": "path", + "description": "Name of MacieAllowList", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "MacieAllowLists_Delete": { + "$ref": "./examples/MacieAllowLists_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsMacieAllowListProperties": { + "type": "object", + "description": "Definition of awsMacieAllowList", + "properties": { + "arn": { + "type": "string", + "description": "AllowList ARN." + }, + "criteria": { + "$ref": "#/definitions/Criteria", + "description": "AllowList criteria. The regex or s3 object to use for the AllowList." + }, + "description": { + "type": "string", + "description": "Description of AllowList." + }, + "id": { + "type": "string", + "description": "AllowList ID." + }, + "name": { + "type": "string", + "description": "Name of AllowList." + }, + "status": { + "$ref": "#/definitions/Status", + "description": "AllowList status. The status for the AllowList" + }, + "tags": { + "type": "array", + "description": "A collection of tags associated with a resource", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "Criteria": { + "type": "object", + "description": "Definition of Criteria", + "properties": { + "regex": { + "type": "string", + "description": "The S3 object key for the AllowList." + }, + "s3WordsList": { + "$ref": "#/definitions/S3WordsList", + "description": "The S3 location for the AllowList." + } + } + }, + "MacieAllowList": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/MacieAllowListProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "MacieAllowListListResult": { + "type": "object", + "description": "The response of a MacieAllowList list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MacieAllowList items on this page", + "items": { + "$ref": "#/definitions/MacieAllowList" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MacieAllowListProperties": { + "type": "object", + "description": "Definition of MacieAllowList", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsMacieAllowListProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "MacieAllowListTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in MacieAllowList resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "S3WordsList": { + "type": "object", + "description": "Definition of S3WordsList", + "properties": { + "bucketName": { + "type": "string", + "description": "Property bucketName" + }, + "objectKey": { + "type": "string", + "description": "Property objectKey" + } + } + }, + "Status": { + "type": "string", + "description": "Status enum", + "enum": [ + "OK", + "S3_OBJECT_ACCESS_DENIED", + "S3_OBJECT_EMPTY", + "S3_OBJECT_NOT_FOUND", + "S3_OBJECT_OVERSIZE", + "S3_THROTTLED", + "S3_USER_ACCESS_DENIED", + "UNKNOWN_ERROR" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "OK", + "value": "OK", + "description": "Status enum OK" + }, + { + "name": "S3_OBJECT_ACCESS_DENIED", + "value": "S3_OBJECT_ACCESS_DENIED", + "description": "Status enum S3_OBJECT_ACCESS_DENIED" + }, + { + "name": "S3_OBJECT_EMPTY", + "value": "S3_OBJECT_EMPTY", + "description": "Status enum S3_OBJECT_EMPTY" + }, + { + "name": "S3_OBJECT_NOT_FOUND", + "value": "S3_OBJECT_NOT_FOUND", + "description": "Status enum S3_OBJECT_NOT_FOUND" + }, + { + "name": "S3_OBJECT_OVERSIZE", + "value": "S3_OBJECT_OVERSIZE", + "description": "Status enum S3_OBJECT_OVERSIZE" + }, + { + "name": "S3_THROTTLED", + "value": "S3_THROTTLED", + "description": "Status enum S3_THROTTLED" + }, + { + "name": "S3_USER_ACCESS_DENIED", + "value": "S3_USER_ACCESS_DENIED", + "description": "Status enum S3_USER_ACCESS_DENIED" + }, + { + "name": "UNKNOWN_ERROR", + "value": "UNKNOWN_ERROR", + "description": "Status enum UNKNOWN_ERROR" + } + ] + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The tag's key." + }, + "value": { + "type": "string", + "description": "The tag's value." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewall.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewall.json new file mode 100644 index 000000000000..9d3b8d2a6e62 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewall.json @@ -0,0 +1,630 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "NetworkFirewallFirewalls" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/networkFirewallFirewalls": { + "get": { + "operationId": "NetworkFirewallFirewalls_ListBySubscription", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "List NetworkFirewallFirewall resources 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/NetworkFirewallFirewallListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewalls_ListBySubscription": { + "$ref": "./examples/NetworkFirewallFirewalls_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallFirewalls": { + "get": { + "operationId": "NetworkFirewallFirewalls_ListByResourceGroup", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "List NetworkFirewallFirewall resources 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/NetworkFirewallFirewallListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewalls_ListByResourceGroup": { + "$ref": "./examples/NetworkFirewallFirewalls_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallFirewalls/{name}": { + "get": { + "operationId": "NetworkFirewallFirewalls_Get", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "Get a NetworkFirewallFirewall", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewall", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewall" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewalls_Get": { + "$ref": "./examples/NetworkFirewallFirewalls_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFirewallFirewalls_CreateOrReplace", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "Create a NetworkFirewallFirewall. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewall", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewall" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFirewallFirewall' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewall" + } + }, + "201": { + "description": "Resource 'NetworkFirewallFirewall' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewall" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "NetworkFirewallFirewalls_CreateOrReplace": { + "$ref": "./examples/NetworkFirewallFirewalls_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFirewallFirewalls_Update", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "Update a NetworkFirewallFirewall", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewall", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewall" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewalls_Update": { + "$ref": "./examples/NetworkFirewallFirewalls_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFirewallFirewalls_Delete", + "tags": [ + "NetworkFirewallFirewalls" + ], + "description": "Delete a NetworkFirewallFirewall", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewall", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "NetworkFirewallFirewalls_Delete": { + "$ref": "./examples/NetworkFirewallFirewalls_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsNetworkFirewallFirewallProperties": { + "type": "object", + "description": "Definition of awsNetworkFirewallFirewall", + "properties": { + "deleteProtection": { + "type": "boolean", + "description": "Property deleteProtection" + }, + "description": { + "type": "string", + "description": "Property description" + }, + "endpointIds": { + "type": "array", + "description": "Property endpointIds", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "firewallArn": { + "type": "string", + "description": "A resource ARN." + }, + "firewallId": { + "type": "string", + "description": "Property firewallId" + }, + "firewallName": { + "type": "string", + "description": "Property firewallName" + }, + "firewallPolicyArn": { + "type": "string", + "description": "A resource ARN." + }, + "firewallPolicyChangeProtection": { + "type": "boolean", + "description": "Property firewallPolicyChangeProtection" + }, + "subnetChangeProtection": { + "type": "boolean", + "description": "Property subnetChangeProtection" + }, + "subnetMappings": { + "type": "array", + "description": "Property subnetMappings", + "items": { + "$ref": "#/definitions/SubnetMapping" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "Property vpcId" + } + } + }, + "NetworkFirewallFirewall": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFirewallFirewallProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFirewallFirewallListResult": { + "type": "object", + "description": "The response of a NetworkFirewallFirewall list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFirewallFirewall items on this page", + "items": { + "$ref": "#/definitions/NetworkFirewallFirewall" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFirewallFirewallProperties": { + "type": "object", + "description": "Definition of NetworkFirewallFirewall", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsNetworkFirewallFirewallProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "NetworkFirewallFirewallTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkFirewallFirewall resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SubnetMapping": { + "type": "object", + "description": "Definition of SubnetMapping", + "properties": { + "ipAddressType": { + "type": "string", + "description": "A IPAddressType" + }, + "subnetId": { + "type": "string", + "description": "A SubnetId." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewallPolicy.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewallPolicy.json new file mode 100644 index 000000000000..777f8608d7b5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewallPolicy.json @@ -0,0 +1,855 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "NetworkFirewallFirewallPolicies" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/networkFirewallFirewallPolicies": { + "get": { + "operationId": "NetworkFirewallFirewallPolicies_ListBySubscription", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "List NetworkFirewallFirewallPolicy resources 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/NetworkFirewallFirewallPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewallPolicies_ListBySubscription": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallFirewallPolicies": { + "get": { + "operationId": "NetworkFirewallFirewallPolicies_ListByResourceGroup", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "List NetworkFirewallFirewallPolicy resources 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/NetworkFirewallFirewallPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewallPolicies_ListByResourceGroup": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallFirewallPolicies/{name}": { + "get": { + "operationId": "NetworkFirewallFirewallPolicies_Get", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "Get a NetworkFirewallFirewallPolicy", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewallPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewallPolicies_Get": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFirewallFirewallPolicies_CreateOrReplace", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "Create a NetworkFirewallFirewallPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewallPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFirewallFirewallPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + } + }, + "201": { + "description": "Resource 'NetworkFirewallFirewallPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "NetworkFirewallFirewallPolicies_CreateOrReplace": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFirewallFirewallPolicies_Update", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "Update a NetworkFirewallFirewallPolicy", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewallPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicyTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallFirewallPolicies_Update": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFirewallFirewallPolicies_Delete", + "tags": [ + "NetworkFirewallFirewallPolicies" + ], + "description": "Delete a NetworkFirewallFirewallPolicy", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallFirewallPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "NetworkFirewallFirewallPolicies_Delete": { + "$ref": "./examples/NetworkFirewallFirewallPolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActionDefinition": { + "type": "object", + "description": "Definition of ActionDefinition", + "properties": { + "publishMetricAction": { + "$ref": "#/definitions/PublishMetricAction", + "description": "Property publishMetricAction" + } + } + }, + "AwsNetworkFirewallFirewallPolicyProperties": { + "type": "object", + "description": "Definition of awsNetworkFirewallFirewallPolicy", + "properties": { + "description": { + "type": "string", + "description": "Property description" + }, + "firewallPolicy": { + "$ref": "#/definitions/FirewallPolicy", + "description": "Property firewallPolicy" + }, + "firewallPolicyArn": { + "type": "string", + "description": "A resource ARN." + }, + "firewallPolicyId": { + "type": "string", + "description": "Property firewallPolicyId" + }, + "firewallPolicyName": { + "type": "string", + "description": "Property firewallPolicyName" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "CustomAction": { + "type": "object", + "description": "Definition of CustomAction", + "properties": { + "actionDefinition": { + "$ref": "#/definitions/ActionDefinition", + "description": "Property actionDefinition" + }, + "actionName": { + "type": "string", + "description": "Property actionName" + } + } + }, + "Dimension": { + "type": "object", + "description": "Definition of Dimension", + "properties": { + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "FirewallPolicy": { + "type": "object", + "description": "Definition of FirewallPolicy", + "properties": { + "policyVariables": { + "$ref": "#/definitions/RuleVariablesModel", + "description": "Property policyVariables" + }, + "statefulDefaultActions": { + "type": "array", + "description": "Property statefulDefaultActions", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "statefulEngineOptions": { + "$ref": "#/definitions/StatefulEngineOptions", + "description": "Property statefulEngineOptions" + }, + "statefulRuleGroupReferences": { + "type": "array", + "description": "Property statefulRuleGroupReferences", + "items": { + "$ref": "#/definitions/StatefulRuleGroupReference" + }, + "x-ms-identifiers": [] + }, + "statelessCustomActions": { + "type": "array", + "description": "Property statelessCustomActions", + "items": { + "$ref": "#/definitions/CustomAction" + }, + "x-ms-identifiers": [] + }, + "statelessDefaultActions": { + "type": "array", + "description": "Property statelessDefaultActions", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "statelessFragmentDefaultActions": { + "type": "array", + "description": "Property statelessFragmentDefaultActions", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "statelessRuleGroupReferences": { + "type": "array", + "description": "Property statelessRuleGroupReferences", + "items": { + "$ref": "#/definitions/StatelessRuleGroupReference" + }, + "x-ms-identifiers": [] + }, + "tlsInspectionConfigurationArn": { + "type": "string", + "description": "A resource ARN." + } + } + }, + "IPSet": { + "type": "object", + "description": "Definition of IPSet", + "properties": { + "definition": { + "type": "array", + "description": "Property definition", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkFirewallFirewallPolicy": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFirewallFirewallPolicyListResult": { + "type": "object", + "description": "The response of a NetworkFirewallFirewallPolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFirewallFirewallPolicy items on this page", + "items": { + "$ref": "#/definitions/NetworkFirewallFirewallPolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFirewallFirewallPolicyProperties": { + "type": "object", + "description": "Definition of NetworkFirewallFirewallPolicy", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsNetworkFirewallFirewallPolicyProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "NetworkFirewallFirewallPolicyTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkFirewallFirewallPolicy resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "PublishMetricAction": { + "type": "object", + "description": "Definition of PublishMetricAction", + "properties": { + "dimensions": { + "type": "array", + "description": "Property dimensions", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [] + } + } + }, + "RuleVariablesModel": { + "type": "object", + "description": "Definition of RuleVariables", + "properties": { + "ruleVariables": { + "type": "object", + "description": "Property ruleVariables", + "additionalProperties": { + "$ref": "#/definitions/IPSet" + } + } + } + }, + "StatefulEngineOptions": { + "type": "object", + "description": "Definition of StatefulEngineOptions", + "properties": { + "ruleOrder": { + "$ref": "#/definitions/StatefulEngineOptionsRuleOrder", + "description": "Property ruleOrder" + }, + "streamExceptionPolicy": { + "$ref": "#/definitions/StatefulEngineOptionsStreamExceptionPolicy", + "description": "Property streamExceptionPolicy" + } + } + }, + "StatefulEngineOptionsRuleOrder": { + "type": "string", + "description": "StatefulEngineOptionsRuleOrder enum", + "enum": [ + "DEFAULT_ACTION_ORDER", + "STRICT_ORDER" + ], + "x-ms-enum": { + "name": "StatefulEngineOptionsRuleOrder", + "modelAsString": true, + "values": [ + { + "name": "DEFAULT_ACTION_ORDER", + "value": "DEFAULT_ACTION_ORDER", + "description": "StatefulEngineOptionsRuleOrder enum DEFAULT_ACTION_ORDER" + }, + { + "name": "STRICT_ORDER", + "value": "STRICT_ORDER", + "description": "StatefulEngineOptionsRuleOrder enum STRICT_ORDER" + } + ] + } + }, + "StatefulEngineOptionsStreamExceptionPolicy": { + "type": "string", + "description": "StatefulEngineOptionsStreamExceptionPolicy enum", + "enum": [ + "CONTINUE", + "DROP", + "REJECT" + ], + "x-ms-enum": { + "name": "StatefulEngineOptionsStreamExceptionPolicy", + "modelAsString": true, + "values": [ + { + "name": "CONTINUE", + "value": "CONTINUE", + "description": "StatefulEngineOptionsStreamExceptionPolicy enum CONTINUE" + }, + { + "name": "DROP", + "value": "DROP", + "description": "StatefulEngineOptionsStreamExceptionPolicy enum DROP" + }, + { + "name": "REJECT", + "value": "REJECT", + "description": "StatefulEngineOptionsStreamExceptionPolicy enum REJECT" + } + ] + } + }, + "StatefulRuleGroupOverride": { + "type": "object", + "description": "Definition of StatefulRuleGroupOverride", + "properties": { + "action": { + "$ref": "#/definitions/StatefulRuleGroupOverrideAction", + "description": "Property action" + } + } + }, + "StatefulRuleGroupOverrideAction": { + "type": "string", + "description": "StatefulRuleGroupOverrideAction enum", + "enum": [ + "DROP_TO_ALERT" + ], + "x-ms-enum": { + "name": "StatefulRuleGroupOverrideAction", + "modelAsString": true, + "values": [ + { + "name": "DROP_TO_ALERT", + "value": "DROP_TO_ALERT", + "description": "StatefulRuleGroupOverrideAction enum DROP_TO_ALERT" + } + ] + } + }, + "StatefulRuleGroupReference": { + "type": "object", + "description": "Definition of StatefulRuleGroupReference", + "properties": { + "override": { + "$ref": "#/definitions/StatefulRuleGroupOverride", + "description": "Property override" + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "Property priority" + }, + "resourceArn": { + "type": "string", + "description": "A resource ARN." + } + } + }, + "StatelessRuleGroupReference": { + "type": "object", + "description": "Definition of StatelessRuleGroupReference", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Property priority" + }, + "resourceArn": { + "type": "string", + "description": "A resource ARN." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallRuleGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallRuleGroup.json new file mode 100644 index 000000000000..d704b68386ef --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/networkFirewallRuleGroup.json @@ -0,0 +1,1282 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "NetworkFirewallRuleGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/networkFirewallRuleGroups": { + "get": { + "operationId": "NetworkFirewallRuleGroups_ListBySubscription", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "List NetworkFirewallRuleGroup resources 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/NetworkFirewallRuleGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallRuleGroups_ListBySubscription": { + "$ref": "./examples/NetworkFirewallRuleGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallRuleGroups": { + "get": { + "operationId": "NetworkFirewallRuleGroups_ListByResourceGroup", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "List NetworkFirewallRuleGroup resources 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/NetworkFirewallRuleGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallRuleGroups_ListByResourceGroup": { + "$ref": "./examples/NetworkFirewallRuleGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/networkFirewallRuleGroups/{name}": { + "get": { + "operationId": "NetworkFirewallRuleGroups_Get", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "Get a NetworkFirewallRuleGroup", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallRuleGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallRuleGroups_Get": { + "$ref": "./examples/NetworkFirewallRuleGroups_Get.json" + } + } + }, + "put": { + "operationId": "NetworkFirewallRuleGroups_CreateOrReplace", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "Create a NetworkFirewallRuleGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallRuleGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkFirewallRuleGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + } + }, + "201": { + "description": "Resource 'NetworkFirewallRuleGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "NetworkFirewallRuleGroups_CreateOrReplace": { + "$ref": "./examples/NetworkFirewallRuleGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkFirewallRuleGroups_Update", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "Update a NetworkFirewallRuleGroup", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallRuleGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkFirewallRuleGroups_Update": { + "$ref": "./examples/NetworkFirewallRuleGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkFirewallRuleGroups_Delete", + "tags": [ + "NetworkFirewallRuleGroups" + ], + "description": "Delete a NetworkFirewallRuleGroup", + "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": "name", + "in": "path", + "description": "Name of NetworkFirewallRuleGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "NetworkFirewallRuleGroups_Delete": { + "$ref": "./examples/NetworkFirewallRuleGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ActionDefinition": { + "type": "object", + "description": "Definition of ActionDefinition", + "properties": { + "publishMetricAction": { + "$ref": "#/definitions/PublishMetricAction", + "description": "Property publishMetricAction" + } + } + }, + "Address": { + "type": "object", + "description": "Definition of Address", + "properties": { + "addressDefinition": { + "type": "string", + "description": "Property addressDefinition" + } + } + }, + "AwsNetworkFirewallRuleGroupProperties": { + "type": "object", + "description": "Definition of awsNetworkFirewallRuleGroup", + "properties": { + "capacity": { + "type": "integer", + "format": "int32", + "description": "Property capacity" + }, + "description": { + "type": "string", + "description": "Property description" + }, + "ruleGroup": { + "$ref": "#/definitions/RuleGroup", + "description": "Property ruleGroup" + }, + "ruleGroupArn": { + "type": "string", + "description": "A resource ARN." + }, + "ruleGroupId": { + "type": "string", + "description": "Property ruleGroupId" + }, + "ruleGroupName": { + "type": "string", + "description": "Property ruleGroupName" + }, + "tags": { + "type": "array", + "description": "Property tags", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "type": { + "$ref": "#/definitions/Type", + "description": "Property type" + } + } + }, + "CustomAction": { + "type": "object", + "description": "Definition of CustomAction", + "properties": { + "actionDefinition": { + "$ref": "#/definitions/ActionDefinition", + "description": "Property actionDefinition" + }, + "actionName": { + "type": "string", + "description": "Property actionName" + } + } + }, + "Dimension": { + "type": "object", + "description": "Definition of Dimension", + "properties": { + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "Header": { + "type": "object", + "description": "Definition of Header", + "properties": { + "destination": { + "type": "string", + "description": "Property destination" + }, + "destinationPort": { + "type": "string", + "description": "Property destinationPort" + }, + "direction": { + "$ref": "#/definitions/HeaderDirection", + "description": "Property direction" + }, + "protocol": { + "$ref": "#/definitions/HeaderProtocol", + "description": "Property protocol" + }, + "source": { + "type": "string", + "description": "Property source" + }, + "sourcePort": { + "type": "string", + "description": "Property sourcePort" + } + } + }, + "HeaderDirection": { + "type": "string", + "description": "HeaderDirection enum", + "enum": [ + "ANY", + "FORWARD" + ], + "x-ms-enum": { + "name": "HeaderDirection", + "modelAsString": true, + "values": [ + { + "name": "ANY", + "value": "ANY", + "description": "HeaderDirection enum ANY" + }, + { + "name": "FORWARD", + "value": "FORWARD", + "description": "HeaderDirection enum FORWARD" + } + ] + } + }, + "HeaderProtocol": { + "type": "string", + "description": "HeaderProtocol enum", + "enum": [ + "DCERPC", + "DHCP", + "DNS", + "FTP", + "HTTP", + "ICMP", + "IKEV2", + "IMAP", + "IP", + "KRB5", + "MSN", + "NTP", + "SMB", + "SMTP", + "SSH", + "TCP", + "TFTP", + "TLS", + "UDP" + ], + "x-ms-enum": { + "name": "HeaderProtocol", + "modelAsString": true, + "values": [ + { + "name": "DCERPC", + "value": "DCERPC", + "description": "HeaderProtocol enum DCERPC" + }, + { + "name": "DHCP", + "value": "DHCP", + "description": "HeaderProtocol enum DHCP" + }, + { + "name": "DNS", + "value": "DNS", + "description": "HeaderProtocol enum DNS" + }, + { + "name": "FTP", + "value": "FTP", + "description": "HeaderProtocol enum FTP" + }, + { + "name": "HTTP", + "value": "HTTP", + "description": "HeaderProtocol enum HTTP" + }, + { + "name": "ICMP", + "value": "ICMP", + "description": "HeaderProtocol enum ICMP" + }, + { + "name": "IKEV2", + "value": "IKEV2", + "description": "HeaderProtocol enum IKEV2" + }, + { + "name": "IMAP", + "value": "IMAP", + "description": "HeaderProtocol enum IMAP" + }, + { + "name": "IP", + "value": "IP", + "description": "HeaderProtocol enum IP" + }, + { + "name": "KRB5", + "value": "KRB5", + "description": "HeaderProtocol enum KRB5" + }, + { + "name": "MSN", + "value": "MSN", + "description": "HeaderProtocol enum MSN" + }, + { + "name": "NTP", + "value": "NTP", + "description": "HeaderProtocol enum NTP" + }, + { + "name": "SMB", + "value": "SMB", + "description": "HeaderProtocol enum SMB" + }, + { + "name": "SMTP", + "value": "SMTP", + "description": "HeaderProtocol enum SMTP" + }, + { + "name": "SSH", + "value": "SSH", + "description": "HeaderProtocol enum SSH" + }, + { + "name": "TCP", + "value": "TCP", + "description": "HeaderProtocol enum TCP" + }, + { + "name": "TFTP", + "value": "TFTP", + "description": "HeaderProtocol enum TFTP" + }, + { + "name": "TLS", + "value": "TLS", + "description": "HeaderProtocol enum TLS" + }, + { + "name": "UDP", + "value": "UDP", + "description": "HeaderProtocol enum UDP" + } + ] + } + }, + "IPSet": { + "type": "object", + "description": "Definition of IPSet", + "properties": { + "definition": { + "type": "array", + "description": "Property definition", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "IPSetReference": { + "type": "object", + "description": "Definition of IPSetReference", + "properties": { + "referenceArn": { + "type": "string", + "description": "A resource ARN." + } + } + }, + "MatchAttributes": { + "type": "object", + "description": "Definition of MatchAttributes", + "properties": { + "destinationPorts": { + "type": "array", + "description": "Property destinationPorts", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "destinations": { + "type": "array", + "description": "Property destinations", + "items": { + "$ref": "#/definitions/Address" + }, + "x-ms-identifiers": [] + }, + "protocols": { + "type": "array", + "description": "Property protocols", + "items": { + "type": "integer", + "format": "int32" + }, + "x-ms-identifiers": [] + }, + "sourcePorts": { + "type": "array", + "description": "Property sourcePorts", + "items": { + "$ref": "#/definitions/PortRange" + }, + "x-ms-identifiers": [] + }, + "sources": { + "type": "array", + "description": "Property sources", + "items": { + "$ref": "#/definitions/Address" + }, + "x-ms-identifiers": [] + }, + "tcpFlags": { + "type": "array", + "description": "Property tcpFlags", + "items": { + "$ref": "#/definitions/TCPFlagField" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkFirewallRuleGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkFirewallRuleGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkFirewallRuleGroupListResult": { + "type": "object", + "description": "The response of a NetworkFirewallRuleGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkFirewallRuleGroup items on this page", + "items": { + "$ref": "#/definitions/NetworkFirewallRuleGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkFirewallRuleGroupProperties": { + "type": "object", + "description": "Definition of NetworkFirewallRuleGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsNetworkFirewallRuleGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "NetworkFirewallRuleGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkFirewallRuleGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "PortRange": { + "type": "object", + "description": "Definition of PortRange", + "properties": { + "fromPort": { + "type": "integer", + "format": "int32", + "description": "Property fromPort" + }, + "toPort": { + "type": "integer", + "format": "int32", + "description": "Property toPort" + } + } + }, + "PortSet": { + "type": "object", + "description": "Definition of PortSet", + "properties": { + "definition": { + "type": "array", + "description": "Property definition", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "PublishMetricAction": { + "type": "object", + "description": "Definition of PublishMetricAction", + "properties": { + "dimensions": { + "type": "array", + "description": "Property dimensions", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [] + } + } + }, + "ReferenceSets": { + "type": "object", + "description": "Definition of ReferenceSets", + "properties": { + "ipSetReferences": { + "type": "object", + "description": "Property ipSetReferences", + "additionalProperties": { + "$ref": "#/definitions/IPSetReference" + } + } + } + }, + "RuleDefinition": { + "type": "object", + "description": "Definition of RuleDefinition", + "properties": { + "actions": { + "type": "array", + "description": "Property actions", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "matchAttributes": { + "$ref": "#/definitions/MatchAttributes", + "description": "Property matchAttributes" + } + } + }, + "RuleGroup": { + "type": "object", + "description": "Definition of RuleGroup", + "properties": { + "referenceSets": { + "$ref": "#/definitions/ReferenceSets", + "description": "Property referenceSets" + }, + "ruleVariables": { + "$ref": "#/definitions/RuleVariables", + "description": "Property ruleVariables" + }, + "rulesSource": { + "$ref": "#/definitions/RulesSource", + "description": "Property rulesSource" + }, + "statefulRuleOptions": { + "$ref": "#/definitions/StatefulRuleOptions", + "description": "Property statefulRuleOptions" + } + } + }, + "RuleOption": { + "type": "object", + "description": "Definition of RuleOption", + "properties": { + "keyword": { + "type": "string", + "description": "Property keyword" + }, + "settings": { + "type": "array", + "description": "Property settings", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "RuleVariables": { + "type": "object", + "description": "Definition of RuleVariables", + "properties": { + "ipSets": { + "type": "object", + "description": "Property ipSets", + "additionalProperties": { + "$ref": "#/definitions/IPSet" + } + }, + "portSets": { + "type": "object", + "description": "Property portSets", + "additionalProperties": { + "$ref": "#/definitions/PortSet" + } + } + } + }, + "RulesSource": { + "type": "object", + "description": "Definition of RulesSource", + "properties": { + "rulesSourceList": { + "$ref": "#/definitions/RulesSourceList", + "description": "Property rulesSourceList" + }, + "rulesString": { + "type": "string", + "description": "Property rulesString" + }, + "statefulRules": { + "type": "array", + "description": "Property statefulRules", + "items": { + "$ref": "#/definitions/StatefulRule" + }, + "x-ms-identifiers": [] + }, + "statelessRulesAndCustomActions": { + "$ref": "#/definitions/StatelessRulesAndCustomActions", + "description": "Property statelessRulesAndCustomActions" + } + } + }, + "RulesSourceList": { + "type": "object", + "description": "Definition of RulesSourceList", + "properties": { + "generatedRulesType": { + "$ref": "#/definitions/RulesSourceListGeneratedRulesType", + "description": "Property generatedRulesType" + }, + "targetTypes": { + "type": "array", + "description": "Property targetTypes", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "targets": { + "type": "array", + "description": "Property targets", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "RulesSourceListGeneratedRulesType": { + "type": "string", + "description": "RulesSourceListGeneratedRulesType enum", + "enum": [ + "ALLOWLIST", + "DENYLIST" + ], + "x-ms-enum": { + "name": "RulesSourceListGeneratedRulesType", + "modelAsString": true, + "values": [ + { + "name": "ALLOWLIST", + "value": "ALLOWLIST", + "description": "RulesSourceListGeneratedRulesType enum ALLOWLIST" + }, + { + "name": "DENYLIST", + "value": "DENYLIST", + "description": "RulesSourceListGeneratedRulesType enum DENYLIST" + } + ] + } + }, + "StatefulRule": { + "type": "object", + "description": "Definition of StatefulRule", + "properties": { + "action": { + "$ref": "#/definitions/StatefulRuleAction", + "description": "Property action" + }, + "header": { + "$ref": "#/definitions/Header", + "description": "Property header" + }, + "ruleOptions": { + "type": "array", + "description": "Property ruleOptions", + "items": { + "$ref": "#/definitions/RuleOption" + }, + "x-ms-identifiers": [] + } + } + }, + "StatefulRuleAction": { + "type": "string", + "description": "StatefulRuleAction enum", + "enum": [ + "ALERT", + "DROP", + "PASS", + "REJECT" + ], + "x-ms-enum": { + "name": "StatefulRuleAction", + "modelAsString": true, + "values": [ + { + "name": "ALERT", + "value": "ALERT", + "description": "StatefulRuleAction enum ALERT" + }, + { + "name": "DROP", + "value": "DROP", + "description": "StatefulRuleAction enum DROP" + }, + { + "name": "PASS", + "value": "PASS", + "description": "StatefulRuleAction enum PASS" + }, + { + "name": "REJECT", + "value": "REJECT", + "description": "StatefulRuleAction enum REJECT" + } + ] + } + }, + "StatefulRuleOptions": { + "type": "object", + "description": "Definition of StatefulRuleOptions", + "properties": { + "ruleOrder": { + "$ref": "#/definitions/StatefulRuleOptionsRuleOrder", + "description": "Property ruleOrder" + } + } + }, + "StatefulRuleOptionsRuleOrder": { + "type": "string", + "description": "StatefulRuleOptionsRuleOrder enum", + "enum": [ + "DEFAULT_ACTION_ORDER", + "STRICT_ORDER" + ], + "x-ms-enum": { + "name": "StatefulRuleOptionsRuleOrder", + "modelAsString": true, + "values": [ + { + "name": "DEFAULT_ACTION_ORDER", + "value": "DEFAULT_ACTION_ORDER", + "description": "StatefulRuleOptionsRuleOrder enum DEFAULT_ACTION_ORDER" + }, + { + "name": "STRICT_ORDER", + "value": "STRICT_ORDER", + "description": "StatefulRuleOptionsRuleOrder enum STRICT_ORDER" + } + ] + } + }, + "StatelessRule": { + "type": "object", + "description": "Definition of StatelessRule", + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "description": "Property priority" + }, + "ruleDefinition": { + "$ref": "#/definitions/RuleDefinition", + "description": "Property ruleDefinition" + } + } + }, + "StatelessRulesAndCustomActions": { + "type": "object", + "description": "Definition of StatelessRulesAndCustomActions", + "properties": { + "customActions": { + "type": "array", + "description": "Property customActions", + "items": { + "$ref": "#/definitions/CustomAction" + }, + "x-ms-identifiers": [] + }, + "statelessRules": { + "type": "array", + "description": "Property statelessRules", + "items": { + "$ref": "#/definitions/StatelessRule" + }, + "x-ms-identifiers": [] + } + } + }, + "TCPFlagField": { + "type": "object", + "description": "Definition of TCPFlagField", + "properties": { + "flags": { + "type": "array", + "description": "Property flags", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "masks": { + "type": "array", + "description": "Property masks", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + }, + "Type": { + "type": "string", + "description": "Type enum", + "enum": [ + "STATEFUL", + "STATELESS" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true, + "values": [ + { + "name": "STATEFUL", + "value": "STATEFUL", + "description": "Type enum STATEFUL" + }, + { + "name": "STATELESS", + "value": "STATELESS", + "description": "Type enum STATELESS" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/openSearchDomainStatus.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/openSearchDomainStatus.json new file mode 100644 index 000000000000..e3e9583ff2b7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/openSearchDomainStatus.json @@ -0,0 +1,2276 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "OpenSearchDomainStatuses" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/openSearchDomainStatuses": { + "get": { + "operationId": "OpenSearchDomainStatuses_ListBySubscription", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "List OpenSearchDomainStatus resources 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/OpenSearchDomainStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenSearchDomainStatuses_ListBySubscription": { + "$ref": "./examples/OpenSearchDomainStatuses_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/openSearchDomainStatuses": { + "get": { + "operationId": "OpenSearchDomainStatuses_ListByResourceGroup", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "List OpenSearchDomainStatus resources 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/OpenSearchDomainStatusListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenSearchDomainStatuses_ListByResourceGroup": { + "$ref": "./examples/OpenSearchDomainStatuses_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/openSearchDomainStatuses/{name}": { + "get": { + "operationId": "OpenSearchDomainStatuses_Get", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "Get a OpenSearchDomainStatus", + "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": "name", + "in": "path", + "description": "Name of OpenSearchDomainStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenSearchDomainStatuses_Get": { + "$ref": "./examples/OpenSearchDomainStatuses_Get.json" + } + } + }, + "put": { + "operationId": "OpenSearchDomainStatuses_CreateOrReplace", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "Create a OpenSearchDomainStatus. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of OpenSearchDomainStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatus" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OpenSearchDomainStatus' update operation succeeded", + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatus" + } + }, + "201": { + "description": "Resource 'OpenSearchDomainStatus' create operation succeeded", + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatus" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "OpenSearchDomainStatuses_CreateOrReplace": { + "$ref": "./examples/OpenSearchDomainStatuses_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OpenSearchDomainStatuses_Update", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "Update a OpenSearchDomainStatus", + "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": "name", + "in": "path", + "description": "Name of OpenSearchDomainStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatusTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OpenSearchDomainStatus" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OpenSearchDomainStatuses_Update": { + "$ref": "./examples/OpenSearchDomainStatuses_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OpenSearchDomainStatuses_Delete", + "tags": [ + "OpenSearchDomainStatuses" + ], + "description": "Delete a OpenSearchDomainStatus", + "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": "name", + "in": "path", + "description": "Name of OpenSearchDomainStatus", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "OpenSearchDomainStatuses_Delete": { + "$ref": "./examples/OpenSearchDomainStatuses_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdvancedSecurityOptions": { + "type": "object", + "description": "Definition of AdvancedSecurityOptions", + "properties": { + "anonymousAuthDisableDate": { + "type": "string", + "format": "date-time", + "description": "<p>Date and time when the migration period will be disabled. Only necessary when <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'>enabling fine-grained access control on an existing domain</a>.</p>" + }, + "anonymousAuthEnabled": { + "type": "boolean", + "description": "<p>True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'>enabling fine-grained access control on an existing domain</a>.</p>" + }, + "enabled": { + "type": "boolean", + "description": "<p>True if fine-grained access control is enabled.</p>" + }, + "internalUserDatabaseEnabled": { + "type": "boolean", + "description": "<p>True if the internal user database is enabled.</p>" + }, + "samlOptions": { + "$ref": "#/definitions/SAMLOptionsOutput", + "description": "<p>Container for information about the SAML configuration for OpenSearch Dashboards.</p>" + } + } + }, + "AutoTuneOptionsOutput": { + "type": "object", + "description": "Definition of AutoTuneOptionsOutput", + "properties": { + "errorMessage": { + "type": "string", + "description": "<p>Any errors that occurred while enabling or disabling Auto-Tune.</p>" + }, + "state": { + "$ref": "#/definitions/AutoTuneStateEnumValue", + "description": "<p>The current state of Auto-Tune on the domain.</p>" + }, + "useOffPeakWindow": { + "type": "boolean", + "description": "<p>Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.</p>" + } + } + }, + "AutoTuneState": { + "type": "string", + "description": "AutoTuneState enum", + "enum": [ + "DISABLED", + "DISABLED_AND_ROLLBACK_COMPLETE", + "DISABLED_AND_ROLLBACK_ERROR", + "DISABLED_AND_ROLLBACK_IN_PROGRESS", + "DISABLED_AND_ROLLBACK_SCHEDULED", + "DISABLE_IN_PROGRESS", + "ENABLED", + "ENABLE_IN_PROGRESS", + "ERROR" + ], + "x-ms-enum": { + "name": "AutoTuneState", + "modelAsString": true, + "values": [ + { + "name": "DISABLED", + "value": "DISABLED", + "description": "AutoTuneState enum DISABLED" + }, + { + "name": "DISABLED_AND_ROLLBACK_COMPLETE", + "value": "DISABLED_AND_ROLLBACK_COMPLETE", + "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_COMPLETE" + }, + { + "name": "DISABLED_AND_ROLLBACK_ERROR", + "value": "DISABLED_AND_ROLLBACK_ERROR", + "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_ERROR" + }, + { + "name": "DISABLED_AND_ROLLBACK_IN_PROGRESS", + "value": "DISABLED_AND_ROLLBACK_IN_PROGRESS", + "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_IN_PROGRESS" + }, + { + "name": "DISABLED_AND_ROLLBACK_SCHEDULED", + "value": "DISABLED_AND_ROLLBACK_SCHEDULED", + "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_SCHEDULED" + }, + { + "name": "DISABLE_IN_PROGRESS", + "value": "DISABLE_IN_PROGRESS", + "description": "AutoTuneState enum DISABLE_IN_PROGRESS" + }, + { + "name": "ENABLED", + "value": "ENABLED", + "description": "AutoTuneState enum ENABLED" + }, + { + "name": "ENABLE_IN_PROGRESS", + "value": "ENABLE_IN_PROGRESS", + "description": "AutoTuneState enum ENABLE_IN_PROGRESS" + }, + { + "name": "ERROR", + "value": "ERROR", + "description": "AutoTuneState enum ERROR" + } + ] + } + }, + "AutoTuneStateEnumValue": { + "type": "object", + "description": "Definition of AutoTuneStateEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/AutoTuneState", + "description": "Property value" + } + } + }, + "AwsOpenSearchDomainStatusProperties": { + "type": "object", + "description": "Definition of awsOpenSearchDomainStatus", + "properties": { + "arn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the domain. For more information, see <a href='https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html'>IAM identifiers </a> in the <i>AWS Identity and Access Management User Guide</i>.</p>" + }, + "accessPolicies": { + "type": "string", + "description": "<p>Identity and Access Management (IAM) policy document specifying the access policies for the domain.</p>" + }, + "advancedOptions": { + "type": "object", + "description": "<p>Key-value pairs that specify advanced configuration options.</p>", + "additionalProperties": { + "type": "string" + } + }, + "advancedSecurityOptions": { + "$ref": "#/definitions/AdvancedSecurityOptions", + "description": "<p>Settings for fine-grained access control.</p>" + }, + "autoTuneOptions": { + "$ref": "#/definitions/AutoTuneOptionsOutput", + "description": "<p>Auto-Tune settings for the domain.</p>" + }, + "changeProgressDetails": { + "$ref": "#/definitions/ChangeProgressDetails", + "description": "<p>Information about a configuration change happening on the domain.</p>" + }, + "clusterConfig": { + "$ref": "#/definitions/ClusterConfig", + "description": "<p>Container for the cluster configuration of the domain.</p>" + }, + "cognitoOptions": { + "$ref": "#/definitions/CognitoOptions", + "description": "<p>Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.</p>" + }, + "created": { + "type": "boolean", + "description": "<p>Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.</p>" + }, + "deleted": { + "type": "boolean", + "description": "<p>Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.</p>" + }, + "domainEndpointOptions": { + "$ref": "#/definitions/DomainEndpointOptions", + "description": "<p>Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.</p>" + }, + "domainId": { + "type": "string", + "description": "<p>Unique identifier for the domain.</p>" + }, + "domainName": { + "type": "string", + "description": "<p>Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.</p>" + }, + "domainProcessingStatus": { + "$ref": "#/definitions/DomainProcessingStatusTypeEnumValue", + "description": "<p>The status of any changes that are currently in progress for the domain.</p>" + }, + "ebsOptions": { + "$ref": "#/definitions/EBSOptions", + "description": "<p>Container for EBS-based storage settings for the domain.</p>" + }, + "encryptionAtRestOptions": { + "$ref": "#/definitions/EncryptionAtRestOptions", + "description": "<p>Encryption at rest settings for the domain.</p>" + }, + "endpoint": { + "type": "string", + "description": "<p>Domain-specific endpoint used to submit index, search, and data upload requests to the domain.</p>" + }, + "endpointV2": { + "type": "string", + "description": "<p>If <code>IPAddressType</code> to set to <code>dualstack</code>, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. </p>" + }, + "endpoints": { + "type": "object", + "description": "<p>The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example <code>key, value</code>: <code>'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'</code>.</p>", + "additionalProperties": { + "type": "string" + } + }, + "engineVersion": { + "type": "string", + "description": "<p>Version of OpenSearch or Elasticsearch that the domain is running, in the format <code>Elasticsearch_X.Y</code> or <code>OpenSearch_X.Y</code>.</p>" + }, + "ipAddressType": { + "$ref": "#/definitions/IPAddressTypeEnumValue", + "description": "<p>The type of IP addresses supported by the endpoint for the domain.</p>" + }, + "logPublishingOptions": { + "type": "object", + "description": "<p>Log publishing options for the domain.</p>", + "additionalProperties": { + "$ref": "#/definitions/LogPublishingOption" + } + }, + "modifyingProperties": { + "type": "array", + "description": "<p>Information about the domain properties that are currently being modified.</p>", + "items": { + "$ref": "#/definitions/ModifyingProperties" + }, + "x-ms-identifiers": [] + }, + "nodeToNodeEncryptionOptions": { + "$ref": "#/definitions/NodeToNodeEncryptionOptions", + "description": "<p>Whether node-to-node encryption is enabled or disabled.</p>" + }, + "offPeakWindowOptions": { + "$ref": "#/definitions/OffPeakWindowOptions", + "description": "<p>Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.</p>" + }, + "processing": { + "type": "boolean", + "description": "<p>The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.</p>" + }, + "serviceSoftwareOptions": { + "$ref": "#/definitions/ServiceSoftwareOptions", + "description": "<p>The current status of the domain's service software.</p>" + }, + "snapshotOptions": { + "$ref": "#/definitions/SnapshotOptions", + "description": "<p>DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.</p>" + }, + "softwareUpdateOptions": { + "$ref": "#/definitions/SoftwareUpdateOptions", + "description": "<p>Service software update options for the domain.</p>" + }, + "upgradeProcessing": { + "type": "boolean", + "description": "<p>The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.</p>" + }, + "vpcOptions": { + "$ref": "#/definitions/VPCDerivedInfo", + "description": "<p>The VPC configuration for the domain.</p>" + } + } + }, + "ChangeProgressDetails": { + "type": "object", + "description": "Definition of ChangeProgressDetails", + "properties": { + "changeId": { + "type": "string", + "description": "<p>The ID of the configuration change.</p>" + }, + "configChangeStatus": { + "$ref": "#/definitions/ConfigChangeStatusEnumValue", + "description": "<p>The current status of the configuration change.</p>" + }, + "initiatedBy": { + "$ref": "#/definitions/InitiatedByEnumValue", + "description": "<p>The IAM principal who initiated the configuration change.</p>" + }, + "lastUpdatedTime": { + "type": "string", + "format": "date-time", + "description": "<p>The last time that the configuration change was updated.</p>" + }, + "message": { + "type": "string", + "description": "<p>A message corresponding to the status of the configuration change.</p>" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time that the configuration change was initiated, in Universal Coordinated Time (UTC).</p>" + } + } + }, + "ClusterConfig": { + "type": "object", + "description": "Definition of ClusterConfig", + "properties": { + "coldStorageOptions": { + "$ref": "#/definitions/ColdStorageOptions", + "description": "<p>Container for cold storage configuration options.</p>" + }, + "dedicatedMasterCount": { + "type": "integer", + "format": "int32", + "description": "<p>Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.</p>" + }, + "dedicatedMasterEnabled": { + "type": "boolean", + "description": "<p>Indicates whether dedicated master nodes are enabled for the cluster.<code>True</code> if the cluster will use a dedicated master node.<code>False</code> if the cluster will not.</p>" + }, + "dedicatedMasterType": { + "$ref": "#/definitions/OpenSearchPartitionInstanceTypeEnumValue", + "description": "<p>OpenSearch Service instance type of the dedicated master nodes in the cluster.</p>" + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "description": "<p>Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.</p>" + }, + "instanceType": { + "$ref": "#/definitions/OpenSearchPartitionInstanceTypeEnumValue", + "description": "<p>Instance type of data nodes in the cluster.</p>" + }, + "multiAZWithStandbyEnabled": { + "type": "boolean", + "description": "<p>A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'>Configuring a multi-AZ domain in Amazon OpenSearch Service</a>. </p>" + }, + "warmCount": { + "type": "integer", + "format": "int32", + "description": "<p>The number of warm nodes in the cluster.</p>" + }, + "warmEnabled": { + "type": "boolean", + "description": "<p>Whether to enable warm storage for the cluster.</p>" + }, + "warmType": { + "$ref": "#/definitions/OpenSearchWarmPartitionInstanceTypeEnumValue", + "description": "<p>The instance type for the cluster's warm nodes.</p>" + }, + "zoneAwarenessConfig": { + "$ref": "#/definitions/ZoneAwarenessConfig", + "description": "<p>Container for zone awareness configuration options. Only required if <code>ZoneAwarenessEnabled</code> is <code>true</code>.</p>" + }, + "zoneAwarenessEnabled": { + "type": "boolean", + "description": "<p>Indicates whether multiple Availability Zones are enabled. For more information, see <a href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'>Configuring a multi-AZ domain in Amazon OpenSearch Service</a>.</p>" + } + } + }, + "CognitoOptions": { + "type": "object", + "description": "Definition of CognitoOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.</p>" + }, + "identityPoolId": { + "type": "string", + "description": "<p>The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>" + }, + "roleArn": { + "type": "string", + "description": "<p>The <code>AmazonOpenSearchServiceCognitoAccess</code> role that allows OpenSearch Service to configure your user pool and identity pool.</p>" + }, + "userPoolId": { + "type": "string", + "description": "<p>The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.</p>" + } + } + }, + "ColdStorageOptions": { + "type": "object", + "description": "Definition of ColdStorageOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.</p>" + } + } + }, + "ConfigChangeStatus": { + "type": "string", + "description": "ConfigChangeStatus enum", + "enum": [ + "ApplyingChanges", + "Cancelled", + "Completed", + "Initializing", + "Pending", + "PendingUserInput", + "Validating", + "ValidationFailed" + ], + "x-ms-enum": { + "name": "ConfigChangeStatus", + "modelAsString": true, + "values": [ + { + "name": "ApplyingChanges", + "value": "ApplyingChanges", + "description": "ConfigChangeStatus enum ApplyingChanges" + }, + { + "name": "Cancelled", + "value": "Cancelled", + "description": "ConfigChangeStatus enum Cancelled" + }, + { + "name": "Completed", + "value": "Completed", + "description": "ConfigChangeStatus enum Completed" + }, + { + "name": "Initializing", + "value": "Initializing", + "description": "ConfigChangeStatus enum Initializing" + }, + { + "name": "Pending", + "value": "Pending", + "description": "ConfigChangeStatus enum Pending" + }, + { + "name": "PendingUserInput", + "value": "PendingUserInput", + "description": "ConfigChangeStatus enum PendingUserInput" + }, + { + "name": "Validating", + "value": "Validating", + "description": "ConfigChangeStatus enum Validating" + }, + { + "name": "ValidationFailed", + "value": "ValidationFailed", + "description": "ConfigChangeStatus enum ValidationFailed" + } + ] + } + }, + "ConfigChangeStatusEnumValue": { + "type": "object", + "description": "Definition of ConfigChangeStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ConfigChangeStatus", + "description": "Property value" + } + } + }, + "DeploymentStatus": { + "type": "string", + "description": "DeploymentStatus enum", + "enum": [ + "COMPLETED", + "ELIGIBLE", + "IN_PROGRESS", + "NOT_ELIGIBLE", + "PENDING_UPDATE" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true, + "values": [ + { + "name": "COMPLETED", + "value": "COMPLETED", + "description": "DeploymentStatus enum COMPLETED" + }, + { + "name": "ELIGIBLE", + "value": "ELIGIBLE", + "description": "DeploymentStatus enum ELIGIBLE" + }, + { + "name": "IN_PROGRESS", + "value": "IN_PROGRESS", + "description": "DeploymentStatus enum IN_PROGRESS" + }, + { + "name": "NOT_ELIGIBLE", + "value": "NOT_ELIGIBLE", + "description": "DeploymentStatus enum NOT_ELIGIBLE" + }, + { + "name": "PENDING_UPDATE", + "value": "PENDING_UPDATE", + "description": "DeploymentStatus enum PENDING_UPDATE" + } + ] + } + }, + "DeploymentStatusEnumValue": { + "type": "object", + "description": "Definition of DeploymentStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Property value" + } + } + }, + "DomainEndpointOptions": { + "type": "object", + "description": "Definition of DomainEndpointOptions", + "properties": { + "customEndpoint": { + "type": "string", + "description": "<p>The fully qualified URL for the custom endpoint.</p>" + }, + "customEndpointCertificateArn": { + "type": "string", + "description": "<p>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</p>" + }, + "customEndpointEnabled": { + "type": "boolean", + "description": "<p>Whether to enable a custom endpoint for the domain.</p>" + }, + "enforceHTTPS": { + "type": "boolean", + "description": "<p>True to require that all traffic to the domain arrive over HTTPS.</p>" + }, + "tlsSecurityPolicy": { + "$ref": "#/definitions/TLSSecurityPolicyEnumValue", + "description": "<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:</p> <ul> <li> <p> <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that supports only TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p> </li> </ul>" + } + } + }, + "DomainProcessingStatusType": { + "type": "string", + "description": "DomainProcessingStatusType enum", + "enum": [ + "Active", + "Creating", + "Deleting", + "Isolated", + "Modifying", + "UpdatingServiceSoftware", + "UpgradingEngineVersion" + ], + "x-ms-enum": { + "name": "DomainProcessingStatusType", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "DomainProcessingStatusType enum Active" + }, + { + "name": "Creating", + "value": "Creating", + "description": "DomainProcessingStatusType enum Creating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "DomainProcessingStatusType enum Deleting" + }, + { + "name": "Isolated", + "value": "Isolated", + "description": "DomainProcessingStatusType enum Isolated" + }, + { + "name": "Modifying", + "value": "Modifying", + "description": "DomainProcessingStatusType enum Modifying" + }, + { + "name": "UpdatingServiceSoftware", + "value": "UpdatingServiceSoftware", + "description": "DomainProcessingStatusType enum UpdatingServiceSoftware" + }, + { + "name": "UpgradingEngineVersion", + "value": "UpgradingEngineVersion", + "description": "DomainProcessingStatusType enum UpgradingEngineVersion" + } + ] + } + }, + "DomainProcessingStatusTypeEnumValue": { + "type": "object", + "description": "Definition of DomainProcessingStatusTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/DomainProcessingStatusType", + "description": "Property value" + } + } + }, + "EBSOptions": { + "type": "object", + "description": "Definition of EBSOptions", + "properties": { + "ebsEnabled": { + "type": "boolean", + "description": "<p>Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.</p>" + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> and provisioned IOPS EBS volume types.</p>" + }, + "throughput": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the <code>gp3</code> volume type.</p>" + }, + "volumeSize": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the size (in GiB) of EBS volumes attached to data nodes.</p>" + }, + "volumeType": { + "$ref": "#/definitions/VolumeTypeEnumValue", + "description": "<p>Specifies the type of EBS volumes attached to data nodes.</p>" + } + } + }, + "EncryptionAtRestOptions": { + "type": "object", + "description": "Definition of EncryptionAtRestOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>True to enable encryption at rest.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>The KMS key ID. Takes the form <code>1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a</code>.</p>" + } + } + }, + "IPAddressType": { + "type": "string", + "description": "IPAddressType enum", + "enum": [ + "dualstack", + "ipv4" + ], + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "name": "Dualstack", + "value": "dualstack", + "description": "IPAddressType enum dualstack" + }, + { + "name": "Ipv4", + "value": "ipv4", + "description": "IPAddressType enum ipv4" + } + ] + } + }, + "IPAddressTypeEnumValue": { + "type": "object", + "description": "Definition of IPAddressTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/IPAddressType", + "description": "Property value" + } + } + }, + "InitiatedBy": { + "type": "string", + "description": "InitiatedBy enum", + "enum": [ + "CUSTOMER", + "SERVICE" + ], + "x-ms-enum": { + "name": "InitiatedBy", + "modelAsString": true, + "values": [ + { + "name": "CUSTOMER", + "value": "CUSTOMER", + "description": "InitiatedBy enum CUSTOMER" + }, + { + "name": "SERVICE", + "value": "SERVICE", + "description": "InitiatedBy enum SERVICE" + } + ] + } + }, + "InitiatedByEnumValue": { + "type": "object", + "description": "Definition of InitiatedByEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InitiatedBy", + "description": "Property value" + } + } + }, + "LogPublishingOption": { + "type": "object", + "description": "Definition of LogPublishingOption", + "properties": { + "cloudWatchLogsLogGroupArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.</p>" + }, + "enabled": { + "type": "boolean", + "description": "<p>Whether the log should be published.</p>" + } + } + }, + "ModifyingProperties": { + "type": "object", + "description": "Definition of ModifyingProperties", + "properties": { + "activeValue": { + "type": "string", + "description": "<p>The current value of the domain property that is being modified.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name of the property that is currently being modified.</p>" + }, + "pendingValue": { + "type": "string", + "description": "<p>The value that the property that is currently being modified will eventually have.</p>" + }, + "valueType": { + "$ref": "#/definitions/PropertyValueTypeEnumValue", + "description": "<p>The type of value that is currently being modified. Properties can have two types:</p> <ul> <li> <p> <code>PLAIN_TEXT</code>: Contain direct values such as '1', 'True', or 'c5.large.search'.</p> </li> <li> <p> <code>STRINGIFIED_JSON</code>: Contain content in JSON format, such as {'Enabled':'True'}'.</p> </li> </ul>" + } + } + }, + "NodeToNodeEncryptionOptions": { + "type": "object", + "description": "Definition of NodeToNodeEncryptionOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>True to enable node-to-node encryption.</p>" + } + } + }, + "OffPeakWindow": { + "type": "object", + "description": "Definition of OffPeakWindow", + "properties": { + "windowStartTime": { + "$ref": "#/definitions/WindowStartTime", + "description": "<p>A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.</p>" + } + } + }, + "OffPeakWindowOptions": { + "type": "object", + "description": "Definition of OffPeakWindowOptions", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>Whether to enable an off-peak window.</p> <p>This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.</p>" + }, + "offPeakWindow": { + "$ref": "#/definitions/OffPeakWindow", + "description": "<p>Off-peak window settings for the domain.</p>" + } + } + }, + "OpenSearchDomainStatus": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/OpenSearchDomainStatusProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OpenSearchDomainStatusListResult": { + "type": "object", + "description": "The response of a OpenSearchDomainStatus list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OpenSearchDomainStatus items on this page", + "items": { + "$ref": "#/definitions/OpenSearchDomainStatus" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OpenSearchDomainStatusProperties": { + "type": "object", + "description": "Definition of OpenSearchDomainStatus", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsOpenSearchDomainStatusProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "OpenSearchDomainStatusTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in OpenSearchDomainStatus resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OpenSearchPartitionInstanceType": { + "type": "string", + "description": "OpenSearchPartitionInstanceType enum", + "enum": [ + "c4.2xlarge.search", + "c4.4xlarge.search", + "c4.8xlarge.search", + "c4.large.search", + "c4.xlarge.search", + "c5.18xlarge.search", + "c5.2xlarge.search", + "c5.4xlarge.search", + "c5.9xlarge.search", + "c5.large.search", + "c5.xlarge.search", + "c6g.12xlarge.search", + "c6g.2xlarge.search", + "c6g.4xlarge.search", + "c6g.8xlarge.search", + "c6g.large.search", + "c6g.xlarge.search", + "d2.2xlarge.search", + "d2.4xlarge.search", + "d2.8xlarge.search", + "d2.xlarge.search", + "i2.2xlarge.search", + "i2.xlarge.search", + "i3.16xlarge.search", + "i3.2xlarge.search", + "i3.4xlarge.search", + "i3.8xlarge.search", + "i3.large.search", + "i3.xlarge.search", + "m3.2xlarge.search", + "m3.large.search", + "m3.medium.search", + "m3.xlarge.search", + "m4.10xlarge.search", + "m4.2xlarge.search", + "m4.4xlarge.search", + "m4.large.search", + "m4.xlarge.search", + "m5.12xlarge.search", + "m5.24xlarge.search", + "m5.2xlarge.search", + "m5.4xlarge.search", + "m5.large.search", + "m5.xlarge.search", + "m6g.12xlarge.search", + "m6g.2xlarge.search", + "m6g.4xlarge.search", + "m6g.8xlarge.search", + "m6g.large.search", + "m6g.xlarge.search", + "or1.12xlarge.search", + "or1.16xlarge.search", + "or1.2xlarge.search", + "or1.4xlarge.search", + "or1.8xlarge.search", + "or1.large.search", + "or1.medium.search", + "or1.xlarge.search", + "r3.2xlarge.search", + "r3.4xlarge.search", + "r3.8xlarge.search", + "r3.large.search", + "r3.xlarge.search", + "r4.16xlarge.search", + "r4.2xlarge.search", + "r4.4xlarge.search", + "r4.8xlarge.search", + "r4.large.search", + "r4.xlarge.search", + "r5.12xlarge.search", + "r5.24xlarge.search", + "r5.2xlarge.search", + "r5.4xlarge.search", + "r5.large.search", + "r5.xlarge.search", + "r6g.12xlarge.search", + "r6g.2xlarge.search", + "r6g.4xlarge.search", + "r6g.8xlarge.search", + "r6g.large.search", + "r6g.xlarge.search", + "r6gd.12xlarge.search", + "r6gd.16xlarge.search", + "r6gd.2xlarge.search", + "r6gd.4xlarge.search", + "r6gd.8xlarge.search", + "r6gd.large.search", + "r6gd.xlarge.search", + "t2.medium.search", + "t2.micro.search", + "t2.small.search", + "t3.2xlarge.search", + "t3.large.search", + "t3.medium.search", + "t3.micro.search", + "t3.nano.search", + "t3.small.search", + "t3.xlarge.search", + "t4g.medium.search", + "t4g.small.search", + "ultrawarm1.large.search", + "ultrawarm1.medium.search", + "ultrawarm1.xlarge.search" + ], + "x-ms-enum": { + "name": "OpenSearchPartitionInstanceType", + "modelAsString": true, + "values": [ + { + "name": "C42xlargeSearch", + "value": "c4.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c4.2xlarge.search" + }, + { + "name": "C44xlargeSearch", + "value": "c4.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c4.4xlarge.search" + }, + { + "name": "C48xlargeSearch", + "value": "c4.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c4.8xlarge.search" + }, + { + "name": "C4LargeSearch", + "value": "c4.large.search", + "description": "OpenSearchPartitionInstanceType enum c4.large.search" + }, + { + "name": "C4XlargeSearch", + "value": "c4.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c4.xlarge.search" + }, + { + "name": "C518xlargeSearch", + "value": "c5.18xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c5.18xlarge.search" + }, + { + "name": "C52xlargeSearch", + "value": "c5.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c5.2xlarge.search" + }, + { + "name": "C54xlargeSearch", + "value": "c5.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c5.4xlarge.search" + }, + { + "name": "C59xlargeSearch", + "value": "c5.9xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c5.9xlarge.search" + }, + { + "name": "C5LargeSearch", + "value": "c5.large.search", + "description": "OpenSearchPartitionInstanceType enum c5.large.search" + }, + { + "name": "C5XlargeSearch", + "value": "c5.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c5.xlarge.search" + }, + { + "name": "C6g12xlargeSearch", + "value": "c6g.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c6g.12xlarge.search" + }, + { + "name": "C6g2xlargeSearch", + "value": "c6g.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c6g.2xlarge.search" + }, + { + "name": "C6g4xlargeSearch", + "value": "c6g.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c6g.4xlarge.search" + }, + { + "name": "C6g8xlargeSearch", + "value": "c6g.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c6g.8xlarge.search" + }, + { + "name": "C6gLargeSearch", + "value": "c6g.large.search", + "description": "OpenSearchPartitionInstanceType enum c6g.large.search" + }, + { + "name": "C6gXlargeSearch", + "value": "c6g.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum c6g.xlarge.search" + }, + { + "name": "D22xlargeSearch", + "value": "d2.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum d2.2xlarge.search" + }, + { + "name": "D24xlargeSearch", + "value": "d2.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum d2.4xlarge.search" + }, + { + "name": "D28xlargeSearch", + "value": "d2.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum d2.8xlarge.search" + }, + { + "name": "D2XlargeSearch", + "value": "d2.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum d2.xlarge.search" + }, + { + "name": "I22xlargeSearch", + "value": "i2.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i2.2xlarge.search" + }, + { + "name": "I2XlargeSearch", + "value": "i2.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i2.xlarge.search" + }, + { + "name": "I316xlargeSearch", + "value": "i3.16xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i3.16xlarge.search" + }, + { + "name": "I32xlargeSearch", + "value": "i3.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i3.2xlarge.search" + }, + { + "name": "I34xlargeSearch", + "value": "i3.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i3.4xlarge.search" + }, + { + "name": "I38xlargeSearch", + "value": "i3.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i3.8xlarge.search" + }, + { + "name": "I3LargeSearch", + "value": "i3.large.search", + "description": "OpenSearchPartitionInstanceType enum i3.large.search" + }, + { + "name": "I3XlargeSearch", + "value": "i3.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum i3.xlarge.search" + }, + { + "name": "M32xlargeSearch", + "value": "m3.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m3.2xlarge.search" + }, + { + "name": "M3LargeSearch", + "value": "m3.large.search", + "description": "OpenSearchPartitionInstanceType enum m3.large.search" + }, + { + "name": "M3MediumSearch", + "value": "m3.medium.search", + "description": "OpenSearchPartitionInstanceType enum m3.medium.search" + }, + { + "name": "M3XlargeSearch", + "value": "m3.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m3.xlarge.search" + }, + { + "name": "M410xlargeSearch", + "value": "m4.10xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m4.10xlarge.search" + }, + { + "name": "M42xlargeSearch", + "value": "m4.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m4.2xlarge.search" + }, + { + "name": "M44xlargeSearch", + "value": "m4.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m4.4xlarge.search" + }, + { + "name": "M4LargeSearch", + "value": "m4.large.search", + "description": "OpenSearchPartitionInstanceType enum m4.large.search" + }, + { + "name": "M4XlargeSearch", + "value": "m4.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m4.xlarge.search" + }, + { + "name": "M512xlargeSearch", + "value": "m5.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m5.12xlarge.search" + }, + { + "name": "M524xlargeSearch", + "value": "m5.24xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m5.24xlarge.search" + }, + { + "name": "M52xlargeSearch", + "value": "m5.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m5.2xlarge.search" + }, + { + "name": "M54xlargeSearch", + "value": "m5.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m5.4xlarge.search" + }, + { + "name": "M5LargeSearch", + "value": "m5.large.search", + "description": "OpenSearchPartitionInstanceType enum m5.large.search" + }, + { + "name": "M5XlargeSearch", + "value": "m5.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m5.xlarge.search" + }, + { + "name": "M6g12xlargeSearch", + "value": "m6g.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m6g.12xlarge.search" + }, + { + "name": "M6g2xlargeSearch", + "value": "m6g.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m6g.2xlarge.search" + }, + { + "name": "M6g4xlargeSearch", + "value": "m6g.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m6g.4xlarge.search" + }, + { + "name": "M6g8xlargeSearch", + "value": "m6g.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m6g.8xlarge.search" + }, + { + "name": "M6gLargeSearch", + "value": "m6g.large.search", + "description": "OpenSearchPartitionInstanceType enum m6g.large.search" + }, + { + "name": "M6gXlargeSearch", + "value": "m6g.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum m6g.xlarge.search" + }, + { + "name": "Or112xlargeSearch", + "value": "or1.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.12xlarge.search" + }, + { + "name": "Or116xlargeSearch", + "value": "or1.16xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.16xlarge.search" + }, + { + "name": "Or12xlargeSearch", + "value": "or1.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.2xlarge.search" + }, + { + "name": "Or14xlargeSearch", + "value": "or1.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.4xlarge.search" + }, + { + "name": "Or18xlargeSearch", + "value": "or1.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.8xlarge.search" + }, + { + "name": "Or1LargeSearch", + "value": "or1.large.search", + "description": "OpenSearchPartitionInstanceType enum or1.large.search" + }, + { + "name": "Or1MediumSearch", + "value": "or1.medium.search", + "description": "OpenSearchPartitionInstanceType enum or1.medium.search" + }, + { + "name": "Or1XlargeSearch", + "value": "or1.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum or1.xlarge.search" + }, + { + "name": "R32xlargeSearch", + "value": "r3.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r3.2xlarge.search" + }, + { + "name": "R34xlargeSearch", + "value": "r3.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r3.4xlarge.search" + }, + { + "name": "R38xlargeSearch", + "value": "r3.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r3.8xlarge.search" + }, + { + "name": "R3LargeSearch", + "value": "r3.large.search", + "description": "OpenSearchPartitionInstanceType enum r3.large.search" + }, + { + "name": "R3XlargeSearch", + "value": "r3.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r3.xlarge.search" + }, + { + "name": "R416xlargeSearch", + "value": "r4.16xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r4.16xlarge.search" + }, + { + "name": "R42xlargeSearch", + "value": "r4.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r4.2xlarge.search" + }, + { + "name": "R44xlargeSearch", + "value": "r4.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r4.4xlarge.search" + }, + { + "name": "R48xlargeSearch", + "value": "r4.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r4.8xlarge.search" + }, + { + "name": "R4LargeSearch", + "value": "r4.large.search", + "description": "OpenSearchPartitionInstanceType enum r4.large.search" + }, + { + "name": "R4XlargeSearch", + "value": "r4.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r4.xlarge.search" + }, + { + "name": "R512xlargeSearch", + "value": "r5.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r5.12xlarge.search" + }, + { + "name": "R524xlargeSearch", + "value": "r5.24xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r5.24xlarge.search" + }, + { + "name": "R52xlargeSearch", + "value": "r5.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r5.2xlarge.search" + }, + { + "name": "R54xlargeSearch", + "value": "r5.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r5.4xlarge.search" + }, + { + "name": "R5LargeSearch", + "value": "r5.large.search", + "description": "OpenSearchPartitionInstanceType enum r5.large.search" + }, + { + "name": "R5XlargeSearch", + "value": "r5.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r5.xlarge.search" + }, + { + "name": "R6g12xlargeSearch", + "value": "r6g.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6g.12xlarge.search" + }, + { + "name": "R6g2xlargeSearch", + "value": "r6g.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6g.2xlarge.search" + }, + { + "name": "R6g4xlargeSearch", + "value": "r6g.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6g.4xlarge.search" + }, + { + "name": "R6g8xlargeSearch", + "value": "r6g.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6g.8xlarge.search" + }, + { + "name": "R6gLargeSearch", + "value": "r6g.large.search", + "description": "OpenSearchPartitionInstanceType enum r6g.large.search" + }, + { + "name": "R6gXlargeSearch", + "value": "r6g.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6g.xlarge.search" + }, + { + "name": "R6gd12xlargeSearch", + "value": "r6gd.12xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.12xlarge.search" + }, + { + "name": "R6gd16xlargeSearch", + "value": "r6gd.16xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.16xlarge.search" + }, + { + "name": "R6gd2xlargeSearch", + "value": "r6gd.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.2xlarge.search" + }, + { + "name": "R6gd4xlargeSearch", + "value": "r6gd.4xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.4xlarge.search" + }, + { + "name": "R6gd8xlargeSearch", + "value": "r6gd.8xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.8xlarge.search" + }, + { + "name": "R6gdLargeSearch", + "value": "r6gd.large.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.large.search" + }, + { + "name": "R6gdXlargeSearch", + "value": "r6gd.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum r6gd.xlarge.search" + }, + { + "name": "T2MediumSearch", + "value": "t2.medium.search", + "description": "OpenSearchPartitionInstanceType enum t2.medium.search" + }, + { + "name": "T2MicroSearch", + "value": "t2.micro.search", + "description": "OpenSearchPartitionInstanceType enum t2.micro.search" + }, + { + "name": "T2SmallSearch", + "value": "t2.small.search", + "description": "OpenSearchPartitionInstanceType enum t2.small.search" + }, + { + "name": "T32xlargeSearch", + "value": "t3.2xlarge.search", + "description": "OpenSearchPartitionInstanceType enum t3.2xlarge.search" + }, + { + "name": "T3LargeSearch", + "value": "t3.large.search", + "description": "OpenSearchPartitionInstanceType enum t3.large.search" + }, + { + "name": "T3MediumSearch", + "value": "t3.medium.search", + "description": "OpenSearchPartitionInstanceType enum t3.medium.search" + }, + { + "name": "T3MicroSearch", + "value": "t3.micro.search", + "description": "OpenSearchPartitionInstanceType enum t3.micro.search" + }, + { + "name": "T3NanoSearch", + "value": "t3.nano.search", + "description": "OpenSearchPartitionInstanceType enum t3.nano.search" + }, + { + "name": "T3SmallSearch", + "value": "t3.small.search", + "description": "OpenSearchPartitionInstanceType enum t3.small.search" + }, + { + "name": "T3XlargeSearch", + "value": "t3.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum t3.xlarge.search" + }, + { + "name": "T4gMediumSearch", + "value": "t4g.medium.search", + "description": "OpenSearchPartitionInstanceType enum t4g.medium.search" + }, + { + "name": "T4gSmallSearch", + "value": "t4g.small.search", + "description": "OpenSearchPartitionInstanceType enum t4g.small.search" + }, + { + "name": "Ultrawarm1LargeSearch", + "value": "ultrawarm1.large.search", + "description": "OpenSearchPartitionInstanceType enum ultrawarm1.large.search" + }, + { + "name": "Ultrawarm1MediumSearch", + "value": "ultrawarm1.medium.search", + "description": "OpenSearchPartitionInstanceType enum ultrawarm1.medium.search" + }, + { + "name": "Ultrawarm1XlargeSearch", + "value": "ultrawarm1.xlarge.search", + "description": "OpenSearchPartitionInstanceType enum ultrawarm1.xlarge.search" + } + ] + } + }, + "OpenSearchPartitionInstanceTypeEnumValue": { + "type": "object", + "description": "Definition of OpenSearchPartitionInstanceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/OpenSearchPartitionInstanceType", + "description": "Property value" + } + } + }, + "OpenSearchWarmPartitionInstanceType": { + "type": "string", + "description": "OpenSearchWarmPartitionInstanceType enum", + "enum": [ + "ultrawarm1.large.search", + "ultrawarm1.medium.search", + "ultrawarm1.xlarge.search" + ], + "x-ms-enum": { + "name": "OpenSearchWarmPartitionInstanceType", + "modelAsString": true, + "values": [ + { + "name": "Ultrawarm1LargeSearch", + "value": "ultrawarm1.large.search", + "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.large.search" + }, + { + "name": "Ultrawarm1MediumSearch", + "value": "ultrawarm1.medium.search", + "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.medium.search" + }, + { + "name": "Ultrawarm1XlargeSearch", + "value": "ultrawarm1.xlarge.search", + "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.xlarge.search" + } + ] + } + }, + "OpenSearchWarmPartitionInstanceTypeEnumValue": { + "type": "object", + "description": "Definition of OpenSearchWarmPartitionInstanceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/OpenSearchWarmPartitionInstanceType", + "description": "Property value" + } + } + }, + "PropertyValueType": { + "type": "string", + "description": "PropertyValueType enum", + "enum": [ + "PLAIN_TEXT", + "STRINGIFIED_JSON" + ], + "x-ms-enum": { + "name": "PropertyValueType", + "modelAsString": true, + "values": [ + { + "name": "PLAIN_TEXT", + "value": "PLAIN_TEXT", + "description": "PropertyValueType enum PLAIN_TEXT" + }, + { + "name": "STRINGIFIED_JSON", + "value": "STRINGIFIED_JSON", + "description": "PropertyValueType enum STRINGIFIED_JSON" + } + ] + } + }, + "PropertyValueTypeEnumValue": { + "type": "object", + "description": "Definition of PropertyValueTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PropertyValueType", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SAMLIdp": { + "type": "object", + "description": "Definition of SAMLIdp", + "properties": { + "entityId": { + "type": "string", + "description": "<p>The unique entity ID of the application in the SAML identity provider.</p>" + }, + "metadataContent": { + "type": "string", + "description": "<p>The metadata of the SAML application, in XML format.</p>" + } + } + }, + "SAMLOptionsOutput": { + "type": "object", + "description": "Definition of SAMLOptionsOutput", + "properties": { + "enabled": { + "type": "boolean", + "description": "<p>True if SAML is enabled.</p>" + }, + "idp": { + "$ref": "#/definitions/SAMLIdp", + "description": "<p>Describes the SAML identity provider's information.</p>" + }, + "rolesKey": { + "type": "string", + "description": "<p>The key used for matching the SAML roles attribute.</p>" + }, + "sessionTimeoutMinutes": { + "type": "integer", + "format": "int32", + "description": "<p>The duration, in minutes, after which a user session becomes inactive.</p>" + }, + "subjectKey": { + "type": "string", + "description": "<p>The key used for matching the SAML subject attribute.</p>" + } + } + }, + "ServiceSoftwareOptions": { + "type": "object", + "description": "Definition of ServiceSoftwareOptions", + "properties": { + "automatedUpdateDate": { + "type": "string", + "format": "date-time", + "description": "<p>The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.</p>" + }, + "cancellable": { + "type": "boolean", + "description": "<p> True if you're able to cancel your service software version update. False if you can't cancel your service software update.</p>" + }, + "currentVersion": { + "type": "string", + "description": "<p>The current service software version present on the domain.</p>" + }, + "description": { + "type": "string", + "description": "<p>A description of the service software update status.</p>" + }, + "newVersion": { + "type": "string", + "description": "<p>The new service software version, if one is available.</p>" + }, + "optionalDeployment": { + "type": "boolean", + "description": "<p>True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.</p>" + }, + "updateAvailable": { + "type": "boolean", + "description": "<p>True if you're able to update your service software version. False if you can't update your service software version.</p>" + }, + "updateStatus": { + "$ref": "#/definitions/DeploymentStatusEnumValue", + "description": "<p>The status of your service software update.</p>" + } + } + }, + "SnapshotOptions": { + "type": "object", + "description": "Definition of SnapshotOptions", + "properties": { + "automatedSnapshotStartHour": { + "type": "integer", + "format": "int32", + "description": "<p>The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is <code>0</code> hours.</p>" + } + } + }, + "SoftwareUpdateOptions": { + "type": "object", + "description": "Definition of SoftwareUpdateOptions", + "properties": { + "autoSoftwareUpdateEnabled": { + "type": "boolean", + "description": "<p>Whether automatic service software updates are enabled for the domain.</p>" + } + } + }, + "TLSSecurityPolicy": { + "type": "string", + "description": "TLSSecurityPolicy enum", + "enum": [ + "Policy-Min-TLS-1-0-2019-07", + "Policy-Min-TLS-1-2-2019-07", + "Policy-Min-TLS-1-2-PFS-2023-10" + ], + "x-ms-enum": { + "name": "TLSSecurityPolicy", + "modelAsString": true, + "values": [ + { + "name": "PolicyMinTLS10201907", + "value": "Policy-Min-TLS-1-0-2019-07", + "description": "TLSSecurityPolicy enum Policy-Min-TLS-1-0-2019-07" + }, + { + "name": "PolicyMinTLS12201907", + "value": "Policy-Min-TLS-1-2-2019-07", + "description": "TLSSecurityPolicy enum Policy-Min-TLS-1-2-2019-07" + }, + { + "name": "PolicyMinTLS12PFS202310", + "value": "Policy-Min-TLS-1-2-PFS-2023-10", + "description": "TLSSecurityPolicy enum Policy-Min-TLS-1-2-PFS-2023-10" + } + ] + } + }, + "TLSSecurityPolicyEnumValue": { + "type": "object", + "description": "Definition of TLSSecurityPolicyEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/TLSSecurityPolicy", + "description": "Property value" + } + } + }, + "VPCDerivedInfo": { + "type": "object", + "description": "Definition of VPCDerivedInfo", + "properties": { + "availabilityZones": { + "type": "array", + "description": "<p>The list of Availability Zones associated with the VPC subnets.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "securityGroupIds": { + "type": "array", + "description": "<p>The list of security group IDs associated with the VPC endpoints for the domain.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "subnetIds": { + "type": "array", + "description": "<p>A list of subnet IDs associated with the VPC endpoints for the domain.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "vpcId": { + "type": "string", + "description": "<p>The ID for your VPC. Amazon VPC generates this value when you create a VPC.</p>" + } + } + }, + "VolumeType": { + "type": "string", + "description": "VolumeType enum", + "enum": [ + "gp2", + "gp3", + "io1", + "standard" + ], + "x-ms-enum": { + "name": "VolumeType", + "modelAsString": true, + "values": [ + { + "name": "Gp2", + "value": "gp2", + "description": "VolumeType enum gp2" + }, + { + "name": "Gp3", + "value": "gp3", + "description": "VolumeType enum gp3" + }, + { + "name": "Io1", + "value": "io1", + "description": "VolumeType enum io1" + }, + { + "name": "Standard", + "value": "standard", + "description": "VolumeType enum standard" + } + ] + } + }, + "VolumeTypeEnumValue": { + "type": "object", + "description": "Definition of VolumeTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/VolumeType", + "description": "Property value" + } + } + }, + "WindowStartTime": { + "type": "object", + "description": "Definition of WindowStartTime", + "properties": { + "hours": { + "type": "integer", + "format": "int64", + "description": "<p>The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, <code>17</code> refers to 5:00 P.M. UTC.</p>" + }, + "minutes": { + "type": "integer", + "format": "int64", + "description": "<p>The start minute of the window, in UTC.</p>" + } + } + }, + "ZoneAwarenessConfig": { + "type": "object", + "description": "Definition of ZoneAwarenessConfig", + "properties": { + "availabilityZoneCount": { + "type": "integer", + "format": "int32", + "description": "<p>If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are <code>2</code> and <code>3</code>. If your domain is provisioned within a VPC, this value be equal to number of subnets.</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/operations.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/operations.json new file mode 100644 index 000000000000..0825599781ce --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.AwsConnector/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsAccount.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsAccount.json new file mode 100644 index 000000000000..aa417cc714f4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsAccount.json @@ -0,0 +1,659 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "OrganizationsAccounts" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/organizationsAccounts": { + "get": { + "operationId": "OrganizationsAccounts_ListBySubscription", + "tags": [ + "OrganizationsAccounts" + ], + "description": "List OrganizationsAccount resources 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/OrganizationsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsAccounts_ListBySubscription": { + "$ref": "./examples/OrganizationsAccounts_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/organizationsAccounts": { + "get": { + "operationId": "OrganizationsAccounts_ListByResourceGroup", + "tags": [ + "OrganizationsAccounts" + ], + "description": "List OrganizationsAccount resources 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/OrganizationsAccountListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsAccounts_ListByResourceGroup": { + "$ref": "./examples/OrganizationsAccounts_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/organizationsAccounts/{name}": { + "get": { + "operationId": "OrganizationsAccounts_Get", + "tags": [ + "OrganizationsAccounts" + ], + "description": "Get a OrganizationsAccount", + "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": "name", + "in": "path", + "description": "Name of OrganizationsAccount", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsAccount" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsAccounts_Get": { + "$ref": "./examples/OrganizationsAccounts_Get.json" + } + } + }, + "put": { + "operationId": "OrganizationsAccounts_CreateOrReplace", + "tags": [ + "OrganizationsAccounts" + ], + "description": "Create a OrganizationsAccount. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of OrganizationsAccount", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationsAccount" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OrganizationsAccount' update operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationsAccount" + } + }, + "201": { + "description": "Resource 'OrganizationsAccount' create operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationsAccount" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "OrganizationsAccounts_CreateOrReplace": { + "$ref": "./examples/OrganizationsAccounts_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OrganizationsAccounts_Update", + "tags": [ + "OrganizationsAccounts" + ], + "description": "Update a OrganizationsAccount", + "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": "name", + "in": "path", + "description": "Name of OrganizationsAccount", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationsAccountTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsAccount" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsAccounts_Update": { + "$ref": "./examples/OrganizationsAccounts_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OrganizationsAccounts_Delete", + "tags": [ + "OrganizationsAccounts" + ], + "description": "Delete a OrganizationsAccount", + "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": "name", + "in": "path", + "description": "Name of OrganizationsAccount", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "OrganizationsAccounts_Delete": { + "$ref": "./examples/OrganizationsAccounts_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsOrganizationsAccountProperties": { + "type": "object", + "description": "Definition of awsOrganizationsAccount", + "properties": { + "accountId": { + "type": "string", + "description": "If the account was created successfully, the unique identifier (ID) of the new account." + }, + "accountName": { + "type": "string", + "description": "The friendly name of the member account." + }, + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the account." + }, + "email": { + "type": "string", + "description": "The email address of the owner to assign to the new member account." + }, + "joinedMethod": { + "$ref": "#/definitions/JoinedMethod", + "description": "The method by which the account joined the organization." + }, + "joinedTimestamp": { + "type": "string", + "description": "The date the account became a part of the organization." + }, + "parentIds": { + "type": "array", + "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "roleName": { + "type": "string", + "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.", + "default": "OrganizationAccountAccessRole" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the account in the organization." + }, + "tags": { + "type": "array", + "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "JoinedMethod": { + "type": "string", + "description": "JoinedMethod enum", + "enum": [ + "CREATED", + "INVITED" + ], + "x-ms-enum": { + "name": "JoinedMethod", + "modelAsString": true, + "values": [ + { + "name": "CREATED", + "value": "CREATED", + "description": "JoinedMethod enum CREATED" + }, + { + "name": "INVITED", + "value": "INVITED", + "description": "JoinedMethod enum INVITED" + } + ] + } + }, + "OrganizationsAccount": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationsAccountProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OrganizationsAccountListResult": { + "type": "object", + "description": "The response of a OrganizationsAccount list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OrganizationsAccount items on this page", + "items": { + "$ref": "#/definitions/OrganizationsAccount" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OrganizationsAccountProperties": { + "type": "object", + "description": "Definition of OrganizationsAccount", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsOrganizationsAccountProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "OrganizationsAccountTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in OrganizationsAccount resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Status": { + "type": "string", + "description": "Status enum", + "enum": [ + "ACTIVE", + "PENDING_CLOSURE", + "SUSPENDED" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACTIVE", + "value": "ACTIVE", + "description": "Status enum ACTIVE" + }, + { + "name": "PENDING_CLOSURE", + "value": "PENDING_CLOSURE", + "description": "Status enum PENDING_CLOSURE" + }, + { + "name": "SUSPENDED", + "value": "SUSPENDED", + "description": "Status enum SUSPENDED" + } + ] + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key identifier, or name, of the tag." + }, + "value": { + "type": "string", + "description": "The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsOrganization.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsOrganization.json new file mode 100644 index 000000000000..435ed5546cfb --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/organizationsOrganization.json @@ -0,0 +1,615 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "OrganizationsOrganizations" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/organizationsOrganizations": { + "get": { + "operationId": "OrganizationsOrganizations_ListBySubscription", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "List OrganizationsOrganization resources 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/OrganizationsOrganizationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsOrganizations_ListBySubscription": { + "$ref": "./examples/OrganizationsOrganizations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/organizationsOrganizations": { + "get": { + "operationId": "OrganizationsOrganizations_ListByResourceGroup", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "List OrganizationsOrganization resources 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/OrganizationsOrganizationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsOrganizations_ListByResourceGroup": { + "$ref": "./examples/OrganizationsOrganizations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/organizationsOrganizations/{name}": { + "get": { + "operationId": "OrganizationsOrganizations_Get", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "Get a OrganizationsOrganization", + "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": "name", + "in": "path", + "description": "Name of OrganizationsOrganization", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsOrganization" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsOrganizations_Get": { + "$ref": "./examples/OrganizationsOrganizations_Get.json" + } + } + }, + "put": { + "operationId": "OrganizationsOrganizations_CreateOrReplace", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "Create a OrganizationsOrganization. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of OrganizationsOrganization", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationsOrganization" + } + } + ], + "responses": { + "200": { + "description": "Resource 'OrganizationsOrganization' update operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationsOrganization" + } + }, + "201": { + "description": "Resource 'OrganizationsOrganization' create operation succeeded", + "schema": { + "$ref": "#/definitions/OrganizationsOrganization" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "OrganizationsOrganizations_CreateOrReplace": { + "$ref": "./examples/OrganizationsOrganizations_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "OrganizationsOrganizations_Update", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "Update a OrganizationsOrganization", + "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": "name", + "in": "path", + "description": "Name of OrganizationsOrganization", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/OrganizationsOrganizationTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/OrganizationsOrganization" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OrganizationsOrganizations_Update": { + "$ref": "./examples/OrganizationsOrganizations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "OrganizationsOrganizations_Delete", + "tags": [ + "OrganizationsOrganizations" + ], + "description": "Delete a OrganizationsOrganization", + "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": "name", + "in": "path", + "description": "Name of OrganizationsOrganization", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "OrganizationsOrganizations_Delete": { + "$ref": "./examples/OrganizationsOrganizations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsOrganizationsOrganizationProperties": { + "type": "object", + "description": "Definition of awsOrganizationsOrganization", + "properties": { + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of an organization." + }, + "featureSet": { + "type": "string", + "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", + "default": "ALL", + "enum": [ + "ALL", + "CONSOLIDATED_BILLING" + ], + "x-ms-enum": { + "name": "FeatureSet", + "modelAsString": true, + "values": [ + { + "name": "ALL", + "value": "ALL", + "description": "FeatureSet enum ALL" + }, + { + "name": "CONSOLIDATED_BILLING", + "value": "CONSOLIDATED_BILLING", + "description": "FeatureSet enum CONSOLIDATED_BILLING" + } + ] + } + }, + "id": { + "type": "string", + "description": "The unique identifier (ID) of an organization." + }, + "managementAccountArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization." + }, + "managementAccountEmail": { + "type": "string", + "description": "The email address that is associated with the AWS account that is designated as the management account for the organization." + }, + "managementAccountId": { + "type": "string", + "description": "The unique identifier (ID) of the management account of an organization." + }, + "rootId": { + "type": "string", + "description": "The unique identifier (ID) for the root." + } + } + }, + "FeatureSet": { + "type": "string", + "description": "FeatureSet enum", + "enum": [ + "ALL", + "CONSOLIDATED_BILLING" + ], + "x-ms-enum": { + "name": "FeatureSet", + "modelAsString": true, + "values": [ + { + "name": "ALL", + "value": "ALL", + "description": "FeatureSet enum ALL" + }, + { + "name": "CONSOLIDATED_BILLING", + "value": "CONSOLIDATED_BILLING", + "description": "FeatureSet enum CONSOLIDATED_BILLING" + } + ] + } + }, + "OrganizationsOrganization": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/OrganizationsOrganizationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "OrganizationsOrganizationListResult": { + "type": "object", + "description": "The response of a OrganizationsOrganization list operation.", + "properties": { + "value": { + "type": "array", + "description": "The OrganizationsOrganization items on this page", + "items": { + "$ref": "#/definitions/OrganizationsOrganization" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "OrganizationsOrganizationProperties": { + "type": "object", + "description": "Definition of OrganizationsOrganization", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsOrganizationsOrganizationProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "OrganizationsOrganizationTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in OrganizationsOrganization resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBCluster.json new file mode 100644 index 000000000000..a1731a5dc196 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBCluster.json @@ -0,0 +1,925 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsDBClusters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsDBClusters": { + "get": { + "operationId": "RdsDbClusters_ListBySubscription", + "tags": [ + "RdsDBClusters" + ], + "description": "List RdsDBCluster resources 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/RdsDBClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbClusters_ListBySubscription": { + "$ref": "./examples/RdsDbClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBClusters": { + "get": { + "operationId": "RdsDbClusters_ListByResourceGroup", + "tags": [ + "RdsDBClusters" + ], + "description": "List RdsDBCluster resources 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/RdsDBClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbClusters_ListByResourceGroup": { + "$ref": "./examples/RdsDbClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBClusters/{name}": { + "get": { + "operationId": "RdsDbClusters_Get", + "tags": [ + "RdsDBClusters" + ], + "description": "Get a RdsDBCluster", + "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": "name", + "in": "path", + "description": "Name of RdsDBCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbClusters_Get": { + "$ref": "./examples/RdsDbClusters_Get.json" + } + } + }, + "put": { + "operationId": "RdsDbClusters_CreateOrReplace", + "tags": [ + "RdsDBClusters" + ], + "description": "Create a RdsDBCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsDBCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsDBCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBCluster" + } + }, + "201": { + "description": "Resource 'RdsDBCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsDbClusters_CreateOrReplace": { + "$ref": "./examples/RdsDbClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsDbClusters_Update", + "tags": [ + "RdsDBClusters" + ], + "description": "Update a RdsDBCluster", + "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": "name", + "in": "path", + "description": "Name of RdsDBCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBClusterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBCluster" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbClusters_Update": { + "$ref": "./examples/RdsDbClusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsDbClusters_Delete", + "tags": [ + "RdsDBClusters" + ], + "description": "Delete a RdsDBCluster", + "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": "name", + "in": "path", + "description": "Name of RdsDBCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsDbClusters_Delete": { + "$ref": "./examples/RdsDbClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsDBClusterProperties": { + "type": "object", + "description": "Definition of awsRdsDBCluster", + "properties": { + "allocatedStorage": { + "type": "integer", + "format": "int32", + "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." + }, + "associatedRoles": { + "type": "array", + "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.", + "items": { + "$ref": "#/definitions/DBClusterRole" + }, + "x-ms-identifiers": [] + }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically." + }, + "availabilityZones": { + "type": "array", + "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "backtrackWindow": { + "type": "integer", + "format": "int32", + "description": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." + }, + "backupRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days for which automated backups are retained.", + "default": 1 + }, + "copyTagsToSnapshot": { + "type": "boolean", + "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them." + }, + "dbClusterArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the DB cluster." + }, + "dbClusterIdentifier": { + "type": "string", + "description": "The DB cluster identifier. This parameter is stored as a lowercase string." + }, + "dbClusterInstanceClass": { + "type": "string", + "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge." + }, + "dbClusterParameterGroupName": { + "type": "string", + "description": "The name of the DB cluster parameter group to associate with this DB cluster.", + "default": "default.aurora5.6" + }, + "dbClusterResourceId": { + "type": "string", + "description": "The AWS Region-unique, immutable identifier for the DB cluster." + }, + "dbInstanceParameterGroupName": { + "type": "string", + "description": "The name of the DB parameter group to apply to all instances of the DB cluster." + }, + "dbSubnetGroupName": { + "type": "string", + "description": "A DB subnet group that you want to associate with this DB cluster." + }, + "dbSystemId": { + "type": "string", + "description": "Reserved for future use." + }, + "databaseName": { + "type": "string", + "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide." + }, + "deletionProtection": { + "type": "boolean", + "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled." + }, + "domain": { + "type": "string", + "description": "The Active Directory directory ID to create the DB cluster in." + }, + "domainIAMRoleName": { + "type": "string", + "description": "Specify the name of the IAM role to be used when making API calls to the Directory Service." + }, + "enableCloudwatchLogsExports": { + "type": "array", + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "enableGlobalWriteForwarding": { + "type": "boolean", + "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database." + }, + "enableHttpEndpoint": { + "type": "boolean", + "description": "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled." + }, + "enableIAMDatabaseAuthentication": { + "type": "boolean", + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled." + }, + "endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "Property endpoint" + }, + "engine": { + "type": "string", + "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql" + }, + "engineMode": { + "type": "string", + "description": "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster." + }, + "engineVersion": { + "type": "string", + "description": "The version number of the database engine to use." + }, + "globalClusterIdentifier": { + "type": "string", + "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.If you aren't configuring a global database cluster, don't specify this property." + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." + }, + "kmsKeyId": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true." + }, + "manageMasterUserPassword": { + "type": "boolean", + "description": "A value that indicates whether to manage the master user password with AWS Secrets Manager." + }, + "masterUserPassword": { + "type": "string", + "description": "The master password for the DB instance." + }, + "masterUserSecret": { + "$ref": "#/definitions/MasterUserSecret", + "description": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." + }, + "masterUsername": { + "type": "string", + "description": "The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername." + }, + "monitoringInterval": { + "type": "integer", + "format": "int32", + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0." + }, + "monitoringRoleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." + }, + "networkType": { + "type": "string", + "description": "The network type of the DB cluster." + }, + "performanceInsightsEnabled": { + "type": "boolean", + "description": "A value that indicates whether to turn on Performance Insights for the DB cluster." + }, + "performanceInsightsKmsKeyId": { + "type": "string", + "description": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data." + }, + "performanceInsightsRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in days, to retain Performance Insights data." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql." + }, + "preferredBackupWindow": { + "type": "string", + "description": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." + }, + "preferredMaintenanceWindow": { + "type": "string", + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." + }, + "publiclyAccessible": { + "type": "boolean", + "description": "A value that indicates whether the DB cluster is publicly accessible." + }, + "readEndpoint": { + "$ref": "#/definitions/ReadEndpoint", + "description": "Property readEndpoint" + }, + "replicationSourceIdentifier": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica." + }, + "restoreToTime": { + "type": "string", + "description": "The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z" + }, + "restoreType": { + "type": "string", + "description": "The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.", + "default": "full-copy" + }, + "scalingConfiguration": { + "$ref": "#/definitions/ScalingConfiguration", + "description": "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster." + }, + "serverlessV2ScalingConfiguration": { + "$ref": "#/definitions/ServerlessV2ScalingConfiguration", + "description": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster." + }, + "snapshotIdentifier": { + "type": "string", + "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted." + }, + "sourceDBClusterIdentifier": { + "type": "string", + "description": "The identifier of the source DB cluster from which to restore." + }, + "sourceRegion": { + "type": "string", + "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1." + }, + "storageEncrypted": { + "type": "boolean", + "description": "Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance." + }, + "storageThroughput": { + "type": "integer", + "format": "int32", + "description": "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type." + }, + "storageType": { + "type": "string", + "description": "Specifies the storage type to be associated with the DB cluster." + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "useLatestRestorableTime": { + "type": "boolean", + "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time." + }, + "vpcSecurityGroupIds": { + "type": "array", + "description": "A list of EC2 VPC security groups to associate with this DB cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "DBClusterRole": { + "type": "object", + "description": "Definition of DBClusterRole", + "properties": { + "featureName": { + "type": "string", + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference." + }, + "roleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." + } + } + }, + "Endpoint": { + "type": "object", + "description": "Definition of Endpoint", + "properties": { + "address": { + "type": "string", + "description": "The connection endpoint for the DB cluster." + }, + "port": { + "type": "string", + "description": "The port number that will accept connections on this DB cluster." + } + } + }, + "MasterUserSecret": { + "type": "object", + "description": "Definition of MasterUserSecret", + "properties": { + "kmsKeyId": { + "type": "string", + "description": "The AWS KMS key identifier that is used to encrypt the secret." + }, + "secretArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the secret." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsDBCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsDBClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsDBClusterListResult": { + "type": "object", + "description": "The response of a RdsDBCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsDBCluster items on this page", + "items": { + "$ref": "#/definitions/RdsDBCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsDBClusterProperties": { + "type": "object", + "description": "Definition of RdsDBCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsDBClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsDBClusterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsDBCluster resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ReadEndpoint": { + "type": "object", + "description": "Definition of ReadEndpoint", + "properties": { + "address": { + "type": "string", + "description": "The reader endpoint for the DB cluster." + } + } + }, + "ScalingConfiguration": { + "type": "object", + "description": "Definition of ScalingConfiguration", + "properties": { + "autoPause": { + "type": "boolean", + "description": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections)." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "description": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity." + }, + "minCapacity": { + "type": "integer", + "format": "int32", + "description": "The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity." + }, + "secondsBeforeTimeout": { + "type": "integer", + "format": "int32", + "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.The default is 300." + }, + "secondsUntilAutoPause": { + "type": "integer", + "format": "int32", + "description": "The time, in seconds, before an Aurora DB cluster in serverless mode is paused." + }, + "timeoutAction": { + "type": "string", + "description": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide." + } + } + }, + "ServerlessV2ScalingConfiguration": { + "type": "object", + "description": "Definition of ServerlessV2ScalingConfiguration", + "properties": { + "maxCapacity": { + "type": "number", + "format": "float", + "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128." + }, + "minCapacity": { + "type": "number", + "format": "float", + "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBInstance.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBInstance.json new file mode 100644 index 000000000000..27884db100ea --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBInstance.json @@ -0,0 +1,1011 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsDBInstances" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsDBInstances": { + "get": { + "operationId": "RdsDbInstances_ListBySubscription", + "tags": [ + "RdsDBInstances" + ], + "description": "List RdsDBInstance resources 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/RdsDBInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbInstances_ListBySubscription": { + "$ref": "./examples/RdsDbInstances_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBInstances": { + "get": { + "operationId": "RdsDbInstances_ListByResourceGroup", + "tags": [ + "RdsDBInstances" + ], + "description": "List RdsDBInstance resources 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/RdsDBInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbInstances_ListByResourceGroup": { + "$ref": "./examples/RdsDbInstances_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBInstances/{name}": { + "get": { + "operationId": "RdsDbInstances_Get", + "tags": [ + "RdsDBInstances" + ], + "description": "Get a RdsDBInstance", + "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": "name", + "in": "path", + "description": "Name of RdsDBInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbInstances_Get": { + "$ref": "./examples/RdsDbInstances_Get.json" + } + } + }, + "put": { + "operationId": "RdsDbInstances_CreateOrReplace", + "tags": [ + "RdsDBInstances" + ], + "description": "Create a RdsDBInstance. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsDBInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsDBInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBInstance" + } + }, + "201": { + "description": "Resource 'RdsDBInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBInstance" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsDbInstances_CreateOrReplace": { + "$ref": "./examples/RdsDbInstances_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsDbInstances_Update", + "tags": [ + "RdsDBInstances" + ], + "description": "Update a RdsDBInstance", + "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": "name", + "in": "path", + "description": "Name of RdsDBInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBInstanceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBInstance" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbInstances_Update": { + "$ref": "./examples/RdsDbInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsDbInstances_Delete", + "tags": [ + "RdsDBInstances" + ], + "description": "Delete a RdsDBInstance", + "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": "name", + "in": "path", + "description": "Name of RdsDBInstance", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsDbInstances_Delete": { + "$ref": "./examples/RdsDbInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsDBInstanceProperties": { + "type": "object", + "description": "Definition of awsRdsDBInstance", + "properties": { + "allocatedStorage": { + "type": "string", + "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). *Amazon Aurora* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. *MySQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *MariaDB* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *PostgreSQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *Oracle* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. *SQL Server* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024." + }, + "allowMajorVersionUpgrade": { + "type": "boolean", + "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version." + }, + "associatedRoles": { + "type": "array", + "description": "The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster.", + "items": { + "$ref": "#/definitions/DBInstanceRole" + }, + "x-ms-identifiers": [] + }, + "autoMinorVersionUpgrade": { + "type": "boolean", + "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically." + }, + "automaticBackupReplicationKmsKeyId": { + "type": "string", + "description": "Property automaticBackupReplicationKmsKeyId" + }, + "automaticBackupReplicationRegion": { + "type": "string", + "description": "The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*." + }, + "availabilityZone": { + "type": "string", + "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example: ``us-east-1d``" + }, + "backupRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas", + "default": 1 + }, + "caCertificateIdentifier": { + "type": "string", + "description": "The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." + }, + "certificateDetails": { + "$ref": "#/definitions/CertificateDetails", + "description": "The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." + }, + "certificateRotationRestart": { + "type": "boolean", + "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances." + }, + "characterSetName": { + "type": "string", + "description": "For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html)." + }, + "copyTagsToSnapshot": { + "type": "boolean", + "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting." + }, + "customIAMInstanceProfile": { + "type": "string", + "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*." + }, + "dbClusterIdentifier": { + "type": "string", + "description": "The identifier of the DB cluster that the instance will belong to." + }, + "dbClusterSnapshotIdentifier": { + "type": "string", + "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when ``DBSnapshotIdentifier`` is specified. + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot." + }, + "dbInstanceArn": { + "type": "string", + "description": "Property dbInstanceArn" + }, + "dbInstanceClass": { + "type": "string", + "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*." + }, + "dbInstanceIdentifier": { + "type": "string", + "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "dbName": { + "type": "string", + "description": "The meaning of this parameter differs according to the database engine you use. If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. Default: ``ORCL`` Constraints: + Can't be longer than 8 characters *SQL Server* Not applicable. Must be null." + }, + "dbParameterGroupName": { + "type": "string", + "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used." + }, + "dbSecurityGroups": { + "type": "array", + "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + ``AllocatedStorage`` + ``AutoMinorVersionUpgrade`` + ``AvailabilityZone`` + ``BackupRetentionPeriod`` + ``CharacterSetName`` + ``DBInstanceClass`` + ``DBName`` + ``DBParameterGroupName`` + ``DBSecurityGroups`` + ``DBSubnetGroupName`` + ``Engine`` + ``EngineVersion`` + ``Iops`` + ``LicenseModel`` + ``MasterUsername`` + ``MasterUserPassword`` + ``MultiAZ`` + ``OptionGroupName`` + ``PreferredBackupWindow`` + ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "dbSnapshotIdentifier": { + "type": "string", + "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + ``CharacterSetName`` + ``DBClusterIdentifier`` + ``DBName`` + ``DeleteAutomatedBackups`` + ``EnablePerformanceInsights`` + ``KmsKeyId`` + ``MasterUsername`` + ``MasterUserPassword`` + ``PerformanceInsightsKMSKeyId`` + ``PerformanceInsightsRetentionPeriod`` + ``PromotionTier`` + ``SourceDBInstanceIdentifier`` + ``SourceRegion`` + ``StorageEncrypted`` (for an encrypted snapshot) + ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster." + }, + "dbSubnetGroupName": { + "type": "string", + "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting." + }, + "dbSystemId": { + "type": "string", + "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB." + }, + "dbiResourceId": { + "type": "string", + "description": "Property dbiResourceId" + }, + "dedicatedLogVolume": { + "type": "boolean", + "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled." + }, + "deleteAutomatedBackups": { + "type": "boolean", + "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted." + }, + "deletionProtection": { + "type": "boolean", + "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster." + }, + "domain": { + "type": "string", + "description": "The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*." + }, + "domainAuthSecretArn": { + "type": "string", + "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``" + }, + "domainDnsIps": { + "type": "array", + "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "domainFqdn": { + "type": "string", + "description": "The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example: ``mymanagedADtest.mymanagedAD.mydomain``" + }, + "domainIAMRoleName": { + "type": "string", + "description": "The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom" + }, + "domainOu": { + "type": "string", + "description": "The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``" + }, + "enableCloudwatchLogsExports": { + "type": "array", + "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* Valid values: ``diag.log``, ``notify.log`` *MariaDB* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* Valid values: ``agent``, ``error`` *MySQL* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade``", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "enableIAMDatabaseAuthentication": { + "type": "boolean", + "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster." + }, + "enablePerformanceInsights": { + "type": "boolean", + "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances." + }, + "endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of ``creating``. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` + ``DescribeDBInstances`` + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``." + }, + "engine": { + "type": "string", + "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` or ``oracle-ee-cdb`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web``" + }, + "engineVersion": { + "type": "string", + "description": "The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. *Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* *MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* *PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*" + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance." + }, + "kmsKeyId": { + "type": "string", + "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The KMS key identifier is managed by the DB cluster." + }, + "licenseModel": { + "type": "string", + "description": "License model information for this DB instance. Valid Values: + Aurora MySQL - ``general-public-license`` + Aurora PostgreSQL - ``postgresql-license`` + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + RDS for MariaDB - ``general-public-license`` + RDS for Microsoft SQL Server - ``license-included`` + RDS for MySQL - ``general-public-license`` + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability." + }, + "manageMasterUserPassword": { + "type": "boolean", + "description": "Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified." + }, + "masterUserPassword": { + "type": "string", + "description": "The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters." + }, + "masterUserSecret": { + "$ref": "#/definitions/MasterUserSecret", + "description": "The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*" + }, + "masterUsername": { + "type": "string", + "description": "The master user name for the DB instance. If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. *Amazon Aurora* Not applicable. The name for the master user is managed by the DB cluster. *RDS for Db2* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MariaDB* Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for Oracle* Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for PostgreSQL* Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine." + }, + "maxAllocatedStorage": { + "type": "integer", + "format": "int32", + "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom" + }, + "monitoringInterval": { + "type": "integer", + "format": "int32", + "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: ``0, 1, 5, 10, 15, 30, 60``" + }, + "monitoringRoleArn": { + "type": "string", + "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances." + }, + "multiAZ": { + "type": "boolean", + "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set." + }, + "ncharCharacterSetName": { + "type": "string", + "description": "The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances." + }, + "networkType": { + "type": "string", + "description": "The network type of the DB instance. Valid values: + ``IPV4`` + ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*" + }, + "optionGroupName": { + "type": "string", + "description": "Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance." + }, + "performanceInsightsKMSKeyId": { + "type": "string", + "description": "The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)." + }, + "performanceInsightsRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error." + }, + "port": { + "type": "string", + "description": "The port number on which the database accepts connections. *Amazon Aurora* Not applicable. The port number is managed by the DB cluster. *Db2* Default value: ``50000``" + }, + "preferredBackupWindow": { + "type": "string", + "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: + Must be in the format ``hh24:mi-hh24:mi``. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster." + }, + "preferredMaintenanceWindow": { + "type": "string", + "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window." + }, + "processorFeatures": { + "type": "array", + "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.", + "items": { + "$ref": "#/definitions/ProcessorFeature" + }, + "x-ms-identifiers": [] + }, + "promotionTier": { + "type": "integer", + "format": "int32", + "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``", + "default": 1 + }, + "publiclyAccessible": { + "type": "boolean", + "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*." + }, + "replicaMode": { + "type": "string", + "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This setting is only supported in RDS for Oracle. Default: ``open-read-only`` Valid Values: ``open-read-only`` or ``mounted``" + }, + "restoreTime": { + "type": "string", + "description": "The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. Example: ``2009-09-07T23:45:00Z``" + }, + "sourceDBClusterIdentifier": { + "type": "string", + "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported." + }, + "sourceDBInstanceAutomatedBackupsArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. This setting doesn't apply to RDS Custom." + }, + "sourceDBInstanceIdentifier": { + "type": "string", + "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances." + }, + "sourceDbiResourceId": { + "type": "string", + "description": "The resource ID of the source DB instance from which to restore." + }, + "sourceRegion": { + "type": "string", + "description": "The ID of the region that contains the source DB instance for the read replica." + }, + "storageEncrypted": { + "type": "boolean", + "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster." + }, + "storageThroughput": { + "type": "integer", + "format": "int32", + "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora." + }, + "storageType": { + "type": "string", + "description": "The storage type to associate with the DB instance. If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``." + }, + "tags": { + "type": "array", + "description": "An optional array of key-value pairs to apply to this DB instance.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tdeCredentialArn": { + "type": "string", + "description": "Property tdeCredentialArn" + }, + "tdeCredentialPassword": { + "type": "string", + "description": "Property tdeCredentialPassword" + }, + "timezone": { + "type": "string", + "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)." + }, + "useDefaultProcessorFeatures": { + "type": "boolean", + "description": "Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances." + }, + "useLatestRestorableTime": { + "type": "boolean", + "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided." + }, + "vpcSecurityGroups": { + "type": "array", + "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. *Amazon Aurora* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "CertificateDetails": { + "type": "object", + "description": "Definition of CertificateDetails", + "properties": { + "caIdentifier": { + "type": "string", + "description": "The CA identifier of the CA certificate used for the DB instance's server certificate." + }, + "validTill": { + "type": "string", + "description": "The expiration date of the DB instance’s server certificate." + } + } + }, + "DBInstanceRole": { + "type": "object", + "description": "Definition of DBInstanceRole", + "properties": { + "featureName": { + "type": "string", + "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*." + }, + "roleArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." + } + } + }, + "Endpoint": { + "type": "object", + "description": "Definition of Endpoint", + "properties": { + "address": { + "type": "string", + "description": "Specifies the DNS address of the DB instance." + }, + "hostedZoneId": { + "type": "string", + "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." + }, + "port": { + "type": "string", + "description": "Specifies the port that the database engine is listening on." + } + } + }, + "MasterUserSecret": { + "type": "object", + "description": "Definition of MasterUserSecret", + "properties": { + "kmsKeyId": { + "type": "string", + "description": "The AWS KMS key identifier that is used to encrypt the secret." + }, + "secretArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the secret." + } + } + }, + "ProcessorFeature": { + "type": "object", + "description": "Definition of ProcessorFeature", + "properties": { + "name": { + "$ref": "#/definitions/ProcessorFeatureName", + "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``." + }, + "value": { + "type": "string", + "description": "The value of a processor feature name." + } + } + }, + "ProcessorFeatureName": { + "type": "string", + "description": "ProcessorFeatureName enum", + "enum": [ + "coreCount", + "threadsPerCore" + ], + "x-ms-enum": { + "name": "ProcessorFeatureName", + "modelAsString": true, + "values": [ + { + "name": "coreCount", + "value": "coreCount", + "description": "ProcessorFeatureName enum coreCount" + }, + { + "name": "threadsPerCore", + "value": "threadsPerCore", + "description": "ProcessorFeatureName enum threadsPerCore" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsDBInstance": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsDBInstanceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsDBInstanceListResult": { + "type": "object", + "description": "The response of a RdsDBInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsDBInstance items on this page", + "items": { + "$ref": "#/definitions/RdsDBInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsDBInstanceProperties": { + "type": "object", + "description": "Definition of RdsDBInstance", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsDBInstanceProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsDBInstanceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsDBInstance resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$')." + }, + "value": { + "type": "string", + "description": "A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with ``aws:`` or ``rds:``. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$')." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshot.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshot.json new file mode 100644 index 000000000000..5c084e0af419 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshot.json @@ -0,0 +1,731 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsDBSnapshots" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsDBSnapshots": { + "get": { + "operationId": "RdsDbSnapshots_ListBySubscription", + "tags": [ + "RdsDBSnapshots" + ], + "description": "List RdsDBSnapshot resources 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/RdsDBSnapshotListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshots_ListBySubscription": { + "$ref": "./examples/RdsDbSnapshots_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBSnapshots": { + "get": { + "operationId": "RdsDbSnapshots_ListByResourceGroup", + "tags": [ + "RdsDBSnapshots" + ], + "description": "List RdsDBSnapshot resources 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/RdsDBSnapshotListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshots_ListByResourceGroup": { + "$ref": "./examples/RdsDbSnapshots_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBSnapshots/{name}": { + "get": { + "operationId": "RdsDbSnapshots_Get", + "tags": [ + "RdsDBSnapshots" + ], + "description": "Get a RdsDBSnapshot", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBSnapshot" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshots_Get": { + "$ref": "./examples/RdsDbSnapshots_Get.json" + } + } + }, + "put": { + "operationId": "RdsDbSnapshots_CreateOrReplace", + "tags": [ + "RdsDBSnapshots" + ], + "description": "Create a RdsDBSnapshot. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBSnapshot" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsDBSnapshot' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBSnapshot" + } + }, + "201": { + "description": "Resource 'RdsDBSnapshot' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBSnapshot" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsDbSnapshots_CreateOrReplace": { + "$ref": "./examples/RdsDbSnapshots_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsDbSnapshots_Update", + "tags": [ + "RdsDBSnapshots" + ], + "description": "Update a RdsDBSnapshot", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBSnapshotTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBSnapshot" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshots_Update": { + "$ref": "./examples/RdsDbSnapshots_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsDbSnapshots_Delete", + "tags": [ + "RdsDBSnapshots" + ], + "description": "Delete a RdsDBSnapshot", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshot", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsDbSnapshots_Delete": { + "$ref": "./examples/RdsDbSnapshots_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsDBSnapshotProperties": { + "type": "object", + "description": "Definition of awsRdsDBSnapshot", + "properties": { + "allocatedStorage": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the allocated storage size in gibibytes (GiB).</p>" + }, + "availabilityZone": { + "type": "string", + "description": "<p>Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.</p>" + }, + "dbInstanceIdentifier": { + "type": "string", + "description": "<p>Specifies the DB instance identifier of the DB instance this DB snapshot was created from.</p>" + }, + "dbSnapshotArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) for the DB snapshot.</p>" + }, + "dbSnapshotIdentifier": { + "type": "string", + "description": "<p>Specifies the identifier for the DB snapshot.</p>" + }, + "dbSystemId": { + "type": "string", + "description": "<p>The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.</p>" + }, + "dbiResourceId": { + "type": "string", + "description": "<p>The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.</p>" + }, + "dedicatedLogVolume": { + "type": "boolean", + "description": "<p>Indicates whether the DB instance has a dedicated log volume (DLV) enabled.</p>" + }, + "encrypted": { + "type": "boolean", + "description": "<p>Indicates whether the DB snapshot is encrypted.</p>" + }, + "engine": { + "type": "string", + "description": "<p>Specifies the name of the database engine.</p>" + }, + "engineVersion": { + "type": "string", + "description": "<p>Specifies the version of the database engine.</p>" + }, + "iamDatabaseAuthenticationEnabled": { + "type": "boolean", + "description": "<p>Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.</p>" + }, + "instanceCreateTime": { + "type": "string", + "format": "date-time", + "description": "<p>Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.</p>" + }, + "iops": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>If <code>Encrypted</code> is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.</p> <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>" + }, + "licenseModel": { + "type": "string", + "description": "<p>License model information for the restored DB instance.</p>" + }, + "masterUsername": { + "type": "string", + "description": "<p>Provides the master username for the DB snapshot.</p>" + }, + "multiTenant": { + "type": "boolean", + "description": "<p>Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).</p>" + }, + "optionGroupName": { + "type": "string", + "description": "<p>Provides the option group name for the DB snapshot.</p>" + }, + "originalSnapshotCreateTime": { + "type": "string", + "format": "date-time", + "description": "<p>Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.</p>" + }, + "percentProgress": { + "type": "integer", + "format": "int32", + "description": "<p>The percentage of the estimated data that has been transferred.</p>" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the port that the database engine was listening on at the time of the snapshot.</p>" + }, + "processorFeatures": { + "type": "array", + "description": "<p>The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.</p>", + "items": { + "$ref": "#/definitions/ProcessorFeature" + }, + "x-ms-identifiers": [] + }, + "snapshotCreateTime": { + "type": "string", + "format": "date-time", + "description": "<p>Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.</p>" + }, + "snapshotDatabaseTime": { + "type": "string", + "format": "date-time", + "description": "<p>The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.</p> <p>If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.</p>" + }, + "snapshotTarget": { + "type": "string", + "description": "<p>Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.</p>" + }, + "snapshotType": { + "type": "string", + "description": "<p>Provides the type of the DB snapshot.</p>" + }, + "sourceDBSnapshotIdentifier": { + "type": "string", + "description": "<p>The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.</p>" + }, + "sourceRegion": { + "type": "string", + "description": "<p>The Amazon Web Services Region that the DB snapshot was created in or copied from.</p>" + }, + "status": { + "type": "string", + "description": "<p>Specifies the status of this DB snapshot.</p>" + }, + "storageThroughput": { + "type": "integer", + "format": "int32", + "description": "<p>Specifies the storage throughput for the DB snapshot.</p>" + }, + "storageType": { + "type": "string", + "description": "<p>Specifies the storage type associated with DB snapshot.</p>" + }, + "tagList": { + "type": "array", + "description": "Property tagList", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "tdeCredentialArn": { + "type": "string", + "description": "<p>The ARN from the key store with which to associate the instance for TDE encryption.</p>" + }, + "timezone": { + "type": "string", + "description": "<p>The time zone of the DB snapshot. In most cases, the <code>Timezone</code> element is empty. <code>Timezone</code> content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.</p>" + }, + "vpcId": { + "type": "string", + "description": "<p>Provides the VPC ID associated with the DB snapshot.</p>" + } + } + }, + "ProcessorFeature": { + "type": "object", + "description": "Definition of ProcessorFeature", + "properties": { + "name": { + "type": "string", + "description": "<p>The name of the processor feature. Valid names are <code>coreCount</code> and <code>threadsPerCore</code>.</p>" + }, + "value": { + "type": "string", + "description": "<p>The value of a processor feature name.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsDBSnapshot": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsDBSnapshotProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsDBSnapshotListResult": { + "type": "object", + "description": "The response of a RdsDBSnapshot list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsDBSnapshot items on this page", + "items": { + "$ref": "#/definitions/RdsDBSnapshot" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsDBSnapshotProperties": { + "type": "object", + "description": "Definition of RdsDBSnapshot", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsDBSnapshotProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsDBSnapshotTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsDBSnapshot resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$').</p>" + }, + "value": { + "type": "string", + "description": "<p>A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with <code>aws:</code> or <code>rds:</code>. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$').</p>" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshotAttributesResult.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshotAttributesResult.json new file mode 100644 index 000000000000..08b2f195a244 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshotAttributesResult.json @@ -0,0 +1,572 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsDBSnapshotAttributesResults" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsDBSnapshotAttributesResults": { + "get": { + "operationId": "RdsDbSnapshotAttributesResults_ListBySubscription", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "List RdsDBSnapshotAttributesResult resources 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/RdsDBSnapshotAttributesResultListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshotAttributesResults_ListBySubscription": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBSnapshotAttributesResults": { + "get": { + "operationId": "RdsDbSnapshotAttributesResults_ListByResourceGroup", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "List RdsDBSnapshotAttributesResult resources 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/RdsDBSnapshotAttributesResultListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshotAttributesResults_ListByResourceGroup": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsDBSnapshotAttributesResults/{name}": { + "get": { + "operationId": "RdsDbSnapshotAttributesResults_Get", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "Get a RdsDBSnapshotAttributesResult", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshotAttributesResult", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshotAttributesResults_Get": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_Get.json" + } + } + }, + "put": { + "operationId": "RdsDbSnapshotAttributesResults_CreateOrReplace", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "Create a RdsDBSnapshotAttributesResult. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshotAttributesResult", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsDBSnapshotAttributesResult' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + } + }, + "201": { + "description": "Resource 'RdsDBSnapshotAttributesResult' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsDbSnapshotAttributesResults_CreateOrReplace": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsDbSnapshotAttributesResults_Update", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "Update a RdsDBSnapshotAttributesResult", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshotAttributesResult", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResultTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsDbSnapshotAttributesResults_Update": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsDbSnapshotAttributesResults_Delete", + "tags": [ + "RdsDBSnapshotAttributesResults" + ], + "description": "Delete a RdsDBSnapshotAttributesResult", + "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": "name", + "in": "path", + "description": "Name of RdsDBSnapshotAttributesResult", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsDbSnapshotAttributesResults_Delete": { + "$ref": "./examples/RdsDbSnapshotAttributesResults_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsDBSnapshotAttributesResultProperties": { + "type": "object", + "description": "Definition of awsRdsDBSnapshotAttributesResult", + "properties": { + "dbSnapshotAttributes": { + "type": "array", + "description": "<p>The list of attributes and values for the manual DB snapshot.</p>", + "items": { + "$ref": "#/definitions/DBSnapshotAttribute" + }, + "x-ms-identifiers": [] + }, + "dbSnapshotIdentifier": { + "type": "string", + "description": "<p>The identifier of the manual DB snapshot that the attributes apply to.</p>" + } + } + }, + "DBSnapshotAttribute": { + "type": "object", + "description": "Definition of DBSnapshotAttribute", + "properties": { + "attributeName": { + "type": "string", + "description": "<p>The name of the manual DB snapshot attribute.</p> <p>The attribute named <code>restore</code> refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code> API action.</p>" + }, + "attributeValues": { + "type": "array", + "description": "<p>The value or values for the manual DB snapshot attribute.</p> <p>If the <code>AttributeName</code> field is set to <code>restore</code>, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of <code>all</code> is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsDBSnapshotAttributesResult": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResultProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsDBSnapshotAttributesResultListResult": { + "type": "object", + "description": "The response of a RdsDBSnapshotAttributesResult list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsDBSnapshotAttributesResult items on this page", + "items": { + "$ref": "#/definitions/RdsDBSnapshotAttributesResult" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsDBSnapshotAttributesResultProperties": { + "type": "object", + "description": "Definition of RdsDBSnapshotAttributesResult", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsDBSnapshotAttributesResultProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsDBSnapshotAttributesResultTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsDBSnapshotAttributesResult resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsEventSubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsEventSubscription.json new file mode 100644 index 000000000000..a90dea32e6d7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsEventSubscription.json @@ -0,0 +1,597 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsEventSubscriptions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsEventSubscriptions": { + "get": { + "operationId": "RdsEventSubscriptions_ListBySubscription", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "List RdsEventSubscription resources 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/RdsEventSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsEventSubscriptions_ListBySubscription": { + "$ref": "./examples/RdsEventSubscriptions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsEventSubscriptions": { + "get": { + "operationId": "RdsEventSubscriptions_ListByResourceGroup", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "List RdsEventSubscription resources 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/RdsEventSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsEventSubscriptions_ListByResourceGroup": { + "$ref": "./examples/RdsEventSubscriptions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsEventSubscriptions/{name}": { + "get": { + "operationId": "RdsEventSubscriptions_Get", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "Get a RdsEventSubscription", + "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": "name", + "in": "path", + "description": "Name of RdsEventSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsEventSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsEventSubscriptions_Get": { + "$ref": "./examples/RdsEventSubscriptions_Get.json" + } + } + }, + "put": { + "operationId": "RdsEventSubscriptions_CreateOrReplace", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "Create a RdsEventSubscription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsEventSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsEventSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsEventSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsEventSubscription" + } + }, + "201": { + "description": "Resource 'RdsEventSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsEventSubscription" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsEventSubscriptions_CreateOrReplace": { + "$ref": "./examples/RdsEventSubscriptions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsEventSubscriptions_Update", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "Update a RdsEventSubscription", + "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": "name", + "in": "path", + "description": "Name of RdsEventSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsEventSubscriptionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsEventSubscription" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsEventSubscriptions_Update": { + "$ref": "./examples/RdsEventSubscriptions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsEventSubscriptions_Delete", + "tags": [ + "RdsEventSubscriptions" + ], + "description": "Delete a RdsEventSubscription", + "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": "name", + "in": "path", + "description": "Name of RdsEventSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsEventSubscriptions_Delete": { + "$ref": "./examples/RdsEventSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsEventSubscriptionProperties": { + "type": "object", + "description": "Definition of awsRdsEventSubscription", + "properties": { + "enabled": { + "type": "boolean", + "description": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.", + "default": true + }, + "eventCategories": { + "type": "array", + "description": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "snsTopicArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it." + }, + "sourceIds": { + "type": "array", + "description": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "sourceType": { + "type": "string", + "description": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned." + }, + "subscriptionName": { + "type": "string", + "description": "The name of the subscription." + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsEventSubscription": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsEventSubscriptionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsEventSubscriptionListResult": { + "type": "object", + "description": "The response of a RdsEventSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsEventSubscription items on this page", + "items": { + "$ref": "#/definitions/RdsEventSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsEventSubscriptionProperties": { + "type": "object", + "description": "Definition of RdsEventSubscription", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsEventSubscriptionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsEventSubscriptionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsEventSubscription resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsExportTask.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsExportTask.json new file mode 100644 index 000000000000..247cd8147104 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/rdsExportTask.json @@ -0,0 +1,649 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RdsExportTasks" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsExportTasks": { + "get": { + "operationId": "RdsExportTasks_ListBySubscription", + "tags": [ + "RdsExportTasks" + ], + "description": "List RdsExportTask resources 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/RdsExportTaskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsExportTasks_ListBySubscription": { + "$ref": "./examples/RdsExportTasks_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsExportTasks": { + "get": { + "operationId": "RdsExportTasks_ListByResourceGroup", + "tags": [ + "RdsExportTasks" + ], + "description": "List RdsExportTask resources 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/RdsExportTaskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsExportTasks_ListByResourceGroup": { + "$ref": "./examples/RdsExportTasks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsExportTasks/{name}": { + "get": { + "operationId": "RdsExportTasks_Get", + "tags": [ + "RdsExportTasks" + ], + "description": "Get a RdsExportTask", + "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": "name", + "in": "path", + "description": "Name of RdsExportTask", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsExportTask" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsExportTasks_Get": { + "$ref": "./examples/RdsExportTasks_Get.json" + } + } + }, + "put": { + "operationId": "RdsExportTasks_CreateOrReplace", + "tags": [ + "RdsExportTasks" + ], + "description": "Create a RdsExportTask. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RdsExportTask", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsExportTask" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RdsExportTask' update operation succeeded", + "schema": { + "$ref": "#/definitions/RdsExportTask" + } + }, + "201": { + "description": "Resource 'RdsExportTask' create operation succeeded", + "schema": { + "$ref": "#/definitions/RdsExportTask" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RdsExportTasks_CreateOrReplace": { + "$ref": "./examples/RdsExportTasks_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RdsExportTasks_Update", + "tags": [ + "RdsExportTasks" + ], + "description": "Update a RdsExportTask", + "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": "name", + "in": "path", + "description": "Name of RdsExportTask", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RdsExportTaskTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RdsExportTask" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RdsExportTasks_Update": { + "$ref": "./examples/RdsExportTasks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RdsExportTasks_Delete", + "tags": [ + "RdsExportTasks" + ], + "description": "Delete a RdsExportTask", + "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": "name", + "in": "path", + "description": "Name of RdsExportTask", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RdsExportTasks_Delete": { + "$ref": "./examples/RdsExportTasks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRdsExportTaskProperties": { + "type": "object", + "description": "Definition of awsRdsExportTask", + "properties": { + "exportOnly": { + "type": "array", + "description": "<p>The data exported from the snapshot or cluster.</p> <p>Valid Values:</p> <ul> <li> <p> <code>database</code> - Export all the data from a specified database.</p> </li> <li> <p> <code>database.table</code> <i>table-name</i> - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p> </li> <li> <p> <code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li> <li> <p> <code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li> </ul>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "exportTaskIdentifier": { + "type": "string", + "description": "<p>A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.</p>" + }, + "failureCause": { + "type": "string", + "description": "<p>The reason the export failed, if it failed.</p>" + }, + "iamRoleArn": { + "type": "string", + "description": "<p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.</p>" + }, + "kmsKeyId": { + "type": "string", + "description": "<p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.</p>" + }, + "percentProgress": { + "type": "integer", + "format": "int32", + "description": "<p>The progress of the snapshot or cluster export task as a percentage.</p>" + }, + "s3Bucket": { + "type": "string", + "description": "<p>The Amazon S3 bucket where the snapshot or cluster is exported to.</p>" + }, + "s3Prefix": { + "type": "string", + "description": "<p>The Amazon S3 bucket prefix that is the file name and path of the exported data.</p>" + }, + "snapshotTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time when the snapshot was created.</p>" + }, + "sourceArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>" + }, + "sourceType": { + "$ref": "#/definitions/ExportSourceTypeEnumValue", + "description": "<p>The type of source for the export.</p>" + }, + "status": { + "type": "string", + "description": "<p>The progress status of the export task. The status can be one of the following:</p> <ul> <li> <p> <code>CANCELED</code> </p> </li> <li> <p> <code>CANCELING</code> </p> </li> <li> <p> <code>COMPLETE</code> </p> </li> <li> <p> <code>FAILED</code> </p> </li> <li> <p> <code>IN_PROGRESS</code> </p> </li> <li> <p> <code>STARTING</code> </p> </li> </ul>" + }, + "taskEndTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time when the snapshot or cluster export task ended.</p>" + }, + "taskStartTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time when the snapshot or cluster export task started.</p>" + }, + "totalExtractedDataInGB": { + "type": "integer", + "format": "int32", + "description": "<p>The total amount of data exported, in gigabytes.</p>" + }, + "warningMessage": { + "type": "string", + "description": "<p>A warning about the snapshot or cluster export task.</p>" + } + } + }, + "ExportSourceType": { + "type": "string", + "description": "ExportSourceType enum", + "enum": [ + "CLUSTER", + "SNAPSHOT" + ], + "x-ms-enum": { + "name": "ExportSourceType", + "modelAsString": true, + "values": [ + { + "name": "CLUSTER", + "value": "CLUSTER", + "description": "ExportSourceType enum CLUSTER" + }, + { + "name": "SNAPSHOT", + "value": "SNAPSHOT", + "description": "ExportSourceType enum SNAPSHOT" + } + ] + } + }, + "ExportSourceTypeEnumValue": { + "type": "object", + "description": "Definition of ExportSourceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ExportSourceType", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RdsExportTask": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RdsExportTaskProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RdsExportTaskListResult": { + "type": "object", + "description": "The response of a RdsExportTask list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RdsExportTask items on this page", + "items": { + "$ref": "#/definitions/RdsExportTask" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RdsExportTaskProperties": { + "type": "object", + "description": "Definition of RdsExportTask", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRdsExportTaskProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RdsExportTaskTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RdsExportTask resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftCluster.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftCluster.json new file mode 100644 index 000000000000..26cf588b4d86 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftCluster.json @@ -0,0 +1,825 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RedshiftClusters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/redshiftClusters": { + "get": { + "operationId": "RedshiftClusters_ListBySubscription", + "tags": [ + "RedshiftClusters" + ], + "description": "List RedshiftCluster resources 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/RedshiftClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusters_ListBySubscription": { + "$ref": "./examples/RedshiftClusters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/redshiftClusters": { + "get": { + "operationId": "RedshiftClusters_ListByResourceGroup", + "tags": [ + "RedshiftClusters" + ], + "description": "List RedshiftCluster resources 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/RedshiftClusterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusters_ListByResourceGroup": { + "$ref": "./examples/RedshiftClusters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/redshiftClusters/{name}": { + "get": { + "operationId": "RedshiftClusters_Get", + "tags": [ + "RedshiftClusters" + ], + "description": "Get a RedshiftCluster", + "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": "name", + "in": "path", + "description": "Name of RedshiftCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RedshiftCluster" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusters_Get": { + "$ref": "./examples/RedshiftClusters_Get.json" + } + } + }, + "put": { + "operationId": "RedshiftClusters_CreateOrReplace", + "tags": [ + "RedshiftClusters" + ], + "description": "Create a RedshiftCluster. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RedshiftCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RedshiftCluster" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RedshiftCluster' update operation succeeded", + "schema": { + "$ref": "#/definitions/RedshiftCluster" + } + }, + "201": { + "description": "Resource 'RedshiftCluster' create operation succeeded", + "schema": { + "$ref": "#/definitions/RedshiftCluster" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RedshiftClusters_CreateOrReplace": { + "$ref": "./examples/RedshiftClusters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RedshiftClusters_Update", + "tags": [ + "RedshiftClusters" + ], + "description": "Update a RedshiftCluster", + "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": "name", + "in": "path", + "description": "Name of RedshiftCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RedshiftClusterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RedshiftCluster" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusters_Update": { + "$ref": "./examples/RedshiftClusters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RedshiftClusters_Delete", + "tags": [ + "RedshiftClusters" + ], + "description": "Delete a RedshiftCluster", + "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": "name", + "in": "path", + "description": "Name of RedshiftCluster", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RedshiftClusters_Delete": { + "$ref": "./examples/RedshiftClusters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRedshiftClusterProperties": { + "type": "object", + "description": "Definition of awsRedshiftCluster", + "properties": { + "allowVersionUpgrade": { + "type": "boolean", + "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True" + }, + "aquaConfigurationStatus": { + "type": "string", + "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.disabled - Don't use AQUA.auto - Amazon Redshift determines whether to use AQUA." + }, + "automatedSnapshotRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1" + }, + "availabilityZone": { + "type": "string", + "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint" + }, + "availabilityZoneRelocation": { + "type": "boolean", + "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete." + }, + "availabilityZoneRelocationStatus": { + "type": "string", + "description": "The availability zone relocation status of the cluster" + }, + "classic": { + "type": "boolean", + "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic." + }, + "clusterIdentifier": { + "type": "string", + "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account" + }, + "clusterNamespaceArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the cluster namespace." + }, + "clusterParameterGroupName": { + "type": "string", + "description": "The name of the parameter group to be associated with this cluster." + }, + "clusterSecurityGroups": { + "type": "array", + "description": "A list of security groups to be associated with this cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "clusterSubnetGroupName": { + "type": "string", + "description": "The name of a cluster subnet group to be associated with this cluster." + }, + "clusterType": { + "type": "string", + "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required" + }, + "clusterVersion": { + "type": "string", + "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster." + }, + "dbName": { + "type": "string", + "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database." + }, + "deferMaintenance": { + "type": "boolean", + "description": "A boolean indicating whether to enable the deferred maintenance window." + }, + "deferMaintenanceDuration": { + "type": "integer", + "format": "int32", + "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less." + }, + "deferMaintenanceEndTime": { + "type": "string", + "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration." + }, + "deferMaintenanceIdentifier": { + "type": "string", + "description": "A unique identifier for the deferred maintenance window." + }, + "deferMaintenanceStartTime": { + "type": "string", + "description": "A timestamp indicating the start time for the deferred maintenance window." + }, + "destinationRegion": { + "type": "string", + "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference" + }, + "elasticIp": { + "type": "string", + "description": "The Elastic IP (EIP) address for the cluster." + }, + "encrypted": { + "type": "boolean", + "description": "If true, the data in the cluster is encrypted at rest." + }, + "endpoint": { + "$ref": "#/definitions/Endpoint", + "description": "Property endpoint" + }, + "enhancedVpcRouting": { + "type": "boolean", + "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.If this option is true , enhanced VPC routing is enabled.Default: false" + }, + "hsmClientCertificateIdentifier": { + "type": "string", + "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM" + }, + "hsmConfigurationIdentifier": { + "type": "string", + "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM." + }, + "iamRoles": { + "type": "array", + "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "kmsKeyId": { + "type": "string", + "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster." + }, + "loggingProperties": { + "$ref": "#/definitions/LoggingProperties", + "description": "Property loggingProperties" + }, + "maintenanceTrackName": { + "type": "string", + "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied." + }, + "manageMasterPassword": { + "type": "boolean", + "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password." + }, + "manualSnapshotRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653." + }, + "masterPasswordSecretArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret." + }, + "masterPasswordSecretKmsKeyId": { + "type": "string", + "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret." + }, + "masterUserPassword": { + "type": "string", + "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character." + }, + "masterUsername": { + "type": "string", + "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter." + }, + "multiAZ": { + "type": "boolean", + "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az." + }, + "namespaceResourcePolicy": { + "description": "The namespace resource policy document that will be attached to a Redshift cluster." + }, + "nodeType": { + "type": "string", + "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge" + }, + "numberOfNodes": { + "type": "integer", + "format": "int32", + "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node." + }, + "ownerAccount": { + "type": "string", + "description": "Property ownerAccount" + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings" + }, + "preferredMaintenanceWindow": { + "type": "string", + "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur." + }, + "publiclyAccessible": { + "type": "boolean", + "description": "If true, the cluster can be accessed from a public network." + }, + "resourceAction": { + "type": "string", + "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs" + }, + "revisionTarget": { + "type": "string", + "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request." + }, + "rotateEncryptionKey": { + "type": "boolean", + "description": "A boolean indicating if we want to rotate Encryption Keys." + }, + "snapshotClusterIdentifier": { + "type": "string", + "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name." + }, + "snapshotCopyGrantName": { + "type": "string", + "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region." + }, + "snapshotCopyManual": { + "type": "boolean", + "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots." + }, + "snapshotCopyRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35." + }, + "snapshotIdentifier": { + "type": "string", + "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive." + }, + "tags": { + "type": "array", + "description": "The list of tags for the cluster parameter group.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "vpcSecurityGroupIds": { + "type": "array", + "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + } + } + }, + "Endpoint": { + "type": "object", + "description": "Definition of Endpoint", + "properties": { + "address": { + "type": "string", + "description": "Property address" + }, + "port": { + "type": "string", + "description": "Property port" + } + } + }, + "LoggingProperties": { + "type": "object", + "description": "Definition of LoggingProperties", + "properties": { + "bucketName": { + "type": "string", + "description": "Property bucketName" + }, + "s3KeyPrefix": { + "type": "string", + "description": "Property s3KeyPrefix" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RedshiftCluster": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RedshiftClusterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RedshiftClusterListResult": { + "type": "object", + "description": "The response of a RedshiftCluster list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RedshiftCluster items on this page", + "items": { + "$ref": "#/definitions/RedshiftCluster" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RedshiftClusterProperties": { + "type": "object", + "description": "Definition of RedshiftCluster", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRedshiftClusterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RedshiftClusterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RedshiftCluster resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftClusterParameterGroup.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftClusterParameterGroup.json new file mode 100644 index 000000000000..ff9f9dbfbe5d --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/redshiftClusterParameterGroup.json @@ -0,0 +1,598 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "RedshiftClusterParameterGroups" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/redshiftClusterParameterGroups": { + "get": { + "operationId": "RedshiftClusterParameterGroups_ListBySubscription", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "List RedshiftClusterParameterGroup resources 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/RedshiftClusterParameterGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusterParameterGroups_ListBySubscription": { + "$ref": "./examples/RedshiftClusterParameterGroups_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/redshiftClusterParameterGroups": { + "get": { + "operationId": "RedshiftClusterParameterGroups_ListByResourceGroup", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "List RedshiftClusterParameterGroup resources 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/RedshiftClusterParameterGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusterParameterGroups_ListByResourceGroup": { + "$ref": "./examples/RedshiftClusterParameterGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/redshiftClusterParameterGroups/{name}": { + "get": { + "operationId": "RedshiftClusterParameterGroups_Get", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "Get a RedshiftClusterParameterGroup", + "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": "name", + "in": "path", + "description": "Name of RedshiftClusterParameterGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusterParameterGroups_Get": { + "$ref": "./examples/RedshiftClusterParameterGroups_Get.json" + } + } + }, + "put": { + "operationId": "RedshiftClusterParameterGroups_CreateOrReplace", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "Create a RedshiftClusterParameterGroup. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of RedshiftClusterParameterGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'RedshiftClusterParameterGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + } + }, + "201": { + "description": "Resource 'RedshiftClusterParameterGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "RedshiftClusterParameterGroups_CreateOrReplace": { + "$ref": "./examples/RedshiftClusterParameterGroups_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "RedshiftClusterParameterGroups_Update", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "Update a RedshiftClusterParameterGroup", + "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": "name", + "in": "path", + "description": "Name of RedshiftClusterParameterGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RedshiftClusterParameterGroups_Update": { + "$ref": "./examples/RedshiftClusterParameterGroups_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "RedshiftClusterParameterGroups_Delete", + "tags": [ + "RedshiftClusterParameterGroups" + ], + "description": "Delete a RedshiftClusterParameterGroup", + "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": "name", + "in": "path", + "description": "Name of RedshiftClusterParameterGroup", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "RedshiftClusterParameterGroups_Delete": { + "$ref": "./examples/RedshiftClusterParameterGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRedshiftClusterParameterGroupProperties": { + "type": "object", + "description": "Definition of awsRedshiftClusterParameterGroup", + "properties": { + "description": { + "type": "string", + "description": "A description of the parameter group." + }, + "parameterGroupFamily": { + "type": "string", + "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters." + }, + "parameterGroupName": { + "type": "string", + "description": "The name of the cluster parameter group." + }, + "parameters": { + "type": "array", + "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.", + "items": { + "$ref": "#/definitions/Parameter" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "An array of key-value pairs to apply to this resource.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "Parameter": { + "type": "object", + "description": "Definition of Parameter", + "properties": { + "parameterName": { + "type": "string", + "description": "The name of the parameter." + }, + "parameterValue": { + "type": "string", + "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RedshiftClusterParameterGroup": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/RedshiftClusterParameterGroupProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "RedshiftClusterParameterGroupListResult": { + "type": "object", + "description": "The response of a RedshiftClusterParameterGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The RedshiftClusterParameterGroup items on this page", + "items": { + "$ref": "#/definitions/RedshiftClusterParameterGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "RedshiftClusterParameterGroupProperties": { + "type": "object", + "description": "Definition of RedshiftClusterParameterGroup", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRedshiftClusterParameterGroupProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "RedshiftClusterParameterGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in RedshiftClusterParameterGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53DomainsDomainSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53DomainsDomainSummary.json new file mode 100644 index 000000000000..a19c0f967ad5 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53DomainsDomainSummary.json @@ -0,0 +1,559 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Route53DomainsDomainSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/route53DomainsDomainSummaries": { + "get": { + "operationId": "Route53DomainsDomainSummaries_ListBySubscription", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "List Route53DomainsDomainSummary resources 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/Route53DomainsDomainSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53DomainsDomainSummaries_ListBySubscription": { + "$ref": "./examples/Route53DomainsDomainSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53DomainsDomainSummaries": { + "get": { + "operationId": "Route53DomainsDomainSummaries_ListByResourceGroup", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "List Route53DomainsDomainSummary resources 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/Route53DomainsDomainSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53DomainsDomainSummaries_ListByResourceGroup": { + "$ref": "./examples/Route53DomainsDomainSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53DomainsDomainSummaries/{name}": { + "get": { + "operationId": "Route53DomainsDomainSummaries_Get", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "Get a Route53DomainsDomainSummary", + "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": "name", + "in": "path", + "description": "Name of Route53DomainsDomainSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53DomainsDomainSummaries_Get": { + "$ref": "./examples/Route53DomainsDomainSummaries_Get.json" + } + } + }, + "put": { + "operationId": "Route53DomainsDomainSummaries_CreateOrReplace", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "Create a Route53DomainsDomainSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Route53DomainsDomainSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Route53DomainsDomainSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + } + }, + "201": { + "description": "Resource 'Route53DomainsDomainSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Route53DomainsDomainSummaries_CreateOrReplace": { + "$ref": "./examples/Route53DomainsDomainSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Route53DomainsDomainSummaries_Update", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "Update a Route53DomainsDomainSummary", + "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": "name", + "in": "path", + "description": "Name of Route53DomainsDomainSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53DomainsDomainSummaries_Update": { + "$ref": "./examples/Route53DomainsDomainSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Route53DomainsDomainSummaries_Delete", + "tags": [ + "Route53DomainsDomainSummaries" + ], + "description": "Delete a Route53DomainsDomainSummary", + "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": "name", + "in": "path", + "description": "Name of Route53DomainsDomainSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Route53DomainsDomainSummaries_Delete": { + "$ref": "./examples/Route53DomainsDomainSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRoute53DomainsDomainSummaryProperties": { + "type": "object", + "description": "Definition of awsRoute53DomainsDomainSummary", + "properties": { + "autoRenew": { + "type": "boolean", + "description": "<p>Indicates whether the domain is automatically renewed upon expiration.</p>" + }, + "domainName": { + "type": "string", + "description": "<p>The name of the domain that the summary information applies to.</p>" + }, + "expiry": { + "type": "string", + "format": "date-time", + "description": "<p>Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).</p>" + }, + "transferLock": { + "type": "boolean", + "description": "<p>Indicates whether a domain is locked from unauthorized transfer to another party.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "Route53DomainsDomainSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Route53DomainsDomainSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Route53DomainsDomainSummaryListResult": { + "type": "object", + "description": "The response of a Route53DomainsDomainSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Route53DomainsDomainSummary items on this page", + "items": { + "$ref": "#/definitions/Route53DomainsDomainSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Route53DomainsDomainSummaryProperties": { + "type": "object", + "description": "Definition of Route53DomainsDomainSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRoute53DomainsDomainSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Route53DomainsDomainSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Route53DomainsDomainSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53HostedZone.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53HostedZone.json new file mode 100644 index 000000000000..ec7f8fedcad8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53HostedZone.json @@ -0,0 +1,630 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Route53HostedZones" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/route53HostedZones": { + "get": { + "operationId": "Route53HostedZones_ListBySubscription", + "tags": [ + "Route53HostedZones" + ], + "description": "List Route53HostedZone resources 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/Route53HostedZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53HostedZones_ListBySubscription": { + "$ref": "./examples/Route53HostedZones_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53HostedZones": { + "get": { + "operationId": "Route53HostedZones_ListByResourceGroup", + "tags": [ + "Route53HostedZones" + ], + "description": "List Route53HostedZone resources 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/Route53HostedZoneListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53HostedZones_ListByResourceGroup": { + "$ref": "./examples/Route53HostedZones_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53HostedZones/{name}": { + "get": { + "operationId": "Route53HostedZones_Get", + "tags": [ + "Route53HostedZones" + ], + "description": "Get a Route53HostedZone", + "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": "name", + "in": "path", + "description": "Name of Route53HostedZone", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53HostedZone" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53HostedZones_Get": { + "$ref": "./examples/Route53HostedZones_Get.json" + } + } + }, + "put": { + "operationId": "Route53HostedZones_CreateOrReplace", + "tags": [ + "Route53HostedZones" + ], + "description": "Create a Route53HostedZone. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Route53HostedZone", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53HostedZone" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Route53HostedZone' update operation succeeded", + "schema": { + "$ref": "#/definitions/Route53HostedZone" + } + }, + "201": { + "description": "Resource 'Route53HostedZone' create operation succeeded", + "schema": { + "$ref": "#/definitions/Route53HostedZone" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Route53HostedZones_CreateOrReplace": { + "$ref": "./examples/Route53HostedZones_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Route53HostedZones_Update", + "tags": [ + "Route53HostedZones" + ], + "description": "Update a Route53HostedZone", + "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": "name", + "in": "path", + "description": "Name of Route53HostedZone", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53HostedZoneTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53HostedZone" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53HostedZones_Update": { + "$ref": "./examples/Route53HostedZones_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Route53HostedZones_Delete", + "tags": [ + "Route53HostedZones" + ], + "description": "Delete a Route53HostedZone", + "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": "name", + "in": "path", + "description": "Name of Route53HostedZone", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Route53HostedZones_Delete": { + "$ref": "./examples/Route53HostedZones_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsRoute53HostedZoneProperties": { + "type": "object", + "description": "Definition of awsRoute53HostedZone", + "properties": { + "hostedZoneConfig": { + "$ref": "#/definitions/HostedZoneConfig", + "description": "A complex type that contains an optional comment. If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements." + }, + "hostedZoneTags": { + "type": "array", + "description": "Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*.", + "items": { + "$ref": "#/definitions/HostedZoneTag" + }, + "x-ms-identifiers": [] + }, + "id": { + "type": "string", + "description": "Property id" + }, + "name": { + "type": "string", + "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function." + }, + "nameServers": { + "type": "array", + "description": "Property nameServers", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "queryLoggingConfig": { + "$ref": "#/definitions/QueryLoggingConfig", + "description": "Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + Route 53 edge location that responded to the DNS query + Domain or subdomain that was requested + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see 'The Route 53 Global Network' on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. A complex type that contains information about a configuration for DNS query logging." + }, + "vpCs": { + "type": "array", + "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``.", + "items": { + "$ref": "#/definitions/VPC" + }, + "x-ms-identifiers": [] + } + } + }, + "HostedZoneConfig": { + "type": "object", + "description": "Definition of HostedZoneConfig", + "properties": { + "comment": { + "type": "string", + "description": "Any comments that you want to include about the hosted zone." + } + } + }, + "HostedZoneTag": { + "type": "object", + "description": "Definition of HostedZoneTag", + "properties": { + "key": { + "type": "string", + "description": "The value of ``Key`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + *Delete a key*: ``Key`` is the name of the tag you want to remove. + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check." + }, + "value": { + "type": "string", + "description": "The value of ``Value`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + *Edit a tag*: ``Value`` is the new value that you want to assign the tag." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "QueryLoggingConfig": { + "type": "object", + "description": "Definition of QueryLoggingConfig", + "properties": { + "cloudWatchLogsLogGroupArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to." + } + } + }, + "Route53HostedZone": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Route53HostedZoneProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Route53HostedZoneListResult": { + "type": "object", + "description": "The response of a Route53HostedZone list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Route53HostedZone items on this page", + "items": { + "$ref": "#/definitions/Route53HostedZone" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Route53HostedZoneProperties": { + "type": "object", + "description": "Definition of Route53HostedZone", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRoute53HostedZoneProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Route53HostedZoneTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Route53HostedZone resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VPC": { + "type": "object", + "description": "Definition of VPC", + "properties": { + "vpcId": { + "type": "string", + "description": "*Private hosted zones only:* The ID of an Amazon VPC. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." + }, + "vpcRegion": { + "type": "string", + "description": "*Private hosted zones only:* The region that an Amazon VPC was created in. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53ResourceRecordSet.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53ResourceRecordSet.json new file mode 100644 index 000000000000..e0d5d5322607 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/route53ResourceRecordSet.json @@ -0,0 +1,1047 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Route53ResourceRecordSets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/route53ResourceRecordSets": { + "get": { + "operationId": "Route53ResourceRecordSets_ListBySubscription", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "List Route53ResourceRecordSet resources 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/Route53ResourceRecordSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53ResourceRecordSets_ListBySubscription": { + "$ref": "./examples/Route53ResourceRecordSets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53ResourceRecordSets": { + "get": { + "operationId": "Route53ResourceRecordSets_ListByResourceGroup", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "List Route53ResourceRecordSet resources 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/Route53ResourceRecordSetListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53ResourceRecordSets_ListByResourceGroup": { + "$ref": "./examples/Route53ResourceRecordSets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/route53ResourceRecordSets/{name}": { + "get": { + "operationId": "Route53ResourceRecordSets_Get", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "Get a Route53ResourceRecordSet", + "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": "name", + "in": "path", + "description": "Name of Route53ResourceRecordSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSet" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53ResourceRecordSets_Get": { + "$ref": "./examples/Route53ResourceRecordSets_Get.json" + } + } + }, + "put": { + "operationId": "Route53ResourceRecordSets_CreateOrReplace", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "Create a Route53ResourceRecordSet. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Route53ResourceRecordSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSet" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Route53ResourceRecordSet' update operation succeeded", + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSet" + } + }, + "201": { + "description": "Resource 'Route53ResourceRecordSet' create operation succeeded", + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSet" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Route53ResourceRecordSets_CreateOrReplace": { + "$ref": "./examples/Route53ResourceRecordSets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Route53ResourceRecordSets_Update", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "Update a Route53ResourceRecordSet", + "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": "name", + "in": "path", + "description": "Name of Route53ResourceRecordSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSetTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Route53ResourceRecordSet" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Route53ResourceRecordSets_Update": { + "$ref": "./examples/Route53ResourceRecordSets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Route53ResourceRecordSets_Delete", + "tags": [ + "Route53ResourceRecordSets" + ], + "description": "Delete a Route53ResourceRecordSet", + "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": "name", + "in": "path", + "description": "Name of Route53ResourceRecordSet", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Route53ResourceRecordSets_Delete": { + "$ref": "./examples/Route53ResourceRecordSets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AliasTarget": { + "type": "object", + "description": "Definition of AliasTarget", + "properties": { + "dnsName": { + "type": "string", + "description": "<p> <i>Alias resource record sets only:</i> The value that you specify depends on where you want to route queries:</p> <dl> <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> <dd> <p>Specify the applicable domain name for your API. You can get the applicable value using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'>get-domain-names</a>:</p> <ul> <li> <p>For regional APIs, specify the value of <code>regionalDomainName</code>.</p> </li> <li> <p>For edge-optimized APIs, specify the value of <code>distributionDomainName</code>. This is the name of the associated CloudFront distribution, such as <code>da1b2c3d4e5.cloudfront.net</code>.</p> </li> </ul> <note> <p>The name of the record that you're creating must match a custom domain name for your API, such as <code>api.example.com</code>.</p> </note> </dd> <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> <dd> <p>Enter the API endpoint for the interface endpoint, such as <code>vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com</code>. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of <code>DnsName</code> using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'>describe-vpc-endpoints</a>.</p> </dd> <dt>CloudFront distribution</dt> <dd> <p>Specify the domain name that CloudFront assigned when you created your distribution.</p> <p>Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is <i>acme.example.com</i>, your CloudFront distribution must include <i>acme.example.com</i> as one of the alternate domain names. For more information, see <a href='https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html'>Using Alternate Domain Names (CNAMEs)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.</p> <note> <p>For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. </p> </note> </dd> <dt>Elastic Beanstalk environment</dt> <dd> <p>If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name <code>my-environment.<i>us-west-2</i>.elasticbeanstalk.com</code> is a regionalized domain name. </p> <important> <p>For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.</p> </important> <p>For Elastic Beanstalk environments that have regionalized subdomains, specify the <code>CNAME</code> attribute for the environment. You can use the following methods to get the value of the CNAME attribute:</p> <ul> <li> <p> <i>Amazon Web Services Management Console</i>: For information about how to get the value by using the console, see <a href='https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html'>Using Custom Domains with Elastic Beanstalk</a> in the <i>Elastic Beanstalk Developer Guide</i>.</p> </li> <li> <p> <i>Elastic Beanstalk API</i>: Use the <code>DescribeEnvironments</code> action to get the value of the <code>CNAME</code> attribute. For more information, see <a href='https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html'>DescribeEnvironments</a> in the <i>Elastic Beanstalk API Reference</i>.</p> </li> <li> <p> <i>CLI</i>: Use the <code>describe-environments</code> command to get the value of the <code>CNAME</code> attribute. For more information, see <a href='https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html'>describe-environments</a> in the <i>CLI Command Reference</i>.</p> </li> </ul> </dd> <dt>ELB load balancer</dt> <dd> <p>Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. </p> <ul> <li> <p> <b>Amazon Web Services Management Console</b>: Go to the EC2 page, choose <b>Load Balancers</b> in the navigation pane, choose the load balancer, choose the <b>Description</b> tab, and get the value of the <b>DNS name</b> field. </p> <p>If you're routing traffic to a Classic Load Balancer, get the value that begins with <b>dualstack</b>. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.</p> </li> <li> <p> <b>Elastic Load Balancing API</b>: Use <code>DescribeLoadBalancers</code> to get the value of <code>DNSName</code>. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: <a href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> </p> </li> <li> <p>Application and Network Load Balancers: <a href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> </p> </li> </ul> </li> <li> <p> <b>CLI</b>: Use <code>describe-load-balancers</code> to get the value of <code>DNSName</code>. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: <a href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'>describe-load-balancers</a> </p> </li> <li> <p>Application and Network Load Balancers: <a href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'>describe-load-balancers</a> </p> </li> </ul> </li> </ul> </dd> <dt>Global Accelerator accelerator</dt> <dd> <p>Specify the DNS name for your accelerator:</p> <ul> <li> <p> <b>Global Accelerator API:</b> To get the DNS name, use <a href='https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html'>DescribeAccelerator</a>.</p> </li> <li> <p> <b>CLI:</b> To get the DNS name, use <a href='https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html'>describe-accelerator</a>.</p> </li> </ul> </dd> <dt>Amazon S3 bucket that is configured as a static website</dt> <dd> <p>Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, <code>s3-website.us-east-2.amazonaws.com</code>. For more information about valid values, see the table <a href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'>Amazon S3 Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>. For more information about using S3 buckets for websites, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html'>Getting Started with Amazon Route 53</a> in the <i>Amazon Route 53 Developer Guide.</i> </p> </dd> <dt>Another Route 53 resource record set</dt> <dd> <p>Specify the value of the <code>Name</code> element for a resource record set in the current hosted zone.</p> <note> <p>If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of <code>Type</code> is <code>CNAME</code>. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.</p> </note> </dd> </dl>" + }, + "evaluateTargetHealth": { + "type": "boolean", + "description": "<p> <i>Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:</i> When <code>EvaluateTargetHealth</code> is <code>true</code>, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.</p> <p>Note the following:</p> <dl> <dt>CloudFront distributions</dt> <dd> <p>You can't set <code>EvaluateTargetHealth</code> to <code>true</code> when the alias target is a CloudFront distribution.</p> </dd> <dt>Elastic Beanstalk environments that have regionalized subdomains</dt> <dd> <p>If you specify an Elastic Beanstalk environment in <code>DNSName</code> and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set <code>EvaluateTargetHealth</code> to <code>true</code> and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. </p> <p>If the environment contains a single Amazon EC2 instance, there are no special requirements.</p> </dd> <dt>ELB load balancers</dt> <dd> <p>Health checking behavior depends on the type of load balancer:</p> <ul> <li> <p> <b>Classic Load Balancers</b>: If you specify an ELB Classic Load Balancer in <code>DNSName</code>, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set <code>EvaluateTargetHealth</code> to <code>true</code> and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.</p> </li> <li> <p> <b>Application and Network Load Balancers</b>: If you specify an ELB Application or Network Load Balancer and you set <code>EvaluateTargetHealth</code> to <code>true</code>, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:</p> <ul> <li> <p>For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.</p> </li> <li> <p>A target group that has no registered targets is considered unhealthy.</p> </li> </ul> </li> </ul> <note> <p>When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. </p> </note> </dd> <dt>S3 buckets</dt> <dd> <p>There are no special requirements for setting <code>EvaluateTargetHealth</code> to <code>true</code> when the alias target is an S3 bucket.</p> </dd> <dt>Other records in the same hosted zone</dt> <dd> <p>If the Amazon Web Services resource that you specify in <code>DNSName</code> is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting'>What Happens When You Omit Health Checks?</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </dd> </dl> <p>For more information and examples, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Amazon Route 53 Health Checks and DNS Failover</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>" + }, + "hostedZoneId": { + "type": "string", + "description": "<p> <i>Alias resource records sets only</i>: The value used depends on where you want to route traffic:</p> <dl> <dt>Amazon API Gateway custom regional APIs and edge-optimized APIs</dt> <dd> <p>Specify the hosted zone ID for your API. You can get the applicable value using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'>get-domain-names</a>:</p> <ul> <li> <p>For regional APIs, specify the value of <code>regionalHostedZoneId</code>.</p> </li> <li> <p>For edge-optimized APIs, specify the value of <code>distributionHostedZoneId</code>.</p> </li> </ul> </dd> <dt>Amazon Virtual Private Cloud interface VPC endpoint</dt> <dd> <p>Specify the hosted zone ID for your interface endpoint. You can get the value of <code>HostedZoneId</code> using the CLI command <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'>describe-vpc-endpoints</a>.</p> </dd> <dt>CloudFront distribution</dt> <dd> <p>Specify <code>Z2FDTNDATAQYW2</code>.</p> <note> <p>Alias resource record sets for CloudFront can't be created in a private zone.</p> </note> </dd> <dt>Elastic Beanstalk environment</dt> <dd> <p>Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see <a href='https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html'>Elastic Beanstalk endpoints and quotas</a> in the <i>Amazon Web Services General Reference</i>.</p> </dd> <dt>ELB load balancer</dt> <dd> <p>Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:</p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/general/latest/gr/elb.html'>Elastic Load Balancing endpoints and quotas</a> topic in the <i>Amazon Web Services General Reference</i>: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.</p> </li> <li> <p> <b>Amazon Web Services Management Console</b>: Go to the Amazon EC2 page, choose <b>Load Balancers</b> in the navigation pane, select the load balancer, and get the value of the <b>Hosted zone</b> field on the <b>Description</b> tab.</p> </li> <li> <p> <b>Elastic Load Balancing API</b>: Use <code>DescribeLoadBalancers</code> to get the applicable value. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: Use <a href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> to get the value of <code>CanonicalHostedZoneNameId</code>.</p> </li> <li> <p>Application and Network Load Balancers: Use <a href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'>DescribeLoadBalancers</a> to get the value of <code>CanonicalHostedZoneId</code>.</p> </li> </ul> </li> <li> <p> <b>CLI</b>: Use <code>describe-load-balancers</code> to get the applicable value. For more information, see the applicable guide:</p> <ul> <li> <p>Classic Load Balancers: Use <a href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'>describe-load-balancers</a> to get the value of <code>CanonicalHostedZoneNameId</code>.</p> </li> <li> <p>Application and Network Load Balancers: Use <a href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'>describe-load-balancers</a> to get the value of <code>CanonicalHostedZoneId</code>.</p> </li> </ul> </li> </ul> </dd> <dt>Global Accelerator accelerator</dt> <dd> <p>Specify <code>Z2BJ6XQ5FK7U4H</code>.</p> </dd> <dt>An Amazon S3 bucket configured as a static website</dt> <dd> <p>Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table <a href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'>Amazon S3 Website Endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> </dd> <dt>Another Route 53 resource record set in your hosted zone</dt> <dd> <p>Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)</p> </dd> </dl>" + } + } + }, + "AwsRoute53ResourceRecordSetProperties": { + "type": "object", + "description": "Definition of awsRoute53ResourceRecordSet", + "properties": { + "aliasTarget": { + "$ref": "#/definitions/AliasTarget", + "description": "<p> <i>Alias resource record sets only:</i> Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. </p> <p>If you're creating resource records sets for a private hosted zone, note the following:</p> <ul> <li> <p>You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.</p> </li> <li> <p>For information about creating failover resource record sets in a private hosted zone, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </li> </ul>" + }, + "cidrRoutingConfig": { + "$ref": "#/definitions/CidrRoutingConfig", + "description": "Property cidrRoutingConfig" + }, + "failover": { + "$ref": "#/definitions/ResourceRecordSetFailoverEnumValue", + "description": "<p> <i>Failover resource record sets only:</i> To configure failover, you add the <code>Failover</code> element to two resource record sets. For one resource record set, you specify <code>PRIMARY</code> as the value for <code>Failover</code>; for the other resource record set, you specify <code>SECONDARY</code>. In addition, you include the <code>HealthCheckId</code> element and specify the health check that you want Amazon Route 53 to perform for each resource record set.</p> <p>Except where noted, the following failover behaviors assume that you have included the <code>HealthCheckId</code> element in both resource record sets:</p> <ul> <li> <p>When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.</p> </li> <li> <p>When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.</p> </li> <li> <p>When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.</p> </li> <li> <p>If you omit the <code>HealthCheckId</code> element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.</p> </li> </ul> <p>You can't create non-failover resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as failover resource record sets.</p> <p>For failover alias resource record sets, you must also include the <code>EvaluateTargetHealth</code> element and set the value to true.</p> <p>For more information about configuring failover for Route 53, see the following topics in the <i>Amazon Route 53 Developer Guide</i>: </p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Route 53 Health Checks and DNS Failover</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> </p> </li> </ul>" + }, + "geoLocation": { + "$ref": "#/definitions/GeoLocation", + "description": "<p> <i>Geolocation resource record sets only:</i> A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of <code>192.0.2.111</code>, create a resource record set with a <code>Type</code> of <code>A</code> and a <code>ContinentCode</code> of <code>AF</code>.</p> <p>If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.</p> <p>You can't create two geolocation resource record sets that specify the same geographic location.</p> <p>The value <code>*</code> in the <code>CountryCode</code> element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements.</p> <important> <p>Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of <code>CountryCode</code> is <code>*</code>. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a <code>*</code> resource record set, Route 53 returns a 'no answer' response for queries from those locations.</p> </important> <p>You can't create non-geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as geolocation resource record sets.</p>" + }, + "geoProximityLocation": { + "$ref": "#/definitions/GeoProximityLocation", + "description": "<p> <i> GeoproximityLocation resource record sets only:</i> A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. </p>" + }, + "healthCheckId": { + "type": "string", + "description": "<p>If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the <code>HealthCheckId</code> element and specify the ID of the applicable health check.</p> <p>Route 53 determines whether a resource record set is healthy based on one of the following:</p> <ul> <li> <p>By periodically sending a request to the endpoint that is specified in the health check</p> </li> <li> <p>By aggregating the status of a specified group of health checks (calculated health checks)</p> </li> <li> <p>By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)</p> </li> </ul> <important> <p>Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the <code>Value</code> element. When you add a <code>HealthCheckId</code> element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. </p> </important> <p>For more information, see the following topics in the <i>Amazon Route 53 Developer Guide</i>:</p> <ul> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html'>How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'>Route 53 Health Checks and DNS Failover</a> </p> </li> <li> <p> <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'>Configuring Failover in a Private Hosted Zone</a> </p> </li> </ul> <p> <b>When to Specify HealthCheckId</b> </p> <p>Specifying a value for <code>HealthCheckId</code> is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:</p> <ul> <li> <p> <b>Non-alias resource record sets</b>: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. </p> <p>If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.</p> <p>If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.</p> <p>If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. </p> </li> <li> <p> <b>Alias resource record sets</b>: You specify the following settings:</p> <ul> <li> <p>You set <code>EvaluateTargetHealth</code> to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). </p> </li> <li> <p>You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.</p> </li> <li> <p>You specify a health check ID for the non-alias resource record set. </p> </li> </ul> <p>If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.</p> <p>If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.</p> <note> <p>The alias resource record set can also route traffic to a <i>group</i> of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.</p> </note> </li> </ul> <p> <b>Geolocation Routing</b> </p> <p>For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has <code>*</code> for <code>CountryCode</code> is <code>*</code>, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:</p> <ul> <li> <p>The United States</p> </li> <li> <p>North America</p> </li> <li> <p>The default resource record set</p> </li> </ul> <p> <b>Specifying the Health Check Endpoint by Domain Name</b> </p> <p>If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each <code>HTTP</code> server that is serving content for <code>www.example.com</code>. For the value of <code>FullyQualifiedDomainName</code>, specify the domain name of the server (such as <code>us-east-2-www.example.com</code>), not the name of the resource record sets (<code>www.example.com</code>).</p> <important> <p>Health check results will be unpredictable if you do the following:</p> <ul> <li> <p>Create a health check that has the same value for <code>FullyQualifiedDomainName</code> as the name of a resource record set.</p> </li> <li> <p>Associate that health check with the resource record set.</p> </li> </ul> </important>" + }, + "multiValueAnswer": { + "type": "boolean", + "description": "<p> <i>Multivalue answer resource record sets only</i>: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify <code>true</code> for <code>MultiValueAnswer</code>. Note the following:</p> <ul> <li> <p>If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.</p> </li> <li> <p>If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.</p> </li> <li> <p>Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.</p> </li> <li> <p>If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.</p> </li> <li> <p>When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.</p> </li> <li> <p>If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.</p> </li> </ul> <p>You can't create multivalue answer alias records.</p>" + }, + "name": { + "type": "string", + "description": "<p>For <code>ChangeResourceRecordSets</code> requests, the name of the record that you want to create, update, or delete. For <code>ListResourceRecordSets</code> responses, the name of a record in the specified hosted zone.</p> <p> <b>ChangeResourceRecordSets Only</b> </p> <p>Enter a fully qualified domain name, for example, <code>www.example.com</code>. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats <code>www.example.com</code> (without a trailing dot) and <code>www.example.com.</code> (with a trailing dot) as identical.</p> <p>For information about how to specify characters other than <code>a-z</code>, <code>0-9</code>, and <code>-</code> (hyphen) and how to specify internationalized domain names, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html'>DNS Domain Name Format</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, <code>*.example.com</code>. Note the following:</p> <ul> <li> <p>The * must replace the entire label. For example, you can't specify <code>*prod.example.com</code> or <code>prod*.example.com</code>.</p> </li> <li> <p>The * can't replace any of the middle labels, for example, marketing.*.example.com.</p> </li> <li> <p>If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.</p> <important> <p>You can't use the * wildcard for resource records sets that have a type of NS.</p> </important> </li> </ul>" + }, + "region": { + "$ref": "#/definitions/ResourceRecordSetRegionEnumValue", + "description": "<p> <i>Latency-based resource record sets only:</i> The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.</p> <p>When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.</p> <p>Note the following:</p> <ul> <li> <p>You can only specify one <code>ResourceRecord</code> per latency resource record set.</p> </li> <li> <p>You can only create one latency resource record set for each Amazon EC2 Region.</p> </li> <li> <p>You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.</p> </li> <li> <p>You can't create non-latency resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as latency resource record sets.</p> </li> </ul>" + }, + "resourceRecords": { + "type": "array", + "description": "<p>Information about the resource records to act upon.</p> <note> <p>If you're creating an alias resource record set, omit <code>ResourceRecords</code>.</p> </note>", + "items": { + "$ref": "#/definitions/ResourceRecord" + }, + "x-ms-identifiers": [] + }, + "setIdentifier": { + "type": "string", + "description": "<p> <i>Resource record sets that have a routing policy other than simple:</i> An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of <code>SetIdentifier</code> must be unique for each resource record set. </p> <p>For information about routing policies, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html'>Choosing a Routing Policy</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>" + }, + "ttl": { + "type": "integer", + "format": "int64", + "description": "<p>The resource record cache time to live (TTL), in seconds. Note the following:</p> <ul> <li> <p>If you're creating or updating an alias resource record set, omit <code>TTL</code>. Amazon Route 53 uses the value of <code>TTL</code> for the alias target. </p> </li> <li> <p>If you're associating this resource record set with a health check (if you're adding a <code>HealthCheckId</code> element), we recommend that you specify a <code>TTL</code> of 60 seconds or less so clients respond quickly to changes in health status.</p> </li> <li> <p>All of the resource record sets in a group of weighted resource record sets must have the same value for <code>TTL</code>.</p> </li> <li> <p>If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a <code>TTL</code> of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for <code>Weight</code>.</p> </li> </ul>" + }, + "trafficPolicyInstanceId": { + "type": "string", + "description": "<p>When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. <code>TrafficPolicyInstanceId</code> is the ID of the traffic policy instance that Route 53 created this resource record set for.</p> <important> <p>To delete the resource record set that is associated with a traffic policy instance, use <code>DeleteTrafficPolicyInstance</code>. Route 53 will delete the resource record set automatically. If you delete the resource record set by using <code>ChangeResourceRecordSets</code>, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. </p> </important>" + }, + "type": { + "$ref": "#/definitions/RRTypeEnumValue", + "description": "<p>The DNS record type. For information about different record types and how data is encoded for them, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'>Supported DNS Resource Record Types</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>Valid values for basic resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>DS</code> |<code>MX</code> | <code>NAPTR</code> | <code>NS</code> | <code>PTR</code> | <code>SOA</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> </p> <p>Values for weighted, latency, geolocation, and failover resource record sets: <code>A</code> | <code>AAAA</code> | <code>CAA</code> | <code>CNAME</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code>. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.</p> <p>Valid values for multivalue answer resource record sets: <code>A</code> | <code>AAAA</code> | <code>MX</code> | <code>NAPTR</code> | <code>PTR</code> | <code>SPF</code> | <code>SRV</code> | <code>TXT</code> </p> <note> <p>SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of <code>Type</code> is <code>SPF</code>. RFC 7208, <i>Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1</i>, has been updated to say, '...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.' In RFC 7208, see section 14.1, <a href='http://tools.ietf.org/html/rfc7208#section-14.1'>The SPF DNS Record Type</a>.</p> </note> <p>Values for alias resource record sets:</p> <ul> <li> <p> <b>Amazon API Gateway custom regional APIs and edge-optimized APIs:</b> <code>A</code> </p> </li> <li> <p> <b>CloudFront distributions:</b> <code>A</code> </p> <p>If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of <code>A</code> and one with a value of <code>AAAA</code>. </p> </li> <li> <p> <b>Amazon API Gateway environment that has a regionalized subdomain</b>: <code>A</code> </p> </li> <li> <p> <b>ELB load balancers:</b> <code>A</code> | <code>AAAA</code> </p> </li> <li> <p> <b>Amazon S3 buckets:</b> <code>A</code> </p> </li> <li> <p> <b>Amazon Virtual Private Cloud interface VPC endpoints</b> <code>A</code> </p> </li> <li> <p> <b>Another resource record set in this hosted zone:</b> Specify the type of the resource record set that you're creating the alias for. All values are supported except <code>NS</code> and <code>SOA</code>.</p> <note> <p>If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of <code>Type</code> is <code>CNAME</code>. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.</p> </note> </li> </ul>" + }, + "weight": { + "type": "integer", + "format": "int64", + "description": "<p> <i>Weighted resource record sets only:</i> Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:</p> <ul> <li> <p>You must specify a value for the <code>Weight</code> element for every weighted resource record set.</p> </li> <li> <p>You can only specify one <code>ResourceRecord</code> per weighted resource record set.</p> </li> <li> <p>You can't create latency, failover, or geolocation resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements as weighted resource record sets.</p> </li> <li> <p>You can create a maximum of 100 weighted resource record sets that have the same values for the <code>Name</code> and <code>Type</code> elements.</p> </li> <li> <p>For weighted (but not weighted alias) resource record sets, if you set <code>Weight</code> to <code>0</code> for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set <code>Weight</code> to <code>0</code> for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.</p> <p>The effect of setting <code>Weight</code> to <code>0</code> is different when you associate health checks with weighted resource record sets. For more information, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html'>Options for Configuring Route 53 Active-Active and Active-Passive Failover</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> </li> </ul>" + } + } + }, + "CidrRoutingConfig": { + "type": "object", + "description": "Definition of CidrRoutingConfig", + "properties": { + "collectionId": { + "type": "string", + "description": "<p>The CIDR collection ID.</p>" + }, + "locationName": { + "type": "string", + "description": "<p>The CIDR collection location name.</p>" + } + } + }, + "Coordinates": { + "type": "object", + "description": "Definition of Coordinates", + "properties": { + "latitude": { + "type": "string", + "description": "<p> Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). </p>" + }, + "longitude": { + "type": "string", + "description": "<p> Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). </p>" + } + } + }, + "GeoLocation": { + "type": "object", + "description": "Definition of GeoLocation", + "properties": { + "continentCode": { + "type": "string", + "description": "<p>The two-letter code for the continent.</p> <p>Amazon Route 53 supports the following continent codes:</p> <ul> <li> <p> <b>AF</b>: Africa</p> </li> <li> <p> <b>AN</b>: Antarctica</p> </li> <li> <p> <b>AS</b>: Asia</p> </li> <li> <p> <b>EU</b>: Europe</p> </li> <li> <p> <b>OC</b>: Oceania</p> </li> <li> <p> <b>NA</b>: North America</p> </li> <li> <p> <b>SA</b>: South America</p> </li> </ul> <p>Constraint: Specifying <code>ContinentCode</code> with either <code>CountryCode</code> or <code>SubdivisionCode</code> returns an <code>InvalidInput</code> error.</p>" + }, + "countryCode": { + "type": "string", + "description": "<p>For geolocation resource record sets, the two-letter code for a country.</p> <p>Amazon Route 53 uses the two-letter country codes that are specified in <a href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'>ISO standard 3166-1 alpha-2</a>.</p> <p>Route 53 also supports the country code <b>UA</b> for Ukraine.</p>" + }, + "subdivisionCode": { + "type": "string", + "description": "<p>For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for <code>SubdivisionCode</code>. For a list of state abbreviations, see <a href='https://pe.usps.com/text/pub28/28apb.htm'>Appendix B: Two–Letter State and Possession Abbreviations</a> on the United States Postal Service website. </p> <p>If you specify <code>subdivisioncode</code>, you must also specify <code>US</code> for <code>CountryCode</code>. </p>" + } + } + }, + "GeoProximityLocation": { + "type": "object", + "description": "Definition of GeoProximityLocation", + "properties": { + "awsRegion": { + "type": "string", + "description": "<p> The Amazon Web Services Region the resource you are directing DNS traffic to, is in. </p>" + }, + "bias": { + "type": "integer", + "format": "int32", + "description": "<p> The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. </p> <p>To use <code>Bias</code> to change the size of the geographic region, specify the applicable value for the bias:</p> <ul> <li> <p>To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. </p> </li> <li> <p>To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. </p> </li> </ul>" + }, + "coordinates": { + "$ref": "#/definitions/Coordinates", + "description": "<p> Contains the longitude and latitude for a geographic region. </p>" + }, + "localZoneGroup": { + "type": "string", + "description": "<p> Specifies an Amazon Web Services Local Zone Group. </p> <p>A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is <code>us-east-1-bue-1a</code> the Local Zone Group is <code>us-east-1-bue-1</code>.</p> <p>You can identify the Local Zones Group for a specific Local Zone by using the <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html'>describe-availability-zones</a> CLI command:</p> <p>This command returns: <code>'GroupName': 'us-west-2-den-1'</code>, specifying that the Local Zone <code>us-west-2-den-1a</code> belongs to the Local Zone Group <code>us-west-2-den-1</code>.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RRType": { + "type": "string", + "description": "RRType enum", + "enum": [ + "A", + "AAAA", + "CAA", + "CNAME", + "DS", + "MX", + "NAPTR", + "NS", + "PTR", + "SOA", + "SPF", + "SRV", + "TXT" + ], + "x-ms-enum": { + "name": "RRType", + "modelAsString": true, + "values": [ + { + "name": "A", + "value": "A", + "description": "RRType enum A" + }, + { + "name": "AAAA", + "value": "AAAA", + "description": "RRType enum AAAA" + }, + { + "name": "CAA", + "value": "CAA", + "description": "RRType enum CAA" + }, + { + "name": "CNAME", + "value": "CNAME", + "description": "RRType enum CNAME" + }, + { + "name": "DS", + "value": "DS", + "description": "RRType enum DS" + }, + { + "name": "MX", + "value": "MX", + "description": "RRType enum MX" + }, + { + "name": "NAPTR", + "value": "NAPTR", + "description": "RRType enum NAPTR" + }, + { + "name": "NS", + "value": "NS", + "description": "RRType enum NS" + }, + { + "name": "PTR", + "value": "PTR", + "description": "RRType enum PTR" + }, + { + "name": "SOA", + "value": "SOA", + "description": "RRType enum SOA" + }, + { + "name": "SPF", + "value": "SPF", + "description": "RRType enum SPF" + }, + { + "name": "SRV", + "value": "SRV", + "description": "RRType enum SRV" + }, + { + "name": "TXT", + "value": "TXT", + "description": "RRType enum TXT" + } + ] + } + }, + "RRTypeEnumValue": { + "type": "object", + "description": "Definition of RRTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/RRType", + "description": "Property value" + } + } + }, + "ResourceRecord": { + "type": "object", + "description": "Definition of ResourceRecord", + "properties": { + "value": { + "type": "string", + "description": "<p>The current or new DNS record value, not to exceed 4,000 characters. In the case of a <code>DELETE</code> action, if the current value does not match the actual value, an error is returned. For descriptions about how to format <code>Value</code> for different record types, see <a href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'>Supported DNS Resource Record Types</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>You can specify more than one value for all record types except <code>CNAME</code> and <code>SOA</code>. </p> <note> <p>If you're creating an alias resource record set, omit <code>Value</code>.</p> </note>" + } + } + }, + "ResourceRecordSetFailover": { + "type": "string", + "description": "ResourceRecordSetFailover enum", + "enum": [ + "PRIMARY", + "SECONDARY" + ], + "x-ms-enum": { + "name": "ResourceRecordSetFailover", + "modelAsString": true, + "values": [ + { + "name": "PRIMARY", + "value": "PRIMARY", + "description": "ResourceRecordSetFailover enum PRIMARY" + }, + { + "name": "SECONDARY", + "value": "SECONDARY", + "description": "ResourceRecordSetFailover enum SECONDARY" + } + ] + } + }, + "ResourceRecordSetFailoverEnumValue": { + "type": "object", + "description": "Definition of ResourceRecordSetFailoverEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ResourceRecordSetFailover", + "description": "Property value" + } + } + }, + "ResourceRecordSetRegion": { + "type": "string", + "description": "ResourceRecordSetRegion enum", + "enum": [ + "af-south-1", + "ap-east-1", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "ap-south-1", + "ap-south-2", + "ap-southeast-1", + "ap-southeast-2", + "ap-southeast-3", + "ap-southeast-4", + "ca-central-1", + "ca-west-1", + "cn-north-1", + "cn-northwest-1", + "eu-central-1", + "eu-central-2", + "eu-north-1", + "eu-south-1", + "eu-south-2", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "il-central-1", + "me-central-1", + "me-south-1", + "sa-east-1", + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2" + ], + "x-ms-enum": { + "name": "ResourceRecordSetRegion", + "modelAsString": true, + "values": [ + { + "name": "AfSouth1", + "value": "af-south-1", + "description": "ResourceRecordSetRegion enum af-south-1" + }, + { + "name": "ApEast1", + "value": "ap-east-1", + "description": "ResourceRecordSetRegion enum ap-east-1" + }, + { + "name": "ApNortheast1", + "value": "ap-northeast-1", + "description": "ResourceRecordSetRegion enum ap-northeast-1" + }, + { + "name": "ApNortheast2", + "value": "ap-northeast-2", + "description": "ResourceRecordSetRegion enum ap-northeast-2" + }, + { + "name": "ApNortheast3", + "value": "ap-northeast-3", + "description": "ResourceRecordSetRegion enum ap-northeast-3" + }, + { + "name": "ApSouth1", + "value": "ap-south-1", + "description": "ResourceRecordSetRegion enum ap-south-1" + }, + { + "name": "ApSouth2", + "value": "ap-south-2", + "description": "ResourceRecordSetRegion enum ap-south-2" + }, + { + "name": "ApSoutheast1", + "value": "ap-southeast-1", + "description": "ResourceRecordSetRegion enum ap-southeast-1" + }, + { + "name": "ApSoutheast2", + "value": "ap-southeast-2", + "description": "ResourceRecordSetRegion enum ap-southeast-2" + }, + { + "name": "ApSoutheast3", + "value": "ap-southeast-3", + "description": "ResourceRecordSetRegion enum ap-southeast-3" + }, + { + "name": "ApSoutheast4", + "value": "ap-southeast-4", + "description": "ResourceRecordSetRegion enum ap-southeast-4" + }, + { + "name": "CaCentral1", + "value": "ca-central-1", + "description": "ResourceRecordSetRegion enum ca-central-1" + }, + { + "name": "CaWest1", + "value": "ca-west-1", + "description": "ResourceRecordSetRegion enum ca-west-1" + }, + { + "name": "CnNorth1", + "value": "cn-north-1", + "description": "ResourceRecordSetRegion enum cn-north-1" + }, + { + "name": "CnNorthwest1", + "value": "cn-northwest-1", + "description": "ResourceRecordSetRegion enum cn-northwest-1" + }, + { + "name": "EuCentral1", + "value": "eu-central-1", + "description": "ResourceRecordSetRegion enum eu-central-1" + }, + { + "name": "EuCentral2", + "value": "eu-central-2", + "description": "ResourceRecordSetRegion enum eu-central-2" + }, + { + "name": "EuNorth1", + "value": "eu-north-1", + "description": "ResourceRecordSetRegion enum eu-north-1" + }, + { + "name": "EuSouth1", + "value": "eu-south-1", + "description": "ResourceRecordSetRegion enum eu-south-1" + }, + { + "name": "EuSouth2", + "value": "eu-south-2", + "description": "ResourceRecordSetRegion enum eu-south-2" + }, + { + "name": "EuWest1", + "value": "eu-west-1", + "description": "ResourceRecordSetRegion enum eu-west-1" + }, + { + "name": "EuWest2", + "value": "eu-west-2", + "description": "ResourceRecordSetRegion enum eu-west-2" + }, + { + "name": "EuWest3", + "value": "eu-west-3", + "description": "ResourceRecordSetRegion enum eu-west-3" + }, + { + "name": "IlCentral1", + "value": "il-central-1", + "description": "ResourceRecordSetRegion enum il-central-1" + }, + { + "name": "MeCentral1", + "value": "me-central-1", + "description": "ResourceRecordSetRegion enum me-central-1" + }, + { + "name": "MeSouth1", + "value": "me-south-1", + "description": "ResourceRecordSetRegion enum me-south-1" + }, + { + "name": "SaEast1", + "value": "sa-east-1", + "description": "ResourceRecordSetRegion enum sa-east-1" + }, + { + "name": "UsEast1", + "value": "us-east-1", + "description": "ResourceRecordSetRegion enum us-east-1" + }, + { + "name": "UsEast2", + "value": "us-east-2", + "description": "ResourceRecordSetRegion enum us-east-2" + }, + { + "name": "UsWest1", + "value": "us-west-1", + "description": "ResourceRecordSetRegion enum us-west-1" + }, + { + "name": "UsWest2", + "value": "us-west-2", + "description": "ResourceRecordSetRegion enum us-west-2" + } + ] + } + }, + "ResourceRecordSetRegionEnumValue": { + "type": "object", + "description": "Definition of ResourceRecordSetRegionEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ResourceRecordSetRegion", + "description": "Property value" + } + } + }, + "Route53ResourceRecordSet": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Route53ResourceRecordSetProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Route53ResourceRecordSetListResult": { + "type": "object", + "description": "The response of a Route53ResourceRecordSet list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Route53ResourceRecordSet items on this page", + "items": { + "$ref": "#/definitions/Route53ResourceRecordSet" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Route53ResourceRecordSetProperties": { + "type": "object", + "description": "Definition of Route53ResourceRecordSet", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsRoute53ResourceRecordSetProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Route53ResourceRecordSetTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Route53ResourceRecordSet resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3AccessPoint.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3AccessPoint.json new file mode 100644 index 000000000000..fabbbb8f2a03 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3AccessPoint.json @@ -0,0 +1,633 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "S3AccessPoints" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/s3AccessPoints": { + "get": { + "operationId": "S3AccessPoints_ListBySubscription", + "tags": [ + "S3AccessPoints" + ], + "description": "List S3AccessPoint resources 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/S3AccessPointListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3AccessPoints_ListBySubscription": { + "$ref": "./examples/S3AccessPoints_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3AccessPoints": { + "get": { + "operationId": "S3AccessPoints_ListByResourceGroup", + "tags": [ + "S3AccessPoints" + ], + "description": "List S3AccessPoint resources 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/S3AccessPointListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3AccessPoints_ListByResourceGroup": { + "$ref": "./examples/S3AccessPoints_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3AccessPoints/{name}": { + "get": { + "operationId": "S3AccessPoints_Get", + "tags": [ + "S3AccessPoints" + ], + "description": "Get a S3AccessPoint", + "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": "name", + "in": "path", + "description": "Name of S3AccessPoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3AccessPoint" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3AccessPoints_Get": { + "$ref": "./examples/S3AccessPoints_Get.json" + } + } + }, + "put": { + "operationId": "S3AccessPoints_CreateOrReplace", + "tags": [ + "S3AccessPoints" + ], + "description": "Create a S3AccessPoint. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of S3AccessPoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/S3AccessPoint" + } + } + ], + "responses": { + "200": { + "description": "Resource 'S3AccessPoint' update operation succeeded", + "schema": { + "$ref": "#/definitions/S3AccessPoint" + } + }, + "201": { + "description": "Resource 'S3AccessPoint' create operation succeeded", + "schema": { + "$ref": "#/definitions/S3AccessPoint" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "S3AccessPoints_CreateOrReplace": { + "$ref": "./examples/S3AccessPoints_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "S3AccessPoints_Update", + "tags": [ + "S3AccessPoints" + ], + "description": "Update a S3AccessPoint", + "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": "name", + "in": "path", + "description": "Name of S3AccessPoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/S3AccessPointTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3AccessPoint" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3AccessPoints_Update": { + "$ref": "./examples/S3AccessPoints_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "S3AccessPoints_Delete", + "tags": [ + "S3AccessPoints" + ], + "description": "Delete a S3AccessPoint", + "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": "name", + "in": "path", + "description": "Name of S3AccessPoint", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "S3AccessPoints_Delete": { + "$ref": "./examples/S3AccessPoints_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsS3AccessPointProperties": { + "type": "object", + "description": "Definition of awsS3AccessPoint", + "properties": { + "alias": { + "type": "string", + "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications." + }, + "arn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the specified accesspoint. the Amazon Resource Name (ARN) of the specified accesspoint." + }, + "bucket": { + "type": "string", + "description": "The name of the bucket that you want to associate this Access Point with." + }, + "bucketAccountId": { + "type": "string", + "description": "The AWS account ID associated with the S3 bucket associated with this access point." + }, + "name": { + "type": "string", + "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name." + }, + "networkOrigin": { + "$ref": "#/definitions/NetworkOrigin", + "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies." + }, + "policy": { + "description": "The Access Point Policy you want to apply to this access point." + }, + "publicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." + }, + "vpcConfiguration": { + "$ref": "#/definitions/VpcConfiguration", + "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). The Virtual Private Cloud (VPC) configuration for a bucket access point." + } + } + }, + "NetworkOrigin": { + "type": "string", + "description": "NetworkOrigin enum", + "enum": [ + "Internet", + "VPC" + ], + "x-ms-enum": { + "name": "NetworkOrigin", + "modelAsString": true, + "values": [ + { + "name": "Internet", + "value": "Internet", + "description": "NetworkOrigin enum Internet" + }, + { + "name": "VPC", + "value": "VPC", + "description": "NetworkOrigin enum VPC" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "PublicAccessBlockConfiguration": { + "type": "object", + "description": "Definition of PublicAccessBlockConfiguration", + "properties": { + "blockPublicAcls": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:- PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. - PUT Object calls fail if the request includes a public ACL.. - PUT Bucket calls fail if the request includes a public ACL.Enabling this setting doesn't affect existing policies or ACLs." + }, + "blockPublicPolicy": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." + }, + "ignorePublicAcls": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." + }, + "restrictPublicBuckets": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." + } + } + }, + "S3AccessPoint": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/S3AccessPointProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "S3AccessPointListResult": { + "type": "object", + "description": "The response of a S3AccessPoint list operation.", + "properties": { + "value": { + "type": "array", + "description": "The S3AccessPoint items on this page", + "items": { + "$ref": "#/definitions/S3AccessPoint" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "S3AccessPointProperties": { + "type": "object", + "description": "Definition of S3AccessPoint", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsS3AccessPointProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "S3AccessPointTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in S3AccessPoint resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VpcConfiguration": { + "type": "object", + "description": "Definition of VpcConfiguration", + "properties": { + "vpcId": { + "type": "string", + "description": "If this field is specified, this access point will only allow connections from the specified VPC ID." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3Bucket.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3Bucket.json new file mode 100644 index 000000000000..6fb129ef2480 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3Bucket.json @@ -0,0 +1,2633 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "S3Buckets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/s3Buckets": { + "get": { + "operationId": "S3Buckets_ListBySubscription", + "tags": [ + "S3Buckets" + ], + "description": "List S3Bucket resources 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/S3BucketListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3Buckets_ListBySubscription": { + "$ref": "./examples/S3Buckets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3Buckets": { + "get": { + "operationId": "S3Buckets_ListByResourceGroup", + "tags": [ + "S3Buckets" + ], + "description": "List S3Bucket resources 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/S3BucketListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3Buckets_ListByResourceGroup": { + "$ref": "./examples/S3Buckets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3Buckets/{name}": { + "get": { + "operationId": "S3Buckets_Get", + "tags": [ + "S3Buckets" + ], + "description": "Get a S3Bucket", + "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": "name", + "in": "path", + "description": "Name of S3Bucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3Bucket" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3Buckets_Get": { + "$ref": "./examples/S3Buckets_Get.json" + } + } + }, + "put": { + "operationId": "S3Buckets_CreateOrReplace", + "tags": [ + "S3Buckets" + ], + "description": "Create a S3Bucket. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of S3Bucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/S3Bucket" + } + } + ], + "responses": { + "200": { + "description": "Resource 'S3Bucket' update operation succeeded", + "schema": { + "$ref": "#/definitions/S3Bucket" + } + }, + "201": { + "description": "Resource 'S3Bucket' create operation succeeded", + "schema": { + "$ref": "#/definitions/S3Bucket" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "S3Buckets_CreateOrReplace": { + "$ref": "./examples/S3Buckets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "S3Buckets_Update", + "tags": [ + "S3Buckets" + ], + "description": "Update a S3Bucket", + "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": "name", + "in": "path", + "description": "Name of S3Bucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/S3BucketTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3Bucket" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3Buckets_Update": { + "$ref": "./examples/S3Buckets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "S3Buckets_Delete", + "tags": [ + "S3Buckets" + ], + "description": "Delete a S3Bucket", + "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": "name", + "in": "path", + "description": "Name of S3Bucket", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "S3Buckets_Delete": { + "$ref": "./examples/S3Buckets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AbortIncompleteMultipartUpload": { + "type": "object", + "description": "Definition of AbortIncompleteMultipartUpload", + "properties": { + "daysAfterInitiation": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload." + } + } + }, + "AccelerateConfiguration": { + "type": "object", + "description": "Definition of AccelerateConfiguration", + "properties": { + "accelerationStatus": { + "$ref": "#/definitions/AccelerateConfigurationAccelerationStatus", + "description": "Specifies the transfer acceleration status of the bucket." + } + } + }, + "AccelerateConfigurationAccelerationStatus": { + "type": "string", + "description": "AccelerateConfigurationAccelerationStatus enum", + "enum": [ + "Enabled", + "Suspended" + ], + "x-ms-enum": { + "name": "AccelerateConfigurationAccelerationStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "AccelerateConfigurationAccelerationStatus enum Enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "AccelerateConfigurationAccelerationStatus enum Suspended" + } + ] + } + }, + "AccessControl": { + "type": "string", + "description": "AccessControl enum", + "enum": [ + "AuthenticatedRead", + "AwsExecRead", + "BucketOwnerFullControl", + "BucketOwnerRead", + "LogDeliveryWrite", + "Private", + "PublicRead", + "PublicReadWrite" + ], + "x-ms-enum": { + "name": "AccessControl", + "modelAsString": true, + "values": [ + { + "name": "AuthenticatedRead", + "value": "AuthenticatedRead", + "description": "AccessControl enum AuthenticatedRead" + }, + { + "name": "AwsExecRead", + "value": "AwsExecRead", + "description": "AccessControl enum AwsExecRead" + }, + { + "name": "BucketOwnerFullControl", + "value": "BucketOwnerFullControl", + "description": "AccessControl enum BucketOwnerFullControl" + }, + { + "name": "BucketOwnerRead", + "value": "BucketOwnerRead", + "description": "AccessControl enum BucketOwnerRead" + }, + { + "name": "LogDeliveryWrite", + "value": "LogDeliveryWrite", + "description": "AccessControl enum LogDeliveryWrite" + }, + { + "name": "Private", + "value": "Private", + "description": "AccessControl enum Private" + }, + { + "name": "PublicRead", + "value": "PublicRead", + "description": "AccessControl enum PublicRead" + }, + { + "name": "PublicReadWrite", + "value": "PublicReadWrite", + "description": "AccessControl enum PublicReadWrite" + } + ] + } + }, + "AccessControlTranslation": { + "type": "object", + "description": "Definition of AccessControlTranslation", + "properties": { + "owner": { + "type": "string", + "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*." + } + } + }, + "AnalyticsConfiguration": { + "type": "object", + "description": "Definition of AnalyticsConfiguration", + "properties": { + "id": { + "type": "string", + "description": "The ID that identifies the analytics configuration." + }, + "prefix": { + "type": "string", + "description": "The prefix that an object must have to be included in the analytics results." + }, + "storageClassAnalysis": { + "$ref": "#/definitions/StorageClassAnalysis", + "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket." + }, + "tagFilters": { + "type": "array", + "description": "The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis.", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "AwsS3BucketProperties": { + "type": "object", + "description": "Definition of awsS3Bucket", + "properties": { + "accelerateConfiguration": { + "$ref": "#/definitions/AccelerateConfiguration", + "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." + }, + "accessControl": { + "$ref": "#/definitions/AccessControl", + "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*." + }, + "analyticsConfigurations": { + "type": "array", + "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.", + "items": { + "$ref": "#/definitions/AnalyticsConfiguration" + }, + "x-ms-identifiers": [] + }, + "arn": { + "type": "string", + "description": "the Amazon Resource Name (ARN) of the specified bucket." + }, + "bucketEncryption": { + "$ref": "#/definitions/BucketEncryption", + "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." + }, + "bucketName": { + "type": "string", + "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name." + }, + "corsConfiguration": { + "$ref": "#/definitions/CorsConfiguration", + "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." + }, + "domainName": { + "type": "string", + "description": "Property domainName" + }, + "dualStackDomainName": { + "type": "string", + "description": "Property dualStackDomainName" + }, + "intelligentTieringConfigurations": { + "type": "array", + "description": "Defines how Amazon S3 handles Intelligent-Tiering storage.", + "items": { + "$ref": "#/definitions/IntelligentTieringConfiguration" + }, + "x-ms-identifiers": [] + }, + "inventoryConfigurations": { + "type": "array", + "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*.", + "items": { + "$ref": "#/definitions/InventoryConfiguration" + }, + "x-ms-identifiers": [] + }, + "lifecycleConfiguration": { + "$ref": "#/definitions/LifecycleConfiguration", + "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." + }, + "loggingConfiguration": { + "$ref": "#/definitions/LoggingConfiguration", + "description": "Settings that define where logs are stored. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*. To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions." + }, + "metricsConfigurations": { + "type": "array", + "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html).", + "items": { + "$ref": "#/definitions/MetricsConfiguration" + }, + "x-ms-identifiers": [] + }, + "notificationConfiguration": { + "$ref": "#/definitions/NotificationConfiguration", + "description": "Configuration that defines how Amazon S3 handles bucket notifications. Describes the notification configuration for an Amazon S3 bucket. If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3)." + }, + "objectLockConfiguration": { + "$ref": "#/definitions/ObjectLockConfiguration", + "description": "This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html)." + }, + "objectLockEnabled": { + "type": "boolean", + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." + }, + "ownershipControls": { + "$ref": "#/definitions/OwnershipControls", + "description": "Configuration that defines how Amazon S3 handles Object Ownership rules. Specifies the container element for Object Ownership rules. S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*." + }, + "publicAccessBlockConfiguration": { + "$ref": "#/definitions/PublicAccessBlockConfiguration", + "description": "Configuration that defines how Amazon S3 handles public access. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of 'Public'](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*." + }, + "regionalDomainName": { + "type": "string", + "description": "Property regionalDomainName" + }, + "replicationConfiguration": { + "$ref": "#/definitions/ReplicationConfiguration", + "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*." + }, + "tags": { + "type": "array", + "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "versioningConfiguration": { + "$ref": "#/definitions/VersioningConfiguration", + "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*." + }, + "websiteConfiguration": { + "$ref": "#/definitions/WebsiteConfiguration", + "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Specifies website configuration parameters for an Amazon S3 bucket." + }, + "websiteURL": { + "type": "string", + "description": "Property websiteURL" + } + } + }, + "BucketEncryption": { + "type": "object", + "description": "Definition of BucketEncryption", + "properties": { + "serverSideEncryptionConfiguration": { + "type": "array", + "description": "Specifies the default server-side-encryption configuration.", + "items": { + "$ref": "#/definitions/ServerSideEncryptionRule" + }, + "x-ms-identifiers": [] + } + } + }, + "CorsConfiguration": { + "type": "object", + "description": "Definition of CorsConfiguration", + "properties": { + "corsRules": { + "type": "array", + "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "x-ms-identifiers": [] + } + } + }, + "CorsRule": { + "type": "object", + "description": "Definition of CorsRule", + "properties": { + "allowedHeaders": { + "type": "array", + "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "allowedMethods": { + "type": "array", + "description": "An HTTP method that you allow the origin to run. *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``", + "items": { + "$ref": "#/definitions/CorsRuleAllowedMethods" + }, + "x-ms-identifiers": [] + }, + "allowedOrigins": { + "type": "array", + "description": "One or more origins you want customers to be able to access the bucket from.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "exposedHeaders": { + "type": "array", + "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object).", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "id": { + "type": "string", + "description": "A unique identifier for this rule. The value must be no more than 255 characters." + }, + "maxAge": { + "type": "integer", + "format": "int32", + "description": "The time in seconds that your browser is to cache the preflight response for the specified resource." + } + } + }, + "CorsRuleAllowedMethods": { + "type": "string", + "description": "CorsRuleAllowedMethods enum", + "enum": [ + "DELETE", + "GET", + "HEAD", + "POST", + "PUT" + ], + "x-ms-enum": { + "name": "CorsRuleAllowedMethods", + "modelAsString": true, + "values": [ + { + "name": "DELETE", + "value": "DELETE", + "description": "CorsRuleAllowedMethods enum DELETE" + }, + { + "name": "GET", + "value": "GET", + "description": "CorsRuleAllowedMethods enum GET" + }, + { + "name": "HEAD", + "value": "HEAD", + "description": "CorsRuleAllowedMethods enum HEAD" + }, + { + "name": "POST", + "value": "POST", + "description": "CorsRuleAllowedMethods enum POST" + }, + { + "name": "PUT", + "value": "PUT", + "description": "CorsRuleAllowedMethods enum PUT" + } + ] + } + }, + "DataExport": { + "type": "object", + "description": "Definition of DataExport", + "properties": { + "destination": { + "$ref": "#/definitions/Destination", + "description": "The place to store the data for an analysis. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." + }, + "outputSchemaVersion": { + "type": "string", + "description": "The version of the output schema to use when exporting data. Must be ``V_1``." + } + } + }, + "DefaultRetention": { + "type": "object", + "description": "Definition of DefaultRetention", + "properties": { + "days": { + "type": "integer", + "format": "int32", + "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + }, + "mode": { + "$ref": "#/definitions/DefaultRetentionMode", + "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + }, + "years": { + "type": "integer", + "format": "int32", + "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." + } + } + }, + "DefaultRetentionMode": { + "type": "string", + "description": "DefaultRetentionMode enum", + "enum": [ + "COMPLIANCE", + "GOVERNANCE" + ], + "x-ms-enum": { + "name": "DefaultRetentionMode", + "modelAsString": true, + "values": [ + { + "name": "COMPLIANCE", + "value": "COMPLIANCE", + "description": "DefaultRetentionMode enum COMPLIANCE" + }, + { + "name": "GOVERNANCE", + "value": "GOVERNANCE", + "description": "DefaultRetentionMode enum GOVERNANCE" + } + ] + } + }, + "DeleteMarkerReplication": { + "type": "object", + "description": "Definition of DeleteMarkerReplication", + "properties": { + "status": { + "$ref": "#/definitions/DeleteMarkerReplicationStatus", + "description": "Indicates whether to replicate delete markers. Disabled by default." + } + } + }, + "DeleteMarkerReplicationStatus": { + "type": "string", + "description": "DeleteMarkerReplicationStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "DeleteMarkerReplicationStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "DeleteMarkerReplicationStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "DeleteMarkerReplicationStatus enum Enabled" + } + ] + } + }, + "Destination": { + "type": "object", + "description": "Definition of Destination", + "properties": { + "bucketAccountId": { + "type": "string", + "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes." + }, + "bucketArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported." + }, + "format": { + "$ref": "#/definitions/DestinationFormat", + "description": "Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``" + }, + "prefix": { + "type": "string", + "description": "The prefix to use when exporting data. The prefix is prepended to all results." + } + } + }, + "DestinationFormat": { + "type": "string", + "description": "DestinationFormat enum", + "enum": [ + "CSV", + "ORC", + "Parquet" + ], + "x-ms-enum": { + "name": "DestinationFormat", + "modelAsString": true, + "values": [ + { + "name": "CSV", + "value": "CSV", + "description": "DestinationFormat enum CSV" + }, + { + "name": "ORC", + "value": "ORC", + "description": "DestinationFormat enum ORC" + }, + { + "name": "Parquet", + "value": "Parquet", + "description": "DestinationFormat enum Parquet" + } + ] + } + }, + "EncryptionConfiguration": { + "type": "object", + "description": "Definition of EncryptionConfiguration", + "properties": { + "replicaKmsKeyID": { + "type": "string", + "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." + } + } + }, + "EventBridgeConfiguration": { + "type": "object", + "description": "Definition of EventBridgeConfiguration", + "properties": { + "eventBridgeEnabled": { + "type": "boolean", + "description": "Enables delivery of events to Amazon EventBridge.", + "default": true + } + } + }, + "FilterRule": { + "type": "object", + "description": "Definition of FilterRule", + "properties": { + "name": { + "type": "string", + "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "value": { + "type": "string", + "description": "The value that the filter searches for in object key names." + } + } + }, + "IntelligentTieringConfiguration": { + "type": "object", + "description": "Definition of IntelligentTieringConfiguration", + "properties": { + "id": { + "type": "string", + "description": "The ID used to identify the S3 Intelligent-Tiering configuration." + }, + "prefix": { + "type": "string", + "description": "An object key name prefix that identifies the subset of objects to which the rule applies." + }, + "status": { + "$ref": "#/definitions/IntelligentTieringConfigurationStatus", + "description": "Specifies the status of the configuration." + }, + "tagFilters": { + "type": "array", + "description": "A container for a key-value pair.", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "x-ms-identifiers": [] + }, + "tierings": { + "type": "array", + "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers.", + "items": { + "$ref": "#/definitions/Tiering" + }, + "x-ms-identifiers": [] + } + } + }, + "IntelligentTieringConfigurationStatus": { + "type": "string", + "description": "IntelligentTieringConfigurationStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "IntelligentTieringConfigurationStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "IntelligentTieringConfigurationStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "IntelligentTieringConfigurationStatus enum Enabled" + } + ] + } + }, + "InventoryConfiguration": { + "type": "object", + "description": "Definition of InventoryConfiguration", + "properties": { + "destination": { + "$ref": "#/definitions/Destination", + "description": "Contains information about where to publish the inventory results. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated." + }, + "id": { + "type": "string", + "description": "The ID used to identify the inventory configuration." + }, + "includedObjectVersions": { + "$ref": "#/definitions/InventoryConfigurationIncludedObjectVersions", + "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields." + }, + "optionalFields": { + "type": "array", + "description": "Contains the optional fields that are included in the inventory results.", + "items": { + "$ref": "#/definitions/InventoryConfigurationOptionalFields" + }, + "x-ms-identifiers": [] + }, + "prefix": { + "type": "string", + "description": "Specifies the inventory filter prefix." + }, + "scheduleFrequency": { + "$ref": "#/definitions/InventoryConfigurationScheduleFrequency", + "description": "Specifies the schedule for generating inventory results." + } + } + }, + "InventoryConfigurationIncludedObjectVersions": { + "type": "string", + "description": "InventoryConfigurationIncludedObjectVersions enum", + "enum": [ + "All", + "Current" + ], + "x-ms-enum": { + "name": "InventoryConfigurationIncludedObjectVersions", + "modelAsString": true, + "values": [ + { + "name": "All", + "value": "All", + "description": "InventoryConfigurationIncludedObjectVersions enum All" + }, + { + "name": "Current", + "value": "Current", + "description": "InventoryConfigurationIncludedObjectVersions enum Current" + } + ] + } + }, + "InventoryConfigurationOptionalFields": { + "type": "string", + "description": "InventoryConfigurationOptionalFields enum", + "enum": [ + "BucketKeyStatus", + "ChecksumAlgorithm", + "ETag", + "EncryptionStatus", + "IntelligentTieringAccessTier", + "IsMultipartUploaded", + "LastModifiedDate", + "ObjectAccessControlList", + "ObjectLockLegalHoldStatus", + "ObjectLockMode", + "ObjectLockRetainUntilDate", + "ObjectOwner", + "ReplicationStatus", + "Size", + "StorageClass" + ], + "x-ms-enum": { + "name": "InventoryConfigurationOptionalFields", + "modelAsString": true, + "values": [ + { + "name": "BucketKeyStatus", + "value": "BucketKeyStatus", + "description": "InventoryConfigurationOptionalFields enum BucketKeyStatus" + }, + { + "name": "ChecksumAlgorithm", + "value": "ChecksumAlgorithm", + "description": "InventoryConfigurationOptionalFields enum ChecksumAlgorithm" + }, + { + "name": "ETag", + "value": "ETag", + "description": "InventoryConfigurationOptionalFields enum ETag" + }, + { + "name": "EncryptionStatus", + "value": "EncryptionStatus", + "description": "InventoryConfigurationOptionalFields enum EncryptionStatus" + }, + { + "name": "IntelligentTieringAccessTier", + "value": "IntelligentTieringAccessTier", + "description": "InventoryConfigurationOptionalFields enum IntelligentTieringAccessTier" + }, + { + "name": "IsMultipartUploaded", + "value": "IsMultipartUploaded", + "description": "InventoryConfigurationOptionalFields enum IsMultipartUploaded" + }, + { + "name": "LastModifiedDate", + "value": "LastModifiedDate", + "description": "InventoryConfigurationOptionalFields enum LastModifiedDate" + }, + { + "name": "ObjectAccessControlList", + "value": "ObjectAccessControlList", + "description": "InventoryConfigurationOptionalFields enum ObjectAccessControlList" + }, + { + "name": "ObjectLockLegalHoldStatus", + "value": "ObjectLockLegalHoldStatus", + "description": "InventoryConfigurationOptionalFields enum ObjectLockLegalHoldStatus" + }, + { + "name": "ObjectLockMode", + "value": "ObjectLockMode", + "description": "InventoryConfigurationOptionalFields enum ObjectLockMode" + }, + { + "name": "ObjectLockRetainUntilDate", + "value": "ObjectLockRetainUntilDate", + "description": "InventoryConfigurationOptionalFields enum ObjectLockRetainUntilDate" + }, + { + "name": "ObjectOwner", + "value": "ObjectOwner", + "description": "InventoryConfigurationOptionalFields enum ObjectOwner" + }, + { + "name": "ReplicationStatus", + "value": "ReplicationStatus", + "description": "InventoryConfigurationOptionalFields enum ReplicationStatus" + }, + { + "name": "Size", + "value": "Size", + "description": "InventoryConfigurationOptionalFields enum Size" + }, + { + "name": "StorageClass", + "value": "StorageClass", + "description": "InventoryConfigurationOptionalFields enum StorageClass" + } + ] + } + }, + "InventoryConfigurationScheduleFrequency": { + "type": "string", + "description": "InventoryConfigurationScheduleFrequency enum", + "enum": [ + "Daily", + "Weekly" + ], + "x-ms-enum": { + "name": "InventoryConfigurationScheduleFrequency", + "modelAsString": true, + "values": [ + { + "name": "Daily", + "value": "Daily", + "description": "InventoryConfigurationScheduleFrequency enum Daily" + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "InventoryConfigurationScheduleFrequency enum Weekly" + } + ] + } + }, + "LambdaConfiguration": { + "type": "object", + "description": "Definition of LambdaConfiguration", + "properties": { + "event": { + "type": "string", + "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." + }, + "function": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs." + } + } + }, + "LifecycleConfiguration": { + "type": "object", + "description": "Definition of LifecycleConfiguration", + "properties": { + "rules": { + "type": "array", + "description": "A lifecycle rule for individual objects in an Amazon S3 bucket.", + "items": { + "$ref": "#/definitions/Rule" + }, + "x-ms-identifiers": [] + } + } + }, + "LoggingConfiguration": { + "type": "object", + "description": "Definition of LoggingConfiguration", + "properties": { + "destinationBucketName": { + "type": "string", + "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined." + }, + "logFilePrefix": { + "type": "string", + "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket." + }, + "targetObjectKeyFormat": { + "$ref": "#/definitions/TargetObjectKeyFormat", + "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix." + } + } + }, + "Metrics": { + "type": "object", + "description": "Definition of Metrics", + "properties": { + "eventThreshold": { + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." + }, + "status": { + "$ref": "#/definitions/MetricsStatus", + "description": "Specifies whether the replication metrics are enabled." + } + } + }, + "MetricsConfiguration": { + "type": "object", + "description": "Definition of MetricsConfiguration", + "properties": { + "accessPointArn": { + "type": "string", + "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria." + }, + "id": { + "type": "string", + "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration." + }, + "prefix": { + "type": "string", + "description": "The prefix that an object must have to be included in the metrics results." + }, + "tagFilters": { + "type": "array", + "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria.", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricsStatus": { + "type": "string", + "description": "MetricsStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "MetricsStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "MetricsStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "MetricsStatus enum Enabled" + } + ] + } + }, + "NoncurrentVersionExpiration": { + "type": "object", + "description": "Definition of NoncurrentVersionExpiration", + "properties": { + "newerNoncurrentVersions": { + "type": "integer", + "format": "int32", + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." + }, + "noncurrentDays": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." + } + } + }, + "NoncurrentVersionTransition": { + "type": "object", + "description": "Definition of NoncurrentVersionTransition", + "properties": { + "newerNoncurrentVersions": { + "type": "integer", + "format": "int32", + "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." + }, + "storageClass": { + "$ref": "#/definitions/NoncurrentVersionTransitionStorageClass", + "description": "The class of storage used to store the object." + }, + "transitionInDays": { + "type": "integer", + "format": "int32", + "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." + } + } + }, + "NoncurrentVersionTransitionStorageClass": { + "type": "string", + "description": "NoncurrentVersionTransitionStorageClass enum", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "STANDARD_IA" + ], + "x-ms-enum": { + "name": "NoncurrentVersionTransitionStorageClass", + "modelAsString": true, + "values": [ + { + "name": "DEEP_ARCHIVE", + "value": "DEEP_ARCHIVE", + "description": "NoncurrentVersionTransitionStorageClass enum DEEP_ARCHIVE" + }, + { + "name": "GLACIER", + "value": "GLACIER", + "description": "NoncurrentVersionTransitionStorageClass enum GLACIER" + }, + { + "name": "GLACIER_IR", + "value": "GLACIER_IR", + "description": "NoncurrentVersionTransitionStorageClass enum GLACIER_IR" + }, + { + "name": "INTELLIGENT_TIERING", + "value": "INTELLIGENT_TIERING", + "description": "NoncurrentVersionTransitionStorageClass enum INTELLIGENT_TIERING" + }, + { + "name": "ONEZONE_IA", + "value": "ONEZONE_IA", + "description": "NoncurrentVersionTransitionStorageClass enum ONEZONE_IA" + }, + { + "name": "STANDARD_IA", + "value": "STANDARD_IA", + "description": "NoncurrentVersionTransitionStorageClass enum STANDARD_IA" + } + ] + } + }, + "NotificationConfiguration": { + "type": "object", + "description": "Definition of NotificationConfiguration", + "properties": { + "eventBridgeConfiguration": { + "$ref": "#/definitions/EventBridgeConfiguration", + "description": "Enables delivery of events to Amazon EventBridge. Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*. Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*" + }, + "lambdaConfigurations": { + "type": "array", + "description": "Describes the LAMlong functions to invoke and the events for which to invoke them.", + "items": { + "$ref": "#/definitions/LambdaConfiguration" + }, + "x-ms-identifiers": [] + }, + "queueConfigurations": { + "type": "array", + "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.", + "items": { + "$ref": "#/definitions/QueueConfiguration" + }, + "x-ms-identifiers": [] + }, + "topicConfigurations": { + "type": "array", + "description": "The topic to which notifications are sent and the events for which notifications are generated.", + "items": { + "$ref": "#/definitions/TopicConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "NotificationFilter": { + "type": "object", + "description": "Definition of NotificationFilter", + "properties": { + "s3Key": { + "$ref": "#/definitions/S3KeyFilter", + "description": "A container for object key name prefix and suffix filtering rules. A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules." + } + } + }, + "ObjectLockConfiguration": { + "type": "object", + "description": "Definition of ObjectLockConfiguration", + "properties": { + "objectLockEnabled": { + "type": "string", + "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." + }, + "rule": { + "$ref": "#/definitions/ObjectLockRule", + "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket." + } + } + }, + "ObjectLockRule": { + "type": "object", + "description": "Definition of ObjectLockRule", + "properties": { + "defaultRetention": { + "$ref": "#/definitions/DefaultRetention", + "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time." + } + } + }, + "OwnershipControls": { + "type": "object", + "description": "Definition of OwnershipControls", + "properties": { + "rules": { + "type": "array", + "description": "Specifies the container element for Object Ownership rules.", + "items": { + "$ref": "#/definitions/OwnershipControlsRule" + }, + "x-ms-identifiers": [] + } + } + }, + "OwnershipControlsRule": { + "type": "object", + "description": "Definition of OwnershipControlsRule", + "properties": { + "objectOwnership": { + "$ref": "#/definitions/OwnershipControlsRuleObjectOwnership", + "description": "Specifies an object ownership rule." + } + } + }, + "OwnershipControlsRuleObjectOwnership": { + "type": "string", + "description": "OwnershipControlsRuleObjectOwnership enum", + "enum": [ + "BucketOwnerEnforced", + "BucketOwnerPreferred", + "ObjectWriter" + ], + "x-ms-enum": { + "name": "OwnershipControlsRuleObjectOwnership", + "modelAsString": true, + "values": [ + { + "name": "BucketOwnerEnforced", + "value": "BucketOwnerEnforced", + "description": "OwnershipControlsRuleObjectOwnership enum BucketOwnerEnforced" + }, + { + "name": "BucketOwnerPreferred", + "value": "BucketOwnerPreferred", + "description": "OwnershipControlsRuleObjectOwnership enum BucketOwnerPreferred" + }, + { + "name": "ObjectWriter", + "value": "ObjectWriter", + "description": "OwnershipControlsRuleObjectOwnership enum ObjectWriter" + } + ] + } + }, + "PartitionedPrefix": { + "type": "object", + "description": "Definition of PartitionedPrefix", + "properties": { + "partitionDateSource": { + "$ref": "#/definitions/PartitionedPrefixPartitionDateSource", + "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime." + } + } + }, + "PartitionedPrefixPartitionDateSource": { + "type": "string", + "description": "PartitionedPrefixPartitionDateSource enum", + "enum": [ + "DeliveryTime", + "EventTime" + ], + "x-ms-enum": { + "name": "PartitionedPrefixPartitionDateSource", + "modelAsString": true, + "values": [ + { + "name": "DeliveryTime", + "value": "DeliveryTime", + "description": "PartitionedPrefixPartitionDateSource enum DeliveryTime" + }, + { + "name": "EventTime", + "value": "EventTime", + "description": "PartitionedPrefixPartitionDateSource enum EventTime" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "PublicAccessBlockConfiguration": { + "type": "object", + "description": "Definition of PublicAccessBlockConfiguration", + "properties": { + "blockPublicAcls": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs." + }, + "blockPublicPolicy": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." + }, + "ignorePublicAcls": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." + }, + "restrictPublicBuckets": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." + } + } + }, + "QueueConfiguration": { + "type": "object", + "description": "Definition of QueueConfiguration", + "properties": { + "event": { + "type": "string", + "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." + }, + "queue": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination." + } + } + }, + "RedirectAllRequestsTo": { + "type": "object", + "description": "Definition of RedirectAllRequestsTo", + "properties": { + "hostName": { + "type": "string", + "description": "Name of the host where requests are redirected." + }, + "protocol": { + "$ref": "#/definitions/RedirectAllRequestsToProtocol", + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." + } + } + }, + "RedirectAllRequestsToProtocol": { + "type": "string", + "description": "RedirectAllRequestsToProtocol enum", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "RedirectAllRequestsToProtocol", + "modelAsString": true, + "values": [ + { + "name": "http", + "value": "http", + "description": "RedirectAllRequestsToProtocol enum http" + }, + { + "name": "https", + "value": "https", + "description": "RedirectAllRequestsToProtocol enum https" + } + ] + } + }, + "RedirectRule": { + "type": "object", + "description": "Definition of RedirectRule", + "properties": { + "hostName": { + "type": "string", + "description": "The host name to use in the redirect request." + }, + "httpRedirectCode": { + "type": "string", + "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." + }, + "protocol": { + "$ref": "#/definitions/RedirectRuleProtocol", + "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." + }, + "replaceKeyPrefixWith": { + "type": "string", + "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "replaceKeyWith": { + "type": "string", + "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + } + } + }, + "RedirectRuleProtocol": { + "type": "string", + "description": "RedirectRuleProtocol enum", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "RedirectRuleProtocol", + "modelAsString": true, + "values": [ + { + "name": "http", + "value": "http", + "description": "RedirectRuleProtocol enum http" + }, + { + "name": "https", + "value": "https", + "description": "RedirectRuleProtocol enum https" + } + ] + } + }, + "ReplicaModifications": { + "type": "object", + "description": "Definition of ReplicaModifications", + "properties": { + "status": { + "$ref": "#/definitions/ReplicaModificationsStatus", + "description": "Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled``" + } + } + }, + "ReplicaModificationsStatus": { + "type": "string", + "description": "ReplicaModificationsStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ReplicaModificationsStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "ReplicaModificationsStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "ReplicaModificationsStatus enum Enabled" + } + ] + } + }, + "ReplicationConfiguration": { + "type": "object", + "description": "Definition of ReplicationConfiguration", + "properties": { + "role": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*." + }, + "rules": { + "type": "array", + "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.", + "items": { + "$ref": "#/definitions/ReplicationRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ReplicationDestination": { + "type": "object", + "description": "Definition of ReplicationDestination", + "properties": { + "accessControlTranslation": { + "$ref": "#/definitions/AccessControlTranslation", + "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." + }, + "account": { + "type": "string", + "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required." + }, + "bucket": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results." + }, + "encryptionConfiguration": { + "$ref": "#/definitions/EncryptionConfiguration", + "description": "Specifies encryption-related information. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects." + }, + "metrics": { + "$ref": "#/definitions/Metrics", + "description": "A container specifying replication metrics-related settings enabling replication metrics and events. A container specifying replication metrics-related settings enabling replication metrics and events." + }, + "replicationTime": { + "$ref": "#/definitions/ReplicationTime", + "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." + }, + "storageClass": { + "$ref": "#/definitions/ReplicationDestinationStorageClass", + "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*." + } + } + }, + "ReplicationDestinationStorageClass": { + "type": "string", + "description": "ReplicationDestinationStorageClass enum", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "REDUCED_REDUNDANCY", + "STANDARD", + "STANDARD_IA" + ], + "x-ms-enum": { + "name": "ReplicationDestinationStorageClass", + "modelAsString": true, + "values": [ + { + "name": "DEEP_ARCHIVE", + "value": "DEEP_ARCHIVE", + "description": "ReplicationDestinationStorageClass enum DEEP_ARCHIVE" + }, + { + "name": "GLACIER", + "value": "GLACIER", + "description": "ReplicationDestinationStorageClass enum GLACIER" + }, + { + "name": "GLACIER_IR", + "value": "GLACIER_IR", + "description": "ReplicationDestinationStorageClass enum GLACIER_IR" + }, + { + "name": "INTELLIGENT_TIERING", + "value": "INTELLIGENT_TIERING", + "description": "ReplicationDestinationStorageClass enum INTELLIGENT_TIERING" + }, + { + "name": "ONEZONE_IA", + "value": "ONEZONE_IA", + "description": "ReplicationDestinationStorageClass enum ONEZONE_IA" + }, + { + "name": "REDUCED_REDUNDANCY", + "value": "REDUCED_REDUNDANCY", + "description": "ReplicationDestinationStorageClass enum REDUCED_REDUNDANCY" + }, + { + "name": "STANDARD", + "value": "STANDARD", + "description": "ReplicationDestinationStorageClass enum STANDARD" + }, + { + "name": "STANDARD_IA", + "value": "STANDARD_IA", + "description": "ReplicationDestinationStorageClass enum STANDARD_IA" + } + ] + } + }, + "ReplicationRule": { + "type": "object", + "description": "Definition of ReplicationRule", + "properties": { + "deleteMarkerReplication": { + "$ref": "#/definitions/DeleteMarkerReplication", + "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." + }, + "destination": { + "$ref": "#/definitions/ReplicationDestination", + "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." + }, + "filter": { + "$ref": "#/definitions/ReplicationRuleFilter", + "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element." + }, + "id": { + "type": "string", + "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as 'ID'." + }, + "prefix": { + "type": "string", + "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*." + }, + "sourceSelectionCriteria": { + "$ref": "#/definitions/SourceSelectionCriteria", + "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." + }, + "status": { + "$ref": "#/definitions/ReplicationRuleStatus", + "description": "Specifies whether the rule is enabled." + } + } + }, + "ReplicationRuleAndOperator": { + "type": "object", + "description": "Definition of ReplicationRuleAndOperator", + "properties": { + "prefix": { + "type": "string", + "description": "An object key name prefix that identifies the subset of objects to which the rule applies." + }, + "tagFilters": { + "type": "array", + "description": "An array of tags containing key and value pairs.", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "ReplicationRuleFilter": { + "type": "object", + "description": "Definition of ReplicationRuleFilter", + "properties": { + "and": { + "$ref": "#/definitions/ReplicationRuleAndOperator", + "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag" + }, + "prefix": { + "type": "string", + "description": "An object key name prefix that identifies the subset of objects to which the rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "tagFilter": { + "$ref": "#/definitions/TagFilter", + "description": "A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket." + } + } + }, + "ReplicationRuleStatus": { + "type": "string", + "description": "ReplicationRuleStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ReplicationRuleStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "ReplicationRuleStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "ReplicationRuleStatus enum Enabled" + } + ] + } + }, + "ReplicationTime": { + "type": "object", + "description": "Definition of ReplicationTime", + "properties": { + "status": { + "$ref": "#/definitions/ReplicationTimeStatus", + "description": "Specifies whether the replication time is enabled." + }, + "time": { + "$ref": "#/definitions/ReplicationTimeValue", + "description": "A container specifying the time by which replication should be complete for all objects and operations on objects. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." + } + } + }, + "ReplicationTimeStatus": { + "type": "string", + "description": "ReplicationTimeStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ReplicationTimeStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "ReplicationTimeStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "ReplicationTimeStatus enum Enabled" + } + ] + } + }, + "ReplicationTimeValue": { + "type": "object", + "description": "Definition of ReplicationTimeValue", + "properties": { + "minutes": { + "type": "integer", + "format": "int32", + "description": "Contains an integer specifying time in minutes. Valid value: 15" + } + } + }, + "RoutingRule": { + "type": "object", + "description": "Definition of RoutingRule", + "properties": { + "redirectRule": { + "$ref": "#/definitions/RedirectRule", + "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return." + }, + "routingRuleCondition": { + "$ref": "#/definitions/RoutingRuleCondition", + "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." + } + } + }, + "RoutingRuleCondition": { + "type": "object", + "description": "Definition of RoutingRuleCondition", + "properties": { + "httpErrorCodeReturnedEquals": { + "type": "string", + "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied." + }, + "keyPrefixEquals": { + "type": "string", + "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied." + } + } + }, + "Rule": { + "type": "object", + "description": "Definition of Rule", + "properties": { + "abortIncompleteMultipartUpload": { + "$ref": "#/definitions/AbortIncompleteMultipartUpload", + "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*." + }, + "expirationDate": { + "type": "string", + "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)" + }, + "expirationInDays": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." + }, + "expiredObjectDeleteMarker": { + "type": "boolean", + "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``." + }, + "id": { + "type": "string", + "description": "Unique identifier for the rule. The value can't be longer than 255 characters." + }, + "noncurrentVersionExpiration": { + "$ref": "#/definitions/NoncurrentVersionExpiration", + "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html)." + }, + "noncurrentVersionExpirationInDays": { + "type": "integer", + "format": "int32", + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time." + }, + "noncurrentVersionTransition": { + "$ref": "#/definitions/NoncurrentVersionTransition", + "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." + }, + "noncurrentVersionTransitions": { + "type": "array", + "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property.", + "items": { + "$ref": "#/definitions/NoncurrentVersionTransition" + }, + "x-ms-identifiers": [] + }, + "objectSizeGreaterThan": { + "type": "string", + "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." + }, + "objectSizeLessThan": { + "type": "string", + "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." + }, + "prefix": { + "type": "string", + "description": "Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." + }, + "status": { + "$ref": "#/definitions/RuleStatus", + "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied." + }, + "tagFilters": { + "type": "array", + "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies.", + "items": { + "$ref": "#/definitions/TagFilter" + }, + "x-ms-identifiers": [] + }, + "transition": { + "$ref": "#/definitions/Transition", + "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*." + }, + "transitions": { + "type": "array", + "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property.", + "items": { + "$ref": "#/definitions/Transition" + }, + "x-ms-identifiers": [] + } + } + }, + "RuleStatus": { + "type": "string", + "description": "RuleStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "RuleStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "RuleStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "RuleStatus enum Enabled" + } + ] + } + }, + "S3Bucket": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/S3BucketProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "S3BucketListResult": { + "type": "object", + "description": "The response of a S3Bucket list operation.", + "properties": { + "value": { + "type": "array", + "description": "The S3Bucket items on this page", + "items": { + "$ref": "#/definitions/S3Bucket" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "S3BucketProperties": { + "type": "object", + "description": "Definition of S3Bucket", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsS3BucketProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "S3BucketTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in S3Bucket resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "S3KeyFilter": { + "type": "object", + "description": "Definition of S3KeyFilter", + "properties": { + "rules": { + "type": "array", + "description": "A list of containers for the key-value pair that defines the criteria for the filter rule.", + "items": { + "$ref": "#/definitions/FilterRule" + }, + "x-ms-identifiers": [] + } + } + }, + "ServerSideEncryptionByDefault": { + "type": "object", + "description": "Definition of ServerSideEncryptionByDefault", + "properties": { + "kmsMasterKeyID": { + "type": "string", + "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + Key Alias: ``alias/alias-name`` If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." + }, + "sseAlgorithm": { + "$ref": "#/definitions/ServerSideEncryptionByDefaultSSEAlgorithm", + "description": "Server-side encryption algorithm to use for the default encryption." + } + } + }, + "ServerSideEncryptionByDefaultSSEAlgorithm": { + "type": "string", + "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum", + "enum": [ + "AES256", + "aws:kms", + "aws:kms:dsse" + ], + "x-ms-enum": { + "name": "ServerSideEncryptionByDefaultSSEAlgorithm", + "modelAsString": true, + "values": [ + { + "name": "AES256", + "value": "AES256", + "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum AES256" + }, + { + "name": "AwsKms", + "value": "aws:kms", + "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms" + }, + { + "name": "AwsKmsDsse", + "value": "aws:kms:dsse", + "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms:dsse" + } + ] + } + }, + "ServerSideEncryptionRule": { + "type": "object", + "description": "Definition of ServerSideEncryptionRule", + "properties": { + "bucketKeyEnabled": { + "type": "boolean", + "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*." + }, + "serverSideEncryptionByDefault": { + "$ref": "#/definitions/ServerSideEncryptionByDefault", + "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*." + } + } + }, + "SourceSelectionCriteria": { + "type": "object", + "description": "Definition of SourceSelectionCriteria", + "properties": { + "replicaModifications": { + "$ref": "#/definitions/ReplicaModifications", + "description": "A filter that you can specify for selection for modifications on replicas. A filter that you can specify for selection for modifications on replicas." + }, + "sseKmsEncryptedObjects": { + "$ref": "#/definitions/SseKmsEncryptedObjects", + "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. A container for filter information for the selection of S3 objects encrypted with AWS KMS." + } + } + }, + "SseKmsEncryptedObjects": { + "type": "object", + "description": "Definition of SseKmsEncryptedObjects", + "properties": { + "status": { + "$ref": "#/definitions/SseKmsEncryptedObjectsStatus", + "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service." + } + } + }, + "SseKmsEncryptedObjectsStatus": { + "type": "string", + "description": "SseKmsEncryptedObjectsStatus enum", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "SseKmsEncryptedObjectsStatus", + "modelAsString": true, + "values": [ + { + "name": "Disabled", + "value": "Disabled", + "description": "SseKmsEncryptedObjectsStatus enum Disabled" + }, + { + "name": "Enabled", + "value": "Enabled", + "description": "SseKmsEncryptedObjectsStatus enum Enabled" + } + ] + } + }, + "StorageClassAnalysis": { + "type": "object", + "description": "Definition of StorageClassAnalysis", + "properties": { + "dataExport": { + "$ref": "#/definitions/DataExport", + "description": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Name of the object key." + }, + "value": { + "type": "string", + "description": "Value of the tag." + } + } + }, + "TagFilter": { + "type": "object", + "description": "Definition of TagFilter", + "properties": { + "key": { + "type": "string", + "description": "The tag key." + }, + "value": { + "type": "string", + "description": "The tag value." + } + } + }, + "TargetObjectKeyFormat": { + "type": "object", + "description": "Definition of TargetObjectKeyFormat", + "properties": { + "simplePrefix": { + "description": "This format defaults the prefix to the given log file prefix for delivering server access log file." + }, + "partitionedPrefix": { + "$ref": "#/definitions/PartitionedPrefix", + "description": "Amazon S3 keys for log objects are partitioned in the following format: ``[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`` PartitionedPrefix defaults to EventTime delivery when server access logs are delivered." + } + } + }, + "Tiering": { + "type": "object", + "description": "Definition of Tiering", + "properties": { + "accessTier": { + "$ref": "#/definitions/TieringAccessTier", + "description": "S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class." + }, + "days": { + "type": "integer", + "format": "int32", + "description": "The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days)." + } + } + }, + "TieringAccessTier": { + "type": "string", + "description": "TieringAccessTier enum", + "enum": [ + "ARCHIVE_ACCESS", + "DEEP_ARCHIVE_ACCESS" + ], + "x-ms-enum": { + "name": "TieringAccessTier", + "modelAsString": true, + "values": [ + { + "name": "ARCHIVE_ACCESS", + "value": "ARCHIVE_ACCESS", + "description": "TieringAccessTier enum ARCHIVE_ACCESS" + }, + { + "name": "DEEP_ARCHIVE_ACCESS", + "value": "DEEP_ARCHIVE_ACCESS", + "description": "TieringAccessTier enum DEEP_ARCHIVE_ACCESS" + } + ] + } + }, + "TopicConfiguration": { + "type": "object", + "description": "Definition of TopicConfiguration", + "properties": { + "event": { + "type": "string", + "description": "The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." + }, + "filter": { + "$ref": "#/definitions/NotificationFilter", + "description": "The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." + }, + "topic": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type." + } + } + }, + "Transition": { + "type": "object", + "description": "Definition of Transition", + "properties": { + "storageClass": { + "$ref": "#/definitions/TransitionStorageClass", + "description": "The storage class to which you want the object to transition." + }, + "transitionDate": { + "type": "string", + "description": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)" + }, + "transitionInDays": { + "type": "integer", + "format": "int32", + "description": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer." + } + } + }, + "TransitionStorageClass": { + "type": "string", + "description": "TransitionStorageClass enum", + "enum": [ + "DEEP_ARCHIVE", + "GLACIER", + "GLACIER_IR", + "INTELLIGENT_TIERING", + "ONEZONE_IA", + "STANDARD_IA" + ], + "x-ms-enum": { + "name": "TransitionStorageClass", + "modelAsString": true, + "values": [ + { + "name": "DEEP_ARCHIVE", + "value": "DEEP_ARCHIVE", + "description": "TransitionStorageClass enum DEEP_ARCHIVE" + }, + { + "name": "GLACIER", + "value": "GLACIER", + "description": "TransitionStorageClass enum GLACIER" + }, + { + "name": "GLACIER_IR", + "value": "GLACIER_IR", + "description": "TransitionStorageClass enum GLACIER_IR" + }, + { + "name": "INTELLIGENT_TIERING", + "value": "INTELLIGENT_TIERING", + "description": "TransitionStorageClass enum INTELLIGENT_TIERING" + }, + { + "name": "ONEZONE_IA", + "value": "ONEZONE_IA", + "description": "TransitionStorageClass enum ONEZONE_IA" + }, + { + "name": "STANDARD_IA", + "value": "STANDARD_IA", + "description": "TransitionStorageClass enum STANDARD_IA" + } + ] + } + }, + "VersioningConfiguration": { + "type": "object", + "description": "Definition of VersioningConfiguration", + "properties": { + "status": { + "type": "string", + "description": "The versioning state of the bucket.", + "default": "Suspended", + "enum": [ + "Enabled", + "Suspended" + ], + "x-ms-enum": { + "name": "VersioningConfigurationStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "VersioningConfigurationStatus enum Enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "VersioningConfigurationStatus enum Suspended" + } + ] + } + } + } + }, + "VersioningConfigurationStatus": { + "type": "string", + "description": "VersioningConfigurationStatus enum", + "enum": [ + "Enabled", + "Suspended" + ], + "x-ms-enum": { + "name": "VersioningConfigurationStatus", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "VersioningConfigurationStatus enum Enabled" + }, + { + "name": "Suspended", + "value": "Suspended", + "description": "VersioningConfigurationStatus enum Suspended" + } + ] + } + }, + "WebsiteConfiguration": { + "type": "object", + "description": "Definition of WebsiteConfiguration", + "properties": { + "errorDocument": { + "type": "string", + "description": "The name of the error document for the website." + }, + "indexDocument": { + "type": "string", + "description": "The name of the index document for the website." + }, + "redirectAllRequestsTo": { + "$ref": "#/definitions/RedirectAllRequestsTo", + "description": "The redirect behavior for every request to this bucket's website endpoint. If you specify this property, you can't specify any other property. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket." + }, + "routingRules": { + "type": "array", + "description": "Rules that define when a redirect is applied and the redirect behavior.", + "items": { + "$ref": "#/definitions/RoutingRule" + }, + "x-ms-identifiers": [] + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3BucketPolicy.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3BucketPolicy.json new file mode 100644 index 000000000000..64c81073dbc3 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3BucketPolicy.json @@ -0,0 +1,546 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "S3BucketPolicies" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/s3BucketPolicies": { + "get": { + "operationId": "S3BucketPolicies_ListBySubscription", + "tags": [ + "S3BucketPolicies" + ], + "description": "List S3BucketPolicy resources 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/S3BucketPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3BucketPolicies_ListBySubscription": { + "$ref": "./examples/S3BucketPolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3BucketPolicies": { + "get": { + "operationId": "S3BucketPolicies_ListByResourceGroup", + "tags": [ + "S3BucketPolicies" + ], + "description": "List S3BucketPolicy resources 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/S3BucketPolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3BucketPolicies_ListByResourceGroup": { + "$ref": "./examples/S3BucketPolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3BucketPolicies/{name}": { + "get": { + "operationId": "S3BucketPolicies_Get", + "tags": [ + "S3BucketPolicies" + ], + "description": "Get a S3BucketPolicy", + "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": "name", + "in": "path", + "description": "Name of S3BucketPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3BucketPolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3BucketPolicies_Get": { + "$ref": "./examples/S3BucketPolicies_Get.json" + } + } + }, + "put": { + "operationId": "S3BucketPolicies_CreateOrReplace", + "tags": [ + "S3BucketPolicies" + ], + "description": "Create a S3BucketPolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of S3BucketPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/S3BucketPolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'S3BucketPolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/S3BucketPolicy" + } + }, + "201": { + "description": "Resource 'S3BucketPolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/S3BucketPolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "S3BucketPolicies_CreateOrReplace": { + "$ref": "./examples/S3BucketPolicies_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "S3BucketPolicies_Update", + "tags": [ + "S3BucketPolicies" + ], + "description": "Update a S3BucketPolicy", + "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": "name", + "in": "path", + "description": "Name of S3BucketPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/S3BucketPolicyTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3BucketPolicy" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3BucketPolicies_Update": { + "$ref": "./examples/S3BucketPolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "S3BucketPolicies_Delete", + "tags": [ + "S3BucketPolicies" + ], + "description": "Delete a S3BucketPolicy", + "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": "name", + "in": "path", + "description": "Name of S3BucketPolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "S3BucketPolicies_Delete": { + "$ref": "./examples/S3BucketPolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsS3BucketPolicyProperties": { + "type": "object", + "description": "Definition of awsS3BucketPolicy", + "properties": { + "policy": { + "type": "string", + "description": "<p>The bucket policy as a JSON document.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "S3BucketPolicy": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/S3BucketPolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "S3BucketPolicyListResult": { + "type": "object", + "description": "The response of a S3BucketPolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The S3BucketPolicy items on this page", + "items": { + "$ref": "#/definitions/S3BucketPolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "S3BucketPolicyProperties": { + "type": "object", + "description": "Definition of S3BucketPolicy", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsS3BucketPolicyProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "S3BucketPolicyTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in S3BucketPolicy resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3ControlMultiRegionAccessPointPolicyDocument.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3ControlMultiRegionAccessPointPolicyDocument.json new file mode 100644 index 000000000000..6345c8e0558a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/s3ControlMultiRegionAccessPointPolicyDocument.json @@ -0,0 +1,570 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "S3ControlMultiRegionAccessPointPolicyDocuments" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/s3ControlMultiRegionAccessPointPolicyDocuments": { + "get": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "List S3ControlMultiRegionAccessPointPolicyDocument resources 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/S3ControlMultiRegionAccessPointPolicyDocumentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3ControlMultiRegionAccessPointPolicyDocuments": { + "get": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "List S3ControlMultiRegionAccessPointPolicyDocument resources 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/S3ControlMultiRegionAccessPointPolicyDocumentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/s3ControlMultiRegionAccessPointPolicyDocuments/{name}": { + "get": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Get", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "Get a S3ControlMultiRegionAccessPointPolicyDocument", + "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": "name", + "in": "path", + "description": "Name of S3ControlMultiRegionAccessPointPolicyDocument", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3ControlMultiRegionAccessPointPolicyDocuments_Get": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_Get.json" + } + } + }, + "put": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "Create a S3ControlMultiRegionAccessPointPolicyDocument. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of S3ControlMultiRegionAccessPointPolicyDocument", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + } + } + ], + "responses": { + "200": { + "description": "Resource 'S3ControlMultiRegionAccessPointPolicyDocument' update operation succeeded", + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + } + }, + "201": { + "description": "Resource 'S3ControlMultiRegionAccessPointPolicyDocument' create operation succeeded", + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Update", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "Update a S3ControlMultiRegionAccessPointPolicyDocument", + "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": "name", + "in": "path", + "description": "Name of S3ControlMultiRegionAccessPointPolicyDocument", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocumentTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "S3ControlMultiRegionAccessPointPolicyDocuments_Update": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "S3ControlMultiRegionAccessPointPolicyDocuments_Delete", + "tags": [ + "S3ControlMultiRegionAccessPointPolicyDocuments" + ], + "description": "Delete a S3ControlMultiRegionAccessPointPolicyDocument", + "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": "name", + "in": "path", + "description": "Name of S3ControlMultiRegionAccessPointPolicyDocument", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "S3ControlMultiRegionAccessPointPolicyDocuments_Delete": { + "$ref": "./examples/S3ControlMultiRegionAccessPointPolicyDocuments_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties": { + "type": "object", + "description": "Definition of awsS3ControlMultiRegionAccessPointPolicyDocument", + "properties": { + "established": { + "$ref": "#/definitions/EstablishedMultiRegionAccessPointPolicy", + "description": "<p>The last established policy for the Multi-Region Access Point.</p>" + }, + "proposed": { + "$ref": "#/definitions/ProposedMultiRegionAccessPointPolicy", + "description": "<p>The proposed policy for the Multi-Region Access Point.</p>" + } + } + }, + "EstablishedMultiRegionAccessPointPolicy": { + "type": "object", + "description": "Definition of EstablishedMultiRegionAccessPointPolicy", + "properties": { + "policy": { + "type": "string", + "description": "<p>The details of the last established policy.</p>" + } + } + }, + "ProposedMultiRegionAccessPointPolicy": { + "type": "object", + "description": "Definition of ProposedMultiRegionAccessPointPolicy", + "properties": { + "policy": { + "type": "string", + "description": "<p>The details of the proposed policy.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "S3ControlMultiRegionAccessPointPolicyDocument": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocumentProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "S3ControlMultiRegionAccessPointPolicyDocumentListResult": { + "type": "object", + "description": "The response of a S3ControlMultiRegionAccessPointPolicyDocument list operation.", + "properties": { + "value": { + "type": "array", + "description": "The S3ControlMultiRegionAccessPointPolicyDocument items on this page", + "items": { + "$ref": "#/definitions/S3ControlMultiRegionAccessPointPolicyDocument" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "S3ControlMultiRegionAccessPointPolicyDocumentProperties": { + "type": "object", + "description": "Definition of S3ControlMultiRegionAccessPointPolicyDocument", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "S3ControlMultiRegionAccessPointPolicyDocumentTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in S3ControlMultiRegionAccessPointPolicyDocument resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerApp.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerApp.json new file mode 100644 index 000000000000..a5734005bebc --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerApp.json @@ -0,0 +1,1038 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SageMakerApps" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/sageMakerApps": { + "get": { + "operationId": "SageMakerApps_ListBySubscription", + "tags": [ + "SageMakerApps" + ], + "description": "List SageMakerApp resources 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/SageMakerAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerApps_ListBySubscription": { + "$ref": "./examples/SageMakerApps_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sageMakerApps": { + "get": { + "operationId": "SageMakerApps_ListByResourceGroup", + "tags": [ + "SageMakerApps" + ], + "description": "List SageMakerApp resources 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/SageMakerAppListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerApps_ListByResourceGroup": { + "$ref": "./examples/SageMakerApps_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sageMakerApps/{name}": { + "get": { + "operationId": "SageMakerApps_Get", + "tags": [ + "SageMakerApps" + ], + "description": "Get a SageMakerApp", + "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": "name", + "in": "path", + "description": "Name of SageMakerApp", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SageMakerApp" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerApps_Get": { + "$ref": "./examples/SageMakerApps_Get.json" + } + } + }, + "put": { + "operationId": "SageMakerApps_CreateOrReplace", + "tags": [ + "SageMakerApps" + ], + "description": "Create a SageMakerApp. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SageMakerApp", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SageMakerApp" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SageMakerApp' update operation succeeded", + "schema": { + "$ref": "#/definitions/SageMakerApp" + } + }, + "201": { + "description": "Resource 'SageMakerApp' create operation succeeded", + "schema": { + "$ref": "#/definitions/SageMakerApp" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SageMakerApps_CreateOrReplace": { + "$ref": "./examples/SageMakerApps_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SageMakerApps_Update", + "tags": [ + "SageMakerApps" + ], + "description": "Update a SageMakerApp", + "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": "name", + "in": "path", + "description": "Name of SageMakerApp", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SageMakerAppTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SageMakerApp" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerApps_Update": { + "$ref": "./examples/SageMakerApps_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SageMakerApps_Delete", + "tags": [ + "SageMakerApps" + ], + "description": "Delete a SageMakerApp", + "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": "name", + "in": "path", + "description": "Name of SageMakerApp", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SageMakerApps_Delete": { + "$ref": "./examples/SageMakerApps_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AppType": { + "type": "string", + "description": "AppType enum", + "enum": [ + "Canvas", + "JupyterServer", + "KernelGateway", + "RSessionGateway", + "RStudioServerPro" + ], + "x-ms-enum": { + "name": "AppType", + "modelAsString": true, + "values": [ + { + "name": "Canvas", + "value": "Canvas", + "description": "AppType enum Canvas" + }, + { + "name": "JupyterServer", + "value": "JupyterServer", + "description": "AppType enum JupyterServer" + }, + { + "name": "KernelGateway", + "value": "KernelGateway", + "description": "AppType enum KernelGateway" + }, + { + "name": "RSessionGateway", + "value": "RSessionGateway", + "description": "AppType enum RSessionGateway" + }, + { + "name": "RStudioServerPro", + "value": "RStudioServerPro", + "description": "AppType enum RStudioServerPro" + } + ] + } + }, + "AwsSageMakerAppProperties": { + "type": "object", + "description": "Definition of awsSageMakerApp", + "properties": { + "appArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the app." + }, + "appName": { + "type": "string", + "description": "The name of the app." + }, + "appType": { + "$ref": "#/definitions/AppType", + "description": "The type of app." + }, + "domainId": { + "type": "string", + "description": "The domain ID." + }, + "resourceSpec": { + "$ref": "#/definitions/ResourceSpec", + "description": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance." + }, + "tags": { + "type": "array", + "description": "A list of tags to apply to the app.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "userProfileName": { + "type": "string", + "description": "The user profile name." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ResourceSpec": { + "type": "object", + "description": "Definition of ResourceSpec", + "properties": { + "instanceType": { + "$ref": "#/definitions/ResourceSpecInstanceType", + "description": "The instance type that the image version runs on." + }, + "sageMakerImageArn": { + "type": "string", + "description": "The ARN of the SageMaker image that the image version belongs to." + }, + "sageMakerImageVersionArn": { + "type": "string", + "description": "The ARN of the image version created on the instance." + } + } + }, + "ResourceSpecInstanceType": { + "type": "string", + "description": "ResourceSpecInstanceType enum", + "enum": [ + "ml.c5.12xlarge", + "ml.c5.18xlarge", + "ml.c5.24xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.large", + "ml.c5.xlarge", + "ml.g4dn.12xlarge", + "ml.g4dn.16xlarge", + "ml.g4dn.2xlarge", + "ml.g4dn.4xlarge", + "ml.g4dn.8xlarge", + "ml.g4dn.xlarge", + "ml.g5.12xlarge", + "ml.g5.16xlarge", + "ml.g5.24xlarge", + "ml.g5.2xlarge", + "ml.g5.48xlarge", + "ml.g5.4xlarge", + "ml.g5.8xlarge", + "ml.g5.xlarge", + "ml.geospatial.interactive", + "ml.m5.12xlarge", + "ml.m5.16xlarge", + "ml.m5.24xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.8xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5d.12xlarge", + "ml.m5d.16xlarge", + "ml.m5d.24xlarge", + "ml.m5d.2xlarge", + "ml.m5d.4xlarge", + "ml.m5d.8xlarge", + "ml.m5d.large", + "ml.m5d.xlarge", + "ml.p3.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3dn.24xlarge", + "ml.p4d.24xlarge", + "ml.p4de.24xlarge", + "ml.r5.12xlarge", + "ml.r5.16xlarge", + "ml.r5.24xlarge", + "ml.r5.2xlarge", + "ml.r5.4xlarge", + "ml.r5.8xlarge", + "ml.r5.large", + "ml.r5.xlarge", + "ml.t3.2xlarge", + "ml.t3.large", + "ml.t3.medium", + "ml.t3.micro", + "ml.t3.small", + "ml.t3.xlarge", + "ml.trn1.2xlarge", + "ml.trn1.32xlarge", + "ml.trn1n.32xlarge", + "system" + ], + "x-ms-enum": { + "name": "ResourceSpecInstanceType", + "modelAsString": true, + "values": [ + { + "name": "MlC512xlarge", + "value": "ml.c5.12xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.12xlarge" + }, + { + "name": "MlC518xlarge", + "value": "ml.c5.18xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.18xlarge" + }, + { + "name": "MlC524xlarge", + "value": "ml.c5.24xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.24xlarge" + }, + { + "name": "MlC52xlarge", + "value": "ml.c5.2xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.2xlarge" + }, + { + "name": "MlC54xlarge", + "value": "ml.c5.4xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.4xlarge" + }, + { + "name": "MlC59xlarge", + "value": "ml.c5.9xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.9xlarge" + }, + { + "name": "MlC5Large", + "value": "ml.c5.large", + "description": "ResourceSpecInstanceType enum ml.c5.large" + }, + { + "name": "MlC5Xlarge", + "value": "ml.c5.xlarge", + "description": "ResourceSpecInstanceType enum ml.c5.xlarge" + }, + { + "name": "MlG4dn12xlarge", + "value": "ml.g4dn.12xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.12xlarge" + }, + { + "name": "MlG4dn16xlarge", + "value": "ml.g4dn.16xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.16xlarge" + }, + { + "name": "MlG4dn2xlarge", + "value": "ml.g4dn.2xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.2xlarge" + }, + { + "name": "MlG4dn4xlarge", + "value": "ml.g4dn.4xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.4xlarge" + }, + { + "name": "MlG4dn8xlarge", + "value": "ml.g4dn.8xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.8xlarge" + }, + { + "name": "MlG4dnXlarge", + "value": "ml.g4dn.xlarge", + "description": "ResourceSpecInstanceType enum ml.g4dn.xlarge" + }, + { + "name": "MlG512xlarge", + "value": "ml.g5.12xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.12xlarge" + }, + { + "name": "MlG516xlarge", + "value": "ml.g5.16xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.16xlarge" + }, + { + "name": "MlG524xlarge", + "value": "ml.g5.24xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.24xlarge" + }, + { + "name": "MlG52xlarge", + "value": "ml.g5.2xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.2xlarge" + }, + { + "name": "MlG548xlarge", + "value": "ml.g5.48xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.48xlarge" + }, + { + "name": "MlG54xlarge", + "value": "ml.g5.4xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.4xlarge" + }, + { + "name": "MlG58xlarge", + "value": "ml.g5.8xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.8xlarge" + }, + { + "name": "MlG5Xlarge", + "value": "ml.g5.xlarge", + "description": "ResourceSpecInstanceType enum ml.g5.xlarge" + }, + { + "name": "MlGeospatialInteractive", + "value": "ml.geospatial.interactive", + "description": "ResourceSpecInstanceType enum ml.geospatial.interactive" + }, + { + "name": "MlM512xlarge", + "value": "ml.m5.12xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.12xlarge" + }, + { + "name": "MlM516xlarge", + "value": "ml.m5.16xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.16xlarge" + }, + { + "name": "MlM524xlarge", + "value": "ml.m5.24xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.24xlarge" + }, + { + "name": "MlM52xlarge", + "value": "ml.m5.2xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.2xlarge" + }, + { + "name": "MlM54xlarge", + "value": "ml.m5.4xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.4xlarge" + }, + { + "name": "MlM58xlarge", + "value": "ml.m5.8xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.8xlarge" + }, + { + "name": "MlM5Large", + "value": "ml.m5.large", + "description": "ResourceSpecInstanceType enum ml.m5.large" + }, + { + "name": "MlM5Xlarge", + "value": "ml.m5.xlarge", + "description": "ResourceSpecInstanceType enum ml.m5.xlarge" + }, + { + "name": "MlM5d12xlarge", + "value": "ml.m5d.12xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.12xlarge" + }, + { + "name": "MlM5d16xlarge", + "value": "ml.m5d.16xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.16xlarge" + }, + { + "name": "MlM5d24xlarge", + "value": "ml.m5d.24xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.24xlarge" + }, + { + "name": "MlM5d2xlarge", + "value": "ml.m5d.2xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.2xlarge" + }, + { + "name": "MlM5d4xlarge", + "value": "ml.m5d.4xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.4xlarge" + }, + { + "name": "MlM5d8xlarge", + "value": "ml.m5d.8xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.8xlarge" + }, + { + "name": "MlM5dLarge", + "value": "ml.m5d.large", + "description": "ResourceSpecInstanceType enum ml.m5d.large" + }, + { + "name": "MlM5dXlarge", + "value": "ml.m5d.xlarge", + "description": "ResourceSpecInstanceType enum ml.m5d.xlarge" + }, + { + "name": "MlP316xlarge", + "value": "ml.p3.16xlarge", + "description": "ResourceSpecInstanceType enum ml.p3.16xlarge" + }, + { + "name": "MlP32xlarge", + "value": "ml.p3.2xlarge", + "description": "ResourceSpecInstanceType enum ml.p3.2xlarge" + }, + { + "name": "MlP38xlarge", + "value": "ml.p3.8xlarge", + "description": "ResourceSpecInstanceType enum ml.p3.8xlarge" + }, + { + "name": "MlP3dn24xlarge", + "value": "ml.p3dn.24xlarge", + "description": "ResourceSpecInstanceType enum ml.p3dn.24xlarge" + }, + { + "name": "MlP4d24xlarge", + "value": "ml.p4d.24xlarge", + "description": "ResourceSpecInstanceType enum ml.p4d.24xlarge" + }, + { + "name": "MlP4de24xlarge", + "value": "ml.p4de.24xlarge", + "description": "ResourceSpecInstanceType enum ml.p4de.24xlarge" + }, + { + "name": "MlR512xlarge", + "value": "ml.r5.12xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.12xlarge" + }, + { + "name": "MlR516xlarge", + "value": "ml.r5.16xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.16xlarge" + }, + { + "name": "MlR524xlarge", + "value": "ml.r5.24xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.24xlarge" + }, + { + "name": "MlR52xlarge", + "value": "ml.r5.2xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.2xlarge" + }, + { + "name": "MlR54xlarge", + "value": "ml.r5.4xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.4xlarge" + }, + { + "name": "MlR58xlarge", + "value": "ml.r5.8xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.8xlarge" + }, + { + "name": "MlR5Large", + "value": "ml.r5.large", + "description": "ResourceSpecInstanceType enum ml.r5.large" + }, + { + "name": "MlR5Xlarge", + "value": "ml.r5.xlarge", + "description": "ResourceSpecInstanceType enum ml.r5.xlarge" + }, + { + "name": "MlT32xlarge", + "value": "ml.t3.2xlarge", + "description": "ResourceSpecInstanceType enum ml.t3.2xlarge" + }, + { + "name": "MlT3Large", + "value": "ml.t3.large", + "description": "ResourceSpecInstanceType enum ml.t3.large" + }, + { + "name": "MlT3Medium", + "value": "ml.t3.medium", + "description": "ResourceSpecInstanceType enum ml.t3.medium" + }, + { + "name": "MlT3Micro", + "value": "ml.t3.micro", + "description": "ResourceSpecInstanceType enum ml.t3.micro" + }, + { + "name": "MlT3Small", + "value": "ml.t3.small", + "description": "ResourceSpecInstanceType enum ml.t3.small" + }, + { + "name": "MlT3Xlarge", + "value": "ml.t3.xlarge", + "description": "ResourceSpecInstanceType enum ml.t3.xlarge" + }, + { + "name": "MlTrn12xlarge", + "value": "ml.trn1.2xlarge", + "description": "ResourceSpecInstanceType enum ml.trn1.2xlarge" + }, + { + "name": "MlTrn132xlarge", + "value": "ml.trn1.32xlarge", + "description": "ResourceSpecInstanceType enum ml.trn1.32xlarge" + }, + { + "name": "MlTrn1n32xlarge", + "value": "ml.trn1n.32xlarge", + "description": "ResourceSpecInstanceType enum ml.trn1n.32xlarge" + }, + { + "name": "system", + "value": "system", + "description": "ResourceSpecInstanceType enum system" + } + ] + } + }, + "SageMakerApp": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SageMakerAppProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SageMakerAppListResult": { + "type": "object", + "description": "The response of a SageMakerApp list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SageMakerApp items on this page", + "items": { + "$ref": "#/definitions/SageMakerApp" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SageMakerAppProperties": { + "type": "object", + "description": "Definition of SageMakerApp", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSageMakerAppProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SageMakerAppTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SageMakerApp resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "Property key" + }, + "value": { + "type": "string", + "description": "Property value" + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerNotebookInstanceSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerNotebookInstanceSummary.json new file mode 100644 index 000000000000..5ff49bc300db --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sageMakerNotebookInstanceSummary.json @@ -0,0 +1,1616 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SageMakerNotebookInstanceSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/sageMakerNotebookInstanceSummaries": { + "get": { + "operationId": "SageMakerNotebookInstanceSummaries_ListBySubscription", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "List SageMakerNotebookInstanceSummary resources 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/SageMakerNotebookInstanceSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerNotebookInstanceSummaries_ListBySubscription": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sageMakerNotebookInstanceSummaries": { + "get": { + "operationId": "SageMakerNotebookInstanceSummaries_ListByResourceGroup", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "List SageMakerNotebookInstanceSummary resources 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/SageMakerNotebookInstanceSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerNotebookInstanceSummaries_ListByResourceGroup": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sageMakerNotebookInstanceSummaries/{name}": { + "get": { + "operationId": "SageMakerNotebookInstanceSummaries_Get", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "Get a SageMakerNotebookInstanceSummary", + "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": "name", + "in": "path", + "description": "Name of SageMakerNotebookInstanceSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerNotebookInstanceSummaries_Get": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_Get.json" + } + } + }, + "put": { + "operationId": "SageMakerNotebookInstanceSummaries_CreateOrReplace", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "Create a SageMakerNotebookInstanceSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SageMakerNotebookInstanceSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SageMakerNotebookInstanceSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + } + }, + "201": { + "description": "Resource 'SageMakerNotebookInstanceSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SageMakerNotebookInstanceSummaries_CreateOrReplace": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SageMakerNotebookInstanceSummaries_Update", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "Update a SageMakerNotebookInstanceSummary", + "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": "name", + "in": "path", + "description": "Name of SageMakerNotebookInstanceSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SageMakerNotebookInstanceSummaries_Update": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SageMakerNotebookInstanceSummaries_Delete", + "tags": [ + "SageMakerNotebookInstanceSummaries" + ], + "description": "Delete a SageMakerNotebookInstanceSummary", + "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": "name", + "in": "path", + "description": "Name of SageMakerNotebookInstanceSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SageMakerNotebookInstanceSummaries_Delete": { + "$ref": "./examples/SageMakerNotebookInstanceSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSageMakerNotebookInstanceSummaryProperties": { + "type": "object", + "description": "Definition of awsSageMakerNotebookInstanceSummary", + "properties": { + "additionalCodeRepositories": { + "type": "array", + "description": "<p>An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in <a href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'>Amazon Web Services CodeCommit</a> or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'>Associating Git Repositories with SageMaker Notebook Instances</a>.</p>", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "<p>A timestamp that shows when the notebook instance was created.</p>" + }, + "defaultCodeRepository": { + "type": "string", + "description": "<p>The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in <a href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'>Amazon Web Services CodeCommit</a> or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'>Associating Git Repositories with SageMaker Notebook Instances</a>.</p>" + }, + "instanceType": { + "$ref": "#/definitions/InstanceTypeEnumValue", + "description": "<p>The type of ML compute instance that the notebook instance is running on.</p>" + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "<p>A timestamp that shows when the notebook instance was last modified.</p>" + }, + "notebookInstanceArn": { + "type": "string", + "description": "<p>The Amazon Resource Name (ARN) of the notebook instance.</p>" + }, + "notebookInstanceLifecycleConfigName": { + "type": "string", + "description": "<p>The name of a notebook instance lifecycle configuration associated with this notebook instance.</p> <p>For information about notebook instance lifestyle configurations, see <a href='https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html'>Step 2.1: (Optional) Customize a Notebook Instance</a>.</p>" + }, + "notebookInstanceName": { + "type": "string", + "description": "<p>The name of the notebook instance that you want a summary for.</p>" + }, + "notebookInstanceStatus": { + "$ref": "#/definitions/NotebookInstanceStatusEnumValue", + "description": "<p>The status of the notebook instance.</p>" + }, + "url": { + "type": "string", + "description": "<p>The URL that you use to connect to the Jupyter notebook running in your notebook instance. </p>" + } + } + }, + "InstanceType": { + "type": "string", + "description": "InstanceType enum", + "enum": [ + "ml.c4.2xlarge", + "ml.c4.4xlarge", + "ml.c4.8xlarge", + "ml.c4.xlarge", + "ml.c5.18xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.xlarge", + "ml.c5d.18xlarge", + "ml.c5d.2xlarge", + "ml.c5d.4xlarge", + "ml.c5d.9xlarge", + "ml.c5d.xlarge", + "ml.c6i.12xlarge", + "ml.c6i.16xlarge", + "ml.c6i.24xlarge", + "ml.c6i.2xlarge", + "ml.c6i.32xlarge", + "ml.c6i.4xlarge", + "ml.c6i.8xlarge", + "ml.c6i.large", + "ml.c6i.xlarge", + "ml.c6id.12xlarge", + "ml.c6id.16xlarge", + "ml.c6id.24xlarge", + "ml.c6id.2xlarge", + "ml.c6id.32xlarge", + "ml.c6id.4xlarge", + "ml.c6id.8xlarge", + "ml.c6id.large", + "ml.c6id.xlarge", + "ml.c7i.12xlarge", + "ml.c7i.16xlarge", + "ml.c7i.24xlarge", + "ml.c7i.2xlarge", + "ml.c7i.48xlarge", + "ml.c7i.4xlarge", + "ml.c7i.8xlarge", + "ml.c7i.large", + "ml.c7i.xlarge", + "ml.g4dn.12xlarge", + "ml.g4dn.16xlarge", + "ml.g4dn.2xlarge", + "ml.g4dn.4xlarge", + "ml.g4dn.8xlarge", + "ml.g4dn.xlarge", + "ml.g5.12xlarge", + "ml.g5.16xlarge", + "ml.g5.24xlarge", + "ml.g5.2xlarge", + "ml.g5.48xlarge", + "ml.g5.4xlarge", + "ml.g5.8xlarge", + "ml.g5.xlarge", + "ml.inf1.24xlarge", + "ml.inf1.2xlarge", + "ml.inf1.6xlarge", + "ml.inf1.xlarge", + "ml.m4.10xlarge", + "ml.m4.16xlarge", + "ml.m4.2xlarge", + "ml.m4.4xlarge", + "ml.m4.xlarge", + "ml.m5.12xlarge", + "ml.m5.24xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.xlarge", + "ml.m5d.12xlarge", + "ml.m5d.16xlarge", + "ml.m5d.24xlarge", + "ml.m5d.2xlarge", + "ml.m5d.4xlarge", + "ml.m5d.8xlarge", + "ml.m5d.large", + "ml.m5d.xlarge", + "ml.m6i.12xlarge", + "ml.m6i.16xlarge", + "ml.m6i.24xlarge", + "ml.m6i.2xlarge", + "ml.m6i.32xlarge", + "ml.m6i.4xlarge", + "ml.m6i.8xlarge", + "ml.m6i.large", + "ml.m6i.xlarge", + "ml.m6id.12xlarge", + "ml.m6id.16xlarge", + "ml.m6id.24xlarge", + "ml.m6id.2xlarge", + "ml.m6id.32xlarge", + "ml.m6id.4xlarge", + "ml.m6id.8xlarge", + "ml.m6id.large", + "ml.m6id.xlarge", + "ml.m7i.12xlarge", + "ml.m7i.16xlarge", + "ml.m7i.24xlarge", + "ml.m7i.2xlarge", + "ml.m7i.48xlarge", + "ml.m7i.4xlarge", + "ml.m7i.8xlarge", + "ml.m7i.large", + "ml.m7i.xlarge", + "ml.p2.16xlarge", + "ml.p2.8xlarge", + "ml.p2.xlarge", + "ml.p3.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3dn.24xlarge", + "ml.p4d.24xlarge", + "ml.p4de.24xlarge", + "ml.p5.48xlarge", + "ml.r5.12xlarge", + "ml.r5.16xlarge", + "ml.r5.24xlarge", + "ml.r5.2xlarge", + "ml.r5.4xlarge", + "ml.r5.8xlarge", + "ml.r5.large", + "ml.r5.xlarge", + "ml.r6i.12xlarge", + "ml.r6i.16xlarge", + "ml.r6i.24xlarge", + "ml.r6i.2xlarge", + "ml.r6i.32xlarge", + "ml.r6i.4xlarge", + "ml.r6i.8xlarge", + "ml.r6i.large", + "ml.r6i.xlarge", + "ml.r6id.12xlarge", + "ml.r6id.16xlarge", + "ml.r6id.24xlarge", + "ml.r6id.2xlarge", + "ml.r6id.32xlarge", + "ml.r6id.4xlarge", + "ml.r6id.8xlarge", + "ml.r6id.large", + "ml.r6id.xlarge", + "ml.r7i.12xlarge", + "ml.r7i.16xlarge", + "ml.r7i.24xlarge", + "ml.r7i.2xlarge", + "ml.r7i.48xlarge", + "ml.r7i.4xlarge", + "ml.r7i.8xlarge", + "ml.r7i.large", + "ml.r7i.xlarge", + "ml.t2.2xlarge", + "ml.t2.large", + "ml.t2.medium", + "ml.t2.xlarge", + "ml.t3.2xlarge", + "ml.t3.large", + "ml.t3.medium", + "ml.t3.xlarge" + ], + "x-ms-enum": { + "name": "InstanceType", + "modelAsString": true, + "values": [ + { + "name": "MlC42xlarge", + "value": "ml.c4.2xlarge", + "description": "InstanceType enum ml.c4.2xlarge" + }, + { + "name": "MlC44xlarge", + "value": "ml.c4.4xlarge", + "description": "InstanceType enum ml.c4.4xlarge" + }, + { + "name": "MlC48xlarge", + "value": "ml.c4.8xlarge", + "description": "InstanceType enum ml.c4.8xlarge" + }, + { + "name": "MlC4Xlarge", + "value": "ml.c4.xlarge", + "description": "InstanceType enum ml.c4.xlarge" + }, + { + "name": "MlC518xlarge", + "value": "ml.c5.18xlarge", + "description": "InstanceType enum ml.c5.18xlarge" + }, + { + "name": "MlC52xlarge", + "value": "ml.c5.2xlarge", + "description": "InstanceType enum ml.c5.2xlarge" + }, + { + "name": "MlC54xlarge", + "value": "ml.c5.4xlarge", + "description": "InstanceType enum ml.c5.4xlarge" + }, + { + "name": "MlC59xlarge", + "value": "ml.c5.9xlarge", + "description": "InstanceType enum ml.c5.9xlarge" + }, + { + "name": "MlC5Xlarge", + "value": "ml.c5.xlarge", + "description": "InstanceType enum ml.c5.xlarge" + }, + { + "name": "MlC5d18xlarge", + "value": "ml.c5d.18xlarge", + "description": "InstanceType enum ml.c5d.18xlarge" + }, + { + "name": "MlC5d2xlarge", + "value": "ml.c5d.2xlarge", + "description": "InstanceType enum ml.c5d.2xlarge" + }, + { + "name": "MlC5d4xlarge", + "value": "ml.c5d.4xlarge", + "description": "InstanceType enum ml.c5d.4xlarge" + }, + { + "name": "MlC5d9xlarge", + "value": "ml.c5d.9xlarge", + "description": "InstanceType enum ml.c5d.9xlarge" + }, + { + "name": "MlC5dXlarge", + "value": "ml.c5d.xlarge", + "description": "InstanceType enum ml.c5d.xlarge" + }, + { + "name": "MlC6i12xlarge", + "value": "ml.c6i.12xlarge", + "description": "InstanceType enum ml.c6i.12xlarge" + }, + { + "name": "MlC6i16xlarge", + "value": "ml.c6i.16xlarge", + "description": "InstanceType enum ml.c6i.16xlarge" + }, + { + "name": "MlC6i24xlarge", + "value": "ml.c6i.24xlarge", + "description": "InstanceType enum ml.c6i.24xlarge" + }, + { + "name": "MlC6i2xlarge", + "value": "ml.c6i.2xlarge", + "description": "InstanceType enum ml.c6i.2xlarge" + }, + { + "name": "MlC6i32xlarge", + "value": "ml.c6i.32xlarge", + "description": "InstanceType enum ml.c6i.32xlarge" + }, + { + "name": "MlC6i4xlarge", + "value": "ml.c6i.4xlarge", + "description": "InstanceType enum ml.c6i.4xlarge" + }, + { + "name": "MlC6i8xlarge", + "value": "ml.c6i.8xlarge", + "description": "InstanceType enum ml.c6i.8xlarge" + }, + { + "name": "MlC6iLarge", + "value": "ml.c6i.large", + "description": "InstanceType enum ml.c6i.large" + }, + { + "name": "MlC6iXlarge", + "value": "ml.c6i.xlarge", + "description": "InstanceType enum ml.c6i.xlarge" + }, + { + "name": "MlC6id12xlarge", + "value": "ml.c6id.12xlarge", + "description": "InstanceType enum ml.c6id.12xlarge" + }, + { + "name": "MlC6id16xlarge", + "value": "ml.c6id.16xlarge", + "description": "InstanceType enum ml.c6id.16xlarge" + }, + { + "name": "MlC6id24xlarge", + "value": "ml.c6id.24xlarge", + "description": "InstanceType enum ml.c6id.24xlarge" + }, + { + "name": "MlC6id2xlarge", + "value": "ml.c6id.2xlarge", + "description": "InstanceType enum ml.c6id.2xlarge" + }, + { + "name": "MlC6id32xlarge", + "value": "ml.c6id.32xlarge", + "description": "InstanceType enum ml.c6id.32xlarge" + }, + { + "name": "MlC6id4xlarge", + "value": "ml.c6id.4xlarge", + "description": "InstanceType enum ml.c6id.4xlarge" + }, + { + "name": "MlC6id8xlarge", + "value": "ml.c6id.8xlarge", + "description": "InstanceType enum ml.c6id.8xlarge" + }, + { + "name": "MlC6idLarge", + "value": "ml.c6id.large", + "description": "InstanceType enum ml.c6id.large" + }, + { + "name": "MlC6idXlarge", + "value": "ml.c6id.xlarge", + "description": "InstanceType enum ml.c6id.xlarge" + }, + { + "name": "MlC7i12xlarge", + "value": "ml.c7i.12xlarge", + "description": "InstanceType enum ml.c7i.12xlarge" + }, + { + "name": "MlC7i16xlarge", + "value": "ml.c7i.16xlarge", + "description": "InstanceType enum ml.c7i.16xlarge" + }, + { + "name": "MlC7i24xlarge", + "value": "ml.c7i.24xlarge", + "description": "InstanceType enum ml.c7i.24xlarge" + }, + { + "name": "MlC7i2xlarge", + "value": "ml.c7i.2xlarge", + "description": "InstanceType enum ml.c7i.2xlarge" + }, + { + "name": "MlC7i48xlarge", + "value": "ml.c7i.48xlarge", + "description": "InstanceType enum ml.c7i.48xlarge" + }, + { + "name": "MlC7i4xlarge", + "value": "ml.c7i.4xlarge", + "description": "InstanceType enum ml.c7i.4xlarge" + }, + { + "name": "MlC7i8xlarge", + "value": "ml.c7i.8xlarge", + "description": "InstanceType enum ml.c7i.8xlarge" + }, + { + "name": "MlC7iLarge", + "value": "ml.c7i.large", + "description": "InstanceType enum ml.c7i.large" + }, + { + "name": "MlC7iXlarge", + "value": "ml.c7i.xlarge", + "description": "InstanceType enum ml.c7i.xlarge" + }, + { + "name": "MlG4dn12xlarge", + "value": "ml.g4dn.12xlarge", + "description": "InstanceType enum ml.g4dn.12xlarge" + }, + { + "name": "MlG4dn16xlarge", + "value": "ml.g4dn.16xlarge", + "description": "InstanceType enum ml.g4dn.16xlarge" + }, + { + "name": "MlG4dn2xlarge", + "value": "ml.g4dn.2xlarge", + "description": "InstanceType enum ml.g4dn.2xlarge" + }, + { + "name": "MlG4dn4xlarge", + "value": "ml.g4dn.4xlarge", + "description": "InstanceType enum ml.g4dn.4xlarge" + }, + { + "name": "MlG4dn8xlarge", + "value": "ml.g4dn.8xlarge", + "description": "InstanceType enum ml.g4dn.8xlarge" + }, + { + "name": "MlG4dnXlarge", + "value": "ml.g4dn.xlarge", + "description": "InstanceType enum ml.g4dn.xlarge" + }, + { + "name": "MlG512xlarge", + "value": "ml.g5.12xlarge", + "description": "InstanceType enum ml.g5.12xlarge" + }, + { + "name": "MlG516xlarge", + "value": "ml.g5.16xlarge", + "description": "InstanceType enum ml.g5.16xlarge" + }, + { + "name": "MlG524xlarge", + "value": "ml.g5.24xlarge", + "description": "InstanceType enum ml.g5.24xlarge" + }, + { + "name": "MlG52xlarge", + "value": "ml.g5.2xlarge", + "description": "InstanceType enum ml.g5.2xlarge" + }, + { + "name": "MlG548xlarge", + "value": "ml.g5.48xlarge", + "description": "InstanceType enum ml.g5.48xlarge" + }, + { + "name": "MlG54xlarge", + "value": "ml.g5.4xlarge", + "description": "InstanceType enum ml.g5.4xlarge" + }, + { + "name": "MlG58xlarge", + "value": "ml.g5.8xlarge", + "description": "InstanceType enum ml.g5.8xlarge" + }, + { + "name": "MlG5Xlarge", + "value": "ml.g5.xlarge", + "description": "InstanceType enum ml.g5.xlarge" + }, + { + "name": "MlInf124xlarge", + "value": "ml.inf1.24xlarge", + "description": "InstanceType enum ml.inf1.24xlarge" + }, + { + "name": "MlInf12xlarge", + "value": "ml.inf1.2xlarge", + "description": "InstanceType enum ml.inf1.2xlarge" + }, + { + "name": "MlInf16xlarge", + "value": "ml.inf1.6xlarge", + "description": "InstanceType enum ml.inf1.6xlarge" + }, + { + "name": "MlInf1Xlarge", + "value": "ml.inf1.xlarge", + "description": "InstanceType enum ml.inf1.xlarge" + }, + { + "name": "MlM410xlarge", + "value": "ml.m4.10xlarge", + "description": "InstanceType enum ml.m4.10xlarge" + }, + { + "name": "MlM416xlarge", + "value": "ml.m4.16xlarge", + "description": "InstanceType enum ml.m4.16xlarge" + }, + { + "name": "MlM42xlarge", + "value": "ml.m4.2xlarge", + "description": "InstanceType enum ml.m4.2xlarge" + }, + { + "name": "MlM44xlarge", + "value": "ml.m4.4xlarge", + "description": "InstanceType enum ml.m4.4xlarge" + }, + { + "name": "MlM4Xlarge", + "value": "ml.m4.xlarge", + "description": "InstanceType enum ml.m4.xlarge" + }, + { + "name": "MlM512xlarge", + "value": "ml.m5.12xlarge", + "description": "InstanceType enum ml.m5.12xlarge" + }, + { + "name": "MlM524xlarge", + "value": "ml.m5.24xlarge", + "description": "InstanceType enum ml.m5.24xlarge" + }, + { + "name": "MlM52xlarge", + "value": "ml.m5.2xlarge", + "description": "InstanceType enum ml.m5.2xlarge" + }, + { + "name": "MlM54xlarge", + "value": "ml.m5.4xlarge", + "description": "InstanceType enum ml.m5.4xlarge" + }, + { + "name": "MlM5Xlarge", + "value": "ml.m5.xlarge", + "description": "InstanceType enum ml.m5.xlarge" + }, + { + "name": "MlM5d12xlarge", + "value": "ml.m5d.12xlarge", + "description": "InstanceType enum ml.m5d.12xlarge" + }, + { + "name": "MlM5d16xlarge", + "value": "ml.m5d.16xlarge", + "description": "InstanceType enum ml.m5d.16xlarge" + }, + { + "name": "MlM5d24xlarge", + "value": "ml.m5d.24xlarge", + "description": "InstanceType enum ml.m5d.24xlarge" + }, + { + "name": "MlM5d2xlarge", + "value": "ml.m5d.2xlarge", + "description": "InstanceType enum ml.m5d.2xlarge" + }, + { + "name": "MlM5d4xlarge", + "value": "ml.m5d.4xlarge", + "description": "InstanceType enum ml.m5d.4xlarge" + }, + { + "name": "MlM5d8xlarge", + "value": "ml.m5d.8xlarge", + "description": "InstanceType enum ml.m5d.8xlarge" + }, + { + "name": "MlM5dLarge", + "value": "ml.m5d.large", + "description": "InstanceType enum ml.m5d.large" + }, + { + "name": "MlM5dXlarge", + "value": "ml.m5d.xlarge", + "description": "InstanceType enum ml.m5d.xlarge" + }, + { + "name": "MlM6i12xlarge", + "value": "ml.m6i.12xlarge", + "description": "InstanceType enum ml.m6i.12xlarge" + }, + { + "name": "MlM6i16xlarge", + "value": "ml.m6i.16xlarge", + "description": "InstanceType enum ml.m6i.16xlarge" + }, + { + "name": "MlM6i24xlarge", + "value": "ml.m6i.24xlarge", + "description": "InstanceType enum ml.m6i.24xlarge" + }, + { + "name": "MlM6i2xlarge", + "value": "ml.m6i.2xlarge", + "description": "InstanceType enum ml.m6i.2xlarge" + }, + { + "name": "MlM6i32xlarge", + "value": "ml.m6i.32xlarge", + "description": "InstanceType enum ml.m6i.32xlarge" + }, + { + "name": "MlM6i4xlarge", + "value": "ml.m6i.4xlarge", + "description": "InstanceType enum ml.m6i.4xlarge" + }, + { + "name": "MlM6i8xlarge", + "value": "ml.m6i.8xlarge", + "description": "InstanceType enum ml.m6i.8xlarge" + }, + { + "name": "MlM6iLarge", + "value": "ml.m6i.large", + "description": "InstanceType enum ml.m6i.large" + }, + { + "name": "MlM6iXlarge", + "value": "ml.m6i.xlarge", + "description": "InstanceType enum ml.m6i.xlarge" + }, + { + "name": "MlM6id12xlarge", + "value": "ml.m6id.12xlarge", + "description": "InstanceType enum ml.m6id.12xlarge" + }, + { + "name": "MlM6id16xlarge", + "value": "ml.m6id.16xlarge", + "description": "InstanceType enum ml.m6id.16xlarge" + }, + { + "name": "MlM6id24xlarge", + "value": "ml.m6id.24xlarge", + "description": "InstanceType enum ml.m6id.24xlarge" + }, + { + "name": "MlM6id2xlarge", + "value": "ml.m6id.2xlarge", + "description": "InstanceType enum ml.m6id.2xlarge" + }, + { + "name": "MlM6id32xlarge", + "value": "ml.m6id.32xlarge", + "description": "InstanceType enum ml.m6id.32xlarge" + }, + { + "name": "MlM6id4xlarge", + "value": "ml.m6id.4xlarge", + "description": "InstanceType enum ml.m6id.4xlarge" + }, + { + "name": "MlM6id8xlarge", + "value": "ml.m6id.8xlarge", + "description": "InstanceType enum ml.m6id.8xlarge" + }, + { + "name": "MlM6idLarge", + "value": "ml.m6id.large", + "description": "InstanceType enum ml.m6id.large" + }, + { + "name": "MlM6idXlarge", + "value": "ml.m6id.xlarge", + "description": "InstanceType enum ml.m6id.xlarge" + }, + { + "name": "MlM7i12xlarge", + "value": "ml.m7i.12xlarge", + "description": "InstanceType enum ml.m7i.12xlarge" + }, + { + "name": "MlM7i16xlarge", + "value": "ml.m7i.16xlarge", + "description": "InstanceType enum ml.m7i.16xlarge" + }, + { + "name": "MlM7i24xlarge", + "value": "ml.m7i.24xlarge", + "description": "InstanceType enum ml.m7i.24xlarge" + }, + { + "name": "MlM7i2xlarge", + "value": "ml.m7i.2xlarge", + "description": "InstanceType enum ml.m7i.2xlarge" + }, + { + "name": "MlM7i48xlarge", + "value": "ml.m7i.48xlarge", + "description": "InstanceType enum ml.m7i.48xlarge" + }, + { + "name": "MlM7i4xlarge", + "value": "ml.m7i.4xlarge", + "description": "InstanceType enum ml.m7i.4xlarge" + }, + { + "name": "MlM7i8xlarge", + "value": "ml.m7i.8xlarge", + "description": "InstanceType enum ml.m7i.8xlarge" + }, + { + "name": "MlM7iLarge", + "value": "ml.m7i.large", + "description": "InstanceType enum ml.m7i.large" + }, + { + "name": "MlM7iXlarge", + "value": "ml.m7i.xlarge", + "description": "InstanceType enum ml.m7i.xlarge" + }, + { + "name": "MlP216xlarge", + "value": "ml.p2.16xlarge", + "description": "InstanceType enum ml.p2.16xlarge" + }, + { + "name": "MlP28xlarge", + "value": "ml.p2.8xlarge", + "description": "InstanceType enum ml.p2.8xlarge" + }, + { + "name": "MlP2Xlarge", + "value": "ml.p2.xlarge", + "description": "InstanceType enum ml.p2.xlarge" + }, + { + "name": "MlP316xlarge", + "value": "ml.p3.16xlarge", + "description": "InstanceType enum ml.p3.16xlarge" + }, + { + "name": "MlP32xlarge", + "value": "ml.p3.2xlarge", + "description": "InstanceType enum ml.p3.2xlarge" + }, + { + "name": "MlP38xlarge", + "value": "ml.p3.8xlarge", + "description": "InstanceType enum ml.p3.8xlarge" + }, + { + "name": "MlP3dn24xlarge", + "value": "ml.p3dn.24xlarge", + "description": "InstanceType enum ml.p3dn.24xlarge" + }, + { + "name": "MlP4d24xlarge", + "value": "ml.p4d.24xlarge", + "description": "InstanceType enum ml.p4d.24xlarge" + }, + { + "name": "MlP4de24xlarge", + "value": "ml.p4de.24xlarge", + "description": "InstanceType enum ml.p4de.24xlarge" + }, + { + "name": "MlP548xlarge", + "value": "ml.p5.48xlarge", + "description": "InstanceType enum ml.p5.48xlarge" + }, + { + "name": "MlR512xlarge", + "value": "ml.r5.12xlarge", + "description": "InstanceType enum ml.r5.12xlarge" + }, + { + "name": "MlR516xlarge", + "value": "ml.r5.16xlarge", + "description": "InstanceType enum ml.r5.16xlarge" + }, + { + "name": "MlR524xlarge", + "value": "ml.r5.24xlarge", + "description": "InstanceType enum ml.r5.24xlarge" + }, + { + "name": "MlR52xlarge", + "value": "ml.r5.2xlarge", + "description": "InstanceType enum ml.r5.2xlarge" + }, + { + "name": "MlR54xlarge", + "value": "ml.r5.4xlarge", + "description": "InstanceType enum ml.r5.4xlarge" + }, + { + "name": "MlR58xlarge", + "value": "ml.r5.8xlarge", + "description": "InstanceType enum ml.r5.8xlarge" + }, + { + "name": "MlR5Large", + "value": "ml.r5.large", + "description": "InstanceType enum ml.r5.large" + }, + { + "name": "MlR5Xlarge", + "value": "ml.r5.xlarge", + "description": "InstanceType enum ml.r5.xlarge" + }, + { + "name": "MlR6i12xlarge", + "value": "ml.r6i.12xlarge", + "description": "InstanceType enum ml.r6i.12xlarge" + }, + { + "name": "MlR6i16xlarge", + "value": "ml.r6i.16xlarge", + "description": "InstanceType enum ml.r6i.16xlarge" + }, + { + "name": "MlR6i24xlarge", + "value": "ml.r6i.24xlarge", + "description": "InstanceType enum ml.r6i.24xlarge" + }, + { + "name": "MlR6i2xlarge", + "value": "ml.r6i.2xlarge", + "description": "InstanceType enum ml.r6i.2xlarge" + }, + { + "name": "MlR6i32xlarge", + "value": "ml.r6i.32xlarge", + "description": "InstanceType enum ml.r6i.32xlarge" + }, + { + "name": "MlR6i4xlarge", + "value": "ml.r6i.4xlarge", + "description": "InstanceType enum ml.r6i.4xlarge" + }, + { + "name": "MlR6i8xlarge", + "value": "ml.r6i.8xlarge", + "description": "InstanceType enum ml.r6i.8xlarge" + }, + { + "name": "MlR6iLarge", + "value": "ml.r6i.large", + "description": "InstanceType enum ml.r6i.large" + }, + { + "name": "MlR6iXlarge", + "value": "ml.r6i.xlarge", + "description": "InstanceType enum ml.r6i.xlarge" + }, + { + "name": "MlR6id12xlarge", + "value": "ml.r6id.12xlarge", + "description": "InstanceType enum ml.r6id.12xlarge" + }, + { + "name": "MlR6id16xlarge", + "value": "ml.r6id.16xlarge", + "description": "InstanceType enum ml.r6id.16xlarge" + }, + { + "name": "MlR6id24xlarge", + "value": "ml.r6id.24xlarge", + "description": "InstanceType enum ml.r6id.24xlarge" + }, + { + "name": "MlR6id2xlarge", + "value": "ml.r6id.2xlarge", + "description": "InstanceType enum ml.r6id.2xlarge" + }, + { + "name": "MlR6id32xlarge", + "value": "ml.r6id.32xlarge", + "description": "InstanceType enum ml.r6id.32xlarge" + }, + { + "name": "MlR6id4xlarge", + "value": "ml.r6id.4xlarge", + "description": "InstanceType enum ml.r6id.4xlarge" + }, + { + "name": "MlR6id8xlarge", + "value": "ml.r6id.8xlarge", + "description": "InstanceType enum ml.r6id.8xlarge" + }, + { + "name": "MlR6idLarge", + "value": "ml.r6id.large", + "description": "InstanceType enum ml.r6id.large" + }, + { + "name": "MlR6idXlarge", + "value": "ml.r6id.xlarge", + "description": "InstanceType enum ml.r6id.xlarge" + }, + { + "name": "MlR7i12xlarge", + "value": "ml.r7i.12xlarge", + "description": "InstanceType enum ml.r7i.12xlarge" + }, + { + "name": "MlR7i16xlarge", + "value": "ml.r7i.16xlarge", + "description": "InstanceType enum ml.r7i.16xlarge" + }, + { + "name": "MlR7i24xlarge", + "value": "ml.r7i.24xlarge", + "description": "InstanceType enum ml.r7i.24xlarge" + }, + { + "name": "MlR7i2xlarge", + "value": "ml.r7i.2xlarge", + "description": "InstanceType enum ml.r7i.2xlarge" + }, + { + "name": "MlR7i48xlarge", + "value": "ml.r7i.48xlarge", + "description": "InstanceType enum ml.r7i.48xlarge" + }, + { + "name": "MlR7i4xlarge", + "value": "ml.r7i.4xlarge", + "description": "InstanceType enum ml.r7i.4xlarge" + }, + { + "name": "MlR7i8xlarge", + "value": "ml.r7i.8xlarge", + "description": "InstanceType enum ml.r7i.8xlarge" + }, + { + "name": "MlR7iLarge", + "value": "ml.r7i.large", + "description": "InstanceType enum ml.r7i.large" + }, + { + "name": "MlR7iXlarge", + "value": "ml.r7i.xlarge", + "description": "InstanceType enum ml.r7i.xlarge" + }, + { + "name": "MlT22xlarge", + "value": "ml.t2.2xlarge", + "description": "InstanceType enum ml.t2.2xlarge" + }, + { + "name": "MlT2Large", + "value": "ml.t2.large", + "description": "InstanceType enum ml.t2.large" + }, + { + "name": "MlT2Medium", + "value": "ml.t2.medium", + "description": "InstanceType enum ml.t2.medium" + }, + { + "name": "MlT2Xlarge", + "value": "ml.t2.xlarge", + "description": "InstanceType enum ml.t2.xlarge" + }, + { + "name": "MlT32xlarge", + "value": "ml.t3.2xlarge", + "description": "InstanceType enum ml.t3.2xlarge" + }, + { + "name": "MlT3Large", + "value": "ml.t3.large", + "description": "InstanceType enum ml.t3.large" + }, + { + "name": "MlT3Medium", + "value": "ml.t3.medium", + "description": "InstanceType enum ml.t3.medium" + }, + { + "name": "MlT3Xlarge", + "value": "ml.t3.xlarge", + "description": "InstanceType enum ml.t3.xlarge" + } + ] + } + }, + "InstanceTypeEnumValue": { + "type": "object", + "description": "Definition of InstanceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/InstanceType", + "description": "Property value" + } + } + }, + "NotebookInstanceStatus": { + "type": "string", + "description": "NotebookInstanceStatus enum", + "enum": [ + "Deleting", + "Failed", + "InService", + "Pending", + "Stopped", + "Stopping", + "Updating" + ], + "x-ms-enum": { + "name": "NotebookInstanceStatus", + "modelAsString": true, + "values": [ + { + "name": "Deleting", + "value": "Deleting", + "description": "NotebookInstanceStatus enum Deleting" + }, + { + "name": "Failed", + "value": "Failed", + "description": "NotebookInstanceStatus enum Failed" + }, + { + "name": "InService", + "value": "InService", + "description": "NotebookInstanceStatus enum InService" + }, + { + "name": "Pending", + "value": "Pending", + "description": "NotebookInstanceStatus enum Pending" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "NotebookInstanceStatus enum Stopped" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "NotebookInstanceStatus enum Stopping" + }, + { + "name": "Updating", + "value": "Updating", + "description": "NotebookInstanceStatus enum Updating" + } + ] + } + }, + "NotebookInstanceStatusEnumValue": { + "type": "object", + "description": "Definition of NotebookInstanceStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/NotebookInstanceStatus", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SageMakerNotebookInstanceSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SageMakerNotebookInstanceSummaryListResult": { + "type": "object", + "description": "The response of a SageMakerNotebookInstanceSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SageMakerNotebookInstanceSummary items on this page", + "items": { + "$ref": "#/definitions/SageMakerNotebookInstanceSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SageMakerNotebookInstanceSummaryProperties": { + "type": "object", + "description": "Definition of SageMakerNotebookInstanceSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSageMakerNotebookInstanceSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SageMakerNotebookInstanceSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SageMakerNotebookInstanceSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerResourcePolicy.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerResourcePolicy.json new file mode 100644 index 000000000000..56be502b0592 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerResourcePolicy.json @@ -0,0 +1,557 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SecretsManagerResourcePolicies" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/secretsManagerResourcePolicies": { + "get": { + "operationId": "SecretsManagerResourcePolicies_ListBySubscription", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "List SecretsManagerResourcePolicy resources 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/SecretsManagerResourcePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerResourcePolicies_ListBySubscription": { + "$ref": "./examples/SecretsManagerResourcePolicies_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/secretsManagerResourcePolicies": { + "get": { + "operationId": "SecretsManagerResourcePolicies_ListByResourceGroup", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "List SecretsManagerResourcePolicy resources 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/SecretsManagerResourcePolicyListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerResourcePolicies_ListByResourceGroup": { + "$ref": "./examples/SecretsManagerResourcePolicies_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/secretsManagerResourcePolicies/{name}": { + "get": { + "operationId": "SecretsManagerResourcePolicies_Get", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "Get a SecretsManagerResourcePolicy", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerResourcePolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerResourcePolicies_Get": { + "$ref": "./examples/SecretsManagerResourcePolicies_Get.json" + } + } + }, + "put": { + "operationId": "SecretsManagerResourcePolicies_CreateOrReplace", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "Create a SecretsManagerResourcePolicy. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerResourcePolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecretsManagerResourcePolicy' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + } + }, + "201": { + "description": "Resource 'SecretsManagerResourcePolicy' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SecretsManagerResourcePolicies_CreateOrReplace": { + "$ref": "./examples/SecretsManagerResourcePolicies_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SecretsManagerResourcePolicies_Update", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "Update a SecretsManagerResourcePolicy", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerResourcePolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicyTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerResourcePolicies_Update": { + "$ref": "./examples/SecretsManagerResourcePolicies_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecretsManagerResourcePolicies_Delete", + "tags": [ + "SecretsManagerResourcePolicies" + ], + "description": "Delete a SecretsManagerResourcePolicy", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerResourcePolicy", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SecretsManagerResourcePolicies_Delete": { + "$ref": "./examples/SecretsManagerResourcePolicies_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSecretsManagerResourcePolicyProperties": { + "type": "object", + "description": "Definition of awsSecretsManagerResourcePolicy", + "properties": { + "blockPublicPolicy": { + "type": "boolean", + "description": "Property blockPublicPolicy" + }, + "id": { + "type": "string", + "description": "Property id" + }, + "resourcePolicy": { + "description": "Property resourcePolicy" + }, + "secretId": { + "type": "string", + "description": "Property secretId" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SecretsManagerResourcePolicy": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SecretsManagerResourcePolicyProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SecretsManagerResourcePolicyListResult": { + "type": "object", + "description": "The response of a SecretsManagerResourcePolicy list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecretsManagerResourcePolicy items on this page", + "items": { + "$ref": "#/definitions/SecretsManagerResourcePolicy" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecretsManagerResourcePolicyProperties": { + "type": "object", + "description": "Definition of SecretsManagerResourcePolicy", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSecretsManagerResourcePolicyProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SecretsManagerResourcePolicyTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SecretsManagerResourcePolicy resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerSecret.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerSecret.json new file mode 100644 index 000000000000..b9e27640b857 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/secretsManagerSecret.json @@ -0,0 +1,657 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SecretsManagerSecrets" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/secretsManagerSecrets": { + "get": { + "operationId": "SecretsManagerSecrets_ListBySubscription", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "List SecretsManagerSecret resources 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/SecretsManagerSecretListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerSecrets_ListBySubscription": { + "$ref": "./examples/SecretsManagerSecrets_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/secretsManagerSecrets": { + "get": { + "operationId": "SecretsManagerSecrets_ListByResourceGroup", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "List SecretsManagerSecret resources 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/SecretsManagerSecretListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerSecrets_ListByResourceGroup": { + "$ref": "./examples/SecretsManagerSecrets_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/secretsManagerSecrets/{name}": { + "get": { + "operationId": "SecretsManagerSecrets_Get", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "Get a SecretsManagerSecret", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerSecret", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecretsManagerSecret" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerSecrets_Get": { + "$ref": "./examples/SecretsManagerSecrets_Get.json" + } + } + }, + "put": { + "operationId": "SecretsManagerSecrets_CreateOrReplace", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "Create a SecretsManagerSecret. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerSecret", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecretsManagerSecret" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecretsManagerSecret' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecretsManagerSecret" + } + }, + "201": { + "description": "Resource 'SecretsManagerSecret' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecretsManagerSecret" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SecretsManagerSecrets_CreateOrReplace": { + "$ref": "./examples/SecretsManagerSecrets_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SecretsManagerSecrets_Update", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "Update a SecretsManagerSecret", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerSecret", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SecretsManagerSecretTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecretsManagerSecret" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SecretsManagerSecrets_Update": { + "$ref": "./examples/SecretsManagerSecrets_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecretsManagerSecrets_Delete", + "tags": [ + "SecretsManagerSecrets" + ], + "description": "Delete a SecretsManagerSecret", + "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": "name", + "in": "path", + "description": "Name of SecretsManagerSecret", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SecretsManagerSecrets_Delete": { + "$ref": "./examples/SecretsManagerSecrets_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSecretsManagerSecretProperties": { + "type": "object", + "description": "Definition of awsSecretsManagerSecret", + "properties": { + "description": { + "type": "string", + "description": "The description of the secret." + }, + "generateSecretString": { + "$ref": "#/definitions/GenerateSecretString", + "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html)." + }, + "id": { + "type": "string", + "description": "Property id" + }, + "kmsKeyId": { + "type": "string", + "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key." + }, + "name": { + "type": "string", + "description": "The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN." + }, + "replicaRegions": { + "type": "array", + "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.", + "items": { + "$ref": "#/definitions/ReplicaRegion" + }, + "x-ms-identifiers": [] + }, + "secretString": { + "type": "string", + "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created." + }, + "tags": { + "type": "array", + "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: ``[{'Key':'CostCenter','Value':'12345'},{'Key':'environment','Value':'production'}]`` Secrets Manager tag key names are case sensitive. A tag with the key 'ABC' is a different tag from one with key 'abc'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: + Maximum number of tags per secret: 50 + Maximum key length: 127 Unicode characters in UTF-8 + Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + } + } + }, + "GenerateSecretString": { + "type": "object", + "description": "Definition of GenerateSecretString", + "properties": { + "excludeCharacters": { + "type": "string", + "description": "A string of the characters that you don't want in the password." + }, + "excludeLowercase": { + "type": "boolean", + "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters." + }, + "excludeNumbers": { + "type": "boolean", + "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers." + }, + "excludePunctuation": { + "type": "boolean", + "description": "Specifies whether to exclude the following punctuation characters from the password: ``! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation." + }, + "excludeUppercase": { + "type": "boolean", + "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters." + }, + "generateStringKey": { + "type": "string", + "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``." + }, + "includeSpace": { + "type": "boolean", + "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters." + }, + "passwordLength": { + "type": "integer", + "format": "int32", + "description": "The length of the password. If you don't include this parameter, the default length is 32 characters." + }, + "requireEachIncludedType": { + "type": "boolean", + "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type." + }, + "secretStringTemplate": { + "type": "string", + "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ReplicaRegion": { + "type": "object", + "description": "Definition of ReplicaRegion", + "properties": { + "kmsKeyId": { + "type": "string", + "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``." + }, + "region": { + "type": "string", + "description": "A string that represents a ``Region``, for example 'us-east-1'." + } + } + }, + "SecretsManagerSecret": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SecretsManagerSecretProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SecretsManagerSecretListResult": { + "type": "object", + "description": "The response of a SecretsManagerSecret list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecretsManagerSecret items on this page", + "items": { + "$ref": "#/definitions/SecretsManagerSecret" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecretsManagerSecretProperties": { + "type": "object", + "description": "Definition of SecretsManagerSecret", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSecretsManagerSecretProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SecretsManagerSecretTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SecretsManagerSecret resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key identifier, or name, of the tag." + }, + "value": { + "type": "string", + "description": "The string value associated with the key of the tag." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsSubscription.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsSubscription.json new file mode 100644 index 000000000000..2068f4c489f0 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsSubscription.json @@ -0,0 +1,562 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SnsSubscriptions" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/snsSubscriptions": { + "get": { + "operationId": "SnsSubscriptions_ListBySubscription", + "tags": [ + "SnsSubscriptions" + ], + "description": "List SnsSubscription resources 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/SnsSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsSubscriptions_ListBySubscription": { + "$ref": "./examples/SnsSubscriptions_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/snsSubscriptions": { + "get": { + "operationId": "SnsSubscriptions_ListByResourceGroup", + "tags": [ + "SnsSubscriptions" + ], + "description": "List SnsSubscription resources 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/SnsSubscriptionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsSubscriptions_ListByResourceGroup": { + "$ref": "./examples/SnsSubscriptions_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/snsSubscriptions/{name}": { + "get": { + "operationId": "SnsSubscriptions_Get", + "tags": [ + "SnsSubscriptions" + ], + "description": "Get a SnsSubscription", + "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": "name", + "in": "path", + "description": "Name of SnsSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnsSubscription" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsSubscriptions_Get": { + "$ref": "./examples/SnsSubscriptions_Get.json" + } + } + }, + "put": { + "operationId": "SnsSubscriptions_CreateOrReplace", + "tags": [ + "SnsSubscriptions" + ], + "description": "Create a SnsSubscription. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SnsSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SnsSubscription" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SnsSubscription' update operation succeeded", + "schema": { + "$ref": "#/definitions/SnsSubscription" + } + }, + "201": { + "description": "Resource 'SnsSubscription' create operation succeeded", + "schema": { + "$ref": "#/definitions/SnsSubscription" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SnsSubscriptions_CreateOrReplace": { + "$ref": "./examples/SnsSubscriptions_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SnsSubscriptions_Update", + "tags": [ + "SnsSubscriptions" + ], + "description": "Update a SnsSubscription", + "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": "name", + "in": "path", + "description": "Name of SnsSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SnsSubscriptionTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnsSubscription" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsSubscriptions_Update": { + "$ref": "./examples/SnsSubscriptions_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SnsSubscriptions_Delete", + "tags": [ + "SnsSubscriptions" + ], + "description": "Delete a SnsSubscription", + "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": "name", + "in": "path", + "description": "Name of SnsSubscription", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SnsSubscriptions_Delete": { + "$ref": "./examples/SnsSubscriptions_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSnsSubscriptionProperties": { + "type": "object", + "description": "Definition of awsSnsSubscription", + "properties": { + "endpoint": { + "type": "string", + "description": "<p>The subscription's endpoint (format depends on the protocol).</p>" + }, + "owner": { + "type": "string", + "description": "<p>The subscription's owner.</p>" + }, + "protocol": { + "type": "string", + "description": "<p>The subscription's protocol.</p>" + }, + "subscriptionArn": { + "type": "string", + "description": "<p>The subscription's ARN.</p>" + }, + "topicArn": { + "type": "string", + "description": "<p>The ARN of the subscription's topic.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SnsSubscription": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SnsSubscriptionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SnsSubscriptionListResult": { + "type": "object", + "description": "The response of a SnsSubscription list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SnsSubscription items on this page", + "items": { + "$ref": "#/definitions/SnsSubscription" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SnsSubscriptionProperties": { + "type": "object", + "description": "Definition of SnsSubscription", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSnsSubscriptionProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SnsSubscriptionTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SnsSubscription resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsTopic.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsTopic.json new file mode 100644 index 000000000000..72bdc8c538d4 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/snsTopic.json @@ -0,0 +1,696 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SnsTopics" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/snsTopics": { + "get": { + "operationId": "SnsTopics_ListBySubscription", + "tags": [ + "SnsTopics" + ], + "description": "List SnsTopic resources 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/SnsTopicListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsTopics_ListBySubscription": { + "$ref": "./examples/SnsTopics_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/snsTopics": { + "get": { + "operationId": "SnsTopics_ListByResourceGroup", + "tags": [ + "SnsTopics" + ], + "description": "List SnsTopic resources 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/SnsTopicListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsTopics_ListByResourceGroup": { + "$ref": "./examples/SnsTopics_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/snsTopics/{name}": { + "get": { + "operationId": "SnsTopics_Get", + "tags": [ + "SnsTopics" + ], + "description": "Get a SnsTopic", + "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": "name", + "in": "path", + "description": "Name of SnsTopic", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnsTopic" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsTopics_Get": { + "$ref": "./examples/SnsTopics_Get.json" + } + } + }, + "put": { + "operationId": "SnsTopics_CreateOrReplace", + "tags": [ + "SnsTopics" + ], + "description": "Create a SnsTopic. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SnsTopic", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SnsTopic" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SnsTopic' update operation succeeded", + "schema": { + "$ref": "#/definitions/SnsTopic" + } + }, + "201": { + "description": "Resource 'SnsTopic' create operation succeeded", + "schema": { + "$ref": "#/definitions/SnsTopic" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SnsTopics_CreateOrReplace": { + "$ref": "./examples/SnsTopics_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SnsTopics_Update", + "tags": [ + "SnsTopics" + ], + "description": "Update a SnsTopic", + "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": "name", + "in": "path", + "description": "Name of SnsTopic", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SnsTopicTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SnsTopic" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnsTopics_Update": { + "$ref": "./examples/SnsTopics_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SnsTopics_Delete", + "tags": [ + "SnsTopics" + ], + "description": "Delete a SnsTopic", + "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": "name", + "in": "path", + "description": "Name of SnsTopic", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SnsTopics_Delete": { + "$ref": "./examples/SnsTopics_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSnsTopicProperties": { + "type": "object", + "description": "Definition of awsSnsTopic", + "properties": { + "archivePolicy": { + "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days." + }, + "contentBasedDeduplication": { + "type": "boolean", + "description": "Enables content-based deduplication for FIFO topics. + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action." + }, + "dataProtectionPolicy": { + "description": "The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720." + }, + "deliveryStatusLogging": { + "type": "array", + "description": "Property deliveryStatusLogging", + "items": { + "$ref": "#/definitions/LoggingConfig" + }, + "x-ms-identifiers": [] + }, + "displayName": { + "type": "string", + "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs." + }, + "fifoTopic": { + "type": "boolean", + "description": "Set to true to create a FIFO topic." + }, + "kmsMasterKeyId": { + "type": "string", + "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)." + }, + "signatureVersion": { + "type": "string", + "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``." + }, + "subscription": { + "type": "array", + "description": "The SNS subscriptions (endpoints) for this topic. If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted.", + "items": { + "$ref": "#/definitions/Subscription" + }, + "x-ms-identifiers": [] + }, + "tags": { + "type": "array", + "description": "The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "topicArn": { + "type": "string", + "description": "Property topicArn" + }, + "topicName": { + "type": "string", + "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "tracingConfig": { + "type": "string", + "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true." + } + } + }, + "LoggingConfig": { + "type": "object", + "description": "Definition of LoggingConfig", + "properties": { + "failureFeedbackRoleArn": { + "type": "string", + "description": "Property failureFeedbackRoleArn" + }, + "protocol": { + "$ref": "#/definitions/LoggingConfigProtocol", + "description": "Property protocol" + }, + "successFeedbackRoleArn": { + "type": "string", + "description": "Property successFeedbackRoleArn" + }, + "successFeedbackSampleRate": { + "type": "string", + "description": "Property successFeedbackSampleRate" + } + } + }, + "LoggingConfigProtocol": { + "type": "string", + "description": "LoggingConfigProtocol enum", + "enum": [ + "application", + "firehose", + "http/s", + "lambda", + "sqs" + ], + "x-ms-enum": { + "name": "LoggingConfigProtocol", + "modelAsString": true, + "values": [ + { + "name": "application", + "value": "application", + "description": "LoggingConfigProtocol enum application" + }, + { + "name": "firehose", + "value": "firehose", + "description": "LoggingConfigProtocol enum firehose" + }, + { + "name": "HttpS", + "value": "http/s", + "description": "LoggingConfigProtocol enum http/s" + }, + { + "name": "lambda", + "value": "lambda", + "description": "LoggingConfigProtocol enum lambda" + }, + { + "name": "sqs", + "value": "sqs", + "description": "LoggingConfigProtocol enum sqs" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SnsTopic": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SnsTopicProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SnsTopicListResult": { + "type": "object", + "description": "The response of a SnsTopic list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SnsTopic items on this page", + "items": { + "$ref": "#/definitions/SnsTopic" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SnsTopicProperties": { + "type": "object", + "description": "Definition of SnsTopic", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSnsTopicProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SnsTopicTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SnsTopic resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Subscription": { + "type": "object", + "description": "Definition of Subscription", + "properties": { + "endpoint": { + "type": "string", + "description": "The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*." + }, + "protocol": { + "type": "string", + "description": "The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*." + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The required key portion of the tag." + }, + "value": { + "type": "string", + "description": "The optional value portion of the tag." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sqsQueue.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sqsQueue.json new file mode 100644 index 000000000000..63fc55dcd15a --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/sqsQueue.json @@ -0,0 +1,640 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SqsQueues" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/sqsQueues": { + "get": { + "operationId": "SqsQueues_ListBySubscription", + "tags": [ + "SqsQueues" + ], + "description": "List SqsQueue resources 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/SqsQueueListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqsQueues_ListBySubscription": { + "$ref": "./examples/SqsQueues_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sqsQueues": { + "get": { + "operationId": "SqsQueues_ListByResourceGroup", + "tags": [ + "SqsQueues" + ], + "description": "List SqsQueue resources 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/SqsQueueListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqsQueues_ListByResourceGroup": { + "$ref": "./examples/SqsQueues_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/sqsQueues/{name}": { + "get": { + "operationId": "SqsQueues_Get", + "tags": [ + "SqsQueues" + ], + "description": "Get a SqsQueue", + "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": "name", + "in": "path", + "description": "Name of SqsQueue", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqsQueue" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqsQueues_Get": { + "$ref": "./examples/SqsQueues_Get.json" + } + } + }, + "put": { + "operationId": "SqsQueues_CreateOrReplace", + "tags": [ + "SqsQueues" + ], + "description": "Create a SqsQueue. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SqsQueue", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SqsQueue" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SqsQueue' update operation succeeded", + "schema": { + "$ref": "#/definitions/SqsQueue" + } + }, + "201": { + "description": "Resource 'SqsQueue' create operation succeeded", + "schema": { + "$ref": "#/definitions/SqsQueue" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SqsQueues_CreateOrReplace": { + "$ref": "./examples/SqsQueues_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SqsQueues_Update", + "tags": [ + "SqsQueues" + ], + "description": "Update a SqsQueue", + "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": "name", + "in": "path", + "description": "Name of SqsQueue", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqsQueueTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SqsQueue" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SqsQueues_Update": { + "$ref": "./examples/SqsQueues_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SqsQueues_Delete", + "tags": [ + "SqsQueues" + ], + "description": "Delete a SqsQueue", + "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": "name", + "in": "path", + "description": "Name of SqsQueue", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SqsQueues_Delete": { + "$ref": "./examples/SqsQueues_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSqsQueueProperties": { + "type": "object", + "description": "Definition of awsSqsQueue", + "properties": { + "arn": { + "type": "string", + "description": "Property arn" + }, + "contentBasedDeduplication": { + "type": "boolean", + "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*." + }, + "deduplicationScope": { + "type": "string", + "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." + }, + "delaySeconds": { + "type": "integer", + "format": "int32", + "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``." + }, + "fifoQueue": { + "type": "boolean", + "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*." + }, + "fifoThroughputLimit": { + "type": "string", + "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." + }, + "kmsDataKeyReusePeriodSeconds": { + "type": "integer", + "format": "int32", + "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*." + }, + "kmsMasterKeyId": { + "type": "string", + "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + The Key Management Service (KMS) section of the [Best Practices](https://docs.aws.amazon.com/https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper" + }, + "maximumMessageSize": { + "type": "integer", + "format": "int32", + "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB)." + }, + "messageRetentionPeriod": { + "type": "integer", + "format": "int32", + "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days)." + }, + "queueName": { + "type": "string", + "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." + }, + "queueUrl": { + "type": "string", + "description": "Property queueUrl" + }, + "receiveMessageWaitTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*." + }, + "redriveAllowPolicy": { + "type": "object", + "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``.", + "additionalProperties": {} + }, + "redrivePolicy": { + "type": "object", + "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* ``{ 'deadLetterTargetArn' : String, 'maxReceiveCount' : Integer }`` *YAML* ``deadLetterTargetArn : String`` ``maxReceiveCount : Integer``", + "additionalProperties": {} + }, + "sqsManagedSseEnabled": { + "type": "boolean", + "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default." + }, + "tags": { + "type": "array", + "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*.", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-ms-identifiers": [] + }, + "visibilityTimeout": { + "type": "integer", + "format": "int32", + "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*." + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SqsQueue": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SqsQueueProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SqsQueueListResult": { + "type": "object", + "description": "The response of a SqsQueue list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SqsQueue items on this page", + "items": { + "$ref": "#/definitions/SqsQueue" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SqsQueueProperties": { + "type": "object", + "description": "Definition of SqsQueue", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSqsQueueProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SqsQueueTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SqsQueue resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tag": { + "type": "object", + "description": "Definition of Tag", + "properties": { + "key": { + "type": "string", + "description": "The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + }, + "value": { + "type": "string", + "description": "The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -." + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmInstanceInformation.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmInstanceInformation.json new file mode 100644 index 000000000000..81cc7dda6a84 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmInstanceInformation.json @@ -0,0 +1,802 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SsmInstanceInformations" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ssmInstanceInformations": { + "get": { + "operationId": "SsmInstanceInformations_ListBySubscription", + "tags": [ + "SsmInstanceInformations" + ], + "description": "List SsmInstanceInformation resources 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/SsmInstanceInformationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmInstanceInformations_ListBySubscription": { + "$ref": "./examples/SsmInstanceInformations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmInstanceInformations": { + "get": { + "operationId": "SsmInstanceInformations_ListByResourceGroup", + "tags": [ + "SsmInstanceInformations" + ], + "description": "List SsmInstanceInformation resources 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/SsmInstanceInformationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmInstanceInformations_ListByResourceGroup": { + "$ref": "./examples/SsmInstanceInformations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmInstanceInformations/{name}": { + "get": { + "operationId": "SsmInstanceInformations_Get", + "tags": [ + "SsmInstanceInformations" + ], + "description": "Get a SsmInstanceInformation", + "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": "name", + "in": "path", + "description": "Name of SsmInstanceInformation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmInstanceInformation" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmInstanceInformations_Get": { + "$ref": "./examples/SsmInstanceInformations_Get.json" + } + } + }, + "put": { + "operationId": "SsmInstanceInformations_CreateOrReplace", + "tags": [ + "SsmInstanceInformations" + ], + "description": "Create a SsmInstanceInformation. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SsmInstanceInformation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmInstanceInformation" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SsmInstanceInformation' update operation succeeded", + "schema": { + "$ref": "#/definitions/SsmInstanceInformation" + } + }, + "201": { + "description": "Resource 'SsmInstanceInformation' create operation succeeded", + "schema": { + "$ref": "#/definitions/SsmInstanceInformation" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SsmInstanceInformations_CreateOrReplace": { + "$ref": "./examples/SsmInstanceInformations_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SsmInstanceInformations_Update", + "tags": [ + "SsmInstanceInformations" + ], + "description": "Update a SsmInstanceInformation", + "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": "name", + "in": "path", + "description": "Name of SsmInstanceInformation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmInstanceInformationTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmInstanceInformation" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmInstanceInformations_Update": { + "$ref": "./examples/SsmInstanceInformations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SsmInstanceInformations_Delete", + "tags": [ + "SsmInstanceInformations" + ], + "description": "Delete a SsmInstanceInformation", + "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": "name", + "in": "path", + "description": "Name of SsmInstanceInformation", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SsmInstanceInformations_Delete": { + "$ref": "./examples/SsmInstanceInformations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSsmInstanceInformationProperties": { + "type": "object", + "description": "Definition of awsSsmInstanceInformation", + "properties": { + "activationId": { + "type": "string", + "description": "<p>The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.</p>" + }, + "agentVersion": { + "type": "string", + "description": "<p>The version of SSM Agent running on your Linux managed node. </p>" + }, + "associationOverview": { + "$ref": "#/definitions/InstanceAggregatedAssociationOverview", + "description": "<p>Information about the association.</p>" + }, + "associationStatus": { + "type": "string", + "description": "<p>The status of the association.</p>" + }, + "computerName": { + "type": "string", + "description": "<p>The fully qualified host name of the managed node.</p>" + }, + "ipAddress": { + "type": "string", + "description": "<p>The IP address of the managed node.</p>" + }, + "iamRole": { + "type": "string", + "description": "<p>The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'>DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'>describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>" + }, + "instanceId": { + "type": "string", + "description": "<p>The managed node ID. </p>" + }, + "isLatestVersion": { + "type": "boolean", + "description": "<p>Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.</p>" + }, + "lastAssociationExecutionDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date the association was last run.</p>" + }, + "lastPingDateTime": { + "type": "string", + "format": "date-time", + "description": "<p>The date and time when the agent last pinged the Systems Manager service. </p>" + }, + "lastSuccessfulAssociationExecutionDate": { + "type": "string", + "format": "date-time", + "description": "<p>The last date the association was successfully run.</p>" + }, + "name": { + "type": "string", + "description": "<p>The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the <code>DefaultInstanceName</code> property using the <a>CreateActivation</a> command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in <a href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html'>Install SSM Agent for a hybrid and multicloud environment (Linux)</a> and <a href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html'>Install SSM Agent for a hybrid and multicloud environment (Windows)</a>. To retrieve the <code>Name</code> tag of an EC2 instance, use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'>DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'>describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>" + }, + "pingStatus": { + "$ref": "#/definitions/PingStatusEnumValue", + "description": "<p>Connection status of SSM Agent. </p> <note> <p>The status <code>Inactive</code> has been deprecated and is no longer in use.</p> </note>" + }, + "platformName": { + "type": "string", + "description": "<p>The name of the operating system platform running on your managed node. </p>" + }, + "platformType": { + "$ref": "#/definitions/PlatformTypeEnumValue", + "description": "<p>The operating system platform type. </p>" + }, + "platformVersion": { + "type": "string", + "description": "<p>The version of the OS platform running on your managed node. </p>" + }, + "registrationDate": { + "type": "string", + "format": "date-time", + "description": "<p>The date the server or VM was registered with Amazon Web Services as a managed node.</p>" + }, + "resourceType": { + "$ref": "#/definitions/ResourceTypeEnumValue", + "description": "<p>The type of instance. Instances are either EC2 instances or managed instances. </p>" + }, + "sourceId": { + "type": "string", + "description": "<p>The ID of the source resource. For IoT Greengrass devices, <code>SourceId</code> is the Thing name. </p>" + }, + "sourceType": { + "$ref": "#/definitions/SourceTypeEnumValue", + "description": "<p>The type of the source resource. For IoT Greengrass devices, <code>SourceType</code> is <code>AWS::IoT::Thing</code>. </p>" + } + } + }, + "InstanceAggregatedAssociationOverview": { + "type": "object", + "description": "Definition of InstanceAggregatedAssociationOverview", + "properties": { + "detailedStatus": { + "type": "string", + "description": "<p>Detailed status information about the aggregated associations.</p>" + }, + "instanceAssociationStatusAggregatedCount": { + "type": "object", + "description": "<p>The number of associations for the managed nodes.</p>", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + } + }, + "PingStatus": { + "type": "string", + "description": "PingStatus enum", + "enum": [ + "ConnectionLost", + "Inactive", + "Online" + ], + "x-ms-enum": { + "name": "PingStatus", + "modelAsString": true, + "values": [ + { + "name": "ConnectionLost", + "value": "ConnectionLost", + "description": "PingStatus enum ConnectionLost" + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "PingStatus enum Inactive" + }, + { + "name": "Online", + "value": "Online", + "description": "PingStatus enum Online" + } + ] + } + }, + "PingStatusEnumValue": { + "type": "object", + "description": "Definition of PingStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PingStatus", + "description": "Property value" + } + } + }, + "PlatformType": { + "type": "string", + "description": "PlatformType enum", + "enum": [ + "Linux", + "MacOS", + "Windows" + ], + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true, + "values": [ + { + "name": "Linux", + "value": "Linux", + "description": "PlatformType enum Linux" + }, + { + "name": "MacOS", + "value": "MacOS", + "description": "PlatformType enum MacOS" + }, + { + "name": "Windows", + "value": "Windows", + "description": "PlatformType enum Windows" + } + ] + } + }, + "PlatformTypeEnumValue": { + "type": "object", + "description": "Definition of PlatformTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/PlatformType", + "description": "Property value" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "ResourceType": { + "type": "string", + "description": "ResourceType enum", + "enum": [ + "EC2Instance", + "ManagedInstance" + ], + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": true, + "values": [ + { + "name": "EC2Instance", + "value": "EC2Instance", + "description": "ResourceType enum EC2Instance" + }, + { + "name": "ManagedInstance", + "value": "ManagedInstance", + "description": "ResourceType enum ManagedInstance" + } + ] + } + }, + "ResourceTypeEnumValue": { + "type": "object", + "description": "Definition of ResourceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ResourceType", + "description": "Property value" + } + } + }, + "SourceType": { + "type": "string", + "description": "SourceType enum", + "enum": [ + "AWS::EC2::Instance", + "AWS::IoT::Thing", + "AWS::SSM::ManagedInstance" + ], + "x-ms-enum": { + "name": "SourceType", + "modelAsString": true, + "values": [ + { + "name": "AWSEC2Instance", + "value": "AWS::EC2::Instance", + "description": "SourceType enum AWS::EC2::Instance" + }, + { + "name": "AWSIoTThing", + "value": "AWS::IoT::Thing", + "description": "SourceType enum AWS::IoT::Thing" + }, + { + "name": "AWSSSMManagedInstance", + "value": "AWS::SSM::ManagedInstance", + "description": "SourceType enum AWS::SSM::ManagedInstance" + } + ] + } + }, + "SourceTypeEnumValue": { + "type": "object", + "description": "Definition of SourceTypeEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/SourceType", + "description": "Property value" + } + } + }, + "SsmInstanceInformation": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SsmInstanceInformationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SsmInstanceInformationListResult": { + "type": "object", + "description": "The response of a SsmInstanceInformation list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SsmInstanceInformation items on this page", + "items": { + "$ref": "#/definitions/SsmInstanceInformation" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SsmInstanceInformationProperties": { + "type": "object", + "description": "Definition of SsmInstanceInformation", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSsmInstanceInformationProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SsmInstanceInformationTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SsmInstanceInformation resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmParameter.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmParameter.json new file mode 100644 index 000000000000..b221382aa291 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmParameter.json @@ -0,0 +1,655 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SsmParameters" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ssmParameters": { + "get": { + "operationId": "SsmParameters_ListBySubscription", + "tags": [ + "SsmParameters" + ], + "description": "List SsmParameter resources 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/SsmParameterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmParameters_ListBySubscription": { + "$ref": "./examples/SsmParameters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmParameters": { + "get": { + "operationId": "SsmParameters_ListByResourceGroup", + "tags": [ + "SsmParameters" + ], + "description": "List SsmParameter resources 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/SsmParameterListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmParameters_ListByResourceGroup": { + "$ref": "./examples/SsmParameters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmParameters/{name}": { + "get": { + "operationId": "SsmParameters_Get", + "tags": [ + "SsmParameters" + ], + "description": "Get a SsmParameter", + "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": "name", + "in": "path", + "description": "Name of SsmParameter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmParameter" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmParameters_Get": { + "$ref": "./examples/SsmParameters_Get.json" + } + } + }, + "put": { + "operationId": "SsmParameters_CreateOrReplace", + "tags": [ + "SsmParameters" + ], + "description": "Create a SsmParameter. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SsmParameter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmParameter" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SsmParameter' update operation succeeded", + "schema": { + "$ref": "#/definitions/SsmParameter" + } + }, + "201": { + "description": "Resource 'SsmParameter' create operation succeeded", + "schema": { + "$ref": "#/definitions/SsmParameter" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SsmParameters_CreateOrReplace": { + "$ref": "./examples/SsmParameters_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SsmParameters_Update", + "tags": [ + "SsmParameters" + ], + "description": "Update a SsmParameter", + "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": "name", + "in": "path", + "description": "Name of SsmParameter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmParameterTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmParameter" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmParameters_Update": { + "$ref": "./examples/SsmParameters_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SsmParameters_Delete", + "tags": [ + "SsmParameters" + ], + "description": "Delete a SsmParameter", + "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": "name", + "in": "path", + "description": "Name of SsmParameter", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SsmParameters_Delete": { + "$ref": "./examples/SsmParameters_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSsmParameterProperties": { + "type": "object", + "description": "Definition of awsSsmParameter", + "properties": { + "allowedPattern": { + "type": "string", + "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``" + }, + "dataType": { + "$ref": "#/definitions/DataType", + "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``." + }, + "description": { + "type": "string", + "description": "Information about the parameter." + }, + "name": { + "type": "string", + "description": "The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``" + }, + "policies": { + "type": "string", + "description": "Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*." + }, + "tags": { + "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter." + }, + "tier": { + "$ref": "#/definitions/Tier", + "description": "The parameter tier." + }, + "type": { + "$ref": "#/definitions/Type", + "description": "The type of parameter." + }, + "value": { + "type": "string", + "description": "The parameter value. If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field." + } + } + }, + "DataType": { + "type": "string", + "description": "DataType enum", + "enum": [ + "aws:ec2:image", + "text" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": true, + "values": [ + { + "name": "AwsEc2Image", + "value": "aws:ec2:image", + "description": "DataType enum aws:ec2:image" + }, + { + "name": "text", + "value": "text", + "description": "DataType enum text" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SsmParameter": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SsmParameterProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SsmParameterListResult": { + "type": "object", + "description": "The response of a SsmParameter list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SsmParameter items on this page", + "items": { + "$ref": "#/definitions/SsmParameter" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SsmParameterProperties": { + "type": "object", + "description": "Definition of SsmParameter", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSsmParameterProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SsmParameterTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SsmParameter resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Tier": { + "type": "string", + "description": "Tier enum", + "enum": [ + "Advanced", + "Intelligent-Tiering", + "Standard" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": true, + "values": [ + { + "name": "Advanced", + "value": "Advanced", + "description": "Tier enum Advanced" + }, + { + "name": "IntelligentTiering", + "value": "Intelligent-Tiering", + "description": "Tier enum Intelligent-Tiering" + }, + { + "name": "Standard", + "value": "Standard", + "description": "Tier enum Standard" + } + ] + } + }, + "Type": { + "type": "string", + "description": "Type enum", + "enum": [ + "String", + "StringList" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": true, + "values": [ + { + "name": "String", + "value": "String", + "description": "Type enum String" + }, + { + "name": "StringList", + "value": "StringList", + "description": "Type enum StringList" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmResourceComplianceSummaryItem.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmResourceComplianceSummaryItem.json new file mode 100644 index 000000000000..4f4278125cf7 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/ssmResourceComplianceSummaryItem.json @@ -0,0 +1,751 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SsmResourceComplianceSummaryItems" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/ssmResourceComplianceSummaryItems": { + "get": { + "operationId": "SsmResourceComplianceSummaryItems_ListBySubscription", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "List SsmResourceComplianceSummaryItem resources 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/SsmResourceComplianceSummaryItemListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmResourceComplianceSummaryItems_ListBySubscription": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmResourceComplianceSummaryItems": { + "get": { + "operationId": "SsmResourceComplianceSummaryItems_ListByResourceGroup", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "List SsmResourceComplianceSummaryItem resources 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/SsmResourceComplianceSummaryItemListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmResourceComplianceSummaryItems_ListByResourceGroup": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/ssmResourceComplianceSummaryItems/{name}": { + "get": { + "operationId": "SsmResourceComplianceSummaryItems_Get", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "Get a SsmResourceComplianceSummaryItem", + "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": "name", + "in": "path", + "description": "Name of SsmResourceComplianceSummaryItem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmResourceComplianceSummaryItems_Get": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_Get.json" + } + } + }, + "put": { + "operationId": "SsmResourceComplianceSummaryItems_CreateOrReplace", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "Create a SsmResourceComplianceSummaryItem. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of SsmResourceComplianceSummaryItem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SsmResourceComplianceSummaryItem' update operation succeeded", + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + } + }, + "201": { + "description": "Resource 'SsmResourceComplianceSummaryItem' create operation succeeded", + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "SsmResourceComplianceSummaryItems_CreateOrReplace": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "SsmResourceComplianceSummaryItems_Update", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "Update a SsmResourceComplianceSummaryItem", + "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": "name", + "in": "path", + "description": "Name of SsmResourceComplianceSummaryItem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItemTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SsmResourceComplianceSummaryItems_Update": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SsmResourceComplianceSummaryItems_Delete", + "tags": [ + "SsmResourceComplianceSummaryItems" + ], + "description": "Delete a SsmResourceComplianceSummaryItem", + "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": "name", + "in": "path", + "description": "Name of SsmResourceComplianceSummaryItem", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "SsmResourceComplianceSummaryItems_Delete": { + "$ref": "./examples/SsmResourceComplianceSummaryItems_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsSsmResourceComplianceSummaryItemProperties": { + "type": "object", + "description": "Definition of awsSsmResourceComplianceSummaryItem", + "properties": { + "complianceType": { + "type": "string", + "description": "<p>The compliance type.</p>" + }, + "compliantSummary": { + "$ref": "#/definitions/CompliantSummary", + "description": "<p>A list of items that are compliant for the resource.</p>" + }, + "executionSummary": { + "$ref": "#/definitions/ComplianceExecutionSummary", + "description": "<p>Information about the execution.</p>" + }, + "nonCompliantSummary": { + "$ref": "#/definitions/NonCompliantSummary", + "description": "<p>A list of items that aren't compliant for the resource.</p>" + }, + "overallSeverity": { + "$ref": "#/definitions/ComplianceSeverityEnumValue", + "description": "<p>The highest severity item found for the resource. The resource is compliant for this item.</p>" + }, + "resourceId": { + "type": "string", + "description": "<p>The resource ID.</p>" + }, + "resourceType": { + "type": "string", + "description": "<p>The resource type.</p>" + }, + "status": { + "$ref": "#/definitions/ComplianceStatusEnumValue", + "description": "<p>The compliance status for the resource.</p>" + } + } + }, + "ComplianceExecutionSummary": { + "type": "object", + "description": "Definition of ComplianceExecutionSummary", + "properties": { + "executionId": { + "type": "string", + "description": "<p>An ID created by the system when <code>PutComplianceItems</code> was called. For example, <code>CommandID</code> is a valid execution ID. You can use this ID in subsequent calls.</p>" + }, + "executionTime": { + "type": "string", + "format": "date-time", + "description": "<p>The time the execution ran as a datetime object that is saved in the following format: <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code> </p>" + }, + "executionType": { + "type": "string", + "description": "<p>The type of execution. For example, <code>Command</code> is a valid execution type.</p>" + } + } + }, + "ComplianceSeverity": { + "type": "string", + "description": "ComplianceSeverity enum", + "enum": [ + "CRITICAL", + "HIGH", + "INFORMATIONAL", + "LOW", + "MEDIUM", + "UNSPECIFIED" + ], + "x-ms-enum": { + "name": "ComplianceSeverity", + "modelAsString": true, + "values": [ + { + "name": "CRITICAL", + "value": "CRITICAL", + "description": "ComplianceSeverity enum CRITICAL" + }, + { + "name": "HIGH", + "value": "HIGH", + "description": "ComplianceSeverity enum HIGH" + }, + { + "name": "INFORMATIONAL", + "value": "INFORMATIONAL", + "description": "ComplianceSeverity enum INFORMATIONAL" + }, + { + "name": "LOW", + "value": "LOW", + "description": "ComplianceSeverity enum LOW" + }, + { + "name": "MEDIUM", + "value": "MEDIUM", + "description": "ComplianceSeverity enum MEDIUM" + }, + { + "name": "UNSPECIFIED", + "value": "UNSPECIFIED", + "description": "ComplianceSeverity enum UNSPECIFIED" + } + ] + } + }, + "ComplianceSeverityEnumValue": { + "type": "object", + "description": "Definition of ComplianceSeverityEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ComplianceSeverity", + "description": "Property value" + } + } + }, + "ComplianceStatus": { + "type": "string", + "description": "ComplianceStatus enum", + "enum": [ + "COMPLIANT", + "NON_COMPLIANT" + ], + "x-ms-enum": { + "name": "ComplianceStatus", + "modelAsString": true, + "values": [ + { + "name": "COMPLIANT", + "value": "COMPLIANT", + "description": "ComplianceStatus enum COMPLIANT" + }, + { + "name": "NON_COMPLIANT", + "value": "NON_COMPLIANT", + "description": "ComplianceStatus enum NON_COMPLIANT" + } + ] + } + }, + "ComplianceStatusEnumValue": { + "type": "object", + "description": "Definition of ComplianceStatusEnumValue", + "properties": { + "value": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Property value" + } + } + }, + "CompliantSummary": { + "type": "object", + "description": "Definition of CompliantSummary", + "properties": { + "compliantCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources that are compliant.</p>" + }, + "severitySummary": { + "$ref": "#/definitions/SeveritySummary", + "description": "<p>A summary of the compliance severity by compliance type.</p>" + } + } + }, + "NonCompliantSummary": { + "type": "object", + "description": "Definition of NonCompliantSummary", + "properties": { + "nonCompliantCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of compliance items that aren't compliant.</p>" + }, + "severitySummary": { + "$ref": "#/definitions/SeveritySummary", + "description": "<p>A summary of the non-compliance severity by compliance type</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SeveritySummary": { + "type": "object", + "description": "Definition of SeveritySummary", + "properties": { + "criticalCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of <code>Critical</code>. Critical severity is determined by the organization that published the compliance items.</p>" + }, + "highCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.</p>" + }, + "informationalCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.</p>" + }, + "lowCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.</p>" + }, + "mediumCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.</p>" + }, + "unspecifiedCount": { + "type": "integer", + "format": "int32", + "description": "<p>The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.</p>" + } + } + }, + "SsmResourceComplianceSummaryItem": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItemProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "SsmResourceComplianceSummaryItemListResult": { + "type": "object", + "description": "The response of a SsmResourceComplianceSummaryItem list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SsmResourceComplianceSummaryItem items on this page", + "items": { + "$ref": "#/definitions/SsmResourceComplianceSummaryItem" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SsmResourceComplianceSummaryItemProperties": { + "type": "object", + "description": "Definition of SsmResourceComplianceSummaryItem", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsSsmResourceComplianceSummaryItemProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "SsmResourceComplianceSummaryItemTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in SsmResourceComplianceSummaryItem resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafWebACLSummary.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafWebACLSummary.json new file mode 100644 index 000000000000..ac71e9bc65c8 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafWebACLSummary.json @@ -0,0 +1,550 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "WafWebACLSummaries" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/wafWebACLSummaries": { + "get": { + "operationId": "WafWebAclSummaries_ListBySubscription", + "tags": [ + "WafWebACLSummaries" + ], + "description": "List WafWebACLSummary resources 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/WafWebACLSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WafWebAclSummaries_ListBySubscription": { + "$ref": "./examples/WafWebAclSummaries_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/wafWebACLSummaries": { + "get": { + "operationId": "WafWebAclSummaries_ListByResourceGroup", + "tags": [ + "WafWebACLSummaries" + ], + "description": "List WafWebACLSummary resources 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/WafWebACLSummaryListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WafWebAclSummaries_ListByResourceGroup": { + "$ref": "./examples/WafWebAclSummaries_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/wafWebACLSummaries/{name}": { + "get": { + "operationId": "WafWebAclSummaries_Get", + "tags": [ + "WafWebACLSummaries" + ], + "description": "Get a WafWebACLSummary", + "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": "name", + "in": "path", + "description": "Name of WafWebACLSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WafWebACLSummary" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WafWebAclSummaries_Get": { + "$ref": "./examples/WafWebAclSummaries_Get.json" + } + } + }, + "put": { + "operationId": "WafWebAclSummaries_CreateOrReplace", + "tags": [ + "WafWebACLSummaries" + ], + "description": "Create a WafWebACLSummary. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of WafWebACLSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/WafWebACLSummary" + } + } + ], + "responses": { + "200": { + "description": "Resource 'WafWebACLSummary' update operation succeeded", + "schema": { + "$ref": "#/definitions/WafWebACLSummary" + } + }, + "201": { + "description": "Resource 'WafWebACLSummary' create operation succeeded", + "schema": { + "$ref": "#/definitions/WafWebACLSummary" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "WafWebAclSummaries_CreateOrReplace": { + "$ref": "./examples/WafWebAclSummaries_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "WafWebAclSummaries_Update", + "tags": [ + "WafWebACLSummaries" + ], + "description": "Update a WafWebACLSummary", + "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": "name", + "in": "path", + "description": "Name of WafWebACLSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/WafWebACLSummaryTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/WafWebACLSummary" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "WafWebAclSummaries_Update": { + "$ref": "./examples/WafWebAclSummaries_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "WafWebAclSummaries_Delete", + "tags": [ + "WafWebACLSummaries" + ], + "description": "Delete a WafWebACLSummary", + "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": "name", + "in": "path", + "description": "Name of WafWebACLSummary", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "WafWebAclSummaries_Delete": { + "$ref": "./examples/WafWebAclSummaries_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AwsWafWebACLSummaryProperties": { + "type": "object", + "description": "Definition of awsWafWebACLSummary", + "properties": { + "name": { + "type": "string", + "description": "<p>A friendly name or description of the <a>WebACL</a>. You can't change the name of a <code>WebACL</code> after you create it.</p>" + }, + "webACLId": { + "type": "string", + "description": "<p>A unique identifier for a <code>WebACL</code>. You use <code>WebACLId</code> to get information about a <code>WebACL</code> (see <a>GetWebACL</a>), update a <code>WebACL</code> (see <a>UpdateWebACL</a>), and delete a <code>WebACL</code> from AWS WAF (see <a>DeleteWebACL</a>).</p> <p> <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</p>" + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "WafWebACLSummary": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/WafWebACLSummaryProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "WafWebACLSummaryListResult": { + "type": "object", + "description": "The response of a WafWebACLSummary list operation.", + "properties": { + "value": { + "type": "array", + "description": "The WafWebACLSummary items on this page", + "items": { + "$ref": "#/definitions/WafWebACLSummary" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "WafWebACLSummaryProperties": { + "type": "object", + "description": "Definition of WafWebACLSummary", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsWafWebACLSummaryProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "WafWebACLSummaryTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in WafWebACLSummary resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafv2LoggingConfiguration.json b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafv2LoggingConfiguration.json new file mode 100644 index 000000000000..697a95d33a64 --- /dev/null +++ b/specification/awsconnector/resource-manager/Microsoft.AwsConnector/stable/2024-12-01/wafv2LoggingConfiguration.json @@ -0,0 +1,793 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AwsConnector", + "version": "2024-12-01", + "description": "Microsoft.AwsConnector Resource Provider management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Wafv2LoggingConfigurations" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/wafv2LoggingConfigurations": { + "get": { + "operationId": "Wafv2LoggingConfigurations_ListBySubscription", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "List Wafv2LoggingConfiguration resources 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/Wafv2LoggingConfigurationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Wafv2LoggingConfigurations_ListBySubscription": { + "$ref": "./examples/Wafv2LoggingConfigurations_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/wafv2LoggingConfigurations": { + "get": { + "operationId": "Wafv2LoggingConfigurations_ListByResourceGroup", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "List Wafv2LoggingConfiguration resources 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/Wafv2LoggingConfigurationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Wafv2LoggingConfigurations_ListByResourceGroup": { + "$ref": "./examples/Wafv2LoggingConfigurations_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/wafv2LoggingConfigurations/{name}": { + "get": { + "operationId": "Wafv2LoggingConfigurations_Get", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "Get a Wafv2LoggingConfiguration", + "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": "name", + "in": "path", + "description": "Name of Wafv2LoggingConfiguration", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Wafv2LoggingConfigurations_Get": { + "$ref": "./examples/Wafv2LoggingConfigurations_Get.json" + } + } + }, + "put": { + "operationId": "Wafv2LoggingConfigurations_CreateOrReplace", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "Create a Wafv2LoggingConfiguration. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", + "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": "name", + "in": "path", + "description": "Name of Wafv2LoggingConfiguration", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Wafv2LoggingConfiguration' update operation succeeded", + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + } + }, + "201": { + "description": "Resource 'Wafv2LoggingConfiguration' create operation succeeded", + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "Wafv2LoggingConfigurations_CreateOrReplace": { + "$ref": "./examples/Wafv2LoggingConfigurations_CreateOrReplace.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Wafv2LoggingConfigurations_Update", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "Update a Wafv2LoggingConfiguration", + "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": "name", + "in": "path", + "description": "Name of Wafv2LoggingConfiguration", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfigurationTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Wafv2LoggingConfigurations_Update": { + "$ref": "./examples/Wafv2LoggingConfigurations_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Wafv2LoggingConfigurations_Delete", + "tags": [ + "Wafv2LoggingConfigurations" + ], + "description": "Delete a Wafv2LoggingConfiguration", + "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": "name", + "in": "path", + "description": "Name of Wafv2LoggingConfiguration", + "required": true, + "type": "string", + "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" + } + ], + "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": { + "Wafv2LoggingConfigurations_Delete": { + "$ref": "./examples/Wafv2LoggingConfigurations_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Action": { + "type": "string", + "description": "Action enum", + "enum": [ + "ALLOW", + "BLOCK", + "CAPTCHA", + "CHALLENGE", + "COUNT", + "EXCLUDED_AS_COUNT" + ], + "x-ms-enum": { + "name": "Action", + "modelAsString": true, + "values": [ + { + "name": "ALLOW", + "value": "ALLOW", + "description": "Action enum ALLOW" + }, + { + "name": "BLOCK", + "value": "BLOCK", + "description": "Action enum BLOCK" + }, + { + "name": "CAPTCHA", + "value": "CAPTCHA", + "description": "Action enum CAPTCHA" + }, + { + "name": "CHALLENGE", + "value": "CHALLENGE", + "description": "Action enum CHALLENGE" + }, + { + "name": "COUNT", + "value": "COUNT", + "description": "Action enum COUNT" + }, + { + "name": "EXCLUDED_AS_COUNT", + "value": "EXCLUDED_AS_COUNT", + "description": "Action enum EXCLUDED_AS_COUNT" + } + ] + } + }, + "ActionConditionModelProperties": { + "type": "object", + "description": "Definition of ActionConditionModelProperties", + "properties": { + "action": { + "$ref": "#/definitions/Action", + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." + } + } + }, + "AwsWafv2LoggingConfigurationProperties": { + "type": "object", + "description": "Definition of awsWafv2LoggingConfiguration", + "properties": { + "logDestinationConfigs": { + "type": "array", + "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "loggingFilter": { + "$ref": "#/definitions/LoggingFilterModelProperties", + "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation." + }, + "managedByFirewallManager": { + "type": "boolean", + "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration." + }, + "redactedFields": { + "type": "array", + "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.", + "items": { + "$ref": "#/definitions/FieldToMatch" + }, + "x-ms-identifiers": [] + }, + "resourceArn": { + "type": "string", + "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs." + } + } + }, + "Condition": { + "type": "object", + "description": "Definition of Condition", + "properties": { + "actionCondition": { + "$ref": "#/definitions/ActionConditionModelProperties", + "description": "A single action condition." + }, + "labelNameCondition": { + "$ref": "#/definitions/LabelNameConditionModelProperties", + "description": "A single label name condition." + } + } + }, + "DefaultBehavior": { + "type": "string", + "description": "DefaultBehavior enum", + "enum": [ + "DROP", + "KEEP" + ], + "x-ms-enum": { + "name": "DefaultBehavior", + "modelAsString": true, + "values": [ + { + "name": "DROP", + "value": "DROP", + "description": "DefaultBehavior enum DROP" + }, + { + "name": "KEEP", + "value": "KEEP", + "description": "DefaultBehavior enum KEEP" + } + ] + } + }, + "FieldToMatch": { + "type": "object", + "description": "Definition of FieldToMatch", + "properties": { + "method": { + "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform." + }, + "queryString": { + "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any." + }, + "singleHeader": { + "$ref": "#/definitions/SingleHeaderModelProperties", + "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive." + }, + "uriPath": { + "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg." + } + } + }, + "Filter": { + "type": "object", + "description": "Definition of Filter", + "properties": { + "behavior": { + "$ref": "#/definitions/FilterBehavior", + "description": "How to handle logs that satisfy the filter's conditions and requirement." + }, + "conditions": { + "type": "array", + "description": "Match conditions for the filter.", + "items": { + "$ref": "#/definitions/Condition" + }, + "x-ms-identifiers": [] + }, + "requirement": { + "$ref": "#/definitions/FilterRequirement", + "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." + } + } + }, + "FilterBehavior": { + "type": "string", + "description": "FilterBehavior enum", + "enum": [ + "DROP", + "KEEP" + ], + "x-ms-enum": { + "name": "FilterBehavior", + "modelAsString": true, + "values": [ + { + "name": "DROP", + "value": "DROP", + "description": "FilterBehavior enum DROP" + }, + { + "name": "KEEP", + "value": "KEEP", + "description": "FilterBehavior enum KEEP" + } + ] + } + }, + "FilterRequirement": { + "type": "string", + "description": "FilterRequirement enum", + "enum": [ + "MEETS_ALL", + "MEETS_ANY" + ], + "x-ms-enum": { + "name": "FilterRequirement", + "modelAsString": true, + "values": [ + { + "name": "MEETS_ALL", + "value": "MEETS_ALL", + "description": "FilterRequirement enum MEETS_ALL" + }, + { + "name": "MEETS_ANY", + "value": "MEETS_ANY", + "description": "FilterRequirement enum MEETS_ANY" + } + ] + } + }, + "LabelNameConditionModelProperties": { + "type": "object", + "description": "Definition of LabelNameConditionModelProperties", + "properties": { + "labelName": { + "type": "string", + "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label." + } + } + }, + "LoggingFilterModelProperties": { + "type": "object", + "description": "Definition of LoggingFilterModelProperties", + "properties": { + "defaultBehavior": { + "$ref": "#/definitions/DefaultBehavior", + "description": "Default handling for logs that don't match any of the specified filtering conditions." + }, + "filters": { + "type": "array", + "description": "The filters that you want to apply to the logs.", + "items": { + "$ref": "#/definitions/Filter" + }, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a 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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "SingleHeaderModelProperties": { + "type": "object", + "description": "Definition of SingleHeaderModelProperties", + "properties": { + "name": { + "type": "string", + "description": "The name of the query header to inspect." + } + } + }, + "Wafv2LoggingConfiguration": { + "type": "object", + "description": "A Microsoft.AwsConnector resource", + "properties": { + "properties": { + "$ref": "#/definitions/Wafv2LoggingConfigurationProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "Wafv2LoggingConfigurationListResult": { + "type": "object", + "description": "The response of a Wafv2LoggingConfiguration list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Wafv2LoggingConfiguration items on this page", + "items": { + "$ref": "#/definitions/Wafv2LoggingConfiguration" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Wafv2LoggingConfigurationProperties": { + "type": "object", + "description": "Definition of Wafv2LoggingConfiguration", + "properties": { + "awsProperties": { + "$ref": "#/definitions/AwsWafv2LoggingConfigurationProperties", + "description": "AWS Properties" + }, + "publicCloudConnectorsResourceId": { + "type": "string", + "description": "Public Cloud Connectors Resource ID" + }, + "awsAccountId": { + "type": "string", + "description": "AWS Account ID" + }, + "arn": { + "type": "string", + "description": "Amazon Resource Name (ARN)" + }, + "publicCloudResourceName": { + "type": "string", + "description": "Public Cloud Resource Name" + }, + "awsSourceSchema": { + "type": "string", + "description": "AWS Source Schema" + }, + "awsRegion": { + "type": "string", + "description": "AWS Region" + }, + "awsTags": { + "type": "object", + "description": "AWS Tags", + "additionalProperties": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Wafv2LoggingConfigurationTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in Wafv2LoggingConfiguration resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": {} +} diff --git a/specification/awsconnector/resource-manager/readme.md b/specification/awsconnector/resource-manager/readme.md new file mode 100644 index 000000000000..02d4519a8807 --- /dev/null +++ b/specification/awsconnector/resource-manager/readme.md @@ -0,0 +1,218 @@ +# awsconnector + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for awsconnector. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the awsconnector. + +```yaml +openapi-type: arm +openapi-subtype: rpaas +tag: package-2024-12-01 +``` + +### Tag: package-2024-12-01 + +These settings apply only when `--tag=package-2024-12-01` is specified on the command line. + +``` yaml $(tag) == 'package-2024-12-01' +input-file: + - Microsoft.AwsConnector/stable/2024-12-01/accessAnalyzerAnalyzer.json + - Microsoft.AwsConnector/stable/2024-12-01/acmCertificateSummary.json + - Microsoft.AwsConnector/stable/2024-12-01/apiGatewayRestApi.json + - Microsoft.AwsConnector/stable/2024-12-01/apiGatewayStage.json + - Microsoft.AwsConnector/stable/2024-12-01/appSyncGraphqlApi.json + - Microsoft.AwsConnector/stable/2024-12-01/autoScalingAutoScalingGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStack.json + - Microsoft.AwsConnector/stable/2024-12-01/cloudFormationStackSet.json + - Microsoft.AwsConnector/stable/2024-12-01/cloudFrontDistribution.json + - Microsoft.AwsConnector/stable/2024-12-01/cloudTrailTrail.json + - Microsoft.AwsConnector/stable/2024-12-01/cloudWatchAlarm.json + - Microsoft.AwsConnector/stable/2024-12-01/codeBuildProject.json + - Microsoft.AwsConnector/stable/2024-12-01/codeBuildSourceCredentialsInfo.json + - Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorder.json + - Microsoft.AwsConnector/stable/2024-12-01/configServiceConfigurationRecorderStatus.json + - Microsoft.AwsConnector/stable/2024-12-01/configServiceDeliveryChannel.json + - Microsoft.AwsConnector/stable/2024-12-01/databaseMigrationServiceReplicationInstance.json + - Microsoft.AwsConnector/stable/2024-12-01/daxCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/dynamoDBContinuousBackupsDescription.json + - Microsoft.AwsConnector/stable/2024-12-01/dynamoDBTable.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2AccountAttribute.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Address.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2FlowLog.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Image.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Instance.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2InstanceStatus.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Ipam.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2KeyPair.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkAcl.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2NetworkInterface.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2RouteTable.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2SecurityGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Snapshot.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Subnet.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Volume.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2Vpc.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2VPCEndpoint.json + - Microsoft.AwsConnector/stable/2024-12-01/ec2VPCPeeringConnection.json + - Microsoft.AwsConnector/stable/2024-12-01/ecrImageDetail.json + - Microsoft.AwsConnector/stable/2024-12-01/ecrRepository.json + - Microsoft.AwsConnector/stable/2024-12-01/ecsCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/ecsService.json + - Microsoft.AwsConnector/stable/2024-12-01/ecsTaskDefinition.json + - Microsoft.AwsConnector/stable/2024-12-01/efsFileSystem.json + - Microsoft.AwsConnector/stable/2024-12-01/efsMountTarget.json + - Microsoft.AwsConnector/stable/2024-12-01/eksCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/eksNodegroup.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkApplication.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkConfigurationTemplate.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticBeanstalkEnvironment.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2Listener.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2LoadBalancer.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/elasticLoadBalancingV2TargetHealthDescription.json + - Microsoft.AwsConnector/stable/2024-12-01/emrCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/emrClusterSummary.json + - Microsoft.AwsConnector/stable/2024-12-01/guardDutyDetector.json + - Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyLastUsed.json + - Microsoft.AwsConnector/stable/2024-12-01/iamAccessKeyMetadata.json + - Microsoft.AwsConnector/stable/2024-12-01/iamGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/iamInstanceProfile.json + - Microsoft.AwsConnector/stable/2024-12-01/iamMFADevice.json + - Microsoft.AwsConnector/stable/2024-12-01/iamPasswordPolicy.json + - Microsoft.AwsConnector/stable/2024-12-01/iamPolicyVersion.json + - Microsoft.AwsConnector/stable/2024-12-01/iamRole.json + - Microsoft.AwsConnector/stable/2024-12-01/iamServerCertificate.json + - Microsoft.AwsConnector/stable/2024-12-01/iamVirtualMFADevice.json + - Microsoft.AwsConnector/stable/2024-12-01/kmsAlias.json + - Microsoft.AwsConnector/stable/2024-12-01/kmsKey.json + - Microsoft.AwsConnector/stable/2024-12-01/lambdaFunction.json + - Microsoft.AwsConnector/stable/2024-12-01/lambdaFunctionCodeLocation.json + - Microsoft.AwsConnector/stable/2024-12-01/lightsailBucket.json + - Microsoft.AwsConnector/stable/2024-12-01/lightsailInstance.json + - Microsoft.AwsConnector/stable/2024-12-01/logsLogGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/logsLogStream.json + - Microsoft.AwsConnector/stable/2024-12-01/logsMetricFilter.json + - Microsoft.AwsConnector/stable/2024-12-01/logsSubscriptionFilter.json + - Microsoft.AwsConnector/stable/2024-12-01/macie2JobSummary.json + - Microsoft.AwsConnector/stable/2024-12-01/macieAllowList.json + - Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewall.json + - Microsoft.AwsConnector/stable/2024-12-01/networkFirewallFirewallPolicy.json + - Microsoft.AwsConnector/stable/2024-12-01/networkFirewallRuleGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/openSearchDomainStatus.json + - Microsoft.AwsConnector/stable/2024-12-01/operations.json + - Microsoft.AwsConnector/stable/2024-12-01/organizationsAccount.json + - Microsoft.AwsConnector/stable/2024-12-01/organizationsOrganization.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsDBCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsDBInstance.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshot.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsDBSnapshotAttributesResult.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsEventSubscription.json + - Microsoft.AwsConnector/stable/2024-12-01/rdsExportTask.json + - Microsoft.AwsConnector/stable/2024-12-01/redshiftCluster.json + - Microsoft.AwsConnector/stable/2024-12-01/redshiftClusterParameterGroup.json + - Microsoft.AwsConnector/stable/2024-12-01/route53DomainsDomainSummary.json + - Microsoft.AwsConnector/stable/2024-12-01/route53HostedZone.json + - Microsoft.AwsConnector/stable/2024-12-01/route53ResourceRecordSet.json + - Microsoft.AwsConnector/stable/2024-12-01/s3AccessPoint.json + - Microsoft.AwsConnector/stable/2024-12-01/s3Bucket.json + - Microsoft.AwsConnector/stable/2024-12-01/s3BucketPolicy.json + - Microsoft.AwsConnector/stable/2024-12-01/s3ControlMultiRegionAccessPointPolicyDocument.json + - Microsoft.AwsConnector/stable/2024-12-01/sageMakerApp.json + - Microsoft.AwsConnector/stable/2024-12-01/sageMakerNotebookInstanceSummary.json + - Microsoft.AwsConnector/stable/2024-12-01/secretsManagerResourcePolicy.json + - Microsoft.AwsConnector/stable/2024-12-01/secretsManagerSecret.json + - Microsoft.AwsConnector/stable/2024-12-01/snsSubscription.json + - Microsoft.AwsConnector/stable/2024-12-01/snsTopic.json + - Microsoft.AwsConnector/stable/2024-12-01/sqsQueue.json + - Microsoft.AwsConnector/stable/2024-12-01/ssmInstanceInformation.json + - Microsoft.AwsConnector/stable/2024-12-01/ssmParameter.json + - Microsoft.AwsConnector/stable/2024-12-01/ssmResourceComplianceSummaryItem.json + - Microsoft.AwsConnector/stable/2024-12-01/wafv2LoggingConfiguration.json + - Microsoft.AwsConnector/stable/2024-12-01/wafWebACLSummary.json +``` + +## Suppression + +``` yaml +directive: + - suppress: EnumInsteadOfBoolean + reason: booleans are only used in aws + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Property is CamelCase in aws + - suppress: AvoidAdditionalProperties + reason: 1. Property represents user defined awsTags. 2. All swagger has awsTags.So, we cannot add from clause. + - suppress: PatchPropertiesCorrespondToPutProperties + reason: 1. Issue in LintDiff tool. 2. In patch we allow tags update only and in our TypeSpec we use ArmCustomPatchAsync{Azure.ResourceManager.Foundations.TagsUpdateModel<Resource>}. So, tags property in patch body and the same is not present in the corresponding put body and causing the issue. In case of the put we are using TrackedResource type and same has tags. 3. All typespec has TagsUpdateModel.So, we cannot add from clause. + - suppress: EvenSegmentedPathForPutOperation + reason: 1. Issue in LintDiff tool. 2. In TypeSpec we use @singleton (OpenAPI path ends with /default), we believe this is a false positive. Related issue:https://github.com/Azure/azure-openapi-validator/issues/646 + from: + - ec2Instance.json + - eksCluster.json + - suppress: XmsPageableForListCalls + reason: 1. Issue in LintDiff tool. 2. In TypeSpec we use @singleton (OpenAPI path ends with /default), we believe this is a false positive. Related issue:https://github.com/Azure/azure-openapi-validator/issues/646 + from: + - ec2Instance.json + - eksCluster.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) + +## Java + +See configuration in [readme.java.md](./readme.java.md) \ No newline at end of file diff --git a/specification/awsconnector/shared/main.tsp b/specification/awsconnector/shared/main.tsp new file mode 100644 index 000000000000..e9a895637c67 --- /dev/null +++ b/specification/awsconnector/shared/main.tsp @@ -0,0 +1,52 @@ +using Azure.Core; +using Azure.ClientGenerator.Core; +using Azure.ResourceManager; + +namespace Microsoft.AwsConnector; +#suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" +alias AwsCommonProperties = { + @doc("Public Cloud Connectors Resource ID") + publicCloudConnectorsResourceId?: string; + + @doc("AWS Account ID") + awsAccountId?: string; + + @doc("Amazon Resource Name (ARN)") + arn?: string; + + @doc("Public Cloud Resource Name") + publicCloudResourceName?: string; + + @doc("AWS Source Schema") + awsSourceSchema?: string; + + @doc("AWS Region") + awsRegion?: string; + + @doc("AWS Tags") + awsTags?: Record<string>; + + @visibility("read") + @doc("The status of the last operation.") + provisioningState?: ProvisioningState; +}; + +@doc("The provisioning state of a resource.") +@lroStatus +union ProvisioningState { + ResourceProvisioningState, + + @doc("The resource is being provisioned") + Provisioning: "Provisioning", + + @doc("The resource is updating") + Updating: "Updating", + + @doc("The resource is being deleted") + Deleting: "Deleting", + + @doc("The resource create request has been accepted") + Accepted: "Accepted", + + string, +} From 627a78a43a98951c05d160aa49d3128dfa83f864 Mon Sep 17 00:00:00 2001 From: wiboris <54044985+wiboris@users.noreply.github.com> Date: Wed, 9 Oct 2024 12:07:19 -0700 Subject: [PATCH 077/101] mixed up enum names (#30920) --- specification/batch/Azure.Batch/models.tsp | 8 +- .../preview/2024-07-01.20.0/BatchService.json | 80 +++++++++---------- 2 files changed, 44 insertions(+), 44 deletions(-) diff --git a/specification/batch/Azure.Batch/models.tsp b/specification/batch/Azure.Batch/models.tsp index 9b92b504d225..3e576e19e988 100644 --- a/specification/batch/Azure.Batch/models.tsp +++ b/specification/batch/Azure.Batch/models.tsp @@ -172,8 +172,8 @@ union DiskEncryptionTarget { TemporaryDisk: "temporarydisk", } -@doc("BatchNodePlacementPolicyType enums") -union BatchNodePlacementPolicyType { +@doc("The paths which will be mounted to container task's container.") +union ContainerHostDataPath { string, @doc("The path for multi-instances task to shared their files.") @@ -195,8 +195,8 @@ union BatchNodePlacementPolicyType { Applications: "Applications", } -@doc("The paths which will be mounted to container task's container.") -union ContainerHostDataPath { +@doc("BatchNodePlacementPolicyType enums") +union BatchNodePlacementPolicyType { string, @doc("All nodes in the pool will be allocated in the same region.") diff --git a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json index ec041a5d4142..3ee4e3ba7888 100644 --- a/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json +++ b/specification/batch/data-plane/Azure.Batch/preview/2024-07-01.20.0/BatchService.json @@ -11788,46 +11788,22 @@ "type": "string", "description": "BatchNodePlacementPolicyType enums", "enum": [ - "Shared", - "Startup", - "VfsMounts", - "Task", - "JobPrep", - "Applications" + "regional", + "zonal" ], "x-ms-enum": { "name": "BatchNodePlacementPolicyType", "modelAsString": true, "values": [ { - "name": "Shared", - "value": "Shared", - "description": "The path for multi-instances task to shared their files." - }, - { - "name": "Startup", - "value": "Startup", - "description": "The path for start task." - }, - { - "name": "VfsMounts", - "value": "VfsMounts", - "description": "The path contains all virtual file systems are mounted on this node." - }, - { - "name": "Task", - "value": "Task", - "description": "The task path." - }, - { - "name": "JobPrep", - "value": "JobPrep", - "description": "The job-prep task path." + "name": "Regional", + "value": "regional", + "description": "All nodes in the pool will be allocated in the same region." }, { - "name": "Applications", - "value": "Applications", - "description": "The applications path." + "name": "Zonal", + "value": "zonal", + "description": "Nodes in the pool will be spread across different availability zones with best effort balancing." } ] } @@ -14645,22 +14621,46 @@ "type": "string", "description": "The paths which will be mounted to container task's container.", "enum": [ - "regional", - "zonal" + "Shared", + "Startup", + "VfsMounts", + "Task", + "JobPrep", + "Applications" ], "x-ms-enum": { "name": "ContainerHostDataPath", "modelAsString": true, "values": [ { - "name": "Regional", - "value": "regional", - "description": "All nodes in the pool will be allocated in the same region." + "name": "Shared", + "value": "Shared", + "description": "The path for multi-instances task to shared their files." }, { - "name": "Zonal", - "value": "zonal", - "description": "Nodes in the pool will be spread across different availability zones with best effort balancing." + "name": "Startup", + "value": "Startup", + "description": "The path for start task." + }, + { + "name": "VfsMounts", + "value": "VfsMounts", + "description": "The path contains all virtual file systems are mounted on this node." + }, + { + "name": "Task", + "value": "Task", + "description": "The task path." + }, + { + "name": "JobPrep", + "value": "JobPrep", + "description": "The job-prep task path." + }, + { + "name": "Applications", + "value": "Applications", + "description": "The applications path." } ] } From cde61328a54d392000b36882fec169fce5a983c1 Mon Sep 17 00:00:00 2001 From: ChrisRibe <chrisribe@users.noreply.github.com> Date: Wed, 9 Oct 2024 15:23:15 -0400 Subject: [PATCH 078/101] Microsoft.HealthDataAIServices stable api release 2024-09-20 (#30835) * Microsoft.HealthDataAIServices stable api release 2024-09-20 * Update readme.md Python SDK could be generated from Typespec directly and no need to generate from Swagger. * Update readme.md --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> --- .../DeidServices_Create_MaximumSet_Gen.json | 140 +++ .../DeidServices_Delete_MaximumSet_Gen.json | 18 + .../DeidServices_Get_MaximumSet_Gen.json | 69 ++ ...es_ListByResourceGroup_MaximumSet_Gen.json | 73 ++ ...ces_ListBySubscription_MaximumSet_Gen.json | 72 ++ .../DeidServices_Update_MaximumSet_Gen.json | 84 ++ .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...ointConnections_Create_MaximumSet_Gen.json | 84 ++ ...ointConnections_Delete_MaximumSet_Gen.json | 19 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...ions_ListByDeidService_MaximumSet_Gen.json | 46 + ...inks_ListByDeidService_MaximumSet_Gen.json | 41 + .../HealthDataAIServices.Management/main.tsp | 5 + .../DeidServices_Create_MaximumSet_Gen.json | 140 +++ .../DeidServices_Delete_MaximumSet_Gen.json | 18 + .../DeidServices_Get_MaximumSet_Gen.json | 69 ++ ...es_ListByResourceGroup_MaximumSet_Gen.json | 73 ++ ...ces_ListBySubscription_MaximumSet_Gen.json | 72 ++ .../DeidServices_Update_MaximumSet_Gen.json | 84 ++ .../Operations_List_MaximumSet_Gen.json | 28 + .../Operations_List_MinimumSet_Gen.json | 12 + ...ointConnections_Create_MaximumSet_Gen.json | 84 ++ ...ointConnections_Delete_MaximumSet_Gen.json | 19 + ...ndpointConnections_Get_MaximumSet_Gen.json | 42 + ...ions_ListByDeidService_MaximumSet_Gen.json | 46 + ...inks_ListByDeidService_MaximumSet_Gen.json | 41 + .../stable/2024-09-20/openapi.json | 997 ++++++++++++++++++ .../resource-manager/readme.md | 11 +- 29 files changed, 2468 insertions(+), 1 deletion(-) create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Create_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Delete_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Get_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Update_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MinimumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateLinks_ListByDeidService_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Create_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Delete_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Get_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Update_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MinimumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json create mode 100644 specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/openapi.json diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c73c21b3117 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Create_MaximumSet_Gen.json @@ -0,0 +1,140 @@ +{ + "title": "DeidServices_Create - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Create", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "resource": { + "properties": { + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6304fc4aefc --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "DeidServices_Delete - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Delete", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..3d7b18ff94ac --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "DeidServices_Get - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Get", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListByResourceGroup_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3fab43d7b8bb --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListBySubscription_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4bc5591ff5e --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "DeidServices_ListBySubscription - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_ListBySubscription", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Update_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..d113c9f7a518 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/DeidServices_Update_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "DeidServices_Update - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Update", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..ecb54be5b599 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule. [stable]", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vlozcqymdxttexvmhouwzob", + "isDataAction": true, + "display": { + "provider": "hwy", + "resource": "yxabgnzjshmqldqthxonpam", + "operation": "quwaawjasjgpqhskxoxzx", + "description": "ayqiodducsbwvzcgno" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MinimumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1121e851335e --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet - generated by [MinimumSet] rule. [stable]", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-20" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..4cf603d4758e --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..30c0ec3618d3 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f3e8305c401 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a7d8043136d --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_ListByDeidService", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "mmvcleuufspfrojjveuith" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateLinks_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateLinks_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd8c196e3ba7 --- /dev/null +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/examples/2024-09-20/PrivateLinks_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateLinks_ListByDeidService", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "flaloakbdcqjisfhfnkrxmt", + "requiredMembers": [ + "wbraaugftjqa" + ], + "requiredZoneNames": [ + "ndsmc" + ] + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateLinkResources/rmptbzejhgxhlfpdizsekhsq", + "name": "rmptbzejhgxhlfpdizsekhsq", + "type": "lplbvyjkvsujegzqr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/arzijt" + } + } + } +} diff --git a/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp b/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp index 914a52292a69..c7faddb17e9b 100644 --- a/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp +++ b/specification/healthdataaiservices/HealthDataAIServices.Management/main.tsp @@ -23,6 +23,11 @@ enum Versions { @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) @doc("The 2024-02-28-preview version.") v2024_02_28_preview: "2024-02-28-preview", + + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5) + @doc("The 2024-09-20 version.") + v2024_09_20: "2024-09-20", } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..9c73c21b3117 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Create_MaximumSet_Gen.json @@ -0,0 +1,140 @@ +{ + "title": "DeidServices_Create - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Create", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "resource": { + "properties": { + "publicNetworkAccess": "Enabled" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..d6304fc4aefc --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Delete_MaximumSet_Gen.json @@ -0,0 +1,18 @@ +{ + "title": "DeidServices_Delete - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Delete", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..3d7b18ff94ac --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Get_MaximumSet_Gen.json @@ -0,0 +1,69 @@ +{ + "title": "DeidServices_Get - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Get", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json new file mode 100644 index 000000000000..3fab43d7b8bb --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json @@ -0,0 +1,73 @@ +{ + "title": "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_ListByResourceGroup", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json new file mode 100644 index 000000000000..b4bc5591ff5e --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_ListBySubscription_MaximumSet_Gen.json @@ -0,0 +1,72 @@ +{ + "title": "DeidServices_ListBySubscription - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_ListBySubscription", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru", + "privateEndpointConnections": [ + { + "properties": { + "groupIds": [ + "xbdyjqg" + ], + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ro" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "publicNetworkAccess": "Enabled" + }, + "identity": { + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893", + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Update_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Update_MaximumSet_Gen.json new file mode 100644 index 000000000000..d113c9f7a518 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/DeidServices_Update_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "DeidServices_Update - generated by [MaximumSet] rule. [stable]", + "operationId": "DeidServices_Update", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "properties": { + "identity": { + "type": "None", + "userAssignedIdentities": {} + }, + "tags": {}, + "properties": { + "publicNetworkAccess": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "ddxuoved" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih/privateEndpointConnections/mdwvqjtwcjcvrh", + "name": "mdwvqjtwcjcvrh", + "type": "bzxabjlpbwreez", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "serviceUrl": "woponotsxaippkvhwmibffywnqcfru" + }, + "identity": { + "type": "None", + "userAssignedIdentities": {}, + "principalId": "a82361f4-5320-4a26-8d1b-45832d2164dd", + "tenantId": "53a6a686-ae15-4a1d-badf-3e7947918893" + }, + "tags": {}, + "location": "qwyhvdwcsjulggagdqxlmazcl", + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/nlrthrxaukih", + "name": "nlrthrxaukih", + "type": "slyfiibvwlhfdpzjynsywhbfauexk", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MaximumSet_Gen.json new file mode 100644 index 000000000000..ecb54be5b599 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MaximumSet_Gen.json @@ -0,0 +1,28 @@ +{ + "title": "Operations_List_MaximumSet - generated by [MaximumSet] rule. [stable]", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-20" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vlozcqymdxttexvmhouwzob", + "isDataAction": true, + "display": { + "provider": "hwy", + "resource": "yxabgnzjshmqldqthxonpam", + "operation": "quwaawjasjgpqhskxoxzx", + "description": "ayqiodducsbwvzcgno" + }, + "origin": "user", + "actionType": "Internal" + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MinimumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MinimumSet_Gen.json new file mode 100644 index 000000000000..1121e851335e --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/Operations_List_MinimumSet_Gen.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List_MinimumSet - generated by [MinimumSet] rule. [stable]", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-09-20" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json new file mode 100644 index 000000000000..4cf603d4758e --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json @@ -0,0 +1,84 @@ +{ + "title": "PrivateEndpointConnections_Create - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Create", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl", + "resource": { + "properties": { + "privateEndpoint": {}, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json new file mode 100644 index 000000000000..30c0ec3618d3 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json @@ -0,0 +1,19 @@ +{ + "title": "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json new file mode 100644 index 000000000000..2f3e8305c401 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json @@ -0,0 +1,42 @@ +{ + "title": "PrivateEndpointConnections_Get - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_Get", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest", + "privateEndpointConnectionName": "kgwgrrpabvrsrrvpcgcnfmyfgyrl" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "xr" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..0a7d8043136d --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,46 @@ +{ + "title": "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateEndpointConnections_ListByDeidService", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "gpnxxbbtsysdhhclm" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "actionsRequired": "ulb", + "description": "mmvcleuufspfrojjveuith" + }, + "groupIds": [ + "xbdyjqg" + ], + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateEndpointConnections/aduyb", + "name": "aduyb", + "type": "umjjkodjuhccrngl", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/a" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json new file mode 100644 index 000000000000..bd8c196e3ba7 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json @@ -0,0 +1,41 @@ +{ + "title": "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule. [stable]", + "operationId": "PrivateLinks_ListByDeidService", + "parameters": { + "api-version": "2024-09-20", + "subscriptionId": "F21BB31B-C214-42C0-ACF0-DACCA05D3011", + "resourceGroupName": "rgopenapi", + "deidServiceName": "deidTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "flaloakbdcqjisfhfnkrxmt", + "requiredMembers": [ + "wbraaugftjqa" + ], + "requiredZoneNames": [ + "ndsmc" + ] + }, + "id": "/subscriptions/F21BB31B-C214-42C0-ACF0-DACCA05D3011/resourceGroups/rgopenapi/providers/Microsoft.HealthDataAIServices/deidServices/deidTest/privateLinkResources/rmptbzejhgxhlfpdizsekhsq", + "name": "rmptbzejhgxhlfpdizsekhsq", + "type": "lplbvyjkvsujegzqr", + "systemData": { + "createdBy": "p", + "createdByType": "User", + "createdAt": "2024-04-13T19:47:24.985Z", + "lastModifiedBy": "pmbozfvwrblbknedeb", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-04-13T19:47:24.986Z" + } + } + ], + "nextLink": "https://microsoft.com/arzijt" + } + } + } +} diff --git a/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/openapi.json b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/openapi.json new file mode 100644 index 000000000000..bca4d8e6fdd6 --- /dev/null +++ b/specification/healthdataaiservices/resource-manager/Microsoft.HealthDataAIServices/stable/2024-09-20/openapi.json @@ -0,0 +1,997 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.HealthDataAIServices", + "version": "2024-09-20", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "DeidServices" + }, + { + "name": "PrivateEndpointConnections" + }, + { + "name": "PrivateLinks" + } + ], + "paths": { + "/providers/Microsoft.HealthDataAIServices/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List_MaximumSet - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/Operations_List_MaximumSet_Gen.json" + }, + "Operations_List_MinimumSet - generated by [MinimumSet] rule. [stable]": { + "$ref": "./examples/Operations_List_MinimumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HealthDataAIServices/deidServices": { + "get": { + "operationId": "DeidServices_ListBySubscription", + "tags": [ + "DeidServices" + ], + "description": "List DeidService resources 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/DeidServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_ListBySubscription - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_ListBySubscription_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices": { + "get": { + "operationId": "DeidServices_ListByResourceGroup", + "tags": [ + "DeidServices" + ], + "description": "List DeidService resources 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/DeidServiceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_ListByResourceGroup - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_ListByResourceGroup_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}": { + "get": { + "operationId": "DeidServices_Get", + "tags": [ + "DeidServices" + ], + "description": "Get a DeidService", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_Get - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "DeidServices_Create", + "tags": [ + "DeidServices" + ], + "description": "Create a DeidService", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeidService" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeidService' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "201": { + "description": "Resource 'DeidService' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeidService" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "DeidServices_Create - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DeidServices_Update", + "tags": [ + "DeidServices" + ], + "description": "Update a DeidService", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeidUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeidService" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeidServices_Update - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_Update_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeidServices_Delete", + "tags": [ + "DeidServices" + ], + "description": "Delete a DeidService", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "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": { + "DeidServices_Delete - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/DeidServices_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections": { + "get": { + "operationId": "PrivateEndpointConnections_ListByDeidService", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "List private endpoint connections on the given resource", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByDeidService - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/PrivateEndpointConnections_ListByDeidService_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "operationId": "PrivateEndpointConnections_Get", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Get a specific private connection", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/PrivateEndpointConnections_Get_MaximumSet_Gen.json" + } + } + }, + "put": { + "operationId": "PrivateEndpointConnections_Create", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Create a Private endpoint connection", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "Resource 'PrivateEndpointConnectionResource' update operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Resource 'PrivateEndpointConnectionResource' create operation succeeded", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "PrivateEndpointConnections_Create - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/PrivateEndpointConnections_Create_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "PrivateEndpointConnections_Delete", + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Delete the private endpoint connection", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "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": { + "PrivateEndpointConnections_Delete - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/PrivateEndpointConnections_Delete_MaximumSet_Gen.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthDataAIServices/deidServices/{deidServiceName}/privateLinkResources": { + "get": { + "operationId": "PrivateLinks_ListByDeidService", + "tags": [ + "PrivateLinks" + ], + "description": "List private links on the given resource", + "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": "deidServiceName", + "in": "path", + "description": "The name of the deid service", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PrivateLinks_ListByDeidService - generated by [MaximumSet] rule. [stable]": { + "$ref": "./examples/PrivateLinks_ListByDeidService_MaximumSet_Gen.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DeidPropertiesUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Gets or sets allow or disallow public network access to resource" + } + } + }, + "DeidService": { + "type": "object", + "description": "A HealthDataAIServicesProviderHub resource", + "properties": { + "properties": { + "$ref": "#/definitions/DeidServiceProperties", + "description": "The resource-specific properties for this resource." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "DeidServiceListResult": { + "type": "object", + "description": "The response of a DeidService list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeidService items on this page", + "items": { + "$ref": "#/definitions/DeidService" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeidServiceProperties": { + "type": "object", + "description": "Details of the HealthDataAIServices DeidService.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + }, + "serviceUrl": { + "type": "string", + "description": "Deid service url.", + "readOnly": true + }, + "privateEndpointConnections": { + "type": "array", + "description": "List of private endpoint connections.", + "items": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "publicNetworkAccess": { + "$ref": "#/definitions/PublicNetworkAccess", + "description": "Gets or sets allow or disallow public network access to resource" + } + } + }, + "DeidUpdate": { + "type": "object", + "description": "Patch request body for DeidService", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentityUpdate", + "description": "Updatable managed service identity" + }, + "properties": { + "$ref": "#/definitions/DeidPropertiesUpdate", + "description": "RP-specific properties" + } + } + }, + "ManagedServiceIdentityUpdate": { + "type": "object", + "description": "The template for adding optional properties.", + "properties": { + "type": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentityType", + "description": "The type of managed identity assigned to this resource." + }, + "userAssignedIdentities": { + "type": "object", + "description": "The identities assigned to this resource by the user.", + "additionalProperties": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/UserAssignedIdentity" + } + ], + "type": "object", + "x-nullable": true + } + } + } + }, + "PrivateEndpointConnectionResource": { + "type": "object", + "description": "Holder for private endpoint connections", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionResourceListResult": { + "type": "object", + "description": "The response of a PrivateEndpointConnectionResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateEndpointConnectionResource items on this page", + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PrivateLinkResource": { + "type": "object", + "description": "Private Links for DeidService resource", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "The resource-specific properties for this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "The response of a PrivateLinkResource list operation.", + "properties": { + "value": { + "type": "array", + "description": "The PrivateLinkResource items on this page", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "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": "The resource is being provisioned." + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is being updated." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource provisioning request has been accepted." + } + ] + }, + "readOnly": true + }, + "PublicNetworkAccess": { + "type": "string", + "description": "State of the public network access.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": false, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "The public network access is enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The public network access is disabled" + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/healthdataaiservices/resource-manager/readme.md b/specification/healthdataaiservices/resource-manager/readme.md index 5409d8061415..1e57a362f63d 100644 --- a/specification/healthdataaiservices/resource-manager/readme.md +++ b/specification/healthdataaiservices/resource-manager/readme.md @@ -27,7 +27,16 @@ These are the global settings for the healthdataaiservices. ```yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-02-28-preview +tag: package-2024-09-20 +``` + +### Tag: package-2024-09-20 + +These settings apply only when `--tag=package-2024-09-20` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-20' +input-file: + - Microsoft.HealthDataAIServices/stable/2024-09-20/openapi.json ``` ### Tag: package-2024-02-28-preview From c3f246bece34c122def67e59945e634490f205fe Mon Sep 17 00:00:00 2001 From: Krista Pratico <krpratic@microsoft.com> Date: Wed, 9 Oct 2024 14:33:13 -0700 Subject: [PATCH 079/101] document translation client.tsp updates for python (#30416) * rename Glossary to TranslationGlossary * TranslationGlossary.format --> file_format * more renames * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * fix * review feedback * Overriding id name to translation_id * Update specification/translation/Azure.AI.DocumentTranslation/client.tsp Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com> * Disabling test and sample generation --------- Co-authored-by: Hamshavathi Munibyraiah <v-hamunibyra@microsoft.com> Co-authored-by: hamshavathimunibyraiah <125092972+hamshavathimunibyraiah@users.noreply.github.com> Co-authored-by: catalinaperalta <catalinaperaltah@hotmail.com> --- .../Azure.AI.DocumentTranslation/client.tsp | 148 ++++++++++++++---- .../Azure.AI.DocumentTranslation/routes.tsp | 6 + .../tspconfig.yaml | 4 +- 3 files changed, 123 insertions(+), 35 deletions(-) diff --git a/specification/translation/Azure.AI.DocumentTranslation/client.tsp b/specification/translation/Azure.AI.DocumentTranslation/client.tsp index 121ca660a59a..0d885465eacc 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/client.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/client.tsp @@ -41,49 +41,131 @@ interface SingleDocumentTranslationClient { documentTranslate is DocumentTranslation.DocumentTranslationOperations.documentTranslate; } -// model overrides -@@access(DocumentTranslation.DocumentTranslateResult, +@@clientName(DocumentTranslation.DocumentTranslateBody.body, + "documentTranslateContent", + "csharp" +); + +@@clientName(DocumentTranslation.DocumentTranslateBody.body, + "documentTranslateContent", + "java" +); + +@@clientName(DocumentTranslation.StartTranslationBody.body, + "startTranslationDetails", + "csharp" +); + +@@clientName(DocumentTranslation.StartTranslationBody.body, + "startTranslationDetails", + "java" +); + +@@access(DocumentTranslationClient.getSupportedFormats, Access.internal, "python" ); -@@access(DocumentTranslation.FileFormatType, Access.internal, "python"); -@@access(DocumentTranslation.StorageSource, Access.internal, "python"); -@@access(DocumentTranslation.AdditionalOutputFileFormat, - Access.internal, +@@access(DocumentTranslation.FileFormat, Access.public, "python"); +@@usage(DocumentTranslation.FileFormat, Usage.output, "python"); +@@access(DocumentTranslation.FileFormatType, Access.public, "python"); +@@usage(DocumentTranslation.FileFormatType, Usage.output, "python"); + +@@clientName(DocumentTranslationClient.startTranslation, + "_begin_translation", "python" ); -@@access(DocumentTranslation.StorageInputType, Access.internal, "python"); -@@access(DocumentTranslation.TranslationErrorCode, Access.internal, "python"); -@@access(DocumentTranslation.Status, Access.internal, "python"); -@@access(DocumentTranslation.StartTranslationDetails, - Access.internal, + +@@clientName(DocumentTranslationClient.getDocumentsStatus, + "list_document_statuses", "python" ); -@@access(DocumentTranslation.BatchRequest, Access.internal, "python"); -@@access(DocumentTranslation.SourceInput, Access.internal, "python"); -@@access(DocumentTranslation.DocumentFilter, Access.internal, "python"); -@@access(DocumentTranslation.TargetInput, Access.internal, "python"); -@@access(DocumentTranslation.Glossary, Access.internal, "python"); -@@access(DocumentTranslation.TranslationErrorResponse, - Access.internal, + +@@clientName(DocumentTranslationClient.getTranslationsStatus, + "list_translation_statuses", "python" ); -@@access(DocumentTranslation.TranslationError, Access.internal, "python"); -@@access(DocumentTranslation.InnerTranslationError, Access.internal, "python"); -@@access(DocumentTranslation.TranslationsStatus, Access.internal, "python"); -@@access(DocumentTranslation.TranslationStatus, Access.internal, "python"); -@@access(DocumentTranslation.StatusSummary, Access.internal, "python"); -@@access(DocumentTranslation.DocumentStatus, Access.internal, "python"); -@@access(DocumentTranslation.DocumentsStatus, Access.internal, "python"); -@@access(DocumentTranslation.SupportedFileFormats, Access.internal, "python"); -@@access(DocumentTranslation.FileFormat, Access.internal, "python"); -@@clientName(DocumentTranslation.DocumentTranslateBody.body, - "documentTranslateContent", - "csharp,java" +@@clientName(DocumentTranslation.TranslationStatus.createdDateTimeUtc, + "created_on", + "python" ); -@@clientName(DocumentTranslation.StartTranslationBody.body, - "startTranslationDetails", - "csharp,java" +@@clientName(DocumentTranslation.TranslationStatus.lastActionDateTimeUtc, + "last_updated_on", + "python" ); + +@@clientName(DocumentTranslation.Glossary.format, "file_format", "python"); + +@@clientName(DocumentTranslation.Glossary.version, "format_version", "python"); + +@@clientName(DocumentTranslation.Glossary, "TranslationGlossary", "python"); + +@@clientName(DocumentTranslation.DocumentStatus.createdDateTimeUtc, + "created_on", + "python" +); + +@@clientName(DocumentTranslation.DocumentStatus.lastActionDateTimeUtc, + "last_updated_on", + "python" +); + +@@clientName(DocumentTranslation.DocumentStatus.path, + "translated_document_url", + "python" +); + +@@clientName(DocumentTranslation.DocumentStatus.sourcePath, + "source_document_url", + "python" +); + +@@clientName(DocumentTranslation.DocumentStatus.to, "translated_to", "python"); + +@@clientName(DocumentTranslation.DocumentStatus.progress, + "translation_progress", + "python" +); + +@@clientName(DocumentTranslation.DocumentStatus.characterCharged, + "characters_charged", + "python" +); + +@@clientName(DocumentTranslation.StatusSummary.totalCharacterCharged, + "total_characters_charged", + "python" +); + +@@clientName(DocumentTranslation.StatusSummary.cancelled, "canceled", "python"); + +@@clientName(DocumentTranslation.FileFormat.format, "file_format", "python"); + +@@clientName(DocumentTranslation.FileFormat.defaultVersion, + "default_format_version", + "python" +); + +@@clientName(DocumentTranslation.FileFormat.versions, + "format_versions", + "python" +); + +@@clientName(DocumentTranslation.FileFormat, + "DocumentTranslationFileFormat", + "python" +); + +@@clientName(DocumentTranslation.TargetInput.category, "category_id", "python"); + +@@clientName(DocumentTranslation.TargetInput, "TranslationTarget", "python"); + +@@clientName(DocumentTranslation.TranslationError, + "DocumentTranslationError", + "python" +); + +@@clientName(DocumentTranslation.Status.Cancelled, "canceled", "python"); + +@@clientName(DocumentTranslation.Status.Cancelling, "canceling", "python"); diff --git a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp index 8c8d3c8da894..5757a44cacee 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/routes.tsp +++ b/specification/translation/Azure.AI.DocumentTranslation/routes.tsp @@ -1,12 +1,14 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "./models.tsp"; +import "@azure-tools/typespec-client-generator-core"; using TypeSpec.Versioning; using TypeSpec.Rest; using TypeSpec.Http; using Azure.Core; using Azure.Core.Traits; +using Azure.ClientGenerator.Core; namespace DocumentTranslation; @@ -213,6 +215,7 @@ interface DocumentTranslationOperations { getDocumentStatus is Azure.Core.Foundations.Operation< { @doc("Format - uuid. The batch id") + @clientName("translation_id", "python") @path id: uuid; @@ -236,6 +239,7 @@ interface DocumentTranslationOperations { getTranslationStatus is Azure.Core.Foundations.Operation< { @doc("Format - uuid. The operation id") + @clientName("translation_id", "python") @path id: uuid; }, @@ -259,6 +263,7 @@ interface DocumentTranslationOperations { cancelTranslation is Azure.Core.Foundations.Operation< { @doc("Format - uuid. The operation-id") + @clientName("translation_id", "python") @path id: uuid; }, @@ -320,6 +325,7 @@ interface DocumentTranslationOperations { getDocumentsStatus is Azure.Core.Foundations.Operation< { @doc("Format - uuid. The operation id") + @clientName("translation_id", "python") @path id: uuid; diff --git a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml index fbe351d6711b..135670f2256b 100644 --- a/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.DocumentTranslation/tspconfig.yaml @@ -29,8 +29,8 @@ options: package-mode: dataplane package-version: "1.1.0b1" generate-sample-project: false - generate-test: true - generate-sample: true + generate-test: false + generate-sample: false "@azure-tools/typespec-java": package-dir: "azure-ai-translation-document" namespace: com.azure.ai.translation.document From 74faa8fdb1043d2c45f1f3ae1e7808a38c1535ee Mon Sep 17 00:00:00 2001 From: pikumarmsft16 <pikumar@microsoft.com> Date: Thu, 10 Oct 2024 08:44:58 +0530 Subject: [PATCH 080/101] Swagger update for 2024-07-30-preview version for recoveryservices-backup (#30020) * Copy files from preview/2024-04-30-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-07-30-preview Updated the API version from preview/2024-04-30-preview to preview/2024-07-30-preview. * Added tag for 2024-07-30-preview in readme file * Fixing tag * Adding hana scale out swagger changes * Running swagger prettier * Suppresing spell check error for HanaScaleoutContainer word * Create sdk-suppressions.yaml --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> --- cSpell.json | 6 + .../preview/2024-07-30-preview/bms.json | 13692 ++++++++++++++++ .../AzureIaasVm/BackupFeature_Validate.json | 19 + .../AzureIaasVm/BackupPolicies_List.json | 76 + .../BackupProtectableItems_List.json | 30 + .../BackupProtectedItems_List.json | 39 + .../ClassicCompute_ProtectedItem_Get.json | 38 + .../Compute_ProtectedItem_Get.json | 38 + .../AzureIaasVm/ConfigureProtection.json | 51 + .../examples/AzureIaasVm/GetBackupStatus.json | 25 + .../ProtectedItemOperationResults.json | 46 + .../ProtectedItemOperationStatus.json | 28 + .../ProtectionIntent_CreateOrUpdate.json | 32 + .../ProtectionIntent_Validate.json | 25 + ...ectionPolicies_CreateOrUpdate_Complex.json | 181 + ...tectionPolicies_CreateOrUpdate_Simple.json | 75 + .../ProtectionPolicies_Delete.json | 13 + .../AzureIaasVm/ProtectionPolicies_Get.json | 43 + .../ProtectionPolicyOperationResults_Get.json | 44 + ...ProtectionPolicyOperationStatuses_Get.json | 28 + .../examples/AzureIaasVm/Provision_Ilr.json | 30 + ...RecoveryPointsRecommendedForMove_List.json | 101 + .../AzureIaasVm/RecoveryPoints_Get.json | 48 + .../AzureIaasVm/RecoveryPoints_List.json | 136 + .../examples/AzureIaasVm/Revoke_Ilr.json | 21 + .../examples/AzureIaasVm/StopProtection.json | 51 + ...iggerRestore_ALR_IaasVMRestoreRequest.json | 43 + ...reRequest_IdentityBasedRestoreDetails.json | 45 + ...R_IaasVMRestoreWithRehydrationRequest.json | 44 + .../TriggerRestore_ResourceGuardEnabled.json | 45 + ...ore_RestoreDisks_IaasVMRestoreRequest.json | 44 + ...reRequest_IdentityBasedRestoreDetails.json | 42 + ...s_IaasVMRestoreWithRehydrationRequest.json | 40 + .../TriggerValidateOperation_RestoreDisk.json | 44 + .../AzureIaasVm/V2Policy/IaaS_v2_daily.json | 191 + .../AzureIaasVm/V2Policy/IaaS_v2_hourly.json | 191 + .../AzureIaasVm/V2Policy/v2-Get-Policy.json | 48 + .../V2Policy/v2-List-Policies.json | 107 + .../AzureIaasVm/ValidateOperationResults.json | 33 + .../AzureIaasVm/ValidateOperationStatus.json | 35 + .../ValidateOperation_RestoreDisk.json | 53 + ...storeDisk_IdentityBasedRestoreDetails.json | 55 + .../ProtectableContainers_List.json | 42 + .../ProtectionContainers_Inquire.json | 19 + .../ProtectionContainers_Inquire_Result.json | 65 + .../ProtectionContainers_List.json | 32 + .../ProtectionContainers_Register.json | 44 + ...otectionPolicies_CreateOrUpdate_Daily.json | 180 + ...ctionPolicies_CreateOrUpdate_Hardened.json | 187 + ...tectionPolicies_CreateOrUpdate_Hourly.json | 176 + .../SoftDeletedContainers_List.json | 32 + .../AzureWorkload/BackupPolicies_List.json | 70 + .../BackupProtectionIntent_Delete.json | 14 + .../BackupProtectionIntent_Get.json | 26 + .../BackupProtectionIntent_List.json | 28 + .../BackupWorkloadItems_List.json | 47 + .../ProtectionContainers_Get.json | 57 + .../ProtectionContainers_Unregister.json | 21 + ...ectionPolicies_CreateOrUpdate_Complex.json | 260 + .../BackupDataMoveOperationStatus_Get.json | 20 + .../PrepareDataMoveOperationResult_Get.json | 23 + .../BackupDataMove/PrepareDataMove_Post.json | 23 + .../BackupDataMove/TriggerDataMove_Post.json | 23 + .../BackupResourceEncryptionConfig_Get.json | 27 + .../BackupResourceEncryptionConfig_Put.json | 19 + .../BackupProtectedItem_UsageSummary_Get.json | 62 + ...ProtectionContainers_UsageSummary_Get.json | 44 + .../BackupResourceVaultConfigs_Get.json | 20 + .../BackupResourceVaultConfigs_Patch.json | 25 + .../BackupResourceVaultConfigs_Put.json | 27 + .../Common/BackupSecurityPin_Get.json | 17 + .../Common/BackupStorageConfig_Get.json | 23 + .../Common/BackupStorageConfig_Patch.json | 17 + .../Common/BackupStorageConfig_Put.json | 29 + .../Common/CancelJobOperationResult.json | 20 + .../Common/ExportJobsOperationResult.json | 41 + .../examples/Common/GetJobDetails.json | 46 + .../examples/Common/ListJobs.json | 49 + .../ListJobsWithAllSupportedFilters.json | 33 + ...istJobsWithStartTimeAndEndTimeFilters.json | 51 + .../examples/Common/ProtectedItem_Delete.json | 22 + .../ProtectedItem_Delete_OperationResult.json | 20 + .../ProtectedItem_Delete_OperationStatus.json | 21 + .../Common/RecoveryPoints_Update.json | 44 + .../examples/Common/RefreshContainers.json | 17 + .../RefreshContainers_OperationResults.json | 19 + .../examples/Common/TriggerBackup_Post.json | 25 + .../examples/Common/TriggerCancelJob.json | 17 + .../examples/Common/TriggerExportJobs.json | 16 + .../examples/Dpm/BackupEngines_Get.json | 35 + .../examples/Dpm/BackupEngines_List.json | 60 + .../examples/ListOperations.json | 463 + .../DeletePrivateEndpointConnection.json | 19 + .../GetPrivateEndpointConnection.json | 31 + ...vateEndpointConnectionOperationStatus.json | 21 + .../PutPrivateEndpointConnection.json | 70 + .../DeleteResourceGuardProxy.json | 13 + .../GetResourceGuardProxy.json | 33 + .../ListResourceGuardProxy.json | 36 + .../PutResourceGuardProxy.json | 38 + .../UnlockDeleteResourceGuardProxy.json | 22 + .../FetchTieringCostForPolicy.json | 32 + .../FetchTieringCostForProtectedItem.json | 33 + .../FetchTieringCostForRehydrate.json | 33 + .../TieringCost/FetchTieringCostForVault.json | 31 + .../GetTieringCostOperationResult.json | 20 + .../GetTieringCostOperationStatus.json | 21 + .../TriggerRecoveryPointMove_Post.json | 26 + .../resource-manager/readme.md | 9 + .../resource-manager/sdk-suppressions.yaml | 5 + 110 files changed, 19167 insertions(+) create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/bms.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupFeature_Validate.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupPolicies_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectableItems_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectedItems_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Compute_ProtectedItem_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ConfigureProtection.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/GetBackupStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationResults.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_Validate.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Delete.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Provision_Ilr.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Revoke_Ilr.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/StopProtection.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-List-Policies.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationResults.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectableContainers_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire_Result.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Register.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hardened.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/SoftDeletedContainers_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupPolicies_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Delete.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupWorkloadItems_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Unregister.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMove_Post.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/TriggerDataMove_Post.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Put.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectedItem_UsageSummary_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectionContainers_UsageSummary_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Patch.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Put.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupSecurityPin_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Patch.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Put.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/CancelJobOperationResult.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ExportJobsOperationResult.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/GetJobDetails.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobs.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithAllSupportedFilters.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationResult.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RecoveryPoints_Update.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers_OperationResults.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerBackup_Post.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerCancelJob.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerExportJobs.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_Get.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_List.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ListOperations.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForPolicy.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForProtectedItem.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForRehydrate.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForVault.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationResult.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationStatus.json create mode 100644 specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TriggerRecoveryPointMove_Post.json create mode 100644 specification/recoveryservicesbackup/resource-manager/sdk-suppressions.yaml diff --git a/cSpell.json b/cSpell.json index 256f00c50ab5..797046f01e9d 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1048,6 +1048,12 @@ "xcool" ] }, + { + "filename": "**/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/**/bms.json", + "words": [ + "HanaScaleoutContainer" + ] + }, { "filename": "**/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2021-10-15/iotdps.json", "words": [ diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/bms.json new file mode 100644 index 000000000000..c0b9fca6f757 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/bms.json @@ -0,0 +1,13692 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-07-30-preview", + "title": "RecoveryServicesBackupClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig": { + "get": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Fetches resource storage config.", + "operationId": "BackupResourceStorageConfigsNonCRR_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Get.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Updates vault storage model type.", + "operationId": "BackupResourceStorageConfigsNonCRR_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault storage config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Put.json" + } + } + }, + "patch": { + "tags": [ + "BackupResourceStorageConfigsNonCRR" + ], + "description": "Updates vault storage model type.", + "operationId": "BackupResourceStorageConfigsNonCRR_patch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault storage config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceConfigResource" + } + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Storage Configuration": { + "$ref": "./examples/Common/BackupStorageConfig_Patch.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection": { + "post": { + "tags": [ + "ProtectionIntent" + ], + "summary": "It will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", + "operationId": "ProtectionIntent_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Enable backup validation request on Virtual Machine", + "required": true, + "schema": { + "$ref": "#/definitions/PreValidateEnableBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PreValidateEnableBackupResponse" + } + } + }, + "x-ms-examples": { + "Validate Enable Protection on Azure Vm": { + "$ref": "./examples/AzureIaasVm/ProtectionIntent_Validate.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus": { + "post": { + "tags": [ + "BackupStatus" + ], + "summary": "Get the container backup status", + "operationId": "BackupStatus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Container Backup Status Request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupStatusRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupStatusResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Virtual Machine Backup Status": { + "$ref": "./examples/AzureIaasVm/GetBackupStatus.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures": { + "post": { + "tags": [ + "FeatureSupport" + ], + "summary": "It will validate if given feature with resource properties is supported in service", + "operationId": "FeatureSupport_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AzureRegion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Feature support request object", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureSupportRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureVMResourceFeatureSupportResponse" + } + } + }, + "x-ms-examples": { + "Check Azure Vm Backup Feature Support": { + "$ref": "./examples/AzureIaasVm/BackupFeature_Validate.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}": { + "get": { + "tags": [ + "ProtectionIntent" + ], + "description": "Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", + "operationId": "ProtectionIntent_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Backed up item name whose details are to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + }, + "x-ms-examples": { + "Get ProtectionIntent for an item": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectionIntent" + ], + "description": "Create Intent for Enabling backup of an item. This is a synchronous operation.", + "operationId": "ProtectionIntent_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Intent object name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backed up item", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + }, + "x-ms-examples": { + "Create or Update Azure Vm Protection Intent": { + "$ref": "./examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionIntent" + ], + "description": "Used to remove intent from an item", + "operationId": "ProtectionIntent_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the intent.", + "required": true, + "type": "string" + }, + { + "name": "intentObjectName", + "in": "path", + "description": "Intent to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "x-ms-examples": { + "Delete Protection intent from item": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_Delete.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents": { + "get": { + "tags": [ + "BackupProtectionIntent" + ], + "description": "Provides a pageable list of all intents that are present within a vault.", + "operationId": "BackupProtectionIntent_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionIntentResourceList" + } + } + }, + "x-ms-odata": "#/definitions/ProtectionIntentQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protection intent with backupManagementType filter": { + "$ref": "./examples/AzureWorkload/BackupProtectionIntent_List.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries": { + "get": { + "tags": [ + "BackupUsageSummaries" + ], + "description": "Fetches the backup management usage summaries of the vault.", + "operationId": "BackupUsageSummaries_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupManagementUsageList" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupSummariesQueryObject", + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Get Protected Items Usages Summary": { + "$ref": "./examples/Common/BackupProtectedItem_UsageSummary_Get.json" + }, + "Get Protected Containers Usages Summary": { + "$ref": "./examples/Common/BackupProtectionContainers_UsageSummary_Get.json" + } + } + } + }, + "/providers/Microsoft.RecoveryServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig": { + "get": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Fetches resource vault config.", + "operationId": "BackupResourceVaultConfigs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Get.json" + } + } + }, + "patch": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Updates vault security config.", + "operationId": "BackupResourceVaultConfigs_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Patch.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceVaultConfigs" + ], + "description": "Updates vault security config. ", + "operationId": "BackupResourceVaultConfigs_Put", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceVaultConfigResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Security Config": { + "$ref": "./examples/Common/BackupResourceVaultConfigs_Put.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig": { + "get": { + "tags": [ + "BackupResourceEncryptionConfigs" + ], + "description": "Fetches Vault Encryption config.", + "operationId": "BackupResourceEncryptionConfigs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupResourceEncryptionConfigExtendedResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Vault Encryption Configuration": { + "$ref": "./examples/BackupResourceEncryptionConfig_Get.json" + } + } + }, + "put": { + "tags": [ + "BackupResourceEncryptionConfigs" + ], + "description": "Updates Vault encryption config.", + "operationId": "BackupResourceEncryptionConfigs_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Vault encryption input config request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupResourceEncryptionConfigResource" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Update Vault Encryption Configuration": { + "$ref": "./examples/BackupResourceEncryptionConfig_Put.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Get Private Endpoint Connection. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Approve or Reject Private Endpoint requests. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Put", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnection" + ], + "description": "Delete Private Endpoint requests. This call is made by Backup Admin.", + "operationId": "PrivateEndpointConnection_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete PrivateEndpointConnection": { + "$ref": "./examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "PrivateEndpoint" + ], + "summary": "Gets the operation status for a private endpoint connection.", + "operationId": "PrivateEndpoint_GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation id", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}": { + "get": { + "tags": [ + "DataMove" + ], + "description": "Fetches operation status for data move operation on vault", + "operationId": "GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove": { + "post": { + "tags": [ + "DataMove" + ], + "description": "Prepares source vault for Data Move operation", + "operationId": "BMSPrepareDataMove", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Prepare data move request", + "required": true, + "schema": { + "$ref": "#/definitions/PrepareDataMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Prepare Data Move": { + "$ref": "./examples/BackupDataMove/PrepareDataMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationResults/{operationId}": { + "get": { + "tags": [ + "BMSPrepareDataMoveOperationResult" + ], + "description": "Fetches Operation Result for Prepare Data Move", + "operationId": "BMSPrepareDataMoveOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VaultStorageConfigOperationResultResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. ", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-examples": { + "Get operation result for PrepareDataMove": { + "$ref": "./examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove": { + "post": { + "tags": [ + "DataMove" + ], + "description": "Triggers Data Move Operation on target vault", + "operationId": "BMSTriggerDataMove", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "Trigger data move request", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerDataMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/NewErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Data Move": { + "$ref": "./examples/BackupDataMove/TriggerDataMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}": { + "get": { + "tags": [ + "ProtectedItems" + ], + "description": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API.", + "operationId": "ProtectedItems_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/GetProtectedItemQueryObject", + "x-ms-examples": { + "Get Protected Classic Virtual Machine Details": { + "$ref": "./examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json" + }, + "Get Protected Virtual Machine Details": { + "$ref": "./examples/AzureIaasVm/Compute_ProtectedItem_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectedItems" + ], + "description": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\r\nasynchronous operation. To know the status of the operation, call the GetItemOperationResult API.", + "operationId": "ProtectedItems_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Item name to be backed up.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backed up item", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Enable Protection on Azure IaasVm": { + "$ref": "./examples/AzureIaasVm/ConfigureProtection.json" + }, + "Stop Protection with retain data on Azure IaasVm": { + "$ref": "./examples/AzureIaasVm/StopProtection.json" + } + } + }, + "delete": { + "tags": [ + "ProtectedItems" + ], + "description": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\r\nrequest, call the GetItemOperationResult API.", + "operationId": "ProtectedItems_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Protection from Azure Virtual Machine": { + "$ref": "./examples/Common/ProtectedItem_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectedItemOperationResults" + ], + "description": "Fetches the result of any operation on the backup item.", + "operationId": "ProtectedItemOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResource" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Results of Protected Vm": { + "$ref": "./examples/AzureIaasVm/ProtectedItemOperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "description": "Lists the backup copies for the backed up item.", + "operationId": "RecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item whose backup copies are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSRPQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Protected Azure Vm Recovery Points": { + "$ref": "./examples/AzureIaasVm/RecoveryPoints_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}": { + "get": { + "tags": [ + "RecoveryPoints" + ], + "description": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\nTo know the status of the operation, call the GetProtectedItemOperationResult API.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose backup data needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "RecoveryPointID represents the backed up data to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Vm Recovery Point Details": { + "$ref": "./examples/AzureIaasVm/RecoveryPoints_Get.json" + } + } + }, + "patch": { + "tags": [ + "RecoveryPoints" + ], + "description": "UpdateRecoveryPoint to update recovery point for given RecoveryPointID.", + "operationId": "RecoveryPoints_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with backed up item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose backup data needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "RecoveryPointID represents the backed up data to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRecoveryPointRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Azure Vm Recovery Point Details": { + "$ref": "./examples/Common/RecoveryPoints_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore": { + "post": { + "tags": [ + "Restores" + ], + "description": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\nGetProtectedItemOperationResult API.", + "operationId": "Restores_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents the backed up data to be restored.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource restore request", + "required": true, + "schema": { + "$ref": "#/definitions/RestoreRequestResource" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Restore to New Azure IaasVm with IaasVMRestoreRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json" + }, + "Restore to New Azure IaasVm with IaasVMRestoreRequest with identityBasedRestoreDetails": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json" + }, + "Restore to New Azure IaasVm with IaasVMRestoreWithRehydrationRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json" + }, + "Restore Disks with IaasVMRestoreRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json" + }, + "Restore Disks with IaasVMRestoreRequest with IdentityBasedRestoreDetails": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json" + }, + "Restore Disks with IaasVMRestoreWithRehydrationRequest": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json" + }, + "Trigger Restore with MUA": { + "$ref": "./examples/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies": { + "get": { + "tags": [ + "BackupPolicies" + ], + "description": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\nscoped results.", + "operationId": "BackupPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/ProtectionPolicyQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protection policies with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupPolicies_List.json" + }, + "List protection policies with backupManagementType filter as AzureIaasVm with both V1 and V2 policies": { + "$ref": "./examples/AzureIaasVm/V2Policy/v2-List-Policies.json" + }, + "List protection policies with backupManagementType filter as AzureWorkload": { + "$ref": "./examples/AzureWorkload/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}": { + "get": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\noperation. Status of the operation can be fetched using GetPolicyOperationResult API.", + "operationId": "ProtectionPolicies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy information to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure IaasVm Protection Policy Details": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Get.json" + }, + "Get Azure IaasVm Enhanced Protection Policy Details": { + "$ref": "./examples/AzureIaasVm/V2Policy/v2-Get-Policy.json" + } + } + }, + "put": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\nusing GetPolicyOperationResult API.", + "operationId": "ProtectionPolicies_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy to be created.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backup policy", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create or Update Simple Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json" + }, + "Create or Update Full Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json" + }, + "Create or Update Enhanced Azure Vm Protection Policy with Hourly backup": { + "$ref": "./examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json" + }, + "Create or Update Enhanced Azure Vm Protection Policy with daily backup": { + "$ref": "./examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json" + }, + "Create or Update Full Azure Workload Protection Policy": { + "$ref": "./examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json" + }, + "Create or Update Daily Azure Storage Protection Policy": { + "$ref": "./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json" + }, + "Create or Update Hourly Azure Storage Protection Policy": { + "$ref": "./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json" + }, + "Create or Update Azure Storage Vault Standard Protection Policy": { + "$ref": "./examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hardened.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionPolicies" + ], + "description": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\noperation can be fetched using GetProtectionPolicyOperationResult API.", + "operationId": "ProtectionPolicies_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Azure Vm Protection Policy": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionPolicyOperationResults" + ], + "description": "Provides the result of an operation.", + "operationId": "ProtectionPolicyOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy name whose operation's result needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Policy Operation Results": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs": { + "get": { + "tags": [ + "BackupJobs" + ], + "description": "Provides a pageable list of jobs.", + "operationId": "BackupJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/JobQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List All Jobs": { + "$ref": "./examples/Common/ListJobs.json" + }, + "List Jobs With Filters": { + "$ref": "./examples/Common/ListJobsWithAllSupportedFilters.json" + }, + "List Jobs With Time Filter": { + "$ref": "./examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}": { + "get": { + "tags": [ + "JobDetails" + ], + "description": "Gets extended information associated with the job.", + "operationId": "JobDetails_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the job whose details are to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Job Details": { + "$ref": "./examples/Common/GetJobDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel": { + "post": { + "tags": [ + "JobCancellations" + ], + "description": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\nGetCancelOperationResult API.", + "operationId": "JobCancellations_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Name of the job to cancel.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Cancel Job": { + "$ref": "./examples/Common/TriggerCancelJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}": { + "get": { + "tags": [ + "JobOperationResults" + ], + "description": "Fetches the result of any operation.", + "operationId": "JobOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "jobName", + "in": "path", + "description": "Job name whose operation result has to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation whose result has to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Cancel Job Operation Result": { + "$ref": "./examples/Common/CancelJobOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}": { + "get": { + "tags": [ + "ExportJobsOperationResults" + ], + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\ncontains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "operationId": "ExportJobsOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the export job.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResultInfoBaseResource" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/OperationResultInfoBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Export Jobs Operation Results": { + "$ref": "./examples/Common/ExportJobsOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport": { + "post": { + "tags": [ + "Jobs" + ], + "description": "Triggers export of jobs specified by filters and returns an OperationID to track.", + "operationId": "Jobs_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/JobQueryObject", + "x-ms-examples": { + "Export Jobs": { + "$ref": "./examples/Common/TriggerExportJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems": { + "get": { + "tags": [ + "BackupProtectedItems" + ], + "description": "Provides a pageable list of all items that are backed up within a vault.", + "operationId": "BackupProtectedItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectedItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/ProtectedItemQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protected items with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupProtectedItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation": { + "post": { + "tags": [ + "Operation" + ], + "description": "Validate operation for specified backed up item. This is a synchronous operation.", + "operationId": "Operation_Validate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource validate operation request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateOperationRequestResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateOperationsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk.json" + }, + "Validate Operation with identityBasedRestoreDetails": { + "$ref": "./examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTriggerValidateOperation": { + "post": { + "tags": [ + "ValidateOperation" + ], + "description": "Validate operation for specified backed up item in the form of an asynchronous operation. Returns tracking headers which can be tracked using GetValidateOperationResult API.", + "operationId": "ValidateOperation_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "resource validate operation request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateOperationRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Validate Operation": { + "$ref": "./examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationResults/{operationId}": { + "get": { + "tags": [ + "ValidateOperationResults" + ], + "description": "Fetches the result of a triggered validate operation.", + "operationId": "ValidateOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ValidateOperationsResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Results of Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationsStatuses/{operationId}": { + "get": { + "tags": [ + "ValidateOperationStatuses" + ], + "description": "Fetches the status of a triggered validate operation. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation.\r\nIf operation has completed, this method returns the list of errors obtained while validating the operation.", + "operationId": "ValidateOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID represents the operation whose status needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Status of Validate Operation": { + "$ref": "./examples/AzureIaasVm/ValidateOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines": { + "get": { + "tags": [ + "BackupEngines" + ], + "description": "Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.", + "operationId": "BackupEngines_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupEngineBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupEnginesQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Dpm/AzureBackupServer/Lajolla Backup Engines": { + "$ref": "./examples/Dpm/BackupEngines_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}": { + "get": { + "tags": [ + "BackupEngines" + ], + "description": "Returns backup management server registered to Recovery Services Vault.", + "operationId": "BackupEngines_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "backupEngineName", + "in": "path", + "description": "Name of the backup management server.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupEngineBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSBackupEngineQueryObject", + "x-ms-examples": { + "Get Dpm/AzureBackupServer/Lajolla Backup Engine Details": { + "$ref": "./examples/Dpm/BackupEngines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionContainerRefreshOperationResults" + ], + "description": "Provides the result of the refresh operation triggered by the BeginRefresh operation.", + "operationId": "ProtectionContainerRefreshOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID associated with the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Azure Vm Discovery Operation Result": { + "$ref": "./examples/Common/RefreshContainers_OperationResults.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers": { + "get": { + "tags": [ + "ProtectableContainers" + ], + "description": "Lists the containers that can be registered to Recovery Services Vault.", + "operationId": "ProtectableContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectableContainerResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainerQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protectable items with backupManagementType filter as AzureStorage": { + "$ref": "./examples/AzureStorage/ProtectableContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}": { + "get": { + "tags": [ + "ProtectionContainers" + ], + "description": "Gets details of the specific container registered to your Recovery Services Vault.", + "operationId": "ProtectionContainers_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric where the container belongs.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container whose details need to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Container Details": { + "$ref": "./examples/AzureWorkload/ProtectionContainers_Get.json" + } + } + }, + "put": { + "tags": [ + "ProtectionContainers" + ], + "description": "Registers the container with Recovery Services vault.\r\nThis is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\nthe operation.", + "operationId": "ProtectionContainers_Register", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container to be registered.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RegisterAzure Storage ProtectionContainers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Register.json" + } + } + }, + "delete": { + "tags": [ + "ProtectionContainers" + ], + "description": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\nwhether the backend service has finished processing the request, call Get Container Operation Result API.", + "operationId": "ProtectionContainers_Unregister", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Name of the fabric where the container belongs.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container which needs to be unregistered from the Recovery Services Vault.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Unregister Protection Container": { + "$ref": "./examples/AzureWorkload/ProtectionContainers_Unregister.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire": { + "post": { + "tags": [ + "ProtectionContainers" + ], + "summary": "Inquires all the protectable items under the given container.", + "description": "This is an async operation and the results should be tracked using location header or Azure-async-url.", + "operationId": "ProtectionContainers_Inquire", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric Name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container in which inquiry needs to be triggered.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainersInquiryQueryObject", + "x-ms-examples": { + "Inquire Azure Storage Protection Containers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items": { + "get": { + "tags": [ + "BackupWorkloadItems" + ], + "description": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\nparameters.", + "operationId": "BackupWorkloadItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Name of the container.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkloadItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSWorkloadItemQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Workload Items in Container": { + "$ref": "./examples/AzureWorkload/BackupWorkloadItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}": { + "get": { + "tags": [ + "ProtectionContainerOperationResults" + ], + "description": "Fetches the result of any operation on the container.", + "operationId": "ProtectionContainerOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the container.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name whose information should be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents the operation whose result needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResource" + } + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Storage Protection Container Operation Result": { + "$ref": "./examples/AzureStorage/ProtectionContainers_Inquire_Result.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup": { + "post": { + "tags": [ + "Backups" + ], + "description": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\noperation, call GetProtectedItemOperationResult API.", + "operationId": "Backups_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item for which backup needs to be triggered.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource backup request", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Trigger Backup": { + "$ref": "./examples/Common/TriggerBackup_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}": { + "get": { + "tags": [ + "ProtectedItemOperationStatuses" + ], + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with the operation.", + "operationId": "ProtectedItemOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backup item.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backup item name whose details are to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID represents the operation whose status needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Operation Status of Protected Vm": { + "$ref": "./examples/AzureIaasVm/ProtectedItemOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery": { + "post": { + "tags": [ + "ItemLevelRecoveryConnections" + ], + "description": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\nexplorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\nprovisioning, call GetProtectedItemOperationResult API.", + "operationId": "ItemLevelRecoveryConnections_Provision", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose files/folders are to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "resource ILR request", + "required": true, + "schema": { + "$ref": "#/definitions/ILRRequestResource" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Provision Instant Item Level Recovery for Azure Vm": { + "$ref": "./examples/AzureIaasVm/Provision_Ilr.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery": { + "post": { + "tags": [ + "ItemLevelRecoveryConnections" + ], + "description": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\ndisplaying all recoverable files and folders. This is an asynchronous operation.", + "operationId": "ItemLevelRecoveryConnections_Revoke", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "Container name associated with the backed up items.", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "description": "Backed up item name whose files/folders are to be restored.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "description": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Revoke Instant Item Level Recovery for Azure Vm": { + "$ref": "./examples/AzureIaasVm/Revoke_Ilr.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers": { + "post": { + "tags": [ + "ProtectionContainers" + ], + "description": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\nasynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.", + "operationId": "ProtectionContainers_Refresh", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name associated the container.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSRefreshContainersQueryObject", + "x-ms-examples": { + "Trigger Azure Vm Discovery": { + "$ref": "./examples/Common/RefreshContainers.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperationResults/{operationId}": { + "get": { + "tags": [ + "BackupOperationResults" + ], + "description": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\nstatus code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\nsuccessful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\npart of the Location header of the operation response.", + "operationId": "BackupOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Result for Protected Item Delete Operation": { + "$ref": "./examples/Common/ProtectedItem_Delete_OperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperations/{operationId}": { + "get": { + "tags": [ + "BackupOperationStatuses" + ], + "description": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs when the operation is complete.", + "operationId": "BackupOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "operationId", + "in": "path", + "description": "OperationID which represents the operation.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protected Item Delete Operation Status": { + "$ref": "./examples/Common/ProtectedItem_Delete_OperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}": { + "get": { + "tags": [ + "ProtectionPolicyOperationStatuses" + ], + "description": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with operation.", + "operationId": "ProtectionPolicyOperationStatuses_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "policyName", + "in": "path", + "description": "Backup policy name whose operation's status needs to be fetched.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "Operation ID which represents an operation whose status needs to be fetched.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Protection Policy Operation Status": { + "$ref": "./examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems": { + "get": { + "tags": [ + "BackupProtectableItems" + ], + "description": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\npagination parameters.", + "operationId": "BackupProtectableItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkloadProtectableItemResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSPOQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List protectable items with backupManagementType filter as AzureIaasVm": { + "$ref": "./examples/AzureIaasVm/BackupProtectableItems_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionContainers": { + "get": { + "tags": [ + "BackupProtectionContainers" + ], + "description": "Lists the containers registered to Recovery Services Vault.", + "operationId": "BackupProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainerQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Backup Protection Containers": { + "$ref": "./examples/AzureStorage/ProtectionContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupDeletedProtectionContainers": { + "get": { + "tags": [ + "SoftDeletedContainers" + ], + "description": "Lists the soft deleted containers registered to Recovery Services Vault.", + "operationId": "DeletedProtectionContainers_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/BMSContainerQueryObject", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Backup Protection Containers": { + "$ref": "./examples/AzureStorage/SoftDeletedContainers_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupSecurityPIN": { + "post": { + "tags": [ + "SecurityPINs" + ], + "description": "Get the security PIN.", + "operationId": "SecurityPINs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "security pin request", + "required": false, + "schema": { + "$ref": "#/definitions/SecurityPinBase" + } + }, + { + "name": "x-ms-authorization-auxiliary", + "in": "header", + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TokenInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Vault Security Pin": { + "$ref": "./examples/Common/BackupSecurityPin_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/move": { + "post": { + "tags": [ + "RecoveryPoint" + ], + "summary": "Move recovery point from one datastore to another store.", + "operationId": "MoveRecoveryPoint", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Move Resource Across Tiers Request", + "required": true, + "schema": { + "$ref": "#/definitions/MoveRPAcrossTiersRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger RP Move Operation": { + "$ref": "./examples/TriggerRecoveryPointMove_Post.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPointsRecommendedForMove": { + "post": { + "tags": [ + "RecoveryPointsRecommendedForMove" + ], + "description": "Lists the recovery points recommended for move to another tier", + "operationId": "RecoveryPointsRecommendedForMove_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "protectedItemName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "List Recovery points Recommended for Move Request", + "required": true, + "schema": { + "$ref": "#/definitions/ListRecoveryPointsRecommendedForMoveRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Protected Azure Vm Recovery Points Recommended for Move": { + "$ref": "./examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies": { + "get": { + "tags": [ + "ResourceGuardProxies" + ], + "description": "List the ResourceGuardProxies under vault", + "operationId": "ResourceGuardProxies_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get VaultGuardProxies": { + "$ref": "./examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}": { + "get": { + "tags": [ + "ResourceGuardProxy" + ], + "description": "Returns ResourceGuardProxy under vault and with the name referenced in request", + "operationId": "ResourceGuardProxy_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardProxyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json" + } + } + }, + "put": { + "tags": [ + "ResourceGuardProxy" + ], + "description": "Add or Update ResourceGuardProxy under vault\r\nSecures vault critical operations", + "operationId": "ResourceGuardProxy_Put", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardProxyName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json" + } + } + }, + "delete": { + "tags": [ + "ResourceGuardProxy" + ], + "description": "Delete ResourceGuardProxy under vault", + "operationId": "ResourceGuardProxy_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardProxyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete": { + "post": { + "tags": [ + "ResourceGuardProxy" + ], + "description": "Secures delete ResourceGuardProxy operations.", + "operationId": "ResourceGuardProxy_UnlockDelete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "resourceGuardProxyName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/UnlockDeleteRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UnlockDeleteResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UnlockDelete ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/fetchTieringCost": { + "post": { + "tags": [ + "FetchTieringCost" + ], + "operationId": "FetchTieringCost_Post", + "description": "Provides the details of the tiering related sizes and cost.\r\nStatus of the operation can be fetched using GetTieringCostOperationStatus API and result using GetTieringCostOperationResult API.", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RestrictedVaultName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "description": "Fetch Tiering Cost Request", + "required": true, + "schema": { + "$ref": "#/definitions/FetchTieringCostInfoRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TieringCostInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Get the tiering savings cost info for policy": { + "$ref": "./examples/TieringCost/FetchTieringCostForPolicy.json" + }, + "Get the tiering savings cost info for protected item": { + "$ref": "./examples/TieringCost/FetchTieringCostForProtectedItem.json" + }, + "Get the tiering savings cost info for vault": { + "$ref": "./examples/TieringCost/FetchTieringCostForVault.json" + }, + "Get the rehydration cost for recovery point": { + "$ref": "./examples/TieringCost/FetchTieringCostForRehydrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationResults/{operationId}": { + "get": { + "tags": [ + "GetTieringCostOperationResult" + ], + "description": "Gets the result of async operation for tiering cost", + "operationId": "GetTieringCostOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RestrictedVaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TieringCostInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Fetch Tiering Cost Operation Result": { + "$ref": "./examples/TieringCost/GetTieringCostOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationsStatus/{operationId}": { + "get": { + "tags": [ + "TieringCostOperationStatus" + ], + "operationId": "TieringCostOperationStatus_Get", + "description": "Gets the status of async operations of tiering cost", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/RestrictedVaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Fetch Tiering Cost Operation Status": { + "$ref": "./examples/TieringCost/GetTieringCostOperationStatus.json" + } + } + } + } + }, + "definitions": { + "BackupResourceEncryptionConfig": { + "type": "object", + "properties": { + "encryptionAtRestType": { + "description": "Encryption At Rest Type", + "enum": [ + "Invalid", + "MicrosoftManaged", + "CustomerManaged" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAtRestType", + "modelAsString": true + } + }, + "keyUri": { + "description": "Key Vault Key URI", + "type": "string" + }, + "subscriptionId": { + "description": "Key Vault Subscription Id", + "type": "string" + }, + "lastUpdateStatus": { + "enum": [ + "Invalid", + "NotEnabled", + "PartiallySucceeded", + "PartiallyFailed", + "Failed", + "Succeeded", + "Initialized", + "FirstInitialization" + ], + "type": "string", + "x-ms-enum": { + "name": "LastUpdateStatus", + "modelAsString": true + } + }, + "infrastructureEncryptionState": { + "enum": [ + "Invalid", + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "InfrastructureEncryptionState", + "modelAsString": true + } + } + } + }, + "BackupResourceEncryptionConfigExtended": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupResourceEncryptionConfig" + } + ], + "properties": { + "userAssignedIdentity": { + "description": "User Assigned Identity Id", + "type": "string" + }, + "useSystemAssignedIdentity": { + "description": "bool to indicate whether to use system Assigned Identity or not", + "type": "boolean" + } + } + }, + "BackupResourceEncryptionConfigExtendedResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceEncryptionConfigExtended", + "description": "BackupResourceEncryptionConfigExtendedResource properties" + } + } + }, + "BackupResourceEncryptionConfigResource": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceEncryptionConfig", + "description": "BackupResourceEncryptionConfigResource properties" + } + } + }, + "PrivateEndpoint": { + "description": "The Private Endpoint network resource that is linked to the Private Endpoint connection", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets id", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "Private Endpoint Connection Response Properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "Gets or sets provisioning state of the private endpoint connection", + "enum": [ + "Succeeded", + "Deleting", + "Failed", + "Pending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Gets or sets private endpoint associated with the private endpoint connection" + }, + "groupIds": { + "description": "Group Ids for the Private Endpoint", + "type": "array", + "items": { + "description": "GroupId for the PrivateEndpointConnection - AzureBackup, AzureBackup_secondary or AzureSiteRecovery", + "enum": [ + "AzureBackup", + "AzureBackup_secondary", + "AzureSiteRecovery" + ], + "type": "string", + "x-ms-enum": { + "name": "VaultSubResourceType", + "modelAsString": true + } + } + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Gets or sets private link service connection state" + } + } + }, + "PrivateEndpointConnectionResource": { + "description": "Private Endpoint Connection Response Properties", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnection", + "description": "PrivateEndpointConnectionResource properties" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Private Link Service Connection State", + "type": "object", + "properties": { + "status": { + "description": "Gets or sets the status", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateEndpointConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Gets or sets description", + "type": "string" + }, + "actionsRequired": { + "description": "Gets or sets actions required", + "type": "string" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "type": "object", + "$ref": "#/definitions/CloudErrorBody", + "description": "The error object." + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "A list of additional details about the error." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + }, + "description": "An error response from the Container Instance service." + }, + "NewErrorResponse": { + "properties": { + "error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NewErrorResponse" + }, + "x-ms-identifiers": [ + "/error/code" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + } + }, + "description": "The resource management error response." + }, + "AzureFileshareProtectedItem": { + "description": "Azure File Share workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the fileshare represented by this backup item.", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureFileshareProtectedItemExtendedInfo", + "description": "Additional information with this backup item." + } + }, + "x-ms-discriminator-value": "AzureFileShareProtectedItem" + }, + "AzureFileshareProtectedItemExtendedInfo": { + "description": "Additional information about Azure File Share backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this item in the service.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of available backup copies associated with this backup item.", + "type": "integer" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + }, + "resourceState": { + "description": "Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted}", + "type": "string", + "readOnly": true + }, + "resourceStateSyncTime": { + "format": "date-time", + "description": "The resource state sync time for this backup item.", + "type": "string", + "readOnly": true + } + } + }, + "AzureFileShareRecoveryPoint": { + "description": "Azure File Share workload specific backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointType": { + "description": "Type of the backup copy. Specifies whether it is a crash consistent backup or app consistent.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "fileShareSnapshotUri": { + "description": "Contains Url to the snapshot of fileshare, if applicable", + "type": "string" + }, + "recoveryPointSizeInGB": { + "format": "int32", + "description": "Contains recovery point size", + "type": "integer" + }, + "recoveryPointProperties": { + "description": "Properties of Recovery Point", + "$ref": "#/definitions/RecoveryPointProperties" + } + }, + "x-ms-discriminator-value": "AzureFileShareRecoveryPoint" + }, + "AzureFileShareRestoreRequest": { + "description": "AzureFileShare Restore Request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Source storage account ARM Id", + "type": "string" + }, + "copyOptions": { + "description": "Options to resolve copy conflicts.", + "enum": [ + "Invalid", + "CreateCopy", + "Skip", + "Overwrite", + "FailOnConflict" + ], + "type": "string", + "x-ms-enum": { + "name": "CopyOptions", + "modelAsString": true + } + }, + "restoreRequestType": { + "description": "Restore Type (FullShareRestore or ItemLevelRestore)", + "enum": [ + "Invalid", + "FullShareRestore", + "ItemLevelRestore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreRequestType", + "modelAsString": true + } + }, + "restoreFileSpecs": { + "description": "List of Source Files/Folders(which need to recover) and TargetFolderPath details", + "type": "array", + "items": { + "$ref": "#/definitions/RestoreFileSpecs" + }, + "x-ms-identifiers": [] + }, + "targetDetails": { + "$ref": "#/definitions/TargetAFSRestoreInfo", + "description": "Target File Share Details" + } + }, + "x-ms-discriminator-value": "AzureFileShareRestoreRequest" + }, + "AzureVmWorkloadProtectionPolicy": { + "description": "Azure VM (Mercury) workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "workLoadType": { + "description": "Type of workload for the backup management", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "settings": { + "$ref": "#/definitions/Settings", + "description": "Common settings for the backup management" + }, + "subProtectionPolicy": { + "description": "List of sub-protection policies which includes schedule and retention", + "type": "array", + "items": { + "$ref": "#/definitions/SubProtectionPolicy" + }, + "x-ms-identifiers": [] + }, + "makePolicyConsistent": { + "description": "Fix the policy inconsistency", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AzureWorkload" + }, + "AzureFileShareProtectionPolicy": { + "description": "AzureStorage backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "workLoadType": { + "description": "Type of workload for the backup management", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + }, + "vaultRetentionPolicy": { + "$ref": "#/definitions/VaultRetentionPolicy", + "description": "Retention policy with the details on hardened backup copy retention ranges." + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureStorage" + }, + "AzureIaaSClassicComputeVMProtectedItem": { + "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureIaaSVMProtectedItem" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSComputeVMProtectedItem": { + "description": "IaaS VM workload-specific backup item representing the Azure Resource Manager VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureIaaSVMProtectedItem" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureIaaSVMErrorInfo": { + "description": "Azure IaaS VM workload-specific error information.", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer", + "readOnly": true + }, + "errorTitle": { + "description": "Title: Typically, the entity that the error pertains to.", + "type": "string", + "readOnly": true + }, + "errorString": { + "description": "Localized error string.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ResourceHealthDetails": { + "description": "Health Details for backup items.", + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Health Code", + "type": "integer", + "readOnly": true + }, + "title": { + "description": "Health Title", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Health Message", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "Health Recommended Actions", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "AzureIaaSVMHealthDetails": { + "description": "Azure IaaS VM workload-specific Health Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceHealthDetails" + } + ] + }, + "AzureIaaSVMJob": { + "description": "Azure IaaS VM workload-specific job object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMErrorInfo" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "virtualMachineVersion": { + "description": "Specifies whether the backup item is a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureIaaSVMJobExtendedInfo", + "description": "Additional information for this job." + }, + "containerName": { + "description": "Container name of the entity on which the current job is executing.", + "type": "string" + }, + "isUserTriggered": { + "description": "Indicated that whether the job is adhoc(true) or scheduled(false)", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AzureIaaSVMJob" + }, + "AzureIaaSVMJobV2": { + "description": "Azure IaaS VM workload-specific job object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "containerName": { + "description": "Container name of the entity on which the current job is executing.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMErrorInfo" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "virtualMachineVersion": { + "description": "Specifies whether the backup item is a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureIaaSVMJobExtendedInfo", + "description": "Additional information for this job." + } + }, + "x-ms-discriminator-value": "AzureIaaSVMJobV2" + }, + "AzureIaaSVMJobExtendedInfo": { + "description": "Azure IaaS VM workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks associated with this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMJobTaskDetails" + }, + "x-ms-identifiers": [ + "taskId" + ] + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "internalPropertyBag": { + "description": "Job internal properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "progressPercentage": { + "format": "double", + "description": "Indicates progress of the job. Null if it has not started or completed.", + "type": "number" + }, + "estimatedRemainingDuration": { + "description": "Time remaining for execution of this job.", + "type": "string" + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureIaaSVMJobTaskDetails": { + "description": "Azure IaaS VM workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "instanceId": { + "description": "The instanceId.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + }, + "progressPercentage": { + "format": "double", + "description": "Progress of the task.", + "type": "number" + }, + "taskExecutionDetails": { + "description": "Details about execution of the task.\r\neg: number of bytes transferred etc", + "type": "string" + } + } + }, + "AzureIaaSVMProtectedItem": { + "description": "IaaS VM workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the VM represented by this backup item.", + "type": "string", + "readOnly": true + }, + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine represented by this item.", + "type": "string", + "readOnly": true + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "healthStatus": { + "description": "Health status of protected item.", + "enum": [ + "Passed", + "ActionRequired", + "ActionSuggested", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + }, + "readOnly": true + }, + "healthDetails": { + "description": "Health details on this backup item.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureIaaSVMHealthDetails" + }, + "x-ms-identifiers": [ + "code" + ] + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, + "lastBackupStatus": { + "description": "Last backup operation status.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string", + "readOnly": true + }, + "protectedItemDataId": { + "description": "Data ID of the protected item.", + "type": "string", + "readOnly": true + }, + "extendedInfo": { + "$ref": "#/definitions/AzureIaaSVMProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + }, + "extendedProperties": { + "$ref": "#/definitions/ExtendedProperties" + } + }, + "x-ms-discriminator-value": "AzureIaaSVMProtectedItem" + }, + "AzureIaaSVMProtectedItemExtendedInfo": { + "description": "Additional information on Azure IaaS VM specific backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item across all tiers.", + "type": "string" + }, + "oldestRecoveryPointInVault": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item in vault tier", + "type": "string" + }, + "oldestRecoveryPointInArchive": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item in archive tier", + "type": "string" + }, + "newestRecoveryPointInArchive": { + "format": "date-time", + "description": "The latest backup copy available for this backup item in archive tier", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies available for this backup item.", + "type": "integer" + }, + "policyInconsistent": { + "description": "Specifies if backup policy associated with the backup item is inconsistent.", + "type": "boolean" + } + } + }, + "AzureIaaSVMProtectionPolicy": { + "description": "IaaS VM workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "instantRPDetails": { + "$ref": "#/definitions/InstantRPAdditionalDetails" + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + }, + "tieringPolicy": { + "description": "Tiering policy to automatically move RPs to another tier\r\nKey is Target Tier, defined in RecoveryPointTierType enum.\r\nTiering policy specifies the criteria to move RP to the target tier.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TieringPolicy" + } + }, + "instantRpRetentionRangeInDays": { + "format": "int32", + "description": "Instant RP retention policy range in days", + "type": "integer" + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + }, + "policyType": { + "enum": [ + "Invalid", + "V1", + "V2" + ], + "type": "string", + "x-ms-enum": { + "name": "IAASVMPolicyType", + "modelAsString": true + } + }, + "snapshotConsistencyType": { + "enum": [ + "OnlyCrashConsistent" + ], + "type": "string", + "x-ms-enum": { + "name": "IaasVMSnapshotConsistencyType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureIaasVM" + }, + "AzureSqlProtectedItem": { + "description": "Azure SQL workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "protectedItemDataId": { + "description": "Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of the backed up item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemState", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureSqlProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + } + }, + "x-ms-discriminator-value": "Microsoft.Sql/servers/databases" + }, + "AzureSqlProtectedItemExtendedInfo": { + "description": "Additional information on Azure Sql specific protected item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this item in the service.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of available backup copies associated with this backup item.", + "type": "integer" + }, + "policyState": { + "description": "State of the backup policy associated with this backup item.", + "type": "string" + } + } + }, + "AzureStorageErrorInfo": { + "description": "Azure storage specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AzureSqlProtectionPolicy": { + "description": "Azure SQL workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy details." + } + }, + "x-ms-discriminator-value": "AzureSql" + }, + "AzureStorageJob": { + "description": "Azure storage specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureStorageErrorInfo" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "storageAccountName": { + "description": "Specifies friendly name of the storage account.", + "type": "string" + }, + "storageAccountVersion": { + "description": "Specifies whether the Storage account is a Classic or an Azure Resource Manager Storage account.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureStorageJobExtendedInfo", + "description": "Additional information about the job." + }, + "isUserTriggered": { + "description": "Indicated that whether the job is adhoc(true) or scheduled(false)", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AzureStorageJob" + }, + "AzureStorageJobExtendedInfo": { + "description": "Azure Storage workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job", + "type": "array", + "items": { + "$ref": "#/definitions/AzureStorageJobTaskDetails" + }, + "x-ms-identifiers": [ + "taskId" + ] + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureStorageJobTaskDetails": { + "description": "Azure storage workload specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "AzureVmWorkloadProtectedItem": { + "description": "Azure VM workload-specific protected item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the DB represented by this backup item.", + "type": "string", + "readOnly": true + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "parentName": { + "description": "Parent name of the DB such as Instance or Availability Group.", + "type": "string" + }, + "parentType": { + "description": "Parent type of protected item, example: for a DB, standalone server or distributed", + "type": "string" + }, + "protectionStatus": { + "description": "Backup status of this backup item.", + "type": "string", + "readOnly": true + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "lastBackupStatus": { + "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "LastBackupStatus", + "modelAsString": true + } + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "lastBackupErrorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error details in last backup" + }, + "protectedItemDataSourceId": { + "description": "Data ID of the protected item.", + "type": "string" + }, + "protectedItemHealthStatus": { + "description": "Health status of the backup item, evaluated based on last heartbeat received", + "enum": [ + "Invalid", + "Healthy", + "Unhealthy", + "NotReachable", + "IRPending" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemHealthStatus", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", + "description": "Additional information for this backup item." + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, + "nodesList": { + "description": "List of the nodes in case of distributed container.", + "type": "array", + "items": { + "$ref": "#/definitions/DistributedNodesInfo" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectedItem" + }, + "AzureVmWorkloadProtectedItemExtendedInfo": { + "description": "Additional information on Azure Workload for SQL specific backup item.", + "type": "object", + "properties": { + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item across all tiers.", + "type": "string" + }, + "oldestRecoveryPointInVault": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item in vault tier", + "type": "string" + }, + "oldestRecoveryPointInArchive": { + "format": "date-time", + "description": "The oldest backup copy available for this backup item in archive tier", + "type": "string" + }, + "newestRecoveryPointInArchive": { + "format": "date-time", + "description": "The latest backup copy available for this backup item in archive tier", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies available for this backup item.", + "type": "integer" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + }, + "recoveryModel": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + } + } + }, + "AzureVmWorkloadSAPAseDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPAseDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaDBInstanceProtectedItem": { + "description": "Azure VM workload-specific protected item representing SAP HANA DBInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSAPHanaDBInstance" + }, + "AzureVmWorkloadSQLDatabaseProtectedItem": { + "description": "Azure VM workload-specific protected item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectedItem" + } + ], + "x-ms-discriminator-value": "AzureVmWorkloadSQLDatabase" + }, + "AzureWorkloadErrorInfo": { + "description": "Azure storage specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "errorTitle": { + "description": "Title: Typically, the entity that the error pertains to.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalDetails": { + "description": "Additional details for above error code.", + "type": "string" + } + } + }, + "AzureWorkloadJob": { + "description": "Azure storage specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "workloadType": { + "description": "Workload type of the job", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureWorkloadErrorInfo" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadJobExtendedInfo", + "description": "Additional information about the job." + } + }, + "x-ms-discriminator-value": "AzureWorkloadJob" + }, + "AzureWorkloadJobExtendedInfo": { + "description": "Azure VM workload-specific additional information for job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job", + "type": "array", + "items": { + "$ref": "#/definitions/AzureWorkloadJobTaskDetails" + }, + "x-ms-identifiers": [ + "taskId" + ] + }, + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "AzureWorkloadJobTaskDetails": { + "description": "Azure VM workload specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "AzureWorkloadPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRecoveryPoint" + }, + "AzureWorkloadPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadPointInTimeRestoreRequest" + }, + "AzureWorkloadRecoveryPoint": { + "description": "Workload specific recovery point, specifically encapsulates full/diff recovery point", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointTimeInUTC": { + "format": "date-time", + "description": "UTC time at which recovery point was created", + "type": "string" + }, + "type": { + "description": "Type of restore point", + "enum": [ + "Invalid", + "Full", + "Log", + "Differential", + "Incremental", + "SnapshotFull", + "SnapshotCopyOnlyFull" + ], + "type": "string", + "x-ms-enum": { + "name": "RestorePointType", + "modelAsString": true + } + }, + "recoveryPointTierDetails": { + "description": "Recovery point tier information.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointTierInformationV2" + }, + "x-ms-identifiers": [] + }, + "recoveryPointMoveReadinessInfo": { + "description": "Eligibility of RP to be moved to another tier", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RecoveryPointMoveReadinessInfo" + } + }, + "recoveryPointProperties": { + "description": "Properties of Recovery Point", + "$ref": "#/definitions/RecoveryPointProperties" + } + }, + "x-ms-discriminator-value": "AzureWorkloadRecoveryPoint" + }, + "AzureWorkloadRestoreRequest": { + "description": "AzureWorkload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM on which workload that was running is being recovered.", + "type": "string" + }, + "propertyBag": { + "description": "Workload specific property bag.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "targetInfo": { + "$ref": "#/definitions/TargetRestoreInfo", + "description": "Details of target database" + }, + "recoveryMode": { + "description": "Defines whether the current recovery mode is file restore or database restore", + "enum": [ + "Invalid", + "FileRecovery", + "WorkloadRecovery", + "SnapshotAttach", + "RecoveryUsingSnapshot", + "SnapshotAttachAndRecover" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryMode", + "modelAsString": true + } + }, + "targetResourceGroupName": { + "description": "Defines the Resource group of the Target VM", + "type": "string" + }, + "userAssignedManagedIdentityDetails": { + "$ref": "#/definitions/UserAssignedManagedIdentityDetails", + "description": "User Assigned managed identity details\r\nCurrently used for snapshot." + }, + "snapshotRestoreParameters": { + "$ref": "#/definitions/SnapshotRestoreParameters", + "description": "Additional details for snapshot recovery\r\nCurrently used for snapshot for SAP Hana." + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the target VM\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadRestoreRequest" + }, + "AzureWorkloadSAPHanaPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime in SAPHana", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadPointInTimeRecoveryPoint" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRecoveryPoint" + }, + "AzureWorkloadSAPHanaPointInTimeRestoreRequest": { + "description": "AzureWorkload SAP Hana -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" + }, + "AzureWorkloadSAPHanaRecoveryPoint": { + "description": "SAPHana specific recoverypoint, specifically encapsulates full/diff recoverypoints", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRecoveryPoint" + }, + "AzureWorkloadSAPHanaRestoreRequest": { + "description": "AzureWorkload SAP Hana-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreRequest" + }, + "AzureWorkloadSQLPointInTimeRecoveryPoint": { + "description": "Recovery point specific to PointInTime", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRecoveryPoint" + } + ], + "properties": { + "timeRanges": { + "description": "List of log ranges", + "type": "array", + "items": { + "$ref": "#/definitions/PointInTimeRange" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRecoveryPoint" + }, + "AzureWorkloadSQLPointInTimeRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for PointInTime/Log restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "pointInTime": { + "format": "date-time", + "description": "PointInTime value", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreRequest" + }, + "AzureWorkloadSQLRecoveryPoint": { + "description": "SQL specific recoverypoint, specifically encapsulates full/diff recoverypoint along with extended info", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRecoveryPoint" + } + ], + "properties": { + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadSQLRecoveryPointExtendedInfo", + "description": "Extended Info that provides data directory details. Will be populated in two cases:\r\nWhen a specific recovery point is accessed using GetRecoveryPoint\r\nOr when ListRecoveryPoints is called for Log RP only with ExtendedInfo query filter" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRecoveryPoint" + }, + "AzureWorkloadSQLRecoveryPointExtendedInfo": { + "description": "Extended info class details", + "type": "object", + "properties": { + "dataDirectoryTimeInUTC": { + "format": "date-time", + "description": "UTC time at which data directory info was captured", + "type": "string" + }, + "dataDirectoryPaths": { + "description": "List of data directory paths during restore operation.", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectory" + }, + "x-ms-identifiers": [] + } + } + }, + "AzureWorkloadSQLRestoreRequest": { + "description": "AzureWorkload SQL -specific restore. Specifically for full/diff restore", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadRestoreRequest" + } + ], + "properties": { + "shouldUseAlternateTargetLocation": { + "description": "Default option set to true. If this is set to false, alternate data directory must be provided", + "type": "boolean" + }, + "isNonRecoverable": { + "description": "SQL specific property where user can chose to set no-recovery when restore operation is tried", + "type": "boolean" + }, + "alternateDirectoryPaths": { + "description": "Data directory details", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectoryMapping" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreRequest" + }, + "BEKDetails": { + "description": "BEK is bitlocker encryption key.", + "type": "object", + "properties": { + "secretUrl": { + "description": "Secret is BEK.", + "type": "string" + }, + "secretVaultId": { + "description": "ID of the Key Vault where this Secret is stored.", + "type": "string" + }, + "secretData": { + "description": "BEK data.", + "type": "string" + } + } + }, + "BMSRPQueryObject": { + "description": "Filters to list backup copies.", + "type": "object", + "properties": { + "startDate": { + "format": "date-time", + "description": "Backup copies created after this time.", + "type": "string" + }, + "endDate": { + "format": "date-time", + "description": "Backup copies created before this time.", + "type": "string" + }, + "restorePointQueryType": { + "description": "RestorePoint type", + "enum": [ + "Invalid", + "Full", + "Log", + "Differential", + "FullAndDifferential", + "All", + "Incremental", + "SnapshotFull", + "SnapshotCopyOnlyFull" + ], + "type": "string", + "x-ms-enum": { + "name": "RestorePointQueryType", + "modelAsString": true + } + }, + "extendedInfo": { + "description": "In Get Recovery Point, it tells whether extended information about recovery point is asked.", + "type": "boolean" + }, + "moveReadyRPOnly": { + "description": "Whether the RP can be moved to another tier", + "type": "boolean" + }, + "includeSoftDeletedRP": { + "description": "Flag to indicate whether Soft Deleted RPs should be included/excluded from result.", + "type": "boolean" + } + } + }, + "DiskExclusionProperties": { + "type": "object", + "properties": { + "diskLunList": { + "description": "List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "isInclusionList": { + "description": "Flag to indicate whether DiskLunList is to be included/ excluded from backup.", + "type": "boolean" + } + } + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + } + } + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "type": "object", + "properties": { + "name": { + "description": "Name for shoebox log specification.", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "blobDuration": { + "description": "blob duration of shoebox log specification", + "type": "string" + } + } + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + } + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "type": "object", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + }, + "x-ms-identifiers": [] + } + } + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "type": "object", + "properties": { + "value": { + "description": "List of available operations.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next chunk of Response.", + "type": "string" + } + } + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "ShoeBox properties for the given operation." + } + } + }, + "DiskInformation": { + "description": "Disk information", + "type": "object", + "properties": { + "lun": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + } + } + }, + "DailyRetentionFormat": { + "description": "Daily retention format.", + "type": "object", + "properties": { + "daysOfTheMonth": { + "description": "List of days of the month.", + "type": "array", + "items": { + "$ref": "#/definitions/Day" + }, + "x-ms-identifiers": [] + } + } + }, + "DailyRetentionSchedule": { + "description": "Daily retention schedule.", + "type": "object", + "properties": { + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "Day": { + "description": "Day of the week.", + "type": "object", + "properties": { + "date": { + "format": "int32", + "description": "Date of the month", + "type": "integer" + }, + "isLast": { + "description": "Whether Date is last date of month", + "type": "boolean" + } + } + }, + "DpmErrorInfo": { + "description": "DPM workload-specific error information.", + "type": "object", + "properties": { + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DpmJob": { + "description": "DPM workload-specific job object.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed for job.", + "type": "string" + }, + "dpmServerName": { + "description": "DPM server name managing the backup item or backup job.", + "type": "string" + }, + "containerName": { + "description": "Name of cluster/server protecting current backup item, if any.", + "type": "string" + }, + "containerType": { + "description": "Type of container.", + "type": "string" + }, + "workloadType": { + "description": "Type of backup item.", + "type": "string" + }, + "actionsInfo": { + "description": "The state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/DpmErrorInfo" + }, + "x-ms-identifiers": [] + }, + "extendedInfo": { + "$ref": "#/definitions/DpmJobExtendedInfo", + "description": "Additional information for this job." + } + }, + "x-ms-discriminator-value": "DpmJob" + }, + "BackupResourceConfigResource": { + "description": "The resource storage details.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceConfig", + "description": "BackupResourceConfigResource properties" + } + } + }, + "BackupResourceConfig": { + "description": "The resource storage details.", + "type": "object", + "properties": { + "storageModelType": { + "description": "Storage type", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageTypeState": { + "description": "Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.", + "enum": [ + "Invalid", + "Locked", + "Unlocked" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageTypeState", + "modelAsString": true + } + }, + "crossRegionRestoreFlag": { + "description": "Opt in details of Cross Region Restore feature.", + "type": "boolean" + }, + "dedupState": { + "description": "Vault Dedup state", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "dedupState", + "modelAsString": true + } + }, + "xcoolState": { + "description": "Vault x-cool state", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "xcoolState", + "modelAsString": true + } + } + } + }, + "DpmJobExtendedInfo": { + "description": "Additional information on the DPM workload-specific job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks associated with this job.", + "type": "array", + "items": { + "$ref": "#/definitions/DpmJobTaskDetails" + }, + "x-ms-identifiers": [ + "taskId" + ] + }, + "propertyBag": { + "description": "The job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message on job execution.", + "type": "string" + } + } + }, + "DpmJobTaskDetails": { + "description": "DPM workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "DPMProtectedItem": { + "description": "Additional information on Backup engine specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the managed item", + "type": "string" + }, + "backupEngineName": { + "description": "Backup Management server protecting this backup item", + "type": "string" + }, + "protectionState": { + "description": "Protection state of the backup engine", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectedItemState", + "modelAsString": true + } + }, + "extendedInfo": { + "$ref": "#/definitions/DPMProtectedItemExtendedInfo", + "description": "Extended info of the backup item." + } + }, + "x-ms-discriminator-value": "DPMProtectedItem" + }, + "DPMProtectedItemExtendedInfo": { + "description": "Additional information of DPM Protected item.", + "type": "object", + "properties": { + "protectableObjectLoadPath": { + "description": "Attribute to provide information on various DBs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "protected": { + "description": "To check if backup item is disk protected.", + "type": "boolean" + }, + "isPresentOnCloud": { + "description": "To check if backup item is cloud protected.", + "type": "boolean" + }, + "lastBackupStatus": { + "description": "Last backup status information on backup item.", + "type": "string" + }, + "lastRefreshedAt": { + "format": "date-time", + "description": "Last refresh time on backup item.", + "type": "string" + }, + "oldestRecoveryPoint": { + "format": "date-time", + "description": "Oldest cloud recovery point time.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "cloud recovery point count.", + "type": "integer" + }, + "onPremiseOldestRecoveryPoint": { + "format": "date-time", + "description": "Oldest disk recovery point time.", + "type": "string" + }, + "onPremiseLatestRecoveryPoint": { + "format": "date-time", + "description": "latest disk recovery point time.", + "type": "string" + }, + "onPremiseRecoveryPointCount": { + "format": "int32", + "description": "disk recovery point count.", + "type": "integer" + }, + "isCollocated": { + "description": "To check if backup item is collocated.", + "type": "boolean" + }, + "protectionGroupName": { + "description": "Protection group name of the backup item.", + "type": "string" + }, + "diskStorageUsedInBytes": { + "description": "Used Disk storage in bytes.", + "type": "string" + }, + "totalDiskStorageSizeInBytes": { + "description": "total Disk storage in bytes.", + "type": "string" + } + } + }, + "EncryptionDetails": { + "description": "Details needed if the VM was encrypted at the time of backup.", + "type": "object", + "properties": { + "encryptionEnabled": { + "description": "Identifies whether this backup copy represents an encrypted VM at the time of backup.", + "type": "boolean" + }, + "kekUrl": { + "description": "Key Url.", + "type": "string" + }, + "secretKeyUrl": { + "description": "Secret Url.", + "type": "string" + }, + "kekVaultId": { + "description": "ID of Key Vault where KEK is stored.", + "type": "string" + }, + "secretKeyVaultId": { + "description": "ID of Key Vault where Secret is stored.", + "type": "string" + } + } + }, + "ErrorDetail": { + "description": "Error Detail class which encapsulates Code, Message and Recommendations.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error Message related to the Code.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of recommendation strings.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ExportJobsOperationResultInfo": { + "description": "This class is used to send blob details after exporting jobs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationResultInfoBase" + } + ], + "properties": { + "blobUrl": { + "description": "URL of the blob into which the serialized string of list of jobs is exported.", + "type": "string" + }, + "blobSasKey": { + "description": "SAS key to access the blob. It expires in 15 mins.", + "type": "string" + }, + "excelFileBlobUrl": { + "description": "URL of the blob into which the ExcelFile is uploaded.", + "type": "string" + }, + "excelFileBlobSasKey": { + "description": "SAS key to access the blob. It expires in 15 mins.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExportJobsOperationResultInfo" + }, + "ExtendedProperties": { + "description": "Extended Properties for Azure IaasVM Backup.", + "type": "object", + "properties": { + "diskExclusionProperties": { + "$ref": "#/definitions/DiskExclusionProperties", + "description": "Extended Properties for Disk Exclusion." + }, + "linuxVmApplicationName": { + "description": "Linux VM name", + "type": "string" + } + } + }, + "GenericProtectionPolicy": { + "description": "Azure VM (Mercury) workload-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "subProtectionPolicy": { + "description": "List of sub-protection policies which includes schedule and retention", + "type": "array", + "items": { + "$ref": "#/definitions/SubProtectionPolicy" + }, + "x-ms-identifiers": [] + }, + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + }, + "fabricName": { + "description": "Name of this policy's fabric.", + "type": "string" + } + }, + "x-ms-discriminator-value": "GenericProtectionPolicy" + }, + "HourlySchedule": { + "type": "object", + "properties": { + "interval": { + "format": "int32", + "description": "Interval at which backup needs to be triggered. For hourly the value\r\n can be 4/6/8/12", + "type": "integer" + }, + "scheduleWindowStartTime": { + "format": "date-time", + "description": "To specify start time of the backup window", + "type": "string" + }, + "scheduleWindowDuration": { + "format": "int32", + "description": "To specify duration of the backup window", + "type": "integer" + } + } + }, + "DailySchedule": { + "type": "object", + "properties": { + "scheduleRunTimes": { + "description": "List of times of day this schedule has to be run.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + } + } + }, + "WeeklySchedule": { + "type": "object", + "properties": { + "scheduleRunDays": { + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "scheduleRunTimes": { + "description": "List of times of day this schedule has to be run.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + } + } + }, + "IdentityBasedRestoreDetails": { + "description": "IaaS VM workload specific restore details for restores using managed identity", + "type": "object", + "properties": { + "objectType": { + "description": "Gets the class type.", + "type": "string" + }, + "targetStorageAccountId": { + "description": "Fully qualified ARM ID of the target storage account.", + "type": "string" + } + } + }, + "IdentityInfo": { + "description": "Encapsulates Managed Identity related information", + "type": "object", + "properties": { + "isSystemAssignedIdentity": { + "description": "To differentiate if the managed identity is system assigned or user assigned", + "type": "boolean" + }, + "managedIdentityResourceId": { + "description": "Managed Identity Resource Id\r\nOptional: Might not be required in the case of system assigned managed identity", + "type": "string" + } + } + }, + "InstantRPAdditionalDetails": { + "type": "object", + "properties": { + "azureBackupRGNamePrefix": { + "type": "string" + }, + "azureBackupRGNameSuffix": { + "type": "string" + } + } + }, + "GenericProtectedItem": { + "description": "Base class for backup items.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "policyState": { + "description": "Indicates consistency of policy object and policy applied to this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "IRPending", + "Protected", + "ProtectionError", + "ProtectionStopped", + "ProtectionPaused", + "BackupsSuspended" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionState", + "modelAsString": true + } + }, + "protectedItemId": { + "format": "int64", + "description": "Data Plane Service ID of the protected item.", + "type": "integer" + }, + "sourceAssociations": { + "description": "Loosely coupled (type, value) associations (example - parent of a protected item)", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "fabricName": { + "description": "Name of this backup item's fabric.", + "type": "string" + } + }, + "x-ms-discriminator-value": "GenericProtectedItem" + }, + "GenericRecoveryPoint": { + "description": "Generic backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the backup copy.", + "type": "string" + }, + "recoveryPointType": { + "description": "Type of the backup copy.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "recoveryPointAdditionalInfo": { + "description": "Additional information associated with this backup copy.", + "type": "string" + }, + "recoveryPointProperties": { + "description": "Properties of Recovery Point", + "$ref": "#/definitions/RecoveryPointProperties" + } + }, + "x-ms-discriminator-value": "GenericRecoveryPoint" + }, + "GetProtectedItemQueryObject": { + "description": "Filters to list backup items.", + "type": "object", + "properties": { + "expand": { + "description": "Specifies if the additional information should be provided for this item.", + "type": "string" + } + } + }, + "IaasVMRecoveryPoint": { + "description": "IaaS VM workload specific backup copy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPoint" + } + ], + "properties": { + "recoveryPointType": { + "description": "Type of the backup copy.", + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "description": "Time at which this backup copy was created.", + "type": "string" + }, + "recoveryPointAdditionalInfo": { + "description": "Additional information associated with this backup copy.", + "type": "string" + }, + "sourceVMStorageType": { + "description": "Storage type of the VM whose backup copy is created.", + "type": "string" + }, + "isSourceVMEncrypted": { + "description": "Identifies whether the VM was encrypted when the backup copy is created.", + "type": "boolean" + }, + "keyAndSecret": { + "$ref": "#/definitions/KeyAndSecretDetails", + "description": "Required details for recovering an encrypted VM. Applicable only when IsSourceVMEncrypted is true." + }, + "isInstantIlrSessionActive": { + "description": "Is the session to recover items from this backup copy still active.", + "type": "boolean" + }, + "recoveryPointTierDetails": { + "description": "Recovery point tier information.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointTierInformationV2" + }, + "x-ms-identifiers": [] + }, + "isManagedVirtualMachine": { + "description": "Whether VM is with Managed Disks", + "type": "boolean" + }, + "virtualMachineSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "osType": { + "description": "OS type", + "type": "string" + }, + "recoveryPointDiskConfiguration": { + "$ref": "#/definitions/RecoveryPointDiskConfiguration", + "description": "Disk configuration" + }, + "zones": { + "description": "Identifies the zone of the VM at the time of backup. Applicable only for zone-pinned Vms", + "type": "array", + "items": { + "type": "string" + } + }, + "recoveryPointMoveReadinessInfo": { + "description": "Eligibility of RP to be moved to another tier", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RecoveryPointMoveReadinessInfo" + } + }, + "securityType": { + "description": "Security Type of the Disk", + "type": "string" + }, + "recoveryPointProperties": { + "description": "Properties of Recovery Point", + "$ref": "#/definitions/RecoveryPointProperties" + }, + "isPrivateAccessEnabledOnAnyDisk": { + "description": "This flag denotes if any of the disks in the VM are using Private access network setting", + "type": "boolean" + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Extended location of the VM recovery point,\r\nshould be null if VM is in public cloud" + } + }, + "x-ms-discriminator-value": "IaasVMRecoveryPoint" + }, + "ExtendedLocation": { + "description": "The extended location of Recovery point where VM was present.", + "type": "object", + "properties": { + "name": { + "description": "Name of the extended location.", + "type": "string" + }, + "type": { + "description": "Type of the extended location. Possible values include: 'EdgeZone'", + "type": "string" + } + } + }, + "SecuredVMDetails": { + "description": "Restore request parameters for Secured VMs", + "type": "object", + "properties": { + "securedVMOsDiskEncryptionSetId": { + "description": "Gets or Sets Disk Encryption Set Id for Secured VM OS Disk", + "type": "string" + } + } + }, + "TargetDiskNetworkAccessSettings": { + "description": "Specifies target network access settings for disks of VM to be restored.", + "type": "object", + "properties": { + "targetDiskNetworkAccessOption": { + "description": "Network access settings to be used for restored disks", + "enum": [ + "SameAsOnSourceDisks", + "EnablePrivateAccessForAllDisks", + "EnablePublicAccessForAllDisks" + ], + "type": "string", + "x-ms-enum": { + "name": "TargetDiskNetworkAccessOption" + } + }, + "targetDiskAccessId": { + "description": "Gets or sets the ARM resource ID of the target disk access to be used when TargetDiskNetworkAccessOption is set to TargetDiskNetworkAccessOption.UseNew", + "type": "string" + } + } + }, + "IaasVMRestoreRequest": { + "description": "IaaS VM workload-specific restore.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the backup copy to be recovered.", + "type": "string" + }, + "recoveryType": { + "description": "Type of this recovery.", + "enum": [ + "Invalid", + "OriginalLocation", + "AlternateLocation", + "RestoreDisks", + "Offline" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "Fully qualified ARM ID of the VM which is being recovered.", + "type": "string" + }, + "targetVirtualMachineId": { + "description": "This is the complete ARM Id of the VM that will be created.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}/provider/Microsoft.Compute/virtualmachines/{vm}", + "type": "string" + }, + "targetResourceGroupId": { + "description": "This is the ARM Id of the resource group that you want to create for this Virtual machine and other artifacts.\r\nFor e.g. /subscriptions/{subId}/resourcegroups/{rg}", + "type": "string" + }, + "storageAccountId": { + "description": "Fully qualified ARM ID of the storage account to which the VM has to be restored.", + "type": "string" + }, + "virtualNetworkId": { + "description": "This is the virtual network Id of the vnet that will be attached to the virtual machine.\r\nUser will be validated for join action permissions in the linked access.", + "type": "string" + }, + "subnetId": { + "description": "Subnet ID, is the subnet ID associated with the to be restored VM. For Classic VMs it would be\r\n{VnetID}/Subnet/{SubnetName} and, for the Azure Resource Manager VMs it would be ARM resource ID used to represent\r\nthe subnet.", + "type": "string" + }, + "targetDomainNameId": { + "description": "Fully qualified ARM ID of the domain name to be associated to the VM being restored. This applies only to Classic\r\nVirtual Machines.", + "type": "string" + }, + "region": { + "description": "Region in which the virtual machine is restored.", + "type": "string" + }, + "affinityGroup": { + "description": "Affinity group associated to VM to be restored. Used only for Classic Compute Virtual Machines.", + "type": "string" + }, + "createNewCloudService": { + "description": "Should a new cloud service be created while restoring the VM. If this is false, VM will be restored to the same\r\ncloud service as it was at the time of backup.", + "type": "boolean" + }, + "originalStorageAccountOption": { + "description": "Original Storage Account Option", + "type": "boolean" + }, + "encryptionDetails": { + "$ref": "#/definitions/EncryptionDetails", + "description": "Details needed if the VM was encrypted at the time of backup." + }, + "restoreDiskLunList": { + "description": "List of Disk LUNs for partial restore", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "restoreWithManagedDisks": { + "description": "Flag to denote of an Unmanaged disk VM should be restored with Managed disks.", + "type": "boolean" + }, + "diskEncryptionSetId": { + "description": "DiskEncryptionSet's ID - needed if the VM needs to be encrypted at rest during restore with customer managed key.", + "type": "string" + }, + "zones": { + "description": "Target zone where the VM and its disks should be restored.", + "type": "array", + "items": { + "type": "string" + } + }, + "identityInfo": { + "$ref": "#/definitions/IdentityInfo", + "description": "Managed Identity information required to access customer storage account." + }, + "identityBasedRestoreDetails": { + "$ref": "#/definitions/IdentityBasedRestoreDetails", + "description": "IaaS VM workload specific restore details for restores using managed identity." + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "Target extended location where the VM should be restored,\r\nshould be null if restore is to be done in public cloud" + }, + "securedVMDetails": { + "$ref": "#/definitions/SecuredVMDetails", + "description": "Stores Secured VM Details" + }, + "targetDiskNetworkAccessSettings": { + "$ref": "#/definitions/TargetDiskNetworkAccessSettings", + "description": "Specifies target network access settings for disks of VM to be restored," + } + }, + "x-ms-discriminator-value": "IaasVMRestoreRequest" + }, + "Job": { + "description": "Defines workload agnostic properties for a job.", + "required": [ + "jobType" + ], + "type": "object", + "properties": { + "entityFriendlyName": { + "description": "Friendly name of the entity on which the current job is executing.", + "type": "string" + }, + "backupManagementType": { + "description": "Backup management type to execute the current job.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "operation": { + "description": "The operation name.", + "type": "string" + }, + "status": { + "description": "Job status.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "activityId": { + "description": "ActivityId of job.", + "type": "string" + }, + "jobType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "jobType" + }, + "JobQueryObject": { + "description": "Filters to list the jobs.", + "type": "object", + "properties": { + "status": { + "description": "Status of the job.", + "enum": [ + "Invalid", + "InProgress", + "Completed", + "Failed", + "CompletedWithWarnings", + "Cancelled", + "Cancelling" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "backupManagementType": { + "description": "Type of backup management for the job.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "operation": { + "description": "Type of operation.", + "enum": [ + "Invalid", + "Register", + "UnRegister", + "ConfigureBackup", + "Backup", + "Restore", + "DisableBackup", + "DeleteBackupData", + "CrossRegionRestore", + "Undelete", + "UpdateCustomerManagedKey" + ], + "type": "string", + "x-ms-enum": { + "name": "JobOperationType", + "modelAsString": true + } + }, + "jobId": { + "description": "JobID represents the job uniquely.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "Job has started at this time. Value is in UTC.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Job has ended at this time. Value is in UTC.", + "type": "string" + } + } + }, + "JobResource": { + "description": "Defines workload agnostic properties for a job.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/Job", + "description": "JobResource properties" + } + } + }, + "JobResourceList": { + "description": "List of Job resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResource" + } + } + } + }, + "KEKDetails": { + "description": "KEK is encryption key for BEK.", + "type": "object", + "properties": { + "keyUrl": { + "description": "Key is KEK.", + "type": "string" + }, + "keyVaultId": { + "description": "Key Vault ID where this Key is stored.", + "type": "string" + }, + "keyBackupData": { + "description": "KEK data.", + "type": "string" + } + } + }, + "KeyAndSecretDetails": { + "description": "BEK is bitlocker key.\r\nKEK is encryption key for BEK\r\nIf the VM was encrypted then we will store following details :\r\n1. Secret(BEK) - Url + Backup Data + vaultId.\r\n2. Key(KEK) - Url + Backup Data + vaultId.\r\n3. EncryptionMechanism\r\nBEK and KEK can potentially have different vault ids.", + "type": "object", + "properties": { + "kekDetails": { + "$ref": "#/definitions/KEKDetails", + "description": "KEK is encryption key for BEK." + }, + "bekDetails": { + "$ref": "#/definitions/BEKDetails", + "description": "BEK is bitlocker encryption key." + }, + "encryptionMechanism": { + "description": "Encryption mechanism: None/ SinglePass/ DoublePass", + "type": "string" + } + } + }, + "LogSchedulePolicy": { + "description": "Log policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "properties": { + "scheduleFrequencyInMins": { + "format": "int32", + "description": "Frequency of the log schedule operation of this policy in minutes.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "LogSchedulePolicy" + }, + "LongTermRetentionPolicy": { + "description": "Long term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RetentionPolicy" + } + ], + "properties": { + "dailySchedule": { + "$ref": "#/definitions/DailyRetentionSchedule", + "description": "Daily retention schedule of the protection policy." + }, + "weeklySchedule": { + "$ref": "#/definitions/WeeklyRetentionSchedule", + "description": "Weekly retention schedule of the protection policy." + }, + "monthlySchedule": { + "$ref": "#/definitions/MonthlyRetentionSchedule", + "description": "Monthly retention schedule of the protection policy." + }, + "yearlySchedule": { + "$ref": "#/definitions/YearlyRetentionSchedule", + "description": "Yearly retention schedule of the protection policy." + } + }, + "x-ms-discriminator-value": "LongTermRetentionPolicy" + }, + "LongTermSchedulePolicy": { + "description": "Long term policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "x-ms-discriminator-value": "LongTermSchedulePolicy" + }, + "MabErrorInfo": { + "description": "MAB workload-specific error information.", + "type": "object", + "properties": { + "errorString": { + "description": "Localized error string.", + "type": "string", + "readOnly": true + }, + "recommendations": { + "description": "List of localized recommendations.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "MabFileFolderProtectedItem": { + "description": "MAB workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectedItem" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of this backup item.", + "type": "string" + }, + "computerName": { + "description": "Name of the computer associated with this backup item.", + "type": "string" + }, + "lastBackupStatus": { + "description": "Status of last backup operation.", + "type": "string" + }, + "lastBackupTime": { + "format": "date-time", + "description": "Timestamp of the last backup operation on this backup item.", + "type": "string" + }, + "protectionState": { + "description": "Protected, ProtectionStopped, IRPending or ProtectionError", + "type": "string" + }, + "deferredDeleteSyncTimeInUTC": { + "format": "int64", + "description": "Sync time for deferred deletion in UTC", + "type": "integer" + }, + "extendedInfo": { + "$ref": "#/definitions/MabFileFolderProtectedItemExtendedInfo", + "description": "Additional information with this backup item." + } + }, + "x-ms-discriminator-value": "MabFileFolderProtectedItem" + }, + "MabFileFolderProtectedItemExtendedInfo": { + "description": "Additional information on the backed up item.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Last time when the agent data synced to service.", + "type": "string" + }, + "oldestRecoveryPoint": { + "format": "date-time", + "description": "The oldest backup copy available.", + "type": "string" + }, + "recoveryPointCount": { + "format": "int32", + "description": "Number of backup copies associated with the backup item.", + "type": "integer" + } + } + }, + "MabJob": { + "description": "MAB workload-specific job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time taken by job to run.", + "type": "string" + }, + "actionsInfo": { + "description": "The state/actions applicable on jobs like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "mabServerName": { + "description": "Name of server protecting the DS.", + "type": "string" + }, + "mabServerType": { + "description": "Server type of MAB container.", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "MabServerType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type of backup item.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "errorDetails": { + "description": "The errors.", + "type": "array", + "items": { + "$ref": "#/definitions/MabErrorInfo" + }, + "x-ms-identifiers": [] + }, + "extendedInfo": { + "$ref": "#/definitions/MabJobExtendedInfo", + "description": "Additional information on the job." + } + }, + "x-ms-discriminator-value": "MabJob" + }, + "MabJobExtendedInfo": { + "description": "Additional information for the MAB workload-specific job.", + "type": "object", + "properties": { + "tasksList": { + "description": "List of tasks for this job.", + "type": "array", + "items": { + "$ref": "#/definitions/MabJobTaskDetails" + }, + "x-ms-identifiers": [ + "taskId" + ] + }, + "propertyBag": { + "description": "The job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "dynamicErrorMessage": { + "description": "Non localized error message specific to this job.", + "type": "string" + } + } + }, + "MabJobTaskDetails": { + "description": "MAB workload-specific job task details.", + "type": "object", + "properties": { + "taskId": { + "description": "The task display name.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "The end time.", + "type": "string" + }, + "duration": { + "format": "duration", + "description": "Time elapsed for task.", + "type": "string" + }, + "status": { + "description": "The status.", + "type": "string" + } + } + }, + "MabProtectionPolicy": { + "description": "Mab container-specific backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionPolicy" + } + ], + "properties": { + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy details." + } + }, + "x-ms-discriminator-value": "MAB" + }, + "MonthlyRetentionSchedule": { + "description": "Monthly retention schedule.", + "type": "object", + "properties": { + "retentionScheduleFormatType": { + "description": "Retention schedule format type for monthly retention policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionScheduleFormat", + "modelAsString": true + } + }, + "retentionScheduleDaily": { + "$ref": "#/definitions/DailyRetentionFormat", + "description": "Daily retention format for monthly retention policy." + }, + "retentionScheduleWeekly": { + "$ref": "#/definitions/WeeklyRetentionFormat", + "description": "Weekly retention format for monthly retention policy." + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "OperationResultInfo": { + "description": "Operation result info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationResultInfoBase" + } + ], + "properties": { + "jobList": { + "description": "List of jobs created by this operation.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "OperationResultInfo" + }, + "OperationResultInfoBase": { + "description": "Base class for operation result info.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "KPIResourceHealthDetails": { + "description": "KPI Resource Health Details", + "type": "object", + "properties": { + "resourceHealthStatus": { + "description": "Resource Health Status", + "enum": [ + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceHealthStatus", + "modelAsString": true + } + }, + "resourceHealthDetails": { + "description": "Resource Health Status", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceHealthDetails" + }, + "x-ms-identifiers": [ + "code" + ] + } + } + }, + "PrepareDataMoveRequest": { + "description": "Prepare DataMove Request", + "required": [ + "targetResourceId", + "targetRegion", + "dataMoveLevel" + ], + "type": "object", + "properties": { + "targetResourceId": { + "description": "ARM Id of target vault", + "type": "string" + }, + "targetRegion": { + "description": "Target Region", + "type": "string" + }, + "dataMoveLevel": { + "description": "DataMove Level", + "enum": [ + "Invalid", + "Vault", + "Container" + ], + "type": "string", + "x-ms-enum": { + "name": "DataMoveLevel", + "modelAsString": true + } + }, + "sourceContainerArmIds": { + "description": "Source Container ArmIds\r\nThis needs to be populated only if DataMoveLevel is set to container", + "type": "array", + "items": { + "type": "string" + } + }, + "ignoreMoved": { + "description": "Ignore the artifacts which are already moved.", + "type": "boolean" + } + } + }, + "PrepareDataMoveResponse": { + "description": "Prepare DataMove Response", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/VaultStorageConfigOperationResultResponse" + } + ], + "properties": { + "correlationId": { + "description": "Co-relationId for move operation", + "type": "string" + }, + "sourceVaultProperties": { + "description": "Source Vault Properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "PrepareDataMoveResponse" + }, + "VaultStorageConfigOperationResultResponse": { + "description": "Operation result response for Vault Storage Config", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "TriggerDataMoveRequest": { + "description": "Trigger DataMove Request", + "required": [ + "sourceResourceId", + "sourceRegion", + "dataMoveLevel", + "correlationId" + ], + "type": "object", + "properties": { + "sourceResourceId": { + "description": "ARM Id of source vault", + "type": "string" + }, + "sourceRegion": { + "description": "Source Region", + "type": "string" + }, + "dataMoveLevel": { + "description": "DataMove Level", + "enum": [ + "Invalid", + "Vault", + "Container" + ], + "type": "string", + "x-ms-enum": { + "name": "DataMoveLevel", + "modelAsString": true + } + }, + "correlationId": { + "description": "Correlation Id", + "type": "string" + }, + "sourceContainerArmIds": { + "description": "Source Container ArmIds", + "type": "array", + "items": { + "type": "string" + } + }, + "pauseGC": { + "description": "Pause GC", + "type": "boolean" + } + } + }, + "OperationResultInfoBaseResource": { + "description": "Base class for operation result info.", + "allOf": [ + { + "$ref": "#/definitions/OperationWorkerResponse" + } + ], + "properties": { + "operation": { + "$ref": "#/definitions/OperationResultInfoBase", + "description": "OperationResultInfoBaseResource operation" + } + } + }, + "OperationWorkerResponse": { + "description": "This is the base class for operation result responses.", + "type": "object", + "properties": { + "statusCode": { + "description": "HTTP Status Code of the operation.", + "enum": [ + "Continue", + "SwitchingProtocols", + "OK", + "Created", + "Accepted", + "NonAuthoritativeInformation", + "NoContent", + "ResetContent", + "PartialContent", + "MultipleChoices", + "Ambiguous", + "MovedPermanently", + "Moved", + "Found", + "Redirect", + "SeeOther", + "RedirectMethod", + "NotModified", + "UseProxy", + "Unused", + "TemporaryRedirect", + "RedirectKeepVerb", + "BadRequest", + "Unauthorized", + "PaymentRequired", + "Forbidden", + "NotFound", + "MethodNotAllowed", + "NotAcceptable", + "ProxyAuthenticationRequired", + "RequestTimeout", + "Conflict", + "Gone", + "LengthRequired", + "PreconditionFailed", + "RequestEntityTooLarge", + "RequestUriTooLong", + "UnsupportedMediaType", + "RequestedRangeNotSatisfiable", + "ExpectationFailed", + "UpgradeRequired", + "InternalServerError", + "NotImplemented", + "BadGateway", + "ServiceUnavailable", + "GatewayTimeout", + "HttpVersionNotSupported" + ], + "type": "string", + "x-ms-enum": { + "name": "HttpStatusCode", + "modelAsString": false + } + }, + "headers": { + "description": "HTTP headers associated with this operation.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "PointInTimeRange": { + "description": "Provides details for log ranges", + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "Start time of the time range for log recovery.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "End time of the time range for log recovery.", + "type": "string" + } + } + }, + "ProtectedItem": { + "description": "Base class for backup items.", + "required": [ + "protectedItemType" + ], + "type": "object", + "properties": { + "protectedItemType": { + "description": "backup item type.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + }, + "readOnly": true + }, + "workloadType": { + "description": "Type of workload this item represents.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + }, + "readOnly": true + }, + "containerName": { + "description": "Unique name of container", + "type": "string" + }, + "sourceResourceId": { + "description": "ARM ID of the resource to be backed up.", + "type": "string" + }, + "policyId": { + "description": "ID of the backup policy with which this item is backed up.", + "type": "string" + }, + "lastRecoveryPoint": { + "format": "date-time", + "description": "Timestamp when the last (latest) backup copy was created for this backup item.", + "type": "string" + }, + "backupSetName": { + "description": "Name of the backup set the backup item belongs to", + "type": "string" + }, + "createMode": { + "description": "Create mode to indicate recovery of existing soft deleted data source or creation of new data source.", + "enum": [ + "Invalid", + "Default", + "Recover" + ], + "type": "string", + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + }, + "deferredDeleteTimeInUTC": { + "format": "date-time", + "description": "Time for deferred deletion in UTC", + "type": "string" + }, + "isScheduledForDeferredDelete": { + "description": "Flag to identify whether the DS is scheduled for deferred delete", + "type": "boolean" + }, + "deferredDeleteTimeRemaining": { + "description": "Time remaining before the DS marked for deferred delete is permanently deleted", + "type": "string" + }, + "isDeferredDeleteScheduleUpcoming": { + "description": "Flag to identify whether the deferred deleted DS is to be purged soon", + "type": "boolean" + }, + "isRehydrate": { + "description": "Flag to identify that deferred deleted DS is to be moved into Pause state", + "type": "boolean" + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + }, + "isArchiveEnabled": { + "description": "Flag to identify whether datasource is protected in archive", + "type": "boolean" + }, + "policyName": { + "description": "Name of the policy used for protection", + "type": "string" + }, + "softDeleteRetentionPeriodInDays": { + "format": "int32", + "description": "Soft delete retention period in days", + "type": "integer" + }, + "vaultId": { + "description": "ID of the vault which protects this item", + "type": "string", + "readOnly": true + } + }, + "discriminator": "protectedItemType" + }, + "ProtectedItemQueryObject": { + "description": "Filters to list backup items.", + "type": "object", + "properties": { + "healthState": { + "description": "Health State for the backed up item.", + "enum": [ + "Passed", + "ActionRequired", + "ActionSuggested", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + }, + "backupManagementType": { + "description": "Backup management type for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "itemType": { + "description": "Type of workload this item represents.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "policyName": { + "description": "Backup policy name associated with the backup item.", + "type": "string" + }, + "containerName": { + "description": "Name of the container.", + "type": "string" + }, + "backupEngineName": { + "description": "Backup Engine name", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of protected item", + "type": "string" + }, + "fabricName": { + "description": "Name of the fabric.", + "type": "string" + }, + "backupSetName": { + "description": "Name of the backup set.", + "type": "string" + } + } + }, + "ProtectedItemResource": { + "description": "Base class for backup items.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectedItem", + "description": "ProtectedItemResource properties" + } + } + }, + "ProtectedItemResourceList": { + "description": "List of ProtectedItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectedItemResource" + } + } + } + }, + "ProtectionPolicy": { + "description": "Base class for backup policy. Workload-specific backup policies are derived from this class.", + "required": [ + "backupManagementType" + ], + "type": "object", + "properties": { + "protectedItemsCount": { + "format": "int32", + "description": "Number of items associated with this policy.", + "type": "integer" + }, + "backupManagementType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuard Operation Requests", + "type": "array", + "items": { + "type": "string" + } + } + }, + "discriminator": "backupManagementType" + }, + "ProtectionPolicyQueryObject": { + "description": "Filters the list backup policies API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backup policy.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "fabricName": { + "description": "Fabric name for filter", + "type": "string" + }, + "workloadType": { + "description": "Workload type for the backup policy.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + } + } + }, + "ProtectionPolicyResource": { + "description": "Base class for backup policy. Workload-specific backup policies are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionPolicy", + "description": "ProtectionPolicyResource properties" + } + } + }, + "ProtectionPolicyResourceList": { + "description": "List of ProtectionPolicy resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionPolicyResource" + } + } + } + }, + "RecoveryPoint": { + "description": "Base class for backup copies. Workload-specific backup copies are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "RecoveryPointDiskConfiguration": { + "description": "Disk configuration", + "type": "object", + "properties": { + "numberOfDisksIncludedInBackup": { + "format": "int32", + "description": "Number of disks included in backup", + "type": "integer" + }, + "numberOfDisksAttachedToVm": { + "format": "int32", + "description": "Number of disks attached to the VM", + "type": "integer" + }, + "includedDiskList": { + "description": "Information of disks included in backup", + "type": "array", + "items": { + "$ref": "#/definitions/DiskInformation" + }, + "x-ms-identifiers": [] + }, + "excludedDiskList": { + "description": "Information of disks excluded from backup", + "type": "array", + "items": { + "$ref": "#/definitions/DiskInformation" + }, + "x-ms-identifiers": [] + } + } + }, + "RecoveryPointResource": { + "description": "Base class for backup copies. Workload-specific backup copies are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RecoveryPoint", + "description": "RecoveryPointResource properties" + } + } + }, + "RecoveryPointResourceList": { + "description": "List of RecoveryPoint resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/RecoveryPointResource" + } + } + } + }, + "RecoveryPointTierInformation": { + "description": "Recovery point tier information.", + "type": "object", + "properties": { + "type": { + "description": "Recovery point tier type.", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "status": { + "description": "Recovery point tier status.", + "enum": [ + "Invalid", + "Valid", + "Disabled", + "Deleted", + "Rehydrated" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierStatus", + "modelAsString": false + } + }, + "extendedInfo": { + "description": "Recovery point tier status.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "RecoveryPointTierInformationV2": { + "description": "RecoveryPoint Tier Information V2", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RecoveryPointTierInformation" + } + ], + "properties": { + "type": { + "description": "Recovery point tier type.", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": true + } + }, + "status": { + "description": "Recovery point tier status.", + "enum": [ + "Invalid", + "Valid", + "Disabled", + "Deleted", + "Rehydrated" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierStatus", + "modelAsString": true + } + } + } + }, + "PatchRecoveryPointPropertiesInput": { + "description": "Recovery Point Properties Contract for Update Recovery Point API.", + "type": "object", + "properties": { + "expiryTime": { + "format": "date-time", + "description": "Expiry time of Recovery Point in UTC.", + "type": "string" + } + } + }, + "PatchRecoveryPointInput": { + "description": "Recovery Point Contract for Update Recovery Point API.", + "type": "object", + "properties": { + "recoveryPointProperties": { + "description": "Properties of Recovery Point", + "$ref": "#/definitions/PatchRecoveryPointPropertiesInput" + } + } + }, + "UpdateRecoveryPointRequest": { + "description": "Patch Request content to update recovery point for given RecoveryPointId", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PatchRecoveryPointInput", + "description": "Resource properties." + } + } + }, + "Resource": { + "description": "ARM Resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Resource location.", + "type": "string" + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "eTag": { + "description": "Optional ETag.", + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "ResourceList": { + "description": "Base for all lists of resources.", + "type": "object", + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + } + }, + "RestoreFileSpecs": { + "description": "Restore file specs like file path, type and target folder path info.", + "type": "object", + "properties": { + "path": { + "description": "Source File/Folder path", + "type": "string" + }, + "fileSpecType": { + "description": "Indicates what the Path variable stands for", + "type": "string" + }, + "targetFolderPath": { + "description": "Destination folder path in target FileShare", + "type": "string" + } + } + }, + "RestoreRequest": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuardOperationRequests on which LAC check will be performed", + "type": "array", + "items": { + "type": "string" + } + } + }, + "discriminator": "objectType" + }, + "RestoreRequestResource": { + "description": "Base class for restore request. Workload-specific restore requests are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RestoreRequest", + "description": "RestoreRequestResource properties" + } + } + }, + "RetentionDuration": { + "description": "Retention duration.", + "type": "object", + "properties": { + "count": { + "format": "int32", + "description": "Count of duration types. Retention duration is obtained by the counting the duration type Count times.\r\nFor example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks.", + "type": "integer" + }, + "durationType": { + "description": "Retention duration type of retention policy.", + "enum": [ + "Invalid", + "Days", + "Weeks", + "Months", + "Years" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionDurationType", + "modelAsString": true + } + } + } + }, + "RetentionPolicy": { + "description": "Base class for retention policy.", + "required": [ + "retentionPolicyType" + ], + "type": "object", + "properties": { + "retentionPolicyType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "retentionPolicyType" + }, + "SchedulePolicy": { + "description": "Base class for backup schedule.", + "required": [ + "schedulePolicyType" + ], + "type": "object", + "properties": { + "schedulePolicyType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "schedulePolicyType" + }, + "Settings": { + "description": "Common settings field for backup management", + "type": "object", + "properties": { + "timeZone": { + "description": "TimeZone optional input as string. For example: TimeZone = \"Pacific Standard Time\".", + "type": "string" + }, + "issqlcompression": { + "description": "SQL compression flag", + "type": "boolean" + }, + "isCompression": { + "description": "Workload compression flag. This has been added so that 'isSqlCompression'\r\nwill be deprecated once clients upgrade to consider this flag.", + "type": "boolean" + } + } + }, + "SimpleRetentionPolicy": { + "description": "Simple policy retention.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RetentionPolicy" + } + ], + "properties": { + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of the protection policy." + } + }, + "x-ms-discriminator-value": "SimpleRetentionPolicy" + }, + "SimpleSchedulePolicy": { + "description": "Simple policy schedule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "properties": { + "scheduleRunFrequency": { + "description": "Frequency of the schedule operation of this policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly", + "Hourly" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleRunType", + "modelAsString": true + } + }, + "scheduleRunDays": { + "description": "List of days of week this schedule has to be run.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "scheduleRunTimes": { + "description": "List of times of day this schedule has to be run.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "hourlySchedule": { + "$ref": "#/definitions/HourlySchedule", + "description": "Hourly Schedule of this Policy" + }, + "scheduleWeeklyFrequency": { + "format": "int32", + "description": "At every number weeks this schedule has to be run.", + "type": "integer" + } + }, + "x-ms-discriminator-value": "SimpleSchedulePolicy" + }, + "SimpleSchedulePolicyV2": { + "description": "The V2 policy schedule for IaaS that supports hourly backups.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SchedulePolicy" + } + ], + "properties": { + "scheduleRunFrequency": { + "description": "Frequency of the schedule operation of this policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly", + "Hourly" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleRunType", + "modelAsString": true + } + }, + "hourlySchedule": { + "$ref": "#/definitions/HourlySchedule", + "description": "hourly schedule of this policy" + }, + "dailySchedule": { + "$ref": "#/definitions/DailySchedule", + "description": "Daily schedule of this policy" + }, + "weeklySchedule": { + "$ref": "#/definitions/WeeklySchedule", + "description": "Weekly schedule of this policy" + } + }, + "x-ms-discriminator-value": "SimpleSchedulePolicyV2" + }, + "SubProtectionPolicy": { + "description": "Sub-protection policy which includes schedule and retention", + "type": "object", + "properties": { + "policyType": { + "description": "Type of backup policy type", + "enum": [ + "Invalid", + "Full", + "Differential", + "Log", + "CopyOnlyFull", + "Incremental", + "SnapshotFull", + "SnapshotCopyOnlyFull" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyType", + "modelAsString": true + } + }, + "schedulePolicy": { + "$ref": "#/definitions/SchedulePolicy", + "description": "Backup schedule specified as part of backup policy." + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicy", + "description": "Retention policy with the details on backup copy retention ranges." + }, + "tieringPolicy": { + "description": "Tiering policy to automatically move RPs to another tier.\r\nKey is Target Tier, defined in RecoveryPointTierType enum.\r\nTiering policy specifies the criteria to move RP to the target tier.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TieringPolicy" + } + }, + "snapshotBackupAdditionalDetails": { + "$ref": "#/definitions/SnapshotBackupAdditionalDetails" + } + } + }, + "SnapshotBackupAdditionalDetails": { + "description": "Snapshot Backup related fields for WorkloadType SaPHanaSystem", + "type": "object", + "properties": { + "instantRpRetentionRangeInDays": { + "format": "int32", + "type": "integer" + }, + "instantRPDetails": { + "type": "string" + }, + "userAssignedManagedIdentityDetails": { + "$ref": "#/definitions/UserAssignedManagedIdentityDetails" + } + } + }, + "SnapshotRestoreParameters": { + "description": "Encapsulates information regarding snapshot recovery for SAP Hana", + "type": "object", + "properties": { + "skipAttachAndMount": { + "type": "boolean" + }, + "logPointInTimeForDBRecovery": { + "type": "string" + } + } + }, + "SQLDataDirectory": { + "description": "SQLDataDirectory info", + "type": "object", + "properties": { + "type": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "path": { + "description": "File path", + "type": "string" + }, + "logicalName": { + "description": "Logical name of the file", + "type": "string" + } + } + }, + "SQLDataDirectoryMapping": { + "description": "Encapsulates information regarding data directory", + "type": "object", + "properties": { + "mappingType": { + "description": "Type of data directory mapping", + "enum": [ + "Invalid", + "Data", + "Log" + ], + "type": "string", + "x-ms-enum": { + "name": "SQLDataDirectoryType", + "modelAsString": true + } + }, + "sourceLogicalName": { + "description": "Restore source logical name path", + "type": "string" + }, + "sourcePath": { + "description": "Restore source path", + "type": "string" + }, + "targetPath": { + "description": "Target path", + "type": "string" + } + } + }, + "TargetAFSRestoreInfo": { + "description": "Target Azure File Share Info.", + "type": "object", + "properties": { + "name": { + "description": "File share name", + "type": "string" + }, + "targetResourceId": { + "description": "Target file share resource ARM ID", + "type": "string" + } + } + }, + "TargetRestoreInfo": { + "description": "Details about target workload during restore operation.", + "type": "object", + "properties": { + "overwriteOption": { + "description": "Can Overwrite if Target DataBase already exists", + "enum": [ + "Invalid", + "FailOnConflict", + "Overwrite" + ], + "type": "string", + "x-ms-enum": { + "name": "OverwriteOptions", + "modelAsString": true + } + }, + "containerId": { + "description": "Resource Id name of the container in which Target DataBase resides", + "type": "string" + }, + "databaseName": { + "description": "Database name InstanceName/DataBaseName for SQL or System/DbName for SAP Hana", + "type": "string" + }, + "targetDirectoryForFileRestore": { + "description": "Target directory location for restore as files.", + "type": "string" + } + } + }, + "UserAssignedIdentityProperties": { + "type": "object", + "description": "User assigned managed identity properties", + "properties": { + "clientId": { + "description": "The client ID of the assigned identity.", + "type": "string" + }, + "principalId": { + "description": "The principal ID of the assigned identity.", + "type": "string" + } + } + }, + "UserAssignedManagedIdentityDetails": { + "type": "object", + "description": "User assigned managed identity details", + "properties": { + "identityArmId": { + "type": "string", + "description": "The ARM id of the assigned identity." + }, + "identityName": { + "type": "string", + "description": "The name of the assigned identity." + }, + "userAssignedIdentityProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperties" + } + } + }, + "ValidateIaasVMRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateRestoreOperationRequest" + } + ], + "x-ms-discriminator-value": "ValidateIaasVMRestoreOperationRequest" + }, + "ValidateOperationRequest": { + "description": "Base class for validate operation request.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ValidateOperationRequestResource": { + "description": "Base class for validate operation request.", + "required": [ + "id", + "properties" + ], + "type": "object", + "properties": { + "id": { + "description": "Recovery point ID.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ValidateOperationRequest", + "description": "ValidateOperationRequestResource properties" + } + } + }, + "ValidateOperationResponse": { + "description": "Base class for validate operation response.", + "type": "object", + "properties": { + "validationResults": { + "description": "Gets the validation result", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "x-ms-identifiers": [ + "code" + ] + } + } + }, + "ValidateOperationsResponse": { + "type": "object", + "properties": { + "validateOperationResponse": { + "$ref": "#/definitions/ValidateOperationResponse" + } + } + }, + "ValidateRestoreOperationRequest": { + "description": "AzureRestoreValidation request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ValidateOperationRequest" + } + ], + "properties": { + "restoreRequest": { + "$ref": "#/definitions/RestoreRequest", + "description": "Sets restore request to be validated" + } + }, + "x-ms-discriminator-value": "ValidateRestoreOperationRequest" + }, + "VaultRetentionPolicy": { + "description": "Vault retention policy for AzureFileShare", + "required": [ + "vaultRetention", + "snapshotRetentionInDays" + ], + "type": "object", + "properties": { + "vaultRetention": { + "$ref": "#/definitions/RetentionPolicy" + }, + "snapshotRetentionInDays": { + "format": "int32", + "type": "integer" + } + } + }, + "WeeklyRetentionFormat": { + "description": "Weekly retention format.", + "type": "object", + "properties": { + "daysOfTheWeek": { + "description": "List of days of the week.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "weeksOfTheMonth": { + "description": "List of weeks of month.", + "type": "array", + "items": { + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "WeekOfMonth", + "modelAsString": false + } + } + } + } + }, + "WeeklyRetentionSchedule": { + "description": "Weekly retention schedule.", + "type": "object", + "properties": { + "daysOfTheWeek": { + "description": "List of days of week for weekly retention policy.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + } + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "BackupResourceVaultConfigResource": { + "description": "Backup resource vault config details.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupResourceVaultConfig", + "description": "BackupResourceVaultConfigResource properties" + } + } + }, + "BackupResourceVaultConfig": { + "description": "Backup resource vault config details.", + "type": "object", + "properties": { + "storageModelType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageType": { + "description": "Storage type.", + "enum": [ + "Invalid", + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant", + "ReadAccessGeoZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "storageTypeState": { + "description": "Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked.", + "enum": [ + "Invalid", + "Locked", + "Unlocked" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageTypeState", + "modelAsString": true + } + }, + "enhancedSecurityState": { + "description": "Enabled or Disabled.", + "enum": [ + "Invalid", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnhancedSecurityState", + "modelAsString": true + } + }, + "softDeleteFeatureState": { + "description": "Soft Delete feature state", + "enum": [ + "Invalid", + "Enabled", + "Disabled", + "AlwaysON" + ], + "type": "string", + "x-ms-enum": { + "name": "SoftDeleteFeatureState", + "modelAsString": true + } + }, + "softDeleteRetentionPeriodInDays": { + "format": "int32", + "description": "Soft delete retention period in days", + "type": "integer" + }, + "resourceGuardOperationRequests": { + "description": "ResourceGuard Operation Requests", + "type": "array", + "items": { + "type": "string" + } + }, + "isSoftDeleteFeatureStateEditable": { + "description": "This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault", + "type": "boolean" + } + } + }, + "YearlyRetentionSchedule": { + "description": "Yearly retention schedule.", + "type": "object", + "properties": { + "retentionScheduleFormatType": { + "description": "Retention schedule format for yearly retention policy.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionScheduleFormat", + "modelAsString": true + } + }, + "monthsOfYear": { + "description": "List of months of year of yearly retention policy.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December" + ], + "type": "string", + "x-ms-enum": { + "name": "MonthOfYear", + "modelAsString": false + } + } + }, + "retentionScheduleDaily": { + "$ref": "#/definitions/DailyRetentionFormat", + "description": "Daily retention format for yearly retention policy." + }, + "retentionScheduleWeekly": { + "$ref": "#/definitions/WeeklyRetentionFormat", + "description": "Weekly retention format for yearly retention policy." + }, + "retentionTimes": { + "description": "Retention times of retention policy.", + "type": "array", + "items": { + "format": "date-time", + "type": "string" + } + }, + "retentionDuration": { + "$ref": "#/definitions/RetentionDuration", + "description": "Retention duration of retention Policy." + } + } + }, + "VaultJob": { + "description": "Vault level Job", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Job" + } + ], + "properties": { + "duration": { + "format": "duration", + "description": "Time elapsed during the execution of this job.", + "type": "string" + }, + "actionsInfo": { + "description": "Gets or sets the state/actions applicable on this job like cancel/retry.", + "type": "array", + "items": { + "enum": [ + "Invalid", + "Cancellable", + "Retriable" + ], + "type": "string", + "x-ms-enum": { + "name": "JobSupportedAction", + "modelAsString": false + } + } + }, + "errorDetails": { + "description": "Error details on execution of this job.", + "type": "array", + "items": { + "$ref": "#/definitions/VaultJobErrorInfo" + }, + "x-ms-identifiers": [ + "errorCode" + ] + }, + "extendedInfo": { + "$ref": "#/definitions/VaultJobExtendedInfo", + "description": "Additional information about the job." + } + }, + "x-ms-discriminator-value": "VaultJob" + }, + "VaultJobErrorInfo": { + "description": "Vault Job specific error information", + "type": "object", + "properties": { + "errorCode": { + "format": "int32", + "description": "Error code.", + "type": "integer" + }, + "errorString": { + "description": "Localized error string.", + "type": "string" + }, + "recommendations": { + "description": "List of localized recommendations for above error code.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "VaultJobExtendedInfo": { + "description": "Vault Job for CMK - has CMK specific info.", + "type": "object", + "properties": { + "propertyBag": { + "description": "Job properties.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AzureBackupServerContainer": { + "description": "AzureBackupServer (DPMVenus) workload-specific protection container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DpmContainer" + } + ], + "x-ms-discriminator-value": "AzureBackupServerContainer" + }, + "AzureBackupServerEngine": { + "description": "Backup engine type when Azure Backup Server is used to manage the backups.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupEngineBase" + } + ], + "x-ms-discriminator-value": "AzureBackupServerEngine" + }, + "AzureFileShareBackupRequest": { + "description": "AzureFileShare workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureFileShareBackupRequest" + }, + "AzureFileShareProtectableItem": { + "description": "Protectable item for Azure Fileshare workloads.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "parentContainerFabricId": { + "description": "Full Fabric ID of container to which this protectable item belongs. For example, ARM ID.", + "type": "string" + }, + "parentContainerFriendlyName": { + "description": "Friendly name of container to which this protectable item belongs.", + "type": "string" + }, + "azureFileShareType": { + "description": "File Share type XSync or XSMB.", + "enum": [ + "Invalid", + "XSMB", + "XSync" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureFileShareType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureFileShare" + }, + "AzureFileShareProvisionILRRequest": { + "description": "Update snapshot Uri with the correct friendly Name of the source Azure file share.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ILRRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "Recovery point ID.", + "type": "string" + }, + "sourceResourceId": { + "description": "Source Storage account ARM Id", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureFileShareProvisionILRRequest" + }, + "AzureIaaSClassicComputeVMContainer": { + "description": "IaaS VM workload-specific backup item representing a classic virtual machine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMContainer" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSClassicComputeVMProtectableItem": { + "description": "IaaS VM workload-specific backup item representing the Classic Compute VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMProtectableItem" + } + ], + "x-ms-discriminator-value": "Microsoft.ClassicCompute/virtualMachines" + }, + "AzureIaaSComputeVMContainer": { + "description": "IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMContainer" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureIaaSComputeVMProtectableItem": { + "description": "IaaS VM workload-specific backup item representing the Azure Resource Manager VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaaSVMProtectableItem" + } + ], + "x-ms-discriminator-value": "Microsoft.Compute/virtualMachines" + }, + "AzureSQLAGWorkloadContainerProtectionContainer": { + "description": "Container for SQL workloads under SQL Availability Group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadContainer" + } + ], + "x-ms-discriminator-value": "SQLAGWorkLoadContainer" + }, + "AzureSqlContainer": { + "description": "Azure Sql workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "x-ms-discriminator-value": "AzureSqlContainer" + }, + "AzureStorageContainer": { + "description": "Azure Storage Account workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "sourceResourceId": { + "description": "Fully qualified ARM url.", + "type": "string" + }, + "storageAccountVersion": { + "description": "Storage account version.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of Recovery Services Vault.", + "type": "string" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of items backed up in this container.", + "type": "integer" + }, + "acquireStorageAccountLock": { + "description": "Whether storage account lock is to be acquired for this container or not.", + "enum": [ + "Acquire", + "NotAcquire" + ], + "type": "string", + "x-ms-enum": { + "name": "AcquireStorageAccountLock", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "StorageContainer" + }, + "AzureStorageProtectableContainer": { + "description": "Azure Storage-specific protectable containers", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectableContainer" + } + ], + "x-ms-discriminator-value": "StorageContainer" + }, + "AzureVMAppContainerProtectableContainer": { + "description": "Azure workload-specific container", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectableContainer" + } + ], + "x-ms-discriminator-value": "VMAppContainer" + }, + "AzureVMAppContainerProtectionContainer": { + "description": "Container for SQL workloads under Azure Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadContainer" + } + ], + "x-ms-discriminator-value": "VMAppContainer" + }, + "AzureVmWorkloadItem": { + "description": "Azure VM workload-specific workload item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadItem" + } + ], + "properties": { + "parentName": { + "description": "Name for instance or AG", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "isAutoProtectable": { + "description": "Indicates if workload item is auto-protectable", + "type": "boolean" + }, + "subinquireditemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's present", + "type": "integer" + }, + "subWorkloadItemCount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's to be protected", + "type": "integer" + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadItem" + }, + "AzureVmWorkloadProtectableItem": { + "description": "Azure VM workload-specific protectable item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "parentName": { + "description": "Name for instance or AG", + "type": "string" + }, + "parentUniqueName": { + "description": "Parent Unique Name is added to provide the service formatted URI Name of the Parent\r\nOnly Applicable for data bases where the parent would be either Instance or a SQL AG.", + "type": "string" + }, + "serverName": { + "description": "Host/Cluster Name for instance or AG", + "type": "string" + }, + "isAutoProtectable": { + "description": "Indicates if protectable item is auto-protectable", + "type": "boolean" + }, + "isAutoProtected": { + "description": "Indicates if protectable item is auto-protected", + "type": "boolean" + }, + "subinquireditemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's present", + "type": "integer" + }, + "subprotectableitemcount": { + "format": "int32", + "description": "For instance or AG, indicates number of DB's to be protected", + "type": "integer" + }, + "prebackupvalidation": { + "$ref": "#/definitions/PreBackupValidation", + "description": "Pre-backup validation for protectable objects" + }, + "isProtectable": { + "description": "Indicates if item is protectable", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "AzureVmWorkloadProtectableItem" + }, + "AzureVmWorkloadSAPAseDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseDatabase" + }, + "AzureVmWorkloadSAPAseSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, + "AzureVmWorkloadSAPAseSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP ASE System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPAseSystem" + }, + "AzureVmWorkloadSAPHanaDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP HANA Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDatabase" + }, + "AzureVmWorkloadSAPHanaSystemProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SAP HANA System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, + "AzureVmWorkloadSAPHanaDBInstance": { + "description": "Azure VM workload-specific protectable item representing SAP HANA Dbinstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SAPHanaDBInstance" + }, + "AzureVmWorkloadSAPHanaHSRProtectableItem": { + "description": "Azure VM workload-specific protectable item representing HANA HSR.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "HanaHSRContainer" + }, + "AzureVmWorkloadSAPHanaScaleoutProtectableItem": { + "description": "Azure VM workload-specific protectable item representing HANA scale out.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "HanaScaleoutContainer" + }, + "AzureVmWorkloadSAPHanaSystemWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SAP HANA System.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SAPHanaSystem" + }, + "AzureVmWorkloadSQLAvailabilityGroupProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Availability Group.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "properties": { + "nodesList": { + "description": "List of the nodes in case of distributed container.", + "type": "array", + "items": { + "$ref": "#/definitions/DistributedNodesInfo" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "SQLAvailabilityGroupContainer" + }, + "AzureVmWorkloadSQLDatabaseProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SQLDataBase" + }, + "AzureVmWorkloadSQLDatabaseWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SQL Database.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "x-ms-discriminator-value": "SQLDataBase" + }, + "AzureVmWorkloadSQLInstanceProtectableItem": { + "description": "Azure VM workload-specific protectable item representing SQL Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadProtectableItem" + } + ], + "x-ms-discriminator-value": "SQLInstance" + }, + "AzureVmWorkloadSQLInstanceWorkloadItem": { + "description": "Azure VM workload-specific workload item representing SQL Instance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureVmWorkloadItem" + } + ], + "properties": { + "dataDirectoryPaths": { + "description": "Data Directory Paths for default directories", + "type": "array", + "items": { + "$ref": "#/definitions/SQLDataDirectory" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "SQLInstance" + }, + "AzureWorkloadBackupRequest": { + "description": "AzureWorkload workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "backupType": { + "description": "Type of backup, viz. Full, Differential, Log or CopyOnlyFull", + "enum": [ + "Invalid", + "Full", + "Differential", + "Log", + "CopyOnlyFull", + "Incremental", + "SnapshotFull", + "SnapshotCopyOnlyFull" + ], + "type": "string", + "x-ms-enum": { + "name": "backupType", + "modelAsString": true + } + }, + "enableCompression": { + "description": "Bool for Compression setting", + "type": "boolean" + }, + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureWorkloadBackupRequest" + }, + "AzureBackupGoalFeatureSupportRequest": { + "description": "Azure backup goal feature specific request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureSupportRequest" + } + ], + "x-ms-discriminator-value": "AzureBackupGoals" + }, + "AzureRecoveryServiceVaultProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "x-ms-discriminator-value": "RecoveryServiceVaultItem" + }, + "AzureResourceProtectionIntent": { + "description": "IaaS VM specific backup protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the VM represented by this backup item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureResourceItem" + }, + "AzureVMResourceFeatureSupportRequest": { + "description": "AzureResource(IaaS VM) Specific feature support request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureSupportRequest" + } + ], + "properties": { + "vmSize": { + "description": "Size of the resource: VM size(A/D series etc) in case of IaasVM", + "type": "string" + }, + "vmSku": { + "description": "SKUs (Premium/Managed etc) in case of IaasVM", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureVMResourceBackup" + }, + "AzureVMResourceFeatureSupportResponse": { + "description": "Response for feature support requests for Azure IaasVm", + "type": "object", + "properties": { + "supportStatus": { + "description": "Support status of feature", + "enum": [ + "Invalid", + "Supported", + "DefaultOFF", + "DefaultON", + "NotSupported" + ], + "type": "string", + "x-ms-enum": { + "name": "SupportStatus", + "modelAsString": true + } + } + } + }, + "AzureWorkloadContainerAutoProtectionIntent": { + "description": "Azure workload specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionIntent" + } + ], + "x-ms-discriminator-value": "AzureWorkloadContainerAutoProtectionIntent" + }, + "AzureWorkloadAutoProtectionIntent": { + "description": "Azure Recovery Services Vault specific protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureRecoveryServiceVaultProtectionIntent" + } + ], + "x-ms-discriminator-value": "AzureWorkloadAutoProtectionIntent" + }, + "AzureWorkloadSQLAutoProtectionIntent": { + "description": "Azure Workload SQL Auto Protection intent item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadAutoProtectionIntent" + } + ], + "properties": { + "workloadItemType": { + "description": "Workload item type of the item for which intent is to be set", + "enum": [ + "Invalid", + "SQLInstance", + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadItemType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLAutoProtectionIntent" + }, + "BackupManagementUsage": { + "description": "Backup management usages of a vault.", + "type": "object", + "properties": { + "unit": { + "description": "Unit of the usage.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "UsagesUnit", + "modelAsString": true + } + }, + "quotaPeriod": { + "description": "Quota period of usage.", + "type": "string" + }, + "nextResetTime": { + "format": "date-time", + "description": "Next reset time of usage.", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value of usage.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "Limit of usage.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/NameInfo", + "description": "Name of usage." + } + } + }, + "BackupManagementUsageList": { + "description": "Backup management usage for vault.", + "type": "object", + "properties": { + "value": { + "description": "The list of backup management usages for the given vault.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupManagementUsage" + }, + "x-ms-identifiers": [] + } + } + }, + "BackupStatusRequest": { + "description": "BackupStatus request.", + "type": "object", + "properties": { + "resourceType": { + "description": "Container Type - VM, SQLPaaS, DPM, AzureFileShare...", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "Entire ARM resource id of the resource", + "type": "string" + }, + "poLogicalName": { + "description": "Protectable Item Logical Name", + "type": "string" + } + } + }, + "BackupStatusResponse": { + "description": "BackupStatus response.", + "type": "object", + "properties": { + "protectionStatus": { + "description": "Specifies whether the container is registered or not", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + }, + "vaultId": { + "description": "Specifies the arm resource id of the vault", + "type": "string" + }, + "fabricName": { + "description": "Specifies the fabric name - Azure or AD", + "enum": [ + "Invalid", + "Azure" + ], + "type": "string", + "x-ms-enum": { + "name": "FabricName", + "modelAsString": true + } + }, + "containerName": { + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.", + "type": "string" + }, + "protectedItemName": { + "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.", + "type": "string" + }, + "errorCode": { + "description": "ErrorCode in case of intent failed", + "type": "string" + }, + "errorMessage": { + "description": "ErrorMessage in case of intent failed.", + "type": "string" + }, + "policyName": { + "description": "Specifies the policy name which is used for protection", + "type": "string" + }, + "registrationStatus": { + "description": "Container registration status", + "type": "string" + }, + "protectedItemsCount": { + "format": "int32", + "description": "Number of protected items", + "type": "integer" + }, + "acquireStorageAccountLock": { + "description": "Specifies whether the storage account lock has been acquired or not", + "enum": [ + "Acquire", + "NotAcquire" + ], + "type": "string", + "x-ms-enum": { + "name": "AcquireStorageAccountLock", + "modelAsString": true + } + } + } + }, + "BMSBackupSummariesQueryObject": { + "description": "Query parameters to fetch backup summaries.", + "type": "object", + "properties": { + "type": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "BackupProtectedItemCountSummary", + "BackupProtectionContainerCountSummary" + ], + "type": "string", + "x-ms-enum": { + "name": "Type", + "modelAsString": true + } + } + } + }, + "FeatureSupportRequest": { + "description": "Base class for feature request", + "required": [ + "featureType" + ], + "type": "object", + "properties": { + "featureType": { + "description": "backup support feature type.", + "type": "string" + } + }, + "discriminator": "featureType" + }, + "NameInfo": { + "description": "The name of usage.", + "type": "object", + "properties": { + "value": { + "description": "Value of usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of usage.", + "type": "string" + } + } + }, + "PreValidateEnableBackupRequest": { + "description": "Contract to validate if backup can be enabled on the given resource in a given vault and given configuration.\r\nIt will validate followings\r\n1. Vault capacity\r\n2. VM is already protected\r\n3. Any VM related configuration passed in properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataSourceType", + "modelAsString": true + } + }, + "resourceId": { + "description": "ARM Virtual Machine Id", + "type": "string" + }, + "vaultId": { + "description": "ARM id of the Recovery Services Vault", + "type": "string" + }, + "properties": { + "description": "Configuration of VM if any needs to be validated like OS type etc", + "type": "string" + } + } + }, + "PreValidateEnableBackupResponse": { + "description": "Response contract for enable backup validation request", + "type": "object", + "properties": { + "status": { + "description": "Validation Status", + "enum": [ + "Invalid", + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationStatus", + "modelAsString": true + } + }, + "errorCode": { + "description": "Response error code", + "type": "string" + }, + "errorMessage": { + "description": "Response error message", + "type": "string" + }, + "recommendation": { + "description": "Recommended action for user", + "type": "string" + }, + "containerName": { + "description": "Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required\r\nfor portal", + "type": "string" + }, + "protectedItemName": { + "description": "Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal", + "type": "string" + } + } + }, + "ProtectionIntent": { + "description": "Base class for backup ProtectionIntent.", + "required": [ + "protectionIntentItemType" + ], + "type": "object", + "properties": { + "protectionIntentItemType": { + "description": "backup protectionIntent type.", + "enum": [ + "Invalid", + "AzureResourceItem", + "RecoveryServiceVaultItem", + "AzureWorkloadContainerAutoProtectionIntent", + "AzureWorkloadAutoProtectionIntent", + "AzureWorkloadSQLAutoProtectionIntent" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionIntentItemType", + "modelAsString": true + } + }, + "backupManagementType": { + "description": "Type of backup management for the backed up item.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "sourceResourceId": { + "description": "ARM ID of the resource to be backed up.", + "type": "string" + }, + "itemId": { + "description": "ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId", + "type": "string" + }, + "policyId": { + "description": "ID of the backup policy with which this item is backed up.", + "type": "string" + }, + "protectionState": { + "description": "Backup state of this backup item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "protectionIntentItemType" + }, + "ProtectionIntentQueryObject": { + "description": "Filters to list protection intent.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backed up item", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "itemType": { + "description": "Type of workload this item represents", + "enum": [ + "Invalid", + "SQLInstance", + "SQLAvailabilityGroupContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "IntentItemType", + "modelAsString": true + } + }, + "parentName": { + "description": "Parent name of the intent", + "type": "string" + }, + "itemName": { + "description": "Item name of the intent", + "type": "string" + } + } + }, + "ProtectionIntentResource": { + "description": "Base class for backup ProtectionIntent.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionIntent", + "description": "ProtectionIntentResource properties" + } + } + }, + "ProtectionIntentResourceList": { + "description": "List of ProtectionIntent resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionIntentResource" + } + } + } + }, + "AzureWorkloadContainer": { + "description": "Container for the workloads running inside Azure Compute or Classic Compute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "sourceResourceId": { + "description": "ARM ID of the virtual machine represented by this Azure Workload Container", + "type": "string" + }, + "lastUpdatedTime": { + "format": "date-time", + "description": "Time stamp when this container was updated.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/AzureWorkloadContainerExtendedInfo", + "description": "Additional details of a workload container." + }, + "workloadType": { + "description": "Workload type for which registration was sent.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "operationType": { + "description": "Re-Do Operation", + "enum": [ + "Invalid", + "Register", + "Reregister" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "AzureWorkloadContainer" + }, + "AzureWorkloadContainerExtendedInfo": { + "description": "Extended information of the container.", + "type": "object", + "properties": { + "hostServerName": { + "description": "Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.", + "type": "string" + }, + "inquiryInfo": { + "$ref": "#/definitions/InquiryInfo", + "description": "Inquiry Status for the container." + }, + "nodesList": { + "description": "List of the nodes in case of distributed container.", + "type": "array", + "items": { + "$ref": "#/definitions/DistributedNodesInfo" + }, + "x-ms-identifiers": [] + } + } + }, + "BackupEngineBase": { + "description": "The base backup engine class. All workload specific backup engines derive from this class.", + "type": "object", + "required": [ + "backupEngineType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the backup engine.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the backup engine.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "registrationStatus": { + "description": "Registration status of the backup engine with the Recovery Services Vault.", + "type": "string" + }, + "backupEngineState": { + "description": "Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}", + "type": "string" + }, + "healthStatus": { + "description": "Backup status of the backup engine.", + "type": "string" + }, + "backupEngineType": { + "description": "Type of the backup engine.", + "enum": [ + "Invalid", + "DpmBackupEngine", + "AzureBackupServerEngine" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupEngineType", + "modelAsString": true + } + }, + "canReRegister": { + "description": "Flag indicating if the backup engine be registered, once already registered.", + "type": "boolean" + }, + "backupEngineId": { + "description": "ID of the backup engine.", + "type": "string" + }, + "dpmVersion": { + "description": "Backup engine version", + "type": "string" + }, + "azureBackupAgentVersion": { + "description": "Backup agent version", + "type": "string" + }, + "isAzureBackupAgentUpgradeAvailable": { + "description": "To check if backup agent upgrade available", + "type": "boolean" + }, + "isDpmUpgradeAvailable": { + "description": "To check if backup engine upgrade available", + "type": "boolean" + }, + "extendedInfo": { + "$ref": "#/definitions/BackupEngineExtendedInfo", + "description": "Extended info of the backupengine" + } + }, + "discriminator": "backupEngineType" + }, + "BackupEngineBaseResource": { + "description": "The base backup engine class. All workload specific backup engines derive from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupEngineBase", + "description": "BackupEngineBaseResource properties" + } + } + }, + "BackupEngineBaseResourceList": { + "description": "List of BackupEngineBase resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/BackupEngineBaseResource" + } + } + } + }, + "BackupEngineExtendedInfo": { + "description": "Additional information on backup engine.", + "type": "object", + "properties": { + "databaseName": { + "description": "Database name of backup engine.", + "type": "string" + }, + "protectedItemsCount": { + "format": "int32", + "description": "Number of protected items in the backup engine.", + "type": "integer" + }, + "protectedServersCount": { + "format": "int32", + "description": "Number of protected servers in the backup engine.", + "type": "integer" + }, + "diskCount": { + "format": "int32", + "description": "Number of disks in the backup engine.", + "type": "integer" + }, + "usedDiskSpace": { + "format": "double", + "description": "Disk space used in the backup engine.", + "type": "number" + }, + "availableDiskSpace": { + "format": "double", + "description": "Disk space currently available in the backup engine.", + "type": "number" + }, + "refreshedAt": { + "format": "date-time", + "description": "Last refresh time in the backup engine.", + "type": "string" + }, + "azureProtectedInstances": { + "format": "int32", + "description": "Protected instances in the backup engine.", + "type": "integer" + } + } + }, + "BackupRequest": { + "description": "Base class for backup request. Workload-specific backup requests are derived from this class.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "BackupRequestResource": { + "description": "Base class for backup request. Workload-specific backup requests are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BackupRequest", + "description": "BackupRequestResource properties" + } + } + }, + "BMSBackupEngineQueryObject": { + "description": "Query parameters to fetch list of backup engines.", + "type": "object", + "properties": { + "expand": { + "description": "attribute to add extended info", + "type": "string" + } + } + }, + "BMSBackupEnginesQueryObject": { + "description": "Query parameters to fetch list of backup engines.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for the backup engine.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "Friendly name of the backup engine.", + "type": "string" + }, + "expand": { + "description": "Attribute to add extended info.", + "type": "string" + } + } + }, + "BMSContainerQueryObject": { + "description": "The query filters that can be used with the list containers API.", + "required": [ + "backupManagementType" + ], + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "containerType": { + "description": "Type of container for filter", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer", + "HanaHSRContainer", + "HanaScaleoutContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": true + } + }, + "backupEngineName": { + "description": "Backup engine name", + "type": "string" + }, + "fabricName": { + "description": "Fabric name for filter", + "type": "string" + }, + "status": { + "description": "Status of registration of this container with the Recovery Services Vault.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of this container.", + "type": "string" + } + } + }, + "BMSContainersInquiryQueryObject": { + "description": "The query filters that can be used with the inquire container API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type for this container.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + } + } + }, + "BMSPOQueryObject": { + "description": "Filters to list items that can be backed up.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureSql", + "AzureBackupServer", + "AzureWorkload", + "AzureStorage", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "containerName": { + "description": "Full name of the container whose Protectable Objects should be returned.", + "type": "string" + }, + "status": { + "description": "Backup status query parameter.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name.", + "type": "string" + } + } + }, + "BMSRefreshContainersQueryObject": { + "description": "The query filters that can be used with the refresh container API.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type for this container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + } + } + }, + "BMSWorkloadItemQueryObject": { + "description": "Filters to list items that can be backed up.", + "type": "object", + "properties": { + "backupManagementType": { + "description": "Backup management type.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureSql", + "AzureBackupServer", + "AzureWorkload", + "AzureStorage", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "workloadItemType": { + "description": "Workload Item type", + "enum": [ + "Invalid", + "SQLInstance", + "SQLDataBase", + "SAPHanaSystem", + "SAPHanaDatabase", + "SAPAseSystem", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadItemType", + "modelAsString": true + } + }, + "workloadType": { + "description": "Workload type", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "WorkloadType", + "modelAsString": true + } + }, + "protectionStatus": { + "description": "Backup status query parameter.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + } + }, + "ClientScriptForConnect": { + "description": "Client script details for file / folder restore.", + "type": "object", + "properties": { + "scriptContent": { + "description": "File content of the client script for file / folder restore.", + "type": "string" + }, + "scriptExtension": { + "description": "File extension of the client script for file / folder restore - .ps1 , .sh , etc.", + "type": "string" + }, + "osType": { + "description": "OS type - Windows, Linux etc. for which this file / folder restore client script works.", + "type": "string" + }, + "url": { + "description": "URL of Executable from where to source the content. If this is not null then ScriptContent should not be used", + "type": "string" + }, + "scriptNameSuffix": { + "description": "Mandatory suffix that should be added to the name of script that is given for download to user.\r\nIf its null or empty then , ignore it.", + "type": "string" + } + } + }, + "ContainerIdentityInfo": { + "description": "Container identity information", + "type": "object", + "properties": { + "uniqueName": { + "description": "Unique name of the container", + "type": "string" + }, + "aadTenantId": { + "description": "Protection container identity - AAD Tenant", + "type": "string" + }, + "servicePrincipalClientId": { + "description": "Protection container identity - AAD Service Principal", + "type": "string" + }, + "audience": { + "description": "Protection container identity - Audience", + "type": "string" + } + } + }, + "DistributedNodesInfo": { + "description": "This is used to represent the various nodes of the distributed container.", + "type": "object", + "properties": { + "nodeName": { + "description": "Name of the node under a distributed container.", + "type": "string" + }, + "status": { + "description": "Status of this Node.\r\nFailed | Succeeded", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Details if the Status is non-success." + }, + "sourceResourceId": { + "description": "ARM resource id of the node", + "type": "string" + } + } + }, + "DpmBackupEngine": { + "description": "Data Protection Manager (DPM) specific backup engine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupEngineBase" + } + ], + "x-ms-discriminator-value": "DpmBackupEngine" + }, + "DpmContainer": { + "description": "DPM workload-specific protection container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "canReRegister": { + "description": "Specifies whether the container is re-registrable.", + "type": "boolean" + }, + "containerId": { + "description": "ID of container.", + "type": "string" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of protected items in the BackupEngine", + "type": "integer" + }, + "dpmAgentVersion": { + "description": "Backup engine Agent version", + "type": "string" + }, + "dpmServers": { + "description": "List of BackupEngines protecting the container", + "type": "array", + "items": { + "type": "string" + } + }, + "upgradeAvailable": { + "description": "To check if upgrade available", + "type": "boolean" + }, + "protectionStatus": { + "description": "Protection status of the container.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/DPMContainerExtendedInfo", + "description": "Extended Info of the container." + } + }, + "x-ms-discriminator-value": "DPMContainer" + }, + "DPMContainerExtendedInfo": { + "description": "Additional information of the DPMContainer.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Last refresh time of the DPMContainer.", + "type": "string" + } + } + }, + "GenericContainer": { + "description": "Base class for generic container of backup items", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "fabricName": { + "description": "Name of the container's fabric", + "type": "string" + }, + "extendedInformation": { + "$ref": "#/definitions/GenericContainerExtendedInfo", + "description": "Extended information (not returned in List container API calls)" + } + }, + "x-ms-discriminator-value": "GenericContainer" + }, + "GenericContainerExtendedInfo": { + "description": "Container extended information", + "type": "object", + "properties": { + "rawCertData": { + "description": "Public key of container cert", + "type": "string" + }, + "containerIdentityInfo": { + "$ref": "#/definitions/ContainerIdentityInfo", + "description": "Container identity information" + }, + "serviceEndpoints": { + "description": "Azure Backup Service Endpoints for the container", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "IaasVMBackupRequest": { + "description": "IaaS VM workload-specific backup request.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupRequest" + } + ], + "properties": { + "recoveryPointExpiryTimeInUTC": { + "format": "date-time", + "description": "Backup copy will expire after the time specified (UTC).", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaasVMBackupRequest" + }, + "IaaSVMContainer": { + "description": "IaaS VM workload-specific container.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "virtualMachineId": { + "description": "Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.", + "type": "string" + }, + "virtualMachineVersion": { + "description": "Specifies whether the container represents a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of Recovery Services Vault.", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaasVMContainer" + }, + "IaasVMILRRegistrationRequest": { + "description": "Restore files/folders from a backup copy of IaaS VM.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ILRRequest" + } + ], + "properties": { + "recoveryPointId": { + "description": "ID of the IaaS VM backup copy from where the files/folders have to be restored.", + "type": "string" + }, + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored.", + "type": "string" + }, + "initiatorName": { + "description": "iSCSI initiator name.", + "type": "string" + }, + "renewExistingRegistration": { + "description": "Whether to renew existing registration with the iSCSI server.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "IaasVMILRRegistrationRequest" + }, + "IaaSVMProtectableItem": { + "description": "IaaS VM workload-specific backup item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/WorkloadProtectableItem" + } + ], + "properties": { + "virtualMachineId": { + "description": "Fully qualified ARM ID of the virtual machine.", + "type": "string" + }, + "virtualMachineVersion": { + "description": "Specifies whether the container represents a Classic or an Azure Resource Manager VM.", + "type": "string" + }, + "resourceGroup": { + "description": "Resource group name of Recovery Services Vault.", + "type": "string" + } + }, + "x-ms-discriminator-value": "IaaSVMProtectableItem" + }, + "ILRRequest": { + "description": "Parameters to Provision ILR API.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ILRRequestResource": { + "description": "Parameters to Provision ILR API.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ILRRequest", + "description": "ILRRequestResource properties" + } + } + }, + "InquiryInfo": { + "description": "Details about inquired protectable items under a given container.", + "type": "object", + "properties": { + "status": { + "description": "Inquiry Status for this container such as\r\nInProgress | Failed | Succeeded", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Details if the Status is non-success." + }, + "inquiryDetails": { + "description": "Inquiry Details which will have workload specific details.\r\nFor e.g. - For SQL and oracle this will contain different details.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadInquiryDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "InquiryValidation": { + "description": "Validation for inquired protectable items under a given container.", + "type": "object", + "properties": { + "status": { + "description": "Status for the Inquiry Validation.", + "type": "string" + }, + "errorDetail": { + "$ref": "#/definitions/ErrorDetail", + "description": "Error Detail in case the status is non-success." + }, + "additionalDetail": { + "description": "Error Additional Detail in case the status is non-success.", + "type": "string", + "readOnly": true + }, + "protectableItemCount": { + "description": "Dictionary to store the count of ProtectableItems with key POType.", + "type": "object", + "readOnly": true + } + } + }, + "InstantItemRecoveryTarget": { + "description": "Target details for file / folder restore.", + "type": "object", + "properties": { + "clientScripts": { + "description": "List of client scripts.", + "type": "array", + "items": { + "$ref": "#/definitions/ClientScriptForConnect" + }, + "x-ms-identifiers": [] + } + } + }, + "MabContainer": { + "description": "Container with items backed up using MAB backup engine.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainer" + } + ], + "properties": { + "canReRegister": { + "description": "Can the container be registered one more time.", + "type": "boolean" + }, + "containerId": { + "format": "int64", + "description": "ContainerID represents the container.", + "type": "integer" + }, + "protectedItemCount": { + "format": "int64", + "description": "Number of items backed up in this container.", + "type": "integer" + }, + "agentVersion": { + "description": "Agent version of this container.", + "type": "string" + }, + "extendedInfo": { + "$ref": "#/definitions/MabContainerExtendedInfo", + "description": "Additional information for this container" + }, + "mabContainerHealthDetails": { + "description": "Health details on this mab container.", + "type": "array", + "items": { + "$ref": "#/definitions/MABContainerHealthDetails" + }, + "x-ms-identifiers": [ + "code" + ] + }, + "containerHealthState": { + "description": "Health state of mab container.", + "type": "string" + } + }, + "x-ms-discriminator-value": "Windows" + }, + "MabContainerExtendedInfo": { + "description": "Additional information of the container.", + "type": "object", + "properties": { + "lastRefreshedAt": { + "format": "date-time", + "description": "Time stamp when this container was refreshed.", + "type": "string" + }, + "backupItemType": { + "description": "Type of backup items associated with this container.", + "enum": [ + "Invalid", + "VM", + "FileFolder", + "AzureSqlDb", + "SQLDB", + "Exchange", + "Sharepoint", + "VMwareVM", + "SystemState", + "Client", + "GenericDataSource", + "SQLDataBase", + "AzureFileShare", + "SAPHanaDatabase", + "SAPAseDatabase", + "SAPHanaDBInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupItemType", + "modelAsString": true + } + }, + "backupItems": { + "description": "List of backup items associated with this container.", + "type": "array", + "items": { + "type": "string" + } + }, + "policyName": { + "description": "Backup policy associated with this container.", + "type": "string" + }, + "lastBackupStatus": { + "description": "Latest backup status of this container.", + "type": "string" + } + } + }, + "MABContainerHealthDetails": { + "description": "MAB workload-specific Health Details.", + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Health Code", + "type": "integer" + }, + "title": { + "description": "Health Title", + "type": "string" + }, + "message": { + "description": "Health Message", + "type": "string" + }, + "recommendations": { + "description": "Health Recommended Actions", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "OperationStatus": { + "description": "Operation status.", + "type": "object", + "properties": { + "id": { + "description": "ID of the operation.", + "type": "string" + }, + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "status": { + "description": "Operation status.", + "enum": [ + "Invalid", + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "x-ms-enum": { + "name": "OperationStatusValues", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "Operation start time. Format: ISO-8601.", + "type": "string" + }, + "endTime": { + "format": "date-time", + "description": "Operation end time. Format: ISO-8601.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/OperationStatusError", + "description": "Error information related to this operation." + }, + "properties": { + "$ref": "#/definitions/OperationStatusExtendedInfo", + "description": "Additional information associated with this operation." + } + } + }, + "OperationStatusError": { + "description": "Error information associated with operation status call.", + "type": "object", + "properties": { + "code": { + "description": "Error code of the operation failure.", + "type": "string" + }, + "message": { + "description": "Error message displayed if the operation failure.", + "type": "string" + } + } + }, + "OperationStatusExtendedInfo": { + "description": "Base class for additional information of operation status.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "OperationStatusJobExtendedInfo": { + "description": "Operation status job extended info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "jobId": { + "description": "ID of the job created for this protected item.", + "type": "string" + } + }, + "x-ms-discriminator-value": "OperationStatusJobExtendedInfo" + }, + "OperationStatusJobsExtendedInfo": { + "description": "Operation status extended info for list of jobs.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "jobIds": { + "description": "IDs of the jobs created for the protected item.", + "type": "array", + "items": { + "type": "string" + } + }, + "failedJobsError": { + "description": "Stores all the failed jobs along with the corresponding error codes.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "OperationStatusJobsExtendedInfo" + }, + "OperationStatusProvisionILRExtendedInfo": { + "description": "Operation status extended info for ILR provision action.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "recoveryTarget": { + "$ref": "#/definitions/InstantItemRecoveryTarget", + "description": "Target details for file / folder restore." + } + }, + "x-ms-discriminator-value": "OperationStatusProvisionILRExtendedInfo" + }, + "OperationStatusValidateOperationExtendedInfo": { + "description": "Operation status extended info for ValidateOperation action.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/OperationStatusExtendedInfo" + } + ], + "properties": { + "validateOperationResponse": { + "$ref": "#/definitions/ValidateOperationResponse", + "description": "Gets the validation operation response" + } + }, + "x-ms-discriminator-value": "OperationStatusValidateOperationExtendedInfo" + }, + "PreBackupValidation": { + "description": "Pre-backup validation for Azure VM Workload provider.", + "type": "object", + "properties": { + "status": { + "description": "Status of protectable item, i.e. InProgress,Succeeded,Failed", + "enum": [ + "Invalid", + "Success", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "InquiryStatus", + "modelAsString": true + } + }, + "code": { + "description": "Error code of protectable item", + "type": "string" + }, + "message": { + "description": "Message corresponding to the error code for the protectable item", + "type": "string" + } + } + }, + "ProtectableContainer": { + "description": "Protectable Container Class.", + "type": "object", + "required": [ + "protectableContainerType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "protectableContainerType": { + "description": "Type of the container. The value of this property for\r\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer", + "Microsoft.ClassicCompute/virtualMachines", + "Microsoft.Compute/virtualMachines", + "AzureWorkloadContainer" + ], + "type": "string", + "readOnly": false, + "x-ms-enum": { + "name": "protectableContainerType", + "modelAsString": false + } + }, + "healthStatus": { + "description": "Status of health of the container.", + "type": "string" + }, + "containerId": { + "description": "Fabric Id of the container such as ARM Id.", + "type": "string" + } + }, + "discriminator": "protectableContainerType" + }, + "ProtectableContainerResource": { + "description": "Protectable Container Class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectableContainer", + "description": "ProtectableContainerResource properties" + } + } + }, + "ProtectableContainerResourceList": { + "description": "List of ProtectableContainer resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectableContainerResource" + } + } + } + }, + "ProtectionContainer": { + "description": "Base class for container with backup items. Containers with specific workloads are derived from this class.", + "type": "object", + "required": [ + "containerType" + ], + "properties": { + "friendlyName": { + "description": "Friendly name of the container.", + "type": "string" + }, + "backupManagementType": { + "description": "Type of backup management for the container.", + "enum": [ + "Invalid", + "AzureIaasVM", + "MAB", + "DPM", + "AzureBackupServer", + "AzureSql", + "AzureStorage", + "AzureWorkload", + "DefaultBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupManagementType", + "modelAsString": true + } + }, + "registrationStatus": { + "description": "Status of registration of the container with the Recovery Services Vault.", + "type": "string" + }, + "healthStatus": { + "description": "Status of health of the container.", + "type": "string" + }, + "containerType": { + "description": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer", + "enum": [ + "Invalid", + "Unknown", + "IaasVMContainer", + "IaasVMServiceContainer", + "DPMContainer", + "AzureBackupServerContainer", + "MABContainer", + "Cluster", + "AzureSqlContainer", + "Windows", + "VCenter", + "VMAppContainer", + "SQLAGWorkLoadContainer", + "StorageContainer", + "GenericContainer", + "Microsoft.ClassicCompute/virtualMachines", + "Microsoft.Compute/virtualMachines", + "AzureWorkloadContainer" + ], + "type": "string", + "x-ms-enum": { + "name": "protectableContainerType", + "modelAsString": true + } + }, + "protectableObjectType": { + "description": "Type of the protectable object associated with this container", + "type": "string" + } + }, + "discriminator": "containerType" + }, + "ProtectionContainerResource": { + "description": "Base class for container with backup items. Containers with specific workloads are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ProtectionContainer", + "description": "ProtectionContainerResource properties" + } + } + }, + "ProtectionContainerResourceList": { + "description": "List of ProtectionContainer resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ProtectionContainerResource" + } + } + } + }, + "SecurityPinBase": { + "description": "Base class for get security pin request body", + "type": "object", + "properties": { + "resourceGuardOperationRequests": { + "description": "ResourceGuard Operation Requests", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TokenInformation": { + "description": "The token information details.", + "type": "object", + "properties": { + "token": { + "description": "Token value.", + "type": "string" + }, + "expiryTimeInUtcTicks": { + "format": "int64", + "description": "Expiry time of token.", + "type": "integer" + }, + "securityPIN": { + "description": "Security PIN", + "type": "string" + } + } + }, + "WorkloadInquiryDetails": { + "description": "Details of an inquired protectable item.", + "type": "object", + "properties": { + "type": { + "description": "Type of the Workload such as SQL, Oracle etc.", + "type": "string" + }, + "itemCount": { + "format": "int64", + "description": "Contains the protectable item Count inside this Container.", + "type": "integer" + }, + "inquiryValidation": { + "$ref": "#/definitions/InquiryValidation", + "description": "Inquiry validation such as permissions and other backup validations." + } + } + }, + "WorkloadItem": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "type": "object", + "required": [ + "workloadItemType" + ], + "properties": { + "backupManagementType": { + "description": "Type of backup management to backup an item.", + "type": "string" + }, + "workloadType": { + "description": "Type of workload for the backup management", + "type": "string" + }, + "workloadItemType": { + "description": "Type of the backup item.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the backup item.", + "type": "string" + }, + "protectionState": { + "description": "State of the back up item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "workloadItemType" + }, + "WorkloadItemResource": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadItem", + "description": "WorkloadItemResource properties" + } + } + }, + "WorkloadItemResourceList": { + "description": "List of WorkloadItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadItemResource" + } + } + } + }, + "WorkloadProtectableItem": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "type": "object", + "required": [ + "protectableItemType" + ], + "properties": { + "backupManagementType": { + "description": "Type of backup management to backup an item.", + "type": "string" + }, + "workloadType": { + "description": "Type of workload for the backup management", + "type": "string" + }, + "protectableItemType": { + "description": "Type of the backup item.", + "type": "string" + }, + "friendlyName": { + "description": "Friendly name of the backup item.", + "type": "string" + }, + "protectionState": { + "description": "State of the back up item.", + "enum": [ + "Invalid", + "NotProtected", + "Protecting", + "Protected", + "ProtectionFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ProtectionStatus", + "modelAsString": true + } + } + }, + "discriminator": "protectableItemType" + }, + "WorkloadProtectableItemResource": { + "description": "Base class for backup item. Workload-specific backup items are derived from this class.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkloadProtectableItem", + "description": "WorkloadProtectableItemResource properties" + } + } + }, + "WorkloadProtectableItemResourceList": { + "description": "List of WorkloadProtectableItem resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/WorkloadProtectableItemResource" + } + } + } + }, + "AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest": { + "description": "AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaPointInTimeRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreWithRehydrateRequest" + }, + "AzureWorkloadSAPHanaRestoreWithRehydrateRequest": { + "description": "AzureWorkload SAP Hana-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSAPHanaRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSAPHanaRestoreWithRehydrateRequest" + }, + "AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest": { + "description": "AzureWorkload SQL-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLPointInTimeRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreWithRehydrateRequest" + }, + "AzureWorkloadSQLRestoreWithRehydrateRequest": { + "description": "AzureWorkload SQL-specific restore with integrated rehydration of recovery point", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureWorkloadSQLRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "AzureWorkloadSQLRestoreWithRehydrateRequest" + }, + "IaasVMRestoreWithRehydrationRequest": { + "description": "IaaS VM workload-specific restore with integrated rehydration of recovery point.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/IaasVMRestoreRequest" + } + ], + "properties": { + "recoveryPointRehydrationInfo": { + "$ref": "#/definitions/RecoveryPointRehydrationInfo", + "description": "RP Rehydration Info" + } + }, + "x-ms-discriminator-value": "IaasVMRestoreWithRehydrationRequest" + }, + "MoveRPAcrossTiersRequest": { + "type": "object", + "properties": { + "objectType": { + "description": "Gets the class type.", + "type": "string" + }, + "sourceTierType": { + "description": "Source tier from where RP needs to be moved", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "targetTierType": { + "description": "Target tier where RP needs to be moved", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + } + } + }, + "RecoveryPointMoveReadinessInfo": { + "type": "object", + "properties": { + "isReadyForMove": { + "type": "boolean" + }, + "additionalInfo": { + "type": "string" + } + } + }, + "RecoveryPointRehydrationInfo": { + "description": "RP Rehydration Info", + "type": "object", + "properties": { + "rehydrationRetentionDuration": { + "description": "How long the rehydrated RP should be kept\r\nShould be ISO8601 Duration format e.g. \"P7D\"", + "type": "string" + }, + "rehydrationPriority": { + "description": "Rehydration Priority", + "enum": [ + "Standard", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "RehydrationPriority", + "modelAsString": true + } + } + } + }, + "RecoveryPointProperties": { + "description": "Properties of Recovery Point", + "type": "object", + "properties": { + "expiryTime": { + "description": "Expiry time of Recovery Point in UTC.", + "type": "string" + }, + "ruleName": { + "description": "Rule name tagged on Recovery Point that governs life cycle", + "type": "string" + }, + "isSoftDeleted": { + "description": "Bool to indicate whether RP is in soft delete state or not", + "type": "boolean" + } + } + }, + "ListRecoveryPointsRecommendedForMoveRequest": { + "description": "ListRecoveryPointsRecommendedForMoveRequest Request", + "type": "object", + "properties": { + "objectType": { + "description": "Gets the class type.", + "type": "string" + }, + "excludedRPList": { + "description": "List of Recovery Points excluded from Move", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UnlockDeleteRequest": { + "description": "Request body of unlock delete API.", + "type": "object", + "properties": { + "resourceGuardOperationRequests": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourceToBeDeleted": { + "type": "string" + } + } + }, + "UnlockDeleteResponse": { + "description": "Response of Unlock Delete API.", + "type": "object", + "properties": { + "unlockDeleteExpiryTime": { + "description": "This is the time when unlock delete privileges will get expired.", + "type": "string" + } + } + }, + "ResourceGuardOperationDetail": { + "type": "object", + "properties": { + "vaultCriticalOperation": { + "type": "string" + }, + "defaultResourceRequest": { + "type": "string" + } + } + }, + "ResourceGuardProxyBase": { + "type": "object", + "required": [ + "resourceGuardResourceId" + ], + "properties": { + "resourceGuardResourceId": { + "type": "string" + }, + "resourceGuardOperationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardOperationDetail" + }, + "x-ms-identifiers": [] + }, + "lastUpdatedTime": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "ResourceGuardProxyBaseResource": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceGuardProxyBase", + "description": "ResourceGuardProxyBaseResource properties" + } + } + }, + "ResourceGuardProxyBaseResourceList": { + "description": "List of ResourceGuardProxyBase resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + } + } + }, + "TieringPolicy": { + "description": "Tiering Policy for a target tier.\r\nIf the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier", + "type": "object", + "properties": { + "tieringMode": { + "description": "Tiering Mode to control automatic tiering of recovery points. Supported values are:\r\n1. TierRecommended: Tier all recovery points recommended to be tiered\r\n2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below.\r\n3. DoNotTier: Do not tier any recovery points", + "enum": [ + "Invalid", + "TierRecommended", + "TierAfter", + "DoNotTier" + ], + "type": "string", + "x-ms-enum": { + "name": "TieringMode", + "modelAsString": true + } + }, + "duration": { + "format": "int32", + "description": "Number of days/weeks/months/years to retain backups in current tier before tiering.\r\nUsed only if TieringMode is set to TierAfter", + "type": "integer" + }, + "durationType": { + "description": "Retention duration type: days/weeks/months/years\r\nUsed only if TieringMode is set to TierAfter", + "enum": [ + "Invalid", + "Days", + "Weeks", + "Months", + "Years" + ], + "type": "string", + "x-ms-enum": { + "name": "RetentionDurationType", + "modelAsString": true + } + } + } + }, + "TieringCostInfo": { + "description": "Base class for tiering cost response", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "FetchTieringCostInfoForRehydrationRequest": { + "description": "Request parameters for fetching cost info of rehydration", + "required": [ + "objectType", + "containerName", + "protectedItemName", + "recoveryPointId", + "rehydrationPriority", + "sourceTierType", + "targetTierType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FetchTieringCostInfoRequest" + } + ], + "properties": { + "containerName": { + "description": "Name of the protected item container", + "type": "string" + }, + "protectedItemName": { + "description": "Name of the protectedItemName", + "type": "string" + }, + "recoveryPointId": { + "description": "ID of the backup copy for rehydration cost info needs to be fetched.", + "type": "string" + }, + "rehydrationPriority": { + "description": "Rehydration Priority", + "enum": [ + "Standard", + "High" + ], + "type": "string", + "x-ms-enum": { + "name": "RehydrationPriority", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "FetchTieringCostInfoForRehydrationRequest" + }, + "FetchTieringCostInfoRequest": { + "description": "Base class for tiering cost request.\r\nSpecific cost request types are derived from this class.", + "required": [ + "sourceTierType", + "targetTierType", + "objectType" + ], + "type": "object", + "properties": { + "sourceTierType": { + "description": "Source tier for the request", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "targetTierType": { + "description": "target tier for the request", + "enum": [ + "Invalid", + "InstantRP", + "HardenedRP", + "ArchivedRP" + ], + "type": "string", + "x-ms-enum": { + "name": "RecoveryPointTierType", + "modelAsString": false + } + }, + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "TieringCostRehydrationInfo": { + "description": "Response parameters for tiering cost info for rehydration", + "required": [ + "objectType", + "rehydrationSizeInBytes", + "retailRehydrationCostPerGBPerMonth" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TieringCostInfo" + } + ], + "properties": { + "rehydrationSizeInBytes": { + "format": "int64", + "description": "Rehydration size in bytes", + "type": "integer" + }, + "retailRehydrationCostPerGBPerMonth": { + "format": "double", + "description": "Source tier to target tier rehydration cost per GB per month", + "type": "number" + } + }, + "x-ms-discriminator-value": "TieringCostRehydrationInfo" + }, + "TieringCostSavingInfo": { + "description": "Response parameters for tiering cost info for savings", + "required": [ + "objectType", + "sourceTierSizeReductionInBytes", + "targetTierSizeIncreaseInBytes", + "retailSourceTierCostPerGBPerMonth", + "retailTargetTierCostPerGBPerMonth" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TieringCostInfo" + } + ], + "properties": { + "sourceTierSizeReductionInBytes": { + "format": "int64", + "description": "Source tier size reduction in bytes after moving all the recommended backup points to target tier", + "type": "integer" + }, + "targetTierSizeIncreaseInBytes": { + "format": "int64", + "description": "Target tier size increase in bytes after moving all the recommended backup points to target tier", + "type": "integer" + }, + "retailSourceTierCostPerGBPerMonth": { + "format": "double", + "description": "Source tier retail cost per GB per month", + "type": "number" + }, + "retailTargetTierCostPerGBPerMonth": { + "format": "double", + "description": "Target tier retail cost per GB per month", + "type": "number" + } + }, + "x-ms-discriminator-value": "TieringCostSavingInfo" + }, + "FetchTieringCostSavingsInfoForPolicyRequest": { + "description": "Request parameters for tiering cost info for policy", + "required": [ + "objectType", + "policyName", + "sourceTierType", + "targetTierType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FetchTieringCostInfoRequest" + } + ], + "properties": { + "policyName": { + "description": "Name of the backup policy for which the cost savings information is requested", + "type": "string" + } + }, + "x-ms-discriminator-value": "FetchTieringCostSavingsInfoForPolicyRequest" + }, + "FetchTieringCostSavingsInfoForProtectedItemRequest": { + "description": "Request parameters for tiering cost info for protected item", + "required": [ + "objectType", + "containerName", + "protectedItemName", + "sourceTierType", + "targetTierType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FetchTieringCostInfoRequest" + } + ], + "properties": { + "containerName": { + "description": "Name of the protected item container", + "type": "string" + }, + "protectedItemName": { + "description": "Name of the protectedItemName", + "type": "string" + } + }, + "x-ms-discriminator-value": "FetchTieringCostSavingsInfoForProtectedItemRequest" + }, + "FetchTieringCostSavingsInfoForVaultRequest": { + "description": "Request parameters for tiering cost info for vault", + "required": [ + "objectType", + "sourceTierType", + "targetTierType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FetchTieringCostInfoRequest" + } + ], + "x-ms-discriminator-value": "FetchTieringCostSavingsInfoForVaultRequest" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription Id.", + "required": true, + "type": "string" + }, + "AzureRegion": { + "name": "azureRegion", + "in": "path", + "description": "Azure region to hit Api", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group where the recovery services vault is present.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RestrictedVaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the recovery services vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$", + "minLength": 2, + "maxLength": 50 + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupFeature_Validate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupFeature_Validate.json new file mode 100644 index 000000000000..81c9604ec164 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupFeature_Validate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2024-07-30-preview", + "parameters": { + "featureType": "AzureVMResourceBackup", + "vmSize": "Basic_A0", + "vmSku": "Premium" + } + }, + "responses": { + "200": { + "body": { + "supportStatus": "DefaultOFF" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupPolicies_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupPolicies_List.json new file mode 100644 index 000000000000..54222c593054 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupPolicies_List.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureIaasVM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy", + "name": "DefaultPolicy", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2017-12-05T19:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2017-12-05T19:00:00Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + }, + "protectedItemsCount": 0 + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectableItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectableItems_List.json new file mode 100644 index 000000000000..fd7f1c91822f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectableItems_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureIaasVM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectableItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectableItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionState": "NotProtected", + "protectableItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectedItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectedItems_List.json new file mode 100644 index 000000000000..f2ad36ca2505 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/BackupProtectedItems_List.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureIaasVM' and itemType eq 'VM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json new file mode 100644 index 000000000000..ced610e51447 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ClassicCompute_ProtectedItem_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "protectedItemName": "vm;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.ClassicCompute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Compute_ProtectedItem_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Compute_ProtectedItem_Get.json new file mode 100644 index 000000000000..96700d82958f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Compute_ProtectedItem_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "protectedItemName": "vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "name": "VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "iaasvm-1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;iaasvm-rg;iaasvm-1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ConfigureProtection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ConfigureProtection.json new file mode 100644 index 000000000000..08115eca9c7f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ConfigureProtection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "protectedItemType": "Microsoft.Compute/virtualMachines", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/GetBackupStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/GetBackupStatus.json new file mode 100644 index 000000000000..7179f33a570b --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/GetBackupStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2024-07-30-preview", + "parameters": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm", + "resourceType": "VM" + } + }, + "responses": { + "200": { + "body": { + "protectionStatus": "Protected", + "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/Vaults/testVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;testRg;testVm", + "protectedItemName": "vm;iaasvmcontainerv2;testRg;testVm", + "policyName": "myPolicy", + "errorCode": "Success", + "errorMessage": "ErrorMessage" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationResults.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationResults.json new file mode 100644 index 000000000000..dc96f0991870 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationResults.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "Protected", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationStatus.json new file mode 100644 index 000000000000..b446f2faac83 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectedItemOperationStatus.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Succeeded", + "startTime": "2017-10-29T06:04:18.207325Z", + "endTime": "2017-10-29T06:04:18.207325Z", + "properties": { + "objectType": "OperationStatusJobExtendedInfo", + "jobId": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json new file mode 100644 index 000000000000..d95929faba58 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_CreateOrUpdate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/chamsrgtest/providers/Microsoft.Compute/virtualMachines/chamscandel", + "protectionIntentItemType": "AzureResourceItem", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "name": "vm;iaasvmcontainerv2;chamsrgtest;chamscandel", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "protectionIntentItemType": "AzureResourceItem", + "backupManagementType": "AzureIaasVM", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "protectionState": "Protected" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_Validate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_Validate.json new file mode 100644 index 000000000000..04051d403305 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionIntent_Validate.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "azureRegion": "southeastasia", + "api-version": "2024-07-30-preview", + "parameters": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/arunaupgrade/providers/Microsoft.Compute/VirtualMachines/upgrade1", + "resourceType": "VM", + "vaultId": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/Vaults/myVault", + "properties": "" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "errorCode": "VirtualMachineAlreadyProtected", + "errorMessage": "Virtual machine with same name and same resource group is already protected. Please select `Disable' choice above for backup and go to backup item corresponding to this VM in the vault", + "recommendation": "Please do not enable protection again.", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;arunaupgrade;upgrade1", + "protectedItemName": "vm;iaasvmcontainerv2;arunaupgrade;upgrade1" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..38f9d9b9af28 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Complex.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "Pacific Standard Time", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Monday", + "Wednesday", + "Thursday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Monday", + "Wednesday", + "Thursday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Wednesday", + "Thursday" + ], + "weeksOfTheMonth": [ + "First", + "Third" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "February", + "November" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Monday", + "Thursday" + ], + "weeksOfTheMonth": [ + "Fourth" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 4, + "durationType": "Years" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Monday", + "Wednesday", + "Thursday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Monday", + "Wednesday", + "Thursday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Wednesday", + "Thursday" + ], + "weeksOfTheMonth": [ + "First", + "Third" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "February", + "November" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Monday", + "Thursday" + ], + "weeksOfTheMonth": [ + "Fourth" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 4, + "durationType": "Years" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json new file mode 100644 index 000000000000..5ef77e183984 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_CreateOrUpdate_Simple.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "Pacific Standard Time", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Delete.json new file mode 100644 index 000000000000..0f351469539c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Get.json new file mode 100644 index 000000000000..0615e5222285 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicies_Get.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json new file mode 100644 index 000000000000..3b0652e7d446 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationResults_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 1 + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json new file mode 100644 index 000000000000..1bf631572ad1 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ProtectionPolicyOperationStatuses_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "GetProtectionPolicyOperationStatus", + "status": "Succeeded", + "startTime": "2018-01-24T12:57:32.1142968Z", + "endTime": "2018-01-24T12:57:32.1142968Z", + "properties": { + "objectType": "OperationStatusJobsExtendedInfo", + "jobIds": [ + "00000000-0000-0000-0000-000000000000" + ], + "failedJobsError": {} + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Provision_Ilr.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Provision_Ilr.json new file mode 100644 index 000000000000..6a6d6a303a15 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Provision_Ilr.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "recoveryPointId": "1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "initiatorName": "Hello World", + "recoveryPointId": "38823086363464", + "renewExistingRegistration": true, + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1", + "objectType": "IaasVMILRRegistrationRequest" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json new file mode 100644 index 000000000000..559ad3aefef8 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPointsRecommendedForMove_List.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "ListRecoveryPointsRecommendedForMoveRequest", + "excludedRPList": [ + "348916168024334", + "348916168024335" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/22244821112382", + "name": "22244821112382", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-21T22:48:25.4353958Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/24977149827250", + "name": "24977149827250", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-20T22:49:44.3317945Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Deleted" + }, + { + "type": "ArchivedRP", + "status": "Rehydrated", + "extendedInfo": { + "RehydratedRPExpiryTime": "2020-12-21T22:48:25.4353958Z" + } + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ] + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_Get.json new file mode 100644 index 000000000000..2fc053217231 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "recoveryPointId": "26083826328862", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/26083826328862", + "name": "26083826328862", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-11-22T22:32:46.6088472Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ], + "isPrivateAccessEnabledOnAnyDisk": true + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_List.json new file mode 100644 index 000000000000..361bcf46c7bd --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/RecoveryPoints_List.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rshhtestmdvmrg", + "vaultName": "rshvault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "protectedItemName": "VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/22244821112382", + "name": "22244821112382", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-21T22:48:25.4353958Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "recoveryPointMoveReadinessInfo": { + "Archive": { + "isReadyForMove": true + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rshhtestmdvmrg/providers/Microsoft.RecoveryServices/vaults/rshvault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/protectedItems/VM;iaasvmcontainerv2;rshhtestmdvmrg;rshmdvmsmall/recoveryPoints/24977149827250", + "name": "24977149827250", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2017-12-20T22:49:44.3317945Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "NormalStorage", + "isSourceVMEncrypted": false, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Deleted" + }, + { + "type": "HardenedRP", + "status": "Deleted" + }, + { + "type": "ArchivedRP", + "status": "Rehydrated", + "extendedInfo": { + "RehydratedRPExpiryTime": "2020-12-21T22:48:25.4353958Z" + } + } + ], + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": false, + "additionalInfo": "Recovery point cannot be moved to archive tier since it has already been moved." + } + }, + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D1", + "originalStorageAccountOption": false, + "zones": [ + "1" + ], + "isPrivateAccessEnabledOnAnyDisk": true + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/FijiValidation-asr-microsoftrrdclab3-408/providers/Microsoft.RecoveryServices/vaults/testVault408/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;fijivalidation-asr-microsoftrrdclab3-408;vm408/protectedItems/VM;iaasvmcontainerv2;fijivalidation-asr-microsoftrrdclab3-408;vm408/recoveryPoints/70477518625276", + "name": "70477518625276", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "IaasVMRecoveryPoint", + "recoveryPointType": "CrashConsistent", + "recoveryPointTime": "2023-09-22T20:02:00.1225746Z", + "recoveryPointAdditionalInfo": "", + "sourceVMStorageType": "PremiumVMOnPartialPremiumStorage", + "isSourceVMEncrypted": true, + "isInstantIlrSessionActive": false, + "recoveryPointTierDetails": [ + { + "type": "InstantRP", + "status": "Valid" + }, + { + "type": "HardenedRP", + "status": "Valid" + } + ], + "isManagedVirtualMachine": true, + "virtualMachineSize": "Standard_D2s_v3", + "originalStorageAccountOption": false, + "osType": "Windows", + "recoveryPointMoveReadinessInfo": { + "ArchivedRP": { + "isReadyForMove": false, + "additionalInfo": "We're still determining if this Recovery Point can be moved.. Please check again after some time." + } + }, + "extendedLocation": { + "name": "microsoftrrdclab3", + "type": "EdgeZone" + }, + "securityType": "None", + "isPrivateAccessEnabledOnAnyDisk": false + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Revoke_Ilr.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Revoke_Ilr.json new file mode 100644 index 000000000000..61a3a566d247 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/Revoke_Ilr.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "recoveryPointId": "1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/StopProtection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/StopProtection.json new file mode 100644 index 000000000000..6c7a6673e70d --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/StopProtection.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "protectedItemType": "Microsoft.Compute/virtualMachines", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionState": "ProtectionStopped" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "name": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems", + "properties": { + "friendlyName": "netvmtestv2vm1", + "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "protectionStatus": "Healthy", + "protectionState": "ProtectionStopped", + "healthStatus": "Passed", + "lastBackupStatus": "Completed", + "lastBackupTime": "2018-01-22T12:25:32.048723Z", + "protectedItemDataId": "636482643132986882", + "protectedItemType": "Microsoft.Compute/virtualMachines", + "backupManagementType": "AzureIaasVM", + "workloadType": "VM", + "containerName": "iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1", + "lastRecoveryPoint": null + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json new file mode 100644 index 000000000000..5e5029274053 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "AlternateLocation", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435", + "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount", + "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default", + "region": "southeastasia", + "createNewCloudService": false, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": true + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json new file mode 100644 index 000000000000..5970d7c26386 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "AlternateLocation", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435", + "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2", + "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default", + "region": "southeastasia", + "createNewCloudService": false, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": true + }, + "identityBasedRestoreDetails": { + "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json new file mode 100644 index 000000000000..ec0e8567098c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ALR_IaasVMRestoreWithRehydrationRequest.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreWithRehydrationRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "AlternateLocation", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "targetVirtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2/providers/Microsoft.Compute/virtualmachines/RSMDALRVM981435", + "targetResourceGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg2", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Storage/storageAccounts/testingAccount", + "virtualNetworkId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Network/virtualNetworks/testNet/subnets/default", + "region": "southeastasia", + "createNewCloudService": false, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "recoveryPointRehydrationInfo": { + "rehydrationRetentionDuration": "P7D", + "rehydrationPriority": "High" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json new file mode 100644 index 000000000000..c60593aaa162 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_ResourceGuardEnabled.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + }, + "identityBasedRestoreDetails": { + "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount" + }, + "resourceGuardOperationRequests": [ + "/subscriptions/063bf7bc-e4dc-4cde-8840-8416fbd7921e/resourcegroups/ankurRG1/providers/Microsoft.DataProtection/resourceGuards/RG341/triggerRestoreRequests/default" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json new file mode 100644 index 000000000000..8808145a27a5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + }, + "targetDiskNetworkAccessSettings": { + "targetDiskNetworkAccessOption": "EnablePrivateAccessForAllDisks", + "targetDiskAccessId": "/subscriptions/e7a191f5-713c-4bdb-b5e4-cf3dd90230ef/resourceGroups/arpja/providers/Microsoft.Compute/diskAccesses/arpja-diskaccess-ccy" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json new file mode 100644 index 000000000000..5e99b2b37794 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreRequest_IdentityBasedRestoreDetails.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + }, + "identityBasedRestoreDetails": { + "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json new file mode 100644 index 000000000000..5ff52b483d4c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerRestore_RestoreDisks_IaasVMRestoreWithRehydrationRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMRestoreWithRehydrationRequest", + "recoveryPointId": "348916168024334", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "recoveryPointRehydrationInfo": { + "rehydrationRetentionDuration": "P7D", + "rehydrationPriority": "Standard" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json new file mode 100644 index 000000000000..2b1f03d08885 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/TriggerValidateOperation_RestoreDisk.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVault/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;testRG;testvmName/protectedItems/VM;iaasvmcontainerv2;testRG;testvmName/recoveryPoints/348916168024334", + "properties": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupValidateOperationResults/00000000-0000-0000-0000-000000000000?api-version=2022-03-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupValidateOperationsStatuses/00000000-0000-0000-0000-000000000000?api-version=2022-03-01", + "Retry-After": 10 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json new file mode 100644 index 000000000000..4195140451f9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_daily.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "v2-daily-sample", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "India Standard Time", + "instantRpRetentionRangeInDays": 30, + "policyType": "V2", + "snapshotConsistencyType": "OnlyCrashConsistent", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Daily", + "dailySchedule": { + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ] + } + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionDuration": { + "count": 180, + "durationType": "Days" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "monthlySchedule": { + "retentionDuration": { + "count": 60, + "durationType": "Months" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "yearlySchedule": { + "monthsOfYear": [ + "January" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample", + "name": "v2-daily-sample", + "properties": { + "backupManagementType": "AzureIaasVM", + "instantRpRetentionRangeInDays": 30, + "policyType": "V2", + "snapshotConsistencyType": "OnlyCrashConsistent", + "protectedItemsCount": 0, + "resourceGuardOperationRequests": null, + "retentionPolicy": { + "dailySchedule": { + "retentionDuration": { + "count": 180, + "durationType": "Days" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "monthlySchedule": { + "retentionDuration": { + "count": 60, + "durationType": "Months" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "yearlySchedule": { + "monthsOfYear": [ + "January" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + } + }, + "schedulePolicy": { + "dailySchedule": { + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ] + }, + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Daily" + }, + "timeZone": "India Standard Time" + }, + "type": "Microsoft.RecoveryServices/vaults/backupPolicies" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample/operations/00000000-0000-0000-0000-000000000000?api-version=2020-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json new file mode 100644 index 000000000000..236f8c07be85 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/IaaS_v2_hourly.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "v2-daily-sample", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureIaasVM", + "timeZone": "India Standard Time", + "instantRpRetentionRangeInDays": 30, + "policyType": "V2", + "snapshotConsistencyType": "OnlyCrashConsistent", + "schedulePolicy": { + "hourlySchedule": { + "interval": 4, + "scheduleWindowDuration": 16, + "scheduleWindowStartTime": "2021-12-17T08:00:00Z" + }, + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Hourly" + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionDuration": { + "count": 180, + "durationType": "Days" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "monthlySchedule": { + "retentionDuration": { + "count": 60, + "durationType": "Months" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "yearlySchedule": { + "monthsOfYear": [ + "January" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample", + "name": "v2-daily-sample", + "properties": { + "backupManagementType": "AzureIaasVM", + "instantRpRetentionRangeInDays": 30, + "policyType": "V2", + "snapshotConsistencyType": "OnlyCrashConsistent", + "protectedItemsCount": 0, + "resourceGuardOperationRequests": null, + "retentionPolicy": { + "dailySchedule": { + "retentionDuration": { + "count": 180, + "durationType": "Days" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "monthlySchedule": { + "retentionDuration": { + "count": 60, + "durationType": "Months" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + }, + "yearlySchedule": { + "monthsOfYear": [ + "January" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + }, + "retentionScheduleDaily": null, + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-12-17T08:00:00+00:00" + ] + } + }, + "schedulePolicy": { + "hourlySchedule": { + "interval": 4, + "scheduleWindowDuration": 16, + "scheduleWindowStartTime": "2021-12-17T08:00:00Z" + }, + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Hourly" + }, + "timeZone": "India Standard Time" + }, + "type": "Microsoft.RecoveryServices/vaults/backupPolicies" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample/operations/00000000-0000-0000-0000-000000000000?api-version=2020-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json new file mode 100644 index 000000000000..064b8bfc5a26 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-Get-Policy.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "v2-daily-sample", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-sample", + "name": "v2-daily-sample", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "instantRpRetentionRangeInDays": 30, + "policyType": "V2", + "snapshotConsistencyType": "OnlyCrashConsistent", + "schedulePolicy": { + "dailySchedule": { + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ] + }, + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Daily" + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0, + "resourceGuardOperationRequests": null + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-List-Policies.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-List-Policies.json new file mode 100644 index 000000000000..0c11411db466 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/V2Policy/v2-List-Policies.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureIaasVM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/DefaultPolicy", + "name": "DefaultPolicy", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2017-12-05T19:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2017-12-05T19:00:00Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + }, + "protectedItemsCount": 0 + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2018-01-24T02:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/v2-daily-policy", + "name": "v2-daily-policy", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureIaasVM", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicyV2", + "scheduleRunFrequency": "Daily", + "dailySchedule": { + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ] + } + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2018-01-24T02:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Days" + } + } + }, + "timeZone": "Pacific Standard Time", + "protectedItemsCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationResults.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationResults.json new file mode 100644 index 000000000000..44c1ec7cb111 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationResults.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupValidateOperationResults/00000000-0000-0000-0000-000000000000?api-version=2022-03-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupValidateOperationsStatuses/00000000-0000-0000-0000-000000000000?api-version=2022-03-01", + "Retry-After": 10 + } + }, + "200": { + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationStatus.json new file mode 100644 index 000000000000..95dae30cc3b1 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperationStatus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Succeeded", + "startTime": "2017-10-29T06:04:18.207325Z", + "endTime": "2017-10-29T06:04:18.207325Z", + "properties": { + "objectType": "OperationStatusValidateOperationExtendedInfo", + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json new file mode 100644 index 000000000000..db5962707a92 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVault/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;testRG;testvmName/protectedItems/VM;iaasvmcontainerv2;testRG;testvmName/recoveryPoints/348916168024334", + "properties": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "storageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json new file mode 100644 index 000000000000..472e64cf5e4c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureIaasVm/ValidateOperation_RestoreDisk_IdentityBasedRestoreDetails.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testRG;testvmName", + "protectedItemName": "VM;iaasvmcontainerv2;testRG;testvmName", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVault/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;testRG;testvmName/protectedItems/VM;iaasvmcontainerv2;testRG;testvmName/recoveryPoints/348916168024334", + "properties": { + "objectType": "ValidateIaasVMRestoreOperationRequest", + "restoreRequest": { + "recoveryPointId": "348916168024334", + "objectType": "IaasVMRestoreRequest", + "recoveryType": "RestoreDisks", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.Compute/virtualMachines/netvmtestv2vm1", + "region": "southeastasia", + "createNewCloudService": true, + "originalStorageAccountOption": false, + "encryptionDetails": { + "encryptionEnabled": false + }, + "identityInfo": { + "isSystemAssignedIdentity": false, + "managedIdentityResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/asmaskarRG1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/asmaskartestmsi" + }, + "identityBasedRestoreDetails": { + "targetStorageAccountId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testingRg/providers/Microsoft.Storage/storageAccounts/testAccount" + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "validateOperationResponse": { + "validationResults": [ + { + "code": "UserErrorCoreCountSubscriptionQuotaReached", + "message": "Core Count subscription quota has been reached.", + "recommendations": [ + "Contact Azure support to increase the limits." + ] + } + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectableContainers_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectableContainers_List.json new file mode 100644 index 000000000000..8fb69634773f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectableContainers_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testvault", + "fabricName": "Azure", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureStorage' and workloadType eq 'AzureFileShare'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;storage;test-rg;teststorage", + "name": "StorageContainer;storage;test-rg;testst", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers", + "properties": { + "friendlyName": "teststorage", + "backupManagementType": "AzureStorage", + "protectableContainerType": "StorageContainer", + "healthStatus": "Healthy", + "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.Storage/storageAccounts/teststorage" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectableContainers/StorageContainer;ClassicStorage;test-rg;teststorage", + "name": "StorageContainer;ClassicStorage;test-rg;teststorage", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectableContainers", + "properties": { + "friendlyName": "teststorage", + "backupManagementType": "AzureStorage", + "protectableContainerType": "StorageContainer", + "healthStatus": "Healthy", + "containerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.ClassicStorage/storageAccounts/teststorage" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire.json new file mode 100644 index 000000000000..b10538cf286a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "testvault", + "fabricName": "Azure", + "containerName": "storagecontainer;Storage;test-rg;teststorage", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire_Result.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire_Result.json new file mode 100644 index 000000000000..7c54e91c7393 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Inquire_Result.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "testvault", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;testRG;testSQL", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "name": "VMAppContainer;Compute;testRG;testSQL", + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "extendedInfo": { + "hostServerName": "testsql", + "nodesList": [], + "inquiryInfo": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + }, + "inquiryDetails": [ + { + "type": "sql", + "itemCount": 14, + "inquiryValidation": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + } + } + } + ] + } + }, + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "backupManagementType": "AzureWorkload", + "workloadType": null, + "containerType": "VMAppContainer", + "friendlyName": "testSQL" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_List.json new file mode 100644 index 000000000000..2ab671c278bb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "fabricName": "Azure", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourcegroups/testrg/providers/microsoft.recoveryservices/vaults/suchandr-test-vault-wcus/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;testrg;suchandrtestsa125", + "name": "StorageContainer;Storage;testrg;suchandrtestsa125", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "sourceResourceId": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/suchandrtestsa125", + "protectedItemCount": 2, + "friendlyName": "suchandrtestsa125", + "backupManagementType": "AzureStorage", + "registrationStatus": "Registered", + "healthStatus": "Healthy", + "containerType": "StorageContainer" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Register.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Register.json new file mode 100644 index 000000000000..2319d16ec683 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionContainers_Register.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "swaggertestvault", + "fabricName": "Azure", + "containerName": "StorageContainer;Storage;SwaggerTestRg;swaggertestsa", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "friendlyName": "swaggertestsa", + "backupManagementType": "AzureStorage", + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa", + "containerType": "StorageContainer", + "acquireStorageAccountLock": "Acquire" + } + } + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2019-05-13-preview", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa", + "name": "StorageContainer;Storage;SwaggerTestRg;swaggertestsa", + "properties": { + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa", + "protectedItemCount": 0, + "acquireStorageAccountLock": "Acquire", + "friendlyName": "swaggertestsa", + "backupManagementType": "AzureStorage", + "registrationStatus": "Registered", + "healthStatus": "Healthy", + "containerType": "StorageContainer" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json new file mode 100644 index 000000000000..c8bfea13f862 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Daily.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "swaggertestvault", + "policyName": "dailyPolicy2", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureStorage", + "workLoadType": "AzureFileShare", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2021-09-29T08:00:00.000Z" + ] + }, + "timeZone": "UTC", + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2021-09-29T08:00:00.000Z" + ], + "retentionDuration": { + "count": 5, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": [ + "2021-09-29T08:00:00.000Z" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T08:00:00.000Z" + ], + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T08:00:00.000Z" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/dailyPolicy2", + "name": "dailyPolicy2", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureStorage", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2021-09-29T08:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2021-09-29T08:00:00Z" + ], + "retentionDuration": { + "count": 5, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": [ + "2021-09-29T08:00:00Z" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T08:00:00Z" + ], + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T08:00:00Z" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + }, + "timeZone": "UTC", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/dailyPolicy2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/dailyPolicy2/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hardened.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hardened.json new file mode 100644 index 000000000000..fb724d79f77a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hardened.json @@ -0,0 +1,187 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "swaggertestvault", + "policyName": "newPolicyV2", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureStorage", + "workLoadType": "AzureFileShare", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2023-07-18T09:30:00.000Z" + ] + }, + "timeZone": "UTC", + "vaultRetentionPolicy": { + "snapshotRetentionInDays": 5, + "vaultRetention": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicyV2", + "name": "newPolicyV2", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureStorage", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2023-07-18T09:30:00.000Z" + ] + }, + "vaultRetentionPolicy": { + "snapshotRetentionInDays": 5, + "vaultRetention": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2023-07-18T09:30:00.000Z" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + } + }, + "timeZone": "UTC", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicyV2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicyV2/operations/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json new file mode 100644 index 000000000000..df0e1b32c931 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/ProtectionPolicies_CreateOrUpdate_Hourly.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "swaggertestvault", + "policyName": "newPolicy2", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureStorage", + "workLoadType": "AzureFileShare", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Hourly", + "hourlySchedule": { + "interval": 4, + "scheduleWindowStartTime": "2021-09-29T08:00:00.000Z", + "scheduleWindowDuration": 12 + } + }, + "timeZone": "UTC", + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": null, + "retentionDuration": { + "count": 5, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": null, + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": null, + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleDaily": null, + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": null, + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicy2", + "name": "newPolicy2", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureStorage", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Hourly", + "hourlySchedule": { + "interval": 4, + "scheduleWindowStartTime": "2021-09-29T08:00:00Z", + "scheduleWindowDuration": 12 + }, + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2021-09-29T20:00:00Z" + ], + "retentionDuration": { + "count": 5, + "durationType": "Days" + } + }, + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday" + ], + "retentionTimes": [ + "2021-09-29T20:00:00Z" + ], + "retentionDuration": { + "count": 12, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T20:00:00Z" + ], + "retentionDuration": { + "count": 60, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "First" + ] + }, + "retentionTimes": [ + "2021-09-29T20:00:00Z" + ], + "retentionDuration": { + "count": 10, + "durationType": "Years" + } + } + }, + "timeZone": "UTC", + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicy2/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupPolicies/newPolicy2/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/SoftDeletedContainers_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/SoftDeletedContainers_List.json new file mode 100644 index 000000000000..cd736e424808 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureStorage/SoftDeletedContainers_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "fabricName": "Azure", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourcegroups/testrg/providers/microsoft.recoveryservices/vaults/suchandr-test-vault-wcus/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;testrg;suchandrtestsa125", + "name": "StorageContainer;Storage;testrg;suchandrtestsa125", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "sourceResourceId": "/subscriptions/172424a4-d65f-421e-a8de-197d98aabeba/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/suchandrtestsa125", + "protectedItemCount": 2, + "friendlyName": "suchandrtestsa125", + "backupManagementType": "AzureStorage", + "registrationStatus": "SoftDeleted", + "healthStatus": "Healthy", + "containerType": "StorageContainer" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupPolicies_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupPolicies_List.json new file mode 100644 index 000000000000..03b8434adb87 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupPolicies_List.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/HourlyLogBackup", + "name": "HourlyLogBackup", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "UTC", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Daily", + "scheduleRunTimes": [ + "2017-12-05T19:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "dailySchedule": { + "retentionTimes": [ + "2017-12-05T19:00:00Z" + ], + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 30, + "durationType": "Days" + } + } + } + ], + "protectedItemsCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Delete.json new file mode 100644 index 000000000000..132604970796 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "249D9B07-D2EF-4202-AA64-65F35418564E", + "api-version": "2024-07-30-preview", + "parameters": {} + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Get.json new file mode 100644 index 000000000000..da6552ed07e8 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "fabricName": "Azure", + "intentObjectName": "249D9B07-D2EF-4202-AA64-65F35418564E", + "api-version": "2024-07-30-preview", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E", + "name": "249D9B07-D2EF-4202-AA64-65F35418564E", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "protectionIntentItemType": "AzureWorkloadContainerAutoProtectionIntent", + "backupManagementType": "AzureWorkload", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_List.json new file mode 100644 index 000000000000..deb88c05f17c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupProtectionIntent_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myRG", + "vaultName": "myVault", + "api-version": "2024-07-30-preview", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupFabrics/Azure/backupProtectionIntent/249D9B07-D2EF-4202-AA64-65F35418564E", + "name": "249D9B07-D2EF-4202-AA64-65F35418564E", + "type": "Microsoft.RecoveryServices/vaults/backupProtectionIntent", + "properties": { + "protectionIntentItemType": "AzureWorkloadContainerAutoProtectionIntent", + "backupManagementType": "AzureWorkload", + "policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupPolicies/myPolicy", + "itemId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/myVault/backupProtectionContainer/VMAppContainer;Compute;testVmName/backupProtectableItems/SQLInstance;MSSQLSERVER" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupWorkloadItems_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupWorkloadItems_List.json new file mode 100644 index 000000000000..dc00f3fb31af --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/BackupWorkloadItems_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "suchandr-seacan-rsv", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureWorkload'", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;bvtdtestag;sqlserver-1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/testRg/providers/Microsoft.RecoveryServices/vaults/suchandr-seacan-rsv/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;bvtdtestag;sqlserver-1/protectableItems/SQLInstance;MSSQLSERVER", + "name": "SQLInstance;MSSQLSERVER", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/items", + "properties": { + "dataDirectoryPaths": [ + { + "type": "Data", + "path": "F:\\DATA\\" + }, + { + "type": "Log", + "path": "F:\\LOG\\" + } + ], + "parentName": "MSSQLSERVER", + "serverName": "sqlserver-1.contoso.com", + "isAutoProtectable": true, + "subinquireditemcount": 0, + "subWorkloadItemCount": 3, + "backupManagementType": "AzureWorkload", + "workloadType": "SQL", + "workloadItemType": "SQLInstance", + "friendlyName": "MSSQLSERVER", + "protectionState": "NotProtected" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Get.json new file mode 100644 index 000000000000..66739b1b98d4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Get.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "VMAppContainer;Compute;testRG;testSQL", + "api-version": "2024-07-30-preview", + "$filter": "backupManagementType eq 'AzureWorkload'" + }, + "responses": { + "200": { + "body": { + "name": "VMAppContainer;Compute;testRG;testSQL", + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/VMAppContainer;Compute;testRG;testSQL", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers", + "properties": { + "extendedInfo": { + "hostServerName": "testsql", + "nodesList": [], + "inquiryInfo": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + }, + "inquiryDetails": [ + { + "type": "sql", + "itemCount": 14, + "inquiryValidation": { + "status": "Success", + "errorDetail": { + "code": "Success", + "message": "Not Available", + "recommendations": [ + "Not Available" + ] + } + } + } + ] + } + }, + "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.Compute/virtualMachines/testSQL", + "backupManagementType": "AzureWorkload", + "workloadType": null, + "containerType": "VMAppContainer", + "friendlyName": "testSQL" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Unregister.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Unregister.json new file mode 100644 index 000000000000..7e140f7e65fd --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionContainers_Unregister.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "fabricName": "Azure", + "containerName": "storagecontainer;Storage;test-rg;teststorage" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-rg/providers/Microsoft.RecoveryServices/vaults/testvault/backupFabrics/Azure/protectionContainers/storagecontainer;Storage;test-rg;teststorage/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json new file mode 100644 index 000000000000..54e19b25eac4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json @@ -0,0 +1,260 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "policyName": "testPolicy1", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "Pacific Standard Time", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Sunday", + "Tuesday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday", + "Tuesday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Second" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January", + "June", + "December" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Last" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Years" + } + } + } + }, + { + "policyType": "Differential", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleRunDays": [ + "Friday" + ] + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 8, + "durationType": "Days" + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 7, + "durationType": "Days" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1", + "name": "testPolicy1", + "type": "Microsoft.RecoveryServices/vaults/backupPolicies", + "properties": { + "backupManagementType": "AzureWorkload", + "workLoadType": "SQLDataBase", + "settings": { + "timeZone": "Pacific Standard Time", + "issqlcompression": false + }, + "subProtectionPolicy": [ + { + "policyType": "Full", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Sunday", + "Tuesday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "LongTermRetentionPolicy", + "weeklySchedule": { + "daysOfTheWeek": [ + "Sunday", + "Tuesday" + ], + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 2, + "durationType": "Weeks" + } + }, + "monthlySchedule": { + "retentionScheduleFormatType": "Weekly", + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Second" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Months" + } + }, + "yearlySchedule": { + "retentionScheduleFormatType": "Weekly", + "monthsOfYear": [ + "January", + "June", + "December" + ], + "retentionScheduleWeekly": { + "daysOfTheWeek": [ + "Sunday" + ], + "weeksOfTheMonth": [ + "Last" + ] + }, + "retentionTimes": [ + "2018-01-24T10:00:00Z" + ], + "retentionDuration": { + "count": 1, + "durationType": "Years" + } + } + } + }, + { + "policyType": "Differential", + "schedulePolicy": { + "schedulePolicyType": "SimpleSchedulePolicy", + "scheduleRunFrequency": "Weekly", + "scheduleRunDays": [ + "Friday" + ], + "scheduleRunTimes": [ + "2018-01-24T10:00:00Z" + ], + "scheduleWeeklyFrequency": 0 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 8, + "durationType": "Days" + } + } + }, + { + "policyType": "Log", + "schedulePolicy": { + "schedulePolicyType": "LogSchedulePolicy", + "scheduleFrequencyInMins": 60 + }, + "retentionPolicy": { + "retentionPolicyType": "SimpleRetentionPolicy", + "retentionDuration": { + "count": 7, + "durationType": "Days" + } + } + } + ], + "protectedItemsCount": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1/operations/00000000-0000-0000-0000-000000000000?api-version=2016-06-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json new file mode 100644 index 000000000000..00377755754f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "name": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "status": "Succeeded", + "startTime": "2020-02-27T11:59:47.5901592Z", + "endTime": "2020-02-27T11:59:47.5901592Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json new file mode 100644 index 000000000000..9bb1733039f3 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMoveOperationResult_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/operationResult/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + }, + "200": { + "body": { + "objectType": "PrepareDataMoveResponse" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMove_Post.json new file mode 100644 index 000000000000..8bd07b8dd0b9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/PrepareDataMove_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sourceRG", + "vaultName": "source-rsv", + "api-version": "2024-07-30-preview", + "parameters": { + "targetResourceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/targetRG/providers/Microsoft.RecoveryServices/vaults/target-rsv", + "targetRegion": "USGov Virginia", + "dataMoveLevel": "Vault" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/prepareDataMove/operationResult/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/backupDataMove/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/TriggerDataMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/TriggerDataMove_Post.json new file mode 100644 index 000000000000..f2180b43dafa --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupDataMove/TriggerDataMove_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "targetRG", + "vaultName": "target-rsv", + "api-version": "2024-07-30-preview", + "parameters": { + "sourceResourceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv", + "sourceRegion": "USGov Iowa", + "dataMoveLevel": "Vault", + "correlationId": "MTg2OTcyMzM4NzYyMjc1NDY3Nzs1YmUzYmVmNi04YjJiLTRhOTItOTllYi01NTM0MDllYjk2NjE=" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sourceRG/providers/Microsoft.RecoveryServices/vaults/source-rsv/backupStorageConfig/vaultStorageConfig/backupDataMove/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2020-07-01-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Get.json new file mode 100644 index 000000000000..370a3ffef211 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "rishgrp", + "vaultName": "rishTestVault", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rishgrp/providers/Microsoft.RecoveryServicesBVTD2/vaults/rishTestVault/backupEncryptionConfigs/backupResourceEncryptionConfig", + "name": "backupResourceEncryptionConfig", + "type": "Microsoft.RecoveryServices/vaults/backupEncryptionConfigs", + "properties": { + "userAssignedIdentity": "/subscriptions/85bf5e8c-3084-4f42-add2-746ebb7e97b2/resourcegroups/defaultrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/examplemsi", + "useSystemAssignedIdentity": false, + "encryptionAtRestType": "CustomerManaged", + "keyUri": "https://gktestkv1.vault.azure.net/keys/Test1/ed2e8cdc7f86477ebf0c6462b504a9ed", + "subscriptionId": "1a2311d9-66f5-47d3-a9fb-7a37da63934b", + "lastUpdateStatus": "Succeeded", + "infrastructureEncryptionState": "Disabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Put.json new file mode 100644 index 000000000000..d2628fee9205 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/BackupResourceEncryptionConfig_Put.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "test-rg", + "vaultName": "source-rsv", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "encryptionAtRestType": "CustomerManaged", + "keyUri": "https://gktestkv1.vault.azure.net/keys/Test1/ed2e8cdc7f86477ebf0c6462b504a9ed", + "subscriptionId": "1a2311d9-66f5-47d3-a9fb-7a37da63934b", + "infrastructureEncryptionState": "true" + } + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectedItem_UsageSummary_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectedItem_UsageSummary_Get.json new file mode 100644 index 000000000000..7512087b4946 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectedItem_UsageSummary_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "$filter": "type eq 'BackupProtectedItemCountSummary'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 7, + "limit": -1, + "name": { + "value": "AzureIaasVM", + "localizedValue": "Azure Virtual Machine" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "MAB", + "localizedValue": "Azure Backup Agent" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "AzureBackupServer", + "localizedValue": "Azure Backup Server" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureStorage", + "localizedValue": "Azure Storage (Azure Files)" + } + }, + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureWorkload", + "localizedValue": "SQL in Azure VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectionContainers_UsageSummary_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectionContainers_UsageSummary_Get.json new file mode 100644 index 000000000000..50056204d6bb --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupProtectionContainers_UsageSummary_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "$filter": "type eq 'BackupProtectionContainerCountSummary'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 2, + "limit": -1, + "name": { + "value": "AzureBackupServer", + "localizedValue": "Azure Backup Server" + } + }, + { + "unit": "Count", + "currentValue": 3, + "limit": -1, + "name": { + "value": "MAB", + "localizedValue": "Azure Backup Agent" + } + }, + { + "unit": "Count", + "currentValue": 1, + "limit": -1, + "name": { + "value": "AzureWorkload", + "localizedValue": "SQL in Azure VM" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Get.json new file mode 100644 index 000000000000..97599485cb6e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Patch.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Patch.json new file mode 100644 index 000000000000..5ca86be3688c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Patch.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "enhancedSecurityState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Put.json new file mode 100644 index 000000000000..6b2b5f5a75f5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupResourceVaultConfigs_Put.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "enhancedSecurityState": "Enabled", + "softDeleteFeatureState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/SwaggerTest/backupconfig/vaultconfig", + "name": "vaultconfig", + "type": "Microsoft.RecoveryServices/vaults/backupconfig", + "properties": { + "enhancedSecurityState": "Enabled", + "softDeleteFeatureState": "Enabled" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupSecurityPin_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupSecurityPin_Get.json new file mode 100644 index 000000000000..ace0b15118c4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupSecurityPin_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "SwaggerTest", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "token": "200432", + "expiryTimeInUtcTicks": 636495150137443121, + "securityPIN": "200432" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Get.json new file mode 100644 index 000000000000..ea5008adf457 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig", + "name": "vaultstorageconfig", + "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig", + "properties": { + "storageModelType": "GeoRedundant", + "storageType": "GeoRedundant", + "storageTypeState": "Locked" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Patch.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Patch.json new file mode 100644 index 000000000000..f75da52e3c07 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Patch.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Put.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Put.json new file mode 100644 index 000000000000..c905bd4b798c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/BackupStorageConfig_Put.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupstorageconfig/vaultstorageconfig", + "name": "vaultstorageconfig", + "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig", + "properties": { + "storageModelType": "LocallyRedundant", + "storageType": "LocallyRedundant", + "storageTypeState": "Unlocked" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/CancelJobOperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/CancelJobOperationResult.json new file mode 100644 index 000000000000..f0a06ab418c9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/CancelJobOperationResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "204": {}, + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ExportJobsOperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ExportJobsOperationResult.json new file mode 100644 index 000000000000..ca8c1ef692c9 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ExportJobsOperationResult.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "operation": { + "objectType": "ExportJobsOperationResultInfo", + "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreportc00000000-0000-0000-0000-000000000000", + "blobSasKey": "?sv=2014-02-14&sr=b&sig=<sas_signature>&st=2017-11-29T07%3A53%3A34Z&se=2017-11-29T08%3A03%3A34Z&sp=r" + }, + "headers": {} + } + }, + "202": { + "headers": { + "Retry-After": 60, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01" + }, + "body": { + "operation": { + "objectType": "ExportJobsOperationResultInfo" + }, + "headers": { + "Location": [ + "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01" + ], + "Retry-After": [ + "60" + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/GetJobDetails.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/GetJobDetails.json new file mode 100644 index 000000000000..fbd3bcab513f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/GetJobDetails.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT9.8782791S", + "virtualMachineVersion": "Compute", + "extendedInfo": { + "tasksList": [ + { + "taskId": "Take Snapshot", + "duration": "PT0S", + "status": "InProgress" + }, + { + "taskId": "Transfer data to vault", + "duration": "PT0S", + "status": "NotStarted" + } + ], + "propertyBag": { + "VM Name": "testvm" + } + }, + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobs.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobs.json new file mode 100644 index 000000000000..431936949f1e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobs.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT31.3066291S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "ConfigureBackup", + "status": "Completed", + "startTime": "2017-08-03T05:30:32.4487085Z", + "endTime": "2017-08-03T05:31:03.7553376Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithAllSupportedFilters.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithAllSupportedFilters.json new file mode 100644 index 000000000000..24089dadc8ed --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithAllSupportedFilters.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM' and operation eq 'Backup' and backupManagementType eq 'AzureIaasVM' and status eq 'InProgress'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json new file mode 100644 index 000000000000..6f5d6746d0c3 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ListJobsWithStartTimeAndEndTimeFilters.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview", + "$filter": "startTime eq '2016-01-01 00:00:00 AM' and endTime eq '2017-11-29 00:00:00 AM'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT12.4272909S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "Backup", + "status": "InProgress", + "startTime": "2017-08-03T05:31:07.014604Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.RecoveryServices/vaults/backupJobs", + "properties": { + "jobType": "AzureIaaSVMJob", + "duration": "PT31.3066291S", + "virtualMachineVersion": "Compute", + "entityFriendlyName": "testvm", + "backupManagementType": "AzureIaasVM", + "operation": "ConfigureBackup", + "status": "Completed", + "startTime": "2017-08-03T05:30:32.4487085Z", + "endTime": "2017-08-03T05:31:03.7553376Z", + "activityId": "00000000-0000-0000-0000-000000000000" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs?api-version=2017-07-01&%24filter=startTime+eq+%272016-01-01+00%3a00%3a00+AM%27+and+endTime+eq+%272017-11-29+00%3a00%3a00+AM%27&%24skiptoken=%3c%3fxml+version%3d%221.0%22+encoding%3d%22utf-16%22%3f%3e%0d%0a%3cContinuationToken%3e%0d%0a++%3cContinuationToken%3e%0d%0a++++%3cVersion%3e2.0%3c%2fVersion%3e%0d%0a++++%3cType%3eTable%3c%2fType%3e%0d%0a++++%3cNextPartitionKey%3e1!28!NzI5MTk0OTM1MDkwNjEwODQzMA--%3c%2fNextPartitionKey%3e%0d%0a++++%3cNextRowKey%3e1!108!am9ic3N0YXJ0dGltZWluZGV4XzBfMjUxODkxNDYzNTI2NjE5Nzg5OF8wXzYwOWZkM2JmLTU4MzctNDFkYi1iMjExLTY1MzliNDNlZjM1OA--%3c%2fNextRowKey%3e%0d%0a++++%3cTargetLocation%3ePrimary%3c%2fTargetLocation%3e%0d%0a++%3c%2fContinuationToken%3e%0d%0a%3c%2fContinuationToken%3e" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete.json new file mode 100644 index 000000000000..b25778728bc4 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "fabricName": "Azure", + "containerName": "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "protectedItemName": "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperations/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationResult.json new file mode 100644 index 000000000000..e58be1f2e55a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperations/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupOperationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationStatus.json new file mode 100644 index 000000000000..69d73f3a31fc --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/ProtectedItem_Delete_OperationStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "PythonSDKBackupTestRg", + "vaultName": "PySDKBackupTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "InProgress", + "startTime": "2017-08-03T06:52:53.886027Z", + "endTime": "0001-01-01T00:00:00.00000Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RecoveryPoints_Update.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RecoveryPoints_Update.json new file mode 100644 index 000000000000..6722e3556c35 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RecoveryPoints_Update.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "hanasnapshottesting", + "vaultName": "HanaSnapshotTest", + "fabricName": "Azure", + "containerName": "VMAppContainer;compute;hanasnapshottesting;hana-eacan-2", + "protectedItemName": "SAPHanaDatabase;hye;hye", + "recoveryPointId": "2265668074516978193", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "recoveryPointProperties": { + "expiryTime": "2025-01-02T00:00:00.0000000Z" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hanasnapshottesting/providers/Microsoft.RecoveryServices/vaults/HanaSnapshotTest/backupFabrics/Azure/protectionContainers/VMAppContainer;compute;hanasnapshottesting;hana-eacan-2/protectedItems/SAPHanaDatabase;hye;hye/recoveryPoints/2265668074516978193", + "name": "2265668074516978193", + "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints", + "properties": { + "objectType": "AzureWorkloadSAPHanaRecoveryPoint", + "recoveryPointProperties": { + "expiryTime": "2025-01-02T00:00:00.0000000Z", + "isSoftDeleted": false, + "ruleName": "On-Demand" + }, + "recoveryPointTierDetails": [ + { + "status": "Valid", + "type": "HardenedRP" + } + ], + "recoveryPointTimeInUTC": "2023-08-18T06:26:36.922Z", + "type": "Full" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers.json new file mode 100644 index 000000000000..f39954ebd668 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers_OperationResults.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers_OperationResults.json new file mode 100644 index 000000000000..d65c5605c8b3 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/RefreshContainers_OperationResults.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "fabricName": "Azure", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupFabrics/Azure/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerBackup_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerBackup_Post.json new file mode 100644 index 000000000000..b41e77e30ffc --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerBackup_Post.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "linuxRsVaultRG", + "vaultName": "linuxRsVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;testrg;v1win2012r", + "protectedItemName": "VM;iaasvmcontainerv2;testrg;v1win2012r", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "objectType": "IaasVMBackupRequest" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Azure-AsyncOperation": "https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/linuxRsVaultRG/providers/Microsoft.RecoveryServices/vaults/linuxRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;testrg;v1win2012r/protectedItems/VM;iaasvmcontainer;testrg;v1win2012r/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerCancelJob.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerCancelJob.json new file mode 100644 index 000000000000..13ebf3e69f2a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerCancelJob.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "jobName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/00000000-0000-0000-0000-000000000000/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerExportJobs.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerExportJobs.json new file mode 100644 index 000000000000..30fac19645b3 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Common/TriggerExportJobs.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2024-07-30-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupJobs/operationResults/00000000-0000-0000-0000-000000000000?api-version=2017-07-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_Get.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_Get.json new file mode 100644 index 000000000000..b799a4c6376e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "backupEngineName": "testServer", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer", + "name": "testServer", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9532.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_List.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_List.json new file mode 100644 index 000000000000..e2dc9b674c8f --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/Dpm/BackupEngines_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "testRG", + "vaultName": "testVault", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer1", + "name": "testServer1", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9532.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer1", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + }, + { + "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupEngines/testServer5", + "name": "testServer5", + "type": "Microsoft.RecoveryServices/vaults/backupEngines", + "properties": { + "backupEngineType": "DpmBackupEngine", + "dpmVersion": "5.1.348.0", + "isDpmUpgradeAvailable": false, + "azureBackupAgentVersion": "2.0.9530.0", + "isAzureBackupAgentUpgradeAvailable": false, + "registrationStatus": "Registered", + "backupEngineState": "Active", + "friendlyName": "testServer5", + "extendedInfo": { + "protectedItemsCount": 35, + "protectedServersCount": 21, + "diskCount": 5, + "availableDiskSpace": 50, + "usedDiskSpace": 20 + } + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ListOperations.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ListOperations.json new file mode 100644 index 000000000000..763e836a380a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ListOperations.json @@ -0,0 +1,463 @@ +{ + "parameters": { + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "microsoft.recoveryservices/vaults/usages/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Usage", + "operation": "Recovery Services Vault usage details.", + "description": "Returns usage details for a Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupUsageSummaries/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Usages Summaries", + "operation": "Recovery Services Protected Items and Protected Servers usage summaries details.", + "description": "Returns summaries for Protected Items and Protected Servers for a Recovery Services ." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Get Resource Storage Config", + "description": "Returns Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/storageConfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Storage Config", + "operation": "Write Resource Storage Config", + "description": "Updates Storage Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Get Resource Config", + "description": "Returns Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupconfig/vaultconfig/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Vault Config", + "operation": "Update Resource Config", + "description": "Updates Configuration for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/tokenInfo/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Token Info", + "operation": "Get Vault Token Info", + "description": "Returns token information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupSecurityPIN/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "SecurityPINInfo", + "operation": "Get Security PIN Info", + "description": "Returns Security PIN Information for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupManagementMetaData/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Management Metadata", + "operation": "Get Backup Management Metadata", + "description": "Returns Backup Management Metadata for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupOperations/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Recovery Services Vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Get Jobs", + "description": "Returns all Job Objects" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/cancel/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs", + "operation": "Cancel Jobs", + "description": "Cancel the Job" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs", + "operation": "Export Jobs", + "description": "Export Jobs" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobs/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Jobs Operation Results", + "operation": "Get Job Operation Result", + "description": "Returns the Result of Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupJobsExport/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Export Backup Jobs Operation Results", + "operation": "Get Export Job Operation Result", + "description": "Returns the Result of Export Job Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Get Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/restore/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Restore Recovery Points", + "description": "Restore Recovery Points for Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/provisionInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Provision Instant Item Recovery for Protected Item", + "description": "Provision Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/recoveryPoints/revokeInstantItemRecovery/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Recovery Points", + "operation": "Revoke Instant Item Recovery for Protected Item", + "description": "Revoke Instant Item Recovery for Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Get Protection Policy", + "description": "Returns all Protection Policies" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Create Protection Policy", + "description": "Creates Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policies", + "operation": "Delete Protection Policy", + "description": "Delete a Protection Policy" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Results", + "operation": "Get Policy Operation Results", + "description": "Get Results of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPolicies/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Policy Operation Status", + "operation": "Get Policy Operation Status", + "description": "Get Status of Policy Operation." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get Protected Item Details", + "description": "Returns object details of the Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectedItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Get All Protected Items", + "description": "Returns the list of all Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Create Backup Protected Item", + "description": "Create a backup Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/delete", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Delete Protected Items", + "description": "Deletes Protected Item" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Results", + "operation": "Get Protected Items Operation Results", + "description": "Gets Result of Operation Performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/operationsStatus/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Item Operation Status", + "operation": "Get Protected Items operation status", + "description": "Returns the status of Operation performed on Protected Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/protectedItems/backup/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protected Items", + "operation": "Backup Protected Item", + "description": "Performs Backup for Protected Item." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectableItems/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protectable Items", + "operation": "Get Protectable Items", + "description": "Returns list of all Protectable Items." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/refreshContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers", + "operation": "Refresh container", + "description": "Refreshes the container list" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Refresh Containers Operation Results", + "operation": "Get Operation Results", + "description": "Returns status of the operation" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupProtectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Protection Containers", + "operation": "Get Containers In Subscription", + "description": "Returns all containers belonging to the subscription" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers", + "operation": "Get Registered Container", + "description": "Returns all registered containers" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/operationResults/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Operation Results", + "operation": "Get Container Operation Results", + "description": "Gets result of Operation performed on Protection Container." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupEngines", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Engines", + "operation": "List of backup management servers.", + "description": "Returns all the backup management servers registered with vault." + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupStatus", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupPreValidateProtection", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "PreValidate Protection", + "operation": "Pre Validate Enable Protection", + "description": "" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupValidateFeatures", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Validate Features", + "operation": "Validate Features", + "description": "Validate Features" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/backupProtectionIntent/write", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Intent", + "operation": "Create backup Protection Intent", + "description": "Create a backup Protection Intent" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/{fabricName}/protectionContainers/{containerName}/items/read", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Workload Items", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + }, + { + "name": "microsoft.recoveryservices/vaults/backupFabrics/protectionContainers/inquire/action", + "display": { + "provider": "microsoft.recoveryservices", + "resource": "Protection Containers Inquire", + "operation": "Get all items in a container", + "description": "Get all items in a container" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..7a1e5a4c2f95 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/DeletePrivateEndpointConnection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/backupadminrg/providers/Microsoft.RecoveryServices/Vaults/demo-pevault-2/privateEndpointConnections/autoapprovalpeecy4.3679789459502941542.backup.5ede856d-d9f0-461e-a15b-370c84525817/operationsStatus/2908a25d-8036-48d2-bdcc-fdce26b9771f?api-versi", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..bcb63fcb3c77 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + }, + "groupIds": [ + "AzureBackup_secondary" + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json new file mode 100644 index 000000000000..49605dd94f9a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/GetPrivateEndpointConnectionOperationStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "vaultName": "gaallavaultbvtd2msi", + "operationId": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "name": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "status": "Succeeded", + "startTime": "2020-02-27T11:59:47.5901592Z", + "endTime": "2020-02-27T11:59:47.5901592Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json new file mode 100644 index 000000000000..5ca21d351da2 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/PrivateEndpointConnection/PutPrivateEndpointConnection.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + }, + "groupIds": [ + "AzureBackup_secondary" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Pending", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + }, + "groupIds": [ + "AzureBackup_secondary" + ] + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/6c48fa17-39c7-45f1-90ac-47a587128ace/resourceGroups/backupadminrg/providers/Microsoft.RecoveryServices/Vaults/demo-pevault-2/privateEndpointConnections/autoapprovalpeecy4.3679789459502941542.backup.5ede856d-d9f0-461e-a15b-370c84525817/operationsStatus/2908a25d-8036-48d2-bdcc-fdce26b9771f?api-versi", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.RecoveryServicesBVTD2/vaults/gaallavaultbvtd2msi/privateEndpointConnections/gaallatestpe3.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "name": "gaallatestpe1.3592346090307038890.backup.5704c932-249a-490b-a142-1396838cd3b", + "type": "Microsoft.RecoveryServices/vaults/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/gaallaRG/providers/Microsoft.Network/privateEndpoints/gaallatestpe3" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@company.com" + }, + "groupIds": [ + "AzureBackup_secondary" + ] + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json new file mode 100644 index 000000000000..2fe99db2ea7a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json new file mode 100644 index 000000000000..fbea6cd5fbdd --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "/backupmanagement/resources/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/deleteResourceGuardProxyRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/resourceguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/disableSoftDeleteRequests/default" + } + ], + "lastUpdatedTime": "2021-02-11T12:20:47.8210031Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json new file mode 100644 index 000000000000..02627646f22c --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/backupmanagement/resources/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/deleteResourceGuardProxyRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/disableSoftDeleteRequests/default" + } + ], + "lastUpdatedTime": "2021-02-11T12:20:47.8210031Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json new file mode 100644 index 000000000000..9b5c7582d57d --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2024-07-30-preview", + "parameters": { + "properties": { + "resourceGuardResourceId": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/backupmanagement/resources/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/deleteResourceGuardProxyRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests", + "defaultResourceRequest": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/disableSoftDeleteRequests/default" + } + ], + "lastUpdatedTime": "2021-02-11T12:20:47.8210031Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json new file mode 100644 index 000000000000..8f01da5d0651 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2024-07-30-preview", + "parameters": { + "resourceGuardOperationRequests": [ + "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew/deleteProtectedItemRequests/default" + ], + "resourceToBeDeleted": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/gaallarg/providers/Microsoft.RecoveryServices/vaults/MercuryCrrVault/backupFabrics/Azure/protectionContainers/VMAppContainer;compute;crrtestrg;crrtestvm/protectedItems/SQLDataBase;mssqlserver;testdb" + } + }, + "responses": { + "200": { + "body": { + "unlockDeleteExpiryTime": "2021-02-11T13:12:27.7870742Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForPolicy.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForPolicy.json new file mode 100644 index 000000000000..3e926e7096b8 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForPolicy.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "FetchTieringCostSavingsInfoForPolicyRequest", + "policyName": "monthly", + "sourceTierType": "HardenedRP", + "targetTierType": "ArchivedRP" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Retry-After": 60 + } + }, + "200": { + "body": { + "objectType": "TieringCostSavingInfo", + "sourceTierSizeReductionInBytes": 1204000, + "targetTierSizeIncreaseInBytes": 1892, + "retailSourceTierCostPerGBPerMonth": 0.02, + "retailTargetTierCostPerGBPerMonth": 0.003 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForProtectedItem.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForProtectedItem.json new file mode 100644 index 000000000000..1bd00589b160 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForProtectedItem.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "FetchTieringCostSavingsInfoForProtectedItemRequest", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "sourceTierType": "HardenedRP", + "targetTierType": "ArchivedRP" + } + }, + "responses": { + "200": { + "body": { + "objectType": "TieringCostSavingInfo", + "sourceTierSizeReductionInBytes": 1204000, + "targetTierSizeIncreaseInBytes": 1892, + "retailSourceTierCostPerGBPerMonth": 0.02, + "retailTargetTierCostPerGBPerMonth": 0.003 + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForRehydrate.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForRehydrate.json new file mode 100644 index 000000000000..7b006b13b1ff --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForRehydrate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "FetchTieringCostInfoForRehydrationRequest", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "1222343434", + "rehydrationPriority": "High", + "sourceTierType": "ArchivedRP", + "targetTierType": "HardenedRP" + } + }, + "responses": { + "200": { + "body": { + "objectType": "TieringCostRehydrationInfo", + "rehydrationSizeInBytes": 1204000, + "retailRehydrationCostPerGBPerMonth": 0.02 + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForVault.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForVault.json new file mode 100644 index 000000000000..18973a6bd564 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/FetchTieringCostForVault.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "FetchTieringCostSavingsInfoForVaultRequest", + "sourceTierType": "HardenedRP", + "targetTierType": "ArchivedRP" + } + }, + "responses": { + "200": { + "body": { + "objectType": "TieringCostSavingInfo", + "sourceTierSizeReductionInBytes": 1204000, + "targetTierSizeIncreaseInBytes": 1892, + "retailSourceTierCostPerGBPerMonth": 0.02, + "retailTargetTierCostPerGBPerMonth": 0.003 + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationResults/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupTieringCost/default/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2024-07-30-preview", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationResult.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationResult.json new file mode 100644 index 000000000000..4e0e08efde6e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "vaultName": "gaallavaultbvtd2msi", + "operationId": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "objectType": "TieringCostSavingInfo", + "sourceTierSizeReductionInBytes": 1204000, + "targetTierSizeIncreaseInBytes": 1892, + "retailSourceTierCostPerGBPerMonth": 0.02, + "retailTargetTierCostPerGBPerMonth": 0.003 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationStatus.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationStatus.json new file mode 100644 index 000000000000..49605dd94f9a --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TieringCost/GetTieringCostOperationStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "gaallaRG", + "privateEndpointConnectionName": "gaallatestpe2.5704c932-249a-490b-a142-1396838cd3b", + "vaultName": "gaallavaultbvtd2msi", + "operationId": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "api-version": "2024-07-30-preview" + }, + "responses": { + "200": { + "body": { + "id": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "name": "0f48183b-0a44-4dca-aec1-bba5daab888a", + "status": "Succeeded", + "startTime": "2020-02-27T11:59:47.5901592Z", + "endTime": "2020-02-27T11:59:47.5901592Z" + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TriggerRecoveryPointMove_Post.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TriggerRecoveryPointMove_Post.json new file mode 100644 index 000000000000..6fe1bb60192e --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/preview/2024-07-30-preview/examples/TriggerRecoveryPointMove_Post.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "netsdktestrg", + "vaultName": "testVault", + "fabricName": "Azure", + "containerName": "IaasVMContainer;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "protectedItemName": "VM;iaasvmcontainerv2;netsdktestrg;netvmtestv2vm1", + "recoveryPointId": "348916168024334", + "api-version": "2024-07-30-preview", + "parameters": { + "objectType": "MoveRPAcrossTiersRequest", + "sourceTierType": "HardenedRP", + "targetTierType": "ArchivedRP" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/netsdktestrg/providers/Microsoft.RecoveryServices/vaults/testVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/protectedItems/vm;iaasVMContainerV2;netsdktestrg;netvmtestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2020-09-01", + "Retry-After": 60 + } + } + } +} diff --git a/specification/recoveryservicesbackup/resource-manager/readme.md b/specification/recoveryservicesbackup/resource-manager/readme.md index 285c42d6262a..e7c1f6bf6195 100644 --- a/specification/recoveryservicesbackup/resource-manager/readme.md +++ b/specification/recoveryservicesbackup/resource-manager/readme.md @@ -55,6 +55,15 @@ semantic-validator: true message-format: json ``` +### Tag: package-preview-2024-07 + +These settings apply only when `--tag=package-preview-2024-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-07' +input-file: + - Microsoft.RecoveryServices/preview/2024-07-30-preview/bms.json +``` + ### Tag: package-preview-2024-04 These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. diff --git a/specification/recoveryservicesbackup/resource-manager/sdk-suppressions.yaml b/specification/recoveryservicesbackup/resource-manager/sdk-suppressions.yaml new file mode 100644 index 000000000000..925adf973ab5 --- /dev/null +++ b/specification/recoveryservicesbackup/resource-manager/sdk-suppressions.yaml @@ -0,0 +1,5 @@ +suppressions: + azure-sdk-for-python: + - package: azure-mgmt-recoveryservicesbackup + breaking-changes: + - Deleted or renamed enum value `HttpStatusCode.CONTINUE_ENUM` From 491dbe210848ae24740e0018fa8d7f72f480f177 Mon Sep 17 00:00:00 2001 From: Weidong Xu <weidxu@microsoft.com> Date: Thu, 10 Oct 2024 15:56:17 +0800 Subject: [PATCH 081/101] java, mgmt, iotoperstions, tspconfig (#30945) --- .../iotoperations/IoTOperations.Management/client.tsp | 1 + .../iotoperations/IoTOperations.Management/tspconfig.yaml | 5 +++++ 2 files changed, 6 insertions(+) diff --git a/specification/iotoperations/IoTOperations.Management/client.tsp b/specification/iotoperations/IoTOperations.Management/client.tsp index e7db2f8919a4..cf64e894694f 100644 --- a/specification/iotoperations/IoTOperations.Management/client.tsp +++ b/specification/iotoperations/IoTOperations.Management/client.tsp @@ -4,3 +4,4 @@ import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; @@clientName(Microsoft.IoTOperations, "IoTOperationsMgmt", "python"); +@@clientName(Microsoft.IoTOperations, "IoTOperationsManagementClient", "java"); diff --git a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml index d28a739a8e06..28a7b5e44de7 100644 --- a/specification/iotoperations/IoTOperations.Management/tspconfig.yaml +++ b/specification/iotoperations/IoTOperations.Management/tspconfig.yaml @@ -15,6 +15,11 @@ options: flavor: "azure" generate-test: true generate-sample: true + "@azure-tools/typespec-java": + package-dir: "azure-resourcemanager-iotoperations" + namespace: "com.azure.resourcemanager.iotoperations" + service-name: "IoT Operations" + flavor: "azure" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From bc2ade950bf5f66fde8f554eafa566cd306dac4c Mon Sep 17 00:00:00 2001 From: Ayush Gupta <guptaayush@microsoft.com> Date: Thu, 10 Oct 2024 19:21:45 +0530 Subject: [PATCH 082/101] Add Swagger API change to add new phases in progress reporting in DatabaseOperations --- .../DatabaseOperations.json | 4 +- .../examples/ListDatabaseOperations.json | 66 ++++++++++++++++--- 2 files changed, 61 insertions(+), 9 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json index 239c7d185ce0..04b6023ea2fc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json @@ -277,7 +277,9 @@ "phase": { "description": "The operation phase.", "enum": [ + "LogTransitionInProgress", "Copying", + "BuildingHyperscaleComponents", "Catchup", "WaitingForCutover", "CutoverInProgress" @@ -329,4 +331,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/ListDatabaseOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/ListDatabaseOperations.json index 857e84723a62..571332f23393 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/ListDatabaseOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/examples/ListDatabaseOperations.json @@ -35,20 +35,70 @@ "databaseName": "testdb", "operation": "UpdateLogicalDatabase", "operationFriendlyName": "ALTER DATABASE", - "percentComplete": 19, + "percentComplete": 50, "serverName": "testsvr", - "startTime": "2023-02-13T06:25:23.67Z", + "startTime": "2024-09-27T05:42:30.097Z", "state": "InProgress", - "estimatedCompletionTime": "2023-02-17T14:30:30.71Z", - "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_2', target ServiceLevelObjective 'SQLDB_HS_Gen5_2', target database MaxSize '32'GB", + "estimatedCompletionTime": "2024-09-27T12:44:33.953Z", + "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_BC_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB", "isCancellable": true, "operationPhaseDetails": { - "phase": "WaitingForCutover", + "phase": "LogTransitionInProgress", + "phaseInformation": { + "currentStep": "1", + "totalSteps": "6", + "logTransitioningInProgress": "True" + } + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555", + "name": "55555555-5555-5555-5555-555555555555", + "type": "Microsoft.Sql/servers/databases/operations", + "properties": { + "databaseName": "testdb", + "operation": "UpdateLogicalDatabase", + "operationFriendlyName": "ALTER DATABASE", + "percentComplete": 50, + "serverName": "testsvr", + "startTime": "2024-09-27T05:13:37.84Z", + "state": "InProgress", + "estimatedCompletionTime": "2024-09-27T12:28:10.83Z", + "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB", + "isCancellable": true, + "operationPhaseDetails": { + "phase": "BuildingHyperscaleComponents", "phaseInformation": { "currentStep": "3", - "totalSteps": "4", - "performCutoverBy": "2023-02-17T11:57:06.71Z", - "dataDelayInMb": "31" + "totalSteps": "6", + "creatingPrimaryHyperscaleComponents": "True" + } + } + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555", + "name": "55555555-5555-5555-5555-555555555555", + "type": "Microsoft.Sql/servers/databases/operations", + "properties": { + "databaseName": "testdb", + "operation": "UpdateLogicalDatabase", + "operationFriendlyName": "ALTER DATABASE", + "percentComplete": 50, + "serverName": "testsvr", + "startTime": "2024-09-27T07:31:56.087Z", + "state": "InProgress", + "estimatedCompletionTime": "2024-09-27T14:59:54.38Z", + "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB", + "isCancellable": true, + "operationPhaseDetails": { + "phase": "WaitingForCutover", + "phaseInformation": { + "currentStep": "5", + "totalSteps": "6", + "dataDelayInMb": "0", + "performCutoverBy": "2024-09-30T07:43:55.08Z" } } } From f90ef6cf4f2618f27335c74f3e0f5c0c3ab16efd Mon Sep 17 00:00:00 2001 From: Ayush Gupta <guptaayush@microsoft.com> Date: Thu, 10 Oct 2024 19:52:53 +0530 Subject: [PATCH 083/101] ran command for fixing required : azure-pipelines/ Swagger PrettierCheck --- .../preview/2024-08-01-preview/DatabaseOperations.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json index 04b6023ea2fc..b263e4142e65 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2024-08-01-preview/DatabaseOperations.json @@ -331,4 +331,4 @@ } } } -} \ No newline at end of file +} From 0b5555556f3288ee49d3a154cb0662d75b14a4ba Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Thu, 10 Oct 2024 10:48:08 -0700 Subject: [PATCH 084/101] Azure fleet 2024-11-01 API updates. (#30873) * Updating the version to "2024-10-01" * Fix Stable version path in readme.Md * Updating path for stable version. * Updating Readme.md files for other languages SDK. * Updating SDK readme.md files. * Add Java SDK readme reference to main readme.md file. * Updating Main.tsp to add GA version. * Remove version references from individual sdk readme.md files, as it gets it from main.tsp. * fixing dependencies for2024-10-01 in main.tsp. * updated generated file from sp. * Adding example refs back, removed by tool * Adding examples * Update main.tsp. local build - npx tsv specification/azurefleet/AzureFleet.Management * Update Path for 24_10_01 in main.tsp * Restore Python package-version: 1.0.0b1 * Adding Retry-after header in 20` response examples. * Changing API version to 2024-11-01 * Updating "provisioningState" in example and swagger - adding "Azure-AsyncOperation" - header. * update to example. * Updating the examples based on tsp generated to pass the build. The Tsp files needs to be update for correctness. * Update examples to have succeeded state * Update sdk-suppressions.yaml * Updating examples to add Retry-After header. Update "provisioningState": "Creating" for 201 responses. * Changes for Attribute schema. * Attribute changes. * Updates. * Adding Atrributes. * Supressing - typespec-azure-core/casing-style: The names of Model types must use PascalCase * Adding VM Attributes properties. * Adding refrence to VmAttributes and locationProfiles (Needs to be completed for model.) * Adding AdditionalCapabilities, LocationProfile. * Run Prettier. * Spell Check fixes. * Make paramters optional - vmAttributes, additionalLocationsProfile * Fixing Descriptions. * Supress error for ultraSSDEnabled name. * Updates after npx ci * Revert "Updates after npx ci" This reverts commit bf1aed71f182bc43cfe5efd23a929a6c49912f29. * Updates after npx ci * Supression update * Updating description of ultraSSD to match Compute description. * Supress Camel Case error for SSD * Suppress ultraSSDEnabled for DefinitionsPropertiesNamesCamelCase * Updates based on comments. * Fix FPGAs. It's listed on - https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview?tabs=breakdownseries%2Cgeneralsizelist%2Ccomputesizelist%2Cmemorysizelist%2Cstoragesizelist%2Cgpusizelist%2Cfpgasizelist%2Chpcsizelist#general-purpose * Updates after npm ci, as the branch was updated from main source. * Doc updates. * npx ci, after updatess from main branch. * Updating VMAttributes as per new spec. * Updated based on new spec for VMAttributes * Run npm ci. * After npm ci. * remove MaxValue() for float64. * Updates based on comments. * updates. * Updates. * Fixes for spell Check - localStorageInGiB * Updates after npm ci. * Adding memoryInGiBPerVCpu to VMAttributes * Updates. * Formatting fixes. --------- Co-authored-by: Sahil Arora <arorasahil@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Rahul Singh <rahuls@microsft.com> --- .../2024-11-01/Fleets_CreateOrUpdate.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../examples/2024-11-01/Fleets_Update.json | 3 +- .../AzureFleet.Management/fleet.tsp | 45 ++++++++++++++----- .../stable/2024-11-01/azurefleet.json | 31 ++++++++----- .../examples/Fleets_CreateOrUpdate.json | 3 +- .../Fleets_CreateOrUpdate_MinimumSet.json | 3 +- .../2024-11-01/examples/Fleets_Update.json | 3 +- 8 files changed, 60 insertions(+), 34 deletions(-) diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json index a76ad9c827a9..bad67bdba86c 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate.json @@ -775,8 +775,7 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus", - "Retry-After": 30 + "Azure-AsyncOperation": "https://contoso.com/operationstatus" }, "body": { "properties": { diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json index e94c80506873..a3f3c5334ee1 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_CreateOrUpdate_MinimumSet.json @@ -197,8 +197,7 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus", - "Retry-After": 30 + "Azure-AsyncOperation": "https://contoso.com/operationstatus" }, "body": { "properties": { diff --git a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json index 73a8f4820114..2a646fd30bcf 100644 --- a/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json +++ b/specification/azurefleet/AzureFleet.Management/examples/2024-11-01/Fleets_Update.json @@ -759,8 +759,7 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus", - "Retry-After": 30 + "location": "https://contoso.com/operationstatus" } } } diff --git a/specification/azurefleet/AzureFleet.Management/fleet.tsp b/specification/azurefleet/AzureFleet.Management/fleet.tsp index c4c78b4e7f5f..bf10a6f5a5b5 100644 --- a/specification/azurefleet/AzureFleet.Management/fleet.tsp +++ b/specification/azurefleet/AzureFleet.Management/fleet.tsp @@ -370,8 +370,8 @@ union ArchitectureType { @doc("ARM64 Architecture") ARM64: "ARM64", - @doc("X86 Architecture") - X86: "X86", + @doc("X64 Architecture") + X64: "X64", } @added(Versions.v2024_11_01) @@ -411,10 +411,16 @@ model VMAttributes { @doc("The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified.") memoryInGiB: VMAttributeMinMaxDouble; + @doc("The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified.") + memoryInGiBPerVCpu?: VMAttributeMinMaxDouble; + @doc("Specifies whether the VMSize supporting local storage should be used to build Fleet or not.") localStorageSupport?: VMAttributeSupport; - @doc("The range of local storage in GB specified from Min to Max.") + @doc(""" + LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. + If localStorageSupport is "Excluded", this VMAttribute can not be used. + """) localStorageInGiB?: VMAttributeMinMaxDouble; @extension("x-ms-identifiers", []) @@ -436,21 +442,40 @@ model VMAttributes { @doc("Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not.") rdmaSupport?: VMAttributeSupport; - @doc("The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.") + @doc(""" + The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. + rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. + If rdmaSupport is "Excluded", this VMAttribute can not be used. + """) rdmaNetworkInterfaceCount?: VMAttributeMinMaxInteger; - @doc("Specifies whether the VMSize supporting accelerator should be used to build Fleet or not.") + @doc(""" + Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. + acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. + If acceleratorSupport is "Excluded", this VMAttribute can not be used. + """) acceleratorSupport?: VMAttributeSupport; @extension("x-ms-identifiers", []) - @doc("The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + @doc(""" + The accelerator manufacturers specified as a list. + acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. + If acceleratorSupport is "Excluded", this VMAttribute can not be used. + """) acceleratorManufacturers?: Array<AcceleratorManufacturer>; @extension("x-ms-identifiers", []) - @doc("The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.") + @doc(""" + The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. + If acceleratorSupport is "Excluded", this VMAttribute can not be used. + """) acceleratorTypes?: Array<AcceleratorType>; - @doc("The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified.") + @doc(""" + The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. + acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. + If acceleratorSupport is "Excluded", this VMAttribute can not be used. + """) acceleratorCount?: VMAttributeMinMaxInteger; @extension("x-ms-identifiers", []) @@ -477,9 +502,9 @@ model VMAttributes { @doc("Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional).") model LocationProfile { @doc(""" - The ARM location name of the additional region. + The ARM location name of the additional region. If LocationProfile is specified, then location is required. """) - location?: string; + location: string; @doc(""" An override for computeProfile.baseVirtualMachineProfile specific to this region. diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json index 3042422c58d8..94cbc4cde62b 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/azurefleet.json @@ -676,7 +676,7 @@ "description": "Architecture types supported by Azure VMs.", "enum": [ "ARM64", - "X86" + "X64" ], "x-ms-enum": { "name": "ArchitectureType", @@ -688,9 +688,9 @@ "description": "ARM64 Architecture" }, { - "name": "X86", - "value": "X86", - "description": "X86 Architecture" + "name": "X64", + "value": "X64", + "description": "X64 Architecture" } ] } @@ -1566,13 +1566,16 @@ "properties": { "location": { "type": "string", - "description": "The ARM location name of the additional region." + "description": "The ARM location name of the additional region. If LocationProfile is specified, then location is required." }, "virtualMachineProfileOverride": { "$ref": "#/definitions/BaseVirtualMachineProfile", "description": "An override for computeProfile.baseVirtualMachineProfile specific to this region. \nThis override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location." } - } + }, + "required": [ + "location" + ] }, "ManagedServiceIdentityUpdate": { "type": "object", @@ -2461,13 +2464,17 @@ "$ref": "#/definitions/VMAttributeMinMaxDouble", "description": "The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified." }, + "memoryInGiBPerVCpu": { + "$ref": "#/definitions/VMAttributeMinMaxDouble", + "description": "The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified." + }, "localStorageSupport": { "$ref": "#/definitions/VMAttributeSupport", "description": "Specifies whether the VMSize supporting local storage should be used to build Fleet or not." }, "localStorageInGiB": { "$ref": "#/definitions/VMAttributeMinMaxDouble", - "description": "The range of local storage in GB specified from Min to Max." + "description": "LocalStorageSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf localStorageSupport is \"Excluded\", this VMAttribute can not be used." }, "localStorageDiskTypes": { "type": "array", @@ -2495,15 +2502,15 @@ }, "rdmaNetworkInterfaceCount": { "$ref": "#/definitions/VMAttributeMinMaxInteger", - "description": "The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified." + "description": "The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified.\nrdmaSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf rdmaSupport is \"Excluded\", this VMAttribute can not be used." }, "acceleratorSupport": { "$ref": "#/definitions/VMAttributeSupport", - "description": "Specifies whether the VMSize supporting accelerator should be used to build Fleet or not." + "description": "Specifies whether the VMSize supporting accelerator should be used to build Fleet or not.\nacceleratorSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf acceleratorSupport is \"Excluded\", this VMAttribute can not be used." }, "acceleratorManufacturers": { "type": "array", - "description": "The accelerator manufacturers specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "description": "The accelerator manufacturers specified as a list. \nacceleratorSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf acceleratorSupport is \"Excluded\", this VMAttribute can not be used.", "items": { "$ref": "#/definitions/AcceleratorManufacturer" }, @@ -2511,7 +2518,7 @@ }, "acceleratorTypes": { "type": "array", - "description": "The accelerator types specified as a list. acceleratorSupport should be set to Included or Required to use this VMAttribute.", + "description": "The accelerator types specified as a list. acceleratorSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf acceleratorSupport is \"Excluded\", this VMAttribute can not be used.", "items": { "$ref": "#/definitions/AcceleratorType" }, @@ -2519,7 +2526,7 @@ }, "acceleratorCount": { "$ref": "#/definitions/VMAttributeMinMaxInteger", - "description": "The range of accelerator count specified from min to max.. Optional parameter. Either Min or Max is required if specified." + "description": "The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified.\nacceleratorSupport should be set to \"Included\" or \"Required\" to use this VMAttribute. \nIf acceleratorSupport is \"Excluded\", this VMAttribute can not be used." }, "vmCategories": { "type": "array", diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json index a76ad9c827a9..bad67bdba86c 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate.json @@ -775,8 +775,7 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus", - "Retry-After": 30 + "Azure-AsyncOperation": "https://contoso.com/operationstatus" }, "body": { "properties": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json index e94c80506873..a3f3c5334ee1 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_CreateOrUpdate_MinimumSet.json @@ -197,8 +197,7 @@ }, "201": { "headers": { - "Azure-AsyncOperation": "https://contoso.com/operationstatus", - "Retry-After": 30 + "Azure-AsyncOperation": "https://contoso.com/operationstatus" }, "body": { "properties": { diff --git a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json index 73a8f4820114..2a646fd30bcf 100644 --- a/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json +++ b/specification/azurefleet/resource-manager/Microsoft.AzureFleet/stable/2024-11-01/examples/Fleets_Update.json @@ -759,8 +759,7 @@ }, "202": { "headers": { - "location": "https://contoso.com/operationstatus", - "Retry-After": 30 + "location": "https://contoso.com/operationstatus" } } } From d248e0ab028c567052728d67f3dfe300e90ba680 Mon Sep 17 00:00:00 2001 From: steve munk <33468793+stevemunk@users.noreply.github.com> Date: Thu, 10 Oct 2024 11:41:09 -0700 Subject: [PATCH 085/101] Fixed links. (#30959) --- specification/maps/data-plane/Weather/stable/1.1/weather.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/maps/data-plane/Weather/stable/1.1/weather.json b/specification/maps/data-plane/Weather/stable/1.1/weather.json index 47d5ab673171..cea6c4b5c9e4 100644 --- a/specification/maps/data-plane/Weather/stable/1.1/weather.json +++ b/specification/maps/data-plane/Weather/stable/1.1/weather.json @@ -552,7 +552,7 @@ "/weather/severe/alerts/{format}": { "get": { "summary": "Use to get information about severe weather conditions such as hurricanes, thunderstorms, flooding, lightning, heat waves or forest fires for a given location.", - "description": "\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products. \n\n The `Get Severe Weather Alerts` API is an HTTP `GET` request that returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires. For more information, see [Request severe weather alerts](/azure-maps/how-to-request-weather-data#request-severe-weather-alerts)", + "description": "\n\nSevere weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products. \n\n The `Get Severe Weather Alerts` API is an HTTP `GET` request that returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires. For more information, see [Request severe weather alerts](/azure/azure-maps/how-to-request-weather-data#request-severe-weather-alerts)", "operationId": "Weather_GetSevereWeatherAlerts", "x-ms-examples": { "Successfully retrieve severe weather alerts": { @@ -1523,7 +1523,7 @@ "UnitType": { "type": "integer", "format": "int32", - "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unittype) for details.", + "description": "Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather services in Azure Maps](/azure/azure-maps/weather-services-concepts#unit-types) for details.", "enum": [ 0, 1, From 7c2d8d88e35acda25c8a0fe358f75a10d2f3597c Mon Sep 17 00:00:00 2001 From: noahdavis-msft <107129993+noahdavis-msft@users.noreply.github.com> Date: Thu, 10 Oct 2024 15:22:14 -0400 Subject: [PATCH 086/101] noahdavis Microsoft.AzureDataTransfer add new API spec 2024-09-27 for FMV (#30756) * Copy files from stable/2024-09-11 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-09-27 Updated the API version from stable/2024-09-11 to stable/2024-09-27. * Added tag for 2024-09-27 in readme file * 2024-09-27 initial commit * Correct getFlowSourceAddresses.json file name * Address errors * Update examples parameters * Update schema definitions for param 5 * Fix examples ref, params 5 schema * Fix duplicate operation Id * Only allow endpoints/ports to be instead of entire configuration * Update schema port->ports * Address linting * address more linting things * Fix unresolvable reference * Fix typo in param name * Update readme for autorest * retrigger checks * retrigger checks 2 --- .../stable/2024-09-27/azuredatatransfer.json | 3054 +++++++++++++++++ .../examples/approveOrRejectConnection.json | 31 + .../examples/createOrUpdateConnection.json | 42 + .../examples/createOrUpdateFlow.json | 36 + .../examples/createOrUpdatePipeline.json | 30 + .../2024-09-27/examples/deleteConnection.json | 16 + .../2024-09-27/examples/deleteFlow.json | 17 + .../2024-09-27/examples/deletePipeline.json | 16 + .../examples/enableOrDisableFlow.json | 23 + .../examples/generateFlowPassphrase.json | 23 + .../2024-09-27/examples/getConnection.json | 17 + .../stable/2024-09-27/examples/getFlow.json | 18 + .../getFlowDestinationEndpointPorts.json | 18 + .../examples/getFlowDestinationEndpoints.json | 18 + .../examples/getFlowSourceAddresses.json | 19 + .../2024-09-27/examples/getPipeline.json | 17 + .../examples/getStreamConnectionString.json | 16 + .../2024-09-27/examples/linkConnection.json | 25 + .../stable/2024-09-27/examples/linkFlow.json | 26 + .../listConnectionsByResourceGroup.json | 37 + .../listConnectionsBySubscription.json | 36 + .../examples/listFlowsByConnection.json | 44 + .../2024-09-27/examples/listOperations.json | 43 + .../examples/listPendingConnections.json | 34 + .../2024-09-27/examples/listPendingFlows.json | 34 + .../listPipelinesByResourceGroup.json | 33 + .../examples/listPipelinesBySubscription.json | 32 + .../2024-09-27/examples/listSchemas.json | 24 + .../2024-09-27/examples/patchConnection.json | 47 + .../stable/2024-09-27/examples/patchFlow.json | 54 + .../2024-09-27/examples/patchPipeline.json | 43 + .../examples/postListApprovedSchemas.json | 21 + .../examples/postValidateSchema.json | 16 + .../setFlowDestinationEndpointPorts.json | 28 + .../examples/setFlowDestinationEndpoints.json | 28 + .../examples/setFlowPassphrase.json | 26 + .../examples/setFlowSourceAddresses.json | 29 + .../resource-manager/readme.md | 11 +- 38 files changed, 4081 insertions(+), 1 deletion(-) create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/approveOrRejectConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdatePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deletePipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/enableOrDisableFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/generateFlowPassphrase.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpointPorts.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpoints.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowSourceAddresses.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getStreamConnectionString.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listFlowsByConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listOperations.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingConnections.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingFlows.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesByResourceGroup.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesBySubscription.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchConnection.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchFlow.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchPipeline.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postListApprovedSchemas.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postValidateSchema.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpointPorts.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpoints.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowPassphrase.json create mode 100644 specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowSourceAddresses.json diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json new file mode 100644 index 000000000000..e05885a6ccfe --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json @@ -0,0 +1,3054 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-27", + "title": "azuredatatransferrp", + "description": "Azure Data Transfer service resource provider" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AzureDataTransfer/validateSchema": { + "post": { + "description": "Validates a schema for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postValidateSchema.json" + } + }, + "operationId": "AzureDataTransfer_validateSchema", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + }, + "description": "The schema to validate" + } + ], + "responses": { + "200": { + "description": "Result of the schema validation.", + "schema": { + "$ref": "#/definitions/validateSchemaResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.AzureDataTransfer/listApprovedSchemas": { + "post": { + "description": "Lists approved schemas for Azure Data Transfer.", + "x-ms-examples": { + "Performs action request": { + "$ref": "examples/postListApprovedSchemas.json" + } + }, + "operationId": "AzureDataTransfer_listApprovedSchemas", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/listApprovedSchemasRequest" + }, + "description": "The request to list approved schemas." + } + ], + "responses": { + "200": { + "description": "List of approved schemas.", + "schema": { + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}": { + "get": { + "description": "Gets flow resource.", + "x-ms-examples": { + "Gets flow resource": { + "$ref": "examples/getFlow.json" + } + }, + "operationId": "Flows_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the flow resource.", + "operationId": "Flows_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the flow resource": { + "$ref": "examples/createOrUpdateFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flow" + } + } + ], + "responses": { + "200": { + "description": "Created the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "201": { + "description": "Accepted creation the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the flow resource.", + "x-ms-examples": { + "Deletes the flow resource": { + "$ref": "examples/deleteFlow.json" + } + }, + "operationId": "Flows_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the flows resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the flow resource.", + "operationId": "Flows_Update", + "x-ms-examples": { + "Updates the flow resource": { + "$ref": "examples/patchFlow.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/flowsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the flows resource.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Accepted update to the flows resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/flow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/enable": { + "post": { + "description": "Enables the specified flow.", + "x-ms-examples": { + "Enables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Enable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Enables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Enables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/disable": { + "post": { + "description": "Disables the specified flow", + "x-ms-examples": { + "Disables the specified flow": { + "$ref": "examples/enableOrDisableFlow.json" + } + }, + "operationId": "Flows_Disable", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Disables a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Disables a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/link": { + "post": { + "description": "Links the specified flow.", + "x-ms-examples": { + "Links the specified flow": { + "$ref": "examples/linkFlow.json" + } + }, + "operationId": "Flows_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "flow", + "description": "Flow body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Links a flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setPassphrase": { + "post": { + "description": "Sets the passphrase of the specified flow.", + "x-ms-examples": { + "Set the flow stream passphrase": { + "$ref": "examples/setFlowPassphrase.json" + } + }, + "operationId": "Flows_SetPassphrase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "passphrase", + "description": "Passphrase to set", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/setStreamPassphrase" + } + } + ], + "responses": { + "200": { + "description": "Sets a flow passphrase.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Sets a flow passphrase.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/generatePassphrase": { + "post": { + "description": "Generate a compliant passphrase for the specified flow.", + "x-ms-examples": { + "Generate a new compliant streaming passphrase": { + "$ref": "examples/generateFlowPassphrase.json" + } + }, + "operationId": "Flows_GeneratePassphrase", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Generate and set the flow passphrase.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "Generate and set the flow passphrase.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getSourceAddresses": { + "post": { + "description": "Get the source addresses for the specified flow.", + "x-ms-examples": { + "Get the flow stream source addresses": { + "$ref": "examples/getFlowSourceAddresses.json" + } + }, + "operationId": "Flows_GetSourceAddresses", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The source addresses of the flow.", + "schema": { + "$ref": "#/definitions/streamSourceAddresses" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setSourceAddresses": { + "post": { + "description": "Set the source addresses for the specified flow.", + "x-ms-examples": { + "Set the flow stream source addresses": { + "$ref": "examples/setFlowSourceAddresses.json" + } + }, + "operationId": "Flows_SetSourceAddresses", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "sourceAddresses", + "description": "Source addresses wanted", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/setSourceAddresses" + } + } + ], + "responses": { + "200": { + "description": "The source addresses of the flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "The source addresses of the flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpoints": { + "post": { + "description": "Get the destination endpoints for the specified flow and stream ID.", + "x-ms-examples": { + "Get the flow stream destination endpoints": { + "$ref": "examples/getFlowDestinationEndpoints.json" + } + }, + "operationId": "Flows_GetDestinationEndpoints", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The destination endpoints of the stream ID on this flow.", + "schema": { + "$ref": "#/definitions/getDestinationEndpointsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpoints": { + "post": { + "description": "Set the destination endpoints for the specified flow and stream ID.", + "x-ms-examples": { + "Set the flow stream destination endpoints": { + "$ref": "examples/setFlowDestinationEndpoints.json" + } + }, + "operationId": "Flows_SetDestinationEndpoints", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "streamDestinationEndpoints", + "description": "Stream ID destination endpoints wanted", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/setDestinationEndpoints" + } + } + ], + "responses": { + "200": { + "description": "The destination endpoint of the stream ID on this flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "The destination endpoint of the stream ID on this flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getDestinationEndpointPorts": { + "post": { + "description": "Get the destination endpoint ports for the specified flow and stream ID.", + "x-ms-examples": { + "Get the flow stream destination endpoint ports": { + "$ref": "examples/getFlowDestinationEndpointPorts.json" + } + }, + "operationId": "Flows_GetDestinationEndpointPorts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The destination endpoint ports of the stream ID on this flow.", + "schema": { + "$ref": "#/definitions/getDestinationEndpointPortsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/setDestinationEndpointPorts": { + "post": { + "description": "Set the destination endpoint ports for the specified flow and stream ID.", + "x-ms-examples": { + "Set the flow stream destination endpoint ports": { + "$ref": "examples/setFlowDestinationEndpointPorts.json" + } + }, + "operationId": "Flows_SetDestinationEndpointPorts", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "streamDestinationEndpointPorts", + "description": "Stream ID destination endpoint ports wanted", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/setDestinationEndpointPorts" + } + } + ], + "responses": { + "200": { + "description": "The destination endpoint ports of the stream ID on this flow.", + "schema": { + "$ref": "#/definitions/flow" + } + }, + "202": { + "description": "The destination endpoint ports of the stream ID on this flow.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows/{flowName}/getStreamConnectionString": { + "post": { + "description": "Get the connection string for the specified flow.", + "x-ms-examples": { + "Get the flow stream connection string": { + "$ref": "examples/getStreamConnectionString.json" + } + }, + "operationId": "Flows_GetStreamConnectionString", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/flowNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Get the connection string for the specified flow.", + "schema": { + "$ref": "#/definitions/getStreamConnectionStringResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/flows": { + "get": { + "description": "Gets flows in a connection.", + "x-ms-examples": { + "Gets flows in a connection": { + "$ref": "examples/listFlowsByConnection.json" + } + }, + "operationId": "Flows_ListByConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + } + ], + "responses": { + "200": { + "description": "Listed all flows under the resource group.", + "schema": { + "$ref": "#/definitions/flowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}": { + "get": { + "description": "Gets connection resource.", + "x-ms-examples": { + "Gets connection resource": { + "$ref": "examples/getConnection.json" + } + }, + "operationId": "Connections_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the connection resource.", + "operationId": "Connections_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the connection resource": { + "$ref": "examples/createOrUpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connection" + } + } + ], + "responses": { + "200": { + "description": "Created the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "201": { + "description": "Accepted create of the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the connection resource.", + "x-ms-examples": { + "Deletes the connection resource": { + "$ref": "examples/deleteConnection.json" + } + }, + "operationId": "Connections_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the connections resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the connection resource.", + "operationId": "Connections_Update", + "x-ms-examples": { + "Updates the connection resource": { + "$ref": "examples/patchConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/connectionsPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the connections resource.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Accepted update to the connections resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/connection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/link": { + "post": { + "description": "Links the connection to its pending connection.", + "x-ms-examples": { + "Links the specified connection": { + "$ref": "examples/linkConnection.json" + } + }, + "operationId": "Connections_Link", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Links a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Links a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingConnections": { + "post": { + "description": "Lists all pending connections for a connection.", + "x-ms-examples": { + "Lists a list of pending connections": { + "$ref": "examples/listPendingConnections.json" + } + }, + "operationId": "ListPendingConnections_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pending connections.", + "schema": { + "$ref": "#/definitions/pendingConnectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections/{connectionName}/listPendingFlows": { + "post": { + "description": "Lists all pending flows for a connection.", + "x-ms-examples": { + "Lists a list of pending flows": { + "$ref": "examples/listPendingFlows.json" + } + }, + "operationId": "ListPendingFlows_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/pendingFlowsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a resource group.", + "x-ms-examples": { + "Gets connections in a resource group": { + "$ref": "examples/listConnectionsByResourceGroup.json" + } + }, + "operationId": "Connections_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the resource group.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/connections": { + "get": { + "description": "Gets connections in a subscription.", + "x-ms-examples": { + "Gets connections in a subscription": { + "$ref": "examples/listConnectionsBySubscription.json" + } + }, + "operationId": "Connections_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all connections under the subscription.", + "schema": { + "$ref": "#/definitions/connectionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}": { + "get": { + "description": "Gets pipeline resource.", + "x-ms-examples": { + "Gets pipeline resource": { + "$ref": "examples/getPipeline.json" + } + }, + "operationId": "Pipelines_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "description": "Creates or updates the pipeline resource.", + "operationId": "Pipelines_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates the pipeline resource": { + "$ref": "examples/createOrUpdatePipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipeline" + } + } + ], + "responses": { + "200": { + "description": "Created the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "201": { + "description": "Accepted create of the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "description": "Deletes the pipeline resource.", + "x-ms-examples": { + "Deletes the pipeline resource": { + "$ref": "examples/deletePipeline.json" + } + }, + "operationId": "Pipelines_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted delete of the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "204": { + "description": "Deleted the pipelines resource." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "description": "Updates the pipeline resource.", + "operationId": "Pipelines_Update", + "x-ms-examples": { + "Updates the pipeline resource": { + "$ref": "examples/patchPipeline.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "pipeline", + "description": "Pipeline body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/pipelinesPatch" + } + } + ], + "responses": { + "200": { + "description": "Updated the pipelines resource.", + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "202": { + "description": "Accepted update to the pipelines resource.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/pipeline" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/approveConnection": { + "post": { + "description": "Approves the specified connection in a pipeline.", + "x-ms-examples": { + "Approves the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_ApproveConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Approves a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/rejectConnection": { + "post": { + "description": "Rejects the specified connection in a pipeline.", + "x-ms-examples": { + "Rejects the specified connection in a pipeline": { + "$ref": "examples/approveOrRejectConnection.json" + } + }, + "operationId": "Pipelines_RejectConnection", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "connection", + "description": "Connection body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/resourceBody" + } + } + ], + "responses": { + "200": { + "description": "Rejects a connection.", + "schema": { + "$ref": "#/definitions/connection" + } + }, + "202": { + "description": "Rejects a connection.", + "headers": { + "location": { + "description": "Location response header", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/listSchemas": { + "post": { + "description": "Lists the schemas for the specified connection in a pipeline.", + "x-ms-examples": { + "Lists schemas for a pipeline": { + "$ref": "examples/listSchemas.json" + } + }, + "operationId": "ListSchemas_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/pipelineNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "schema", + "description": "Schema(s) to retrieve", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/schema" + } + } + ], + "responses": { + "200": { + "description": "Approves a connection.", + "schema": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a resource group.", + "x-ms-examples": { + "Gets pipelines in a resource group": { + "$ref": "examples/listPipelinesByResourceGroup.json" + } + }, + "operationId": "Pipelines_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the resource group.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureDataTransfer/pipelines": { + "get": { + "description": "Gets pipelines in a subscription.", + "x-ms-examples": { + "Gets pipelines in a subscription": { + "$ref": "examples/listPipelinesBySubscription.json" + } + }, + "operationId": "Pipelines_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all pipelines under the subscription.", + "schema": { + "$ref": "#/definitions/pipelinesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.AzureDataTransfer/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List operations": { + "$ref": "./examples/listOperations.json" + } + }, + "description": "Lists all of the available Microsoft.AzureDataTransfer REST API operations.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Listed all of the available operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "validateSchemaResult": { + "type": "object", + "description": "Result of the schema validation.", + "properties": { + "status": { + "enum": [ + "Succeeded", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "validateSchemaStatus", + "modelAsString": true + }, + "description": "Validation status of the schema" + }, + "message": { + "type": "string", + "description": "Message describing the schema validation" + } + } + }, + "listApprovedSchemasRequest": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "The name of the pipeline to filter approved schemas." + }, + "direction": { + "description": "The direction pipeline to filter approved schemas.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "listApprovedSchemasDirection", + "modelAsString": true + } + } + } + }, + "selectedResource": { + "type": "object", + "description": "A resource selected from ARM", + "properties": { + "name": { + "type": "string", + "description": "Name of the connection" + }, + "id": { + "type": "string", + "description": "Id of the connection" + }, + "location": { + "type": "string", + "description": "Location of the connection", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "subscriptionName": { + "type": "string", + "description": "Name of the subscription with the connection" + } + }, + "required": [ + "id" + ] + }, + "flowProperties": { + "type": "object", + "properties": { + "connection": { + "$ref": "#/definitions/selectedResource", + "description": "The connection associated with this flow" + }, + "flowId": { + "type": "string", + "description": "Dataflow GUID associated with this flow", + "readOnly": true + }, + "keyVaultUri": { + "type": "string", + "description": "AME, PME, or TORUS only! AKV Chain Containing SAS Token" + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatusFlow", + "modelAsString": true + }, + "description": "Link status of the current flow", + "readOnly": true + }, + "linkedFlowId": { + "type": "string", + "description": "Resource ID of the linked flow", + "readOnly": true + }, + "status": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "flowStatus", + "modelAsString": true + }, + "description": "Status of the current flow" + }, + "storageAccountName": { + "type": "string", + "description": "Storage Account" + }, + "storageAccountId": { + "type": "string", + "format": "arm-id", + "description": "Storage Account ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/storageAccounts" + } + ] + } + }, + "storageContainerName": { + "type": "string", + "description": "Storage Container Name" + }, + "serviceBusQueueId": { + "type": "string", + "format": "arm-id", + "description": "Service Bus Queue ID", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "scopes": [ + "*" + ], + "type": "Microsoft.Storage/namespaces/queues" + } + ] + } + }, + "flowType": { + "$ref": "#/definitions/flowType", + "description": "The flow type for this flow" + }, + "dataType": { + "enum": [ + "Blob", + "Table" + ], + "type": "string", + "x-ms-enum": { + "name": "dataType", + "modelAsString": true + }, + "description": "Transfer Storage Blobs or Tables" + }, + "provisioningState": { + "description": "Provisioning state of the flow", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this flow", + "items": { + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/schema", + "description": "The selected schema for this flow" + }, + "messagingOptions": { + "$ref": "#/definitions/messagingOptions", + "description": "The messaging options for this flow" + }, + "customerManagedKeyVaultUri": { + "type": "string", + "format": "url", + "description": "The URI to the customer managed key for this flow" + }, + "streamId": { + "type": "string", + "description": "The flow stream identifier" + }, + "streamProtocol": { + "description": "The protocol of the stream", + "enum": [ + "UDP", + "SRT", + "RTP" + ], + "type": "string", + "x-ms-enum": { + "name": "streamProtocol", + "modelAsString": true + } + }, + "streamLatency": { + "type": "integer", + "format": "int64", + "description": "The latency of the stream in milliseconds" + }, + "passphrase": { + "type": "string", + "description": "The passphrase used for SRT streams" + }, + "sourceAddresses": { + "$ref": "#/definitions/streamSourceAddresses", + "description": "The source IP address and CIDR ranges of the stream" + }, + "destinationEndpoints": { + "type": "array", + "description": "The destination endpoints of the stream", + "items": { + "type": "string" + } + }, + "destinationEndpointPorts": { + "type": "array", + "description": "The destination endpoint ports of the stream", + "items": { + "type": "integer", + "format": "int64" + } + } + }, + "description": "Properties of flow" + }, + "flow": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/flowProperties" + }, + "plan": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/Plan" + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The flow resource definition." + }, + "pendingFlow": { + "type": "object", + "description": "Pending flow object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending flow.", + "readOnly": true + }, + "connectionId": { + "type": "string", + "description": "Connection ID of the pending flow.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/flowProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "flowsPatch": { + "type": "object", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed identity of the flow resource, if configured." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The flows resource patch definition." + }, + "flowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/flow" + }, + "description": "Flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The flows list result." + }, + "connectionProperties": { + "type": "object", + "properties": { + "pipeline": { + "type": "string", + "description": "Pipeline to use to transfer data" + }, + "direction": { + "description": "Direction of data movement", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + }, + "justification": { + "type": "string", + "description": "Justification for the connection request" + }, + "status": { + "description": "Status of the connection", + "enum": [ + "InReview", + "Approved", + "Rejected", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "status", + "modelAsString": true + }, + "readOnly": true + }, + "statusReason": { + "type": "string", + "description": "Reason for status", + "readOnly": true + }, + "linkStatus": { + "enum": [ + "Linked", + "Unlinked" + ], + "type": "string", + "x-ms-enum": { + "name": "linkStatus", + "modelAsString": true + }, + "description": "Link status of the current connection", + "readOnly": true + }, + "linkedConnectionId": { + "type": "string", + "description": "Resource ID of the linked connection", + "readOnly": true + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types being requested for this connection" + }, + "requirementId": { + "description": "Requirement ID of the connection", + "type": "string" + }, + "remoteSubscriptionId": { + "description": "Subscription ID to link cloud subscriptions together", + "type": "string" + }, + "approver": { + "description": "Approver of this connection request", + "type": "string", + "readOnly": true + }, + "pin": { + "description": "PIN to link requests together", + "type": "string" + }, + "dateSubmitted": { + "type": "string", + "format": "date-time", + "description": "The timestamp that this connection request was submitted at", + "readOnly": true + }, + "primaryContact": { + "type": "string", + "description": "The primary contact for this connection request" + }, + "secondaryContacts": { + "type": "array", + "description": "The secondary contacts for this connection request", + "items": { + "type": "string" + } + }, + "provisioningState": { + "description": "Provisioning state of the connection", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this connection", + "items": { + "type": "string" + } + }, + "schemas": { + "description": "The schemas for this connection", + "$ref": "#/definitions/schemas" + }, + "schemaUris": { + "description": "The schema URIs for this connection", + "type": "array", + "items": { + "type": "string", + "format": "url" + } + } + }, + "required": [ + "pipeline" + ], + "description": "Properties of connection" + }, + "connection": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/connectionProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The connection resource definition." + }, + "pendingConnection": { + "type": "object", + "description": "Pending connection object", + "properties": { + "subscriptionId": { + "type": "string", + "description": "Subscription ID of the pending connection.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/connectionProperties" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "connectionsPatch": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The connections resource patch definition." + }, + "connectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/connection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingConnectionsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingConnection" + }, + "description": "Connections array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "pendingFlowsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pendingFlow" + }, + "description": "flows array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The connections list result." + }, + "operationStatusProperties": { + "type": "object", + "description": "Operation status associated with the last patch request", + "properties": { + "status": { + "enum": [ + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "operationStatusEnum", + "modelAsString": true + }, + "description": "Operation status for the last patch request for this connection.", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Operation status ID of the last patch request for this connection.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Message for the operation for the last patch request for this connection.", + "readOnly": true + } + } + }, + "internalMetadataProperties": { + "type": "object", + "description": "Internal metadata of the connection inside pipeline.", + "properties": { + "operationStatus": { + "$ref": "#/definitions/operationStatusProperties" + }, + "statusSetBy": { + "type": "string", + "description": "User that last set the approved status for this connection", + "readOnly": true + } + }, + "additionalProperties": {} + }, + "pipelineConnection": { + "description": "Connection body inside a pipeline", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Connection id inside pipeline" + }, + "name": { + "type": "string", + "description": "Connection name inside pipeline", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Connection type inside pipeline", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Connection location inside pipeline", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "etag": { + "type": "string", + "description": "Connection etag inside pipeline", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/systemData" + }, + "properties": { + "type": "object", + "description": "Connection properties inside pipeline", + "properties": { + "internalMetadata": { + "$ref": "#/definitions/internalMetadataProperties" + } + }, + "additionalProperties": {} + } + }, + "additionalProperties": {}, + "required": [ + "id" + ] + }, + "pipelineProperties": { + "type": "object", + "properties": { + "remoteCloud": { + "type": "string", + "description": "Remote cloud of the data to be transferred or received" + }, + "displayName": { + "type": "string", + "description": "Display name of this pipeline" + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "readOnly": true, + "x-ms-identifiers": [ + "id" + ] + }, + "subscribers": { + "type": "array", + "items": { + "$ref": "#/definitions/subscriber" + }, + "x-ms-identifiers": [], + "description": "Subscribers of this resource" + }, + "provisioningState": { + "description": "Provisioning state of the pipeline", + "enum": [ + "Failed", + "Succeeded", + "Canceled", + "Accepted" + ], + "type": "string", + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "policies": { + "type": "array", + "description": "The policies for this pipeline", + "items": { + "type": "string" + } + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "required": [ + "remoteCloud" + ], + "description": "Properties of pipeline" + }, + "pipeline": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "$ref": "#/definitions/pipelineProperties" + } + }, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "description": "The pipeline resource definition." + }, + "pipelinesPatch": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/pipelineConnection" + }, + "description": "Connections associated with pipeline", + "x-ms-identifiers": [ + "id" + ] + }, + "flowTypes": { + "$ref": "#/definitions/flowTypes", + "description": "The flow types allowed for this pipeline" + } + }, + "description": "Properties of pipelines patch body." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "The pipelines resource patch definition." + }, + "pipelinesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/pipeline" + }, + "description": "Pipelines array.", + "x-ms-identifiers": [ + "id" + ] + }, + "nextLink": { + "description": "Link to next results", + "type": "string" + } + }, + "description": "The pipelines list result." + }, + "subscriber": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "Email of the subscriber" + }, + "notifications": { + "type": "integer", + "format": "int64", + "description": "Number specifying what notifications to receive" + } + } + }, + "schemas": { + "type": "array", + "description": "The schemas for this connection", + "x-ms-identifiers": [ + "connectionId", + "name" + ], + "items": { + "$ref": "#/definitions/schema" + } + }, + "schema": { + "type": "object", + "description": "The schema object.", + "properties": { + "id": { + "type": "string", + "description": "ID associated with this schema" + }, + "connectionId": { + "type": "string", + "description": "Connection ID associated with this schema" + }, + "status": { + "enum": [ + "New", + "Approved" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaStatus", + "modelAsString": true + }, + "description": "Status of the schema" + }, + "name": { + "type": "string", + "description": "Name of the schema" + }, + "content": { + "type": "string", + "description": "Content of the schema" + }, + "direction": { + "description": "The direction of the schema.", + "enum": [ + "Send", + "Receive" + ], + "type": "string", + "x-ms-enum": { + "name": "schemaDirection", + "modelAsString": true + } + }, + "schemaUri": { + "type": "string", + "format": "url", + "description": "Uri containing SAS token for the zipped schema" + }, + "schemaType": { + "description": "The Schema Type", + "enum": [ + "Xsd", + "Zip" + ], + "type": "string", + "x-ms-enum": { + "name": "SchemaType", + "modelAsString": true + } + } + } + }, + "schemasListResult": { + "type": "object", + "properties": { + "value": { + "description": "Schemas array.", + "$ref": "#/definitions/schemas" + } + }, + "description": "The schemas list result." + }, + "flowTypes": { + "type": "array", + "description": "The flow types that are allowed for this resource", + "items": { + "$ref": "#/definitions/flowType" + } + }, + "flowType": { + "enum": [ + "Unknown", + "Complex", + "DevSecOps", + "Messaging", + "Mission", + "MicrosoftInternal", + "BasicFiles", + "Data", + "Standard", + "StreamingVideo", + "Opaque", + "MissionOpaqueXML" + ], + "type": "string", + "x-ms-enum": { + "name": "flowType", + "modelAsString": true + }, + "description": "Flow type for the specified resource" + }, + "resourceBody": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the resource." + }, + "statusReason": { + "type": "string", + "description": "Reason for resource operation." + } + }, + "required": [ + "id" + ], + "description": "The resource to reference." + }, + "messagingOptions": { + "type": "object", + "properties": { + "billingTier": { + "enum": [ + "BlobTransport", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "flowBillingTier", + "modelAsString": true + }, + "description": "Billing tier for this messaging flow" + } + }, + "description": "The option associated with messaging flows." + }, + "streamSourceAddresses": { + "type": "object", + "description": "The source IP address and CIDR ranges of the stream", + "properties": { + "sourceAddresses": { + "type": "array", + "description": "A source IP address or CIDR range", + "items": { + "type": "string" + } + } + } + }, + "getDestinationEndpointsResult": { + "type": "object", + "description": "List of destination endpoints for the flow stream", + "properties": { + "endpoints": { + "type": "array", + "description": "The destination endpoints for the flow stream", + "items": { + "type": "string" + } + } + } + }, + "getDestinationEndpointPortsResult": { + "type": "object", + "description": "List of destination endpoint ports for the flow stream", + "properties": { + "ports": { + "type": "array", + "description": "The destination endpoint port for the flow stream", + "items": { + "type": "integer", + "format": "int64" + } + } + } + }, + "getStreamConnectionStringResult": { + "type": "object", + "description": "The connection string for the specified streaming flow", + "properties": { + "connectionString": { + "type": "string", + "description": "The connection string for the specified streaming flow" + } + } + }, + "setStreamPassphrase": { + "type": "object", + "description": "Set the passphrase used for SRT streams", + "properties": { + "value": { + "type": "string", + "description": "The passphrase used for SRT streams" + } + } + }, + "setSourceAddresses": { + "type": "object", + "description": "Set the source addresses for the specified stream ID", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Source addresses" + } + } + }, + "setDestinationEndpoints": { + "type": "object", + "description": "Set the destination endpoints for the specified stream ID", + "properties": { + "endpoints": { + "type": "array", + "description": "The specified stream ID destination endpoints", + "items": { + "type": "string" + } + } + } + }, + "setDestinationEndpointPorts": { + "type": "object", + "description": "Set the destination endpoint ports for the specified stream ID", + "properties": { + "ports": { + "type": "array", + "description": "The specified stream ID destination endpoint ports", + "items": { + "type": "integer", + "format": "int64" + } + } + } + } + }, + "parameters": { + "flowNameParameter": { + "x-ms-parameter-location": "method", + "name": "flowName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the flow that is to be onboarded." + }, + "connectionNameParameter": { + "x-ms-parameter-location": "method", + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the connection that is to be requested." + }, + "pipelineNameParameter": { + "x-ms-parameter-location": "method", + "name": "pipelineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,64}$", + "maxLength": 64, + "minLength": 3, + "description": "The name for the pipeline that is to be requested." + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/approveOrRejectConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/approveOrRejectConnection.json new file mode 100644 index 000000000000..55e122a10339 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/approveOrRejectConnection.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "statusReason": "Example reason" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateConnection.json new file mode 100644 index 000000000000..75039973d251 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateConnection.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateFlow.json new file mode 100644 index 000000000000..6dcad02ff412 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdateFlow.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdatePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdatePipeline.json new file mode 100644 index 000000000000..9f522501ab4e --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/createOrUpdatePipeline.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": { + "properties": { + "remoteCloud": "testdc" + }, + "location": "East US" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteConnection.json new file mode 100644 index 000000000000..ae8aa2096cec --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteConnection.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteFlow.json new file mode 100644 index 000000000000..a632b6cb7594 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deleteFlow.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deletePipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deletePipeline.json new file mode 100644 index 000000000000..148bc7d7967d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/deletePipeline.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + }, + "204": {} + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/enableOrDisableFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/enableOrDisableFlow.json new file mode 100644 index 000000000000..9c71355ba8cf --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/enableOrDisableFlow.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/generateFlowPassphrase.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/generateFlowPassphrase.json new file mode 100644 index 000000000000..9c71355ba8cf --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/generateFlowPassphrase.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getConnection.json new file mode 100644 index 000000000000..7504a902b5f2 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getConnection.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connection/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlow.json new file mode 100644 index 000000000000..de72bac42406 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlow.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpointPorts.json new file mode 100644 index 000000000000..fed09ec2636a --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpointPorts.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "ports": [ + 1234 + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpoints.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpoints.json new file mode 100644 index 000000000000..221207813f6b --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowDestinationEndpoints.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "endpoints": [ + "10.0.0.1" + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowSourceAddresses.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowSourceAddresses.json new file mode 100644 index 000000000000..d3dd6bb73842 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getFlowSourceAddresses.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "sourceAddresses": [ + "0.0.0.0", + "1.0.0.0/24" + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getPipeline.json new file mode 100644 index 000000000000..d9f72db1c1fe --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getPipeline.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getStreamConnectionString.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getStreamConnectionString.json new file mode 100644 index 000000000000..4f30564c6bd1 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/getStreamConnectionString.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "connectionString": "https://fmv.usgovirginia.adt.microsoft.com:1234/?passphrase=password123&streamid=1234" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkConnection.json new file mode 100644 index 000000000000..61bc8d487ed4 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connection", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkFlow.json new file mode 100644 index 000000000000..97221a38bbcf --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/linkFlow.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsByResourceGroup.json new file mode 100644 index 000000000000..65b2846d7f32 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsBySubscription.json new file mode 100644 index 000000000000..e1c2bf919d72 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listConnectionsBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listFlowsByConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listFlowsByConnection.json new file mode 100644 index 000000000000..a87071af2abf --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listFlowsByConnection.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + }, + { + "name": "testConnection2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection2/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listOperations.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listOperations.json new file mode 100644 index 000000000000..b71609710215 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listOperations.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "teleportalClient", + "api-version": "2024-09-27", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureDataTransfer/read", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Read flows", + "description": "Read flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/write", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Update flows", + "description": "Update flows" + } + }, + { + "name": "Microsoft.AzureDataTransfer/delete", + "display": { + "provider": "CTS Experience", + "resource": "Flow", + "operation": "Delete flows", + "description": "Delete flows" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingConnections.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingConnections.json new file mode 100644 index 000000000000..1f0e5606e36c --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingConnections.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + }, + { + "name": "testConnection", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "location": "East US", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingFlows.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingFlows.json new file mode 100644 index 000000000000..35cd0829c050 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPendingFlows.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "connectionName": "testConnection", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testFlow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + }, + { + "name": "testInstallation2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Blob" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesByResourceGroup.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesByResourceGroup.json new file mode 100644 index 000000000000..01618823a666 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesBySubscription.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesBySubscription.json new file mode 100644 index 000000000000..c2c32cbb7399 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listPipelinesBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPipeline", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + }, + { + "name": "testPipeline2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline2", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listSchemas.json new file mode 100644 index 000000000000..59f0de18fc46 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/listSchemas.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "schema": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "name": "test.xsd" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchConnection.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchConnection.json new file mode 100644 index 000000000000..fdc340943bed --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchConnection.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "connectionName": "testConnection", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "connection": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection", + "type": "Microsoft.AzureDataTransfer/connections", + "location": "East US", + "properties": { + "pipeline": "testdc", + "justification": "justification", + "requirementId": "id" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchFlow.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchFlow.json new file mode 100644 index 000000000000..08073eaca727 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchFlow.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "flow": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/connections/flows", + "location": "East US", + "properties": { + "storageAccountName": "testsa", + "storageContainerName": "testcontainer", + "flowType": "Standard", + "connection": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testFlow" + } + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchPipeline.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchPipeline.json new file mode 100644 index 000000000000..39a79a71f298 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/patchPipeline.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "pipelineName": "testPipeline", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "pipeline": {}, + "tags": { + "tag": "value" + } + }, + "responses": { + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + }, + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + }, + "200": { + "body": { + "tags": { + "tag": "value" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/pipelines/testPipeline", + "type": "Microsoft.AzureDataTransfer/pipelines", + "location": "East US", + "properties": { + "remoteCloud": "testdc" + } + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postListApprovedSchemas.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postListApprovedSchemas.json new file mode 100644 index 000000000000..a08ad3c356fa --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postListApprovedSchemas.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2024-09-27", + "pipeline": { + "pipeline": "test", + "direction": "Send" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test.xsd", + "content": "xsd content" + } + ] + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postValidateSchema.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postValidateSchema.json new file mode 100644 index 000000000000..08c84fd4b40d --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/postValidateSchema.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2024-09-27", + "schema": { + "name": "schema.xml" + } + }, + "responses": { + "200": { + "body": { + "status": "Failed", + "message": "Validation failed" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpointPorts.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpointPorts.json new file mode 100644 index 000000000000..ba440c01bcc3 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpointPorts.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "streamDestinationEndpointPorts": { + "ports": [ + 1234 + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpoints.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpoints.json new file mode 100644 index 000000000000..c510a18c73ac --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowDestinationEndpoints.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "streamDestinationEndpoints": { + "endpoints": [ + "10.0.0.1" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowPassphrase.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowPassphrase.json new file mode 100644 index 000000000000..19626a6f7e06 --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowPassphrase.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "passphrase": { + "value": "password123" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowSourceAddresses.json b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowSourceAddresses.json new file mode 100644 index 000000000000..16d1e4d7b8de --- /dev/null +++ b/specification/azuredatatransfer/resource-manager/Microsoft.AzureDataTransfer/stable/2024-09-27/examples/setFlowSourceAddresses.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "connectionName": "testConnection", + "flowName": "testFlow", + "resourceGroupName": "testRG", + "api-version": "2024-09-27", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "sourceAddresses": { + "values": [ + "0.0.0.0", + "1.0.0.0/24" + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection/flows/testFlow", + "type": "Microsoft.AzureDataTransfer/flows", + "location": "East US" + } + }, + "202": { + "headers": { + "location": "http://management.azure.com/subscriptions/12345/providers/Microsoft.AzureDataTransfer/locations/eastUS?api-version=2024-09-27" + } + } + } +} diff --git a/specification/azuredatatransfer/resource-manager/readme.md b/specification/azuredatatransfer/resource-manager/readme.md index 6e1ef87294e3..59e7759094db 100644 --- a/specification/azuredatatransfer/resource-manager/readme.md +++ b/specification/azuredatatransfer/resource-manager/readme.md @@ -27,10 +27,19 @@ These are the global settings for the azuredatatransfer. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-2024-09 +tag: package-2024-09-27 ``` +### Tag: package-2024-09-27 + +These settings apply only when `--tag=package-2024-09-27` is specified on the command line. + +```yaml $(tag) == 'package-2024-09-27' +input-file: + - Microsoft.AzureDataTransfer/stable/2024-09-27/azuredatatransfer.json +``` + ### Tag: package-2024-09 These settings apply only when `--tag=package-2024-09` is specified on the command line. From 07bdede4651ce2ea0e4039d76e81a69df23a3d6e Mon Sep 17 00:00:00 2001 From: Timothee Guerin <timothee.guerin@outlook.com> Date: Thu, 10 Oct 2024 13:37:01 -0700 Subject: [PATCH 087/101] Upgrade to typespec 0.61.0 (#30955) --- package-lock.json | 219 +++++++++--------- package.json | 24 +- .../apicenter/ApiCenter.Management/models.tsp | 1 + .../EmrCluster.Management/main.tsp | 1 + .../main.tsp | 5 + .../PublicCloud.Management/main.tsp | 2 + .../client.tsp | 5 +- .../NetworkAnalytics.Management/main.tsp | 2 + .../portal/Dashboard.Management/models.tsp | 4 + .../Extension.Management/models.tsp | 2 + .../sphere/Sphere.Management/models.tsp | 3 + .../scriptExecutions.tsp | 1 + 12 files changed, 141 insertions(+), 128 deletions(-) diff --git a/package-lock.json b/package-lock.json index b5677bb0bbc9..57bb71bbc8fa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,21 +7,21 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.9", - "@azure-tools/typespec-autorest": "0.46.0", - "@azure-tools/typespec-azure-core": "0.46.0", - "@azure-tools/typespec-azure-portal-core": "0.46.0", - "@azure-tools/typespec-azure-resource-manager": "0.46.1", - "@azure-tools/typespec-azure-rulesets": "0.46.0", + "@azure-tools/typespec-autorest": "0.47.0", + "@azure-tools/typespec-azure-core": "0.47.0", + "@azure-tools/typespec-azure-portal-core": "0.47.0", + "@azure-tools/typespec-azure-resource-manager": "0.47.0", + "@azure-tools/typespec-azure-rulesets": "0.47.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.2", + "@azure-tools/typespec-client-generator-core": "0.47.0", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.1", - "@typespec/http": "0.60.0", - "@typespec/openapi": "0.60.0", - "@typespec/openapi3": "0.60.0", - "@typespec/rest": "0.60.0", - "@typespec/versioning": "0.60.1", + "@typespec/compiler": "0.61.0", + "@typespec/http": "0.61.0", + "@typespec/openapi": "0.61.0", + "@typespec/openapi3": "0.61.0", + "@typespec/rest": "0.61.0", + "@typespec/versioning": "0.61.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", @@ -883,55 +883,55 @@ } }, "node_modules/@azure-tools/typespec-autorest": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.46.0.tgz", - "integrity": "sha512-LCIvxQgjczWUq/wi6fzKBqYHWJYD0hRLA8wBPzFasriHdBDHjpZ6vgTPmApzt0H5ArZX92Ar53Q5+ZXD9ktMUg==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.47.0.tgz", + "integrity": "sha512-uYkk8mnzekSMhJKU3RS0cXvKPH0vbkonthYoPe7/vxZ7tWv4xJLSglV2v3m3QElFgvNebNVoBOEWSY8Kz/ip2Q==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.46.0", - "@azure-tools/typespec-azure-resource-manager": "~0.46.0", - "@azure-tools/typespec-client-generator-core": "~0.46.0", - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0", - "@typespec/openapi": "~0.60.0", - "@typespec/rest": "~0.60.0", - "@typespec/versioning": "~0.60.0" + "@azure-tools/typespec-azure-core": "~0.47.0", + "@azure-tools/typespec-azure-resource-manager": "~0.47.0", + "@azure-tools/typespec-client-generator-core": "~0.47.0", + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0", + "@typespec/openapi": "~0.61.0", + "@typespec/rest": "~0.61.0", + "@typespec/versioning": "~0.61.0" } }, "node_modules/@azure-tools/typespec-azure-core": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.46.0.tgz", - "integrity": "sha512-BNE31enSHWtWlrdIKShBS6CNFGk3OYmHSBnWqobcFJkTGXC090EoV2u6otn4BMI99fZRSR4gpwp/kYU9KLE9Jw==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.47.0.tgz", + "integrity": "sha512-RcBC5+dE1BVXTrUkkKULTImGxzM/ea3P3IL2kr9pk7r1uqF7D4CGqEKHFTg5L6QUtqc1f+zgTgQTNn6t4gI92w==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0", - "@typespec/rest": "~0.60.0" + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0", + "@typespec/rest": "~0.61.0" } }, "node_modules/@azure-tools/typespec-azure-portal-core": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.46.0.tgz", - "integrity": "sha512-bkbD5N8dORnfpna+0Graq0nUtgXcF4tKMcVTJ3QVWpyF+N3Mf7EDkD1GNaK7rKOx+1W5IiUX+gXEIy2uH6DUeQ==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-portal-core/-/typespec-azure-portal-core-0.47.0.tgz", + "integrity": "sha512-SSdS7fzG+QBATs3gesjgDDrBRLv2KEnFznfCFx1gHOq/V3IvLlnhlH6T7nK8s4dGLPDVGv30a1NewIYt0MUUoQ==", "dev": true, "license": "MIT", "peerDependencies": { - "@azure-tools/typespec-azure-resource-manager": "~0.46.0", - "@typespec/compiler": "~0.60.0" + "@azure-tools/typespec-azure-resource-manager": "~0.47.0", + "@typespec/compiler": "~0.61.0" } }, "node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.46.1", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.46.1.tgz", - "integrity": "sha512-8md8AwnxoYVkDBavQL5dbToUTS10PTSkcF+emd9BKEdnF9MKuA542vZudzaQOz2BzFbArMVUE/PLm2mhuwRkLw==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.47.0.tgz", + "integrity": "sha512-pe9XhHJezTZtVlSVKIMhL1kRATMg6QSaXUZQhQmQKSuozVRsRBxI4IAhK3RU4p6SA8A2CoCpPeJpRhQTvdt73Q==", "dev": true, "license": "MIT", "dependencies": { @@ -942,28 +942,28 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.46.0", - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0", - "@typespec/openapi": "~0.60.0", - "@typespec/rest": "~0.60.0", - "@typespec/versioning": "~0.60.0" + "@azure-tools/typespec-azure-core": "~0.47.0", + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0", + "@typespec/openapi": "~0.61.0", + "@typespec/rest": "~0.61.0", + "@typespec/versioning": "~0.61.0" } }, "node_modules/@azure-tools/typespec-azure-rulesets": { - "version": "0.46.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.46.0.tgz", - "integrity": "sha512-HssO+0ARHbnuLhRiT/7l5DF2hV91Jf/MmsSPdOsDMbVZG26YsB8JD1MiBqs9VJZjB+1xn2DiimYrgqF4n9aDvw==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-rulesets/-/typespec-azure-rulesets-0.47.0.tgz", + "integrity": "sha512-CG6sGYc/9qKAQIWtauzH6yEoTdugfz4DEmiWcytJMhgw1tQ2bqmcJuar01ctDKuaD5F1PKZ0X3oAxPu84pIlqw==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.46.0", - "@azure-tools/typespec-azure-resource-manager": "~0.46.0", - "@azure-tools/typespec-client-generator-core": "~0.46.0", - "@typespec/compiler": "~0.60.0" + "@azure-tools/typespec-azure-core": "~0.47.0", + "@azure-tools/typespec-azure-resource-manager": "~0.47.0", + "@azure-tools/typespec-client-generator-core": "~0.47.0", + "@typespec/compiler": "~0.61.0" } }, "node_modules/@azure-tools/typespec-client-generator-cli": { @@ -997,10 +997,11 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.46.2", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.2.tgz", - "integrity": "sha512-/HKeehCNDeylouOHMe7IwpcDcGJHRAuEy3a5FBnSY51m4EpMq4VMQzW9tka/8brFO2m5LLj7tyhOL/xnzi2fLg==", + "version": "0.47.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.47.0.tgz", + "integrity": "sha512-Z7zBxfGjGgUSFdno5m4Oi5OzWF9pTjw2edUv6IjJDN824ViXKXa15MpzodBR6Ad9lblsRE9KrYGMJeCPx75oNA==", "dev": true, + "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -1009,12 +1010,12 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.46.0", - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0", - "@typespec/openapi": "~0.60.0", - "@typespec/rest": "~0.60.0", - "@typespec/versioning": "~0.60.0" + "@azure-tools/typespec-azure-core": "~0.47.0", + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0", + "@typespec/openapi": "~0.61.0", + "@typespec/rest": "~0.61.0", + "@typespec/versioning": "~0.61.0" } }, "node_modules/@azure-tools/typespec-liftr-base": { @@ -3446,24 +3447,25 @@ } }, "node_modules/@typespec/compiler": { - "version": "0.60.1", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.1.tgz", - "integrity": "sha512-I6Vcpvd7mBP7SI5vCBh9rZGXAtVy95BKhAd33Enw32psswiSzRpA7zdyZhOMekTOGVXNS/+E5l2PGGCzQddB4w==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.61.0.tgz", + "integrity": "sha512-sVS8oa6aWAsb2Dy2c4HGn5VOxoYy05bveMn6GRnBA8ZP/wPD3nvJgqWy94AUPezofKoGOfg0Pp/BrrkVyDzCuw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "~7.24.7", "ajv": "~8.17.1", "change-case": "~5.4.4", "globby": "~14.0.2", "mustache": "~4.2.0", - "picocolors": "~1.0.1", + "picocolors": "~1.1.0", "prettier": "~3.3.3", "prompts": "~2.4.2", "semver": "^7.6.3", "temporal-polyfill": "^0.2.5", "vscode-languageserver": "~9.0.1", - "vscode-languageserver-textdocument": "~1.0.11", - "yaml": "~2.4.5", + "vscode-languageserver-textdocument": "~1.0.12", + "yaml": "~2.5.1", "yargs": "~17.7.2" }, "bin": { @@ -3474,55 +3476,55 @@ "node": ">=18.0.0" } }, - "node_modules/@typespec/compiler/node_modules/yaml": { - "version": "2.4.5", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.5.tgz", - "integrity": "sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg==", + "node_modules/@typespec/compiler/node_modules/picocolors": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", + "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", "dev": true, - "license": "ISC", - "bin": { - "yaml": "bin.mjs" - }, - "engines": { - "node": ">= 14" - } + "license": "ISC" }, "node_modules/@typespec/http": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.60.0.tgz", - "integrity": "sha512-ktfS9vpHfltyeAaQLNAZdqrn6Per3vmB/HDH/iyudYLA5wWblT1siKvpFCMWq53CJorRO7yeOKv+Q/M26zwEtg==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.61.0.tgz", + "integrity": "sha512-7+AYHkzkc+p652GY9BcEbXY4OZa1fTr03MVmZeafvmbQbXfyzUU9eJld13M3v6NaUWqXWZ7nBNMISyKiXp/kSw==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0" + "@typespec/compiler": "~0.61.0", + "@typespec/streams": "~0.61.0" + }, + "peerDependenciesMeta": { + "@typespec/streams": { + "optional": true + } } }, "node_modules/@typespec/openapi": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.60.0.tgz", - "integrity": "sha512-YVwLppgHY8r/MudHNSLSUXzdw+CIpjmb31gI2a0KDGnI6sWDwY7LSWfjGU4TY/ubt0+X0Tjoy330mTvw71YBTg==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.61.0.tgz", + "integrity": "sha512-3AF319Ae4yGVOscsCLQeedXUJJcL/NdGOR2/e/nFiL/AOVdgLfIRnpR0Ad9Zj9XAESh1fq9XSu4Mi7N1k4V7rw==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0" + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0" } }, "node_modules/@typespec/openapi3": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.60.0.tgz", - "integrity": "sha512-gvrTHZACdeQtV7GfhVOHqkyTgMFyM2nKAIiz2P83LIncMCDUc00bGKGmaBk+xpuwKtCJyxBeVpCbID31YAq96g==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.61.0.tgz", + "integrity": "sha512-ALLsTkK1UiJBzvygV1Zk/yZaym+lOWroGeEUhQNXYShsq+/GLZkK0rl8sd76Gigq+TVXKMOEwUUvgfws/LMUJw==", "dev": true, "license": "MIT", "dependencies": { "@readme/openapi-parser": "~2.6.0", - "yaml": "~2.4.5" + "yaml": "~2.5.1" }, "bin": { "tsp-openapi3": "cmd/tsp-openapi3.js" @@ -3531,23 +3533,10 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0", - "@typespec/openapi": "~0.60.0", - "@typespec/versioning": "~0.60.0" - } - }, - "node_modules/@typespec/openapi3/node_modules/yaml": { - "version": "2.4.5", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.5.tgz", - "integrity": "sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg==", - "dev": true, - "license": "ISC", - "bin": { - "yaml": "bin.mjs" - }, - "engines": { - "node": ">= 14" + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0", + "@typespec/openapi": "~0.61.0", + "@typespec/versioning": "~0.61.0" } }, "node_modules/@typespec/prettier-plugin-typespec": { @@ -3561,30 +3550,30 @@ } }, "node_modules/@typespec/rest": { - "version": "0.60.0", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.60.0.tgz", - "integrity": "sha512-mHYubyuBvwdV2xkHrJfPwV7b/Ksyb9lA1Q/AQwpVFa7Qu1X075TBVALmH+hK3V0EdUG1CGJZ5Sw4BWgl8ZS0BA==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.61.0.tgz", + "integrity": "sha512-L9Oyor+l42p6S8GE+UvaZTi+dcu6WubGZKmaBRpX8mCZGsa69EgIK8DQoyxrfMcxAO4I5U0sfkzCKwCVFtRr9g==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0", - "@typespec/http": "~0.60.0" + "@typespec/compiler": "~0.61.0", + "@typespec/http": "~0.61.0" } }, "node_modules/@typespec/versioning": { - "version": "0.60.1", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.60.1.tgz", - "integrity": "sha512-HogYL7P9uOPoSvkLLDjF22S6E9td6EY3c6TcIHhCzDTAQoi54csikD0gNrtcCkFG0UeQk29HgQymV397j+vp4g==", + "version": "0.61.0", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.61.0.tgz", + "integrity": "sha512-PIIug6eg3zc7E+BBHyNHHQD+OBq3FU465nhKrLEp35iVji/sYFuPc1ywnELDuwJVRWm6nvqNL1vtnc+4lEk+oA==", "dev": true, "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.60.0" + "@typespec/compiler": "~0.61.0" } }, "node_modules/@ungap/structured-clone": { diff --git a/package.json b/package.json index e9c2ab0f565d..7b16327e068e 100644 --- a/package.json +++ b/package.json @@ -2,21 +2,21 @@ "name": "azure-rest-api-specs", "devDependencies": { "@azure-tools/typespec-apiview": "0.4.9", - "@azure-tools/typespec-autorest": "0.46.0", - "@azure-tools/typespec-azure-core": "0.46.0", - "@azure-tools/typespec-azure-portal-core": "0.46.0", - "@azure-tools/typespec-azure-resource-manager": "0.46.1", - "@azure-tools/typespec-azure-rulesets": "0.46.0", + "@azure-tools/typespec-autorest": "0.47.0", + "@azure-tools/typespec-azure-core": "0.47.0", + "@azure-tools/typespec-azure-portal-core": "0.47.0", + "@azure-tools/typespec-azure-resource-manager": "0.47.0", + "@azure-tools/typespec-azure-rulesets": "0.47.0", "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.46.2", + "@azure-tools/typespec-client-generator-core": "0.47.0", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", - "@typespec/compiler": "0.60.1", - "@typespec/http": "0.60.0", - "@typespec/openapi": "0.60.0", - "@typespec/openapi3": "0.60.0", - "@typespec/rest": "0.60.0", - "@typespec/versioning": "0.60.1", + "@typespec/compiler": "0.61.0", + "@typespec/http": "0.61.0", + "@typespec/openapi": "0.61.0", + "@typespec/openapi3": "0.61.0", + "@typespec/rest": "0.61.0", + "@typespec/versioning": "0.61.0", "azure-rest-api-specs-eng-tools": "file:eng/tools", "oav": "^3.3.7", "prettier": "~3.3.3", diff --git a/specification/apicenter/ApiCenter.Management/models.tsp b/specification/apicenter/ApiCenter.Management/models.tsp index 2f37764ae65d..a13fbb1561d6 100644 --- a/specification/apicenter/ApiCenter.Management/models.tsp +++ b/specification/apicenter/ApiCenter.Management/models.tsp @@ -487,6 +487,7 @@ model DeploymentProperties { customProperties?: CustomProperties; } +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @summary("Custom Properties") @doc("The custom metadata defined for API catalog entities.") model CustomProperties {} diff --git a/specification/awsconnector/EmrCluster.Management/main.tsp b/specification/awsconnector/EmrCluster.Management/main.tsp index 24398430977e..15e3087f6e67 100644 --- a/specification/awsconnector/EmrCluster.Management/main.tsp +++ b/specification/awsconnector/EmrCluster.Management/main.tsp @@ -562,6 +562,7 @@ model ClusterTimeline { readyDateTime?: utcDateTime; } +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing" #suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." #suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp index f3e3dce90944..b43dc159be7b 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp @@ -63,6 +63,7 @@ model PoolProperties { } #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("Defines the organization in which the pool will be used.") @discriminator("kind") model OrganizationProfile {} @@ -134,6 +135,7 @@ union AzureDevOpsPermissionType { } #suppress "@azure-tools/typespec-azure-core/no-string-discriminator" "Existing" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("Defines the type of fabric the agent will run on.") @discriminator("kind") model FabricProfile {} @@ -315,6 +317,7 @@ model Stateful extends AgentProfile { @doc("How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week.") gracePeriodTimeSpan?: string; } +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("Defines pool buffer.") model ResourcePredictions {} @@ -650,6 +653,7 @@ model Location is ProxyResource<LocationProperties> { } #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("Properties of a location.") model LocationProperties {} @@ -717,6 +721,7 @@ model Image is ProxyResource<ImageProperties> { } #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state" "No ProvisioningState" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("Properties of an image.") model ImageProperties {} diff --git a/specification/hybridconnectivity/PublicCloud.Management/main.tsp b/specification/hybridconnectivity/PublicCloud.Management/main.tsp index d480834bcd6a..5d9ac6bb3b00 100644 --- a/specification/hybridconnectivity/PublicCloud.Management/main.tsp +++ b/specification/hybridconnectivity/PublicCloud.Management/main.tsp @@ -301,6 +301,7 @@ union CloudNativeType { //------------------- Shared ------------------- +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "will move to a more structured model when stable/GA" @doc("Solution settings") model SolutionSettings is Record<string>; @@ -308,6 +309,7 @@ model SolutionSettings is Record<string>; //---------------------------------------------- Operations ---------------------------------------------- #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-interface-requires-decorator" "Need to remove autoroute" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @route("/subscriptions/{subscriptionId}/providers/Microsoft.HybridConnectivity/") interface GenerateAwsTemplate { #suppress "@azure-tools/typespec-azure-resource-manager/arm-resource-operation" "Need to remove autoroute" diff --git a/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp index 4e464d9b59f4..2d3e41626472 100644 --- a/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp +++ b/specification/mongocluster/DocumentDB.MongoCluster.Management/client.tsp @@ -58,7 +58,10 @@ using Microsoft.DocumentDB; "MongoClusterNameUnavailableReason", "csharp" ); -@@clientName(PublicNetworkAccess, "MongoClusterPublicNetworkAccess", "csharp"); +@@clientName(Microsoft.DocumentDB.PublicNetworkAccess, + "MongoClusterPublicNetworkAccess", + "csharp" +); @@clientName(FirewallRule, "MongoClusterFirewallRule", "csharp"); @@clientName(FirewallRuleProperties, "MongoClusterFirewallRuleProperties", diff --git a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp index 5eee7314f3be..25f381a87dd7 100644 --- a/specification/networkanalytics/NetworkAnalytics.Management/main.tsp +++ b/specification/networkanalytics/NetworkAnalytics.Management/main.tsp @@ -554,6 +554,7 @@ interface DataTypes { @doc("Delete data type resource.") delete is ArmResourceDeleteWithoutOkAsync<DataType>; + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" #suppress "@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes" "Existing API" @doc("Delete data for data type.") deleteData is ArmResourceActionNoContentAsync<DataType, {}>; @@ -619,6 +620,7 @@ interface DataProducts { RoleAssignmentDetail >; + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("List user roles associated with the data product.") listRolesAssignments is ArmResourceActionSync< DataProduct, diff --git a/specification/portal/Dashboard.Management/models.tsp b/specification/portal/Dashboard.Management/models.tsp index 25ba06548055..c565464f215c 100644 --- a/specification/portal/Dashboard.Management/models.tsp +++ b/specification/portal/Dashboard.Management/models.tsp @@ -103,6 +103,7 @@ model DashboardProperties { /** * The dashboard metadata. */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" metadata?: {}; } @@ -124,6 +125,7 @@ model DashboardLens { /** * The dashboard len's metadata. */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" metadata?: {}; } @@ -169,6 +171,7 @@ model DashboardPartsPosition { /** * The dashboard part's metadata. */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" metadata?: {}; } @@ -233,6 +236,7 @@ model MarkdownPartMetadata extends DashboardPartMetadata { /** * Input to dashboard part. */ + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @OpenAPI.extension("x-ms-identifiers", []) inputs?: {}[]; diff --git a/specification/portalservices/Extension.Management/models.tsp b/specification/portalservices/Extension.Management/models.tsp index 9e739c64b4ec..2bef8b5e1550 100644 --- a/specification/portalservices/Extension.Management/models.tsp +++ b/specification/portalservices/Extension.Management/models.tsp @@ -384,6 +384,7 @@ model PortalExtensionCompileFile { * The result of contents of the file to compile. */ #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "existing API" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" model PortalExtensionCompileFileResult is Record<unknown>; /** @@ -665,6 +666,7 @@ model PortalTenantCompileFileProperties { * The contents of the file to compile. */ #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "existing API" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" model PortalTenantCompileFileResult is Record<unknown>; /** diff --git a/specification/sphere/Sphere.Management/models.tsp b/specification/sphere/Sphere.Management/models.tsp index f17cd216ad26..e94264b1334e 100644 --- a/specification/sphere/Sphere.Management/models.tsp +++ b/specification/sphere/Sphere.Management/models.tsp @@ -421,12 +421,14 @@ model ProofOfPossessionNonceRequest { * Result of the action to generate a proof of possession nonce */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatible" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" model ProofOfPossessionNonceResponse extends CertificateProperties {} /** * Response to the action call for count devices in a catalog. */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatible" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" model CountDevicesResponse extends CountElementsResponse {} /** @@ -818,6 +820,7 @@ model SignedCapabilityImageResponse { * Response to the action call for count devices in a catalog (preview API). */ #suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "For backward compatible" +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" model CountDeviceResponse extends CountElementsResponse {} /** diff --git a/specification/vmware/Microsoft.AVS.Management/scriptExecutions.tsp b/specification/vmware/Microsoft.AVS.Management/scriptExecutions.tsp index 40184f3a24c1..51a7ba093f3c 100644 --- a/specification/vmware/Microsoft.AVS.Management/scriptExecutions.tsp +++ b/specification/vmware/Microsoft.AVS.Management/scriptExecutions.tsp @@ -145,6 +145,7 @@ model ScriptExecutionProperties { #suppress "@azure-tools/typespec-azure-core/bad-record-type" "It is unknown." #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "It is unknown." + #suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing use case" @doc("User-defined dictionary.") namedOutputs?: Record<{}>; From daa3ef92fffbf84c85a037673d018f96248b672d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 10 Oct 2024 14:06:25 -0700 Subject: [PATCH 088/101] Bump the typespec group across 1 directory with 3 updates (#30963) Bumps the typespec group with 2 updates in the / directory: [@azure-tools/typespec-client-generator-cli](https://github.com/Azure/azure-sdk-tools) and [@azure-tools/typespec-client-generator-core](https://github.com/Azure/typespec-azure). Updates `@azure-tools/typespec-client-generator-cli` from 0.13.0 to 0.13.1 - [Release notes](https://github.com/Azure/azure-sdk-tools/releases) - [Commits](https://github.com/Azure/azure-sdk-tools/commits) Updates `@azure-tools/typespec-client-generator-core` from 0.47.0 to 0.47.1 - [Release notes](https://github.com/Azure/typespec-azure/releases) - [Commits](https://github.com/Azure/typespec-azure/compare/typespec-azure@0.47.0...@azure-tools/typespec-client-generator-core@0.47.1) Updates `@typespec/prettier-plugin-typespec` from 0.59.0 to 0.60.0 --- updated-dependencies: - dependency-name: "@azure-tools/typespec-client-generator-cli" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec - dependency-name: "@azure-tools/typespec-client-generator-core" dependency-type: direct:development update-type: version-update:semver-patch dependency-group: typespec - dependency-name: "@typespec/prettier-plugin-typespec" dependency-type: indirect update-type: version-update:semver-minor dependency-group: typespec ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 223 +++++++++++++++++++++------------------------- package.json | 4 +- 2 files changed, 106 insertions(+), 121 deletions(-) diff --git a/package-lock.json b/package-lock.json index 57bb71bbc8fa..08edaadbbc17 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,8 +12,8 @@ "@azure-tools/typespec-azure-portal-core": "0.47.0", "@azure-tools/typespec-azure-resource-manager": "0.47.0", "@azure-tools/typespec-azure-rulesets": "0.47.0", - "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.47.0", + "@azure-tools/typespec-client-generator-cli": "0.13.1", + "@azure-tools/typespec-client-generator-core": "0.47.1", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", "@typespec/compiler": "0.61.0", @@ -436,7 +436,6 @@ "resolved": "https://registry.npmjs.org/@autorest/codemodel/-/codemodel-4.20.0.tgz", "integrity": "sha512-Z2GwVwAGNTcfGUmrWT5LJqZv/WDXKBBpxhZrHu6zco/HrEGrqKQcKx5whlLX/GmAB/KmhcOWYr6aIyWomcoisQ==", "dev": true, - "license": "MIT", "dependencies": { "@azure-tools/codegen": "~2.10.0", "js-yaml": "~4.1.0" @@ -445,12 +444,24 @@ "node": ">=12.0.0" } }, + "node_modules/@autorest/core": { + "version": "3.10.2", + "resolved": "https://registry.npmjs.org/@autorest/core/-/core-3.10.2.tgz", + "integrity": "sha512-HQlqkY7SkqyEIidYhEUt3O0mDv0qwxewPTlV6cxlknnLmnj6pTPYqMAmIjXiKo5NzwP2HY8jYZyOJyGGxBQNzw==", + "dev": true, + "bin": { + "autorest-core": "entrypoints/app.js", + "autorest-language-service": "entrypoints/language-service.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/@autorest/extension-base": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/@autorest/extension-base/-/extension-base-3.6.0.tgz", "integrity": "sha512-hE6nmdYu2SA6xlG46lM+/njtz0yNEkhzfkOs7PjrYulnXuBWHo08RdbXHGcecypgNhV2QAQcbV6ar5f1UGX6xQ==", "dev": true, - "license": "MIT", "dependencies": { "@azure-tools/codegen": "~2.10.0", "js-yaml": "~4.1.0", @@ -461,25 +472,24 @@ } }, "node_modules/@autorest/openapi-to-typespec": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.0.tgz", - "integrity": "sha512-2+dpiF+gj0lEsjbJP1WX9BIdYT0b3+NoamhXY4PbNS0p9eNHT2lFCVzaHYNbY0fwRMR1yRDUd7dvwcsZi8qUgQ==", + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@autorest/openapi-to-typespec/-/openapi-to-typespec-0.10.1.tgz", + "integrity": "sha512-nA5uEoxhYwSHuKeiFq5uALUcP08vajXnbBJ5QlEsTZ2fRuUR7EpQuU+KbWcokiYzmnezqX4H7O/+9m10MYg3hA==", "dev": true, - "license": "MIT", "dependencies": { "@autorest/codemodel": "~4.20.0", "@autorest/extension-base": "~3.6.0", "@azure-tools/codegen": "~2.10.0", - "@azure-tools/typespec-autorest": "^0.45.0", - "@azure-tools/typespec-azure-core": "^0.45.0", - "@azure-tools/typespec-azure-resource-manager": "^0.45.0", - "@typespec/compiler": "^0.59.0", - "@typespec/http": "^0.59.0", - "@typespec/openapi": "^0.59.0", - "@typespec/openapi3": "^0.59.0", - "@typespec/prettier-plugin-typespec": "^0.59.0", - "@typespec/rest": "^0.59.0", - "@typespec/versioning": "^0.59.0", + "@azure-tools/typespec-autorest": "^0.46.0", + "@azure-tools/typespec-azure-core": "^0.46.0", + "@azure-tools/typespec-azure-resource-manager": "^0.46.0", + "@typespec/compiler": "^0.60.0", + "@typespec/http": "^0.60.0", + "@typespec/openapi": "^0.60.0", + "@typespec/openapi3": "^0.60.0", + "@typespec/prettier-plugin-typespec": "^0.60.0", + "@typespec/rest": "^0.60.0", + "@typespec/versioning": "^0.60.1", "change-case-all": "~2.1.0", "lodash": "~4.17.20", "pluralize": "^8.0.0", @@ -487,46 +497,43 @@ } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-autorest": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.45.0.tgz", - "integrity": "sha512-6ycZ0bEfXC0U26FHHEt9smAhxh78SACIDY+u7zLAopRzmxjTuthDdGgYSShuRDu3J+vEBi1fOKpz4cYQkgRkBQ==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.46.0.tgz", + "integrity": "sha512-LCIvxQgjczWUq/wi6fzKBqYHWJYD0hRLA8wBPzFasriHdBDHjpZ6vgTPmApzt0H5ArZX92Ar53Q5+ZXD9ktMUg==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.45.0", - "@azure-tools/typespec-azure-resource-manager": "~0.45.0", - "@azure-tools/typespec-client-generator-core": "~0.45.0", - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.0", - "@typespec/openapi": "~0.59.0", - "@typespec/rest": "~0.59.0", - "@typespec/versioning": "~0.59.0" + "@azure-tools/typespec-azure-core": "~0.46.0", + "@azure-tools/typespec-azure-resource-manager": "~0.46.0", + "@azure-tools/typespec-client-generator-core": "~0.46.0", + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0", + "@typespec/openapi": "~0.60.0", + "@typespec/rest": "~0.60.0", + "@typespec/versioning": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-core": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.45.0.tgz", - "integrity": "sha512-GycGMCmaIVSN+TftPtlPJLyeOrglbLmH08ZiZaVMjSih/TQEJM21RGR6d8QdjlkQWN61ntNDRD+RP2uv9tHmqw==", + "version": "0.46.0", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.46.0.tgz", + "integrity": "sha512-BNE31enSHWtWlrdIKShBS6CNFGk3OYmHSBnWqobcFJkTGXC090EoV2u6otn4BMI99fZRSR4gpwp/kYU9KLE9Jw==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.0", - "@typespec/rest": "~0.59.0" + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0", + "@typespec/rest": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-azure-resource-manager": { - "version": "0.45.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.45.0.tgz", - "integrity": "sha512-PdhB03P8PoOlUoUWd+CF5WipGzu2Q3ZjT0EAzgQe878DmXvxMq+zYaPJQtvkq9R6jCxFauDSr5gG7Yd4NINAuA==", + "version": "0.46.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.46.1.tgz", + "integrity": "sha512-8md8AwnxoYVkDBavQL5dbToUTS10PTSkcF+emd9BKEdnF9MKuA542vZudzaQOz2BzFbArMVUE/PLm2mhuwRkLw==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -535,20 +542,19 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.45.0", - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.0", - "@typespec/openapi": "~0.59.0", - "@typespec/rest": "~0.59.0", - "@typespec/versioning": "~0.59.0" + "@azure-tools/typespec-azure-core": "~0.46.0", + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0", + "@typespec/openapi": "~0.60.0", + "@typespec/rest": "~0.60.0", + "@typespec/versioning": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.45.4", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.45.4.tgz", - "integrity": "sha512-QJygwMqhEtBi2tPYs/HAfs0QTowXAwp6QpP/Vd2pHnJAncTV1BN17n/9LLAlMu2CnLimqvTuIN+FfliM28AX9w==", + "version": "0.46.2", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.46.2.tgz", + "integrity": "sha512-/HKeehCNDeylouOHMe7IwpcDcGJHRAuEy3a5FBnSY51m4EpMq4VMQzW9tka/8brFO2m5LLj7tyhOL/xnzi2fLg==", "dev": true, - "license": "MIT", "peer": true, "dependencies": { "change-case": "~5.4.4", @@ -558,20 +564,19 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@azure-tools/typespec-azure-core": "~0.45.0", - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.0", - "@typespec/openapi": "~0.59.0", - "@typespec/rest": "~0.59.0", - "@typespec/versioning": "~0.59.0" + "@azure-tools/typespec-azure-core": "~0.46.0", + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0", + "@typespec/openapi": "~0.60.0", + "@typespec/rest": "~0.60.0", + "@typespec/versioning": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/compiler": { - "version": "0.59.1", - "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.59.1.tgz", - "integrity": "sha512-O2ljgr6YoFaIH6a8lWc90/czdv4B2X6N9wz4WsnQnVvgO0Tj0s+3xkvp4Tv59RKMhT0f3fK6dL8oEGO32FYk1A==", + "version": "0.60.1", + "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.60.1.tgz", + "integrity": "sha512-I6Vcpvd7mBP7SI5vCBh9rZGXAtVy95BKhAd33Enw32psswiSzRpA7zdyZhOMekTOGVXNS/+E5l2PGGCzQddB4w==", "dev": true, - "license": "MIT", "dependencies": { "@babel/code-frame": "~7.24.7", "ajv": "~8.17.1", @@ -601,7 +606,6 @@ "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", "dev": true, - "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" }, @@ -613,38 +617,35 @@ } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/http": { - "version": "0.59.1", - "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.59.1.tgz", - "integrity": "sha512-Ai8oCAO+Bw1HMSZ9gOI5Od4fNn/ul4HrVtTB01xFuLK6FQj854pxhzao8ylPnr7gIRQ327FV12/QfXR87yCiYQ==", + "version": "0.60.0", + "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.60.0.tgz", + "integrity": "sha512-ktfS9vpHfltyeAaQLNAZdqrn6Per3vmB/HDH/iyudYLA5wWblT1siKvpFCMWq53CJorRO7yeOKv+Q/M26zwEtg==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0" + "@typespec/compiler": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi": { - "version": "0.59.0", - "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.59.0.tgz", - "integrity": "sha512-do1Dm5w0MuK3994gYTBg6qMfgeIxmmsDqnz3zimYKMPpbnUBi4F6/o4iCfn0Fn9kaNl+H6UlOzZpsZW9xHui1Q==", + "version": "0.60.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.60.0.tgz", + "integrity": "sha512-YVwLppgHY8r/MudHNSLSUXzdw+CIpjmb31gI2a0KDGnI6sWDwY7LSWfjGU4TY/ubt0+X0Tjoy330mTvw71YBTg==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.0" + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/openapi3": { - "version": "0.59.1", - "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.59.1.tgz", - "integrity": "sha512-89VbUbkWKxeFgE0w0hpVyk1UZ6ZHRxOhcAHvF5MgxQxEhs2ALXKAqapWjFQsYrLBhAUoWzdPFrJJUMbwF9kX0Q==", + "version": "0.60.0", + "resolved": "https://registry.npmjs.org/@typespec/openapi3/-/openapi3-0.60.0.tgz", + "integrity": "sha512-gvrTHZACdeQtV7GfhVOHqkyTgMFyM2nKAIiz2P83LIncMCDUc00bGKGmaBk+xpuwKtCJyxBeVpCbID31YAq96g==", "dev": true, - "license": "MIT", "dependencies": { "@readme/openapi-parser": "~2.6.0", "yaml": "~2.4.5" @@ -656,37 +657,35 @@ "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.1", - "@typespec/openapi": "~0.59.0", - "@typespec/versioning": "~0.59.0" + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0", + "@typespec/openapi": "~0.60.0", + "@typespec/versioning": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/rest": { - "version": "0.59.1", - "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.59.1.tgz", - "integrity": "sha512-uKU431jBYL2tVQWG5THA75+OtXDa1e8cMAafYK/JJRRiVRd8D/Epd8fp07dzlB8tFGrhCaGlekRMqFPFrHh2/A==", + "version": "0.60.0", + "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.60.0.tgz", + "integrity": "sha512-mHYubyuBvwdV2xkHrJfPwV7b/Ksyb9lA1Q/AQwpVFa7Qu1X075TBVALmH+hK3V0EdUG1CGJZ5Sw4BWgl8ZS0BA==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0", - "@typespec/http": "~0.59.1" + "@typespec/compiler": "~0.60.0", + "@typespec/http": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/@typespec/versioning": { - "version": "0.59.0", - "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.59.0.tgz", - "integrity": "sha512-aihO/ux0lLmsuYAdGVkiBflSudcZokYG42SELk1FtMFo609G3Pd7ep7hau6unBnMIceQZejB0ow5UGRupK4X5A==", + "version": "0.60.1", + "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.60.1.tgz", + "integrity": "sha512-HogYL7P9uOPoSvkLLDjF22S6E9td6EY3c6TcIHhCzDTAQoi54csikD0gNrtcCkFG0UeQk29HgQymV397j+vp4g==", "dev": true, - "license": "MIT", "engines": { "node": ">=18.0.0" }, "peerDependencies": { - "@typespec/compiler": "~0.59.0" + "@typespec/compiler": "~0.60.0" } }, "node_modules/@autorest/openapi-to-typespec/node_modules/prettier": { @@ -694,7 +693,6 @@ "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", "dev": true, - "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" }, @@ -710,7 +708,6 @@ "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.5.tgz", "integrity": "sha512-aBx2bnqDzVOyNKfsysjA2ms5ZlnjSAW2eG3/L5G/CSujfjLJTJsEw1bGw8kCf04KodQWk1pxlGnZ56CRxiawmg==", "dev": true, - "license": "ISC", "bin": { "yaml": "bin.mjs" }, @@ -730,7 +727,6 @@ "resolved": "https://registry.npmjs.org/@azure-tools/async-io/-/async-io-3.0.254.tgz", "integrity": "sha512-X1C7XdyCuo50ch9FzKtTvmK18FgDxxf1Bbt3cSoknQqeDaRegHSSCO+zByq2YA4NvUzKXeZ1engh29IDxZXgpQ==", "dev": true, - "license": "MIT", "dependencies": { "@azure-tools/tasks": "~3.0.255", "proper-lockfile": "~2.0.1" @@ -744,7 +740,6 @@ "resolved": "https://registry.npmjs.org/@azure-tools/codegen/-/codegen-2.10.0.tgz", "integrity": "sha512-gdy0at3BUZAAARgiX9Ye6SNCKhcjLs5FNUewa/KV/dMGcPv7mBvbslt5VO3W8wj0n96ifk970aIFaivjacBxeQ==", "dev": true, - "license": "MIT", "dependencies": { "@azure-tools/async-io": "~3.0.0", "js-yaml": "~4.1.0", @@ -859,7 +854,6 @@ "resolved": "https://registry.npmjs.org/@azure-tools/tasks/-/tasks-3.0.255.tgz", "integrity": "sha512-GjALNLz7kWMEdRVbaN5g0cJHNAr3XVTbP0611Mv2UzMgGL6FOhNZJK+oPHJKLDR8EEDZNnkwPlyi7B+INXUSQA==", "dev": true, - "license": "MIT", "engines": { "node": ">=10.12.0" } @@ -967,13 +961,13 @@ } }, "node_modules/@azure-tools/typespec-client-generator-cli": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.13.0.tgz", - "integrity": "sha512-50kgfm5UKNEn/DknGKOl2T6dupEYGtG+BPWeaC8dWWitSmj9DCAIb/CXtASbiI4KN2fT1kTpDnjlGdEUhXhhgw==", + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-cli/-/typespec-client-generator-cli-0.13.1.tgz", + "integrity": "sha512-PZtgoN3jaaSQ7NFgrztw54KvHq1QxiOn/RCaGRUWK5Ve0tn7bxXggJmndo+zRhhsR9dTa2fQXZugzR1cag/v0g==", "dev": true, - "license": "MIT", "dependencies": { - "@autorest/openapi-to-typespec": "0.10.0", + "@autorest/core": "^3.10.2", + "@autorest/openapi-to-typespec": "0.10.1", "@azure-tools/rest-api-diff": ">=0.1.0 <1.0.0", "@azure-tools/typespec-autorest": ">=0.44.0 <1.0.0", "@azure/core-rest-pipeline": "^1.12.0", @@ -997,11 +991,10 @@ } }, "node_modules/@azure-tools/typespec-client-generator-core": { - "version": "0.47.0", - "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.47.0.tgz", - "integrity": "sha512-Z7zBxfGjGgUSFdno5m4Oi5OzWF9pTjw2edUv6IjJDN824ViXKXa15MpzodBR6Ad9lblsRE9KrYGMJeCPx75oNA==", + "version": "0.47.1", + "resolved": "https://registry.npmjs.org/@azure-tools/typespec-client-generator-core/-/typespec-client-generator-core-0.47.1.tgz", + "integrity": "sha512-kgjGnnOaHewa8PjmZcEY4+UrEMBrXhOpMxDuhlMnFfOvCo3uZc3FVryoNrDHkZ8weCn6sjxo8zHcj1lpCg4/uw==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "~5.4.4", "pluralize": "^8.0.0" @@ -3540,11 +3533,10 @@ } }, "node_modules/@typespec/prettier-plugin-typespec": { - "version": "0.59.0", - "resolved": "https://registry.npmjs.org/@typespec/prettier-plugin-typespec/-/prettier-plugin-typespec-0.59.0.tgz", - "integrity": "sha512-6baXmjOKvvxGOH+rH/kAn7FaR+agdPN8iw+kT08XvWdLrsQXECDTl0lb2pH1RztWIfL3fC7SwoT/naEztNVDog==", + "version": "0.60.0", + "resolved": "https://registry.npmjs.org/@typespec/prettier-plugin-typespec/-/prettier-plugin-typespec-0.60.0.tgz", + "integrity": "sha512-hQ6eiTKzJULd8lLU255cT4NWwyAZzaWEd6zJVdTxi4jqmPkYKVEPdsXfaLEPT0Gm8x7dN5DTm1b45d8DlEDdIw==", "dev": true, - "license": "MIT", "dependencies": { "prettier": "~3.3.3" } @@ -4179,7 +4171,6 @@ "resolved": "https://registry.npmjs.org/change-case-all/-/change-case-all-2.1.0.tgz", "integrity": "sha512-v6b0WWWkZUMHVuYk82l+WROgkUm4qEN2w5hKRNWtEOYwWqUGoi8C6xH0l1RLF1EoWqDFK6MFclmN3od6ws3/uw==", "dev": true, - "license": "MIT", "dependencies": { "change-case": "^5.2.0", "sponge-case": "^2.0.2", @@ -8256,7 +8247,6 @@ "resolved": "https://registry.npmjs.org/proper-lockfile/-/proper-lockfile-2.0.1.tgz", "integrity": "sha512-rjaeGbsmhNDcDInmwi4MuI6mRwJu6zq8GjYCLuSuE7GF+4UjgzkL69sVKKJ2T2xH61kK7rXvGYpvaTu909oXaQ==", "dev": true, - "license": "MIT", "dependencies": { "graceful-fs": "^4.1.2", "retry": "^0.10.0" @@ -8270,7 +8260,6 @@ "resolved": "https://registry.npmjs.org/retry/-/retry-0.10.1.tgz", "integrity": "sha512-ZXUSQYTHdl3uS7IuCehYfMzKyIDBNoAuUblvy5oGO5UJSUTmStUUVPXbA9Qxd173Bgre53yCQczQuHgRWAdvJQ==", "dev": true, - "license": "MIT", "engines": { "node": "*" } @@ -8849,8 +8838,7 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/sponge-case/-/sponge-case-2.0.3.tgz", "integrity": "sha512-i4h9ZGRfxV6Xw3mpZSFOfbXjf0cQcYmssGWutgNIfFZ2VM+YIWfD71N/kjjwK6X/AAHzBr+rciEcn/L34S8TGw==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/sprintf-js": { "version": "1.0.3", @@ -9121,8 +9109,7 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/swap-case/-/swap-case-3.0.3.tgz", "integrity": "sha512-6p4op8wE9CQv7uDFzulI6YXUw4lD9n4oQierdbFThEKVWVQcbQcUjdP27W8XE7V4QnWmnq9jueSHceyyQnqQVA==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/teleport-javascript": { "version": "1.0.0", @@ -9273,7 +9260,6 @@ "resolved": "https://registry.npmjs.org/title-case/-/title-case-3.0.3.tgz", "integrity": "sha512-e1zGYRvbffpcHIrnuqT0Dh+gEJtDaxDSoG4JAIpq4oDFyooziLBIiYQv0GBT4FUAnUop5uZ1hiIAj7oAF6sOCA==", "dev": true, - "license": "MIT", "dependencies": { "tslib": "^2.0.3" } @@ -9720,7 +9706,6 @@ "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-3.6.2.tgz", "integrity": "sha512-T24Jb5V48e4VgYliUXMnZ379ItbrXgOimweKaJshD84z+8q7ZOZjJan0MeDe+Ugb+uqERDVV8SBmemaGMSMugA==", "dev": true, - "license": "MIT", "engines": { "node": ">=4.0.0 || >=6.0.0" } diff --git a/package.json b/package.json index 7b16327e068e..357a021d8647 100644 --- a/package.json +++ b/package.json @@ -7,8 +7,8 @@ "@azure-tools/typespec-azure-portal-core": "0.47.0", "@azure-tools/typespec-azure-resource-manager": "0.47.0", "@azure-tools/typespec-azure-rulesets": "0.47.0", - "@azure-tools/typespec-client-generator-cli": "0.13.0", - "@azure-tools/typespec-client-generator-core": "0.47.0", + "@azure-tools/typespec-client-generator-cli": "0.13.1", + "@azure-tools/typespec-client-generator-core": "0.47.1", "@azure-tools/typespec-liftr-base": "0.4.0", "@azure/avocado": "^0.8.4", "@typespec/compiler": "0.61.0", From 6f847746e7d8148bb248e509e76fac18945a1e77 Mon Sep 17 00:00:00 2001 From: Driele Neves Ribeiro <drielene@microsoft.com> Date: Thu, 10 Oct 2024 14:12:26 -0700 Subject: [PATCH 089/101] Fix environment patch (#30894) * Fix body property for environment patch * regenerate swagger * EnvironmentPatchProperties as models * regen * Remove ; as model doens't need it --- .../DevCenter/Environments/models.tsp | 6 ++-- .../DevCenter/Environments/routes.tsp | 2 +- .../preview/2024-05-01-preview/devcenter.json | 29 ++++++++----------- .../preview/2024-08-01-preview/devcenter.json | 29 ++++++++----------- .../preview/2024-09-01-preview/devcenter.json | 29 ++++++++----------- .../preview/2024-10-01-preview/devcenter.json | 29 ++++++++----------- .../stable/2024-02-01/devcenter.json | 29 ++++++++----------- 7 files changed, 65 insertions(+), 88 deletions(-) diff --git a/specification/devcenter/DevCenter/Environments/models.tsp b/specification/devcenter/DevCenter/Environments/models.tsp index 2be2b880a45d..19c522594bdf 100644 --- a/specification/devcenter/DevCenter/Environments/models.tsp +++ b/specification/devcenter/DevCenter/Environments/models.tsp @@ -223,14 +223,16 @@ alias EnvironmentUpdateProperties = { parameters?: Record<unknown>; }; -alias EnvironmentPatchProperties = { +@doc("Properties of an environment. These properties can be updated via PATCH after the resource has been created.") +@added(APIVersions.v2024_02_01) +model EnvironmentPatchProperties { @doc(""" The time the expiration date will be triggered (UTC), after which the environment and associated resources will be deleted. """) @added(APIVersions.v2024_02_01) expirationDate?: utcDateTime; -}; +} @doc("Outputs from environment deployment.") @added(APIVersions.v2024_02_01) diff --git a/specification/devcenter/DevCenter/Environments/routes.tsp b/specification/devcenter/DevCenter/Environments/routes.tsp index 58b04ed42b6c..2346ae9e48e5 100644 --- a/specification/devcenter/DevCenter/Environments/routes.tsp +++ b/specification/devcenter/DevCenter/Environments/routes.tsp @@ -88,7 +88,7 @@ interface Environments { @doc("Represents an environment.") @body - body: Environment; + body: EnvironmentPatchProperties; }, Environment >; diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-05-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-05-01-preview/devcenter.json index 2d63fe396245..e2d7177f291b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-05-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-05-01-preview/devcenter.json @@ -2759,7 +2759,7 @@ "description": "Represents an environment.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentUpdate" + "$ref": "#/definitions/EnvironmentPatchProperties" } } ], @@ -5029,6 +5029,17 @@ } } }, + "EnvironmentPatchProperties": { + "type": "object", + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + } + } + }, "EnvironmentProvisioningState": { "type": "string", "description": "The provisioning state of the environment.", @@ -5300,22 +5311,6 @@ ] } }, - "EnvironmentUpdate": { - "type": "object", - "description": "Properties of an environment.", - "properties": { - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." - }, - "parameters": { - "type": "object", - "description": "Parameters object for the environment.", - "additionalProperties": {} - } - } - }, "HardwareProfile": { "type": "object", "description": "Hardware specifications for the Dev Box.", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-08-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-08-01-preview/devcenter.json index dd925191aec6..f088616c7454 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-08-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-08-01-preview/devcenter.json @@ -2810,7 +2810,7 @@ "description": "Represents an environment.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentUpdate" + "$ref": "#/definitions/EnvironmentPatchProperties" } } ], @@ -5080,6 +5080,17 @@ } } }, + "EnvironmentPatchProperties": { + "type": "object", + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + } + } + }, "EnvironmentProvisioningState": { "type": "string", "description": "The provisioning state of the environment.", @@ -5351,22 +5362,6 @@ ] } }, - "EnvironmentUpdate": { - "type": "object", - "description": "Properties of an environment.", - "properties": { - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." - }, - "parameters": { - "type": "object", - "description": "Parameters object for the environment.", - "additionalProperties": {} - } - } - }, "HardwareProfile": { "type": "object", "description": "Hardware specifications for the Dev Box.", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json index 3644ca59a864..795ed1ac9ff4 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json @@ -3029,7 +3029,7 @@ "description": "Represents an environment.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentUpdate" + "$ref": "#/definitions/EnvironmentPatchProperties" } } ], @@ -5351,6 +5351,17 @@ } } }, + "EnvironmentPatchProperties": { + "type": "object", + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + } + } + }, "EnvironmentProvisioningState": { "type": "string", "description": "The provisioning state of the environment.", @@ -5622,22 +5633,6 @@ ] } }, - "EnvironmentUpdate": { - "type": "object", - "description": "Properties of an environment.", - "properties": { - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." - }, - "parameters": { - "type": "object", - "description": "Parameters object for the environment.", - "additionalProperties": {} - } - } - }, "HardwareProfile": { "type": "object", "description": "Hardware specifications for the Dev Box.", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json index 78fedb94d760..bc35fc08b72b 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -3103,7 +3103,7 @@ "description": "Represents an environment.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentUpdate" + "$ref": "#/definitions/EnvironmentPatchProperties" } } ], @@ -5459,6 +5459,17 @@ } } }, + "EnvironmentPatchProperties": { + "type": "object", + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + } + } + }, "EnvironmentProvisioningState": { "type": "string", "description": "The provisioning state of the environment.", @@ -5730,22 +5741,6 @@ ] } }, - "EnvironmentUpdate": { - "type": "object", - "description": "Properties of an environment.", - "properties": { - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." - }, - "parameters": { - "type": "object", - "description": "Parameters object for the environment.", - "additionalProperties": {} - } - } - }, "HardwareProfile": { "type": "object", "description": "Hardware specifications for the Dev Box.", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json index 8489a9bfabc3..601f57593de0 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2024-02-01/devcenter.json @@ -2142,7 +2142,7 @@ "description": "Represents an environment.", "required": true, "schema": { - "$ref": "#/definitions/EnvironmentUpdate" + "$ref": "#/definitions/EnvironmentPatchProperties" } } ], @@ -3930,6 +3930,17 @@ } } }, + "EnvironmentPatchProperties": { + "type": "object", + "description": "Properties of an environment. These properties can be updated via PATCH after the resource has been created.", + "properties": { + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." + } + } + }, "EnvironmentProvisioningState": { "type": "string", "description": "The provisioning state of the environment.", @@ -4081,22 +4092,6 @@ ] } }, - "EnvironmentUpdate": { - "type": "object", - "description": "Properties of an environment.", - "properties": { - "expirationDate": { - "type": "string", - "format": "date-time", - "description": "The time the expiration date will be triggered (UTC), after which the\nenvironment and associated resources will be deleted." - }, - "parameters": { - "type": "object", - "description": "Parameters object for the environment.", - "additionalProperties": {} - } - } - }, "HardwareProfile": { "type": "object", "description": "Hardware specifications for the Dev Box.", From fda3d5e4ae4c69aa72ddfdf5ca1b6d5795a03e71 Mon Sep 17 00:00:00 2001 From: Timothee Guerin <timothee.guerin@outlook.com> Date: Thu, 10 Oct 2024 14:14:53 -0700 Subject: [PATCH 090/101] Fix awsconnector missing suppression (#30964) --- specification/awsconnector/EmrClusterSummary.Management/main.tsp | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/awsconnector/EmrClusterSummary.Management/main.tsp b/specification/awsconnector/EmrClusterSummary.Management/main.tsp index b0082e187f11..6696039eaa82 100644 --- a/specification/awsconnector/EmrClusterSummary.Management/main.tsp +++ b/specification/awsconnector/EmrClusterSummary.Management/main.tsp @@ -231,6 +231,7 @@ model ClusterTimeline { readyDateTime?: utcDateTime; } +#suppress "@azure-tools/typespec-azure-resource-manager/no-empty-model" "Existing model" #suppress "@azure-tools/typespec-azure-core/casing-style" "Supress casing style as the property name is defined in aws." #suppress "@azure-tools/typespec-azure-core/no-unknown" "Supress no-unknown to handle the datatype object used in aws" #suppress "@azure-tools/typespec-azure-resource-manager/arm-no-record" "Supress arm-no-record to handle the datatype object used in aws" From 57cbfdb4deb7ce06476022bcc18d32cddd83c2a0 Mon Sep 17 00:00:00 2001 From: Venkat Ragavan <50309787+venkatr21@users.noreply.github.com> Date: Fri, 11 Oct 2024 11:25:45 +0530 Subject: [PATCH 091/101] Azure load testing API version 2024-07-01-preview (#30881) * add api version 2024-07-01-preview * update readme * added trigger examples * spacing fix * PR Comment for List Parameter * Updatiing property docs --------- Co-authored-by: Venkat Ragavan S <vens@microsoft.com> Co-authored-by: Mitesh Shah <58204159+mitsha-microsoft@users.noreply.github.com> --- .../CreateOrUpdateTest.json | 222 + .../CreateOrUpdateTestAppComponents.json | 60 + .../CreateOrUpdateTestProfile.json | 81 + .../CreateOrUpdateTestProfileRun.json | 99 + .../CreateOrUpdateTestRun.json | 311 + .../CreateOrUpdateTestRunAppComponents.json | 60 + ...ateOrUpdateTestRunServerMetricsConfig.json | 65 + ...CreateOrUpdateTestServerMetricsConfig.json | 65 + .../CreateOrUpdateTrigger.json | 75 + .../2024-07-01-preview/DeleteTest.json | 11 + .../2024-07-01-preview/DeleteTestFile.json | 12 + .../2024-07-01-preview/DeleteTestProfile.json | 11 + .../DeleteTestProfileRun.json | 11 + .../2024-07-01-preview/DeleteTestRun.json | 11 + .../2024-07-01-preview/DeleteTrigger.json | 11 + .../examples/2024-07-01-preview/GetTest.json | 99 + .../2024-07-01-preview/GetTestFile.json | 20 + .../2024-07-01-preview/GetTestProfile.json | 36 + .../GetTestProfileRun_Executed.json | 66 + .../GetTestProfileRun_Executing.json | 38 + .../2024-07-01-preview/GetTestRun.json | 150 + .../2024-07-01-preview/GetTestRunFile.json | 20 + .../2024-07-01-preview/GetTrigger.json | 34 + .../ListMetricDimensionValues.json | 23 + .../ListTestAppComponents.json | 30 + .../2024-07-01-preview/ListTestFiles.json | 25 + .../ListTestProfileRuns.json | 63 + .../2024-07-01-preview/ListTestProfiles.json | 45 + .../ListTestRunAppComponents.json | 30 + .../ListTestRunMetrics.json | 465 ++ .../ListTestRunMetricsDefinitions.json | 156 + .../ListTestRunMetricsNamespaces.json | 20 + .../ListTestRunServerMetricsConfig.json | 31 + .../2024-07-01-preview/ListTestRuns.json | 153 + .../ListTestServerMetricsConfig.json | 31 + .../2024-07-01-preview/ListTests.json | 109 + .../2024-07-01-preview/ListTriggers.json | 62 + .../StopTestProfileRun.json | 52 + .../2024-07-01-preview/StopTestRun.json | 106 + .../2024-07-01-preview/UploadTestFile.json | 22 + .../loadtestservice/LoadTestService/main.tsp | 4 + .../LoadTestService/models.trigger.tsp | 283 + .../LoadTestService/models.tsp | 72 + .../LoadTestService/routes.tsp | 16 + .../examples/CreateOrUpdateTest.json | 222 + .../CreateOrUpdateTestAppComponents.json | 60 + .../examples/CreateOrUpdateTestProfile.json | 81 + .../CreateOrUpdateTestProfileRun.json | 99 + .../examples/CreateOrUpdateTestRun.json | 311 + .../CreateOrUpdateTestRunAppComponents.json | 60 + ...ateOrUpdateTestRunServerMetricsConfig.json | 65 + ...CreateOrUpdateTestServerMetricsConfig.json | 65 + .../examples/CreateOrUpdateTrigger.json | 75 + .../examples/DeleteTest.json | 11 + .../examples/DeleteTestFile.json | 12 + .../examples/DeleteTestProfile.json | 11 + .../examples/DeleteTestProfileRun.json | 11 + .../examples/DeleteTestRun.json | 11 + .../examples/DeleteTrigger.json | 11 + .../2024-07-01-preview/examples/GetTest.json | 99 + .../examples/GetTestFile.json | 20 + .../examples/GetTestProfile.json | 36 + .../examples/GetTestProfileRun_Executed.json | 66 + .../examples/GetTestProfileRun_Executing.json | 38 + .../examples/GetTestRun.json | 150 + .../examples/GetTestRunFile.json | 20 + .../examples/GetTrigger.json | 34 + .../examples/ListMetricDimensionValues.json | 23 + .../examples/ListTestAppComponents.json | 30 + .../examples/ListTestFiles.json | 25 + .../examples/ListTestProfileRuns.json | 63 + .../examples/ListTestProfiles.json | 45 + .../examples/ListTestRunAppComponents.json | 30 + .../examples/ListTestRunMetrics.json | 465 ++ .../ListTestRunMetricsDefinitions.json | 156 + .../ListTestRunMetricsNamespaces.json | 20 + .../ListTestRunServerMetricsConfig.json | 31 + .../examples/ListTestRuns.json | 153 + .../examples/ListTestServerMetricsConfig.json | 31 + .../examples/ListTests.json | 109 + .../examples/ListTriggers.json | 62 + .../examples/StopTestProfileRun.json | 52 + .../examples/StopTestRun.json | 106 + .../examples/UploadTestFile.json | 22 + .../2024-07-01-preview/loadtestservice.json | 6573 +++++++++++++++++ .../loadtestservice/data-plane/readme.md | 9 + 86 files changed, 12939 insertions(+) create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTrigger.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTrigger.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTest.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executed.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executing.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRunFile.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTrigger.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListMetricDimensionValues.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestFiles.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfileRuns.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfiles.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunAppComponents.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetrics.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsDefinitions.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsNamespaces.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRuns.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTests.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTriggers.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestProfileRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestRun.json create mode 100644 specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/UploadTestFile.json create mode 100644 specification/loadtestservice/LoadTestService/models.trigger.tsp create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTrigger.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTrigger.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTest.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executed.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executing.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRunFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTrigger.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListMetricDimensionValues.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestFiles.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfileRuns.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfiles.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunAppComponents.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetrics.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsDefinitions.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsNamespaces.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRuns.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestServerMetricsConfig.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTests.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTriggers.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestProfileRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestRun.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/UploadTestFile.json create mode 100644 specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTest.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTest.json new file mode 100644 index 000000000000..653c35e1e815 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTest.json @@ -0,0 +1,222 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "title": "Create or update a load test", + "parameters": { + "api-version": "2024-07-01-preview", + "testId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestAppComponents.json new file mode 100644 index 000000000000..ddd3d793bf94 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfile.json new file mode 100644 index 000000000000..505c340ccce2 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfile.json @@ -0,0 +1,81 @@ +{ + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "title": "Create or update a test profile", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfileRun.json new file mode 100644 index 000000000000..052e4adaa901 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestProfileRun.json @@ -0,0 +1,99 @@ +{ + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "title": "Create/update and start a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview", + "body": { + "displayName": "Performance_TestProfile_Run1", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description" + } + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRun.json new file mode 100644 index 000000000000..02d3d6e86ac1 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRun.json @@ -0,0 +1,311 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "title": "Create/update and start a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "oldTestRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview", + "body": { + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://dummyurl.com/configresource", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://dummyurl.com/userpropresource", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://dummyurl.com/logresource", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunAppComponents.json new file mode 100644 index 000000000000..694d5d7947c9 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test run", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..cfcdc6d9fcd1 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestRunServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test run", + "parameters": { + "testRunId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-07-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestServerMetricsConfig.json new file mode 100644 index 000000000000..63a555850699 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTestServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test.", + "parameters": { + "testId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-07-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTrigger.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTrigger.json new file mode 100644 index 000000000000..82de0570f173 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/CreateOrUpdateTrigger.json @@ -0,0 +1,75 @@ +{ + "operationId": "TriggerAdministration_CreateOrUpdateTrigger", + "title": "Create or update a trigger.", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Sample_Trigger", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTest.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTest.json new file mode 100644 index 000000000000..e1406dc179a6 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTest.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestAdministration_DeleteTest", + "title": "Delete a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestFile.json new file mode 100644 index 000000000000..0d9977e88a00 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestFile.json @@ -0,0 +1,12 @@ +{ + "operationId": "LoadTestAdministration_DeleteTestFile", + "title": "Delete a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "app.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfile.json new file mode 100644 index 000000000000..cebe50559f2a --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfile.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileAdministration_DeleteTestProfile", + "title": "Delete a test profile", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfileRun.json new file mode 100644 index 000000000000..56447a3e4b2d --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestProfileRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "title": "Deletes a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestRun.json new file mode 100644 index 000000000000..8539e9590d4b --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTestRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestRun_DeleteTestRun", + "title": "Delete a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTrigger.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTrigger.json new file mode 100644 index 000000000000..7bbfcdacfc9f --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/DeleteTrigger.json @@ -0,0 +1,11 @@ +{ + "operationId": "TriggerAdministration_DeleteTrigger", + "title": "Delete a trigger", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTest.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTest.json new file mode 100644 index 000000000000..f6cf14edc539 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTest.json @@ -0,0 +1,99 @@ +{ + "operationId": "LoadTestAdministration_GetTest", + "title": "Get a load test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestFile.json new file mode 100644 index 000000000000..50166bcaba94 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestAdministration_GetTestFile", + "title": "Get a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfile.json new file mode 100644 index 000000000000..478a4d97fe30 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfile.json @@ -0,0 +1,36 @@ +{ + "operationId": "TestProfileAdministration_GetTestProfile", + "title": "Get a test profile.", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executed.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executed.json new file mode 100644 index 000000000000..ae3840cb4a66 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executed.json @@ -0,0 +1,66 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run after the run has executed.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "DONE", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "recommendations": [ + { + "category": "ThroughputOptimized", + "configurations": [ + "config2" + ] + }, + { + "category": "CostOptimized", + "configurations": [ + "config1" + ] + } + ], + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executing.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executing.json new file mode 100644 index 000000000000..64116f6b55f7 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestProfileRun_Executing.json @@ -0,0 +1,38 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run while the run is executing.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRun.json new file mode 100644 index 000000000000..987db3f3aa82 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRun.json @@ -0,0 +1,150 @@ +{ + "operationId": "LoadTestRun_GetTestRun", + "title": "Get a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + }, + "reportFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "virtualUserHours": 20.50, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRunFile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRunFile.json new file mode 100644 index 000000000000..debcfd8d99d7 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTestRunFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_GetTestRunFile", + "title": "Get a file associated to a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "fileName": "sample.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTrigger.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTrigger.json new file mode 100644 index 000000000000..d9feea3233ac --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/GetTrigger.json @@ -0,0 +1,34 @@ +{ + "operationId": "TriggerAdministration_GetTrigger", + "title": "Get a trigger.", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListMetricDimensionValues.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListMetricDimensionValues.json new file mode 100644 index 000000000000..65772f2bb026 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListMetricDimensionValues.json @@ -0,0 +1,23 @@ +{ + "operationId": "LoadTestRun_ListMetricDimensionValues", + "title": "List the dimension values for the given metric dimension name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "name": "SamplerName", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + "HighLoadTest" + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestAppComponents.json new file mode 100644 index 000000000000..121b7f4ab1e4 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestAdministration_GetAppComponents", + "title": "Get associated app component for the given test.", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestFiles.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestFiles.json new file mode 100644 index 000000000000..e761cd228f98 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestFiles.json @@ -0,0 +1,25 @@ +{ + "operationId": "LoadTestAdministration_ListTestFiles", + "title": "Get all test files.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview", + "continuationToken": "continuation token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfileRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfileRuns.json new file mode 100644 index 000000000000..e99c3e119248 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfileRuns.json @@ -0,0 +1,63 @@ +{ + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "title": "Get all test profile runs for the specified filters.", + "parameters": { + "maxPageSize": 30, + "minStartDateTime": "2024-05-01T16:00:46.072Z", + "maxStartDateTime": "2024-05-01T16:50:46.072Z", + "minEndDateTime": "2024-05-01T16:00:46.072Z", + "maxEndDateTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "statuses": "ACCEPTED", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profile-runs?orderby=startDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&executionFrom=&executionTo=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfiles.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfiles.json new file mode 100644 index 000000000000..c63f6866d25a --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestProfiles.json @@ -0,0 +1,45 @@ +{ + "operationId": "TestProfileAdministration_ListTestProfiles", + "title": "Get all test profiles for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "testIds": "12346-abcd-6789", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profiles?orderby=lastModifiedDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&lastModifiedStartTime=&lastModifiedEndTime=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunAppComponents.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunAppComponents.json new file mode 100644 index 000000000000..f2da50c7340c --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestRun_GetAppComponents", + "title": "Get associated app component for the given test run.", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetrics.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetrics.json new file mode 100644 index 000000000000..08b2aef39370 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetrics.json @@ -0,0 +1,465 @@ +{ + "operationId": "LoadTestRun_ListMetrics", + "title": "List the metric values for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-07-01-preview", + "body": { + "filters": [ + { + "name": "SamplerName", + "values": [ + "HTTP Request" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "data": [ + { + "timestamp": "2022-10-29T08:44:40.000Z", + "value": 10.0 + }, + { + "timestamp": "2022-10-29T08:44:45.000Z", + "value": 28.0 + }, + { + "timestamp": "2022-10-29T08:44:50.000Z", + "value": 45.0 + }, + { + "timestamp": "2022-10-29T08:44:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:25.000Z", + "value": 49.0 + } + ], + "dimensionValues": [ + { + "name": "SamplerName", + "value": "HighLoadTest" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsDefinitions.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsDefinitions.json new file mode 100644 index 000000000000..433f7803f097 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsDefinitions.json @@ -0,0 +1,156 @@ +{ + "operationId": "LoadTestRun_ListMetricDefinitions", + "title": "List the metric definitions for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metricNamespace": "LoadTestRunMetrics", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "No of concurrent virtual users", + "name": "VirtualUsers", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Response time (Successful request)", + "name": "ResponseTime", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Percentile90", + "supportedAggregationTypes": [ + "Average", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "unit": "Milliseconds", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Total Requests", + "name": "TotalRequests", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + }, + { + "description": "Error response code", + "name": "Errors" + } + ], + "description": "Total Errors", + "name": "Errors", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsNamespaces.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsNamespaces.json new file mode 100644 index 000000000000..330151a6ec88 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunMetricsNamespaces.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_ListMetricNamespaces", + "title": "List the metric namespaces for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "description": "Load test run metrics", + "name": "LoadTestRunMetrics" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..dea88efb5ae5 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRunServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestRun_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test run.", + "parameters": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRuns.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRuns.json new file mode 100644 index 000000000000..705ad1e376a9 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestRuns.json @@ -0,0 +1,153 @@ +{ + "operationId": "LoadTestRun_ListTestRuns", + "title": "List test runs.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "orderBy": "executedDateTime", + "continuationToken": "continuation token", + "search": "Performance_LoadTest_Run1", + "executionFrom": "2021-12-05T16:43:48.805Z", + "executionTo": "2021-12-05T16:43:48.805Z", + "status": "DONE,EXECUTING", + "maxPageSize": 30, + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 10, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "virtualUserHours": 20.50, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + ], + "nextLink": "https://nextlink.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestServerMetricsConfig.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestServerMetricsConfig.json new file mode 100644 index 000000000000..5791633ccc35 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTestServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTests.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTests.json new file mode 100644 index 000000000000..90b6d8829336 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTests.json @@ -0,0 +1,109 @@ +{ + "operationId": "LoadTestAdministration_ListTests", + "title": "Get all load tests.", + "parameters": { + "orderBy": "executedDateTime", + "search": "Performance_LoadTest", + "lastUpdatedStartTime": "2021-12-05T16:43:46.797Z", + "lastUpdatedEndTime": "2021-12-05T16:43:46.797Z", + "continuationToken": "continuation token", + "maxPageSize": 30, + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/tests?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTriggers.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTriggers.json new file mode 100644 index 000000000000..97feb6aceb19 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/ListTriggers.json @@ -0,0 +1,62 @@ +{ + "operationId": "TriggerAdministration_ListTrigger", + "title": "Get all triggers for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger1", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + }, + { + "testIds": [ + "12345678-1234-1234-1234-123456789013" + ], + "description": "sample description", + "displayName": "Sample_Trigger2", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Paused", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Hourly", + "recurrenceEnd": { + "numberOfOccurrences": 50 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestProfileRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestProfileRun.json new file mode 100644 index 000000000000..240f3257a9c0 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestProfileRun.json @@ -0,0 +1,52 @@ +{ + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "title": "Stop a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "CANCELLING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestRun.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestRun.json new file mode 100644 index 000000000000..a03f6c09d048 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/StopTestRun.json @@ -0,0 +1,106 @@ +{ + "operationId": "LoadTestRun_StopTestRun", + "title": "Stop test run by name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "CANCELLING", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "NOT_APPLICABLE", + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": null, + "logsFileInfo": null + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": null, + "testRunStatistics": null, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/UploadTestFile.json b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/UploadTestFile.json new file mode 100644 index 000000000000..8a37faa9bd4b --- /dev/null +++ b/specification/loadtestservice/LoadTestService/examples/2024-07-01-preview/UploadTestFile.json @@ -0,0 +1,22 @@ +{ + "operationId": "LoadTestAdministration_UploadTestFile", + "title": "Upload input file for a given test name.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "body": "application/octet-stream content", + "api-version": "2024-07-01-preview" + }, + "responses": { + "201": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/LoadTestService/main.tsp b/specification/loadtestservice/LoadTestService/main.tsp index 9eeccba0b38b..9ad95955fc39 100644 --- a/specification/loadtestservice/LoadTestService/main.tsp +++ b/specification/loadtestservice/LoadTestService/main.tsp @@ -42,6 +42,10 @@ enum APIVersions { @doc("The 2024-05-01-preview version of the Azure Load Testing API.") @useDependency(Azure.Core.Versions.v1_0_Preview_2) v2024_05_01_preview: "2024-05-01-preview", + + @doc("The 2024-07-01-preview version of the Azure Load Testing API.") + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2024_07_01_preview: "2024-07-01-preview", } @doc("OAuth 2.0 Flow with Microsoft Entra ID.") diff --git a/specification/loadtestservice/LoadTestService/models.trigger.tsp b/specification/loadtestservice/LoadTestService/models.trigger.tsp new file mode 100644 index 000000000000..0ae7132cc633 --- /dev/null +++ b/specification/loadtestservice/LoadTestService/models.trigger.tsp @@ -0,0 +1,283 @@ +import "@typespec/rest"; +import "@typespec/http"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; + +using TypeSpec.Rest; +using TypeSpec.Http; +using TypeSpec.Versioning; +using Azure.ClientGenerator.Core; + +namespace Microsoft.LoadTestService; + +@added(APIVersions.v2024_07_01_preview) +@doc("Frequency of recurrence for a trigger.") +union Frequency { + string, + + @doc("Recurrence defined by a cron expression.") + Cron: "Cron", + + @doc("Recurrence defined on an hourly basis, as specified by HourlyRecurrence.") + Hourly: "Hourly", + + @doc("Recurrence defined on a daily basis, as specified by DailyRecurrence.") + Daily: "Daily", + + @doc("Recurrence defined on a weekly basis, as specified by WeeklyRecurrence.") + Weekly: "Weekly", + + @doc("Recurrence defined monthly on specific days, as specified by MonthlyRecurrenceByWeekDays.") + MonthlyByDays: "MonthlyByDays", + + @doc("Recurrence defined monthly on specific dates, as specified by MonthlyRecurrenceByDates.") + MonthlyByDates: "MonthlyByDates", +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Current state of a trigger.") +union TriggerState { + string, + + @doc("The trigger is active.") + Active: "Active", + + @doc("The trigger is paused manually.") + Paused: "Paused", + + @doc("The trigger is completed.") + Completed: "Completed", + + @doc("The trigger is disabled due to error.") + Disabled: "Disabled", +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Defines the days of the week.") +union WeekDays { + string, + + @doc("Refers to Sunday.") + Sunday: "Sunday", + + @doc("Refers to Monday.") + Monday: "Monday", + + @doc("Refers to Tuesday.") + Tuesday: "Tuesday", + + @doc("Refers to Wednesday.") + Wednesday: "Wednesday", + + @doc("Refers to Thursday.") + Thursday: "Thursday", + + @doc("Refers to Friday.") + Friday: "Friday", + + @doc("Refers to Saturday.") + Saturday: "Saturday", +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Type of a trigger.") +union TriggerType { + string, + + @doc("Trigger is a Scheduled Trigger on a Test.") + ScheduleTestsTrigger: "ScheduleTestsTrigger", +} + +@added(APIVersions.v2024_07_01_preview) +@doc("ScheduleTestsTrigger model.") +model ScheduleTestsTrigger extends Trigger { + @doc("The type of the trigger is ScheduleTestsTrigger.") + kind: TriggerType.ScheduleTestsTrigger; + + @doc("The test id of test to be triggered by this schedule trigger. Currently only one test is supported for a trigger.") + testIds: string[]; + + @doc("Start date time of the trigger in UTC timezone. (RFC 3339 literal format)") + startDateTime?: utcDateTime; + + @visibility("read") + recurrenceStatus?: RecurrenceStatus; + + @doc("Recurrence details of the trigger. Null if schedule is not recurring.") + recurrence?: Recurrence; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Actual state of the recurrence for the trigger.") +model RecurrenceStatus { + @doc("The number of occurrences remaining for the trigger. Null if recurrence end has end date instead of number of occurrences.") + remainingOccurrences?: int32; + + @doc("The next three execution times of the trigger. (RFC 3339 literal format)") + nextScheduledDateTimes?: utcDateTime[]; +} + +@added(APIVersions.v2024_07_01_preview) +@resource("triggers") +@discriminator("kind") +@doc("Trigger model.") +model Trigger { + @key + @maxLength(50) + @minLength(2) + @pattern("^[a-z0-9_-]*$") + @doc("The unique identifier of the trigger.") + @visibility("read") + triggerId: string; + + @maxLength(50) + @minLength(2) + @doc("The name of the trigger.") + displayName: string; + + @maxLength(100) + @doc("The description of the trigger.") + description?: string; + + @doc("The type of the trigger.") + kind: TriggerType; + + @doc("The current state of the trigger.") + state?: TriggerState; + + @doc("Details of current state of the trigger.") + @visibility("read") + stateDetails?: StateDetails; + + ...SystemMetaData; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("State details of the trigger.") +model StateDetails { + @doc("The error message if the trigger is in disabled state.") + message?: string; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence model when frequency is set as Daily.") +model DailyRecurrence extends Recurrence { + @doc("Frequency of the day recurrence.") + frequency: Frequency.Daily; + + @doc("The interval at which the recurrence should repeat. It signifies the number of days between each recurrence.") + interval: int32; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence model when frequency is set as Hourly.") +model HourlyRecurrence extends Recurrence { + @doc("Frequency of the hour recurrence.") + frequency: Frequency.Hourly; + + @doc("The interval at which the recurrence should repeat. It signifies the number of hours between each recurrence.") + interval: int32; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence model when frequency is set as MonthlyByDays .") +model MonthlyRecurrenceByWeekDays extends Recurrence { + @doc("Frequency of the month recurrence.") + frequency: Frequency.MonthlyByDays; + + @doc("Specific days of the week when the recurrence should repeat.") + weekDaysInMonth?: WeekDays[]; + + @doc("Index of the week in a month at which the recurrence should repeat. For example, if the index is '2', weekDay is 'Monday', interval is 3 and frequency is 'Month', the recurrence will run every second Monday of the month and repeat every 3 months. Value of index can be 1 to 5.") + @minValue(1) + @maxValue(5) + index: int32; + + @doc("The interval at which the recurrence should repeat. It signifies the number of months between each recurrence.") + interval: int32; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence model when frequency is set as MonthlyByDates.") +model MonthlyRecurrenceByDates extends Recurrence { + @doc("Frequency of the month recurrence.") + frequency: Frequency.MonthlyByDates; + + @doc("Recurrence set to repeat on the specified dates of the month. Value of dates can be 1 to 31 and -1. -1 represents the last day of the month.") + datesInMonth?: int32[]; + + @doc("The interval at which the recurrence should repeat. It signifies the number of months between each recurrence.") + interval?: int32; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence is set based on cron expression.") +model RecurrenceWithCron extends Recurrence { + @doc("Specify frequency using a cron expression.") + frequency: Frequency.Cron; + + @doc("Cron expression for the recurrence.") + cronExpression: string; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Recurrence model when frequency is set as weekly.") +model WeeklyRecurrence extends Recurrence { + @doc("Frequency of the week recurrence.") + frequency: Frequency.Weekly; + + @doc("Recurrence set to repeat on the specified days of the week.") + daysOfWeek?: WeekDays[]; + + @doc("The interval at which the recurrence should repeat. It signifies the number of weeks between each recurrence.") + interval?: int32; +} + +@doc("Recurrence end model. Either provide numberOfOccurrences if you want recurrence to end after a specified number of occurrences or provide endDate if you want recurrence to end after a specified end date. If both values are provided, a validation error will be thrown indicating that only one field should be provided. If neither value is provided, the recurrence will end when manually ended.") +@added(APIVersions.v2024_07_01_preview) +model RecurrenceEnd { + @doc("Number of occurrences after which the recurrence will end.") + numberOfOccurrences?: int32; + + @doc("The date after which the recurrence will end. (RFC 3339 literal format)") + endDateTime?: utcDateTime; +} + +@added(APIVersions.v2024_07_01_preview) +@discriminator("frequency") +@doc("Recurrence model.") +model Recurrence { + @doc("Frequency of the recurrence.") + frequency: Frequency; + + @doc("Recurrence end model. You can specify the end either by providing a numberOfOccurrences (which will end the recurrence after the specified number of occurrences) or by providing an endDateTime (which will end the recurrence after the specified date). If neither value is provided, the recurrence will continue until it is manually ended. However, if both values are provided, an error will be thrown.") + recurrenceEnd?: RecurrenceEnd; +} + +@added(APIVersions.v2024_07_01_preview) +@doc("Parameters for list trigger operation") +model ListTriggerQueryParams { + @doc("Search based on triggers associated with the provided test ids.") + @query + testIds?: string; + + @doc("Filter triggers based on a comma separated list of states.") + @query + states?: TriggerState; + + @doc(""" + Start DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. + """) + @query + lastModifiedStartTime?: utcDateTime; + + @doc(""" + End DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. + """) + @query + lastModifiedEndTime?: utcDateTime; + + @doc("Number of results in response. Default page size is 50.") + @query + maxpagesize?: int32 = 50; +} diff --git a/specification/loadtestservice/LoadTestService/models.tsp b/specification/loadtestservice/LoadTestService/models.tsp index 49b3c0727f44..08b1eb89cfa7 100644 --- a/specification/loadtestservice/LoadTestService/models.tsp +++ b/specification/loadtestservice/LoadTestService/models.tsp @@ -90,6 +90,17 @@ union SecretType { @doc("If the secret value provided as plain text.") "SECRET_VALUE", } +@doc("Managed identity type.") +union ManagedIdentityType { + string, + + @doc("System-assigned managed identity.") + SystemAssigned: "SystemAssigned", + + @doc("User-assigned managed identity.") + UserAssigned: "UserAssigned", +} + @doc("Types of certificates supported.") union CertificateType { string, @@ -248,6 +259,14 @@ union TestKind { "Locust", } +@added(APIVersions.v2024_07_01_preview) +@doc("The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).") +union CreateByTypes { + string, + @doc("Entity was created by a user.") "User", + @doc("Entity was created by a scheduled trigger.") "ScheduledTrigger", +} + @doc("Test file info.") @resource("files") @parentResource(Test) @@ -323,6 +342,14 @@ model Test { @doc("Resource Id of the managed identity referencing the Key vault.") keyvaultReferenceIdentityId?: string; + @doc("Type of the managed identity referencing the metrics.") + @added(APIVersions.v2024_07_01_preview) + metricsReferenceIdentityType?: ManagedIdentityType = ManagedIdentityType.SystemAssigned; + + @doc("Resource Id of the managed identity referencing the metrics.") + @added(APIVersions.v2024_07_01_preview) + metricsReferenceIdentityId?: string; + ...SystemMetaData; } @@ -330,6 +357,10 @@ model Test { model PassFailCriteria { @doc("Map of id and pass fail metrics { id : pass fail metrics }.") passFailMetrics?: Record<PassFailMetric>; + + @doc("Map of id and pass fail server metrics { id : pass fail metrics }.") + @added(APIVersions.v2024_07_01_preview) + passFailServerMetrics?: Record<PassFailServerMetric>; } @doc("Pass fail metric") @@ -369,6 +400,38 @@ model PassFailMetric { result?: PFResult; } +@doc("Pass fail server metric") +model PassFailServerMetric { + @doc("The resource id of the resource emitting the metric.") + resourceId: string; + + @doc("The server metric namespace.") + metricNamespace: string; + + @doc("The server metric name.") + metricName: string; + + @doc("Aggregation Type") + aggregation: string; + + @doc("The comparison operator. Supported types ‘>’, ‘<’ ") + condition: string; + + @doc("The value to compare with the server metric.") + value: float64; + + @doc("Action taken after the threshold is met. Default is ‘continue’.") + action?: PFAction = PFAction.continue; + + @doc("The actual value of the server metric ") + @visibility("read") + actualValue?: float64; + + @doc("Outcome of the test run.") + @visibility("read") + result?: PFResult; +} + @doc("Secret") model Secret { @doc("The value of the secret for the respective type") @@ -719,6 +782,11 @@ model TestRun { @visibility("read") duration?: int64; + @doc("Virtual user hours consumed by the test run.") + @visibility("read") + @added(APIVersions.v2024_07_01_preview) + virtualUserHours?: float64; + @doc("Subnet ID on which the load test instances should run.") @visibility("read") subnetId?: string; @@ -742,6 +810,10 @@ model TestRun { @visibility("read") publicIPDisabled?: boolean; + @added(APIVersions.v2024_07_01_preview) + @doc("The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).") + createdByType?: CreateByTypes; + ...SystemMetaData; } diff --git a/specification/loadtestservice/LoadTestService/routes.tsp b/specification/loadtestservice/LoadTestService/routes.tsp index 631938e8f9ad..10d63a8efd20 100644 --- a/specification/loadtestservice/LoadTestService/routes.tsp +++ b/specification/loadtestservice/LoadTestService/routes.tsp @@ -5,6 +5,7 @@ import "@typespec/openapi"; import "@azure-tools/typespec-client-generator-core"; import "./models.tsp"; import "./models.testprofile.tsp"; +import "./models.trigger.tsp"; using Azure.Core; using Azure.Core.Traits; @@ -510,3 +511,18 @@ interface TestProfileRunAdministration { ListQueryParametersTrait<ListTestProfileRunQueryParams> >; } + +@tag("Trigger") +@added(APIVersions.v2024_07_01_preview) +interface TriggerAdministration { + getTrigger is StandardResourceOperations.ResourceRead<Trigger>; + + createOrUpdateTrigger is StandardResourceOperations.ResourceCreateOrUpdate<Trigger>; + + deleteTrigger is StandardResourceOperations.ResourceDelete<Trigger>; + + listTrigger is StandardResourceOperations.ResourceList< + Trigger, + ListQueryParametersTrait<ListTriggerQueryParams> + >; +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTest.json new file mode 100644 index 000000000000..653c35e1e815 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTest.json @@ -0,0 +1,222 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "title": "Create or update a load test", + "parameters": { + "api-version": "2024-07-01-preview", + "testId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestAppComponents.json new file mode 100644 index 000000000000..ddd3d793bf94 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfile.json new file mode 100644 index 000000000000..505c340ccce2 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfile.json @@ -0,0 +1,81 @@ +{ + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "title": "Create or update a test profile", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfileRun.json new file mode 100644 index 000000000000..052e4adaa901 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestProfileRun.json @@ -0,0 +1,99 @@ +{ + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "title": "Create/update and start a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview", + "body": { + "displayName": "Performance_TestProfile_Run1", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description" + } + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 512, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRun.json new file mode 100644 index 000000000000..02d3d6e86ac1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRun.json @@ -0,0 +1,311 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "title": "Create/update and start a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "oldTestRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview", + "body": { + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "ACCEPTED", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://dummyurl.com/configresource", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://dummyurl.com/userpropresource", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://dummyurl.com/inputartifactzipresource", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://dummyurl.com/dummyresourceresult", + "fileName": "results.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://dummyurl.com/logresource", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunAppComponents.json new file mode 100644 index 000000000000..694d5d7947c9 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunAppComponents.json @@ -0,0 +1,60 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "title": "Add or update app components to a load test run", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview", + "body": { + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "kind": "web" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..cfcdc6d9fcd1 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestRunServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test run", + "parameters": { + "testRunId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-07-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json new file mode 100644 index 000000000000..63a555850699 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTestServerMetricsConfig.json @@ -0,0 +1,65 @@ +{ + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "title": "Add or update server metrics configuration for a load test.", + "parameters": { + "testId": "edc6e529-d009-4b99-b763-ca492e3a2823", + "api-version": "2024-07-01-preview", + "body": { + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + } + } + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTrigger.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTrigger.json new file mode 100644 index 000000000000..82de0570f173 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/CreateOrUpdateTrigger.json @@ -0,0 +1,75 @@ +{ + "operationId": "TriggerAdministration_CreateOrUpdateTrigger", + "title": "Create or update a trigger.", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012", + "body": { + "description": "sample description", + "displayName": "Sample_Trigger", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + }, + "201": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTest.json new file mode 100644 index 000000000000..e1406dc179a6 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTest.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestAdministration_DeleteTest", + "title": "Delete a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestFile.json new file mode 100644 index 000000000000..0d9977e88a00 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestFile.json @@ -0,0 +1,12 @@ +{ + "operationId": "LoadTestAdministration_DeleteTestFile", + "title": "Delete a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "app.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfile.json new file mode 100644 index 000000000000..cebe50559f2a --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfile.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileAdministration_DeleteTestProfile", + "title": "Delete a test profile", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfileRun.json new file mode 100644 index 000000000000..56447a3e4b2d --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestProfileRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "title": "Deletes a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestRun.json new file mode 100644 index 000000000000..8539e9590d4b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTestRun.json @@ -0,0 +1,11 @@ +{ + "operationId": "LoadTestRun_DeleteTestRun", + "title": "Delete a load test run", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTrigger.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTrigger.json new file mode 100644 index 000000000000..7bbfcdacfc9f --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/DeleteTrigger.json @@ -0,0 +1,11 @@ +{ + "operationId": "TriggerAdministration_DeleteTrigger", + "title": "Delete a trigger", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTest.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTest.json new file mode 100644 index 000000000000..f6cf14edc539 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTest.json @@ -0,0 +1,99 @@ +{ + "operationId": "LoadTestAdministration_GetTest", + "title": "Get a load test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestFile.json new file mode 100644 index 000000000000..50166bcaba94 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestAdministration_GetTestFile", + "title": "Get a file from a load test", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfile.json new file mode 100644 index 000000000000..478a4d97fe30 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfile.json @@ -0,0 +1,36 @@ +{ + "operationId": "TestProfileAdministration_GetTestProfile", + "title": "Get a test profile.", + "parameters": { + "api-version": "2024-07-01-preview", + "testProfileId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executed.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executed.json new file mode 100644 index 000000000000..ae3840cb4a66 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executed.json @@ -0,0 +1,66 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run after the run has executed.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "DONE", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "recommendations": [ + { + "category": "ThroughputOptimized", + "configurations": [ + "config2" + ] + }, + { + "category": "CostOptimized", + "configurations": [ + "config1" + ] + } + ], + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executing.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executing.json new file mode 100644 index 000000000000..64116f6b55f7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestProfileRun_Executing.json @@ -0,0 +1,38 @@ +{ + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "title": "Get a test profile run while the run is executing.", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "EXECUTING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRun.json new file mode 100644 index 000000000000..987db3f3aa82 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRun.json @@ -0,0 +1,150 @@ +{ + "operationId": "LoadTestRun_GetTestRun", + "title": "Get a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + }, + "reportFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "virtualUserHours": 20.50, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "debugLogsEnabled": true, + "requestDataLevel": "NONE" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRunFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRunFile.json new file mode 100644 index 000000000000..debcfd8d99d7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTestRunFile.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_GetTestRunFile", + "title": "Get a file associated to a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "fileName": "sample.jmx", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTrigger.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTrigger.json new file mode 100644 index 000000000000..d9feea3233ac --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/GetTrigger.json @@ -0,0 +1,34 @@ +{ + "operationId": "TriggerAdministration_GetTrigger", + "title": "Get a trigger.", + "parameters": { + "api-version": "2024-07-01-preview", + "triggerId": "12345678-1234-1234-1234-123456789012" + }, + "responses": { + "200": { + "body": { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListMetricDimensionValues.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListMetricDimensionValues.json new file mode 100644 index 000000000000..65772f2bb026 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListMetricDimensionValues.json @@ -0,0 +1,23 @@ +{ + "operationId": "LoadTestRun_ListMetricDimensionValues", + "title": "List the dimension values for the given metric dimension name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "name": "SamplerName", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + "HighLoadTest" + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestAppComponents.json new file mode 100644 index 000000000000..121b7f4ab1e4 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestAdministration_GetAppComponents", + "title": "Get associated app component for the given test.", + "parameters": { + "testId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestFiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestFiles.json new file mode 100644 index 000000000000..e761cd228f98 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestFiles.json @@ -0,0 +1,25 @@ +{ + "operationId": "LoadTestAdministration_ListTestFiles", + "title": "Get all test files.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview", + "continuationToken": "continuation token" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfileRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfileRuns.json new file mode 100644 index 000000000000..e99c3e119248 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfileRuns.json @@ -0,0 +1,63 @@ +{ + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "title": "Get all test profile runs for the specified filters.", + "parameters": { + "maxPageSize": 30, + "minStartDateTime": "2024-05-01T16:00:46.072Z", + "maxStartDateTime": "2024-05-01T16:50:46.072Z", + "minEndDateTime": "2024-05-01T16:00:46.072Z", + "maxEndDateTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "statuses": "ACCEPTED", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "ACCEPTED", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profile-runs?orderby=startDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&executionFrom=&executionTo=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfiles.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfiles.json new file mode 100644 index 000000000000..c63f6866d25a --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestProfiles.json @@ -0,0 +1,45 @@ +{ + "operationId": "TestProfileAdministration_ListTestProfiles", + "title": "Get all test profiles for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "testProfileIds": "12345678-1234-1234-1234-123456789012", + "testIds": "12346-abcd-6789", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testProfileId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_TestProfile", + "testId": "12346-abcd-6789", + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.eastus.cnt-prod.loadtesting.azure.com/test-profiles?orderby=lastModifiedDateTime%20desc&continuationToken=some-value&search=Performance_TestProfile&&lastModifiedStartTime=&lastModifiedEndTime=&maxPageSize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunAppComponents.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunAppComponents.json new file mode 100644 index 000000000000..f2da50c7340c --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunAppComponents.json @@ -0,0 +1,30 @@ +{ + "operationId": "LoadTestRun_GetAppComponents", + "title": "Get associated app component for the given test run.", + "parameters": { + "testRunId": "ee843bd9-a6d4-4364-a45c-427a03c39fa7", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "components": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "resourceType": "microsoft.insights/components", + "resourceName": "appcomponentresource", + "displayName": "Performance_LoadTest_Insights", + "resourceGroup": "samplerg", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "kind": "web" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetrics.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetrics.json new file mode 100644 index 000000000000..08b2aef39370 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetrics.json @@ -0,0 +1,465 @@ +{ + "operationId": "LoadTestRun_ListMetrics", + "title": "List the metric values for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "interval": "PT1H", + "aggregation": "Average", + "metricname": "ActiveThreads", + "metricNamespace": "LoadTestRunMetrics", + "timespan": "2022-09-24T19:00:40Z/2022-09-25T19:28:40Z", + "api-version": "2024-07-01-preview", + "body": { + "filters": [ + { + "name": "SamplerName", + "values": [ + "HTTP Request" + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "data": [ + { + "timestamp": "2022-10-29T08:44:40.000Z", + "value": 10.0 + }, + { + "timestamp": "2022-10-29T08:44:45.000Z", + "value": 28.0 + }, + { + "timestamp": "2022-10-29T08:44:50.000Z", + "value": 45.0 + }, + { + "timestamp": "2022-10-29T08:44:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:45:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:46:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:47:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:48:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:49:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:50:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:51:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:25.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:30.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:35.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:40.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:45.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:50.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:52:55.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:00.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:05.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:10.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:15.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:20.000Z", + "value": 50.0 + }, + { + "timestamp": "2022-10-29T08:53:25.000Z", + "value": 49.0 + } + ], + "dimensionValues": [ + { + "name": "SamplerName", + "value": "HighLoadTest" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsDefinitions.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsDefinitions.json new file mode 100644 index 000000000000..433f7803f097 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsDefinitions.json @@ -0,0 +1,156 @@ +{ + "operationId": "LoadTestRun_ListMetricDefinitions", + "title": "List the metric definitions for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metricNamespace": "LoadTestRunMetrics", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "No of concurrent virtual users", + "name": "VirtualUsers", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Response time (Successful request)", + "name": "ResponseTime", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Percentile90", + "supportedAggregationTypes": [ + "Average", + "Percentile90", + "Percentile95", + "Percentile99" + ], + "unit": "Milliseconds", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + } + ], + "description": "Total Requests", + "name": "TotalRequests", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + }, + { + "dimensions": [ + { + "description": "Sampler Name", + "name": "SamplerName" + }, + { + "description": "Error response code", + "name": "Errors" + } + ], + "description": "Total Errors", + "name": "Errors", + "namespace": "LoadTestRunMetrics", + "primaryAggregationType": "Total", + "supportedAggregationTypes": [ + "Total" + ], + "unit": "Count", + "metricAvailabilities": [ + { + "timeGrain": "PT5S" + }, + { + "timeGrain": "PT10S" + }, + { + "timeGrain": "PT1M" + }, + { + "timeGrain": "PT5M" + }, + { + "timeGrain": "PT1H" + } + ] + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsNamespaces.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsNamespaces.json new file mode 100644 index 000000000000..330151a6ec88 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunMetricsNamespaces.json @@ -0,0 +1,20 @@ +{ + "operationId": "LoadTestRun_ListMetricNamespaces", + "title": "List the metric namespaces for a load test run.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "description": "Load test run metrics", + "name": "LoadTestRunMetrics" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunServerMetricsConfig.json new file mode 100644 index 000000000000..dea88efb5ae5 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRunServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestRun_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test run.", + "parameters": { + "testRunId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRuns.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRuns.json new file mode 100644 index 000000000000..705ad1e376a9 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestRuns.json @@ -0,0 +1,153 @@ +{ + "operationId": "LoadTestRun_ListTestRuns", + "title": "List test runs.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "orderBy": "executedDateTime", + "continuationToken": "continuation token", + "search": "Performance_LoadTest_Run1", + "executionFrom": "2021-12-05T16:43:48.805Z", + "executionTo": "2021-12-05T16:43:48.805Z", + "status": "DONE,EXECUTING", + "maxPageSize": 30, + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "DONE", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "PASSED", + "passFailCriteria": { + "passFailMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 10, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "logsFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "worker.log", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2022-05-16T09:14:46.0411793+00:00", + "validationStatus": "" + } + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": 4, + "virtualUserHours": 20.50, + "testRunStatistics": { + "Total": { + "transaction": "Total", + "sampleCount": 18, + "errorCount": 19, + "errorPct": 17, + "meanResTime": 13, + "medianResTime": 10, + "maxResTime": 16, + "minResTime": 18, + "pct1ResTime": 27, + "pct2ResTime": 20, + "pct3ResTime": 3, + "throughput": 5, + "receivedKBytesPerSec": 13, + "sentKBytesPerSec": 4 + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": 18, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + ], + "nextLink": "https://nextlink.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestServerMetricsConfig.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestServerMetricsConfig.json new file mode 100644 index 000000000000..5791633ccc35 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTestServerMetricsConfig.json @@ -0,0 +1,31 @@ +{ + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "title": "List server metrics configuration for the given test.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testId": "12316678-1234-1234-1234-122451189012", + "metrics": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource/providers/microsoft.insights/metricdefinitions/requests/duration", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource", + "metricNamespace": "microsoft.insights/components", + "displayDescription": "sample description", + "name": "requests/duration", + "aggregation": "Average", + "unit": null, + "resourceType": "microsoft.insights/components" + } + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTests.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTests.json new file mode 100644 index 000000000000..90b6d8829336 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTests.json @@ -0,0 +1,109 @@ +{ + "operationId": "LoadTestAdministration_ListTests", + "title": "Get all load tests.", + "parameters": { + "orderBy": "executedDateTime", + "search": "Performance_LoadTest", + "lastUpdatedStartTime": "2021-12-05T16:43:46.797Z", + "lastUpdatedEndTime": "2021-12-05T16:43:46.797Z", + "continuationToken": "continuation token", + "maxPageSize": 30, + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "displayName": "Performance_LoadTest", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 10, + "result": "passed" + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "autoStopCriteria": { + "autoStopDisabled": true, + "errorRate": 70, + "errorRateTimeWindowInSeconds": 60 + }, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0", + "keyvaultReferenceIdentityType": "UserAssigned", + "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1", + "metricsReferenceIdentityType": "UserAssigned", + "metricsReferenceIdentityId": "/subscriptions/10000000-0000-0000-0000-000000000000/resourceGroups/samplerg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleresourcename" + } + ], + "nextLink": "https://00000000-0000-0000-aaaa-00aa00aa00aa.westus2.cnt-prod.loadtesting.azure.com/tests?orderby=executedDateTime%20desc&continuationToken=some-value&search=&testId=&executionFrom=&executionTo=&status=&maxpagesize=50&api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTriggers.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTriggers.json new file mode 100644 index 000000000000..97feb6aceb19 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/ListTriggers.json @@ -0,0 +1,62 @@ +{ + "operationId": "TriggerAdministration_ListTrigger", + "title": "Get all triggers for the specified filters.", + "parameters": { + "maxPageSize": 30, + "lastModifiedStartTime": "2024-05-01T16:00:46.072Z", + "lastModifiedEndTime": "2024-05-01T16:50:46.072Z", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "testIds": [ + "12345678-1234-1234-1234-123456789012" + ], + "description": "sample description", + "displayName": "Sample_Trigger1", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Active", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Daily", + "recurrenceEnd": { + "numberOfOccurrences": 10 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + }, + { + "testIds": [ + "12345678-1234-1234-1234-123456789013" + ], + "description": "sample description", + "displayName": "Sample_Trigger2", + "triggerId": "12345678-1234-1234-1234-123456789012", + "state": "Paused", + "kind": "ScheduleTestsTrigger", + "recurrence": { + "interval": 1, + "frequency": "Hourly", + "recurrenceEnd": { + "numberOfOccurrences": 50 + } + }, + "startDateTime": "2024-05-01T00:00:00Z", + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + ] + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestProfileRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestProfileRun.json new file mode 100644 index 000000000000..240f3257a9c0 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestProfileRun.json @@ -0,0 +1,52 @@ +{ + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "title": "Stop a test profile run", + "parameters": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testProfileRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_TestProfile_Run1", + "description": "sample description", + "testProfileId": "12345678-1234-1234-1234-123456789012", + "status": "CANCELLING", + "startDateTime": "2024-05-01T16:43:46.072Z", + "endDateTime": "2024-05-01T16:43:46.072Z", + "durationInSeconds": 400, + "targetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Web/sites/myfunctionapp", + "targetResourceConfigurations": { + "kind": "FunctionsFlexConsumption", + "configurations": { + "config1": { + "instanceMemoryMB": 2048, + "httpConcurrency": 16 + }, + "config2": { + "instanceMemoryMB": 4096, + "httpConcurrency": 16 + } + } + }, + "testRunDetails": { + "testRun1": { + "status": "DONE", + "configurationId": "config1", + "properties": {} + }, + "testRun2": { + "status": "DONE", + "configurationId": "config2", + "properties": {} + } + }, + "createdDateTime": "2024-05-01T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2024-05-01T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestRun.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestRun.json new file mode 100644 index 000000000000..a03f6c09d048 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/StopTestRun.json @@ -0,0 +1,106 @@ +{ + "operationId": "LoadTestRun_StopTestRun", + "title": "Stop test run by name.", + "parameters": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "api-version": "2024-07-01-preview" + }, + "responses": { + "200": { + "body": { + "testRunId": "12316678-1234-1234-1234-122451189012", + "displayName": "Performance_LoadTest_Run1", + "testId": "12345678-1234-1234-1234-123456789012", + "description": "sample description", + "status": "CANCELLING", + "startDateTime": "2021-12-05T16:43:48.125Z", + "endDateTime": "2021-12-05T16:43:48.125Z", + "loadTestConfiguration": { + "engineInstances": 6, + "splitAllCSVs": true + }, + "testResult": "NOT_APPLICABLE", + "passFailCriteria": { + "passFailMetrics": { + "pfmetric1": { + "clientMetric": "response_time_ms", + "aggregate": "percentage", + "condition": ">", + "value": 20, + "action": "continue", + "actualValue": 0, + "result": null + } + }, + "passFailServerMetrics": { + "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": { + "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/MyResourceGroup/providers/Microsoft.Compute/virtualMachines/MyVM", + "metricNamespace": "Microsoft.Compute/virtualMachines", + "metricName": "Percentage CPU", + "aggregation": "Average", + "condition": ">", + "value": 20, + "action": "continue" + } + } + }, + "testArtifacts": { + "inputArtifacts": { + "configFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.yaml?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "config.yaml", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "testScriptFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.jmx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "sample.jmx", + "fileType": "JMX_FILE", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + }, + "userPropFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.properties?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "user.properties", + "fileType": "USER_PROPERTIES", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "inputArtifactsZipFileInfo": { + "url": "https://somestorageaccount.blob.core.windows.net/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000.zip?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D", + "fileName": "inputartifacts.zip", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "" + }, + "additionalFileInfo": [] + }, + "outputArtifacts": { + "resultFileInfo": null, + "logsFileInfo": null + } + }, + "executedDateTime": "2021-12-05T16:43:48.125Z", + "virtualUsers": null, + "testRunStatistics": null, + "createdDateTime": "2021-12-05T16:43:46.072Z", + "createdBy": "user@contoso.com", + "lastModifiedDateTime": "2021-12-05T16:43:46.072Z", + "lastModifiedBy": "user@contoso.com", + "portalUrl": "https://portal.azure.com/dummyresource", + "secrets": { + "secret1": { + "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827", + "type": "AKV_SECRET_URI" + } + }, + "environmentVariables": { + "envvar1": "sampletext" + }, + "duration": null, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/UploadTestFile.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/UploadTestFile.json new file mode 100644 index 000000000000..8a37faa9bd4b --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/examples/UploadTestFile.json @@ -0,0 +1,22 @@ +{ + "operationId": "LoadTestAdministration_UploadTestFile", + "title": "Upload input file for a given test name.", + "parameters": { + "testId": "12345678-1234-1234-1234-123456789012", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "body": "application/octet-stream content", + "api-version": "2024-07-01-preview" + }, + "responses": { + "201": { + "body": { + "url": "https://dummyurl.com/testscriptresource", + "fileName": "sample.jmx", + "fileType": "ADDITIONAL_ARTIFACTS", + "expireDateTime": "2021-12-05T16:43:46.072Z", + "validationStatus": "VALIDATION_SUCCESS" + } + } + } +} diff --git a/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json new file mode 100644 index 000000000000..b61c7f68bcb7 --- /dev/null +++ b/specification/loadtestservice/data-plane/Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json @@ -0,0 +1,6573 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Load Testing", + "version": "2024-07-01-preview", + "description": "These APIs allow end users to create, view and run load tests using Azure Load Test Service.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "https://{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "Oauth2": [ + "https://cnt-prod.loadtesting.azure.com/.default" + ] + } + ], + "securityDefinitions": { + "Oauth2": { + "type": "oauth2", + "description": "OAuth 2.0 Flow with Microsoft Entra ID.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": { + "https://cnt-prod.loadtesting.azure.com/.default": "" + } + } + }, + "tags": [ + { + "name": "Test" + }, + { + "name": "TestRun" + }, + { + "name": "TestProfile" + }, + { + "name": "TestProfileRun" + }, + { + "name": "Trigger" + } + ], + "paths": { + "/test-profile-runs": { + "get": { + "operationId": "TestProfileRunAdministration_ListTestProfileRuns", + "tags": [ + "TestProfileRun" + ], + "summary": "List test profile runs.", + "description": "Get all test profile runs for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxpagesize" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.minStartDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxStartDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.minEndDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.maxEndDateTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.createdDateStartTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.createdDateEndTime" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.testProfileRunIds" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.testProfileIds" + }, + { + "$ref": "#/parameters/ListTestProfileRunQueryParams.statuses" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test profile runs for the specified filters.": { + "$ref": "./examples/ListTestProfileRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-profile-runs/{testProfileRunId}": { + "get": { + "operationId": "TestProfileRunAdministration_GetTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Get test profile run details.", + "description": "Get test profile run details by test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a test profile run after the run has executed.": { + "$ref": "./examples/GetTestProfileRun_Executed.json" + }, + "Get a test profile run while the run is executing.": { + "$ref": "./examples/GetTestProfileRun_Executing.json" + } + } + }, + "patch": { + "operationId": "TestProfileRunAdministration_CreateOrUpdateTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Create and start a new test profile run.", + "description": "Create and start a new test profile run with the given test profile run Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestProfileRunCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create/update and start a test profile run": { + "$ref": "./examples/CreateOrUpdateTestProfileRun.json" + } + } + }, + "delete": { + "operationId": "TestProfileRunAdministration_DeleteTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Delete an existing load test profile run.", + "description": "Delete an existing load test profile run by providing the test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Deletes a test profile run": { + "$ref": "./examples/DeleteTestProfileRun.json" + } + } + } + }, + "/test-profile-runs/{testProfileRunId}:stop": { + "post": { + "operationId": "TestProfileRunAdministration_StopTestProfileRun", + "tags": [ + "TestProfileRun" + ], + "summary": "Stop test profile run.", + "description": "Stop test profile run for the given test profile run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileRunId", + "in": "path", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfileRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stop a test profile run": { + "$ref": "./examples/StopTestProfileRun.json" + } + } + } + }, + "/test-profiles": { + "get": { + "operationId": "TestProfileAdministration_ListTestProfiles", + "tags": [ + "TestProfile" + ], + "summary": "List test profiles.", + "description": "Get all test profiles for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.maxpagesize" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.lastModifiedStartTime" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.lastModifiedEndTime" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.testProfileIds" + }, + { + "$ref": "#/parameters/ListTestProfileQueryParams.testIds" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test profiles for the specified filters.": { + "$ref": "./examples/ListTestProfiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-profiles/{testProfileId}": { + "get": { + "operationId": "TestProfileAdministration_GetTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Get load test profile details.", + "description": "Get load test profile details by test profile Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a test profile.": { + "$ref": "./examples/GetTestProfile.json" + } + } + }, + "patch": { + "operationId": "TestProfileAdministration_CreateOrUpdateTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Create a new test profile or update an existing test profile.", + "description": "Create a new test profile or update an existing test profile by providing the test profile Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestProfileCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestProfile" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create or update a test profile": { + "$ref": "./examples/CreateOrUpdateTestProfile.json" + } + } + }, + "delete": { + "operationId": "TestProfileAdministration_DeleteTestProfile", + "tags": [ + "TestProfile" + ], + "summary": "Delete a test profile.", + "description": "Delete a test profile by its test profile Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testProfileId", + "in": "path", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a test profile": { + "$ref": "./examples/DeleteTestProfile.json" + } + } + } + }, + "/test-runs": { + "get": { + "operationId": "LoadTestRun_ListTestRuns", + "tags": [ + "TestRun" + ], + "summary": "Get all test runs for the given filters.", + "description": "Get all test runs for the given filters.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.orderby" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.search" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.testId" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.executionFrom" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.executionTo" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.status" + }, + { + "$ref": "#/parameters/ListTestRunQueryParams.maxpagesize" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List test runs.": { + "$ref": "./examples/ListTestRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-runs/{testRunId}": { + "get": { + "operationId": "LoadTestRun_GetTestRun", + "tags": [ + "TestRun" + ], + "summary": "Get test run details by test run Id.", + "description": "Get test run details by test run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a load test run.": { + "$ref": "./examples/GetTestRun.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateTestRun", + "tags": [ + "TestRun" + ], + "summary": "Create and start a new test run with the given test run Id.", + "description": "Create and start a new test run with the given test run Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "$ref": "#/parameters/OldTestRunIdQueryParam" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create/update and start a load test run": { + "$ref": "./examples/CreateOrUpdateTestRun.json" + } + } + }, + "delete": { + "operationId": "LoadTestRun_DeleteTestRun", + "tags": [ + "TestRun" + ], + "summary": "Delete an existing load test run.", + "description": "Delete an existing load test run by providing the testRunId.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a load test run": { + "$ref": "./examples/DeleteTestRun.json" + } + } + } + }, + "/test-runs/{testRunId}:stop": { + "post": { + "operationId": "LoadTestRun_StopTestRun", + "tags": [ + "TestRun" + ], + "summary": "Stop test run by test run Id.", + "description": "Stop test run by test run Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRun" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Stop test run by name.": { + "$ref": "./examples/StopTestRun.json" + } + } + } + }, + "/test-runs/{testRunId}/app-components": { + "get": { + "operationId": "LoadTestRun_GetAppComponents", + "tags": [ + "TestRun" + ], + "summary": "Get associated app component (collection of azure resources) for the given test\nrun.", + "description": "Get associated app component (collection of azure resources) for the given test\nrun.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get associated app component for the given test run.": { + "$ref": "./examples/ListTestRunAppComponents.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateAppComponents", + "tags": [ + "TestRun" + ], + "summary": "Add an app component to a test run.", + "description": "Add an app component to a test run by providing the resource Id, name and type.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "App Component model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunAppComponentsUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRunAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update app components to a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunAppComponents.json" + } + } + } + }, + "/test-runs/{testRunId}/files/{fileName}": { + "get": { + "operationId": "LoadTestRun_GetTestRunFile", + "tags": [ + "TestRun" + ], + "summary": "Get test run file by file name.", + "description": "Get test run file by file name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a file associated to a load test run.": { + "$ref": "./examples/GetTestRunFile.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-definitions": { + "get": { + "operationId": "LoadTestRun_ListMetricDefinitions", + "tags": [ + "TestRun" + ], + "summary": "List the metric definitions for a load test run.", + "description": "List the metric definitions for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MetricDefinitionCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric definitions for a load test run.": { + "$ref": "./examples/ListTestRunMetricsDefinitions.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-dimensions/{name}/values": { + "get": { + "operationId": "LoadTestRun_ListMetricDimensionValues", + "tags": [ + "TestRun" + ], + "summary": "List the dimension values for the given metric dimension name.", + "description": "List the dimension values for the given metric dimension name.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "name", + "in": "path", + "description": "Dimension name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionValueList" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the dimension values for the given metric dimension name.": { + "$ref": "./examples/ListMetricDimensionValues.json" + } + } + } + }, + "/test-runs/{testRunId}/metric-namespaces": { + "get": { + "operationId": "LoadTestRun_ListMetricNamespaces", + "tags": [ + "TestRun" + ], + "summary": "List the metric namespaces for a load test run.", + "description": "List the metric namespaces for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/MetricNamespaceCollection" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric namespaces for a load test run.": { + "$ref": "./examples/ListTestRunMetricsNamespaces.json" + } + } + } + }, + "/test-runs/{testRunId}/metrics": { + "post": { + "operationId": "LoadTestRun_ListMetrics", + "tags": [ + "TestRun" + ], + "summary": "List the metric values for a load test run.", + "description": "List the metric values for a load test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "aggregation", + "in": "query", + "description": "The aggregation", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricname" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.interval" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.metricNamespace" + }, + { + "$ref": "#/parameters/MetricDimensionsRequest.timespan" + }, + { + "name": "body", + "in": "body", + "description": "Metric dimension filter ", + "required": false, + "schema": { + "$ref": "#/definitions/MetricRequestPayload" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Metrics" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List the metric values for a load test run.": { + "$ref": "./examples/ListTestRunMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/test-runs/{testRunId}/server-metrics-config": { + "get": { + "operationId": "LoadTestRun_GetServerMetricsConfig", + "tags": [ + "TestRun" + ], + "summary": "Get associated server metrics configuration for the given test run.", + "description": "Get associated server metrics configuration for the given test run.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique name for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List server metrics configuration for the given test run.": { + "$ref": "./examples/ListTestRunServerMetricsConfig.json" + } + } + }, + "patch": { + "operationId": "LoadTestRun_CreateOrUpdateServerMetricsConfig", + "tags": [ + "TestRun" + ], + "summary": "Configure server metrics for a test run", + "description": "Configure server metrics for a test run", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testRunId", + "in": "path", + "description": "Unique Id for the load test run, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestRunServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update server metrics configuration for a load test run": { + "$ref": "./examples/CreateOrUpdateTestRunServerMetricsConfig.json" + } + } + } + }, + "/tests": { + "get": { + "operationId": "LoadTestAdministration_ListTests", + "tags": [ + "Test" + ], + "summary": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "description": "Get all load tests by the fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTestQueryParams.orderby" + }, + { + "$ref": "#/parameters/ListTestQueryParams.search" + }, + { + "$ref": "#/parameters/ListTestQueryParams.lastModifiedStartTime" + }, + { + "$ref": "#/parameters/ListTestQueryParams.lastModifiedEndTime" + }, + { + "$ref": "#/parameters/ListTestQueryParams.maxpagesize" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTest" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all load tests.": { + "$ref": "./examples/ListTests.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tests/{testId}": { + "get": { + "operationId": "LoadTestAdministration_GetTest", + "tags": [ + "Test" + ], + "summary": "Get load test details by test Id", + "description": "Get load test details by test Id", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a load test.": { + "$ref": "./examples/GetTest.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateTest", + "tags": [ + "Test" + ], + "summary": "Create a new test or update an existing test by providing the test Id.", + "description": "Create a new test or update an existing test by providing the test Id.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TestCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Test" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create or update a load test": { + "$ref": "./examples/CreateOrUpdateTest.json" + } + } + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTest", + "tags": [ + "Test" + ], + "summary": "Delete a test by its test Id.", + "description": "Delete a test by its test Id.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a load test": { + "$ref": "./examples/DeleteTest.json" + } + } + } + }, + "/tests/{testId}/app-components": { + "get": { + "operationId": "LoadTestAdministration_GetAppComponents", + "tags": [ + "Test" + ], + "summary": "Get associated app component (collection of azure resources) for the given test.", + "description": "Get associated app component (collection of azure resources) for the given test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get associated app component for the given test.": { + "$ref": "./examples/ListTestAppComponents.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateAppComponents", + "tags": [ + "Test" + ], + "summary": "Add an app component to a test.", + "description": "Add an app component to a test by providing the resource Id, name and type.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "App Component model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestAppComponentsUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestAppComponents" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update app components to a load test": { + "$ref": "./examples/CreateOrUpdateTestAppComponents.json" + } + } + } + }, + "/tests/{testId}/files": { + "get": { + "operationId": "LoadTestAdministration_ListTestFiles", + "tags": [ + "Test" + ], + "summary": "Get all test files.", + "description": "Get all test files.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all test files.": { + "$ref": "./examples/ListTestFiles.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/tests/{testId}/files/{fileName}": { + "get": { + "operationId": "LoadTestAdministration_GetTestFile", + "tags": [ + "Test" + ], + "summary": "Get all the files that are associated with a test.", + "description": "Get all the files that are associated with a test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a file from a load test": { + "$ref": "./examples/GetTestFile.json" + } + } + }, + "put": { + "operationId": "LoadTestAdministration_UploadTestFile", + "tags": [ + "Test" + ], + "summary": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", + "description": "Upload input file for a given test Id. File size can't be more than 50 MB.\nExisting file with same name for the given test will be overwritten. File\nshould be provided in the request body as application/octet-stream.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Unique name for test file with file extension like : App.jmx", + "required": true, + "type": "string" + }, + { + "name": "fileType", + "in": "query", + "description": "File type", + "required": false, + "type": "string", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", + "URL_TEST_CONFIG", + "TEST_SCRIPT" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + }, + { + "name": "ZIPPED_ARTIFACTS", + "value": "ZIPPED_ARTIFACTS", + "description": "If the file is a compressed archive containing a collection of various artifacts or resources." + }, + { + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", + "description": "If the file is a JSON config file to define the requests for a URL test." + }, + { + "name": "TEST_SCRIPT", + "value": "TEST_SCRIPT", + "description": "If the file is a test script." + } + ] + } + }, + { + "name": "body", + "in": "body", + "description": "The file content as application/octet-stream.", + "required": true, + "schema": { + "type": "string", + "format": "binary" + } + } + ], + "responses": { + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestFileInfo" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Upload input file for a given test name.": { + "$ref": "./examples/UploadTestFile.json" + } + } + }, + "delete": { + "operationId": "LoadTestAdministration_DeleteTestFile", + "tags": [ + "Test" + ], + "summary": "Delete file by the file name for a test", + "description": "Delete file by the file name for a test", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "fileName", + "in": "path", + "description": "Name of the file.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a file from a load test": { + "$ref": "./examples/DeleteTestFile.json" + } + } + } + }, + "/tests/{testId}/server-metrics-config": { + "get": { + "operationId": "LoadTestAdministration_GetServerMetricsConfig", + "tags": [ + "Test" + ], + "summary": "List server metrics configuration for the given test.", + "description": "List server metrics configuration for the given test.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "List server metrics configuration for the given test.": { + "$ref": "./examples/ListTestServerMetricsConfig.json" + } + } + }, + "patch": { + "operationId": "LoadTestAdministration_CreateOrUpdateServerMetricsConfig", + "tags": [ + "Test" + ], + "summary": "Configure server metrics for a test", + "description": "Configure server metrics for a test", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "testId", + "in": "path", + "description": "Unique name for the load test, must contain only lower-case alphabetic,\nnumeric, underscore or hyphen characters.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "Server metric configuration model.", + "required": true, + "schema": { + "$ref": "#/definitions/TestServerMetricConfigUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TestServerMetricConfig" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Add or update server metrics configuration for a load test.": { + "$ref": "./examples/CreateOrUpdateTestServerMetricsConfig.json" + } + } + } + }, + "/triggers": { + "get": { + "operationId": "TriggerAdministration_ListTrigger", + "tags": [ + "Trigger" + ], + "description": "Resource list operation template.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListTriggerQueryParams.testIds" + }, + { + "$ref": "#/parameters/ListTriggerQueryParams.states" + }, + { + "$ref": "#/parameters/ListTriggerQueryParams.lastModifiedStartTime" + }, + { + "$ref": "#/parameters/ListTriggerQueryParams.lastModifiedEndTime" + }, + { + "$ref": "#/parameters/ListTriggerQueryParams.maxpagesize" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/PagedTrigger" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get all triggers for the specified filters.": { + "$ref": "./examples/ListTriggers.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/triggers/{triggerId}": { + "get": { + "operationId": "TriggerAdministration_GetTrigger", + "tags": [ + "Trigger" + ], + "description": "Resource read operation template.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "triggerId", + "in": "path", + "description": "The unique identifier of the trigger.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Get a trigger.": { + "$ref": "./examples/GetTrigger.json" + } + } + }, + "patch": { + "operationId": "TriggerAdministration_CreateOrUpdateTrigger", + "tags": [ + "Trigger" + ], + "description": "Create or update operation template.", + "consumes": [ + "application/merge-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "triggerId", + "in": "path", + "description": "The unique identifier of the trigger.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + }, + { + "name": "body", + "in": "body", + "description": "The resource instance.", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerCreateOrUpdate" + }, + "x-ms-client-name": "resource" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Create or update a trigger.": { + "$ref": "./examples/CreateOrUpdateTrigger.json" + } + } + }, + "delete": { + "operationId": "TriggerAdministration_DeleteTrigger", + "tags": [ + "Trigger" + ], + "description": "Resource delete operation template.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "triggerId", + "in": "path", + "description": "The unique identifier of the trigger.", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$" + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "String error code indicating what went wrong." + } + } + } + }, + "x-ms-examples": { + "Delete a trigger": { + "$ref": "./examples/DeleteTrigger.json" + } + } + } + } + }, + "definitions": { + "AggregationType": { + "type": "string", + "description": "Aggregation type.", + "enum": [ + "Average", + "Count", + "None", + "Total", + "Percentile75", + "Percentile90", + "Percentile95", + "Percentile96", + "Percentile97", + "Percentile98", + "Percentile99", + "Percentile999", + "Percentile9999" + ], + "x-ms-enum": { + "name": "AggregationType", + "modelAsString": true, + "values": [ + { + "name": "Average", + "value": "Average", + "description": "Average value." + }, + { + "name": "Count", + "value": "Count", + "description": "Total count." + }, + { + "name": "None", + "value": "None", + "description": "Aggregation will be average in this case." + }, + { + "name": "Total", + "value": "Total", + "description": "Total sum." + }, + { + "name": "Percentile75", + "value": "Percentile75", + "description": "75th percentile." + }, + { + "name": "Percentile90", + "value": "Percentile90", + "description": "90th percentile." + }, + { + "name": "Percentile95", + "value": "Percentile95", + "description": "95th percentile." + }, + { + "name": "Percentile96", + "value": "Percentile96", + "description": "96th percentile." + }, + { + "name": "Percentile97", + "value": "Percentile97", + "description": "97th percentile." + }, + { + "name": "Percentile98", + "value": "Percentile98", + "description": "98th percentile." + }, + { + "name": "Percentile99", + "value": "Percentile99", + "description": "99th percentile." + }, + { + "name": "Percentile999", + "value": "Percentile999", + "description": "99.9th percentile." + }, + { + "name": "Percentile9999", + "value": "Percentile9999", + "description": "99.99th percentile." + } + ] + } + }, + "AppComponent": { + "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", + "properties": { + "resourceId": { + "type": "string", + "description": "fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}", + "readOnly": true + }, + "resourceName": { + "type": "string", + "description": "Azure resource name, required while creating the app component." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type, required while creating the app component." + }, + "displayName": { + "type": "string", + "description": "Azure resource display name" + }, + "resourceGroup": { + "type": "string", + "description": "Resource group name of the Azure resource", + "readOnly": true + }, + "subscriptionId": { + "type": "string", + "description": "Subscription Id of the Azure resource", + "readOnly": true + }, + "kind": { + "type": "string", + "description": "Kind of Azure resource type" + } + }, + "required": [ + "resourceId", + "resourceName", + "resourceType" + ] + }, + "AppComponentUpdate": { + "type": "object", + "description": "An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)", + "properties": { + "resourceName": { + "type": "string", + "description": "Azure resource name, required while creating the app component." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type, required while creating the app component." + }, + "displayName": { + "type": "string", + "description": "Azure resource display name" + }, + "kind": { + "type": "string", + "description": "Kind of Azure resource type" + } + } + }, + "ArtifactsContainerInfo": { + "type": "object", + "description": "Artifacts container info.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "This is a SAS URI to an Azure Storage Container that contains the test run artifacts." + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the container (RFC 3339 literal format)" + } + } + }, + "AutoStopCriteria": { + "type": "object", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window.", + "properties": { + "autoStopDisabled": { + "type": "boolean", + "description": "Whether auto-stop should be disabled. The default value is false.", + "default": false + }, + "errorRate": { + "type": "number", + "format": "float", + "description": "Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0", + "default": 90 + }, + "errorRateTimeWindowInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time window during which the error percentage should be evaluated in seconds.", + "default": 60 + } + } + }, + "Azure.Core.Foundations.Error": { + "type": "object", + "description": "The error object.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [] + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "required": [ + "code", + "message" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "description": "A response containing error details.", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + } + }, + "CertificateMetadata": { + "type": "object", + "description": "Certificates metadata", + "properties": { + "value": { + "type": "string", + "description": "The value of the certificate for respective type" + }, + "type": { + "$ref": "#/definitions/CertificateType", + "description": "Type of certificate" + }, + "name": { + "type": "string", + "description": "Name of the certificate." + } + } + }, + "CertificateType": { + "type": "string", + "description": "Types of certificates supported.", + "enum": [ + "AKV_CERT_URI" + ], + "x-ms-enum": { + "name": "CertificateType", + "modelAsString": true, + "values": [ + { + "name": "AKV_CERT_URI", + "value": "AKV_CERT_URI", + "description": "If the certificate is stored in an Azure Key Vault." + } + ] + } + }, + "CreateByTypes": { + "type": "string", + "description": "The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).", + "enum": [ + "User", + "ScheduledTrigger" + ], + "x-ms-enum": { + "name": "CreateByTypes", + "modelAsString": true, + "values": [ + { + "name": "User", + "value": "User", + "description": "Entity was created by a user." + }, + { + "name": "ScheduledTrigger", + "value": "ScheduledTrigger", + "description": "Entity was created by a scheduled trigger." + } + ] + } + }, + "DailyRecurrence": { + "type": "object", + "description": "Recurrence model when frequency is set as Daily.", + "properties": { + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of days between each recurrence." + } + }, + "required": [ + "interval" + ], + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "Daily" + }, + "DailyRecurrenceCreateOrUpdate": { + "type": "object", + "description": "Recurrence model when frequency is set as Daily.", + "properties": { + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of days between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "Daily" + }, + "DimensionFilter": { + "type": "object", + "description": "Dimension name and values to filter", + "properties": { + "name": { + "type": "string", + "description": "The dimension name" + }, + "values": { + "type": "array", + "description": "The dimension values. Maximum values can be 20.", + "items": { + "type": "string" + } + } + } + }, + "DimensionValue": { + "type": "object", + "description": "Represents a metric dimension value.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "value": { + "type": "string", + "description": "The value of the dimension." + } + } + }, + "DimensionValueList": { + "type": "object", + "description": "Metrics dimension values.", + "properties": { + "name": { + "type": "string", + "description": "The dimension name", + "readOnly": true + }, + "value": { + "type": "array", + "description": "The dimension value", + "items": { + "type": "string" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "Link for the next set of values in case of paginated results, if applicable." + } + } + }, + "ErrorDetails": { + "type": "object", + "description": "Error details if there is any failure in load test run", + "properties": { + "message": { + "type": "string", + "description": "Error details in case test run was not successfully run.", + "readOnly": true + } + } + }, + "FileStatus": { + "type": "string", + "description": "File status.", + "enum": [ + "NOT_VALIDATED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE", + "VALIDATION_INITIATED", + "VALIDATION_NOT_REQUIRED" + ], + "x-ms-enum": { + "name": "FileStatus", + "modelAsString": true, + "values": [ + { + "name": "NOT_VALIDATED", + "value": "NOT_VALIDATED", + "description": "File is not validated." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "File is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "File validation is failed." + }, + { + "name": "VALIDATION_INITIATED", + "value": "VALIDATION_INITIATED", + "description": "File validation is in progress." + }, + { + "name": "VALIDATION_NOT_REQUIRED", + "value": "VALIDATION_NOT_REQUIRED", + "description": "Validation is not required." + } + ] + } + }, + "FileType": { + "type": "string", + "description": "Types of file supported.", + "enum": [ + "JMX_FILE", + "USER_PROPERTIES", + "ADDITIONAL_ARTIFACTS", + "ZIPPED_ARTIFACTS", + "URL_TEST_CONFIG", + "TEST_SCRIPT" + ], + "x-ms-enum": { + "name": "FileType", + "modelAsString": true, + "values": [ + { + "name": "JMX_FILE", + "value": "JMX_FILE", + "description": "If the file is a JMX script." + }, + { + "name": "USER_PROPERTIES", + "value": "USER_PROPERTIES", + "description": "If the file is a user properties file." + }, + { + "name": "ADDITIONAL_ARTIFACTS", + "value": "ADDITIONAL_ARTIFACTS", + "description": "If the file is not among any of the other supported file types." + }, + { + "name": "ZIPPED_ARTIFACTS", + "value": "ZIPPED_ARTIFACTS", + "description": "If the file is a compressed archive containing a collection of various artifacts or resources." + }, + { + "name": "URL_TEST_CONFIG", + "value": "URL_TEST_CONFIG", + "description": "If the file is a JSON config file to define the requests for a URL test." + }, + { + "name": "TEST_SCRIPT", + "value": "TEST_SCRIPT", + "description": "If the file is a test script." + } + ] + } + }, + "Frequency": { + "type": "string", + "description": "Frequency of recurrence for a trigger.", + "enum": [ + "Cron", + "Hourly", + "Daily", + "Weekly", + "MonthlyByDays", + "MonthlyByDates" + ], + "x-ms-enum": { + "name": "Frequency", + "modelAsString": true, + "values": [ + { + "name": "Cron", + "value": "Cron", + "description": "Recurrence defined by a cron expression." + }, + { + "name": "Hourly", + "value": "Hourly", + "description": "Recurrence defined on an hourly basis, as specified by HourlyRecurrence." + }, + { + "name": "Daily", + "value": "Daily", + "description": "Recurrence defined on a daily basis, as specified by DailyRecurrence." + }, + { + "name": "Weekly", + "value": "Weekly", + "description": "Recurrence defined on a weekly basis, as specified by WeeklyRecurrence." + }, + { + "name": "MonthlyByDays", + "value": "MonthlyByDays", + "description": "Recurrence defined monthly on specific days, as specified by MonthlyRecurrenceByWeekDays." + }, + { + "name": "MonthlyByDates", + "value": "MonthlyByDates", + "description": "Recurrence defined monthly on specific dates, as specified by MonthlyRecurrenceByDates." + } + ] + } + }, + "FunctionFlexConsumptionResourceConfiguration": { + "type": "object", + "description": "Resource configuration instance for a Flex Consumption based Azure Function App.", + "properties": { + "instanceMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Memory size of the instance. Supported values are 2048, 4096." + }, + "httpConcurrency": { + "type": "integer", + "format": "int64", + "description": "HTTP Concurrency for the function app." + } + }, + "required": [ + "instanceMemoryMB", + "httpConcurrency" + ] + }, + "FunctionFlexConsumptionResourceConfigurationCreateOrUpdate": { + "type": "object", + "description": "Resource configuration instance for a Flex Consumption based Azure Function App.", + "properties": { + "instanceMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Memory size of the instance. Supported values are 2048, 4096." + }, + "httpConcurrency": { + "type": "integer", + "format": "int64", + "description": "HTTP Concurrency for the function app." + } + } + }, + "FunctionFlexConsumptionTargetResourceConfigurations": { + "type": "object", + "description": "Configurations for a Function App using Flex Consumption Plan.", + "properties": { + "configurations": { + "type": "object", + "description": "A map of configurations for a Function app using Flex Consumption Plan.", + "additionalProperties": { + "$ref": "#/definitions/FunctionFlexConsumptionResourceConfiguration" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetResourceConfigurations" + } + ], + "x-ms-discriminator-value": "FunctionsFlexConsumption" + }, + "FunctionFlexConsumptionTargetResourceConfigurationsCreateOrUpdate": { + "type": "object", + "description": "Configurations for a Function App using Flex Consumption Plan.", + "properties": { + "configurations": { + "type": "object", + "description": "A map of configurations for a Function app using Flex Consumption Plan.", + "additionalProperties": { + "$ref": "#/definitions/FunctionFlexConsumptionResourceConfigurationCreateOrUpdate" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/TargetResourceConfigurationsCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "FunctionsFlexConsumption" + }, + "HourlyRecurrence": { + "type": "object", + "description": "Recurrence model when frequency is set as Hourly.", + "properties": { + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of hours between each recurrence." + } + }, + "required": [ + "interval" + ], + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "Hourly" + }, + "HourlyRecurrenceCreateOrUpdate": { + "type": "object", + "description": "Recurrence model when frequency is set as Hourly.", + "properties": { + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of hours between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "Hourly" + }, + "LoadTestConfiguration": { + "type": "object", + "description": "Configurations for the load test.", + "properties": { + "engineInstances": { + "type": "integer", + "format": "int32", + "description": "The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test." + }, + "splitAllCSVs": { + "type": "boolean", + "description": "If false, Azure Load Testing copies and processes your input files unmodified\nacross all test engine instances. If true, Azure Load Testing splits the CSV\ninput data evenly across all engine instances. If you provide multiple CSV\nfiles, each file will be split evenly.", + "default": false + }, + "quickStartTest": { + "type": "boolean", + "description": "If true, optionalLoadTestConfig is required and JMX script for the load test is\nnot required to upload.", + "default": false + }, + "optionalLoadTestConfig": { + "$ref": "#/definitions/OptionalLoadTestConfig", + "description": "Configuration for quick load test" + }, + "regionalLoadTestConfig": { + "type": "array", + "description": "Region distribution configuration for the load test.", + "items": { + "$ref": "#/definitions/RegionalConfiguration" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricAvailability": { + "type": "object", + "description": "Metric availability specifies the time grain (aggregation interval or frequency)", + "properties": { + "timeGrain": { + "$ref": "#/definitions/TimeGrain", + "description": "The time grain specifies the aggregation interval for the metric. Expressed as\na duration 'PT1M', 'PT1H', etc." + } + } + }, + "MetricDefinition": { + "type": "object", + "description": "Metric definition", + "properties": { + "dimensions": { + "type": "array", + "description": "List of dimensions", + "items": { + "$ref": "#/definitions/NameAndDesc" + }, + "x-ms-identifiers": [] + }, + "description": { + "type": "string", + "description": "The metric description" + }, + "name": { + "type": "string", + "description": "The metric name" + }, + "namespace": { + "type": "string", + "description": "The namespace the metric belongs to." + }, + "primaryAggregationType": { + "$ref": "#/definitions/AggregationType", + "description": "The primary aggregation type value defining how to use the values for display." + }, + "supportedAggregationTypes": { + "type": "array", + "description": "The collection of what all aggregation types are supported.", + "items": { + "type": "string" + } + }, + "unit": { + "$ref": "#/definitions/MetricUnit", + "description": "The unit of the metric." + }, + "metricAvailabilities": { + "type": "array", + "description": "Metric availability specifies the time grain (aggregation interval or\nfrequency).", + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricDefinitionCollection": { + "type": "object", + "description": "Represents collection of metric definitions.", + "properties": { + "value": { + "type": "array", + "description": "the values for the metric definitions.", + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MetricNamespace": { + "type": "object", + "description": "Metric namespace class specifies the metadata for a metric namespace.", + "properties": { + "description": { + "type": "string", + "description": "The namespace description." + }, + "name": { + "type": "string", + "description": "The metric namespace name." + } + } + }, + "MetricNamespaceCollection": { + "type": "object", + "description": "Represents collection of metric namespaces.", + "properties": { + "value": { + "type": "array", + "description": "The values for the metric namespaces.", + "items": { + "$ref": "#/definitions/MetricNamespace" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ] + }, + "MetricRequestPayload": { + "type": "object", + "description": "Filters to fetch the set of metric.", + "properties": { + "filters": { + "type": "array", + "description": "Get metrics for specific dimension values. Example: Metric contains dimension\nlike SamplerName, Error. To retrieve all the time series data where SamplerName\nis equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be\n{\"SamplerName\", [\"HTTPRequest1\", \"HTTPRequest2\"}", + "items": { + "$ref": "#/definitions/DimensionFilter" + }, + "x-ms-identifiers": [] + } + } + }, + "MetricUnit": { + "type": "string", + "description": "Metric unit.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "No unit specified." + }, + { + "name": "Percent", + "value": "Percent", + "description": "Percentage." + }, + { + "name": "Count", + "value": "Count", + "description": "Value count." + }, + { + "name": "Seconds", + "value": "Seconds", + "description": "Seconds." + }, + { + "name": "Milliseconds", + "value": "Milliseconds", + "description": "Milliseconds" + }, + { + "name": "Bytes", + "value": "Bytes", + "description": "Bytes" + }, + { + "name": "BytesPerSecond", + "value": "BytesPerSecond", + "description": "Bytes per second" + }, + { + "name": "CountPerSecond", + "value": "CountPerSecond", + "description": "Count per second" + } + ] + } + }, + "MetricValue": { + "type": "object", + "description": "Represents a metric value.", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the metric value in RFC 3339 format." + }, + "value": { + "type": "number", + "format": "double", + "description": "The metric value." + } + } + }, + "Metrics": { + "type": "object", + "description": "The response to a metrics query.", + "properties": { + "value": { + "type": "array", + "description": "The TimeSeriesElement items on this page", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MonthlyRecurrenceByDates": { + "type": "object", + "description": "Recurrence model when frequency is set as MonthlyByDates.", + "properties": { + "datesInMonth": { + "type": "array", + "description": "Recurrence set to repeat on the specified dates of the month. Value of dates can be 1 to 31 and -1. -1 represents the last day of the month.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of months between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "MonthlyByDates" + }, + "MonthlyRecurrenceByDatesCreateOrUpdate": { + "type": "object", + "description": "Recurrence model when frequency is set as MonthlyByDates.", + "properties": { + "datesInMonth": { + "type": "array", + "description": "Recurrence set to repeat on the specified dates of the month. Value of dates can be 1 to 31 and -1. -1 represents the last day of the month.", + "items": { + "type": "integer", + "format": "int32" + } + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of months between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "MonthlyByDates" + }, + "MonthlyRecurrenceByWeekDays": { + "type": "object", + "description": "Recurrence model when frequency is set as MonthlyByDays .", + "properties": { + "weekDaysInMonth": { + "type": "array", + "description": "Specific days of the week when the recurrence should repeat.", + "items": { + "$ref": "#/definitions/WeekDays" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the week in a month at which the recurrence should repeat. For example, if the index is '2', weekDay is 'Monday', interval is 3 and frequency is 'Month', the recurrence will run every second Monday of the month and repeat every 3 months. Value of index can be 1 to 5.", + "minimum": 1, + "maximum": 5 + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of months between each recurrence." + } + }, + "required": [ + "index", + "interval" + ], + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "MonthlyByDays" + }, + "MonthlyRecurrenceByWeekDaysCreateOrUpdate": { + "type": "object", + "description": "Recurrence model when frequency is set as MonthlyByDays .", + "properties": { + "weekDaysInMonth": { + "type": "array", + "description": "Specific days of the week when the recurrence should repeat.", + "items": { + "$ref": "#/definitions/WeekDays" + } + }, + "index": { + "type": "integer", + "format": "int32", + "description": "Index of the week in a month at which the recurrence should repeat. For example, if the index is '2', weekDay is 'Monday', interval is 3 and frequency is 'Month', the recurrence will run every second Monday of the month and repeat every 3 months. Value of index can be 1 to 5.", + "minimum": 1, + "maximum": 5 + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of months between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "MonthlyByDays" + }, + "NameAndDesc": { + "type": "object", + "description": "The name and description", + "properties": { + "description": { + "type": "string", + "description": "The description" + }, + "name": { + "type": "string", + "description": "The name" + } + } + }, + "OptionalLoadTestConfig": { + "type": "object", + "description": "Configuration for quick load test", + "properties": { + "endpointUrl": { + "type": "string", + "description": "Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login" + }, + "requestsPerSecond": { + "type": "integer", + "format": "int32", + "description": "Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it." + }, + "maxResponseTimeInMs": { + "type": "integer", + "format": "int32", + "description": "Maximum response time in milliseconds of the API/endpoint." + }, + "virtualUsers": { + "type": "integer", + "format": "int32", + "description": "No of concurrent virtual users." + }, + "rampUpTime": { + "type": "integer", + "format": "int32", + "description": "Ramp up time in seconds." + }, + "duration": { + "type": "integer", + "format": "int32", + "description": "Test run duration in seconds." + } + } + }, + "PFAgFunc": { + "type": "string", + "description": "Aggregation functions for pass/fail criteria.", + "enum": [ + "count", + "percentage", + "avg", + "p50", + "p75", + "p90", + "p95", + "p96", + "p97", + "p98", + "p99", + "p99.9", + "p99.99", + "min", + "max" + ], + "x-ms-enum": { + "name": "PFAgFunc", + "modelAsString": true, + "values": [ + { + "name": "count", + "value": "count", + "description": "Criteria applies for count value." + }, + { + "name": "percentage", + "value": "percentage", + "description": "Criteria applies for given percentage value." + }, + { + "name": "avg", + "value": "avg", + "description": "Criteria applies for avg value." + }, + { + "name": "p50", + "value": "p50", + "description": "Criteria applies for 50th percentile value." + }, + { + "name": "p75", + "value": "p75", + "description": "Criteria applies for 75th percentile value." + }, + { + "name": "p90", + "value": "p90", + "description": "Criteria applies for 90th percentile value." + }, + { + "name": "p95", + "value": "p95", + "description": "Criteria applies for 95th percentile value." + }, + { + "name": "p96", + "value": "p96", + "description": "Criteria applies for 96th percentile value." + }, + { + "name": "p97", + "value": "p97", + "description": "Criteria applies for 97th percentile value." + }, + { + "name": "p98", + "value": "p98", + "description": "Criteria applies for 98th percentile value." + }, + { + "name": "p99", + "value": "p99", + "description": "Criteria applies for 99th percentile value." + }, + { + "name": "p99.9", + "value": "p99.9", + "description": "Criteria applies for 99.9th percentile value." + }, + { + "name": "p99.99", + "value": "p99.99", + "description": "Criteria applies for 99.99th percentile value." + }, + { + "name": "min", + "value": "min", + "description": "Criteria applies for minimum value." + }, + { + "name": "max", + "value": "max", + "description": "Criteria applies for maximum value." + } + ] + } + }, + "PFMetrics": { + "type": "string", + "description": "Metrics for pass/fail criteria.", + "enum": [ + "response_time_ms", + "latency", + "error", + "requests", + "requests_per_sec" + ], + "x-ms-enum": { + "name": "PFMetrics", + "modelAsString": true, + "values": [ + { + "name": "response_time_ms", + "value": "response_time_ms", + "description": "Pass fail criteria for response time metric in milliseconds." + }, + { + "name": "latency", + "value": "latency", + "description": "Pass fail criteria for latency metric in milliseconds." + }, + { + "name": "error", + "value": "error", + "description": "Pass fail criteria for error metric." + }, + { + "name": "requests", + "value": "requests", + "description": "Pass fail criteria for total requests." + }, + { + "name": "requests_per_sec", + "value": "requests_per_sec", + "description": "Pass fail criteria for request per second." + } + ] + } + }, + "PFResult": { + "type": "string", + "description": "Pass/fail criteria result.", + "enum": [ + "passed", + "undetermined", + "failed" + ], + "x-ms-enum": { + "name": "PFResult", + "modelAsString": true, + "values": [ + { + "name": "passed", + "value": "passed", + "description": "Given pass fail criteria metric has passed." + }, + { + "name": "undetermined", + "value": "undetermined", + "description": "Given pass fail criteria metric couldn't determine." + }, + { + "name": "failed", + "value": "failed", + "description": "Given pass fail criteria metric has failed." + } + ] + } + }, + "PFTestResult": { + "type": "string", + "description": "Test result based on pass/fail criteria.", + "enum": [ + "PASSED", + "NOT_APPLICABLE", + "FAILED" + ], + "x-ms-enum": { + "name": "PFTestResult", + "modelAsString": true, + "values": [ + { + "name": "PASSED", + "value": "PASSED", + "description": "Pass/fail criteria has passed." + }, + { + "name": "NOT_APPLICABLE", + "value": "NOT_APPLICABLE", + "description": "Pass/fail criteria is not applicable." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Pass/fail criteria has failed." + } + ] + } + }, + "PagedTest": { + "type": "object", + "description": "Paged collection of Test items", + "properties": { + "value": { + "type": "array", + "description": "The Test items on this page", + "items": { + "$ref": "#/definitions/Test" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestFileInfo": { + "type": "object", + "description": "Paged collection of TestFileInfo items", + "properties": { + "value": { + "type": "array", + "description": "The TestFileInfo items on this page", + "items": { + "$ref": "#/definitions/TestFileInfo" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestProfile": { + "type": "object", + "description": "Paged collection of TestProfile items", + "properties": { + "value": { + "type": "array", + "description": "The TestProfile items on this page", + "items": { + "$ref": "#/definitions/TestProfile" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestProfileRun": { + "type": "object", + "description": "Paged collection of TestProfileRun items", + "properties": { + "value": { + "type": "array", + "description": "The TestProfileRun items on this page", + "items": { + "$ref": "#/definitions/TestProfileRun" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTestRun": { + "type": "object", + "description": "Paged collection of TestRun items", + "properties": { + "value": { + "type": "array", + "description": "The TestRun items on this page", + "items": { + "$ref": "#/definitions/TestRun" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PagedTrigger": { + "type": "object", + "description": "Paged collection of Trigger items", + "properties": { + "value": { + "type": "array", + "description": "The Trigger items on this page", + "items": { + "$ref": "#/definitions/Trigger" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PassFailCriteria": { + "type": "object", + "description": "Pass fail criteria for a test.", + "properties": { + "passFailMetrics": { + "type": "object", + "description": "Map of id and pass fail metrics { id : pass fail metrics }.", + "additionalProperties": { + "$ref": "#/definitions/PassFailMetric" + } + }, + "passFailServerMetrics": { + "type": "object", + "description": "Map of id and pass fail server metrics { id : pass fail metrics }.", + "additionalProperties": { + "$ref": "#/definitions/PassFailServerMetric" + } + } + } + }, + "PassFailMetric": { + "type": "object", + "description": "Pass fail metric", + "properties": { + "clientMetric": { + "$ref": "#/definitions/PFMetrics", + "description": "The client metric on which the criteria should be applied." + }, + "aggregate": { + "$ref": "#/definitions/PFAgFunc", + "description": "The aggregation function to be applied on the client metric. Allowed functions\n- ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’,\n‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec,\n‘count’ - for requests" + }, + "condition": { + "type": "string", + "description": "The comparison operator. Supported types ‘>’, ‘<’ " + }, + "requestName": { + "type": "string", + "description": "Request name for which the Pass fail criteria has to be applied " + }, + "value": { + "type": "number", + "format": "double", + "description": "The value to compare with the client metric. Allowed values - ‘error : [0.0 ,\n100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms." + }, + "action": { + "type": "string", + "description": "Action taken after the threshold is met. Default is ‘continue’.", + "default": "continue", + "enum": [ + "continue", + "stop" + ], + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true, + "values": [ + { + "name": "continue", + "value": "continue", + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." + }, + { + "name": "stop", + "value": "stop", + "description": "Test run will stop if pass fail criteria metric is not passed." + } + ] + } + }, + "actualValue": { + "type": "number", + "format": "double", + "description": "The actual value of the client metric for the test run.", + "readOnly": true + }, + "result": { + "$ref": "#/definitions/PFResult", + "description": "Outcome of the test run.", + "readOnly": true + } + } + }, + "PassFailServerMetric": { + "type": "object", + "description": "Pass fail server metric", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the resource emitting the metric." + }, + "metricNamespace": { + "type": "string", + "description": "The server metric namespace." + }, + "metricName": { + "type": "string", + "description": "The server metric name." + }, + "aggregation": { + "type": "string", + "description": "Aggregation Type" + }, + "condition": { + "type": "string", + "description": "The comparison operator. Supported types ‘>’, ‘<’ " + }, + "value": { + "type": "number", + "format": "double", + "description": "The value to compare with the server metric." + }, + "action": { + "type": "string", + "description": "Action taken after the threshold is met. Default is ‘continue’.", + "default": "continue", + "enum": [ + "continue", + "stop" + ], + "x-ms-enum": { + "name": "PFAction", + "modelAsString": true, + "values": [ + { + "name": "continue", + "value": "continue", + "description": "Test will continue to run even if pass fail metric criteria metric gets failed." + }, + { + "name": "stop", + "value": "stop", + "description": "Test run will stop if pass fail criteria metric is not passed." + } + ] + } + }, + "actualValue": { + "type": "number", + "format": "double", + "description": "The actual value of the server metric ", + "readOnly": true + }, + "result": { + "$ref": "#/definitions/PFResult", + "description": "Outcome of the test run.", + "readOnly": true + } + }, + "required": [ + "resourceId", + "metricNamespace", + "metricName", + "aggregation", + "condition", + "value" + ] + }, + "RecommendationCategory": { + "type": "string", + "description": "Category of Recommendation.", + "enum": [ + "ThroughputOptimized", + "CostOptimized" + ], + "x-ms-enum": { + "name": "RecommendationCategory", + "modelAsString": true, + "values": [ + { + "name": "ThroughputOptimized", + "value": "ThroughputOptimized", + "description": "The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app." + }, + { + "name": "CostOptimized", + "value": "CostOptimized", + "description": "The recommendation for this category optimizes the cost of the app." + } + ] + } + }, + "Recurrence": { + "type": "object", + "description": "Recurrence model.", + "properties": { + "frequency": { + "$ref": "#/definitions/Frequency", + "description": "Frequency of the recurrence." + }, + "recurrenceEnd": { + "$ref": "#/definitions/RecurrenceEnd", + "description": "Recurrence end model. You can specify the end either by providing a numberOfOccurrences (which will end the recurrence after the specified number of occurrences) or by providing an endDateTime (which will end the recurrence after the specified date). If neither value is provided, the recurrence will continue until it is manually ended. However, if both values are provided, an error will be thrown." + } + }, + "discriminator": "frequency", + "required": [ + "frequency" + ] + }, + "RecurrenceCreateOrUpdate": { + "type": "object", + "description": "Recurrence model.", + "properties": { + "frequency": { + "$ref": "#/definitions/Frequency", + "description": "Frequency of the recurrence." + }, + "recurrenceEnd": { + "$ref": "#/definitions/RecurrenceEnd", + "description": "Recurrence end model. You can specify the end either by providing a numberOfOccurrences (which will end the recurrence after the specified number of occurrences) or by providing an endDateTime (which will end the recurrence after the specified date). If neither value is provided, the recurrence will continue until it is manually ended. However, if both values are provided, an error will be thrown." + } + }, + "discriminator": "frequency", + "required": [ + "frequency" + ] + }, + "RecurrenceEnd": { + "type": "object", + "description": "Recurrence end model. Either provide numberOfOccurrences if you want recurrence to end after a specified number of occurrences or provide endDate if you want recurrence to end after a specified end date. If both values are provided, a validation error will be thrown indicating that only one field should be provided. If neither value is provided, the recurrence will end when manually ended.", + "properties": { + "numberOfOccurrences": { + "type": "integer", + "format": "int32", + "description": "Number of occurrences after which the recurrence will end." + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The date after which the recurrence will end. (RFC 3339 literal format)" + } + } + }, + "RecurrenceStatus": { + "type": "object", + "description": "Actual state of the recurrence for the trigger.", + "properties": { + "remainingOccurrences": { + "type": "integer", + "format": "int32", + "description": "The number of occurrences remaining for the trigger. Null if recurrence end has end date instead of number of occurrences." + }, + "nextScheduledDateTimes": { + "type": "array", + "description": "The next three execution times of the trigger. (RFC 3339 literal format)", + "items": { + "type": "string", + "format": "date-time" + } + } + } + }, + "RecurrenceWithCron": { + "type": "object", + "description": "Recurrence is set based on cron expression.", + "properties": { + "cronExpression": { + "type": "string", + "description": "Cron expression for the recurrence." + } + }, + "required": [ + "cronExpression" + ], + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "Cron" + }, + "RecurrenceWithCronCreateOrUpdate": { + "type": "object", + "description": "Recurrence is set based on cron expression.", + "properties": { + "cronExpression": { + "type": "string", + "description": "Cron expression for the recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "Cron" + }, + "RegionalConfiguration": { + "type": "object", + "description": "Region distribution configuration for the load test.", + "properties": { + "engineInstances": { + "type": "integer", + "format": "int32", + "description": " The number of engine instances to execute load test in specified region. Supported values are in range of 1-400." + }, + "region": { + "type": "string", + "description": "Azure region name.\nThe region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as \"eastus\".\nThe region name must match one of the strings in the \"Name\" column returned from running the \"az account list-locations -o table\" Azure CLI command." + } + }, + "required": [ + "engineInstances", + "region" + ] + }, + "RequestDataLevel": { + "type": "string", + "description": "Request data collection level for test run", + "enum": [ + "NONE", + "ERRORS" + ], + "x-ms-enum": { + "name": "RequestDataLevel", + "modelAsString": true, + "values": [ + { + "name": "NONE", + "value": "NONE", + "description": "No request data will be collected" + }, + { + "name": "ERRORS", + "value": "ERRORS", + "description": "Request data will be collected in case of failed requests" + } + ] + } + }, + "ResourceKind": { + "type": "string", + "description": "Kind of the resource on which test profile is created.", + "enum": [ + "FunctionsFlexConsumption" + ], + "x-ms-enum": { + "name": "ResourceKind", + "modelAsString": true, + "values": [ + { + "name": "FunctionsFlexConsumption", + "value": "FunctionsFlexConsumption", + "description": "Resource is a Azure FunctionApp on Flex Consumption Plan." + } + ] + } + }, + "ResourceMetric": { + "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", + "properties": { + "id": { + "type": "string", + "description": "Unique name for metric.", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "Azure resource id." + }, + "metricNamespace": { + "type": "string", + "description": "Metric name space." + }, + "displayDescription": { + "type": "string", + "description": "Metric description." + }, + "name": { + "type": "string", + "description": "The invariant value of metric name" + }, + "aggregation": { + "type": "string", + "description": "Metric aggregation." + }, + "unit": { + "type": "string", + "description": "Metric unit." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type." + } + }, + "required": [ + "resourceId", + "metricNamespace", + "name", + "aggregation", + "resourceType" + ] + }, + "ResourceMetricUpdate": { + "type": "object", + "description": "Associated metric definition for particular metrics of the azure resource (\nRefer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).", + "properties": { + "resourceId": { + "type": "string", + "description": "Azure resource id." + }, + "metricNamespace": { + "type": "string", + "description": "Metric name space." + }, + "displayDescription": { + "type": "string", + "description": "Metric description." + }, + "name": { + "type": "string", + "description": "The invariant value of metric name" + }, + "aggregation": { + "type": "string", + "description": "Metric aggregation." + }, + "unit": { + "type": "string", + "description": "Metric unit." + }, + "resourceType": { + "type": "string", + "description": "Azure resource type." + } + } + }, + "ScheduleTestsTrigger": { + "type": "object", + "description": "ScheduleTestsTrigger model.", + "properties": { + "testIds": { + "type": "array", + "description": "The test id of test to be triggered by this schedule trigger. Currently only one test is supported for a trigger.", + "items": { + "type": "string" + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start date time of the trigger in UTC timezone. (RFC 3339 literal format)" + }, + "recurrenceStatus": { + "$ref": "#/definitions/RecurrenceStatus", + "readOnly": true + }, + "recurrence": { + "$ref": "#/definitions/Recurrence", + "description": "Recurrence details of the trigger. Null if schedule is not recurring." + } + }, + "required": [ + "testIds" + ], + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "x-ms-discriminator-value": "ScheduleTestsTrigger" + }, + "ScheduleTestsTriggerCreateOrUpdate": { + "type": "object", + "description": "ScheduleTestsTrigger model.", + "properties": { + "testIds": { + "type": "array", + "description": "The test id of test to be triggered by this schedule trigger. Currently only one test is supported for a trigger.", + "items": { + "type": "string" + } + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "Start date time of the trigger in UTC timezone. (RFC 3339 literal format)" + }, + "recurrence": { + "$ref": "#/definitions/RecurrenceCreateOrUpdate", + "description": "Recurrence details of the trigger. Null if schedule is not recurring." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TriggerCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "ScheduleTestsTrigger" + }, + "Secret": { + "type": "object", + "description": "Secret", + "properties": { + "value": { + "type": "string", + "description": "The value of the secret for the respective type" + }, + "type": { + "$ref": "#/definitions/SecretType", + "description": "Type of secret" + } + } + }, + "SecretType": { + "type": "string", + "description": "Types of secrets supported.", + "enum": [ + "AKV_SECRET_URI", + "SECRET_VALUE" + ], + "x-ms-enum": { + "name": "SecretType", + "modelAsString": true, + "values": [ + { + "name": "AKV_SECRET_URI", + "value": "AKV_SECRET_URI", + "description": "If the secret is stored in an Azure Key Vault." + }, + { + "name": "SECRET_VALUE", + "value": "SECRET_VALUE", + "description": "If the secret value provided as plain text." + } + ] + } + }, + "StateDetails": { + "type": "object", + "description": "State details of the trigger.", + "properties": { + "message": { + "type": "string", + "description": "The error message if the trigger is in disabled state." + } + } + }, + "Status": { + "type": "string", + "description": "Test run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "PROVISIONING", + "PROVISIONED", + "CONFIGURING", + "CONFIGURED", + "EXECUTING", + "EXECUTED", + "DEPROVISIONING", + "DEPROVISIONED", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED", + "VALIDATION_SUCCESS", + "VALIDATION_FAILURE" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "ACCEPTED", + "value": "ACCEPTED", + "description": "Test run request is accepted." + }, + { + "name": "NOTSTARTED", + "value": "NOTSTARTED", + "description": "Test run is not yet started." + }, + { + "name": "PROVISIONING", + "value": "PROVISIONING", + "description": "Test run is provisioning." + }, + { + "name": "PROVISIONED", + "value": "PROVISIONED", + "description": "Test run is provisioned." + }, + { + "name": "CONFIGURING", + "value": "CONFIGURING", + "description": "Test run is getting configured." + }, + { + "name": "CONFIGURED", + "value": "CONFIGURED", + "description": "Test run configuration is done." + }, + { + "name": "EXECUTING", + "value": "EXECUTING", + "description": "Test run has started executing." + }, + { + "name": "EXECUTED", + "value": "EXECUTED", + "description": "Test run execution is completed." + }, + { + "name": "DEPROVISIONING", + "value": "DEPROVISIONING", + "description": "Test run is getting deprovisioned." + }, + { + "name": "DEPROVISIONED", + "value": "DEPROVISIONED", + "description": "Test run is deprovisioned." + }, + { + "name": "DONE", + "value": "DONE", + "description": "Test run is completed." + }, + { + "name": "CANCELLING", + "value": "CANCELLING", + "description": "Test run is being cancelled." + }, + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "Test run request is cancelled." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Test run request is failed." + }, + { + "name": "VALIDATION_SUCCESS", + "value": "VALIDATION_SUCCESS", + "description": "Test run JMX file is validated." + }, + { + "name": "VALIDATION_FAILURE", + "value": "VALIDATION_FAILURE", + "description": "Test run JMX file validation is failed." + } + ] + } + }, + "TargetResourceConfigurations": { + "type": "object", + "description": "Configurations of a target resource. This varies with the kind of resource.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourceKind", + "description": "Kind of the resource for which the configurations apply.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "TargetResourceConfigurationsCreateOrUpdate": { + "type": "object", + "description": "Configurations of a target resource. This varies with the kind of resource.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourceKind", + "description": "Kind of the resource for which the configurations apply.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "Test": { + "type": "object", + "description": "Load test model.", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of <name,value> pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "baselineTestRunId": { + "type": "string", + "description": "Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs" + }, + "inputArtifacts": { + "$ref": "#/definitions/TestInputArtifacts", + "description": "The input artifacts for the test.", + "readOnly": true + }, + "testId": { + "type": "string", + "description": "Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The test description.", + "maxLength": 100 + }, + "displayName": { + "type": "string", + "description": "Display name of a test.", + "minLength": 2, + "maxLength": 50 + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run." + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Kind of test." + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access" + }, + "keyvaultReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the Key vault." + }, + "keyvaultReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the Key vault." + }, + "metricsReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the metrics.", + "default": "SystemAssigned", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "System-assigned managed identity." + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "User-assigned managed identity." + } + ] + } + }, + "metricsReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the metrics." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testId" + ] + }, + "TestAppComponents": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testId": { + "type": "string", + "description": "Test identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "components" + ] + }, + "TestAppComponentsUpdate": { + "type": "object", + "description": "Test app components", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestCreateOrUpdate": { + "type": "object", + "description": "Load test model.", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata." + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of <name,value> pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "baselineTestRunId": { + "type": "string", + "description": "Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs" + }, + "description": { + "type": "string", + "description": "The test description.", + "maxLength": 100 + }, + "displayName": { + "type": "string", + "description": "Display name of a test.", + "minLength": 2, + "maxLength": 50 + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run." + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Kind of test." + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access" + }, + "keyvaultReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the Key vault." + }, + "keyvaultReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the Key vault." + }, + "metricsReferenceIdentityType": { + "type": "string", + "description": "Type of the managed identity referencing the metrics.", + "default": "SystemAssigned", + "enum": [ + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true, + "values": [ + { + "name": "SystemAssigned", + "value": "SystemAssigned", + "description": "System-assigned managed identity." + }, + { + "name": "UserAssigned", + "value": "UserAssigned", + "description": "User-assigned managed identity." + } + ] + } + }, + "metricsReferenceIdentityId": { + "type": "string", + "description": "Resource Id of the managed identity referencing the metrics." + } + } + }, + "TestFileInfo": { + "type": "object", + "description": "Test file info.", + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file." + }, + "url": { + "type": "string", + "format": "uri", + "description": "File URL.", + "readOnly": true + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", + "readOnly": true + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", + "readOnly": true + }, + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", + "readOnly": true + }, + "validationFailureDetails": { + "type": "string", + "description": "Validation failure error details", + "readOnly": true + } + }, + "required": [ + "fileName" + ] + }, + "TestInputArtifacts": { + "type": "object", + "description": "The input artifacts for the test.", + "properties": { + "configFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "testScriptFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "userPropFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "inputArtifactsZipFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "File info" + }, + "urlTestConfigFileInfo": { + "$ref": "#/definitions/TestFileInfo", + "description": "The config json file for url based test" + }, + "additionalFileInfo": { + "type": "array", + "description": "Additional supported files for the test run", + "items": { + "$ref": "#/definitions/TestFileInfo" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "TestKind": { + "type": "string", + "description": "Test kind", + "enum": [ + "URL", + "JMX", + "Locust" + ], + "x-ms-enum": { + "name": "TestKind", + "modelAsString": true, + "values": [ + { + "name": "URL", + "value": "URL", + "description": "URL Test" + }, + { + "name": "JMX", + "value": "JMX", + "description": "JMX Test" + }, + { + "name": "Locust", + "value": "Locust", + "description": "Locust Test" + } + ] + } + }, + "TestProfile": { + "type": "object", + "title": "Test Profile Model.", + "description": "The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource.", + "properties": { + "testProfileId": { + "type": "string", + "description": "Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of the test profile.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description for the test profile.", + "maxLength": 100 + }, + "testId": { + "type": "string", + "description": "Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurations", + "description": "Configurations of the target resource on which testing would be done." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testProfileId" + ] + }, + "TestProfileCreateOrUpdate": { + "type": "object", + "title": "Test Profile Model.", + "description": "The Test Profile Model. A Test Profile resource enables you to set up a test profile which contains various configurations for a supported resource type and a load test to execute on that resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name of the test profile.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "Description for the test profile.", + "maxLength": 100 + }, + "testId": { + "type": "string", + "description": "Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurationsCreateOrUpdate", + "description": "Configurations of the target resource on which testing would be done." + } + } + }, + "TestProfileRun": { + "type": "object", + "title": "Test Profile Run model.", + "description": "The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource.", + "properties": { + "testProfileRunId": { + "type": "string", + "description": "Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name for the test profile run.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test profile run description", + "maxLength": 100 + }, + "testProfileId": { + "type": "string", + "description": "Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "targetResourceId": { + "type": "string", + "description": "Target resource ID on which the test profile run is created", + "readOnly": true + }, + "targetResourceConfigurations": { + "$ref": "#/definitions/TargetResourceConfigurations", + "description": "Configurations of the target resource on which the test profile ran.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/TestProfileRunStatus", + "description": "The test profile run status.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run.", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The test profile run start DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The test profile run end DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "durationInSeconds": { + "type": "integer", + "format": "int64", + "description": "Test profile run duration in seconds.", + "readOnly": true + }, + "testRunDetails": { + "type": "object", + "description": "Details of the test runs ran as part of the test profile run.\nKey is the testRunId of the corresponding testRun.", + "additionalProperties": { + "$ref": "#/definitions/TestRunDetail" + }, + "readOnly": true + }, + "recommendations": { + "type": "array", + "description": "Recommendations provided based on a successful test profile run.", + "items": { + "$ref": "#/definitions/TestProfileRunRecommendation" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testProfileRunId" + ] + }, + "TestProfileRunCreateOrUpdate": { + "type": "object", + "title": "Test Profile Run model.", + "description": "The Test Profile Run Model. Test Profile Run resource enables you to instantiate an already created test profile and run load tests to get recommendations on the optimal configuration for the target resource.", + "properties": { + "displayName": { + "type": "string", + "description": "Display name for the test profile run.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test profile run description", + "maxLength": 100 + }, + "testProfileId": { + "type": "string", + "description": "Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "TestProfileRunRecommendation": { + "type": "object", + "description": "A recommendation object that provides a list of configuration that optimizes its category.", + "properties": { + "category": { + "$ref": "#/definitions/RecommendationCategory", + "description": "Category of the recommendation." + }, + "configurations": { + "type": "array", + "description": "List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations.", + "items": { + "type": "string" + } + } + }, + "required": [ + "category" + ] + }, + "TestProfileRunStatus": { + "type": "string", + "description": "Test profile run status.", + "enum": [ + "ACCEPTED", + "NOTSTARTED", + "EXECUTING", + "DONE", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "x-ms-enum": { + "name": "TestProfileRunStatus", + "modelAsString": true, + "values": [ + { + "name": "ACCEPTED", + "value": "ACCEPTED", + "description": "Test profile run request is accepted." + }, + { + "name": "NOTSTARTED", + "value": "NOTSTARTED", + "description": "Test profile run is not yet started." + }, + { + "name": "EXECUTING", + "value": "EXECUTING", + "description": "Test profile run has started executing." + }, + { + "name": "DONE", + "value": "DONE", + "description": "Test profile run has completed successfully." + }, + { + "name": "CANCELLING", + "value": "CANCELLING", + "description": "Test profile run is being cancelled." + }, + { + "name": "CANCELLED", + "value": "CANCELLED", + "description": "Test profile run is cancelled." + }, + { + "name": "FAILED", + "value": "FAILED", + "description": "Test profile run has failed." + } + ] + } + }, + "TestRun": { + "type": "object", + "description": "Load test run model", + "properties": { + "testRunId": { + "type": "string", + "description": "Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of <name,value> pairs.", + "additionalProperties": { + "type": "string" + } + }, + "errorDetails": { + "type": "array", + "description": "Error details if there is any failure in load test run", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "testRunStatistics": { + "type": "object", + "description": "Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run.\nThe sampler name is the same as the name mentioned in the test script.\nSampler name \"Total\" represents the aggregated statistics of all the samplers.", + "additionalProperties": { + "$ref": "#/definitions/TestRunStatistics" + }, + "readOnly": true + }, + "regionalStatistics": { + "type": "object", + "description": "Regional statistics. Key is the Azure region name and value is the test run statistics.\nThe region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as \"eastus\".\nThe region name must match one of the strings in the \"Name\" column returned from running the \"az account list-locations -o table\" Azure CLI command.", + "additionalProperties": { + "$ref": "#/definitions/TestRunStatistics" + }, + "readOnly": true + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "testArtifacts": { + "$ref": "#/definitions/TestRunArtifacts", + "description": "Collection of test run artifacts", + "readOnly": true + }, + "testResult": { + "$ref": "#/definitions/PFTestResult", + "description": "Test result for pass/Fail criteria used during the test run.", + "readOnly": true + }, + "virtualUsers": { + "type": "integer", + "format": "int32", + "description": "Number of virtual users, for which test has been run.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display name of a testRun.", + "minLength": 2, + "maxLength": 50 + }, + "testId": { + "type": "string", + "description": "Associated test Id.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test run description.", + "maxLength": 100 + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The test run status.", + "readOnly": true + }, + "startDateTime": { + "type": "string", + "format": "date-time", + "description": "The test run start DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "endDateTime": { + "type": "string", + "format": "date-time", + "description": "The test run end DateTime(RFC 3339 literal format).", + "readOnly": true + }, + "executedDateTime": { + "type": "string", + "format": "date-time", + "description": "Test run initiated time.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Portal url.", + "readOnly": true + }, + "duration": { + "type": "integer", + "format": "int64", + "description": "Test run duration in milliseconds.", + "readOnly": true + }, + "virtualUserHours": { + "type": "number", + "format": "double", + "description": "Virtual user hours consumed by the test run.", + "readOnly": true + }, + "subnetId": { + "type": "string", + "description": "Subnet ID on which the load test instances should run.", + "readOnly": true + }, + "kind": { + "$ref": "#/definitions/TestKind", + "description": "Type of test.", + "readOnly": true + }, + "requestDataLevel": { + "$ref": "#/definitions/RequestDataLevel", + "description": "Request data collection level for test run" + }, + "debugLogsEnabled": { + "type": "boolean", + "description": "Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise" + }, + "publicIPDisabled": { + "type": "boolean", + "description": "Inject load test engines without deploying public IP for outbound access", + "readOnly": true + }, + "createdByType": { + "$ref": "#/definitions/CreateByTypes", + "description": "The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc)." + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "testRunId" + ] + }, + "TestRunAppComponents": { + "type": "object", + "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponent" + } + }, + "testRunId": { + "type": "string", + "description": "Test run identifier", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "components" + ] + }, + "TestRunAppComponentsUpdate": { + "type": "object", + "description": "Test run app component", + "properties": { + "components": { + "type": "object", + "description": "Azure resource collection { resource id (fully qualified resource Id e.g\nsubscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName})\n: resource object } ", + "additionalProperties": { + "$ref": "#/definitions/AppComponentUpdate" + } + } + } + }, + "TestRunArtifacts": { + "type": "object", + "description": "Collection of test run artifacts", + "properties": { + "inputArtifacts": { + "$ref": "#/definitions/TestRunInputArtifacts", + "description": "The input artifacts for the test run.", + "readOnly": true + }, + "outputArtifacts": { + "$ref": "#/definitions/TestRunOutputArtifacts", + "description": "The output artifacts for the test run." + } + } + }, + "TestRunCreateOrUpdate": { + "type": "object", + "description": "Load test run model", + "properties": { + "passFailCriteria": { + "$ref": "#/definitions/PassFailCriteria", + "description": "Pass fail criteria for a test." + }, + "autoStopCriteria": { + "$ref": "#/definitions/AutoStopCriteria", + "description": "Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window." + }, + "secrets": { + "type": "object", + "description": "Secrets can be stored in an Azure Key Vault or any other secret store. If the\nsecret is stored in an Azure Key Vault, the value should be the secret\nidentifier and the type should be AKV_SECRET_URI. If the secret is stored\nelsewhere, the secret value should be provided directly and the type should be\nSECRET_VALUE.", + "additionalProperties": { + "$ref": "#/definitions/Secret" + } + }, + "certificate": { + "$ref": "#/definitions/CertificateMetadata", + "description": "Certificates metadata" + }, + "environmentVariables": { + "type": "object", + "description": "Environment variables which are defined as a set of <name,value> pairs.", + "additionalProperties": { + "type": "string" + } + }, + "loadTestConfiguration": { + "$ref": "#/definitions/LoadTestConfiguration", + "description": "The load test configuration." + }, + "displayName": { + "type": "string", + "description": "Display name of a testRun.", + "minLength": 2, + "maxLength": 50 + }, + "testId": { + "type": "string", + "description": "Associated test Id.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The test run description.", + "maxLength": 100 + }, + "requestDataLevel": { + "$ref": "#/definitions/RequestDataLevel", + "description": "Request data collection level for test run" + }, + "debugLogsEnabled": { + "type": "boolean", + "description": "Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise" + }, + "createdByType": { + "$ref": "#/definitions/CreateByTypes", + "description": "The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc)." + } + } + }, + "TestRunDetail": { + "type": "object", + "description": "Details of a particular test run for a test profile run.", + "properties": { + "status": { + "$ref": "#/definitions/Status", + "description": "Status of the test run." + }, + "configurationId": { + "type": "string", + "description": "ID of the configuration on which the test ran." + }, + "properties": { + "type": "object", + "description": "Key value pair of extra properties associated with the test run.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "status", + "configurationId", + "properties" + ] + }, + "TestRunFileInfo": { + "type": "object", + "description": "Test run file info.", + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file." + }, + "url": { + "type": "string", + "format": "uri", + "description": "File URL.", + "readOnly": true + }, + "fileType": { + "$ref": "#/definitions/FileType", + "description": "File type", + "readOnly": true + }, + "expireDateTime": { + "type": "string", + "format": "date-time", + "description": "Expiry time of the file (RFC 3339 literal format)", + "readOnly": true + }, + "validationStatus": { + "$ref": "#/definitions/FileStatus", + "description": "Validation status of the file", + "readOnly": true + }, + "validationFailureDetails": { + "type": "string", + "description": "Validation failure error details", + "readOnly": true + } + }, + "required": [ + "fileName" + ] + }, + "TestRunInputArtifacts": { + "type": "object", + "description": "The input artifacts for the test run.", + "properties": { + "configFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "testScriptFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "userPropFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "inputArtifactsZipFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "urlTestConfigFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "The config json file for url based test" + }, + "additionalFileInfo": { + "type": "array", + "description": "Additional supported files for the test run", + "items": { + "$ref": "#/definitions/TestRunFileInfo" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "TestRunOutputArtifacts": { + "type": "object", + "description": "The output artifacts for the test run.", + "properties": { + "resultFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "logsFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "File info" + }, + "artifactsContainerInfo": { + "$ref": "#/definitions/ArtifactsContainerInfo", + "description": "The container for test run artifacts." + }, + "reportFileInfo": { + "$ref": "#/definitions/TestRunFileInfo", + "description": "The report file for the test run." + } + } + }, + "TestRunServerMetricConfig": { + "type": "object", + "description": "Test run server metrics configuration", + "properties": { + "testRunId": { + "type": "string", + "description": "Test run identifier", + "readOnly": true + }, + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetric" + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + } + }, + "TestRunStatistics": { + "type": "object", + "description": "Test run statistics.", + "properties": { + "transaction": { + "type": "string", + "description": "Transaction name.", + "readOnly": true + }, + "sampleCount": { + "type": "number", + "format": "double", + "description": "Sampler count.", + "readOnly": true + }, + "errorCount": { + "type": "number", + "format": "double", + "description": "Error count.", + "readOnly": true + }, + "errorPct": { + "type": "number", + "format": "double", + "description": "Error percentage.", + "readOnly": true + }, + "meanResTime": { + "type": "number", + "format": "double", + "description": "Mean response time.", + "readOnly": true + }, + "medianResTime": { + "type": "number", + "format": "double", + "description": "Median response time.", + "readOnly": true + }, + "maxResTime": { + "type": "number", + "format": "double", + "description": "Max response time.", + "readOnly": true + }, + "minResTime": { + "type": "number", + "format": "double", + "description": "Minimum response time.", + "readOnly": true + }, + "pct1ResTime": { + "type": "number", + "format": "double", + "description": "90 percentile response time.", + "readOnly": true + }, + "pct2ResTime": { + "type": "number", + "format": "double", + "description": "95 percentile response time.", + "readOnly": true + }, + "pct3ResTime": { + "type": "number", + "format": "double", + "description": "99 percentile response time.", + "readOnly": true + }, + "pct75ResTime": { + "type": "number", + "format": "double", + "description": "75 percentile response time.", + "readOnly": true + }, + "pct96ResTime": { + "type": "number", + "format": "double", + "description": "96 percentile response time.", + "readOnly": true + }, + "pct97ResTime": { + "type": "number", + "format": "double", + "description": "97 percentile response time.", + "readOnly": true + }, + "pct98ResTime": { + "type": "number", + "format": "double", + "description": "98 percentile response time.", + "readOnly": true + }, + "pct999ResTime": { + "type": "number", + "format": "double", + "description": "99.9 percentile response time.", + "readOnly": true + }, + "pct9999ResTime": { + "type": "number", + "format": "double", + "description": "99.99 percentile response time.", + "readOnly": true + }, + "throughput": { + "type": "number", + "format": "double", + "description": "Throughput.", + "readOnly": true + }, + "receivedKBytesPerSec": { + "type": "number", + "format": "double", + "description": "Received network bytes.", + "readOnly": true + }, + "sentKBytesPerSec": { + "type": "number", + "format": "double", + "description": "Send network bytes.", + "readOnly": true + } + } + }, + "TestServerMetricConfig": { + "type": "object", + "description": "Test server metrics configuration", + "properties": { + "testId": { + "type": "string", + "description": "Test identifier", + "readOnly": true + }, + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetric" + } + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "required": [ + "metrics" + ] + }, + "TestServerMetricConfigUpdate": { + "type": "object", + "description": "Test server metrics configuration", + "properties": { + "metrics": { + "type": "object", + "description": "Azure resource metrics collection {metric id : metrics object} (Refer :\nhttps://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition\nfor metric id).", + "additionalProperties": { + "$ref": "#/definitions/ResourceMetricUpdate" + } + } + } + }, + "TimeGrain": { + "type": "string", + "description": "Time Grain", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + } + }, + "TimeSeriesElement": { + "type": "object", + "description": "The time series returned when a data query is performed.", + "properties": { + "data": { + "type": "array", + "description": "An array of data points representing the metric values.", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "x-ms-identifiers": [] + }, + "dimensionValues": { + "type": "array", + "description": "The dimension values ", + "items": { + "$ref": "#/definitions/DimensionValue" + }, + "x-ms-identifiers": [] + } + } + }, + "Trigger": { + "type": "object", + "description": "Trigger model.", + "properties": { + "triggerId": { + "type": "string", + "description": "The unique identifier of the trigger.", + "minLength": 2, + "maxLength": 50, + "pattern": "^[a-z0-9_-]*$", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The name of the trigger.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the trigger.", + "maxLength": 100 + }, + "kind": { + "$ref": "#/definitions/TriggerType", + "description": "The type of the trigger." + }, + "state": { + "$ref": "#/definitions/TriggerState", + "description": "The current state of the trigger." + }, + "stateDetails": { + "$ref": "#/definitions/StateDetails", + "description": "Details of current state of the trigger.", + "readOnly": true + }, + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The creation datetime(RFC 3339 literal format).", + "readOnly": true + }, + "createdBy": { + "type": "string", + "description": "The user that created.", + "readOnly": true + }, + "lastModifiedDateTime": { + "type": "string", + "format": "date-time", + "description": "The last Modified datetime(RFC 3339 literal format).", + "readOnly": true + }, + "lastModifiedBy": { + "type": "string", + "description": "The user that last modified.", + "readOnly": true + } + }, + "discriminator": "kind", + "required": [ + "triggerId", + "displayName", + "kind" + ] + }, + "TriggerCreateOrUpdate": { + "type": "object", + "description": "Trigger model.", + "properties": { + "displayName": { + "type": "string", + "description": "The name of the trigger.", + "minLength": 2, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the trigger.", + "maxLength": 100 + }, + "kind": { + "$ref": "#/definitions/TriggerType", + "description": "The type of the trigger." + }, + "state": { + "$ref": "#/definitions/TriggerState", + "description": "The current state of the trigger." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "TriggerState": { + "type": "string", + "description": "Current state of a trigger.", + "enum": [ + "Active", + "Paused", + "Completed", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The trigger is active." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The trigger is paused manually." + }, + { + "name": "Completed", + "value": "Completed", + "description": "The trigger is completed." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The trigger is disabled due to error." + } + ] + } + }, + "TriggerType": { + "type": "string", + "description": "Type of a trigger.", + "enum": [ + "ScheduleTestsTrigger" + ], + "x-ms-enum": { + "name": "TriggerType", + "modelAsString": true, + "values": [ + { + "name": "ScheduleTestsTrigger", + "value": "ScheduleTestsTrigger", + "description": "Trigger is a Scheduled Trigger on a Test." + } + ] + } + }, + "WeekDays": { + "type": "string", + "description": "Defines the days of the week.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "WeekDays", + "modelAsString": true, + "values": [ + { + "name": "Sunday", + "value": "Sunday", + "description": "Refers to Sunday." + }, + { + "name": "Monday", + "value": "Monday", + "description": "Refers to Monday." + }, + { + "name": "Tuesday", + "value": "Tuesday", + "description": "Refers to Tuesday." + }, + { + "name": "Wednesday", + "value": "Wednesday", + "description": "Refers to Wednesday." + }, + { + "name": "Thursday", + "value": "Thursday", + "description": "Refers to Thursday." + }, + { + "name": "Friday", + "value": "Friday", + "description": "Refers to Friday." + }, + { + "name": "Saturday", + "value": "Saturday", + "description": "Refers to Saturday." + } + ] + } + }, + "WeeklyRecurrence": { + "type": "object", + "description": "Recurrence model when frequency is set as weekly.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Recurrence set to repeat on the specified days of the week.", + "items": { + "$ref": "#/definitions/WeekDays" + } + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of weeks between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Recurrence" + } + ], + "x-ms-discriminator-value": "Weekly" + }, + "WeeklyRecurrenceCreateOrUpdate": { + "type": "object", + "description": "Recurrence model when frequency is set as weekly.", + "properties": { + "daysOfWeek": { + "type": "array", + "description": "Recurrence set to repeat on the specified days of the week.", + "items": { + "$ref": "#/definitions/WeekDays" + } + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The interval at which the recurrence should repeat. It signifies the number of weeks between each recurrence." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RecurrenceCreateOrUpdate" + } + ], + "x-ms-discriminator-value": "Weekly" + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for this operation.", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "x-ms-client-name": "apiVersion" + }, + "ListTestProfileQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Maximum number of results to include in a single response.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.testIds": { + "name": "testIds", + "in": "query", + "description": "Comma separated list IDs of the tests which should be associated with the test profiles to fetch.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileQueryParams.testProfileIds": { + "name": "testProfileIds", + "in": "query", + "description": "Comma separated list of IDs of the test profiles to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.createdDateEndTime": { + "name": "createdDateEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the created time range to filter test profile runs.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.createdDateStartTime": { + "name": "createdDateStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the created time range to filter test profile runs.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxEndDateTime": { + "name": "maxEndDateTime", + "in": "query", + "description": "Maximum End DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxStartDateTime": { + "name": "maxStartDateTime", + "in": "query", + "description": "Maximum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Maximum number of results to include in a single response.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.minEndDateTime": { + "name": "minEndDateTime", + "in": "query", + "description": "Minimum End DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.minStartDateTime": { + "name": "minStartDateTime", + "in": "query", + "description": "Minimum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.statuses": { + "name": "statuses", + "in": "query", + "description": "Comma separated list of Statuses of the test profile runs to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.testProfileIds": { + "name": "testProfileIds", + "in": "query", + "description": "Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestProfileRunQueryParams.testProfileRunIds": { + "name": "testProfileRunIds", + "in": "query", + "description": "Comma separated list of IDs of the test profile runs to filter.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg:\nlastModifiedDateTime asc. Supported fields - lastModifiedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestQueryParams.search": { + "name": "search", + "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - displayName,\ncreatedBy. For example, to search for a test, with display name is Login Test,\nthe search parameter can be Login.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionFrom": { + "name": "executionFrom", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.executionTo": { + "name": "executionTo", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of test-run execution time filter range.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.orderby": { + "name": "orderby", + "in": "query", + "description": "Sort on the supported fields in (field asc/desc) format. eg: executedDateTime\nasc. Supported fields - executedDateTime", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.search": { + "name": "search", + "in": "query", + "description": "Prefix based, case sensitive search on searchable fields - description,\nexecutedUser. For example, to search for a test run, with description 500 VUs,\nthe search parameter can be 500.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.status": { + "name": "status", + "in": "query", + "description": "Comma separated list of test run status.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTestRunQueryParams.testId": { + "name": "testId", + "in": "query", + "description": "Unique name of an existing load test.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ListTriggerQueryParams.lastModifiedEndTime": { + "name": "lastModifiedEndTime", + "in": "query", + "description": "End DateTime(RFC 3339 literal format) of the last updated time range to filter triggers.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTriggerQueryParams.lastModifiedStartTime": { + "name": "lastModifiedStartTime", + "in": "query", + "description": "Start DateTime(RFC 3339 literal format) of the last updated time range to filter triggers.", + "required": false, + "type": "string", + "format": "date-time", + "x-ms-parameter-location": "method" + }, + "ListTriggerQueryParams.maxpagesize": { + "name": "maxpagesize", + "in": "query", + "description": "Number of results in response. Default page size is 50.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "x-ms-parameter-location": "method" + }, + "ListTriggerQueryParams.states": { + "name": "states", + "in": "query", + "description": "Filter triggers based on a comma separated list of states.", + "required": false, + "type": "string", + "enum": [ + "Active", + "Paused", + "Completed", + "Disabled" + ], + "x-ms-enum": { + "name": "TriggerState", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "The trigger is active." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The trigger is paused manually." + }, + { + "name": "Completed", + "value": "Completed", + "description": "The trigger is completed." + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "The trigger is disabled due to error." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ListTriggerQueryParams.testIds": { + "name": "testIds", + "in": "query", + "description": "Search based on triggers associated with the provided test ids.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.interval": { + "name": "interval", + "in": "query", + "description": "The interval (i.e. timegrain) of the query.", + "required": false, + "type": "string", + "default": "PT1M", + "enum": [ + "PT5S", + "PT10S", + "PT1M", + "PT5M", + "PT1H" + ], + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true, + "values": [ + { + "name": "PT5S", + "value": "PT5S", + "description": "5 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT10S", + "value": "PT10S", + "description": "10 seconds, available only if test run duration is less than 10 minutes." + }, + { + "name": "PT1M", + "value": "PT1M", + "description": "1 minute" + }, + { + "name": "PT5M", + "value": "PT5M", + "description": "5 minutes, available only if test run duration is greater than 1 minute." + }, + { + "name": "PT1H", + "value": "PT1H", + "description": "1 hour, available only if test run duration is greater than 1 minute." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.metricNamespace": { + "name": "metricNamespace", + "in": "query", + "description": "Metric namespace to query metric definitions for.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.metricname": { + "name": "metricname", + "in": "query", + "description": "Metric name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MetricDimensionsRequest.timespan": { + "name": "timespan", + "in": "query", + "description": "The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OldTestRunIdQueryParam": { + "name": "oldTestRunId", + "in": "query", + "description": "Existing test run identifier that should be rerun, if this is provided, the\ntest will run with the JMX file, configuration and app components from the\nexisting test run. You can override the configuration values for new test run\nin the request body.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/loadtestservice/data-plane/readme.md b/specification/loadtestservice/data-plane/readme.md index 544b7e65a130..a62c42f7583b 100644 --- a/specification/loadtestservice/data-plane/readme.md +++ b/specification/loadtestservice/data-plane/readme.md @@ -27,6 +27,15 @@ tag: package-2022-11-01 title: LoadTestingClient ``` +### Tag: package-2024-07-01-preview + +These settings apply only when `--tag=package-2024-07-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2024-07-01-preview' +input-file: + - Microsoft.LoadTestService/preview/2024-07-01-preview/loadtestservice.json +``` + ### Tag: package-2024-05-01-preview These settings apply only when `--tag=package-2024-05-01-preview` is specified on the command line. From 3b2c83a92854c5694d37123f100b87490fab6068 Mon Sep 17 00:00:00 2001 From: shraddhasun <128851887+shraddhasun@users.noreply.github.com> Date: Fri, 11 Oct 2024 09:25:52 -0700 Subject: [PATCH 092/101] Add new api-versions (#30637) * Add new api-versions * add operations files * add upload to 2024-08-01-preview * add to readme and cspell * remove suppress message * Added a new type of resource allowed for the subnet.id property in a NetworkInterface * Added vmImageCredentials to gallery image properties for Nexus * Allow references to Microsoft.NetworkCloud/l2/l3/trunkednetwork types by AzStackHCINetworkInterface * remove api-version internal * get rid of file * Update sdk-suppressions.yaml * Update sdk-suppressions.yaml --------- Co-authored-by: kumdeepakgit <kumdeepak@microsoft.com> Co-authored-by: Ashwini Cheerla <acheerla@microsoft.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Chenjie Shi <tadelesh.shi@live.cn> --- cSpell.json | 6 + .../VirtualHardDisks.tsp | 9 + .../AttestationStatuses_Get.json | 28 + .../GalleryImages_CreateOrUpdate.json | 100 + .../GalleryImages_Delete.json | 22 + .../2024-08-01-preview/GalleryImages_Get.json | 56 + .../GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../GalleryImages_Update.json | 63 + .../GuestAgents_Create.json | 43 + .../GuestAgents_Delete.json | 20 + .../2024-08-01-preview/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../LogicalNetworks_Delete.json | 22 + .../LogicalNetworks_Get.json | 27 + .../LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../NetworkInterfaces_Delete.json | 22 + .../NetworkInterfaces_Get.json | 37 + .../NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../SecurityRules_CreateOrUpdate.json | 85 + .../SecurityRules_Delete.json | 23 + .../2024-08-01-preview/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../StorageContainers_Delete.json | 22 + .../StorageContainers_Get.json | 28 + .../StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../VirtualHardDisks_Delete.json | 22 + .../VirtualHardDisks_Get.json | 34 + .../VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../VirtualHardDisks_Update.json | 47 + .../VirtualHardDisks_Upload.json | 29 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...Put_Virtual_Machine_Instance_With_Gpu.json | 133 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 107 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../VirtualMachineInstances_Get.json | 51 + .../VirtualMachineInstances_List.json | 55 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../main.tsp | 7 + .../models.tsp | 89 + .../2024-08-01-preview/Operations_List.json | 305 + .../Operations.Management/main.tsp | 9 +- .../2024-02-01-preview/stackhcivm.json | 12 + .../2024-05-01-preview/stackhcivm.json | 12 + .../examples/AttestationStatuses_Get.json | 26 + .../GalleryImages_CreateOrUpdate.json | 100 + .../examples/GalleryImages_Delete.json | 22 + .../examples/GalleryImages_Get.json | 56 + .../examples/GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../examples/GalleryImages_Update.json | 63 + .../examples/GuestAgents_Create.json | 43 + .../examples/GuestAgents_Delete.json | 20 + .../examples/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../examples/LogicalNetworks_Delete.json | 22 + .../examples/LogicalNetworks_Get.json | 27 + .../examples/LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../examples/LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../examples/NetworkInterfaces_Delete.json | 22 + .../examples/NetworkInterfaces_Get.json | 37 + .../examples/NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../examples/NetworkInterfaces_Update.json | 47 + ...faces__CreateOrUpdate_CreateFromLocal.json | 84 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../examples/NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../SecurityRules_CreateOrUpdate.json | 85 + .../examples/SecurityRules_Delete.json | 23 + .../examples/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../examples/StorageContainers_Delete.json | 22 + .../examples/StorageContainers_Get.json | 28 + .../examples/StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../examples/StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../examples/VirtualHardDisks_Delete.json | 22 + .../examples/VirtualHardDisks_Get.json | 34 + .../examples/VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../examples/VirtualHardDisks_Update.json | 47 + .../examples/VirtualHardDisks_Upload.json | 29 + ...Disks__CreateOrUpdate_CreateFromLocal.json | 74 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...Put_Virtual_Machine_Instance_With_Gpu.json | 133 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 102 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../examples/VirtualMachineInstances_Get.json | 44 + .../VirtualMachineInstances_List.json | 48 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + ...ances__CreateOrUpdate_CreateFromLocal.json | 105 + .../2024-07-15-preview/stackhcivm.json | 7171 ++++++++++++++++ .../examples/AttestationStatuses_Get.json | 28 + .../GalleryImages_CreateOrUpdate.json | 100 + .../examples/GalleryImages_Delete.json | 22 + .../examples/GalleryImages_Get.json | 56 + .../examples/GalleryImages_ListAll.json | 52 + .../GalleryImages_ListByResourceGroup.json | 53 + .../examples/GalleryImages_Update.json | 63 + .../examples/GuestAgents_Create.json | 43 + .../examples/GuestAgents_Delete.json | 20 + .../examples/GuestAgents_Get.json | 22 + ...stAgents_ListByVirtualMachineInstance.json | 26 + .../HybridIdentityMetadataGroup_Get.json | 25 + ...Metadata_ListByVirtualMachineInstance.json | 29 + .../LogicalNetworks_CreateOrUpdate.json | 49 + .../examples/LogicalNetworks_Delete.json | 22 + .../examples/LogicalNetworks_Get.json | 27 + .../examples/LogicalNetworks_ListAll.json | 29 + .../LogicalNetworks_ListByResourceGroup.json | 30 + .../examples/LogicalNetworks_Update.json | 40 + ...rketplaceGalleryImages_CreateOrUpdate.json | 122 + .../MarketplaceGalleryImages_Delete.json | 22 + .../MarketplaceGalleryImages_Get.json | 56 + .../MarketplaceGalleryImages_ListAll.json | 58 + ...laceGalleryImages_ListByResourceGroup.json | 59 + .../MarketplaceGalleryImages_Update.json | 69 + .../NetworkInterfaces_CreateOrUpdate.json | 81 + .../examples/NetworkInterfaces_Delete.json | 22 + .../examples/NetworkInterfaces_Get.json | 37 + .../examples/NetworkInterfaces_ListAll.json | 41 + ...NetworkInterfaces_ListByResourceGroup.json | 41 + .../examples/NetworkInterfaces_Update.json | 47 + .../NetworkSecurityGroups_CreateOrUpdate.json | 37 + .../NetworkSecurityGroups_Delete.json | 22 + .../examples/NetworkSecurityGroups_Get.json | 23 + .../NetworkSecurityGroups_ListAll.json | 34 + ...orkSecurityGroups_ListByResourceGroup.json | 35 + .../NetworkSecurityGroups_UpdateTags.json | 38 + .../SecurityRules_CreateOrUpdate.json | 85 + .../examples/SecurityRules_Delete.json | 23 + .../examples/SecurityRules_Get.json | 37 + ...urityRules_ListByNetworkSecurityGroup.json | 40 + .../StorageContainers_CreateOrUpdate.json | 54 + .../examples/StorageContainers_Delete.json | 22 + .../examples/StorageContainers_Get.json | 28 + .../examples/StorageContainers_ListAll.json | 30 + ...StorageContainers_ListByResourceGroup.json | 31 + .../examples/StorageContainers_Update.json | 41 + .../VirtualHardDisks_CreateOrUpdate.json | 66 + .../examples/VirtualHardDisks_Delete.json | 22 + .../examples/VirtualHardDisks_Get.json | 34 + .../examples/VirtualHardDisks_ListAll.json | 36 + .../VirtualHardDisks_ListByResourceGroup.json | 37 + .../examples/VirtualHardDisks_Update.json | 47 + .../examples/VirtualHardDisks_Upload.json | 29 + ...l_Machine_Instance_With_Gallery_Image.json | 115 + ...Put_Virtual_Machine_Instance_With_Gpu.json | 133 + ...stance_With_Marketplace_Gallery_Image.json | 115 + ...Virtual_Machine_Instance_With_Os_Disk.json | 107 + ...Machine_Instance_With_Vm_Config_Agent.json | 146 + .../VirtualMachineInstances_Delete.json | 20 + .../examples/VirtualMachineInstances_Get.json | 51 + .../VirtualMachineInstances_List.json | 55 + .../VirtualMachineInstances_Pause.json | 15 + .../VirtualMachineInstances_Restart.json | 15 + .../VirtualMachineInstances_Save.json | 15 + .../VirtualMachineInstances_Start.json | 15 + .../VirtualMachineInstances_Stop.json | 15 + .../VirtualMachineInstances_Update.json | 64 + .../2024-08-01-preview/stackhcivm.json | 7341 +++++++++++++++++ .../StackHCIVM/readme.md | 12 +- .../examples/Operations_List.json | 305 + .../2024-08-01-preview/operations.json | 86 + .../resource-manager/sdk-suppressions.yaml | 91 +- 221 files changed, 25063 insertions(+), 3 deletions(-) create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Create.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Upload.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/Operations.Management/examples/2024-08-01-preview/Operations_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Create.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces__CreateOrUpdate_CreateFromLocal.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Upload.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks__CreateOrUpdate_CreateFromLocal.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances__CreateOrUpdate_CreateFromLocal.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/stackhcivm.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/AttestationStatuses_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Create.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadataGroup_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_UpdateTags.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListAll.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Upload.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Get.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Pause.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Restart.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Save.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Start.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Stop.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Update.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/stackhcivm.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/examples/Operations_List.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/operations.json diff --git a/cSpell.json b/cSpell.json index 797046f01e9d..1f9bdecc35a2 100644 --- a/cSpell.json +++ b/cSpell.json @@ -1653,6 +1653,12 @@ "words": [ "billables" ] + }, + { + "filename": "**/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/**/*.json", + "words": [ + "SEVSNP" + ] } ], "enableFiletypes": [ diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp index 507c3ae39e87..6e6e69f6d29b 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/VirtualHardDisks.tsp @@ -8,6 +8,7 @@ using TypeSpec.Rest; using Azure.ResourceManager; using TypeSpec.Http; using TypeSpec.OpenAPI; +using TypeSpec.Versioning; namespace Microsoft.AzureStackHCI; @@ -52,4 +53,12 @@ interface VirtualHardDisks { @doc("Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.") listAll is ArmListBySubscription<VirtualHardDisk>; + + @added(Versions.v2024_08_01_preview) + @doc("The operation to upload a virtual hard disk.") + upload is ArmResourceActionAsync< + VirtualHardDisk, + VirtualHardDiskUploadRequest, + VirtualHardDiskUploadResponse + >; } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/AttestationStatuses_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/AttestationStatuses_Get.json new file mode 100644 index 000000000000..d339fdebc4f7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/AttestationStatuses_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48", + "attestHardwarePlatform": "Unknown", + "attestDiskSecurityEncryptionType": "Unknown" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..a0219040aeef --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Delete.json new file mode 100644 index 000000000000..c87318aeb68e --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Get.json new file mode 100644 index 000000000000..105faa9fd489 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListAll.json new file mode 100644 index 000000000000..5a33d2932869 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..1e57ba6027a4 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Update.json new file mode 100644 index 000000000000..b8765cba7cd7 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Create.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Create.json new file mode 100644 index 000000000000..7663f4459c2b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "<password>", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Delete.json new file mode 100644 index 000000000000..b3e1105e076c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Get.json new file mode 100644 index 000000000000..0b8f12803a13 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..22a9816a093c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..956c696255bc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..4a7d20505a7d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..541a8d04bd12 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..89ebae14d6ed --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Get.json new file mode 100644 index 000000000000..a3a3b0aad8ba --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..361afb916417 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..e1bdfe2716ae --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Update.json new file mode 100644 index 000000000000..182ced9b0543 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..52554d81e4f4 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..ac7ff6b32350 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..394327ce3269 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..aa74afc3a4e5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..2c499fd4dd41 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..f42d21232f8b --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..6154e5928cb9 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..580f2e678f95 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..cb3dd2e821a5 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..453b28046975 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..30b7fbcfb730 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..7f5fd3b05ecf --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..841e24009947 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..4fc0b92e58b0 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..dfb438bfafb0 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..bfbd0977f166 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..903104d4e17d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..efe01ef99c08 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..ac96358ef200 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Delete.json new file mode 100644 index 000000000000..ae63db18e876 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Get.json new file mode 100644 index 000000000000..e4da57024895 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..b556d8a21208 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..905d891b4a4a --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Delete.json new file mode 100644 index 000000000000..fbf14e5eaeec --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Get.json new file mode 100644 index 000000000000..8631e9b74b77 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListAll.json new file mode 100644 index 000000000000..b58b163a1b73 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..28d803bbbf30 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Update.json new file mode 100644 index 000000000000..f788ae629c84 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..a48a83f0d6f2 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..f3404da91368 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..a3ecb1778c34 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListAll.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..0ca42c8a3787 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..1461ca846e54 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..6fee18b8f611 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Upload.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Upload.json new file mode 100644 index 000000000000..e587b4cd6c1c --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualHardDisks_Upload.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "body": { + "azureManagedDiskUploadUrl": "https://YourStorageAccountName.blob.core.windows.net/YourContainerName/YourVHDBlobName.vhd?<sas-token>" + } + }, + "responses": { + "200": { + "body": { + "virtualHardDiskId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "uploadStatus": { + "uploadedSizeInMB": 10240, + "status": "InProgress" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + }, + "operationId": "VirtualHardDisks_Upload", + "title": "UploadVirtualHardDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..9fee0391abdd --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json new file mode 100644 index 000000000000..280313b28e4a --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGpu" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..6b5f931dc903 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..f96761dced05 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..bf9c3879a0d1 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Delete.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..6637564606dc --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Get.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..0d663ca1cb4f --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container", + "osDisk": { + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + } + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_List.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..c7e1477bbf47 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container", + "osDisk": { + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + } + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Pause.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..145b176acbca --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Restart.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..853261dd3b76 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Save.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..1a6cdebfae81 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Start.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..506b5cf0246d --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Stop.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..ada31ebc5900 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Update.json b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..0218480a6f75 --- /dev/null +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/examples/2024-08-01-preview/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp index 4ae2c9529641..bab532899aa9 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/main.tsp @@ -51,4 +51,11 @@ enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_05_01_preview: "2024-05-01-preview", + + /** + * The 2024-08-01-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_08_01_preview: "2024-08-01-preview", } diff --git a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp index af6e9bf4d78c..78e564c9a975 100644 --- a/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp +++ b/specification/azurestackhci/AzureStackHCI.StackHCIVM.Management/models.tsp @@ -357,6 +357,30 @@ union AttestHealthStatusEnum { string, } +@added(Versions.v2024_08_01_preview) +@doc("Defines type of hardware platform from attestation token.") +union AttestHWPlatformEnum { + @doc("AttestHWPlatform is Secure Encrypted Virtualization Secure Nested Paging (SEVSNP)") + SEVSNP: "SEVSNP", + + @doc("AttestHWPlatform is unknown") + Unknown: "Unknown", + + string, +} + +@added(Versions.v2024_08_01_preview) +@doc("Defines type of managed disk security encryption type from attestation token.") +union AttestDiskSecurityEncryptionTypeEnum { + @doc("Disk security encryption type is non-persisted Trusted Platform Module (TPM)") + NonPersistedTPM: "NonPersistedTPM", + + @doc("Disk security encryption type is unknown") + Unknown: "Unknown", + + string, +} + @doc("Defines the different types of operations for guest agent.") union ProvisioningAction { @doc("Install guest agent") @@ -382,6 +406,15 @@ union OperatingSystemTypes { string, } +@added(Versions.v2024_08_01_preview) +@doc("Encryption type of the managed disk enum.") +union SecurityEncryptionType { + @doc("Non-persisted TPM encryption type") + NonPersistedTPM: "NonPersistedTPM", + + string, +} + #suppress "@azure-tools/typespec-azure-core/casing-style" "IP is a short form. The casing is correct." @doc("Type of the IP Pool [vm, vippool]") union IPPoolTypeEnum { @@ -430,6 +463,18 @@ model LogicalNetworkArmReference { id?: armResourceIdentifier<[ { type: "Microsoft.AzureStackHCI/logicalNetworks"; + }, + { + type: "Microsoft.NetworkCloud/cloudServicesNetworks"; + }, + { + type: "Microsoft.NetworkCloud/l2Networks"; + }, + { + type: "Microsoft.NetworkCloud/l3Networks"; + }, + { + type: "Microsoft.NetworkCloud/trunkedNetworks"; } ]>; } @@ -501,6 +546,10 @@ model GalleryImageProperties { @doc("The hypervisor generation of the Virtual Machine [V1, V2]") hyperVGeneration?: HyperVGeneration; + @added(Versions.v2024_08_01_preview) + @doc("The credentials used to login to the image repository that has access to the specified image") + vmImageRepositoryCredentials?: VmImageRepositoryCredentials; + @doc("This is the gallery image definition identifier.") identifier?: GalleryImageIdentifier; @@ -524,6 +573,17 @@ model GalleryImageProperties { ]>; } +@added(Versions.v2024_08_01_preview) +@doc("The credentials used to login to the image repository that has access to the specified image") +model VmImageRepositoryCredentials { + @doc("Username for accessing image repository") + username: string; + + @doc("Password for accessing image repository") + @secret + password: string; +} + @doc("This is the gallery image definition identifier.") model GalleryImageIdentifier { @doc("The name of the gallery image definition publisher.") @@ -1417,6 +1477,25 @@ model VirtualMachineInstancePropertiesStorageProfileOsDisk is VirtualHardDiskArmReference { @doc("This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.") osType?: OperatingSystemTypes; + + @added(Versions.v2024_08_01_preview) + @doc("The managed disk parameters.") + managedDisk?: VirtualMachineInstanceManagedDiskParameters; +} + +@added(Versions.v2024_08_01_preview) +@doc("The parameters of a managed disk.") +model VirtualMachineInstanceManagedDiskParameters { + @doc("Specifies the security profile for the managed disk.") + securityProfile?: VMDiskSecurityProfile; +} + +#suppress "@azure-tools/typespec-azure-core/casing-style" "VM is a short form. It is the correct case." +@added(Versions.v2024_08_01_preview) +@doc("Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs") +model VMDiskSecurityProfile { + @doc("Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs.") + securityEncryptionType?: SecurityEncryptionType; } @doc("HTTP Proxy configuration for the VM.") @@ -1673,6 +1752,16 @@ model AttestationStatusProperties { @doc("Provisioning state of the virtual machine instance.") @visibility("read") provisioningState?: ProvisioningStateEnum; + + @doc("The hardware platform information from attestation token. This only applies to Confidential VM.") + @visibility("read") + @added(Versions.v2024_08_01_preview) + attestHardwarePlatform?: AttestHWPlatformEnum; + + @added(Versions.v2024_08_01_preview) + @doc("The managed disk security encryption type from attestation token. This only applies to Confidential VM.") + @visibility("read") + attestDiskSecurityEncryptionType?: AttestDiskSecurityEncryptionTypeEnum; } @doc("Defines the resource properties.") diff --git a/specification/azurestackhci/Operations.Management/examples/2024-08-01-preview/Operations_List.json b/specification/azurestackhci/Operations.Management/examples/2024-08-01-preview/Operations_List.json new file mode 100644 index 000000000000..cb75a255d1e7 --- /dev/null +++ b/specification/azurestackhci/Operations.Management/examples/2024-08-01-preview/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/Operations.Management/main.tsp b/specification/azurestackhci/Operations.Management/main.tsp index 8139d472a7b0..7165430cd43f 100644 --- a/specification/azurestackhci/Operations.Management/main.tsp +++ b/specification/azurestackhci/Operations.Management/main.tsp @@ -33,9 +33,16 @@ enum Versions { v2024_02_01_preview: "2024-02-01-preview", /** - * The 2024-05-01-preview API version for internal testing only. + * The 2024-05-01-preview API version. */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_1) v2024_05_01_preview: "2024-05-01-preview", + + /** + * The 2024-08-01-preview API version. + */ + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + v2024_08_01_preview: "2024-08-01-preview", } diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json index b5971bfff41b..742cafe03e3c 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-02-01-preview/stackhcivm.json @@ -4590,6 +4590,18 @@ "allowedResources": [ { "type": "Microsoft.AzureStackHCI/logicalNetworks" + }, + { + "type": "Microsoft.NetworkCloud/cloudServicesNetworks" + }, + { + "type": "Microsoft.NetworkCloud/l2Networks" + }, + { + "type": "Microsoft.NetworkCloud/l3Networks" + }, + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" } ] } diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json index 2342ba4a649c..443e85a6b372 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-05-01-preview/stackhcivm.json @@ -4637,6 +4637,18 @@ "allowedResources": [ { "type": "Microsoft.AzureStackHCI/logicalNetworks" + }, + { + "type": "Microsoft.NetworkCloud/cloudServicesNetworks" + }, + { + "type": "Microsoft.NetworkCloud/l2Networks" + }, + { + "type": "Microsoft.NetworkCloud/l3Networks" + }, + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" } ] } diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/AttestationStatuses_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/AttestationStatuses_Get.json new file mode 100644 index 000000000000..056f96132202 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/AttestationStatuses_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..3e9de01b7fd6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Delete.json new file mode 100644 index 000000000000..0c6256fec0e0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Get.json new file mode 100644 index 000000000000..b2252afd2d33 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListAll.json new file mode 100644 index 000000000000..eb0fd65d0c29 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..79b6f44fb216 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Update.json new file mode 100644 index 000000000000..77be4e2035c2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Create.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Create.json new file mode 100644 index 000000000000..9cf2b475298f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resource": { + "properties": { + "credentials": { + "password": "<password>", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Delete.json new file mode 100644 index 000000000000..f1a37fd4a43d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Get.json new file mode 100644 index 000000000000..88fe587b7556 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..36a5968a65c4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..11eff1b861ff --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..edb4a7cdb1cd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..b6681a7861ef --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..d98fba7066ab --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Get.json new file mode 100644 index 000000000000..70643c648af5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..0b4883e7044b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..e6d3474ceabe --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Update.json new file mode 100644 index 000000000000..21eb1e24ba9b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..7d80c3747905 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-07-15-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..3ba2153df60c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..0eb9a9493029 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..38e4b97ba5dd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..bbb4e829dbef --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..fee3766e9edf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..e3fe1bec136a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..670ad6a9648b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..a60771f8e3e8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..12e63840c04d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..e278828640cd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..ad63207fb8e1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces__CreateOrUpdate_CreateFromLocal.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces__CreateOrUpdate_CreateFromLocal.json new file mode 100644 index 000000000000..de404415e40c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkInterfaces__CreateOrUpdate_CreateFromLocal.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "createFromLocal": true + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "createFromLocal": true, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "createFromLocal": true, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "CreateNetworkInterfaceFromLocal" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..da375fb0ea66 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..496f2629af30 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..5c5998056c74 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..ccb183baa9b3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..e3b87b47ef32 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..29abd3dde8a8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..8ac894605f79 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Delete.json new file mode 100644 index 000000000000..f8a0dc577eab --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Get.json new file mode 100644 index 000000000000..c2e425be2774 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..e64460c80a6f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..2bfd287c2b1a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Delete.json new file mode 100644 index 000000000000..6a4833e160b5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Get.json new file mode 100644 index 000000000000..8779fa32ff48 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListAll.json new file mode 100644 index 000000000000..8fafefc9b0eb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..e363f65a98b5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Update.json new file mode 100644 index 000000000000..e99975fd4e44 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..28e3ab0eb398 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..b3a6ea6d7882 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..5eb3ce84edac --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..b059999dc4e5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..f288219de961 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..06c3ec54f0ab --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Upload.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Upload.json new file mode 100644 index 000000000000..b97c161022e9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks_Upload.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "body": { + "azureManagedDiskUploadUrl": "https://YourStorageAccountName.blob.core.windows.net/YourContainerName/YourVHDBlobName.vhd?<sas-token>" + } + }, + "responses": { + "200": { + "body": { + "virtualHardDiskId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "uploadStatus": { + "uploadedSizeInMB": 10240, + "status": "InProgress" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + }, + "operationId": "VirtualHardDisks_Upload", + "title": "UploadVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks__CreateOrUpdate_CreateFromLocal.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks__CreateOrUpdate_CreateFromLocal.json new file mode 100644 index 000000000000..da0f6bf21523 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualHardDisks__CreateOrUpdate_CreateFromLocal.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "createFromLocal": true, + "osType": "Windows", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "createFromLocal": true, + "osType": "Windows", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "createFromLocal": true, + "osType": "Windows", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "CreateVirtualHardDiskFromLocal" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..15974ead09fa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json new file mode 100644 index 000000000000..4d2895978be8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGpu" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..40dead16b1f4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..7fe26b487896 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..58d395bbbc2d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..3818e09fa131 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..9b8e48a85b8c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..c2c486299804 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_List.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Pause.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..8a974ffad021 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Restart.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..6dc0ac3ff6e9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Save.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..6587ac445b19 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Start.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..f1f102c5d335 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Stop.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..137ea8c96191 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..d731912ea1f5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances__CreateOrUpdate_CreateFromLocal.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances__CreateOrUpdate_CreateFromLocal.json new file mode 100644 index 000000000000..98d27024a9ac --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/examples/VirtualMachineInstances__CreateOrUpdate_CreateFromLocal.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2024-07-15-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + }, + "createFromLocal": true + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + }, + "createFromLocal": true + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + }, + "createFromLocal": true + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "CreateVirtualMachineInstanceFromLocal" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/stackhcivm.json new file mode 100644 index 000000000000..48e7e39b3908 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-07-15-preview/stackhcivm.json @@ -0,0 +1,7171 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-07-15-preview", + "description": "Azure Stack HCI management service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "GalleryImages" + }, + { + "name": "LogicalNetworks" + }, + { + "name": "MarketplaceGalleryImages" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkSecurityGroups" + }, + { + "name": "SecurityRules" + }, + { + "name": "StorageContainers" + }, + { + "name": "VirtualHardDisks" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "HybridIdentityMetadataGroup" + }, + { + "name": "AttestationStatuses" + }, + { + "name": "GuestAgents" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances": { + "get": { + "operationId": "VirtualMachineInstances_List", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Lists all of the virtual machine instances within the specified parent resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualMachineInstances": { + "$ref": "./examples/VirtualMachineInstances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Gets a virtual machine instance", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualMachineInstance": { + "$ref": "./examples/VirtualMachineInstances_Get.json" + } + } + }, + "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "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": { + "CreateVirtualMachineInstanceFromLocal": { + "$ref": "./examples/VirtualMachineInstances__CreateOrUpdate_CreateFromLocal.json" + }, + "PutVirtualMachineInstanceWithGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithGpu": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json" + }, + "PutVirtualMachineInstanceWithMarketplaceGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithOsDisk": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json" + }, + "PutVirtualMachineInstanceWithVMConfigAgent": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to update a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineInstances_Delete", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to delete a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default": { + "get": { + "operationId": "AttestationStatuses_Get", + "tags": [ + "AttestationStatuses" + ], + "description": "Implements AttestationStatus GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AttestationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAttestationStatus": { + "$ref": "./examples/AttestationStatuses_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents": { + "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "tags": [ + "GuestAgents" + ], + "description": "Returns the list of GuestAgent of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgentListByVirtualMachineInstances": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default": { + "get": { + "operationId": "GuestAgents_Get", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGuestAgent": { + "$ref": "./examples/GuestAgents_Get.json" + } + } + }, + "put": { + "operationId": "GuestAgents_Create", + "tags": [ + "GuestAgents" + ], + "description": "Create Or Update GuestAgent.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuestAgent" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuestAgent' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "201": { + "description": "Resource 'GuestAgent' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + }, + "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": { + "CreateGuestAgent": { + "$ref": "./examples/GuestAgents_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuestAgents_Delete", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent DELETE method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteGuestAgent": { + "$ref": "./examples/GuestAgents_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Returns the list of HybridIdentityMetadata of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachineInstances": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default": { + "get": { + "operationId": "HybridIdentityMetadata_Get", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Implements HybridIdentityMetadata GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadataGroup_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/pause": { + "post": { + "operationId": "VirtualMachineInstances_Pause", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to pause a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PauseVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Pause.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to restart a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RestartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Restart.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/save": { + "post": { + "operationId": "VirtualMachineInstances_Save", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to save a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SaveVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Save.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to start a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Start.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to stop a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StopVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Stop.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListAll", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageBySubscription": { + "$ref": "./examples/GalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListAll", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkBySubscription": { + "$ref": "./examples/LogicalNetworks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListAll", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageBySubscription": { + "$ref": "./examples/MarketplaceGalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListAll", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceBySubscription": { + "$ref": "./examples/NetworkInterfaces_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListAll", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a subscription.", + "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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroups_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListAll", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerBySubscription": { + "$ref": "./examples/StorageContainers_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListAll", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskBySubscription": { + "$ref": "./examples/VirtualHardDisks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListByResourceGroup", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageByResourceGroup": { + "$ref": "./examples/GalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}": { + "get": { + "operationId": "GalleryImages_Get", + "tags": [ + "GalleryImages" + ], + "description": "Gets a gallery image", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGalleryImage": { + "$ref": "./examples/GalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "GalleryImages_CreateOrUpdate", + "tags": [ + "GalleryImages" + ], + "description": "The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Resource 'GalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "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": { + "PutGalleryImage": { + "$ref": "./examples/GalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "GalleryImages_Update", + "tags": [ + "GalleryImages" + ], + "description": "The operation to update a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateGalleryImage": { + "$ref": "./examples/GalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GalleryImages_Delete", + "tags": [ + "GalleryImages" + ], + "description": "The operation to delete a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteGalleryImage": { + "$ref": "./examples/GalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListByResourceGroup", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkByResourceGroup": { + "$ref": "./examples/LogicalNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}": { + "get": { + "operationId": "LogicalNetworks_Get", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to get a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "LogicalNetworks_CreateOrUpdate", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to create or update a logical network. Please note some properties can be set only during logical network creation.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogicalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "201": { + "description": "Resource 'LogicalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + }, + "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": { + "PutLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogicalNetworks_Update", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to update a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetworksUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogicalNetworks_Delete", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to delete a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageByResourceGroup": { + "$ref": "./examples/MarketplaceGalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}": { + "get": { + "operationId": "MarketplaceGalleryImages_Get", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Gets a marketplace gallery image", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MarketplaceGalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "201": { + "description": "Resource 'MarketplaceGalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + }, + "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": { + "PutMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MarketplaceGalleryImages_Update", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to update a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MarketplaceGalleryImages_Delete", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to delete a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByResourceGroup", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceByResourceGroup": { + "$ref": "./examples/NetworkInterfaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Gets a network interface", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_CreateOrUpdate", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to create or update a network interface. Please note some properties can be set only during network interface creation.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "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": { + "CreateNetworkInterfaceFromLocal": { + "$ref": "./examples/NetworkInterfaces__CreateOrUpdate_CreateFromLocal.json" + }, + "PutNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to update a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to delete a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a 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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}": { + "get": { + "operationId": "NetworkSecurityGroups_Get", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets the specified network security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroups_Get.json" + } + } + }, + "put": { + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Creates or updates a network security group in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkSecurityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "201": { + "description": "Resource 'NetworkSecurityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "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": { + "CreateNetworkSecurityGroup": { + "$ref": "./examples/NetworkSecurityGroups_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkSecurityGroups_UpdateTags", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Updates a network security group tags.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroups_UpdateTags.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkSecurityGroups_Delete", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Deletes the specified network security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "tags": [ + "SecurityRules" + ], + "description": "Gets all security rules in a Network Security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/SecurityRules_ListByNetworkSecurityGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "get": { + "operationId": "SecurityRules_Get", + "tags": [ + "SecurityRules" + ], + "description": "Gets the specified security rule.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/SecurityRules_Get.json" + } + } + }, + "put": { + "operationId": "SecurityRules_CreateOrUpdate", + "tags": [ + "SecurityRules" + ], + "description": "Creates or updates a security rule in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecurityRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Resource 'SecurityRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "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": { + "SecurityRulesCreateOrUpdate": { + "$ref": "./examples/SecurityRules_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecurityRules_Delete", + "tags": [ + "SecurityRules" + ], + "description": "Deletes the specified security rule.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "SecurityRulesDelete": { + "$ref": "./examples/SecurityRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListByResourceGroup", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerByResourceGroup": { + "$ref": "./examples/StorageContainers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}": { + "get": { + "operationId": "StorageContainers_Get", + "tags": [ + "StorageContainers" + ], + "description": "Gets a storage container", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStorageContainer": { + "$ref": "./examples/StorageContainers_Get.json" + } + } + }, + "put": { + "operationId": "StorageContainers_CreateOrUpdate", + "tags": [ + "StorageContainers" + ], + "description": "The operation to create or update a storage container. Please note some properties can be set only during storage container creation.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'StorageContainer' update operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "201": { + "description": "Resource 'StorageContainer' create operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + }, + "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": { + "PutStorageContainer": { + "$ref": "./examples/StorageContainers_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "StorageContainers_Update", + "tags": [ + "StorageContainers" + ], + "description": "The operation to update a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateStorageContainer": { + "$ref": "./examples/StorageContainers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "StorageContainers_Delete", + "tags": [ + "StorageContainers" + ], + "description": "The operation to delete a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteStorageContainer": { + "$ref": "./examples/StorageContainers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListByResourceGroup", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskByResourceGroup": { + "$ref": "./examples/VirtualHardDisks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}": { + "get": { + "operationId": "VirtualHardDisks_Get", + "tags": [ + "VirtualHardDisks" + ], + "description": "Gets a virtual hard disk", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Get.json" + } + } + }, + "put": { + "operationId": "VirtualHardDisks_CreateOrUpdate", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualHardDisk' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "201": { + "description": "Resource 'VirtualHardDisk' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + }, + "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": { + "CreateVirtualHardDiskFromLocal": { + "$ref": "./examples/VirtualHardDisks__CreateOrUpdate_CreateFromLocal.json" + }, + "PutVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualHardDisks_Update", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to update a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDiskTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHardDisks_Delete", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to delete a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttestBootIntegrityPropertyEnum": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + } + }, + "AttestCertPropertyEnum": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + } + }, + "AttestHealthStatusEnum": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + } + }, + "AttestSecureBootPropertyEnum": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + } + }, + "AttestationStatus": { + "type": "object", + "description": "The attestation status of the virtual machine", + "properties": { + "properties": { + "$ref": "#/definitions/AttestationStatusProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AttestationStatusProperties": { + "type": "object", + "description": "Defines the attestation status properties", + "properties": { + "attestSecureBootEnabled": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "default": "Unknown", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + }, + "readOnly": true + }, + "attestationCertValidated": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + }, + "readOnly": true + }, + "bootIntegrityValidated": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + }, + "readOnly": true + }, + "linuxKernelVersion": { + "type": "string", + "description": "kernel version string for Linux VM.", + "readOnly": true + }, + "healthStatus": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "default": "Unknown", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + }, + "readOnly": true + }, + "timestamp": { + "type": "string", + "description": "The time stamp of the last time attestation token is validated by relying party service.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "The error message of attestation validation and parsing", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "CloudInitDataSource": { + "type": "string", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]", + "enum": [ + "NoCloud", + "Azure" + ], + "x-ms-enum": { + "name": "CloudInitDataSource", + "modelAsString": true, + "values": [ + { + "name": "NoCloud", + "value": "NoCloud", + "description": "NoCloud is used as the datasource" + }, + { + "name": "Azure", + "value": "Azure", + "description": "Azure is used as the datasource" + } + ] + } + }, + "DiskFileFormat": { + "type": "string", + "description": "The format of the actual VHD file [vhd, vhdx]", + "enum": [ + "vhdx", + "vhd" + ], + "x-ms-enum": { + "name": "DiskFileFormat", + "modelAsString": true, + "values": [ + { + "name": "vhdx", + "value": "vhdx", + "description": "VHDX file format" + }, + { + "name": "vhd", + "value": "vhd", + "description": "VHD file format" + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationTypes", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationTypes": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "Custom extended location type" + } + ] + } + }, + "GalleryDiskImage": { + "type": "object", + "description": "This is the disk image base class.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GalleryImage": { + "type": "object", + "description": "The gallery images resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "GalleryImageIdentifier": { + "type": "object", + "description": "This is the gallery image definition identifier.", + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ] + }, + "GalleryImageListResult": { + "type": "object", + "description": "The response of a GalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GalleryImage items on this page", + "items": { + "$ref": "#/definitions/GalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GalleryImageProperties": { + "type": "object", + "description": "Properties under the gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "imagePath": { + "type": "string", + "format": "password", + "description": "location of the image the gallery image should be created from", + "x-ms-secret": true + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/GalleryImageStatus", + "description": "The observed state of gallery images", + "readOnly": true + }, + "sourceVirtualMachineId": { + "type": "string", + "format": "arm-id", + "description": "Resource ID of the source virtual machine from whose OS disk the gallery image is created.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + }, + "required": [ + "osType" + ] + }, + "GalleryImageStatus": { + "type": "object", + "description": "The observed state of gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "GalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/GalleryImageStatusProvisioningStatus", + "description": "provisioning status of the gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/GalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + } + }, + "GalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "GalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "The status of the operation performed on the gallery image", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "GalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in GalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryImageVersion": { + "type": "object", + "description": "Specifies information about the gallery image version that you want to create or update.", + "properties": { + "name": { + "type": "string", + "description": "This is the version of the gallery image." + }, + "properties": { + "$ref": "#/definitions/GalleryImageVersionProperties", + "description": "Describes the properties of a gallery image version.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageVersionProperties": { + "type": "object", + "description": "Describes the properties of a gallery image version.", + "properties": { + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile", + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ] + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "description": "This is the storage profile of a Gallery Image Version.", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage", + "description": "This is the OS disk image." + } + } + }, + "GalleryImagesUpdateRequest": { + "type": "object", + "description": "The gallery images resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryOSDiskImage": { + "type": "object", + "description": "This is the OS disk image.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GpuAssignmentTypeEnum": { + "type": "string", + "description": "Gpu Assignment types", + "enum": [ + "GpuDDA", + "GpuP" + ], + "x-ms-enum": { + "name": "GpuAssignmentTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "GpuDDA", + "value": "GpuDDA", + "description": "Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA)" + }, + { + "name": "GpuP", + "value": "GpuP", + "description": "Attach Graphics Processing Unit (GPU) using GPU Partitioning" + } + ] + } + }, + "GuestAgent": { + "type": "object", + "description": "Defines the GuestAgent.", + "properties": { + "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GuestAgentInstallStatus": { + "type": "object", + "description": "Defines the status of a guest agent installation.", + "properties": { + "vmUuid": { + "type": "string", + "description": "Specifies the VM's unique SMBIOS ID.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StatusTypes", + "description": "The installation status of the hybrid machine agent installation.", + "readOnly": true + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The time of the last status change.", + "readOnly": true + }, + "agentVersion": { + "type": "string", + "description": "The hybrid machine agent full version.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Details about the error state.", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "GuestAgentListResult": { + "type": "object", + "description": "The response of a GuestAgent list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuestAgent items on this page", + "items": { + "$ref": "#/definitions/GuestAgent" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GuestAgentProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." + }, + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "The guest agent provisioning action." + }, + "status": { + "type": "string", + "description": "The guest agent status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "GuestCredential": { + "type": "object", + "description": "Username / Password Credentials to connect to guest.", + "properties": { + "username": { + "type": "string", + "description": "The username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to connect with the guest.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "HardwareProfileUpdate": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "$ref": "#/definitions/VmSizeEnum", + "description": "VM Size Enum" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - updated list of GPUs on the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpProxy": { + "type": "string", + "format": "password", + "description": "The HTTP proxy server endpoint to use.", + "x-ms-secret": true + }, + "httpsProxy": { + "type": "string", + "format": "password", + "description": "The HTTPS proxy server endpoint to use.", + "x-ms-secret": true + }, + "noProxy": { + "type": "array", + "description": "The endpoints that should not go through proxy.", + "items": { + "type": "string" + } + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "HybridIdentityMetadata": { + "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/HybridIdentityMetadataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a HybridIdentityMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadataProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "resourceUid": { + "type": "string", + "description": "The unique identifier for the resource." + }, + "publicKey": { + "type": "string", + "description": "The Public Key." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "HyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true, + "values": [ + { + "name": "V1", + "value": "V1", + "description": "Generation 1 (V1) hypervisor" + }, + { + "name": "V2", + "value": "V2", + "description": "Generation 2 (V2) hypervisor" + } + ] + } + }, + "IPConfiguration": { + "type": "object", + "description": "InterfaceIPConfiguration IPConfiguration in a network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/IPConfigurationProperties", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration." + } + } + }, + "IPConfigurationProperties": { + "type": "object", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration.", + "properties": { + "gateway": { + "type": "string", + "description": "Gateway for network interface", + "readOnly": true + }, + "prefixLength": { + "type": "string", + "description": "prefixLength for network interface", + "readOnly": true + }, + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress - Private IP address of the IP configuration." + }, + "subnet": { + "$ref": "#/definitions/LogicalNetworkArmReference", + "description": "Subnet - Name of Subnet bound to the IP configuration." + } + } + }, + "IPPool": { + "type": "object", + "description": "Describes IPPool", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP-Pool" + }, + "ipPoolType": { + "$ref": "#/definitions/IPPoolTypeEnum", + "description": "Type of the IP Pool [vm, vippool]" + }, + "start": { + "type": "string", + "description": "Start of the IP address pool" + }, + "end": { + "type": "string", + "description": "End of the IP address pool" + }, + "info": { + "$ref": "#/definitions/IPPoolInfo", + "description": "IPPool info" + } + } + }, + "IPPoolInfo": { + "type": "object", + "description": "IP Pool info", + "properties": { + "used": { + "type": "string", + "description": "Number of IP addresses allocated from the IP Pool", + "readOnly": true + }, + "available": { + "type": "string", + "description": "Number of IP addresses available in the IP Pool", + "readOnly": true + } + } + }, + "IPPoolTypeEnum": { + "type": "string", + "description": "Type of the IP Pool [vm, vippool]", + "enum": [ + "vm", + "vippool" + ], + "x-ms-enum": { + "name": "IPPoolTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "vm", + "value": "vm", + "description": "Virtual Machine IP Pool" + }, + { + "name": "vippool", + "value": "vippool", + "description": "VIP Pool" + } + ] + } + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID of resource identity. The value must be an UUID.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource. The value must be an UUID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "modelAsString": false + } + } + } + }, + "ImageArmReference": { + "type": "object", + "description": "The ARM ID for a Gallery Image.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for an image resource used by the virtual machine instance.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/galleryImages" + }, + { + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages" + } + ] + } + } + } + }, + "InstanceViewStatus": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "$ref": "#/definitions/StatusLevelTypes", + "description": "The level code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + }, + "InterfaceDNSSettings": { + "type": "object", + "description": "DNS Settings of the interface", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS server IP Addresses for the interface", + "items": { + "type": "string" + } + } + } + }, + "IpAllocationMethodEnum": { + "type": "string", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "IpAllocationMethodEnum", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamic IP allocation method" + }, + { + "name": "Static", + "value": "Static", + "description": "Static IP allocation method" + } + ] + } + }, + "LogicalNetwork": { + "type": "object", + "description": "The logical network resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "LogicalNetworkArmReference": { + "type": "object", + "description": "The ARM ID for a Logical Network.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Logical Network.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/logicalNetworks" + }, + { + "type": "Microsoft.NetworkCloud/cloudServicesNetworks" + }, + { + "type": "Microsoft.NetworkCloud/l2Networks" + }, + { + "type": "Microsoft.NetworkCloud/l3Networks" + }, + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" + } + ] + } + } + } + }, + "LogicalNetworkListResult": { + "type": "object", + "description": "The response of a LogicalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogicalNetwork items on this page", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogicalNetworkProperties": { + "type": "object", + "description": "Properties under the logical network resource", + "properties": { + "dhcpOptions": { + "$ref": "#/definitions/LogicalNetworkPropertiesDhcpOptions", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options." + }, + "subnets": { + "type": "array", + "description": "Subnet - list of subnets under the logical network", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the logical network.", + "readOnly": true + }, + "vmSwitchName": { + "type": "string", + "description": "name of the network switch to be used for VMs" + }, + "status": { + "$ref": "#/definitions/LogicalNetworkStatus", + "description": "The observed state of logical networks", + "readOnly": true + } + } + }, + "LogicalNetworkPropertiesDhcpOptions": { + "type": "object", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.", + "properties": { + "dnsServers": { + "type": "array", + "description": "The list of DNS servers IP addresses.", + "items": { + "type": "string" + } + } + } + }, + "LogicalNetworkStatus": { + "type": "object", + "description": "The observed state of logical networks", + "properties": { + "errorCode": { + "type": "string", + "description": "LogicalNetwork provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/LogicalNetworkStatusProvisioningStatus", + "description": "Logical network provisioning status" + } + } + }, + "LogicalNetworkStatusProvisioningStatus": { + "type": "object", + "description": "Describes the status of the provisioning.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the logical network" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the logical network [Succeeded, Failed, InProgress]" + } + } + }, + "LogicalNetworksUpdateRequest": { + "type": "object", + "description": "The logical network resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImage": { + "type": "object", + "description": "The marketplace gallery image resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/MarketplaceGalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "MarketplaceGalleryImageListResult": { + "type": "object", + "description": "The response of a MarketplaceGalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MarketplaceGalleryImage items on this page", + "items": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MarketplaceGalleryImageProperties": { + "type": "object", + "description": "Properties under the marketplace gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for marketplace gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the marketplace gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MarketplaceGalleryImageStatus", + "description": "The observed state of marketplace gallery images", + "readOnly": true + } + }, + "required": [ + "osType" + ] + }, + "MarketplaceGalleryImageStatus": { + "type": "object", + "description": "The observed state of marketplace gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "MarketplaceGalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusProvisioningStatus", + "description": "Provisioning status of marketplace gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + } + }, + "MarketplaceGalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "MarketplaceGalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "Marketplace GalleryImage provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "MarketplaceGalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in MarketplaceGalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImagesUpdateRequest": { + "type": "object", + "description": "The marketplace gallery image resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterface": { + "type": "object", + "description": "The network interface resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "NetworkInterfaceArmReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Properties under the network interface resource", + "properties": { + "ipConfigurations": { + "type": "array", + "description": "IPConfigurations - A list of IPConfigurations of the network interface.", + "items": { + "$ref": "#/definitions/IPConfiguration" + }, + "x-ms-identifiers": [] + }, + "macAddress": { + "type": "string", + "description": "MacAddress - The MAC address of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/InterfaceDNSSettings", + "description": "DNS Settings for the interface" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the network interface.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/NetworkInterfaceStatus", + "description": "The observed state of network interfaces", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the network interface." + }, + "createFromLocal": { + "type": "boolean", + "description": "Boolean indicating whether this is a local network interface or if one should be created.", + "default": false + } + } + }, + "NetworkInterfaceStatus": { + "type": "object", + "description": "The observed state of network interfaces", + "properties": { + "errorCode": { + "type": "string", + "description": "NetworkInterface provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/NetworkInterfaceStatusProvisioningStatus", + "description": "Network interface provisioning status" + } + } + }, + "NetworkInterfaceStatusProvisioningStatus": { + "type": "object", + "description": "Network interface provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the network interface" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the network interface [Succeeded, Failed, InProgress]" + } + } + }, + "NetworkInterfaceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkInterface resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterfacesUpdateRequest": { + "type": "object", + "description": "The network interface resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkSecurityGroup": { + "type": "object", + "description": "NetworkSecurityGroup resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkSecurityGroupArmReference": { + "type": "object", + "description": "The ARM ID for a Network Security Group.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Security Group.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkSecurityGroups" + } + ] + } + } + } + }, + "NetworkSecurityGroupListResult": { + "type": "object", + "description": "The response of a NetworkSecurityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkSecurityGroup items on this page", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkSecurityGroupProperties": { + "type": "object", + "description": "Network Security Group resource.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "A collection of references to network interfaces that are currently using this NSG.", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "A collection of references to logical networks that are currently using this NSG", + "items": { + "$ref": "#/definitions/LogicalNetworkArmReference" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "The provisioning state of the network security group resource.", + "readOnly": true + } + } + }, + "NetworkSecurityGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkSecurityGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "Operating system type that the gallery image uses [Windows, Linux]", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system" + } + ] + } + }, + "OsProfileUpdate": { + "type": "object", + "description": "OsProfile - describes the update configuration of the operating system", + "properties": { + "computerName": { + "type": "string", + "description": "ComputerName - name of the computer" + }, + "linuxConfiguration": { + "$ref": "#/definitions/OsProfileUpdateLinuxConfiguration", + "description": "Linux configuration properties" + }, + "windowsConfiguration": { + "$ref": "#/definitions/OsProfileUpdateWindowsConfiguration", + "description": "Windows configuration properties" + } + } + }, + "OsProfileUpdateLinuxConfiguration": { + "type": "object", + "description": "OSProfile update linux configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "OsProfileUpdateWindowsConfiguration": { + "type": "object", + "description": "OSProfile update windows configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "PowerStateEnum": { + "type": "string", + "description": "The power state of the virtual machine instance", + "enum": [ + "Deallocated", + "Deallocating", + "Running", + "Starting", + "Stopped", + "Stopping", + "Paused", + "Saved", + "Unknown" + ], + "x-ms-enum": { + "name": "PowerStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Deallocated", + "value": "Deallocated", + "description": "Virtual machine deallocated" + }, + { + "name": "Deallocating", + "value": "Deallocating", + "description": "Virtual machine deallocating" + }, + { + "name": "Running", + "value": "Running", + "description": "Virtual machine running" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Virtual machine starting" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Virtual machine stopped" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Virtual machine stopping" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Virtual machine paused" + }, + { + "name": "Saved", + "value": "Saved", + "description": "Virtual machine Saved," + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Power state of the virtual machine is unknown" + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Defines the different types of operations for guest agent.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent" + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent" + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent" + } + ] + } + }, + "ProvisioningStateEnum": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "InProgress", + "Accepted", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning has failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning has been accepted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion of the resource is in progress" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning has been canceled" + } + ] + }, + "readOnly": true + }, + "Route": { + "type": "object", + "description": "Route - Route resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RouteProperties", + "description": "Properties of the route.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - name of the subnet", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "RouteProperties": { + "type": "object", + "description": "RoutePropertiesFormat - Route resource.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + } + } + }, + "RouteTable": { + "type": "object", + "description": "Route table resource.", + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RouteTableProperties", + "description": "Properties of the route table.", + "x-ms-client-flatten": true + } + } + }, + "RouteTableProperties": { + "type": "object", + "description": "RouteTablePropertiesFormat - Route Table resource.", + "properties": { + "routes": { + "type": "array", + "description": "Collection of routes contained within a route table.", + "items": { + "$ref": "#/definitions/Route" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityRule": { + "type": "object", + "description": "Security Rule resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityRuleProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Network traffic is allowed" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Network traffic is denied" + } + ] + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true, + "values": [ + { + "name": "Inbound", + "value": "Inbound", + "description": "Rule is evaluated on incoming traffic" + }, + { + "name": "Outbound", + "value": "Outbound", + "description": "Rule is evaluated on outgoing traffic" + } + ] + } + }, + "SecurityRuleListResult": { + "type": "object", + "description": "The response of a SecurityRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecurityRule items on this page", + "items": { + "$ref": "#/definitions/SecurityRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecurityRuleProperties": { + "type": "object", + "description": "Security rule resource.", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "$ref": "#/definitions/SecurityRuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sourceAddressPrefixes": { + "type": "array", + "description": "The CIDR or source IP ranges.", + "items": { + "type": "string" + } + }, + "destinationAddressPrefixes": { + "type": "array", + "description": "The destination address prefixes. CIDR or destination IP ranges.", + "items": { + "type": "string" + } + }, + "sourcePortRanges": { + "type": "array", + "description": "The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "destinationPortRanges": { + "type": "array", + "description": "The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the SR", + "readOnly": true + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ] + }, + "SecurityRuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true, + "values": [ + { + "name": "Tcp", + "value": "Tcp", + "description": "Transmission Control Protocol" + }, + { + "name": "Udp", + "value": "Udp", + "description": "User Datagram Protocol" + }, + { + "name": "Icmp", + "value": "Icmp", + "description": "Internet Control Message Protocol" + }, + { + "name": "Asterisk", + "value": "*", + "description": "Wildcard rule for all protocols" + } + ] + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "Trusted Launch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential VM security type" + } + ] + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "Status": { + "type": "string", + "description": "The status of the operation performed on the resource [Succeeded, Failed, InProgress]", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operation failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Operation is in progress" + } + ] + }, + "readOnly": true + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Informational status level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning status level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error status level" + } + ] + } + }, + "StatusTypes": { + "type": "string", + "description": "The installation status of the hybrid machine agent installation.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Installation succeeded" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Installation in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Installation failed" + } + ] + }, + "readOnly": true + }, + "StorageContainer": { + "type": "object", + "description": "The storage container resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageContainerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "StorageContainerArmReference": { + "type": "object", + "description": "The ARM ID for a Storage Container.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Storage Container.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "StorageContainerListResult": { + "type": "object", + "description": "The response of a StorageContainer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The StorageContainer items on this page", + "items": { + "$ref": "#/definitions/StorageContainer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StorageContainerProperties": { + "type": "object", + "description": "Properties under the storage container resource", + "properties": { + "path": { + "type": "string", + "description": "Path of the storage container on the disk" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the storage container.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StorageContainerStatus", + "description": "The observed state of storage containers", + "readOnly": true + } + }, + "required": [ + "path" + ] + }, + "StorageContainerStatus": { + "type": "object", + "description": "The observed state of storage containers", + "properties": { + "errorCode": { + "type": "string", + "description": "StorageContainer provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "availableSizeMB": { + "type": "integer", + "format": "int64", + "description": "Amount of space available on the disk in MB" + }, + "containerSizeMB": { + "type": "integer", + "format": "int64", + "description": "Total size of the disk in MB" + }, + "provisioningStatus": { + "$ref": "#/definitions/StorageContainerStatusProvisioningStatus", + "description": "Storage container's provisioning status" + } + } + }, + "StorageContainerStatusProvisioningStatus": { + "type": "object", + "description": "Storage container provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the storage container" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the storage container [Succeeded, Failed, InProgress]" + } + } + }, + "StorageContainerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in StorageContainer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageContainersUpdateRequest": { + "type": "object", + "description": "The storage container resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageProfileUpdate": { + "type": "object", + "description": "Storage profile update", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance for the update call", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + } + } + }, + "Subnet": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "properties": { + "$ref": "#/definitions/SubnetProperties", + "description": "Properties of the subnet.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "SubnetIpConfigurationReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "ID": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6." + }, + "addressPrefixes": { + "type": "array", + "description": "List of address prefixes for the subnet.", + "items": { + "type": "string" + } + }, + "ipAllocationMethod": { + "$ref": "#/definitions/IpAllocationMethodEnum", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'" + }, + "ipConfigurationReferences": { + "type": "array", + "description": "IPConfigurationReferences - list of IPConfigurationReferences", + "items": { + "$ref": "#/definitions/SubnetIpConfigurationReference" + }, + "x-ms-identifiers": [] + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the logical network." + }, + "routeTable": { + "$ref": "#/definitions/RouteTable", + "description": "Route table resource." + }, + "ipPools": { + "type": "array", + "description": "network associated pool of IP Addresses", + "items": { + "$ref": "#/definitions/IPPool" + }, + "x-ms-identifiers": [] + }, + "vlan": { + "type": "integer", + "format": "int32", + "description": "Vlan to use for the subnet" + } + } + }, + "TagsObject": { + "type": "object", + "description": "Tags object for patch operations.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "The virtual hard disk resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualHardDiskProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualHardDiskArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Hard Disk.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + } + } + }, + "VirtualHardDiskDownloadStatus": { + "type": "object", + "description": "The download status of the virtual hard disk", + "properties": { + "downloadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the virtual hard disk in MB" + } + } + }, + "VirtualHardDiskListResult": { + "type": "object", + "description": "The response of a VirtualHardDisk list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualHardDisk items on this page", + "items": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualHardDiskProperties": { + "type": "object", + "description": "Properties under the virtual hard disk resource", + "properties": { + "blockSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Block size in bytes" + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "Size of the disk in GB" + }, + "dynamic": { + "type": "boolean", + "description": "Boolean for enabling dynamic sizing on the virtual hard disk" + }, + "logicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Logical sector in bytes" + }, + "physicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Physical sector in bytes" + }, + "downloadUrl": { + "type": "string", + "format": "password", + "description": "URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.", + "x-ms-secret": true + }, + "createFromLocal": { + "type": "boolean", + "description": "Boolean indicating whether this is a local hard disk or if one should be created.", + "default": false + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type of the OS disk. Possible values are: Windows, Linux." + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "diskFileFormat": { + "$ref": "#/definitions/DiskFileFormat", + "description": "The format of the actual VHD file [vhd, vhdx]" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual hard disk.", + "readOnly": true + }, + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for VHD", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "status": { + "$ref": "#/definitions/VirtualHardDiskStatus", + "description": "The observed state of virtual hard disks", + "readOnly": true + } + } + }, + "VirtualHardDiskStatus": { + "type": "object", + "description": "The observed state of virtual hard disks", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualHardDisk provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualHardDiskStatusProvisioningStatus", + "description": "Provisioning status of the vhd" + }, + "downloadStatus": { + "$ref": "#/definitions/VirtualHardDiskDownloadStatus", + "description": "The download status of the virtual hard disk" + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + } + }, + "VirtualHardDiskStatusProvisioningStatus": { + "type": "object", + "description": "VHD Status provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual hard disk" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDiskTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualHardDisk resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDiskUploadRequest": { + "type": "object", + "description": "Request for uploading virtual hard disk.", + "properties": { + "azureManagedDiskUploadUrl": { + "type": "string", + "format": "password", + "description": "The Azure managed disk SAS URL to upload the virtual hard disk to.", + "x-ms-secret": true + } + }, + "required": [ + "azureManagedDiskUploadUrl" + ] + }, + "VirtualHardDiskUploadResponse": { + "type": "object", + "description": "Response for uploading virtual hard disk.", + "properties": { + "virtualHardDiskId": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + } + }, + "VirtualHardDiskUploadStatus": { + "type": "object", + "description": "The upload status of the virtual hard disk", + "properties": { + "uploadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The uploaded sized of the virtual hard disk in MB" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDisksUpdateRequest": { + "type": "object", + "description": "The virtual hard disk resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachineArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Machine.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Machine.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + } + }, + "VirtualMachineConfigAgentInstanceView": { + "type": "object", + "description": "The instance view of the VM Config Agent running on the virtual machine.", + "properties": { + "vmConfigAgentVersion": { + "type": "string", + "description": "The VM Config Agent full version." + }, + "statuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstance": { + "type": "object", + "description": "The virtual machine instance resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualMachineInstanceListResult": { + "type": "object", + "description": "The response of a VirtualMachineInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineInstance items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineInstanceProperties": { + "type": "object", + "description": "Properties under the virtual machine instance resource", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfile", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesNetworkProfile", + "description": "NetworkProfile - describes the network configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfile", + "description": "OsProfile - describes the configuration of the operating system and sets login data" + }, + "securityProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfile", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfile", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance" + }, + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "description": "The virtual machine instance view.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/VirtualMachineInstanceStatus", + "description": "The observed state of virtual machine instances", + "readOnly": true + }, + "guestAgentInstallStatus": { + "$ref": "#/definitions/GuestAgentInstallStatus", + "description": "Guest agent install status." + }, + "vmId": { + "type": "string", + "description": "Unique identifier for the vm resource.", + "readOnly": true + }, + "resourceUid": { + "type": "string", + "description": "Unique identifier defined by ARC to identify the guest of the VM." + }, + "createFromLocal": { + "type": "boolean", + "description": "Boolean indicating whether this is a local virtual machine or if one should be created.", + "default": false + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfile": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "type": "string", + "description": "Enum of VM Sizes", + "default": "Default", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "dynamicMemoryConfig": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig", + "description": "Dynamic memory config" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - list of gpus to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig": { + "type": "object", + "description": "Dynamic memory config", + "properties": { + "maximumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Maximum memory in MB" + }, + "minimumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Minimum memory in MB" + }, + "targetMemoryBuffer": { + "type": "integer", + "format": "int32", + "description": "Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU": { + "type": "object", + "description": "GPU properties - describes the GPU configuration.", + "properties": { + "assignmentType": { + "$ref": "#/definitions/GpuAssignmentTypeEnum", + "description": "GPU assignment type" + }, + "partitionSizeMB": { + "type": "integer", + "format": "int64", + "description": "Size of gpu partition in MB for GPU-P" + }, + "gpuName": { + "type": "string", + "description": "Name of the GPU" + } + }, + "required": [ + "assignmentType" + ] + }, + "VirtualMachineInstancePropertiesNetworkProfile": { + "type": "object", + "description": "NetworkProfile - describes the network configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesOsProfile": { + "type": "object", + "description": "OsProfile - describes the configuration of the operating system and sets login data", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "AdminPassword - admin password", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "adminUsername": { + "type": "string", + "description": "AdminUsername - admin username" + }, + "computerName": { + "type": "string", + "description": "ComputerName - name of the compute" + }, + "linuxConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileLinuxConfiguration", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance" + }, + "windowsConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileWindowsConfiguration", + "description": "Windows Configuration for the virtual machine instance" + } + } + }, + "VirtualMachineInstancePropertiesOsProfileLinuxConfiguration": { + "type": "object", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "DisablePasswordAuthentication - whether password authentication should be disabled" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesOsProfileWindowsConfiguration": { + "type": "object", + "description": "Windows Configuration for the virtual machine instance", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Whether to EnableAutomaticUpdates on the machine" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for Windows OS." + }, + "timeZone": { + "type": "string", + "description": "TimeZone for the virtual machine instance" + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfile": { + "type": "object", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance.", + "properties": { + "enableTPM": { + "type": "boolean", + "description": "Enable TPM flag", + "default": false + }, + "uefiSettings": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfileUefiSettings", + "description": "Uefi settings of the virtual machine instance" + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function." + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfileUefiSettings": { + "type": "object", + "description": "Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine instance.", + "default": false + } + } + }, + "VirtualMachineInstancePropertiesStorageProfile": { + "type": "object", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + }, + "imageReference": { + "$ref": "#/definitions/ImageArmReference", + "description": "Which Image to use for the virtual machine instance", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfileOsDisk", + "description": "VHD to attach as OS disk" + }, + "vmConfigStoragePathId": { + "type": "string", + "format": "arm-id", + "description": "Id of the storage container that hosts the VM configuration file", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "VirtualMachineInstancePropertiesStorageProfileOsDisk": { + "type": "object", + "description": "VHD to attach as OS disk", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux." + } + } + }, + "VirtualMachineInstanceStatus": { + "type": "object", + "description": "The observed state of virtual machine instances", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualMachine provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "powerState": { + "$ref": "#/definitions/PowerStateEnum", + "description": "The power state of the virtual machine instance" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualMachineInstanceStatusProvisioningStatus", + "description": "Provisioning status of the virtual machine instance" + } + } + }, + "VirtualMachineInstanceStatusProvisioningStatus": { + "type": "object", + "description": "Virtual machine instance provisioning status.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual machine instance" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualMachineInstanceUpdateProperties": { + "type": "object", + "description": "Defines the resource properties for the update.", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "StorageProfile - Specifies the storage settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/OsProfileUpdate", + "description": "OsProfile - describes the update configuration of the operating system" + } + } + }, + "VirtualMachineInstanceUpdateRequest": { + "type": "object", + "description": "The virtual machine instance resource patch definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "Defines the resource properties for the update." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + } + }, + "VirtualMachineInstanceView": { + "type": "object", + "description": "The instance view of a virtual machine.", + "properties": { + "vmAgent": { + "$ref": "#/definitions/VirtualMachineConfigAgentInstanceView", + "description": "The VM Config Agent running on the virtual machine." + } + } + }, + "VmSizeEnum": { + "type": "string", + "description": "VM Sizes", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/AttestationStatuses_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/AttestationStatuses_Get.json new file mode 100644 index 000000000000..d339fdebc4f7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/AttestationStatuses_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/AttestationStatus", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default", + "properties": { + "attestSecureBootEnabled": "Disabled", + "attestationCertValidated": "Invalid", + "bootIntegrityValidated": "Invalid", + "errorMessage": "Attestation token has invalid signature", + "healthStatus": "Unhealthy", + "linuxKernelVersion": "1.0.0.0", + "timestamp": "2023/11/10 9:48", + "attestHardwarePlatform": "Unknown", + "attestDiskSecurityEncryptionType": "Unknown" + } + } + } + }, + "operationId": "AttestationStatuses_Get", + "title": "GetAttestationStatus" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..a0219040aeef --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_CreateOrUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "imagePath": "C:\\test.vhdx", + "osType": "Linux" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Succeeded", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_CreateOrUpdate", + "title": "PutGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Delete.json new file mode 100644 index 000000000000..c87318aeb68e --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Delete", + "title": "DeleteGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Get.json new file mode 100644 index 000000000000..105faa9fd489 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "GalleryImages_Get", + "title": "GetGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListAll.json new file mode 100644 index 000000000000..5a33d2932869 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListAll", + "title": "ListGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..1e57ba6027a4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_ListByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "GalleryImages_ListByResourceGroup", + "title": "ListGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Update.json new file mode 100644 index 000000000000..b8765cba7cd7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GalleryImages_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "galleryImageName": "test-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-gallery-image", + "type": "Microsoft.AzureStackHCI/galleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-galimg3325", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V2", + "osType": "Linux", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GalleryImages_Update", + "title": "UpdateGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Create.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Create.json new file mode 100644 index 000000000000..7663f4459c2b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Create.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resource": { + "properties": { + "credentials": { + "password": "<password>", + "username": "tempuser" + }, + "provisioningAction": "install" + } + }, + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + }, + "201": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Created", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Create", + "title": "CreateGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Delete.json new file mode 100644 index 000000000000..b3e1105e076c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "GuestAgents_Delete", + "title": "DeleteGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Get.json new file mode 100644 index 000000000000..0b8f12803a13 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + } + }, + "operationId": "GuestAgents_Get", + "title": "GetGuestAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..22a9816a093c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/GuestAgents_ListByVirtualMachineInstance.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/guestAgents", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default", + "properties": { + "provisioningAction": "install", + "provisioningState": "Succeeded", + "status": "connected" + } + } + ] + } + } + }, + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "title": "GuestAgentListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadataGroup_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadataGroup_Get.json new file mode 100644 index 000000000000..956c696255bc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadataGroup_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + } + }, + "operationId": "HybridIdentityMetadata_Get", + "title": "GetHybridIdentityMetadata" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json new file mode 100644 index 000000000000..4a7d20505a7d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances/hybridIdentityMetadata", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default", + "properties": { + "identity": { + "type": "SystemAssigned", + "principalId": "7b5129bc-8642-4a6a-95f8-63400ca6ec4d", + "tenantId": "ec46ca82-5d4a-4e3e-b4b7-e27f9318645d" + }, + "publicKey": "8ec7d60c-9700-40b1-8e6e-e5b2f6f477f2" + } + } + ] + } + } + }, + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "title": "HybridIdentityMetadataListByVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..541a8d04bd12 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_CreateOrUpdate.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2" + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "LogicalNetworks_CreateOrUpdate", + "title": "PutLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Delete.json new file mode 100644 index 000000000000..89ebae14d6ed --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Delete", + "title": "DeleteLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Get.json new file mode 100644 index 000000000000..a3a3b0aad8ba --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "LogicalNetworks_Get", + "title": "GetLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListAll.json new file mode 100644 index 000000000000..361afb916417 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListAll.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListAll", + "title": "ListLogicalNetworkBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListByResourceGroup.json new file mode 100644 index 000000000000..e1bdfe2716ae --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_ListByResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "LogicalNetworks_ListByResourceGroup", + "title": "ListLogicalNetworkByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Update.json new file mode 100644 index 000000000000..182ced9b0543 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/LogicalNetworks_Update.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "logicalNetworkName": "test-lnet", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-lnet", + "type": "Microsoft.AzureStackHCI/logicalNetworks", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet", + "location": "West US2", + "properties": { + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "LogicalNetworks_Update", + "title": "UpdateLogicalNetwork" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json new file mode 100644 index 000000000000..52554d81e4f4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_CreateOrUpdate.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "name": "test-marketplace-gallery-image", + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "version": { + "name": "1.0.0" + } + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + }, + "201": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Creating", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "title": "PutMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Delete.json new file mode 100644 index 000000000000..ac7ff6b32350 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Delete", + "title": "DeleteMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Get.json new file mode 100644 index 000000000000..394327ce3269 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Get.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplace-gallery-image", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "NoCloud", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + } + }, + "operationId": "MarketplaceGalleryImages_Get", + "title": "GetMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListAll.json new file mode 100644 index 000000000000..aa74afc3a4e5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListAll.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListAll", + "title": "ListMarketplaceGalleryImageBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json new file mode 100644 index 000000000000..2c499fd4dd41 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_ListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 100, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "Succeeded" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + } + } + ] + } + } + }, + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "title": "ListMarketplaceGalleryImageByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Update.json new file mode 100644 index 000000000000..f42d21232f8b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/MarketplaceGalleryImages_Update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "marketplaceGalleryImageName": "test-marketplce-gallery-image", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-marketplace-gallery-image", + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image", + "location": "West US2", + "properties": { + "cloudInitDataSource": "Azure", + "containerId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-storage-container", + "hyperVGeneration": "V1", + "identifier": { + "offer": "myOfferName", + "publisher": "myPublisherName", + "sku": "mySkuName" + }, + "osType": "Windows", + "provisioningState": "Accepted", + "status": { + "downloadStatus": { + "downloadSizeInMB": 9383 + }, + "progressPercentage": 0, + "provisioningStatus": { + "operationId": "79cfc696-44f5-4a68-a620-21850f7e9fb0", + "status": "InProgress" + } + }, + "version": { + "name": "1.0.0", + "properties": { + "storageProfile": { + "osDiskImage": { + "sizeInMB": 30270 + } + } + } + } + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "MarketplaceGalleryImages_Update", + "title": "UpdateMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json new file mode 100644 index 000000000000..6154e5928cb9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "eastus", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ] + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkInterfaces_CreateOrUpdate", + "title": "PutNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Delete.json new file mode 100644 index 000000000000..580f2e678f95 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Delete", + "title": "DeleteNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Get.json new file mode 100644 index 000000000000..cb3dd2e821a5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "NetworkInterfaces_Get", + "title": "GetNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListAll.json new file mode 100644 index 000000000000..453b28046975 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListAll.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListAll", + "title": "ListNetworkInterfaceBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json new file mode 100644 index 000000000000..30b7fbcfb730 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_ListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "NetworkInterfaces_ListByResourceGroup", + "title": "ListNetworkInterfaceByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Update.json new file mode 100644 index 000000000000..7f5fd3b05ecf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkInterfaces_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkInterfaceName": "test-nic", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "type": "Microsoft.AzureStackHCI/networkInterfaces", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic", + "location": "West US2", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig-sample", + "properties": { + "subnet": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/logicalNetworks/test-lnet" + } + } + } + ], + "provisioningState": "Accepted" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkInterfaces_Update", + "title": "UpdateNetworkInterface" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json new file mode 100644 index 000000000000..841e24009947 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_CreateOrUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resource": { + "location": "eastus" + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "title": "CreateNetworkSecurityGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Delete.json new file mode 100644 index 000000000000..4fc0b92e58b0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_Delete", + "title": "Delete network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Get.json new file mode 100644 index 000000000000..dfb438bfafb0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg1/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "NetworkSecurityGroups_Get", + "title": "Get network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListAll.json new file mode 100644 index 000000000000..bfbd0977f166 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg2", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/rg2/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg2", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListAll", + "title": "List all network security groups" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json new file mode 100644 index 000000000000..903104d4e17d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_ListByResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg1", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nsg3", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/nsg3", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + }, + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "title": "List network security groups in resource group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_UpdateTags.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_UpdateTags.json new file mode 100644 index 000000000000..efe01ef99c08 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/NetworkSecurityGroups_UpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "properties": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "type": "Microsoft.AzureStackHCI/networkSecurityGroups", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "NetworkSecurityGroups_UpdateTags", + "title": "Update network security group tags" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_CreateOrUpdate.json new file mode 100644 index 000000000000..ac96358ef200 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_CreateOrUpdate.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "resource": { + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + }, + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_CreateOrUpdate", + "title": "SecurityRulesCreateOrUpdate" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Delete.json new file mode 100644 index 000000000000..ae63db18e876 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Delete.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "SecurityRules_Delete", + "title": "SecurityRulesDelete" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Get.json new file mode 100644 index 000000000000..e4da57024895 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "securityRuleName": "rule1", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + } + }, + "operationId": "SecurityRules_Get", + "title": "Get network security rule in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json new file mode 100644 index 000000000000..b556d8a21208 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/SecurityRules_ListByNetworkSecurityGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "networkSecurityGroupName": "testnsg", + "resourceGroupName": "testrg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/networkSecurityGroups/testnsg/securityRule/rule1", + "properties": { + "access": "Allow", + "destinationAddressPrefixes": [ + "*" + ], + "destinationPortRanges": [ + "80" + ], + "direction": "Inbound", + "priority": 130, + "sourceAddressPrefixes": [ + "*" + ], + "sourcePortRanges": [ + "*" + ], + "protocol": "*" + } + } + ] + } + } + }, + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "title": "List network security rules in network security group" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_CreateOrUpdate.json new file mode 100644 index 000000000000..905d891b4a4a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_CreateOrUpdate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "path": "C:\\container_storage" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "StorageContainers_CreateOrUpdate", + "title": "PutStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Delete.json new file mode 100644 index 000000000000..fbf14e5eaeec --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Delete", + "title": "DeleteStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Get.json new file mode 100644 index 000000000000..8631e9b74b77 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "StorageContainers_Get", + "title": "GetStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListAll.json new file mode 100644 index 000000000000..b58b163a1b73 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListAll.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListAll", + "title": "ListStorageContainerBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListByResourceGroup.json new file mode 100644 index 000000000000..28d803bbbf30 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_ListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/Default_Container", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "StorageContainers_ListByResourceGroup", + "title": "ListStorageContainerByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Update.json new file mode 100644 index 000000000000..f788ae629c84 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/StorageContainers_Update.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "storageContainerName": "Default_Container", + "properties": { + "tags": { + "additionalProperties": "sample" + } + }, + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "name": "Default_Container", + "type": "Microsoft.AzureStackHCI/storageContainers", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-galimg3325", + "location": "West US2", + "properties": { + "path": "C:\\container_storage", + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "StorageContainers_Update", + "title": "UpdateStorageContainer" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json new file mode 100644 index 000000000000..a48a83f0d6f2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_CreateOrUpdate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "location": "West US2", + "properties": { + "diskSizeGB": 32 + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + }, + "201": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Succeeded" + } + } + } + }, + "operationId": "VirtualHardDisks_CreateOrUpdate", + "title": "PutVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Delete.json new file mode 100644 index 000000000000..f3404da91368 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Delete.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Delete", + "title": "DeleteVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Get.json new file mode 100644 index 000000000000..a3ecb1778c34 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd" + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + } + }, + "operationId": "VirtualHardDisks_Get", + "title": "GetVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListAll.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListAll.json new file mode 100644 index 000000000000..0ca42c8a3787 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListAll", + "title": "ListVirtualHardDiskBySubscription" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json new file mode 100644 index 000000000000..1461ca846e54 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + } + } + ] + } + } + }, + "operationId": "VirtualHardDisks_ListByResourceGroup", + "title": "ListVirtualHardDiskByResourceGroup" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Update.json new file mode 100644 index 000000000000..6fee18b8f611 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "properties": { + "tags": { + "additionalProperties": "sample" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vhd", + "type": "Microsoft.AzureStackHCI/virtualHardDisks", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "location": "West US2", + "properties": { + "blockSizeBytes": 0, + "diskFileFormat": "vhdx", + "diskSizeGB": 32, + "dynamic": true, + "hyperVGeneration": "V2", + "logicalSectorBytes": 512, + "physicalSectorBytes": 512, + "provisioningState": "Accepted" + }, + "tags": { + "additionalProperties": "sample" + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualHardDisks_Update", + "title": "UpdateVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Upload.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Upload.json new file mode 100644 index 000000000000..e587b4cd6c1c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualHardDisks_Upload.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceGroupName": "test-rg", + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "virtualHardDiskName": "test-vhd", + "body": { + "azureManagedDiskUploadUrl": "https://YourStorageAccountName.blob.core.windows.net/YourContainerName/YourVHDBlobName.vhd?<sas-token>" + } + }, + "responses": { + "200": { + "body": { + "virtualHardDiskId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "uploadStatus": { + "uploadedSizeInMB": 10240, + "status": "InProgress" + } + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + }, + "operationId": "VirtualHardDisks_Upload", + "title": "UploadVirtualHardDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json new file mode 100644 index 000000000000..9fee0391abdd --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json new file mode 100644 index 000000000000..280313b28e4a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default", + "virtualMachineGPUs": [ + { + "assignmentType": "GpuDDA", + "partitionSizeMB": 0 + } + ] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithGpu" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json new file mode 100644 index 000000000000..6b5f931dc903 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/test-marketplace-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithMarketplaceGalleryImage" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json new file mode 100644 index 000000000000..f96761dced05 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd", + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "provisioningState": "Succeeded", + "storageProfile": { + "osDisk": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithOsDisk" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json new file mode 100644 index 000000000000..bf9c3879a0d1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json @@ -0,0 +1,146 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "resource": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminPassword": "password", + "adminUsername": "localadmin", + "computerName": "luamaster", + "windowsConfiguration": { + "provisionVMConfigAgent": true + } + }, + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "responses": { + "200": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "securityProfile": { + "enableTPM": true, + "uefiSettings": { + "secureBootEnabled": true + } + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + }, + "201": { + "body": { + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "instanceView": { + "vmAgent": { + "statuses": [ + { + "code": "Ok", + "displayStatus": "Ok", + "level": "Info", + "message": "The agent is healthy", + "time": "2009-06-15T13:45:30" + } + ], + "vmConfigAgentVersion": "1.0.0" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Succeeded", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container" + } + } + } + } + }, + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "title": "PutVirtualMachineInstanceWithVMConfigAgent" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Delete.json new file mode 100644 index 000000000000..6637564606dc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + }, + "204": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Delete", + "title": "DeleteVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Get.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Get.json new file mode 100644 index 000000000000..0d663ca1cb4f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Get.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container", + "osDisk": { + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + } + } + } + } + } + }, + "operationId": "VirtualMachineInstances_Get", + "title": "GetVirtualMachineInstance" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_List.json new file mode 100644 index 000000000000..c7e1477bbf47 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_List.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "imageReference": { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + }, + "vmConfigStoragePathId": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/storageContainers/test-container", + "osDisk": { + "managedDisk": { + "securityProfile": { + "securityEncryptionType": "NonPersistedTPM" + } + } + } + } + } + } + ] + } + } + }, + "operationId": "VirtualMachineInstances_List", + "title": "ListVirtualMachineInstances" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Pause.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Pause.json new file mode 100644 index 000000000000..145b176acbca --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Pause.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Pause", + "title": "PauseVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Restart.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Restart.json new file mode 100644 index 000000000000..853261dd3b76 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Restart.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Restart", + "title": "RestartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Save.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Save.json new file mode 100644 index 000000000000..1a6cdebfae81 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Save.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Save", + "title": "SaveVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Start.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Start.json new file mode 100644 index 000000000000..506b5cf0246d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Start.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Start", + "title": "StartVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Stop.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Stop.json new file mode 100644 index 000000000000..ada31ebc5900 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Stop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default" + }, + "responses": { + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Stop", + "title": "StopVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Update.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Update.json new file mode 100644 index 000000000000..0218480a6f75 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/examples/VirtualMachineInstances_Update.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM", + "properties": { + "properties": { + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "default", + "type": "Microsoft.AzureStackHCI/virtualMachineInstances", + "extendedLocation": { + "name": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/dogfood-location", + "type": "CustomLocation" + }, + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.HybridCompute/machines/DemoVM/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default", + "properties": { + "hardwareProfile": { + "vmSize": "Default" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/a95612cb-f1fa-4daa-a4fd-272844fa512c/resourceGroups/dogfoodarc/providers/Microsoft.AzureStackHCI/networkInterfaces/test-nic" + } + ] + }, + "osProfile": { + "adminUsername": "localadmin", + "computerName": "luamaster" + }, + "provisioningState": "Accepted", + "storageProfile": { + "dataDisks": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/virtualHardDisks/test-vhd" + } + ], + "imageReference": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/galleryImages/test-gallery-image" + } + } + } + } + }, + "202": { + "headers": { + "azure-asyncoperation": "http://azure.async.operation/status" + } + } + }, + "operationId": "VirtualMachineInstances_Update", + "title": "UpdateVirtualMachine" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/stackhcivm.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/stackhcivm.json new file mode 100644 index 000000000000..5f2cf9663887 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/preview/2024-08-01-preview/stackhcivm.json @@ -0,0 +1,7341 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-08-01-preview", + "description": "Azure Stack HCI management service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "GalleryImages" + }, + { + "name": "LogicalNetworks" + }, + { + "name": "MarketplaceGalleryImages" + }, + { + "name": "NetworkInterfaces" + }, + { + "name": "NetworkSecurityGroups" + }, + { + "name": "SecurityRules" + }, + { + "name": "StorageContainers" + }, + { + "name": "VirtualHardDisks" + }, + { + "name": "VirtualMachineInstances" + }, + { + "name": "HybridIdentityMetadataGroup" + }, + { + "name": "AttestationStatuses" + }, + { + "name": "GuestAgents" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances": { + "get": { + "operationId": "VirtualMachineInstances_List", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Lists all of the virtual machine instances within the specified parent resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualMachineInstances": { + "$ref": "./examples/VirtualMachineInstances_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default": { + "get": { + "operationId": "VirtualMachineInstances_Get", + "tags": [ + "VirtualMachineInstances" + ], + "description": "Gets a virtual machine instance", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualMachineInstance": { + "$ref": "./examples/VirtualMachineInstances_Get.json" + } + } + }, + "put": { + "operationId": "VirtualMachineInstances_CreateOrUpdate", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualMachineInstance' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "201": { + "description": "Resource 'VirtualMachineInstance' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + }, + "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": { + "PutVirtualMachineInstanceWithGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithGpu": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Gpu.json" + }, + "PutVirtualMachineInstanceWithMarketplaceGalleryImage": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Marketplace_Gallery_Image.json" + }, + "PutVirtualMachineInstanceWithOsDisk": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Os_Disk.json" + }, + "PutVirtualMachineInstanceWithVMConfigAgent": { + "$ref": "./examples/VirtualMachineInstances_CreateOrUpdate_Put_Virtual_Machine_Instance_With_Vm_Config_Agent.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualMachineInstances_Update", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to update a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualMachineInstances_Delete", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to delete a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/attestationStatus/default": { + "get": { + "operationId": "AttestationStatuses_Get", + "tags": [ + "AttestationStatuses" + ], + "description": "Implements AttestationStatus GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/AttestationStatus" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetAttestationStatus": { + "$ref": "./examples/AttestationStatuses_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents": { + "get": { + "operationId": "GuestAgents_ListByVirtualMachineInstance", + "tags": [ + "GuestAgents" + ], + "description": "Returns the list of GuestAgent of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GuestAgentListByVirtualMachineInstances": { + "$ref": "./examples/GuestAgents_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/default": { + "get": { + "operationId": "GuestAgents_Get", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGuestAgent": { + "$ref": "./examples/GuestAgents_Get.json" + } + } + }, + "put": { + "operationId": "GuestAgents_Create", + "tags": [ + "GuestAgents" + ], + "description": "Create Or Update GuestAgent.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GuestAgent" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GuestAgent' update operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + } + }, + "201": { + "description": "Resource 'GuestAgent' create operation succeeded", + "schema": { + "$ref": "#/definitions/GuestAgent" + }, + "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": { + "CreateGuestAgent": { + "$ref": "./examples/GuestAgents_Create.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GuestAgents_Delete", + "tags": [ + "GuestAgents" + ], + "description": "Implements GuestAgent DELETE method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "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": { + "DeleteGuestAgent": { + "$ref": "./examples/GuestAgents_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata": { + "get": { + "operationId": "HybridIdentityMetadata_ListByVirtualMachineInstance", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Returns the list of HybridIdentityMetadata of the given vm.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadataListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "HybridIdentityMetadataListByVirtualMachineInstances": { + "$ref": "./examples/HybridIdentityMetadata_ListByVirtualMachineInstance.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default": { + "get": { + "operationId": "HybridIdentityMetadata_Get", + "tags": [ + "HybridIdentityMetadataGroup" + ], + "description": "Implements HybridIdentityMetadata GET method.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetHybridIdentityMetadata": { + "$ref": "./examples/HybridIdentityMetadataGroup_Get.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/pause": { + "post": { + "operationId": "VirtualMachineInstances_Pause", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to pause a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "PauseVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Pause.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restart": { + "post": { + "operationId": "VirtualMachineInstances_Restart", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to restart a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RestartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Restart.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/save": { + "post": { + "operationId": "VirtualMachineInstances_Save", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to save a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SaveVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Save.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/start": { + "post": { + "operationId": "VirtualMachineInstances_Start", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to start a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StartVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Start.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stop": { + "post": { + "operationId": "VirtualMachineInstances_Stop", + "tags": [ + "VirtualMachineInstances" + ], + "description": "The operation to stop a virtual machine instance.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "StopVirtualMachine": { + "$ref": "./examples/VirtualMachineInstances_Stop.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListAll", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified subscription. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageBySubscription": { + "$ref": "./examples/GalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListAll", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkBySubscription": { + "$ref": "./examples/LogicalNetworks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListAll", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageBySubscription": { + "$ref": "./examples/MarketplaceGalleryImages_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListAll", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified subscription. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceBySubscription": { + "$ref": "./examples/NetworkInterfaces_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListAll", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a subscription.", + "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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroups_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListAll", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified subscription. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerBySubscription": { + "$ref": "./examples/StorageContainers_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListAll", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified subscription. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskBySubscription": { + "$ref": "./examples/VirtualHardDisks_ListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages": { + "get": { + "operationId": "GalleryImages_ListByResourceGroup", + "tags": [ + "GalleryImages" + ], + "description": "Lists all of the gallery images in the specified resource group. Use the nextLink property in the response to get the next page of gallery images.", + "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/GalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListGalleryImageByResourceGroup": { + "$ref": "./examples/GalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/galleryImages/{galleryImageName}": { + "get": { + "operationId": "GalleryImages_Get", + "tags": [ + "GalleryImages" + ], + "description": "Gets a gallery image", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetGalleryImage": { + "$ref": "./examples/GalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "GalleryImages_CreateOrUpdate", + "tags": [ + "GalleryImages" + ], + "description": "The operation to create or update a gallery image. Please note some properties can be set only during gallery image creation.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'GalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "201": { + "description": "Resource 'GalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/GalleryImage" + }, + "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": { + "PutGalleryImage": { + "$ref": "./examples/GalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "GalleryImages_Update", + "tags": [ + "GalleryImages" + ], + "description": "The operation to update a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/GalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/GalleryImage" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateGalleryImage": { + "$ref": "./examples/GalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "GalleryImages_Delete", + "tags": [ + "GalleryImages" + ], + "description": "The operation to delete a gallery image.", + "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": "galleryImageName", + "in": "path", + "description": "Name of the gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteGalleryImage": { + "$ref": "./examples/GalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks": { + "get": { + "operationId": "LogicalNetworks_ListByResourceGroup", + "tags": [ + "LogicalNetworks" + ], + "description": "Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.", + "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/LogicalNetworkListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListLogicalNetworkByResourceGroup": { + "$ref": "./examples/LogicalNetworks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/logicalNetworks/{logicalNetworkName}": { + "get": { + "operationId": "LogicalNetworks_Get", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to get a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Get.json" + } + } + }, + "put": { + "operationId": "LogicalNetworks_CreateOrUpdate", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to create or update a logical network. Please note some properties can be set only during logical network creation.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + } + ], + "responses": { + "200": { + "description": "Resource 'LogicalNetwork' update operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "201": { + "description": "Resource 'LogicalNetwork' create operation succeeded", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + }, + "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": { + "PutLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "LogicalNetworks_Update", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to update a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/LogicalNetworksUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "LogicalNetworks_Delete", + "tags": [ + "LogicalNetworks" + ], + "description": "The operation to delete a logical network.", + "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": "logicalNetworkName", + "in": "path", + "description": "Name of the logical network", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteLogicalNetwork": { + "$ref": "./examples/LogicalNetworks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages": { + "get": { + "operationId": "MarketplaceGalleryImages_ListByResourceGroup", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.", + "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/MarketplaceGalleryImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListMarketplaceGalleryImageByResourceGroup": { + "$ref": "./examples/MarketplaceGalleryImages_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/marketplaceGalleryImages/{marketplaceGalleryImageName}": { + "get": { + "operationId": "MarketplaceGalleryImages_Get", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "Gets a marketplace gallery image", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Get.json" + } + } + }, + "put": { + "operationId": "MarketplaceGalleryImages_CreateOrUpdate", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + } + ], + "responses": { + "200": { + "description": "Resource 'MarketplaceGalleryImage' update operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "201": { + "description": "Resource 'MarketplaceGalleryImage' create operation succeeded", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + }, + "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": { + "PutMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "MarketplaceGalleryImages_Update", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to update a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImageTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "MarketplaceGalleryImages_Delete", + "tags": [ + "MarketplaceGalleryImages" + ], + "description": "The operation to delete a marketplace gallery image.", + "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": "marketplaceGalleryImageName", + "in": "path", + "description": "Name of the marketplace gallery image", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteMarketplaceGalleryImage": { + "$ref": "./examples/MarketplaceGalleryImages_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces": { + "get": { + "operationId": "NetworkInterfaces_ListByResourceGroup", + "tags": [ + "NetworkInterfaces" + ], + "description": "Lists all of the network interfaces in the specified resource group. Use the nextLink property in the response to get the next page of network interfaces.", + "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/NetworkInterfaceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListNetworkInterfaceByResourceGroup": { + "$ref": "./examples/NetworkInterfaces_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkInterfaces/{networkInterfaceName}": { + "get": { + "operationId": "NetworkInterfaces_Get", + "tags": [ + "NetworkInterfaces" + ], + "description": "Gets a network interface", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Get.json" + } + } + }, + "put": { + "operationId": "NetworkInterfaces_CreateOrUpdate", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to create or update a network interface. Please note some properties can be set only during network interface creation.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkInterface' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "201": { + "description": "Resource 'NetworkInterface' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "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": { + "PutNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkInterfaces_Update", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to update a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkInterfaces_Delete", + "tags": [ + "NetworkInterfaces" + ], + "description": "The operation to delete a network interface.", + "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": "networkInterfaceName", + "in": "path", + "description": "Name of the network interface", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteNetworkInterface": { + "$ref": "./examples/NetworkInterfaces_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups": { + "get": { + "operationId": "NetworkSecurityGroups_ListByResourceGroup", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets all network security groups in a 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/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroups_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}": { + "get": { + "operationId": "NetworkSecurityGroups_Get", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Gets the specified network security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroups_Get.json" + } + } + }, + "put": { + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Creates or updates a network security group in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'NetworkSecurityGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "201": { + "description": "Resource 'NetworkSecurityGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "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": { + "CreateNetworkSecurityGroup": { + "$ref": "./examples/NetworkSecurityGroups_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "NetworkSecurityGroups_UpdateTags", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Updates a network security group tags.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroups_UpdateTags.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "NetworkSecurityGroups_Delete", + "tags": [ + "NetworkSecurityGroups" + ], + "description": "Deletes the specified network security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroups_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "operationId": "SecurityRules_ListByNetworkSecurityGroup", + "tags": [ + "SecurityRules" + ], + "description": "Gets all security rules in a Network Security 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/SecurityRules_ListByNetworkSecurityGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "get": { + "operationId": "SecurityRules_Get", + "tags": [ + "SecurityRules" + ], + "description": "Gets the specified security rule.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/SecurityRules_Get.json" + } + } + }, + "put": { + "operationId": "SecurityRules_CreateOrUpdate", + "tags": [ + "SecurityRules" + ], + "description": "Creates or updates a security rule in the specified 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" + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecurityRule' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Resource 'SecurityRule' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "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": { + "SecurityRulesCreateOrUpdate": { + "$ref": "./examples/SecurityRules_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecurityRules_Delete", + "tags": [ + "SecurityRules" + ], + "description": "Deletes the specified security rule.", + "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": "networkSecurityGroupName", + "in": "path", + "description": "Name of the network security group", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "securityRuleName", + "in": "path", + "description": "Name of the security rule.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "SecurityRulesDelete": { + "$ref": "./examples/SecurityRules_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers": { + "get": { + "operationId": "StorageContainers_ListByResourceGroup", + "tags": [ + "StorageContainers" + ], + "description": "Lists all of the storage containers in the specified resource group. Use the nextLink property in the response to get the next page of storage containers.", + "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/StorageContainerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListStorageContainerByResourceGroup": { + "$ref": "./examples/StorageContainers_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/storageContainers/{storageContainerName}": { + "get": { + "operationId": "StorageContainers_Get", + "tags": [ + "StorageContainers" + ], + "description": "Gets a storage container", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetStorageContainer": { + "$ref": "./examples/StorageContainers_Get.json" + } + } + }, + "put": { + "operationId": "StorageContainers_CreateOrUpdate", + "tags": [ + "StorageContainers" + ], + "description": "The operation to create or update a storage container. Please note some properties can be set only during storage container creation.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainer" + } + } + ], + "responses": { + "200": { + "description": "Resource 'StorageContainer' update operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "201": { + "description": "Resource 'StorageContainer' create operation succeeded", + "schema": { + "$ref": "#/definitions/StorageContainer" + }, + "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": { + "PutStorageContainer": { + "$ref": "./examples/StorageContainers_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "StorageContainers_Update", + "tags": [ + "StorageContainers" + ], + "description": "The operation to update a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageContainerTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/StorageContainer" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateStorageContainer": { + "$ref": "./examples/StorageContainers_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "StorageContainers_Delete", + "tags": [ + "StorageContainers" + ], + "description": "The operation to delete a storage container.", + "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": "storageContainerName", + "in": "path", + "description": "Name of the storage container", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteStorageContainer": { + "$ref": "./examples/StorageContainers_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks": { + "get": { + "operationId": "VirtualHardDisks_ListByResourceGroup", + "tags": [ + "VirtualHardDisks" + ], + "description": "Lists all of the virtual hard disks in the specified resource group. Use the nextLink property in the response to get the next page of virtual hard disks.", + "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/VirtualHardDiskListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ListVirtualHardDiskByResourceGroup": { + "$ref": "./examples/VirtualHardDisks_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}": { + "get": { + "operationId": "VirtualHardDisks_Get", + "tags": [ + "VirtualHardDisks" + ], + "description": "Gets a virtual hard disk", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Get.json" + } + } + }, + "put": { + "operationId": "VirtualHardDisks_CreateOrUpdate", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to create or update a virtual hard disk. Please note some properties can be set only during virtual hard disk creation.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + } + ], + "responses": { + "200": { + "description": "Resource 'VirtualHardDisk' update operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "201": { + "description": "Resource 'VirtualHardDisk' create operation succeeded", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + }, + "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": { + "PutVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "VirtualHardDisks_Update", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to update a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDiskTagsUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UpdateVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Update.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHardDisks_Delete", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to delete a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[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": { + "DeleteVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/virtualHardDisks/{virtualHardDiskName}/upload": { + "post": { + "operationId": "VirtualHardDisks_Upload", + "tags": [ + "VirtualHardDisks" + ], + "description": "The operation to upload a virtual hard disk.", + "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": "virtualHardDiskName", + "in": "path", + "description": "Name of the virtual hard disk", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,62}[a-zA-Z0-9]$" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHardDiskUploadRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/VirtualHardDiskUploadResponse" + } + }, + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "UploadVirtualHardDisk": { + "$ref": "./examples/VirtualHardDisks_Upload.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AttestBootIntegrityPropertyEnum": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + } + }, + "AttestCertPropertyEnum": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + } + }, + "AttestDiskSecurityEncryptionTypeEnum": { + "type": "string", + "description": "Defines type of managed disk security encryption type from attestation token.", + "enum": [ + "NonPersistedTPM", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestDiskSecurityEncryptionTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "Disk security encryption type is non-persisted Trusted Platform Module (TPM)" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Disk security encryption type is unknown" + } + ] + } + }, + "AttestHWPlatformEnum": { + "type": "string", + "description": "Defines type of hardware platform from attestation token.", + "enum": [ + "SEVSNP", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHWPlatformEnum", + "modelAsString": true, + "values": [ + { + "name": "SEVSNP", + "value": "SEVSNP", + "description": "AttestHWPlatform is Secure Encrypted Virtualization Secure Nested Paging (SEVSNP)" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "AttestHWPlatform is unknown" + } + ] + } + }, + "AttestHealthStatusEnum": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + } + }, + "AttestSecureBootPropertyEnum": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + } + }, + "AttestationStatus": { + "type": "object", + "description": "The attestation status of the virtual machine", + "properties": { + "properties": { + "$ref": "#/definitions/AttestationStatusProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "AttestationStatusProperties": { + "type": "object", + "description": "Defines the attestation status properties", + "properties": { + "attestSecureBootEnabled": { + "type": "string", + "description": "The status of whether secure boot is enabled.", + "default": "Unknown", + "enum": [ + "Enabled", + "Disabled", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestSecureBootPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Secure boot enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Secure boot disabled" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Secure boot status is unknown" + } + ] + }, + "readOnly": true + }, + "attestationCertValidated": { + "type": "string", + "description": "The status of whether attestation certificate is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestCertPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Attestation certificate is valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Attestation certificate is invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation certificate status is unknown" + } + ] + }, + "readOnly": true + }, + "bootIntegrityValidated": { + "type": "string", + "description": "The status of whether the list of boot integrity properties is validated.", + "default": "Unknown", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestBootIntegrityPropertyEnum", + "modelAsString": true, + "values": [ + { + "name": "Valid", + "value": "Valid", + "description": "Boot integrity properties are valid" + }, + { + "name": "Invalid", + "value": "Invalid", + "description": "Boot integrity properties are invalid" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Boot integrity properties status is unknown" + } + ] + }, + "readOnly": true + }, + "linuxKernelVersion": { + "type": "string", + "description": "kernel version string for Linux VM.", + "readOnly": true + }, + "healthStatus": { + "type": "string", + "description": "The health status of attestation validation and parsing", + "default": "Unknown", + "enum": [ + "Pending", + "Healthy", + "Unhealthy", + "Unknown" + ], + "x-ms-enum": { + "name": "AttestHealthStatusEnum", + "modelAsString": true, + "values": [ + { + "name": "Pending", + "value": "Pending", + "description": "Attestation validation and parsing pending" + }, + { + "name": "Healthy", + "value": "Healthy", + "description": "Attestation validation and parsing healthy" + }, + { + "name": "Unhealthy", + "value": "Unhealthy", + "description": "Attestation validation and parsing unhealthy" + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Attestation validation and parsing status is unknown" + } + ] + }, + "readOnly": true + }, + "timestamp": { + "type": "string", + "description": "The time stamp of the last time attestation token is validated by relying party service.", + "readOnly": true + }, + "errorMessage": { + "type": "string", + "description": "The error message of attestation validation and parsing", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + }, + "attestHardwarePlatform": { + "$ref": "#/definitions/AttestHWPlatformEnum", + "description": "The hardware platform information from attestation token. This only applies to Confidential VM.", + "readOnly": true + }, + "attestDiskSecurityEncryptionType": { + "$ref": "#/definitions/AttestDiskSecurityEncryptionTypeEnum", + "description": "The managed disk security encryption type from attestation token. This only applies to Confidential VM.", + "readOnly": true + } + } + }, + "CloudInitDataSource": { + "type": "string", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]", + "enum": [ + "NoCloud", + "Azure" + ], + "x-ms-enum": { + "name": "CloudInitDataSource", + "modelAsString": true, + "values": [ + { + "name": "NoCloud", + "value": "NoCloud", + "description": "NoCloud is used as the datasource" + }, + { + "name": "Azure", + "value": "Azure", + "description": "Azure is used as the datasource" + } + ] + } + }, + "DiskFileFormat": { + "type": "string", + "description": "The format of the actual VHD file [vhd, vhdx]", + "enum": [ + "vhdx", + "vhd" + ], + "x-ms-enum": { + "name": "DiskFileFormat", + "modelAsString": true, + "values": [ + { + "name": "vhdx", + "value": "vhdx", + "description": "VHDX file format" + }, + { + "name": "vhd", + "value": "vhd", + "description": "VHD file format" + } + ] + } + }, + "ExtendedLocation": { + "type": "object", + "description": "The complex type of the extended location.", + "properties": { + "name": { + "type": "string", + "description": "The name of the extended location." + }, + "type": { + "$ref": "#/definitions/ExtendedLocationTypes", + "description": "The type of the extended location." + } + } + }, + "ExtendedLocationTypes": { + "type": "string", + "description": "The type of extendedLocation.", + "enum": [ + "CustomLocation" + ], + "x-ms-enum": { + "name": "ExtendedLocationTypes", + "modelAsString": true, + "values": [ + { + "name": "CustomLocation", + "value": "CustomLocation", + "description": "Custom extended location type" + } + ] + } + }, + "GalleryDiskImage": { + "type": "object", + "description": "This is the disk image base class.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GalleryImage": { + "type": "object", + "description": "The gallery images resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "GalleryImageIdentifier": { + "type": "object", + "description": "This is the gallery image definition identifier.", + "properties": { + "publisher": { + "type": "string", + "description": "The name of the gallery image definition publisher." + }, + "offer": { + "type": "string", + "description": "The name of the gallery image definition offer." + }, + "sku": { + "type": "string", + "description": "The name of the gallery image definition SKU." + } + }, + "required": [ + "publisher", + "offer", + "sku" + ] + }, + "GalleryImageListResult": { + "type": "object", + "description": "The response of a GalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GalleryImage items on this page", + "items": { + "$ref": "#/definitions/GalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GalleryImageProperties": { + "type": "object", + "description": "Properties under the gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "imagePath": { + "type": "string", + "format": "password", + "description": "location of the image the gallery image should be created from", + "x-ms-secret": true + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "vmImageRepositoryCredentials": { + "$ref": "#/definitions/VmImageRepositoryCredentials", + "description": "The credentials used to login to the image repository that has access to the specified image" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/GalleryImageStatus", + "description": "The observed state of gallery images", + "readOnly": true + }, + "sourceVirtualMachineId": { + "type": "string", + "format": "arm-id", + "description": "Resource ID of the source virtual machine from whose OS disk the gallery image is created.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + }, + "required": [ + "osType" + ] + }, + "GalleryImageStatus": { + "type": "object", + "description": "The observed state of gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "GalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/GalleryImageStatusProvisioningStatus", + "description": "provisioning status of the gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/GalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + } + }, + "GalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "GalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "The status of the operation performed on the gallery image", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "GalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in GalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryImageVersion": { + "type": "object", + "description": "Specifies information about the gallery image version that you want to create or update.", + "properties": { + "name": { + "type": "string", + "description": "This is the version of the gallery image." + }, + "properties": { + "$ref": "#/definitions/GalleryImageVersionProperties", + "description": "Describes the properties of a gallery image version.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageVersionProperties": { + "type": "object", + "description": "Describes the properties of a gallery image version.", + "properties": { + "storageProfile": { + "$ref": "#/definitions/GalleryImageVersionStorageProfile", + "description": "This is the storage profile of a Gallery Image Version." + } + }, + "required": [ + "storageProfile" + ] + }, + "GalleryImageVersionStorageProfile": { + "type": "object", + "description": "This is the storage profile of a Gallery Image Version.", + "properties": { + "osDiskImage": { + "$ref": "#/definitions/GalleryOSDiskImage", + "description": "This is the OS disk image." + } + } + }, + "GalleryImagesUpdateRequest": { + "type": "object", + "description": "The gallery images resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "GalleryOSDiskImage": { + "type": "object", + "description": "This is the OS disk image.", + "properties": { + "sizeInMB": { + "type": "integer", + "format": "int64", + "description": "This property indicates the size of the VHD to be created.", + "readOnly": true + } + } + }, + "GpuAssignmentTypeEnum": { + "type": "string", + "description": "Gpu Assignment types", + "enum": [ + "GpuDDA", + "GpuP" + ], + "x-ms-enum": { + "name": "GpuAssignmentTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "GpuDDA", + "value": "GpuDDA", + "description": "Attach Graphics Processing Unit (GPU) using Discrete Device Assignment (DDA)" + }, + { + "name": "GpuP", + "value": "GpuP", + "description": "Attach Graphics Processing Unit (GPU) using GPU Partitioning" + } + ] + } + }, + "GuestAgent": { + "type": "object", + "description": "Defines the GuestAgent.", + "properties": { + "properties": { + "$ref": "#/definitions/GuestAgentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "GuestAgentInstallStatus": { + "type": "object", + "description": "Defines the status of a guest agent installation.", + "properties": { + "vmUuid": { + "type": "string", + "description": "Specifies the VM's unique SMBIOS ID.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StatusTypes", + "description": "The installation status of the hybrid machine agent installation.", + "readOnly": true + }, + "lastStatusChange": { + "type": "string", + "format": "date-time", + "description": "The time of the last status change.", + "readOnly": true + }, + "agentVersion": { + "type": "string", + "description": "The hybrid machine agent full version.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Details about the error state.", + "items": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "GuestAgentListResult": { + "type": "object", + "description": "The response of a GuestAgent list operation.", + "properties": { + "value": { + "type": "array", + "description": "The GuestAgent items on this page", + "items": { + "$ref": "#/definitions/GuestAgent" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "GuestAgentProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "credentials": { + "$ref": "#/definitions/GuestCredential", + "description": "Username / Password Credentials to provision guest agent." + }, + "provisioningAction": { + "$ref": "#/definitions/ProvisioningAction", + "description": "The guest agent provisioning action." + }, + "status": { + "type": "string", + "description": "The guest agent status.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "GuestCredential": { + "type": "object", + "description": "Username / Password Credentials to connect to guest.", + "properties": { + "username": { + "type": "string", + "description": "The username to connect with the guest." + }, + "password": { + "type": "string", + "format": "password", + "description": "The password to connect with the guest.", + "x-ms-mutability": [ + "update", + "create" + ], + "x-ms-secret": true + } + } + }, + "HardwareProfileUpdate": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "$ref": "#/definitions/VmSizeEnum", + "description": "VM Size Enum" + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - updated list of GPUs on the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "HttpProxyConfiguration": { + "type": "object", + "description": "HTTP Proxy configuration for the VM.", + "properties": { + "httpProxy": { + "type": "string", + "format": "password", + "description": "The HTTP proxy server endpoint to use.", + "x-ms-secret": true + }, + "httpsProxy": { + "type": "string", + "format": "password", + "description": "The HTTPS proxy server endpoint to use.", + "x-ms-secret": true + }, + "noProxy": { + "type": "array", + "description": "The endpoints that should not go through proxy.", + "items": { + "type": "string" + } + }, + "trustedCa": { + "type": "string", + "description": "Alternative CA cert to use for connecting to proxy servers." + } + } + }, + "HybridIdentityMetadata": { + "type": "object", + "description": "Defines the HybridIdentityMetadata.", + "properties": { + "properties": { + "$ref": "#/definitions/HybridIdentityMetadataProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true + }, + "HybridIdentityMetadataListResult": { + "type": "object", + "description": "The response of a HybridIdentityMetadata list operation.", + "properties": { + "value": { + "type": "array", + "description": "The HybridIdentityMetadata items on this page", + "items": { + "$ref": "#/definitions/HybridIdentityMetadata" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "HybridIdentityMetadataProperties": { + "type": "object", + "description": "Defines the resource properties.", + "properties": { + "resourceUid": { + "type": "string", + "description": "The unique identifier for the resource." + }, + "publicKey": { + "type": "string", + "description": "The Public Key." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + } + } + }, + "HyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true, + "values": [ + { + "name": "V1", + "value": "V1", + "description": "Generation 1 (V1) hypervisor" + }, + { + "name": "V2", + "value": "V2", + "description": "Generation 2 (V2) hypervisor" + } + ] + } + }, + "IPConfiguration": { + "type": "object", + "description": "InterfaceIPConfiguration IPConfiguration in a network interface.", + "properties": { + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/IPConfigurationProperties", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration." + } + } + }, + "IPConfigurationProperties": { + "type": "object", + "description": "InterfaceIPConfigurationPropertiesFormat properties of IP configuration.", + "properties": { + "gateway": { + "type": "string", + "description": "Gateway for network interface", + "readOnly": true + }, + "prefixLength": { + "type": "string", + "description": "prefixLength for network interface", + "readOnly": true + }, + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress - Private IP address of the IP configuration." + }, + "subnet": { + "$ref": "#/definitions/LogicalNetworkArmReference", + "description": "Subnet - Name of Subnet bound to the IP configuration." + } + } + }, + "IPPool": { + "type": "object", + "description": "Describes IPPool", + "properties": { + "name": { + "type": "string", + "description": "Name of the IP-Pool" + }, + "ipPoolType": { + "$ref": "#/definitions/IPPoolTypeEnum", + "description": "Type of the IP Pool [vm, vippool]" + }, + "start": { + "type": "string", + "description": "Start of the IP address pool" + }, + "end": { + "type": "string", + "description": "End of the IP address pool" + }, + "info": { + "$ref": "#/definitions/IPPoolInfo", + "description": "IPPool info" + } + } + }, + "IPPoolInfo": { + "type": "object", + "description": "IP Pool info", + "properties": { + "used": { + "type": "string", + "description": "Number of IP addresses allocated from the IP Pool", + "readOnly": true + }, + "available": { + "type": "string", + "description": "Number of IP addresses available in the IP Pool", + "readOnly": true + } + } + }, + "IPPoolTypeEnum": { + "type": "string", + "description": "Type of the IP Pool [vm, vippool]", + "enum": [ + "vm", + "vippool" + ], + "x-ms-enum": { + "name": "IPPoolTypeEnum", + "modelAsString": true, + "values": [ + { + "name": "vm", + "value": "vm", + "description": "Virtual Machine IP Pool" + }, + { + "name": "vippool", + "value": "vippool", + "description": "VIP Pool" + } + ] + } + }, + "Identity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID of resource identity. The value must be an UUID.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The tenant ID of resource. The value must be an UUID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "modelAsString": false + } + } + } + }, + "ImageArmReference": { + "type": "object", + "description": "The ARM ID for a Gallery Image.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for an image resource used by the virtual machine instance.", + "x-ms-mutability": [ + "read", + "create" + ], + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/galleryImages" + }, + { + "type": "Microsoft.AzureStackHCI/marketplaceGalleryImages" + } + ] + } + } + } + }, + "InstanceViewStatus": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "$ref": "#/definitions/StatusLevelTypes", + "description": "The level code." + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + }, + "InterfaceDNSSettings": { + "type": "object", + "description": "DNS Settings of the interface", + "properties": { + "dnsServers": { + "type": "array", + "description": "List of DNS server IP Addresses for the interface", + "items": { + "type": "string" + } + } + } + }, + "IpAllocationMethodEnum": { + "type": "string", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'", + "enum": [ + "Dynamic", + "Static" + ], + "x-ms-enum": { + "name": "IpAllocationMethodEnum", + "modelAsString": true, + "values": [ + { + "name": "Dynamic", + "value": "Dynamic", + "description": "Dynamic IP allocation method" + }, + { + "name": "Static", + "value": "Static", + "description": "Static IP allocation method" + } + ] + } + }, + "LogicalNetwork": { + "type": "object", + "description": "The logical network resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/LogicalNetworkProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "LogicalNetworkArmReference": { + "type": "object", + "description": "The ARM ID for a Logical Network.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Logical Network.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/logicalNetworks" + }, + { + "type": "Microsoft.NetworkCloud/cloudServicesNetworks" + }, + { + "type": "Microsoft.NetworkCloud/l2Networks" + }, + { + "type": "Microsoft.NetworkCloud/l3Networks" + }, + { + "type": "Microsoft.NetworkCloud/trunkedNetworks" + } + ] + } + } + } + }, + "LogicalNetworkListResult": { + "type": "object", + "description": "The response of a LogicalNetwork list operation.", + "properties": { + "value": { + "type": "array", + "description": "The LogicalNetwork items on this page", + "items": { + "$ref": "#/definitions/LogicalNetwork" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "LogicalNetworkProperties": { + "type": "object", + "description": "Properties under the logical network resource", + "properties": { + "dhcpOptions": { + "$ref": "#/definitions/LogicalNetworkPropertiesDhcpOptions", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options." + }, + "subnets": { + "type": "array", + "description": "Subnet - list of subnets under the logical network", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [] + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the logical network.", + "readOnly": true + }, + "vmSwitchName": { + "type": "string", + "description": "name of the network switch to be used for VMs" + }, + "status": { + "$ref": "#/definitions/LogicalNetworkStatus", + "description": "The observed state of logical networks", + "readOnly": true + } + } + }, + "LogicalNetworkPropertiesDhcpOptions": { + "type": "object", + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.", + "properties": { + "dnsServers": { + "type": "array", + "description": "The list of DNS servers IP addresses.", + "items": { + "type": "string" + } + } + } + }, + "LogicalNetworkStatus": { + "type": "object", + "description": "The observed state of logical networks", + "properties": { + "errorCode": { + "type": "string", + "description": "LogicalNetwork provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/LogicalNetworkStatusProvisioningStatus", + "description": "Logical network provisioning status" + } + } + }, + "LogicalNetworkStatusProvisioningStatus": { + "type": "object", + "description": "Describes the status of the provisioning.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the logical network" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the logical network [Succeeded, Failed, InProgress]" + } + } + }, + "LogicalNetworksUpdateRequest": { + "type": "object", + "description": "The logical network resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImage": { + "type": "object", + "description": "The marketplace gallery image resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/MarketplaceGalleryImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "MarketplaceGalleryImageListResult": { + "type": "object", + "description": "The response of a MarketplaceGalleryImage list operation.", + "properties": { + "value": { + "type": "array", + "description": "The MarketplaceGalleryImage items on this page", + "items": { + "$ref": "#/definitions/MarketplaceGalleryImage" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "MarketplaceGalleryImageProperties": { + "type": "object", + "description": "Properties under the marketplace gallery image resource", + "properties": { + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for marketplace gallery image", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "Operating system type that the gallery image uses [Windows, Linux]" + }, + "cloudInitDataSource": { + "$ref": "#/definitions/CloudInitDataSource", + "description": "Datasource for the gallery image when provisioning with cloud-init [NoCloud, Azure]" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "identifier": { + "$ref": "#/definitions/GalleryImageIdentifier", + "description": "This is the gallery image definition identifier." + }, + "version": { + "$ref": "#/definitions/GalleryImageVersion", + "description": "Specifies information about the gallery image version that you want to create or update." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the marketplace gallery image.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MarketplaceGalleryImageStatus", + "description": "The observed state of marketplace gallery images", + "readOnly": true + } + }, + "required": [ + "osType" + ] + }, + "MarketplaceGalleryImageStatus": { + "type": "object", + "description": "The observed state of marketplace gallery images", + "properties": { + "errorCode": { + "type": "string", + "description": "MarketplaceGalleryImage provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusProvisioningStatus", + "description": "Provisioning status of marketplace gallery image" + }, + "downloadStatus": { + "$ref": "#/definitions/MarketplaceGalleryImageStatusDownloadStatus", + "description": "The download status of the gallery image" + }, + "progressPercentage": { + "type": "integer", + "format": "int64", + "description": "The progress of the operation in percentage" + } + } + }, + "MarketplaceGalleryImageStatusDownloadStatus": { + "type": "object", + "description": "The download status of the gallery image", + "properties": { + "downloadSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the image in MB" + } + } + }, + "MarketplaceGalleryImageStatusProvisioningStatus": { + "type": "object", + "description": "Marketplace GalleryImage provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the gallery image" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the gallery image [Succeeded, Failed, InProgress]" + } + } + }, + "MarketplaceGalleryImageTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in MarketplaceGalleryImage resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MarketplaceGalleryImagesUpdateRequest": { + "type": "object", + "description": "The marketplace gallery image resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterface": { + "type": "object", + "description": "The network interface resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "NetworkInterfaceArmReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "NetworkInterfaceListResult": { + "type": "object", + "description": "The response of a NetworkInterface list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkInterface items on this page", + "items": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkInterfaceProperties": { + "type": "object", + "description": "Properties under the network interface resource", + "properties": { + "ipConfigurations": { + "type": "array", + "description": "IPConfigurations - A list of IPConfigurations of the network interface.", + "items": { + "$ref": "#/definitions/IPConfiguration" + }, + "x-ms-identifiers": [] + }, + "macAddress": { + "type": "string", + "description": "MacAddress - The MAC address of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/InterfaceDNSSettings", + "description": "DNS Settings for the interface" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the network interface.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/NetworkInterfaceStatus", + "description": "The observed state of network interfaces", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the network interface." + } + } + }, + "NetworkInterfaceStatus": { + "type": "object", + "description": "The observed state of network interfaces", + "properties": { + "errorCode": { + "type": "string", + "description": "NetworkInterface provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/NetworkInterfaceStatusProvisioningStatus", + "description": "Network interface provisioning status" + } + } + }, + "NetworkInterfaceStatusProvisioningStatus": { + "type": "object", + "description": "Network interface provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the network interface" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the network interface [Succeeded, Failed, InProgress]" + } + } + }, + "NetworkInterfaceTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkInterface resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkInterfacesUpdateRequest": { + "type": "object", + "description": "The network interface resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "NetworkProfileUpdate": { + "type": "object", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "NetworkSecurityGroup": { + "type": "object", + "description": "NetworkSecurityGroup resource.", + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSecurityGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "eTag": { + "type": "string", + "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "NetworkSecurityGroupArmReference": { + "type": "object", + "description": "The ARM ID for a Network Security Group.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Security Group.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkSecurityGroups" + } + ] + } + } + } + }, + "NetworkSecurityGroupListResult": { + "type": "object", + "description": "The response of a NetworkSecurityGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The NetworkSecurityGroup items on this page", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "NetworkSecurityGroupProperties": { + "type": "object", + "description": "Network Security Group resource.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "A collection of references to network interfaces that are currently using this NSG.", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "subnets": { + "type": "array", + "description": "A collection of references to logical networks that are currently using this NSG", + "items": { + "$ref": "#/definitions/LogicalNetworkArmReference" + }, + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "The provisioning state of the network security group resource.", + "readOnly": true + } + } + }, + "NetworkSecurityGroupTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in NetworkSecurityGroup resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "OperatingSystemTypes": { + "type": "string", + "description": "Operating system type that the gallery image uses [Windows, Linux]", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true, + "values": [ + { + "name": "Windows", + "value": "Windows", + "description": "Windows operating system" + }, + { + "name": "Linux", + "value": "Linux", + "description": "Linux operating system" + } + ] + } + }, + "OsProfileUpdate": { + "type": "object", + "description": "OsProfile - describes the update configuration of the operating system", + "properties": { + "computerName": { + "type": "string", + "description": "ComputerName - name of the computer" + }, + "linuxConfiguration": { + "$ref": "#/definitions/OsProfileUpdateLinuxConfiguration", + "description": "Linux configuration properties" + }, + "windowsConfiguration": { + "$ref": "#/definitions/OsProfileUpdateWindowsConfiguration", + "description": "Windows configuration properties" + } + } + }, + "OsProfileUpdateLinuxConfiguration": { + "type": "object", + "description": "OSProfile update linux configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "OsProfileUpdateWindowsConfiguration": { + "type": "object", + "description": "OSProfile update windows configuration", + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process." + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process." + } + } + }, + "PowerStateEnum": { + "type": "string", + "description": "The power state of the virtual machine instance", + "enum": [ + "Deallocated", + "Deallocating", + "Running", + "Starting", + "Stopped", + "Stopping", + "Paused", + "Saved", + "Unknown" + ], + "x-ms-enum": { + "name": "PowerStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Deallocated", + "value": "Deallocated", + "description": "Virtual machine deallocated" + }, + { + "name": "Deallocating", + "value": "Deallocating", + "description": "Virtual machine deallocating" + }, + { + "name": "Running", + "value": "Running", + "description": "Virtual machine running" + }, + { + "name": "Starting", + "value": "Starting", + "description": "Virtual machine starting" + }, + { + "name": "Stopped", + "value": "Stopped", + "description": "Virtual machine stopped" + }, + { + "name": "Stopping", + "value": "Stopping", + "description": "Virtual machine stopping" + }, + { + "name": "Paused", + "value": "Paused", + "description": "Virtual machine paused" + }, + { + "name": "Saved", + "value": "Saved", + "description": "Virtual machine Saved," + }, + { + "name": "Unknown", + "value": "Unknown", + "description": "Power state of the virtual machine is unknown" + } + ] + } + }, + "ProvisioningAction": { + "type": "string", + "description": "Defines the different types of operations for guest agent.", + "enum": [ + "install", + "uninstall", + "repair" + ], + "x-ms-enum": { + "name": "ProvisioningAction", + "modelAsString": true, + "values": [ + { + "name": "install", + "value": "install", + "description": "Install guest agent" + }, + { + "name": "uninstall", + "value": "uninstall", + "description": "Uninstall guest agent" + }, + { + "name": "repair", + "value": "repair", + "description": "Repair guest agent" + } + ] + } + }, + "ProvisioningStateEnum": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Succeeded", + "Failed", + "InProgress", + "Accepted", + "Deleting", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningStateEnum", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Provisioning has succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Provisioning has failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Provisioning is in progress" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Provisioning has been accepted" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Deletion of the resource is in progress" + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Provisioning has been canceled" + } + ] + }, + "readOnly": true + }, + "Route": { + "type": "object", + "description": "Route - Route resource.", + "properties": { + "properties": { + "$ref": "#/definitions/RouteProperties", + "description": "Properties of the route.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - name of the subnet", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "RouteProperties": { + "type": "object", + "description": "RoutePropertiesFormat - Route resource.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + } + } + }, + "RouteTable": { + "type": "object", + "description": "Route table resource.", + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/RouteTableProperties", + "description": "Properties of the route table.", + "x-ms-client-flatten": true + } + } + }, + "RouteTableProperties": { + "type": "object", + "description": "RouteTablePropertiesFormat - Route Table resource.", + "properties": { + "routes": { + "type": "array", + "description": "Collection of routes contained within a route table.", + "items": { + "$ref": "#/definitions/Route" + }, + "x-ms-identifiers": [] + } + } + }, + "SecurityEncryptionType": { + "type": "string", + "description": "Encryption type of the managed disk enum.", + "enum": [ + "NonPersistedTPM" + ], + "x-ms-enum": { + "name": "SecurityEncryptionType", + "modelAsString": true, + "values": [ + { + "name": "NonPersistedTPM", + "value": "NonPersistedTPM", + "description": "Non-persisted TPM encryption type" + } + ] + } + }, + "SecurityRule": { + "type": "object", + "description": "Security Rule resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityRuleProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true, + "values": [ + { + "name": "Allow", + "value": "Allow", + "description": "Network traffic is allowed" + }, + { + "name": "Deny", + "value": "Deny", + "description": "Network traffic is denied" + } + ] + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true, + "values": [ + { + "name": "Inbound", + "value": "Inbound", + "description": "Rule is evaluated on incoming traffic" + }, + { + "name": "Outbound", + "value": "Outbound", + "description": "Rule is evaluated on outgoing traffic" + } + ] + } + }, + "SecurityRuleListResult": { + "type": "object", + "description": "The response of a SecurityRule list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecurityRule items on this page", + "items": { + "$ref": "#/definitions/SecurityRule" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "SecurityRuleProperties": { + "type": "object", + "description": "Security rule resource.", + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "$ref": "#/definitions/SecurityRuleProtocol", + "description": "Network protocol this rule applies to." + }, + "sourceAddressPrefixes": { + "type": "array", + "description": "The CIDR or source IP ranges.", + "items": { + "type": "string" + } + }, + "destinationAddressPrefixes": { + "type": "array", + "description": "The destination address prefixes. CIDR or destination IP ranges.", + "items": { + "type": "string" + } + }, + "sourcePortRanges": { + "type": "array", + "description": "The source port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "destinationPortRanges": { + "type": "array", + "description": "The destination port ranges. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.", + "items": { + "type": "string" + } + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the SR", + "readOnly": true + } + }, + "required": [ + "protocol", + "access", + "priority", + "direction" + ] + }, + "SecurityRuleProtocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true, + "values": [ + { + "name": "Tcp", + "value": "Tcp", + "description": "Transmission Control Protocol" + }, + { + "name": "Udp", + "value": "Udp", + "description": "User Datagram Protocol" + }, + { + "name": "Icmp", + "value": "Icmp", + "description": "Internet Control Message Protocol" + }, + { + "name": "Asterisk", + "value": "*", + "description": "Wildcard rule for all protocols" + } + ] + } + }, + "SecurityTypes": { + "type": "string", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function.", + "enum": [ + "TrustedLaunch", + "ConfidentialVM" + ], + "x-ms-enum": { + "name": "SecurityTypes", + "modelAsString": true, + "values": [ + { + "name": "TrustedLaunch", + "value": "TrustedLaunch", + "description": "Trusted Launch security type" + }, + { + "name": "ConfidentialVM", + "value": "ConfidentialVM", + "description": "Confidential VM security type" + } + ] + } + }, + "SshConfiguration": { + "type": "object", + "description": "SSH configuration for Linux based VMs running on Azure", + "properties": { + "publicKeys": { + "type": "array", + "description": "The list of SSH public keys used to authenticate with linux based VMs.", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "path" + ] + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.", + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. <br><br> For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed)." + } + } + }, + "Status": { + "type": "string", + "description": "The status of the operation performed on the resource [Succeeded, Failed, InProgress]", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Operation succeeded" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Operation failed" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Operation is in progress" + } + ] + }, + "readOnly": true + }, + "StatusLevelTypes": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true, + "values": [ + { + "name": "Info", + "value": "Info", + "description": "Informational status level" + }, + { + "name": "Warning", + "value": "Warning", + "description": "Warning status level" + }, + { + "name": "Error", + "value": "Error", + "description": "Error status level" + } + ] + } + }, + "StatusTypes": { + "type": "string", + "description": "The installation status of the hybrid machine agent installation.", + "enum": [ + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "StatusTypes", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Installation succeeded" + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Installation in progress" + }, + { + "name": "Failed", + "value": "Failed", + "description": "Installation failed" + } + ] + }, + "readOnly": true + }, + "StorageContainer": { + "type": "object", + "description": "The storage container resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/StorageContainerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "StorageContainerArmReference": { + "type": "object", + "description": "The ARM ID for a Storage Container.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Storage Container.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "StorageContainerListResult": { + "type": "object", + "description": "The response of a StorageContainer list operation.", + "properties": { + "value": { + "type": "array", + "description": "The StorageContainer items on this page", + "items": { + "$ref": "#/definitions/StorageContainer" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "StorageContainerProperties": { + "type": "object", + "description": "Properties under the storage container resource", + "properties": { + "path": { + "type": "string", + "description": "Path of the storage container on the disk" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the storage container.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/StorageContainerStatus", + "description": "The observed state of storage containers", + "readOnly": true + } + }, + "required": [ + "path" + ] + }, + "StorageContainerStatus": { + "type": "object", + "description": "The observed state of storage containers", + "properties": { + "errorCode": { + "type": "string", + "description": "StorageContainer provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "availableSizeMB": { + "type": "integer", + "format": "int64", + "description": "Amount of space available on the disk in MB" + }, + "containerSizeMB": { + "type": "integer", + "format": "int64", + "description": "Total size of the disk in MB" + }, + "provisioningStatus": { + "$ref": "#/definitions/StorageContainerStatusProvisioningStatus", + "description": "Storage container's provisioning status" + } + } + }, + "StorageContainerStatusProvisioningStatus": { + "type": "object", + "description": "Storage container provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the storage container" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the storage container [Succeeded, Failed, InProgress]" + } + } + }, + "StorageContainerTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in StorageContainer resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageContainersUpdateRequest": { + "type": "object", + "description": "The storage container resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "StorageProfileUpdate": { + "type": "object", + "description": "Storage profile update", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance for the update call", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + } + } + }, + "Subnet": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "properties": { + "$ref": "#/definitions/SubnetProperties", + "description": "Properties of the subnet.", + "x-ms-client-flatten": true + }, + "name": { + "type": "string", + "description": "Name - The name of the resource that is unique within a resource group. This name can be used to access the resource.", + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-._a-zA-Z0-9]{0,78}[_a-zA-Z0-9]$" + } + } + }, + "SubnetIpConfigurationReference": { + "type": "object", + "description": "The ARM ID for a Network Interface.", + "properties": { + "ID": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Network Interface.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/networkInterfaces" + } + ] + } + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "Properties of the subnet.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6." + }, + "addressPrefixes": { + "type": "array", + "description": "List of address prefixes for the subnet.", + "items": { + "type": "string" + } + }, + "ipAllocationMethod": { + "$ref": "#/definitions/IpAllocationMethodEnum", + "description": "IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic'" + }, + "ipConfigurationReferences": { + "type": "array", + "description": "IPConfigurationReferences - list of IPConfigurationReferences", + "items": { + "$ref": "#/definitions/SubnetIpConfigurationReference" + }, + "x-ms-identifiers": [] + }, + "networkSecurityGroup": { + "$ref": "#/definitions/NetworkSecurityGroupArmReference", + "description": "NetworkSecurityGroup - Network Security Group attached to the logical network." + }, + "routeTable": { + "$ref": "#/definitions/RouteTable", + "description": "Route table resource." + }, + "ipPools": { + "type": "array", + "description": "network associated pool of IP Addresses", + "items": { + "$ref": "#/definitions/IPPool" + }, + "x-ms-identifiers": [] + }, + "vlan": { + "type": "integer", + "format": "int32", + "description": "Vlan to use for the subnet" + } + } + }, + "TagsObject": { + "type": "object", + "description": "Tags object for patch operations.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VMDiskSecurityProfile": { + "type": "object", + "description": "Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs", + "properties": { + "securityEncryptionType": { + "$ref": "#/definitions/SecurityEncryptionType", + "description": "Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs." + } + } + }, + "VirtualHardDisk": { + "type": "object", + "description": "The virtual hard disk resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualHardDiskProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualHardDiskArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Hard Disk.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + } + } + }, + "VirtualHardDiskDownloadStatus": { + "type": "object", + "description": "The download status of the virtual hard disk", + "properties": { + "downloadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The downloaded sized of the virtual hard disk in MB" + } + } + }, + "VirtualHardDiskListResult": { + "type": "object", + "description": "The response of a VirtualHardDisk list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualHardDisk items on this page", + "items": { + "$ref": "#/definitions/VirtualHardDisk" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualHardDiskProperties": { + "type": "object", + "description": "Properties under the virtual hard disk resource", + "properties": { + "blockSizeBytes": { + "type": "integer", + "format": "int32", + "description": "Block size in bytes" + }, + "diskSizeGB": { + "type": "integer", + "format": "int64", + "description": "Size of the disk in GB" + }, + "dynamic": { + "type": "boolean", + "description": "Boolean for enabling dynamic sizing on the virtual hard disk" + }, + "logicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Logical sector in bytes" + }, + "physicalSectorBytes": { + "type": "integer", + "format": "int32", + "description": "Physical sector in bytes" + }, + "downloadUrl": { + "type": "string", + "format": "password", + "description": "URL for downloading or accessing the virtual hard disk. This URL points to a secure link from where the VHD can be downloaded or accessed directly.", + "x-ms-secret": true + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGeneration", + "description": "The hypervisor generation of the Virtual Machine [V1, V2]" + }, + "diskFileFormat": { + "$ref": "#/definitions/DiskFileFormat", + "description": "The format of the actual VHD file [vhd, vhdx]" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual hard disk.", + "readOnly": true + }, + "containerId": { + "type": "string", + "format": "arm-id", + "description": "Storage ContainerID of the storage container to be used for VHD", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + }, + "status": { + "$ref": "#/definitions/VirtualHardDiskStatus", + "description": "The observed state of virtual hard disks", + "readOnly": true + } + } + }, + "VirtualHardDiskStatus": { + "type": "object", + "description": "The observed state of virtual hard disks", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualHardDisk provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualHardDiskStatusProvisioningStatus", + "description": "Provisioning status of the vhd" + }, + "downloadStatus": { + "$ref": "#/definitions/VirtualHardDiskDownloadStatus", + "description": "The download status of the virtual hard disk" + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + } + }, + "VirtualHardDiskStatusProvisioningStatus": { + "type": "object", + "description": "VHD Status provisioning status", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual hard disk" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDiskTagsUpdate": { + "type": "object", + "description": "The type used for updating tags in VirtualHardDisk resources.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualHardDiskUploadRequest": { + "type": "object", + "description": "Request for uploading virtual hard disk.", + "properties": { + "azureManagedDiskUploadUrl": { + "type": "string", + "format": "password", + "description": "The Azure managed disk SAS URL to upload the virtual hard disk to.", + "x-ms-secret": true + } + }, + "required": [ + "azureManagedDiskUploadUrl" + ] + }, + "VirtualHardDiskUploadResponse": { + "type": "object", + "description": "Response for uploading virtual hard disk.", + "properties": { + "virtualHardDiskId": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "uploadStatus": { + "$ref": "#/definitions/VirtualHardDiskUploadStatus", + "description": "The upload status of the virtual hard disk" + } + } + }, + "VirtualHardDiskUploadStatus": { + "type": "object", + "description": "The upload status of the virtual hard disk", + "properties": { + "uploadedSizeInMB": { + "type": "integer", + "format": "int64", + "description": "The uploaded sized of the virtual hard disk in MB" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of Uploading virtual hard disk [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualHardDisksUpdateRequest": { + "type": "object", + "description": "The virtual hard disk resource patch definition.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags", + "additionalProperties": { + "type": "string" + } + } + } + }, + "VirtualMachineArmReference": { + "type": "object", + "description": "The ARM ID for a Virtual Machine.", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Machine.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualMachineInstance" + } + ] + } + } + } + }, + "VirtualMachineConfigAgentInstanceView": { + "type": "object", + "description": "The instance view of the VM Config Agent running on the virtual machine.", + "properties": { + "vmConfigAgentVersion": { + "type": "string", + "description": "The VM Config Agent full version." + }, + "statuses": { + "type": "array", + "description": "The resource status information.", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstance": { + "type": "object", + "description": "The virtual machine instance resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "extendedLocation": { + "$ref": "#/definitions/ExtendedLocation", + "description": "The extendedLocation of the resource." + }, + "identity": { + "$ref": "../../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "x-ms-azure-resource": true + }, + "VirtualMachineInstanceListResult": { + "type": "object", + "description": "The response of a VirtualMachineInstance list operation.", + "properties": { + "value": { + "type": "array", + "description": "The VirtualMachineInstance items on this page", + "items": { + "$ref": "#/definitions/VirtualMachineInstance" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "VirtualMachineInstanceManagedDiskParameters": { + "type": "object", + "description": "The parameters of a managed disk.", + "properties": { + "securityProfile": { + "$ref": "#/definitions/VMDiskSecurityProfile", + "description": "Specifies the security profile for the managed disk." + } + } + }, + "VirtualMachineInstanceProperties": { + "type": "object", + "description": "Properties under the virtual machine instance resource", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfile", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesNetworkProfile", + "description": "NetworkProfile - describes the network configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfile", + "description": "OsProfile - describes the configuration of the operating system and sets login data" + }, + "securityProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfile", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfile", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance" + }, + "httpProxyConfig": { + "$ref": "#/definitions/HttpProxyConfiguration", + "description": "HTTP Proxy configuration for the VM." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningStateEnum", + "description": "Provisioning state of the virtual machine instance.", + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "description": "The virtual machine instance view.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/VirtualMachineInstanceStatus", + "description": "The observed state of virtual machine instances", + "readOnly": true + }, + "guestAgentInstallStatus": { + "$ref": "#/definitions/GuestAgentInstallStatus", + "description": "Guest agent install status." + }, + "vmId": { + "type": "string", + "description": "Unique identifier for the vm resource.", + "readOnly": true + }, + "resourceUid": { + "type": "string", + "description": "Unique identifier defined by ARC to identify the guest of the VM." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfile": { + "type": "object", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance.", + "properties": { + "vmSize": { + "type": "string", + "description": "Enum of VM Sizes", + "default": "Default", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + }, + "processors": { + "type": "integer", + "format": "int32", + "description": "number of processors for the virtual machine instance" + }, + "memoryMB": { + "type": "integer", + "format": "int64", + "description": "RAM in MB for the virtual machine instance" + }, + "dynamicMemoryConfig": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig", + "description": "Dynamic memory config" + }, + "virtualMachineGPUs": { + "type": "array", + "description": "virtualMachineGPUs - list of gpus to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfig": { + "type": "object", + "description": "Dynamic memory config", + "properties": { + "maximumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Maximum memory in MB" + }, + "minimumMemoryMB": { + "type": "integer", + "format": "int64", + "description": "Minimum memory in MB" + }, + "targetMemoryBuffer": { + "type": "integer", + "format": "int32", + "description": "Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000." + } + } + }, + "VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPU": { + "type": "object", + "description": "GPU properties - describes the GPU configuration.", + "properties": { + "assignmentType": { + "$ref": "#/definitions/GpuAssignmentTypeEnum", + "description": "GPU assignment type" + }, + "partitionSizeMB": { + "type": "integer", + "format": "int64", + "description": "Size of gpu partition in MB for GPU-P" + }, + "gpuName": { + "type": "string", + "description": "Name of the GPU" + } + }, + "required": [ + "assignmentType" + ] + }, + "VirtualMachineInstancePropertiesNetworkProfile": { + "type": "object", + "description": "NetworkProfile - describes the network configuration the virtual machine instance", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance", + "items": { + "$ref": "#/definitions/NetworkInterfaceArmReference" + }, + "x-ms-identifiers": [] + } + } + }, + "VirtualMachineInstancePropertiesOsProfile": { + "type": "object", + "description": "OsProfile - describes the configuration of the operating system and sets login data", + "properties": { + "adminPassword": { + "type": "string", + "format": "password", + "description": "AdminPassword - admin password", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "adminUsername": { + "type": "string", + "description": "AdminUsername - admin username" + }, + "computerName": { + "type": "string", + "description": "ComputerName - name of the compute" + }, + "linuxConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileLinuxConfiguration", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance" + }, + "windowsConfiguration": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesOsProfileWindowsConfiguration", + "description": "Windows Configuration for the virtual machine instance" + } + } + }, + "VirtualMachineInstancePropertiesOsProfileLinuxConfiguration": { + "type": "object", + "description": "LinuxConfiguration - linux specific configuration values for the virtual machine instance", + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "DisablePasswordAuthentication - whether password authentication should be disabled" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesOsProfileWindowsConfiguration": { + "type": "object", + "description": "Windows Configuration for the virtual machine instance", + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Whether to EnableAutomaticUpdates on the machine" + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for Windows OS." + }, + "timeZone": { + "type": "string", + "description": "TimeZone for the virtual machine instance" + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process.", + "default": true + }, + "provisionVMConfigAgent": { + "type": "boolean", + "description": "Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process.", + "default": true + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfile": { + "type": "object", + "description": "SecurityProfile - Specifies the security settings for the virtual machine instance.", + "properties": { + "enableTPM": { + "type": "boolean", + "description": "Enable TPM flag", + "default": false + }, + "uefiSettings": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesSecurityProfileUefiSettings", + "description": "Uefi settings of the virtual machine instance" + }, + "securityType": { + "$ref": "#/definitions/SecurityTypes", + "description": "Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function." + } + } + }, + "VirtualMachineInstancePropertiesSecurityProfileUefiSettings": { + "type": "object", + "description": "Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance.", + "properties": { + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the virtual machine instance.", + "default": false + } + } + }, + "VirtualMachineInstancePropertiesStorageProfile": { + "type": "object", + "description": "StorageProfile - contains information about the disks and storage information for the virtual machine instance", + "properties": { + "dataDisks": { + "type": "array", + "description": "adds data disks to the virtual machine instance", + "items": { + "$ref": "#/definitions/VirtualHardDiskArmReference" + } + }, + "imageReference": { + "$ref": "#/definitions/ImageArmReference", + "description": "Which Image to use for the virtual machine instance", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineInstancePropertiesStorageProfileOsDisk", + "description": "VHD to attach as OS disk" + }, + "vmConfigStoragePathId": { + "type": "string", + "format": "arm-id", + "description": "Id of the storage container that hosts the VM configuration file", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/storageContainers" + } + ] + } + } + } + }, + "VirtualMachineInstancePropertiesStorageProfileOsDisk": { + "type": "object", + "description": "VHD to attach as OS disk", + "properties": { + "id": { + "type": "string", + "format": "arm-id", + "description": "The ARM ID for a Virtual Hard Disk.", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.AzureStackHCI/virtualHardDisks" + } + ] + } + }, + "osType": { + "$ref": "#/definitions/OperatingSystemTypes", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux." + }, + "managedDisk": { + "$ref": "#/definitions/VirtualMachineInstanceManagedDiskParameters", + "description": "The managed disk parameters." + } + } + }, + "VirtualMachineInstanceStatus": { + "type": "object", + "description": "The observed state of virtual machine instances", + "properties": { + "errorCode": { + "type": "string", + "description": "VirtualMachine provisioning error code" + }, + "errorMessage": { + "type": "string", + "description": "Descriptive error message" + }, + "powerState": { + "$ref": "#/definitions/PowerStateEnum", + "description": "The power state of the virtual machine instance" + }, + "provisioningStatus": { + "$ref": "#/definitions/VirtualMachineInstanceStatusProvisioningStatus", + "description": "Provisioning status of the virtual machine instance" + } + } + }, + "VirtualMachineInstanceStatusProvisioningStatus": { + "type": "object", + "description": "Virtual machine instance provisioning status.", + "properties": { + "operationId": { + "type": "string", + "description": "The ID of the operation performed on the virtual machine instance" + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress]" + } + } + }, + "VirtualMachineInstanceUpdateProperties": { + "type": "object", + "description": "Defines the resource properties for the update.", + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfileUpdate", + "description": "HardwareProfile - Specifies the hardware settings for the virtual machine instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfileUpdate", + "description": "StorageProfile - Specifies the storage settings for the virtual machine instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfileUpdate", + "description": "NetworkProfile - describes the network update configuration the virtual machine instance" + }, + "osProfile": { + "$ref": "#/definitions/OsProfileUpdate", + "description": "OsProfile - describes the update configuration of the operating system" + } + } + }, + "VirtualMachineInstanceUpdateRequest": { + "type": "object", + "description": "The virtual machine instance resource patch definition.", + "properties": { + "properties": { + "$ref": "#/definitions/VirtualMachineInstanceUpdateProperties", + "description": "Defines the resource properties for the update." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "Identity for the resource." + } + } + }, + "VirtualMachineInstanceView": { + "type": "object", + "description": "The instance view of a virtual machine.", + "properties": { + "vmAgent": { + "$ref": "#/definitions/VirtualMachineConfigAgentInstanceView", + "description": "The VM Config Agent running on the virtual machine." + } + } + }, + "VmImageRepositoryCredentials": { + "type": "object", + "description": "The credentials used to login to the image repository that has access to the specified image", + "properties": { + "username": { + "type": "string", + "description": "Username for accessing image repository" + }, + "password": { + "type": "string", + "format": "password", + "description": "Password for accessing image repository", + "x-ms-secret": true + } + }, + "required": [ + "username", + "password" + ] + }, + "VmSizeEnum": { + "type": "string", + "description": "VM Sizes", + "enum": [ + "Default", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS13_v2", + "Standard_K8S_v1", + "Standard_K8S2_v1", + "Standard_K8S3_v1", + "Standard_K8S4_v1", + "Standard_NK6", + "Standard_NK12", + "Standard_NV6", + "Standard_NV12", + "Standard_K8S5_v1", + "Custom" + ], + "x-ms-enum": { + "name": "VmSizeEnum", + "modelAsString": true, + "values": [ + { + "name": "Default", + "value": "Default", + "description": "Default virtual machine size" + }, + { + "name": "Standard_A2_v2", + "value": "Standard_A2_v2", + "description": "Standard A2 v2 virtual machine size" + }, + { + "name": "Standard_A4_v2", + "value": "Standard_A4_v2", + "description": "Standard A4 v2 virtual machine size" + }, + { + "name": "Standard_D2s_v3", + "value": "Standard_D2s_v3", + "description": "Standard D2s v3 virtual machine size" + }, + { + "name": "Standard_D4s_v3", + "value": "Standard_D4s_v3", + "description": "Standard D4s v3 virtual machine size" + }, + { + "name": "Standard_D8s_v3", + "value": "Standard_D8s_v3", + "description": "Standard D8s v3 virtual machine size" + }, + { + "name": "Standard_D16s_v3", + "value": "Standard_D16s_v3", + "description": "Standard D16s v3 virtual machine size" + }, + { + "name": "Standard_D32s_v3", + "value": "Standard_D32s_v3", + "description": "Standard D32s v3 virtual machine size" + }, + { + "name": "Standard_DS2_v2", + "value": "Standard_DS2_v2", + "description": "Standard DS2 v2 virtual machine size" + }, + { + "name": "Standard_DS3_v2", + "value": "Standard_DS3_v2", + "description": "Standard DS3 v2 virtual machine size" + }, + { + "name": "Standard_DS4_v2", + "value": "Standard_DS4_v2", + "description": "Standard DS4 v2 virtual machine size" + }, + { + "name": "Standard_DS5_v2", + "value": "Standard_DS5_v2", + "description": "Standard DS5 v2 virtual machine size" + }, + { + "name": "Standard_DS13_v2", + "value": "Standard_DS13_v2", + "description": "Standard DS13 v2 virtual machine size" + }, + { + "name": "Standard_K8S_v1", + "value": "Standard_K8S_v1", + "description": "Standard K8S v1 virtual machine size" + }, + { + "name": "Standard_K8S2_v1", + "value": "Standard_K8S2_v1", + "description": "Standard K8S2 v1 virtual machine size" + }, + { + "name": "Standard_K8S3_v1", + "value": "Standard_K8S3_v1", + "description": "Standard K8S3 v1 virtual machine size" + }, + { + "name": "Standard_K8S4_v1", + "value": "Standard_K8S4_v1", + "description": "Standard K8S4 v1 virtual machine size" + }, + { + "name": "Standard_NK6", + "value": "Standard_NK6", + "description": "Standard NK6 virtual machine size" + }, + { + "name": "Standard_NK12", + "value": "Standard_NK12", + "description": "Standard NK12 virtual machine size" + }, + { + "name": "Standard_NV6", + "value": "Standard_NV6", + "description": "Standard NV6 virtual machine size" + }, + { + "name": "Standard_NV12", + "value": "Standard_NV12", + "description": "Standard NV12 virtual machine size" + }, + { + "name": "Standard_K8S5_v1", + "value": "Standard_K8S5_v1", + "description": "Standard K8S5 v1 virtual machine size" + }, + { + "name": "Custom", + "value": "Custom", + "description": "Custom virtual machine size" + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md index d6ad26211f5c..1036da7e649a 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCIVM/readme.md @@ -29,7 +29,7 @@ title: Microsoft.AzureStackHCI description: Azure Stack HCI management service openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2024-05-01-preview +tag: package-preview-2024-08-01-preview ``` ## Suppression @@ -62,6 +62,16 @@ suppressions: - stackhcivm.json ``` +### Tag: package-preview-2024-08 + +These settings apply only when `--tag=package-preview-2024-08` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-08' +input-file: + - preview/2024-08-01-preview/stackhcivm.json + - ../operations/preview/2024-08-01-preview/operations.json +``` + ### Tag: package-preview-2024-05 These settings apply only when `--tag=package-preview-2024-05-01-preview` is specified on the command line. diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/examples/Operations_List.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..cb75a255d1e7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/examples/Operations_List.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "api-version": "2024-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine instance hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/attestationStatus/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances/attestationStatus", + "operation": "Gets/Lists virtual machine instance's attestation status", + "description": "Gets/Lists virtual machine instance's attestation status" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Deletes logical networks resource", + "description": "Deletes logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Creates/Updates logical networks resource", + "description": "Creates/Updates logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Gets/Lists logical networks resource", + "description": "Gets/Lists logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/LogicalNetworks/join/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "LogicalNetworks", + "operation": "Joins logical networks resource", + "description": "Joins logical networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Restarts virtual machine instance resource", + "description": "Restarts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Starts virtual machine instance resource", + "description": "Starts virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Stops virtual machine instance resource", + "description": "Stops virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Deletes virtual machine instance resource", + "description": "Deletes virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Creates/Updates virtual machine instance resource", + "description": "Creates/Updates virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachineInstances/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachineInstances", + "operation": "Gets/Lists virtual machine instance resource", + "description": "Gets/Lists virtual machine instance resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deletes storage containers resource", + "description": "Deletes storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Creates/Updates storage containers resource", + "description": "Creates/Updates storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Gets/Lists storage containers resource", + "description": "Gets/Lists storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/StorageContainers/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "StorageContainers", + "operation": "Deploys storage containers resource", + "description": "Deploys storage containers resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deletes market place gallery images resource", + "description": "Deletes market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Creates/Updates market place gallery images resource", + "description": "Creates/Updates market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Gets/Lists market place gallery images resource", + "description": "Gets/Lists market place gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/MarketPlaceGalleryImages/deploy/action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "MarketPlaceGalleryImages", + "operation": "Deploys market place gallery images resource", + "description": "Deploys market place gallery images resource" + } + } + ] + } + } + }, + "operationId": "Operations_List", + "title": "List the operations for the provider." +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/operations.json new file mode 100644 index 000000000000..e60e40001caa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-08-01-preview/operations.json @@ -0,0 +1,86 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-08-01-preview", + "description": "Azure Stack HCI management service", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.AzureStackHCI/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List the operations for the provider.": { + "$ref": "./examples/Operations_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml index 10fb5145acbc..84e49712c877 100644 --- a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml +++ b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml @@ -3,6 +3,77 @@ suppressions: - package: 'sdk/resourcemanager/azurestackhci/armazurestackhci' breaking-changes: - Function `*ExtensionsClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, string, string, Extension, *ExtensionsClientBeginUpdateOptions)` to `(context.Context, string, string, string, string, ExtensionPatch, *ExtensionsClientBeginUpdateOptions)` + - Enum `AccessLevel` has been removed + - Enum `ArcExtensionState` has been removed + - Enum `DeviceKind` has been removed + - Enum `DeviceState` has been removed + - Enum `EceSecrets` has been removed + - Enum `LogCollectionJobType` has been removed + - Enum `LogCollectionStatus` has been removed + - Enum `OperationType` has been removed + - Enum `RemoteSupportType` has been removed + - Field `CurrentOemVersion`, `CurrentSbeVersion` of struct `UpdateSummariesProperties` has been removed + - Field `EdgeDeviceClassification` of struct `EdgeDevicesClientCreateOrUpdateResponse` has been removed + - Field `EdgeDeviceClassification` of struct `EdgeDevicesClientGetResponse` has been removed + - Field `ExpectedExecutionTime` of struct `Step` has been removed + - Field `HealthCheckTags`, `TargetResourceType` of struct `PrecheckResult` has been removed + - Field `LogCollectionProperties`, `RemoteSupportProperties` of struct `ClusterProperties` has been removed + - Field `MinSbeVersionRequired` of struct `UpdateProperties` has been removed + - Field `OperationType` of struct `DeploymentSettingsProperties` has been removed + - Field `SbePartnerInfo` of struct `ScaleUnits` has been removed + - Field `SdnIntegration`, `Secrets` of struct `DeploymentData` has been removed + - Field `SmbEncryptionForIntraClusterTrafficComplianceAssignment`, `WdacComplianceAssignment` of struct `SecurityProperties` has been removed + - Function `*ClustersClient.BeginConfigureRemoteSupport` has been removed + - Function `*ClustersClient.BeginTriggerLogCollection` has been removed + - Function `*EdgeDevice.GetEdgeDevice` has been removed + - Function `*EdgeDevicesClient.BeginCreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, EdgeDeviceClassification, *EdgeDevicesClientBeginCreateOrUpdateOptions)` to `(context.Context, string, string, EdgeDevice, *EdgeDevicesClientBeginCreateOrUpdateOptions)` + - Function `*HciEdgeDevice.GetEdgeDevice` has been removed + - Struct `DeploymentSettingAdapterPropertyOverrides` has been removed + - Struct `DeploymentSettingHostNetwork` has been removed + - Struct `DeploymentSettingIntents` has been removed + - Struct `DeploymentSettingStorageAdapterIPInfo` has been removed + - Struct `DeploymentSettingStorageNetworks` has been removed + - Struct `DeploymentSettingVirtualSwitchConfigurationOverrides` has been removed + - Struct `EceActionStatus` has been removed + - Struct `EceDeploymentSecrets` has been removed + - Struct `EceReportedProperties` has been removed + - Struct `ExtensionProfile` has been removed + - Struct `HciEdgeDeviceAdapterPropertyOverrides` has been removed + - Struct `HciEdgeDeviceArcExtension` has been removed + - Struct `HciEdgeDeviceHostNetwork` has been removed + - Struct `HciEdgeDeviceIntents` has been removed + - Struct `HciEdgeDeviceProperties` has been removed + - Struct `HciEdgeDeviceStorageAdapterIPInfo` has been removed + - Struct `HciEdgeDeviceStorageNetworks` has been removed + - Struct `HciEdgeDeviceVirtualSwitchConfigurationOverrides` has been removed + - Struct `HciEdgeDevice` has been removed + - Struct `HciNetworkProfile` has been removed + - Struct `HciNicDetail` has been removed + - Struct `HciOsProfile` has been removed + - Struct `HciReportedProperties` has been removed + - Struct `HciValidationFailureDetail` has been removed + - Struct `LogCollectionError` has been removed + - Struct `LogCollectionProperties` has been removed + - Struct `LogCollectionRequestProperties` has been removed + - Struct `LogCollectionRequest` has been removed + - Struct `LogCollectionSession` has been removed + - Struct `NetworkController` has been removed + - Struct `PerNodeRemoteSupportSession` has been removed + - Struct `RemoteSupportNodeSettings` has been removed + - Struct `RemoteSupportProperties` has been removed + - Struct `RemoteSupportRequestProperties` has been removed + - Struct `RemoteSupportRequest` has been removed + - Struct `SbeCredentials` has been removed + - Struct `SbeDeploymentInfo` has been removed + - Struct `SbeDeploymentPackageInfo` has been removed + - Struct `SbePartnerInfo` has been removed + - Struct `SbePartnerProperties` has been removed + - Struct `SdnIntegration` has been removed + - Struct `SwitchDetail` has been removed + - Struct `SwitchExtension` has been removed + - Type of `DeploymentData.HostNetwork` has been changed from `*DeploymentSettingHostNetwork` to `*HostNetwork` + - Type of `DeploymentSettingsProperties.ReportedProperties` has been changed from `*EceReportedProperties` to `*ReportedProperties` + - Type of `EdgeDeviceListResult.Value` has been changed from `[]EdgeDeviceClassification` to `[]*EdgeDevice` azure-sdk-for-python: - package: 'azure-mgmt-azurestackhci' @@ -105,7 +176,25 @@ suppressions: - The model or publicly exposed class 'Extension' had its instance variable 'last_modified_by_type' deleted or renamed in the current version - The publicly exposed function 'patch_sdk' was deleted or renamed in the current version - The publicly exposed function 'patch_sdk' was deleted or renamed in the current version - + - Deleted or renamed function `patch_sdk` + - Model `ArcSetting` deleted or renamed its instance variable `created_at` + - Model `ArcSetting` deleted or renamed its instance variable `created_by_type` + - Model `ArcSetting` deleted or renamed its instance variable `created_by` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_at` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_by_type` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_by` + - Model `Cluster` deleted or renamed its instance variable `created_at` + - Model `Cluster` deleted or renamed its instance variable `created_by_type` + - Model `Cluster` deleted or renamed its instance variable `created_by` + - Model `Cluster` deleted or renamed its instance variable `last_modified_at` + - Model `Cluster` deleted or renamed its instance variable `last_modified_by_type` + - Model `Cluster` deleted or renamed its instance variable `last_modified_by` + - Model `Extension` deleted or renamed its instance variable `created_at` + - Model `Extension` deleted or renamed its instance variable `created_by_type` + - Model `Extension` deleted or renamed its instance variable `created_by` + - Model `Extension` deleted or renamed its instance variable `last_modified_at` + - Model `Extension` deleted or renamed its instance variable `last_modified_by_type` + - Model `Extension` deleted or renamed its instance variable `last_modified_by` azure-sdk-for-js: - package: '@azure/arm-azurestackhci' breaking-changes: From 59a7e3290263cf8bfba4d4e08956e9fc22e2ecd6 Mon Sep 17 00:00:00 2001 From: Matthew Boentoro <mattboentoro@yahoo.com> Date: Fri, 11 Oct 2024 09:38:04 -0700 Subject: [PATCH 093/101] Fix the diagnostic text typo (#30796) Co-authored-by: Matthew Boentoro <mboentoro@microsoft.com> --- .../2018-06-01-privatepreview/examples/OperationList.json | 2 +- .../stable/2018-06-01/examples/OperationList.json | 2 +- .../preview/2021-12-01-preview/examples/OperationsList.json | 2 +- .../preview/2022-09-30-preview/examples/OperationsList.json | 2 +- .../preview/2023-06-01-preview/examples/OperationsList.json | 2 +- .../preview/2023-12-01-preview/examples/OperationsList.json | 2 +- .../stable/2022-01-01/examples/OperationsList.json | 2 +- .../stable/2023-06-30/examples/OperationsList.json | 2 +- .../stable/2023-12-30/examples/OperationsList.json | 2 +- .../preview/2017-12-01-preview/examples/OperationList.json | 2 +- .../2018-06-01-privatepreview/examples/OperationList.json | 2 +- .../preview/2020-07-01-preview/examples/OperationsList.json | 2 +- .../2020-07-01-privatepreview/examples/OperationsList.json | 2 +- .../preview/2021-05-01-preview/examples/OperationsList.json | 2 +- .../legacy/stable/2017-12-01/examples/OperationList.json | 2 +- .../legacy/stable/2021-05-01/examples/OperationsList.json | 2 +- .../preview/2017-12-01-preview/examples/OperationList.json | 2 +- .../preview/2020-02-14-preview/examples/OperationList.json | 2 +- .../2020-02-14-privatepreview/examples/OperationList.json | 2 +- .../2021-04-10-privatepreview/examples/OperationList.json | 2 +- .../preview/2021-06-01-preview/examples/OperationList.json | 2 +- .../2021-06-15-privatepreview/examples/OperationList.json | 2 +- .../preview/2022-01-20-preview/examples/OperationList.json | 2 +- .../preview/2022-03-08-preview/examples/OperationList.json | 2 +- .../preview/2022-05-01-preview/examples/OperationList.json | 2 +- .../preview/2023-03-01-preview/examples/OperationList.json | 2 +- .../preview/2023-06-01-preview/examples/OperationList.json | 2 +- .../preview/2023-12-01-preview/examples/OperationList.json | 2 +- .../preview/2024-03-01-preview/examples/OperationList.json | 2 +- .../stable/2017-12-01/examples/OperationList.json | 2 +- .../stable/2021-06-01/examples/OperationList.json | 2 +- .../stable/2022-12-01/examples/OperationList.json | 2 +- .../2020-10-05-privatepreview/examples/OperationList.json | 2 +- .../preview/2023-03-02-preview/examples/OperationList.json | 2 +- .../stable/2022-11-08/examples/OperationList.json | 2 +- 35 files changed, 35 insertions(+), 35 deletions(-) diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/examples/OperationList.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/examples/OperationList.json index e5d4c6992f3f..826eedd36351 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/examples/OperationList.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/examples/OperationList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MariaDB", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/OperationList.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/OperationList.json index e5d4c6992f3f..826eedd36351 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/OperationList.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/examples/OperationList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MariaDB", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2021-12-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2021-12-01-preview/examples/OperationsList.json index 4ff9be1db93f..440c5cccf476 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2021-12-01-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2021-12-01-preview/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2022-09-30-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2022-09-30-preview/examples/OperationsList.json index 2098009efd32..1ca95e4f7af8 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2022-09-30-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2022-09-30-preview/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-06-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-06-01-preview/examples/OperationsList.json index a6ca678a70f0..b9714afc0081 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-06-01-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-06-01-preview/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-12-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-12-01-preview/examples/OperationsList.json index ea843531f4e1..1378e40e13d7 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-12-01-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/preview/2023-12-01-preview/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2022-01-01/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2022-01-01/examples/OperationsList.json index e95d5e49966f..e4553c7f4596 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2022-01-01/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2022-01-01/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-06-30/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-06-30/examples/OperationsList.json index da4a3f15a11e..0373df095200 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-06-30/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-06-30/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-12-30/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-12-30/examples/OperationsList.json index 6b70f1279773..3d16b7ad6603 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-12-30/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/ServiceOperations/stable/2023-12-30/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2017-12-01-preview/examples/OperationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2017-12-01-preview/examples/OperationList.json index 3c2143e5e4f0..4576d697357a 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2017-12-01-preview/examples/OperationList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2017-12-01-preview/examples/OperationList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2018-06-01-privatepreview/examples/OperationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2018-06-01-privatepreview/examples/OperationList.json index d58a0f0af262..1c8105a9ceac 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2018-06-01-privatepreview/examples/OperationList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2018-06-01-privatepreview/examples/OperationList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-preview/examples/OperationsList.json index 6add7867c492..b3f420c16f0f 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-preview/examples/OperationsList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-privatepreview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-privatepreview/examples/OperationsList.json index 850bf4852be2..3e352fb5841c 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-privatepreview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2020-07-01-privatepreview/examples/OperationsList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2021-05-01-preview/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2021-05-01-preview/examples/OperationsList.json index 38466a7f0b6f..ee36e6e6d8a9 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2021-05-01-preview/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/preview/2021-05-01-preview/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2017-12-01/examples/OperationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2017-12-01/examples/OperationList.json index d58a0f0af262..1c8105a9ceac 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2017-12-01/examples/OperationList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2017-12-01/examples/OperationList.json @@ -198,7 +198,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/examples/OperationsList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/examples/OperationsList.json index 6357eb4e8108..4b4eb92374ac 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/examples/OperationsList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2021-05-01/examples/OperationsList.json @@ -171,7 +171,7 @@ "provider": "Microsoft DB for MySQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/OperationList.json index c0680a25457c..4add31f7abb2 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/OperationList.json @@ -175,7 +175,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json index 034fdc616edd..e39268505f78 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json index af13889175e0..6ee798efa708 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/examples/OperationList.json index fca6e07cde04..4fbde31574d9 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-04-10-privatepreview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json index c7a129c6acc1..129645833653 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json index d2568e2815bf..1bc145b8e027 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2021-06-15-privatepreview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/examples/OperationList.json index 1951a7f343b0..feb6b53ee468 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-01-20-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/examples/OperationList.json index 11c053ee91c1..e5462207376d 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-03-08-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/examples/OperationList.json index b2d4063c6f15..14f577237da7 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2022-05-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/examples/OperationList.json index 583504129c5b..d294f0ea23df 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/OperationList.json index c41129527ab0..95847ff48a8f 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-06-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/examples/OperationList.json index f706839440d3..e959c6c1fb4b 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-12-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/examples/OperationList.json index 5e60cc472a41..7525df52f23f 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2024-03-01-preview/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json index c91564222e96..924c070b4c94 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/examples/OperationList.json @@ -160,7 +160,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json index 79c1521a1cba..3191953ecd8f 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2021-06-01/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/OperationList.json index 9cac954a374a..8607f5493002 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/OperationList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-12-01/examples/OperationList.json @@ -157,7 +157,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-10-05-privatepreview/examples/OperationList.json b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-10-05-privatepreview/examples/OperationList.json index be0464cc5513..bac6e074e7f0 100644 --- a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-10-05-privatepreview/examples/OperationList.json +++ b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-10-05-privatepreview/examples/OperationList.json @@ -178,7 +178,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/OperationList.json b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/OperationList.json index 92a97b2fcca2..83bc3916dd3d 100644 --- a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/OperationList.json +++ b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/preview/2023-03-02-preview/examples/OperationList.json @@ -178,7 +178,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { diff --git a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-11-08/examples/OperationList.json b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-11-08/examples/OperationList.json index 71a53a67b6f3..b55e808f62f5 100644 --- a/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-11-08/examples/OperationList.json +++ b/specification/postgresqlhsc/resource-manager/Microsoft.DBforPostgreSQL/stable/2022-11-08/examples/OperationList.json @@ -178,7 +178,7 @@ "provider": "Microsoft DB for PostgreSQL", "resource": "Database Metric Definition", "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" + "description": "Gets the diagnostic setting for the resource" } }, { From 8b9c9e84b2ed9da6d74ce0856bb0d8973912cb2f Mon Sep 17 00:00:00 2001 From: elizatargithub7 <148910954+elizatargithub7@users.noreply.github.com> Date: Fri, 11 Oct 2024 12:11:03 -0700 Subject: [PATCH 094/101] DevOpsInfrastructure - stable version (#30880) * new version base * up * remove unused * up --- .../2024-10-19/CreateOrUpdatePool.json | 111 + .../examples/2024-10-19/DeletePool.json | 18 + .../examples/2024-10-19/GetPool.json | 45 + .../2024-10-19/ImageVersions_ListByImage.json | 27 + .../examples/2024-10-19/ListOperations.json | 12 + .../2024-10-19/ListPoolsBySubscription.json | 20 + ...stPoolsBySubscriptionAndResourceGroup.json | 21 + .../ResourceDetails_ListByPool.json | 37 + .../2024-10-19/Sku_ListByLocation.json | 278 +++ .../2024-10-19/SubscriptionUsages_Usages.json | 38 + .../examples/2024-10-19/UpdatePool.json | 23 + .../main.tsp | 4 +- .../2024-10-19/devopsinfrastructure.json | 1987 +++++++++++++++++ .../examples/CreateOrUpdatePool.json | 111 + .../2024-10-19/examples/DeletePool.json | 18 + .../stable/2024-10-19/examples/GetPool.json | 45 + .../examples/ImageVersions_ListByImage.json | 27 + .../2024-10-19/examples/ListOperations.json | 12 + .../examples/ListPoolsBySubscription.json | 20 + ...stPoolsBySubscriptionAndResourceGroup.json | 21 + .../examples/ResourceDetails_ListByPool.json | 37 + .../examples/Sku_ListByLocation.json | 278 +++ .../examples/SubscriptionUsages_Usages.json | 38 + .../2024-10-19/examples/UpdatePool.json | 23 + .../resource-manager/readme.md | 12 +- 25 files changed, 3260 insertions(+), 3 deletions(-) create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/CreateOrUpdatePool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/DeletePool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/GetPool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ImageVersions_ListByImage.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListOperations.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscription.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscriptionAndResourceGroup.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ResourceDetails_ListByPool.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/Sku_ListByLocation.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/SubscriptionUsages_Usages.json create mode 100644 specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/UpdatePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/devopsinfrastructure.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/CreateOrUpdatePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/DeletePool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/GetPool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ImageVersions_ListByImage.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListOperations.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscription.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscriptionAndResourceGroup.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ResourceDetails_ListByPool.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/Sku_ListByLocation.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/SubscriptionUsages_Usages.json create mode 100644 specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/UpdatePool.json diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/CreateOrUpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/CreateOrUpdatePool.json new file mode 100644 index 000000000000..5fb4aa120fd0 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/CreateOrUpdatePool.json @@ -0,0 +1,111 @@ +{ + "title": "Pools_CreateOrUpdate", + "operationId": "Pools_CreateOrUpdate", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "resource": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/DeletePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/DeletePool.json new file mode 100644 index 000000000000..75a144374697 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/DeletePool.json @@ -0,0 +1,18 @@ +{ + "title": "Pools_Delete", + "operationId": "Pools_Delete", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/GetPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/GetPool.json new file mode 100644 index 000000000000..67e3ffe27ff7 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Pools_Get", + "operationId": "Pools_Get", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ImageVersions_ListByImage.json new file mode 100644 index 000000000000..1a4142f2edc4 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ImageVersions_ListByImage.json @@ -0,0 +1,27 @@ +{ + "title": "ImageVersions_ListByImage", + "operationId": "ImageVersions_ListByImage", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "imageName": "windows-2022" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.0", + "name": "2024.0417.0" + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.1", + "name": "2024.0417.1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListOperations.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListOperations.json new file mode 100644 index 000000000000..88828d9caf3c --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListOperations.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-10-19" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscription.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscription.json new file mode 100644 index 000000000000..85563c083109 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscription.json @@ -0,0 +1,20 @@ +{ + "title": "Pools_ListBySubscription", + "operationId": "Pools_ListBySubscription", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/aoiresourceGroupName/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..3a89dd5bab50 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ListPoolsBySubscriptionAndResourceGroup.json @@ -0,0 +1,21 @@ +{ + "title": "Pools_ListByResourceGroup", + "operationId": "Pools_ListByResourceGroup", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ResourceDetails_ListByPool.json new file mode 100644 index 000000000000..2870cc532b47 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/ResourceDetails_ListByPool.json @@ -0,0 +1,37 @@ +{ + "title": "ResourceDetails_ListByPool", + "operationId": "ResourceDetails_ListByPool", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "poolName": "my-dev-ops-pool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_0", + "name": "dd8cc705c000000", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Ready" + } + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_1", + "name": "dd8cc705c000001", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Allocated" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/Sku_ListByLocation.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/Sku_ListByLocation.json new file mode 100644 index 000000000000..e81d4b9afe48 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/Sku_ListByLocation.json @@ -0,0 +1,278 @@ +{ + "title": "Sku_ListByLocation", + "operationId": "Sku_ListByLocation", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Basic", + "size": "A0", + "family": "basicAFamily", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "MaxDataDiskCount", + "value": "1" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "50" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [ + { + "type": "Location", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ] + }, + "reasonCode": "NotAvailableForSubscription" + }, + { + "type": "Zone", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ], + "zones": [ + "1", + "2", + "3" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Basic_A0", + "name": "Basic_A0" + }, + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Standard", + "size": "A2_v2", + "family": "standardAv2Family", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [ + "1", + "2", + "3" + ], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "2" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "4" + }, + { + "name": "MaxDataDiskCount", + "value": "4" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "True" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "PaaS,IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "2" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "CombinedTempDiskAndCachedIOPS", + "value": "2000" + }, + { + "name": "CombinedTempDiskAndCachedReadBytesPerSecond", + "value": "41943040" + }, + { + "name": "CombinedTempDiskAndCachedWriteBytesPerSecond", + "value": "20971520" + }, + { + "name": "UncachedDiskIOPS", + "value": "3200" + }, + { + "name": "UncachedDiskBytesPerSecond", + "value": "48000000" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "True" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Standard_A2_v2", + "name": "Standard_A2_v2" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..3b4e544fb465 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2024-10-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/UpdatePool.json b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/UpdatePool.json new file mode 100644 index 000000000000..422a675358b9 --- /dev/null +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/examples/2024-10-19/UpdatePool.json @@ -0,0 +1,23 @@ +{ + "title": "Pools_Update", + "operationId": "Pools_Update", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp index b43dc159be7b..f97c686b6005 100644 --- a/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp +++ b/specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure.Management/main.tsp @@ -21,10 +21,10 @@ namespace Microsoft.DevOpsInfrastructure; /** Api versions */ enum Versions { - /** 2024-04-04-preview preview version */ + /** 2024-10-19 version */ @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) @useDependency(Azure.Core.Versions.v1_0_Preview_2) - `2024-04-04-preview`, + `2024-10-19`, } model Pool is TrackedResource<PoolProperties> { diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/devopsinfrastructure.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/devopsinfrastructure.json new file mode 100644 index 000000000000..be7e89f00470 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/devopsinfrastructure.json @@ -0,0 +1,1987 @@ +{ + "swagger": "2.0", + "info": { + "title": "Managed DevOps Infrastructure", + "version": "2024-10-19", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Pools" + }, + { + "name": "ResourceDetails" + }, + { + "name": "Sku" + }, + { + "name": "SubscriptionUsages" + }, + { + "name": "ImageVersions" + } + ], + "paths": { + "/providers/Microsoft.DevOpsInfrastructure/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/ListOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{locationName}/skus": { + "get": { + "operationId": "Sku_ListByLocation", + "tags": [ + "Sku" + ], + "description": "List ResourceSku resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "locationName", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceSkuListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Sku_ListByLocation": { + "$ref": "./examples/Sku_ListByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/locations/{location}/usages": { + "get": { + "operationId": "SubscriptionUsages_Usages", + "tags": [ + "SubscriptionUsages" + ], + "description": "List Quota resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedQuota" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SubscriptionUsages_Usages": { + "$ref": "./examples/SubscriptionUsages_Usages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevOpsInfrastructure/pools": { + "get": { + "operationId": "Pools_ListBySubscription", + "tags": [ + "Pools" + ], + "description": "List Pool resources 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/PoolListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_ListBySubscription": { + "$ref": "./examples/ListPoolsBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/images/{imageName}/versions": { + "get": { + "operationId": "ImageVersions_ListByImage", + "tags": [ + "ImageVersions" + ], + "description": "List ImageVersion resources by Image", + "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": "imageName", + "in": "path", + "description": "Name of the image.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_ListByImage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools": { + "get": { + "operationId": "Pools_ListByResourceGroup", + "tags": [ + "Pools" + ], + "description": "List Pool resources 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/PoolListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_ListByResourceGroup": { + "$ref": "./examples/ListPoolsBySubscriptionAndResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}": { + "get": { + "operationId": "Pools_Get", + "tags": [ + "Pools" + ], + "description": "Get a Pool", + "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": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/GetPool.json" + } + } + }, + "put": { + "operationId": "Pools_CreateOrUpdate", + "tags": [ + "Pools" + ], + "description": "Create a Pool", + "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": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Pool' update operation succeeded", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Resource 'Pool' create operation succeeded", + "schema": { + "$ref": "#/definitions/Pool" + }, + "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": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdatePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Pools_Update", + "tags": [ + "Pools" + ], + "description": "Update a Pool", + "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": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Resource update request 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/UpdatePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Pools_Delete", + "tags": [ + "Pools" + ], + "description": "Delete a Pool", + "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": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[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": { + "Pools_Delete": { + "$ref": "./examples/DeletePool.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}/resources": { + "get": { + "operationId": "ResourceDetails_ListByPool", + "tags": [ + "ResourceDetails" + ], + "description": "List ResourceDetailsObject resources by Pool", + "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": "poolName", + "in": "path", + "description": "Name of the pool. It needs to be globally unique.", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-.]*$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ResourceDetailsObjectListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "ResourceDetails_ListByPool": { + "$ref": "./examples/ResourceDetails_ListByPool.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AgentProfile": { + "type": "object", + "description": "The agent profile of the machines in the pool.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for AgentProfile." + }, + "resourcePredictions": { + "$ref": "#/definitions/ResourcePredictions", + "description": "Defines pool buffer/stand-by agents." + }, + "resourcePredictionsProfile": { + "$ref": "#/definitions/ResourcePredictionsProfile", + "description": "Defines how the pool buffer/stand-by agents is provided." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "AutomaticResourcePredictionsProfile": { + "type": "object", + "description": "The stand-by agent scheme is determined based on historical demand.", + "properties": { + "predictionPreference": { + "$ref": "#/definitions/PredictionPreference", + "description": "Determines the balance between cost and performance." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourcePredictionsProfile" + } + ], + "x-ms-discriminator-value": "Automatic" + }, + "Azure.Core.azureLocation": { + "type": "string", + "description": "Represents an Azure geography region where supported resource providers live." + }, + "AzureDevOpsOrganizationProfile": { + "type": "object", + "description": "Azure DevOps organization profile", + "properties": { + "organizations": { + "type": "array", + "description": "The list of Azure DevOps organizations the pool should be present in.", + "items": { + "$ref": "#/definitions/Organization" + }, + "x-ms-identifiers": [] + }, + "permissionProfile": { + "$ref": "#/definitions/AzureDevOpsPermissionProfile", + "description": "The type of permission which determines which accounts are admins on the Azure DevOps pool." + } + }, + "required": [ + "organizations" + ], + "allOf": [ + { + "$ref": "#/definitions/OrganizationProfile" + } + ], + "x-ms-discriminator-value": "AzureDevOps" + }, + "AzureDevOpsPermissionProfile": { + "type": "object", + "description": "Defines the type of Azure DevOps pool permission.", + "properties": { + "kind": { + "$ref": "#/definitions/AzureDevOpsPermissionType", + "description": "Determines who has admin permissions to the Azure DevOps pool." + }, + "users": { + "type": "array", + "description": "User email addresses", + "items": { + "type": "string" + } + }, + "groups": { + "type": "array", + "description": "Group email addresses", + "items": { + "type": "string" + } + } + }, + "required": [ + "kind" + ] + }, + "AzureDevOpsPermissionType": { + "type": "string", + "description": "Determines who has admin permissions to the Azure DevOps pool.", + "enum": [ + "Inherit", + "CreatorOnly", + "SpecificAccounts" + ], + "x-ms-enum": { + "name": "AzureDevOpsPermissionType", + "modelAsString": true, + "values": [ + { + "name": "Inherit", + "value": "Inherit", + "description": "Pool will inherit permissions from the project or organization." + }, + { + "name": "CreatorOnly", + "value": "CreatorOnly", + "description": "Only the pool creator will be an admin of the pool." + }, + { + "name": "SpecificAccounts", + "value": "SpecificAccounts", + "description": "Only the specified accounts will be admins of the pool." + } + ] + } + }, + "CachingType": { + "type": "string", + "description": "The type of caching in a data disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Don't use host caching." + }, + { + "name": "ReadOnly", + "value": "ReadOnly", + "description": "For workloads that only do read operations." + }, + { + "name": "ReadWrite", + "value": "ReadWrite", + "description": "For workloads that do a balance of read and write operations." + } + ] + } + }, + "DataDisk": { + "type": "object", + "description": "The data disk of the VMSS.", + "properties": { + "caching": { + "$ref": "#/definitions/CachingType", + "description": "The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGiB": { + "type": "integer", + "format": "int32", + "description": "The initial disk size in gigabytes." + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "The storage Account type to be used for the data disk. If omitted, the default is \"standard_lrs\"." + }, + "driveLetter": { + "type": "string", + "description": "The drive letter for the empty data disk. If not specified, it will be the first available letter." + } + } + }, + "DevOpsAzureSku": { + "type": "object", + "description": "The Azure SKU of the machines in the pool.", + "properties": { + "name": { + "type": "string", + "description": "The Azure SKU name of the machines in the pool." + } + }, + "required": [ + "name" + ] + }, + "FabricProfile": { + "type": "object", + "description": "Defines the type of fabric the agent will run on.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for FabricProfile." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "GitHubOrganization": { + "type": "object", + "description": "Defines a GitHub organization", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The GitHub organization URL in which the pool should be created." + }, + "repositories": { + "type": "array", + "description": "Optional list of repositories in which the pool should be created.", + "items": { + "type": "string" + } + } + }, + "required": [ + "url" + ] + }, + "GitHubOrganizationProfile": { + "type": "object", + "description": "GitHub organization profile", + "properties": { + "organizations": { + "type": "array", + "description": "The list of GitHub organizations/repositories the pool should be present in.", + "items": { + "$ref": "#/definitions/GitHubOrganization" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "organizations" + ], + "allOf": [ + { + "$ref": "#/definitions/OrganizationProfile" + } + ], + "x-ms-discriminator-value": "GitHub" + }, + "ImageVersion": { + "type": "object", + "description": "An image version object", + "properties": { + "properties": { + "$ref": "#/definitions/ImageVersionProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ImageVersionListResult": { + "type": "object", + "description": "The response of a ImageVersion list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ImageVersion items on this page", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImageVersionProperties": { + "type": "object", + "description": "Details of the ImageVersionProperties.", + "properties": { + "version": { + "type": "string", + "description": "Version of the image." + } + }, + "required": [ + "version" + ] + }, + "LogonType": { + "type": "string", + "description": "Determines how the service should be run.", + "enum": [ + "Service", + "Interactive" + ], + "x-ms-enum": { + "name": "LogonType", + "modelAsString": true, + "values": [ + { + "name": "Service", + "value": "Service", + "description": "Run as a service." + }, + { + "name": "Interactive", + "value": "Interactive", + "description": "Run in interactive mode." + } + ] + } + }, + "ManualResourcePredictionsProfile": { + "type": "object", + "description": "Customer provides the stand-by agent scheme.", + "allOf": [ + { + "$ref": "#/definitions/ResourcePredictionsProfile" + } + ], + "x-ms-discriminator-value": "Manual" + }, + "NetworkProfile": { + "type": "object", + "description": "The network profile of the machines in the pool.", + "properties": { + "subnetId": { + "type": "string", + "description": "The subnet id on which to put all machines created in the pool." + } + }, + "required": [ + "subnetId" + ] + }, + "Organization": { + "type": "object", + "description": "Defines an Azure DevOps organization.", + "properties": { + "url": { + "type": "string", + "format": "uri", + "description": "The Azure DevOps organization URL in which the pool should be created." + }, + "projects": { + "type": "array", + "description": "Optional list of projects in which the pool should be created.", + "items": { + "type": "string" + } + }, + "parallelism": { + "type": "integer", + "format": "int32", + "description": "How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool." + } + }, + "required": [ + "url" + ] + }, + "OrganizationProfile": { + "type": "object", + "description": "Defines the organization in which the pool will be used.", + "properties": { + "kind": { + "type": "string", + "description": "Discriminator property for OrganizationProfile." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "OsDiskStorageAccountType": { + "type": "string", + "description": "The storage account type of the OS disk.", + "enum": [ + "Standard", + "Premium", + "StandardSSD" + ], + "x-ms-enum": { + "name": "OsDiskStorageAccountType", + "modelAsString": true, + "values": [ + { + "name": "Standard", + "value": "Standard", + "description": "Standard OS disk type." + }, + { + "name": "Premium", + "value": "Premium", + "description": "Premium OS disk type." + }, + { + "name": "StandardSSD", + "value": "StandardSSD", + "description": "Standard SSD OS disk type." + } + ] + } + }, + "OsProfile": { + "type": "object", + "description": "The OS profile of the machines in the pool.", + "properties": { + "secretsManagementSettings": { + "$ref": "#/definitions/SecretsManagementSettings", + "description": "The secret management settings of the machines in the pool." + }, + "logonType": { + "$ref": "#/definitions/LogonType", + "description": "Determines how the service should be run. By default, this will be set to Service." + } + } + }, + "PagedQuota": { + "type": "object", + "description": "Paged collection of Quota items", + "properties": { + "value": { + "type": "array", + "description": "The Quota items on this page", + "items": { + "$ref": "#/definitions/Quota" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Pool": { + "type": "object", + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "properties": { + "properties": { + "$ref": "#/definitions/PoolProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ] + }, + "PoolImage": { + "type": "object", + "description": "The VM image of the machines in the pool.", + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the image." + }, + "wellKnownImageName": { + "type": "string", + "description": "The image to use from a well-known set of images made available to customers." + }, + "aliases": { + "type": "array", + "description": "List of aliases to reference the image by.", + "items": { + "type": "string" + } + }, + "buffer": { + "type": "string", + "description": "The percentage of the buffer to be allocated to this image.", + "default": "*" + } + } + }, + "PoolListResult": { + "type": "object", + "description": "The response of a Pool list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Pool items on this page", + "items": { + "$ref": "#/definitions/Pool" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "PoolProperties": { + "type": "object", + "description": "Pool properties", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the current operation." + }, + "maximumConcurrency": { + "type": "integer", + "format": "int32", + "description": "Defines how many resources can there be created at any given time.", + "minimum": 1, + "maximum": 10000 + }, + "organizationProfile": { + "$ref": "#/definitions/OrganizationProfile", + "description": "Defines the organization in which the pool will be used." + }, + "agentProfile": { + "$ref": "#/definitions/AgentProfile", + "description": "Defines how the machine will be handled once it executed a job." + }, + "fabricProfile": { + "$ref": "#/definitions/FabricProfile", + "description": "Defines the type of fabric the agent will run on." + }, + "devCenterProjectResourceId": { + "type": "string", + "description": "The resource id of the DevCenter Project the pool belongs to." + } + }, + "required": [ + "maximumConcurrency", + "organizationProfile", + "agentProfile", + "fabricProfile", + "devCenterProjectResourceId" + ] + }, + "PoolUpdate": { + "type": "object", + "description": "The type used for update operations of the Pool.", + "properties": { + "identity": { + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The managed service identities assigned to this resource." + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/PoolUpdateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + } + }, + "PoolUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Pool.", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the current operation." + }, + "maximumConcurrency": { + "type": "integer", + "format": "int32", + "description": "Defines how many resources can there be created at any given time.", + "minimum": 1, + "maximum": 10000 + }, + "organizationProfile": { + "$ref": "#/definitions/OrganizationProfile", + "description": "Defines the organization in which the pool will be used." + }, + "agentProfile": { + "$ref": "#/definitions/AgentProfile", + "description": "Defines how the machine will be handled once it executed a job." + }, + "fabricProfile": { + "$ref": "#/definitions/FabricProfile", + "description": "Defines the type of fabric the agent will run on." + }, + "devCenterProjectResourceId": { + "type": "string", + "description": "The resource id of the DevCenter Project the pool belongs to." + } + } + }, + "PredictionPreference": { + "type": "string", + "description": "Determines the balance between cost and performance.", + "enum": [ + "Balanced", + "MostCostEffective", + "MoreCostEffective", + "MorePerformance", + "BestPerformance" + ], + "x-ms-enum": { + "name": "PredictionPreference", + "modelAsString": true, + "values": [ + { + "name": "Balanced", + "value": "Balanced", + "description": "Balance between cost and performance." + }, + { + "name": "MostCostEffective", + "value": "MostCostEffective", + "description": "Optimizes for cost over performance." + }, + { + "name": "MoreCostEffective", + "value": "MoreCostEffective", + "description": "Halfway through cost and balanced." + }, + { + "name": "MorePerformance", + "value": "MorePerformance", + "description": "Halfway through balanced and performance." + }, + { + "name": "BestPerformance", + "value": "BestPerformance", + "description": "Optimizes for performance over cost." + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The status of the current operation.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Represents a succeeded operation." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Represents a failed operation." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Represents a canceled operation." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Represents a pending operation." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Represents a pending operation." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Represents an operation under deletion." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Represents an accepted operation." + } + ] + } + }, + "Quota": { + "type": "object", + "description": "Describes Resource Quota", + "properties": { + "name": { + "$ref": "#/definitions/QuotaName", + "description": "The name of the quota.", + "readOnly": true + }, + "id": { + "type": "string", + "format": "arm-id", + "description": "Fully qualified ARM resource id" + }, + "unit": { + "type": "string", + "description": "The unit of usage measurement." + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + } + }, + "required": [ + "id", + "unit", + "currentValue", + "limit" + ] + }, + "QuotaName": { + "type": "object", + "description": "The Quota Names", + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + } + }, + "ResourceDetailsObject": { + "type": "object", + "description": "A ResourceDetailsObject", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceDetailsObjectProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResourceDetailsObjectListResult": { + "type": "object", + "description": "The response of a ResourceDetailsObject list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceDetailsObject items on this page", + "items": { + "$ref": "#/definitions/ResourceDetailsObject" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ResourceDetailsObjectProperties": { + "type": "object", + "description": "Details of the ResourceDetailsObject.", + "properties": { + "status": { + "$ref": "#/definitions/ResourceStatus", + "description": "The status of the resource." + }, + "image": { + "type": "string", + "description": "The image name of the resource." + }, + "imageVersion": { + "type": "string", + "description": "The version of the image running on the resource." + } + }, + "required": [ + "status", + "image", + "imageVersion" + ] + }, + "ResourcePredictions": { + "type": "object", + "description": "Defines pool buffer." + }, + "ResourcePredictionsProfile": { + "type": "object", + "description": "Determines how the stand-by scheme should be provided.", + "properties": { + "kind": { + "$ref": "#/definitions/ResourcePredictionsProfileType", + "description": "Determines how the stand-by scheme should be provided." + } + }, + "discriminator": "kind", + "required": [ + "kind" + ] + }, + "ResourcePredictionsProfileType": { + "type": "string", + "description": "Determines how the stand-by scheme should be provided.", + "enum": [ + "Manual", + "Automatic" + ], + "x-ms-enum": { + "name": "ResourcePredictionsProfileType", + "modelAsString": true, + "values": [ + { + "name": "Manual", + "value": "Manual", + "description": "Customer provides the stand-by agent scheme." + }, + { + "name": "Automatic", + "value": "Automatic", + "description": "The stand-by agent scheme is determined based on historical demand." + } + ] + } + }, + "ResourceSku": { + "type": "object", + "description": "A ResourceSku", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceSkuProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "ResourceSkuCapabilities": { + "type": "object", + "description": "Describes The SKU capabilities object.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU capability." + }, + "value": { + "type": "string", + "description": "The value of the SKU capability." + } + }, + "required": [ + "name", + "value" + ] + }, + "ResourceSkuListResult": { + "type": "object", + "description": "The response of a ResourceSku list operation.", + "properties": { + "value": { + "type": "array", + "description": "The ResourceSku items on this page", + "items": { + "$ref": "#/definitions/ResourceSku" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ResourceSkuLocationInfo": { + "type": "object", + "description": "Describes an available Compute SKU Location Information.", + "properties": { + "location": { + "$ref": "#/definitions/Azure.Core.azureLocation", + "description": "Location of the SKU" + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is supported.", + "items": { + "type": "string" + } + }, + "zoneDetails": { + "type": "array", + "description": "Gets details of capabilities available to a SKU in specific zones.", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "location", + "zones", + "zoneDetails" + ] + }, + "ResourceSkuProperties": { + "type": "object", + "description": "Properties of a ResourceSku", + "properties": { + "resourceType": { + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "tier": { + "type": "string", + "description": "The tier of virtual machines in a scale set" + }, + "size": { + "type": "string", + "description": "The size of the SKU." + }, + "family": { + "type": "string", + "description": "The family of the SKU." + }, + "locations": { + "type": "array", + "description": "The set of locations that the SKU is available.", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + }, + "locationInfo": { + "type": "array", + "description": "A list of locations and availability zones in those locations where the SKU is available", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "x-ms-identifiers": [] + }, + "capabilities": { + "type": "array", + "description": "Name value pairs to describe the capability.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "x-ms-identifiers": [] + }, + "restrictions": { + "type": "array", + "description": "The restrictions of the SKU.", + "items": { + "$ref": "#/definitions/ResourceSkuRestrictions" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "resourceType", + "tier", + "size", + "family", + "locations", + "locationInfo", + "capabilities", + "restrictions" + ] + }, + "ResourceSkuRestrictionInfo": { + "type": "object", + "description": "Describes an available Compute SKU Restriction Information.", + "properties": { + "locations": { + "type": "array", + "description": "Locations where the SKU is restricted", + "items": { + "$ref": "#/definitions/Azure.Core.azureLocation" + } + }, + "zones": { + "type": "array", + "description": "List of availability zones where the SKU is restricted.", + "items": { + "type": "string" + } + } + } + }, + "ResourceSkuRestrictions": { + "type": "object", + "description": "The restrictions of the SKU.", + "properties": { + "type": { + "$ref": "#/definitions/ResourceSkuRestrictionsType", + "description": "the type of restrictions." + }, + "values": { + "type": "array", + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.", + "items": { + "type": "string" + } + }, + "restrictionInfo": { + "$ref": "#/definitions/ResourceSkuRestrictionInfo", + "description": "The information about the restriction where the SKU cannot be used." + }, + "reasonCode": { + "$ref": "#/definitions/ResourceSkuRestrictionsReasonCode", + "description": "the reason for restriction." + } + }, + "required": [ + "values", + "restrictionInfo" + ] + }, + "ResourceSkuRestrictionsReasonCode": { + "type": "string", + "description": "Describes the reason for SKU restriction.", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsReasonCode", + "modelAsString": true, + "values": [ + { + "name": "QuotaId", + "value": "QuotaId", + "description": "The restriction is due to exceeding a quota limitation." + }, + { + "name": "NotAvailableForSubscription", + "value": "NotAvailableForSubscription", + "description": "The restriction is not available for this subscription." + } + ] + } + }, + "ResourceSkuRestrictionsType": { + "type": "string", + "description": "Describes the kind of SKU restrictions that can exist", + "enum": [ + "Location", + "Zone" + ], + "x-ms-enum": { + "name": "ResourceSkuRestrictionsType", + "modelAsString": true, + "values": [ + { + "name": "Location", + "value": "Location", + "description": "SKU restricted by location." + }, + { + "name": "Zone", + "value": "Zone", + "description": "SKU restricted by availability zone." + } + ] + } + }, + "ResourceSkuZoneDetails": { + "type": "object", + "description": "Describes The zonal capabilities of a SKU.", + "properties": { + "name": { + "type": "array", + "description": "Gets the set of zones that the SKU is available in with the specified capabilities.", + "items": { + "type": "string" + } + }, + "capabilities": { + "type": "array", + "description": "A list of capabilities that are available for the SKU in the specified list of zones.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "capabilities" + ] + }, + "ResourceStatus": { + "type": "string", + "description": "The status of the machine resource.", + "enum": [ + "Ready", + "NotReady", + "Allocated", + "PendingReturn", + "Returned", + "Leased", + "Provisioning", + "Updating", + "Starting", + "PendingReimage", + "Reimaging" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "name": "Ready", + "value": "Ready", + "description": "Represents a machine resource that is ready." + }, + { + "name": "NotReady", + "value": "NotReady", + "description": "Represents a machine resource that is not ready." + }, + { + "name": "Allocated", + "value": "Allocated", + "description": "Represents a machine resource that is allocated." + }, + { + "name": "PendingReturn", + "value": "PendingReturn", + "description": "Represents a machine resource that is pending return." + }, + { + "name": "Returned", + "value": "Returned", + "description": "Represents a machine resource that is returned." + }, + { + "name": "Leased", + "value": "Leased", + "description": "Represents a machine resource that is leased." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "Represents a machine resource that is provisioning." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Represents a machine resource that is updating." + }, + { + "name": "Starting", + "value": "Starting", + "description": "Represents a machine resource that is starting." + }, + { + "name": "PendingReimage", + "value": "PendingReimage", + "description": "Represents a machine resource that is pending reimage." + }, + { + "name": "Reimaging", + "value": "Reimaging", + "description": "Represents a machine resource that is reimaging." + } + ] + } + }, + "SecretsManagementSettings": { + "type": "object", + "description": "The secret management settings of the machines in the pool.", + "properties": { + "certificateStoreLocation": { + "type": "string", + "description": "Where to store certificates on the machine." + }, + "observedCertificates": { + "type": "array", + "description": "The list of certificates to install on all machines in the pool.", + "items": { + "type": "string", + "format": "uri" + } + }, + "keyExportable": { + "type": "boolean", + "description": "Defines if the key of the certificates should be exportable." + } + }, + "required": [ + "observedCertificates", + "keyExportable" + ] + }, + "Stateful": { + "type": "object", + "description": "Stateful profile meaning that the machines will be returned to the pool after running a job.", + "properties": { + "maxAgentLifetime": { + "type": "string", + "description": "How long should stateful machines be kept around. The maximum is one week." + }, + "gracePeriodTimeSpan": { + "type": "string", + "description": "How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AgentProfile" + } + ], + "x-ms-discriminator-value": "Stateful" + }, + "StatelessAgentProfile": { + "type": "object", + "description": "Stateless profile meaning that the machines will be cleaned up after running a job.", + "allOf": [ + { + "$ref": "#/definitions/AgentProfile" + } + ], + "x-ms-discriminator-value": "Stateless" + }, + "StorageAccountType": { + "type": "string", + "description": "StorageAccountType enums", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "Premium_ZRS", + "StandardSSD_ZRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": true, + "values": [ + { + "name": "StandardLRS", + "value": "Standard_LRS", + "description": "The data disk should use standard locally redundant storage." + }, + { + "name": "PremiumLRS", + "value": "Premium_LRS", + "description": "The data disk should use premium locally redundant storage." + }, + { + "name": "StandardSSDLRS", + "value": "StandardSSD_LRS", + "description": "The data disk should use standard SSD locally redundant storage." + }, + { + "name": "PremiumZRS", + "value": "Premium_ZRS", + "description": "The data disk should use premium SSD zonal redundant storage." + }, + { + "name": "StandardSSDZRS", + "value": "StandardSSD_ZRS", + "description": "The data disk should use standard SSD zonal redundant storage." + } + ] + } + }, + "StorageProfile": { + "type": "object", + "description": "The storage profile of the VMSS.", + "properties": { + "osDiskStorageAccountType": { + "$ref": "#/definitions/OsDiskStorageAccountType", + "description": "The Azure SKU name of the machines in the pool." + }, + "dataDisks": { + "type": "array", + "description": "A list of empty data disks to attach.", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "x-ms-identifiers": [] + } + } + }, + "VmssFabricProfile": { + "type": "object", + "description": "The agents will run on Virtual Machine Scale Sets.", + "properties": { + "sku": { + "$ref": "#/definitions/DevOpsAzureSku", + "description": "The Azure SKU of the machines in the pool." + }, + "images": { + "type": "array", + "description": "The VM images of the machines in the pool.", + "items": { + "$ref": "#/definitions/PoolImage" + }, + "x-ms-identifiers": [] + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The OS profile of the machines in the pool." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile of the machines in the pool." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "The network profile of the machines in the pool." + } + }, + "required": [ + "sku", + "images" + ], + "allOf": [ + { + "$ref": "#/definitions/FabricProfile" + } + ], + "x-ms-discriminator-value": "Vmss" + } + }, + "parameters": {} +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/CreateOrUpdatePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/CreateOrUpdatePool.json new file mode 100644 index 000000000000..5fb4aa120fd0 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/CreateOrUpdatePool.json @@ -0,0 +1,111 @@ +{ + "title": "Pools_CreateOrUpdate", + "operationId": "Pools_CreateOrUpdate", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "resource": { + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/DeletePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/DeletePool.json new file mode 100644 index 000000000000..75a144374697 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/DeletePool.json @@ -0,0 +1,18 @@ +{ + "title": "Pools_Delete", + "operationId": "Pools_Delete", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/GetPool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/GetPool.json new file mode 100644 index 000000000000..67e3ffe27ff7 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/GetPool.json @@ -0,0 +1,45 @@ +{ + "title": "Pools_Get", + "operationId": "Pools_Get", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "maximumConcurrency": 10, + "devCenterProjectResourceId": "/subscriptions/222e81d0-cf38-4dab-baa5-289bf16baaa4/resourceGroups/rg-1es-devcenter/providers/Microsoft.DevCenter/projects/1ES", + "organizationProfile": { + "kind": "AzureDevOps", + "organizations": [ + { + "url": "https://mseng.visualstudio.com" + } + ] + }, + "agentProfile": { + "kind": "Stateless" + }, + "fabricProfile": { + "kind": "Vmss", + "sku": { + "name": "Standard_D4ads_v5" + }, + "images": [ + { + "resourceId": "/MicrosoftWindowsServer/WindowsServer/2019-Datacenter/latest" + } + ] + } + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ImageVersions_ListByImage.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ImageVersions_ListByImage.json new file mode 100644 index 000000000000..1a4142f2edc4 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ImageVersions_ListByImage.json @@ -0,0 +1,27 @@ +{ + "title": "ImageVersions_ListByImage", + "operationId": "ImageVersions_ListByImage", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "imageName": "windows-2022" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.0", + "name": "2024.0417.0" + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/images/windows-2022/versions/2024.0417.1", + "name": "2024.0417.1" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListOperations.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListOperations.json new file mode 100644 index 000000000000..88828d9caf3c --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListOperations.json @@ -0,0 +1,12 @@ +{ + "title": "Operations_List", + "operationId": "Operations_List", + "parameters": { + "api-version": "2024-10-19" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscription.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscription.json new file mode 100644 index 000000000000..85563c083109 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscription.json @@ -0,0 +1,20 @@ +{ + "title": "Pools_ListBySubscription", + "operationId": "Pools_ListBySubscription", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/aoiresourceGroupName/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscriptionAndResourceGroup.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscriptionAndResourceGroup.json new file mode 100644 index 000000000000..3a89dd5bab50 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ListPoolsBySubscriptionAndResourceGroup.json @@ -0,0 +1,21 @@ +{ + "title": "Pools_ListByResourceGroup", + "operationId": "Pools_ListByResourceGroup", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/rg/providers/Microsoft.DevOpsInfrastructure/Pools/pool", + "location": "eastus" + } + ] + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ResourceDetails_ListByPool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ResourceDetails_ListByPool.json new file mode 100644 index 000000000000..2870cc532b47 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/ResourceDetails_ListByPool.json @@ -0,0 +1,37 @@ +{ + "title": "ResourceDetails_ListByPool", + "operationId": "ResourceDetails_ListByPool", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "my-resource-group", + "poolName": "my-dev-ops-pool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_0", + "name": "dd8cc705c000000", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Ready" + } + }, + { + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/resourceGroups/my-resource-group/providers/Microsoft.DevOpsInfrastructure/pools/my-devops-pool/resources/my-dev-ops-pool:04dcde21-626e-5a7e-8659-ce12f9284b29:dd8cc705c_1", + "name": "dd8cc705c000001", + "properties": { + "image": "my-image", + "imageVersion": "4.0.0", + "status": "Allocated" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/Sku_ListByLocation.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/Sku_ListByLocation.json new file mode 100644 index 000000000000..e81d4b9afe48 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/Sku_ListByLocation.json @@ -0,0 +1,278 @@ +{ + "title": "Sku_ListByLocation", + "operationId": "Sku_ListByLocation", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "locationName": "eastus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Basic", + "size": "A0", + "family": "basicAFamily", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "1" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "0.75" + }, + { + "name": "MaxDataDiskCount", + "value": "1" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "False" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "1" + }, + { + "name": "ACUs", + "value": "50" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "False" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [ + { + "type": "Location", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ] + }, + "reasonCode": "NotAvailableForSubscription" + }, + { + "type": "Zone", + "values": [ + "eastus" + ], + "restrictionInfo": { + "locations": [ + "eastus" + ], + "zones": [ + "1", + "2", + "3" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Basic_A0", + "name": "Basic_A0" + }, + { + "properties": { + "resourceType": "virtualMachines", + "tier": "Standard", + "size": "A2_v2", + "family": "standardAv2Family", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [ + "1", + "2", + "3" + ], + "zoneDetails": [] + } + ], + "capabilities": [ + { + "name": "MaxResourceVolumeMB", + "value": "20480" + }, + { + "name": "OSVhdSizeMB", + "value": "1047552" + }, + { + "name": "vCPUs", + "value": "2" + }, + { + "name": "MemoryPreservingMaintenanceSupported", + "value": "True" + }, + { + "name": "HyperVGenerations", + "value": "V1" + }, + { + "name": "MemoryGB", + "value": "4" + }, + { + "name": "MaxDataDiskCount", + "value": "4" + }, + { + "name": "CpuArchitectureType", + "value": "x64" + }, + { + "name": "LowPriorityCapable", + "value": "True" + }, + { + "name": "PremiumIO", + "value": "False" + }, + { + "name": "VMDeploymentTypes", + "value": "PaaS,IaaS" + }, + { + "name": "vCPUsAvailable", + "value": "2" + }, + { + "name": "ACUs", + "value": "100" + }, + { + "name": "vCPUsPerCore", + "value": "1" + }, + { + "name": "CombinedTempDiskAndCachedIOPS", + "value": "2000" + }, + { + "name": "CombinedTempDiskAndCachedReadBytesPerSecond", + "value": "41943040" + }, + { + "name": "CombinedTempDiskAndCachedWriteBytesPerSecond", + "value": "20971520" + }, + { + "name": "UncachedDiskIOPS", + "value": "3200" + }, + { + "name": "UncachedDiskBytesPerSecond", + "value": "48000000" + }, + { + "name": "EphemeralOSDiskSupported", + "value": "False" + }, + { + "name": "EncryptionAtHostSupported", + "value": "False" + }, + { + "name": "CapacityReservationSupported", + "value": "True" + }, + { + "name": "AcceleratedNetworkingEnabled", + "value": "False" + }, + { + "name": "RdmaEnabled", + "value": "False" + }, + { + "name": "MaxNetworkInterfaces", + "value": "2" + } + ], + "restrictions": [] + }, + "id": "/subscriptions/a2e95d27-c161-4b61-bda4-11512c14c2c2/providers/Microsoft.DevOpsInfrastructure/locations/eastus/skus/Standard_A2_v2", + "name": "Standard_A2_v2" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/SubscriptionUsages_Usages.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/SubscriptionUsages_Usages.json new file mode 100644 index 000000000000..3b4e544fb465 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/SubscriptionUsages_Usages.json @@ -0,0 +1,38 @@ +{ + "title": "SubscriptionUsages_Usages", + "operationId": "SubscriptionUsages_Usages", + "parameters": { + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "location": "eastus", + "api-version": "2024-10-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDADSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 212, + "name": { + "value": "standardDADSv5Family", + "localizedValue": "Standard DADSv5 Family vCPUs (PME VMSS)" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Compute/locations/eastus/providers/Microsoft.DevOpsInfrastructure/Usages/standardDPLDSv5Family", + "unit": "Count", + "currentValue": 0, + "limit": 100, + "name": { + "value": "standardDPLDSv5Family", + "localizedValue": "Standard DPLDSv5 Family vCPUs (PME VMSS)" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/UpdatePool.json b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/UpdatePool.json new file mode 100644 index 000000000000..422a675358b9 --- /dev/null +++ b/specification/devopsinfrastructure/resource-manager/Microsoft.DevOpsInfrastructure/stable/2024-10-19/examples/UpdatePool.json @@ -0,0 +1,23 @@ +{ + "title": "Pools_Update", + "operationId": "Pools_Update", + "parameters": { + "api-version": "2024-10-19", + "subscriptionId": "a2e95d27-c161-4b61-bda4-11512c14c2c2", + "resourceGroupName": "rg", + "poolName": "pool", + "properties": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus" + } + }, + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + } + } +} diff --git a/specification/devopsinfrastructure/resource-manager/readme.md b/specification/devopsinfrastructure/resource-manager/readme.md index cf97da24c4ff..05a4876acd68 100644 --- a/specification/devopsinfrastructure/resource-manager/readme.md +++ b/specification/devopsinfrastructure/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the devopsinfrastructure. ``` yaml openapi-type: arm openapi-subtype: providerHub -tag: package-preview-2024-04 +tag: package-stable-2024-10-19 ``` ``` yaml @@ -35,6 +35,15 @@ modelerfour: flatten-models: false ``` +### Tag: package-stable-2024-10-19 + +These settings apply only when `--tag=package-stable-2024-10-19` is specified on the command line. + +```yaml $(tag) == 'package-stable-2024-10-19' +input-file: + - Microsoft.DevOpsInfrastructure/stable/2024-10-19/devopsinfrastructure.json +``` + ### Tag: package-preview-2024-04 These settings apply only when `--tag=package-preview-2024-04` is specified on the command line. @@ -43,6 +52,7 @@ These settings apply only when `--tag=package-preview-2024-04` is specified on t input-file: - Microsoft.DevOpsInfrastructure/preview/2024-04-04-preview/devopsinfrastructure.json ``` + ### Tag: package-preview-2024-03 These settings apply only when `--tag=package-preview-2024-03` is specified on the command line. From 15b16d1b5c3cccdecdd1cfe936f6a8005680c557 Mon Sep 17 00:00:00 2001 From: Sneha Nagendra <47864291+snehanagendra@users.noreply.github.com> Date: Fri, 11 Oct 2024 14:12:50 -0700 Subject: [PATCH 095/101] DevCenter: Remove redundant "devbox" string from capture and restore snapshot operation names (#30981) * remove redunant devbox string in operation route for restore and capture snapshot * update examples * remove obsolete example files --------- Co-authored-by: Sneha Nagendra <snnagen@microsoft.com> --- specification/devcenter/DevCenter/DevBox/routes.tsp | 4 ++-- ...eSnapshotDevBox.json => DevBoxes_RestoreSnapshot.json} | 2 +- .../2024-10-01-preview/DevBoxes_CaptureSnapshot.json} | 2 +- .../2024-10-01-preview/DevBoxes_RestoreSnapshot.json} | 2 +- .../preview/2024-09-01-preview/devcenter.json | 4 ++-- ...eSnapshotDevBox.json => DevBoxes_RestoreSnapshot.json} | 2 +- .../preview/2024-10-01-preview/devcenter.json | 8 ++++---- .../examples/DevBoxes_CaptureSnapshot.json} | 2 +- .../examples/DevBoxes_RestoreSnapshot.json} | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) rename specification/devcenter/DevCenter/examples/2024-09-01-preview/{DevBoxes_RestoreSnapshotDevBox.json => DevBoxes_RestoreSnapshot.json} (95%) rename specification/devcenter/{data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json => DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshot.json} (95%) rename specification/devcenter/{data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json => DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshot.json} (95%) rename specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/{DevBoxes_RestoreSnapshotDevBox.json => DevBoxes_RestoreSnapshot.json} (95%) rename specification/devcenter/{DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json => data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshot.json} (95%) rename specification/devcenter/{DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json => data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshot.json} (95%) diff --git a/specification/devcenter/DevCenter/DevBox/routes.tsp b/specification/devcenter/DevCenter/DevBox/routes.tsp index b203fcedf8b0..0adb56dd37af 100644 --- a/specification/devcenter/DevCenter/DevBox/routes.tsp +++ b/specification/devcenter/DevCenter/DevBox/routes.tsp @@ -432,7 +432,7 @@ interface DevBoxes { @added(APIVersions.v2024_09_01_preview) @pollingOperation(OperationStatuses.get) @action("restoreSnapshot") - restoreSnapshotDevBox is DevCenterOps.LongRunningResourceAction< + restoreSnapshot is DevCenterOps.LongRunningResourceAction< DevBox, { ...SnapshotIdQueryParameter; @@ -445,7 +445,7 @@ interface DevBoxes { @added(APIVersions.v2024_10_01_preview) @pollingOperation(OperationStatuses.get) @action("captureSnapshot") - captureSnapshotDevBox is DevCenterOps.LongRunningResourceAction< + captureSnapshot is DevCenterOps.LongRunningResourceAction< DevBox, {}, OperationStatus diff --git a/specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshot.json similarity index 95% rename from specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshotDevBox.json rename to specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshot.json index 7678cfb3b28e..0d616e909fa1 100644 --- a/specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshotDevBox.json +++ b/specification/devcenter/DevCenter/examples/2024-09-01-preview/DevBoxes_RestoreSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to restore the Dev Box to a selected snapshot.", - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "parameters": { "api-version": "2024-09-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshot.json similarity index 95% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json rename to specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshot.json index 1306f8183682..5d176aff8d08 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshotDevBox.json +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to capture the manual snapshot for the Dev Box.", - "operationId": "DevBoxes_CaptureSnapshotDevBox", + "operationId": "DevBoxes_CaptureSnapshot", "parameters": { "api-version": "2024-10-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshot.json similarity index 95% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json rename to specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshot.json index 891948c547a0..502792acd1eb 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json +++ b/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to restore the Dev Box to a selected snapshot.", - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "parameters": { "api-version": "2024-10-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json index 795ed1ac9ff4..e9d0aa3bd39e 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/devcenter.json @@ -1762,7 +1762,7 @@ }, "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot": { "post": { - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "description": "Restores a Dev Box to a specified snapshot.", "parameters": [ { @@ -1831,7 +1831,7 @@ }, "x-ms-examples": { "Attempts to restore the Dev Box to a selected snapshot.": { - "$ref": "./examples/DevBoxes_RestoreSnapshotDevBox.json" + "$ref": "./examples/DevBoxes_RestoreSnapshot.json" } }, "x-ms-long-running-operation": true diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshot.json similarity index 95% rename from specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshot.json index 7678cfb3b28e..0d616e909fa1 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshotDevBox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-09-01-preview/examples/DevBoxes_RestoreSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to restore the Dev Box to a selected snapshot.", - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "parameters": { "api-version": "2024-09-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", diff --git a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json index bc35fc08b72b..c5397449fddd 100644 --- a/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/devcenter.json @@ -1762,7 +1762,7 @@ }, "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:restoreSnapshot": { "post": { - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "description": "Restores a Dev Box to a specified snapshot.", "parameters": [ { @@ -1831,7 +1831,7 @@ }, "x-ms-examples": { "Attempts to restore the Dev Box to a selected snapshot.": { - "$ref": "./examples/DevBoxes_RestoreSnapshotDevBox.json" + "$ref": "./examples/DevBoxes_RestoreSnapshot.json" } }, "x-ms-long-running-operation": true @@ -1839,7 +1839,7 @@ }, "/projects/{projectName}/users/{userId}/devboxes/{devBoxName}:captureSnapshot": { "post": { - "operationId": "DevBoxes_CaptureSnapshotDevBox", + "operationId": "DevBoxes_CaptureSnapshot", "description": "Captures a manual snapshot of the Dev Box.", "parameters": [ { @@ -1905,7 +1905,7 @@ }, "x-ms-examples": { "Attempts to capture the manual snapshot for the Dev Box.": { - "$ref": "./examples/DevBoxes_CaptureSnapshotDevBox.json" + "$ref": "./examples/DevBoxes_CaptureSnapshot.json" } }, "x-ms-long-running-operation": true diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshot.json similarity index 95% rename from specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshot.json index 1306f8183682..5d176aff8d08 100644 --- a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_CaptureSnapshotDevBox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_CaptureSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to capture the manual snapshot for the Dev Box.", - "operationId": "DevBoxes_CaptureSnapshotDevBox", + "operationId": "DevBoxes_CaptureSnapshot", "parameters": { "api-version": "2024-10-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", diff --git a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshot.json similarity index 95% rename from specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json rename to specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshot.json index 891948c547a0..502792acd1eb 100644 --- a/specification/devcenter/DevCenter/examples/2024-10-01-preview/DevBoxes_RestoreSnapshotDevBox.json +++ b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2024-10-01-preview/examples/DevBoxes_RestoreSnapshot.json @@ -1,6 +1,6 @@ { "title": "Attempts to restore the Dev Box to a selected snapshot.", - "operationId": "DevBoxes_RestoreSnapshotDevBox", + "operationId": "DevBoxes_RestoreSnapshot", "parameters": { "api-version": "2024-10-01-preview", "endpoint": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com", From 02ff8f08a132a5a68fcdd48da118e36e5ececc3d Mon Sep 17 00:00:00 2001 From: Arthur Ma <mars.arthur@263.net> Date: Mon, 14 Oct 2024 12:38:52 +0800 Subject: [PATCH 096/101] Add client setting for ContainerOrchestratorRuntime (#30789) * Add client setting for ContainerOrchestratorRuntime * Update the client.tsp for releasing .Net SDK * add suppression --------- Co-authored-by: Junda Chen <jundachen@microsoft.com> --- .../KubernetesRuntime.Management/client.tsp | 28 +++++++++++++++++++ .../KubernetesRuntime.Management/common.tsp | 1 + .../KubernetesRuntime.Management/service.tsp | 3 +- .../tspconfig.yaml | 6 ++++ .../2023-10-01-preview/kubernetesruntime.json | 7 ++++- .../stable/2024-03-01/kubernetesruntime.json | 7 ++++- .../resource-manager/readme.md | 4 +++ 7 files changed, 53 insertions(+), 3 deletions(-) diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/client.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/client.tsp index a1b8cb0a8104..03b2ce894b4b 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/client.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/client.tsp @@ -2,8 +2,36 @@ import "./main.tsp"; import "@azure-tools/typespec-client-generator-core"; using Azure.ClientGenerator.Core; +using Azure.ResourceManager.CommonTypes; +using Microsoft.KubernetesRuntime; @@clientName(Microsoft.KubernetesRuntime, "ContainerOrchestratorRuntimeMgmt", "python" ); + +@@clientName(AccessMode, "StorageClassAccessMode", "csharp"); +@@clientName(AdvertiseMode.ARP, "Arp", "csharp"); +@@clientName(AdvertiseMode.BGP, "Bgp", "csharp"); +@@clientName(BgpPeer, "ConnectedClusterBgpPeer", "csharp"); +@@clientName(BgpPeerProperties, "ConnectedClusterBgpPeerProperties", "csharp"); +@@clientName(LoadBalancer, "ConnectedClusterLoadBalancer", "csharp"); +@@clientName(LoadBalancerProperties, + "ConnectedClusterLoadBalancerProperties", + "csharp" +); +@@clientName(ServiceResource, "ConnectedClusterService", "csharp"); +@@clientName(ServiceProperties, "ConnectedClusterServiceProperties", "csharp"); +@@clientName(StorageClassResource, "ConnectedClusterStorageClass", "csharp"); +@@clientName(StorageClassProperties, + "ConnectedClusterStorageClassProperties", + "csharp" +); +@@clientName(ProvisioningState, + "ContainerOrchestratorProvisioningState", + "csharp" +); +@@clientName(SCType, "StorageClassType", "csharp"); +@@clientName(SCType.RWX, "Rwx", "csharp"); +@@clientName(SCType.NFS, "Nfs", "csharp"); +@@clientName(SCType.SMB, "Smb", "csharp"); diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/common.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/common.tsp index 65a0cbfcc851..c98fc6b2ad66 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/common.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/common.tsp @@ -20,6 +20,7 @@ namespace Microsoft.KubernetesRuntime; @doc("Versions of KubernetesRuntime service") enum Versions { @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @useDependency(Azure.Core.Versions.v1_0_Preview_2) @doc("2023-10-01-preview") v2023_10_01_preview: "2023-10-01-preview", diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp b/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp index 79b1700e0f9c..16bf30a3c455 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/service.tsp @@ -3,6 +3,7 @@ import "./common.tsp"; using TypeSpec.Http; using TypeSpec.Rest; using TypeSpec.Versioning; +using Azure.Core; using Azure.ResourceManager; namespace Microsoft.KubernetesRuntime; @@ -11,7 +12,7 @@ namespace Microsoft.KubernetesRuntime; model ServiceProperties { @doc("The object id of the service principal of the RP provisioned in the tenant") @visibility("read") - rpObjectId?: string; + rpObjectId?: uuid; @doc("Resource provision state") @visibility("read") diff --git a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml index 8f4556678620..d4634e4cc448 100644 --- a/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml +++ b/specification/kubernetesruntime/KubernetesRuntime.Management/tspconfig.yaml @@ -14,6 +14,12 @@ options: arm-resource-flattening: true output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/kubernetesruntime.json" use-read-only-status-schema: true + "@azure-tools/typespec-csharp": + package-dir: "Azure.ResourceManager.ContainerOrchestratorRuntime" + flavor: azure + clear-output-folder: true + use-write-core: true + namespace: "{package-dir}" "@azure-tools/typespec-python": package-dir: "azure-mgmt-containerorchestratorruntime" package-name: "{package-dir}" diff --git a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json index 49d50221a434..6f3bdba114ae 100644 --- a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json +++ b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/preview/2023-10-01-preview/kubernetesruntime.json @@ -1022,6 +1022,11 @@ ] } }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, "BgpPeer": { "type": "object", "description": "A BgpPeer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)", @@ -1478,7 +1483,7 @@ "description": "Properties for the service resource", "properties": { "rpObjectId": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The object id of the service principal of the RP provisioned in the tenant", "readOnly": true }, diff --git a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json index a890d90a7748..b101c568c5f8 100644 --- a/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json +++ b/specification/kubernetesruntime/resource-manager/Microsoft.KubernetesRuntime/stable/2024-03-01/kubernetesruntime.json @@ -992,6 +992,11 @@ ] } }, + "Azure.Core.uuid": { + "type": "string", + "format": "uuid", + "description": "Universally Unique Identifier" + }, "BgpPeer": { "type": "object", "description": "A BgpPeer resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters)", @@ -1455,7 +1460,7 @@ "description": "Properties for the service resource", "properties": { "rpObjectId": { - "type": "string", + "$ref": "#/definitions/Azure.Core.uuid", "description": "The object id of the service principal of the RP provisioned in the tenant", "readOnly": true }, diff --git a/specification/kubernetesruntime/resource-manager/readme.md b/specification/kubernetesruntime/resource-manager/readme.md index 822f278b2a47..5f34a4ddaac9 100644 --- a/specification/kubernetesruntime/resource-manager/readme.md +++ b/specification/kubernetesruntime/resource-manager/readme.md @@ -33,6 +33,10 @@ suppressions: - code: ConsistentPatchProperties from: kubernetesruntime.json reason: The tooling doens't check properties in derived models of discriminated unions. + - code: GuidUsage + from: kubernetesruntime.json + where: $.definitions["Azure.Core.uuid"].format + reason: The definition is used for AAD object ids, which are UUIDs. ``` ### Tag: package-preview-2023-10-01 From 6bd2fd3e6d02b020b9b9f384f980eb40c162f100 Mon Sep 17 00:00:00 2001 From: Priyanshi Jain <87351063+priyjain358@users.noreply.github.com> Date: Mon, 14 Oct 2024 11:25:17 +0530 Subject: [PATCH 097/101] [AzureStackHCI] Add public preview changes for 2024-09-01-preview (#30809) * Add public preview changes for 2024-09-01-preview * add edge device jobs * readme updates * Update sdk-suppressions.yaml * updated jobs * pretty check * updated --------- Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com> Co-authored-by: Bhuvnesh Kumar <50610735+agrbhuvnesh@users.noreply.github.com> Co-authored-by: Bhuvnesh Kumar <bhuvnesh.agrawal@gmail.com> --- .../2024-09-01-preview/arcSettings.json | 819 ++++++++ .../preview/2024-09-01-preview/clusters.json | 1686 +++++++++++++++++ .../deploymentSettings.json | 1004 ++++++++++ .../2024-09-01-preview/edgeDeviceJobs.json | 1150 +++++++++++ .../2024-09-01-preview/edgeDevices.json | 1263 ++++++++++++ .../Clusters_UpdateSecretsLocations.json | 93 + .../examples/ConfigureRemoteSupport.json | 113 ++ .../ConsentAndInstallDefaultExtensions.json | 52 + .../examples/CreateArcIdentity.json | 26 + .../examples/CreateCluster.json | 60 + .../examples/CreateClusterIdentity.json | 25 + .../examples/CreateHciEdgeDevice.json | 257 +++ .../examples/DeleteArcSetting.json | 18 + .../examples/DeleteCluster.json | 17 + .../examples/DeleteDeploymentSettings.json | 17 + .../examples/DeleteEdgeDevices.json | 15 + .../examples/DeleteExtension.json | 19 + .../examples/DeleteSecuritySettings.json | 17 + .../examples/DeleteUpdateRuns.json | 19 + .../examples/DeleteUpdateSummaries.json | 17 + .../examples/DeleteUpdates.json | 18 + ...eDeviceJobs_CreateOrUpdate_CollectLog.json | 65 + ...viceJobs_CreateOrUpdate_RemoteSupport.json | 68 + .../examples/EdgeDeviceJobs_Delete.json | 18 + .../EdgeDeviceJobs_Get_RemoteSupport.json | 34 + .../EdgeDeviceJobs_ListByEdgeDevice.json | 38 + .../ExtendSoftwareAssuranceBenefit.json | 82 + .../examples/Extensions_Upgrade.json | 22 + .../examples/GeneratePassword.json | 19 + .../examples/GetArcSetting.json | 61 + .../examples/GetCluster.json | 122 ++ .../examples/GetDeploymentSettings.json | 270 +++ .../examples/GetEdgeDevices.json | 46 + .../examples/GetExtension.json | 80 + .../2024-09-01-preview/examples/GetOffer.json | 34 + .../examples/GetPublisher.json | 18 + .../examples/GetSecuritySettings.json | 38 + .../2024-09-01-preview/examples/GetSku.json | 36 + .../examples/GetUpdateRuns.json | 43 + .../examples/GetUpdateSummaries.json | 41 + .../examples/GetUpdates.json | 44 + .../examples/InitializeDisableProcess.json | 19 + .../examples/ListArcSettingsByCluster.json | 64 + .../examples/ListClustersByResourceGroup.json | 131 ++ .../examples/ListClustersBySubscription.json | 130 ++ .../ListDeploymentSettingsByCluster.json | 202 ++ .../examples/ListEdgeDevices.json | 72 + .../examples/ListExtensionsByArcSetting.json | 95 + .../examples/ListOffersByCluster.json | 36 + .../examples/ListOffersByPublisher.json | 37 + .../examples/ListPublishersByCluster.json | 21 + .../ListSecuritySettingsByCluster.json | 41 + .../examples/ListSkusByOffer.json | 39 + .../examples/ListUpdateRuns.json | 46 + .../examples/ListUpdateSummaries.json | 45 + .../examples/ListUpdates.json | 47 + .../examples/PatchArcSetting.json | 74 + .../examples/PatchExtension.json | 99 + .../examples/PostUpdates.json | 17 + .../examples/PutArcSetting.json | 53 + .../examples/PutDeploymentSettings.json | 730 +++++++ .../examples/PutExtension.json | 164 ++ .../examples/PutSecuritySettings.json | 72 + .../examples/PutUpdateRuns.json | 68 + .../examples/PutUpdateSummaries.json | 52 + .../examples/PutUpdates.json | 71 + .../examples/TriggerLogCollection.json | 95 + .../examples/UpdateCluster.json | 125 ++ .../examples/UploadCertificate.json | 23 + .../examples/ValidateEdgeDevices.json | 26 + .../2024-09-01-preview/extensions.json | 707 +++++++ .../preview/2024-09-01-preview/hciCommon.json | 417 ++++ .../preview/2024-09-01-preview/offers.json | 302 +++ .../2024-09-01-preview/publishers.json | 188 ++ .../2024-09-01-preview/securitySettings.json | 502 +++++ .../preview/2024-09-01-preview/skus.json | 275 +++ .../2024-09-01-preview/updateRuns.json | 412 ++++ .../2024-09-01-preview/updateSummaries.json | 408 ++++ .../preview/2024-09-01-preview/updates.json | 577 ++++++ .../StackHCI/readme.md | 31 +- .../examples/ListOperations.json | 453 +++++ .../2024-09-01-preview/operations.json | 73 + .../azurestackhci/resource-manager/readme.md | 1 - .../resource-manager/sdk-suppressions.yaml | 19 + 84 files changed, 14941 insertions(+), 2 deletions(-) create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/arcSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/clusters.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/deploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDeviceJobs.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Clusters_UpdateSecretsLocations.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConfigureRemoteSupport.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConsentAndInstallDefaultExtensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateArcIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateClusterIdentity.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateHciEdgeDevice.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_CollectLog.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_RemoteSupport.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Delete.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Get_RemoteSupport.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_ListByEdgeDevice.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ExtendSoftwareAssuranceBenefit.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Extensions_Upgrade.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GeneratePassword.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSku.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/InitializeDisableProcess.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListArcSettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersByResourceGroup.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersBySubscription.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListDeploymentSettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListExtensionsByArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByPublisher.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListPublishersByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSecuritySettingsByCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSkusByOffer.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PostUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutArcSetting.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutDeploymentSettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutExtension.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutSecuritySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/TriggerLogCollection.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UpdateCluster.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UploadCertificate.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ValidateEdgeDevices.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/extensions.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/hciCommon.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/offers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/publishers.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/securitySettings.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/skus.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateRuns.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateSummaries.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updates.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/examples/ListOperations.json create mode 100644 specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/operations.json diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/arcSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/arcSettings.json new file mode 100644 index 000000000000..b28cded79f16 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/arcSettings.json @@ -0,0 +1,819 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings": { + "get": { + "operationId": "ArcSettings_ListByCluster", + "description": "Get ArcSetting resources of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List ArcSetting resources by HCI Cluster": { + "$ref": "./examples/ListArcSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}": { + "get": { + "operationId": "ArcSettings_Get", + "description": "Get ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSetting": { + "$ref": "./examples/GetArcSetting.json" + } + } + }, + "put": { + "operationId": "ArcSettings_Create", + "description": "Create ArcSetting for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSetting" + }, + "description": "Parameters supplied to the Create ArcSetting resource for this HCI cluster." + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create ArcSetting": { + "$ref": "./examples/PutArcSetting.json" + } + } + }, + "patch": { + "operationId": "ArcSettings_Update", + "description": "Update ArcSettings for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "name": "arcSetting", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ArcSettingsPatch" + }, + "description": "ArcSettings parameters that needs to be updated" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Patch ArcSetting": { + "$ref": "./examples/PatchArcSetting.json" + } + } + }, + "delete": { + "operationId": "ArcSettings_Delete", + "description": "Delete ArcSetting resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete ArcSetting": { + "$ref": "./examples/DeleteArcSetting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_GeneratePassword", + "description": "Generate password for arc settings.", + "x-ms-examples": { + "Generate Password": { + "$ref": "./examples/GeneratePassword.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PasswordCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_CreateIdentity", + "description": "Create Aad identity for arc settings.", + "x-ms-examples": { + "Create Arc Identity": { + "$ref": "./examples/CreateArcIdentity.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_ConsentAndInstallDefaultExtensions", + "description": "Add consent time for default extensions and initiate extensions installation", + "x-ms-examples": { + "Consent And Install Default Extensions": { + "$ref": "./examples/ConsentAndInstallDefaultExtensions.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ArcSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess": { + "post": { + "tags": [ + "ArcSettings" + ], + "operationId": "ArcSettings_InitializeDisableProcess", + "description": "Initializes ARC Disable process on the cluster", + "x-ms-examples": { + "Trigger ARC Disable": { + "$ref": "./examples/InitializeDisableProcess.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ArcSettingList": { + "description": "List of ArcSetting proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of ArcSetting proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ArcSetting" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ArcSettingsPatch": { + "description": "ArcSetting details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "ArcSettings properties.", + "$ref": "#/definitions/ArcSettingsPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingsPatchProperties": { + "description": "ArcSettings properties.", + "type": "object", + "properties": { + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + } + } + }, + "ArcSetting": { + "description": "ArcSetting details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "ArcSetting properties.", + "$ref": "#/definitions/ArcSettingProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcSettingProperties": { + "description": "ArcSetting properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the ArcSetting proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "arcInstanceResourceGroup": { + "description": "The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources.", + "type": "string" + }, + "arcApplicationClientId": { + "description": "App id of arc AAD identity.", + "type": "string" + }, + "arcApplicationTenantId": { + "description": "Tenant id of arc AAD identity.", + "type": "string" + }, + "arcServicePrincipalObjectId": { + "description": "Object id of arc AAD service principal.", + "type": "string" + }, + "arcApplicationObjectId": { + "description": "Object id of arc AAD identity.", + "type": "string" + }, + "aggregateState": { + "description": "Aggregate state of Arc agent across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "ArcSettingAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeDetails": { + "description": "State of Arc agent in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeState" + }, + "readOnly": true + }, + "connectivityProperties": { + "description": "contains connectivity related configuration for ARC resources", + "type": "object", + "items": { + "$ref": "#/definitions/ArcConnectivityProperties" + } + }, + "defaultExtensions": { + "description": "Properties for each of the default extensions category", + "type": "array", + "items": { + "$ref": "#/definitions/DefaultExtensionDetails" + }, + "x-ms-identifiers": [ + "category" + ], + "readOnly": true + } + } + }, + "PerNodeState": { + "description": "Status of Arc agent for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the Node in HCI Cluster" + }, + "arcInstance": { + "description": "Fully qualified resource ID for the Arc agent of this node.", + "type": "string", + "readOnly": true + }, + "arcNodeServicePrincipalObjectId": { + "description": "The service principal id of the arc for server node", + "type": "string", + "readOnly": true + }, + "state": { + "description": "State of Arc agent in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "DisableInProgress" + ], + "x-ms-enum": { + "name": "NodeArcState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "DefaultExtensionDetails": { + "description": "Properties for a particular default extension category.", + "type": "object", + "properties": { + "category": { + "description": "Default extension category", + "type": "string", + "readOnly": true + }, + "consentTime": { + "description": "Consent time for extension category", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "ArcConnectivityProperties": { + "description": "Connectivity related configuration required by arc server.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "True indicates ARC connectivity is enabled" + }, + "serviceConfigurations": { + "type": "array", + "description": "Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'.", + "items": { + "$ref": "#/definitions/ServiceConfiguration" + }, + "x-ms-identifiers": [ + "serviceName" + ] + } + }, + "additionalProperties": false + }, + "ServiceConfiguration": { + "type": "object", + "description": "Service configuration details", + "required": [ + "serviceName", + "port" + ], + "properties": { + "serviceName": { + "type": "string", + "description": "Name of the service.", + "enum": [ + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int64", + "description": "The port on which service is enabled." + } + } + }, + "PasswordCredential": { + "type": "object", + "properties": { + "secretText": { + "type": "string" + }, + "keyId": { + "type": "string" + }, + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + } + }, + "additionalProperties": false, + "readOnly": true + }, + "ArcIdentityResponse": { + "description": "ArcIdentity details.", + "type": "object", + "properties": { + "properties": { + "description": "ArcIdentity properties.", + "$ref": "#/definitions/ArcIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ArcIdentityResponseProperties": { + "type": "object", + "properties": { + "arcApplicationClientId": { + "type": "string" + }, + "arcApplicationTenantId": { + "type": "string" + }, + "arcServicePrincipalObjectId": { + "type": "string" + }, + "arcApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/clusters.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/clusters.json new file mode 100644 index 000000000000..34a15d05f0cc --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/clusters.json @@ -0,0 +1,1686 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListBySubscription", + "x-ms-examples": { + "List clusters in a given subscription": { + "$ref": "./examples/ListClustersBySubscription.json" + } + }, + "description": "List all HCI clusters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "List clusters in a given resource group": { + "$ref": "./examples/ListClustersByResourceGroup.json" + } + }, + "description": "List all HCI clusters in a resource group.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "Get cluster": { + "$ref": "./examples/GetCluster.json" + } + }, + "description": "Get HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/CreateCluster.json" + } + }, + "description": "Create an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "Update cluster": { + "$ref": "./examples/UpdateCluster.json" + } + }, + "description": "Update an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "cluster", + "in": "body", + "description": "Details of the HCI cluster.", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "Delete cluster": { + "$ref": "./examples/DeleteCluster.json" + } + }, + "description": "Delete an HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSecretsLocations": { + "post": { + "operationId": "Clusters_UpdateSecretsLocations", + "tags": [ + "Clusters" + ], + "description": "Update cluster secrets locations.", + "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": "clusterName", + "in": "path", + "description": "The name of the cluster.", + "required": true, + "type": "string" + }, + { + "name": "body", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/SecretsLocationsChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Resource operation 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." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update secrets locations for a Cluster": { + "$ref": "./examples/Clusters_UpdateSecretsLocations.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_UploadCertificate", + "x-ms-examples": { + "Upload certificate": { + "$ref": "./examples/UploadCertificate.json" + } + }, + "description": "Upload certificate.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "uploadCertificateRequest", + "in": "body", + "description": "Upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_CreateIdentity", + "description": "Create cluster identity.", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/CreateClusterIdentity.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClusterIdentityResponse" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ExtendSoftwareAssuranceBenefit", + "description": "Extends Software Assurance Benefit to a cluster", + "x-ms-examples": { + "Create cluster Identity": { + "$ref": "./examples/ExtendSoftwareAssuranceBenefit.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "softwareAssuranceChangeRequest", + "in": "body", + "description": "Software Assurance Change Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/triggerLogCollection": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_TriggerLogCollection", + "description": "Trigger Log Collection on a cluster", + "x-ms-examples": { + "Trigger Log Collection": { + "$ref": "./examples/TriggerLogCollection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "logCollectionRequest", + "in": "body", + "description": "Trigger Log Collection Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/LogCollectionRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/configureRemoteSupport": { + "post": { + "tags": [ + "Cluster" + ], + "operationId": "Clusters_ConfigureRemoteSupport", + "description": "Configure RemoteSupport on a cluster", + "x-ms-examples": { + "Configure Remote Support": { + "$ref": "./examples/ConfigureRemoteSupport.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "remoteSupportRequest", + "in": "body", + "description": "Configure Remote Support Request Payload", + "required": true, + "schema": { + "$ref": "#/definitions/RemoteSupportRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ClusterList": { + "description": "List of clusters.", + "type": "object", + "properties": { + "value": { + "description": "List of clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Cluster": { + "description": "Cluster details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterPatch": { + "description": "Cluster details to update.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "identity": { + "description": "Identity of Cluster resource", + "$ref": "../../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Cluster properties.", + "$ref": "#/definitions/ClusterPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning", + "NotSpecified", + "Creating", + "Updating", + "Deleting", + "Moving", + "Deleted", + "PartiallySucceeded", + "InProgress", + "DisableInProgress", + "Connected", + "PartiallyConnected", + "Disconnected" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "status": { + "description": "Status of the cluster agent.", + "type": "string", + "enum": [ + "NotYetRegistered", + "ConnectedRecently", + "NotConnectedRecently", + "Disconnected", + "Error", + "NotSpecified", + "ValidationInProgress", + "ValidationSuccess", + "ValidationFailed", + "DeploymentInProgress", + "DeploymentFailed", + "DeploymentSuccess" + ], + "x-ms-enum": { + "name": "Status", + "modelAsString": true + }, + "readOnly": true + }, + "connectivityStatus": { + "description": "Overall connectivity status for the cluster resource.", + "type": "string", + "enum": [ + "NotYetRegistered", + "Connected", + "NotConnectedRecently", + "PartiallyConnected", + "Disconnected", + "NotSpecified" + ], + "x-ms-enum": { + "name": "ConnectivityStatus", + "modelAsString": true + }, + "readOnly": true + }, + "cloudId": { + "description": "Unique, immutable resource id.", + "type": "string", + "readOnly": true + }, + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal.", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "aadApplicationObjectId": { + "description": "Object id of cluster AAD identity.", + "type": "string" + }, + "aadServicePrincipalObjectId": { + "description": "Id of cluster identity service principal.", + "type": "string" + }, + "softwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "$ref": "#/definitions/SoftwareAssuranceProperties" + }, + "logCollectionProperties": { + "description": "Log Collection properties of the cluster.", + "$ref": "#/definitions/LogCollectionProperties" + }, + "remoteSupportProperties": { + "description": "RemoteSupport properties of the cluster.", + "$ref": "#/definitions/RemoteSupportProperties" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + }, + "reportedProperties": { + "description": "Properties reported by cluster agent.", + "$ref": "#/definitions/ClusterReportedProperties", + "readOnly": true + }, + "isolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "$ref": "#/definitions/IsolatedVmAttestationConfiguration", + "readOnly": true + }, + "trialDaysRemaining": { + "description": "Number of days remaining in the trial period.", + "type": "number", + "readOnly": true + }, + "billingModel": { + "description": "Type of billing applied to the resource.", + "type": "string", + "readOnly": true + }, + "registrationTimestamp": { + "description": "First cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastSyncTimestamp": { + "description": "Most recent cluster sync timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastBillingTimestamp": { + "description": "Most recent billing meter timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "serviceEndpoint": { + "description": "Region specific DataPath Endpoint of the cluster.", + "type": "string", + "readOnly": true + }, + "resourceProviderObjectId": { + "description": "Object id of RP Service Principal", + "type": "string", + "readOnly": true + }, + "secretsLocations": { + "type": "array", + "description": "List of secret locations.", + "items": { + "$ref": "#/definitions/SecretsLocationDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ClusterPatchProperties": { + "description": "Cluster properties.", + "type": "object", + "properties": { + "cloudManagementEndpoint": { + "description": "Endpoint configured for management from the Azure portal", + "type": "string" + }, + "aadClientId": { + "description": "App id of cluster AAD identity.", + "type": "string" + }, + "aadTenantId": { + "description": "Tenant id of cluster AAD identity.", + "type": "string" + }, + "desiredProperties": { + "description": "Desired properties of the cluster.", + "$ref": "#/definitions/ClusterDesiredProperties" + } + } + }, + "LogCollectionProperties": { + "description": "Log Collection properties of the cluster.", + "type": "object", + "properties": { + "fromDate": { + "description": "From DateTimeStamp from when logs need to be connected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "toDate": { + "description": "To DateTimeStamp till when logs need to be connected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "lastLogGenerated": { + "description": "Recent DateTimeStamp where logs are successfully generated", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logCollectionSessionDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/LogCollectionSession" + }, + "readOnly": true + } + } + }, + "LogCollectionSession": { + "description": "Log Collection Session details of the cluster.", + "type": "object", + "properties": { + "logStartTime": { + "description": "Start Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logEndTime": { + "description": "End Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "timeCollected": { + "description": "Duration of logs collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logSize": { + "description": "Size of the logs collected", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "logCollectionStatus": { + "description": "LogCollection status", + "type": "string", + "enum": [ + "None", + "InProgress", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "LogCollectionStatus", + "modelAsString": true + }, + "readOnly": true + }, + "correlationId": { + "description": "CorrelationId of the log collection", + "type": "string", + "readOnly": true + }, + "logCollectionJobType": { + "description": "LogCollection job type", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "LogCollectionJobType", + "modelAsString": true + }, + "readOnly": true + }, + "endTimeCollected": { + "description": "End Time of the logs when it was collected", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "logCollectionError": { + "$ref": "#/definitions/LogCollectionError", + "readOnly": true + } + } + }, + "AccessLevel": { + "description": "Remote Support Access Level", + "type": "string", + "enum": [ + "Diagnostics", + "DiagnosticsAndRepair" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "LogCollectionError": { + "description": "Log Collection Error details of the cluster.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error Code of the log collection", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message of the log collection", + "type": "string", + "readOnly": true + } + } + }, + "RemoteSupportProperties": { + "description": "Remote Support properties of the cluster.", + "type": "object", + "properties": { + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + }, + "expirationTimeStamp": { + "description": "Expiration DateTimeStamp when Remote Support Access will be expired", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "remoteSupportType": { + "description": "Remote Support Type for cluster", + "type": "string", + "enum": [ + "Enable", + "Revoke" + ], + "x-ms-enum": { + "name": "RemoteSupportType", + "modelAsString": true + }, + "readOnly": true + }, + "remoteSupportNodeSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/RemoteSupportNodeSettings" + }, + "readOnly": true + }, + "remoteSupportSessionDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeRemoteSupportSession" + }, + "readOnly": true + } + } + }, + "RemoteSupportNodeSettings": { + "description": "Remote Support Node Settings of the cluster.", + "type": "object", + "properties": { + "arcResourceId": { + "description": "Arc ResourceId of the Node", + "type": "string", + "readOnly": true + }, + "state": { + "description": "Remote Support Access Connection State on the Node", + "type": "string", + "readOnly": true + }, + "createdAt": { + "description": "Remote Support Enablement Request Created TimeStamp on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "description": "Remote Support Enablement Request Updated TimeStamp on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "connectionStatus": { + "description": "Remote Support Access Connection Status on the Node", + "type": "string", + "readOnly": true + }, + "connectionErrorMessage": { + "description": "Remote Support Access Connection Error Message on the Node", + "type": "string", + "readOnly": true + }, + "transcriptLocation": { + "description": "Remote Support Transcript location on the node", + "type": "string", + "readOnly": true + } + } + }, + "PerNodeRemoteSupportSession": { + "description": "Remote Support Node Session Details on the Node.", + "type": "object", + "properties": { + "sessionStartTime": { + "description": "Remote Support Session StartTime on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sessionEndTime": { + "description": "Remote Support Session EndTime on the Node", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "nodeName": { + "description": "Name of the node", + "type": "string", + "readOnly": true + }, + "duration": { + "description": "Duration of Remote Support Enablement", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + } + } + }, + "SoftwareAssuranceProperties": { + "description": "Software Assurance properties of the cluster.", + "type": "object", + "properties": { + "softwareAssuranceStatus": { + "description": "Status of the Software Assurance for the cluster.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceStatus", + "modelAsString": true + }, + "readOnly": true + }, + "softwareAssuranceIntent": { + "description": "Customer Intent for Software Assurance Benefit.", + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + }, + "lastUpdated": { + "description": "TimeStamp denoting the latest SA benefit applicability is validated.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IsolatedVmAttestationConfiguration": { + "description": "Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster.", + "type": "object", + "properties": { + "attestationResourceId": { + "description": "Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster.", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Attestation/attestationProviders", + "scopes": [ + "Tenant" + ] + } + ] + }, + "readOnly": true + }, + "relyingPartyServiceEndpoint": { + "description": "Region specific endpoint for relying party service.", + "type": "string", + "readOnly": true + }, + "attestationServiceEndpoint": { + "description": "Region specific endpoint for Microsoft Azure Attestation service for the cluster", + "type": "string", + "readOnly": true + } + } + }, + "ClusterDesiredProperties": { + "description": "Desired properties of the cluster.", + "type": "object", + "properties": { + "windowsServerSubscription": { + "description": "Desired state of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + } + }, + "diagnosticLevel": { + "description": "Desired level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + } + } + }, + "ClusterReportedProperties": { + "description": "Properties reported by cluster agent.", + "type": "object", + "properties": { + "clusterName": { + "description": "Name of the on-prem cluster connected to this resource.", + "type": "string", + "readOnly": true + }, + "clusterId": { + "description": "Unique id generated by the on-prem cluster.", + "type": "string", + "readOnly": true + }, + "clusterVersion": { + "description": "Version of the cluster software.", + "type": "string", + "readOnly": true + }, + "nodes": { + "description": "List of nodes reported by the cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterNode" + }, + "readOnly": true + }, + "lastUpdated": { + "description": "Last time the cluster reported the data.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "imdsAttestation": { + "description": "IMDS attestation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ImdsAttestation", + "modelAsString": true + }, + "readOnly": true + }, + "diagnosticLevel": { + "description": "Level of diagnostic data emitted by the cluster.", + "type": "string", + "enum": [ + "Off", + "Basic", + "Enhanced" + ], + "x-ms-enum": { + "name": "DiagnosticLevel", + "modelAsString": true + } + }, + "supportedCapabilities": { + "description": "Capabilities supported by the cluster.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "clusterType": { + "description": "The node type of all the nodes of the cluster.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "manufacturer": { + "description": "The manufacturer of all the nodes of the cluster.", + "type": "string", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the cluster.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + }, + "hardwareClass": { + "$ref": "./hciCommon.json#/definitions/HardwareClass", + "description": "Hardware class of the cluster.", + "readOnly": true + } + } + }, + "ClusterNode": { + "description": "Cluster node details.", + "type": "object", + "properties": { + "name": { + "description": "Name of the cluster node.", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Id of the node in the cluster.", + "type": "number", + "readOnly": true + }, + "windowsServerSubscription": { + "description": "State of Windows Server Subscription.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WindowsServerSubscription", + "modelAsString": true + }, + "readOnly": true + }, + "nodeType": { + "description": "Type of the cluster node hardware.", + "type": "string", + "enum": [ + "FirstParty", + "ThirdParty" + ], + "x-ms-enum": { + "name": "ClusterNodeType", + "modelAsString": true + }, + "readOnly": true + }, + "ehcResourceId": { + "description": "Edge Hardware Center Resource Id", + "type": "string", + "readOnly": true + }, + "manufacturer": { + "description": "Manufacturer of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "Model name of the cluster node hardware.", + "type": "string", + "readOnly": true + }, + "osName": { + "description": "Operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osVersion": { + "description": "Version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "osDisplayVersion": { + "description": "Display version of the operating system running on the cluster node.", + "type": "string", + "readOnly": true + }, + "serialNumber": { + "description": "Immutable id of the cluster node.", + "type": "string", + "readOnly": true + }, + "coreCount": { + "description": "Number of physical cores on the cluster node.", + "type": "number", + "readOnly": true + }, + "memoryInGiB": { + "description": "Total available memory on the cluster node (in GiB).", + "type": "number", + "readOnly": true + }, + "lastLicensingTimestamp": { + "description": "Most recent licensing timestamp.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "oemActivation": { + "description": "OEM activation status of the node.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "OemActivation", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "RawCertificateData": { + "type": "object", + "properties": { + "certificates": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "UploadCertificateRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData" + } + }, + "additionalProperties": false + }, + "LogCollectionRequestProperties": { + "description": "Properties for Log Collection Request", + "type": "object", + "properties": { + "fromDate": { + "description": "From DateTimeStamp from when logs need to be connected", + "type": "string", + "format": "date-time" + }, + "toDate": { + "description": "To DateTimeStamp till when logs need to be connected", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "fromDate", + "toDate" + ], + "additionalProperties": false + }, + "RemoteSupportRequestProperties": { + "description": "Properties for Remote Support Request", + "type": "object", + "properties": { + "accessLevel": { + "$ref": "#/definitions/AccessLevel", + "readOnly": true + }, + "expirationTimeStamp": { + "description": "Expiration DateTimeStamp when Remote Support Access will be expired", + "type": "string", + "format": "date-time" + }, + "remoteSupportType": { + "description": "Remote Support Type for cluster", + "type": "string", + "enum": [ + "Enable", + "Revoke" + ], + "x-ms-enum": { + "name": "RemoteSupportType", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SecretsLocationDetails": { + "type": "object", + "description": "Secrets location details", + "properties": { + "secretsType": { + "$ref": "#/definitions/SecretsType", + "description": "Type of secrets to store" + }, + "secretsLocation": { + "type": "string", + "description": "secrets location" + } + }, + "required": [ + "secretsType", + "secretsLocation" + ] + }, + "SecretsLocationsChangeRequest": { + "type": "object", + "description": "Update secrets locations change Request.", + "properties": { + "properties": { + "type": "array", + "description": "List of secret locations", + "items": { + "$ref": "#/definitions/SecretsLocationDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "SecretsType": { + "type": "string", + "description": "Type of secrets to store", + "enum": [ + "BackupSecrets" + ], + "x-ms-enum": { + "name": "SecretsType", + "modelAsString": true, + "values": [ + { + "name": "BackupSecrets", + "value": "BackupSecrets", + "description": "Backup secrets type" + } + ] + } + }, + "SoftwareAssuranceChangeRequestProperties": { + "type": "object", + "properties": { + "softwareAssuranceIntent": { + "type": "string", + "enum": [ + "Enable", + "Disable" + ], + "x-ms-enum": { + "name": "SoftwareAssuranceIntent", + "modelAsString": true + } + } + }, + "additionalProperties": false + }, + "SoftwareAssuranceChangeRequest": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SoftwareAssuranceChangeRequestProperties" + } + }, + "additionalProperties": false + }, + "LogCollectionRequest": { + "description": "Log Collection Request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LogCollectionRequestProperties" + } + }, + "additionalProperties": false + }, + "RemoteSupportRequest": { + "description": "Remote Support Request", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RemoteSupportRequestProperties" + } + }, + "additionalProperties": false + }, + "ClusterIdentityResponse": { + "description": "Cluster Identity details.", + "type": "object", + "properties": { + "properties": { + "description": "Cluster identity properties.", + "$ref": "#/definitions/ClusterIdentityResponseProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterIdentityResponseProperties": { + "type": "object", + "properties": { + "aadClientId": { + "type": "string" + }, + "aadTenantId": { + "type": "string" + }, + "aadServicePrincipalObjectId": { + "type": "string" + }, + "aadApplicationObjectId": { + "type": "string" + } + }, + "additionalProperties": false, + "readOnly": true + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/deploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/deploymentSettings.json new file mode 100644 index 000000000000..fcebb8ccc288 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/deploymentSettings.json @@ -0,0 +1,1004 @@ +{ + "swagger": "2.0", + "info": { + "title": "Deployment Settings", + "version": "2024-09-01-preview", + "description": "Azure Stack HCI Deployment Settings." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "DeploymentSettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings": { + "get": { + "operationId": "DeploymentSettings_ListByClusters", + "tags": [ + "DeploymentSettings" + ], + "description": "List DeploymentSetting resources by Clusters", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Deployment Settings": { + "$ref": "./examples/ListDeploymentSettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}": { + "get": { + "operationId": "DeploymentSettings_Get", + "tags": [ + "DeploymentSettings" + ], + "description": "Get a DeploymentSetting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Deployment Settings": { + "$ref": "./examples/GetDeploymentSettings.json" + } + } + }, + "put": { + "operationId": "DeploymentSettings_CreateOrUpdate", + "tags": [ + "DeploymentSettings" + ], + "description": "Create a DeploymentSetting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeploymentSetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "201": { + "description": "Resource 'DeploymentSetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeploymentSetting" + }, + "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": { + "Create Deployment Settings": { + "$ref": "./examples/PutDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeploymentSettings_Delete", + "tags": [ + "DeploymentSettings" + ], + "description": "Delete a DeploymentSetting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "deploymentSettingsName", + "in": "path", + "description": "Name of Deployment Setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Deployment Settings": { + "$ref": "./examples/DeleteDeploymentSettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdapterPropertyOverrides": { + "type": "object", + "description": "The AdapterPropertyOverrides of a cluster.", + "properties": { + "jumboPacket": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirect": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "networkDirectTechnology": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'" + } + } + }, + "DeploymentCluster": { + "type": "object", + "description": "AzureStackHCI Cluster deployment properties.", + "properties": { + "name": { + "type": "string", + "description": "The cluster name provided when preparing Active Directory." + }, + "witnessType": { + "type": "string", + "description": "Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. " + }, + "witnessPath": { + "type": "string", + "description": "Specify the fileshare path for the local witness for your Azure Stack HCI cluster." + }, + "cloudAccountName": { + "type": "string", + "description": "Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster." + }, + "azureServiceEndpoint": { + "type": "string", + "description": "For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net." + }, + "hardwareClass": { + "$ref": "./hciCommon.json#/definitions/HardwareClass", + "description": "Hardware class of the cluster.", + "readOnly": true + } + } + }, + "DeploymentConfiguration": { + "type": "object", + "description": "Deployment Configuration", + "properties": { + "version": { + "type": "string", + "description": "deployment template version " + }, + "scaleUnits": { + "type": "array", + "description": "Scale units will contains list of deployment data", + "items": { + "$ref": "#/definitions/ScaleUnits" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "scaleUnits" + ] + }, + "DeploymentData": { + "type": "object", + "description": "The Deployment data of AzureStackHCI Cluster.", + "properties": { + "securitySettings": { + "$ref": "#/definitions/DeploymentSecuritySettings", + "description": "SecuritySettings to deploy AzureStackHCI Cluster." + }, + "observability": { + "$ref": "#/definitions/Observability", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "cluster": { + "$ref": "#/definitions/DeploymentCluster", + "description": "Observability config to deploy AzureStackHCI Cluster." + }, + "storage": { + "$ref": "#/definitions/Storage", + "description": "Storage config to deploy AzureStackHCI Cluster." + }, + "namingPrefix": { + "type": "string", + "description": "naming prefix to deploy cluster.", + "pattern": "^[a-zA-Z0-9-]{1,8}$" + }, + "domainFqdn": { + "type": "string", + "description": "FQDN to deploy cluster" + }, + "infrastructureNetwork": { + "type": "array", + "description": "InfrastructureNetwork config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/InfrastructureNetwork" + }, + "x-ms-identifiers": [] + }, + "physicalNodes": { + "type": "array", + "description": "list of physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/PhysicalNodes" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "hostNetwork": { + "$ref": "#/definitions/HostNetwork", + "description": "HostNetwork config to deploy AzureStackHCI Cluster." + }, + "sdnIntegration": { + "$ref": "#/definitions/SdnIntegration", + "description": "SDN Integration config to deploy AzureStackHCI Cluster." + }, + "adouPath": { + "type": "string", + "description": "The path to the Active Directory Organizational Unit container object prepared for the deployment. " + }, + "secretsLocation": { + "type": "string", + "description": "Azure keyvault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead." + }, + "secrets": { + "type": "array", + "description": "secrets used for cloud deployment.", + "items": { + "$ref": "./hciCommon.json#/definitions/EceDeploymentSecrets" + }, + "x-ms-identifiers": [ + "secretName" + ] + }, + "optionalServices": { + "$ref": "#/definitions/OptionalServices", + "description": "OptionalServices config to deploy AzureStackHCI Cluster." + } + } + }, + "DeploymentSetting": { + "type": "object", + "description": "Edge device resource", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentSettingsProperties", + "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/ProxyResource" + } + ] + }, + "DeploymentSettingListResult": { + "type": "object", + "description": "The response of a DeploymentSetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeploymentSetting items on this page", + "items": { + "$ref": "#/definitions/DeploymentSetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeploymentSettingsProperties": { + "type": "object", + "description": "DeploymentSetting properties", + "properties": { + "provisioningState": { + "$ref": "./hciCommon.json#/definitions/ProvisioningState", + "description": "DeploymentSetting provisioning state", + "readOnly": true + }, + "arcNodeResourceIds": { + "type": "array", + "description": "Azure resource ids of Arc machines to be part of cluster.", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "deploymentMode": { + "$ref": "./hciCommon.json#/definitions/DeploymentMode", + "description": "The deployment mode for cluster deployment." + }, + "operationType": { + "type": "string", + "description": "The intended operation for a cluster.", + "enum": [ + "ClusterProvisioning", + "ClusterUpgrade" + ], + "default": "ClusterProvisioning", + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "name": "ClusterProvisioning", + "value": "ClusterProvisioning", + "description": "Cluster provisioning operation." + }, + { + "name": "ClusterUpgrade", + "value": "ClusterUpgrade", + "description": "Cluster upgrade operation." + } + ] + } + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "description": "Scale units will contains list of deployment data", + "x-ms-identifiers": [] + }, + "reportedProperties": { + "$ref": "./hciCommon.json#/definitions/EceReportedProperties", + "description": "Deployment Status reported from cluster.", + "readOnly": true + } + }, + "required": [ + "arcNodeResourceIds", + "deploymentMode", + "deploymentConfiguration" + ] + }, + "HostNetwork": { + "type": "object", + "description": "The HostNetwork of a cluster.", + "properties": { + "intents": { + "type": "array", + "description": "The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.", + "items": { + "$ref": "#/definitions/Intents" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageNetworks": { + "type": "array", + "description": "List of StorageNetworks config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageNetworks" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "storageConnectivitySwitchless": { + "type": "boolean", + "description": "Defines how the storage adapters between nodes are connected either switch or switch less..", + "default": false + }, + "enableStorageAutoIp": { + "type": "boolean", + "description": "Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.", + "default": false + } + } + }, + "InfrastructureNetwork": { + "type": "object", + "description": "The InfrastructureNetwork of a AzureStackHCI Cluster.", + "properties": { + "subnetMask": { + "type": "string", + "description": "Subnet mask that matches the provided IP address space." + }, + "gateway": { + "type": "string", + "description": "Default gateway that should be used for the provided IP address space." + }, + "ipPools": { + "type": "array", + "description": "Range of IP addresses from which addresses are allocated for nodes within a subnet.", + "items": { + "$ref": "#/definitions/IpPools" + }, + "x-ms-identifiers": [] + }, + "dnsServers": { + "type": "array", + "description": "IPv4 address of the DNS servers in your environment.", + "items": { + "type": "string" + } + }, + "useDhcp": { + "type": "boolean", + "description": "Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required" + } + } + }, + "Intents": { + "type": "object", + "description": "The Intents of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network intent you wish to create." + }, + "trafficType": { + "type": "array", + "description": "List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'.", + "items": { + "type": "string" + } + }, + "adapter": { + "type": "array", + "description": "Array of network interfaces used for the network intent.", + "items": { + "type": "string" + } + }, + "overrideVirtualSwitchConfiguration": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "virtualSwitchConfigurationOverrides": { + "$ref": "#/definitions/VirtualSwitchConfigurationOverrides", + "description": "Set virtualSwitch ConfigurationOverrides for cluster." + }, + "overrideQosPolicy": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "qosPolicyOverrides": { + "$ref": "#/definitions/QosPolicyOverrides", + "description": "Set QoS PolicyOverrides for cluster." + }, + "overrideAdapterProperty": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "default": false + }, + "adapterPropertyOverrides": { + "$ref": "#/definitions/AdapterPropertyOverrides", + "description": "Set Adapter PropertyOverrides for cluster." + } + } + }, + "IpPools": { + "type": "object", + "description": "The dnsServers of a device.", + "properties": { + "startingAddress": { + "type": "string", + "description": "Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + }, + "endingAddress": { + "type": "string", + "description": "Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering." + } + } + }, + "NetworkController": { + "type": "object", + "description": "network controller config for SDN Integration to deploy AzureStackHCI Cluster.", + "properties": { + "macAddressPoolStart": { + "type": "string", + "description": "macAddressPoolStart of network controller used for SDN Integration." + }, + "macAddressPoolStop": { + "type": "string", + "description": "macAddressPoolStop of network controller used for SDN Integration." + }, + "networkVirtualizationEnabled": { + "type": "boolean", + "description": "NetworkVirtualizationEnabled of network controller used for SDN Integration." + } + } + }, + "Observability": { + "type": "object", + "description": "The Observability of AzureStackHCI Cluster.", + "properties": { + "streamingDataClient": { + "type": "boolean", + "description": "Enables telemetry data to be sent to Microsoft", + "default": true + }, + "euLocation": { + "type": "boolean", + "description": "Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU.", + "default": false + }, + "episodicDataUpload": { + "type": "boolean", + "description": "When set to true, collects log data to facilitate quicker issue resolution.", + "default": true + } + } + }, + "OptionalServices": { + "type": "object", + "description": "The OptionalServices of AzureStackHCI Cluster.", + "properties": { + "customLocation": { + "type": "string", + "description": "The name of custom location." + } + } + }, + "PhysicalNodes": { + "type": "object", + "description": "The PhysicalNodes of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "NETBIOS name of each physical server on your Azure Stack HCI cluster." + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each physical server on your Azure Stack HCI cluster." + } + } + }, + "QosPolicyOverrides": { + "type": "object", + "description": "The QoSPolicyOverrides of a cluster.", + "properties": { + "priorityValue8021Action_Cluster": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "priorityValue8021Action_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + }, + "bandwidthPercentage_SMB": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation." + } + } + }, + "SbePartnerInfo": { + "type": "object", + "description": "The solution builder extension (SBE) partner deployment info for cluster.", + "properties": { + "sbeDeploymentInfo": { + "$ref": "#/definitions/SbeDeploymentInfo", + "description": "SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment." + }, + "partnerProperties": { + "type": "array", + "description": "List of SBE partner properties for AzureStackHCI cluster deployment.", + "items": { + "$ref": "#/definitions/SbePartnerProperties" + }, + "x-ms-identifiers": [] + }, + "credentialList": { + "type": "array", + "description": "SBE credentials list for AzureStackHCI cluster deployment.", + "items": { + "$ref": "#/definitions/SbeCredentials" + }, + "x-ms-identifiers": [ + "secretName" + ] + } + } + }, + "SbeDeploymentInfo": { + "type": "object", + "description": "Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment.", + "properties": { + "version": { + "type": "string", + "description": "SBE package version." + }, + "family": { + "type": "string", + "description": "SBE family name." + }, + "publisher": { + "type": "string", + "description": "SBE manifest publisher." + }, + "sbeManifestSource": { + "type": "string", + "description": "SBE Manifest Source." + }, + "sbeManifestCreationDate": { + "type": "string", + "format": "date-time", + "description": "SBE Manifest Creation Date." + } + } + }, + "SbePartnerProperties": { + "type": "object", + "description": "Solution builder extension (SBE) partner properties object.", + "properties": { + "name": { + "type": "string", + "description": "SBE partner property name." + }, + "value": { + "type": "string", + "description": "SBE partner property value." + } + } + }, + "SbeCredentials": { + "type": "object", + "description": "secrets used for solution builder extension (SBE) partner extensibility.", + "properties": { + "secretName": { + "type": "string", + "description": "secret name stored in keyvault." + }, + "eceSecretName": { + "type": "string", + "description": "secret name expected for Enterprise Cloud Engine (ECE)." + }, + "secretLocation": { + "type": "string", + "format": "uri", + "description": "secret URI stored in keyvault." + } + } + }, + "ScaleUnits": { + "type": "object", + "description": "Scale units will contains list of deployment data", + "properties": { + "deploymentData": { + "$ref": "#/definitions/DeploymentData", + "description": "Deployment Data to deploy AzureStackHCI Cluster." + }, + "sbePartnerInfo": { + "$ref": "#/definitions/SbePartnerInfo", + "description": "Solution builder extension (SBE) partner properties" + } + }, + "required": [ + "deploymentData" + ], + "externalDocs": { + "description": "Deploy Azure Stack HCI using an existing configuration file", + "url": "https://learn.microsoft.com/en-us/azure-stack/hci/deploy/deployment-tool-existing-file" + } + }, + "SdnIntegration": { + "type": "object", + "description": "SDN Integration config to deploy AzureStackHCI Cluster.", + "properties": { + "networkController": { + "$ref": "#/definitions/NetworkController", + "description": "network controller config for SDN Integration to deploy AzureStackHCI Cluster." + } + } + }, + "DeploymentSecuritySettings": { + "type": "object", + "description": "The SecuritySettings of AzureStackHCI Cluster.", + "properties": { + "hvciProtection": { + "type": "boolean", + "description": "By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster.", + "default": true + }, + "drtmProtection": { + "type": "boolean", + "description": "By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent.", + "default": true + }, + "driftControlEnforced": { + "type": "boolean", + "description": "When set to true, the security baseline is re-applied regularly.", + "default": true + }, + "credentialGuardEnforced": { + "type": "boolean", + "description": "When set to true, Credential Guard is enabled.", + "default": false + }, + "smbSigningEnforced": { + "type": "boolean", + "description": "When set to true, the SMB default instance requires sign in for the client and server services.", + "default": true + }, + "smbClusterEncryption": { + "type": "boolean", + "description": "When set to true, cluster east-west traffic is encrypted.", + "default": false + }, + "sideChannelMitigationEnforced": { + "type": "boolean", + "description": "When set to true, all the side channel mitigations are enabled", + "default": true + }, + "bitlockerBootVolume": { + "type": "boolean", + "description": "When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ", + "default": true + }, + "bitlockerDataVolumes": { + "type": "boolean", + "description": "When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes.", + "default": true + }, + "wdacEnforced": { + "type": "boolean", + "description": "WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster.", + "default": true + } + } + }, + "Storage": { + "type": "object", + "description": "The Storage config of AzureStackHCI Cluster.", + "properties": { + "configurationMode": { + "type": "string", + "description": "By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage'", + "default": "Express" + } + } + }, + "StorageAdapterIPInfo": { + "type": "object", + "description": "The StorageAdapter physical nodes of a cluster.", + "properties": { + "physicalNode": { + "type": "string", + "description": "storage adapter physical node name." + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster." + }, + "subnetMask": { + "type": "string", + "description": "The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster." + } + } + }, + "StorageNetworks": { + "type": "object", + "description": "The StorageNetworks of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the storage network." + }, + "networkAdapterName": { + "type": "string", + "description": "Name of the storage network adapter." + }, + "vlanId": { + "type": "string", + "description": "ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. " + }, + "storageAdapterIPInfo": { + "type": "array", + "description": "List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageAdapterIPInfo" + }, + "x-ms-identifiers": [ + "physicalNode" + ] + } + } + }, + "VirtualSwitchConfigurationOverrides": { + "type": "object", + "description": "The VirtualSwitchConfigurationOverrides of a cluster.", + "properties": { + "enableIov": { + "type": "string", + "description": "Enable IoV for Virtual Switch" + }, + "loadBalancingAlgorithm": { + "type": "string", + "description": "Load Balancing Algorithm for Virtual Switch" + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDeviceJobs.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDeviceJobs.json new file mode 100644 index 000000000000..61629ab51bda --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDeviceJobs.json @@ -0,0 +1,1150 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.AzureStackHCI", + "version": "2024-09-01-preview", + "description": "A EdgeDevice" + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EdgeDeviceJobs" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs": { + "get": { + "operationId": "EdgeDeviceJobs_ListByEdgeDevice", + "tags": [ + "EdgeDeviceJobs" + ], + "description": "List EdgeDeviceJob resources by EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "The name of the EdgeDevice", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDeviceJobListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EdgeDeviceJobs_ListByEdgeDevice": { + "$ref": "./examples/EdgeDeviceJobs_ListByEdgeDevice.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}": { + "get": { + "operationId": "EdgeDeviceJobs_Get", + "tags": [ + "EdgeDeviceJobs" + ], + "description": "Get a EdgeDeviceJob", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "The name of the EdgeDevice", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobsName", + "in": "path", + "description": "Name of EdgeDevice Job", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDeviceJob" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "EdgeDeviceJobs_Get_RemoteSupport": { + "$ref": "./examples/EdgeDeviceJobs_Get_RemoteSupport.json" + } + } + }, + "put": { + "operationId": "EdgeDeviceJobs_CreateOrUpdate", + "tags": [ + "EdgeDeviceJobs" + ], + "description": "Create a EdgeDeviceJob", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "The name of the EdgeDevice", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobsName", + "in": "path", + "description": "Name of EdgeDevice Job", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeDeviceJob" + } + } + ], + "responses": { + "200": { + "description": "Resource 'EdgeDeviceJob' update operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeDeviceJob" + } + }, + "201": { + "description": "Resource 'EdgeDeviceJob' create operation succeeded", + "schema": { + "$ref": "#/definitions/EdgeDeviceJob" + }, + "headers": { + "Azure-AsyncOperation": { + "type": "string", + "description": "A link to the status monitor" + }, + "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": { + "EdgeDeviceJobs_CreateOrUpdate_CollectLog": { + "$ref": "./examples/EdgeDeviceJobs_CreateOrUpdate_CollectLog.json" + }, + "EdgeDeviceJobs_CreateOrUpdate_RemoteSupport": { + "$ref": "./examples/EdgeDeviceJobs_CreateOrUpdate_RemoteSupport.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "EdgeDeviceJobs_Delete", + "tags": [ + "EdgeDeviceJobs" + ], + "description": "Delete a EdgeDeviceJob", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "The name of the EdgeDevice", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "jobsName", + "in": "path", + "description": "Name of EdgeDevice Job", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "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": { + "EdgeDeviceJobs_Delete": { + "$ref": "./examples/EdgeDeviceJobs_Delete.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "CollectLogJobProperties": { + "type": "object", + "description": "Represents the properties of a log collection job.", + "properties": { + "fromDate": { + "type": "string", + "format": "date-time", + "description": "From date for log collection." + }, + "toDate": { + "type": "string", + "format": "date-time", + "description": "To date for log collection." + }, + "lastLogGenerated": { + "type": "string", + "format": "date-time", + "description": "To date for log collection.", + "readOnly": true + }, + "reportedProperties": { + "$ref": "#/definitions/LogCollectionReportedProperties", + "description": "log collection job reported properties.", + "readOnly": true + } + }, + "required": [ + "fromDate", + "toDate" + ] + }, + "DeploymentMode": { + "type": "string", + "description": "Deployment mode to trigger job.", + "enum": [ + "Validate", + "Deploy" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": true, + "values": [ + { + "name": "Validate", + "value": "Validate", + "description": "Validate ECE action deployment for a cluster." + }, + { + "name": "Deploy", + "value": "Deploy", + "description": "Deploy ECE action deployment for a cluster." + } + ] + } + }, + "DeviceLogCollectionStatus": { + "type": "string", + "description": "Represents the status of a log collection operation.", + "enum": [ + "NotStarted", + "Running", + "Failed", + "Succeeded", + "Canceled" + ], + "x-ms-enum": { + "name": "DeviceLogCollectionStatus", + "modelAsString": true, + "values": [ + { + "name": "NotStarted", + "value": "NotStarted", + "description": "Log collection operation has not been initiated." + }, + { + "name": "Running", + "value": "Running", + "description": "Indicates that the log collection operation is currently running." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that the log collection operation has failed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Indicates that the log collection operation has completed successfully." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Indicates that the log collection operation has completed successfully." + } + ] + }, + "readOnly": true + }, + "EdgeDeviceJob": { + "type": "object", + "description": "EdgeDevice Jobs resource", + "properties": { + "kind": { + "$ref": "./hciCommon.json#/definitions/EdgeDeviceKind", + "description": "Edge Solution type to support polymorphic resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EdgeDeviceJobListResult": { + "type": "object", + "description": "The response of a EdgeDeviceJob list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeDeviceJob items on this page", + "items": { + "$ref": "#/definitions/EdgeDeviceJob" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeDeviceJobProperties": { + "type": "object", + "description": "Edge device job properties", + "properties": { + "deploymentMode": { + "$ref": "#/definitions/DeploymentMode", + "description": "Deployment mode to trigger job." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Job provisioning state", + "readOnly": true + }, + "jobId": { + "type": "string", + "description": "Unique, immutable job id.", + "readOnly": true + }, + "startTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which the job started.", + "readOnly": true + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which the job completed.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Status of Edge device job.", + "readOnly": true + } + } + }, + "EdgeDeviceJobType": { + "type": "string", + "description": "Common Job Types supported.", + "enum": [ + "CollectLog", + "RemoteSupport" + ], + "x-ms-enum": { + "name": "EdgeDeviceJobType", + "modelAsString": true, + "values": [ + { + "name": "CollectLog", + "value": "CollectLog", + "description": "Job to collect logs from the device." + }, + { + "name": "RemoteSupport", + "value": "RemoteSupport", + "description": "Job to provide remote support to the device." + } + ] + } + }, + "EdgeSolutionType": { + "type": "string", + "description": "Edge solution type.", + "enum": [ + "WindowsServer" + ], + "x-ms-enum": { + "name": "EdgeSolutionType", + "modelAsString": true, + "values": [ + { + "name": "WindowsServer", + "value": "WindowsServer", + "description": "Edge solution for Windows based edge devices." + } + ] + } + }, + "HciCollectLogJobProperties": { + "type": "object", + "description": "Represents the properties of an HCI Collect Log job.", + "properties": { + "fromDate": { + "type": "string", + "format": "date-time", + "description": "From date for log collection." + }, + "toDate": { + "type": "string", + "format": "date-time", + "description": "To date for log collection." + }, + "lastLogGenerated": { + "type": "string", + "format": "date-time", + "description": "To date for log collection.", + "readOnly": true + }, + "reportedProperties": { + "$ref": "#/definitions/LogCollectionReportedProperties", + "description": "log collection job reported properties.", + "readOnly": true + } + }, + "required": [ + "fromDate", + "toDate" + ], + "allOf": [ + { + "$ref": "#/definitions/HciEdgeDeviceJobProperties" + } + ], + "x-ms-discriminator-value": "CollectLog" + }, + "HciEdgeDeviceJob": { + "type": "object", + "description": "Edge device job for Azure Stack HCI solution.", + "properties": { + "properties": { + "$ref": "#/definitions/HciEdgeDeviceJobProperties", + "description": "HCI Edge device job properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EdgeDeviceJob" + } + ], + "x-ms-discriminator-value": "HCI" + }, + "HciEdgeDeviceJobProperties": { + "type": "object", + "description": "HCI Edge device job properties", + "properties": { + "deploymentMode": { + "$ref": "#/definitions/DeploymentMode", + "description": "Deployment mode to trigger job." + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Job provisioning state", + "readOnly": true + }, + "jobId": { + "type": "string", + "description": "Unique, immutable job id.", + "readOnly": true + }, + "startTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which the job started.", + "readOnly": true + }, + "endTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which the job completed.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/JobStatus", + "description": "Status of Edge device job.", + "readOnly": true + }, + "jobType": { + "$ref": "#/definitions/HciEdgeDeviceJobType", + "description": "Job Type to support polymorphic resource.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "discriminator": "jobType", + "required": [ + "jobType" + ] + }, + "HciEdgeDeviceJobType": { + "type": "string", + "description": "Job Type supported.", + "enum": [ + "CollectLog", + "RemoteSupport" + ], + "x-ms-enum": { + "name": "HciEdgeDeviceJobType", + "modelAsString": true, + "values": [ + { + "name": "CollectLog", + "value": "CollectLog", + "description": "Job to collect logs from the device." + }, + { + "name": "RemoteSupport", + "value": "RemoteSupport", + "description": "Job to provide remote support to the device." + } + ] + } + }, + "HciRemoteSupportJobProperties": { + "type": "object", + "description": "Represents the properties of a remote support job for HCI.", + "properties": { + "accessLevel": { + "$ref": "#/definitions/RemoteSupportAccessLevel", + "description": "Remote support access level." + }, + "expirationTimestamp": { + "type": "string", + "format": "date-time", + "description": "Remote support expiration timestamp." + }, + "type": { + "$ref": "#/definitions/RemoteSupportType", + "description": "Remote support type." + }, + "reportedProperties": { + "$ref": "#/definitions/RemoteSupportJobReportedProperties", + "description": "log collection job reported properties.", + "readOnly": true + } + }, + "required": [ + "accessLevel", + "expirationTimestamp", + "type" + ], + "allOf": [ + { + "$ref": "#/definitions/HciEdgeDeviceJobProperties" + } + ], + "x-ms-discriminator-value": "RemoteSupport" + }, + "JobReportedProperties": { + "type": "object", + "description": "Reported Properties for job triggered from cloud.", + "properties": { + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "The percentage of the job that is complete.", + "readOnly": true + }, + "validationStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Validation status of job.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Deployment status of job.", + "readOnly": true + } + } + }, + "JobStatus": { + "type": "string", + "description": "Represents the various statuses a job can have throughout its lifecycle.", + "enum": [ + "NotSpecified", + "ValidationInProgress", + "ValidationSuccess", + "ValidationFailed", + "DeploymentInProgress", + "DeploymentFailed", + "DeploymentSuccess", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "The job status has not been specified." + }, + { + "name": "ValidationInProgress", + "value": "ValidationInProgress", + "description": "The job is currently undergoing validation." + }, + { + "name": "ValidationSuccess", + "value": "ValidationSuccess", + "description": "The job has successfully passed validation." + }, + { + "name": "ValidationFailed", + "value": "ValidationFailed", + "description": "The job has failed validation." + }, + { + "name": "DeploymentInProgress", + "value": "DeploymentInProgress", + "description": "The job's deployment is currently in progress." + }, + { + "name": "DeploymentFailed", + "value": "DeploymentFailed", + "description": "The job's deployment has failed." + }, + { + "name": "DeploymentSuccess", + "value": "DeploymentSuccess", + "description": "The job has been successfully deployed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "The job has succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "The job has failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "The job has been canceled." + }, + { + "name": "Paused", + "value": "Paused", + "description": "The job is paused." + }, + { + "name": "Scheduled", + "value": "Scheduled", + "description": "The job is scheduled to run." + } + ] + }, + "readOnly": true + }, + "LogCollectionReportedProperties": { + "type": "object", + "description": "Represents the reported properties of a log collection job.", + "properties": { + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "The percentage of the job that is complete.", + "readOnly": true + }, + "validationStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Validation status of job.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Deployment status of job.", + "readOnly": true + }, + "logCollectionSessionDetails": { + "type": "array", + "description": "Details of the log collection session.", + "items": { + "$ref": "#/definitions/LogCollectionJobSession" + }, + "readOnly": true, + "x-ms-identifiers": [ + "correlationId" + ] + } + } + }, + "LogCollectionJobSession": { + "type": "object", + "description": "Represents a session for collecting logs from an edge device.", + "properties": { + "startTime": { + "type": "string", + "description": "The timestamp when log collection started, in ISO 8601 format.", + "readOnly": true + }, + "endTime": { + "type": "string", + "description": "The timestamp when log collection ended, in ISO 8601 format.", + "readOnly": true + }, + "timeCollected": { + "type": "string", + "description": "The total time logs were collected for, in ISO 8601 duration format.", + "readOnly": true + }, + "logSize": { + "type": "integer", + "format": "int32", + "description": "The size of the collected logs in bytes.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/DeviceLogCollectionStatus", + "description": "The status of the log collection session.", + "readOnly": true + }, + "correlationId": { + "type": "string", + "description": "A unique identifier for correlating this log collection session with other operations or sessions.", + "readOnly": true + } + } + }, + "LogCollectionStatus": { + "type": "string", + "description": "Represents the status of a log collection operation.", + "enum": [ + "None", + "InProgress", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "LogCollectionStatus", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "Indicates that no log collection operation has been initiated." + }, + { + "name": "InProgress", + "value": "InProgress", + "description": "Indicates that the log collection operation is currently in progress." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Indicates that the log collection operation has failed." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Indicates that the log collection operation has completed successfully." + } + ] + }, + "readOnly": true + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "NotSpecified", + "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": "NotSpecified", + "value": "NotSpecified", + "description": "The resource provision state is not specified" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + }, + "readOnly": true + }, + "RemoteSupportAccessLevel": { + "type": "string", + "description": "Defines the level of remote support access granted.", + "enum": [ + "None", + "Diagnostics", + "DiagnosticsAndRepair" + ], + "x-ms-enum": { + "name": "RemoteSupportAccessLevel", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No remote support access is granted." + }, + { + "name": "Diagnostics", + "value": "Diagnostics", + "description": "Access is limited to diagnostics information only." + }, + { + "name": "DiagnosticsAndRepair", + "value": "DiagnosticsAndRepair", + "description": "Access includes diagnostics information and the ability to perform repairs." + } + ] + } + }, + "RemoteSupportJobProperties": { + "type": "object", + "description": "Represents the properties of a remote support job.", + "properties": { + "accessLevel": { + "$ref": "#/definitions/RemoteSupportAccessLevel", + "description": "Remote support access level." + }, + "expirationTimestamp": { + "type": "string", + "format": "date-time", + "description": "Remote support expiration timestamp." + }, + "type": { + "$ref": "#/definitions/RemoteSupportType", + "description": "Remote support type." + }, + "reportedProperties": { + "$ref": "#/definitions/RemoteSupportJobReportedProperties", + "description": "log collection job reported properties.", + "readOnly": true + } + }, + "required": [ + "accessLevel", + "expirationTimestamp", + "type" + ] + }, + "RemoteSupportJobNodeSettings": { + "type": "object", + "description": "Represents the settings of a remote support node.", + "properties": { + "state": { + "type": "string", + "description": "The state of the remote support node.", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the node settings were created, in UTC.", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp when the node settings were last updated, in UTC.", + "readOnly": true + }, + "connectionStatus": { + "type": "string", + "description": "The current connection status of the remote support session.", + "readOnly": true + }, + "connectionErrorMessage": { + "type": "string", + "description": "The error message, if any, from the last connection attempt.", + "readOnly": true + } + } + }, + "RemoteSupportJobReportedProperties": { + "type": "object", + "description": "Represents the reported properties of a remote support job.", + "properties": { + "percentComplete": { + "type": "integer", + "format": "int32", + "description": "The percentage of the job that is complete.", + "readOnly": true + }, + "validationStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Validation status of job.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "./hciCommon.json#/definitions/EceActionStatus", + "description": "Deployment status of job.", + "readOnly": true + }, + "nodeSettings": { + "$ref": "#/definitions/RemoteSupportJobNodeSettings", + "description": "Optional settings for configuring the node for remote support.", + "readOnly": true + }, + "sessionDetails": { + "type": "array", + "description": "Details of the remote support session.", + "items": { + "$ref": "#/definitions/RemoteSupportSession" + }, + "readOnly": true, + "x-ms-identifiers": [ + "sessionId" + ] + } + } + }, + "RemoteSupportSession": { + "type": "object", + "description": "Represents a remote support session.", + "properties": { + "sessionId": { + "type": "string", + "description": "Unique session Id.", + "readOnly": true + }, + "sessionStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the remote support session, in UTC.", + "readOnly": true + }, + "sessionEndTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the remote support session, in UTC.", + "readOnly": true + }, + "accessLevel": { + "$ref": "#/definitions/RemoteSupportAccessLevel", + "description": "The level of access granted during the remote support session.", + "readOnly": true + }, + "transcriptLocation": { + "type": "string", + "description": "The location where the session transcript is stored.", + "readOnly": true + } + } + }, + "RemoteSupportType": { + "type": "string", + "description": "Defines the type of remote support action to be performed on an edge device.", + "enum": [ + "Enable", + "Revoke" + ], + "x-ms-enum": { + "name": "RemoteSupportType", + "modelAsString": true, + "values": [ + { + "name": "Enable", + "value": "Enable", + "description": "Enables remote support for the edge device." + }, + { + "name": "Revoke", + "value": "Revoke", + "description": "Revokes previously granted remote support access for the edge device." + } + ] + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDevices.json new file mode 100644 index 000000000000..3c8a1a7c0ea9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/edgeDevices.json @@ -0,0 +1,1263 @@ +{ + "swagger": "2.0", + "info": { + "title": "Edge Devices", + "version": "2024-09-01-preview", + "description": "Azure Arc-enabled Edge Device." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "EdgeDevices" + } + ], + "paths": { + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices": { + "get": { + "operationId": "EdgeDevices_List", + "tags": [ + "EdgeDevices" + ], + "description": "List EdgeDevice resources by parent", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Edge Devices": { + "$ref": "./examples/ListEdgeDevices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}": { + "get": { + "operationId": "EdgeDevices_Get", + "tags": [ + "EdgeDevices" + ], + "description": "Get a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Edge Device": { + "$ref": "./examples/GetEdgeDevices.json" + } + } + }, + "put": { + "operationId": "EdgeDevices_CreateOrUpdate", + "tags": [ + "EdgeDevices" + ], + "description": "Create a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "201": { + "description": "Resource successfully created.", + "schema": { + "$ref": "#/definitions/EdgeDevice" + }, + "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-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create HCI Edge Device": { + "$ref": "./examples/CreateHciEdgeDevice.json" + } + } + }, + "delete": { + "operationId": "EdgeDevices_Delete", + "tags": [ + "EdgeDevices" + ], + "description": "Delete a EdgeDevice", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Edge Devices": { + "$ref": "./examples/DeleteEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate": { + "post": { + "operationId": "EdgeDevices_Validate", + "tags": [ + "EdgeDevices" + ], + "description": "A long-running resource action.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Azure.ResourceManager.ResourceUriParameter" + }, + { + "name": "edgeDeviceName", + "in": "path", + "description": "Name of Device", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "ValidateRequest", + "in": "body", + "description": "The content of the action request", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRequest" + } + } + ], + "responses": { + "200": { + "description": "Azure operation completed successfully.", + "schema": { + "$ref": "#/definitions/ValidateResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Validate Edge Devices": { + "$ref": "./examples/ValidateEdgeDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AdapterPropertyOverrides": { + "type": "object", + "description": "The AdapterPropertyOverrides of a cluster.", + "properties": { + "jumboPacket": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "networkDirect": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "networkDirectTechnology": { + "type": "string", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE'", + "readOnly": true + } + } + }, + "ArcExtensionState": { + "type": "string", + "description": "Arc extension installation state.", + "enum": [ + "NotSpecified", + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Creating", + "Updating", + "Moving", + "Deleting", + "Deleted" + ], + "x-ms-enum": { + "name": "ArcExtensionState", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "Arc extension state is not specified." + }, + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Arc extension state is Succeeded." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Arc extension state is Failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Arc extension state is Canceled." + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "Arc extension state is Accepted when extension installation triggered." + }, + { + "name": "Creating", + "value": "Creating", + "description": "Arc extension is in Creating State." + }, + { + "name": "Updating", + "value": "Updating", + "description": "Arc extension is in Updating State." + }, + { + "name": "Moving", + "value": "Moving", + "description": "Arc extension is in Moving State." + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "Arc extension is in Deleting State." + }, + { + "name": "Deleted", + "value": "Deleted", + "description": "Arc extension is in Deleted State." + } + ] + } + }, + "DeviceConfiguration": { + "type": "object", + "description": "The device Configuration for edge device.", + "properties": { + "nicDetails": { + "type": "array", + "description": "NIC Details of device", + "items": { + "$ref": "#/definitions/NicDetail" + }, + "x-ms-identifiers": [ + "adapterName" + ] + }, + "deviceMetadata": { + "type": "string", + "description": "Device metadata details." + } + } + }, + "DeviceKind": { + "type": "string", + "description": "Edge device kind.", + "enum": [ + "HCI" + ], + "default": "HCI", + "x-ms-enum": { + "name": "DeviceKind", + "modelAsString": true, + "values": [ + { + "name": "HCI", + "value": "HCI", + "description": "Arc-enabled edge device with HCI OS." + } + ] + } + }, + "DeviceState": { + "type": "string", + "description": "The edge device state.", + "enum": [ + "NotSpecified", + "Connected", + "Disconnected", + "Repairing", + "Draining", + "InMaintenance", + "Resuming", + "Processing" + ], + "x-ms-enum": { + "name": "DeviceState", + "modelAsString": true, + "values": [ + { + "name": "NotSpecified", + "value": "NotSpecified", + "description": "The edge device state is not specified." + }, + { + "name": "Connected", + "value": "Connected", + "description": "The edge device state is in connected state." + }, + { + "name": "Disconnected", + "value": "Disconnected", + "description": "The edge device state is in disconnected state." + }, + { + "name": "Repairing", + "value": "Repairing", + "description": "The edge device state is in repairing state." + }, + { + "name": "Draining", + "value": "Draining", + "description": "The edge device state is in draining state." + }, + { + "name": "InMaintenance", + "value": "InMaintenance", + "description": "The edge device state is in maintenance state." + }, + { + "name": "Resuming", + "value": "Resuming", + "description": "The edge device state is in resuming state." + }, + { + "name": "Processing", + "value": "Processing", + "description": "The edge device state is in processing state." + } + ] + } + }, + "EdgeDevice": { + "type": "object", + "description": "Edge device resource.", + "properties": { + "kind": { + "$ref": "#/definitions/DeviceKind", + "description": "Device kind to support polymorphic resource.", + "x-ms-mutability": [ + "create", + "read" + ] + } + }, + "discriminator": "kind", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ] + }, + "EdgeDeviceListResult": { + "type": "object", + "description": "The response of a EdgeDevice list operation.", + "properties": { + "value": { + "type": "array", + "description": "The EdgeDevice items on this page", + "items": { + "$ref": "#/definitions/EdgeDevice" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "EdgeDeviceProperties": { + "type": "object", + "description": "Edge Device properties", + "properties": { + "deviceConfiguration": { + "$ref": "#/definitions/DeviceConfiguration", + "description": "Device Configuration" + }, + "provisioningState": { + "$ref": "./hciCommon.json#/definitions/ProvisioningState", + "description": "Provisioning state of edgeDevice resource", + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "details of validation failure", + "properties": { + "exception": { + "type": "string", + "description": "Exception details while installing extension.", + "readOnly": true + } + } + }, + "Extension": { + "type": "object", + "description": "Arc extension installed on edge device.", + "properties": { + "extensionName": { + "type": "string", + "description": "Arc extension name installed on edge device.", + "readOnly": true + }, + "state": { + "$ref": "#/definitions/ArcExtensionState", + "description": "Arc extension state from arc machine extension.", + "readOnly": true + }, + "errorDetails": { + "type": "array", + "description": "Error details while installing Arc extension.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "extensionResourceId": { + "type": "string", + "format": "arm-id", + "description": "Arc Extension Azure resource id.", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Extension version installed.", + "readOnly": true + }, + "managedBy": { + "type": "string", + "description": "Extension managed by user or Azure.", + "default": "Azure", + "enum": [ + "User", + "Azure" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ExtensionManagedBy": { + "type": "string", + "description": "Arc extension managed by Azure or User.", + "enum": [ + "User", + "Azure" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + } + }, + "ExtensionProfile": { + "type": "object", + "description": "Extensions details for edge device.", + "properties": { + "extensions": { + "type": "array", + "description": "List of Arc extensions installed on edge device.", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true, + "x-ms-identifiers": [ + "extensionName" + ] + } + } + }, + "HciEdgeDevice": { + "type": "object", + "description": "Arc-enabled edge device with HCI OS.", + "properties": { + "properties": { + "$ref": "#/definitions/HciEdgeDeviceProperties", + "description": "properties for Arc-enabled edge device with HCI OS." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EdgeDevice" + } + ], + "x-ms-discriminator-value": "HCI" + }, + "HciEdgeDeviceProperties": { + "type": "object", + "description": "properties for Arc-enabled edge device with HCI OS.", + "properties": { + "reportedProperties": { + "$ref": "#/definitions/HciReportedProperties", + "description": "The instance view of all current configurations on HCI device.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/EdgeDeviceProperties" + } + ] + }, + "HciNetworkProfile": { + "type": "object", + "description": "The network profile of a device.", + "properties": { + "nicDetails": { + "type": "array", + "description": "List of NIC Details of device.", + "items": { + "$ref": "#/definitions/HciNicDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "adapterName" + ] + }, + "switchDetails": { + "type": "array", + "description": "List of switch details for edge device.", + "items": { + "$ref": "#/definitions/SwitchDetail" + }, + "readOnly": true, + "x-ms-identifiers": [ + "switchName" + ] + }, + "hostNetwork": { + "$ref": "#/definitions/HostNetwork", + "description": "HostNetwork config to deploy AzureStackHCI Cluster.", + "readOnly": true + } + } + }, + "HciNicDetail": { + "type": "object", + "description": "The NIC Detail of a device.", + "properties": { + "adapterName": { + "type": "string", + "description": "Adapter Name of NIC", + "readOnly": true + }, + "interfaceDescription": { + "type": "string", + "description": "Interface Description of NIC", + "readOnly": true + }, + "componentId": { + "type": "string", + "description": "Component Id of NIC", + "readOnly": true + }, + "driverVersion": { + "type": "string", + "description": "Driver Version of NIC", + "readOnly": true + }, + "ip4Address": { + "type": "string", + "description": "Subnet Mask of NIC", + "readOnly": true + }, + "subnetMask": { + "type": "string", + "description": "Subnet Mask of NIC", + "readOnly": true + }, + "defaultGateway": { + "type": "string", + "description": "Default Gateway of NIC", + "readOnly": true + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers for NIC", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "defaultIsolationId": { + "type": "string", + "description": "Default Isolation of Management NIC", + "readOnly": true + }, + "macAddress": { + "type": "string", + "description": "MAC address information of NIC.", + "readOnly": true + }, + "slot": { + "type": "string", + "description": "The slot attached to the NIC.", + "readOnly": true + }, + "switchName": { + "type": "string", + "description": "The switch attached to the NIC, if any.", + "readOnly": true + }, + "nicType": { + "type": "string", + "description": "The type of NIC, physical, virtual, management.", + "readOnly": true + }, + "vlanId": { + "type": "string", + "description": "The VLAN ID of the physical NIC.", + "readOnly": true + }, + "nicStatus": { + "type": "string", + "description": "The status of NIC, up, disconnected.", + "readOnly": true + }, + "rdmaCapability": { + "type": "string", + "description": "Describes the RDMA capability of the network adapter.", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Disabled", + "x-ms-enum": { + "name": "RdmaCapability", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Network Adapter on the device is RDMA Capable" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Network Adapter on the device is RDMA Capable" + } + ] + }, + "readOnly": true + } + } + }, + "HciOsProfile": { + "type": "object", + "description": "OS configurations for HCI device.", + "properties": { + "bootType": { + "type": "string", + "description": "The boot type of the device. e.g. UEFI, Legacy etc", + "readOnly": true + }, + "assemblyVersion": { + "type": "string", + "description": "Version of assembly present on device", + "readOnly": true + } + } + }, + "HciReportedProperties": { + "type": "object", + "description": "The device Configuration for HCI device.", + "properties": { + "networkProfile": { + "$ref": "#/definitions/HciNetworkProfile", + "description": "HCI device network information.", + "readOnly": true + }, + "osProfile": { + "$ref": "#/definitions/HciOsProfile", + "description": "HCI device OS specific information.", + "readOnly": true + }, + "sbeDeploymentPackageInfo": { + "$ref": "#/definitions/SbeDeploymentPackageInfo", + "description": "Solution builder extension (SBE) deployment package information.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ReportedProperties" + } + ] + }, + "HostNetwork": { + "type": "object", + "description": "The HostNetwork of a cluster.", + "properties": { + "intents": { + "type": "array", + "description": "The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM.", + "items": { + "$ref": "#/definitions/Intents" + }, + "readOnly": true, + "x-ms-identifiers": [ + "intentName" + ] + }, + "storageNetworks": { + "type": "array", + "description": "List of StorageNetworks config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageNetworks" + }, + "readOnly": true, + "x-ms-identifiers": [ + "networkAdapterName" + ] + }, + "storageConnectivitySwitchless": { + "type": "boolean", + "description": "Defines how the storage adapters between nodes are connected either switch or switch less.", + "readOnly": true + }, + "enableStorageAutoIp": { + "type": "boolean", + "description": "Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically.", + "readOnly": true + } + } + }, + "Intents": { + "type": "object", + "description": "The Intents of a cluster.", + "properties": { + "scope": { + "type": "integer", + "format": "int64", + "description": "Scope for host network intent.", + "readOnly": true + }, + "intentType": { + "type": "integer", + "format": "int64", + "description": "IntentType for host network intent.", + "readOnly": true + }, + "isComputeIntentSet": { + "type": "boolean", + "description": "IsComputeIntentSet for host network intent.", + "readOnly": true + }, + "isStorageIntentSet": { + "type": "boolean", + "description": "IsStorageIntentSet for host network intent.", + "readOnly": true + }, + "isOnlyStorage": { + "type": "boolean", + "description": "IntentType for host network intent.", + "readOnly": true + }, + "isManagementIntentSet": { + "type": "boolean", + "description": "IsManagementIntentSet for host network intent.", + "readOnly": true + }, + "isStretchIntentSet": { + "type": "boolean", + "description": "IsStretchIntentSet for host network intent.", + "readOnly": true + }, + "isOnlyStretch": { + "type": "boolean", + "description": "IsOnlyStretch for host network intent.", + "readOnly": true + }, + "isNetworkIntentType": { + "type": "boolean", + "description": "IsNetworkIntentType for host network intent.", + "readOnly": true + }, + "intentName": { + "type": "string", + "description": "Name of the network intent you wish to create.", + "readOnly": true + }, + "intentAdapters": { + "type": "array", + "description": "Array of adapters used for the network intent.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "overrideVirtualSwitchConfiguration": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "virtualSwitchConfigurationOverrides": { + "$ref": "#/definitions/VirtualSwitchConfigurationOverrides", + "description": "Set virtualSwitch ConfigurationOverrides for cluster.", + "readOnly": true + }, + "overrideQosPolicy": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "qosPolicyOverrides": { + "$ref": "./deploymentSettings.json#/definitions/QosPolicyOverrides", + "description": "Set QoS PolicyOverrides for cluster.", + "readOnly": true + }, + "overrideAdapterProperty": { + "type": "boolean", + "description": "This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation.", + "readOnly": true + }, + "adapterPropertyOverrides": { + "$ref": "#/definitions/AdapterPropertyOverrides", + "description": "Set Adapter PropertyOverrides for cluster.", + "readOnly": true + } + } + }, + "NicDetail": { + "type": "object", + "description": "The NIC Detail of a device.", + "properties": { + "adapterName": { + "type": "string", + "description": "Adapter Name of NIC" + }, + "interfaceDescription": { + "type": "string", + "description": "Interface Description of NIC" + }, + "componentId": { + "type": "string", + "description": "Component Id of NIC" + }, + "driverVersion": { + "type": "string", + "description": "Driver Version of NIC" + }, + "ip4Address": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "subnetMask": { + "type": "string", + "description": "Subnet Mask of NIC" + }, + "defaultGateway": { + "type": "string", + "description": "Default Gateway of NIC" + }, + "dnsServers": { + "type": "array", + "description": "DNS Servers for NIC", + "items": { + "type": "string" + }, + "x-ms-identifiers": [] + }, + "defaultIsolationId": { + "type": "string", + "description": "Default Isolation of Management NIC" + } + } + }, + "ReportedProperties": { + "type": "object", + "description": "Reported properties pushed from edge device.", + "properties": { + "deviceState": { + "$ref": "#/definitions/DeviceState", + "description": "edge device state.", + "readOnly": true + }, + "extensionProfile": { + "$ref": "#/definitions/ExtensionProfile", + "description": "Extensions details for edge device.", + "readOnly": true + } + } + }, + "SbeDeploymentPackageInfo": { + "type": "object", + "description": "Solution builder extension (SBE) deployment package information.", + "properties": { + "code": { + "type": "string", + "description": "SBE deployment validation code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A detailed message that explains the SBE package validation result.", + "readOnly": true + }, + "sbeManifest": { + "type": "string", + "description": "This represents discovered update results for matching updates and store it as SBE manifest.", + "readOnly": true + } + } + }, + "StorageAdapterIPInfo": { + "type": "object", + "description": "The StorageAdapter physical nodes of a cluster.", + "properties": { + "physicalNode": { + "type": "string", + "description": "storage adapter physical node name.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster.", + "readOnly": true + }, + "subnetMask": { + "type": "string", + "description": "The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster.", + "readOnly": true + } + } + }, + "StorageNetworks": { + "type": "object", + "description": "The StorageNetworks of a cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of the storage network.", + "readOnly": true + }, + "networkAdapterName": { + "type": "string", + "description": "Name of the storage network adapter.", + "readOnly": true + }, + "storageVlanId": { + "type": "string", + "description": "ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ", + "readOnly": true + }, + "storageAdapterIPInfo": { + "type": "array", + "description": "List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster.", + "items": { + "$ref": "#/definitions/StorageAdapterIPInfo" + }, + "readOnly": true, + "x-ms-identifiers": [ + "physicalNode" + ] + } + } + }, + "SwitchDetail": { + "type": "object", + "description": "List of switch details for edge device.", + "properties": { + "switchName": { + "type": "string", + "description": "The name of the switch.", + "readOnly": true + }, + "switchType": { + "type": "string", + "description": "The type of the switch. e.g. external, internal.", + "readOnly": true + }, + "extensions": { + "type": "array", + "description": "This represents extensions installed on virtualSwitch.", + "items": { + "$ref": "#/definitions/SwitchExtension" + }, + "readOnly": true, + "x-ms-identifiers": [ + "extensionName" + ] + } + } + }, + "SwitchExtension": { + "type": "object", + "description": "This represents extensions installed on virtualSwitch.", + "properties": { + "switchId": { + "type": "string", + "description": "Unique identifier for virtualSwitch.", + "readOnly": true + }, + "extensionName": { + "type": "string", + "description": "This will show extension name for virtualSwitch.", + "readOnly": true + }, + "extensionEnabled": { + "type": "boolean", + "description": "This represents whether extension is enabled on virtualSwitch.", + "readOnly": true + } + } + }, + "ValidateRequest": { + "type": "object", + "description": "The validate request for Edge Device.", + "properties": { + "edgeDeviceIds": { + "type": "array", + "description": "Node Ids against which, current node has to be validated.", + "items": { + "type": "string" + } + }, + "additionalInfo": { + "type": "string", + "description": "Additional info required for validation." + } + }, + "required": [ + "edgeDeviceIds" + ] + }, + "ValidateResponse": { + "type": "object", + "description": "An Accepted response with an Operation-Location header.", + "properties": { + "status": { + "type": "string", + "description": "edge device validation status", + "readOnly": true + } + } + }, + "VirtualSwitchConfigurationOverrides": { + "type": "object", + "description": "The VirtualSwitchConfigurationOverrides of a cluster.", + "properties": { + "enableIov": { + "type": "string", + "description": "Enable IoV for Virtual Switch", + "readOnly": true + }, + "loadBalancingAlgorithm": { + "type": "string", + "description": "Load Balancing Algorithm for Virtual Switch", + "readOnly": true + } + } + } + }, + "parameters": { + "Azure.ResourceManager.ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "description": "The fully qualified Azure Resource manager identifier of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Clusters_UpdateSecretsLocations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Clusters_UpdateSecretsLocations.json new file mode 100644 index 000000000000..afd4c575d201 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Clusters_UpdateSecretsLocations.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview", + "body": { + "properties": [ + { + "secretsType": "BackupSecrets", + "secretsLocation": "https://kvname.vault.azure.net/" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "softwareAssuranceProperties": { + "softwareAssuranceStatus": "Enabled", + "lastUpdated": "2022-08-18T22:01:12.4191603Z", + "softwareAssuranceIntent": "Enable" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z", + "secretsLocations": [ + { + "secretsType": "BackupSecrets", + "secretsLocation": "https://kvname.vault.azure.net/" + } + ] + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + }, + "operationId": "Clusters_UpdateSecretsLocations", + "title": "Update secrets locations for a Cluster" +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConfigureRemoteSupport.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConfigureRemoteSupport.json new file mode 100644 index 000000000000..7b4a95509df7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConfigureRemoteSupport.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "mycluster", + "api-version": "2024-09-01-preview", + "remoteSupportRequest": { + "properties": { + "accessLevel": "Diagnostics", + "expirationTimeStamp": "2020-01-01T17:18:19.1234567Z", + "remoteSupportType": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "remoteSupportProperties": { + "accessLevel": "Diagnostics", + "expirationTimeStamp": "2020-01-01T17:18:19.1234567Z", + "remoteSupportType": "Enable", + "remoteSupportNodeSettings": [ + { + "arcResourceId": "/subscriptions/<subId>/resourcegroups/<rg>/Microsoft.HybridCompute/machines/arcNode0", + "state": "Active", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "updatedAt": "2020-01-01T17:18:19.1234567Z", + "connectionStatus": "Connected", + "connectionErrorMessage": "test", + "transcriptLocation": "test" + }, + { + "arcResourceId": "/subscriptions/<subId>/resourcegroups/<rg>/Microsoft.HybridCompute/machines/arcNode1", + "state": "Active", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "updatedAt": "2020-01-01T17:18:19.1234567Z", + "connectionStatus": "Connected", + "connectionErrorMessage": "test", + "transcriptLocation": "test" + } + ], + "remoteSupportSessionDetails": [ + { + "sessionStartTime": "2020-01-01T17:18:19.1234567Z", + "sessionEndTime": "2020-01-01T17:18:19.1234567Z", + "nodeName": "arcNode0", + "duration": 120, + "accessLevel": "Diagnostics" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConsentAndInstallDefaultExtensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConsentAndInstallDefaultExtensions.json new file mode 100644 index 000000000000..68dd610bd3f8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ConsentAndInstallDefaultExtensions.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateArcIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateArcIdentity.json new file mode 100644 index 000000000000..fb5af5c067f8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateArcIdentity.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "arcApplicationClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "arcApplicationTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "arcApplicationObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "arcServicePrincipalObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateCluster.json new file mode 100644 index 000000000000..5e301d8da28d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateCluster.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview", + "cluster": { + "location": "East US", + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94" + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Disabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "serviceEndpoint": "https://azurestackhci.azurefd.net/eastus" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateClusterIdentity.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateClusterIdentity.json new file mode 100644 index 000000000000..224bd80efa56 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateClusterIdentity.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "aadClientId": "7b93bf67-60ac-4909-a987-ac438e69f9ba", + "aadTenantId": "bdb2c88c-9cfd-4e19-927d-51e875f6912b", + "aadServicePrincipalObjectId": "400bd05f-395f-45a6-ba75-72601df80107", + "aadApplicationObjectId": "00cc4014-482e-4de9-9932-83415cc75f45" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateHciEdgeDevice.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateHciEdgeDevice.json new file mode 100644 index 000000000000..d3fe3a47efaf --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/CreateHciEdgeDevice.json @@ -0,0 +1,257 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-09-01-preview", + "resource": { + "kind": "HCI", + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "reportedProperties": { + "deviceState": "Connected", + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ], + "hostNetwork": { + "intents": [ + { + "intentName": "managementcomputestorage", + "scope": 0, + "intentType": 14, + "isComputeIntentSet": true, + "isStorageIntentSet": true, + "isOnlyStorage": false, + "isManagementIntentSet": true, + "isStretchIntentSet": false, + "isOnlyStretch": false, + "isNetworkIntentType": true, + "intentAdapters": [ + "ethernet", + "ethernet2" + ], + "overrideVirtualSwitchConfiguration": true, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": true, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": null, + "priorityValue8021Action_SMB": null, + "bandwidthPercentage_SMB": null + }, + "overrideAdapterProperty": true, + "adapterPropertyOverrides": { + "jumboPacket": null, + "networkDirect": "0", + "networkDirectTechnology": null + } + } + ], + "storageNetworks": [ + { + "name": "StorageIntent1", + "networkAdapterName": "ethernet", + "storageVlanId": "8", + "storageAdapterIPInfo": [ + { + "physicalNode": "v-host1", + "ipv4Address": "192.168.120.192", + "subnetMask": "255.255.244.0" + } + ] + } + ], + "storageConnectivitySwitchless": false, + "enableStorageAutoIp": false + } + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "reportedProperties": { + "deviceState": "Connected", + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ], + "hostNetwork": { + "intents": [ + { + "intentName": "managementcomputestorage", + "scope": 0, + "intentType": 14, + "isComputeIntentSet": true, + "isStorageIntentSet": true, + "isOnlyStorage": false, + "isManagementIntentSet": true, + "isStretchIntentSet": false, + "isOnlyStretch": false, + "intentAdapters": [ + "ethernet", + "ethernet2" + ], + "overrideVirtualSwitchConfiguration": true, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": true, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": null, + "priorityValue8021Action_SMB": null, + "bandwidthPercentage_SMB": null + }, + "overrideAdapterProperty": true, + "adapterPropertyOverrides": { + "jumboPacket": null, + "networkDirect": "0", + "networkDirectTechnology": null + } + } + ], + "storageNetworks": [ + { + "name": "StorageIntent1", + "networkAdapterName": "ethernet", + "storageVlanId": "8", + "storageAdapterIPInfo": [ + { + "physicalNode": "v-host1", + "ipv4Address": "192.168.120.192", + "subnetMask": "255.255.244.0" + } + ] + } + ], + "storageConnectivitySwitchless": false, + "enableStorageAutoIp": false + } + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteArcSetting.json new file mode 100644 index 000000000000..ea8aeaf9796b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteArcSetting.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteCluster.json new file mode 100644 index 000000000000..095f8a8d8dbe --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteCluster.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteDeploymentSettings.json new file mode 100644 index 000000000000..624c45ed80a7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteDeploymentSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteEdgeDevices.json new file mode 100644 index 000000000000..69b0adaf173b --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteEdgeDevices.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteExtension.json new file mode 100644 index 000000000000..a48b1bf4e7ba --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteExtension.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteSecuritySettings.json new file mode 100644 index 000000000000..9f4aaab5fdea --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteSecuritySettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateRuns.json new file mode 100644 index 000000000000..5517bf0eaf98 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateRuns.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateSummaries.json new file mode 100644 index 000000000000..77d5e6534e9a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdateSummaries.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdates.json new file mode 100644 index 000000000000..68276d9741eb --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/DeleteUpdates.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_CollectLog.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_CollectLog.json new file mode 100644 index 000000000000..9476c07631b7 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_CollectLog.json @@ -0,0 +1,65 @@ +{ + "title": "EdgeDeviceJobs_CreateOrUpdate_CollectLog", + "operationId": "EdgeDeviceJobs_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "jobsName": "collectLog", + "resource": { + "properties": { + "jobType": "CollectLog", + "fromDate": "2024-01-29T10:43:27.9471574Z", + "toDate": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "jobType": "CollectLog", + "fromDate": "2024-01-29T10:43:27.9471574Z", + "toDate": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/collectLog", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "jobType": "CollectLog", + "fromDate": "2024-01-29T10:43:27.9471574Z", + "toDate": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/collectLog", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_RemoteSupport.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_RemoteSupport.json new file mode 100644 index 000000000000..0b7978117918 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_CreateOrUpdate_RemoteSupport.json @@ -0,0 +1,68 @@ +{ + "title": "EdgeDeviceJobs_CreateOrUpdate_RemoteSupport", + "operationId": "EdgeDeviceJobs_CreateOrUpdate", + "parameters": { + "api-version": "2024-09-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "jobsName": "collectLog", + "resource": { + "properties": { + "jobType": "RemoteSupport", + "accessLevel": "Diagnostics", + "type": "Enable", + "expirationTimestamp": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "jobType": "RemoteSupport", + "accessLevel": "Diagnostics", + "type": "Enable", + "expirationTimestamp": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/remoteSupport", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + }, + "201": { + "headers": { + "Azure-AsyncOperation": "https://contoso.com/operationstatus" + }, + "body": { + "properties": { + "jobType": "RemoteSupport", + "accessLevel": "Diagnostics", + "type": "Enable", + "expirationTimestamp": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/remoteSupport", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Delete.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Delete.json new file mode 100644 index 000000000000..c1c4795184d2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Delete.json @@ -0,0 +1,18 @@ +{ + "title": "EdgeDeviceJobs_Delete", + "operationId": "EdgeDeviceJobs_Delete", + "parameters": { + "api-version": "2024-09-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "lAq", + "jobsName": "Ihlm3R-bZ4vTC4ABA456" + }, + "responses": { + "202": { + "headers": { + "location": "https://contoso.com/operationstatus" + } + }, + "204": {} + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Get_RemoteSupport.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Get_RemoteSupport.json new file mode 100644 index 000000000000..2175c50686e3 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_Get_RemoteSupport.json @@ -0,0 +1,34 @@ +{ + "title": "EdgeDeviceJobs_Get_RemoteSupport", + "operationId": "EdgeDeviceJobs_Get", + "parameters": { + "api-version": "2024-09-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "-5M1G7G10OZ-o5b-HS3-c72", + "jobsName": "-oUxs" + }, + "responses": { + "200": { + "body": { + "properties": { + "jobType": "RemoteSupport", + "accessLevel": "Diagnostics", + "type": "Enable", + "expirationTimestamp": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/RemoteSupport", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_ListByEdgeDevice.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_ListByEdgeDevice.json new file mode 100644 index 000000000000..5d5dba99601d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/EdgeDeviceJobs_ListByEdgeDevice.json @@ -0,0 +1,38 @@ +{ + "title": "EdgeDeviceJobs_ListByEdgeDevice", + "operationId": "EdgeDeviceJobs_ListByEdgeDevice", + "parameters": { + "api-version": "2024-09-01-preview", + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "YE-855IEIN585-" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "jobType": "RemoteSupport", + "accessLevel": "Diagnostics", + "type": "Enable", + "expirationTimestamp": "2024-01-29T10:43:27.9471574Z" + }, + "kind": "HCI", + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default/jobs/collectLog", + "name": "collectLog", + "type": "Microsoft.AzureStackHCI/edgeDevices/jobs", + "systemData": { + "createdBy": "zsnvvvbj", + "createdByType": "User", + "createdAt": "2024-07-01T17:02:21.168Z", + "lastModifiedBy": "qxlrx", + "lastModifiedByType": "User", + "lastModifiedAt": "2024-07-01T17:02:21.168Z" + } + } + ], + "nextLink": "https://microsoft.com/alqov" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ExtendSoftwareAssuranceBenefit.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ExtendSoftwareAssuranceBenefit.json new file mode 100644 index 000000000000..149d45f9cef9 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ExtendSoftwareAssuranceBenefit.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview", + "softwareAssuranceChangeRequest": { + "properties": { + "softwareAssuranceIntent": "Enable" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "softwareAssuranceProperties": { + "softwareAssuranceStatus": "Enabled", + "lastUpdated": "2022-08-18T22:01:12.4191603Z", + "softwareAssuranceIntent": "Enable" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Extensions_Upgrade.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Extensions_Upgrade.json new file mode 100644 index 000000000000..647f8ed240ae --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/Extensions_Upgrade.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-09-01-preview", + "extensionUpgradeParameters": { + "targetVersion": "1.0.18062.0" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GeneratePassword.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GeneratePassword.json new file mode 100644 index 000000000000..7782527340af --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GeneratePassword.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "secretText": "secretText", + "startDateTime": "2022-02-17T16:24:23.6264005+05:30", + "endDateTime": "2121-02-17T16:24:23.6264377+05:30", + "keyId": "00000000-2d47-4fb2-8ed2-fed71a5c197b" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetArcSetting.json new file mode 100644 index 000000000000..60a88bf40688 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetArcSetting.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetCluster.json new file mode 100644 index 000000000000..2ae87b61207a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetCluster.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "logCollectionProperties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z", + "lastLogGenerated": "2020-01-01T17:18:19.1234567Z", + "logCollectionSessionDetails": [ + { + "logStartTime": "2020-01-01T17:18:19.1234567Z", + "logEndTime": "2020-01-01T17:18:19.1234567Z", + "timeCollected": "2020-01-01T17:18:19.1234567Z", + "logSize": 1000, + "logCollectionStatus": "Succeeded", + "correlationId": "a76ab33a-1819-4e82-1212-e3e4ec3d1425", + "endTimeCollected": "2020-01-01T17:25:19.1234567Z" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z", + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic", + "hardwareClass": "Medium" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetDeploymentSettings.json new file mode 100644 index 000000000000..d3a1964aba14 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetDeploymentSettings.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net", + "hardwareClass": "Medium" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetEdgeDevices.json new file mode 100644 index 000000000000..bedf2c0744f6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetEdgeDevices.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "deviceConfiguration": { + "nicDetails": [ + { + "adapterName": "ethernet", + "interfaceDescription": "NDIS 6.70 ", + "componentId": "VMBUS{f8615163-df3e-46c5-913f-f2d2f965ed0g} ", + "driverVersion": "10.0.20348.1547 ", + "ip4Address": "10.10.10.10", + "subnetMask": "255.255.255.0", + "defaultGateway": "10.10.10.1", + "dnsServers": [ + "100.10.10.1" + ], + "defaultIsolationId": "0" + } + ], + "deviceMetadata": "" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetExtension.json new file mode 100644 index 000000000000..43c9a2ff03d6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetExtension.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "enableAutomaticUpgrade": true, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "Azure" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetOffer.json new file mode 100644 index 000000000000..5ab918c52c15 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetOffer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetPublisher.json new file mode 100644 index 000000000000..4d0d0640e431 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetPublisher.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSecuritySettings.json new file mode 100644 index 000000000000..434942ce7710 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSecuritySettings.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSku.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSku.json new file mode 100644 index 000000000000..8b41e3433169 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetSku.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "skuName": "sku1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "publisherId": "publisher1", + "offerId": "offer1", + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateRuns.json new file mode 100644 index 000000000000..418dd3fea163 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateRuns.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateSummaries.json new file mode 100644 index 000000000000..c84c9c2099e4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdateSummaries.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdates.json new file mode 100644 index 000000000000..744b46e225aa --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/GetUpdates.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/InitializeDisableProcess.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/InitializeDisableProcess.json new file mode 100644 index 000000000000..3dc47fa0b8e8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/InitializeDisableProcess.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses", + "Retry-After": 200, + "Azure-AsyncOperation": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListArcSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListArcSettingsByCluster.json new file mode 100644 index 000000000000..eab6007bc1a1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListArcSettingsByCluster.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "PartiallyConnected", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Connected" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Disconnected" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersByResourceGroup.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersByResourceGroup.json new file mode 100644 index 000000000000..0b43ab2617be --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersByResourceGroup.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "PartiallyConnected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Disabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Disabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersBySubscription.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersBySubscription.json new file mode 100644 index 000000000000..baac9ebc3d80 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListClustersBySubscription.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg1/providers/Microsoft.AzureStackHCI/clusters/myCluster1", + "name": "myCluster1", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "NotYetRegistered", + "connectivityStatus": "NotYetRegistered", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": {}, + "trialDaysRemaining": 29, + "billingModel": "Trial" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg2/providers/Microsoft.AzureStackHCI/clusters/myCluster2", + "name": "myCluster2", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "West US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "oemActivation": "Enabled", + "nodes": [ + { + "name": "Node1", + "id": 0, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node2", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "oemActivation": "Enabled" + }, + { + "name": "Node3", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "oemActivation": "Enabled" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListDeploymentSettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListDeploymentSettingsByCluster.json new file mode 100644 index 000000000000..871ee97ff380 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListDeploymentSettingsByCluster.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListEdgeDevices.json new file mode 100644 index 000000000000..70c8f1c56fca --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListEdgeDevices.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/providers/Microsoft.AzureStackHCI/edgeDevices/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/edgeDevices", + "kind": "HCI", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "reportedProperties": { + "networkProfile": { + "nicDetails": [ + { + "adapterName": "vmanagement", + "interfaceDescription": "Hyper-V Virtual Ethernet Adapter", + "componentId": "vms_mp", + "driverVersion": "10.0.25398.1", + "ip4Address": "192.168.200.92", + "subnetMask": "255.255.255.0", + "defaultGateway": "192.168.200.1", + "dnsServers": [ + "192.168.200.222" + ], + "defaultIsolationId": "0", + "slot": "0", + "macAddress": "000000000041", + "switchName": null, + "nicType": "Virtual", + "vlanId": "0", + "nicStatus": "Up" + } + ], + "switchDetails": [ + { + "switchName": "vmanagement", + "switchType": "External" + } + ] + }, + "osProfile": { + "bootType": "UEFI", + "assemblyVersion": "2402.1" + }, + "sbeDeploymentPackageInfo": { + "code": "NewerThanLatestPublished", + "message": "The SBE package at path 'C:\\SBE' with version 4.1.2312.10 is published later than the latest SBE manifest published for online discovery. ", + "sbeManifest": "PEFwcGxpY2Fi" + } + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListExtensionsByArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListExtensionsByArcSetting.json new file mode 100644 index 000000000000..e48cf596cc7c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListExtensionsByArcSetting.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected" + } + ], + "managedBy": "Azure" + } + }, + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/Extensions/SecurityExtension", + "name": "CustomScriptExtension", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.CustomScriptExtension", + "type": "string", + "typeHandlerVersion": "1.10.3", + "autoUpgradeMinorVersion": false, + "settings": { + "scriptLocation": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/SecurityExtension", + "state": "Succeeded" + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/SecurityExtension", + "state": "Failed" + } + ], + "managedBy": "Azure" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByCluster.json new file mode 100644 index 000000000000..7e257e7ddc2a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByPublisher.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByPublisher.json new file mode 100644 index 000000000000..92466d830b9c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListOffersByPublisher.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers", + "name": "offer1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "provisioningState": "Succeeded", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListPublishersByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListPublishersByCluster.json new file mode 100644 index 000000000000..ebf9889fba93 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListPublishersByCluster.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1", + "type": "Microsoft.AzureStackHCI/clusters/publishers", + "name": "publisher1" + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSecuritySettingsByCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSecuritySettingsByCluster.json new file mode 100644 index 000000000000..1abe92ad0425 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSecuritySettingsByCluster.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSkusByOffer.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSkusByOffer.json new file mode 100644 index 000000000000..1b76a505aa48 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListSkusByOffer.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "publisherName": "publisher1", + "offerName": "offer1", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/publishers/publisher1/offers/offer1/skus/sku1", + "type": "Microsoft.AzureStackHCI/clusters/publishers/offers/skus", + "name": "sku1", + "properties": { + "content": "{\"id\":\"canonical.ubuntuserver1404lts-arm-14.04.201808140\",\"displayName\":\"Ubuntu Server 14.04 LTS\",\"publisherId\":\"Canonical\",\"publisherName\":\"Canonical\",\"type\":\"VirtualMachine\",\"version\":\"14.04.201808140\",\"properties\":{\"description\":\"Ubuntu Server 14.04.5 LTS amd64. Ubuntu Server is the world's most popular Linux for cloud environments. Updates and patches for Ubuntu 14.04 LTS will be available until 2019-04-17. Ubuntu Server is the perfect virtual machine (VM) platform for all workloads from web applications to NoSQL databases and Hadoop. For more information see <a href='http://partners.ubuntu.com/microsoft' target='_blank'>Ubuntu on Azure</a> and <a href='http://juju.ubuntu.com' target='_blank'>using Juju to deploy your workloads</a>.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking the Create button, I acknowledge that I am getting this software from Canonical and that the <a href='http://www.ubuntu.com/project/about-ubuntu/licensing' target='_blank'>legal terms</a> of Canonical apply to it. Microsoft does not provide rights for third-party software. Also see the <a href='http://www.ubuntu.com/aboutus/privacypolicy' target='_blank'>privacy statement</a> from Canonical.</p>\"},\"extendedProperties\":{\"osType\":\"Linux\",\"offer\":\"UbuntuServer\",\"offerVersion\":\"1.0.52\",\"sku\":\"14.04.5-LTS\",\"galleryItemIdentity\":\"Canonical.UbuntuServer1404LTS-ARM.1.0.52\"},\"links\":[{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]},{\"name\":[],\"uri\":[]}],\"iconUris\":{\"medium\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Medium.png\",\"wide\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Wide.png\",\"large\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Large.png\",\"small\":\"https://azstmktdfwcu001.blob.core.windows.net/icons/e5da743bb86d4d429320a75bfa5b96b8/Small.png\"},\"payloadLength\":32212288276,\"compatibility\":{\"isCompatible\":true,\"message\":\"None\",\"description\":\"None\",\"issues\":[]}}", + "contentVersion": "2018-01-01", + "publisherId": "publisher1", + "offerId": "offer1", + "skuMappings": [ + { + "catalogPlanId": "microsoftsqlserver.sql2019-ubuntu2004enterprise-arm", + "marketplaceSkuId": "enterprise", + "marketplaceSkuVersions": [ + "15.0.220208" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateRuns.json new file mode 100644 index 000000000000..22c7fbc90350 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateRuns.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateSummaries.json new file mode 100644 index 000000000000..61bc26b35315 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdateSummaries.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdates.json new file mode 100644 index 000000000000..da1b2d9372be --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ListUpdates.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": " Microsoft. AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchArcSetting.json new file mode 100644 index 000000000000..9a8a426b06a4 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchArcSetting.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": { + "properties": { + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + } + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "connectivityProperties": { + "enabled": true, + "serviceConfigurations": [ + { + "serviceName": "WAC", + "port": 6516 + } + ] + }, + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + }, + { + "category": "Supportability", + "consentTime": null + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchExtension.json new file mode 100644 index 000000000000..c8eb1c2218e2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PatchExtension.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallyConnected", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Connected", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Disconnected", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PostUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PostUpdates.json new file mode 100644 index 000000000000..42a8eba882d6 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PostUpdates.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutArcSetting.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutArcSetting.json new file mode 100644 index 000000000000..8a1c4a5aae9d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutArcSetting.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "arcSetting": {}, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "arcInstanceResourceGroup": "ArcInstance-rg", + "aggregateState": "Creating", + "perNodeDetails": [ + { + "name": "Node-1", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "state": "Creating" + }, + { + "name": "Node-2", + "arcInstance": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2", + "state": "Creating" + } + ], + "connectivityProperties": { + "enabled": false, + "serviceConfigurations": [] + }, + "defaultExtensions": [ + { + "category": "Telemetry", + "consentTime": "2023-01-01T17:18:19.1234567Z" + } + ] + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutDeploymentSettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutDeploymentSettings.json new file mode 100644 index 000000000000..500ac91b28c1 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutDeploymentSettings.json @@ -0,0 +1,730 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "deploymentSettingsName": "default", + "api-version": "2024-09-01-preview", + "resource": { + "properties": { + "operationType": "ClusterProvisioning", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net", + "hardwareClass": "Medium" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": null, + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": null, + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/deploymentSettings/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/clusters/deploymentSettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "deploymentMode": "Deploy", + "arcNodeResourceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2" + ], + "deploymentConfiguration": { + "version": "string", + "scaleUnits": [ + { + "deploymentData": { + "securitySettings": { + "hvciProtection": true, + "drtmProtection": true, + "driftControlEnforced": true, + "credentialGuardEnforced": false, + "smbSigningEnforced": true, + "smbClusterEncryption": false, + "sideChannelMitigationEnforced": true, + "bitlockerBootVolume": true, + "bitlockerDataVolumes": true, + "wdacEnforced": true + }, + "observability": { + "streamingDataClient": true, + "euLocation": false, + "episodicDataUpload": true + }, + "cluster": { + "name": "testHCICluster", + "witnessType": "Cloud", + "witnessPath": "Cloud", + "cloudAccountName": "myasestoragacct", + "azureServiceEndpoint": "core.windows.net" + }, + "storage": { + "configurationMode": "Express" + }, + "namingPrefix": "ms169", + "domainFqdn": "ASZ1PLab8.nttest.microsoft.com", + "infrastructureNetwork": [ + { + "subnetMask": "255.255.248.0", + "gateway": "255.255.248.0", + "ipPools": [ + { + "startingAddress": "10.57.48.60", + "endingAddress": "10.57.48.66" + } + ], + "dnsServers": [ + "10.57.50.90" + ] + } + ], + "physicalNodes": [ + { + "name": "ms169host", + "ipv4Address": "10.57.51.224" + }, + { + "name": "ms154host", + "ipv4Address": "10.57.53.236" + } + ], + "hostNetwork": { + "intents": [ + { + "name": "Compute_Management", + "trafficType": [ + "Compute", + "Management" + ], + "adapter": [ + "Port2" + ], + "overrideVirtualSwitchConfiguration": false, + "virtualSwitchConfigurationOverrides": { + "enableIov": "True", + "loadBalancingAlgorithm": "HyperVPort" + }, + "overrideQosPolicy": false, + "qosPolicyOverrides": { + "priorityValue8021Action_Cluster": "7", + "priorityValue8021Action_SMB": "3", + "bandwidthPercentage_SMB": "50" + }, + "overrideAdapterProperty": false, + "adapterPropertyOverrides": { + "jumboPacket": "1514", + "networkDirect": "Enabled", + "networkDirectTechnology": "iWARP" + } + } + ], + "storageNetworks": [ + { + "name": "Storage1Network", + "networkAdapterName": "Port3", + "vlanId": "5", + "storageAdapterIPInfo": [ + { + "physicalNode": "string", + "ipv4Address": "10.57.48.60", + "subnetMask": "255.255.248.0" + } + ] + } + ], + "storageConnectivitySwitchless": true, + "enableStorageAutoIp": false + }, + "sdnIntegration": { + "networkController": { + "macAddressPoolStart": "00-0D-3A-1B-C7-21", + "macAddressPoolStop": "00-0D-3A-1B-C7-29", + "networkVirtualizationEnabled": true + } + }, + "adouPath": "OU=ms169,DC=ASZ1PLab8,DC=nttest,DC=microsoft,DC=com", + "secretsLocation": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-xxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/vaults/abcd123", + "secrets": [ + { + "secretName": "cluster1-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "BMCAdminUserCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-BmcAdminUser-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + }, + { + "secretName": "cluster2-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "AzureStackLCMUserCredential", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-AzureStackLCMUserCredential-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4c" + } + ], + "optionalServices": { + "customLocation": "customLocationName" + } + }, + "sbePartnerInfo": { + "sbeDeploymentInfo": { + "version": "4.0.2309.13", + "family": "Gen5", + "publisher": "Contoso", + "sbeManifestSource": "default", + "sbeManifestCreationDate": "2023-07-25T02:40:33Z" + }, + "partnerProperties": [ + { + "name": "EnableBMCIpV6", + "value": "false" + }, + { + "name": "PhoneHomePort", + "value": "1653" + }, + { + "name": "BMCSecurityState", + "value": "HighSecurity" + } + ], + "credentialList": [ + { + "secretName": "cluster1-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63", + "eceSecretName": "DownloadConnectorCred", + "secretLocation": "https://sclusterkvnirhci35.vault.azure.net/secrets/cluster-34232342-DownloadConnectorCred-f5bcc1d9-23af-4ae9-aca1-041d0f593a63/9276354aabfc492fa9b2cdbefb54ae4b" + } + ] + } + } + ] + }, + "reportedProperties": { + "validationStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10" + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ] + } + ] + } + ] + }, + "deploymentStatus": { + "status": "Error", + "steps": [ + { + "fullStepIndex": "0", + "name": "Cloud Deployment", + "description": "Deploy Cloud.", + "startTimeUtc": "2023-06-09T00:08:19", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [ + { + "fullStepIndex": "0.1", + "name": "Before Cloud Deployment", + "description": "Before Cloud Deployment", + "startTimeUtc": "2023-06-09T00:08:23", + "endTimeUtc": "2023-06-09T01:10:10", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + }, + { + "fullStepIndex": "0.36", + "name": "Clean up temporary content", + "description": "Clean up temporary content", + "startTimeUtc": "2023-06-09T03:58:37", + "endTimeUtc": "2023-06-09T04:01:47", + "status": "Error", + "exception": [ + "exception1", + "exception2" + ], + "steps": [] + } + ] + } + ] + } + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutExtension.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutExtension.json new file mode 100644 index 000000000000..9abf70869a6a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutExtension.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "arcSettingName": "default", + "extensionName": "MicrosoftMonitoringAgent", + "extension": { + "properties": { + "extensionParameters": { + "publisher": "Microsoft.Compute", + "typeHandlerVersion": "1.10", + "type": "MicrosoftMonitoringAgent", + "enableAutomaticUpgrade": false, + "settings": { + "workspaceId": "xx" + }, + "protectedSettings": { + "workspaceKey": "xx" + } + } + } + }, + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/arcSettings/default/extensions/MicrosoftMonitoringAgent", + "name": "MicrosoftMonitoringAgent", + "type": "Microsoft.AzureStackHCI/clusters/arcSettings/extensions", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "extensionParameters": { + "publisher": "Microsoft.Compute", + "type": "string", + "typeHandlerVersion": "1.10.3", + "enableAutomaticUpgrade": false, + "autoUpgradeMinorVersion": false, + "settings": { + "workspaceId": "xx" + } + }, + "aggregateState": "PartiallySucceeded", + "perNodeExtensionDetails": [ + { + "name": "Node-1", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/Extensions/MicrosoftMonitoringAgent", + "state": "Succeeded", + "typeHandlerVersion": "1.10.0", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.0", + "status": { + "code": "success", + "level": "Information", + "displayStatus": "Provisioning succeeded", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + }, + { + "name": "Node-2", + "extension": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/Extensions/MicrosoftMonitoringAgent", + "state": "Failed", + "typeHandlerVersion": "1.10.3", + "instanceView": { + "name": "MicrosoftMonitoringAgent", + "type": "MicrosoftMonitoringAgent", + "typeHandlerVersion": "1.10.3", + "status": { + "code": "error", + "level": "Error", + "displayStatus": "Provisioning failed", + "message": "Finished executing command, StdOut: , StdErr:", + "time": "2019-08-08T20:42:10.999Z" + } + } + } + ], + "managedBy": "User" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutSecuritySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutSecuritySettings.json new file mode 100644 index 000000000000..8d612a27c886 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutSecuritySettings.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "securitySettingsName": "default", + "api-version": "2024-09-01-preview", + "resource": { + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster/securitySettings/default", + "type": "Microsoft.AzureStackHCI/clusters/securitySettings", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + }, + "properties": { + "securedCoreComplianceAssignment": "Audit", + "wdacComplianceAssignment": "ApplyAndAutoCorrect", + "smbEncryptionForIntraClusterTrafficComplianceAssignment": "Audit", + "securityComplianceStatus": { + "securedCoreCompliance": "Compliant", + "wdacCompliance": "Compliant", + "dataAtRestEncrypted": "Compliant", + "dataInTransitProtected": "Compliant", + "lastUpdated": "2023-11-14T07:09:44.771Z" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateRuns.json new file mode 100644 index 000000000000..66d39c2d135d --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateRuns.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "updateRunName": "23b779ba-0d52-4a80-8571-45ca74664ec3", + "api-version": "2024-09-01-preview", + "updateRunsProperties": { + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32/updateRuns/23b779ba-0d52-4a80-8571-45ca74664ec3", + "name": "Microsoft4.2203.2.32/23b779ba-0d52-4a80-8571-45ca74664ec3", + "type": "Microsoft.AzureStackHCI/updates/updateRuns", + "location": "West US", + "properties": { + "progress": { + "name": "Unnamed step", + "description": "Update Azure Stack.", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "lastUpdatedTimeUtc": "2022-04-06T13:58:42.969006+00:00", + "steps": [ + { + "name": "PreUpdate Cloud", + "description": "Prepare for SSU update", + "errorMessage": "", + "status": "Success", + "startTimeUtc": "2022-04-06T01:36:33.3876751+00:00", + "endTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "lastUpdatedTimeUtc": "2022-04-06T01:37:16.8728314+00:00", + "steps": [] + } + ] + } + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateSummaries.json new file mode 100644 index 000000000000..072b1d2e5f48 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdateSummaries.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview", + "updateLocationProperties": { + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "lastChecked": "2022-04-07T18:04:07Z", + "currentVersion": "4.2203.2.32", + "lastUpdated": "2022-04-06T14:08:18.254Z", + "state": "AppliedSuccessfully" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updateSummaries/default", + "name": "default", + "type": "Microsoft.AzureStackHCI/updateSummaries", + "location": "West US", + "properties": { + "oemFamily": "DellEMC", + "hardwareModel": "PowerEdge R730xd", + "packageVersions": [ + { + "packageType": "OEM", + "version": "2.2.2108.6", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Services", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + }, + { + "packageType": "Infrastructure", + "version": "4.2203.2.32", + "lastUpdated": "2022-04-07T18:04:07Z" + } + ], + "currentVersion": "4.2203.2.32", + "state": "AppliedSuccessfully" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdates.json new file mode 100644 index 000000000000..42bb61175623 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/PutUpdates.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "b8d594e5-51f3-4c11-9c54-a7771b81c712", + "resourceGroupName": "testrg", + "clusterName": "testcluster", + "updateName": "Microsoft4.2203.2.32", + "api-version": "2024-09-01-preview", + "updateProperties": { + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/b8d594e5-51f3-4c11-9c54-a7771b81c712/resourceGroups/testrg/providers/Microsoft.AzureStackHCI/clusters/testcluster/updates/Microsoft4.2203.2.32", + "name": "Microsoft4.2203.2.32", + "type": "Microsoft.AzureStackHCI/updates", + "location": "West US", + "properties": { + "installedDate": "2022-04-06T14:08:18.254Z", + "description": "AzS Update 4.2203.2.32", + "state": "Installed", + "prerequisites": [ + { + "updateType": "update type", + "version": "prerequisite version", + "packageName": "update package name" + } + ], + "packagePath": "\\\\SU1FileServer\\SU1_Infrastructure_2\\Updates\\Packages\\Microsoft4.2203.2.32", + "packageSizeInMb": 18858, + "displayName": "AzS Update - 4.2203.2.32", + "version": "4.2203.2.32", + "publisher": "Microsoft", + "releaseLink": "https://docs.microsoft.com/azure-stack/operator/release-notes?view=azs-2203", + "availabilityType": "Local", + "packageType": "Infrastructure", + "updateStateProperties": { + "notifyMessage": "Brief message with instructions for updates of AvailabilityType Notify", + "progressPercentage": 0 + }, + "additionalProperties": "additional properties" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/TriggerLogCollection.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/TriggerLogCollection.json new file mode 100644 index 000000000000..a1bf0297a6ad --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/TriggerLogCollection.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "mycluster", + "api-version": "2024-09-01-preview", + "logCollectionRequest": { + "properties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z" + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "tags": {}, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "cloudId": "a3c0468f-e38e-4dda-ac48-817f620536f0", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "24a6e53d-04e5-44d2-b7cc-1b732a847dfc", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "logCollectionProperties": { + "fromDate": "2020-01-01T17:18:19.1234567Z", + "toDate": "2021-01-01T17:18:19.1234567Z", + "lastLogGenerated": "2020-01-01T17:18:19.1234567Z", + "logCollectionSessionDetails": [ + { + "logStartTime": "2020-01-01T17:18:19.1234567Z", + "logEndTime": "2020-01-01T17:18:19.1234567Z", + "timeCollected": "2020-01-01T17:18:19.1234567Z", + "logSize": 1000, + "logCollectionStatus": "Succeeded", + "correlationId": "a76ab33a-1819-4e82-1212-e3e4ec3d1425", + "logCollectionJobType": "OnDemand", + "endTimeCollected": "2020-01-01T17:25:19.1234567Z" + } + ] + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "nodeType": "ThirdParty", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128 + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UpdateCluster.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UpdateCluster.json new file mode 100644 index 000000000000..e0b44cf37d6f --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UpdateCluster.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview", + "cluster": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + } + }, + "identity": { + "type": "SystemAssigned" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.AzureStackHCI/clusters/myCluster", + "name": "myCluster", + "type": "Microsoft.AzureStackHCI/clusters", + "location": "East US", + "identity": { + "principalId": "87a834db-2e45-409e-911b-e16a44562ec3", + "tenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "type": "SystemAssigned" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "provisioningState": "Succeeded", + "status": "ConnectedRecently", + "connectivityStatus": "Connected", + "cloudId": "91c2b355-4826-4e96-9164-e3f26dcf1cdd", + "cloudManagementEndpoint": "https://98294836-31be-4668-aeae-698667faf99b.waconazure.com", + "aadClientId": "515da1c2-379e-49b4-9975-09e3e40c86be", + "aadTenantId": "7e589cc1-a8b6-4dff-91bd-5ec0fa18db94", + "desiredProperties": { + "windowsServerSubscription": "Enabled", + "diagnosticLevel": "Basic" + }, + "isolatedVmAttestationConfiguration": { + "attestationResourceId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/test-rg/providers/Microsoft.Attestation/attestationProviders/testmaa", + "relyingPartyServiceEndpoint": "https://azurestackhci.azurefd.net/eastus", + "attestationServiceEndpoint": "https://dantestnoauth01.eus.attest.azure.net" + }, + "reportedProperties": { + "clusterName": "cluster1", + "clusterId": "a76ac23a-1819-4e82-9410-e3e4ec3d1425", + "clusterVersion": "10.0.17777", + "clusterType": "ThirdParty", + "manufacturer": "Dell Inc.", + "nodes": [ + { + "name": "Node1", + "id": 1, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q45CZC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node2", + "id": 2, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44BSC3", + "coreCount": 8, + "memoryInGiB": 128, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + }, + { + "name": "Node3", + "id": 3, + "windowsServerSubscription": "Enabled", + "manufacturer": "Dell Inc.", + "model": "EMC AX740", + "osName": "Azure Stack HCI", + "osVersion": "10.0.17777.1061", + "serialNumber": "Q44RFC3", + "coreCount": 16, + "memoryInGiB": 256, + "lastLicensingTimestamp": "2020-03-11T19:24:42.1946017Z" + } + ], + "lastUpdated": "2020-03-11T19:24:42.1946017Z", + "imdsAttestation": "Disabled", + "diagnosticLevel": "Basic" + }, + "trialDaysRemaining": 30, + "billingModel": "Trial", + "registrationTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastSyncTimestamp": "2020-03-11T20:44:32.5625121Z", + "lastBillingTimestamp": "2020-03-12T08:12:55.2312022Z" + } + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UploadCertificate.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UploadCertificate.json new file mode 100644 index 000000000000..20b1c543c1d2 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/UploadCertificate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "fd3c3665-1729-4b7b-9a38-238e83b0f98b", + "resourceGroupName": "test-rg", + "clusterName": "myCluster", + "api-version": "2024-09-01-preview", + "uploadCertificateRequest": { + "properties": { + "certificates": [ + "base64cert", + "base64cert" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ValidateEdgeDevices.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ValidateEdgeDevices.json new file mode 100644 index 000000000000..445af6c845b0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/examples/ValidateEdgeDevices.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceUri": "subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1", + "edgeDeviceName": "default", + "api-version": "2024-09-01-preview", + "ValidateRequest": { + "edgeDeviceIds": [ + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-1/edgeDevices/default", + "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/ArcInstance-rg/providers/Microsoft.HybridCompute/machines/Node-2/edgeDevices/default" + ], + "additionalInfo": "test" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://foo.com/operationStatuses" + } + }, + "200": { + "body": { + "status": "success" + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/extensions.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/extensions.json new file mode 100644 index 000000000000..3f6820db1988 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/extensions.json @@ -0,0 +1,707 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions": { + "get": { + "operationId": "Extensions_ListByArcSetting", + "description": "List all Extensions under ArcSetting resource.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExtensionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Extensions under ArcSetting resource": { + "$ref": "./examples/ListExtensionsByArcSetting.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}": { + "get": { + "operationId": "Extensions_Get", + "description": "Get particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get ArcSettings Extension": { + "$ref": "./examples/GetExtension.json" + } + } + }, + "put": { + "operationId": "Extensions_Create", + "description": "Create Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create Arc Extension": { + "$ref": "./examples/PutExtension.json" + } + } + }, + "patch": { + "operationId": "Extensions_Update", + "description": "Update Extension for HCI cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extension", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionPatch" + }, + "description": "Details of the Machine Extension to be created." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Extension" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "original-uri" + }, + "x-ms-examples": { + "Update Arc Extension": { + "$ref": "./examples/PatchExtension.json" + } + } + }, + "delete": { + "operationId": "Extensions_Delete", + "description": "Delete particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "OK" + }, + "204": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete Arc Extension": { + "$ref": "./examples/DeleteExtension.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade": { + "post": { + "operationId": "Extensions_Upgrade", + "description": "Upgrade a particular Arc Extension of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ArcSettingNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "name": "extensionUpgradeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExtensionUpgradeParameters" + }, + "description": "Parameters supplied to the Upgrade Extensions operation." + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Upgrade Machine Extensions": { + "$ref": "./examples/Extensions_Upgrade.json" + } + } + } + } + }, + "definitions": { + "Extension": { + "description": "Details of a particular extension in HCI Cluster.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Describes Machine Extension Properties.", + "$ref": "#/definitions/ExtensionProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionPatch": { + "description": "Extension Details to update", + "type": "object", + "properties": { + "properties": { + "description": "Describes Machine Extension Properties that can be updated.", + "$ref": "#/definitions/ExtensionPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "ExtensionProperties": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Extension proxy resource.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Failed", + "Canceled", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "extensionParameters": { + "description": "Parameters specific to this extension type.", + "$ref": "#/definitions/ExtensionParameters", + "x-ms-client-flatten": true + }, + "aggregateState": { + "description": "Aggregate state of Arc Extensions across the nodes in this HCI cluster.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning", + "UpgradeFailedRollbackSucceeded" + ], + "x-ms-enum": { + "name": "ExtensionAggregateState", + "modelAsString": true + }, + "readOnly": true + }, + "perNodeExtensionDetails": { + "description": "State of Arc Extension in each of the nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/PerNodeExtensionState" + }, + "readOnly": true + }, + "managedBy": { + "description": "Indicates if the extension is managed by azure or the user.", + "type": "string", + "enum": [ + "Azure", + "User" + ], + "x-ms-enum": { + "name": "ExtensionManagedBy", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "ExtensionPatchProperties": { + "description": "Describes Machine Extension Properties that can be updated.", + "type": "object", + "properties": { + "extensionParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "$ref": "#/definitions/ExtensionPatchParameters" + } + } + }, + "ExtensionPatchParameters": { + "description": "Describes the properties of a Machine Extension that can be updated.", + "type": "object", + "properties": { + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler. Latest version would be used if not specified." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + } + } + }, + "PerNodeExtensionState": { + "description": "Status of Arc Extension for a particular node in HCI Cluster.", + "type": "object", + "properties": { + "name": { + "description": "Name of the node in HCI Cluster.", + "type": "string", + "readOnly": true + }, + "extension": { + "description": "Fully qualified resource ID for the particular Arc Extension on this node.", + "type": "string", + "readOnly": true + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler.", + "readOnly": true + }, + "state": { + "description": "State of Arc Extension in this node.", + "type": "string", + "enum": [ + "NotSpecified", + "Error", + "Succeeded", + "Canceled", + "Failed", + "Connected", + "Disconnected", + "Deleted", + "Creating", + "Updating", + "Deleting", + "Moving", + "PartiallySucceeded", + "PartiallyConnected", + "InProgress", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "NodeExtensionState", + "modelAsString": true + }, + "readOnly": true + }, + "instanceView": { + "$ref": "#/definitions/ExtensionInstanceView", + "description": "The extension instance view.", + "readOnly": true + } + } + }, + "ExtensionList": { + "description": "List of Extensions in HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Extensions in HCI cluster.", + "type": "array", + "items": { + "$ref": "#/definitions/Extension" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ExtensionParameters": { + "description": "Describes the properties of a Machine Extension. This object mirrors the definition in HybridCompute.", + "type": "object", + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler. Latest version would be used if not specified." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "Protected settings (may contain secrets).", + "x-ms-secret": true + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available." + } + } + }, + "ExtensionInstanceView": { + "type": "object", + "description": "Describes the Extension Instance View.", + "properties": { + "name": { + "type": "string", + "description": "The extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"MicrosoftMonitoringAgent\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "type": "object", + "description": "Instance view status.", + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": true + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + } + } + } + }, + "ExtensionUpgradeParameters": { + "type": "object", + "description": "Describes the parameters for Extension upgrade.", + "properties": { + "targetVersion": { + "type": "string", + "description": "Extension Upgrade Target Version." + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ArcSettingNameParameter": { + "name": "arcSettingName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proxy resource holding details of HCI ArcSetting information.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the machine extension.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/hciCommon.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/hciCommon.json new file mode 100644 index 000000000000..4d1be9f22e09 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/hciCommon.json @@ -0,0 +1,417 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureStackHCI Common", + "version": "2024-09-01-preview", + "description": "Azure Stack HCI common Rest API spec definitions." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [], + "paths": {}, + "definitions": { + "DeploymentMode": { + "type": "string", + "description": "The deployment mode of EnterpriseCloudEngine(ECE) action for a cluster.", + "enum": [ + "Validate", + "Deploy" + ], + "default": "Deploy", + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": true, + "values": [ + { + "name": "Validate", + "value": "Validate", + "description": "Validate ECE action deployment for a cluster." + }, + { + "name": "Deploy", + "value": "Deploy", + "description": "Deploy ECE action deployment for a cluster." + } + ] + } + }, + "EceReportedProperties": { + "type": "object", + "description": "The DeploymentStatus of AzureStackHCI Cluster.", + "properties": { + "validationStatus": { + "$ref": "#/definitions/EceActionStatus", + "description": "validation status of AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "deploymentStatus": { + "$ref": "#/definitions/EceActionStatus", + "description": "Deployment status of AzureStackHCI Cluster Deployment.", + "readOnly": true + } + } + }, + "EceActionStatus": { + "type": "object", + "description": "The ECE action plan deployment status for AzureStackHCI Cluster.", + "properties": { + "status": { + "type": "string", + "description": "Status of ECE action AzureStackHCI Cluster Deployment.", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "NotSpecified", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "readOnly": true, + "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": "NotSpecified", + "value": "NotSpecified", + "description": "The resource provision state is not specified" + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "EceDeploymentSecrets": { + "type": "object", + "description": "Protected parameters list stored in keyvault.", + "properties": { + "secretName": { + "type": "string", + "description": "Secret name stored in keyvault." + }, + "eceSecretName": { + "$ref": "#/definitions/EceSecrets", + "description": "Secret name expected for Enterprise Cloud Engine (ECE) deployment." + }, + "secretLocation": { + "type": "string", + "format": "uri", + "description": "Secret URI stored in keyvault." + } + } + }, + "EceSecrets": { + "type": "string", + "description": "Secret names allowed for Enterprise Cloud Engine (ECE) deployment.", + "enum": [ + "AzureStackLCMUserCredential", + "DefaultARBApplication", + "LocalAdminCredential", + "WitnessStorageKey" + ], + "x-ms-enum": { + "name": "EceSecrets", + "modelAsString": true, + "values": [ + { + "name": "AzureStackLCMUserCredential", + "value": "AzureStackLCMUserCredential", + "description": "AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster." + }, + { + "name": "DefaultARBApplication", + "value": "DefaultARBApplication", + "description": "DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster." + }, + { + "name": "LocalAdminCredential", + "value": "LocalAdminCredential", + "description": "LocalAdminCredential used for admin operations for AzureStackHCI cluster." + }, + { + "name": "WitnessStorageKey", + "value": "WitnessStorageKey", + "description": "WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster." + } + ] + } + }, + "DeploymentStep": { + "type": "object", + "description": "The Step of AzureStackHCI Cluster.", + "properties": { + "name": { + "type": "string", + "description": "Name of step.", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of step.", + "readOnly": true + }, + "fullStepIndex": { + "type": "string", + "description": "FullStepIndex of step.", + "readOnly": true + }, + "startTimeUtc": { + "type": "string", + "description": "Start time of step.", + "readOnly": true + }, + "endTimeUtc": { + "type": "string", + "description": "End time of step.", + "readOnly": true + }, + "status": { + "type": "string", + "description": "Status of step. Allowed values are 'Error', 'Success', 'InProgress'", + "readOnly": true + }, + "steps": { + "type": "array", + "description": "List of nested steps of AzureStackHCI Cluster Deployment.", + "items": { + "$ref": "#/definitions/DeploymentStep" + }, + "readOnly": true, + "x-ms-identifiers": [] + }, + "exception": { + "type": "array", + "description": "List of exceptions in AzureStackHCI Cluster Deployment.", + "items": { + "type": "string" + }, + "readOnly": true, + "x-ms-identifiers": [] + } + } + }, + "PrecheckResult": { + "type": "object", + "properties": { + "name": { + "description": "Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer.", + "type": "string" + }, + "displayName": { + "description": "The health check DisplayName localized of the individual test executed.", + "type": "string" + }, + "tags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object", + "properties": { + "key": { + "description": "Key that allow grouping/filtering individual tests.", + "type": "string" + }, + "value": { + "description": "Value of the key that allow grouping/filtering individual tests.", + "type": "string" + } + } + }, + "healthCheckTags": { + "description": "Key-value pairs that allow grouping/filtering individual tests.", + "type": "object" + }, + "title": { + "description": "User-facing name; one or more sentences indicating the direct issue.", + "type": "string" + }, + "status": { + "description": "The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + }, + "severity": { + "description": "Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity.", + "type": "string", + "enum": [ + "Critical", + "Warning", + "Informational", + "Hidden" + ], + "x-ms-enum": { + "name": "severity", + "modelAsString": true + } + }, + "description": { + "description": "Detailed overview of the issue and what impact the issue has on the stamp.", + "type": "string" + }, + "remediation": { + "description": "Set of steps that can be taken to resolve the issue found.", + "type": "string" + }, + "targetResourceID": { + "description": "The unique identifier for the affected resource (such as a node or drive).", + "type": "string" + }, + "targetResourceName": { + "description": "The name of the affected resource.", + "type": "string" + }, + "targetResourceType": { + "description": "The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring).", + "type": "string" + }, + "timestamp": { + "description": "The time in which the HealthCheck was called.", + "type": "string", + "format": "date-time" + }, + "additionalData": { + "description": "Property bag of key value pairs for additional information.", + "type": "string" + }, + "healthCheckSource": { + "description": "The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster).", + "type": "string" + } + } + }, + "EdgeDeviceKind": { + "type": "string", + "description": "Edge device kind.", + "enum": [ + "HCI" + ], + "default": "HCI", + "x-ms-enum": { + "name": "EdgeDeviceKind", + "modelAsString": true, + "values": [ + { + "name": "HCI", + "value": "HCI", + "description": "Arc-enabled edge device with HCI OS." + } + ] + } + }, + "HardwareClass": { + "type": "string", + "description": "Hardware class of the cluster.", + "enum": [ + "Small", + "Medium", + "Large" + ], + "default": "Medium", + "x-ms-enum": { + "name": "HardwareClass", + "modelAsString": true, + "values": [ + { + "name": "Small", + "value": "Small", + "description": "The hardware class is small." + }, + { + "name": "Medium", + "value": "Medium", + "description": "The hardware class is medium. This corresponds to the default" + }, + { + "name": "Large", + "value": "Large", + "description": "The hardware class is large." + } + ] + } + } + }, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/offers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/offers.json new file mode 100644 index 000000000000..ae9d024b6050 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/offers.json @@ -0,0 +1,302 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers": { + "get": { + "operationId": "Offers_ListByPublisher", + "description": "List Offers available for a publisher within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by publisher for the HCI Cluster": { + "$ref": "./examples/ListOffersByPublisher.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers": { + "get": { + "operationId": "Offers_ListByCluster", + "description": "List Offers available across publishers for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfferList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Offer resources by HCI Cluster": { + "$ref": "./examples/ListOffersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}": { + "get": { + "operationId": "Offers_Get", + "description": "Get Offer resource details within a publisher of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Offer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Offer": { + "$ref": "./examples/GetOffer.json" + } + } + } + } + }, + "definitions": { + "OfferList": { + "description": "List of Offer proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Offer proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Offer" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Offer": { + "description": "Offer details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Offer properties.", + "$ref": "#/definitions/OfferProperties", + "x-ms-client-flatten": true + } + } + }, + "OfferProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/publishers.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/publishers.json new file mode 100644 index 000000000000..066115f47bf5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/publishers.json @@ -0,0 +1,188 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers": { + "get": { + "operationId": "Publishers_ListByCluster", + "description": "List Publishers available for the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublisherList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publisher resources by HCI Cluster": { + "$ref": "./examples/ListPublishersByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}": { + "get": { + "operationId": "Publishers_Get", + "description": "Get Publisher resource details of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Publisher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Publisher": { + "$ref": "./examples/GetPublisher.json" + } + } + } + } + }, + "definitions": { + "PublisherList": { + "description": "List of Publisher proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of Publisher proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Publisher" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Publisher": { + "description": "Publisher details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Publisher properties.", + "$ref": "#/definitions/PublisherProperties", + "x-ms-client-flatten": true + } + } + }, + "PublisherProperties": { + "description": "Publisher properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/securitySettings.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/securitySettings.json new file mode 100644 index 000000000000..3f604a1648a0 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/securitySettings.json @@ -0,0 +1,502 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureStackHCI", + "version": "2024-09-01-preview", + "description": "Azure Stack HCI cluster security settings." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "SecuritySettings" + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings": { + "get": { + "operationId": "SecuritySettings_ListByClusters", + "tags": [ + "SecuritySettings" + ], + "description": "List SecuritySetting resources by Clusters", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySettingListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Security Settings": { + "$ref": "./examples/ListSecuritySettingsByCluster.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}": { + "get": { + "operationId": "SecuritySettings_Get", + "tags": [ + "SecuritySettings" + ], + "description": "Get a SecuritySetting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Security Settings": { + "$ref": "./examples/GetSecuritySettings.json" + } + } + }, + "put": { + "operationId": "SecuritySettings_CreateOrUpdate", + "tags": [ + "SecuritySettings" + ], + "description": "Create a security setting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + } + ], + "responses": { + "200": { + "description": "Resource 'SecuritySetting' update operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "201": { + "description": "Resource 'SecuritySetting' create operation succeeded", + "schema": { + "$ref": "#/definitions/SecuritySetting" + }, + "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": { + "Create Security Settings": { + "$ref": "./examples/PutSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "SecuritySettings_Delete", + "tags": [ + "SecuritySettings" + ], + "description": "Delete a SecuritySetting", + "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" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "securitySettingsName", + "in": "path", + "description": "Name of security setting", + "required": true, + "type": "string", + "default": "default", + "pattern": "^[a-zA-Z0-9-]{3,24}$" + } + ], + "responses": { + "202": { + "description": "Resource deletion accepted.", + "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." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Security Settings": { + "$ref": "./examples/DeleteSecuritySettings.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ComplianceAssignmentType": { + "type": "string", + "description": "Represents the compliance assignment type of a resource.", + "enum": [ + "Audit", + "ApplyAndAutoCorrect" + ], + "x-ms-enum": { + "name": "ComplianceAssignmentType", + "modelAsString": true, + "values": [ + { + "name": "Audit", + "value": "Audit", + "description": "Report on the state of the machine, but don't make changes." + }, + { + "name": "ApplyAndAutoCorrect", + "value": "ApplyAndAutoCorrect", + "description": "Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation." + } + ] + } + }, + "ComplianceStatus": { + "type": "string", + "description": "Represents the compliance status of a resource.", + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ], + "x-ms-enum": { + "name": "ComplianceStatus", + "modelAsString": true, + "values": [ + { + "name": "Compliant", + "value": "Compliant", + "description": "The resource is compliant" + }, + { + "name": "NonCompliant", + "value": "NonCompliant", + "description": "The resource is non-compliant" + }, + { + "name": "Pending", + "value": "Pending", + "description": "The resource compliance status is pending" + } + ] + } + }, + "ProvisioningState": { + "type": "string", + "description": "The provisioning state of a resource.", + "readOnly": true, + "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": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is updating" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "SecurityComplianceStatus": { + "type": "object", + "description": "Security compliance properties of the resource", + "properties": { + "securedCoreCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts meets secured-core server requirements.", + "readOnly": true + }, + "wdacCompliance": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI hosts have enforced consistent Windows Defender Application Control.", + "readOnly": true + }, + "dataAtRestEncrypted": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes.", + "readOnly": true + }, + "dataInTransitProtected": { + "$ref": "#/definitions/ComplianceStatus", + "description": "Indicates whether HCI cluster has data in-transit protection.", + "readOnly": true + }, + "lastUpdated": { + "type": "string", + "format": "date-time", + "description": "Time in UTC when compliance status was last updated.", + "readOnly": true + } + } + }, + "SecurityProperties": { + "type": "object", + "description": "Security properties of the resource", + "properties": { + "securedCoreComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "Secured Core Compliance Assignment", + "default": "Audit" + }, + "wdacComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "WDAC Compliance Assignment", + "default": "Audit" + }, + "smbEncryptionForIntraClusterTrafficComplianceAssignment": { + "$ref": "#/definitions/ComplianceAssignmentType", + "description": "SMB encryption for intra-cluster traffic Compliance Assignment", + "default": "Audit" + }, + "securityComplianceStatus": { + "$ref": "#/definitions/SecurityComplianceStatus", + "description": "Security Compliance Status", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation." + } + } + }, + "SecuritySetting": { + "type": "object", + "description": "Security settings proxy resource", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityProperties", + "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/ProxyResource" + } + ] + }, + "SecuritySettingListResult": { + "type": "object", + "description": "The response of a SecuritySetting list operation.", + "properties": { + "value": { + "type": "array", + "description": "The SecuritySetting items on this page", + "items": { + "$ref": "#/definitions/SecuritySetting" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/skus.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/skus.json new file mode 100644 index 000000000000..72e1d472af4a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/skus.json @@ -0,0 +1,275 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus": { + "get": { + "operationId": "Skus_ListByOffer", + "description": "List Skus available for a offer within the HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List SKU resources by offer for the HCI Cluster": { + "$ref": "./examples/ListSkusByOffer.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}": { + "get": { + "operationId": "Skus_Get", + "description": "Get SKU resource details within a offer of HCI Cluster.", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PublisherNameParameter" + }, + { + "$ref": "#/parameters/OfferNameParameter" + }, + { + "$ref": "#/parameters/SkuNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ODataExpandParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Sku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Sku": { + "$ref": "./examples/GetSku.json" + } + } + } + } + }, + "definitions": { + "SkuList": { + "description": "List of SKU proxy resources for the HCI cluster.", + "type": "object", + "properties": { + "value": { + "description": "List of SKU proxy resources.", + "type": "array", + "items": { + "$ref": "#/definitions/Sku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "description": "Sku details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SKU properties.", + "$ref": "#/definitions/SkuProperties", + "x-ms-client-flatten": true + } + } + }, + "SkuProperties": { + "description": "SKU properties.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning State", + "type": "string", + "readOnly": true + }, + "publisherId": { + "type": "string", + "description": "Identifier of the Publisher for the offer" + }, + "offerId": { + "type": "string", + "description": "Identifier of the Offer for the sku" + }, + "content": { + "type": "string", + "description": "JSON serialized catalog content of the sku offer" + }, + "contentVersion": { + "type": "string", + "description": "The API version of the catalog service used to serve the catalog content" + }, + "skuMappings": { + "type": "array", + "description": "Array of SKU mappings", + "items": { + "$ref": "#/definitions/SkuMappings" + }, + "x-ms-identifiers": [] + } + } + }, + "SkuMappings": { + "description": "SKU Mapping details.", + "type": "object", + "properties": { + "catalogPlanId": { + "type": "string", + "description": "Identifier of the CatalogPlan for the sku" + }, + "marketplaceSkuId": { + "type": "string", + "description": "Identifier for the sku" + }, + "marketplaceSkuVersions": { + "type": "array", + "description": "Array of SKU versions available", + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "PublisherNameParameter": { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the publisher available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "OfferNameParameter": { + "name": "offerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the offer available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "SkuNameParameter": { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SKU available within HCI cluster.", + "x-ms-parameter-location": "method" + }, + "ODataExpandParameter": { + "name": "$expand", + "in": "query", + "description": "Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateRuns.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateRuns.json new file mode 100644 index 000000000000..f67833c1e44a --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateRuns.json @@ -0,0 +1,412 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns": { + "get": { + "operationId": "UpdateRuns_List", + "description": "List all Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRunList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List Update runs under cluster resource": { + "$ref": "./examples/ListUpdateRuns.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}": { + "delete": { + "operationId": "UpdateRuns_Delete", + "description": "Delete specified Update Run", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateRuns.json" + } + } + }, + "put": { + "operationId": "UpdateRuns_Put", + "description": "Put Update runs for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateRunsProperties", + "in": "body", + "description": "Properties of the updateRuns object", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateRun" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/PutUpdateRuns.json" + } + } + }, + "get": { + "operationId": "UpdateRuns_Get", + "description": "Get the Update run for a specified update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "#/parameters/UpdateRunNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update runs under cluster resource": { + "$ref": "./examples/GetUpdateRuns.json" + } + } + } + } + }, + "definitions": { + "UpdateRunList": { + "description": "List of Update runs", + "type": "object", + "properties": { + "value": { + "description": "List of Update runs", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateRun" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateRun": { + "description": "Details of an Update run", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Describes Update Run Properties.", + "$ref": "#/definitions/UpdateRunProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateRunProperties": { + "description": "Details of an Update run", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateRuns proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "timeStarted": { + "description": "Timestamp of the update run was started.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTime": { + "description": "Timestamp of the most recently completed step in the update run.", + "type": "string", + "format": "date-time" + }, + "duration": { + "description": "Duration of the update run.", + "type": "string" + }, + "state": { + "description": "State of the update run.", + "type": "string", + "enum": [ + "Unknown", + "Succeeded", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "name": "updateRunPropertiesState", + "modelAsString": true + } + }, + "progress": { + "description": "Progress representation of the update run steps.", + "$ref": "#/definitions/Step", + "x-ms-client-flatten": true + } + } + }, + "Step": { + "description": "Progress representation of the update run steps.", + "type": "object", + "properties": { + "name": { + "description": "Name of the step.", + "type": "string" + }, + "description": { + "description": "More detailed description of the step.", + "type": "string" + }, + "errorMessage": { + "description": "Error message, specified if the step is in a failed state.", + "type": "string" + }, + "status": { + "description": "Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.", + "type": "string" + }, + "startTimeUtc": { + "description": "When the step started, or empty if it has not started executing.", + "type": "string", + "format": "date-time" + }, + "endTimeUtc": { + "description": "When the step reached a terminal state.", + "type": "string", + "format": "date-time" + }, + "lastUpdatedTimeUtc": { + "description": "Completion time of this step or the last completed sub-step.", + "type": "string", + "format": "date-time" + }, + "expectedExecutionTime": { + "description": "Expected execution time of a given step. This is optionally authored in the update action plan and can be empty.", + "type": "string" + }, + "steps": { + "description": "Recursive model for child steps of this step.", + "type": "array", + "items": { + "$ref": "#/definitions/Step" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + }, + "UpdateRunNameParameter": { + "name": "updateRunName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update Run", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateSummaries.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateSummaries.json new file mode 100644 index 000000000000..06075fc8a7d8 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updateSummaries.json @@ -0,0 +1,408 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries": { + "get": { + "operationId": "UpdateSummaries_List", + "description": "List all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummariesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/ListUpdateSummaries.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default": { + "delete": { + "operationId": "UpdateSummaries_Delete", + "description": "Delete Update Summaries", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdateSummaries.json" + } + } + }, + "put": { + "operationId": "UpdateSummaries_Put", + "description": "Put Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateLocationProperties", + "in": "body", + "description": "Properties of the UpdateSummaries resource", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Update summaries under cluster resource": { + "$ref": "./examples/PutUpdateSummaries.json" + } + } + }, + "get": { + "operationId": "UpdateSummaries_Get", + "description": "Get all Update summaries under the HCI cluster", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateSummaries" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Update summaries under cluster resource": { + "$ref": "./examples/GetUpdateSummaries.json" + } + } + } + } + }, + "definitions": { + "UpdateSummariesList": { + "description": "List of Update Summaries", + "type": "object", + "properties": { + "value": { + "description": "List of Update Summaries", + "type": "array", + "items": { + "$ref": "#/definitions/UpdateSummaries" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateSummaries": { + "description": "Get the update summaries for the cluster", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update summaries properties", + "type": "object", + "$ref": "#/definitions/UpdateSummariesProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummariesProperties": { + "description": "Properties of Update summaries", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the UpdateSummaries proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "oemFamily": { + "description": "OEM family name.", + "type": "string" + }, + "currentOemVersion": { + "description": "Current OEM Version.", + "type": "string" + }, + "hardwareModel": { + "description": "Name of the hardware model.", + "type": "string" + }, + "packageVersions": { + "description": "Current version of each updatable component.", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "currentVersion": { + "description": "Current Solution Bundle version of the stamp.", + "type": "string" + }, + "currentSbeVersion": { + "description": "Current Sbe version of the stamp.", + "type": "string" + }, + "lastUpdated": { + "description": "Last time an update installation completed successfully.", + "type": "string", + "format": "date-time" + }, + "lastChecked": { + "description": "Last time the update service successfully checked for updates", + "type": "string", + "format": "date-time" + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of pre-check result objects.", + "type": "array", + "items": { + "$ref": "./hciCommon.json#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "name" + ] + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "state": { + "description": "Overall update state of the stamp.", + "type": "string", + "enum": [ + "Unknown", + "AppliedSuccessfully", + "UpdateAvailable", + "UpdateInProgress", + "UpdateFailed", + "NeedsAttention", + "PreparationInProgress", + "PreparationFailed" + ], + "x-ms-enum": { + "name": "updateSummariesPropertiesState", + "modelAsString": true + } + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updates.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updates.json new file mode 100644 index 000000000000..5be9ab63088c --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/preview/2024-09-01-preview/updates.json @@ -0,0 +1,577 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply": { + "post": { + "operationId": "Updates_Post", + "description": "Apply Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/PostUpdates.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates": { + "get": { + "operationId": "Updates_List", + "description": "List all Updates", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "List available updates": { + "$ref": "./examples/ListUpdates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}": { + "delete": { + "operationId": "Updates_Delete", + "description": "Delete specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED", + "headers": { + "Azure-AsyncOperation": { + "description": "URL to query for status of the operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Delete an Update": { + "$ref": "./examples/DeleteUpdates.json" + } + } + }, + "put": { + "operationId": "Updates_Put", + "description": "Put specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateProperties", + "in": "body", + "description": "Properties of the Updates object", + "required": true, + "schema": { + "$ref": "#/definitions/Update" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put a specific update": { + "$ref": "./examples/PutUpdates.json" + } + } + }, + "get": { + "operationId": "Updates_Get", + "description": "Get specified Update", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/UpdateNameParameter" + }, + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Update" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get a specific update": { + "$ref": "./examples/GetUpdates.json" + } + } + } + } + }, + "definitions": { + "UpdateList": { + "description": "List of Updates", + "type": "object", + "properties": { + "value": { + "description": "List of Updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdatePrerequisite": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "object", + "properties": { + "updateType": { + "description": "Updatable component type.", + "type": "string" + }, + "version": { + "description": "Version of the prerequisite.", + "type": "string" + }, + "packageName": { + "description": "Friendly name of the prerequisite.", + "type": "string" + } + } + }, + "Update": { + "description": "Update details", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "properties": { + "description": "Update properties", + "type": "object", + "$ref": "#/definitions/UpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Details of a singular Update in HCI Cluster", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Updates proxy resource.", + "type": "string", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Accepted", + "Provisioning" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "installedDate": { + "description": "Date that the update was installed.", + "type": "string", + "format": "date-time" + }, + "description": { + "description": "Description of the update.", + "type": "string" + }, + "minSbeVersionRequired": { + "description": "Minimum Sbe Version of the update.", + "type": "string" + }, + "state": { + "description": "State of the update as it relates to this stamp.", + "type": "string", + "enum": [ + "HasPrerequisite", + "Obsolete", + "Ready", + "NotApplicableBecauseAnotherUpdateIsInProgress", + "Preparing", + "Installing", + "Installed", + "PreparationFailed", + "InstallationFailed", + "Invalid", + "Recalled", + "Downloading", + "DownloadFailed", + "HealthChecking", + "HealthCheckFailed", + "ReadyToInstall", + "ScanInProgress", + "ScanFailed", + "AdditionalContentRequired" + ], + "x-ms-enum": { + "name": "state", + "modelAsString": true + } + }, + "prerequisites": { + "description": "If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.", + "type": "array", + "items": { + "$ref": "#/definitions/UpdatePrerequisite" + }, + "x-ms-identifiers": [ + "packageName" + ] + }, + "componentVersions": { + "description": "An array of component versions for a Solution Bundle update, and an empty array otherwise. ", + "type": "array", + "items": { + "$ref": "#/definitions/PackageVersionInfo" + }, + "x-ms-client-flatten": true, + "x-ms-identifiers": [ + "version" + ] + }, + "rebootRequired": { + "type": "object", + "$ref": "#/definitions/RebootRequirement", + "x-ms-client-flatten": true + }, + "healthState": { + "description": "Overall health state for update-specific health checks.", + "type": "object", + "$ref": "#/definitions/HealthState", + "x-ms-client-flatten": true + }, + "healthCheckResult": { + "description": "An array of PrecheckResult objects.", + "type": "array", + "items": { + "$ref": "./hciCommon.json#/definitions/PrecheckResult" + }, + "x-ms-client-flatten": true + }, + "healthCheckDate": { + "description": "Last time the package-specific checks were run.", + "type": "string", + "format": "date-time" + }, + "packagePath": { + "description": "Path where the update package is available.", + "type": "string" + }, + "packageSizeInMb": { + "description": "Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.", + "type": "number" + }, + "displayName": { + "description": "Display name of the Update", + "type": "string" + }, + "version": { + "description": "Version of the update.", + "type": "string" + }, + "publisher": { + "description": "Publisher of the update package.", + "type": "string" + }, + "releaseLink": { + "description": "Link to release notes for the update.", + "type": "string" + }, + "availabilityType": { + "description": "Indicates the way the update content can be downloaded.", + "type": "string", + "enum": [ + "Local", + "Online", + "Notify" + ], + "x-ms-enum": { + "name": "availabilityType", + "modelAsString": true + } + }, + "packageType": { + "description": "Customer-visible type of the update.", + "type": "string" + }, + "additionalProperties": { + "description": "Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.", + "type": "string" + }, + "updateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "$ref": "#/definitions/UpdateStateProperties", + "x-ms-client-flatten": true + } + } + }, + "UpdateStateProperties": { + "description": "Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.", + "type": "object", + "properties": { + "progressPercentage": { + "description": "Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.", + "type": "number" + }, + "notifyMessage": { + "description": "Brief message with instructions for updates of AvailabilityType Notify.", + "type": "string" + } + } + }, + "PackageVersionInfo": { + "description": "Current version of each updatable component.", + "type": "object", + "properties": { + "packageType": { + "description": "Package type", + "type": "string" + }, + "version": { + "description": "Package version", + "type": "string" + }, + "lastUpdated": { + "description": "Last time this component was updated.", + "type": "string", + "format": "date-time" + } + } + }, + "RebootRequirement": { + "type": "string", + "enum": [ + "Unknown", + "True", + "False" + ], + "x-ms-enum": { + "name": "RebootRequirement", + "modelAsString": true + } + }, + "HealthState": { + "type": "string", + "enum": [ + "Unknown", + "Success", + "Failure", + "Warning", + "Error", + "InProgress" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true + } + } + }, + "parameters": { + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "UpdateNameParameter": { + "name": "updateName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Update", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md index b90952eb42c6..ba0cc06b1b80 100644 --- a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/readme.md @@ -29,7 +29,7 @@ title: AzureStackHCIClient description: Azure Stack HCI management service openapi-type: arm openapi-subtype: rpaas -tag: package-2024-04 +tag: package-preview-2024-09 directive: - from: edgeDevices.json @@ -107,6 +107,7 @@ suppressions: - deploymentSettings.json - edgeDevices.json - securitySettings.json + - edgeDeviceJobs.json - code: ResourceNameRestriction reason: ClusterName didn't have a pattern initially, adding the constraint now will cause a breaking change @@ -183,6 +184,7 @@ suppressions: reason: already working without the properties section, adding it will break polymorphism from: - edgeDevices.json + - edgeDeviceJobs.json - code: XmsPageableForListCalls reason: already used in GA api version, fixing it will cause breaking change @@ -228,8 +230,35 @@ suppressions: - code: TopLevelResourcesListBySubscription reason: It is reporting issue for proxy extension resource which doesn't have use case to ListBySubscription as this resource will always tied to one parent resource only. Additionally, there is a 1:1 relationship between HybridCompute Machines and AzureStackHCI VirtualMachineInstances. + + - code: PatchBodyParametersSchema + from: + - clusters.json + reason: Making the body optional now would cause a breaking change in backward compatibility ``` +### Tag: package-preview-2024-09 + +These settings apply only when `--tag=package-preview-2024-09` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-09' +input-file: + - preview/2024-09-01-preview/arcSettings.json + - preview/2024-09-01-preview/clusters.json + - preview/2024-09-01-preview/deploymentSettings.json + - preview/2024-09-01-preview/edgeDevices.json + - preview/2024-09-01-preview/edgeDeviceJobs.json + - preview/2024-09-01-preview/extensions.json + - preview/2024-09-01-preview/hciCommon.json + - preview/2024-09-01-preview/offers.json + - ../operations/preview/2024-09-01-preview/operations.json + - preview/2024-09-01-preview/publishers.json + - preview/2024-09-01-preview/securitySettings.json + - preview/2024-09-01-preview/skus.json + - preview/2024-09-01-preview/updateRuns.json + - preview/2024-09-01-preview/updateSummaries.json + - preview/2024-09-01-preview/updates.json +``` ### Tag: package-2024-04 diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/examples/ListOperations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/examples/ListOperations.json new file mode 100644 index 000000000000..d28dbae03fd5 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/examples/ListOperations.json @@ -0,0 +1,453 @@ +{ + "parameters": { + "api-version": "2024-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureStackHCI/Register/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Register", + "operation": "Registers the Azure Stack HCI Resource Provider", + "description": "Registers the subscription for the Azure Stack HCI resource provider and enables the creation of Azure Stack HCI resources." + } + }, + { + "name": "Microsoft.AzureStackHCI/Unregister/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Unregister", + "operation": "Unregisters the Azure Stack HCI Resource Provider", + "description": "Unregisters the subscription for the Azure Stack HCI resource provider." + } + }, + { + "name": "Microsoft.AzureStackHCI/Operations/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Operations", + "operation": "Gets/List operations resources", + "description": "Gets operations" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Gets/List cluster resources", + "description": "Gets clusters" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Create/update cluster resources", + "description": "Creates or updates a cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters", + "operation": "Deletes cluster resource", + "description": "Deletes cluster resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Gets/List arc resources", + "description": "Gets arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Create/Update arc resources", + "description": "Create or updates arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings", + "operation": "Delete arc resources", + "description": "Delete arc resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Gets/List extension resources of HCI cluster", + "description": "Gets extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Create/Update extension resources of HCI cluster", + "description": "Create or update extension resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/ArcSettings/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/ArcSettings/Extensions", + "operation": "Delete extension resources of HCI cluster", + "description": "Delete extension resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Restart/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Restarts virtual machine resource", + "description": "Restarts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Start/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Starts virtual machine resource", + "description": "Starts virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Stop/Action", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Stops virtual machine resource", + "description": "Stops virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Deletes virtual machine resource", + "description": "Deletes virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Creates/Updates virtual machine resource", + "description": "Creates/Updates virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines", + "operation": "Gets/Lists virtual machine resource", + "description": "Gets/Lists virtual machine resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Deletes virtual networks resource", + "description": "Deletes virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Creates/Updates virtual networks resource", + "description": "Creates/Updates virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualNetworks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualNetworks", + "operation": "Gets/Lists virtual networks resource", + "description": "Gets/Lists virtual networks resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Deletes virtual hard disk resource", + "description": "Deletes virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Creates/Updates virtual hard disk resource", + "description": "Creates/Updates virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualHardDisks/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualHardDisks", + "operation": "Gets/Lists virtual hard disk resource", + "description": "Gets/Lists virtual hard disk resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Deletes network interfaces resource", + "description": "Deletes network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Creates/Updates network interfaces resource", + "description": "Creates/Updates network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/NetworkInterfaces/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "NetworkInterfaces", + "operation": "Gets/Lists network interfaces resource", + "description": "Gets/Lists network interfaces resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Deletes gallery images resource", + "description": "Deletes gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Creates/Updates gallery images resource", + "description": "Creates/Updates gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/GalleryImages/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "GalleryImages", + "operation": "Gets/Lists gallery images resource", + "description": "Gets/Lists gallery images resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/HybridIdentityMetadata/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/HybridIdentityMetadata", + "operation": "Gets/Lists virtual machine hybrid identity metadata proxy resource", + "description": "Gets/Lists virtual machine hybrid identity metadata proxy resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Gets/Lists virtual machine extensions resource", + "description": "Gets/Lists virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Creates/Updates virtual machine extensions resource", + "description": "Creates/Updates virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/VirtualMachines/Extensions/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "VirtualMachines/Extensions", + "operation": "Deletes virtual machine extensions resource", + "description": "Deletes virtual machine extensions resource" + } + }, + { + "name": "Microsoft.AzureStackHCI/RegisteredSubscriptions/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "RegisteredSubscriptions", + "operation": "Gets/Lists registered subscriptions", + "description": "Reads registered subscriptions" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Gets/List available updates for HCI cluster", + "description": "Gets available updates for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Create/Update updates resource of HCI cluster", + "description": "Create or update updates resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates", + "operation": "Delete updates resources of HCI cluster", + "description": "Delete updates resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Gets/List available update summaries for HCI cluster", + "description": "Gets available update summaries for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Create/Update update summaries resource of HCI cluster", + "description": "Create or update update summaries resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/UpdateSummaries/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/UpdateSummaries", + "operation": "Delete updates resource summaries of HCI cluster", + "description": "Delete update summaries resources of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Read", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Gets/List available update runs for HCI cluster", + "description": "Gets available update runs for HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Write", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Create/Update update runs resource of HCI cluster", + "description": "Create or update update runs resource of HCI cluster" + } + }, + { + "name": "Microsoft.AzureStackHCI/Clusters/Updates/UpdateRuns/Delete", + "isDataAction": false, + "display": { + "provider": "Microsoft.AzureStackHCI", + "resource": "Clusters/Updates/UpdateRuns", + "operation": "Delete updates resource runs of HCI cluster", + "description": "Delete update runs resources of HCI cluster" + } + } + ] + } + } + } +} diff --git a/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/operations.json b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/operations.json new file mode 100644 index 000000000000..a1212f643042 --- /dev/null +++ b/specification/azurestackhci/resource-manager/Microsoft.AzureStackHCI/operations/preview/2024-09-01-preview/operations.json @@ -0,0 +1,73 @@ +{ + "swagger": "2.0", + "info": { + "version": "2024-09-01-preview", + "title": "AzureStackHCI", + "description": "Azure Stack HCI management service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AzureStackHCI/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "Create cluster": { + "$ref": "./examples/ListOperations.json" + } + }, + "description": "List all available Microsoft.AzureStackHCI provider operations", + "parameters": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": {}, + "parameters": {} +} diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index 9fb318fb8aa7..a36734a911d3 100644 --- a/specification/azurestackhci/resource-manager/readme.md +++ b/specification/azurestackhci/resource-manager/readme.md @@ -476,7 +476,6 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml index 84e49712c877..68a5c0790282 100644 --- a/specification/azurestackhci/resource-manager/sdk-suppressions.yaml +++ b/specification/azurestackhci/resource-manager/sdk-suppressions.yaml @@ -78,6 +78,25 @@ suppressions: azure-sdk-for-python: - package: 'azure-mgmt-azurestackhci' breaking-changes: + - Deleted or renamed function `patch_sdk` + - Model `ArcSetting` deleted or renamed its instance variable `created_at` + - Model `ArcSetting` deleted or renamed its instance variable `created_by_type` + - Model `ArcSetting` deleted or renamed its instance variable `created_by` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_at` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_by_type` + - Model `ArcSetting` deleted or renamed its instance variable `last_modified_by` + - Model `Cluster` deleted or renamed its instance variable `created_at` + - Model `Cluster` deleted or renamed its instance variable `created_by_type` + - Model `Cluster` deleted or renamed its instance variable `created_by` + - Model `Cluster` deleted or renamed its instance variable `last_modified_at` + - Model `Cluster` deleted or renamed its instance variable `last_modified_by_type` + - Model `Cluster` deleted or renamed its instance variable `last_modified_by` + - Model `Extension` deleted or renamed its instance variable `created_at` + - Model `Extension` deleted or renamed its instance variable `created_by_type` + - Model `Extension` deleted or renamed its instance variable `created_by` + - Model `Extension` deleted or renamed its instance variable `last_modified_at` + - Model `Extension` deleted or renamed its instance variable `last_modified_by_type` + - Model `Extension` deleted or renamed its instance variable `last_modified_by` - Model ArcSetting no longer has parameter created_at - Model ArcSetting no longer has parameter created_by - Model ArcSetting no longer has parameter created_by_type From 9ce76c4f113368361dac4de5d0a71eb058602756 Mon Sep 17 00:00:00 2001 From: ZiWei Chen <98569699+kazrael2119@users.noreply.github.com> Date: Mon, 14 Oct 2024 15:03:53 +0800 Subject: [PATCH 098/101] add typespec-ts config for computeschedule (#30999) Co-authored-by: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> --- .../ComputeSchedule.Management/tspconfig.yaml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml index 0c5a91d3e011..58f71a97c3cf 100644 --- a/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml +++ b/specification/computeschedule/ComputeSchedule.Management/tspconfig.yaml @@ -24,6 +24,17 @@ options: flavor: "azure" namespace: "com.azure.resourcemanager.computeschedule" service-name: "Compute Schedule" + "@azure-tools/typespec-ts": + azureSdkForJs: true + isModularLibrary: true + generateMetadata: true + hierarchyClient: false + experimentalExtensibleEnums: true + enableOperationGroup: true + package-dir: "arm-computeschedule" + flavor: "azure" + packageDetails: + name: "@azure/arm-computeschedule" linter: extends: - "@azure-tools/typespec-azure-rulesets/resource-manager" From 3e8105665a8c485415a1c697c12ad72293f51504 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= <audunn@netapp.com> Date: Mon, 14 Oct 2024 14:28:17 +0000 Subject: [PATCH 099/101] [NetAppFiles] Release netapp microsoft.net app 2024 05 01 (#30268) * Copy files from stable/2024-03-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-05-01 Updated the API version from stable/2024-03-01 to stable/2024-05-01. * Added tag for 2024-05-01 in readme file * pretty new version * pretty new version * cspell * external replication descriptions * FilePathAvailabilityRequest add availabilityZone --- cSpell.json | 1 + .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../2024-05-01/examples/Accounts_Delete.json | 16 + .../2024-05-01/examples/Accounts_Get.json | 36 + .../2024-05-01/examples/Accounts_List.json | 24 + .../examples/Accounts_RenewCredentials.json | 17 + .../2024-05-01/examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../2024-05-01/examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../2024-05-01/examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + .../2024-05-01/examples/Pools_Delete.json | 17 + .../stable/2024-05-01/examples/Pools_Get.json | 28 + .../2024-05-01/examples/Pools_List.json | 30 + .../2024-05-01/examples/Pools_Update.json | 34 + .../2024-05-01/examples/QuotaLimits_Get.json | 21 + .../2024-05-01/examples/QuotaLimits_List.json | 87 + .../2024-05-01/examples/RegionInfo.json | 20 + .../2024-05-01/examples/RegionInfos_Get.json | 33 + .../2024-05-01/examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../2024-05-01/examples/Snapshots_Create.json | 31 + .../2024-05-01/examples/Snapshots_Delete.json | 20 + .../2024-05-01/examples/Snapshots_Get.json | 26 + .../2024-05-01/examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../2024-05-01/examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../2024-05-01/examples/Subvolumes_Get.json | 24 + .../2024-05-01/examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeExternalReplication.json | 23 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../2024-05-01/examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeExternalReplication.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../2024-05-01/examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../2024-05-01/examples/Volumes_List.json | 35 + .../examples/Volumes_ListReplications.json | 27 + .../examples/Volumes_PeerExternalCluster.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../2024-05-01/examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../2024-05-01/examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../2024-05-01/examples/Volumes_Update.json | 43 + .../stable/2024-05-01/netapp.json | 9723 +++++++++++++++++ .../netapp/resource-manager/readme.md | 11 +- 102 files changed, 16429 insertions(+), 1 deletion(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PeerExternalCluster.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/netapp.json diff --git a/cSpell.json b/cSpell.json index 1f9bdecc35a2..d8d1099b9235 100644 --- a/cSpell.json +++ b/cSpell.json @@ -471,6 +471,7 @@ "filename": "**/specification/netapp/**/*.json", "words": [ "SVMs", + "SVM's", "kibibytes" ] }, diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..e532bf341ff7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..071e7c2fa4fb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..2ea95f857a11 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..f0bfc6b98617 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_List.json new file mode 100644 index 000000000000..afb6618fabca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..e5be46f8a57e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..f3429c252ceb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..ea56bc1f4034 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..b9c9ddae36d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..8b355a4c4e75 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..df613360e3e2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..059992f46bf8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..775a4d64a181 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..054cb85c1404 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..3460b9988e11 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_List.json new file mode 100644 index 000000000000..026cde4bd654 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..3fda80c5038d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..e4e8b9bab59a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..c2120e3ae2dd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..f427253c5cdc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..6e450d1391e6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..a51f004b960f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..db45de06fb2c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..aae8c6336d7b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..453778cc779f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..895272b26b43 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..72c76915b5d0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..a737bd5e0663 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..4212454db2bd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..587b6878f8f6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..68bbeb1c6375 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/OperationList.json new file mode 100644 index 000000000000..b90809d328a0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..1b39b67ad0a0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..ed0438012d69 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Get.json new file mode 100644 index 000000000000..608836629770 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_List.json new file mode 100644 index 000000000000..0c53c4f232c4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Update.json new file mode 100644 index 000000000000..eafaaa59d167 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..8eb25d7c9812 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..6b192e38d6e8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfo.json new file mode 100644 index 000000000000..71e923646776 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..821f02615dcf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_List.json new file mode 100644 index 000000000000..7aa9bdc5992e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..3b8bf547b2a7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..35c3b647c454 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..589708930ef6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..1bb6fca4d25f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..4873b7da41c6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..d86e11c90590 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..b54f89fe5a62 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..f72f72fdbce5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..465debf04195 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..e14ddc0b88b6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..1871d1c43d88 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..411fd6dfe10a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..95fd7304c04d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..bdcc9eba687b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..21877a638f02 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_List.json new file mode 100644 index 000000000000..b2f2476d2e79 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..6af2ecbaed25 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..bc5b8a234e81 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..52d497a4aa4c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..e4d9b64734ed --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..43b964af1917 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..0869d546dfb9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..c01489ecdecd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..4e9b6b985f07 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..4b8e5f92b728 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..5b1c5e6b65c8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..4d6741fcd1b3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..65c86ee0befc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..a1e4fde3ef72 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..9700a0fb4318 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..b3828ff00618 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeExternalReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..cd999dec7d58 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..ad0c00b34a0e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..c7db32d8aac4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..380afa6125be --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..732ec5384f19 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..5e47a6bd0438 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..6e1d424eff8f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeExternalReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..5e47a6bd0438 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..32a312446c28 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..5cc98960f885 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..1e506d9be82c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_List.json new file mode 100644 index 000000000000..04d56e441de5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..9a75c0332efd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..00839a4ffda7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PeerExternalCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "peerIpAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..1291fcb20cca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..af9aff3fe142 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..ef51fb773960 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..5e47a6bd0438 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..d4e1a93fbf41 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..9cf8c70e69b5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..897bd4810ce3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..1291fcb20cca --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..5e47a6bd0438 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..f8022074348c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..5e47a6bd0438 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..a628ee11ee02 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/netapp.json new file mode 100644 index 000000000000..169889a98466 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-05-01/netapp.json @@ -0,0 +1,9723 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-05-01", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the external cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerExternalCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerExternalCluster": { + "$ref": "examples/Volumes_PeerExternalCluster.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_AuthorizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_AuthorizeExternalReplication": { + "$ref": "examples/Volumes_AuthorizeExternalReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeExternalReplication": { + "$ref": "examples/Volumes_FinalizeExternalReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "<code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "<code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "description": "kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot" + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy Resource ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "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." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "DefaultUserQuota" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running <wmic useraccount where name='user-name' get sid>", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if <code>clusterPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about svm peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if <code>svmPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source Cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerIpAddresses" + ], + "properties": { + "peerIpAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the On-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + } + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index b94ccc36f8fd..e6d75f9f34b5 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-2024-03 +tag: package-2024-05 +``` + +### Tag: package-2024-05 + +These settings apply only when `--tag=package-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-2024-05' +input-file: + - Microsoft.NetApp/stable/2024-05-01/netapp.json ``` ### Tag: package-2024-03 From eb55e604dc7ee5de41155bb304028af51a11d2d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= <audunn@netapp.com> Date: Mon, 14 Oct 2024 14:58:41 +0000 Subject: [PATCH 100/101] [NetAppFiles] Release netapp microsoft.net app 2024 05 01 preview (#30299) * Copy files from preview/2024-03-01-preview Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2024-05-01-preview Updated the API version from preview/2024-03-01-preview to preview/2024-05-01-preview. * Added tag for 2024-05-01-preview in readme file * pretty version * update * rename migrateEncryption to Transition * rename migrateEncryption to Transition * casling * rename migrateEncryption to Transition 2 * rename migrateEncryption to Transition 2 spelling * empty --- cSpell.json | 7 +- .../examples/Accounts_ChangeKeyVault.json | 26 + .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../examples/Accounts_Delete.json | 16 + .../examples/Accounts_Get.json | 36 + ...Accounts_GetChangeKeyVaultInformation.json | 15 + .../examples/Accounts_List.json | 24 + .../examples/Accounts_RenewCredentials.json | 17 + .../Accounts_TransitionEncryptionKey.json | 20 + .../examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + .../examples/Pools_Delete.json | 17 + .../examples/Pools_Get.json | 28 + .../examples/Pools_List.json | 30 + .../examples/Pools_Update.json | 34 + .../examples/QuotaLimits_Get.json | 21 + .../examples/QuotaLimits_List.json | 87 + .../examples/RegionInfo.json | 20 + .../examples/RegionInfos_Get.json | 33 + .../examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../examples/Snapshots_Create.json | 31 + .../examples/Snapshots_Delete.json | 20 + .../examples/Snapshots_Get.json | 26 + .../examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../examples/Subvolumes_Get.json | 24 + .../examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeExternalReplication.json | 23 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeExternalReplication.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../examples/Volumes_List.json | 35 + .../examples/Volumes_ListQuotaReport.json | 40 + .../examples/Volumes_ListReplications.json | 27 + .../examples/Volumes_PeerExternalCluster.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../examples/Volumes_SplitClone.json | 17 + .../examples/Volumes_Update.json | 43 + .../preview/2024-05-01-preview/netapp.json | 10657 ++++++++++++++++ .../netapp/resource-manager/readme.md | 10 +- 107 files changed, 17483 insertions(+), 4 deletions(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_ChangeKeyVault.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_TransitionEncryptionKey.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListQuotaReport.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PeerExternalCluster.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_SplitClone.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/netapp.json diff --git a/cSpell.json b/cSpell.json index d8d1099b9235..cc1518a8a13d 100644 --- a/cSpell.json +++ b/cSpell.json @@ -472,7 +472,8 @@ "words": [ "SVMs", "SVM's", - "kibibytes" + "kibibytes", + "transitiontocmk" ] }, { @@ -1054,7 +1055,7 @@ "words": [ "HanaScaleoutContainer" ] - }, + }, { "filename": "**/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2021-10-15/iotdps.json", "words": [ @@ -1372,7 +1373,7 @@ "efgyghrtguk", "Elong", "emaccess", - "ENCHIPHERMENT", + "ENCHIPHERMENT", "ENIs", "FARGAT", "Fargate", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_ChangeKeyVault.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_ChangeKeyVault.json new file mode 100644 index 000000000000..7dce2e343e33 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_ChangeKeyVault.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "keyVaultUri": "https://my-key-vault.managedhsm.azure.net", + "keyName": "rsakey", + "keyVaultResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "keyVaultPrivateEndpoints": [ + { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..ffbd1a09ae06 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..730fd55146a8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Delete.json new file mode 100644 index 000000000000..6bd9592c0d2d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Get.json new file mode 100644 index 000000000000..9c32b8eb01f4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json new file mode 100644 index 000000000000..8a898842d515 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_GetChangeKeyVaultInformation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_List.json new file mode 100644 index 000000000000..0ea838f8a632 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..f1717aff8c70 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_TransitionEncryptionKey.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_TransitionEncryptionKey.json new file mode 100644 index 000000000000..21b112832e1d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_TransitionEncryptionKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "virtualNetworkId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1", + "privateEndpointId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privip1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Update.json new file mode 100644 index 000000000000..b0e677f7a38e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-05-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..9c3831dbf2eb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..297dd8eb630b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..2c9b1d8fa275 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..9bb951e3550a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..d0be4028e33a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-05-01-preview", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..387ba0ea0c57 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..bdead3e4f07c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..bd8ef488f17b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_List.json new file mode 100644 index 000000000000..dc563b1e7d83 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..2b5aabeeed75 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01-preview", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..150f3166ce32 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..111d93e7ad26 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01-preview", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..be374c090b53 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..0d8594cea16e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..43e268e380f3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..b7ba2ccbc044 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01-preview", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..94798a02417b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..82c38395979d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..a4255b79ab39 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..b58dd188545d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..565aea89d3a5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..84b80aa25c95 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..8174767c0107 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..ecc5d8e3410c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..be1cea5ee276 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..25e68d36194b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Delete.json new file mode 100644 index 000000000000..24b0178208db --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Get.json new file mode 100644 index 000000000000..8490303d201f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_List.json new file mode 100644 index 000000000000..502e30a6239d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_List.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Update.json new file mode 100644 index 000000000000..8dea95b1a13b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..877074dbcecf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..671f6b75c6af --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfo.json new file mode 100644 index 000000000000..6c4dc0b834e0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..d0cea7ec6776 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_List.json new file mode 100644 index 000000000000..57af35624b9f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..d3f749146695 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..09c726ce55af --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..41dfd06da186 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..289a0b1c7aa4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..576ec8f815be --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..24a48e026067 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-05-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Create.json new file mode 100644 index 000000000000..cc18aad315b5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01-preview", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..ccf8af41df29 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Get.json new file mode 100644 index 000000000000..244136966973 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_List.json new file mode 100644 index 000000000000..7cd6b974740e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..97bf82aba96f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01-preview", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Update.json new file mode 100644 index 000000000000..a3aa9ad65de1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..416b8f6a0eb7 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..1e85ca1efe92 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..f7f1b1fac8a9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_List.json new file mode 100644 index 000000000000..a26298fa96a5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..7314e44b1cdf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..ac88b786ca3e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-05-01-preview", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..05f3b5ac6558 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..f9144e603213 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01-preview", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..fba0939ed351 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..7c784a186aaa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..1815c9ff14b2 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..27492ad63ea0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..deca72b4e5e6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..0babd33f2cb8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01-preview", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..e0cd24a81798 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..07fadd39f909 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..fdf5594728c5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..1d006e23ae8f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-05-01-preview", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..fff177fbfe86 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeExternalReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..6bdae47ed4e4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..12864fcdcb73 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..cfd9ba161776 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..f9401bf7580e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Delete.json new file mode 100644 index 000000000000..0d6841aa3002 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..3489a144453b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..c44082bd6bfb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeExternalReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..ea10563ad83b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-03-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Get.json new file mode 100644 index 000000000000..01dddbe4cbdf --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..1f937f45d2c5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..12e1e8fb5616 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_List.json new file mode 100644 index 000000000000..eaad2acee01a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListQuotaReport.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListQuotaReport.json new file mode 100644 index 000000000000..d845b5b16e21 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListQuotaReport.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "quotaType": "IndividualUserQuota", + "quotaTarget": "1013", + "quotaLimitTotalInKiBs": 204914688, + "quotaLimitUsedInKiBs": 8192, + "percentageUsed": 5.0, + "isDerivedQuota": false + }, + { + "quotaType": "IndividualGroupQuota", + "quotaTarget": "1012", + "quotaLimitTotalInKiBs": 204914688, + "quotaLimitUsedInKiBs": 8192, + "percentageUsed": 5.0, + "isDerivedQuota": false + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..4108f19d0688 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..1561d111789c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PeerExternalCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "peerIpAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..9e02a72425b3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..7a662310c144 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..8b0f07300bb1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..3489a144453b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..0c90d7dd457f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..743d14295e5d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..d5ce43bcac02 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..9e02a72425b3 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..3489a144453b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Revert.json new file mode 100644 index 000000000000..0bea15049558 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..3489a144453b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_SplitClone.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_SplitClone.json new file mode 100644 index 000000000000..c44082bd6bfb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_SplitClone.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Update.json new file mode 100644 index 000000000000..f3b8a5fc65cb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-05-01-preview", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-05-01-preview&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/netapp.json new file mode 100644 index 000000000000..c1d9192ab781 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2024-05-01-preview/netapp.json @@ -0,0 +1,10657 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-05-01-preview", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/transitiontocmk": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_TransitionToCmk", + "summary": "Transition volumes encryption from PMK to CMK.", + "description": "Transitions all volumes in a VNet to a different encryption key source (Microsoft-managed key or Azure Key Vault). Operation fails if targeted volumes share encryption sibling set with volumes from another account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption transition.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/encryptionTransitionRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_MigrateEncryptionKey": { + "$ref": "examples/Accounts_TransitionEncryptionKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_GetChangeKeyVaultInformation", + "summary": "Get information about how volumes under NetApp account are encrypted.", + "description": "Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_GetChangeKeyVaultInformation": { + "$ref": "examples/Accounts_GetChangeKeyVaultInformation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/changeKeyVault": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ChangeKeyVault", + "summary": "Change Key Vault/Managed HSM that is used for encryption of volumes under NetApp account.", + "description": "Affects existing volumes that are encrypted with Key Vault/Managed HSM, and new volumes. Supports HSM to Key Vault, Key Vault to HSM, HSM to HSM and Key Vault to Key Vault.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "The required parameters to perform encryption migration.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/changeKeyVault" + } + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_ChangeKeyVault": { + "$ref": "examples/Accounts_ChangeKeyVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent": { + "post": { + "tags": [ + "Split clone volume" + ], + "summary": "Split clone from parent volume", + "description": " Split operation to convert clone volume to an independent volume.", + "operationId": "Volumes_SplitCloneFromParent", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_SplitClone": { + "$ref": "examples/Volumes_SplitClone.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listQuotaReport": { + "post": { + "tags": [ + "Quota Report for Volume" + ], + "summary": "Lists Quota Report for the volume", + "description": "Returns report of quotas for the volume", + "operationId": "Volumes_ListQuotaReport", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listQuotaReportResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/listQuotaReportResponse" + }, + "x-ms-examples": { + "ListQuotaReport": { + "$ref": "examples/Volumes_ListQuotaReport.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the external cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerExternalCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerExternalCluster": { + "$ref": "examples/Volumes_PeerExternalCluster.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_AuthorizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_AuthorizeExternalReplication": { + "$ref": "examples/Volumes_AuthorizeExternalReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeExternalReplication": { + "$ref": "examples/Volumes_FinalizeExternalReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "<code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "<code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + }, + "nfsV4IDDomain": { + "type": "string", + "description": "Domain for NFSv4 user ID mapping. This property will be set for all NetApp accounts in the subscription and region and only affect non ldap NFSv4 volumes.", + "maxLength": 255, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9.-]{0,253}[a-zA-Z0-9]$", + "x-nullable": true, + "example": "defaultv4IDDomain.com" + }, + "isMultiAdEnabled": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "This will have true value only if account is Multiple AD enabled." + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "description": "kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + }, + "federatedClientId": { + "type": "string", + "description": "ClientId of the multi-tenant AAD Application. Used to access cross-tenant KeyVaults.", + "example": "87654321-1234-1234-1234-876543214321" + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "acceptGrowCapacityPoolForShortTermCloneSplit": { + "title": "acceptGrowCapacityPoolForShortTermCloneSplit", + "type": "string", + "description": "While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Accepted", + "Declined" + ], + "x-ms-enum": { + "name": "acceptGrowCapacityPoolForShortTermCloneSplit", + "modelAsString": true, + "values": [ + { + "value": "Accepted", + "description": "Auto grow capacity pool for short term clone split is accepted." + }, + { + "value": "Declined", + "description": "Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool." + } + ] + }, + "example": "Accepted" + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. Avoid passing null value for unixPermissions in volume update operation, As per the behavior, If Null value is passed then user-visible unixPermissions value will became null, and user will not be able to get unixPermissions value. On safer side, actual unixPermissions value on volume will remain as its last saved value only.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + }, + "inheritedSizeInBytes": { + "title": "inheritedSizeInBytes", + "type": "integer", + "format": "int64", + "description": "Space shared by short term clone volume with parent volume in bytes.", + "readOnly": true, + "x-nullable": true + }, + "language": { + "title": "language", + "$ref": "#/definitions/VolumeLanguage" + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume. Required for cross region and cross zone replication", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + }, + "destinationReplications": { + "description": "A list of destination replications", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/destinationReplication" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "destinationReplication": { + "description": "Destination replication properties", + "type": "object", + "properties": { + "resourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + }, + "description": "The resource ID of the remote volume" + }, + "replicationType": { + "type": "string", + "description": "Indicates whether the replication is cross zone or cross region.", + "enum": [ + "CrossRegionReplication", + "CrossZoneReplication" + ], + "x-ms-enum": { + "name": "ReplicationType", + "modelAsString": true, + "values": [ + { + "value": "CrossRegionReplication", + "description": "Cross region replication" + }, + { + "value": "CrossZoneReplication", + "description": "Cross zone replication" + } + ] + } + }, + "region": { + "type": "string", + "description": "The remote region for the destination volume." + }, + "zone": { + "type": "string", + "description": "The remote zone for the destination volume." + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot" + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy Resource ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "listQuotaReportResponse": { + "description": "Quota Report for volume", + "type": "object", + "properties": { + "value": { + "description": "List of volume quota report records", + "type": "array", + "x-ms-identifiers": [], + "items": { + "$ref": "#/definitions/quotaReport" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "quotaReport": { + "description": "Quota report record properties", + "type": "object", + "properties": { + "quotaType": { + "description": "Type of quota", + "$ref": "#/definitions/quotaType" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running <wmic useraccount where name='user-name' get sid>", + "example": "1001" + }, + "quotaLimitUsedInKiBs": { + "type": "integer", + "description": "Specifies the current usage in kibibytes for the user/group quota.", + "format": "int64", + "example": 1024 + }, + "quotaLimitTotalInKiBs": { + "type": "integer", + "description": "Specifies the total size limit in kibibytes for the user/group quota.", + "format": "int64", + "example": 1024 + }, + "percentageUsed": { + "type": "number", + "description": "Percentage of used size compared to total size.", + "example": 10.0 + }, + "isDerivedQuota": { + "title": "IsDerivedQuota", + "type": "boolean", + "description": "Flag to indicate whether the quota is derived from default quota.", + "example": true + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "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." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "VolumeLanguage": { + "title": "VolumeLanguage", + "type": "string", + "x-nullable": true, + "description": "Language supported for volume.", + "enum": [ + "c.utf-8", + "utf8mb4", + "ar", + "ar.utf-8", + "hr", + "hr.utf-8", + "cs", + "cs.utf-8", + "da", + "da.utf-8", + "nl", + "nl.utf-8", + "en", + "en.utf-8", + "fi", + "fi.utf-8", + "fr", + "fr.utf-8", + "de", + "de.utf-8", + "he", + "he.utf-8", + "hu", + "hu.utf-8", + "it", + "it.utf-8", + "ja", + "ja.utf-8", + "ja-v1", + "ja-v1.utf-8", + "ja-jp.pck", + "ja-jp.pck.utf-8", + "ja-jp.932", + "ja-jp.932.utf-8", + "ja-jp.pck-v2", + "ja-jp.pck-v2.utf-8", + "ko", + "ko.utf-8", + "no", + "no.utf-8", + "pl", + "pl.utf-8", + "pt", + "pt.utf-8", + "c", + "ro", + "ro.utf-8", + "ru", + "ru.utf-8", + "zh", + "zh.utf-8", + "zh.gbk", + "zh.gbk.utf-8", + "zh-tw.big5", + "zh-tw.big5.utf-8", + "zh-tw", + "zh-tw.utf-8", + "sk", + "sk.utf-8", + "sl", + "sl.utf-8", + "es", + "es.utf-8", + "sv", + "sv.utf-8", + "tr", + "tr.utf-8", + "en-us", + "en-us.utf-8" + ], + "x-ms-enum": { + "name": "VolumeLanguage", + "modelAsString": true, + "values": [ + { + "value": "c.utf-8", + "description": "Posix with UTF-8" + }, + { + "value": "utf8mb4", + "description": "UTF-8 with 4 byte character support" + }, + { + "value": "ar", + "description": "Arabic - Deprecated" + }, + { + "value": "ar.utf-8", + "description": "Arabic with UTF-8" + }, + { + "value": "hr", + "description": "Croatian - Deprecated" + }, + { + "value": "hr.utf-8", + "description": "Croatian with UTF-8" + }, + { + "value": "cs", + "description": "Czech - Deprecated" + }, + { + "value": "cs.utf-8", + "description": "Czech with UTF-8" + }, + { + "value": "da", + "description": "Danish - Deprecated" + }, + { + "value": "da.utf-8", + "description": "Danish with UTF-8" + }, + { + "value": "nl", + "description": "Dutch - Deprecated" + }, + { + "value": "nl.utf-8", + "description": "Dutch with UTF-8" + }, + { + "value": "en", + "description": "English - Deprecated" + }, + { + "value": "en.utf-8", + "description": "English with UTF-8" + }, + { + "value": "fi", + "description": "Finnish - Deprecated" + }, + { + "value": "fi.utf-8", + "description": "Finnish with UTF-8" + }, + { + "value": "fr", + "description": "French - Deprecated" + }, + { + "value": "fr.utf-8", + "description": "French with UTF-8" + }, + { + "value": "de", + "description": "German - Deprecated" + }, + { + "value": "de.utf-8", + "description": "German with UTF-8" + }, + { + "value": "he", + "description": "Hebrew - Deprecated" + }, + { + "value": "he.utf-8", + "description": "Hebrew with UTF-8" + }, + { + "value": "hu", + "description": "Hungarian - Deprecated" + }, + { + "value": "hu.utf-8", + "description": "Hungarian with UTF-8" + }, + { + "value": "it", + "description": "Italian - Deprecated" + }, + { + "value": "it.utf-8", + "description": "Italian with UTF-8" + }, + { + "value": "ja", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-v1", + "description": "Japanese euc-j - Deprecated" + }, + { + "value": "ja-v1.utf-8", + "description": "Japanese euc-j with UTF-8" + }, + { + "value": "ja-jp.pck", + "description": "Japanese pck" + }, + { + "value": "ja-jp.pck.utf-8", + "description": "Japanese pck with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.932", + "description": "Japanese cp932" + }, + { + "value": "ja-jp.932.utf-8", + "description": "Japanese cp932 with UTF-8 - Deprecated" + }, + { + "value": "ja-jp.pck-v2", + "description": "Japanese pck - sjis" + }, + { + "value": "ja-jp.pck-v2.utf-8", + "description": "Japanese pck - sjis with UTF-8 - Deprecated" + }, + { + "value": "ko", + "description": "Korean - Deprecated" + }, + { + "value": "ko.utf-8", + "description": "Korean with UTF-8" + }, + { + "value": "no", + "description": "Norwegian - Deprecated" + }, + { + "value": "no.utf-8", + "description": "Norwegian with UTF-8" + }, + { + "value": "pl", + "description": "Polish - Deprecated" + }, + { + "value": "pl.utf-8", + "description": "Polish with UTF-8" + }, + { + "value": "pt", + "description": "Portuguese - Deprecated" + }, + { + "value": "pt.utf-8", + "description": "Portuguese with UTF-8" + }, + { + "value": "c", + "description": "Posix - Deprecated" + }, + { + "value": "ro", + "description": "Romanian - Deprecated" + }, + { + "value": "ro.utf-8", + "description": "Romanian with UTF-8" + }, + { + "value": "ru", + "description": "Russian - Deprecated" + }, + { + "value": "ru.utf-8", + "description": "Russian with UTF-8" + }, + { + "value": "zh", + "description": "Simplified Chinese - Deprecated" + }, + { + "value": "zh.utf-8", + "description": "Simplified Chinese with UTF-8" + }, + { + "value": "zh.gbk", + "description": "Simplified gbk Chinese" + }, + { + "value": "zh.gbk.utf-8", + "description": "Simplified gbk Chinese with UTF-8 - Deprecated" + }, + { + "value": "zh-tw.big5", + "description": "Traditional Chinese BIG 5" + }, + { + "value": "zh-tw.big5.utf-8", + "description": "Traditional Chinese BIG 5 with UTF-8 - Deprecated" + }, + { + "value": "zh-tw", + "description": "Traditional Chinese EUC-TW" + }, + { + "value": "zh-tw.utf-8", + "description": "Traditional Chinese EUC-TW with UTF-8 - Deprecated" + }, + { + "value": "sk", + "description": "Slovak - Deprecated" + }, + { + "value": "sk.utf-8", + "description": "Slovak with UTF-8" + }, + { + "value": "sl", + "description": "Slovenian - Deprecated" + }, + { + "value": "sl.utf-8", + "description": "Slovenian with UTF-8" + }, + { + "value": "es", + "description": "Spanish - Deprecated" + }, + { + "value": "es.utf-8", + "description": "Spanish with UTF-8" + }, + { + "value": "sv", + "description": "Swedish - Deprecated" + }, + { + "value": "sv.utf-8", + "description": "Swedish with UTF-8" + }, + { + "value": "tr", + "description": "Turkish - Deprecated" + }, + { + "value": "tr.utf-8", + "description": "Turkish with UTF-8" + }, + { + "value": "en-us", + "description": "US English - Deprecated" + }, + { + "value": "en-us.utf-8", + "description": "US English with UTF-8" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "description": "Type of quota", + "$ref": "#/definitions/quotaType", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running <wmic useraccount where name='user-name' get sid>", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota rule", + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "IndividualUserQuota" + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "encryptionTransitionRequest": { + "description": "Encryption transition request", + "type": "object", + "required": [ + "virtualNetworkId", + "privateEndpointId" + ], + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks" + } + ] + }, + "description": "Identifier for the virtual network", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/privateEndpoints" + } + ] + }, + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + }, + "isLargeVolume": { + "type": "boolean", + "readOnly": true, + "description": "Specifies if the backup is for a large volume.", + "example": false + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + }, + "changeKeyVault": { + "description": "Change key vault request", + "type": "object", + "required": [ + "keyVaultUri", + "keyName", + "keyVaultPrivateEndpoints" + ], + "properties": { + "keyVaultUri": { + "title": "keyVaultUri", + "description": "The URI of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "https://my-key-vault.managedhsm.azure.net" + }, + "keyName": { + "title": "keyName", + "description": "The name of the key that should be used for encryption.", + "type": "string", + "example": "rsaKeyName" + }, + "keyVaultResourceId": { + "title": "keyVaultResourceId", + "description": "Azure resource ID of the key vault/managed HSM that should be used for encryption.", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.KeyVault/managedHSMs/my-hsm", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "keyVaultPrivateEndpoints": { + "title": "keyVaultPrivateEndpoints", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/keyVaultPrivateEndpoint" + }, + "x-ms-identifiers": [ + "virtualNetworkId" + ] + } + } + }, + "keyVaultPrivateEndpoint": { + "title": "keyVaultPrivateEndpoint", + "description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.", + "type": "object", + "properties": { + "virtualNetworkId": { + "title": "virtualNetworkId", + "type": "string", + "description": "Identifier for the virtual network id", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "privateEndpointId": { + "title": "privateEndpointId", + "type": "string", + "description": "Identifier of the private endpoint to reach the Azure Key Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1" + } + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if <code>clusterPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about svm peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if <code>svmPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source Cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerIpAddresses" + ], + "properties": { + "peerIpAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the On-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index e6d75f9f34b5..00aea2ca9389 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,9 +28,17 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-2024-05 +tag: package-preview-2024-05 ``` +### Tag: package-preview-2024-05 + +These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2024-05' +input-file: + - Microsoft.NetApp/preview/2024-05-01-preview/netapp.json +``` ### Tag: package-2024-05 These settings apply only when `--tag=package-2024-05` is specified on the command line. From 3906cab97616932be970c3292df68c966438628a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= <audunn@netapp.com> Date: Mon, 14 Oct 2024 15:54:22 +0000 Subject: [PATCH 101/101] [NetAppFiles] Release netapp microsoft.net app 2024-07-01 (#30447) * Copy files from stable/2024-05-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-07-01 Updated the API version from stable/2024-05-01 to stable/2024-07-01. * Added tag for 2024-07-01 in readme file * pretty * update to 2024-07-01 * snapshot and backupid as resource id * pretty * backupvault as resource id * backuppolicyid as resource id * revert backupId and snapshotId format as arm-id * revert backupPolicyId and backupVaultId format as arm-id * typo missing brace * snapshot, backupid, backuppolicyId and packupVaultId as resource Ids * BackupPolicy Correct property to resourceId correction * backupVaultId to resourceId correction * Flexible service level will be in a later service version * update usageThreshold descrption --- .../examples/Accounts_CreateOrUpdate.json | 36 + .../examples/Accounts_CreateOrUpdateAD.json | 81 + .../2024-07-01/examples/Accounts_Delete.json | 16 + .../2024-07-01/examples/Accounts_Get.json | 36 + .../2024-07-01/examples/Accounts_List.json | 24 + .../examples/Accounts_RenewCredentials.json | 17 + .../2024-07-01/examples/Accounts_Update.json | 46 + .../examples/BackupPolicies_Create.json | 51 + .../examples/BackupPolicies_Delete.json | 18 + .../examples/BackupPolicies_Get.json | 33 + .../examples/BackupPolicies_List.json | 29 + .../examples/BackupPolicies_Update.json | 70 + .../examples/BackupVaults_Create.json | 36 + .../examples/BackupVaults_Delete.json | 18 + .../2024-07-01/examples/BackupVaults_Get.json | 25 + .../examples/BackupVaults_List.json | 28 + .../examples/BackupVaults_Update.json | 48 + .../examples/BackupsUnderAccount_Migrate.json | 19 + .../BackupsUnderBackupVault_Create.json | 50 + .../BackupsUnderBackupVault_Delete.json | 19 + .../examples/BackupsUnderBackupVault_Get.json | 29 + .../BackupsUnderBackupVault_List.json | 32 + ...upsUnderBackupVault_SingleFileRestore.json | 24 + .../BackupsUnderBackupVault_Update.json | 49 + .../examples/BackupsUnderVolume_Migrate.json | 21 + .../examples/CheckFilePathAvailability.json | 18 + .../examples/CheckNameAvailability.json | 19 + .../examples/CheckQuotaAvailability.json | 19 + .../examples/GroupIdListForLDAPUser.json | 29 + .../examples/NetworkSiblingSet_Query.json | 42 + .../examples/NetworkSiblingSet_Update.json | 49 + .../2024-07-01/examples/OperationList.json | 1565 +++ .../examples/Pools_CreateOrUpdate.json | 51 + .../2024-07-01/examples/Pools_Delete.json | 17 + .../stable/2024-07-01/examples/Pools_Get.json | 28 + .../2024-07-01/examples/Pools_List.json | 31 + .../2024-07-01/examples/Pools_Update.json | 34 + .../2024-07-01/examples/QuotaLimits_Get.json | 21 + .../2024-07-01/examples/QuotaLimits_List.json | 87 + .../2024-07-01/examples/RegionInfo.json | 20 + .../2024-07-01/examples/RegionInfos_Get.json | 33 + .../2024-07-01/examples/RegionInfos_List.json | 37 + .../examples/SnapshotPolicies_Create.json | 104 + .../examples/SnapshotPolicies_Delete.json | 18 + .../examples/SnapshotPolicies_Get.json | 44 + .../examples/SnapshotPolicies_List.json | 47 + .../SnapshotPolicies_ListVolumes.json | 36 + .../examples/SnapshotPolicies_Update.json | 107 + .../2024-07-01/examples/Snapshots_Create.json | 31 + .../2024-07-01/examples/Snapshots_Delete.json | 20 + .../2024-07-01/examples/Snapshots_Get.json | 26 + .../2024-07-01/examples/Snapshots_List.json | 29 + .../examples/Snapshots_SingleFileRestore.json | 25 + .../2024-07-01/examples/Snapshots_Update.json | 32 + .../examples/Subvolumes_Create.json | 42 + .../examples/Subvolumes_Delete.json | 20 + .../2024-07-01/examples/Subvolumes_Get.json | 24 + .../2024-07-01/examples/Subvolumes_List.json | 28 + .../examples/Subvolumes_Metadata.json | 35 + .../examples/Subvolumes_Update.json | 34 + .../examples/VolumeGroups_Create_Oracle.json | 965 ++ .../examples/VolumeGroups_Create_SapHana.json | 406 + .../examples/VolumeGroups_Delete.json | 18 + .../examples/VolumeGroups_Get_Oracle.json | 510 + .../examples/VolumeGroups_Get_SapHana.json | 220 + .../examples/VolumeGroups_List_Oracle.json | 31 + .../examples/VolumeGroups_List_SapHana.json | 31 + .../examples/VolumeQuotaRules_Create.json | 52 + .../examples/VolumeQuotaRules_Delete.json | 20 + .../examples/VolumeQuotaRules_Get.json | 27 + .../examples/VolumeQuotaRules_List.json | 31 + .../examples/VolumeQuotaRules_Update.json | 37 + .../Volumes_AuthorizeExternalReplication.json | 23 + .../Volumes_AuthorizeReplication.json | 21 + .../examples/Volumes_BreakFileLocks.json | 22 + .../examples/Volumes_BreakReplication.json | 21 + .../examples/Volumes_CreateOrUpdate.json | 58 + .../2024-07-01/examples/Volumes_Delete.json | 18 + .../examples/Volumes_DeleteReplication.json | 22 + .../Volumes_FinalizeExternalReplication.json | 17 + .../examples/Volumes_FinalizeRelocation.json | 22 + .../2024-07-01/examples/Volumes_Get.json | 32 + .../examples/Volumes_LatestBackupStatus.json | 24 + .../examples/Volumes_LatestRestoreStatus.json | 22 + .../2024-07-01/examples/Volumes_List.json | 35 + .../examples/Volumes_ListReplications.json | 27 + .../examples/Volumes_PeerExternalCluster.json | 33 + .../Volumes_PerformReplicationTransfer.json | 21 + .../examples/Volumes_PoolChange.json | 21 + .../Volumes_PopulateAvailabilityZones.json | 37 + .../Volumes_ReInitializeReplication.json | 22 + .../Volumes_ReestablishReplication.json | 20 + .../2024-07-01/examples/Volumes_Relocate.json | 19 + .../examples/Volumes_ReplicationStatus.json | 25 + .../examples/Volumes_ResetCifsPassword.json | 21 + .../examples/Volumes_ResyncReplication.json | 22 + .../2024-07-01/examples/Volumes_Revert.json | 21 + .../examples/Volumes_RevertRelocation.json | 22 + .../2024-07-01/examples/Volumes_Update.json | 43 + .../stable/2024-07-01/netapp.json | 9779 +++++++++++++++++ .../netapp/resource-manager/readme.md | 13 +- 101 files changed, 16486 insertions(+), 2 deletions(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdateAD.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_RenewCredentials.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderAccount_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderVolume_Migrate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckFilePathAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckNameAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckQuotaAvailability.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/GroupIdListForLDAPUser.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Query.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/OperationList.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfo.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_ListVolumes.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_SingleFileRestore.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Metadata.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_Oracle.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_SapHana.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakFileLocks.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_CreateOrUpdate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Delete.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_DeleteReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeExternalReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Get.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestBackupStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestRestoreStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_List.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ListReplications.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PeerExternalCluster.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PerformReplicationTransfer.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PoolChange.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PopulateAvailabilityZones.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReInitializeReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReestablishReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Relocate.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReplicationStatus.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResetCifsPassword.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResyncReplication.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Revert.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_RevertRelocation.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/netapp.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdate.json new file mode 100644 index 000000000000..ef9b9451efec --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdateAD.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdateAD.json new file mode 100644 index 000000000000..72ad64d22a61 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_CreateOrUpdateAD.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": { + "activeDirectories": [ + { + "site": "SiteName", + "username": "ad_user_name", + "password": "ad_password", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Creating", + "activeDirectories": [ + { + "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b", + "site": "SiteName", + "username": "ad_user_name", + "password": null, + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "aesEncryption": true, + "ldapSigning": false, + "ldapOverTLS": false + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Delete.json new file mode 100644 index 000000000000..84cb6e814fa8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "204": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Get.json new file mode 100644 index 000000000000..8aedd96a9632 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "activeDirectories": [ + { + "site": "SiteName", + "activeDirectoryId": "02da3711-6c58-2d64-098a-e3af7afaf936", + "username": "ad_user_name", + "domain": "10.10.10.3", + "dns": "10.10.10.3", + "status": "InUse", + "smbServerName": "SMBServer", + "organizationalUnit": "OU=Engineering", + "statusDetails": "Status Details", + "aesEncryption": true, + "ldapSigning": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_List.json new file mode 100644 index 000000000000..50ad0252bdff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_RenewCredentials.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_RenewCredentials.json new file mode 100644 index 000000000000..ce6a1d319039 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_RenewCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Update.json new file mode 100644 index 000000000000..f9c11297a029 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Accounts_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/a0216c17-f9d6-4b99-9faf-9ebd4883d0e4?api-version=2024-07-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1", + "name": "account1", + "type": "Microsoft.NetApp/netAppAccounts", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Patching", + "encryption": { + "keySource": "Microsoft.NetApp" + } + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Create.json new file mode 100644 index 000000000000..552e33a723d4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Create.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-07-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": true, + "provisioningState": "creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Delete.json new file mode 100644 index 000000000000..ca6fcbfe8dae --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Get.json new file mode 100644 index 000000000000..5b269f8badfd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_List.json new file mode 100644 index 000000000000..d6a3c44b3b19 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicy1", + "name": "account1/backupPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "eastus", + "properties": { + "dailyBackupsToKeep": 10, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 0, + "enabled": true + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Update.json new file mode 100644 index 000000000000..1d2922d0541b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupPolicies_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupPolicyName": "backupPolicyName", + "api-version": "2024-07-01", + "body": { + "location": "westus", + "properties": { + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "enabled": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolocies/backupPolicyName", + "name": "account1/backupPolicyName", + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "dailyBackupsToKeep": 5, + "weeklyBackupsToKeep": 10, + "monthlyBackupsToKeep": 10, + "volumesAssigned": 1, + "enabled": false, + "volumeBackups": [ + { + "volumeName": "volume 1", + "backupsCount": 5, + "policyEnabled": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Create.json new file mode 100644 index 000000000000..b968947fd168 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Create.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-07-01", + "body": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "properties": { + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Delete.json new file mode 100644 index 000000000000..0a8d89780f2a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Get.json new file mode 100644 index 000000000000..81533441e209 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_List.json new file mode 100644 index 000000000000..f2ebb2d62e87 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Update.json new file mode 100644 index 000000000000..1aa4bbcb478d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupVaults_Update.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-07-01", + "body": { + "tags": { + "Tag1": "Value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1", + "name": "account1/backupVault1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults", + "location": "eastus", + "tags": { + "Tag1": "Value1" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderAccount_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderAccount_Migrate.json new file mode 100644 index 000000000000..22f73b79d60d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderAccount_Migrate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Create.json new file mode 100644 index 000000000000..b72599174ebc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Create.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-07-01", + "body": { + "properties": { + "label": "myLabel", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Delete.json new file mode 100644 index 000000000000..5b59e57b1a9b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Get.json new file mode 100644 index 000000000000..9536d6b8dc0f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_List.json new file mode 100644 index 000000000000..3ac1d161405e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1", + "backupPolicyResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupPolicies/policy1" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_SingleFileRestore.json new file mode 100644 index 000000000000..a191545b7f4d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_SingleFileRestore.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-07-01", + "body": { + "fileList": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ], + "destinationVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Update.json new file mode 100644 index 000000000000..3b31a4c599db --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderBackupVault_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "backupVaultName": "backupVault1", + "backupName": "backup1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1", + "name": "account1/backupVault1/backup1", + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups", + "properties": { + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded", + "size": 10011, + "label": "myLabel", + "backupType": "Manual", + "snapshotName": "backup1", + "volumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPool/pool1/volumes/volume1" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderVolume_Migrate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderVolume_Migrate.json new file mode 100644 index 000000000000..701861d21bea --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/BackupsUnderVolume_Migrate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "backupVaultId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckFilePathAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckFilePathAvailability.json new file mode 100644 index 000000000000..9d99db2f4284 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckFilePathAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01", + "body": { + "name": "my-exact-filepth", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckNameAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..6fa67f38c712 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01", + "body": { + "name": "accName", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckQuotaAvailability.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckQuotaAvailability.json new file mode 100644 index 000000000000..0c130addb7f8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/CheckQuotaAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01", + "body": { + "name": "resource1", + "type": "Microsoft.NetApp/netAppAccounts", + "resourceGroup": "myRG" + } + }, + "responses": { + "200": { + "body": { + "isAvailable": true + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/GroupIdListForLDAPUser.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/GroupIdListForLDAPUser.json new file mode 100644 index 000000000000..dbc044431dfa --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/GroupIdListForLDAPUser.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "username": "user1" + } + }, + "responses": { + "200": { + "body": { + "groupIdsForLdapUser": [ + "123", + "224" + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Query.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Query.json new file mode 100644 index 000000000000..e83a0e83f5b0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Query.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Update.json new file mode 100644 index 000000000000..a0664dd2e913 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/NetworkSiblingSet_Update.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01", + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard" + } + }, + "responses": { + "200": { + "body": { + "networkSiblingSetId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/testSubnet", + "networkSiblingSetStateId": "12345_44420.8001578125", + "networkFeatures": "Standard", + "provisioningState": "Succeeded", + "nicInfoList": [ + { + "ipAddress": "1.2.3.4", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume10", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume11" + ] + }, + { + "ipAddress": "1.2.3.5", + "volumeResourceIds": [ + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume20", + "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account2/capacityPools/pool2/volumes/volume21" + ] + }, + { + "ipAddress": "1.2.3.9", + "volumeResourceIds": [] + } + ] + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/OperationList.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/OperationList.json new file mode 100644 index 000000000000..2732d7d7588b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/OperationList.json @@ -0,0 +1,1565 @@ +{ + "parameters": { + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.NetApp/register/action", + "display": { + "provider": "Microsoft.NetApp", + "resource": "Subscription", + "operation": "Subscription Registration Action", + "description": "Subscription Registration Action" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume resource", + "description": "Reads a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write volume resource", + "description": "Writes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete volume resource", + "description": "Deletes a volume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/Revert/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert volume resource", + "description": "Revert volume to specific snapshot" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BreakReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Break volume replication resource", + "description": "Break volume replication relations" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ListReplications/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReInitializeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Re-Initialize replication", + "description": "Attempts to re-initialize an uninitialized replication" + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "AverageReadLatency", + "displayName": "Average read latency", + "displayDescription": "Average read latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageReadLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "AverageWriteLatency", + "displayName": "Average write latency", + "displayDescription": "Average write latency in milliseconds per operation", + "unit": "MilliSeconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "AverageWriteLatency", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeLogicalSize", + "displayName": "Volume Consumed Size", + "displayDescription": "Logical size of the volume (used bytes)", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeSnapshotSize", + "displayName": "Volume snapshot size", + "displayDescription": "Size of all snapshots in volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadIops", + "displayName": "Read iops", + "displayDescription": "Read In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteIops", + "displayName": "Write iops", + "displayDescription": "Write In/out operations per second", + "unit": "CountPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteIops", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeAllocatedSize", + "displayName": "Volume allocated size", + "displayDescription": "The provisioned size of a volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierSize", + "displayName": "Volume cool tier size", + "displayDescription": "Volume Footprint for Cool Tier", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataReadSize", + "displayName": "Volume cool tier data read size", + "displayDescription": "Data read in using GET per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataReadSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeCoolTierDataWriteSize", + "displayName": "Volume cool tier data write size", + "displayDescription": "Data tiered out using PUT per volume", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeCoolTierDataWriteSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferDuration", + "displayName": "Volume replication last transfer duration", + "displayDescription": "The amount of time in seconds it took for the last transfer to complete.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferDuration", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLastTransferSize", + "displayName": "Volume replication last transfer size", + "displayDescription": "The total number of bytes transferred as part of the last transfer.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLastTransferSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationHealthy", + "displayName": "Is volume replication status healthy", + "displayDescription": "Condition of the relationship, 1 or 0.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationHealthy", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationLagTime", + "displayName": "Volume replication lag time", + "displayDescription": "The amount of time in seconds by which the data on the mirror lags behind the source.", + "unit": "Seconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationLagTime", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationTotalTransferBytes", + "displayName": "Volume replication total transfer", + "displayDescription": "Cumulative bytes transferred for the relationship.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationTotalTransferBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipProgress", + "displayName": "Volume replication progress", + "displayDescription": "Total amount of data transferred for the current transfer operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipProgress", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "XregionReplicationRelationshipTransferring", + "displayName": "Is volume replication transferring", + "displayDescription": "Whether the status of the Volume Replication is 'transferring'.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "XregionReplicationRelationshipTransferring", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeLogicalBackupBytes", + "displayName": "Volume Backup Bytes", + "displayDescription": "Total bytes backed up for this Volume.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeLogicalBackupBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeProtected", + "displayName": "Is Volume Backup Enabled", + "displayDescription": "Is backup enabled for the volume? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeProtected", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeBackupActive", + "displayName": "Is Volume Backup suspended", + "displayDescription": "Is the backup policy suspended for the volume? 0 if yes, 1 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeBackupActive", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationTransferredBytes", + "displayName": "Volume Backup Last Transferred Bytes", + "displayDescription": "Total bytes transferred for last backup or restore operation.", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationTransferredBytes", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "CbsVolumeOperationComplete", + "displayName": "Is Volume Backup Operation Complete", + "displayDescription": "Did the last volume backup or restore operation complete successfully? 1 if yes, 0 if no.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "CbsVolumeOperationComplete", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumeConsumedSizePercentage", + "displayName": "Percentage Volume Consumed Size", + "displayDescription": "The percentage of the volume consumed including snapshots.", + "unit": "Percent", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumeConsumedSizePercentage", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "OtherThroughput", + "displayName": "Other throughput", + "displayDescription": "Other throughput (that is not read or write) in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "OtherThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "ReadThroughput", + "displayName": "Read throughput", + "displayDescription": "Read throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "ReadThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "TotalThroughput", + "displayName": "Total throughput", + "displayDescription": "Sum of all throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "TotalThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "WriteThroughput", + "displayName": "Write throughput", + "displayDescription": "Write throughput in bytes per second", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "WriteThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/AuthorizeReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Authorize Replication", + "description": "Authorize the source volume replication" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ResyncReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Resync Replication", + "description": "Resync the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/DeleteReplication/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Delete Replication", + "description": "Delete the replication on the destination volume" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/ReplicationStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read Volume Replication Status.", + "description": "Reads the statuses of the Volume Replication." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/MountTargets/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Read mount target resource", + "description": "Reads a mount target resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/BackupStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RestoreStatus/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/PoolChange/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Change pool for volume", + "description": "Moves volume to another pool." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RelocateVolume/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Relocate volume to a new stamp.", + "description": "Relocate volume to a new stamp." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/FinalizeRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Finalize relocation of volume.", + "description": "Finalize relocation by cleaning up the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/RevertRelocation/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Revert the relocation of volume.", + "description": "Revert the relocation and revert back to the old volume." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Read account resource", + "description": "Reads an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Write account resource", + "description": "Writes an account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Delete account resource", + "description": "Deletes a account resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/RenewCredentials/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Accounts resource type", + "operation": "Renew MSI credentials, if possible.", + "description": "Renews MSI credentials of account, if account has MSI credentials that are due for renewal." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read pool resource", + "description": "Reads a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write pool resource", + "description": "Writes a pool resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Delete pool resource", + "description": "Deletes a pool resource." + }, + "origin": "user,system" + }, + { + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "VolumePoolAllocatedUsed", + "displayName": "Pool Allocated To Volume Size", + "displayDescription": "Allocated used size of the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedUsed", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalLogicalSize", + "displayName": "Pool Consumed Size", + "displayDescription": "Sum of the logical size of all the volumes belonging to the pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalLogicalSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedSize", + "displayName": "Pool Allocated Size", + "displayDescription": "Provisioned size of this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average", + "Total" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolTotalSnapshotSize", + "displayName": "Total Snapshot size for the pool", + "displayDescription": "Sum of snapshot size of all volumes in this pool", + "unit": "Bytes", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolTotalSnapshotSize", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolProvisionedThroughput", + "displayName": "Provisioned throughput for the pool", + "displayDescription": "Provisioned throughput of this pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolProvisionedThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + }, + { + "name": "VolumePoolAllocatedToVolumeThroughput", + "displayName": "Pool allocated throughput", + "displayDescription": "Sum of the throughput of all the volumes belonging to the pool", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Average" + ], + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "internalMetricName": "VolumePoolAllocatedToVolumeThroughput", + "enableRegionalMdmAccount": true, + "sourceMdmAccount": "MicrosoftNetAppShoebox2", + "sourceMdmNamespace": "NetAppUsageAndMetrics", + "fillGapWithZero": false, + "isInternal": false, + "dimensions": [] + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read volume metric definitions.", + "description": "Gets the available metrics for Volume resource." + }, + "origin": "system" + }, + { + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "Autoscale", + "displayName": "Capacity Pool Autoscaled" + } + ] + } + }, + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read log definitions.", + "description": "Gets the log definitions for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Read diagnostic setting.", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Pools resource type", + "operation": "Write diagnostic setting.", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Read snapshot resource", + "description": "Reads a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Write snapshot resource", + "description": "Writes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Delete snapshot resource", + "description": "Deletes a snapshot resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots/RestoreFiles/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshots resource type", + "operation": "Single File Snapshot Restore", + "description": "Restores files from a snapshot resource" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Write subvolume Resource", + "description": "Write a subvolume resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/GetMetadata/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subvolume resource type.", + "operation": "Subvolume Metadata resource.", + "description": "Read subvolume metadata resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Read snapshot policy resource", + "description": "Reads a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Write snapshot policy resource", + "description": "Writes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "Delete snapshot policy resource", + "description": "Deletes a snapshot policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/Volumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/snapshotPolicies/ListVolumes/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Snapshot Policies resource type", + "operation": "List connected volumes", + "description": "List volumes connected to snapshot policy" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Read backup resource.", + "description": "Reads a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Write backup resource.", + "description": "Writes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/backups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup resource type", + "operation": "Delete backup resource", + "description": "Deletes a backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Read backup policy resource.", + "description": "Reads a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Write backup policy resource.", + "description": "Writes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/backupPolicies/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Backup Policy resource type", + "operation": "Delete backup policy resource", + "description": "Deletes a backup policy resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/vaults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Vault resource type", + "operation": "Read vault resource.", + "description": "Reads a vault resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Read an account backup resource.", + "description": "Reads an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Write an account backup resource.", + "description": "Writes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/accountBackups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Account backup resource type", + "operation": "Delete an account backup resource.", + "description": "Deletes an account backup resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Read volume group resource", + "description": "Reads a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/write", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Write volume group resource", + "description": "Writes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/netAppAccounts/volumeGroups/delete", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volume Group resource type", + "operation": "Delete volume group resource", + "description": "Deletes a volume group resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/quotaLimits/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "QuotaLimit resource type", + "operation": "Read QuotaLimit resource type", + "description": "Reads a Quotalimit resource type." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/Operations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operations resource type", + "operation": "Read operation resource", + "description": "Reads an operation resources." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/operationresults/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Operation results resource type", + "operation": "Read operation result resource", + "description": "Reads an operation result resource." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/read", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Location wide operation", + "operation": "Read location wide operation", + "description": "Reads a location wide operation." + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checknameavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "NetApp resources", + "operation": "Check if resource name is available", + "description": "Check if resource name is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkfilepathavailability/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Volumes resource type", + "operation": "Check if file path is available", + "description": "Check if file path is available" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/unregister/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "Subscription", + "operation": "Unregister Subscription for Azure NetApp Files", + "description": "Unregisters Subscription with Microsoft.NetApp resource provider" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.NetApp/locations/checkinventory/action", + "display": { + "provider": "Microsoft.NetApp Resource Provider", + "resource": "ReservedCapacity reservation resource.", + "operation": "Checks ReservedCapacity inventory.", + "description": "Checks ReservedCapacity inventory." + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_CreateOrUpdate.json new file mode 100644 index 000000000000..99fd959338ef --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_CreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": { + "size": 4398046511104, + "serviceLevel": "Premium", + "qosType": "Auto" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..c26e742b0dfd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Get.json new file mode 100644 index 000000000000..7c78d0c2cc57 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Get.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_List.json new file mode 100644 index 000000000000..a39246706007 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Auto", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.474 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Update.json new file mode 100644 index 000000000000..a52c5ce843cd --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Pools_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "name": "account1/pool1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104, + "qosType": "Manual", + "totalThroughputMibps": 281.474, + "utilizedThroughputMibps": 100.47 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_Get.json new file mode 100644 index 000000000000..bdf9f13885a9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "quotaLimitName": "totalCoolAccessVolumesPerSubscription", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_List.json new file mode 100644 index 000000000000..f02fd5bd8ccb --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/QuotaLimits_List.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/accountsPerSubscription", + "name": "eastus/accountsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/poolsPerAccount", + "name": "eastus/poolsPerAccount", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 25, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/volumesPerPool", + "name": "eastus/volumesPerPool", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/snapshotsPerVolume", + "name": "eastus/snapshotsPerVolume", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 255, + "default": 255 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalTiBsPerSubscription", + "name": "eastus/totalTiBsPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 1000, + "default": 25 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalDPVolumesPerSubscription", + "name": "eastus/totalDPVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalVolumesPerSubscription", + "name": "eastus/totalVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 500, + "default": 500 + } + }, + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/quotaLimits/totalCoolAccessVolumesPerSubscription", + "name": "eastus/totalCoolAccessVolumesPerSubscription", + "type": "Microsoft.NetApp/locations/quotaLimits", + "properties": { + "current": 10, + "default": 10 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfo.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfo.json new file mode 100644 index 000000000000..c9c76d38b510 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_Get.json new file mode 100644 index 000000000000..464b7cb9d099 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_List.json new file mode 100644 index 000000000000..12014939d4d1 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/RegionInfos_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "location": "eastus", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/regionInfos/default", + "name": "eastus/default", + "type": "Microsoft.NetApp/locations/regionInfos", + "properties": { + "storageToNetworkProximity": "T2", + "availabilityZoneMappings": [ + { + "availabilityZone": "1", + "isAvailable": true + }, + { + "availabilityZone": "2", + "isAvailable": true + }, + { + "availabilityZone": "3", + "isAvailable": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Create.json new file mode 100644 index 000000000000..c960a15d4ee9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Create.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "location": "eastus", + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Delete.json new file mode 100644 index 000000000000..8213a0932727 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "resourceGroup", + "accountName": "accountName", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Get.json new file mode 100644 index 000000000000..0ab8d1f39297 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json new file mode 100644 index 000000000000..5415b80c836c --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_List.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "location": "eastus", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_ListVolumes.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_ListVolumes.json new file mode 100644 index 000000000000..5e8dfb3d2811 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_ListVolumes.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Update.json new file mode 100644 index 000000000000..b3f21ac36016 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/SnapshotPolicies_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "snapshotPolicyName": "snapshotPolicyName", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/18c499e1-2a3c-441c-950e-4b456c991c18?api-version=2024-07-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1", + "name": "account1/snapshotPolicy1", + "type": "Microsoft.NetApp/netAppAccounts/snapshotPolicies", + "location": "eastus", + "properties": { + "enabled": true, + "hourlySchedule": { + "snapshotsToKeep": 2, + "minute": 50 + }, + "dailySchedule": { + "snapshotsToKeep": 4, + "hour": 14, + "minute": 30 + }, + "weeklySchedule": { + "snapshotsToKeep": 3, + "day": "Wednesday", + "hour": 14, + "minute": 45 + }, + "monthlySchedule": { + "snapshotsToKeep": 5, + "daysOfMonth": "10,11,12", + "hour": 14, + "minute": 15 + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Create.json new file mode 100644 index 000000000000..262ecd5d5e17 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Create.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-07-01", + "location": "eastus", + "body": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Delete.json new file mode 100644 index 000000000000..fe39e42536af --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Get.json new file mode 100644 index 000000000000..5213c2e0cc8f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_List.json new file mode 100644 index 000000000000..da4bef8b3419 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_SingleFileRestore.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_SingleFileRestore.json new file mode 100644 index 000000000000..2c9d70df1139 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_SingleFileRestore.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-07-01", + "body": { + "filePaths": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Update.json new file mode 100644 index 000000000000..eaf05a872a43 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Snapshots_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "snapshotName": "snapshot1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1", + "name": "account1/pool1/volume1/snapshot1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots", + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "created": "2017-08-15T13:23:33Z", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Create.json new file mode 100644 index 000000000000..5d76cf2de146 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Create.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Succeeded", + "size": 0 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/subvolumePath", + "provisioningState": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Delete.json new file mode 100644 index 000000000000..5022765a4dfc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Get.json new file mode 100644 index 000000000000..b3ffcc357876 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_List.json new file mode 100644 index 000000000000..c05c0e24814d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes", + "properties": { + "path": "/pathToSubvol", + "size": 0 + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Metadata.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Metadata.json new file mode 100644 index 000000000000..44e9cc9ad66f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Metadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata", + "name": "account1/pool1/volume1/subvolume1/metadata", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata", + "properties": { + "path": "/pathToSubvol", + "size": 5, + "bytesUsed": 5, + "permissions": "777", + "creationTimeStamp": "2017-08-15T13:23:33Z", + "accessedTimeStamp": "2017-08-15T13:23:33Z", + "modifiedTimeStamp": "2017-08-15T13:23:33Z", + "changedTimeStamp": "2017-08-15T13:23:33Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Update.json new file mode 100644 index 000000000000..5e52f5bde343 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Subvolumes_Update.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "subvolumeName": "subvolume1", + "api-version": "2024-07-01", + "body": { + "properties": { + "path": "/subvolumePath" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1", + "name": "account1/pool1/volume1/subvolume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1", + "properties": { + "path": "/subvolumePath", + "size": 0 + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_Oracle.json new file mode 100644 index 000000000000..9f7b548fe1d6 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_Oracle.json @@ -0,0 +1,965 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-07-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data1", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data1", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data2", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data2", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data3", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data3", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data4", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data4", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data5", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data5", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data6", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data6", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data7", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data7", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-data8", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-data8", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-log-mirror", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-log-mirror", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-binary", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-binary", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "creationToken": "test-ora-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "ora-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_SapHana.json new file mode 100644 index 000000000000..ed13fdc8c604 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Create_SapHana.json @@ -0,0 +1,406 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-07-01", + "body": { + "location": "westus", + "properties": { + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "name": "test-data-mnt00001", + "properties": { + "creationToken": "test-data-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-mnt00001", + "properties": { + "creationToken": "test-log-mnt00001", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-shared", + "properties": { + "creationToken": "test-shared", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "shared", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-data-backup", + "properties": { + "creationToken": "test-data-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "data-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "name": "test-log-backup", + "properties": { + "creationToken": "test-log-backup", + "serviceLevel": "Premium", + "throughputMibps": 10, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400, + "volumeSpecName": "log-backup", + "capacityPoolResourceId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1", + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "westus", + "properties": { + "provisioningState": "Creating", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9" + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-mnt00001", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-shared", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-data-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "test-log-backup", + "properties": { + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Delete.json new file mode 100644 index 000000000000..b4b5271eee70 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + }, + "200": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_Oracle.json new file mode 100644 index 000000000000..b8c92d1fff7a --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_Oracle.json @@ -0,0 +1,510 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "OR2", + "volumesCount": 12 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data1", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data1", + "serviceLevel": "Premium", + "creationToken": "test-ora-data1", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data2", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data2", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data2", + "serviceLevel": "Premium", + "creationToken": "test-ora-data2", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data3", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data3", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data3", + "serviceLevel": "Premium", + "creationToken": "test-ora-data3", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data4", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data4", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data4", + "serviceLevel": "Premium", + "creationToken": "test-ora-data4", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data5", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data5", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data5", + "serviceLevel": "Premium", + "creationToken": "test-ora-data5", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data6", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data6", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data6", + "serviceLevel": "Premium", + "creationToken": "test-ora-data6", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data7", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data7", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data7", + "serviceLevel": "Premium", + "creationToken": "test-ora-data7", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-data8", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-data8", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-data8", + "serviceLevel": "Premium", + "creationToken": "test-ora-data8", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log", + "serviceLevel": "Premium", + "creationToken": "test-ora-log", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-log-mirror", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-log-mirror", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-log-mirror", + "serviceLevel": "Premium", + "creationToken": "test-ora-log-mirror", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-binary", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-binary", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-binary", + "serviceLevel": "Premium", + "creationToken": "test-ora-binary", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-ora-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-ora-backup", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "volumeSpecName": "ora-backup", + "serviceLevel": "Premium", + "creationToken": "test-ora-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_SapHana.json new file mode 100644 index 000000000000..1dc6311fd912 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_Get_SapHana.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "volumeGroupName": "group1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + }, + "volumes": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data", + "serviceLevel": "Premium", + "creationToken": "test-data-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-mnt00001", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-mnt00001", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log", + "serviceLevel": "Premium", + "creationToken": "test-log-mnt00001", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-shared", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-shared", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "shared", + "serviceLevel": "Premium", + "creationToken": "test-shared", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-data-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-data-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "data-backup", + "serviceLevel": "Premium", + "creationToken": "test-data-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + }, + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/test-log-backup", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "name": "account1/pool1/test-log-backup", + "properties": { + "provisioningState": "Succeeded", + "throughputMibps": 10.0, + "proximityPlacementGroup": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/cys_sjain_fcp_rg/providers/Microsoft.Compute/proximityPlacementGroups/svlqa_sjain_multivolume_ppg", + "volumeSpecName": "log-backup", + "serviceLevel": "Premium", + "creationToken": "test-log-backup", + "usageThreshold": 107374182400, + "subnetId": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "exportPolicy": { + "rules": [ + { + "ruleIndex": 1, + "unixReadOnly": true, + "unixReadWrite": true, + "kerberos5ReadOnly": false, + "kerberos5ReadWrite": false, + "kerberos5iReadOnly": false, + "kerberos5iReadWrite": false, + "kerberos5pReadOnly": false, + "kerberos5pReadWrite": false, + "cifs": false, + "nfsv3": false, + "nfsv41": true, + "allowedClients": "0.0.0.0/0", + "hasRootAccess": true + } + ] + }, + "protocolTypes": [ + "NFSv4.1" + ] + } + } + ] + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_Oracle.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_Oracle.json new file mode 100644 index 000000000000..f1abb1dfe96f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_Oracle.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "ORACLE", + "applicationIdentifier": "DEV", + "volumesCount": 12 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_SapHana.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_SapHana.json new file mode 100644 index 000000000000..d2dc3afb8b60 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeGroups_List_SapHana.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d633cc2e-722b-4ae1-b636-bbd9e4c60ed9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/volumeGroups/group1", + "name": "group1", + "type": "Microsoft.NetApp/netAppAccounts/volumeGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "groupMetaData": { + "groupDescription": "Volume group", + "applicationType": "SAP-HANA", + "applicationIdentifier": "SH9", + "volumesCount": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Create.json new file mode 100644 index 000000000000..978dd6393562 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Create.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-07-01", + "body": { + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + }, + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Creating" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Delete.json new file mode 100644 index 000000000000..c4c5302b72c4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-07-01" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Get.json new file mode 100644 index 000000000000..e6d4abe1e27b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Get.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_List.json new file mode 100644 index 000000000000..2fa4a6c87629 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Update.json new file mode 100644 index 000000000000..cc35388c90ab --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/VolumeQuotaRules_Update.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "5275316f-a498-48d6-b324-2cbfdc4311b9", + "resourceGroupName": "myRG", + "accountName": "account-9957", + "poolName": "pool-5210", + "volumeName": "volume-6387", + "volumeQuotaRuleName": "rule-0004", + "api-version": "2024-07-01", + "body": { + "properties": { + "quotaSizeInKiBs": 100009 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-9957/capacityPools/pool-5210/volumes/volume-6387/volumeQuotaRules/rule-0004", + "name": "account-9957/pool-5210/volume-6387/rule-0004", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/volumeQuotaRules", + "location": "westus", + "properties": { + "provisioningState": "Patching", + "quotaTarget": "1821", + "quotaSizeInKiBs": 100005, + "quotaType": "IndividualUserQuota" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/5275316f-a498-48d6-b324-2cbfdc4311b9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeExternalReplication.json new file mode 100644 index 000000000000..0a16cc89982f --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeExternalReplication.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "svmPeeringCommand": "vserver peer accept -vserver OnPremSvm -peer-vserver AnfSvm" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeReplication.json new file mode 100644 index 000000000000..9aa0cdd33b42 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_AuthorizeReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "remoteVolumeResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRemoteRG/providers/Microsoft.NetApp/netAppAccounts/remoteAccount1/capacityPools/remotePool1/volumes/remoteVolume1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakFileLocks.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakFileLocks.json new file mode 100644 index 000000000000..8aa9a968dc65 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakFileLocks.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "clientIp": "101.102.103.104", + "confirmRunningDisruptiveOperation": true + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakReplication.json new file mode 100644 index 000000000000..87af959f83e5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_BreakReplication.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "forceBreakReplication": false + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_CreateOrUpdate.json new file mode 100644 index 000000000000..4df22a6ccf99 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": { + "creationToken": "my-unique-file-path", + "serviceLevel": "Premium", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "usageThreshold": 107374182400 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "201": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "location": "eastus", + "name": "account1/pool1/volume1", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "encryptionKeySource": "Microsoft.NetApp" + }, + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Delete.json new file mode 100644 index 000000000000..62e07aee6b29 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "204": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_DeleteReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_DeleteReplication.json new file mode 100644 index 000000000000..460c4ba5e4ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_DeleteReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeExternalReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeExternalReplication.json new file mode 100644 index 000000000000..3f661633521e --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeExternalReplication.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeRelocation.json new file mode 100644 index 000000000000..460c4ba5e4ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_FinalizeRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Get.json new file mode 100644 index 000000000000..0b367ebe2e65 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Get.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestBackupStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestBackupStatus.json new file mode 100644 index 000000000000..3e3a2a952b64 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestBackupStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "unhealthyReason": "", + "errorMessage": "", + "lastTransferSize": 100000, + "lastTransferType": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestRestoreStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestRestoreStatus.json new file mode 100644 index 000000000000..0f0aa09a4b10 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_LatestRestoreStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Uninitialized", + "unhealthyReason": "", + "errorMessage": "", + "totalTransferBytes": 100000 + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_List.json new file mode 100644 index 000000000000..9a6f3a483b1d --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_List.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ListReplications.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ListReplications.json new file mode 100644 index 000000000000..56021e928622 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ListReplications.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "replicationSchedule": "daily", + "remoteVolumeResourceId": "/subscriptions/36e85c76-e720-473e-881f-e2fe72f462d0/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account-5999/capacityPools/pool-0977/volumes/volume-4508", + "remoteVolumeRegion": "westus" + } + ] + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PeerExternalCluster.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PeerExternalCluster.json new file mode 100644 index 000000000000..4aa3cbe7efe4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PeerExternalCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "peerIpAddresses": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ] + } + }, + "responses": { + "200": { + "body": { + "peerAcceptCommand": "cluster peer create -ipspace replication -encryption-protocol-proposed tls-psk -passphrase passphraseString -peer-addrs 1.1.1.1,1.1.1.2,1.1.1.3,1.1.1.4,1.1.1.5,1.1.1.6" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PerformReplicationTransfer.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PerformReplicationTransfer.json new file mode 100644 index 000000000000..2b6073180ca5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PerformReplicationTransfer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PoolChange.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PoolChange.json new file mode 100644 index 000000000000..2e6cae4e9ce9 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PoolChange.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "newPoolResourceId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PopulateAvailabilityZones.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PopulateAvailabilityZones.json new file mode 100644 index 000000000000..0b8527ac95b8 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_PopulateAvailabilityZones.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReInitializeReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReInitializeReplication.json new file mode 100644 index 000000000000..460c4ba5e4ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReInitializeReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReestablishReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReestablishReplication.json new file mode 100644 index 000000000000..1b3b10a0558b --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReestablishReplication.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "sourceVolumeId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/mySourceRG/providers/Microsoft.NetApp/netAppAccounts/sourceAccount1/capacityPools/sourcePool1/volumes/sourceVolume1" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Relocate.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Relocate.json new file mode 100644 index 000000000000..db32339bdf25 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Relocate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReplicationStatus.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReplicationStatus.json new file mode 100644 index 000000000000..d5e5fc6f1218 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ReplicationStatus.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "healthy": true, + "relationshipStatus": "Idle", + "mirrorState": "Mirrored", + "totalProgress": "1048576", + "errorMessage": "" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResetCifsPassword.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResetCifsPassword.json new file mode 100644 index 000000000000..2b6073180ca5 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResetCifsPassword.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResyncReplication.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResyncReplication.json new file mode 100644 index 000000000000..460c4ba5e4ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_ResyncReplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Revert.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Revert.json new file mode 100644 index 000000000000..ba6b5e72dece --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Revert.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "snapshotId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_RevertRelocation.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_RevertRelocation.json new file mode 100644 index 000000000000..460c4ba5e4ff --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_RevertRelocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json new file mode 100644 index 000000000000..7939bdf8ffdc --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9", + "resourceGroupName": "myRG", + "accountName": "account1", + "poolName": "pool1", + "volumeName": "volume1", + "api-version": "2024-07-01", + "body": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1", + "name": "account1/pool1/volume1", + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Succeeded", + "throughputMibps": 128, + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3", + "networkFeatures": "Standard", + "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4", + "storageToNetworkProximity": "T2", + "dataProtection": { + "snapshot": { + "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1" + } + } + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location" + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/netapp.json new file mode 100644 index 000000000000..45eecee0e0b4 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/netapp.json @@ -0,0 +1,9779 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft NetApp", + "description": "Microsoft NetApp Azure Resource Provider specification", + "version": "2024-07-01", + "x-ms-code-generation-settings": { + "name": "AzureNetAppFilesManagementClient" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "host": "management.azure.com", + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.NetApp/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Describes the Resource Provider", + "description": "Lists all of the available Microsoft.NetApp Rest API operations", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "OperationList": { + "$ref": "examples/OperationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check resource name availability", + "description": "Check if a resource name is available.", + "operationId": "NetAppResource_CheckNameAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Name availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceNameAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check file path availability", + "description": "Check if a file path is available.", + "operationId": "NetAppResource_CheckFilePathAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "File path availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/FilePathAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckFilePathAvailability": { + "$ref": "examples/CheckFilePathAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Check quota availability", + "description": "Check if a quota is available.", + "operationId": "NetAppResource_CheckQuotaAvailability", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Quota availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaAvailabilityRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "examples/CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current limits for quotas", + "operationId": "NetAppResourceQuotaLimits_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}": { + "get": { + "tags": [ + "NetApp Resource" + ], + "summary": "Get quota limits", + "description": "Get the default and current subscription quota limit", + "operationId": "NetAppResourceQuotaLimits_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/QuotaLimitName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "QuotaLimits": { + "$ref": "examples/QuotaLimits_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResource_QueryRegionInfo", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfo_Query": { + "$ref": "examples/RegionInfo.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides region specific information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfosList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_List": { + "$ref": "examples/RegionInfos_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default": { + "get": { + "summary": "Describes region specific information.", + "description": "Provides storage to network proximity and logical zone mapping information.", + "tags": [ + "NetApp Resource" + ], + "operationId": "NetAppResourceRegionInfos_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "RegionInfos_Get": { + "$ref": "examples/RegionInfos_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Describe a network sibling set", + "description": "Get details of the specified network sibling set.", + "operationId": "NetAppResource_QueryNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Network sibling set to query.", + "required": true, + "schema": { + "$ref": "#/definitions/QueryNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NetworkSiblingSet_Query": { + "$ref": "examples/NetworkSiblingSet_Query.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet": { + "post": { + "tags": [ + "NetApp Resource" + ], + "summary": "Update the network features of a network sibling set", + "description": "Update the network features of the specified network sibling set.", + "operationId": "NetAppResource_UpdateNetworkSiblingSet", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "Update for the specified network sibling set.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateNetworkSiblingSetRequest" + }, + "x-ms-client-flatten": true + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/networkSiblingSet" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "NetworkFeatures_Update": { + "$ref": "examples/NetworkSiblingSet_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a subscription", + "description": "List and describe all NetApp accounts in the subscription.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts": { + "get": { + "summary": "Describe all NetApp Accounts in a resource group", + "description": "List and describe all NetApp accounts in the resource group.", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_List": { + "$ref": "examples/Accounts_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "get": { + "summary": "Describe a NetApp Account", + "description": "Get the NetApp account", + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Accounts_Get": { + "$ref": "examples/Accounts_Get.json" + } + } + }, + "put": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_CreateOrUpdate", + "summary": "Create or update a NetApp account", + "description": "Create or update the specified NetApp account within the resource group", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "201": { + "description": "Account created", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_CreateOrUpdate": { + "$ref": "examples/Accounts_CreateOrUpdate.json" + }, + "Accounts_CreateOrUpdateWithActiveDirectory": { + "$ref": "examples/Accounts_CreateOrUpdateAD.json" + } + } + }, + "delete": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Delete", + "summary": "Delete a NetApp account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "Delete the specified NetApp account", + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Delete": { + "$ref": "examples/Accounts_Delete.json" + } + } + }, + "patch": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_Update", + "summary": "Update a NetApp account", + "description": "Patch the specified NetApp account", + "parameters": [ + { + "name": "body", + "description": "NetApp Account object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/netAppAccountPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - account updated", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/netAppAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Accounts_Update": { + "$ref": "examples/Accounts_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials": { + "post": { + "tags": [ + "NetApp Accounts" + ], + "operationId": "Accounts_RenewCredentials", + "summary": "Renew identity credentials", + "description": "Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Accounts_RenewCredentials": { + "$ref": "examples/Accounts_RenewCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { + "get": { + "summary": "Describe all Capacity Pools", + "description": "List all capacity pools in the NetApp Account", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPoolList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_List": { + "$ref": "examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { + "get": { + "summary": "Describe a Capacity Pool", + "description": "Get details of the specified capacity pool", + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "examples/Pools_Get.json" + } + } + }, + "put": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_CreateOrUpdate", + "summary": "Create or Update the specified capacity pool within the resource group", + "description": "Create or Update a capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "201": { + "description": "Pool created", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "examples/Pools_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Update", + "summary": "Update a capacity pool", + "description": "Patch the specified capacity pool", + "parameters": [ + { + "name": "body", + "description": "Capacity pool object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/capacityPoolPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "examples/Pools_Update.json" + } + } + }, + "delete": { + "tags": [ + "Capacity Pools" + ], + "operationId": "Pools_Delete", + "summary": "Delete a capacity pool", + "description": "Delete the specified capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { + "get": { + "summary": "Describe all volumes", + "description": "List all volumes within the capacity pool", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volumes" + ], + "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_List": { + "$ref": "examples/Volumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { + "get": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Get", + "summary": "Describe a volume", + "description": "Get the details of the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_Get": { + "$ref": "examples/Volumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_CreateOrUpdate", + "summary": "Create or Update a volume", + "description": "Create or update the specified volume within the capacity pool", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volume" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "201": { + "description": "Volume created", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Volumes_CreateOrUpdate": { + "$ref": "examples/Volumes_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Update", + "summary": "Update a volume", + "description": "Patch the specified volume", + "parameters": [ + { + "name": "body", + "description": "Volume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Update": { + "$ref": "examples/Volumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Volumes" + ], + "operationId": "Volumes_Delete", + "summary": "Delete a volume", + "description": "Delete the specified volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "in": "query", + "name": "forceDelete", + "type": "boolean", + "description": "An option to force delete the volume. Will cleanup resources connected to the particular volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Delete": { + "$ref": "examples/Volumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone": { + "post": { + "tags": [ + "Volumes" + ], + "summary": "Populate Availability Zone", + "description": "This operation will populate availability zone information for a volume", + "operationId": "Volumes_PopulateAvailabilityZone", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volume" + } + }, + "202": { + "description": "Accepted -- populate availability zone accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PopulateAvailabilityZones": { + "$ref": "examples/Volumes_PopulateAvailabilityZones.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert": { + "post": { + "tags": [ + "Volumes Revert" + ], + "summary": "Revert a volume to one of its snapshots", + "description": "Revert a volume to the snapshot specified in the body", + "operationId": "Volumes_Revert", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Object for snapshot to revert supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeRevert" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_Revert": { + "$ref": "examples/Volumes_Revert.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword": { + "post": { + "tags": [ + "Reset Cifs Password" + ], + "summary": "Reset cifs password", + "description": "Reset cifs password from volume", + "operationId": "Volumes_ResetCifsPassword", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_ResetCifsPassword": { + "$ref": "examples/Volumes_ResetCifsPassword.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks": { + "post": { + "tags": [ + "File Locks" + ], + "summary": "Break file locks", + "description": "Break all the file locks on a volume", + "operationId": "Volumes_BreakFileLocks", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to provide the ability to clear file locks with selected options", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakFileLocksRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakFileLocks": { + "$ref": "examples/Volumes_BreakFileLocks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser": { + "post": { + "tags": [ + "Group Id List for LDAP User" + ], + "summary": " Get Group Id List for LDAP User", + "description": "Returns the list of group Ids for a specific LDAP User", + "operationId": "Volumes_ListGetGroupIdListForLdapUser", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Returns group Id list for a specific LDAP user", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/getGroupIdListForLDAPUserResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "GetGroupIdListForUser": { + "$ref": "examples/GroupIdListForLDAPUser.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Break volume replication", + "description": "Break the replication connection on the destination volume", + "operationId": "Volumes_BreakReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Optional body to force break the replication.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/breakReplicationRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_BreakReplication": { + "$ref": "examples/Volumes_BreakReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Re-establish volume replication", + "description": "Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots", + "operationId": "Volumes_ReestablishReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "body for the id of the source volume.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/reestablishReplicationRequest" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReestablishReplication": { + "$ref": "examples/Volumes_ReestablishReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus": { + "get": { + "tags": [ + "Volumes Replication" + ], + "summary": "Get volume replication status", + "description": "Get the status of the replication", + "operationId": "Volumes_ReplicationStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/replicationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ReplicationStatus": { + "$ref": "examples/Volumes_ReplicationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "List replications for volume", + "description": "List all replications for a specified volume", + "operationId": "Volumes_ListReplications", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/listReplications" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_ListReplications": { + "$ref": "examples/Volumes_ListReplications.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Resync volume replication", + "description": "Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.", + "operationId": "Volumes_ResyncReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ResyncReplication": { + "$ref": "examples/Volumes_ResyncReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Delete volume replication", + "description": "Delete the replication connection on the destination volume, and send release to the source replication", + "operationId": "Volumes_DeleteReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_DeleteReplication": { + "$ref": "examples/Volumes_DeleteReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "Authorize source volume replication", + "description": "Authorize the replication connection on the source volume", + "operationId": "Volumes_AuthorizeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Authorize request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/authorizeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_AuthorizeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication": { + "post": { + "tags": [ + "Volumes Replication" + ], + "summary": "ReInitialize volume replication", + "description": "Re-Initializes the replication connection on the destination volume", + "operationId": "Volumes_ReInitializeReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_ReInitializeReplication": { + "$ref": "examples/Volumes_ReInitializeReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerExternalCluster": { + "post": { + "summary": "Start Cluster peering", + "description": "Starts peering the external cluster for this migration volume", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_PeerExternalCluster", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Cluster peer request object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/peerClusterForVolumeMigrationRequest" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/clusterPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_PeerExternalCluster": { + "$ref": "examples/Volumes_PeerExternalCluster.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/clusterPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeExternalReplication": { + "post": { + "summary": "Start migration process", + "description": "Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created", + "tags": [ + "Volumes OnPrem Migration" + ], + "operationId": "Volumes_AuthorizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location", + "final-state-schema": "#/definitions/svmPeerCommandResponse" + }, + "x-ms-examples": { + "Volumes_AuthorizeExternalReplication": { + "$ref": "examples/Volumes_AuthorizeExternalReplication.json" + } + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/svmPeerCommandResponse" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication": { + "post": { + "summary": "Finalize migration process", + "description": "Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.", + "tags": [ + "Volumes OnPrem Migration Finalize" + ], + "operationId": "Volumes_FinalizeExternalReplication", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_FinalizeExternalReplication": { + "$ref": "examples/Volumes_FinalizeExternalReplication.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer": { + "post": { + "tags": [ + "Volumes OnPrem Migration" + ], + "summary": "Perform a replication transfer", + "description": "Performs an adhoc replication transfer on a volume with volumeType Migration", + "operationId": "Volumes_PerformReplicationTransfer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_PerformReplicationTransfer": { + "$ref": "examples/Volumes_PerformReplicationTransfer.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange": { + "post": { + "tags": [ + "Pool Change" + ], + "summary": "Change pool for volume", + "description": "Moves volume to another pool", + "operationId": "Volumes_PoolChange", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Move volume to the pool supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/poolChangeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Volumes_AuthorizeReplication": { + "$ref": "examples/Volumes_PoolChange.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Relocate volume", + "description": "Relocates volume to a new stamp", + "operationId": "Volumes_Relocate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Relocate volume request", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/relocateVolumeRequest" + } + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_Relocate": { + "$ref": "examples/Volumes_Relocate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Finalize volume relocation", + "description": "Finalizes the relocation of the volume and cleans up the old volume.", + "operationId": "Volumes_FinalizeRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_FinalizeRelocation": { + "$ref": "examples/Volumes_FinalizeRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation": { + "post": { + "tags": [ + "Volumes Relocation" + ], + "summary": "Revert volume relocation", + "description": "Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.", + "operationId": "Volumes_RevertRelocation", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Volumes_RevertRelocation": { + "$ref": "examples/Volumes_RevertRelocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "summary": "Describe all snapshots", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all snapshots associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_List": { + "$ref": "examples/Snapshots_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "summary": "Describe a snapshot", + "description": "Get details of the specified snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Snapshots_Get": { + "$ref": "examples/Snapshots_Get.json" + } + } + }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "summary": "Create a snapshot", + "description": "Create the specified snapshot within the given volume", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "summary": "Update a snapshot", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "summary": "Delete a snapshot", + "description": "Delete snapshot", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_Delete": { + "$ref": "examples/Snapshots_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RestoreFiles", + "summary": "Create a new Snapshot Restore Files request", + "description": "Restore the specified files from the specified snapshot to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SnapshotName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - terminal state" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Snapshots_SingleFileRestore": { + "$ref": "examples/Snapshots_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies": { + "get": { + "operationId": "SnapshotPolicies_List", + "description": "List snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_List": { + "$ref": "examples/SnapshotPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}": { + "get": { + "operationId": "SnapshotPolicies_Get", + "description": "Get a snapshot Policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_Get": { + "$ref": "examples/SnapshotPolicies_Get.json" + } + } + }, + "put": { + "operationId": "SnapshotPolicies_Create", + "description": "Create a snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - snapshot Policy updated", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "201": { + "description": "Snapshot Policy created", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "SnapshotPolicies_Create": { + "$ref": "examples/SnapshotPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshot Policy" + ], + "operationId": "SnapshotPolicies_Update", + "description": "Patch a snapshot policy", + "parameters": [ + { + "name": "body", + "description": "Snapshot policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPolicyPatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/snapshotPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Update": { + "$ref": "examples/SnapshotPolicies_Update.json" + } + } + }, + "delete": { + "operationId": "SnapshotPolicies_Delete", + "description": "Delete snapshot policy", + "tags": [ + "Snapshot Policy" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "SnapshotPolicies_Delete": { + "$ref": "examples/SnapshotPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes": { + "get": { + "tags": [ + "Snapshot Policy List Volumes" + ], + "summary": "Get volumes for snapshot policy", + "description": "Get volumes associated with snapshot policy", + "operationId": "SnapshotPolicies_ListVolumes", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/SnapshotPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshotPolicyVolumeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SnapshotPolicies_ListVolumes": { + "$ref": "examples/SnapshotPolicies_ListVolumes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "List backup policies", + "description": "List backup policies for Netapp Account", + "operationId": "BackupPolicies_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPoliciesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupPolicies_List": { + "$ref": "examples/BackupPolicies_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "Backup Policy" + ], + "summary": "Get a backup Policy", + "description": "Get a particular backup Policy", + "operationId": "BackupPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_Get": { + "$ref": "examples/BackupPolicies_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Policy" + ], + "summary": "Create a backup policy", + "description": "Create a backup policy for Netapp Account", + "operationId": "BackupPolicies_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicy" + } + } + ], + "responses": { + "200": { + "description": "Backup Policy created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Create": { + "$ref": "examples/BackupPolicies_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backup Policy" + ], + "summary": "Patch a backup policy", + "description": "Patch a backup policy for Netapp Account", + "operationId": "BackupPolicies_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup policy object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupPolicyPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backupPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupPolicies_Update": { + "$ref": "examples/BackupPolicies_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backup Policy" + ], + "summary": "Delete a backup policy", + "description": "Delete backup policy", + "operationId": "BackupPolicies_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupPolicyName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupPolicies_Delete": { + "$ref": "examples/BackupPolicies_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_ListByVolume", + "summary": "Get all quota rules for a volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "description": "List all quota rules associated with the volume", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_List": { + "$ref": "examples/VolumeQuotaRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}": { + "get": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Get", + "summary": "Describe a quota rule", + "description": "Get details of the specified quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeQuotaRules_Get": { + "$ref": "examples/VolumeQuotaRules_Get.json" + } + } + }, + "put": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Create", + "summary": "Create a quota rule", + "description": "Create the specified quota rule within the given volume", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - VolumeQuotaRule updated", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "201": { + "description": "Quota rule Created", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Create": { + "$ref": "examples/VolumeQuotaRules_Create.json" + } + } + }, + "patch": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Update", + "summary": "Update a quota rule", + "description": "Patch a quota rule", + "parameters": [ + { + "name": "body", + "description": "Quota rule object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeQuotaRulePatch" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeQuotaRule" + } + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Update": { + "$ref": "examples/VolumeQuotaRules_Update.json" + } + } + }, + "delete": { + "tags": [ + "VolumeQuotaRules" + ], + "operationId": "VolumeQuotaRules_Delete", + "summary": "Delete a quota rule", + "description": "Delete quota rule", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/VolumeQuotaRuleName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "VolumeQuotaRules_Delete": { + "$ref": "examples/VolumeQuotaRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups": { + "get": { + "summary": "Describe all volume groups", + "description": "List all volume groups for given account", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_ListByNetAppAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_List_SapHana": { + "$ref": "examples/VolumeGroups_List_SapHana.json" + }, + "VolumeGroups_List_Oracle": { + "$ref": "examples/VolumeGroups_List_Oracle.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}": { + "get": { + "summary": "Describe a Volume Group", + "description": "Get details of the specified volume group", + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "VolumeGroups_Get_SapHana": { + "$ref": "examples/VolumeGroups_Get_SapHana.json" + }, + "VolumeGroups_Get_Oracle": { + "$ref": "examples/VolumeGroups_Get_Oracle.json" + } + } + }, + "put": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Create", + "summary": "Create the specified volume group and volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.", + "description": "Create a volume group along with specified volumes", + "parameters": [ + { + "name": "body", + "description": "Volume Group object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Volume group created", + "schema": { + "$ref": "#/definitions/volumeGroupDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Create_SapHana": { + "$ref": "examples/VolumeGroups_Create_SapHana.json" + }, + "VolumeGroups_Create_Oracle": { + "$ref": "examples/VolumeGroups_Create_Oracle.json" + } + } + }, + "delete": { + "tags": [ + "Volume Groups" + ], + "operationId": "VolumeGroups_Delete", + "summary": "Delete a volume group", + "description": "Delete the specified volume group only if there are no volumes under volume group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/VolumeGroupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "VolumeGroups_Delete": { + "$ref": "examples/VolumeGroups_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes": { + "get": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_ListByVolume", + "summary": "List of all the subvolumes", + "description": "Returns a list of the subvolumes in the volume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_List": { + "$ref": "examples/Subvolumes_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}": { + "get": { + "tags": [ + "Subvolumes" + ], + "summary": "Get the path associated with the subvolumeName", + "description": "Returns the path associated with the subvolumeName provided", + "operationId": "Subvolumes_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Subvolumes_Get": { + "$ref": "examples/Subvolumes_Get.json" + } + } + }, + "put": { + "tags": [ + "Subvolumes" + ], + "summary": "Create or clone a new subvolume", + "description": "Creates a subvolume in the path or clones the subvolume mentioned in the parentPath", + "operationId": "Subvolumes_Create", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - updated", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "201": { + "description": "Subvolume created", + "schema": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Create": { + "$ref": "examples/Subvolumes_Create.json" + } + } + }, + "patch": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Update", + "summary": "Update a subvolume", + "description": "Patch a subvolume", + "parameters": [ + { + "name": "body", + "description": "Subvolume object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/subvolumePatchRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/subvolumeInfo" + }, + "description": "OK" + }, + "202": { + "description": "Accepted -- Update request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Update": { + "$ref": "examples/Subvolumes_Update.json" + } + } + }, + "delete": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_Delete", + "summary": "Delete a subvolume", + "description": "Delete subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously" + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Delete": { + "$ref": "examples/Subvolumes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata": { + "post": { + "tags": [ + "Subvolumes" + ], + "operationId": "Subvolumes_GetMetadata", + "summary": "Describe a subvolume", + "description": "Get details of the specified subvolume", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "#/parameters/SubvolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/subvolumeModel" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Subvolumes_Metadata": { + "$ref": "examples/Subvolumes_Metadata.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current": { + "get": { + "tags": [ + "Backups" + ], + "summary": "Get the latest backup status of a volume", + "description": "Get the latest status of the backup for a volume", + "operationId": "Backups_GetLatestStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_BackupStatus": { + "$ref": "examples/Volumes_LatestBackupStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current": { + "get": { + "tags": [ + "Restore" + ], + "summary": "Get the latest restore status of a volume", + "description": "Get the latest status of the restore for a volume", + "operationId": "Backups_GetVolumeLatestRestoreStatus", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/restoreStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Volumes_RestoreStatus": { + "$ref": "examples/Volumes_LatestRestoreStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups": { + "get": { + "tags": [ + "Backups" + ], + "summary": "List Backups", + "description": "List all backups Under a Backup Vault", + "operationId": "Backups_ListByVault", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "in": "query", + "name": "$filter", + "type": "string", + "description": "An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume", + "required": false + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Backups_List": { + "$ref": "examples/BackupsUnderBackupVault_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}": { + "get": { + "summary": "Describe the Backup under Backup Vault", + "description": "Get the specified Backup under Backup Vault.", + "tags": [ + "Backups" + ], + "operationId": "Backups_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Get": { + "$ref": "examples/BackupsUnderBackupVault_Get.json" + } + } + }, + "put": { + "tags": [ + "Backups" + ], + "summary": "Create a backup", + "description": "Create a backup under the Backup Vault", + "operationId": "Backups_Create", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backup" + } + } + ], + "responses": { + "200": { + "description": "OK - backup created updated", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "201": { + "description": "Backup created", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Create": { + "$ref": "examples/BackupsUnderBackupVault_Create.json" + } + } + }, + "patch": { + "tags": [ + "Backups" + ], + "summary": "Patch a backup", + "description": "Patch a Backup under the Backup Vault", + "operationId": "Backups_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup object supplied in the body of the operation.", + "in": "body", + "schema": { + "$ref": "#/definitions/backupPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backup" + } + }, + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "schema": { + "$ref": "#/definitions/backup" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Update": { + "$ref": "examples/BackupsUnderBackupVault_Update.json" + } + } + }, + "delete": { + "tags": [ + "Backups" + ], + "summary": "Delete backup", + "description": "Delete a Backup under the Backup Vault", + "operationId": "Backups_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Create or update request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderBackupVault_Delete": { + "$ref": "examples/BackupsUnderBackupVault_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults": { + "get": { + "summary": "Describe all Backup Vaults", + "description": "List and describe all Backup Vaults in the NetApp account.", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_ListByNetAppAccount", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVaultsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_List": { + "$ref": "examples/BackupVaults_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}": { + "get": { + "summary": "Describe the Backup Vault", + "description": "Get the Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "BackupVaults_Get": { + "$ref": "examples/BackupVaults_Get.json" + } + } + }, + "put": { + "tags": [ + "Backup Vaults" + ], + "summary": "Create or Update a Backup Vault", + "description": "Create or update the specified Backup Vault in the NetApp account", + "operationId": "BackupVaults_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "BackupVault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVault" + } + } + ], + "responses": { + "200": { + "description": "OK - backupVault updated", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "201": { + "description": "backupVault created", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "BackupVault_CreateOrUpdate": { + "$ref": "examples/BackupVaults_Create.json" + } + } + }, + "patch": { + "summary": "Update NetApp Backup Vault", + "description": "Patch the specified NetApp Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "body", + "description": "Backup Vault object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupVaultPatch" + } + } + ], + "responses": { + "200": { + "description": "OK - Backup Vault updated.", + "schema": { + "$ref": "#/definitions/backupVault" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/backupVault" + }, + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Update": { + "$ref": "examples/BackupVaults_Update.json" + } + } + }, + "delete": { + "summary": "Delete NetApp Backup Vault", + "description": "Delete the specified Backup Vault", + "tags": [ + "Backup Vaults" + ], + "operationId": "BackupVaults_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted -- Delete request accepted; operation will complete asynchronously", + "headers": { + "Location": { + "type": "string" + } + } + }, + "204": { + "description": "NoContent -- Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupVaults_Delete": { + "$ref": "examples/BackupVaults_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderBackupVault_RestoreFiles", + "summary": "Create a new Backup Restore Files request", + "description": "Restore the specified files from the specified backup to the active filesystem", + "parameters": [ + { + "name": "body", + "description": "Restore payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupRestoreFiles" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/BackupVaultName" + }, + { + "$ref": "#/parameters/BackupName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Backups_SingleFileRestore": { + "$ref": "examples/BackupsUnderBackupVault_SingleFileRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderVolume_MigrateBackups", + "summary": "Create a new migrate request for backups under volume", + "description": "Migrate the backups under volume to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under volume payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "#/parameters/PoolName" + }, + { + "$ref": "#/parameters/VolumeName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderVolume_Migrate": { + "$ref": "examples/BackupsUnderVolume_Migrate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups": { + "post": { + "tags": [ + "Backups" + ], + "operationId": "BackupsUnderAccount_MigrateBackups", + "summary": "Create a new migrate request for backups under account", + "description": "Migrate the backups under a NetApp account to backup vault", + "parameters": [ + { + "name": "body", + "description": "Migrate backups under an account payload supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/backupsMigrationRequest" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "BackupsUnderAccount_Migrate": { + "$ref": "examples/BackupsUnderAccount_Migrate.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Cloud Volume operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of Storage operations supported by the Storage resource provider." + } + } + }, + "Operation": { + "description": "Microsoft.NetApp REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft NetApp.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed etc.", + "type": "string" + }, + "operation": { + "description": "Type of operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Operation description.", + "type": "string" + } + } + }, + "origin": { + "type": "string", + "description": "The origin of operations." + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Properties of operation, include metric specifications.", + "x-ms-client-flatten": true + } + } + }, + "OperationProperties": { + "description": "Properties of operation, include metric specifications.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "One property of operation, include metric specifications." + } + } + }, + "ServiceSpecification": { + "description": "One property of operation, include metric specifications.", + "properties": { + "metricSpecifications": { + "description": "Metric specifications of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Log specification of operation.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecification": { + "description": "Metric specification of operation.", + "properties": { + "name": { + "type": "string", + "description": "Name of metric specification." + }, + "displayName": { + "type": "string", + "description": "Display name of metric specification." + }, + "displayDescription": { + "type": "string", + "description": "Display description of metric specification." + }, + "unit": { + "type": "string", + "description": "Unit could be Bytes or Count." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "uniqueItems": false, + "type": "array", + "items": { + "enum": [ + "Average" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "supportedTimeGrainTypes": { + "type": "array", + "description": "The supported time grain types for the metrics.", + "items": { + "type": "string" + } + }, + "internalMetricName": { + "type": "string", + "description": "The internal metric name." + }, + "enableRegionalMdmAccount": { + "description": "Whether or not the service is using regional MDM accounts.", + "type": "boolean" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "dimensions": { + "description": "Dimensions of blobs, including blob type and access tier.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "aggregationType": { + "type": "string", + "description": "Aggregation type could be Average." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "The property to decide fill gap with zero or not." + }, + "category": { + "type": "string", + "description": "The category this metric specification belong to, could be Capacity." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "Account Resource Id." + }, + "isInternal": { + "description": "Whether the metric is internal.", + "type": "boolean" + } + } + }, + "LogSpecification": { + "description": "Log Definition of a single resource metric.", + "type": "object", + "properties": { + "name": { + "description": "Name of log specification.", + "type": "string" + }, + "displayName": { + "description": "Display name of log specification.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Dimension of blobs, possibly be blob type or access tier.", + "properties": { + "name": { + "type": "string", + "description": "Display name of dimension." + }, + "displayName": { + "type": "string", + "description": "Display name of dimension." + } + } + }, + "CheckAvailabilityResponse": { + "description": "Information regarding availability of a resource.", + "type": "object", + "properties": { + "isAvailable": { + "description": "<code>true</code> indicates name is valid and available. <code>false</code> indicates the name is invalid, unavailable, or both.", + "type": "boolean" + }, + "reason": { + "description": "<code>Invalid</code> indicates the name provided does not match Azure App Service naming requirements. <code>AlreadyExists</code> indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "InAvailabilityReasonType", + "modelAsString": true + } + }, + "message": { + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.", + "type": "string" + } + } + }, + "regionInfosList": { + "description": "List of regionInfo resources", + "type": "object", + "properties": { + "value": { + "description": "A list of regionInfo resources", + "type": "array", + "items": { + "$ref": "#/definitions/regionInfoResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "regionInfoResource": { + "description": "Information regarding regionInfo Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "regionInfo properties", + "$ref": "#/definitions/regionInfo", + "x-ms-client-flatten": true + } + } + }, + "regionInfo": { + "description": "Provides region specific information.", + "type": "object", + "properties": { + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information in the region.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2", + "T1AndT2", + "T1AndAcrossT2", + "T2AndAcrossT2", + "T1AndT2AndAcrossT2" + ], + "x-ms-enum": { + "name": "RegionStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 network connectivity." + }, + { + "value": "T1AndT2", + "description": "Standard T1 and T2 network connectivity." + }, + { + "value": "T1AndAcrossT2", + "description": "Standard T1 and AcrossT2 network connectivity." + }, + { + "value": "T2AndAcrossT2", + "description": "Standard T2 and AcrossT2 network connectivity." + }, + { + "value": "T1AndT2AndAcrossT2", + "description": "Standard T1, T2 and AcrossT2 network connectivity." + } + ] + }, + "example": "T2" + }, + "availabilityZoneMappings": { + "title": "Logical availability zone mappings.", + "description": "Provides logical availability zone mappings for the subscription for a region.", + "type": "array", + "x-ms-identifiers": [ + "availabilityZone" + ], + "items": { + "type": "object", + "properties": { + "availabilityZone": { + "description": "Logical availability zone.", + "type": "string", + "example": "1" + }, + "isAvailable": { + "description": "Available availability zone", + "type": "boolean", + "example": true + } + } + } + } + } + }, + "ResourceNameAvailabilityRequest": { + "description": "Resource name availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Resource name to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "FilePathAvailabilityRequest": { + "description": "File path availability request content - availability is based on the name and the subnetId.", + "required": [ + "name", + "subnetId" + ], + "type": "object", + "properties": { + "name": { + "description": "File path to verify.", + "type": "string" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "availabilityZone": { + "title": "Logical availability zone", + "type": "string", + "example": "1", + "x-nullable": true, + "description": "The Azure Resource logical availability zone which is used within zone mapping lookup for the subscription and region. The lookup will retrieve the physical zone where volume is placed." + } + } + }, + "QuotaAvailabilityRequest": { + "description": "Quota availability request content.", + "required": [ + "name", + "type", + "resourceGroup" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the resource to verify.", + "type": "string" + }, + "type": { + "description": "Resource type used for verification.", + "enum": [ + "Microsoft.NetApp/netAppAccounts", + "Microsoft.NetApp/netAppAccounts/capacityPools", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", + "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckQuotaNameResourceTypes", + "modelAsString": true + } + }, + "resourceGroup": { + "description": "Resource group name.", + "type": "string" + } + } + }, + "SubscriptionQuotaItemList": { + "description": "List of Subscription Quota Items", + "type": "object", + "properties": { + "value": { + "description": "A list of SubscriptionQuotaItems", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionQuotaItem" + } + } + } + }, + "SubscriptionQuotaItem": { + "description": "Information regarding Subscription Quota Item.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "SubscriptionQuotaItem properties", + "$ref": "#/definitions/SubscriptionQuotaItemProperties", + "x-ms-client-flatten": true + } + } + }, + "SubscriptionQuotaItemProperties": { + "description": "SubscriptionQuotaItem Properties", + "type": "object", + "properties": { + "current": { + "description": "The current quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "default": { + "description": "The default quota value.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + }, + "netAppAccountList": { + "description": "List of NetApp account resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Multiple NetApp accounts", + "items": { + "$ref": "#/definitions/netAppAccount" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "netAppAccount": { + "description": "NetApp account resource", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "netAppAccountPatch": { + "description": "NetApp account patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "NetApp Account properties", + "$ref": "#/definitions/accountProperties", + "x-ms-client-flatten": true + }, + "identity": { + "description": "The identity used for the resource.", + "$ref": "../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "accountProperties": { + "description": "NetApp account properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "activeDirectories": { + "description": "Active Directories", + "type": "array", + "items": { + "$ref": "#/definitions/activeDirectory" + }, + "x-ms-identifiers": [ + "activeDirectoryId" + ] + }, + "encryption": { + "description": "Encryption settings", + "$ref": "#/definitions/accountEncryption" + }, + "disableShowmount": { + "type": "boolean", + "readOnly": true, + "x-nullable": true, + "description": "Shows the status of disableShowmount for all volumes under the subscription, null equals false" + } + } + }, + "activeDirectory": { + "description": "Active Directory", + "type": "object", + "properties": { + "activeDirectoryId": { + "type": "string", + "x-nullable": true, + "description": "Id of the Active Directory" + }, + "username": { + "type": "string", + "description": "A domain user account with permission to create machine accounts" + }, + "password": { + "type": "string", + "x-ms-secret": true, + "maxLength": 64, + "description": "Plain text password of Active Directory domain administrator, value is masked in the response" + }, + "domain": { + "type": "string", + "description": "Name of the Active Directory domain" + }, + "dns": { + "type": "string", + "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "example": "101.102.103.104,101.102.103.105" + }, + "status": { + "type": "string", + "description": "Status of the Active Directory", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "ActiveDirectoryStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Active Directory created but not in use" + }, + { + "value": "InUse", + "description": "Active Directory in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "Active Directory Deleted" + }, + { + "value": "Error", + "description": "Error with the Active Directory" + }, + { + "value": "Updating", + "description": "Active Directory Updating" + } + ] + } + }, + "statusDetails": { + "type": "string", + "description": "Any details in regards to the Status of the Active Directory", + "readOnly": true + }, + "smbServerName": { + "type": "string", + "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes" + }, + "organizationalUnit": { + "type": "string", + "default": "CN=Computers", + "description": "The Organizational Unit (OU) within the Windows Active Directory" + }, + "site": { + "type": "string", + "description": "The Active Directory site the service will limit Domain Controller discovery to" + }, + "backupOperators": { + "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "administrators": { + "description": "Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier", + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "kdcIP": { + "type": "string", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$", + "description": "kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume.", + "example": "101.102.103.104" + }, + "adName": { + "type": "string", + "maxLength": 64, + "minLength": 1, + "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume", + "example": "ADServerName" + }, + "serverRootCACertificate": { + "type": "string", + "maxLength": 10240, + "minLength": 1, + "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.", + "x-ms-secret": true, + "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" + }, + "aesEncryption": { + "type": "boolean", + "description": "If enabled, AES encryption will be enabled for SMB communication." + }, + "ldapSigning": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be signed." + }, + "securityOperators": { + "type": "array", + "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier", + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1 + }, + "example": [ + "user1", + "user2" + ] + }, + "ldapOverTLS": { + "type": "boolean", + "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS." + }, + "allowLocalNfsUsersWithLdap": { + "type": "boolean", + "description": " If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes." + }, + "encryptDCConnections": { + "type": "boolean", + "description": "If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted." + }, + "ldapSearchScope": { + "description": "LDAP Search scope options", + "$ref": "#/definitions/ldapSearchScopeOpt" + }, + "preferredServersForLdapClient": { + "type": "string", + "maxLength": 32, + "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$", + "description": "Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.", + "example": "101.102.103.104, 101.102.103.105" + } + } + }, + "ldapSearchScopeOpt": { + "type": "object", + "description": "LDAP search scope ", + "properties": { + "userDN": { + "type": "string", + "description": "This specifies the user DN, which overrides the base DN for user lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupDN": { + "type": "string", + "description": "This specifies the group DN, which overrides the base DN for group lookups.", + "maxLength": 255, + "example": "OU=fin,OU=hr,dc=domain,dc=com" + }, + "groupMembershipFilter": { + "type": "string", + "description": "This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.", + "maxLength": 255, + "example": "cn=*99" + } + } + }, + "accountEncryption": { + "type": "object", + "description": "Encryption settings", + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'." + }, + "identity": { + "$ref": "#/definitions/EncryptionIdentity", + "description": "Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'." + } + } + }, + "KeyVaultProperties": { + "description": "Properties of key vault.", + "type": "object", + "required": [ + "keyVaultUri", + "keyName" + ], + "properties": { + "keyVaultId": { + "type": "string", + "description": "UUID v4 used to identify the Azure Key Vault configuration", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of KeyVault." + }, + "keyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyVaultResourceId": { + "type": "string", + "description": "The resource ID of KeyVault.", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.KeyVault/vaults" + } + ] + } + }, + "status": { + "type": "string", + "description": "Status of the KeyVault connection.", + "readOnly": true, + "enum": [ + "Created", + "Updating", + "InUse", + "Deleted", + "Error" + ], + "x-ms-enum": { + "name": "KeyVaultStatus", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "KeyVault connection created but not in use" + }, + { + "value": "InUse", + "description": "KeyVault connection in use by SMB Volume" + }, + { + "value": "Deleted", + "description": "KeyVault connection Deleted" + }, + { + "value": "Error", + "description": "Error with the KeyVault connection" + }, + { + "value": "Updating", + "description": "KeyVault connection Updating" + } + ] + } + } + } + }, + "EncryptionIdentity": { + "description": "Identity used to authenticate with key vault.", + "type": "object", + "properties": { + "principalId": { + "type": "string", + "description": "The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.", + "readOnly": true + }, + "userAssignedIdentity": { + "type": "string", + "description": "The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities." + } + } + }, + "capacityPoolList": { + "description": "List of capacity pool resources", + "type": "object", + "properties": { + "value": { + "description": "List of Capacity pools", + "type": "array", + "items": { + "$ref": "#/definitions/capacityPool" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "capacityPool": { + "description": "Capacity pool resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolProperties", + "x-ms-client-flatten": true + } + } + }, + "poolProperties": { + "description": "Pool properties", + "type": "object", + "required": [ + "size", + "serviceLevel" + ], + "properties": { + "poolId": { + "title": "poolId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Pool", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "totalThroughputMibps": { + "type": "number", + "description": "Total throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "utilizedThroughputMibps": { + "type": "number", + "description": "Utilized throughput of pool in MiB/s", + "example": 164.221, + "readOnly": true + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "default": false, + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + }, + "encryptionType": { + "title": "encryptionType", + "type": "string", + "x-nullable": true, + "description": "Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "Single", + "Double" + ], + "x-ms-enum": { + "name": "encryptionType", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "EncryptionType Single, volumes will use single encryption at rest" + }, + { + "value": "Double", + "description": "EncryptionType Double, volumes will use double encryption at rest" + } + ] + }, + "example": "Single", + "default": "Single" + } + } + }, + "capacityPoolPatch": { + "description": "Capacity pool patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Capacity pool properties", + "$ref": "#/definitions/poolPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "poolPatchProperties": { + "description": "Patchable pool properties", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiple of 1099511627776).", + "default": 4398046511104 + }, + "qosType": { + "title": "qosType", + "type": "string", + "description": "The qos type of the pool", + "enum": [ + "Auto", + "Manual" + ], + "x-ms-enum": { + "name": "qosType", + "modelAsString": true, + "values": [ + { + "value": "Auto", + "description": "qos type Auto" + }, + { + "value": "Manual", + "description": "qos type Manual" + } + ] + }, + "example": "Manual", + "default": "Auto" + }, + "coolAccess": { + "type": "boolean", + "example": false, + "description": "If enabled (true) the pool can contain cool Access enabled volumes." + } + } + }, + "volumeList": { + "description": "List of volume resources", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "volume": { + "description": "Volume resource", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "resourceIdentity": { + "type": "object", + "description": "Identity for the resource.", + "properties": { + "principalId": { + "description": "Object id of the identity resource", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of Identity. Supported values are: 'None', 'SystemAssigned'", + "type": "string" + } + } + }, + "resourceTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource" + }, + "volumeProperties": { + "description": "Volume properties", + "type": "object", + "required": [ + "creationToken", + "usageThreshold", + "subnetId" + ], + "properties": { + "fileSystemId": { + "title": "FileSystem ID", + "type": "string", + "readOnly": true, + "description": "Unique FileSystem Identifier.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca7778" + }, + "creationToken": { + "title": "Creation Token or File Path", + "type": "string", + "description": "A unique file path for the volume. Used when creating mount targets", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$", + "minLength": 1, + "maxLength": 80, + "example": "some-amazing-filepath" + }, + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "snapshotId": { + "title": "Snapshot ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Snapshot.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/snapshots/snapshot1" + }, + "deleteBaseSnapshot": { + "type": "boolean", + "description": "If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false" + }, + "backupId": { + "title": "Backup ID", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults/backups" + } + ] + }, + "x-nullable": true, + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource identifier used to identify the Backup.", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1/backups/backup1" + }, + "baremetalTenantId": { + "title": "Baremetal Tenant ID", + "type": "string", + "readOnly": true, + "description": "Unique Baremetal Tenant Identifier.", + "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779" + }, + "subnetId": { + "type": "string", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The original value of the network features type available to the volume at the time it was created.", + "example": "Basic" + }, + "effectiveNetworkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "The effective value of the network features type available to the volume, or current effective state of update.", + "readOnly": true, + "example": "Standard" + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for the the group of volumes sharing networking resources.", + "type": "string", + "readOnly": true, + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "storageToNetworkProximity": { + "title": "Storage to Network Proximity", + "description": "Provides storage to network proximity information for the volume.", + "type": "string", + "enum": [ + "Default", + "T1", + "T2", + "AcrossT2" + ], + "readOnly": true, + "x-ms-enum": { + "name": "VolumeStorageToNetworkProximity", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "Basic storage to network connectivity." + }, + { + "value": "T1", + "description": "Standard T1 storage to network connectivity." + }, + { + "value": "T2", + "description": "Standard T2 storage to network connectivity." + }, + { + "value": "AcrossT2", + "description": "Standard AcrossT2 storage to network connectivity." + } + ] + }, + "example": "T1" + }, + "mountTargets": { + "title": "mountTargets", + "type": "array", + "readOnly": true, + "description": "List of mount targets", + "items": { + "$ref": "#/definitions/mountTargetProperties" + }, + "x-ms-identifiers": [ + "fileSystemId" + ] + }, + "volumeType": { + "type": "string", + "description": "What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection", + "example": "DataProtection" + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "replication": { + "title": "Replication", + "description": "Replication properties", + "type": "object", + "$ref": "#/definitions/replicationObject" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + }, + "volumeRelocation": { + "title": "VolumeRelocation", + "description": "VolumeRelocation properties", + "type": "object", + "$ref": "#/definitions/volumeRelocationProperties" + } + } + }, + "isRestoring": { + "type": "boolean", + "description": "Restoring" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "default": true, + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true)." + }, + "kerberosEnabled": { + "type": "boolean", + "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later", + "x-ms-mutability": [ + "read", + "create" + ], + "example": false, + "default": false + }, + "securityStyle": { + "type": "string", + "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol", + "default": "unix", + "enum": [ + "ntfs", + "unix" + ], + "x-ms-enum": { + "name": "SecurityStyle", + "modelAsString": true + } + }, + "smbEncryption": { + "type": "boolean", + "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later", + "example": false, + "default": false + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + }, + "smbContinuouslyAvailable": { + "type": "boolean", + "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume", + "example": false, + "default": false + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "x-nullable": true, + "example": 128.223 + }, + "actualThroughputMibps": { + "type": "number", + "description": "Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel", + "example": 164.221, + "readOnly": true + }, + "encryptionKeySource": { + "description": "Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'", + "type": "string", + "enum": [ + "Microsoft.NetApp", + "Microsoft.KeyVault" + ], + "x-ms-enum": { + "name": "EncryptionKeySource", + "modelAsString": true, + "values": [ + { + "value": "Microsoft.NetApp", + "description": "Microsoft-managed key encryption" + }, + { + "value": "Microsoft.KeyVault", + "description": "Customer-managed key encryption" + } + ] + }, + "default": "Microsoft.NetApp" + }, + "keyVaultPrivateEndpointResourceId": { + "type": "string", + "description": "The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'." + }, + "ldapEnabled": { + "type": "boolean", + "description": "Specifies whether LDAP is enabled or not for a given NFS volume.", + "example": false, + "default": false + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false, + "default": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "cloneProgress": { + "description": "When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.", + "type": "integer", + "format": "int32", + "example": 10, + "x-nullable": true, + "readOnly": true + }, + "fileAccessLogs": { + "type": "string", + "description": "Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.", + "readOnly": true, + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "fileAccessLogs", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "fileAccessLogs are enabled" + }, + { + "value": "Disabled", + "description": "fileAccessLogs are not enabled" + } + ] + }, + "example": "Disabled", + "default": "Disabled" + }, + "avsDataStore": { + "title": "avsDataStore", + "type": "string", + "description": "Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "avsDataStore", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "avsDataStore is enabled" + }, + { + "value": "Disabled", + "description": "avsDataStore is disabled" + } + ] + }, + "example": "Enabled", + "default": "Disabled" + }, + "dataStoreResourceId": { + "title": "dataStoreResourceId", + "description": "Data store resource unique identifier", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "maximumNumberOfFiles": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.", + "example": 100000000 + }, + "volumeGroupName": { + "type": "string", + "description": "Volume Group Name", + "readOnly": true + }, + "capacityPoolResourceId": { + "type": "string", + "description": "Pool Resource Id used in case of creating a volume through volume group" + }, + "proximityPlacementGroup": { + "type": "string", + "description": "Proximity placement group associated with the volume", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg" + }, + "t2Network": { + "type": "string", + "description": "T2 network information", + "example": "Test-T2-Alias", + "readOnly": true + }, + "volumeSpecName": { + "type": "string", + "description": "Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log", + "example": "Data" + }, + "encrypted": { + "type": "boolean", + "description": "Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.", + "readOnly": true + }, + "placementRules": { + "title": "Volume placement rules", + "description": "Application specific placement rules for the particular volume", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "enableSubvolumes": { + "type": "string", + "description": "Flag indicating whether subvolume operations are enabled on the volume", + "example": "Enabled", + "default": "Disabled", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "enableSubvolumes", + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "subvolumes are enabled" + }, + { + "value": "Disabled", + "description": "subvolumes are not enabled" + } + ] + } + }, + "provisionedAvailabilityZone": { + "title": "Provisioned Availability Zone", + "type": "string", + "readOnly": true, + "description": "The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.", + "example": "2", + "x-nullable": true + }, + "isLargeVolume": { + "title": "Is Large Volume", + "type": "boolean", + "description": "Specifies whether volume is a Large Volume or Regular Volume.", + "example": false, + "default": false + }, + "originatingResourceId": { + "title": "Originating Resource Id", + "type": "string", + "description": "Id of the snapshot or backup that the volume is restored from.", + "example": "/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot", + "readOnly": true, + "x-nullable": true + } + } + }, + "exportPolicyRule": { + "description": "Volume Export Policy Rule", + "type": "object", + "properties": { + "ruleIndex": { + "type": "integer", + "description": "Order index", + "format": "int32" + }, + "unixReadOnly": { + "type": "boolean", + "description": "Read only access" + }, + "unixReadWrite": { + "type": "boolean", + "description": "Read and write access" + }, + "kerberos5ReadOnly": { + "type": "boolean", + "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5ReadWrite": { + "type": "boolean", + "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadOnly": { + "type": "boolean", + "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5iReadWrite": { + "type": "boolean", + "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadOnly": { + "type": "boolean", + "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "kerberos5pReadWrite": { + "type": "boolean", + "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later", + "example": false, + "default": false + }, + "cifs": { + "type": "boolean", + "description": "Allows CIFS protocol" + }, + "nfsv3": { + "type": "boolean", + "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes" + }, + "nfsv41": { + "type": "boolean", + "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes" + }, + "allowedClients": { + "type": "string", + "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names" + }, + "hasRootAccess": { + "type": "boolean", + "description": "Has root access to volume", + "example": true, + "default": true + }, + "chownMode": { + "type": "string", + "description": "This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.", + "default": "Restricted", + "enum": [ + "Restricted", + "Unrestricted" + ], + "x-ms-enum": { + "name": "ChownMode", + "modelAsString": true + } + } + } + }, + "replicationObject": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "description": "Id", + "readOnly": true + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "$ref": "#/definitions/remotePath", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "remotePath": { + "description": "The full path to a volume that is to be migrated into ANF. Required for Migration volumes", + "type": "object", + "required": [ + "externalHostName", + "serverName", + "volumeName" + ], + "properties": { + "externalHostName": { + "type": "string", + "description": "The Path to a ONTAP Host" + }, + "serverName": { + "type": "string", + "description": "The name of a server on the ONTAP Host" + }, + "volumeName": { + "type": "string", + "description": "The name of a volume on the server" + } + } + }, + "replication": { + "description": "Replication properties", + "type": "object", + "required": [ + "remoteVolumeResourceId" + ], + "properties": { + "replicationId": { + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the replication.", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "5ee41ce4-8f44-4ecd-ad89-8c1e573fe3b8" + }, + "endpointType": { + "type": "string", + "description": "Indicates whether the local volume is the source or destination for the Volume Replication", + "enum": [ + "src", + "dst" + ], + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + }, + "replicationSchedule": { + "type": "string", + "description": "Schedule", + "enum": [ + "_10minutely", + "hourly", + "daily" + ], + "x-ms-enum": { + "name": "ReplicationSchedule", + "modelAsString": true + } + }, + "remoteVolumeResourceId": { + "type": "string", + "description": "The resource ID of the remote volume." + }, + "remoteVolumeRegion": { + "type": "string", + "description": "The remote region for the other end of the Volume Replication." + } + } + }, + "volumeRelocationProperties": { + "description": "Volume relocation properties", + "type": "object", + "properties": { + "relocationRequested": { + "type": "boolean", + "description": "Has relocation been requested for this volume" + }, + "readyToBeFinalized": { + "type": "boolean", + "readOnly": true, + "description": "Has relocation finished and is ready to be cleaned up" + } + } + }, + "volumeSnapshotProperties": { + "description": "Volume Snapshot Properties", + "type": "object", + "properties": { + "snapshotPolicyId": { + "type": "string", + "description": "Snapshot Policy ResourceId" + } + } + }, + "replicationStatus": { + "description": "Replication status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "description": "Replication health check" + }, + "relationshipStatus": { + "type": "string", + "description": "Status of the mirror relationship", + "enum": [ + "Idle", + "Transferring" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "description": "The status of the replication", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "totalProgress": { + "type": "string", + "description": "The progress of the replication" + }, + "errorMessage": { + "type": "string", + "description": "Displays error message if the replication is in an error state" + } + } + }, + "listReplications": { + "description": "List Replications", + "type": "object", + "properties": { + "value": { + "description": "A list of replications", + "type": "array", + "items": { + "$ref": "#/definitions/replication" + }, + "x-ms-identifiers": [] + } + } + }, + "volumePatch": { + "description": "Volume patch resource", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Patchable volume properties", + "$ref": "#/definitions/volumePatchProperties", + "x-ms-client-flatten": true + } + } + }, + "volumePatchProperties": { + "description": "Patchable volume properties", + "type": "object", + "properties": { + "serviceLevel": { + "title": "serviceLevel", + "$ref": "#/definitions/serviceLevel" + }, + "usageThreshold": { + "title": "usageThreshold", + "type": "integer", + "format": "int64", + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.", + "minimum": 53687091200, + "maximum": 2638827906662400, + "default": 107374182400, + "example": 107374182400 + }, + "exportPolicy": { + "title": "exportPolicy", + "description": "Set of export policy rules", + "properties": { + "rules": { + "title": "Export policy rule", + "description": "Export policy rule", + "type": "array", + "items": { + "$ref": "#/definitions/exportPolicyRule" + }, + "x-ms-identifiers": [ + "ruleIndex" + ] + } + } + }, + "protocolTypes": { + "title": "protocolTypes", + "description": "Set of protocol types, default NFSv3, CIFS for SMB protocol", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "NFSv4.1" + ] + }, + "throughputMibps": { + "title": "Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume", + "type": "number", + "example": 128.22 + }, + "dataProtection": { + "title": "DataProtection", + "description": "DataProtection type volumes include an object containing details of the replication", + "properties": { + "backup": { + "title": "Backup", + "description": "Backup Properties", + "type": "object", + "$ref": "#/definitions/volumeBackupProperties" + }, + "snapshot": { + "title": "Snapshot", + "description": "Snapshot properties.", + "$ref": "#/definitions/volumeSnapshotProperties" + } + } + }, + "isDefaultQuotaEnabled": { + "type": "boolean", + "description": "Specifies if default quota is enabled for the volume.", + "example": false, + "default": false + }, + "defaultUserQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .", + "example": 4, + "default": 0 + }, + "defaultGroupQuotaInKiBs": { + "type": "integer", + "format": "int64", + "description": "Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.", + "example": 4, + "default": 0 + }, + "unixPermissions": { + "type": "string", + "description": "UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.", + "minLength": 4, + "maxLength": 4, + "x-nullable": true, + "example": "0770" + }, + "coolAccess": { + "type": "boolean", + "description": "Specifies whether Cool Access(tiering) is enabled for the volume.", + "example": false + }, + "coolnessPeriod": { + "type": "integer", + "description": "Specifies the number of days after which data that is not accessed by clients will be tiered.", + "example": 7, + "minimum": 2, + "maximum": 183, + "format": "int32" + }, + "coolAccessRetrievalPolicy": { + "$ref": "#/definitions/coolAccessRetrievalPolicy" + }, + "snapshotDirectoryVisible": { + "type": "boolean", + "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots." + }, + "smbAccessBasedEnumeration": { + "$ref": "#/definitions/smbAccessBasedEnumeration" + }, + "smbNonBrowsable": { + "$ref": "#/definitions/smbNonBrowsable" + } + } + }, + "mountTarget": { + "description": "Mount Target", + "type": "object", + "required": [ + "location", + "properties" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + }, + "properties": { + "description": "Mount Target Properties", + "$ref": "#/definitions/mountTargetProperties", + "x-ms-client-flatten": true + } + } + }, + "mountTargetProperties": { + "description": "Mount target properties", + "type": "object", + "required": [ + "fileSystemId" + ], + "properties": { + "mountTargetId": { + "title": "mountTargetId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "fileSystemId": { + "title": "fileSystemId", + "type": "string", + "description": "UUID v4 used to identify the MountTarget", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "ipAddress": { + "title": "ipAddress", + "description": "The mount target's IPv4 address", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "smbServerFqdn": { + "title": "smbServerFQDN", + "description": "The SMB server's Fully Qualified Domain Name, FQDN", + "type": "string", + "example": "fullyqualified.domainname.com" + } + } + }, + "snapshotsList": { + "description": "List of Snapshots", + "type": "object", + "properties": { + "value": { + "description": "A list of Snapshots", + "type": "array", + "items": { + "$ref": "#/definitions/snapshot" + } + } + } + }, + "snapshot": { + "description": "Snapshot of a Volume", + "type": "object", + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "description": "Snapshot Properties", + "$ref": "#/definitions/snapshotProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "properties": {} + }, + "snapshotProperties": { + "description": "Snapshot properties", + "type": "object", + "properties": { + "snapshotId": { + "title": "snapshotId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Snapshot", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "created": { + "title": "name", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the snapshot", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicyProperties": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "hourlySchedule": { + "title": "hourlySchedule", + "description": "Schedule for hourly snapshots", + "type": "object", + "$ref": "#/definitions/hourlySchedule" + }, + "dailySchedule": { + "title": "dailySchedule", + "description": "Schedule for daily snapshots", + "type": "object", + "$ref": "#/definitions/dailySchedule" + }, + "weeklySchedule": { + "title": "weeklySchedule", + "description": "Schedule for weekly snapshots", + "type": "object", + "$ref": "#/definitions/weeklySchedule" + }, + "monthlySchedule": { + "title": "monthlySchedule", + "description": "Schedule for monthly snapshots", + "type": "object", + "$ref": "#/definitions/monthlySchedule" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "snapshotPolicy": { + "description": "Snapshot policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPoliciesList": { + "description": "List of Snapshot Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of snapshot policies", + "type": "array", + "items": { + "$ref": "#/definitions/snapshotPolicy" + } + } + } + }, + "snapshotPolicyDetails": { + "description": "Snapshot policy properties", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot policy Properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyPatch": { + "description": "Snapshot policy Details for create and update", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Snapshot Policy properties", + "$ref": "#/definitions/snapshotPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "snapshotPolicyVolumeList": { + "description": "Volumes associated with snapshot policy", + "type": "object", + "properties": { + "value": { + "description": "List of volumes", + "type": "array", + "items": { + "$ref": "#/definitions/volume" + } + } + } + }, + "hourlySchedule": { + "description": "Hourly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Hourly snapshot count to keep", + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "dailySchedule": { + "description": "Daily Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Daily snapshot count to keep", + "format": "int32" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "weeklySchedule": { + "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Weekly snapshot count to keep", + "format": "int32" + }, + "day": { + "type": "string", + "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english", + "example": "Sunday,Monday" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "monthlySchedule": { + "description": "Monthly Schedule properties", + "type": "object", + "properties": { + "snapshotsToKeep": { + "type": "integer", + "description": "Monthly snapshot count to keep", + "format": "int32" + }, + "daysOfMonth": { + "type": "string", + "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.", + "example": "1,11,21" + }, + "hour": { + "type": "integer", + "description": "Indicates which hour in UTC timezone a snapshot should be taken", + "example": 11, + "format": "int32" + }, + "minute": { + "type": "integer", + "description": "Indicates which minute snapshot should be taken", + "example": 30, + "format": "int32" + }, + "usedBytes": { + "type": "integer", + "description": "Resource size in bytes, current storage usage for the volume in bytes", + "format": "int64" + } + } + }, + "volumeRevert": { + "description": "revert a volume to the snapshot", + "type": "object", + "properties": { + "snapshotId": { + "type": "string", + "description": "Resource id of the snapshot", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots" + } + ] + } + } + } + }, + "authorizeRequest": { + "description": "Authorize request", + "type": "object", + "properties": { + "remoteVolumeResourceId": { + "type": "string", + "description": "Resource id of the remote volume" + } + } + }, + "breakReplicationRequest": { + "description": "Break replication request", + "type": "object", + "properties": { + "forceBreakReplication": { + "type": "boolean", + "description": "If replication is in status transferring and you want to force break the replication, set to true" + } + } + }, + "reestablishReplicationRequest": { + "description": "Re-establish request object supplied in the body of the operation.", + "type": "object", + "properties": { + "sourceVolumeId": { + "type": "string", + "description": "Resource id of the source volume for the replication" + } + } + }, + "relocateVolumeRequest": { + "description": "Relocate volume request", + "type": "object", + "properties": { + "creationToken": { + "type": "string", + "description": "New creation token for the volume that controls the mount point name" + } + } + }, + "breakFileLocksRequest": { + "description": "Break file locks request", + "type": "object", + "properties": { + "clientIp": { + "type": "string", + "description": "To clear file locks on a volume for a particular client", + "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "example": "101.102.103.104" + }, + "confirmRunningDisruptiveOperation": { + "type": "boolean", + "description": "Break File locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.", + "default": false + } + } + }, + "poolChangeRequest": { + "description": "Pool change request", + "type": "object", + "required": [ + "newPoolResourceId" + ], + "properties": { + "newPoolResourceId": { + "type": "string", + "description": "Resource id of the pool to move volume to" + } + } + }, + "backupPolicyProperties": { + "description": "Backup policy properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "readOnly": true, + "description": "Backup Policy GUID ID" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "dailyBackupsToKeep": { + "type": "integer", + "description": "Daily backups count to keep", + "format": "int32" + }, + "weeklyBackupsToKeep": { + "type": "integer", + "description": "Weekly backups count to keep", + "format": "int32" + }, + "monthlyBackupsToKeep": { + "type": "integer", + "description": "Monthly backups count to keep", + "format": "int32" + }, + "volumesAssigned": { + "type": "integer", + "readOnly": true, + "description": "Volumes using current backup policy", + "format": "int32" + }, + "enabled": { + "type": "boolean", + "description": "The property to decide policy is enabled or not" + }, + "volumeBackups": { + "description": "A list of volumes assigned to this policy", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/volumeBackups" + }, + "x-ms-identifiers": [ + "volumeName" + ] + } + } + }, + "backupPolicy": { + "description": "Backup policy information", + "type": "object", + "required": [ + "location", + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPoliciesList": { + "description": "List of Backup Policies", + "type": "object", + "properties": { + "value": { + "description": "A list of backup policies", + "type": "array", + "items": { + "$ref": "#/definitions/backupPolicy" + } + } + } + }, + "backupPolicyPatch": { + "description": "Backup policy Details for create and update", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Backup policy Properties", + "$ref": "#/definitions/backupPolicyProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeBackups": { + "description": "Volume details using the backup policy", + "type": "object", + "readOnly": true, + "properties": { + "volumeName": { + "type": "string", + "description": "Volume name" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "backupsCount": { + "type": "integer", + "description": "Total count of backups for volume", + "format": "int32" + }, + "policyEnabled": { + "type": "boolean", + "description": "Policy enabled" + } + } + }, + "restoreStatus": { + "description": "Restore status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Restore health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the restore SnapMirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the restore", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy restore relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the restore is in an error state" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + } + } + }, + "getGroupIdListForLDAPUserRequest": { + "description": "Get group Id list for LDAP User request", + "type": "object", + "required": [ + "username" + ], + "properties": { + "username": { + "type": "string", + "description": "username is required to fetch the group to which user is part of", + "maxLength": 255, + "minLength": 1 + } + } + }, + "getGroupIdListForLDAPUserResponse": { + "description": "Group Id list for Ldap user", + "type": "object", + "properties": { + "groupIdsForLdapUser": { + "description": "Group Id list", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "123", + "224" + ] + } + } + }, + "cloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/cloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "cloudErrorBody": { + "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." + } + }, + "description": "An error response from the service." + }, + "serviceLevel": { + "title": "serviceLevel", + "type": "string", + "description": "The service level of the file system", + "enum": [ + "Standard", + "Premium", + "Ultra", + "StandardZRS" + ], + "default": "Premium", + "x-ms-enum": { + "name": "ServiceLevel", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard service level" + }, + { + "value": "Premium", + "description": "Premium service level" + }, + { + "value": "Ultra", + "description": "Ultra service level" + }, + { + "value": "StandardZRS", + "description": "Zone redundant storage service level" + } + ] + } + }, + "volumeQuotaRulesList": { + "description": "List of Volume Quota Rules", + "type": "object", + "properties": { + "value": { + "description": "A list of Volume Quota Rules", + "type": "array", + "items": { + "$ref": "#/definitions/volumeQuotaRule" + } + } + } + }, + "volumeQuotaRule": { + "description": "Quota Rule of a Volume", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulePatch": { + "description": "Patchable Quota Rule of a Volume", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "properties": { + "description": "Volume Quota Rule Properties", + "$ref": "#/definitions/volumeQuotaRulesProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeQuotaRulesProperties": { + "description": "Volume Quota Rule properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/netappProvisioningState" + }, + "quotaSizeInKiBs": { + "type": "integer", + "description": "Size of quota", + "format": "int64", + "example": "100006" + }, + "quotaType": { + "title": "quotaType", + "type": "string", + "description": "Type of quota", + "x-ms-mutability": [ + "read", + "create" + ], + "enum": [ + "DefaultUserQuota", + "DefaultGroupQuota", + "IndividualUserQuota", + "IndividualGroupQuota" + ], + "x-ms-enum": { + "name": "type", + "modelAsString": true, + "values": [ + { + "value": "DefaultUserQuota", + "description": "Default user quota" + }, + { + "value": "DefaultGroupQuota", + "description": "Default group quota" + }, + { + "value": "IndividualUserQuota", + "description": "Individual user quota" + }, + { + "value": "IndividualGroupQuota", + "description": "Individual group quota" + } + ] + }, + "example": "DefaultUserQuota" + }, + "quotaTarget": { + "type": "string", + "description": "UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running <wmic useraccount where name='user-name' get sid>", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "volumeGroupList": { + "description": "List of volume group resources", + "type": "object", + "properties": { + "value": { + "description": "List of volume Groups", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroup" + } + } + } + }, + "volumeGroup": { + "description": "Volume group resource", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupListProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupDetails": { + "description": "Volume group resource for create", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "Volume group properties", + "$ref": "#/definitions/volumeGroupProperties", + "x-ms-client-flatten": true + } + } + }, + "volumeGroupMetaData": { + "description": "Volume group properties", + "type": "object", + "properties": { + "groupDescription": { + "type": "string", + "description": "Group Description", + "example": "group description" + }, + "applicationType": { + "type": "string", + "description": "Application Type", + "enum": [ + "SAP-HANA", + "ORACLE" + ], + "x-ms-enum": { + "name": "ApplicationType", + "modelAsString": true + }, + "example": "SAP-HANA" + }, + "applicationIdentifier": { + "type": "string", + "description": "Application specific identifier", + "example": "SH1" + }, + "globalPlacementRules": { + "title": "Global volume placement rules", + "description": "Application specific placement rules for the volume group", + "type": "array", + "items": { + "$ref": "#/definitions/placementKeyValuePairs" + }, + "x-ms-identifiers": [ + "key" + ] + }, + "volumesCount": { + "type": "integer", + "format": "int64", + "description": "Number of volumes in volume group", + "example": 5, + "readOnly": true + } + } + }, + "volumeGroupProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + }, + "volumes": { + "description": "List of volumes from group", + "type": "array", + "items": { + "$ref": "#/definitions/volumeGroupVolumeProperties" + } + } + } + }, + "volumeGroupListProperties": { + "description": "Volume group properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available", + "readOnly": true + }, + "groupMetaData": { + "title": "groupMetaData", + "description": "Volume group details", + "type": "object", + "$ref": "#/definitions/volumeGroupMetaData" + } + } + }, + "volumeGroupVolumeProperties": { + "description": "Volume resource", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "properties" + ], + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + }, + "zones": { + "type": "array", + "description": "Availability Zone", + "x-ms-mutability": [ + "read", + "create" + ], + "items": { + "type": "string", + "maxLength": 255, + "minLength": 1, + "example": "1" + } + }, + "properties": { + "description": "Volume properties", + "$ref": "#/definitions/volumeProperties", + "x-ms-client-flatten": true + } + } + }, + "placementKeyValuePairs": { + "description": "Application specific parameters for the placement of volumes in the volume group", + "type": "object", + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Key for an application specific parameter for the placement of volumes in the volume group", + "example": "key1" + }, + "value": { + "type": "string", + "description": "Value for an application specific parameter for the placement of volumes in the volume group", + "example": "value1" + } + } + }, + "networkSiblingSet": { + "title": "Network sibling set", + "description": "Describes the contents of a network sibling set.", + "type": "object", + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures" + }, + "provisioningState": { + "$ref": "#/definitions/networkSiblingSetProvisioningState" + }, + "nicInfoList": { + "type": "array", + "x-ms-identifiers": [], + "description": "List of NIC information", + "items": { + "$ref": "#/definitions/nicInfo" + } + } + } + }, + "QueryNetworkSiblingSetRequest": { + "title": "QueryNetworkSiblingSetRequest", + "description": "Network sibling set query.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + } + } + }, + "UpdateNetworkSiblingSetRequest": { + "title": "UpdateNetworkSiblingSetRequest", + "description": "Network sibling set update.", + "type": "object", + "required": [ + "networkSiblingSetId", + "subnetId", + "networkSiblingSetStateId", + "networkFeatures" + ], + "properties": { + "networkSiblingSetId": { + "$ref": "#/definitions/networkSiblingSetId" + }, + "subnetId": { + "$ref": "#/definitions/subnetId" + }, + "networkSiblingSetStateId": { + "$ref": "#/definitions/networkSiblingSetStateId" + }, + "networkFeatures": { + "$ref": "#/definitions/networkFeatures", + "description": "Network features available to the volume." + } + } + }, + "networkFeatures": { + "title": "Network features", + "description": "Network features available to the volume, or current state of update.", + "type": "string", + "enum": [ + "Basic", + "Standard", + "Basic_Standard", + "Standard_Basic" + ], + "x-ms-enum": { + "name": "NetworkFeatures", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic network features." + }, + { + "value": "Standard", + "description": "Standard network features." + }, + { + "value": "Basic_Standard", + "description": "Updating from Basic to Standard network features." + }, + { + "value": "Standard_Basic", + "description": "Updating from Standard to Basic network features." + } + ] + }, + "example": "Standard", + "default": "Basic" + }, + "networkSiblingSetProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the NetworkSiblingSet at the time the operation was called.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Updating" + ], + "x-ms-enum": { + "name": "NetworkSiblingSetProvisioningState", + "modelAsString": true + } + }, + "networkSiblingSetId": { + "title": "Network Sibling Set ID", + "description": "Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.", + "type": "string", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "networkSiblingSetStateId": { + "title": "Network sibling set state Id", + "description": "Network sibling set state Id identifying the current state of the sibling set.", + "type": "string", + "example": "12345_44420.8001578125" + }, + "nicInfo": { + "title": "NIC information", + "description": "NIC information and list of volumes for which the NIC has the primary mount ip address.", + "type": "object", + "properties": { + "ipAddress": { + "$ref": "#/definitions/ipAddress" + }, + "volumeResourceIds": { + "$ref": "#/definitions/volumeResourceIds" + } + } + }, + "ipAddress": { + "title": "ipAddress", + "type": "string", + "readOnly": true, + "example": "1.2.3.4" + }, + "volumeResourceIds": { + "title": "Volume resource Ids", + "type": "array", + "items": { + "title": "Resource Id of volume", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + } + }, + "subnetId": { + "title": "Subnet resource Id", + "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}", + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + } + }, + "snapshotRestoreFiles": { + "description": "Restore payload for Single File Snapshot Restore", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "filePaths" + ], + "properties": { + "filePaths": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 10, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "destinationPath": { + "description": "Destination folder where the files will be restored", + "type": "string", + "example": "/AVSdataStore" + } + } + }, + "subvolumesList": { + "description": "List of Subvolumes", + "type": "object", + "properties": { + "value": { + "description": "A list of Subvolumes", + "type": "array", + "items": { + "$ref": "#/definitions/subvolumeInfo" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "subvolumeInfo": { + "description": "Subvolume Information properties", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumeProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchRequest": { + "description": "Subvolume Patch Request properties", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "description": "Subvolume Properties", + "$ref": "#/definitions/subvolumePatchParams", + "x-ms-client-flatten": true + } + } + }, + "subvolumePatchParams": { + "description": "Parameters with which a subvolume can be updated", + "type": "object", + "properties": { + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "path": { + "title": "path", + "type": "string", + "description": "path to the subvolume", + "example": "/pathToSubvolume" + } + } + }, + "subvolumeProperties": { + "description": "This represents path associated with the subvolume", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "size": { + "title": "size", + "type": "integer", + "x-nullable": true, + "format": "int64", + "description": "Truncate subvolume to the provided size in bytes", + "example": 5 + }, + "parentPath": { + "title": "name", + "x-nullable": true, + "type": "string", + "description": "parent path to the subvolume", + "example": "/parentPath" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "readOnly": true, + "example": "Available" + } + } + }, + "subvolumeModel": { + "description": "Result of the post subvolume and action is to get metadata of the subvolume.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, + "properties": { + "description": "It represents the minimal properties of the subvolume.", + "$ref": "#/definitions/subvolumeModelProperties", + "x-ms-client-flatten": true + } + } + }, + "subvolumeModelProperties": { + "description": "Properties which represents actual subvolume model which is stored as a file in the system.", + "type": "object", + "properties": { + "path": { + "title": "path", + "type": "string", + "description": "Path to the subvolume", + "example": "/subvolume1" + }, + "parentPath": { + "title": "parentpath", + "type": "string", + "description": "Path to the parent subvolume", + "example": "/parentPath" + }, + "size": { + "title": "size", + "type": "integer", + "format": "int64", + "description": "Size of subvolume", + "example": 5 + }, + "bytesUsed": { + "title": "bytesUsed", + "type": "integer", + "format": "int64", + "description": "Bytes used", + "example": 5 + }, + "permissions": { + "title": "permissions", + "type": "string", + "description": "Permissions of the subvolume", + "example": "777" + }, + "creationTimeStamp": { + "title": "creationTimeStamp", + "type": "string", + "format": "date-time", + "description": "Creation time and date", + "example": "2017-08-15T13:23:33Z" + }, + "accessedTimeStamp": { + "title": "accessedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent access time and date", + "example": "2017-08-15T13:23:33Z" + }, + "modifiedTimeStamp": { + "title": "modifiedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent modification time and date", + "example": "2017-08-15T13:23:33Z" + }, + "changedTimeStamp": { + "title": "changedTimeStamp", + "type": "string", + "format": "date-time", + "description": "Most recent change time and date", + "example": "2017-08-15T13:23:33Z" + }, + "provisioningState": { + "type": "string", + "description": "Azure lifecycle management", + "example": "Available" + } + } + }, + "netappProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the status of the VolumeQuotaRule at the time the operation was called.", + "enum": [ + "Accepted", + "Creating", + "Patching", + "Deleting", + "Moving", + "Failed", + "Succeeded" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false + } + }, + "coolAccessRetrievalPolicy": { + "type": "string", + "description": "coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: \n Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.\n OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.\n Never - No client-driven data is pulled from cool tier to standard storage.", + "enum": [ + "Default", + "OnRead", + "Never" + ], + "x-ms-enum": { + "name": "coolAccessRetrievalPolicy", + "modelAsString": true + } + }, + "clusterPeerCommandResponse": { + "description": "Information about cluster peering process", + "type": "object", + "properties": { + "peerAcceptCommand": { + "description": "A command that needs to be run on the external ONTAP to accept cluster peering. Will only be present if <code>clusterPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "svmPeerCommandResponse": { + "description": "Information about svm peering process", + "type": "object", + "properties": { + "svmPeeringCommand": { + "description": "A command that needs to be run on the external ONTAP to accept svm peering. Will only be present if <code>svmPeeringStatus</code> is <code>pending</code>", + "type": "string" + } + } + }, + "peerClusterForVolumeMigrationRequest": { + "description": "Source Cluster properties for a cluster peer request", + "type": "object", + "required": [ + "peerIpAddresses" + ], + "properties": { + "peerIpAddresses": { + "type": "array", + "minItems": 1, + "description": "A list of IC-LIF IPs that can be used to connect to the On-prem cluster", + "example": [ + "0.0.0.1", + "0.0.0.2", + "0.0.0.3", + "0.0.0.4", + "0.0.0.5", + "0.0.0.6" + ], + "items": { + "type": "string" + } + } + } + }, + "smbAccessBasedEnumeration": { + "title": "smbAccessBasedEnumeration", + "type": "string", + "description": "Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbAccessBasedEnumeration", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbAccessBasedEnumeration share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbAccessBasedEnumeration share setting is enabled" + } + ] + }, + "x-nullable": true, + "example": "Enabled" + }, + "smbNonBrowsable": { + "title": "smbNonBrowsable", + "type": "string", + "description": "Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "smbNonBrowsable", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "smbNonBrowsable share setting is disabled" + }, + { + "value": "Enabled", + "description": "smbNonBrowsable share setting is enabled" + } + ] + }, + "example": "Enabled" + }, + "backupRestoreFiles": { + "description": "Restore payload for Single File Backup Restore", + "type": "object", + "required": [ + "fileList", + "destinationVolumeId" + ], + "properties": { + "fileList": { + "description": "List of files to be restored", + "type": "array", + "minItems": 1, + "maxItems": 8, + "items": { + "type": "string", + "maxLength": 1024, + "minLength": 1 + }, + "example": [ + "/dir1/customer1.db", + "/dir1/customer2.db" + ] + }, + "restoreFilePath": { + "description": "Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default", + "type": "string", + "pattern": "^\\/.*$", + "example": "/AVSdataStore" + }, + "destinationVolumeId": { + "description": "Resource Id of the destination volume on which the files need to be restored", + "type": "string", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1" + } + } + }, + "volumeBackupProperties": { + "description": "Volume Backup Properties", + "type": "object", + "properties": { + "backupPolicyId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + }, + "description": "Backup Policy Resource ID" + }, + "policyEnforced": { + "type": "boolean", + "description": "Policy Enforced" + }, + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "Backup Vault Resource ID" + } + } + }, + "backupsList": { + "description": "List of Backups", + "type": "object", + "properties": { + "value": { + "description": "A list of Backups", + "type": "array", + "items": { + "$ref": "#/definitions/backup" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backup": { + "description": "Backup under a Backup Vault", + "type": "object", + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "description": "Backup Properties", + "$ref": "#/definitions/backupProperties", + "x-ms-client-flatten": true + } + } + }, + "backupPatch": { + "description": "Backup patch", + "type": "object", + "properties": { + "properties": { + "description": "Backup Patch Properties", + "$ref": "#/definitions/backupPatchProperties", + "x-ms-client-flatten": true + } + } + }, + "backupProperties": { + "description": "Backup properties", + "type": "object", + "required": [ + "volumeResourceId" + ], + "properties": { + "backupId": { + "title": "backupId", + "type": "string", + "readOnly": true, + "description": "UUID v4 used to identify the Backup", + "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", + "maxLength": 36, + "minLength": 36, + "example": "9760acf5-4638-11e7-9bdb-020073ca3333" + }, + "creationDate": { + "title": "creationDate", + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The creation date of the backup", + "example": "2017-08-15 13:23:33" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + }, + "size": { + "type": "integer", + "readOnly": true, + "description": "Size of backup in bytes", + "format": "int64" + }, + "label": { + "type": "string", + "description": "Label for backup" + }, + "backupType": { + "title": "backupType", + "type": "string", + "readOnly": true, + "description": "Type of backup Manual or Scheduled", + "enum": [ + "Manual", + "Scheduled" + ], + "x-ms-enum": { + "name": "backupType", + "modelAsString": true, + "values": [ + { + "value": "Manual", + "description": "Manual backup" + }, + { + "value": "Scheduled", + "description": "Scheduled backup" + } + ] + }, + "example": "Manual" + }, + "failureReason": { + "type": "string", + "readOnly": true, + "description": "Failure reason" + }, + "volumeResourceId": { + "type": "string", + "description": "ResourceId used to identify the Volume", + "x-ms-mutability": [ + "read", + "create" + ], + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes" + } + ] + } + }, + "useExistingSnapshot": { + "type": "boolean", + "description": "Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups", + "example": true, + "default": false, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "snapshotName": { + "type": "string", + "description": "The name of the snapshot", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "backupPolicyResourceId": { + "type": "string", + "readOnly": true, + "description": "ResourceId used to identify the backup policy", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupPolicies" + } + ] + } + } + } + }, + "backupPatchProperties": { + "description": "Backup patch properties", + "type": "object", + "properties": { + "label": { + "type": "string", + "description": "Label for backup" + } + } + }, + "backupStatus": { + "description": "Backup status", + "type": "object", + "properties": { + "healthy": { + "type": "boolean", + "readOnly": true, + "description": "Backup health status" + }, + "relationshipStatus": { + "type": "string", + "readOnly": true, + "description": "Status of the backup mirror relationship", + "enum": [ + "Idle", + "Transferring", + "Failed", + "Unknown" + ], + "x-ms-enum": { + "name": "RelationshipStatus", + "modelAsString": true + } + }, + "mirrorState": { + "type": "string", + "readOnly": true, + "description": "The status of the backup", + "enum": [ + "Uninitialized", + "Mirrored", + "Broken" + ], + "x-ms-enum": { + "name": "MirrorState", + "modelAsString": true + } + }, + "unhealthyReason": { + "type": "string", + "readOnly": true, + "description": "Reason for the unhealthy backup relationship" + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Displays error message if the backup is in an error state" + }, + "lastTransferSize": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the last transfer size" + }, + "lastTransferType": { + "type": "string", + "readOnly": true, + "description": "Displays the last transfer type" + }, + "totalTransferBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total bytes transferred" + }, + "transferProgressBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Displays the total number of bytes transferred for the ongoing operation" + } + } + }, + "backupVaultsList": { + "description": "List of Backup Vaults", + "type": "object", + "properties": { + "value": { + "description": "A list of Backup Vaults", + "type": "array", + "items": { + "$ref": "#/definitions/backupVault" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + } + }, + "backupVault": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "location" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Backup Vault Properties", + "$ref": "#/definitions/backupVaultProperties", + "x-ms-client-flatten": true + } + } + }, + "backupVaultPatch": { + "description": "Backup Vault information", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags" + } + } + }, + "backupVaultProperties": { + "description": "Backup Vault properties", + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Azure lifecycle management" + } + } + }, + "backupsMigrationRequest": { + "description": "Migrate Backups Request", + "type": "object", + "x-ms-azure-resource": true, + "required": [ + "backupVaultId" + ], + "properties": { + "backupVaultId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.NetApp/netAppAccounts/backupVaults" + } + ] + }, + "description": "The ResourceId of the Backup Vault", + "example": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1" + } + } + } + }, + "parameters": { + "AccountName": { + "name": "accountName", + "type": "string", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,127}$", + "in": "path", + "required": true, + "description": "The name of the NetApp account", + "x-ms-parameter-location": "method" + }, + "PoolName": { + "name": "poolName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the capacity pool", + "x-ms-parameter-location": "method" + }, + "VolumeName": { + "name": "volumeName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volume", + "x-ms-parameter-location": "method" + }, + "MountTargetName": { + "name": "mountTargetName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the mount target", + "x-ms-parameter-location": "method" + }, + "SnapshotName": { + "name": "snapshotName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot", + "x-ms-parameter-location": "method" + }, + "SnapshotPolicyName": { + "name": "snapshotPolicyName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the snapshot policy", + "x-ms-parameter-location": "method" + }, + "BackupPolicyName": { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Backup policy Name which uniquely identify backup policy.", + "x-ms-parameter-location": "method" + }, + "QuotaLimitName": { + "name": "quotaLimitName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of the Quota Limit", + "x-ms-parameter-location": "method" + }, + "VolumeGroupName": { + "name": "volumeGroupName", + "type": "string", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the volumeGroup", + "x-ms-parameter-location": "method" + }, + "SubvolumeName": { + "name": "subvolumeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subvolume.", + "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$", + "minLength": 1, + "maxLength": 64, + "x-ms-parameter-location": "method" + }, + "VolumeQuotaRuleName": { + "name": "volumeQuotaRuleName", + "type": "string", + "in": "path", + "required": true, + "description": "The name of volume quota rule", + "x-ms-parameter-location": "method" + }, + "BackupName": { + "name": "backupName", + "type": "string", + "in": "path", + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_.]{0,255}$", + "required": true, + "description": "The name of the backup", + "x-ms-parameter-location": "method" + }, + "BackupVaultName": { + "name": "backupVaultName", + "in": "path", + "required": true, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$", + "type": "string", + "description": "The name of the Backup Vault", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/netapp/resource-manager/readme.md b/specification/netapp/resource-manager/readme.md index 00aea2ca9389..f03f5363f1bf 100644 --- a/specification/netapp/resource-manager/readme.md +++ b/specification/netapp/resource-manager/readme.md @@ -28,17 +28,26 @@ These are the global settings for the Azure NetApp Files API. title: NetAppManagementClient description: Microsoft NetApp Files Azure Resource Provider specification openapi-type: arm -tag: package-preview-2024-05 +tag: package-2024-07 ``` -### Tag: package-preview-2024-05 +### Tag: package-2024-07 + +These settings apply only when `--tag=package-2024-07` is specified on the command line. +```yaml $(tag) == 'package-2024-07' +input-file: + - Microsoft.NetApp/stable/2024-07-01/netapp.json +``` + +### Tag: package-preview-2024-05 These settings apply only when `--tag=package-preview-2024-05` is specified on the command line. ```yaml $(tag) == 'package-preview-2024-05' input-file: - Microsoft.NetApp/preview/2024-05-01-preview/netapp.json ``` + ### Tag: package-2024-05 These settings apply only when `--tag=package-2024-05` is specified on the command line.